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 (!inhibit_free_realized_faces
)
2668 face_change
= false;
2669 free_all_realized_faces (Qnil
);
2671 else if (XFRAME (w
->frame
)->face_change
)
2673 XFRAME (w
->frame
)->face_change
= 0;
2674 free_all_realized_faces (w
->frame
);
2678 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2679 if (! NILP (Vface_remapping_alist
))
2680 remapped_base_face_id
2681 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2683 /* Use one of the mode line rows of W's desired matrix if
2687 if (base_face_id
== MODE_LINE_FACE_ID
2688 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2689 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2690 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2691 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2694 /* Clear IT, and set it->object and other IT's Lisp objects to Qnil.
2695 Other parts of redisplay rely on that. */
2696 memclear (it
, sizeof *it
);
2697 it
->current
.overlay_string_index
= -1;
2698 it
->current
.dpvec_index
= -1;
2699 it
->base_face_id
= remapped_base_face_id
;
2700 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2701 it
->paragraph_embedding
= L2R
;
2704 /* The window in which we iterate over current_buffer: */
2705 XSETWINDOW (it
->window
, w
);
2707 it
->f
= XFRAME (w
->frame
);
2711 /* Extra space between lines (on window systems only). */
2712 if (base_face_id
== DEFAULT_FACE_ID
2713 && FRAME_WINDOW_P (it
->f
))
2715 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2716 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2717 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2718 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2719 * FRAME_LINE_HEIGHT (it
->f
));
2720 else if (it
->f
->extra_line_spacing
> 0)
2721 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2724 /* If realized faces have been removed, e.g. because of face
2725 attribute changes of named faces, recompute them. When running
2726 in batch mode, the face cache of the initial frame is null. If
2727 we happen to get called, make a dummy face cache. */
2728 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2729 init_frame_faces (it
->f
);
2730 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2731 recompute_basic_faces (it
->f
);
2733 it
->override_ascent
= -1;
2735 /* Are control characters displayed as `^C'? */
2736 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2738 /* -1 means everything between a CR and the following line end
2739 is invisible. >0 means lines indented more than this value are
2741 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2743 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2745 : (!NILP (BVAR (current_buffer
, selective_display
))
2747 it
->selective_display_ellipsis_p
2748 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2750 /* Display table to use. */
2751 it
->dp
= window_display_table (w
);
2753 /* Are multibyte characters enabled in current_buffer? */
2754 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2756 /* Get the position at which the redisplay_end_trigger hook should
2757 be run, if it is to be run at all. */
2758 if (MARKERP (w
->redisplay_end_trigger
)
2759 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2760 it
->redisplay_end_trigger_charpos
2761 = marker_position (w
->redisplay_end_trigger
);
2762 else if (INTEGERP (w
->redisplay_end_trigger
))
2763 it
->redisplay_end_trigger_charpos
2764 = clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
),
2767 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2769 /* Are lines in the display truncated? */
2771 it
->line_wrap
= TRUNCATE
;
2772 if (base_face_id
== DEFAULT_FACE_ID
2774 && (WINDOW_FULL_WIDTH_P (it
->w
)
2775 || NILP (Vtruncate_partial_width_windows
)
2776 || (INTEGERP (Vtruncate_partial_width_windows
)
2777 /* PXW: Shall we do something about this? */
2778 && (XINT (Vtruncate_partial_width_windows
)
2779 <= WINDOW_TOTAL_COLS (it
->w
))))
2780 && NILP (BVAR (current_buffer
, truncate_lines
)))
2781 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2782 ? WINDOW_WRAP
: WORD_WRAP
;
2784 /* Get dimensions of truncation and continuation glyphs. These are
2785 displayed as fringe bitmaps under X, but we need them for such
2786 frames when the fringes are turned off. But leave the dimensions
2787 zero for tooltip frames, as these glyphs look ugly there and also
2788 sabotage calculations of tooltip dimensions in x-show-tip. */
2789 #ifdef HAVE_WINDOW_SYSTEM
2790 if (!(FRAME_WINDOW_P (it
->f
)
2791 && FRAMEP (tip_frame
)
2792 && it
->f
== XFRAME (tip_frame
)))
2795 if (it
->line_wrap
== TRUNCATE
)
2797 /* We will need the truncation glyph. */
2798 eassert (it
->glyph_row
== NULL
);
2799 produce_special_glyphs (it
, IT_TRUNCATION
);
2800 it
->truncation_pixel_width
= it
->pixel_width
;
2804 /* We will need the continuation glyph. */
2805 eassert (it
->glyph_row
== NULL
);
2806 produce_special_glyphs (it
, IT_CONTINUATION
);
2807 it
->continuation_pixel_width
= it
->pixel_width
;
2811 /* Reset these values to zero because the produce_special_glyphs
2812 above has changed them. */
2813 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2814 it
->phys_ascent
= it
->phys_descent
= 0;
2816 /* Set this after getting the dimensions of truncation and
2817 continuation glyphs, so that we don't produce glyphs when calling
2818 produce_special_glyphs, above. */
2819 it
->glyph_row
= row
;
2820 it
->area
= TEXT_AREA
;
2822 /* Get the dimensions of the display area. The display area
2823 consists of the visible window area plus a horizontally scrolled
2824 part to the left of the window. All x-values are relative to the
2825 start of this total display area. */
2826 if (base_face_id
!= DEFAULT_FACE_ID
)
2828 /* Mode lines, menu bar in terminal frames. */
2829 it
->first_visible_x
= 0;
2830 it
->last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
2835 = window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2836 it
->last_visible_x
= (it
->first_visible_x
2837 + window_box_width (w
, TEXT_AREA
));
2839 /* If we truncate lines, leave room for the truncation glyph(s) at
2840 the right margin. Otherwise, leave room for the continuation
2841 glyph(s). Done only if the window has no right fringe. */
2842 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
2844 if (it
->line_wrap
== TRUNCATE
)
2845 it
->last_visible_x
-= it
->truncation_pixel_width
;
2847 it
->last_visible_x
-= it
->continuation_pixel_width
;
2850 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2851 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2854 /* Leave room for a border glyph. */
2855 if (!FRAME_WINDOW_P (it
->f
)
2856 && !WINDOW_RIGHTMOST_P (it
->w
))
2857 it
->last_visible_x
-= 1;
2859 it
->last_visible_y
= window_text_bottom_y (w
);
2861 /* For mode lines and alike, arrange for the first glyph having a
2862 left box line if the face specifies a box. */
2863 if (base_face_id
!= DEFAULT_FACE_ID
)
2867 it
->face_id
= remapped_base_face_id
;
2869 /* If we have a boxed mode line, make the first character appear
2870 with a left box line. */
2871 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2872 if (face
&& face
->box
!= FACE_NO_BOX
)
2873 it
->start_of_box_run_p
= true;
2876 /* If a buffer position was specified, set the iterator there,
2877 getting overlays and face properties from that position. */
2878 if (charpos
>= BUF_BEG (current_buffer
))
2880 it
->stop_charpos
= charpos
;
2881 it
->end_charpos
= ZV
;
2882 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
2883 IT_CHARPOS (*it
) = charpos
;
2884 IT_BYTEPOS (*it
) = bytepos
;
2886 /* We will rely on `reseat' to set this up properly, via
2887 handle_face_prop. */
2888 it
->face_id
= it
->base_face_id
;
2890 it
->start
= it
->current
;
2891 /* Do we need to reorder bidirectional text? Not if this is a
2892 unibyte buffer: by definition, none of the single-byte
2893 characters are strong R2L, so no reordering is needed. And
2894 bidi.c doesn't support unibyte buffers anyway. Also, don't
2895 reorder while we are loading loadup.el, since the tables of
2896 character properties needed for reordering are not yet
2900 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2903 /* If we are to reorder bidirectional text, init the bidi
2907 /* Since we don't know at this point whether there will be
2908 any R2L lines in the window, we reserve space for
2909 truncation/continuation glyphs even if only the left
2910 fringe is absent. */
2911 if (base_face_id
== DEFAULT_FACE_ID
2912 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
2913 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
2915 if (it
->line_wrap
== TRUNCATE
)
2916 it
->last_visible_x
-= it
->truncation_pixel_width
;
2918 it
->last_visible_x
-= it
->continuation_pixel_width
;
2920 /* Note the paragraph direction that this buffer wants to
2922 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2924 it
->paragraph_embedding
= L2R
;
2925 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2927 it
->paragraph_embedding
= R2L
;
2929 it
->paragraph_embedding
= NEUTRAL_DIR
;
2930 bidi_unshelve_cache (NULL
, false);
2931 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2935 /* Compute faces etc. */
2936 reseat (it
, it
->current
.pos
, true);
2943 /* Initialize IT for the display of window W with window start POS. */
2946 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2948 struct glyph_row
*row
;
2949 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
2951 row
= w
->desired_matrix
->rows
+ first_vpos
;
2952 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2953 it
->first_vpos
= first_vpos
;
2955 /* Don't reseat to previous visible line start if current start
2956 position is in a string or image. */
2957 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2959 int first_y
= it
->current_y
;
2961 /* If window start is not at a line start, skip forward to POS to
2962 get the correct continuation lines width. */
2963 bool start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2964 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2965 if (!start_at_line_beg_p
)
2969 reseat_at_previous_visible_line_start (it
);
2970 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2972 new_x
= it
->current_x
+ it
->pixel_width
;
2974 /* If lines are continued, this line may end in the middle
2975 of a multi-glyph character (e.g. a control character
2976 displayed as \003, or in the middle of an overlay
2977 string). In this case move_it_to above will not have
2978 taken us to the start of the continuation line but to the
2979 end of the continued line. */
2980 if (it
->current_x
> 0
2981 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2982 && (/* And glyph doesn't fit on the line. */
2983 new_x
> it
->last_visible_x
2984 /* Or it fits exactly and we're on a window
2986 || (new_x
== it
->last_visible_x
2987 && FRAME_WINDOW_P (it
->f
)
2988 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
2989 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
2990 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
2992 if ((it
->current
.dpvec_index
>= 0
2993 || it
->current
.overlay_string_index
>= 0)
2994 /* If we are on a newline from a display vector or
2995 overlay string, then we are already at the end of
2996 a screen line; no need to go to the next line in
2997 that case, as this line is not really continued.
2998 (If we do go to the next line, C-e will not DTRT.) */
3001 set_iterator_to_next (it
, true);
3002 move_it_in_display_line_to (it
, -1, -1, 0);
3005 it
->continuation_lines_width
+= it
->current_x
;
3007 /* If the character at POS is displayed via a display
3008 vector, move_it_to above stops at the final glyph of
3009 IT->dpvec. To make the caller redisplay that character
3010 again (a.k.a. start at POS), we need to reset the
3011 dpvec_index to the beginning of IT->dpvec. */
3012 else if (it
->current
.dpvec_index
>= 0)
3013 it
->current
.dpvec_index
= 0;
3015 /* We're starting a new display line, not affected by the
3016 height of the continued line, so clear the appropriate
3017 fields in the iterator structure. */
3018 it
->max_ascent
= it
->max_descent
= 0;
3019 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3021 it
->current_y
= first_y
;
3023 it
->current_x
= it
->hpos
= 0;
3029 /* Return true if POS is a position in ellipses displayed for invisible
3030 text. W is the window we display, for text property lookup. */
3033 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3035 Lisp_Object prop
, window
;
3036 bool ellipses_p
= false;
3037 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3039 /* If POS specifies a position in a display vector, this might
3040 be for an ellipsis displayed for invisible text. We won't
3041 get the iterator set up for delivering that ellipsis unless
3042 we make sure that it gets aware of the invisible text. */
3043 if (pos
->dpvec_index
>= 0
3044 && pos
->overlay_string_index
< 0
3045 && CHARPOS (pos
->string_pos
) < 0
3047 && (XSETWINDOW (window
, w
),
3048 prop
= Fget_char_property (make_number (charpos
),
3049 Qinvisible
, window
),
3050 TEXT_PROP_MEANS_INVISIBLE (prop
) == 0))
3052 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3054 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3061 /* Initialize IT for stepping through current_buffer in window W,
3062 starting at position POS that includes overlay string and display
3063 vector/ control character translation position information. Value
3064 is false if there are overlay strings with newlines at POS. */
3067 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3069 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3071 bool overlay_strings_with_newlines
= false;
3073 /* If POS specifies a position in a display vector, this might
3074 be for an ellipsis displayed for invisible text. We won't
3075 get the iterator set up for delivering that ellipsis unless
3076 we make sure that it gets aware of the invisible text. */
3077 if (in_ellipses_for_invisible_text_p (pos
, w
))
3083 /* Keep in mind: the call to reseat in init_iterator skips invisible
3084 text, so we might end up at a position different from POS. This
3085 is only a problem when POS is a row start after a newline and an
3086 overlay starts there with an after-string, and the overlay has an
3087 invisible property. Since we don't skip invisible text in
3088 display_line and elsewhere immediately after consuming the
3089 newline before the row start, such a POS will not be in a string,
3090 but the call to init_iterator below will move us to the
3092 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3094 /* This only scans the current chunk -- it should scan all chunks.
3095 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3096 to 16 in 22.1 to make this a lesser problem. */
3097 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3099 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3100 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3102 while (s
< e
&& *s
!= '\n')
3107 overlay_strings_with_newlines
= true;
3112 /* If position is within an overlay string, set up IT to the right
3114 if (pos
->overlay_string_index
>= 0)
3118 /* If the first overlay string happens to have a `display'
3119 property for an image, the iterator will be set up for that
3120 image, and we have to undo that setup first before we can
3121 correct the overlay string index. */
3122 if (it
->method
== GET_FROM_IMAGE
)
3125 /* We already have the first chunk of overlay strings in
3126 IT->overlay_strings. Load more until the one for
3127 pos->overlay_string_index is in IT->overlay_strings. */
3128 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3130 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3131 it
->current
.overlay_string_index
= 0;
3134 load_overlay_strings (it
, 0);
3135 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3139 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3140 relative_index
= (it
->current
.overlay_string_index
3141 % OVERLAY_STRING_CHUNK_SIZE
);
3142 it
->string
= it
->overlay_strings
[relative_index
];
3143 eassert (STRINGP (it
->string
));
3144 it
->current
.string_pos
= pos
->string_pos
;
3145 it
->method
= GET_FROM_STRING
;
3146 it
->end_charpos
= SCHARS (it
->string
);
3147 /* Set up the bidi iterator for this overlay string. */
3150 it
->bidi_it
.string
.lstring
= it
->string
;
3151 it
->bidi_it
.string
.s
= NULL
;
3152 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3153 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3154 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3155 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3156 it
->bidi_it
.w
= it
->w
;
3157 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3158 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3160 /* Synchronize the state of the bidi iterator with
3161 pos->string_pos. For any string position other than
3162 zero, this will be done automagically when we resume
3163 iteration over the string and get_visually_first_element
3164 is called. But if string_pos is zero, and the string is
3165 to be reordered for display, we need to resync manually,
3166 since it could be that the iteration state recorded in
3167 pos ended at string_pos of 0 moving backwards in string. */
3168 if (CHARPOS (pos
->string_pos
) == 0)
3170 get_visually_first_element (it
);
3171 if (IT_STRING_CHARPOS (*it
) != 0)
3174 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3175 bidi_move_to_visually_next (&it
->bidi_it
);
3176 } while (it
->bidi_it
.charpos
!= 0);
3178 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3179 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3183 if (CHARPOS (pos
->string_pos
) >= 0)
3185 /* Recorded position is not in an overlay string, but in another
3186 string. This can only be a string from a `display' property.
3187 IT should already be filled with that string. */
3188 it
->current
.string_pos
= pos
->string_pos
;
3189 eassert (STRINGP (it
->string
));
3191 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3192 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3195 /* Restore position in display vector translations, control
3196 character translations or ellipses. */
3197 if (pos
->dpvec_index
>= 0)
3199 if (it
->dpvec
== NULL
)
3200 get_next_display_element (it
);
3201 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3202 it
->current
.dpvec_index
= pos
->dpvec_index
;
3206 return !overlay_strings_with_newlines
;
3210 /* Initialize IT for stepping through current_buffer in window W
3211 starting at ROW->start. */
3214 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3216 init_from_display_pos (it
, w
, &row
->start
);
3217 it
->start
= row
->start
;
3218 it
->continuation_lines_width
= row
->continuation_lines_width
;
3223 /* Initialize IT for stepping through current_buffer in window W
3224 starting in the line following ROW, i.e. starting at ROW->end.
3225 Value is false if there are overlay strings with newlines at ROW's
3229 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3231 bool success
= false;
3233 if (init_from_display_pos (it
, w
, &row
->end
))
3235 if (row
->continued_p
)
3236 it
->continuation_lines_width
3237 = row
->continuation_lines_width
+ row
->pixel_width
;
3248 /***********************************************************************
3250 ***********************************************************************/
3252 /* Called when IT reaches IT->stop_charpos. Handle text property and
3253 overlay changes. Set IT->stop_charpos to the next position where
3257 handle_stop (struct it
*it
)
3259 enum prop_handled handled
;
3260 bool handle_overlay_change_p
;
3264 it
->current
.dpvec_index
= -1;
3265 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3266 it
->ellipsis_p
= false;
3268 /* Use face of preceding text for ellipsis (if invisible) */
3269 if (it
->selective_display_ellipsis_p
)
3270 it
->saved_face_id
= it
->face_id
;
3272 /* Here's the description of the semantics of, and the logic behind,
3273 the various HANDLED_* statuses:
3275 HANDLED_NORMALLY means the handler did its job, and the loop
3276 should proceed to calling the next handler in order.
3278 HANDLED_RECOMPUTE_PROPS means the handler caused a significant
3279 change in the properties and overlays at current position, so the
3280 loop should be restarted, to re-invoke the handlers that were
3281 already called. This happens when fontification-functions were
3282 called by handle_fontified_prop, and actually fontified
3283 something. Another case where HANDLED_RECOMPUTE_PROPS is
3284 returned is when we discover overlay strings that need to be
3285 displayed right away. The loop below will continue for as long
3286 as the status is HANDLED_RECOMPUTE_PROPS.
3288 HANDLED_RETURN means return immediately to the caller, to
3289 continue iteration without calling any further handlers. This is
3290 used when we need to act on some property right away, for example
3291 when we need to display the ellipsis or a replacing display
3292 property, such as display string or image.
3294 HANDLED_OVERLAY_STRING_CONSUMED means an overlay string was just
3295 consumed, and the handler switched to the next overlay string.
3296 This signals the loop below to refrain from looking for more
3297 overlays before all the overlay strings of the current overlay
3300 Some of the handlers called by the loop push the iterator state
3301 onto the stack (see 'push_it'), and arrange for the iteration to
3302 continue with another object, such as an image, a display string,
3303 or an overlay string. In most such cases, it->stop_charpos is
3304 set to the first character of the string, so that when the
3305 iteration resumes, this function will immediately be called
3306 again, to examine the properties at the beginning of the string.
3308 When a display or overlay string is exhausted, the iterator state
3309 is popped (see 'pop_it'), and iteration continues with the
3310 previous object. Again, in many such cases this function is
3311 called again to find the next position where properties might
3316 handled
= HANDLED_NORMALLY
;
3318 /* Call text property handlers. */
3319 for (p
= it_props
; p
->handler
; ++p
)
3321 handled
= p
->handler (it
);
3323 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3325 else if (handled
== HANDLED_RETURN
)
3327 /* We still want to show before and after strings from
3328 overlays even if the actual buffer text is replaced. */
3329 if (!handle_overlay_change_p
3331 /* Don't call get_overlay_strings_1 if we already
3332 have overlay strings loaded, because doing so
3333 will load them again and push the iterator state
3334 onto the stack one more time, which is not
3335 expected by the rest of the code that processes
3337 || (it
->current
.overlay_string_index
< 0
3338 && !get_overlay_strings_1 (it
, 0, false)))
3341 setup_for_ellipsis (it
, 0);
3342 /* When handling a display spec, we might load an
3343 empty string. In that case, discard it here. We
3344 used to discard it in handle_single_display_spec,
3345 but that causes get_overlay_strings_1, above, to
3346 ignore overlay strings that we must check. */
3347 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3351 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3355 it
->string_from_display_prop_p
= false;
3356 it
->from_disp_prop_p
= false;
3357 handle_overlay_change_p
= false;
3359 handled
= HANDLED_RECOMPUTE_PROPS
;
3362 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3363 handle_overlay_change_p
= false;
3366 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3368 /* Don't check for overlay strings below when set to deliver
3369 characters from a display vector. */
3370 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3371 handle_overlay_change_p
= false;
3373 /* Handle overlay changes.
3374 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3375 if it finds overlays. */
3376 if (handle_overlay_change_p
)
3377 handled
= handle_overlay_change (it
);
3382 setup_for_ellipsis (it
, 0);
3386 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3388 /* Determine where to stop next. */
3389 if (handled
== HANDLED_NORMALLY
)
3390 compute_stop_pos (it
);
3394 /* Compute IT->stop_charpos from text property and overlay change
3395 information for IT's current position. */
3398 compute_stop_pos (struct it
*it
)
3400 register INTERVAL iv
, next_iv
;
3401 Lisp_Object object
, limit
, position
;
3402 ptrdiff_t charpos
, bytepos
;
3404 if (STRINGP (it
->string
))
3406 /* Strings are usually short, so don't limit the search for
3408 it
->stop_charpos
= it
->end_charpos
;
3409 object
= it
->string
;
3411 charpos
= IT_STRING_CHARPOS (*it
);
3412 bytepos
= IT_STRING_BYTEPOS (*it
);
3418 /* If end_charpos is out of range for some reason, such as a
3419 misbehaving display function, rationalize it (Bug#5984). */
3420 if (it
->end_charpos
> ZV
)
3421 it
->end_charpos
= ZV
;
3422 it
->stop_charpos
= it
->end_charpos
;
3424 /* If next overlay change is in front of the current stop pos
3425 (which is IT->end_charpos), stop there. Note: value of
3426 next_overlay_change is point-max if no overlay change
3428 charpos
= IT_CHARPOS (*it
);
3429 bytepos
= IT_BYTEPOS (*it
);
3430 pos
= next_overlay_change (charpos
);
3431 if (pos
< it
->stop_charpos
)
3432 it
->stop_charpos
= pos
;
3434 /* Set up variables for computing the stop position from text
3435 property changes. */
3436 XSETBUFFER (object
, current_buffer
);
3437 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3440 /* Get the interval containing IT's position. Value is a null
3441 interval if there isn't such an interval. */
3442 position
= make_number (charpos
);
3443 iv
= validate_interval_range (object
, &position
, &position
, false);
3446 Lisp_Object values_here
[LAST_PROP_IDX
];
3449 /* Get properties here. */
3450 for (p
= it_props
; p
->handler
; ++p
)
3451 values_here
[p
->idx
] = textget (iv
->plist
,
3452 builtin_lisp_symbol (p
->name
));
3454 /* Look for an interval following iv that has different
3456 for (next_iv
= next_interval (iv
);
3459 || XFASTINT (limit
) > next_iv
->position
));
3460 next_iv
= next_interval (next_iv
))
3462 for (p
= it_props
; p
->handler
; ++p
)
3464 Lisp_Object new_value
= textget (next_iv
->plist
,
3465 builtin_lisp_symbol (p
->name
));
3466 if (!EQ (values_here
[p
->idx
], new_value
))
3476 if (INTEGERP (limit
)
3477 && next_iv
->position
>= XFASTINT (limit
))
3478 /* No text property change up to limit. */
3479 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3481 /* Text properties change in next_iv. */
3482 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3486 if (it
->cmp_it
.id
< 0)
3488 ptrdiff_t stoppos
= it
->end_charpos
;
3490 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3492 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3493 stoppos
, it
->string
);
3496 eassert (STRINGP (it
->string
)
3497 || (it
->stop_charpos
>= BEGV
3498 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3502 /* Return the position of the next overlay change after POS in
3503 current_buffer. Value is point-max if no overlay change
3504 follows. This is like `next-overlay-change' but doesn't use
3508 next_overlay_change (ptrdiff_t pos
)
3510 ptrdiff_t i
, noverlays
;
3512 Lisp_Object
*overlays
;
3515 /* Get all overlays at the given position. */
3516 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, true);
3518 /* If any of these overlays ends before endpos,
3519 use its ending point instead. */
3520 for (i
= 0; i
< noverlays
; ++i
)
3525 oend
= OVERLAY_END (overlays
[i
]);
3526 oendpos
= OVERLAY_POSITION (oend
);
3527 endpos
= min (endpos
, oendpos
);
3534 /* How many characters forward to search for a display property or
3535 display string. Searching too far forward makes the bidi display
3536 sluggish, especially in small windows. */
3537 #define MAX_DISP_SCAN 250
3539 /* Return the character position of a display string at or after
3540 position specified by POSITION. If no display string exists at or
3541 after POSITION, return ZV. A display string is either an overlay
3542 with `display' property whose value is a string, or a `display'
3543 text property whose value is a string. STRING is data about the
3544 string to iterate; if STRING->lstring is nil, we are iterating a
3545 buffer. FRAME_WINDOW_P is true when we are displaying a window
3546 on a GUI frame. DISP_PROP is set to zero if we searched
3547 MAX_DISP_SCAN characters forward without finding any display
3548 strings, non-zero otherwise. It is set to 2 if the display string
3549 uses any kind of `(space ...)' spec that will produce a stretch of
3550 white space in the text area. */
3552 compute_display_string_pos (struct text_pos
*position
,
3553 struct bidi_string_data
*string
,
3555 bool frame_window_p
, int *disp_prop
)
3557 /* OBJECT = nil means current buffer. */
3558 Lisp_Object object
, object1
;
3559 Lisp_Object pos
, spec
, limpos
;
3560 bool string_p
= string
&& (STRINGP (string
->lstring
) || string
->s
);
3561 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3562 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3563 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3565 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3566 struct text_pos tpos
;
3569 if (string
&& STRINGP (string
->lstring
))
3570 object1
= object
= string
->lstring
;
3571 else if (w
&& !string_p
)
3573 XSETWINDOW (object
, w
);
3577 object1
= object
= Qnil
;
3582 /* We don't support display properties whose values are strings
3583 that have display string properties. */
3584 || string
->from_disp_str
3585 /* C strings cannot have display properties. */
3586 || (string
->s
&& !STRINGP (object
)))
3592 /* If the character at CHARPOS is where the display string begins,
3594 pos
= make_number (charpos
);
3595 if (STRINGP (object
))
3596 bufpos
= string
->bufpos
;
3600 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3602 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3605 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3613 /* Look forward for the first character with a `display' property
3614 that will replace the underlying text when displayed. */
3615 limpos
= make_number (lim
);
3617 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3618 CHARPOS (tpos
) = XFASTINT (pos
);
3619 if (CHARPOS (tpos
) >= lim
)
3624 if (STRINGP (object
))
3625 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3627 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3628 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3629 if (!STRINGP (object
))
3630 bufpos
= CHARPOS (tpos
);
3631 } while (NILP (spec
)
3632 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3633 bufpos
, frame_window_p
)));
3637 return CHARPOS (tpos
);
3640 /* Return the character position of the end of the display string that
3641 started at CHARPOS. If there's no display string at CHARPOS,
3642 return -1. A display string is either an overlay with `display'
3643 property whose value is a string or a `display' text property whose
3644 value is a string. */
3646 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3648 /* OBJECT = nil means current buffer. */
3649 Lisp_Object object
=
3650 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3651 Lisp_Object pos
= make_number (charpos
);
3653 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3655 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3658 /* It could happen that the display property or overlay was removed
3659 since we found it in compute_display_string_pos above. One way
3660 this can happen is if JIT font-lock was called (through
3661 handle_fontified_prop), and jit-lock-functions remove text
3662 properties or overlays from the portion of buffer that includes
3663 CHARPOS. Muse mode is known to do that, for example. In this
3664 case, we return -1 to the caller, to signal that no display
3665 string is actually present at CHARPOS. See bidi_fetch_char for
3666 how this is handled.
3668 An alternative would be to never look for display properties past
3669 it->stop_charpos. But neither compute_display_string_pos nor
3670 bidi_fetch_char that calls it know or care where the next
3672 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3675 /* Look forward for the first character where the `display' property
3677 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3679 return XFASTINT (pos
);
3684 /***********************************************************************
3686 ***********************************************************************/
3688 /* Handle changes in the `fontified' property of the current buffer by
3689 calling hook functions from Qfontification_functions to fontify
3692 static enum prop_handled
3693 handle_fontified_prop (struct it
*it
)
3695 Lisp_Object prop
, pos
;
3696 enum prop_handled handled
= HANDLED_NORMALLY
;
3698 if (!NILP (Vmemory_full
))
3701 /* Get the value of the `fontified' property at IT's current buffer
3702 position. (The `fontified' property doesn't have a special
3703 meaning in strings.) If the value is nil, call functions from
3704 Qfontification_functions. */
3705 if (!STRINGP (it
->string
)
3707 && !NILP (Vfontification_functions
)
3708 && !NILP (Vrun_hooks
)
3709 && (pos
= make_number (IT_CHARPOS (*it
)),
3710 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3711 /* Ignore the special cased nil value always present at EOB since
3712 no amount of fontifying will be able to change it. */
3713 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3715 ptrdiff_t count
= SPECPDL_INDEX ();
3717 struct buffer
*obuf
= current_buffer
;
3718 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3719 bool old_clip_changed
= current_buffer
->clip_changed
;
3721 val
= Vfontification_functions
;
3722 specbind (Qfontification_functions
, Qnil
);
3724 eassert (it
->end_charpos
== ZV
);
3726 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3727 safe_call1 (val
, pos
);
3730 Lisp_Object fns
, fn
;
3734 for (; CONSP (val
); val
= XCDR (val
))
3740 /* A value of t indicates this hook has a local
3741 binding; it means to run the global binding too.
3742 In a global value, t should not occur. If it
3743 does, we must ignore it to avoid an endless
3745 for (fns
= Fdefault_value (Qfontification_functions
);
3751 safe_call1 (fn
, pos
);
3755 safe_call1 (fn
, pos
);
3759 unbind_to (count
, Qnil
);
3761 /* Fontification functions routinely call `save-restriction'.
3762 Normally, this tags clip_changed, which can confuse redisplay
3763 (see discussion in Bug#6671). Since we don't perform any
3764 special handling of fontification changes in the case where
3765 `save-restriction' isn't called, there's no point doing so in
3766 this case either. So, if the buffer's restrictions are
3767 actually left unchanged, reset clip_changed. */
3768 if (obuf
== current_buffer
)
3770 if (begv
== BEGV
&& zv
== ZV
)
3771 current_buffer
->clip_changed
= old_clip_changed
;
3773 /* There isn't much we can reasonably do to protect against
3774 misbehaving fontification, but here's a fig leaf. */
3775 else if (BUFFER_LIVE_P (obuf
))
3776 set_buffer_internal_1 (obuf
);
3778 /* The fontification code may have added/removed text.
3779 It could do even a lot worse, but let's at least protect against
3780 the most obvious case where only the text past `pos' gets changed',
3781 as is/was done in grep.el where some escapes sequences are turned
3782 into face properties (bug#7876). */
3783 it
->end_charpos
= ZV
;
3785 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3786 something. This avoids an endless loop if they failed to
3787 fontify the text for which reason ever. */
3788 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3789 handled
= HANDLED_RECOMPUTE_PROPS
;
3797 /***********************************************************************
3799 ***********************************************************************/
3801 /* Set up iterator IT from face properties at its current position.
3802 Called from handle_stop. */
3804 static enum prop_handled
3805 handle_face_prop (struct it
*it
)
3808 ptrdiff_t next_stop
;
3810 if (!STRINGP (it
->string
))
3813 = face_at_buffer_position (it
->w
,
3817 + TEXT_PROP_DISTANCE_LIMIT
),
3818 false, it
->base_face_id
);
3820 /* Is this a start of a run of characters with box face?
3821 Caveat: this can be called for a freshly initialized
3822 iterator; face_id is -1 in this case. We know that the new
3823 face will not change until limit, i.e. if the new face has a
3824 box, all characters up to limit will have one. But, as
3825 usual, we don't know whether limit is really the end. */
3826 if (new_face_id
!= it
->face_id
)
3828 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3829 /* If it->face_id is -1, old_face below will be NULL, see
3830 the definition of FACE_FROM_ID. This will happen if this
3831 is the initial call that gets the face. */
3832 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3834 /* If the value of face_id of the iterator is -1, we have to
3835 look in front of IT's position and see whether there is a
3836 face there that's different from new_face_id. */
3837 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
3839 int prev_face_id
= face_before_it_pos (it
);
3841 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
3844 /* If the new face has a box, but the old face does not,
3845 this is the start of a run of characters with box face,
3846 i.e. this character has a shadow on the left side. */
3847 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
3848 && (old_face
== NULL
|| !old_face
->box
));
3849 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3857 Lisp_Object from_overlay
3858 = (it
->current
.overlay_string_index
>= 0
3859 ? it
->string_overlays
[it
->current
.overlay_string_index
3860 % OVERLAY_STRING_CHUNK_SIZE
]
3863 /* See if we got to this string directly or indirectly from
3864 an overlay property. That includes the before-string or
3865 after-string of an overlay, strings in display properties
3866 provided by an overlay, their text properties, etc.
3868 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3869 if (! NILP (from_overlay
))
3870 for (i
= it
->sp
- 1; i
>= 0; i
--)
3872 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3874 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3875 % OVERLAY_STRING_CHUNK_SIZE
];
3876 else if (! NILP (it
->stack
[i
].from_overlay
))
3877 from_overlay
= it
->stack
[i
].from_overlay
;
3879 if (!NILP (from_overlay
))
3883 if (! NILP (from_overlay
))
3885 bufpos
= IT_CHARPOS (*it
);
3886 /* For a string from an overlay, the base face depends
3887 only on text properties and ignores overlays. */
3889 = face_for_overlay_string (it
->w
,
3893 + TEXT_PROP_DISTANCE_LIMIT
),
3901 /* For strings from a `display' property, use the face at
3902 IT's current buffer position as the base face to merge
3903 with, so that overlay strings appear in the same face as
3904 surrounding text, unless they specify their own faces.
3905 For strings from wrap-prefix and line-prefix properties,
3906 use the default face, possibly remapped via
3907 Vface_remapping_alist. */
3908 /* Note that the fact that we use the face at _buffer_
3909 position means that a 'display' property on an overlay
3910 string will not inherit the face of that overlay string,
3911 but will instead revert to the face of buffer text
3912 covered by the overlay. This is visible, e.g., when the
3913 overlay specifies a box face, but neither the buffer nor
3914 the display string do. This sounds like a design bug,
3915 but Emacs always did that since v21.1, so changing that
3916 might be a big deal. */
3917 base_face_id
= it
->string_from_prefix_prop_p
3918 ? (!NILP (Vface_remapping_alist
)
3919 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
3921 : underlying_face_id (it
);
3924 new_face_id
= face_at_string_position (it
->w
,
3926 IT_STRING_CHARPOS (*it
),
3929 base_face_id
, false);
3931 /* Is this a start of a run of characters with box? Caveat:
3932 this can be called for a freshly allocated iterator; face_id
3933 is -1 is this case. We know that the new face will not
3934 change until the next check pos, i.e. if the new face has a
3935 box, all characters up to that position will have a
3936 box. But, as usual, we don't know whether that position
3937 is really the end. */
3938 if (new_face_id
!= it
->face_id
)
3940 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3941 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3943 /* If new face has a box but old face hasn't, this is the
3944 start of a run of characters with box, i.e. it has a
3945 shadow on the left side. */
3946 it
->start_of_box_run_p
3947 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3948 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3952 it
->face_id
= new_face_id
;
3953 return HANDLED_NORMALLY
;
3957 /* Return the ID of the face ``underlying'' IT's current position,
3958 which is in a string. If the iterator is associated with a
3959 buffer, return the face at IT's current buffer position.
3960 Otherwise, use the iterator's base_face_id. */
3963 underlying_face_id (struct it
*it
)
3965 int face_id
= it
->base_face_id
, i
;
3967 eassert (STRINGP (it
->string
));
3969 for (i
= it
->sp
- 1; i
>= 0; --i
)
3970 if (NILP (it
->stack
[i
].string
))
3971 face_id
= it
->stack
[i
].face_id
;
3977 /* Compute the face one character before or after the current position
3978 of IT, in the visual order. BEFORE_P means get the face
3979 in front (to the left in L2R paragraphs, to the right in R2L
3980 paragraphs) of IT's screen position. Value is the ID of the face. */
3983 face_before_or_after_it_pos (struct it
*it
, bool before_p
)
3986 ptrdiff_t next_check_charpos
;
3988 void *it_copy_data
= NULL
;
3990 eassert (it
->s
== NULL
);
3992 if (STRINGP (it
->string
))
3994 ptrdiff_t bufpos
, charpos
;
3997 /* No face change past the end of the string (for the case
3998 we are padding with spaces). No face change before the
4000 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
4001 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
4006 /* Set charpos to the position before or after IT's current
4007 position, in the logical order, which in the non-bidi
4008 case is the same as the visual order. */
4010 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4011 else if (it
->what
== IT_COMPOSITION
)
4012 /* For composition, we must check the character after the
4014 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4016 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4022 /* With bidi iteration, the character before the current
4023 in the visual order cannot be found by simple
4024 iteration, because "reverse" reordering is not
4025 supported. Instead, we need to start from the string
4026 beginning and go all the way to the current string
4027 position, remembering the previous position. */
4028 /* Ignore face changes before the first visible
4029 character on this display line. */
4030 if (it
->current_x
<= it
->first_visible_x
)
4032 SAVE_IT (it_copy
, *it
, it_copy_data
);
4033 IT_STRING_CHARPOS (it_copy
) = 0;
4034 bidi_init_it (0, 0, FRAME_WINDOW_P (it_copy
.f
), &it_copy
.bidi_it
);
4038 charpos
= IT_STRING_CHARPOS (it_copy
);
4039 if (charpos
>= SCHARS (it
->string
))
4041 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4043 while (IT_STRING_CHARPOS (it_copy
) != IT_STRING_CHARPOS (*it
));
4045 RESTORE_IT (it
, it
, it_copy_data
);
4049 /* Set charpos to the string position of the character
4050 that comes after IT's current position in the visual
4052 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4056 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4058 charpos
= it_copy
.bidi_it
.charpos
;
4061 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4063 if (it
->current
.overlay_string_index
>= 0)
4064 bufpos
= IT_CHARPOS (*it
);
4068 base_face_id
= underlying_face_id (it
);
4070 /* Get the face for ASCII, or unibyte. */
4071 face_id
= face_at_string_position (it
->w
,
4075 &next_check_charpos
,
4076 base_face_id
, false);
4078 /* Correct the face for charsets different from ASCII. Do it
4079 for the multibyte case only. The face returned above is
4080 suitable for unibyte text if IT->string is unibyte. */
4081 if (STRING_MULTIBYTE (it
->string
))
4083 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4084 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4086 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4088 c
= string_char_and_length (p
, &len
);
4089 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4094 struct text_pos pos
;
4096 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4097 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4100 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4101 pos
= it
->current
.pos
;
4106 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4109 if (it
->what
== IT_COMPOSITION
)
4111 /* For composition, we must check the position after
4113 pos
.charpos
+= it
->cmp_it
.nchars
;
4114 pos
.bytepos
+= it
->len
;
4117 INC_TEXT_POS (pos
, it
->multibyte_p
);
4126 /* With bidi iteration, the character before the current
4127 in the visual order cannot be found by simple
4128 iteration, because "reverse" reordering is not
4129 supported. Instead, we need to use the move_it_*
4130 family of functions, and move to the previous
4131 character starting from the beginning of the visual
4133 /* Ignore face changes before the first visible
4134 character on this display line. */
4135 if (it
->current_x
<= it
->first_visible_x
)
4137 SAVE_IT (it_copy
, *it
, it_copy_data
);
4138 /* Implementation note: Since move_it_in_display_line
4139 works in the iterator geometry, and thinks the first
4140 character is always the leftmost, even in R2L lines,
4141 we don't need to distinguish between the R2L and L2R
4143 current_x
= it_copy
.current_x
;
4144 move_it_vertically_backward (&it_copy
, 0);
4145 move_it_in_display_line (&it_copy
, ZV
, current_x
- 1, MOVE_TO_X
);
4146 pos
= it_copy
.current
.pos
;
4147 RESTORE_IT (it
, it
, it_copy_data
);
4151 /* Set charpos to the buffer position of the character
4152 that comes after IT's current position in the visual
4154 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4158 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4161 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4164 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4166 /* Determine face for CHARSET_ASCII, or unibyte. */
4167 face_id
= face_at_buffer_position (it
->w
,
4169 &next_check_charpos
,
4172 /* Correct the face for charsets different from ASCII. Do it
4173 for the multibyte case only. The face returned above is
4174 suitable for unibyte text if current_buffer is unibyte. */
4175 if (it
->multibyte_p
)
4177 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4178 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4179 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4188 /***********************************************************************
4190 ***********************************************************************/
4192 /* Set up iterator IT from invisible properties at its current
4193 position. Called from handle_stop. */
4195 static enum prop_handled
4196 handle_invisible_prop (struct it
*it
)
4198 enum prop_handled handled
= HANDLED_NORMALLY
;
4202 if (STRINGP (it
->string
))
4204 Lisp_Object end_charpos
, limit
;
4206 /* Get the value of the invisible text property at the
4207 current position. Value will be nil if there is no such
4209 end_charpos
= make_number (IT_STRING_CHARPOS (*it
));
4210 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4211 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4213 if (invis
!= 0 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4215 /* Record whether we have to display an ellipsis for the
4217 bool display_ellipsis_p
= (invis
== 2);
4218 ptrdiff_t len
, endpos
;
4220 handled
= HANDLED_RECOMPUTE_PROPS
;
4222 /* Get the position at which the next visible text can be
4223 found in IT->string, if any. */
4224 endpos
= len
= SCHARS (it
->string
);
4225 XSETINT (limit
, len
);
4229 = Fnext_single_property_change (end_charpos
, Qinvisible
,
4231 /* Since LIMIT is always an integer, so should be the
4232 value returned by Fnext_single_property_change. */
4233 eassert (INTEGERP (end_charpos
));
4234 if (INTEGERP (end_charpos
))
4236 endpos
= XFASTINT (end_charpos
);
4237 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4238 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4240 display_ellipsis_p
= true;
4242 else /* Should never happen; but if it does, exit the loop. */
4245 while (invis
!= 0 && endpos
< len
);
4247 if (display_ellipsis_p
)
4248 it
->ellipsis_p
= true;
4252 /* Text at END_CHARPOS is visible. Move IT there. */
4253 struct text_pos old
;
4256 old
= it
->current
.string_pos
;
4257 oldpos
= CHARPOS (old
);
4260 if (it
->bidi_it
.first_elt
4261 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4262 bidi_paragraph_init (it
->paragraph_embedding
,
4263 &it
->bidi_it
, true);
4264 /* Bidi-iterate out of the invisible text. */
4267 bidi_move_to_visually_next (&it
->bidi_it
);
4269 while (oldpos
<= it
->bidi_it
.charpos
4270 && it
->bidi_it
.charpos
< endpos
);
4272 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4273 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4274 if (IT_CHARPOS (*it
) >= endpos
)
4275 it
->prev_stop
= endpos
;
4279 IT_STRING_CHARPOS (*it
) = endpos
;
4280 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4285 /* The rest of the string is invisible. If this is an
4286 overlay string, proceed with the next overlay string
4287 or whatever comes and return a character from there. */
4288 if (it
->current
.overlay_string_index
>= 0
4289 && !display_ellipsis_p
)
4291 next_overlay_string (it
);
4292 /* Don't check for overlay strings when we just
4293 finished processing them. */
4294 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4298 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4299 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4306 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4307 Lisp_Object pos
, overlay
;
4309 /* First of all, is there invisible text at this position? */
4310 tem
= start_charpos
= IT_CHARPOS (*it
);
4311 pos
= make_number (tem
);
4312 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4314 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4316 /* If we are on invisible text, skip over it. */
4317 if (invis
!= 0 && start_charpos
< it
->end_charpos
)
4319 /* Record whether we have to display an ellipsis for the
4321 bool display_ellipsis_p
= invis
== 2;
4323 handled
= HANDLED_RECOMPUTE_PROPS
;
4325 /* Loop skipping over invisible text. The loop is left at
4326 ZV or with IT on the first char being visible again. */
4329 /* Try to skip some invisible text. Return value is the
4330 position reached which can be equal to where we start
4331 if there is nothing invisible there. This skips both
4332 over invisible text properties and overlays with
4333 invisible property. */
4334 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4336 /* If we skipped nothing at all we weren't at invisible
4337 text in the first place. If everything to the end of
4338 the buffer was skipped, end the loop. */
4339 if (newpos
== tem
|| newpos
>= ZV
)
4343 /* We skipped some characters but not necessarily
4344 all there are. Check if we ended up on visible
4345 text. Fget_char_property returns the property of
4346 the char before the given position, i.e. if we
4347 get invis = 0, this means that the char at
4348 newpos is visible. */
4349 pos
= make_number (newpos
);
4350 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4351 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4354 /* If we ended up on invisible text, proceed to
4355 skip starting with next_stop. */
4359 /* If there are adjacent invisible texts, don't lose the
4360 second one's ellipsis. */
4362 display_ellipsis_p
= true;
4366 /* The position newpos is now either ZV or on visible text. */
4369 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4371 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4373 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4375 /* If the invisible text ends on a newline or on a
4376 character after a newline, we can avoid the costly,
4377 character by character, bidi iteration to NEWPOS, and
4378 instead simply reseat the iterator there. That's
4379 because all bidi reordering information is tossed at
4380 the newline. This is a big win for modes that hide
4381 complete lines, like Outline, Org, etc. */
4382 if (on_newline
|| after_newline
)
4384 struct text_pos tpos
;
4385 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4387 SET_TEXT_POS (tpos
, newpos
, bpos
);
4388 reseat_1 (it
, tpos
, false);
4389 /* If we reseat on a newline/ZV, we need to prep the
4390 bidi iterator for advancing to the next character
4391 after the newline/EOB, keeping the current paragraph
4392 direction (so that PRODUCE_GLYPHS does TRT wrt
4393 prepending/appending glyphs to a glyph row). */
4396 it
->bidi_it
.first_elt
= false;
4397 it
->bidi_it
.paragraph_dir
= pdir
;
4398 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4399 it
->bidi_it
.nchars
= 1;
4400 it
->bidi_it
.ch_len
= 1;
4403 else /* Must use the slow method. */
4405 /* With bidi iteration, the region of invisible text
4406 could start and/or end in the middle of a
4407 non-base embedding level. Therefore, we need to
4408 skip invisible text using the bidi iterator,
4409 starting at IT's current position, until we find
4410 ourselves outside of the invisible text.
4411 Skipping invisible text _after_ bidi iteration
4412 avoids affecting the visual order of the
4413 displayed text when invisible properties are
4414 added or removed. */
4415 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4417 /* If we were `reseat'ed to a new paragraph,
4418 determine the paragraph base direction. We
4419 need to do it now because
4420 next_element_from_buffer may not have a
4421 chance to do it, if we are going to skip any
4422 text at the beginning, which resets the
4424 bidi_paragraph_init (it
->paragraph_embedding
,
4425 &it
->bidi_it
, true);
4429 bidi_move_to_visually_next (&it
->bidi_it
);
4431 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4432 && it
->bidi_it
.charpos
< newpos
);
4433 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4434 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4435 /* If we overstepped NEWPOS, record its position in
4436 the iterator, so that we skip invisible text if
4437 later the bidi iteration lands us in the
4438 invisible region again. */
4439 if (IT_CHARPOS (*it
) >= newpos
)
4440 it
->prev_stop
= newpos
;
4445 IT_CHARPOS (*it
) = newpos
;
4446 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4449 if (display_ellipsis_p
)
4451 /* Make sure that the glyphs of the ellipsis will get
4452 correct `charpos' values. If we would not update
4453 it->position here, the glyphs would belong to the
4454 last visible character _before_ the invisible
4455 text, which confuses `set_cursor_from_row'.
4457 We use the last invisible position instead of the
4458 first because this way the cursor is always drawn on
4459 the first "." of the ellipsis, whenever PT is inside
4460 the invisible text. Otherwise the cursor would be
4461 placed _after_ the ellipsis when the point is after the
4462 first invisible character. */
4463 if (!STRINGP (it
->object
))
4465 it
->position
.charpos
= newpos
- 1;
4466 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4470 /* If there are before-strings at the start of invisible
4471 text, and the text is invisible because of a text
4472 property, arrange to show before-strings because 20.x did
4473 it that way. (If the text is invisible because of an
4474 overlay property instead of a text property, this is
4475 already handled in the overlay code.) */
4477 && get_overlay_strings (it
, it
->stop_charpos
))
4479 handled
= HANDLED_RECOMPUTE_PROPS
;
4482 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4483 /* The call to get_overlay_strings above recomputes
4484 it->stop_charpos, but it only considers changes
4485 in properties and overlays beyond iterator's
4486 current position. This causes us to miss changes
4487 that happen exactly where the invisible property
4488 ended. So we play it safe here and force the
4489 iterator to check for potential stop positions
4490 immediately after the invisible text. Note that
4491 if get_overlay_strings returns true, it
4492 normally also pushed the iterator stack, so we
4493 need to update the stop position in the slot
4494 below the current one. */
4495 it
->stack
[it
->sp
- 1].stop_charpos
4496 = CHARPOS (it
->stack
[it
->sp
- 1].current
.pos
);
4499 else if (display_ellipsis_p
)
4501 it
->ellipsis_p
= true;
4502 /* Let the ellipsis display before
4503 considering any properties of the following char.
4504 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4505 handled
= HANDLED_RETURN
;
4514 /* Make iterator IT return `...' next.
4515 Replaces LEN characters from buffer. */
4518 setup_for_ellipsis (struct it
*it
, int len
)
4520 /* Use the display table definition for `...'. Invalid glyphs
4521 will be handled by the method returning elements from dpvec. */
4522 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4524 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4525 it
->dpvec
= v
->contents
;
4526 it
->dpend
= v
->contents
+ v
->header
.size
;
4530 /* Default `...'. */
4531 it
->dpvec
= default_invis_vector
;
4532 it
->dpend
= default_invis_vector
+ 3;
4535 it
->dpvec_char_len
= len
;
4536 it
->current
.dpvec_index
= 0;
4537 it
->dpvec_face_id
= -1;
4539 /* Remember the current face id in case glyphs specify faces.
4540 IT's face is restored in set_iterator_to_next.
4541 saved_face_id was set to preceding char's face in handle_stop. */
4542 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4543 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4545 /* If the ellipsis represents buffer text, it means we advanced in
4546 the buffer, so we should no longer ignore overlay strings. */
4547 if (it
->method
== GET_FROM_BUFFER
)
4548 it
->ignore_overlay_strings_at_pos_p
= false;
4550 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4551 it
->ellipsis_p
= true;
4556 /***********************************************************************
4558 ***********************************************************************/
4560 /* Set up iterator IT from `display' property at its current position.
4561 Called from handle_stop.
4562 We return HANDLED_RETURN if some part of the display property
4563 overrides the display of the buffer text itself.
4564 Otherwise we return HANDLED_NORMALLY. */
4566 static enum prop_handled
4567 handle_display_prop (struct it
*it
)
4569 Lisp_Object propval
, object
, overlay
;
4570 struct text_pos
*position
;
4572 /* Nonzero if some property replaces the display of the text itself. */
4573 int display_replaced
= 0;
4575 if (STRINGP (it
->string
))
4577 object
= it
->string
;
4578 position
= &it
->current
.string_pos
;
4579 bufpos
= CHARPOS (it
->current
.pos
);
4583 XSETWINDOW (object
, it
->w
);
4584 position
= &it
->current
.pos
;
4585 bufpos
= CHARPOS (*position
);
4588 /* Reset those iterator values set from display property values. */
4589 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4590 it
->space_width
= Qnil
;
4591 it
->font_height
= Qnil
;
4594 /* We don't support recursive `display' properties, i.e. string
4595 values that have a string `display' property, that have a string
4596 `display' property etc. */
4597 if (!it
->string_from_display_prop_p
)
4598 it
->area
= TEXT_AREA
;
4600 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4601 Qdisplay
, object
, &overlay
);
4603 return HANDLED_NORMALLY
;
4604 /* Now OVERLAY is the overlay that gave us this property, or nil
4605 if it was a text property. */
4607 if (!STRINGP (it
->string
))
4608 object
= it
->w
->contents
;
4610 display_replaced
= handle_display_spec (it
, propval
, object
, overlay
,
4612 FRAME_WINDOW_P (it
->f
));
4613 return display_replaced
!= 0 ? HANDLED_RETURN
: HANDLED_NORMALLY
;
4616 /* Subroutine of handle_display_prop. Returns non-zero if the display
4617 specification in SPEC is a replacing specification, i.e. it would
4618 replace the text covered by `display' property with something else,
4619 such as an image or a display string. If SPEC includes any kind or
4620 `(space ...) specification, the value is 2; this is used by
4621 compute_display_string_pos, which see.
4623 See handle_single_display_spec for documentation of arguments.
4624 FRAME_WINDOW_P is true if the window being redisplayed is on a
4625 GUI frame; this argument is used only if IT is NULL, see below.
4627 IT can be NULL, if this is called by the bidi reordering code
4628 through compute_display_string_pos, which see. In that case, this
4629 function only examines SPEC, but does not otherwise "handle" it, in
4630 the sense that it doesn't set up members of IT from the display
4633 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4634 Lisp_Object overlay
, struct text_pos
*position
,
4635 ptrdiff_t bufpos
, bool frame_window_p
)
4640 /* Simple specifications. */
4641 && !EQ (XCAR (spec
), Qimage
)
4642 && !EQ (XCAR (spec
), Qspace
)
4643 && !EQ (XCAR (spec
), Qwhen
)
4644 && !EQ (XCAR (spec
), Qslice
)
4645 && !EQ (XCAR (spec
), Qspace_width
)
4646 && !EQ (XCAR (spec
), Qheight
)
4647 && !EQ (XCAR (spec
), Qraise
)
4648 /* Marginal area specifications. */
4649 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4650 && !EQ (XCAR (spec
), Qleft_fringe
)
4651 && !EQ (XCAR (spec
), Qright_fringe
)
4652 && !NILP (XCAR (spec
)))
4654 for (; CONSP (spec
); spec
= XCDR (spec
))
4656 int rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4657 overlay
, position
, bufpos
,
4658 replacing
, frame_window_p
);
4662 /* If some text in a string is replaced, `position' no
4663 longer points to the position of `object'. */
4664 if (!it
|| STRINGP (object
))
4669 else if (VECTORP (spec
))
4672 for (i
= 0; i
< ASIZE (spec
); ++i
)
4674 int rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4675 overlay
, position
, bufpos
,
4676 replacing
, frame_window_p
);
4680 /* If some text in a string is replaced, `position' no
4681 longer points to the position of `object'. */
4682 if (!it
|| STRINGP (object
))
4688 replacing
= handle_single_display_spec (it
, spec
, object
, overlay
, position
,
4689 bufpos
, 0, frame_window_p
);
4693 /* Value is the position of the end of the `display' property starting
4694 at START_POS in OBJECT. */
4696 static struct text_pos
4697 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4700 struct text_pos end_pos
;
4702 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4703 Qdisplay
, object
, Qnil
);
4704 CHARPOS (end_pos
) = XFASTINT (end
);
4705 if (STRINGP (object
))
4706 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4708 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4714 /* Set up IT from a single `display' property specification SPEC. OBJECT
4715 is the object in which the `display' property was found. *POSITION
4716 is the position in OBJECT at which the `display' property was found.
4717 BUFPOS is the buffer position of OBJECT (different from POSITION if
4718 OBJECT is not a buffer). DISPLAY_REPLACED non-zero means that we
4719 previously saw a display specification which already replaced text
4720 display with something else, for example an image; we ignore such
4721 properties after the first one has been processed.
4723 OVERLAY is the overlay this `display' property came from,
4724 or nil if it was a text property.
4726 If SPEC is a `space' or `image' specification, and in some other
4727 cases too, set *POSITION to the position where the `display'
4730 If IT is NULL, only examine the property specification in SPEC, but
4731 don't set up IT. In that case, FRAME_WINDOW_P means SPEC
4732 is intended to be displayed in a window on a GUI frame.
4734 Value is non-zero if something was found which replaces the display
4735 of buffer or string text. */
4738 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4739 Lisp_Object overlay
, struct text_pos
*position
,
4740 ptrdiff_t bufpos
, int display_replaced
,
4741 bool frame_window_p
)
4744 Lisp_Object location
, value
;
4745 struct text_pos start_pos
= *position
;
4747 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4748 If the result is non-nil, use VALUE instead of SPEC. */
4750 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4759 if (!NILP (form
) && !EQ (form
, Qt
))
4761 ptrdiff_t count
= SPECPDL_INDEX ();
4763 /* Bind `object' to the object having the `display' property, a
4764 buffer or string. Bind `position' to the position in the
4765 object where the property was found, and `buffer-position'
4766 to the current position in the buffer. */
4769 XSETBUFFER (object
, current_buffer
);
4770 specbind (Qobject
, object
);
4771 specbind (Qposition
, make_number (CHARPOS (*position
)));
4772 specbind (Qbuffer_position
, make_number (bufpos
));
4773 form
= safe_eval (form
);
4774 unbind_to (count
, Qnil
);
4780 /* Handle `(height HEIGHT)' specifications. */
4782 && EQ (XCAR (spec
), Qheight
)
4783 && CONSP (XCDR (spec
)))
4787 if (!FRAME_WINDOW_P (it
->f
))
4790 it
->font_height
= XCAR (XCDR (spec
));
4791 if (!NILP (it
->font_height
))
4793 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4794 int new_height
= -1;
4796 if (CONSP (it
->font_height
)
4797 && (EQ (XCAR (it
->font_height
), Qplus
)
4798 || EQ (XCAR (it
->font_height
), Qminus
))
4799 && CONSP (XCDR (it
->font_height
))
4800 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4802 /* `(+ N)' or `(- N)' where N is an integer. */
4803 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4804 if (EQ (XCAR (it
->font_height
), Qplus
))
4806 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4808 else if (FUNCTIONP (it
->font_height
))
4810 /* Call function with current height as argument.
4811 Value is the new height. */
4813 height
= safe_call1 (it
->font_height
,
4814 face
->lface
[LFACE_HEIGHT_INDEX
]);
4815 if (NUMBERP (height
))
4816 new_height
= XFLOATINT (height
);
4818 else if (NUMBERP (it
->font_height
))
4820 /* Value is a multiple of the canonical char height. */
4823 f
= FACE_FROM_ID (it
->f
,
4824 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4825 new_height
= (XFLOATINT (it
->font_height
)
4826 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4830 /* Evaluate IT->font_height with `height' bound to the
4831 current specified height to get the new height. */
4832 ptrdiff_t count
= SPECPDL_INDEX ();
4834 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4835 value
= safe_eval (it
->font_height
);
4836 unbind_to (count
, Qnil
);
4838 if (NUMBERP (value
))
4839 new_height
= XFLOATINT (value
);
4843 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4850 /* Handle `(space-width WIDTH)'. */
4852 && EQ (XCAR (spec
), Qspace_width
)
4853 && CONSP (XCDR (spec
)))
4857 if (!FRAME_WINDOW_P (it
->f
))
4860 value
= XCAR (XCDR (spec
));
4861 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4862 it
->space_width
= value
;
4868 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4870 && EQ (XCAR (spec
), Qslice
))
4876 if (!FRAME_WINDOW_P (it
->f
))
4879 if (tem
= XCDR (spec
), CONSP (tem
))
4881 it
->slice
.x
= XCAR (tem
);
4882 if (tem
= XCDR (tem
), CONSP (tem
))
4884 it
->slice
.y
= XCAR (tem
);
4885 if (tem
= XCDR (tem
), CONSP (tem
))
4887 it
->slice
.width
= XCAR (tem
);
4888 if (tem
= XCDR (tem
), CONSP (tem
))
4889 it
->slice
.height
= XCAR (tem
);
4898 /* Handle `(raise FACTOR)'. */
4900 && EQ (XCAR (spec
), Qraise
)
4901 && CONSP (XCDR (spec
)))
4905 if (!FRAME_WINDOW_P (it
->f
))
4908 #ifdef HAVE_WINDOW_SYSTEM
4909 value
= XCAR (XCDR (spec
));
4910 if (NUMBERP (value
))
4912 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4913 it
->voffset
= - (XFLOATINT (value
)
4914 * (normal_char_height (face
->font
, -1)));
4916 #endif /* HAVE_WINDOW_SYSTEM */
4922 /* Don't handle the other kinds of display specifications
4923 inside a string that we got from a `display' property. */
4924 if (it
&& it
->string_from_display_prop_p
)
4927 /* Characters having this form of property are not displayed, so
4928 we have to find the end of the property. */
4931 start_pos
= *position
;
4932 *position
= display_prop_end (it
, object
, start_pos
);
4933 /* If the display property comes from an overlay, don't consider
4934 any potential stop_charpos values before the end of that
4935 overlay. Since display_prop_end will happily find another
4936 'display' property coming from some other overlay or text
4937 property on buffer positions before this overlay's end, we
4938 need to ignore them, or else we risk displaying this
4939 overlay's display string/image twice. */
4940 if (!NILP (overlay
))
4942 ptrdiff_t ovendpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4944 if (ovendpos
> CHARPOS (*position
))
4945 SET_TEXT_POS (*position
, ovendpos
, CHAR_TO_BYTE (ovendpos
));
4950 /* Stop the scan at that end position--we assume that all
4951 text properties change there. */
4953 it
->stop_charpos
= position
->charpos
;
4955 /* Handle `(left-fringe BITMAP [FACE])'
4956 and `(right-fringe BITMAP [FACE])'. */
4958 && (EQ (XCAR (spec
), Qleft_fringe
)
4959 || EQ (XCAR (spec
), Qright_fringe
))
4960 && CONSP (XCDR (spec
)))
4966 if (!FRAME_WINDOW_P (it
->f
))
4967 /* If we return here, POSITION has been advanced
4968 across the text with this property. */
4970 /* Synchronize the bidi iterator with POSITION. This is
4971 needed because we are not going to push the iterator
4972 on behalf of this display property, so there will be
4973 no pop_it call to do this synchronization for us. */
4976 it
->position
= *position
;
4977 iterate_out_of_display_property (it
);
4978 *position
= it
->position
;
4983 else if (!frame_window_p
)
4986 #ifdef HAVE_WINDOW_SYSTEM
4987 value
= XCAR (XCDR (spec
));
4988 if (!SYMBOLP (value
)
4989 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4990 /* If we return here, POSITION has been advanced
4991 across the text with this property. */
4993 if (it
&& it
->bidi_p
)
4995 it
->position
= *position
;
4996 iterate_out_of_display_property (it
);
4997 *position
= it
->position
;
5004 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
5006 if (CONSP (XCDR (XCDR (spec
))))
5008 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
5009 int face_id2
= lookup_derived_face (it
->f
, face_name
,
5010 FRINGE_FACE_ID
, false);
5015 /* Save current settings of IT so that we can restore them
5016 when we are finished with the glyph property value. */
5017 push_it (it
, position
);
5019 it
->area
= TEXT_AREA
;
5020 it
->what
= IT_IMAGE
;
5021 it
->image_id
= -1; /* no image */
5022 it
->position
= start_pos
;
5023 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5024 it
->method
= GET_FROM_IMAGE
;
5025 it
->from_overlay
= Qnil
;
5026 it
->face_id
= face_id
;
5027 it
->from_disp_prop_p
= true;
5029 /* Say that we haven't consumed the characters with
5030 `display' property yet. The call to pop_it in
5031 set_iterator_to_next will clean this up. */
5032 *position
= start_pos
;
5034 if (EQ (XCAR (spec
), Qleft_fringe
))
5036 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5037 it
->left_user_fringe_face_id
= face_id
;
5041 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5042 it
->right_user_fringe_face_id
= face_id
;
5045 #endif /* HAVE_WINDOW_SYSTEM */
5049 /* Prepare to handle `((margin left-margin) ...)',
5050 `((margin right-margin) ...)' and `((margin nil) ...)'
5051 prefixes for display specifications. */
5052 location
= Qunbound
;
5053 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5057 value
= XCDR (spec
);
5059 value
= XCAR (value
);
5062 if (EQ (XCAR (tem
), Qmargin
)
5063 && (tem
= XCDR (tem
),
5064 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5066 || EQ (tem
, Qleft_margin
)
5067 || EQ (tem
, Qright_margin
))))
5071 if (EQ (location
, Qunbound
))
5077 /* After this point, VALUE is the property after any
5078 margin prefix has been stripped. It must be a string,
5079 an image specification, or `(space ...)'.
5081 LOCATION specifies where to display: `left-margin',
5082 `right-margin' or nil. */
5084 bool valid_p
= (STRINGP (value
)
5085 #ifdef HAVE_WINDOW_SYSTEM
5086 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5087 && valid_image_p (value
))
5088 #endif /* not HAVE_WINDOW_SYSTEM */
5089 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
5091 if (valid_p
&& display_replaced
== 0)
5097 /* Callers need to know whether the display spec is any kind
5098 of `(space ...)' spec that is about to affect text-area
5100 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5105 /* Save current settings of IT so that we can restore them
5106 when we are finished with the glyph property value. */
5107 push_it (it
, position
);
5108 it
->from_overlay
= overlay
;
5109 it
->from_disp_prop_p
= true;
5111 if (NILP (location
))
5112 it
->area
= TEXT_AREA
;
5113 else if (EQ (location
, Qleft_margin
))
5114 it
->area
= LEFT_MARGIN_AREA
;
5116 it
->area
= RIGHT_MARGIN_AREA
;
5118 if (STRINGP (value
))
5121 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5122 it
->current
.overlay_string_index
= -1;
5123 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5124 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5125 it
->method
= GET_FROM_STRING
;
5126 it
->stop_charpos
= 0;
5128 it
->base_level_stop
= 0;
5129 it
->string_from_display_prop_p
= true;
5130 /* Say that we haven't consumed the characters with
5131 `display' property yet. The call to pop_it in
5132 set_iterator_to_next will clean this up. */
5133 if (BUFFERP (object
))
5134 *position
= start_pos
;
5136 /* Force paragraph direction to be that of the parent
5137 object. If the parent object's paragraph direction is
5138 not yet determined, default to L2R. */
5139 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5140 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5142 it
->paragraph_embedding
= L2R
;
5144 /* Set up the bidi iterator for this display string. */
5147 it
->bidi_it
.string
.lstring
= it
->string
;
5148 it
->bidi_it
.string
.s
= NULL
;
5149 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5150 it
->bidi_it
.string
.bufpos
= bufpos
;
5151 it
->bidi_it
.string
.from_disp_str
= true;
5152 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5153 it
->bidi_it
.w
= it
->w
;
5154 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5157 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5159 it
->method
= GET_FROM_STRETCH
;
5161 *position
= it
->position
= start_pos
;
5162 retval
= 1 + (it
->area
== TEXT_AREA
);
5164 #ifdef HAVE_WINDOW_SYSTEM
5167 it
->what
= IT_IMAGE
;
5168 it
->image_id
= lookup_image (it
->f
, value
);
5169 it
->position
= start_pos
;
5170 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5171 it
->method
= GET_FROM_IMAGE
;
5173 /* Say that we haven't consumed the characters with
5174 `display' property yet. The call to pop_it in
5175 set_iterator_to_next will clean this up. */
5176 *position
= start_pos
;
5178 #endif /* HAVE_WINDOW_SYSTEM */
5183 /* Invalid property or property not supported. Restore
5184 POSITION to what it was before. */
5185 *position
= start_pos
;
5189 /* Check if PROP is a display property value whose text should be
5190 treated as intangible. OVERLAY is the overlay from which PROP
5191 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5192 specify the buffer position covered by PROP. */
5195 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5196 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5198 bool frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5199 struct text_pos position
;
5201 SET_TEXT_POS (position
, charpos
, bytepos
);
5202 return (handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5203 &position
, charpos
, frame_window_p
)
5208 /* Return true if PROP is a display sub-property value containing STRING.
5210 Implementation note: this and the following function are really
5211 special cases of handle_display_spec and
5212 handle_single_display_spec, and should ideally use the same code.
5213 Until they do, these two pairs must be consistent and must be
5214 modified in sync. */
5217 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5219 if (EQ (string
, prop
))
5222 /* Skip over `when FORM'. */
5223 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5228 /* Actually, the condition following `when' should be eval'ed,
5229 like handle_single_display_spec does, and we should return
5230 false if it evaluates to nil. However, this function is
5231 called only when the buffer was already displayed and some
5232 glyph in the glyph matrix was found to come from a display
5233 string. Therefore, the condition was already evaluated, and
5234 the result was non-nil, otherwise the display string wouldn't
5235 have been displayed and we would have never been called for
5236 this property. Thus, we can skip the evaluation and assume
5237 its result is non-nil. */
5242 /* Skip over `margin LOCATION'. */
5243 if (EQ (XCAR (prop
), Qmargin
))
5254 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5258 /* Return true if STRING appears in the `display' property PROP. */
5261 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5264 && !EQ (XCAR (prop
), Qwhen
)
5265 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5267 /* A list of sub-properties. */
5268 while (CONSP (prop
))
5270 if (single_display_spec_string_p (XCAR (prop
), string
))
5275 else if (VECTORP (prop
))
5277 /* A vector of sub-properties. */
5279 for (i
= 0; i
< ASIZE (prop
); ++i
)
5280 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5284 return single_display_spec_string_p (prop
, string
);
5289 /* Look for STRING in overlays and text properties in the current
5290 buffer, between character positions FROM and TO (excluding TO).
5291 BACK_P means look back (in this case, TO is supposed to be
5293 Value is the first character position where STRING was found, or
5294 zero if it wasn't found before hitting TO.
5296 This function may only use code that doesn't eval because it is
5297 called asynchronously from note_mouse_highlight. */
5300 string_buffer_position_lim (Lisp_Object string
,
5301 ptrdiff_t from
, ptrdiff_t to
, bool back_p
)
5303 Lisp_Object limit
, prop
, pos
;
5306 pos
= make_number (max (from
, BEGV
));
5308 if (!back_p
) /* looking forward */
5310 limit
= make_number (min (to
, ZV
));
5311 while (!found
&& !EQ (pos
, limit
))
5313 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5314 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5317 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5321 else /* looking back */
5323 limit
= make_number (max (to
, BEGV
));
5324 while (!found
&& !EQ (pos
, limit
))
5326 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5327 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5330 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5335 return found
? XINT (pos
) : 0;
5338 /* Determine which buffer position in current buffer STRING comes from.
5339 AROUND_CHARPOS is an approximate position where it could come from.
5340 Value is the buffer position or 0 if it couldn't be determined.
5342 This function is necessary because we don't record buffer positions
5343 in glyphs generated from strings (to keep struct glyph small).
5344 This function may only use code that doesn't eval because it is
5345 called asynchronously from note_mouse_highlight. */
5348 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5350 const int MAX_DISTANCE
= 1000;
5351 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5352 around_charpos
+ MAX_DISTANCE
,
5356 found
= string_buffer_position_lim (string
, around_charpos
,
5357 around_charpos
- MAX_DISTANCE
, true);
5363 /***********************************************************************
5364 `composition' property
5365 ***********************************************************************/
5367 /* Set up iterator IT from `composition' property at its current
5368 position. Called from handle_stop. */
5370 static enum prop_handled
5371 handle_composition_prop (struct it
*it
)
5373 Lisp_Object prop
, string
;
5374 ptrdiff_t pos
, pos_byte
, start
, end
;
5376 if (STRINGP (it
->string
))
5380 pos
= IT_STRING_CHARPOS (*it
);
5381 pos_byte
= IT_STRING_BYTEPOS (*it
);
5382 string
= it
->string
;
5383 s
= SDATA (string
) + pos_byte
;
5384 it
->c
= STRING_CHAR (s
);
5388 pos
= IT_CHARPOS (*it
);
5389 pos_byte
= IT_BYTEPOS (*it
);
5391 it
->c
= FETCH_CHAR (pos_byte
);
5394 /* If there's a valid composition and point is not inside of the
5395 composition (in the case that the composition is from the current
5396 buffer), draw a glyph composed from the composition components. */
5397 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5398 && composition_valid_p (start
, end
, prop
)
5399 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5402 /* As we can't handle this situation (perhaps font-lock added
5403 a new composition), we just return here hoping that next
5404 redisplay will detect this composition much earlier. */
5405 return HANDLED_NORMALLY
;
5408 if (STRINGP (it
->string
))
5409 pos_byte
= string_char_to_byte (it
->string
, start
);
5411 pos_byte
= CHAR_TO_BYTE (start
);
5413 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5416 if (it
->cmp_it
.id
>= 0)
5419 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5420 it
->cmp_it
.nglyphs
= -1;
5424 return HANDLED_NORMALLY
;
5429 /***********************************************************************
5431 ***********************************************************************/
5433 /* The following structure is used to record overlay strings for
5434 later sorting in load_overlay_strings. */
5436 struct overlay_entry
5438 Lisp_Object overlay
;
5441 bool after_string_p
;
5445 /* Set up iterator IT from overlay strings at its current position.
5446 Called from handle_stop. */
5448 static enum prop_handled
5449 handle_overlay_change (struct it
*it
)
5451 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5452 return HANDLED_RECOMPUTE_PROPS
;
5454 return HANDLED_NORMALLY
;
5458 /* Set up the next overlay string for delivery by IT, if there is an
5459 overlay string to deliver. Called by set_iterator_to_next when the
5460 end of the current overlay string is reached. If there are more
5461 overlay strings to display, IT->string and
5462 IT->current.overlay_string_index are set appropriately here.
5463 Otherwise IT->string is set to nil. */
5466 next_overlay_string (struct it
*it
)
5468 ++it
->current
.overlay_string_index
;
5469 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5471 /* No more overlay strings. Restore IT's settings to what
5472 they were before overlay strings were processed, and
5473 continue to deliver from current_buffer. */
5475 it
->ellipsis_p
= it
->stack
[it
->sp
- 1].display_ellipsis_p
;
5478 || (NILP (it
->string
)
5479 && it
->method
== GET_FROM_BUFFER
5480 && it
->stop_charpos
>= BEGV
5481 && it
->stop_charpos
<= it
->end_charpos
));
5482 it
->current
.overlay_string_index
= -1;
5483 it
->n_overlay_strings
= 0;
5484 /* If there's an empty display string on the stack, pop the
5485 stack, to resync the bidi iterator with IT's position. Such
5486 empty strings are pushed onto the stack in
5487 get_overlay_strings_1. */
5488 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5491 /* Since we've exhausted overlay strings at this buffer
5492 position, set the flag to ignore overlays until we move to
5493 another position. The flag is reset in
5494 next_element_from_buffer. */
5495 it
->ignore_overlay_strings_at_pos_p
= true;
5497 /* If we're at the end of the buffer, record that we have
5498 processed the overlay strings there already, so that
5499 next_element_from_buffer doesn't try it again. */
5500 if (NILP (it
->string
)
5501 && IT_CHARPOS (*it
) >= it
->end_charpos
5502 && it
->overlay_strings_charpos
>= it
->end_charpos
)
5503 it
->overlay_strings_at_end_processed_p
= true;
5504 /* Note: we reset overlay_strings_charpos only here, to make
5505 sure the just-processed overlays were indeed at EOB.
5506 Otherwise, overlays on text with invisible text property,
5507 which are processed with IT's position past the invisible
5508 text, might fool us into thinking the overlays at EOB were
5509 already processed (linum-mode can cause this, for
5511 it
->overlay_strings_charpos
= -1;
5515 /* There are more overlay strings to process. If
5516 IT->current.overlay_string_index has advanced to a position
5517 where we must load IT->overlay_strings with more strings, do
5518 it. We must load at the IT->overlay_strings_charpos where
5519 IT->n_overlay_strings was originally computed; when invisible
5520 text is present, this might not be IT_CHARPOS (Bug#7016). */
5521 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5523 if (it
->current
.overlay_string_index
&& i
== 0)
5524 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5526 /* Initialize IT to deliver display elements from the overlay
5528 it
->string
= it
->overlay_strings
[i
];
5529 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5530 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5531 it
->method
= GET_FROM_STRING
;
5532 it
->stop_charpos
= 0;
5533 it
->end_charpos
= SCHARS (it
->string
);
5534 if (it
->cmp_it
.stop_pos
>= 0)
5535 it
->cmp_it
.stop_pos
= 0;
5537 it
->base_level_stop
= 0;
5539 /* Set up the bidi iterator for this overlay string. */
5542 it
->bidi_it
.string
.lstring
= it
->string
;
5543 it
->bidi_it
.string
.s
= NULL
;
5544 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5545 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5546 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5547 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5548 it
->bidi_it
.w
= it
->w
;
5549 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5557 /* Compare two overlay_entry structures E1 and E2. Used as a
5558 comparison function for qsort in load_overlay_strings. Overlay
5559 strings for the same position are sorted so that
5561 1. All after-strings come in front of before-strings, except
5562 when they come from the same overlay.
5564 2. Within after-strings, strings are sorted so that overlay strings
5565 from overlays with higher priorities come first.
5567 2. Within before-strings, strings are sorted so that overlay
5568 strings from overlays with higher priorities come last.
5570 Value is analogous to strcmp. */
5574 compare_overlay_entries (const void *e1
, const void *e2
)
5576 struct overlay_entry
const *entry1
= e1
;
5577 struct overlay_entry
const *entry2
= e2
;
5580 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5582 /* Let after-strings appear in front of before-strings if
5583 they come from different overlays. */
5584 if (EQ (entry1
->overlay
, entry2
->overlay
))
5585 result
= entry1
->after_string_p
? 1 : -1;
5587 result
= entry1
->after_string_p
? -1 : 1;
5589 else if (entry1
->priority
!= entry2
->priority
)
5591 if (entry1
->after_string_p
)
5592 /* After-strings sorted in order of decreasing priority. */
5593 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5595 /* Before-strings sorted in order of increasing priority. */
5596 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5605 /* Load the vector IT->overlay_strings with overlay strings from IT's
5606 current buffer position, or from CHARPOS if that is > 0. Set
5607 IT->n_overlays to the total number of overlay strings found.
5609 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5610 a time. On entry into load_overlay_strings,
5611 IT->current.overlay_string_index gives the number of overlay
5612 strings that have already been loaded by previous calls to this
5615 IT->add_overlay_start contains an additional overlay start
5616 position to consider for taking overlay strings from, if non-zero.
5617 This position comes into play when the overlay has an `invisible'
5618 property, and both before and after-strings. When we've skipped to
5619 the end of the overlay, because of its `invisible' property, we
5620 nevertheless want its before-string to appear.
5621 IT->add_overlay_start will contain the overlay start position
5624 Overlay strings are sorted so that after-string strings come in
5625 front of before-string strings. Within before and after-strings,
5626 strings are sorted by overlay priority. See also function
5627 compare_overlay_entries. */
5630 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5632 Lisp_Object overlay
, window
, str
, invisible
;
5633 struct Lisp_Overlay
*ov
;
5634 ptrdiff_t start
, end
;
5635 ptrdiff_t n
= 0, i
, j
;
5637 struct overlay_entry entriesbuf
[20];
5638 ptrdiff_t size
= ARRAYELTS (entriesbuf
);
5639 struct overlay_entry
*entries
= entriesbuf
;
5643 charpos
= IT_CHARPOS (*it
);
5645 /* Append the overlay string STRING of overlay OVERLAY to vector
5646 `entries' which has size `size' and currently contains `n'
5647 elements. AFTER_P means STRING is an after-string of
5649 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5652 Lisp_Object priority; \
5656 struct overlay_entry *old = entries; \
5657 SAFE_NALLOCA (entries, 2, size); \
5658 memcpy (entries, old, size * sizeof *entries); \
5662 entries[n].string = (STRING); \
5663 entries[n].overlay = (OVERLAY); \
5664 priority = Foverlay_get ((OVERLAY), Qpriority); \
5665 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5666 entries[n].after_string_p = (AFTER_P); \
5671 /* Process overlay before the overlay center. */
5672 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5674 XSETMISC (overlay
, ov
);
5675 eassert (OVERLAYP (overlay
));
5676 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5677 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5682 /* Skip this overlay if it doesn't start or end at IT's current
5684 if (end
!= charpos
&& start
!= charpos
)
5687 /* Skip this overlay if it doesn't apply to IT->w. */
5688 window
= Foverlay_get (overlay
, Qwindow
);
5689 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5692 /* If the text ``under'' the overlay is invisible, both before-
5693 and after-strings from this overlay are visible; start and
5694 end position are indistinguishable. */
5695 invisible
= Foverlay_get (overlay
, Qinvisible
);
5696 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5698 /* If overlay has a non-empty before-string, record it. */
5699 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5700 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5702 RECORD_OVERLAY_STRING (overlay
, str
, false);
5704 /* If overlay has a non-empty after-string, record it. */
5705 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5706 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5708 RECORD_OVERLAY_STRING (overlay
, str
, true);
5711 /* Process overlays after the overlay center. */
5712 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5714 XSETMISC (overlay
, ov
);
5715 eassert (OVERLAYP (overlay
));
5716 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5717 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5719 if (start
> charpos
)
5722 /* Skip this overlay if it doesn't start or end at IT's current
5724 if (end
!= charpos
&& start
!= charpos
)
5727 /* Skip this overlay if it doesn't apply to IT->w. */
5728 window
= Foverlay_get (overlay
, Qwindow
);
5729 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5732 /* If the text ``under'' the overlay is invisible, it has a zero
5733 dimension, and both before- and after-strings apply. */
5734 invisible
= Foverlay_get (overlay
, Qinvisible
);
5735 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5737 /* If overlay has a non-empty before-string, record it. */
5738 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5739 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5741 RECORD_OVERLAY_STRING (overlay
, str
, false);
5743 /* If overlay has a non-empty after-string, record it. */
5744 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5745 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5747 RECORD_OVERLAY_STRING (overlay
, str
, true);
5750 #undef RECORD_OVERLAY_STRING
5754 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5756 /* Record number of overlay strings, and where we computed it. */
5757 it
->n_overlay_strings
= n
;
5758 it
->overlay_strings_charpos
= charpos
;
5760 /* IT->current.overlay_string_index is the number of overlay strings
5761 that have already been consumed by IT. Copy some of the
5762 remaining overlay strings to IT->overlay_strings. */
5764 j
= it
->current
.overlay_string_index
;
5765 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5767 it
->overlay_strings
[i
] = entries
[j
].string
;
5768 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5776 /* Get the first chunk of overlay strings at IT's current buffer
5777 position, or at CHARPOS if that is > 0. Value is true if at
5778 least one overlay string was found. */
5781 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, bool compute_stop_p
)
5783 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5784 process. This fills IT->overlay_strings with strings, and sets
5785 IT->n_overlay_strings to the total number of strings to process.
5786 IT->pos.overlay_string_index has to be set temporarily to zero
5787 because load_overlay_strings needs this; it must be set to -1
5788 when no overlay strings are found because a zero value would
5789 indicate a position in the first overlay string. */
5790 it
->current
.overlay_string_index
= 0;
5791 load_overlay_strings (it
, charpos
);
5793 /* If we found overlay strings, set up IT to deliver display
5794 elements from the first one. Otherwise set up IT to deliver
5795 from current_buffer. */
5796 if (it
->n_overlay_strings
)
5798 /* Make sure we know settings in current_buffer, so that we can
5799 restore meaningful values when we're done with the overlay
5802 compute_stop_pos (it
);
5803 eassert (it
->face_id
>= 0);
5805 /* Save IT's settings. They are restored after all overlay
5806 strings have been processed. */
5807 eassert (!compute_stop_p
|| it
->sp
== 0);
5809 /* When called from handle_stop, there might be an empty display
5810 string loaded. In that case, don't bother saving it. But
5811 don't use this optimization with the bidi iterator, since we
5812 need the corresponding pop_it call to resync the bidi
5813 iterator's position with IT's position, after we are done
5814 with the overlay strings. (The corresponding call to pop_it
5815 in case of an empty display string is in
5816 next_overlay_string.) */
5818 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5821 /* Set up IT to deliver display elements from the first overlay
5823 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5824 it
->string
= it
->overlay_strings
[0];
5825 it
->from_overlay
= Qnil
;
5826 it
->stop_charpos
= 0;
5827 eassert (STRINGP (it
->string
));
5828 it
->end_charpos
= SCHARS (it
->string
);
5830 it
->base_level_stop
= 0;
5831 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5832 it
->method
= GET_FROM_STRING
;
5833 it
->from_disp_prop_p
= 0;
5835 /* Force paragraph direction to be that of the parent
5837 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5838 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5840 it
->paragraph_embedding
= L2R
;
5842 /* Set up the bidi iterator for this overlay string. */
5845 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5847 it
->bidi_it
.string
.lstring
= it
->string
;
5848 it
->bidi_it
.string
.s
= NULL
;
5849 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5850 it
->bidi_it
.string
.bufpos
= pos
;
5851 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5852 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5853 it
->bidi_it
.w
= it
->w
;
5854 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5859 it
->current
.overlay_string_index
= -1;
5864 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5867 it
->method
= GET_FROM_BUFFER
;
5869 get_overlay_strings_1 (it
, charpos
, true);
5873 /* Value is true if we found at least one overlay string. */
5874 return STRINGP (it
->string
);
5879 /***********************************************************************
5880 Saving and restoring state
5881 ***********************************************************************/
5883 /* Save current settings of IT on IT->stack. Called, for example,
5884 before setting up IT for an overlay string, to be able to restore
5885 IT's settings to what they were after the overlay string has been
5886 processed. If POSITION is non-NULL, it is the position to save on
5887 the stack instead of IT->position. */
5890 push_it (struct it
*it
, struct text_pos
*position
)
5892 struct iterator_stack_entry
*p
;
5894 eassert (it
->sp
< IT_STACK_SIZE
);
5895 p
= it
->stack
+ it
->sp
;
5897 p
->stop_charpos
= it
->stop_charpos
;
5898 p
->prev_stop
= it
->prev_stop
;
5899 p
->base_level_stop
= it
->base_level_stop
;
5900 p
->cmp_it
= it
->cmp_it
;
5901 eassert (it
->face_id
>= 0);
5902 p
->face_id
= it
->face_id
;
5903 p
->string
= it
->string
;
5904 p
->method
= it
->method
;
5905 p
->from_overlay
= it
->from_overlay
;
5908 case GET_FROM_IMAGE
:
5909 p
->u
.image
.object
= it
->object
;
5910 p
->u
.image
.image_id
= it
->image_id
;
5911 p
->u
.image
.slice
= it
->slice
;
5913 case GET_FROM_STRETCH
:
5914 p
->u
.stretch
.object
= it
->object
;
5916 case GET_FROM_BUFFER
:
5917 case GET_FROM_DISPLAY_VECTOR
:
5918 case GET_FROM_STRING
:
5919 case GET_FROM_C_STRING
:
5924 p
->position
= position
? *position
: it
->position
;
5925 p
->current
= it
->current
;
5926 p
->end_charpos
= it
->end_charpos
;
5927 p
->string_nchars
= it
->string_nchars
;
5929 p
->multibyte_p
= it
->multibyte_p
;
5930 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5931 p
->space_width
= it
->space_width
;
5932 p
->font_height
= it
->font_height
;
5933 p
->voffset
= it
->voffset
;
5934 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5935 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5936 p
->display_ellipsis_p
= false;
5937 p
->line_wrap
= it
->line_wrap
;
5938 p
->bidi_p
= it
->bidi_p
;
5939 p
->paragraph_embedding
= it
->paragraph_embedding
;
5940 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5943 /* Save the state of the bidi iterator as well. */
5945 bidi_push_it (&it
->bidi_it
);
5949 iterate_out_of_display_property (struct it
*it
)
5951 bool buffer_p
= !STRINGP (it
->string
);
5952 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
5953 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
5955 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5957 /* Maybe initialize paragraph direction. If we are at the beginning
5958 of a new paragraph, next_element_from_buffer may not have a
5959 chance to do that. */
5960 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5961 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
5962 /* prev_stop can be zero, so check against BEGV as well. */
5963 while (it
->bidi_it
.charpos
>= bob
5964 && it
->prev_stop
<= it
->bidi_it
.charpos
5965 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5966 && it
->bidi_it
.charpos
< eob
)
5967 bidi_move_to_visually_next (&it
->bidi_it
);
5968 /* Record the stop_pos we just crossed, for when we cross it
5970 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5971 it
->prev_stop
= CHARPOS (it
->position
);
5972 /* If we ended up not where pop_it put us, resync IT's
5973 positional members with the bidi iterator. */
5974 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5975 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5977 it
->current
.pos
= it
->position
;
5979 it
->current
.string_pos
= it
->position
;
5982 /* Restore IT's settings from IT->stack. Called, for example, when no
5983 more overlay strings must be processed, and we return to delivering
5984 display elements from a buffer, or when the end of a string from a
5985 `display' property is reached and we return to delivering display
5986 elements from an overlay string, or from a buffer. */
5989 pop_it (struct it
*it
)
5991 struct iterator_stack_entry
*p
;
5992 bool from_display_prop
= it
->from_disp_prop_p
;
5993 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
5995 eassert (it
->sp
> 0);
5997 p
= it
->stack
+ it
->sp
;
5998 it
->stop_charpos
= p
->stop_charpos
;
5999 it
->prev_stop
= p
->prev_stop
;
6000 it
->base_level_stop
= p
->base_level_stop
;
6001 it
->cmp_it
= p
->cmp_it
;
6002 it
->face_id
= p
->face_id
;
6003 it
->current
= p
->current
;
6004 it
->position
= p
->position
;
6005 it
->string
= p
->string
;
6006 it
->from_overlay
= p
->from_overlay
;
6007 if (NILP (it
->string
))
6008 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
6009 it
->method
= p
->method
;
6012 case GET_FROM_IMAGE
:
6013 it
->image_id
= p
->u
.image
.image_id
;
6014 it
->object
= p
->u
.image
.object
;
6015 it
->slice
= p
->u
.image
.slice
;
6017 case GET_FROM_STRETCH
:
6018 it
->object
= p
->u
.stretch
.object
;
6020 case GET_FROM_BUFFER
:
6021 it
->object
= it
->w
->contents
;
6023 case GET_FROM_STRING
:
6025 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6027 /* Restore the face_box_p flag, since it could have been
6028 overwritten by the face of the object that we just finished
6031 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6032 it
->object
= it
->string
;
6035 case GET_FROM_DISPLAY_VECTOR
:
6037 it
->method
= GET_FROM_C_STRING
;
6038 else if (STRINGP (it
->string
))
6039 it
->method
= GET_FROM_STRING
;
6042 it
->method
= GET_FROM_BUFFER
;
6043 it
->object
= it
->w
->contents
;
6046 case GET_FROM_C_STRING
:
6051 it
->end_charpos
= p
->end_charpos
;
6052 it
->string_nchars
= p
->string_nchars
;
6054 it
->multibyte_p
= p
->multibyte_p
;
6055 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6056 it
->space_width
= p
->space_width
;
6057 it
->font_height
= p
->font_height
;
6058 it
->voffset
= p
->voffset
;
6059 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6060 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6061 it
->line_wrap
= p
->line_wrap
;
6062 it
->bidi_p
= p
->bidi_p
;
6063 it
->paragraph_embedding
= p
->paragraph_embedding
;
6064 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6067 bidi_pop_it (&it
->bidi_it
);
6068 /* Bidi-iterate until we get out of the portion of text, if any,
6069 covered by a `display' text property or by an overlay with
6070 `display' property. (We cannot just jump there, because the
6071 internal coherency of the bidi iterator state can not be
6072 preserved across such jumps.) We also must determine the
6073 paragraph base direction if the overlay we just processed is
6074 at the beginning of a new paragraph. */
6075 if (from_display_prop
6076 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6077 iterate_out_of_display_property (it
);
6079 eassert ((BUFFERP (it
->object
)
6080 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6081 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6082 || (STRINGP (it
->object
)
6083 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6084 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6085 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6087 /* If we move the iterator over text covered by a display property
6088 to a new buffer position, any info about previously seen overlays
6089 is no longer valid. */
6090 if (from_display_prop
&& it
->sp
== 0 && CHARPOS (it
->position
) != prev_pos
)
6091 it
->ignore_overlay_strings_at_pos_p
= false;
6096 /***********************************************************************
6098 ***********************************************************************/
6100 /* Set IT's current position to the previous line start. */
6103 back_to_previous_line_start (struct it
*it
)
6105 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6108 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6112 /* Move IT to the next line start.
6114 Value is true if a newline was found. Set *SKIPPED_P to true if
6115 we skipped over part of the text (as opposed to moving the iterator
6116 continuously over the text). Otherwise, don't change the value
6119 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6120 iterator on the newline, if it was found.
6122 Newlines may come from buffer text, overlay strings, or strings
6123 displayed via the `display' property. That's the reason we can't
6124 simply use find_newline_no_quit.
6126 Note that this function may not skip over invisible text that is so
6127 because of text properties and immediately follows a newline. If
6128 it would, function reseat_at_next_visible_line_start, when called
6129 from set_iterator_to_next, would effectively make invisible
6130 characters following a newline part of the wrong glyph row, which
6131 leads to wrong cursor motion. */
6134 forward_to_next_line_start (struct it
*it
, bool *skipped_p
,
6135 struct bidi_it
*bidi_it_prev
)
6137 ptrdiff_t old_selective
;
6138 bool newline_found_p
= false;
6140 const int MAX_NEWLINE_DISTANCE
= 500;
6142 /* If already on a newline, just consume it to avoid unintended
6143 skipping over invisible text below. */
6144 if (it
->what
== IT_CHARACTER
6146 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6148 if (it
->bidi_p
&& bidi_it_prev
)
6149 *bidi_it_prev
= it
->bidi_it
;
6150 set_iterator_to_next (it
, false);
6155 /* Don't handle selective display in the following. It's (a)
6156 unnecessary because it's done by the caller, and (b) leads to an
6157 infinite recursion because next_element_from_ellipsis indirectly
6158 calls this function. */
6159 old_selective
= it
->selective
;
6162 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6163 from buffer text. */
6165 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6166 n
+= !STRINGP (it
->string
))
6168 if (!get_next_display_element (it
))
6170 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6171 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6172 *bidi_it_prev
= it
->bidi_it
;
6173 set_iterator_to_next (it
, false);
6176 /* If we didn't find a newline near enough, see if we can use a
6178 if (!newline_found_p
)
6180 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6181 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6185 eassert (!STRINGP (it
->string
));
6187 /* If there isn't any `display' property in sight, and no
6188 overlays, we can just use the position of the newline in
6190 if (it
->stop_charpos
>= limit
6191 || ((pos
= Fnext_single_property_change (make_number (start
),
6193 make_number (limit
)),
6195 && next_overlay_change (start
) == ZV
))
6199 IT_CHARPOS (*it
) = limit
;
6200 IT_BYTEPOS (*it
) = bytepos
;
6204 struct bidi_it bprev
;
6206 /* Help bidi.c avoid expensive searches for display
6207 properties and overlays, by telling it that there are
6208 none up to `limit'. */
6209 if (it
->bidi_it
.disp_pos
< limit
)
6211 it
->bidi_it
.disp_pos
= limit
;
6212 it
->bidi_it
.disp_prop
= 0;
6215 bprev
= it
->bidi_it
;
6216 bidi_move_to_visually_next (&it
->bidi_it
);
6217 } while (it
->bidi_it
.charpos
!= limit
);
6218 IT_CHARPOS (*it
) = limit
;
6219 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6221 *bidi_it_prev
= bprev
;
6223 *skipped_p
= newline_found_p
= true;
6227 while (get_next_display_element (it
)
6228 && !newline_found_p
)
6230 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6231 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6232 *bidi_it_prev
= it
->bidi_it
;
6233 set_iterator_to_next (it
, false);
6238 it
->selective
= old_selective
;
6239 return newline_found_p
;
6243 /* Set IT's current position to the previous visible line start. Skip
6244 invisible text that is so either due to text properties or due to
6245 selective display. Caution: this does not change IT->current_x and
6249 back_to_previous_visible_line_start (struct it
*it
)
6251 while (IT_CHARPOS (*it
) > BEGV
)
6253 back_to_previous_line_start (it
);
6255 if (IT_CHARPOS (*it
) <= BEGV
)
6258 /* If selective > 0, then lines indented more than its value are
6260 if (it
->selective
> 0
6261 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6265 /* Check the newline before point for invisibility. */
6268 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6269 Qinvisible
, it
->window
);
6270 if (TEXT_PROP_MEANS_INVISIBLE (prop
) != 0)
6274 if (IT_CHARPOS (*it
) <= BEGV
)
6279 void *it2data
= NULL
;
6282 Lisp_Object val
, overlay
;
6284 SAVE_IT (it2
, *it
, it2data
);
6286 /* If newline is part of a composition, continue from start of composition */
6287 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6288 && beg
< IT_CHARPOS (*it
))
6291 /* If newline is replaced by a display property, find start of overlay
6292 or interval and continue search from that point. */
6293 pos
= --IT_CHARPOS (it2
);
6296 bidi_unshelve_cache (NULL
, false);
6297 it2
.string_from_display_prop_p
= false;
6298 it2
.from_disp_prop_p
= false;
6299 if (handle_display_prop (&it2
) == HANDLED_RETURN
6300 && !NILP (val
= get_char_property_and_overlay
6301 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6302 && (OVERLAYP (overlay
)
6303 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6304 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6306 RESTORE_IT (it
, it
, it2data
);
6310 /* Newline is not replaced by anything -- so we are done. */
6311 RESTORE_IT (it
, it
, it2data
);
6317 IT_CHARPOS (*it
) = beg
;
6318 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6322 it
->continuation_lines_width
= 0;
6324 eassert (IT_CHARPOS (*it
) >= BEGV
);
6325 eassert (IT_CHARPOS (*it
) == BEGV
6326 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6331 /* Reseat iterator IT at the previous visible line start. Skip
6332 invisible text that is so either due to text properties or due to
6333 selective display. At the end, update IT's overlay information,
6334 face information etc. */
6337 reseat_at_previous_visible_line_start (struct it
*it
)
6339 back_to_previous_visible_line_start (it
);
6340 reseat (it
, it
->current
.pos
, true);
6345 /* Reseat iterator IT on the next visible line start in the current
6346 buffer. ON_NEWLINE_P means position IT on the newline
6347 preceding the line start. Skip over invisible text that is so
6348 because of selective display. Compute faces, overlays etc at the
6349 new position. Note that this function does not skip over text that
6350 is invisible because of text properties. */
6353 reseat_at_next_visible_line_start (struct it
*it
, bool on_newline_p
)
6355 bool skipped_p
= false;
6356 struct bidi_it bidi_it_prev
;
6357 bool newline_found_p
6358 = forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6360 /* Skip over lines that are invisible because they are indented
6361 more than the value of IT->selective. */
6362 if (it
->selective
> 0)
6363 while (IT_CHARPOS (*it
) < ZV
6364 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6367 eassert (IT_BYTEPOS (*it
) == BEGV
6368 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6370 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6373 /* Position on the newline if that's what's requested. */
6374 if (on_newline_p
&& newline_found_p
)
6376 if (STRINGP (it
->string
))
6378 if (IT_STRING_CHARPOS (*it
) > 0)
6382 --IT_STRING_CHARPOS (*it
);
6383 --IT_STRING_BYTEPOS (*it
);
6387 /* We need to restore the bidi iterator to the state
6388 it had on the newline, and resync the IT's
6389 position with that. */
6390 it
->bidi_it
= bidi_it_prev
;
6391 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6392 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6396 else if (IT_CHARPOS (*it
) > BEGV
)
6405 /* We need to restore the bidi iterator to the state it
6406 had on the newline and resync IT with that. */
6407 it
->bidi_it
= bidi_it_prev
;
6408 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6409 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6411 reseat (it
, it
->current
.pos
, false);
6415 reseat (it
, it
->current
.pos
, false);
6422 /***********************************************************************
6423 Changing an iterator's position
6424 ***********************************************************************/
6426 /* Change IT's current position to POS in current_buffer.
6427 If FORCE_P, always check for text properties at the new position.
6428 Otherwise, text properties are only looked up if POS >=
6429 IT->check_charpos of a property. */
6432 reseat (struct it
*it
, struct text_pos pos
, bool force_p
)
6434 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6436 reseat_1 (it
, pos
, false);
6438 /* Determine where to check text properties. Avoid doing it
6439 where possible because text property lookup is very expensive. */
6441 || CHARPOS (pos
) > it
->stop_charpos
6442 || CHARPOS (pos
) < original_pos
)
6446 /* For bidi iteration, we need to prime prev_stop and
6447 base_level_stop with our best estimations. */
6448 /* Implementation note: Of course, POS is not necessarily a
6449 stop position, so assigning prev_pos to it is a lie; we
6450 should have called compute_stop_backwards. However, if
6451 the current buffer does not include any R2L characters,
6452 that call would be a waste of cycles, because the
6453 iterator will never move back, and thus never cross this
6454 "fake" stop position. So we delay that backward search
6455 until the time we really need it, in next_element_from_buffer. */
6456 if (CHARPOS (pos
) != it
->prev_stop
)
6457 it
->prev_stop
= CHARPOS (pos
);
6458 if (CHARPOS (pos
) < it
->base_level_stop
)
6459 it
->base_level_stop
= 0; /* meaning it's unknown */
6465 it
->prev_stop
= it
->base_level_stop
= 0;
6474 /* Change IT's buffer position to POS. SET_STOP_P means set
6475 IT->stop_pos to POS, also. */
6478 reseat_1 (struct it
*it
, struct text_pos pos
, bool set_stop_p
)
6480 /* Don't call this function when scanning a C string. */
6481 eassert (it
->s
== NULL
);
6483 /* POS must be a reasonable value. */
6484 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6486 it
->current
.pos
= it
->position
= pos
;
6487 it
->end_charpos
= ZV
;
6489 it
->current
.dpvec_index
= -1;
6490 it
->current
.overlay_string_index
= -1;
6491 IT_STRING_CHARPOS (*it
) = -1;
6492 IT_STRING_BYTEPOS (*it
) = -1;
6494 it
->method
= GET_FROM_BUFFER
;
6495 it
->object
= it
->w
->contents
;
6496 it
->area
= TEXT_AREA
;
6497 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6499 it
->string_from_display_prop_p
= false;
6500 it
->string_from_prefix_prop_p
= false;
6502 it
->from_disp_prop_p
= false;
6503 it
->face_before_selective_p
= false;
6506 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6508 bidi_unshelve_cache (NULL
, false);
6509 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6510 it
->bidi_it
.string
.s
= NULL
;
6511 it
->bidi_it
.string
.lstring
= Qnil
;
6512 it
->bidi_it
.string
.bufpos
= 0;
6513 it
->bidi_it
.string
.from_disp_str
= false;
6514 it
->bidi_it
.string
.unibyte
= false;
6515 it
->bidi_it
.w
= it
->w
;
6520 it
->stop_charpos
= CHARPOS (pos
);
6521 it
->base_level_stop
= CHARPOS (pos
);
6523 /* This make the information stored in it->cmp_it invalidate. */
6528 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6529 If S is non-null, it is a C string to iterate over. Otherwise,
6530 STRING gives a Lisp string to iterate over.
6532 If PRECISION > 0, don't return more then PRECISION number of
6533 characters from the string.
6535 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6536 characters have been returned. FIELD_WIDTH < 0 means an infinite
6539 MULTIBYTE = 0 means disable processing of multibyte characters,
6540 MULTIBYTE > 0 means enable it,
6541 MULTIBYTE < 0 means use IT->multibyte_p.
6543 IT must be initialized via a prior call to init_iterator before
6544 calling this function. */
6547 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6548 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6551 /* No text property checks performed by default, but see below. */
6552 it
->stop_charpos
= -1;
6554 /* Set iterator position and end position. */
6555 memset (&it
->current
, 0, sizeof it
->current
);
6556 it
->current
.overlay_string_index
= -1;
6557 it
->current
.dpvec_index
= -1;
6558 eassert (charpos
>= 0);
6560 /* If STRING is specified, use its multibyteness, otherwise use the
6561 setting of MULTIBYTE, if specified. */
6563 it
->multibyte_p
= multibyte
> 0;
6565 /* Bidirectional reordering of strings is controlled by the default
6566 value of bidi-display-reordering. Don't try to reorder while
6567 loading loadup.el, as the necessary character property tables are
6568 not yet available. */
6571 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6575 eassert (STRINGP (string
));
6576 it
->string
= string
;
6578 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6579 it
->method
= GET_FROM_STRING
;
6580 it
->current
.string_pos
= string_pos (charpos
, string
);
6584 it
->bidi_it
.string
.lstring
= string
;
6585 it
->bidi_it
.string
.s
= NULL
;
6586 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6587 it
->bidi_it
.string
.bufpos
= 0;
6588 it
->bidi_it
.string
.from_disp_str
= false;
6589 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6590 it
->bidi_it
.w
= it
->w
;
6591 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6592 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6597 it
->s
= (const unsigned char *) s
;
6600 /* Note that we use IT->current.pos, not it->current.string_pos,
6601 for displaying C strings. */
6602 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6603 if (it
->multibyte_p
)
6605 it
->current
.pos
= c_string_pos (charpos
, s
, true);
6606 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, true);
6610 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6611 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6616 it
->bidi_it
.string
.lstring
= Qnil
;
6617 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6618 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6619 it
->bidi_it
.string
.bufpos
= 0;
6620 it
->bidi_it
.string
.from_disp_str
= false;
6621 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6622 it
->bidi_it
.w
= it
->w
;
6623 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6626 it
->method
= GET_FROM_C_STRING
;
6629 /* PRECISION > 0 means don't return more than PRECISION characters
6631 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6633 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6635 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6638 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6639 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6640 FIELD_WIDTH < 0 means infinite field width. This is useful for
6641 padding with `-' at the end of a mode line. */
6642 if (field_width
< 0)
6643 field_width
= INFINITY
;
6644 /* Implementation note: We deliberately don't enlarge
6645 it->bidi_it.string.schars here to fit it->end_charpos, because
6646 the bidi iterator cannot produce characters out of thin air. */
6647 if (field_width
> it
->end_charpos
- charpos
)
6648 it
->end_charpos
= charpos
+ field_width
;
6650 /* Use the standard display table for displaying strings. */
6651 if (DISP_TABLE_P (Vstandard_display_table
))
6652 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6654 it
->stop_charpos
= charpos
;
6655 it
->prev_stop
= charpos
;
6656 it
->base_level_stop
= 0;
6659 it
->bidi_it
.first_elt
= true;
6660 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6661 it
->bidi_it
.disp_pos
= -1;
6663 if (s
== NULL
&& it
->multibyte_p
)
6665 ptrdiff_t endpos
= SCHARS (it
->string
);
6666 if (endpos
> it
->end_charpos
)
6667 endpos
= it
->end_charpos
;
6668 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6676 /***********************************************************************
6678 ***********************************************************************/
6680 /* Map enum it_method value to corresponding next_element_from_* function. */
6682 typedef bool (*next_element_function
) (struct it
*);
6684 static next_element_function
const get_next_element
[NUM_IT_METHODS
] =
6686 next_element_from_buffer
,
6687 next_element_from_display_vector
,
6688 next_element_from_string
,
6689 next_element_from_c_string
,
6690 next_element_from_image
,
6691 next_element_from_stretch
6694 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6697 /* Return true iff a character at CHARPOS (and BYTEPOS) is composed
6698 (possibly with the following characters). */
6700 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6701 ((IT)->cmp_it.id >= 0 \
6702 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6703 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6704 END_CHARPOS, (IT)->w, \
6705 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6709 /* Lookup the char-table Vglyphless_char_display for character C (-1
6710 if we want information for no-font case), and return the display
6711 method symbol. By side-effect, update it->what and
6712 it->glyphless_method. This function is called from
6713 get_next_display_element for each character element, and from
6714 x_produce_glyphs when no suitable font was found. */
6717 lookup_glyphless_char_display (int c
, struct it
*it
)
6719 Lisp_Object glyphless_method
= Qnil
;
6721 if (CHAR_TABLE_P (Vglyphless_char_display
)
6722 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6726 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6727 if (CONSP (glyphless_method
))
6728 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6729 ? XCAR (glyphless_method
)
6730 : XCDR (glyphless_method
);
6733 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6737 if (NILP (glyphless_method
))
6740 /* The default is to display the character by a proper font. */
6742 /* The default for the no-font case is to display an empty box. */
6743 glyphless_method
= Qempty_box
;
6745 if (EQ (glyphless_method
, Qzero_width
))
6748 return glyphless_method
;
6749 /* This method can't be used for the no-font case. */
6750 glyphless_method
= Qempty_box
;
6752 if (EQ (glyphless_method
, Qthin_space
))
6753 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6754 else if (EQ (glyphless_method
, Qempty_box
))
6755 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6756 else if (EQ (glyphless_method
, Qhex_code
))
6757 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6758 else if (STRINGP (glyphless_method
))
6759 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6762 /* Invalid value. We use the default method. */
6763 glyphless_method
= Qnil
;
6766 it
->what
= IT_GLYPHLESS
;
6767 return glyphless_method
;
6770 /* Merge escape glyph face and cache the result. */
6772 static struct frame
*last_escape_glyph_frame
= NULL
;
6773 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6774 static int last_escape_glyph_merged_face_id
= 0;
6777 merge_escape_glyph_face (struct it
*it
)
6781 if (it
->f
== last_escape_glyph_frame
6782 && it
->face_id
== last_escape_glyph_face_id
)
6783 face_id
= last_escape_glyph_merged_face_id
;
6786 /* Merge the `escape-glyph' face into the current face. */
6787 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6788 last_escape_glyph_frame
= it
->f
;
6789 last_escape_glyph_face_id
= it
->face_id
;
6790 last_escape_glyph_merged_face_id
= face_id
;
6795 /* Likewise for glyphless glyph face. */
6797 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6798 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6799 static int last_glyphless_glyph_merged_face_id
= 0;
6802 merge_glyphless_glyph_face (struct it
*it
)
6806 if (it
->f
== last_glyphless_glyph_frame
6807 && it
->face_id
== last_glyphless_glyph_face_id
)
6808 face_id
= last_glyphless_glyph_merged_face_id
;
6811 /* Merge the `glyphless-char' face into the current face. */
6812 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6813 last_glyphless_glyph_frame
= it
->f
;
6814 last_glyphless_glyph_face_id
= it
->face_id
;
6815 last_glyphless_glyph_merged_face_id
= face_id
;
6820 /* Forget the `escape-glyph' and `glyphless-char' faces. This should
6821 be called before redisplaying windows, and when the frame's face
6824 forget_escape_and_glyphless_faces (void)
6826 last_escape_glyph_frame
= NULL
;
6827 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6828 last_glyphless_glyph_frame
= NULL
;
6829 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6832 /* Load IT's display element fields with information about the next
6833 display element from the current position of IT. Value is false if
6834 end of buffer (or C string) is reached. */
6837 get_next_display_element (struct it
*it
)
6839 /* True means that we found a display element. False means that
6840 we hit the end of what we iterate over. Performance note: the
6841 function pointer `method' used here turns out to be faster than
6842 using a sequence of if-statements. */
6846 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6848 if (it
->what
== IT_CHARACTER
)
6850 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6851 and only if (a) the resolved directionality of that character
6853 /* FIXME: Do we need an exception for characters from display
6855 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
6856 && !inhibit_bidi_mirroring
)
6857 it
->c
= bidi_mirror_char (it
->c
);
6858 /* Map via display table or translate control characters.
6859 IT->c, IT->len etc. have been set to the next character by
6860 the function call above. If we have a display table, and it
6861 contains an entry for IT->c, translate it. Don't do this if
6862 IT->c itself comes from a display table, otherwise we could
6863 end up in an infinite recursion. (An alternative could be to
6864 count the recursion depth of this function and signal an
6865 error when a certain maximum depth is reached.) Is it worth
6867 if (success_p
&& it
->dpvec
== NULL
)
6870 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6871 bool nonascii_space_p
= false;
6872 bool nonascii_hyphen_p
= false;
6873 int c
= it
->c
; /* This is the character to display. */
6875 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6877 eassert (SINGLE_BYTE_CHAR_P (c
));
6878 if (unibyte_display_via_language_environment
)
6880 c
= DECODE_CHAR (unibyte
, c
);
6882 c
= BYTE8_TO_CHAR (it
->c
);
6885 c
= BYTE8_TO_CHAR (it
->c
);
6889 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6892 struct Lisp_Vector
*v
= XVECTOR (dv
);
6894 /* Return the first character from the display table
6895 entry, if not empty. If empty, don't display the
6896 current character. */
6899 it
->dpvec_char_len
= it
->len
;
6900 it
->dpvec
= v
->contents
;
6901 it
->dpend
= v
->contents
+ v
->header
.size
;
6902 it
->current
.dpvec_index
= 0;
6903 it
->dpvec_face_id
= -1;
6904 it
->saved_face_id
= it
->face_id
;
6905 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6906 it
->ellipsis_p
= false;
6910 set_iterator_to_next (it
, false);
6915 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6917 if (it
->what
== IT_GLYPHLESS
)
6919 /* Don't display this character. */
6920 set_iterator_to_next (it
, false);
6924 /* If `nobreak-char-display' is non-nil, we display
6925 non-ASCII spaces and hyphens specially. */
6926 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6928 if (c
== NO_BREAK_SPACE
)
6929 nonascii_space_p
= true;
6930 else if (c
== SOFT_HYPHEN
|| c
== HYPHEN
6931 || c
== NON_BREAKING_HYPHEN
)
6932 nonascii_hyphen_p
= true;
6935 /* Translate control characters into `\003' or `^C' form.
6936 Control characters coming from a display table entry are
6937 currently not translated because we use IT->dpvec to hold
6938 the translation. This could easily be changed but I
6939 don't believe that it is worth doing.
6941 The characters handled by `nobreak-char-display' must be
6944 Non-printable characters and raw-byte characters are also
6945 translated to octal form. */
6946 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
6947 ? (it
->area
!= TEXT_AREA
6948 /* In mode line, treat \n, \t like other crl chars. */
6951 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6952 || (c
!= '\n' && c
!= '\t'))
6954 || nonascii_hyphen_p
6956 || ! CHAR_PRINTABLE_P (c
))))
6958 /* C is a control character, non-ASCII space/hyphen,
6959 raw-byte, or a non-printable character which must be
6960 displayed either as '\003' or as `^C' where the '\\'
6961 and '^' can be defined in the display table. Fill
6962 IT->ctl_chars with glyphs for what we have to
6963 display. Then, set IT->dpvec to these glyphs. */
6970 /* Handle control characters with ^. */
6972 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6976 g
= '^'; /* default glyph for Control */
6977 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6979 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6981 g
= GLYPH_CODE_CHAR (gc
);
6982 lface_id
= GLYPH_CODE_FACE (gc
);
6986 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
6987 : merge_escape_glyph_face (it
));
6989 XSETINT (it
->ctl_chars
[0], g
);
6990 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6992 goto display_control
;
6995 /* Handle non-ascii space in the mode where it only gets
6998 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
7000 /* Merge `nobreak-space' into the current face. */
7001 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
7003 XSETINT (it
->ctl_chars
[0], ' ');
7005 goto display_control
;
7008 /* Handle sequences that start with the "escape glyph". */
7010 /* the default escape glyph is \. */
7011 escape_glyph
= '\\';
7014 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7016 escape_glyph
= GLYPH_CODE_CHAR (gc
);
7017 lface_id
= GLYPH_CODE_FACE (gc
);
7021 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7022 : merge_escape_glyph_face (it
));
7024 /* Draw non-ASCII hyphen with just highlighting: */
7026 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
7028 XSETINT (it
->ctl_chars
[0], '-');
7030 goto display_control
;
7033 /* Draw non-ASCII space/hyphen with escape glyph: */
7035 if (nonascii_space_p
|| nonascii_hyphen_p
)
7037 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7038 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7040 goto display_control
;
7047 if (CHAR_BYTE8_P (c
))
7048 /* Display \200 instead of \17777600. */
7049 c
= CHAR_TO_BYTE8 (c
);
7050 len
= sprintf (str
, "%03o", c
+ 0u);
7052 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7053 for (i
= 0; i
< len
; i
++)
7054 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7059 /* Set up IT->dpvec and return first character from it. */
7060 it
->dpvec_char_len
= it
->len
;
7061 it
->dpvec
= it
->ctl_chars
;
7062 it
->dpend
= it
->dpvec
+ ctl_len
;
7063 it
->current
.dpvec_index
= 0;
7064 it
->dpvec_face_id
= face_id
;
7065 it
->saved_face_id
= it
->face_id
;
7066 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7067 it
->ellipsis_p
= false;
7070 it
->char_to_display
= c
;
7074 it
->char_to_display
= it
->c
;
7078 #ifdef HAVE_WINDOW_SYSTEM
7079 /* Adjust face id for a multibyte character. There are no multibyte
7080 character in unibyte text. */
7081 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7084 && FRAME_WINDOW_P (it
->f
))
7086 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7088 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7090 /* Automatic composition with glyph-string. */
7091 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7093 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7097 ptrdiff_t pos
= (it
->s
? -1
7098 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7099 : IT_CHARPOS (*it
));
7102 if (it
->what
== IT_CHARACTER
)
7103 c
= it
->char_to_display
;
7106 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7110 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7111 /* TAB in a composition means display glyphs with
7112 padding space on the left or right. */
7113 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7116 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7119 #endif /* HAVE_WINDOW_SYSTEM */
7122 /* Is this character the last one of a run of characters with
7123 box? If yes, set IT->end_of_box_run_p to true. */
7127 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7129 int face_id
= underlying_face_id (it
);
7130 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7134 if (face
->box
== FACE_NO_BOX
)
7136 /* If the box comes from face properties in a
7137 display string, check faces in that string. */
7138 int string_face_id
= face_after_it_pos (it
);
7139 it
->end_of_box_run_p
7140 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7143 /* Otherwise, the box comes from the underlying face.
7144 If this is the last string character displayed, check
7145 the next buffer location. */
7146 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7147 /* n_overlay_strings is unreliable unless
7148 overlay_string_index is non-negative. */
7149 && ((it
->current
.overlay_string_index
>= 0
7150 && (it
->current
.overlay_string_index
7151 == it
->n_overlay_strings
- 1))
7152 /* A string from display property. */
7153 || it
->from_disp_prop_p
))
7157 struct text_pos pos
= it
->current
.pos
;
7159 /* For a string from a display property, the next
7160 buffer position is stored in the 'position'
7161 member of the iteration stack slot below the
7162 current one, see handle_single_display_spec. By
7163 contrast, it->current.pos was is not yet updated
7164 to point to that buffer position; that will
7165 happen in pop_it, after we finish displaying the
7166 current string. Note that we already checked
7167 above that it->sp is positive, so subtracting one
7169 if (it
->from_disp_prop_p
)
7170 pos
= (it
->stack
+ it
->sp
- 1)->position
;
7172 INC_TEXT_POS (pos
, it
->multibyte_p
);
7174 if (CHARPOS (pos
) >= ZV
)
7175 it
->end_of_box_run_p
= true;
7178 next_face_id
= face_at_buffer_position
7179 (it
->w
, CHARPOS (pos
), &ignore
,
7180 CHARPOS (pos
) + TEXT_PROP_DISTANCE_LIMIT
, false, -1);
7181 it
->end_of_box_run_p
7182 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7188 /* next_element_from_display_vector sets this flag according to
7189 faces of the display vector glyphs, see there. */
7190 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7192 int face_id
= face_after_it_pos (it
);
7193 it
->end_of_box_run_p
7194 = (face_id
!= it
->face_id
7195 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7198 /* If we reached the end of the object we've been iterating (e.g., a
7199 display string or an overlay string), and there's something on
7200 IT->stack, proceed with what's on the stack. It doesn't make
7201 sense to return false if there's unprocessed stuff on the stack,
7202 because otherwise that stuff will never be displayed. */
7203 if (!success_p
&& it
->sp
> 0)
7205 set_iterator_to_next (it
, false);
7206 success_p
= get_next_display_element (it
);
7209 /* Value is false if end of buffer or string reached. */
7214 /* Move IT to the next display element.
7216 RESEAT_P means if called on a newline in buffer text,
7217 skip to the next visible line start.
7219 Functions get_next_display_element and set_iterator_to_next are
7220 separate because I find this arrangement easier to handle than a
7221 get_next_display_element function that also increments IT's
7222 position. The way it is we can first look at an iterator's current
7223 display element, decide whether it fits on a line, and if it does,
7224 increment the iterator position. The other way around we probably
7225 would either need a flag indicating whether the iterator has to be
7226 incremented the next time, or we would have to implement a
7227 decrement position function which would not be easy to write. */
7230 set_iterator_to_next (struct it
*it
, bool reseat_p
)
7232 /* Reset flags indicating start and end of a sequence of characters
7233 with box. Reset them at the start of this function because
7234 moving the iterator to a new position might set them. */
7235 it
->start_of_box_run_p
= it
->end_of_box_run_p
= false;
7239 case GET_FROM_BUFFER
:
7240 /* The current display element of IT is a character from
7241 current_buffer. Advance in the buffer, and maybe skip over
7242 invisible lines that are so because of selective display. */
7243 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7244 reseat_at_next_visible_line_start (it
, false);
7245 else if (it
->cmp_it
.id
>= 0)
7247 /* We are currently getting glyphs from a composition. */
7250 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7251 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7257 /* Update IT's char/byte positions to point to the first
7258 character of the next grapheme cluster, or to the
7259 character visually after the current composition. */
7260 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7261 bidi_move_to_visually_next (&it
->bidi_it
);
7262 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7263 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7266 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7267 && it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7269 /* Composition created while scanning forward. Proceed
7270 to the next grapheme cluster. */
7271 it
->cmp_it
.from
= it
->cmp_it
.to
;
7273 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7274 && it
->cmp_it
.from
> 0)
7276 /* Composition created while scanning backward. Proceed
7277 to the previous grapheme cluster. */
7278 it
->cmp_it
.to
= it
->cmp_it
.from
;
7282 /* No more grapheme clusters in this composition.
7283 Find the next stop position. */
7284 ptrdiff_t stop
= it
->end_charpos
;
7286 if (it
->bidi_it
.scan_dir
< 0)
7287 /* Now we are scanning backward and don't know
7290 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7291 IT_BYTEPOS (*it
), stop
, Qnil
);
7296 eassert (it
->len
!= 0);
7300 IT_BYTEPOS (*it
) += it
->len
;
7301 IT_CHARPOS (*it
) += 1;
7305 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7306 /* If this is a new paragraph, determine its base
7307 direction (a.k.a. its base embedding level). */
7308 if (it
->bidi_it
.new_paragraph
)
7309 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
7311 bidi_move_to_visually_next (&it
->bidi_it
);
7312 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7313 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7314 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7316 /* As the scan direction was changed, we must
7317 re-compute the stop position for composition. */
7318 ptrdiff_t stop
= it
->end_charpos
;
7319 if (it
->bidi_it
.scan_dir
< 0)
7321 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7322 IT_BYTEPOS (*it
), stop
, Qnil
);
7325 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7329 case GET_FROM_C_STRING
:
7330 /* Current display element of IT is from a C string. */
7332 /* If the string position is beyond string's end, it means
7333 next_element_from_c_string is padding the string with
7334 blanks, in which case we bypass the bidi iterator,
7335 because it cannot deal with such virtual characters. */
7336 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7338 IT_BYTEPOS (*it
) += it
->len
;
7339 IT_CHARPOS (*it
) += 1;
7343 bidi_move_to_visually_next (&it
->bidi_it
);
7344 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7345 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7349 case GET_FROM_DISPLAY_VECTOR
:
7350 /* Current display element of IT is from a display table entry.
7351 Advance in the display table definition. Reset it to null if
7352 end reached, and continue with characters from buffers/
7354 ++it
->current
.dpvec_index
;
7356 /* Restore face of the iterator to what they were before the
7357 display vector entry (these entries may contain faces). */
7358 it
->face_id
= it
->saved_face_id
;
7360 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7362 bool recheck_faces
= it
->ellipsis_p
;
7365 it
->method
= GET_FROM_C_STRING
;
7366 else if (STRINGP (it
->string
))
7367 it
->method
= GET_FROM_STRING
;
7370 it
->method
= GET_FROM_BUFFER
;
7371 it
->object
= it
->w
->contents
;
7375 it
->current
.dpvec_index
= -1;
7377 /* Skip over characters which were displayed via IT->dpvec. */
7378 if (it
->dpvec_char_len
< 0)
7379 reseat_at_next_visible_line_start (it
, true);
7380 else if (it
->dpvec_char_len
> 0)
7382 it
->len
= it
->dpvec_char_len
;
7383 set_iterator_to_next (it
, reseat_p
);
7386 /* Maybe recheck faces after display vector. */
7389 if (it
->method
== GET_FROM_STRING
)
7390 it
->stop_charpos
= IT_STRING_CHARPOS (*it
);
7392 it
->stop_charpos
= IT_CHARPOS (*it
);
7397 case GET_FROM_STRING
:
7398 /* Current display element is a character from a Lisp string. */
7399 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7400 /* Don't advance past string end. These conditions are true
7401 when set_iterator_to_next is called at the end of
7402 get_next_display_element, in which case the Lisp string is
7403 already exhausted, and all we want is pop the iterator
7405 if (it
->current
.overlay_string_index
>= 0)
7407 /* This is an overlay string, so there's no padding with
7408 spaces, and the number of characters in the string is
7409 where the string ends. */
7410 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7411 goto consider_string_end
;
7415 /* Not an overlay string. There could be padding, so test
7416 against it->end_charpos. */
7417 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7418 goto consider_string_end
;
7420 if (it
->cmp_it
.id
>= 0)
7422 /* We are delivering display elements from a composition.
7423 Update the string position past the grapheme cluster
7424 we've just processed. */
7427 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7428 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7434 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7435 bidi_move_to_visually_next (&it
->bidi_it
);
7436 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7437 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7440 /* Did we exhaust all the grapheme clusters of this
7442 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7443 && (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
))
7445 /* Not all the grapheme clusters were processed yet;
7446 advance to the next cluster. */
7447 it
->cmp_it
.from
= it
->cmp_it
.to
;
7449 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7450 && it
->cmp_it
.from
> 0)
7452 /* Likewise: advance to the next cluster, but going in
7453 the reverse direction. */
7454 it
->cmp_it
.to
= it
->cmp_it
.from
;
7458 /* This composition was fully processed; find the next
7459 candidate place for checking for composed
7461 /* Always limit string searches to the string length;
7462 any padding spaces are not part of the string, and
7463 there cannot be any compositions in that padding. */
7464 ptrdiff_t stop
= SCHARS (it
->string
);
7466 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
7468 else if (it
->end_charpos
< stop
)
7470 /* Cf. PRECISION in reseat_to_string: we might be
7471 limited in how many of the string characters we
7473 stop
= it
->end_charpos
;
7475 composition_compute_stop_pos (&it
->cmp_it
,
7476 IT_STRING_CHARPOS (*it
),
7477 IT_STRING_BYTEPOS (*it
), stop
,
7484 /* If the string position is beyond string's end, it
7485 means next_element_from_string is padding the string
7486 with blanks, in which case we bypass the bidi
7487 iterator, because it cannot deal with such virtual
7489 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7491 IT_STRING_BYTEPOS (*it
) += it
->len
;
7492 IT_STRING_CHARPOS (*it
) += 1;
7496 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7498 bidi_move_to_visually_next (&it
->bidi_it
);
7499 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7500 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7501 /* If the scan direction changes, we may need to update
7502 the place where to check for composed characters. */
7503 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7505 ptrdiff_t stop
= SCHARS (it
->string
);
7507 if (it
->bidi_it
.scan_dir
< 0)
7509 else if (it
->end_charpos
< stop
)
7510 stop
= it
->end_charpos
;
7512 composition_compute_stop_pos (&it
->cmp_it
,
7513 IT_STRING_CHARPOS (*it
),
7514 IT_STRING_BYTEPOS (*it
), stop
,
7520 consider_string_end
:
7522 if (it
->current
.overlay_string_index
>= 0)
7524 /* IT->string is an overlay string. Advance to the
7525 next, if there is one. */
7526 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7528 it
->ellipsis_p
= false;
7529 next_overlay_string (it
);
7531 setup_for_ellipsis (it
, 0);
7536 /* IT->string is not an overlay string. If we reached
7537 its end, and there is something on IT->stack, proceed
7538 with what is on the stack. This can be either another
7539 string, this time an overlay string, or a buffer. */
7540 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7544 if (it
->method
== GET_FROM_STRING
)
7545 goto consider_string_end
;
7550 case GET_FROM_IMAGE
:
7551 case GET_FROM_STRETCH
:
7552 /* The position etc with which we have to proceed are on
7553 the stack. The position may be at the end of a string,
7554 if the `display' property takes up the whole string. */
7555 eassert (it
->sp
> 0);
7557 if (it
->method
== GET_FROM_STRING
)
7558 goto consider_string_end
;
7562 /* There are no other methods defined, so this should be a bug. */
7566 eassert (it
->method
!= GET_FROM_STRING
7567 || (STRINGP (it
->string
)
7568 && IT_STRING_CHARPOS (*it
) >= 0));
7571 /* Load IT's display element fields with information about the next
7572 display element which comes from a display table entry or from the
7573 result of translating a control character to one of the forms `^C'
7576 IT->dpvec holds the glyphs to return as characters.
7577 IT->saved_face_id holds the face id before the display vector--it
7578 is restored into IT->face_id in set_iterator_to_next. */
7581 next_element_from_display_vector (struct it
*it
)
7584 int prev_face_id
= it
->face_id
;
7588 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7590 it
->face_id
= it
->saved_face_id
;
7592 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7593 That seemed totally bogus - so I changed it... */
7594 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7596 if (GLYPH_CODE_P (gc
))
7598 struct face
*this_face
, *prev_face
, *next_face
;
7600 it
->c
= GLYPH_CODE_CHAR (gc
);
7601 it
->len
= CHAR_BYTES (it
->c
);
7603 /* The entry may contain a face id to use. Such a face id is
7604 the id of a Lisp face, not a realized face. A face id of
7605 zero means no face is specified. */
7606 if (it
->dpvec_face_id
>= 0)
7607 it
->face_id
= it
->dpvec_face_id
;
7610 int lface_id
= GLYPH_CODE_FACE (gc
);
7612 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7616 /* Glyphs in the display vector could have the box face, so we
7617 need to set the related flags in the iterator, as
7619 this_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7620 prev_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
7622 /* Is this character the first character of a box-face run? */
7623 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7625 || prev_face
->box
== FACE_NO_BOX
));
7627 /* For the last character of the box-face run, we need to look
7628 either at the next glyph from the display vector, or at the
7629 face we saw before the display vector. */
7630 next_face_id
= it
->saved_face_id
;
7631 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7633 if (it
->dpvec_face_id
>= 0)
7634 next_face_id
= it
->dpvec_face_id
;
7638 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7641 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7645 next_face
= FACE_FROM_ID (it
->f
, next_face_id
);
7646 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7648 || next_face
->box
== FACE_NO_BOX
));
7649 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7652 /* Display table entry is invalid. Return a space. */
7653 it
->c
= ' ', it
->len
= 1;
7655 /* Don't change position and object of the iterator here. They are
7656 still the values of the character that had this display table
7657 entry or was translated, and that's what we want. */
7658 it
->what
= IT_CHARACTER
;
7662 /* Get the first element of string/buffer in the visual order, after
7663 being reseated to a new position in a string or a buffer. */
7665 get_visually_first_element (struct it
*it
)
7667 bool string_p
= STRINGP (it
->string
) || it
->s
;
7668 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7669 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7671 if (STRINGP (it
->string
))
7673 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7674 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7678 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7679 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7682 if (it
->bidi_it
.charpos
== eob
)
7684 /* Nothing to do, but reset the FIRST_ELT flag, like
7685 bidi_paragraph_init does, because we are not going to
7687 it
->bidi_it
.first_elt
= false;
7689 else if (it
->bidi_it
.charpos
== bob
7691 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7692 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7694 /* If we are at the beginning of a line/string, we can produce
7695 the next element right away. */
7696 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7697 bidi_move_to_visually_next (&it
->bidi_it
);
7701 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7703 /* We need to prime the bidi iterator starting at the line's or
7704 string's beginning, before we will be able to produce the
7707 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7709 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7710 IT_BYTEPOS (*it
), -1,
7711 &it
->bidi_it
.bytepos
);
7712 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7715 /* Now return to buffer/string position where we were asked
7716 to get the next display element, and produce that. */
7717 bidi_move_to_visually_next (&it
->bidi_it
);
7719 while (it
->bidi_it
.bytepos
!= orig_bytepos
7720 && it
->bidi_it
.charpos
< eob
);
7723 /* Adjust IT's position information to where we ended up. */
7724 if (STRINGP (it
->string
))
7726 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7727 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7731 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7732 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7735 if (STRINGP (it
->string
) || !it
->s
)
7737 ptrdiff_t stop
, charpos
, bytepos
;
7739 if (STRINGP (it
->string
))
7742 stop
= SCHARS (it
->string
);
7743 if (stop
> it
->end_charpos
)
7744 stop
= it
->end_charpos
;
7745 charpos
= IT_STRING_CHARPOS (*it
);
7746 bytepos
= IT_STRING_BYTEPOS (*it
);
7750 stop
= it
->end_charpos
;
7751 charpos
= IT_CHARPOS (*it
);
7752 bytepos
= IT_BYTEPOS (*it
);
7754 if (it
->bidi_it
.scan_dir
< 0)
7756 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7761 /* Load IT with the next display element from Lisp string IT->string.
7762 IT->current.string_pos is the current position within the string.
7763 If IT->current.overlay_string_index >= 0, the Lisp string is an
7767 next_element_from_string (struct it
*it
)
7769 struct text_pos position
;
7771 eassert (STRINGP (it
->string
));
7772 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7773 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7774 position
= it
->current
.string_pos
;
7776 /* With bidi reordering, the character to display might not be the
7777 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT means
7778 that we were reseat()ed to a new string, whose paragraph
7779 direction is not known. */
7780 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7782 get_visually_first_element (it
);
7783 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7786 /* Time to check for invisible text? */
7787 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7789 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7792 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7793 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7795 /* With bidi non-linear iteration, we could find
7796 ourselves far beyond the last computed stop_charpos,
7797 with several other stop positions in between that we
7798 missed. Scan them all now, in buffer's logical
7799 order, until we find and handle the last stop_charpos
7800 that precedes our current position. */
7801 handle_stop_backwards (it
, it
->stop_charpos
);
7802 return GET_NEXT_DISPLAY_ELEMENT (it
);
7808 /* Take note of the stop position we just moved
7809 across, for when we will move back across it. */
7810 it
->prev_stop
= it
->stop_charpos
;
7811 /* If we are at base paragraph embedding level, take
7812 note of the last stop position seen at this
7814 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7815 it
->base_level_stop
= it
->stop_charpos
;
7819 /* Since a handler may have changed IT->method, we must
7821 return GET_NEXT_DISPLAY_ELEMENT (it
);
7825 /* If we are before prev_stop, we may have overstepped
7826 on our way backwards a stop_pos, and if so, we need
7827 to handle that stop_pos. */
7828 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7829 /* We can sometimes back up for reasons that have nothing
7830 to do with bidi reordering. E.g., compositions. The
7831 code below is only needed when we are above the base
7832 embedding level, so test for that explicitly. */
7833 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7835 /* If we lost track of base_level_stop, we have no better
7836 place for handle_stop_backwards to start from than string
7837 beginning. This happens, e.g., when we were reseated to
7838 the previous screenful of text by vertical-motion. */
7839 if (it
->base_level_stop
<= 0
7840 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7841 it
->base_level_stop
= 0;
7842 handle_stop_backwards (it
, it
->base_level_stop
);
7843 return GET_NEXT_DISPLAY_ELEMENT (it
);
7847 if (it
->current
.overlay_string_index
>= 0)
7849 /* Get the next character from an overlay string. In overlay
7850 strings, there is no field width or padding with spaces to
7852 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7857 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7858 IT_STRING_BYTEPOS (*it
),
7859 it
->bidi_it
.scan_dir
< 0
7861 : SCHARS (it
->string
))
7862 && next_element_from_composition (it
))
7866 else if (STRING_MULTIBYTE (it
->string
))
7868 const unsigned char *s
= (SDATA (it
->string
)
7869 + IT_STRING_BYTEPOS (*it
));
7870 it
->c
= string_char_and_length (s
, &it
->len
);
7874 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7880 /* Get the next character from a Lisp string that is not an
7881 overlay string. Such strings come from the mode line, for
7882 example. We may have to pad with spaces, or truncate the
7883 string. See also next_element_from_c_string. */
7884 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7889 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7891 /* Pad with spaces. */
7892 it
->c
= ' ', it
->len
= 1;
7893 CHARPOS (position
) = BYTEPOS (position
) = -1;
7895 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7896 IT_STRING_BYTEPOS (*it
),
7897 it
->bidi_it
.scan_dir
< 0
7899 : it
->string_nchars
)
7900 && next_element_from_composition (it
))
7904 else if (STRING_MULTIBYTE (it
->string
))
7906 const unsigned char *s
= (SDATA (it
->string
)
7907 + IT_STRING_BYTEPOS (*it
));
7908 it
->c
= string_char_and_length (s
, &it
->len
);
7912 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7917 /* Record what we have and where it came from. */
7918 it
->what
= IT_CHARACTER
;
7919 it
->object
= it
->string
;
7920 it
->position
= position
;
7925 /* Load IT with next display element from C string IT->s.
7926 IT->string_nchars is the maximum number of characters to return
7927 from the string. IT->end_charpos may be greater than
7928 IT->string_nchars when this function is called, in which case we
7929 may have to return padding spaces. Value is false if end of string
7930 reached, including padding spaces. */
7933 next_element_from_c_string (struct it
*it
)
7935 bool success_p
= true;
7938 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7939 it
->what
= IT_CHARACTER
;
7940 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7941 it
->object
= make_number (0);
7943 /* With bidi reordering, the character to display might not be the
7944 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
7945 we were reseated to a new string, whose paragraph direction is
7947 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7948 get_visually_first_element (it
);
7950 /* IT's position can be greater than IT->string_nchars in case a
7951 field width or precision has been specified when the iterator was
7953 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7955 /* End of the game. */
7959 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7961 /* Pad with spaces. */
7962 it
->c
= ' ', it
->len
= 1;
7963 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7965 else if (it
->multibyte_p
)
7966 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7968 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7974 /* Set up IT to return characters from an ellipsis, if appropriate.
7975 The definition of the ellipsis glyphs may come from a display table
7976 entry. This function fills IT with the first glyph from the
7977 ellipsis if an ellipsis is to be displayed. */
7980 next_element_from_ellipsis (struct it
*it
)
7982 if (it
->selective_display_ellipsis_p
)
7983 setup_for_ellipsis (it
, it
->len
);
7986 /* The face at the current position may be different from the
7987 face we find after the invisible text. Remember what it
7988 was in IT->saved_face_id, and signal that it's there by
7989 setting face_before_selective_p. */
7990 it
->saved_face_id
= it
->face_id
;
7991 it
->method
= GET_FROM_BUFFER
;
7992 it
->object
= it
->w
->contents
;
7993 reseat_at_next_visible_line_start (it
, true);
7994 it
->face_before_selective_p
= true;
7997 return GET_NEXT_DISPLAY_ELEMENT (it
);
8001 /* Deliver an image display element. The iterator IT is already
8002 filled with image information (done in handle_display_prop). Value
8007 next_element_from_image (struct it
*it
)
8009 it
->what
= IT_IMAGE
;
8014 /* Fill iterator IT with next display element from a stretch glyph
8015 property. IT->object is the value of the text property. Value is
8019 next_element_from_stretch (struct it
*it
)
8021 it
->what
= IT_STRETCH
;
8025 /* Scan backwards from IT's current position until we find a stop
8026 position, or until BEGV. This is called when we find ourself
8027 before both the last known prev_stop and base_level_stop while
8028 reordering bidirectional text. */
8031 compute_stop_pos_backwards (struct it
*it
)
8033 const int SCAN_BACK_LIMIT
= 1000;
8034 struct text_pos pos
;
8035 struct display_pos save_current
= it
->current
;
8036 struct text_pos save_position
= it
->position
;
8037 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8038 ptrdiff_t where_we_are
= charpos
;
8039 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8040 ptrdiff_t save_end_pos
= it
->end_charpos
;
8042 eassert (NILP (it
->string
) && !it
->s
);
8043 eassert (it
->bidi_p
);
8047 it
->end_charpos
= min (charpos
+ 1, ZV
);
8048 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8049 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8050 reseat_1 (it
, pos
, false);
8051 compute_stop_pos (it
);
8052 /* We must advance forward, right? */
8053 if (it
->stop_charpos
<= charpos
)
8056 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8058 if (it
->stop_charpos
<= where_we_are
)
8059 it
->prev_stop
= it
->stop_charpos
;
8061 it
->prev_stop
= BEGV
;
8063 it
->current
= save_current
;
8064 it
->position
= save_position
;
8065 it
->stop_charpos
= save_stop_pos
;
8066 it
->end_charpos
= save_end_pos
;
8069 /* Scan forward from CHARPOS in the current buffer/string, until we
8070 find a stop position > current IT's position. Then handle the stop
8071 position before that. This is called when we bump into a stop
8072 position while reordering bidirectional text. CHARPOS should be
8073 the last previously processed stop_pos (or BEGV/0, if none were
8074 processed yet) whose position is less that IT's current
8078 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8080 bool bufp
= !STRINGP (it
->string
);
8081 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8082 struct display_pos save_current
= it
->current
;
8083 struct text_pos save_position
= it
->position
;
8084 struct text_pos pos1
;
8085 ptrdiff_t next_stop
;
8087 /* Scan in strict logical order. */
8088 eassert (it
->bidi_p
);
8092 it
->prev_stop
= charpos
;
8095 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8096 reseat_1 (it
, pos1
, false);
8099 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8100 compute_stop_pos (it
);
8101 /* We must advance forward, right? */
8102 if (it
->stop_charpos
<= it
->prev_stop
)
8104 charpos
= it
->stop_charpos
;
8106 while (charpos
<= where_we_are
);
8109 it
->current
= save_current
;
8110 it
->position
= save_position
;
8111 next_stop
= it
->stop_charpos
;
8112 it
->stop_charpos
= it
->prev_stop
;
8114 it
->stop_charpos
= next_stop
;
8117 /* Load IT with the next display element from current_buffer. Value
8118 is false if end of buffer reached. IT->stop_charpos is the next
8119 position at which to stop and check for text properties or buffer
8123 next_element_from_buffer (struct it
*it
)
8125 bool success_p
= true;
8127 eassert (IT_CHARPOS (*it
) >= BEGV
);
8128 eassert (NILP (it
->string
) && !it
->s
);
8129 eassert (!it
->bidi_p
8130 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8131 && it
->bidi_it
.string
.s
== NULL
));
8133 /* With bidi reordering, the character to display might not be the
8134 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
8135 we were reseat()ed to a new buffer position, which is potentially
8136 a different paragraph. */
8137 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8139 get_visually_first_element (it
);
8140 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8143 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8145 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8147 bool overlay_strings_follow_p
;
8149 /* End of the game, except when overlay strings follow that
8150 haven't been returned yet. */
8151 if (it
->overlay_strings_at_end_processed_p
)
8152 overlay_strings_follow_p
= false;
8155 it
->overlay_strings_at_end_processed_p
= true;
8156 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8159 if (overlay_strings_follow_p
)
8160 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8164 it
->position
= it
->current
.pos
;
8168 else if (!(!it
->bidi_p
8169 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8170 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8172 /* With bidi non-linear iteration, we could find ourselves
8173 far beyond the last computed stop_charpos, with several
8174 other stop positions in between that we missed. Scan
8175 them all now, in buffer's logical order, until we find
8176 and handle the last stop_charpos that precedes our
8177 current position. */
8178 handle_stop_backwards (it
, it
->stop_charpos
);
8179 it
->ignore_overlay_strings_at_pos_p
= false;
8180 return GET_NEXT_DISPLAY_ELEMENT (it
);
8186 /* Take note of the stop position we just moved across,
8187 for when we will move back across it. */
8188 it
->prev_stop
= it
->stop_charpos
;
8189 /* If we are at base paragraph embedding level, take
8190 note of the last stop position seen at this
8192 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8193 it
->base_level_stop
= it
->stop_charpos
;
8196 it
->ignore_overlay_strings_at_pos_p
= false;
8197 return GET_NEXT_DISPLAY_ELEMENT (it
);
8201 /* If we are before prev_stop, we may have overstepped on
8202 our way backwards a stop_pos, and if so, we need to
8203 handle that stop_pos. */
8204 && IT_CHARPOS (*it
) < it
->prev_stop
8205 /* We can sometimes back up for reasons that have nothing
8206 to do with bidi reordering. E.g., compositions. The
8207 code below is only needed when we are above the base
8208 embedding level, so test for that explicitly. */
8209 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8211 if (it
->base_level_stop
<= 0
8212 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8214 /* If we lost track of base_level_stop, we need to find
8215 prev_stop by looking backwards. This happens, e.g., when
8216 we were reseated to the previous screenful of text by
8218 it
->base_level_stop
= BEGV
;
8219 compute_stop_pos_backwards (it
);
8220 handle_stop_backwards (it
, it
->prev_stop
);
8223 handle_stop_backwards (it
, it
->base_level_stop
);
8224 it
->ignore_overlay_strings_at_pos_p
= false;
8225 return GET_NEXT_DISPLAY_ELEMENT (it
);
8229 /* No face changes, overlays etc. in sight, so just return a
8230 character from current_buffer. */
8234 /* We moved to the next buffer position, so any info about
8235 previously seen overlays is no longer valid. */
8236 it
->ignore_overlay_strings_at_pos_p
= false;
8238 /* Maybe run the redisplay end trigger hook. Performance note:
8239 This doesn't seem to cost measurable time. */
8240 if (it
->redisplay_end_trigger_charpos
8242 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8243 run_redisplay_end_trigger_hook (it
);
8245 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8246 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8248 && next_element_from_composition (it
))
8253 /* Get the next character, maybe multibyte. */
8254 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8255 if (it
->multibyte_p
&& !ASCII_CHAR_P (*p
))
8256 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8258 it
->c
= *p
, it
->len
= 1;
8260 /* Record what we have and where it came from. */
8261 it
->what
= IT_CHARACTER
;
8262 it
->object
= it
->w
->contents
;
8263 it
->position
= it
->current
.pos
;
8265 /* Normally we return the character found above, except when we
8266 really want to return an ellipsis for selective display. */
8271 /* A value of selective > 0 means hide lines indented more
8272 than that number of columns. */
8273 if (it
->selective
> 0
8274 && IT_CHARPOS (*it
) + 1 < ZV
8275 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8276 IT_BYTEPOS (*it
) + 1,
8279 success_p
= next_element_from_ellipsis (it
);
8280 it
->dpvec_char_len
= -1;
8283 else if (it
->c
== '\r' && it
->selective
== -1)
8285 /* A value of selective == -1 means that everything from the
8286 CR to the end of the line is invisible, with maybe an
8287 ellipsis displayed for it. */
8288 success_p
= next_element_from_ellipsis (it
);
8289 it
->dpvec_char_len
= -1;
8294 /* Value is false if end of buffer reached. */
8295 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8300 /* Run the redisplay end trigger hook for IT. */
8303 run_redisplay_end_trigger_hook (struct it
*it
)
8305 /* IT->glyph_row should be non-null, i.e. we should be actually
8306 displaying something, or otherwise we should not run the hook. */
8307 eassert (it
->glyph_row
);
8309 ptrdiff_t charpos
= it
->redisplay_end_trigger_charpos
;
8310 it
->redisplay_end_trigger_charpos
= 0;
8312 /* Since we are *trying* to run these functions, don't try to run
8313 them again, even if they get an error. */
8314 wset_redisplay_end_trigger (it
->w
, Qnil
);
8315 CALLN (Frun_hook_with_args
, Qredisplay_end_trigger_functions
, it
->window
,
8316 make_number (charpos
));
8318 /* Notice if it changed the face of the character we are on. */
8319 handle_face_prop (it
);
8323 /* Deliver a composition display element. Unlike the other
8324 next_element_from_XXX, this function is not registered in the array
8325 get_next_element[]. It is called from next_element_from_buffer and
8326 next_element_from_string when necessary. */
8329 next_element_from_composition (struct it
*it
)
8331 it
->what
= IT_COMPOSITION
;
8332 it
->len
= it
->cmp_it
.nbytes
;
8333 if (STRINGP (it
->string
))
8337 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8338 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8341 it
->position
= it
->current
.string_pos
;
8342 it
->object
= it
->string
;
8343 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8344 IT_STRING_BYTEPOS (*it
), it
->string
);
8350 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8351 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8354 if (it
->bidi_it
.new_paragraph
)
8355 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
8357 /* Resync the bidi iterator with IT's new position.
8358 FIXME: this doesn't support bidirectional text. */
8359 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8360 bidi_move_to_visually_next (&it
->bidi_it
);
8364 it
->position
= it
->current
.pos
;
8365 it
->object
= it
->w
->contents
;
8366 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8367 IT_BYTEPOS (*it
), Qnil
);
8374 /***********************************************************************
8375 Moving an iterator without producing glyphs
8376 ***********************************************************************/
8378 /* Check if iterator is at a position corresponding to a valid buffer
8379 position after some move_it_ call. */
8381 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8382 ((it)->method != GET_FROM_STRING || IT_STRING_CHARPOS (*it) == 0)
8385 /* Move iterator IT to a specified buffer or X position within one
8386 line on the display without producing glyphs.
8388 OP should be a bit mask including some or all of these bits:
8389 MOVE_TO_X: Stop upon reaching x-position TO_X.
8390 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8391 Regardless of OP's value, stop upon reaching the end of the display line.
8393 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8394 This means, in particular, that TO_X includes window's horizontal
8397 The return value has several possible values that
8398 say what condition caused the scan to stop:
8400 MOVE_POS_MATCH_OR_ZV
8401 - when TO_POS or ZV was reached.
8404 -when TO_X was reached before TO_POS or ZV were reached.
8407 - when we reached the end of the display area and the line must
8411 - when we reached the end of the display area and the line is
8415 - when we stopped at a line end, i.e. a newline or a CR and selective
8418 static enum move_it_result
8419 move_it_in_display_line_to (struct it
*it
,
8420 ptrdiff_t to_charpos
, int to_x
,
8421 enum move_operation_enum op
)
8423 enum move_it_result result
= MOVE_UNDEFINED
;
8424 struct glyph_row
*saved_glyph_row
;
8425 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8426 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8427 void *ppos_data
= NULL
;
8428 bool may_wrap
= false;
8429 enum it_method prev_method
= it
->method
;
8430 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8431 bool saw_smaller_pos
= prev_pos
< to_charpos
;
8433 /* Don't produce glyphs in produce_glyphs. */
8434 saved_glyph_row
= it
->glyph_row
;
8435 it
->glyph_row
= NULL
;
8437 /* Use wrap_it to save a copy of IT wherever a word wrap could
8438 occur. Use atpos_it to save a copy of IT at the desired buffer
8439 position, if found, so that we can scan ahead and check if the
8440 word later overshoots the window edge. Use atx_it similarly, for
8446 /* Use ppos_it under bidi reordering to save a copy of IT for the
8447 initial position. We restore that position in IT when we have
8448 scanned the entire display line without finding a match for
8449 TO_CHARPOS and all the character positions are greater than
8450 TO_CHARPOS. We then restart the scan from the initial position,
8451 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8452 the closest to TO_CHARPOS. */
8455 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8457 SAVE_IT (ppos_it
, *it
, ppos_data
);
8458 closest_pos
= IT_CHARPOS (*it
);
8464 #define BUFFER_POS_REACHED_P() \
8465 ((op & MOVE_TO_POS) != 0 \
8466 && BUFFERP (it->object) \
8467 && (IT_CHARPOS (*it) == to_charpos \
8469 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8470 && IT_CHARPOS (*it) > to_charpos) \
8471 || (it->what == IT_COMPOSITION \
8472 && ((IT_CHARPOS (*it) > to_charpos \
8473 && to_charpos >= it->cmp_it.charpos) \
8474 || (IT_CHARPOS (*it) < to_charpos \
8475 && to_charpos <= it->cmp_it.charpos)))) \
8476 && (it->method == GET_FROM_BUFFER \
8477 || (it->method == GET_FROM_DISPLAY_VECTOR \
8478 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8480 /* If there's a line-/wrap-prefix, handle it. */
8481 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8482 && it
->current_y
< it
->last_visible_y
)
8483 handle_line_prefix (it
);
8485 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8486 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8490 int x
, i
, ascent
= 0, descent
= 0;
8492 /* Utility macro to reset an iterator with x, ascent, and descent. */
8493 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8494 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8495 (IT)->max_descent = descent)
8497 /* Stop if we move beyond TO_CHARPOS (after an image or a
8498 display string or stretch glyph). */
8499 if ((op
& MOVE_TO_POS
) != 0
8500 && BUFFERP (it
->object
)
8501 && it
->method
== GET_FROM_BUFFER
8503 /* When the iterator is at base embedding level, we
8504 are guaranteed that characters are delivered for
8505 display in strictly increasing order of their
8506 buffer positions. */
8507 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8508 && IT_CHARPOS (*it
) > to_charpos
)
8510 && (prev_method
== GET_FROM_IMAGE
8511 || prev_method
== GET_FROM_STRETCH
8512 || prev_method
== GET_FROM_STRING
)
8513 /* Passed TO_CHARPOS from left to right. */
8514 && ((prev_pos
< to_charpos
8515 && IT_CHARPOS (*it
) > to_charpos
)
8516 /* Passed TO_CHARPOS from right to left. */
8517 || (prev_pos
> to_charpos
8518 && IT_CHARPOS (*it
) < to_charpos
)))))
8520 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8522 result
= MOVE_POS_MATCH_OR_ZV
;
8525 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8526 /* If wrap_it is valid, the current position might be in a
8527 word that is wrapped. So, save the iterator in
8528 atpos_it and continue to see if wrapping happens. */
8529 SAVE_IT (atpos_it
, *it
, atpos_data
);
8532 /* Stop when ZV reached.
8533 We used to stop here when TO_CHARPOS reached as well, but that is
8534 too soon if this glyph does not fit on this line. So we handle it
8535 explicitly below. */
8536 if (!get_next_display_element (it
))
8538 result
= MOVE_POS_MATCH_OR_ZV
;
8542 if (it
->line_wrap
== TRUNCATE
)
8544 if (BUFFER_POS_REACHED_P ())
8546 result
= MOVE_POS_MATCH_OR_ZV
;
8552 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8554 if (IT_DISPLAYING_WHITESPACE (it
))
8558 /* We have reached a glyph that follows one or more
8559 whitespace characters. If the position is
8560 already found, we are done. */
8561 if (atpos_it
.sp
>= 0)
8563 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8564 result
= MOVE_POS_MATCH_OR_ZV
;
8569 RESTORE_IT (it
, &atx_it
, atx_data
);
8570 result
= MOVE_X_REACHED
;
8573 /* Otherwise, we can wrap here. */
8574 SAVE_IT (wrap_it
, *it
, wrap_data
);
8580 /* Remember the line height for the current line, in case
8581 the next element doesn't fit on the line. */
8582 ascent
= it
->max_ascent
;
8583 descent
= it
->max_descent
;
8585 /* The call to produce_glyphs will get the metrics of the
8586 display element IT is loaded with. Record the x-position
8587 before this display element, in case it doesn't fit on the
8591 PRODUCE_GLYPHS (it
);
8593 if (it
->area
!= TEXT_AREA
)
8595 prev_method
= it
->method
;
8596 if (it
->method
== GET_FROM_BUFFER
)
8597 prev_pos
= IT_CHARPOS (*it
);
8598 set_iterator_to_next (it
, true);
8599 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8600 SET_TEXT_POS (this_line_min_pos
,
8601 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8603 && (op
& MOVE_TO_POS
)
8604 && IT_CHARPOS (*it
) > to_charpos
8605 && IT_CHARPOS (*it
) < closest_pos
)
8606 closest_pos
= IT_CHARPOS (*it
);
8610 /* The number of glyphs we get back in IT->nglyphs will normally
8611 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8612 character on a terminal frame, or (iii) a line end. For the
8613 second case, IT->nglyphs - 1 padding glyphs will be present.
8614 (On X frames, there is only one glyph produced for a
8615 composite character.)
8617 The behavior implemented below means, for continuation lines,
8618 that as many spaces of a TAB as fit on the current line are
8619 displayed there. For terminal frames, as many glyphs of a
8620 multi-glyph character are displayed in the current line, too.
8621 This is what the old redisplay code did, and we keep it that
8622 way. Under X, the whole shape of a complex character must
8623 fit on the line or it will be completely displayed in the
8626 Note that both for tabs and padding glyphs, all glyphs have
8630 /* More than one glyph or glyph doesn't fit on line. All
8631 glyphs have the same width. */
8632 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8634 int x_before_this_char
= x
;
8635 int hpos_before_this_char
= it
->hpos
;
8637 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8639 new_x
= x
+ single_glyph_width
;
8641 /* We want to leave anything reaching TO_X to the caller. */
8642 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8644 if (BUFFER_POS_REACHED_P ())
8646 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8647 goto buffer_pos_reached
;
8648 if (atpos_it
.sp
< 0)
8650 SAVE_IT (atpos_it
, *it
, atpos_data
);
8651 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8656 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8659 result
= MOVE_X_REACHED
;
8664 SAVE_IT (atx_it
, *it
, atx_data
);
8665 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8670 if (/* Lines are continued. */
8671 it
->line_wrap
!= TRUNCATE
8672 && (/* And glyph doesn't fit on the line. */
8673 new_x
> it
->last_visible_x
8674 /* Or it fits exactly and we're on a window
8676 || (new_x
== it
->last_visible_x
8677 && FRAME_WINDOW_P (it
->f
)
8678 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8679 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8680 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8682 if (/* IT->hpos == 0 means the very first glyph
8683 doesn't fit on the line, e.g. a wide image. */
8685 || (new_x
== it
->last_visible_x
8686 && FRAME_WINDOW_P (it
->f
)))
8689 it
->current_x
= new_x
;
8691 /* The character's last glyph just barely fits
8693 if (i
== it
->nglyphs
- 1)
8695 /* If this is the destination position,
8696 return a position *before* it in this row,
8697 now that we know it fits in this row. */
8698 if (BUFFER_POS_REACHED_P ())
8700 if (it
->line_wrap
!= WORD_WRAP
8702 /* If we've just found whitespace to
8703 wrap, effectively ignore the
8704 previous wrap point -- it is no
8705 longer relevant, but we won't
8706 have an opportunity to update it,
8707 since we've reached the edge of
8708 this screen line. */
8710 && IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8712 it
->hpos
= hpos_before_this_char
;
8713 it
->current_x
= x_before_this_char
;
8714 result
= MOVE_POS_MATCH_OR_ZV
;
8717 if (it
->line_wrap
== WORD_WRAP
8720 SAVE_IT (atpos_it
, *it
, atpos_data
);
8721 atpos_it
.current_x
= x_before_this_char
;
8722 atpos_it
.hpos
= hpos_before_this_char
;
8726 prev_method
= it
->method
;
8727 if (it
->method
== GET_FROM_BUFFER
)
8728 prev_pos
= IT_CHARPOS (*it
);
8729 set_iterator_to_next (it
, true);
8730 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8731 SET_TEXT_POS (this_line_min_pos
,
8732 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8733 /* On graphical terminals, newlines may
8734 "overflow" into the fringe if
8735 overflow-newline-into-fringe is non-nil.
8736 On text terminals, and on graphical
8737 terminals with no right margin, newlines
8738 may overflow into the last glyph on the
8740 if (!FRAME_WINDOW_P (it
->f
)
8742 && it
->bidi_it
.paragraph_dir
== R2L
)
8743 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8744 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8745 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8747 if (!get_next_display_element (it
))
8749 result
= MOVE_POS_MATCH_OR_ZV
;
8752 if (BUFFER_POS_REACHED_P ())
8754 if (ITERATOR_AT_END_OF_LINE_P (it
))
8755 result
= MOVE_POS_MATCH_OR_ZV
;
8757 result
= MOVE_LINE_CONTINUED
;
8760 if (ITERATOR_AT_END_OF_LINE_P (it
)
8761 && (it
->line_wrap
!= WORD_WRAP
8763 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8765 result
= MOVE_NEWLINE_OR_CR
;
8772 IT_RESET_X_ASCENT_DESCENT (it
);
8774 /* If the screen line ends with whitespace, and we
8775 are under word-wrap, don't use wrap_it: it is no
8776 longer relevant, but we won't have an opportunity
8777 to update it, since we are done with this screen
8779 if (may_wrap
&& IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8781 /* If we've found TO_X, go back there, as we now
8782 know the last word fits on this screen line. */
8783 if ((op
& MOVE_TO_X
) && new_x
== it
->last_visible_x
8786 RESTORE_IT (it
, &atx_it
, atx_data
);
8789 result
= MOVE_X_REACHED
;
8793 else if (wrap_it
.sp
>= 0)
8795 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8800 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8802 result
= MOVE_LINE_CONTINUED
;
8806 if (BUFFER_POS_REACHED_P ())
8808 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8809 goto buffer_pos_reached
;
8810 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8812 SAVE_IT (atpos_it
, *it
, atpos_data
);
8813 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8817 if (new_x
> it
->first_visible_x
)
8819 /* Glyph is visible. Increment number of glyphs that
8820 would be displayed. */
8825 if (result
!= MOVE_UNDEFINED
)
8828 else if (BUFFER_POS_REACHED_P ())
8831 IT_RESET_X_ASCENT_DESCENT (it
);
8832 result
= MOVE_POS_MATCH_OR_ZV
;
8835 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8837 /* Stop when TO_X specified and reached. This check is
8838 necessary here because of lines consisting of a line end,
8839 only. The line end will not produce any glyphs and we
8840 would never get MOVE_X_REACHED. */
8841 eassert (it
->nglyphs
== 0);
8842 result
= MOVE_X_REACHED
;
8846 /* Is this a line end? If yes, we're done. */
8847 if (ITERATOR_AT_END_OF_LINE_P (it
))
8849 /* If we are past TO_CHARPOS, but never saw any character
8850 positions smaller than TO_CHARPOS, return
8851 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8853 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8855 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8857 if (closest_pos
< ZV
)
8859 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8860 /* Don't recurse if closest_pos is equal to
8861 to_charpos, since we have just tried that. */
8862 if (closest_pos
!= to_charpos
)
8863 move_it_in_display_line_to (it
, closest_pos
, -1,
8865 result
= MOVE_POS_MATCH_OR_ZV
;
8868 goto buffer_pos_reached
;
8870 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8871 && IT_CHARPOS (*it
) > to_charpos
)
8872 goto buffer_pos_reached
;
8874 result
= MOVE_NEWLINE_OR_CR
;
8877 result
= MOVE_NEWLINE_OR_CR
;
8881 prev_method
= it
->method
;
8882 if (it
->method
== GET_FROM_BUFFER
)
8883 prev_pos
= IT_CHARPOS (*it
);
8884 /* The current display element has been consumed. Advance
8886 set_iterator_to_next (it
, true);
8887 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8888 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8889 if (IT_CHARPOS (*it
) < to_charpos
)
8890 saw_smaller_pos
= true;
8892 && (op
& MOVE_TO_POS
)
8893 && IT_CHARPOS (*it
) >= to_charpos
8894 && IT_CHARPOS (*it
) < closest_pos
)
8895 closest_pos
= IT_CHARPOS (*it
);
8897 /* Stop if lines are truncated and IT's current x-position is
8898 past the right edge of the window now. */
8899 if (it
->line_wrap
== TRUNCATE
8900 && it
->current_x
>= it
->last_visible_x
)
8902 if (!FRAME_WINDOW_P (it
->f
)
8903 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8904 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8905 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8906 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8908 bool at_eob_p
= false;
8910 if ((at_eob_p
= !get_next_display_element (it
))
8911 || BUFFER_POS_REACHED_P ()
8912 /* If we are past TO_CHARPOS, but never saw any
8913 character positions smaller than TO_CHARPOS,
8914 return MOVE_POS_MATCH_OR_ZV, like the
8915 unidirectional display did. */
8916 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8918 && IT_CHARPOS (*it
) > to_charpos
))
8921 && !BUFFER_POS_REACHED_P ()
8922 && !at_eob_p
&& closest_pos
< ZV
)
8924 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8925 if (closest_pos
!= to_charpos
)
8926 move_it_in_display_line_to (it
, closest_pos
, -1,
8929 result
= MOVE_POS_MATCH_OR_ZV
;
8932 if (ITERATOR_AT_END_OF_LINE_P (it
))
8934 result
= MOVE_NEWLINE_OR_CR
;
8938 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8940 && IT_CHARPOS (*it
) > to_charpos
)
8942 if (closest_pos
< ZV
)
8944 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8945 if (closest_pos
!= to_charpos
)
8946 move_it_in_display_line_to (it
, closest_pos
, -1,
8949 result
= MOVE_POS_MATCH_OR_ZV
;
8952 result
= MOVE_LINE_TRUNCATED
;
8955 #undef IT_RESET_X_ASCENT_DESCENT
8958 #undef BUFFER_POS_REACHED_P
8960 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8961 restore the saved iterator. */
8962 if (atpos_it
.sp
>= 0)
8963 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8964 else if (atx_it
.sp
>= 0)
8965 RESTORE_IT (it
, &atx_it
, atx_data
);
8970 bidi_unshelve_cache (atpos_data
, true);
8972 bidi_unshelve_cache (atx_data
, true);
8974 bidi_unshelve_cache (wrap_data
, true);
8976 bidi_unshelve_cache (ppos_data
, true);
8978 /* Restore the iterator settings altered at the beginning of this
8980 it
->glyph_row
= saved_glyph_row
;
8984 /* For external use. */
8986 move_it_in_display_line (struct it
*it
,
8987 ptrdiff_t to_charpos
, int to_x
,
8988 enum move_operation_enum op
)
8990 if (it
->line_wrap
== WORD_WRAP
8991 && (op
& MOVE_TO_X
))
8994 void *save_data
= NULL
;
8997 SAVE_IT (save_it
, *it
, save_data
);
8998 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8999 /* When word-wrap is on, TO_X may lie past the end
9000 of a wrapped line. Then it->current is the
9001 character on the next line, so backtrack to the
9002 space before the wrap point. */
9003 if (skip
== MOVE_LINE_CONTINUED
)
9005 int prev_x
= max (it
->current_x
- 1, 0);
9006 RESTORE_IT (it
, &save_it
, save_data
);
9007 move_it_in_display_line_to
9008 (it
, -1, prev_x
, MOVE_TO_X
);
9011 bidi_unshelve_cache (save_data
, true);
9014 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9018 /* Move IT forward until it satisfies one or more of the criteria in
9019 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9021 OP is a bit-mask that specifies where to stop, and in particular,
9022 which of those four position arguments makes a difference. See the
9023 description of enum move_operation_enum.
9025 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9026 screen line, this function will set IT to the next position that is
9027 displayed to the right of TO_CHARPOS on the screen.
9029 Return the maximum pixel length of any line scanned but never more
9030 than it.last_visible_x. */
9033 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9035 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9036 int line_height
, line_start_x
= 0, reached
= 0;
9037 int max_current_x
= 0;
9038 void *backup_data
= NULL
;
9042 if (op
& MOVE_TO_VPOS
)
9044 /* If no TO_CHARPOS and no TO_X specified, stop at the
9045 start of the line TO_VPOS. */
9046 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9048 if (it
->vpos
== to_vpos
)
9054 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9058 /* TO_VPOS >= 0 means stop at TO_X in the line at
9059 TO_VPOS, or at TO_POS, whichever comes first. */
9060 if (it
->vpos
== to_vpos
)
9066 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9068 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9073 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9075 /* We have reached TO_X but not in the line we want. */
9076 skip
= move_it_in_display_line_to (it
, to_charpos
,
9078 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9086 else if (op
& MOVE_TO_Y
)
9088 struct it it_backup
;
9090 if (it
->line_wrap
== WORD_WRAP
)
9091 SAVE_IT (it_backup
, *it
, backup_data
);
9093 /* TO_Y specified means stop at TO_X in the line containing
9094 TO_Y---or at TO_CHARPOS if this is reached first. The
9095 problem is that we can't really tell whether the line
9096 contains TO_Y before we have completely scanned it, and
9097 this may skip past TO_X. What we do is to first scan to
9100 If TO_X is not specified, use a TO_X of zero. The reason
9101 is to make the outcome of this function more predictable.
9102 If we didn't use TO_X == 0, we would stop at the end of
9103 the line which is probably not what a caller would expect
9105 skip
= move_it_in_display_line_to
9106 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9107 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9109 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9110 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9112 else if (skip
== MOVE_X_REACHED
)
9114 /* If TO_X was reached, we want to know whether TO_Y is
9115 in the line. We know this is the case if the already
9116 scanned glyphs make the line tall enough. Otherwise,
9117 we must check by scanning the rest of the line. */
9118 line_height
= it
->max_ascent
+ it
->max_descent
;
9119 if (to_y
>= it
->current_y
9120 && to_y
< it
->current_y
+ line_height
)
9125 SAVE_IT (it_backup
, *it
, backup_data
);
9126 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9127 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9129 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9130 line_height
= it
->max_ascent
+ it
->max_descent
;
9131 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9133 if (to_y
>= it
->current_y
9134 && to_y
< it
->current_y
+ line_height
)
9136 /* If TO_Y is in this line and TO_X was reached
9137 above, we scanned too far. We have to restore
9138 IT's settings to the ones before skipping. But
9139 keep the more accurate values of max_ascent and
9140 max_descent we've found while skipping the rest
9141 of the line, for the sake of callers, such as
9142 pos_visible_p, that need to know the line
9144 int max_ascent
= it
->max_ascent
;
9145 int max_descent
= it
->max_descent
;
9147 RESTORE_IT (it
, &it_backup
, backup_data
);
9148 it
->max_ascent
= max_ascent
;
9149 it
->max_descent
= max_descent
;
9155 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9161 /* Check whether TO_Y is in this line. */
9162 line_height
= it
->max_ascent
+ it
->max_descent
;
9163 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9165 if (to_y
>= it
->current_y
9166 && to_y
< it
->current_y
+ line_height
)
9168 if (to_y
> it
->current_y
)
9169 max_current_x
= max (it
->current_x
, max_current_x
);
9171 /* When word-wrap is on, TO_X may lie past the end
9172 of a wrapped line. Then it->current is the
9173 character on the next line, so backtrack to the
9174 space before the wrap point. */
9175 if (skip
== MOVE_LINE_CONTINUED
9176 && it
->line_wrap
== WORD_WRAP
)
9178 int prev_x
= max (it
->current_x
- 1, 0);
9179 RESTORE_IT (it
, &it_backup
, backup_data
);
9180 skip
= move_it_in_display_line_to
9181 (it
, -1, prev_x
, MOVE_TO_X
);
9190 max_current_x
= max (it
->current_x
, max_current_x
);
9194 else if (BUFFERP (it
->object
)
9195 && (it
->method
== GET_FROM_BUFFER
9196 || it
->method
== GET_FROM_STRETCH
)
9197 && IT_CHARPOS (*it
) >= to_charpos
9198 /* Under bidi iteration, a call to set_iterator_to_next
9199 can scan far beyond to_charpos if the initial
9200 portion of the next line needs to be reordered. In
9201 that case, give move_it_in_display_line_to another
9204 && it
->bidi_it
.scan_dir
== -1))
9205 skip
= MOVE_POS_MATCH_OR_ZV
;
9207 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9211 case MOVE_POS_MATCH_OR_ZV
:
9212 max_current_x
= max (it
->current_x
, max_current_x
);
9216 case MOVE_NEWLINE_OR_CR
:
9217 max_current_x
= max (it
->current_x
, max_current_x
);
9218 set_iterator_to_next (it
, true);
9219 it
->continuation_lines_width
= 0;
9222 case MOVE_LINE_TRUNCATED
:
9223 max_current_x
= it
->last_visible_x
;
9224 it
->continuation_lines_width
= 0;
9225 reseat_at_next_visible_line_start (it
, false);
9226 if ((op
& MOVE_TO_POS
) != 0
9227 && IT_CHARPOS (*it
) > to_charpos
)
9234 case MOVE_LINE_CONTINUED
:
9235 max_current_x
= it
->last_visible_x
;
9236 /* For continued lines ending in a tab, some of the glyphs
9237 associated with the tab are displayed on the current
9238 line. Since it->current_x does not include these glyphs,
9239 we use it->last_visible_x instead. */
9242 it
->continuation_lines_width
+= it
->last_visible_x
;
9243 /* When moving by vpos, ensure that the iterator really
9244 advances to the next line (bug#847, bug#969). Fixme:
9245 do we need to do this in other circumstances? */
9246 if (it
->current_x
!= it
->last_visible_x
9247 && (op
& MOVE_TO_VPOS
)
9248 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9250 line_start_x
= it
->current_x
+ it
->pixel_width
9251 - it
->last_visible_x
;
9252 if (FRAME_WINDOW_P (it
->f
))
9254 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9255 struct font
*face_font
= face
->font
;
9257 /* When display_line produces a continued line
9258 that ends in a TAB, it skips a tab stop that
9259 is closer than the font's space character
9260 width (see x_produce_glyphs where it produces
9261 the stretch glyph which represents a TAB).
9262 We need to reproduce the same logic here. */
9263 eassert (face_font
);
9266 if (line_start_x
< face_font
->space_width
)
9268 += it
->tab_width
* face_font
->space_width
;
9271 set_iterator_to_next (it
, false);
9275 it
->continuation_lines_width
+= it
->current_x
;
9282 /* Reset/increment for the next run. */
9283 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9284 it
->current_x
= line_start_x
;
9287 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9289 last_height
= it
->max_ascent
+ it
->max_descent
;
9290 it
->max_ascent
= it
->max_descent
= 0;
9295 /* On text terminals, we may stop at the end of a line in the middle
9296 of a multi-character glyph. If the glyph itself is continued,
9297 i.e. it is actually displayed on the next line, don't treat this
9298 stopping point as valid; move to the next line instead (unless
9299 that brings us offscreen). */
9300 if (!FRAME_WINDOW_P (it
->f
)
9302 && IT_CHARPOS (*it
) == to_charpos
9303 && it
->what
== IT_CHARACTER
9305 && it
->line_wrap
== WINDOW_WRAP
9306 && it
->current_x
== it
->last_visible_x
- 1
9309 && it
->w
->window_end_valid
9310 && it
->vpos
< it
->w
->window_end_vpos
)
9312 it
->continuation_lines_width
+= it
->current_x
;
9313 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9314 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9316 last_height
= it
->max_ascent
+ it
->max_descent
;
9320 bidi_unshelve_cache (backup_data
, true);
9322 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9324 return max_current_x
;
9328 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9330 If DY > 0, move IT backward at least that many pixels. DY = 0
9331 means move IT backward to the preceding line start or BEGV. This
9332 function may move over more than DY pixels if IT->current_y - DY
9333 ends up in the middle of a line; in this case IT->current_y will be
9334 set to the top of the line moved to. */
9337 move_it_vertically_backward (struct it
*it
, int dy
)
9341 void *it2data
= NULL
, *it3data
= NULL
;
9342 ptrdiff_t start_pos
;
9344 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9345 ptrdiff_t pos_limit
;
9350 start_pos
= IT_CHARPOS (*it
);
9352 /* Estimate how many newlines we must move back. */
9353 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9354 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9357 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9359 /* Set the iterator's position that many lines back. But don't go
9360 back more than NLINES full screen lines -- this wins a day with
9361 buffers which have very long lines. */
9362 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9363 back_to_previous_visible_line_start (it
);
9365 /* Reseat the iterator here. When moving backward, we don't want
9366 reseat to skip forward over invisible text, set up the iterator
9367 to deliver from overlay strings at the new position etc. So,
9368 use reseat_1 here. */
9369 reseat_1 (it
, it
->current
.pos
, true);
9371 /* We are now surely at a line start. */
9372 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9373 reordering is in effect. */
9374 it
->continuation_lines_width
= 0;
9376 /* Move forward and see what y-distance we moved. First move to the
9377 start of the next line so that we get its height. We need this
9378 height to be able to tell whether we reached the specified
9380 SAVE_IT (it2
, *it
, it2data
);
9381 it2
.max_ascent
= it2
.max_descent
= 0;
9384 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9385 MOVE_TO_POS
| MOVE_TO_VPOS
);
9387 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9388 /* If we are in a display string which starts at START_POS,
9389 and that display string includes a newline, and we are
9390 right after that newline (i.e. at the beginning of a
9391 display line), exit the loop, because otherwise we will
9392 infloop, since move_it_to will see that it is already at
9393 START_POS and will not move. */
9394 || (it2
.method
== GET_FROM_STRING
9395 && IT_CHARPOS (it2
) == start_pos
9396 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9397 eassert (IT_CHARPOS (*it
) >= BEGV
);
9398 SAVE_IT (it3
, it2
, it3data
);
9400 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9401 eassert (IT_CHARPOS (*it
) >= BEGV
);
9402 /* H is the actual vertical distance from the position in *IT
9403 and the starting position. */
9404 h
= it2
.current_y
- it
->current_y
;
9405 /* NLINES is the distance in number of lines. */
9406 nlines
= it2
.vpos
- it
->vpos
;
9408 /* Correct IT's y and vpos position
9409 so that they are relative to the starting point. */
9415 /* DY == 0 means move to the start of the screen line. The
9416 value of nlines is > 0 if continuation lines were involved,
9417 or if the original IT position was at start of a line. */
9418 RESTORE_IT (it
, it
, it2data
);
9420 move_it_by_lines (it
, nlines
);
9421 /* The above code moves us to some position NLINES down,
9422 usually to its first glyph (leftmost in an L2R line), but
9423 that's not necessarily the start of the line, under bidi
9424 reordering. We want to get to the character position
9425 that is immediately after the newline of the previous
9428 && !it
->continuation_lines_width
9429 && !STRINGP (it
->string
)
9430 && IT_CHARPOS (*it
) > BEGV
9431 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9433 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9436 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9437 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9439 bidi_unshelve_cache (it3data
, true);
9443 /* The y-position we try to reach, relative to *IT.
9444 Note that H has been subtracted in front of the if-statement. */
9445 int target_y
= it
->current_y
+ h
- dy
;
9446 int y0
= it3
.current_y
;
9450 RESTORE_IT (&it3
, &it3
, it3data
);
9451 y1
= line_bottom_y (&it3
);
9452 line_height
= y1
- y0
;
9453 RESTORE_IT (it
, it
, it2data
);
9454 /* If we did not reach target_y, try to move further backward if
9455 we can. If we moved too far backward, try to move forward. */
9456 if (target_y
< it
->current_y
9457 /* This is heuristic. In a window that's 3 lines high, with
9458 a line height of 13 pixels each, recentering with point
9459 on the bottom line will try to move -39/2 = 19 pixels
9460 backward. Try to avoid moving into the first line. */
9461 && (it
->current_y
- target_y
9462 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9463 && IT_CHARPOS (*it
) > BEGV
)
9465 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9466 target_y
- it
->current_y
));
9467 dy
= it
->current_y
- target_y
;
9468 goto move_further_back
;
9470 else if (target_y
>= it
->current_y
+ line_height
9471 && IT_CHARPOS (*it
) < ZV
)
9473 /* Should move forward by at least one line, maybe more.
9475 Note: Calling move_it_by_lines can be expensive on
9476 terminal frames, where compute_motion is used (via
9477 vmotion) to do the job, when there are very long lines
9478 and truncate-lines is nil. That's the reason for
9479 treating terminal frames specially here. */
9481 if (!FRAME_WINDOW_P (it
->f
))
9482 move_it_vertically (it
, target_y
- it
->current_y
);
9487 move_it_by_lines (it
, 1);
9489 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9496 /* Move IT by a specified amount of pixel lines DY. DY negative means
9497 move backwards. DY = 0 means move to start of screen line. At the
9498 end, IT will be on the start of a screen line. */
9501 move_it_vertically (struct it
*it
, int dy
)
9504 move_it_vertically_backward (it
, -dy
);
9507 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9508 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9509 MOVE_TO_POS
| MOVE_TO_Y
);
9510 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9512 /* If buffer ends in ZV without a newline, move to the start of
9513 the line to satisfy the post-condition. */
9514 if (IT_CHARPOS (*it
) == ZV
9516 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9517 move_it_by_lines (it
, 0);
9522 /* Move iterator IT past the end of the text line it is in. */
9525 move_it_past_eol (struct it
*it
)
9527 enum move_it_result rc
;
9529 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9530 if (rc
== MOVE_NEWLINE_OR_CR
)
9531 set_iterator_to_next (it
, false);
9535 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9536 negative means move up. DVPOS == 0 means move to the start of the
9539 Optimization idea: If we would know that IT->f doesn't use
9540 a face with proportional font, we could be faster for
9541 truncate-lines nil. */
9544 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9547 /* The commented-out optimization uses vmotion on terminals. This
9548 gives bad results, because elements like it->what, on which
9549 callers such as pos_visible_p rely, aren't updated. */
9550 /* struct position pos;
9551 if (!FRAME_WINDOW_P (it->f))
9553 struct text_pos textpos;
9555 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9556 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9557 reseat (it, textpos, true);
9558 it->vpos += pos.vpos;
9559 it->current_y += pos.vpos;
9565 /* DVPOS == 0 means move to the start of the screen line. */
9566 move_it_vertically_backward (it
, 0);
9567 /* Let next call to line_bottom_y calculate real line height. */
9572 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9573 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9575 /* Only move to the next buffer position if we ended up in a
9576 string from display property, not in an overlay string
9577 (before-string or after-string). That is because the
9578 latter don't conceal the underlying buffer position, so
9579 we can ask to move the iterator to the exact position we
9580 are interested in. Note that, even if we are already at
9581 IT_CHARPOS (*it), the call below is not a no-op, as it
9582 will detect that we are at the end of the string, pop the
9583 iterator, and compute it->current_x and it->hpos
9585 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9586 -1, -1, -1, MOVE_TO_POS
);
9592 void *it2data
= NULL
;
9593 ptrdiff_t start_charpos
, i
;
9595 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9596 bool hit_pos_limit
= false;
9597 ptrdiff_t pos_limit
;
9599 /* Start at the beginning of the screen line containing IT's
9600 position. This may actually move vertically backwards,
9601 in case of overlays, so adjust dvpos accordingly. */
9603 move_it_vertically_backward (it
, 0);
9606 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9607 screen lines, and reseat the iterator there. */
9608 start_charpos
= IT_CHARPOS (*it
);
9609 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9612 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9614 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9615 back_to_previous_visible_line_start (it
);
9616 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9617 hit_pos_limit
= true;
9618 reseat (it
, it
->current
.pos
, true);
9620 /* Move further back if we end up in a string or an image. */
9621 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9623 /* First try to move to start of display line. */
9625 move_it_vertically_backward (it
, 0);
9627 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9629 /* If start of line is still in string or image,
9630 move further back. */
9631 back_to_previous_visible_line_start (it
);
9632 reseat (it
, it
->current
.pos
, true);
9636 it
->current_x
= it
->hpos
= 0;
9638 /* Above call may have moved too far if continuation lines
9639 are involved. Scan forward and see if it did. */
9640 SAVE_IT (it2
, *it
, it2data
);
9641 it2
.vpos
= it2
.current_y
= 0;
9642 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9643 it
->vpos
-= it2
.vpos
;
9644 it
->current_y
-= it2
.current_y
;
9645 it
->current_x
= it
->hpos
= 0;
9647 /* If we moved too far back, move IT some lines forward. */
9648 if (it2
.vpos
> -dvpos
)
9650 int delta
= it2
.vpos
+ dvpos
;
9652 RESTORE_IT (&it2
, &it2
, it2data
);
9653 SAVE_IT (it2
, *it
, it2data
);
9654 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9655 /* Move back again if we got too far ahead. */
9656 if (IT_CHARPOS (*it
) >= start_charpos
)
9657 RESTORE_IT (it
, &it2
, it2data
);
9659 bidi_unshelve_cache (it2data
, true);
9661 else if (hit_pos_limit
&& pos_limit
> BEGV
9662 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9664 /* If we hit the limit, but still didn't make it far enough
9665 back, that means there's a display string with a newline
9666 covering a large chunk of text, and that caused
9667 back_to_previous_visible_line_start try to go too far.
9668 Punish those who commit such atrocities by going back
9669 until we've reached DVPOS, after lifting the limit, which
9670 could make it slow for very long lines. "If it hurts,
9673 RESTORE_IT (it
, it
, it2data
);
9674 for (i
= -dvpos
; i
> 0; --i
)
9676 back_to_previous_visible_line_start (it
);
9679 reseat_1 (it
, it
->current
.pos
, true);
9682 RESTORE_IT (it
, it
, it2data
);
9686 /* Return true if IT points into the middle of a display vector. */
9689 in_display_vector_p (struct it
*it
)
9691 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9692 && it
->current
.dpvec_index
> 0
9693 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9696 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9697 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9698 WINDOW must be a live window and defaults to the selected one. The
9699 return value is a cons of the maximum pixel-width of any text line and
9700 the maximum pixel-height of all text lines.
9702 The optional argument FROM, if non-nil, specifies the first text
9703 position and defaults to the minimum accessible position of the buffer.
9704 If FROM is t, use the minimum accessible position that is not a newline
9705 character. TO, if non-nil, specifies the last text position and
9706 defaults to the maximum accessible position of the buffer. If TO is t,
9707 use the maximum accessible position that is not a newline character.
9709 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9710 width that can be returned. X-LIMIT nil or omitted, means to use the
9711 pixel-width of WINDOW's body; use this if you do not intend to change
9712 the width of WINDOW. Use the maximum width WINDOW may assume if you
9713 intend to change WINDOW's width. In any case, text whose x-coordinate
9714 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9715 can take some time, it's always a good idea to make this argument as
9716 small as possible; in particular, if the buffer contains long lines that
9717 shall be truncated anyway.
9719 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9720 height that can be returned. Text lines whose y-coordinate is beyond
9721 Y-LIMIT are ignored. Since calculating the text height of a large
9722 buffer can take some time, it makes sense to specify this argument if
9723 the size of the buffer is unknown.
9725 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9726 include the height of the mode- or header-line of WINDOW in the return
9727 value. If it is either the symbol `mode-line' or `header-line', include
9728 only the height of that line, if present, in the return value. If t,
9729 include the height of both, if present, in the return value. */)
9730 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
,
9731 Lisp_Object y_limit
, Lisp_Object mode_and_header_line
)
9733 struct window
*w
= decode_live_window (window
);
9734 Lisp_Object buffer
= w
->contents
;
9737 struct buffer
*old_b
= NULL
;
9738 ptrdiff_t start
, end
, pos
;
9739 struct text_pos startp
;
9740 void *itdata
= NULL
;
9741 int c
, max_y
= -1, x
= 0, y
= 0;
9743 CHECK_BUFFER (buffer
);
9744 b
= XBUFFER (buffer
);
9746 if (b
!= current_buffer
)
9748 old_b
= current_buffer
;
9749 set_buffer_internal (b
);
9754 else if (EQ (from
, Qt
))
9757 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9758 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9760 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9765 CHECK_NUMBER_COERCE_MARKER (from
);
9766 start
= min (max (XINT (from
), BEGV
), ZV
);
9771 else if (EQ (to
, Qt
))
9774 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9775 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9777 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9782 CHECK_NUMBER_COERCE_MARKER (to
);
9783 end
= max (start
, min (XINT (to
), ZV
));
9786 if (!NILP (y_limit
))
9788 CHECK_NUMBER (y_limit
);
9789 max_y
= min (XINT (y_limit
), INT_MAX
);
9792 itdata
= bidi_shelve_cache ();
9793 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9794 start_display (&it
, w
, startp
);
9797 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9800 CHECK_NUMBER (x_limit
);
9801 it
.last_visible_x
= min (XINT (x_limit
), INFINITY
);
9802 /* Actually, we never want move_it_to stop at to_x. But to make
9803 sure that move_it_in_display_line_to always moves far enough,
9804 we set it to INT_MAX and specify MOVE_TO_X. */
9805 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9806 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9809 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9811 if (!EQ (mode_and_header_line
, Qheader_line
)
9812 && !EQ (mode_and_header_line
, Qt
))
9813 /* Do not count the header-line which was counted automatically by
9815 y
= y
- WINDOW_HEADER_LINE_HEIGHT (w
);
9817 if (EQ (mode_and_header_line
, Qmode_line
)
9818 || EQ (mode_and_header_line
, Qt
))
9819 /* Do count the mode-line which is not included automatically by
9821 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9823 bidi_unshelve_cache (itdata
, false);
9826 set_buffer_internal (old_b
);
9828 return Fcons (make_number (x
), make_number (y
));
9831 /***********************************************************************
9833 ***********************************************************************/
9835 /* Return the number of arguments the format string FORMAT needs. */
9838 format_nargs (char const *format
)
9840 ptrdiff_t nargs
= 0;
9841 for (char const *p
= format
; (p
= strchr (p
, '%')); p
++)
9849 /* Add a message with format string FORMAT and formatted arguments
9853 add_to_log (const char *format
, ...)
9856 va_start (ap
, format
);
9857 vadd_to_log (format
, ap
);
9862 vadd_to_log (char const *format
, va_list ap
)
9864 ptrdiff_t form_nargs
= format_nargs (format
);
9865 ptrdiff_t nargs
= 1 + form_nargs
;
9866 Lisp_Object args
[10];
9867 eassert (nargs
<= ARRAYELTS (args
));
9868 AUTO_STRING (args0
, format
);
9870 for (ptrdiff_t i
= 1; i
<= nargs
; i
++)
9871 args
[i
] = va_arg (ap
, Lisp_Object
);
9872 Lisp_Object msg
= Qnil
;
9873 msg
= Fformat_message (nargs
, args
);
9875 ptrdiff_t len
= SBYTES (msg
) + 1;
9877 char *buffer
= SAFE_ALLOCA (len
);
9878 memcpy (buffer
, SDATA (msg
), len
);
9880 message_dolog (buffer
, len
- 1, true, STRING_MULTIBYTE (msg
));
9885 /* Output a newline in the *Messages* buffer if "needs" one. */
9888 message_log_maybe_newline (void)
9890 if (message_log_need_newline
)
9891 message_dolog ("", 0, true, false);
9895 /* Add a string M of length NBYTES to the message log, optionally
9896 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9897 true, means interpret the contents of M as multibyte. This
9898 function calls low-level routines in order to bypass text property
9899 hooks, etc. which might not be safe to run.
9901 This may GC (insert may run before/after change hooks),
9902 so the buffer M must NOT point to a Lisp string. */
9905 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9907 const unsigned char *msg
= (const unsigned char *) m
;
9909 if (!NILP (Vmemory_full
))
9912 if (!NILP (Vmessage_log_max
))
9914 struct buffer
*oldbuf
;
9915 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9916 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9917 ptrdiff_t point_at_end
= 0;
9918 ptrdiff_t zv_at_end
= 0;
9919 Lisp_Object old_deactivate_mark
;
9921 old_deactivate_mark
= Vdeactivate_mark
;
9922 oldbuf
= current_buffer
;
9924 /* Ensure the Messages buffer exists, and switch to it.
9925 If we created it, set the major-mode. */
9926 bool newbuffer
= NILP (Fget_buffer (Vmessages_buffer_name
));
9927 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9929 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9930 call0 (intern ("messages-buffer-mode"));
9932 bset_undo_list (current_buffer
, Qt
);
9933 bset_cache_long_scans (current_buffer
, Qnil
);
9935 oldpoint
= message_dolog_marker1
;
9936 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
9937 oldbegv
= message_dolog_marker2
;
9938 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
9939 oldzv
= message_dolog_marker3
;
9940 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
9948 BEGV_BYTE
= BEG_BYTE
;
9951 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9953 /* Insert the string--maybe converting multibyte to single byte
9954 or vice versa, so that all the text fits the buffer. */
9956 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9962 /* Convert a multibyte string to single-byte
9963 for the *Message* buffer. */
9964 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9966 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9967 work
[0] = CHAR_TO_BYTE8 (c
);
9968 insert_1_both (work
, 1, 1, true, false, false);
9971 else if (! multibyte
9972 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9976 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9977 /* Convert a single-byte string to multibyte
9978 for the *Message* buffer. */
9979 for (i
= 0; i
< nbytes
; i
++)
9982 MAKE_CHAR_MULTIBYTE (c
);
9983 char_bytes
= CHAR_STRING (c
, str
);
9984 insert_1_both ((char *) str
, 1, char_bytes
, true, false, false);
9988 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
,
9989 true, false, false);
9993 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9996 insert_1_both ("\n", 1, 1, true, false, false);
9998 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, false);
10000 this_bol_byte
= PT_BYTE
;
10002 /* See if this line duplicates the previous one.
10003 If so, combine duplicates. */
10004 if (this_bol
> BEG
)
10006 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, false);
10008 prev_bol_byte
= PT_BYTE
;
10010 dups
= message_log_check_duplicate (prev_bol_byte
,
10014 del_range_both (prev_bol
, prev_bol_byte
,
10015 this_bol
, this_bol_byte
, false);
10018 char dupstr
[sizeof " [ times]"
10019 + INT_STRLEN_BOUND (printmax_t
)];
10021 /* If you change this format, don't forget to also
10022 change message_log_check_duplicate. */
10023 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
10024 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
10025 insert_1_both (dupstr
, duplen
, duplen
,
10026 true, false, true);
10031 /* If we have more than the desired maximum number of lines
10032 in the *Messages* buffer now, delete the oldest ones.
10033 This is safe because we don't have undo in this buffer. */
10035 if (NATNUMP (Vmessage_log_max
))
10037 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10038 -XFASTINT (Vmessage_log_max
) - 1, false);
10039 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, false);
10042 BEGV
= marker_position (oldbegv
);
10043 BEGV_BYTE
= marker_byte_position (oldbegv
);
10052 ZV
= marker_position (oldzv
);
10053 ZV_BYTE
= marker_byte_position (oldzv
);
10057 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10059 /* We can't do Fgoto_char (oldpoint) because it will run some
10061 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10062 marker_byte_position (oldpoint
));
10064 unchain_marker (XMARKER (oldpoint
));
10065 unchain_marker (XMARKER (oldbegv
));
10066 unchain_marker (XMARKER (oldzv
));
10068 /* We called insert_1_both above with its 5th argument (PREPARE)
10069 false, which prevents insert_1_both from calling
10070 prepare_to_modify_buffer, which in turns prevents us from
10071 incrementing windows_or_buffers_changed even if *Messages* is
10072 shown in some window. So we must manually set
10073 windows_or_buffers_changed here to make up for that. */
10074 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10075 bset_redisplay (current_buffer
);
10077 set_buffer_internal (oldbuf
);
10079 message_log_need_newline
= !nlflag
;
10080 Vdeactivate_mark
= old_deactivate_mark
;
10085 /* We are at the end of the buffer after just having inserted a newline.
10086 (Note: We depend on the fact we won't be crossing the gap.)
10087 Check to see if the most recent message looks a lot like the previous one.
10088 Return 0 if different, 1 if the new one should just replace it, or a
10089 value N > 1 if we should also append " [N times]". */
10092 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10095 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10096 bool seen_dots
= false;
10097 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10098 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10100 for (i
= 0; i
< len
; i
++)
10102 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10104 if (p1
[i
] != p2
[i
])
10110 if (*p1
++ == ' ' && *p1
++ == '[')
10113 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10114 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10121 /* Display an echo area message M with a specified length of NBYTES
10122 bytes. The string may include null characters. If M is not a
10123 string, clear out any existing message, and let the mini-buffer
10126 This function cancels echoing. */
10129 message3 (Lisp_Object m
)
10131 clear_message (true, true);
10134 /* First flush out any partial line written with print. */
10135 message_log_maybe_newline ();
10138 ptrdiff_t nbytes
= SBYTES (m
);
10139 bool multibyte
= STRING_MULTIBYTE (m
);
10142 SAFE_ALLOCA_STRING (buffer
, m
);
10143 message_dolog (buffer
, nbytes
, true, multibyte
);
10146 if (! inhibit_message
)
10147 message3_nolog (m
);
10150 /* Log the message M to stderr. Log an empty line if M is not a string. */
10153 message_to_stderr (Lisp_Object m
)
10155 if (noninteractive_need_newline
)
10157 noninteractive_need_newline
= false;
10158 fputc ('\n', stderr
);
10162 Lisp_Object s
= ENCODE_SYSTEM (m
);
10163 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10165 if (!cursor_in_echo_area
)
10166 fputc ('\n', stderr
);
10170 /* The non-logging version of message3.
10171 This does not cancel echoing, because it is used for echoing.
10172 Perhaps we need to make a separate function for echoing
10173 and make this cancel echoing. */
10176 message3_nolog (Lisp_Object m
)
10178 struct frame
*sf
= SELECTED_FRAME ();
10180 if (FRAME_INITIAL_P (sf
))
10181 message_to_stderr (m
);
10182 /* Error messages get reported properly by cmd_error, so this must be just an
10183 informative message; if the frame hasn't really been initialized yet, just
10185 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10187 /* Get the frame containing the mini-buffer
10188 that the selected frame is using. */
10189 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10190 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10191 struct frame
*f
= XFRAME (frame
);
10193 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10194 Fmake_frame_visible (frame
);
10196 if (STRINGP (m
) && SCHARS (m
) > 0)
10199 if (minibuffer_auto_raise
)
10200 Fraise_frame (frame
);
10201 /* Assume we are not echoing.
10202 (If we are, echo_now will override this.) */
10203 echo_message_buffer
= Qnil
;
10206 clear_message (true, true);
10208 do_pending_window_change (false);
10209 echo_area_display (true);
10210 do_pending_window_change (false);
10211 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10212 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10217 /* Display a null-terminated echo area message M. If M is 0, clear
10218 out any existing message, and let the mini-buffer text show through.
10220 The buffer M must continue to exist until after the echo area gets
10221 cleared or some other message gets displayed there. Do not pass
10222 text that is stored in a Lisp string. Do not pass text in a buffer
10223 that was alloca'd. */
10226 message1 (const char *m
)
10228 message3 (m
? build_unibyte_string (m
) : Qnil
);
10232 /* The non-logging counterpart of message1. */
10235 message1_nolog (const char *m
)
10237 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10240 /* Display a message M which contains a single %s
10241 which gets replaced with STRING. */
10244 message_with_string (const char *m
, Lisp_Object string
, bool log
)
10246 CHECK_STRING (string
);
10249 if (noninteractive
)
10250 need_message
= !!m
;
10251 else if (!INTERACTIVE
)
10252 need_message
= false;
10255 /* The frame whose minibuffer we're going to display the message on.
10256 It may be larger than the selected frame, so we need
10257 to use its buffer, not the selected frame's buffer. */
10258 Lisp_Object mini_window
;
10259 struct frame
*f
, *sf
= SELECTED_FRAME ();
10261 /* Get the frame containing the minibuffer
10262 that the selected frame is using. */
10263 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10264 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10266 /* Error messages get reported properly by cmd_error, so this must be
10267 just an informative message; if the frame hasn't really been
10268 initialized yet, just toss it. */
10269 need_message
= f
->glyphs_initialized_p
;
10274 AUTO_STRING (fmt
, m
);
10275 Lisp_Object msg
= CALLN (Fformat_message
, fmt
, string
);
10277 if (noninteractive
)
10278 message_to_stderr (msg
);
10284 message3_nolog (msg
);
10286 /* Print should start at the beginning of the message
10287 buffer next time. */
10288 message_buf_print
= false;
10294 /* Dump an informative message to the minibuf. If M is 0, clear out
10295 any existing message, and let the mini-buffer text show through.
10297 The message must be safe ASCII and the format must not contain ` or
10298 '. If your message and format do not fit into this category,
10299 convert your arguments to Lisp objects and use Fmessage instead. */
10301 static void ATTRIBUTE_FORMAT_PRINTF (1, 0)
10302 vmessage (const char *m
, va_list ap
)
10304 if (noninteractive
)
10308 if (noninteractive_need_newline
)
10309 putc ('\n', stderr
);
10310 noninteractive_need_newline
= false;
10311 vfprintf (stderr
, m
, ap
);
10312 if (!cursor_in_echo_area
)
10313 fprintf (stderr
, "\n");
10317 else if (INTERACTIVE
)
10319 /* The frame whose mini-buffer we're going to display the message
10320 on. It may be larger than the selected frame, so we need to
10321 use its buffer, not the selected frame's buffer. */
10322 Lisp_Object mini_window
;
10323 struct frame
*f
, *sf
= SELECTED_FRAME ();
10325 /* Get the frame containing the mini-buffer
10326 that the selected frame is using. */
10327 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10328 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10330 /* Error messages get reported properly by cmd_error, so this must be
10331 just an informative message; if the frame hasn't really been
10332 initialized yet, just toss it. */
10333 if (f
->glyphs_initialized_p
)
10338 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10340 char *message_buf
= SAFE_ALLOCA (maxsize
+ 1);
10342 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10344 message3 (make_string (message_buf
, len
));
10350 /* Print should start at the beginning of the message
10351 buffer next time. */
10352 message_buf_print
= false;
10358 message (const char *m
, ...)
10367 /* Display the current message in the current mini-buffer. This is
10368 only called from error handlers in process.c, and is not time
10372 update_echo_area (void)
10374 if (!NILP (echo_area_buffer
[0]))
10376 Lisp_Object string
;
10377 string
= Fcurrent_message ();
10383 /* Make sure echo area buffers in `echo_buffers' are live.
10384 If they aren't, make new ones. */
10387 ensure_echo_area_buffers (void)
10391 for (i
= 0; i
< 2; ++i
)
10392 if (!BUFFERP (echo_buffer
[i
])
10393 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10396 Lisp_Object old_buffer
;
10399 old_buffer
= echo_buffer
[i
];
10400 echo_buffer
[i
] = Fget_buffer_create
10401 (make_formatted_string (name
, " *Echo Area %d*", i
));
10402 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10403 /* to force word wrap in echo area -
10404 it was decided to postpone this*/
10405 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10407 for (j
= 0; j
< 2; ++j
)
10408 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10409 echo_area_buffer
[j
] = echo_buffer
[i
];
10414 /* Call FN with args A1..A2 with either the current or last displayed
10415 echo_area_buffer as current buffer.
10417 WHICH zero means use the current message buffer
10418 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10419 from echo_buffer[] and clear it.
10421 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10422 suitable buffer from echo_buffer[] and clear it.
10424 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10425 that the current message becomes the last displayed one, make
10426 choose a suitable buffer for echo_area_buffer[0], and clear it.
10428 Value is what FN returns. */
10431 with_echo_area_buffer (struct window
*w
, int which
,
10432 bool (*fn
) (ptrdiff_t, Lisp_Object
),
10433 ptrdiff_t a1
, Lisp_Object a2
)
10435 Lisp_Object buffer
;
10436 bool this_one
, the_other
, clear_buffer_p
, rc
;
10437 ptrdiff_t count
= SPECPDL_INDEX ();
10439 /* If buffers aren't live, make new ones. */
10440 ensure_echo_area_buffers ();
10442 clear_buffer_p
= false;
10445 this_one
= false, the_other
= true;
10446 else if (which
> 0)
10447 this_one
= true, the_other
= false;
10450 this_one
= false, the_other
= true;
10451 clear_buffer_p
= true;
10453 /* We need a fresh one in case the current echo buffer equals
10454 the one containing the last displayed echo area message. */
10455 if (!NILP (echo_area_buffer
[this_one
])
10456 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10457 echo_area_buffer
[this_one
] = Qnil
;
10460 /* Choose a suitable buffer from echo_buffer[] is we don't
10462 if (NILP (echo_area_buffer
[this_one
]))
10464 echo_area_buffer
[this_one
]
10465 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10466 ? echo_buffer
[the_other
]
10467 : echo_buffer
[this_one
]);
10468 clear_buffer_p
= true;
10471 buffer
= echo_area_buffer
[this_one
];
10473 /* Don't get confused by reusing the buffer used for echoing
10474 for a different purpose. */
10475 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10478 record_unwind_protect (unwind_with_echo_area_buffer
,
10479 with_echo_area_buffer_unwind_data (w
));
10481 /* Make the echo area buffer current. Note that for display
10482 purposes, it is not necessary that the displayed window's buffer
10483 == current_buffer, except for text property lookup. So, let's
10484 only set that buffer temporarily here without doing a full
10485 Fset_window_buffer. We must also change w->pointm, though,
10486 because otherwise an assertions in unshow_buffer fails, and Emacs
10488 set_buffer_internal_1 (XBUFFER (buffer
));
10491 wset_buffer (w
, buffer
);
10492 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10493 set_marker_both (w
->old_pointm
, buffer
, BEG
, BEG_BYTE
);
10496 bset_undo_list (current_buffer
, Qt
);
10497 bset_read_only (current_buffer
, Qnil
);
10498 specbind (Qinhibit_read_only
, Qt
);
10499 specbind (Qinhibit_modification_hooks
, Qt
);
10501 if (clear_buffer_p
&& Z
> BEG
)
10502 del_range (BEG
, Z
);
10504 eassert (BEGV
>= BEG
);
10505 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10509 eassert (BEGV
>= BEG
);
10510 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10512 unbind_to (count
, Qnil
);
10517 /* Save state that should be preserved around the call to the function
10518 FN called in with_echo_area_buffer. */
10521 with_echo_area_buffer_unwind_data (struct window
*w
)
10524 Lisp_Object vector
, tmp
;
10526 /* Reduce consing by keeping one vector in
10527 Vwith_echo_area_save_vector. */
10528 vector
= Vwith_echo_area_save_vector
;
10529 Vwith_echo_area_save_vector
= Qnil
;
10532 vector
= Fmake_vector (make_number (11), Qnil
);
10534 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10535 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10536 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10540 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10541 ASET (vector
, i
, w
->contents
); ++i
;
10542 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10543 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10544 ASET (vector
, i
, make_number (marker_position (w
->old_pointm
))); ++i
;
10545 ASET (vector
, i
, make_number (marker_byte_position (w
->old_pointm
))); ++i
;
10546 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10547 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10552 for (; i
< end
; ++i
)
10553 ASET (vector
, i
, Qnil
);
10556 eassert (i
== ASIZE (vector
));
10561 /* Restore global state from VECTOR which was created by
10562 with_echo_area_buffer_unwind_data. */
10565 unwind_with_echo_area_buffer (Lisp_Object vector
)
10567 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10568 Vdeactivate_mark
= AREF (vector
, 1);
10569 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10571 if (WINDOWP (AREF (vector
, 3)))
10574 Lisp_Object buffer
;
10576 w
= XWINDOW (AREF (vector
, 3));
10577 buffer
= AREF (vector
, 4);
10579 wset_buffer (w
, buffer
);
10580 set_marker_both (w
->pointm
, buffer
,
10581 XFASTINT (AREF (vector
, 5)),
10582 XFASTINT (AREF (vector
, 6)));
10583 set_marker_both (w
->old_pointm
, buffer
,
10584 XFASTINT (AREF (vector
, 7)),
10585 XFASTINT (AREF (vector
, 8)));
10586 set_marker_both (w
->start
, buffer
,
10587 XFASTINT (AREF (vector
, 9)),
10588 XFASTINT (AREF (vector
, 10)));
10591 Vwith_echo_area_save_vector
= vector
;
10595 /* Set up the echo area for use by print functions. MULTIBYTE_P
10596 means we will print multibyte. */
10599 setup_echo_area_for_printing (bool multibyte_p
)
10601 /* If we can't find an echo area any more, exit. */
10602 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10603 Fkill_emacs (Qnil
);
10605 ensure_echo_area_buffers ();
10607 if (!message_buf_print
)
10609 /* A message has been output since the last time we printed.
10610 Choose a fresh echo area buffer. */
10611 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10612 echo_area_buffer
[0] = echo_buffer
[1];
10614 echo_area_buffer
[0] = echo_buffer
[0];
10616 /* Switch to that buffer and clear it. */
10617 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10618 bset_truncate_lines (current_buffer
, Qnil
);
10622 ptrdiff_t count
= SPECPDL_INDEX ();
10623 specbind (Qinhibit_read_only
, Qt
);
10624 /* Note that undo recording is always disabled. */
10625 del_range (BEG
, Z
);
10626 unbind_to (count
, Qnil
);
10628 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10630 /* Set up the buffer for the multibyteness we need. */
10632 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10633 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10635 /* Raise the frame containing the echo area. */
10636 if (minibuffer_auto_raise
)
10638 struct frame
*sf
= SELECTED_FRAME ();
10639 Lisp_Object mini_window
;
10640 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10641 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10644 message_log_maybe_newline ();
10645 message_buf_print
= true;
10649 if (NILP (echo_area_buffer
[0]))
10651 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10652 echo_area_buffer
[0] = echo_buffer
[1];
10654 echo_area_buffer
[0] = echo_buffer
[0];
10657 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10659 /* Someone switched buffers between print requests. */
10660 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10661 bset_truncate_lines (current_buffer
, Qnil
);
10667 /* Display an echo area message in window W. Value is true if W's
10668 height is changed. If display_last_displayed_message_p,
10669 display the message that was last displayed, otherwise
10670 display the current message. */
10673 display_echo_area (struct window
*w
)
10675 bool no_message_p
, window_height_changed_p
;
10677 /* Temporarily disable garbage collections while displaying the echo
10678 area. This is done because a GC can print a message itself.
10679 That message would modify the echo area buffer's contents while a
10680 redisplay of the buffer is going on, and seriously confuse
10682 ptrdiff_t count
= inhibit_garbage_collection ();
10684 /* If there is no message, we must call display_echo_area_1
10685 nevertheless because it resizes the window. But we will have to
10686 reset the echo_area_buffer in question to nil at the end because
10687 with_echo_area_buffer will sets it to an empty buffer. */
10688 bool i
= display_last_displayed_message_p
;
10689 no_message_p
= NILP (echo_area_buffer
[i
]);
10691 window_height_changed_p
10692 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10693 display_echo_area_1
,
10694 (intptr_t) w
, Qnil
);
10697 echo_area_buffer
[i
] = Qnil
;
10699 unbind_to (count
, Qnil
);
10700 return window_height_changed_p
;
10704 /* Helper for display_echo_area. Display the current buffer which
10705 contains the current echo area message in window W, a mini-window,
10706 a pointer to which is passed in A1. A2..A4 are currently not used.
10707 Change the height of W so that all of the message is displayed.
10708 Value is true if height of W was changed. */
10711 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10714 struct window
*w
= (struct window
*) i1
;
10715 Lisp_Object window
;
10716 struct text_pos start
;
10718 /* We are about to enter redisplay without going through
10719 redisplay_internal, so we need to forget these faces by hand
10721 forget_escape_and_glyphless_faces ();
10723 /* Do this before displaying, so that we have a large enough glyph
10724 matrix for the display. If we can't get enough space for the
10725 whole text, display the last N lines. That works by setting w->start. */
10726 bool window_height_changed_p
= resize_mini_window (w
, false);
10728 /* Use the starting position chosen by resize_mini_window. */
10729 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10732 clear_glyph_matrix (w
->desired_matrix
);
10733 XSETWINDOW (window
, w
);
10734 try_window (window
, start
, 0);
10736 return window_height_changed_p
;
10740 /* Resize the echo area window to exactly the size needed for the
10741 currently displayed message, if there is one. If a mini-buffer
10742 is active, don't shrink it. */
10745 resize_echo_area_exactly (void)
10747 if (BUFFERP (echo_area_buffer
[0])
10748 && WINDOWP (echo_area_window
))
10750 struct window
*w
= XWINDOW (echo_area_window
);
10751 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10752 bool resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10753 (intptr_t) w
, resize_exactly
);
10756 windows_or_buffers_changed
= 42;
10757 update_mode_lines
= 30;
10758 redisplay_internal ();
10764 /* Callback function for with_echo_area_buffer, when used from
10765 resize_echo_area_exactly. A1 contains a pointer to the window to
10766 resize, EXACTLY non-nil means resize the mini-window exactly to the
10767 size of the text displayed. A3 and A4 are not used. Value is what
10768 resize_mini_window returns. */
10771 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10774 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10778 /* Resize mini-window W to fit the size of its contents. EXACT_P
10779 means size the window exactly to the size needed. Otherwise, it's
10780 only enlarged until W's buffer is empty.
10782 Set W->start to the right place to begin display. If the whole
10783 contents fit, start at the beginning. Otherwise, start so as
10784 to make the end of the contents appear. This is particularly
10785 important for y-or-n-p, but seems desirable generally.
10787 Value is true if the window height has been changed. */
10790 resize_mini_window (struct window
*w
, bool exact_p
)
10792 struct frame
*f
= XFRAME (w
->frame
);
10793 bool window_height_changed_p
= false;
10795 eassert (MINI_WINDOW_P (w
));
10797 /* By default, start display at the beginning. */
10798 set_marker_both (w
->start
, w
->contents
,
10799 BUF_BEGV (XBUFFER (w
->contents
)),
10800 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10802 /* Don't resize windows while redisplaying a window; it would
10803 confuse redisplay functions when the size of the window they are
10804 displaying changes from under them. Such a resizing can happen,
10805 for instance, when which-func prints a long message while
10806 we are running fontification-functions. We're running these
10807 functions with safe_call which binds inhibit-redisplay to t. */
10808 if (!NILP (Vinhibit_redisplay
))
10811 /* Nil means don't try to resize. */
10812 if (NILP (Vresize_mini_windows
)
10813 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10816 if (!FRAME_MINIBUF_ONLY_P (f
))
10819 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10820 + WINDOW_PIXEL_HEIGHT (w
));
10821 int unit
= FRAME_LINE_HEIGHT (f
);
10822 int height
, max_height
;
10823 struct text_pos start
;
10824 struct buffer
*old_current_buffer
= NULL
;
10826 if (current_buffer
!= XBUFFER (w
->contents
))
10828 old_current_buffer
= current_buffer
;
10829 set_buffer_internal (XBUFFER (w
->contents
));
10832 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10834 /* Compute the max. number of lines specified by the user. */
10835 if (FLOATP (Vmax_mini_window_height
))
10836 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10837 else if (INTEGERP (Vmax_mini_window_height
))
10838 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10840 max_height
= total_height
/ 4;
10842 /* Correct that max. height if it's bogus. */
10843 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10845 /* Find out the height of the text in the window. */
10846 if (it
.line_wrap
== TRUNCATE
)
10851 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10852 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10853 height
= it
.current_y
+ last_height
;
10855 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10856 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10859 /* Compute a suitable window start. */
10860 if (height
> max_height
)
10862 height
= (max_height
/ unit
) * unit
;
10863 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10864 move_it_vertically_backward (&it
, height
- unit
);
10865 start
= it
.current
.pos
;
10868 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10869 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10871 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10873 /* Let it grow only, until we display an empty message, in which
10874 case the window shrinks again. */
10875 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10877 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10879 FRAME_WINDOWS_FROZEN (f
) = true;
10880 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10881 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10883 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10884 && (exact_p
|| BEGV
== ZV
))
10886 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10888 FRAME_WINDOWS_FROZEN (f
) = false;
10889 shrink_mini_window (w
, true);
10890 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10895 /* Always resize to exact size needed. */
10896 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10898 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10900 FRAME_WINDOWS_FROZEN (f
) = true;
10901 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10902 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10904 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
10906 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10908 FRAME_WINDOWS_FROZEN (f
) = false;
10909 shrink_mini_window (w
, true);
10913 FRAME_WINDOWS_FROZEN (f
) = true;
10914 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10917 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10921 if (old_current_buffer
)
10922 set_buffer_internal (old_current_buffer
);
10925 return window_height_changed_p
;
10929 /* Value is the current message, a string, or nil if there is no
10930 current message. */
10933 current_message (void)
10937 if (!BUFFERP (echo_area_buffer
[0]))
10941 with_echo_area_buffer (0, 0, current_message_1
,
10942 (intptr_t) &msg
, Qnil
);
10944 echo_area_buffer
[0] = Qnil
;
10952 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
10955 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10958 *msg
= make_buffer_string (BEG
, Z
, true);
10965 /* Push the current message on Vmessage_stack for later restoration
10966 by restore_message. Value is true if the current message isn't
10967 empty. This is a relatively infrequent operation, so it's not
10968 worth optimizing. */
10971 push_message (void)
10973 Lisp_Object msg
= current_message ();
10974 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10975 return STRINGP (msg
);
10979 /* Restore message display from the top of Vmessage_stack. */
10982 restore_message (void)
10984 eassert (CONSP (Vmessage_stack
));
10985 message3_nolog (XCAR (Vmessage_stack
));
10989 /* Handler for unwind-protect calling pop_message. */
10992 pop_message_unwind (void)
10994 /* Pop the top-most entry off Vmessage_stack. */
10995 eassert (CONSP (Vmessage_stack
));
10996 Vmessage_stack
= XCDR (Vmessage_stack
);
11000 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11001 exits. If the stack is not empty, we have a missing pop_message
11005 check_message_stack (void)
11007 if (!NILP (Vmessage_stack
))
11012 /* Truncate to NCHARS what will be displayed in the echo area the next
11013 time we display it---but don't redisplay it now. */
11016 truncate_echo_area (ptrdiff_t nchars
)
11019 echo_area_buffer
[0] = Qnil
;
11020 else if (!noninteractive
11022 && !NILP (echo_area_buffer
[0]))
11024 struct frame
*sf
= SELECTED_FRAME ();
11025 /* Error messages get reported properly by cmd_error, so this must be
11026 just an informative message; if the frame hasn't really been
11027 initialized yet, just toss it. */
11028 if (sf
->glyphs_initialized_p
)
11029 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11034 /* Helper function for truncate_echo_area. Truncate the current
11035 message to at most NCHARS characters. */
11038 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11040 if (BEG
+ nchars
< Z
)
11041 del_range (BEG
+ nchars
, Z
);
11043 echo_area_buffer
[0] = Qnil
;
11047 /* Set the current message to STRING. */
11050 set_message (Lisp_Object string
)
11052 eassert (STRINGP (string
));
11054 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11056 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11057 message_buf_print
= false;
11058 help_echo_showing_p
= false;
11060 if (STRINGP (Vdebug_on_message
)
11061 && STRINGP (string
)
11062 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11063 call_debugger (list2 (Qerror
, string
));
11067 /* Helper function for set_message. First argument is ignored and second
11068 argument has the same meaning as for set_message.
11069 This function is called with the echo area buffer being current. */
11072 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11074 eassert (STRINGP (string
));
11076 /* Change multibyteness of the echo buffer appropriately. */
11077 if (message_enable_multibyte
11078 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11079 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11081 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11082 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11083 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11085 /* Insert new message at BEG. */
11086 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11088 /* This function takes care of single/multibyte conversion.
11089 We just have to ensure that the echo area buffer has the right
11090 setting of enable_multibyte_characters. */
11091 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), true);
11097 /* Clear messages. CURRENT_P means clear the current message.
11098 LAST_DISPLAYED_P means clear the message last displayed. */
11101 clear_message (bool current_p
, bool last_displayed_p
)
11105 echo_area_buffer
[0] = Qnil
;
11106 message_cleared_p
= true;
11109 if (last_displayed_p
)
11110 echo_area_buffer
[1] = Qnil
;
11112 message_buf_print
= false;
11115 /* Clear garbaged frames.
11117 This function is used where the old redisplay called
11118 redraw_garbaged_frames which in turn called redraw_frame which in
11119 turn called clear_frame. The call to clear_frame was a source of
11120 flickering. I believe a clear_frame is not necessary. It should
11121 suffice in the new redisplay to invalidate all current matrices,
11122 and ensure a complete redisplay of all windows. */
11125 clear_garbaged_frames (void)
11127 if (frame_garbaged
)
11129 Lisp_Object tail
, frame
;
11131 FOR_EACH_FRAME (tail
, frame
)
11133 struct frame
*f
= XFRAME (frame
);
11135 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11140 clear_current_matrices (f
);
11141 fset_redisplay (f
);
11142 f
->garbaged
= false;
11143 f
->resized_p
= false;
11147 frame_garbaged
= false;
11152 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P, update
11156 echo_area_display (bool update_frame_p
)
11158 Lisp_Object mini_window
;
11161 bool window_height_changed_p
= false;
11162 struct frame
*sf
= SELECTED_FRAME ();
11164 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11165 w
= XWINDOW (mini_window
);
11166 f
= XFRAME (WINDOW_FRAME (w
));
11168 /* Don't display if frame is invisible or not yet initialized. */
11169 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11172 #ifdef HAVE_WINDOW_SYSTEM
11173 /* When Emacs starts, selected_frame may be the initial terminal
11174 frame. If we let this through, a message would be displayed on
11176 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11178 #endif /* HAVE_WINDOW_SYSTEM */
11180 /* Redraw garbaged frames. */
11181 clear_garbaged_frames ();
11183 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11185 echo_area_window
= mini_window
;
11186 window_height_changed_p
= display_echo_area (w
);
11187 w
->must_be_updated_p
= true;
11189 /* Update the display, unless called from redisplay_internal.
11190 Also don't update the screen during redisplay itself. The
11191 update will happen at the end of redisplay, and an update
11192 here could cause confusion. */
11193 if (update_frame_p
&& !redisplaying_p
)
11197 /* If the display update has been interrupted by pending
11198 input, update mode lines in the frame. Due to the
11199 pending input, it might have been that redisplay hasn't
11200 been called, so that mode lines above the echo area are
11201 garbaged. This looks odd, so we prevent it here. */
11202 if (!display_completed
)
11203 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11205 if (window_height_changed_p
11206 /* Don't do this if Emacs is shutting down. Redisplay
11207 needs to run hooks. */
11208 && !NILP (Vrun_hooks
))
11210 /* Must update other windows. Likewise as in other
11211 cases, don't let this update be interrupted by
11213 ptrdiff_t count
= SPECPDL_INDEX ();
11214 specbind (Qredisplay_dont_pause
, Qt
);
11215 fset_redisplay (f
);
11216 redisplay_internal ();
11217 unbind_to (count
, Qnil
);
11219 else if (FRAME_WINDOW_P (f
) && n
== 0)
11221 /* Window configuration is the same as before.
11222 Can do with a display update of the echo area,
11223 unless we displayed some mode lines. */
11224 update_single_window (w
);
11228 update_frame (f
, true, true);
11230 /* If cursor is in the echo area, make sure that the next
11231 redisplay displays the minibuffer, so that the cursor will
11232 be replaced with what the minibuffer wants. */
11233 if (cursor_in_echo_area
)
11234 wset_redisplay (XWINDOW (mini_window
));
11237 else if (!EQ (mini_window
, selected_window
))
11238 wset_redisplay (XWINDOW (mini_window
));
11240 /* Last displayed message is now the current message. */
11241 echo_area_buffer
[1] = echo_area_buffer
[0];
11242 /* Inform read_char that we're not echoing. */
11243 echo_message_buffer
= Qnil
;
11245 /* Prevent redisplay optimization in redisplay_internal by resetting
11246 this_line_start_pos. This is done because the mini-buffer now
11247 displays the message instead of its buffer text. */
11248 if (EQ (mini_window
, selected_window
))
11249 CHARPOS (this_line_start_pos
) = 0;
11251 if (window_height_changed_p
)
11253 fset_redisplay (f
);
11255 /* If window configuration was changed, frames may have been
11256 marked garbaged. Clear them or we will experience
11257 surprises wrt scrolling.
11258 FIXME: How/why/when? */
11259 clear_garbaged_frames ();
11263 /* True if W's buffer was changed but not saved. */
11266 window_buffer_changed (struct window
*w
)
11268 struct buffer
*b
= XBUFFER (w
->contents
);
11270 eassert (BUFFER_LIVE_P (b
));
11272 return (BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
;
11275 /* True if W has %c in its mode line and mode line should be updated. */
11278 mode_line_update_needed (struct window
*w
)
11280 return (w
->column_number_displayed
!= -1
11281 && !(PT
== w
->last_point
&& !window_outdated (w
))
11282 && (w
->column_number_displayed
!= current_column ()));
11285 /* True if window start of W is frozen and may not be changed during
11289 window_frozen_p (struct window
*w
)
11291 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11293 Lisp_Object window
;
11295 XSETWINDOW (window
, w
);
11296 if (MINI_WINDOW_P (w
))
11298 else if (EQ (window
, selected_window
))
11300 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11301 && EQ (window
, Vminibuf_scroll_window
))
11302 /* This special window can't be frozen too. */
11310 /***********************************************************************
11311 Mode Lines and Frame Titles
11312 ***********************************************************************/
11314 /* A buffer for constructing non-propertized mode-line strings and
11315 frame titles in it; allocated from the heap in init_xdisp and
11316 resized as needed in store_mode_line_noprop_char. */
11318 static char *mode_line_noprop_buf
;
11320 /* The buffer's end, and a current output position in it. */
11322 static char *mode_line_noprop_buf_end
;
11323 static char *mode_line_noprop_ptr
;
11325 #define MODE_LINE_NOPROP_LEN(start) \
11326 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11329 MODE_LINE_DISPLAY
= 0,
11333 } mode_line_target
;
11335 /* Alist that caches the results of :propertize.
11336 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11337 static Lisp_Object mode_line_proptrans_alist
;
11339 /* List of strings making up the mode-line. */
11340 static Lisp_Object mode_line_string_list
;
11342 /* Base face property when building propertized mode line string. */
11343 static Lisp_Object mode_line_string_face
;
11344 static Lisp_Object mode_line_string_face_prop
;
11347 /* Unwind data for mode line strings */
11349 static Lisp_Object Vmode_line_unwind_vector
;
11352 format_mode_line_unwind_data (struct frame
*target_frame
,
11353 struct buffer
*obuf
,
11355 bool save_proptrans
)
11357 Lisp_Object vector
, tmp
;
11359 /* Reduce consing by keeping one vector in
11360 Vwith_echo_area_save_vector. */
11361 vector
= Vmode_line_unwind_vector
;
11362 Vmode_line_unwind_vector
= Qnil
;
11365 vector
= Fmake_vector (make_number (10), Qnil
);
11367 ASET (vector
, 0, make_number (mode_line_target
));
11368 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11369 ASET (vector
, 2, mode_line_string_list
);
11370 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11371 ASET (vector
, 4, mode_line_string_face
);
11372 ASET (vector
, 5, mode_line_string_face_prop
);
11375 XSETBUFFER (tmp
, obuf
);
11378 ASET (vector
, 6, tmp
);
11379 ASET (vector
, 7, owin
);
11382 /* Similarly to `with-selected-window', if the operation selects
11383 a window on another frame, we must restore that frame's
11384 selected window, and (for a tty) the top-frame. */
11385 ASET (vector
, 8, target_frame
->selected_window
);
11386 if (FRAME_TERMCAP_P (target_frame
))
11387 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11394 unwind_format_mode_line (Lisp_Object vector
)
11396 Lisp_Object old_window
= AREF (vector
, 7);
11397 Lisp_Object target_frame_window
= AREF (vector
, 8);
11398 Lisp_Object old_top_frame
= AREF (vector
, 9);
11400 mode_line_target
= XINT (AREF (vector
, 0));
11401 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11402 mode_line_string_list
= AREF (vector
, 2);
11403 if (! EQ (AREF (vector
, 3), Qt
))
11404 mode_line_proptrans_alist
= AREF (vector
, 3);
11405 mode_line_string_face
= AREF (vector
, 4);
11406 mode_line_string_face_prop
= AREF (vector
, 5);
11408 /* Select window before buffer, since it may change the buffer. */
11409 if (!NILP (old_window
))
11411 /* If the operation that we are unwinding had selected a window
11412 on a different frame, reset its frame-selected-window. For a
11413 text terminal, reset its top-frame if necessary. */
11414 if (!NILP (target_frame_window
))
11417 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11419 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11420 Fselect_window (target_frame_window
, Qt
);
11422 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11423 Fselect_frame (old_top_frame
, Qt
);
11426 Fselect_window (old_window
, Qt
);
11429 if (!NILP (AREF (vector
, 6)))
11431 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11432 ASET (vector
, 6, Qnil
);
11435 Vmode_line_unwind_vector
= vector
;
11439 /* Store a single character C for the frame title in mode_line_noprop_buf.
11440 Re-allocate mode_line_noprop_buf if necessary. */
11443 store_mode_line_noprop_char (char c
)
11445 /* If output position has reached the end of the allocated buffer,
11446 increase the buffer's size. */
11447 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11449 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11450 ptrdiff_t size
= len
;
11451 mode_line_noprop_buf
=
11452 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11453 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11454 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11457 *mode_line_noprop_ptr
++ = c
;
11461 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11462 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11463 characters that yield more columns than PRECISION; PRECISION <= 0
11464 means copy the whole string. Pad with spaces until FIELD_WIDTH
11465 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11466 pad. Called from display_mode_element when it is used to build a
11470 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11472 const unsigned char *str
= (const unsigned char *) string
;
11474 ptrdiff_t dummy
, nbytes
;
11476 /* Copy at most PRECISION chars from STR. */
11477 nbytes
= strlen (string
);
11478 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11480 store_mode_line_noprop_char (*str
++);
11482 /* Fill up with spaces until FIELD_WIDTH reached. */
11483 while (field_width
> 0
11484 && n
< field_width
)
11486 store_mode_line_noprop_char (' ');
11493 /***********************************************************************
11495 ***********************************************************************/
11497 #ifdef HAVE_WINDOW_SYSTEM
11499 /* Set the title of FRAME, if it has changed. The title format is
11500 Vicon_title_format if FRAME is iconified, otherwise it is
11501 frame_title_format. */
11504 x_consider_frame_title (Lisp_Object frame
)
11506 struct frame
*f
= XFRAME (frame
);
11508 if (FRAME_WINDOW_P (f
)
11509 || FRAME_MINIBUF_ONLY_P (f
)
11510 || f
->explicit_name
)
11512 /* Do we have more than one visible frame on this X display? */
11513 Lisp_Object tail
, other_frame
, fmt
;
11514 ptrdiff_t title_start
;
11518 ptrdiff_t count
= SPECPDL_INDEX ();
11520 FOR_EACH_FRAME (tail
, other_frame
)
11522 struct frame
*tf
= XFRAME (other_frame
);
11525 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11526 && !FRAME_MINIBUF_ONLY_P (tf
)
11527 && !EQ (other_frame
, tip_frame
)
11528 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11532 /* Set global variable indicating that multiple frames exist. */
11533 multiple_frames
= CONSP (tail
);
11535 /* Switch to the buffer of selected window of the frame. Set up
11536 mode_line_target so that display_mode_element will output into
11537 mode_line_noprop_buf; then display the title. */
11538 record_unwind_protect (unwind_format_mode_line
,
11539 format_mode_line_unwind_data
11540 (f
, current_buffer
, selected_window
, false));
11542 Fselect_window (f
->selected_window
, Qt
);
11543 set_buffer_internal_1
11544 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11545 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11547 mode_line_target
= MODE_LINE_TITLE
;
11548 title_start
= MODE_LINE_NOPROP_LEN (0);
11549 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11550 NULL
, DEFAULT_FACE_ID
);
11551 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, false);
11552 len
= MODE_LINE_NOPROP_LEN (title_start
);
11553 title
= mode_line_noprop_buf
+ title_start
;
11554 unbind_to (count
, Qnil
);
11556 /* Set the title only if it's changed. This avoids consing in
11557 the common case where it hasn't. (If it turns out that we've
11558 already wasted too much time by walking through the list with
11559 display_mode_element, then we might need to optimize at a
11560 higher level than this.) */
11561 if (! STRINGP (f
->name
)
11562 || SBYTES (f
->name
) != len
11563 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11564 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11568 #endif /* not HAVE_WINDOW_SYSTEM */
11571 /***********************************************************************
11573 ***********************************************************************/
11575 /* True if we will not redisplay all visible windows. */
11576 #define REDISPLAY_SOME_P() \
11577 ((windows_or_buffers_changed == 0 \
11578 || windows_or_buffers_changed == REDISPLAY_SOME) \
11579 && (update_mode_lines == 0 \
11580 || update_mode_lines == REDISPLAY_SOME))
11582 /* Prepare for redisplay by updating menu-bar item lists when
11583 appropriate. This can call eval. */
11586 prepare_menu_bars (void)
11588 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11589 bool some_windows
= REDISPLAY_SOME_P ();
11590 Lisp_Object tooltip_frame
;
11592 #ifdef HAVE_WINDOW_SYSTEM
11593 tooltip_frame
= tip_frame
;
11595 tooltip_frame
= Qnil
;
11598 if (FUNCTIONP (Vpre_redisplay_function
))
11600 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11601 if (all_windows
&& some_windows
)
11603 Lisp_Object ws
= window_list ();
11604 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11606 Lisp_Object
this = XCAR (ws
);
11607 struct window
*w
= XWINDOW (this);
11609 || XFRAME (w
->frame
)->redisplay
11610 || XBUFFER (w
->contents
)->text
->redisplay
)
11612 windows
= Fcons (this, windows
);
11616 safe__call1 (true, Vpre_redisplay_function
, windows
);
11619 /* Update all frame titles based on their buffer names, etc. We do
11620 this before the menu bars so that the buffer-menu will show the
11621 up-to-date frame titles. */
11622 #ifdef HAVE_WINDOW_SYSTEM
11625 Lisp_Object tail
, frame
;
11627 FOR_EACH_FRAME (tail
, frame
)
11629 struct frame
*f
= XFRAME (frame
);
11630 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11634 && !XBUFFER (w
->contents
)->text
->redisplay
)
11637 if (!EQ (frame
, tooltip_frame
)
11638 && (FRAME_ICONIFIED_P (f
)
11639 || FRAME_VISIBLE_P (f
) == 1
11640 /* Exclude TTY frames that are obscured because they
11641 are not the top frame on their console. This is
11642 because x_consider_frame_title actually switches
11643 to the frame, which for TTY frames means it is
11644 marked as garbaged, and will be completely
11645 redrawn on the next redisplay cycle. This causes
11646 TTY frames to be completely redrawn, when there
11647 are more than one of them, even though nothing
11648 should be changed on display. */
11649 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11650 x_consider_frame_title (frame
);
11653 #endif /* HAVE_WINDOW_SYSTEM */
11655 /* Update the menu bar item lists, if appropriate. This has to be
11656 done before any actual redisplay or generation of display lines. */
11660 Lisp_Object tail
, frame
;
11661 ptrdiff_t count
= SPECPDL_INDEX ();
11662 /* True means that update_menu_bar has run its hooks
11663 so any further calls to update_menu_bar shouldn't do so again. */
11664 bool menu_bar_hooks_run
= false;
11666 record_unwind_save_match_data ();
11668 FOR_EACH_FRAME (tail
, frame
)
11670 struct frame
*f
= XFRAME (frame
);
11671 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11673 /* Ignore tooltip frame. */
11674 if (EQ (frame
, tooltip_frame
))
11680 && !XBUFFER (w
->contents
)->text
->redisplay
)
11683 /* If a window on this frame changed size, report that to
11684 the user and clear the size-change flag. */
11685 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11687 Lisp_Object functions
;
11689 /* Clear flag first in case we get an error below. */
11690 FRAME_WINDOW_SIZES_CHANGED (f
) = false;
11691 functions
= Vwindow_size_change_functions
;
11693 while (CONSP (functions
))
11695 if (!EQ (XCAR (functions
), Qt
))
11696 call1 (XCAR (functions
), frame
);
11697 functions
= XCDR (functions
);
11701 menu_bar_hooks_run
= update_menu_bar (f
, false, menu_bar_hooks_run
);
11702 #ifdef HAVE_WINDOW_SYSTEM
11703 update_tool_bar (f
, false);
11707 unbind_to (count
, Qnil
);
11711 struct frame
*sf
= SELECTED_FRAME ();
11712 update_menu_bar (sf
, true, false);
11713 #ifdef HAVE_WINDOW_SYSTEM
11714 update_tool_bar (sf
, true);
11720 /* Update the menu bar item list for frame F. This has to be done
11721 before we start to fill in any display lines, because it can call
11724 If SAVE_MATCH_DATA, we must save and restore it here.
11726 If HOOKS_RUN, a previous call to update_menu_bar
11727 already ran the menu bar hooks for this redisplay, so there
11728 is no need to run them again. The return value is the
11729 updated value of this flag, to pass to the next call. */
11732 update_menu_bar (struct frame
*f
, bool save_match_data
, bool hooks_run
)
11734 Lisp_Object window
;
11737 /* If called recursively during a menu update, do nothing. This can
11738 happen when, for instance, an activate-menubar-hook causes a
11740 if (inhibit_menubar_update
)
11743 window
= FRAME_SELECTED_WINDOW (f
);
11744 w
= XWINDOW (window
);
11746 if (FRAME_WINDOW_P (f
)
11748 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11749 || defined (HAVE_NS) || defined (USE_GTK)
11750 FRAME_EXTERNAL_MENU_BAR (f
)
11752 FRAME_MENU_BAR_LINES (f
) > 0
11754 : FRAME_MENU_BAR_LINES (f
) > 0)
11756 /* If the user has switched buffers or windows, we need to
11757 recompute to reflect the new bindings. But we'll
11758 recompute when update_mode_lines is set too; that means
11759 that people can use force-mode-line-update to request
11760 that the menu bar be recomputed. The adverse effect on
11761 the rest of the redisplay algorithm is about the same as
11762 windows_or_buffers_changed anyway. */
11763 if (windows_or_buffers_changed
11764 /* This used to test w->update_mode_line, but we believe
11765 there is no need to recompute the menu in that case. */
11766 || update_mode_lines
11767 || window_buffer_changed (w
))
11769 struct buffer
*prev
= current_buffer
;
11770 ptrdiff_t count
= SPECPDL_INDEX ();
11772 specbind (Qinhibit_menubar_update
, Qt
);
11774 set_buffer_internal_1 (XBUFFER (w
->contents
));
11775 if (save_match_data
)
11776 record_unwind_save_match_data ();
11777 if (NILP (Voverriding_local_map_menu_flag
))
11779 specbind (Qoverriding_terminal_local_map
, Qnil
);
11780 specbind (Qoverriding_local_map
, Qnil
);
11785 /* Run the Lucid hook. */
11786 safe_run_hooks (Qactivate_menubar_hook
);
11788 /* If it has changed current-menubar from previous value,
11789 really recompute the menu-bar from the value. */
11790 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11791 call0 (Qrecompute_lucid_menubar
);
11793 safe_run_hooks (Qmenu_bar_update_hook
);
11798 XSETFRAME (Vmenu_updating_frame
, f
);
11799 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11801 /* Redisplay the menu bar in case we changed it. */
11802 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11803 || defined (HAVE_NS) || defined (USE_GTK)
11804 if (FRAME_WINDOW_P (f
))
11806 #if defined (HAVE_NS)
11807 /* All frames on Mac OS share the same menubar. So only
11808 the selected frame should be allowed to set it. */
11809 if (f
== SELECTED_FRAME ())
11811 set_frame_menubar (f
, false, false);
11814 /* On a terminal screen, the menu bar is an ordinary screen
11815 line, and this makes it get updated. */
11816 w
->update_mode_line
= true;
11817 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11818 /* In the non-toolkit version, the menu bar is an ordinary screen
11819 line, and this makes it get updated. */
11820 w
->update_mode_line
= true;
11821 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11823 unbind_to (count
, Qnil
);
11824 set_buffer_internal_1 (prev
);
11831 /***********************************************************************
11833 ***********************************************************************/
11835 #ifdef HAVE_WINDOW_SYSTEM
11837 /* Select `frame' temporarily without running all the code in
11839 FIXME: Maybe do_switch_frame should be trimmed down similarly
11840 when `norecord' is set. */
11842 fast_set_selected_frame (Lisp_Object frame
)
11844 if (!EQ (selected_frame
, frame
))
11846 selected_frame
= frame
;
11847 selected_window
= XFRAME (frame
)->selected_window
;
11851 /* Update the tool-bar item list for frame F. This has to be done
11852 before we start to fill in any display lines. Called from
11853 prepare_menu_bars. If SAVE_MATCH_DATA, we must save
11854 and restore it here. */
11857 update_tool_bar (struct frame
*f
, bool save_match_data
)
11859 #if defined (USE_GTK) || defined (HAVE_NS)
11860 bool do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11862 bool do_update
= (WINDOWP (f
->tool_bar_window
)
11863 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0);
11868 Lisp_Object window
;
11871 window
= FRAME_SELECTED_WINDOW (f
);
11872 w
= XWINDOW (window
);
11874 /* If the user has switched buffers or windows, we need to
11875 recompute to reflect the new bindings. But we'll
11876 recompute when update_mode_lines is set too; that means
11877 that people can use force-mode-line-update to request
11878 that the menu bar be recomputed. The adverse effect on
11879 the rest of the redisplay algorithm is about the same as
11880 windows_or_buffers_changed anyway. */
11881 if (windows_or_buffers_changed
11882 || w
->update_mode_line
11883 || update_mode_lines
11884 || window_buffer_changed (w
))
11886 struct buffer
*prev
= current_buffer
;
11887 ptrdiff_t count
= SPECPDL_INDEX ();
11888 Lisp_Object frame
, new_tool_bar
;
11889 int new_n_tool_bar
;
11891 /* Set current_buffer to the buffer of the selected
11892 window of the frame, so that we get the right local
11894 set_buffer_internal_1 (XBUFFER (w
->contents
));
11896 /* Save match data, if we must. */
11897 if (save_match_data
)
11898 record_unwind_save_match_data ();
11900 /* Make sure that we don't accidentally use bogus keymaps. */
11901 if (NILP (Voverriding_local_map_menu_flag
))
11903 specbind (Qoverriding_terminal_local_map
, Qnil
);
11904 specbind (Qoverriding_local_map
, Qnil
);
11907 /* We must temporarily set the selected frame to this frame
11908 before calling tool_bar_items, because the calculation of
11909 the tool-bar keymap uses the selected frame (see
11910 `tool-bar-make-keymap' in tool-bar.el). */
11911 eassert (EQ (selected_window
,
11912 /* Since we only explicitly preserve selected_frame,
11913 check that selected_window would be redundant. */
11914 XFRAME (selected_frame
)->selected_window
));
11915 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
11916 XSETFRAME (frame
, f
);
11917 fast_set_selected_frame (frame
);
11919 /* Build desired tool-bar items from keymaps. */
11921 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11924 /* Redisplay the tool-bar if we changed it. */
11925 if (new_n_tool_bar
!= f
->n_tool_bar_items
11926 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11928 /* Redisplay that happens asynchronously due to an expose event
11929 may access f->tool_bar_items. Make sure we update both
11930 variables within BLOCK_INPUT so no such event interrupts. */
11932 fset_tool_bar_items (f
, new_tool_bar
);
11933 f
->n_tool_bar_items
= new_n_tool_bar
;
11934 w
->update_mode_line
= true;
11938 unbind_to (count
, Qnil
);
11939 set_buffer_internal_1 (prev
);
11944 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
11946 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11947 F's desired tool-bar contents. F->tool_bar_items must have
11948 been set up previously by calling prepare_menu_bars. */
11951 build_desired_tool_bar_string (struct frame
*f
)
11953 int i
, size
, size_needed
;
11954 Lisp_Object image
, plist
;
11956 image
= plist
= Qnil
;
11958 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11959 Otherwise, make a new string. */
11961 /* The size of the string we might be able to reuse. */
11962 size
= (STRINGP (f
->desired_tool_bar_string
)
11963 ? SCHARS (f
->desired_tool_bar_string
)
11966 /* We need one space in the string for each image. */
11967 size_needed
= f
->n_tool_bar_items
;
11969 /* Reuse f->desired_tool_bar_string, if possible. */
11970 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11971 fset_desired_tool_bar_string
11972 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
11975 AUTO_LIST4 (props
, Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11976 Fremove_text_properties (make_number (0), make_number (size
),
11977 props
, f
->desired_tool_bar_string
);
11980 /* Put a `display' property on the string for the images to display,
11981 put a `menu_item' property on tool-bar items with a value that
11982 is the index of the item in F's tool-bar item vector. */
11983 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11985 #define PROP(IDX) \
11986 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11988 bool enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11989 bool selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11990 int hmargin
, vmargin
, relief
, idx
, end
;
11992 /* If image is a vector, choose the image according to the
11994 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11995 if (VECTORP (image
))
11999 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12000 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
12003 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12004 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
12006 eassert (ASIZE (image
) >= idx
);
12007 image
= AREF (image
, idx
);
12012 /* Ignore invalid image specifications. */
12013 if (!valid_image_p (image
))
12016 /* Display the tool-bar button pressed, or depressed. */
12017 plist
= Fcopy_sequence (XCDR (image
));
12019 /* Compute margin and relief to draw. */
12020 relief
= (tool_bar_button_relief
>= 0
12021 ? tool_bar_button_relief
12022 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12023 hmargin
= vmargin
= relief
;
12025 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12026 INT_MAX
- max (hmargin
, vmargin
)))
12028 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12029 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12031 else if (CONSP (Vtool_bar_button_margin
))
12033 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12034 INT_MAX
- hmargin
))
12035 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12037 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12038 INT_MAX
- vmargin
))
12039 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12042 if (auto_raise_tool_bar_buttons_p
)
12044 /* Add a `:relief' property to the image spec if the item is
12048 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12055 /* If image is selected, display it pressed, i.e. with a
12056 negative relief. If it's not selected, display it with a
12058 plist
= Fplist_put (plist
, QCrelief
,
12060 ? make_number (-relief
)
12061 : make_number (relief
)));
12066 /* Put a margin around the image. */
12067 if (hmargin
|| vmargin
)
12069 if (hmargin
== vmargin
)
12070 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12072 plist
= Fplist_put (plist
, QCmargin
,
12073 Fcons (make_number (hmargin
),
12074 make_number (vmargin
)));
12077 /* If button is not enabled, and we don't have special images
12078 for the disabled state, make the image appear disabled by
12079 applying an appropriate algorithm to it. */
12080 if (!enabled_p
&& idx
< 0)
12081 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12083 /* Put a `display' text property on the string for the image to
12084 display. Put a `menu-item' property on the string that gives
12085 the start of this item's properties in the tool-bar items
12087 image
= Fcons (Qimage
, plist
);
12088 AUTO_LIST4 (props
, Qdisplay
, image
, Qmenu_item
,
12089 make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12091 /* Let the last image hide all remaining spaces in the tool bar
12092 string. The string can be longer than needed when we reuse a
12093 previous string. */
12094 if (i
+ 1 == f
->n_tool_bar_items
)
12095 end
= SCHARS (f
->desired_tool_bar_string
);
12098 Fadd_text_properties (make_number (i
), make_number (end
),
12099 props
, f
->desired_tool_bar_string
);
12105 /* Display one line of the tool-bar of frame IT->f.
12107 HEIGHT specifies the desired height of the tool-bar line.
12108 If the actual height of the glyph row is less than HEIGHT, the
12109 row's height is increased to HEIGHT, and the icons are centered
12110 vertically in the new height.
12112 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12113 count a final empty row in case the tool-bar width exactly matches
12118 display_tool_bar_line (struct it
*it
, int height
)
12120 struct glyph_row
*row
= it
->glyph_row
;
12121 int max_x
= it
->last_visible_x
;
12122 struct glyph
*last
;
12124 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12125 clear_glyph_row (row
);
12126 row
->enabled_p
= true;
12127 row
->y
= it
->current_y
;
12129 /* Note that this isn't made use of if the face hasn't a box,
12130 so there's no need to check the face here. */
12131 it
->start_of_box_run_p
= true;
12133 while (it
->current_x
< max_x
)
12135 int x
, n_glyphs_before
, i
, nglyphs
;
12136 struct it it_before
;
12138 /* Get the next display element. */
12139 if (!get_next_display_element (it
))
12141 /* Don't count empty row if we are counting needed tool-bar lines. */
12142 if (height
< 0 && !it
->hpos
)
12147 /* Produce glyphs. */
12148 n_glyphs_before
= row
->used
[TEXT_AREA
];
12151 PRODUCE_GLYPHS (it
);
12153 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12155 x
= it_before
.current_x
;
12156 while (i
< nglyphs
)
12158 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12160 if (x
+ glyph
->pixel_width
> max_x
)
12162 /* Glyph doesn't fit on line. Backtrack. */
12163 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12165 /* If this is the only glyph on this line, it will never fit on the
12166 tool-bar, so skip it. But ensure there is at least one glyph,
12167 so we don't accidentally disable the tool-bar. */
12168 if (n_glyphs_before
== 0
12169 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12175 x
+= glyph
->pixel_width
;
12179 /* Stop at line end. */
12180 if (ITERATOR_AT_END_OF_LINE_P (it
))
12183 set_iterator_to_next (it
, true);
12188 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12190 /* Use default face for the border below the tool bar.
12192 FIXME: When auto-resize-tool-bars is grow-only, there is
12193 no additional border below the possibly empty tool-bar lines.
12194 So to make the extra empty lines look "normal", we have to
12195 use the tool-bar face for the border too. */
12196 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12197 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12198 it
->face_id
= DEFAULT_FACE_ID
;
12200 extend_face_to_end_of_line (it
);
12201 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12202 last
->right_box_line_p
= true;
12203 if (last
== row
->glyphs
[TEXT_AREA
])
12204 last
->left_box_line_p
= true;
12206 /* Make line the desired height and center it vertically. */
12207 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12209 /* Don't add more than one line height. */
12210 height
%= FRAME_LINE_HEIGHT (it
->f
);
12211 it
->max_ascent
+= height
/ 2;
12212 it
->max_descent
+= (height
+ 1) / 2;
12215 compute_line_metrics (it
);
12217 /* If line is empty, make it occupy the rest of the tool-bar. */
12218 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12220 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12221 row
->visible_height
= row
->height
;
12222 row
->ascent
= row
->phys_ascent
= 0;
12223 row
->extra_line_spacing
= 0;
12226 row
->full_width_p
= true;
12227 row
->continued_p
= false;
12228 row
->truncated_on_left_p
= false;
12229 row
->truncated_on_right_p
= false;
12231 it
->current_x
= it
->hpos
= 0;
12232 it
->current_y
+= row
->height
;
12238 /* Value is the number of pixels needed to make all tool-bar items of
12239 frame F visible. The actual number of glyph rows needed is
12240 returned in *N_ROWS if non-NULL. */
12242 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12244 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12246 /* tool_bar_height is called from redisplay_tool_bar after building
12247 the desired matrix, so use (unused) mode-line row as temporary row to
12248 avoid destroying the first tool-bar row. */
12249 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12251 /* Initialize an iterator for iteration over
12252 F->desired_tool_bar_string in the tool-bar window of frame F. */
12253 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12254 temp_row
->reversed_p
= false;
12255 it
.first_visible_x
= 0;
12256 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12257 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12258 it
.paragraph_embedding
= L2R
;
12260 while (!ITERATOR_AT_END_P (&it
))
12262 clear_glyph_row (temp_row
);
12263 it
.glyph_row
= temp_row
;
12264 display_tool_bar_line (&it
, -1);
12266 clear_glyph_row (temp_row
);
12268 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12270 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12273 return it
.current_y
;
12275 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12278 #endif /* !USE_GTK && !HAVE_NS */
12280 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12282 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12283 If FRAME is nil or omitted, use the selected frame. Optional argument
12284 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12285 (Lisp_Object frame
, Lisp_Object pixelwise
)
12289 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12290 struct frame
*f
= decode_any_frame (frame
);
12292 if (WINDOWP (f
->tool_bar_window
)
12293 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12295 update_tool_bar (f
, true);
12296 if (f
->n_tool_bar_items
)
12298 build_desired_tool_bar_string (f
);
12299 height
= tool_bar_height (f
, NULL
, !NILP (pixelwise
));
12304 return make_number (height
);
12308 /* Display the tool-bar of frame F. Value is true if tool-bar's
12309 height should be changed. */
12311 redisplay_tool_bar (struct frame
*f
)
12313 #if defined (USE_GTK) || defined (HAVE_NS)
12315 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12316 update_frame_tool_bar (f
);
12319 #else /* !USE_GTK && !HAVE_NS */
12323 struct glyph_row
*row
;
12325 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12326 do anything. This means you must start with tool-bar-lines
12327 non-zero to get the auto-sizing effect. Or in other words, you
12328 can turn off tool-bars by specifying tool-bar-lines zero. */
12329 if (!WINDOWP (f
->tool_bar_window
)
12330 || (w
= XWINDOW (f
->tool_bar_window
),
12331 WINDOW_TOTAL_LINES (w
) == 0))
12334 /* Set up an iterator for the tool-bar window. */
12335 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12336 it
.first_visible_x
= 0;
12337 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12338 row
= it
.glyph_row
;
12339 row
->reversed_p
= false;
12341 /* Build a string that represents the contents of the tool-bar. */
12342 build_desired_tool_bar_string (f
);
12343 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12344 /* FIXME: This should be controlled by a user option. But it
12345 doesn't make sense to have an R2L tool bar if the menu bar cannot
12346 be drawn also R2L, and making the menu bar R2L is tricky due
12347 toolkit-specific code that implements it. If an R2L tool bar is
12348 ever supported, display_tool_bar_line should also be augmented to
12349 call unproduce_glyphs like display_line and display_string
12351 it
.paragraph_embedding
= L2R
;
12353 if (f
->n_tool_bar_rows
== 0)
12355 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, true);
12357 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12359 x_change_tool_bar_height (f
, new_height
);
12360 frame_default_tool_bar_height
= new_height
;
12361 /* Always do that now. */
12362 clear_glyph_matrix (w
->desired_matrix
);
12363 f
->fonts_changed
= true;
12368 /* Display as many lines as needed to display all tool-bar items. */
12370 if (f
->n_tool_bar_rows
> 0)
12372 int border
, rows
, height
, extra
;
12374 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12375 border
= XINT (Vtool_bar_border
);
12376 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12377 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12378 else if (EQ (Vtool_bar_border
, Qborder_width
))
12379 border
= f
->border_width
;
12385 rows
= f
->n_tool_bar_rows
;
12386 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12387 extra
= it
.last_visible_y
- border
- height
* rows
;
12389 while (it
.current_y
< it
.last_visible_y
)
12392 if (extra
> 0 && rows
-- > 0)
12394 h
= (extra
+ rows
- 1) / rows
;
12397 display_tool_bar_line (&it
, height
+ h
);
12402 while (it
.current_y
< it
.last_visible_y
)
12403 display_tool_bar_line (&it
, 0);
12406 /* It doesn't make much sense to try scrolling in the tool-bar
12407 window, so don't do it. */
12408 w
->desired_matrix
->no_scrolling_p
= true;
12409 w
->must_be_updated_p
= true;
12411 if (!NILP (Vauto_resize_tool_bars
))
12413 bool change_height_p
= true;
12415 /* If we couldn't display everything, change the tool-bar's
12416 height if there is room for more. */
12417 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
12418 change_height_p
= true;
12420 /* We subtract 1 because display_tool_bar_line advances the
12421 glyph_row pointer before returning to its caller. We want to
12422 examine the last glyph row produced by
12423 display_tool_bar_line. */
12424 row
= it
.glyph_row
- 1;
12426 /* If there are blank lines at the end, except for a partially
12427 visible blank line at the end that is smaller than
12428 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12429 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12430 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12431 change_height_p
= true;
12433 /* If row displays tool-bar items, but is partially visible,
12434 change the tool-bar's height. */
12435 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12436 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
12437 change_height_p
= true;
12439 /* Resize windows as needed by changing the `tool-bar-lines'
12440 frame parameter. */
12441 if (change_height_p
)
12444 int new_height
= tool_bar_height (f
, &nrows
, true);
12446 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12447 && !f
->minimize_tool_bar_window_p
)
12448 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12449 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12450 f
->minimize_tool_bar_window_p
= false;
12452 if (change_height_p
)
12454 x_change_tool_bar_height (f
, new_height
);
12455 frame_default_tool_bar_height
= new_height
;
12456 clear_glyph_matrix (w
->desired_matrix
);
12457 f
->n_tool_bar_rows
= nrows
;
12458 f
->fonts_changed
= true;
12465 f
->minimize_tool_bar_window_p
= false;
12468 #endif /* USE_GTK || HAVE_NS */
12471 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12473 /* Get information about the tool-bar item which is displayed in GLYPH
12474 on frame F. Return in *PROP_IDX the index where tool-bar item
12475 properties start in F->tool_bar_items. Value is false if
12476 GLYPH doesn't display a tool-bar item. */
12479 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12484 /* This function can be called asynchronously, which means we must
12485 exclude any possibility that Fget_text_property signals an
12487 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12488 charpos
= max (0, charpos
);
12490 /* Get the text property `menu-item' at pos. The value of that
12491 property is the start index of this item's properties in
12492 F->tool_bar_items. */
12493 prop
= Fget_text_property (make_number (charpos
),
12494 Qmenu_item
, f
->current_tool_bar_string
);
12495 if (! INTEGERP (prop
))
12497 *prop_idx
= XINT (prop
);
12502 /* Get information about the tool-bar item at position X/Y on frame F.
12503 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12504 the current matrix of the tool-bar window of F, or NULL if not
12505 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12506 item in F->tool_bar_items. Value is
12508 -1 if X/Y is not on a tool-bar item
12509 0 if X/Y is on the same item that was highlighted before.
12513 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12514 int *hpos
, int *vpos
, int *prop_idx
)
12516 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12517 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12520 /* Find the glyph under X/Y. */
12521 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12522 if (*glyph
== NULL
)
12525 /* Get the start of this tool-bar item's properties in
12526 f->tool_bar_items. */
12527 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12530 /* Is mouse on the highlighted item? */
12531 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12532 && *vpos
>= hlinfo
->mouse_face_beg_row
12533 && *vpos
<= hlinfo
->mouse_face_end_row
12534 && (*vpos
> hlinfo
->mouse_face_beg_row
12535 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12536 && (*vpos
< hlinfo
->mouse_face_end_row
12537 || *hpos
< hlinfo
->mouse_face_end_col
12538 || hlinfo
->mouse_face_past_end
))
12546 Handle mouse button event on the tool-bar of frame F, at
12547 frame-relative coordinates X/Y. DOWN_P is true for a button press,
12548 false for button release. MODIFIERS is event modifiers for button
12552 handle_tool_bar_click (struct frame
*f
, int x
, int y
, bool down_p
,
12555 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12556 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12557 int hpos
, vpos
, prop_idx
;
12558 struct glyph
*glyph
;
12559 Lisp_Object enabled_p
;
12562 /* If not on the highlighted tool-bar item, and mouse-highlight is
12563 non-nil, return. This is so we generate the tool-bar button
12564 click only when the mouse button is released on the same item as
12565 where it was pressed. However, when mouse-highlight is disabled,
12566 generate the click when the button is released regardless of the
12567 highlight, since tool-bar items are not highlighted in that
12569 frame_to_window_pixel_xy (w
, &x
, &y
);
12570 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12572 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12575 /* When mouse-highlight is off, generate the click for the item
12576 where the button was pressed, disregarding where it was
12578 if (NILP (Vmouse_highlight
) && !down_p
)
12579 prop_idx
= f
->last_tool_bar_item
;
12581 /* If item is disabled, do nothing. */
12582 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12583 if (NILP (enabled_p
))
12588 /* Show item in pressed state. */
12589 if (!NILP (Vmouse_highlight
))
12590 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12591 f
->last_tool_bar_item
= prop_idx
;
12595 Lisp_Object key
, frame
;
12596 struct input_event event
;
12597 EVENT_INIT (event
);
12599 /* Show item in released state. */
12600 if (!NILP (Vmouse_highlight
))
12601 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12603 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12605 XSETFRAME (frame
, f
);
12606 event
.kind
= TOOL_BAR_EVENT
;
12607 event
.frame_or_window
= frame
;
12609 kbd_buffer_store_event (&event
);
12611 event
.kind
= TOOL_BAR_EVENT
;
12612 event
.frame_or_window
= frame
;
12614 event
.modifiers
= modifiers
;
12615 kbd_buffer_store_event (&event
);
12616 f
->last_tool_bar_item
= -1;
12621 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12622 tool-bar window-relative coordinates X/Y. Called from
12623 note_mouse_highlight. */
12626 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12628 Lisp_Object window
= f
->tool_bar_window
;
12629 struct window
*w
= XWINDOW (window
);
12630 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12631 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12633 struct glyph
*glyph
;
12634 struct glyph_row
*row
;
12636 Lisp_Object enabled_p
;
12638 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12642 /* Function note_mouse_highlight is called with negative X/Y
12643 values when mouse moves outside of the frame. */
12644 if (x
<= 0 || y
<= 0)
12646 clear_mouse_face (hlinfo
);
12650 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12653 /* Not on tool-bar item. */
12654 clear_mouse_face (hlinfo
);
12658 /* On same tool-bar item as before. */
12659 goto set_help_echo
;
12661 clear_mouse_face (hlinfo
);
12663 /* Mouse is down, but on different tool-bar item? */
12664 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12665 && f
== dpyinfo
->last_mouse_frame
);
12667 if (mouse_down_p
&& f
->last_tool_bar_item
!= prop_idx
)
12670 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12672 /* If tool-bar item is not enabled, don't highlight it. */
12673 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12674 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12676 /* Compute the x-position of the glyph. In front and past the
12677 image is a space. We include this in the highlighted area. */
12678 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12679 for (i
= x
= 0; i
< hpos
; ++i
)
12680 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12682 /* Record this as the current active region. */
12683 hlinfo
->mouse_face_beg_col
= hpos
;
12684 hlinfo
->mouse_face_beg_row
= vpos
;
12685 hlinfo
->mouse_face_beg_x
= x
;
12686 hlinfo
->mouse_face_past_end
= false;
12688 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12689 hlinfo
->mouse_face_end_row
= vpos
;
12690 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12691 hlinfo
->mouse_face_window
= window
;
12692 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12694 /* Display it as active. */
12695 show_mouse_face (hlinfo
, draw
);
12700 /* Set help_echo_string to a help string to display for this tool-bar item.
12701 XTread_socket does the rest. */
12702 help_echo_object
= help_echo_window
= Qnil
;
12703 help_echo_pos
= -1;
12704 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12705 if (NILP (help_echo_string
))
12706 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12709 #endif /* !USE_GTK && !HAVE_NS */
12711 #endif /* HAVE_WINDOW_SYSTEM */
12715 /************************************************************************
12716 Horizontal scrolling
12717 ************************************************************************/
12719 /* For all leaf windows in the window tree rooted at WINDOW, set their
12720 hscroll value so that PT is (i) visible in the window, and (ii) so
12721 that it is not within a certain margin at the window's left and
12722 right border. Value is true if any window's hscroll has been
12726 hscroll_window_tree (Lisp_Object window
)
12728 bool hscrolled_p
= false;
12729 bool hscroll_relative_p
= FLOATP (Vhscroll_step
);
12730 int hscroll_step_abs
= 0;
12731 double hscroll_step_rel
= 0;
12733 if (hscroll_relative_p
)
12735 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12736 if (hscroll_step_rel
< 0)
12738 hscroll_relative_p
= false;
12739 hscroll_step_abs
= 0;
12742 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12744 hscroll_step_abs
= XINT (Vhscroll_step
);
12745 if (hscroll_step_abs
< 0)
12746 hscroll_step_abs
= 0;
12749 hscroll_step_abs
= 0;
12751 while (WINDOWP (window
))
12753 struct window
*w
= XWINDOW (window
);
12755 if (WINDOWP (w
->contents
))
12756 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12757 else if (w
->cursor
.vpos
>= 0)
12760 int text_area_width
;
12761 struct glyph_row
*cursor_row
;
12762 struct glyph_row
*bottom_row
;
12764 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12765 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12766 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12768 cursor_row
= bottom_row
- 1;
12770 if (!cursor_row
->enabled_p
)
12772 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12773 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12774 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12776 cursor_row
= bottom_row
- 1;
12778 bool row_r2l_p
= cursor_row
->reversed_p
;
12780 text_area_width
= window_box_width (w
, TEXT_AREA
);
12782 /* Scroll when cursor is inside this scroll margin. */
12783 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12785 /* If the position of this window's point has explicitly
12786 changed, no more suspend auto hscrolling. */
12787 if (NILP (Fequal (Fwindow_point (window
), Fwindow_old_point (window
))))
12788 w
->suspend_auto_hscroll
= false;
12790 /* Remember window point. */
12791 Fset_marker (w
->old_pointm
,
12792 ((w
== XWINDOW (selected_window
))
12793 ? make_number (BUF_PT (XBUFFER (w
->contents
)))
12794 : Fmarker_position (w
->pointm
)),
12797 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12798 && !w
->suspend_auto_hscroll
12799 /* In some pathological cases, like restoring a window
12800 configuration into a frame that is much smaller than
12801 the one from which the configuration was saved, we
12802 get glyph rows whose start and end have zero buffer
12803 positions, which we cannot handle below. Just skip
12805 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12806 /* For left-to-right rows, hscroll when cursor is either
12807 (i) inside the right hscroll margin, or (ii) if it is
12808 inside the left margin and the window is already
12811 && ((w
->hscroll
&& w
->cursor
.x
<= h_margin
)
12812 || (cursor_row
->enabled_p
12813 && cursor_row
->truncated_on_right_p
12814 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12815 /* For right-to-left rows, the logic is similar,
12816 except that rules for scrolling to left and right
12817 are reversed. E.g., if cursor.x <= h_margin, we
12818 need to hscroll "to the right" unconditionally,
12819 and that will scroll the screen to the left so as
12820 to reveal the next portion of the row. */
12822 && ((cursor_row
->enabled_p
12823 /* FIXME: It is confusing to set the
12824 truncated_on_right_p flag when R2L rows
12825 are actually truncated on the left. */
12826 && cursor_row
->truncated_on_right_p
12827 && w
->cursor
.x
<= h_margin
)
12829 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12833 struct buffer
*saved_current_buffer
;
12837 /* Find point in a display of infinite width. */
12838 saved_current_buffer
= current_buffer
;
12839 current_buffer
= XBUFFER (w
->contents
);
12841 if (w
== XWINDOW (selected_window
))
12844 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12846 /* Move iterator to pt starting at cursor_row->start in
12847 a line with infinite width. */
12848 init_to_row_start (&it
, w
, cursor_row
);
12849 it
.last_visible_x
= INFINITY
;
12850 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12851 current_buffer
= saved_current_buffer
;
12853 /* Position cursor in window. */
12854 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12855 hscroll
= max (0, (it
.current_x
12856 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12857 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12858 : (text_area_width
/ 2))))
12859 / FRAME_COLUMN_WIDTH (it
.f
);
12860 else if ((!row_r2l_p
12861 && w
->cursor
.x
>= text_area_width
- h_margin
)
12862 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12864 if (hscroll_relative_p
)
12865 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12868 wanted_x
= text_area_width
12869 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12872 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12876 if (hscroll_relative_p
)
12877 wanted_x
= text_area_width
* hscroll_step_rel
12880 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12883 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12885 hscroll
= max (hscroll
, w
->min_hscroll
);
12887 /* Don't prevent redisplay optimizations if hscroll
12888 hasn't changed, as it will unnecessarily slow down
12890 if (w
->hscroll
!= hscroll
)
12892 struct buffer
*b
= XBUFFER (w
->contents
);
12893 b
->prevent_redisplay_optimizations_p
= true;
12894 w
->hscroll
= hscroll
;
12895 hscrolled_p
= true;
12903 /* Value is true if hscroll of any leaf window has been changed. */
12904 return hscrolled_p
;
12908 /* Set hscroll so that cursor is visible and not inside horizontal
12909 scroll margins for all windows in the tree rooted at WINDOW. See
12910 also hscroll_window_tree above. Value is true if any window's
12911 hscroll has been changed. If it has, desired matrices on the frame
12912 of WINDOW are cleared. */
12915 hscroll_windows (Lisp_Object window
)
12917 bool hscrolled_p
= hscroll_window_tree (window
);
12919 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12920 return hscrolled_p
;
12925 /************************************************************************
12927 ************************************************************************/
12929 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined.
12930 This is sometimes handy to have in a debugger session. */
12934 /* First and last unchanged row for try_window_id. */
12936 static int debug_first_unchanged_at_end_vpos
;
12937 static int debug_last_unchanged_at_beg_vpos
;
12939 /* Delta vpos and y. */
12941 static int debug_dvpos
, debug_dy
;
12943 /* Delta in characters and bytes for try_window_id. */
12945 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12947 /* Values of window_end_pos and window_end_vpos at the end of
12950 static ptrdiff_t debug_end_vpos
;
12952 /* Append a string to W->desired_matrix->method. FMT is a printf
12953 format string. If trace_redisplay_p is true also printf the
12954 resulting string to stderr. */
12956 static void debug_method_add (struct window
*, char const *, ...)
12957 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12960 debug_method_add (struct window
*w
, char const *fmt
, ...)
12963 char *method
= w
->desired_matrix
->method
;
12964 int len
= strlen (method
);
12965 int size
= sizeof w
->desired_matrix
->method
;
12966 int remaining
= size
- len
- 1;
12969 if (len
&& remaining
)
12972 --remaining
, ++len
;
12975 va_start (ap
, fmt
);
12976 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
12979 if (trace_redisplay_p
)
12980 fprintf (stderr
, "%p (%s): %s\n",
12982 ((BUFFERP (w
->contents
)
12983 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
12984 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
12989 #endif /* GLYPH_DEBUG */
12992 /* Value is true if all changes in window W, which displays
12993 current_buffer, are in the text between START and END. START is a
12994 buffer position, END is given as a distance from Z. Used in
12995 redisplay_internal for display optimization. */
12998 text_outside_line_unchanged_p (struct window
*w
,
12999 ptrdiff_t start
, ptrdiff_t end
)
13001 bool unchanged_p
= true;
13003 /* If text or overlays have changed, see where. */
13004 if (window_outdated (w
))
13006 /* Gap in the line? */
13007 if (GPT
< start
|| Z
- GPT
< end
)
13008 unchanged_p
= false;
13010 /* Changes start in front of the line, or end after it? */
13012 && (BEG_UNCHANGED
< start
- 1
13013 || END_UNCHANGED
< end
))
13014 unchanged_p
= false;
13016 /* If selective display, can't optimize if changes start at the
13017 beginning of the line. */
13019 && INTEGERP (BVAR (current_buffer
, selective_display
))
13020 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13021 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13022 unchanged_p
= false;
13024 /* If there are overlays at the start or end of the line, these
13025 may have overlay strings with newlines in them. A change at
13026 START, for instance, may actually concern the display of such
13027 overlay strings as well, and they are displayed on different
13028 lines. So, quickly rule out this case. (For the future, it
13029 might be desirable to implement something more telling than
13030 just BEG/END_UNCHANGED.) */
13033 if (BEG
+ BEG_UNCHANGED
== start
13034 && overlay_touches_p (start
))
13035 unchanged_p
= false;
13036 if (END_UNCHANGED
== end
13037 && overlay_touches_p (Z
- end
))
13038 unchanged_p
= false;
13041 /* Under bidi reordering, adding or deleting a character in the
13042 beginning of a paragraph, before the first strong directional
13043 character, can change the base direction of the paragraph (unless
13044 the buffer specifies a fixed paragraph direction), which will
13045 require to redisplay the whole paragraph. It might be worthwhile
13046 to find the paragraph limits and widen the range of redisplayed
13047 lines to that, but for now just give up this optimization. */
13048 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13049 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13050 unchanged_p
= false;
13053 return unchanged_p
;
13057 /* Do a frame update, taking possible shortcuts into account. This is
13058 the main external entry point for redisplay.
13060 If the last redisplay displayed an echo area message and that message
13061 is no longer requested, we clear the echo area or bring back the
13062 mini-buffer if that is in use. */
13067 redisplay_internal ();
13072 overlay_arrow_string_or_property (Lisp_Object var
)
13076 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13079 return Voverlay_arrow_string
;
13082 /* Return true if there are any overlay-arrows in current_buffer. */
13084 overlay_arrow_in_current_buffer_p (void)
13088 for (vlist
= Voverlay_arrow_variable_list
;
13090 vlist
= XCDR (vlist
))
13092 Lisp_Object var
= XCAR (vlist
);
13095 if (!SYMBOLP (var
))
13097 val
= find_symbol_value (var
);
13099 && current_buffer
== XMARKER (val
)->buffer
)
13106 /* Return true if any overlay_arrows have moved or overlay-arrow-string
13110 overlay_arrows_changed_p (void)
13114 for (vlist
= Voverlay_arrow_variable_list
;
13116 vlist
= XCDR (vlist
))
13118 Lisp_Object var
= XCAR (vlist
);
13119 Lisp_Object val
, pstr
;
13121 if (!SYMBOLP (var
))
13123 val
= find_symbol_value (var
);
13124 if (!MARKERP (val
))
13126 if (! EQ (COERCE_MARKER (val
),
13127 Fget (var
, Qlast_arrow_position
))
13128 || ! (pstr
= overlay_arrow_string_or_property (var
),
13129 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13135 /* Mark overlay arrows to be updated on next redisplay. */
13138 update_overlay_arrows (int up_to_date
)
13142 for (vlist
= Voverlay_arrow_variable_list
;
13144 vlist
= XCDR (vlist
))
13146 Lisp_Object var
= XCAR (vlist
);
13148 if (!SYMBOLP (var
))
13151 if (up_to_date
> 0)
13153 Lisp_Object val
= find_symbol_value (var
);
13154 Fput (var
, Qlast_arrow_position
,
13155 COERCE_MARKER (val
));
13156 Fput (var
, Qlast_arrow_string
,
13157 overlay_arrow_string_or_property (var
));
13159 else if (up_to_date
< 0
13160 || !NILP (Fget (var
, Qlast_arrow_position
)))
13162 Fput (var
, Qlast_arrow_position
, Qt
);
13163 Fput (var
, Qlast_arrow_string
, Qt
);
13169 /* Return overlay arrow string to display at row.
13170 Return integer (bitmap number) for arrow bitmap in left fringe.
13171 Return nil if no overlay arrow. */
13174 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13178 for (vlist
= Voverlay_arrow_variable_list
;
13180 vlist
= XCDR (vlist
))
13182 Lisp_Object var
= XCAR (vlist
);
13185 if (!SYMBOLP (var
))
13188 val
= find_symbol_value (var
);
13191 && current_buffer
== XMARKER (val
)->buffer
13192 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13194 if (FRAME_WINDOW_P (it
->f
)
13195 /* FIXME: if ROW->reversed_p is set, this should test
13196 the right fringe, not the left one. */
13197 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13199 #ifdef HAVE_WINDOW_SYSTEM
13200 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13202 int fringe_bitmap
= lookup_fringe_bitmap (val
);
13203 if (fringe_bitmap
!= 0)
13204 return make_number (fringe_bitmap
);
13207 return make_number (-1); /* Use default arrow bitmap. */
13209 return overlay_arrow_string_or_property (var
);
13216 /* Return true if point moved out of or into a composition. Otherwise
13217 return false. PREV_BUF and PREV_PT are the last point buffer and
13218 position. BUF and PT are the current point buffer and position. */
13221 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13222 struct buffer
*buf
, ptrdiff_t pt
)
13224 ptrdiff_t start
, end
;
13226 Lisp_Object buffer
;
13228 XSETBUFFER (buffer
, buf
);
13229 /* Check a composition at the last point if point moved within the
13231 if (prev_buf
== buf
)
13234 /* Point didn't move. */
13237 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13238 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13239 && composition_valid_p (start
, end
, prop
)
13240 && start
< prev_pt
&& end
> prev_pt
)
13241 /* The last point was within the composition. Return true iff
13242 point moved out of the composition. */
13243 return (pt
<= start
|| pt
>= end
);
13246 /* Check a composition at the current point. */
13247 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13248 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13249 && composition_valid_p (start
, end
, prop
)
13250 && start
< pt
&& end
> pt
);
13253 /* Reconsider the clip changes of buffer which is displayed in W. */
13256 reconsider_clip_changes (struct window
*w
)
13258 struct buffer
*b
= XBUFFER (w
->contents
);
13260 if (b
->clip_changed
13261 && w
->window_end_valid
13262 && w
->current_matrix
->buffer
== b
13263 && w
->current_matrix
->zv
== BUF_ZV (b
)
13264 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13265 b
->clip_changed
= false;
13267 /* If display wasn't paused, and W is not a tool bar window, see if
13268 point has been moved into or out of a composition. In that case,
13269 set b->clip_changed to force updating the screen. If
13270 b->clip_changed has already been set, skip this check. */
13271 if (!b
->clip_changed
&& w
->window_end_valid
)
13273 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13274 ? PT
: marker_position (w
->pointm
));
13276 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13277 && check_point_in_composition (w
->current_matrix
->buffer
,
13278 w
->last_point
, b
, pt
))
13279 b
->clip_changed
= true;
13284 propagate_buffer_redisplay (void)
13285 { /* Resetting b->text->redisplay is problematic!
13286 We can't just reset it in the case that some window that displays
13287 it has not been redisplayed; and such a window can stay
13288 unredisplayed for a long time if it's currently invisible.
13289 But we do want to reset it at the end of redisplay otherwise
13290 its displayed windows will keep being redisplayed over and over
13292 So we copy all b->text->redisplay flags up to their windows here,
13293 such that mark_window_display_accurate can safely reset
13294 b->text->redisplay. */
13295 Lisp_Object ws
= window_list ();
13296 for (; CONSP (ws
); ws
= XCDR (ws
))
13298 struct window
*thisw
= XWINDOW (XCAR (ws
));
13299 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13300 if (thisb
->text
->redisplay
)
13301 thisw
->redisplay
= true;
13305 #define STOP_POLLING \
13306 do { if (! polling_stopped_here) stop_polling (); \
13307 polling_stopped_here = true; } while (false)
13309 #define RESUME_POLLING \
13310 do { if (polling_stopped_here) start_polling (); \
13311 polling_stopped_here = false; } while (false)
13314 /* Perhaps in the future avoid recentering windows if it
13315 is not necessary; currently that causes some problems. */
13318 redisplay_internal (void)
13320 struct window
*w
= XWINDOW (selected_window
);
13324 bool must_finish
= false, match_p
;
13325 struct text_pos tlbufpos
, tlendpos
;
13326 int number_of_visible_frames
;
13329 bool polling_stopped_here
= false;
13330 Lisp_Object tail
, frame
;
13332 /* True means redisplay has to consider all windows on all
13333 frames. False, only selected_window is considered. */
13334 bool consider_all_windows_p
;
13336 /* True means redisplay has to redisplay the miniwindow. */
13337 bool update_miniwindow_p
= false;
13339 /* True means we need to redraw frames whose 'redisplay' bit is set. */
13340 bool consider_some_frames_p
= false;
13342 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13344 /* No redisplay if running in batch mode or frame is not yet fully
13345 initialized, or redisplay is explicitly turned off by setting
13346 Vinhibit_redisplay. */
13347 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13348 || !NILP (Vinhibit_redisplay
))
13351 /* Don't examine these until after testing Vinhibit_redisplay.
13352 When Emacs is shutting down, perhaps because its connection to
13353 X has dropped, we should not look at them at all. */
13354 fr
= XFRAME (w
->frame
);
13355 sf
= SELECTED_FRAME ();
13357 if (!fr
->glyphs_initialized_p
)
13360 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13361 if (popup_activated ())
13365 /* I don't think this happens but let's be paranoid. */
13366 if (redisplaying_p
)
13369 /* Record a function that clears redisplaying_p
13370 when we leave this function. */
13371 count
= SPECPDL_INDEX ();
13372 record_unwind_protect_void (unwind_redisplay
);
13373 redisplaying_p
= true;
13374 specbind (Qinhibit_free_realized_faces
, Qnil
);
13376 /* Record this function, so it appears on the profiler's backtraces. */
13377 record_in_backtrace (Qredisplay_internal
, 0, 0);
13379 FOR_EACH_FRAME (tail
, frame
)
13380 XFRAME (frame
)->already_hscrolled_p
= false;
13383 /* Remember the currently selected window. */
13387 forget_escape_and_glyphless_faces ();
13389 inhibit_free_realized_faces
= false;
13391 /* If face_change, init_iterator will free all realized faces, which
13392 includes the faces referenced from current matrices. So, we
13393 can't reuse current matrices in this case. */
13395 windows_or_buffers_changed
= 47;
13397 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13398 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13400 /* Since frames on a single ASCII terminal share the same
13401 display area, displaying a different frame means redisplay
13402 the whole thing. */
13403 SET_FRAME_GARBAGED (sf
);
13405 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13407 FRAME_TTY (sf
)->previous_frame
= sf
;
13410 /* Set the visible flags for all frames. Do this before checking for
13411 resized or garbaged frames; they want to know if their frames are
13412 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13413 number_of_visible_frames
= 0;
13415 FOR_EACH_FRAME (tail
, frame
)
13417 struct frame
*f
= XFRAME (frame
);
13419 if (FRAME_VISIBLE_P (f
))
13421 ++number_of_visible_frames
;
13422 /* Adjust matrices for visible frames only. */
13423 if (f
->fonts_changed
)
13425 adjust_frame_glyphs (f
);
13426 /* Disable all redisplay optimizations for this frame.
13427 This is because adjust_frame_glyphs resets the
13428 enabled_p flag for all glyph rows of all windows, so
13429 many optimizations will fail anyway, and some might
13430 fail to test that flag and do bogus things as
13432 SET_FRAME_GARBAGED (f
);
13433 f
->fonts_changed
= false;
13435 /* If cursor type has been changed on the frame
13436 other than selected, consider all frames. */
13437 if (f
!= sf
&& f
->cursor_type_changed
)
13438 fset_redisplay (f
);
13440 clear_desired_matrices (f
);
13443 /* Notice any pending interrupt request to change frame size. */
13444 do_pending_window_change (true);
13446 /* do_pending_window_change could change the selected_window due to
13447 frame resizing which makes the selected window too small. */
13448 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13451 /* Clear frames marked as garbaged. */
13452 clear_garbaged_frames ();
13454 /* Build menubar and tool-bar items. */
13455 if (NILP (Vmemory_full
))
13456 prepare_menu_bars ();
13458 reconsider_clip_changes (w
);
13460 /* In most cases selected window displays current buffer. */
13461 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13464 /* Detect case that we need to write or remove a star in the mode line. */
13465 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13466 w
->update_mode_line
= true;
13468 if (mode_line_update_needed (w
))
13469 w
->update_mode_line
= true;
13471 /* If reconsider_clip_changes above decided that the narrowing
13472 in the current buffer changed, make sure all other windows
13473 showing that buffer will be redisplayed. */
13474 if (current_buffer
->clip_changed
)
13475 bset_update_mode_line (current_buffer
);
13478 /* Normally the message* functions will have already displayed and
13479 updated the echo area, but the frame may have been trashed, or
13480 the update may have been preempted, so display the echo area
13481 again here. Checking message_cleared_p captures the case that
13482 the echo area should be cleared. */
13483 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13484 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13485 || (message_cleared_p
13486 && minibuf_level
== 0
13487 /* If the mini-window is currently selected, this means the
13488 echo-area doesn't show through. */
13489 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13491 echo_area_display (false);
13493 if (message_cleared_p
)
13494 update_miniwindow_p
= true;
13496 must_finish
= true;
13498 /* If we don't display the current message, don't clear the
13499 message_cleared_p flag, because, if we did, we wouldn't clear
13500 the echo area in the next redisplay which doesn't preserve
13502 if (!display_last_displayed_message_p
)
13503 message_cleared_p
= false;
13505 else if (EQ (selected_window
, minibuf_window
)
13506 && (current_buffer
->clip_changed
|| window_outdated (w
))
13507 && resize_mini_window (w
, false))
13509 /* Resized active mini-window to fit the size of what it is
13510 showing if its contents might have changed. */
13511 must_finish
= true;
13513 /* If window configuration was changed, frames may have been
13514 marked garbaged. Clear them or we will experience
13515 surprises wrt scrolling. */
13516 clear_garbaged_frames ();
13519 if (windows_or_buffers_changed
&& !update_mode_lines
)
13520 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13521 only the windows's contents needs to be refreshed, or whether the
13522 mode-lines also need a refresh. */
13523 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13524 ? REDISPLAY_SOME
: 32);
13526 /* If specs for an arrow have changed, do thorough redisplay
13527 to ensure we remove any arrow that should no longer exist. */
13528 if (overlay_arrows_changed_p ())
13529 /* Apparently, this is the only case where we update other windows,
13530 without updating other mode-lines. */
13531 windows_or_buffers_changed
= 49;
13533 consider_all_windows_p
= (update_mode_lines
13534 || windows_or_buffers_changed
);
13536 #define AINC(a,i) \
13538 Lisp_Object entry = Fgethash (make_number (i), a, make_number (0)); \
13539 if (INTEGERP (entry)) \
13540 Fputhash (make_number (i), make_number (1 + XINT (entry)), a); \
13543 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13544 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13546 /* Optimize the case that only the line containing the cursor in the
13547 selected window has changed. Variables starting with this_ are
13548 set in display_line and record information about the line
13549 containing the cursor. */
13550 tlbufpos
= this_line_start_pos
;
13551 tlendpos
= this_line_end_pos
;
13552 if (!consider_all_windows_p
13553 && CHARPOS (tlbufpos
) > 0
13554 && !w
->update_mode_line
13555 && !current_buffer
->clip_changed
13556 && !current_buffer
->prevent_redisplay_optimizations_p
13557 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13558 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13559 && !XFRAME (w
->frame
)->cursor_type_changed
13560 && !XFRAME (w
->frame
)->face_change
13561 && !XFRAME (w
->frame
)->redisplay
13562 /* Make sure recorded data applies to current buffer, etc. */
13563 && this_line_buffer
== current_buffer
13566 && !w
->optional_new_start
13567 /* Point must be on the line that we have info recorded about. */
13568 && PT
>= CHARPOS (tlbufpos
)
13569 && PT
<= Z
- CHARPOS (tlendpos
)
13570 /* All text outside that line, including its final newline,
13571 must be unchanged. */
13572 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13573 CHARPOS (tlendpos
)))
13575 if (CHARPOS (tlbufpos
) > BEGV
13576 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13577 && (CHARPOS (tlbufpos
) == ZV
13578 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13579 /* Former continuation line has disappeared by becoming empty. */
13581 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13583 /* We have to handle the case of continuation around a
13584 wide-column character (see the comment in indent.c around
13587 For instance, in the following case:
13589 -------- Insert --------
13590 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13591 J_I_ ==> J_I_ `^^' are cursors.
13595 As we have to redraw the line above, we cannot use this
13599 int line_height_before
= this_line_pixel_height
;
13601 /* Note that start_display will handle the case that the
13602 line starting at tlbufpos is a continuation line. */
13603 start_display (&it
, w
, tlbufpos
);
13605 /* Implementation note: It this still necessary? */
13606 if (it
.current_x
!= this_line_start_x
)
13609 TRACE ((stderr
, "trying display optimization 1\n"));
13610 w
->cursor
.vpos
= -1;
13611 overlay_arrow_seen
= false;
13612 it
.vpos
= this_line_vpos
;
13613 it
.current_y
= this_line_y
;
13614 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13615 display_line (&it
);
13617 /* If line contains point, is not continued,
13618 and ends at same distance from eob as before, we win. */
13619 if (w
->cursor
.vpos
>= 0
13620 /* Line is not continued, otherwise this_line_start_pos
13621 would have been set to 0 in display_line. */
13622 && CHARPOS (this_line_start_pos
)
13623 /* Line ends as before. */
13624 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13625 /* Line has same height as before. Otherwise other lines
13626 would have to be shifted up or down. */
13627 && this_line_pixel_height
== line_height_before
)
13629 /* If this is not the window's last line, we must adjust
13630 the charstarts of the lines below. */
13631 if (it
.current_y
< it
.last_visible_y
)
13633 struct glyph_row
*row
13634 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13635 ptrdiff_t delta
, delta_bytes
;
13637 /* We used to distinguish between two cases here,
13638 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13639 when the line ends in a newline or the end of the
13640 buffer's accessible portion. But both cases did
13641 the same, so they were collapsed. */
13643 - CHARPOS (tlendpos
)
13644 - MATRIX_ROW_START_CHARPOS (row
));
13645 delta_bytes
= (Z_BYTE
13646 - BYTEPOS (tlendpos
)
13647 - MATRIX_ROW_START_BYTEPOS (row
));
13649 increment_matrix_positions (w
->current_matrix
,
13650 this_line_vpos
+ 1,
13651 w
->current_matrix
->nrows
,
13652 delta
, delta_bytes
);
13655 /* If this row displays text now but previously didn't,
13656 or vice versa, w->window_end_vpos may have to be
13658 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13660 if (w
->window_end_vpos
< this_line_vpos
)
13661 w
->window_end_vpos
= this_line_vpos
;
13663 else if (w
->window_end_vpos
== this_line_vpos
13664 && this_line_vpos
> 0)
13665 w
->window_end_vpos
= this_line_vpos
- 1;
13666 w
->window_end_valid
= false;
13668 /* Update hint: No need to try to scroll in update_window. */
13669 w
->desired_matrix
->no_scrolling_p
= true;
13672 *w
->desired_matrix
->method
= 0;
13673 debug_method_add (w
, "optimization 1");
13675 #ifdef HAVE_WINDOW_SYSTEM
13676 update_window_fringes (w
, false);
13683 else if (/* Cursor position hasn't changed. */
13684 PT
== w
->last_point
13685 /* Make sure the cursor was last displayed
13686 in this window. Otherwise we have to reposition it. */
13688 /* PXW: Must be converted to pixels, probably. */
13689 && 0 <= w
->cursor
.vpos
13690 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13694 do_pending_window_change (true);
13695 /* If selected_window changed, redisplay again. */
13696 if (WINDOWP (selected_window
)
13697 && (w
= XWINDOW (selected_window
)) != sw
)
13700 /* We used to always goto end_of_redisplay here, but this
13701 isn't enough if we have a blinking cursor. */
13702 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13703 goto end_of_redisplay
;
13707 /* If highlighting the region, or if the cursor is in the echo area,
13708 then we can't just move the cursor. */
13709 else if (NILP (Vshow_trailing_whitespace
)
13710 && !cursor_in_echo_area
)
13713 struct glyph_row
*row
;
13715 /* Skip from tlbufpos to PT and see where it is. Note that
13716 PT may be in invisible text. If so, we will end at the
13717 next visible position. */
13718 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13719 NULL
, DEFAULT_FACE_ID
);
13720 it
.current_x
= this_line_start_x
;
13721 it
.current_y
= this_line_y
;
13722 it
.vpos
= this_line_vpos
;
13724 /* The call to move_it_to stops in front of PT, but
13725 moves over before-strings. */
13726 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13728 if (it
.vpos
== this_line_vpos
13729 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13732 eassert (this_line_vpos
== it
.vpos
);
13733 eassert (this_line_y
== it
.current_y
);
13734 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13736 *w
->desired_matrix
->method
= 0;
13737 debug_method_add (w
, "optimization 3");
13746 /* Text changed drastically or point moved off of line. */
13747 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13750 CHARPOS (this_line_start_pos
) = 0;
13751 ++clear_face_cache_count
;
13752 #ifdef HAVE_WINDOW_SYSTEM
13753 ++clear_image_cache_count
;
13756 /* Build desired matrices, and update the display. If
13757 consider_all_windows_p, do it for all windows on all frames. If
13758 a frame's 'redisplay' flag is set, do it for all windows on each
13759 such frame. Otherwise do it for selected_window, only. */
13761 if (!consider_all_windows_p
)
13763 FOR_EACH_FRAME (tail
, frame
)
13765 if (XFRAME (frame
)->redisplay
&& XFRAME (frame
) != sf
)
13767 consider_some_frames_p
= true;
13773 if (consider_all_windows_p
|| consider_some_frames_p
)
13775 FOR_EACH_FRAME (tail
, frame
)
13777 if (XFRAME (frame
)->redisplay
|| consider_all_windows_p
)
13778 XFRAME (frame
)->updated_p
= false;
13781 propagate_buffer_redisplay ();
13783 FOR_EACH_FRAME (tail
, frame
)
13785 struct frame
*f
= XFRAME (frame
);
13787 /* We don't have to do anything for unselected terminal
13789 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13790 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13793 if (!consider_all_windows_p
&& !f
->redisplay
)
13797 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13800 /* Only GC scrollbars when we redisplay the whole frame. */
13801 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13802 /* Mark all the scroll bars to be removed; we'll redeem
13803 the ones we want when we redisplay their windows. */
13804 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13805 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13807 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13808 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13809 /* Remember that the invisible frames need to be redisplayed next
13810 time they're visible. */
13811 else if (!REDISPLAY_SOME_P ())
13812 f
->redisplay
= true;
13814 /* The X error handler may have deleted that frame. */
13815 if (!FRAME_LIVE_P (f
))
13818 /* Any scroll bars which redisplay_windows should have
13819 nuked should now go away. */
13820 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13821 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13823 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13825 /* If fonts changed on visible frame, display again. */
13826 if (f
->fonts_changed
)
13828 adjust_frame_glyphs (f
);
13829 /* Disable all redisplay optimizations for this
13830 frame. For the reasons, see the comment near
13831 the previous call to adjust_frame_glyphs above. */
13832 SET_FRAME_GARBAGED (f
);
13833 f
->fonts_changed
= false;
13837 /* See if we have to hscroll. */
13838 if (!f
->already_hscrolled_p
)
13840 f
->already_hscrolled_p
= true;
13841 if (hscroll_windows (f
->root_window
))
13845 /* Prevent various kinds of signals during display
13846 update. stdio is not robust about handling
13847 signals, which can cause an apparent I/O error. */
13848 if (interrupt_input
)
13849 unrequest_sigio ();
13852 pending
|= update_frame (f
, false, false);
13853 f
->cursor_type_changed
= false;
13854 f
->updated_p
= true;
13859 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13863 /* Do the mark_window_display_accurate after all windows have
13864 been redisplayed because this call resets flags in buffers
13865 which are needed for proper redisplay. */
13866 FOR_EACH_FRAME (tail
, frame
)
13868 struct frame
*f
= XFRAME (frame
);
13871 f
->redisplay
= false;
13872 mark_window_display_accurate (f
->root_window
, true);
13873 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13874 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13879 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13881 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13882 struct frame
*mini_frame
;
13884 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13885 /* Use list_of_error, not Qerror, so that
13886 we catch only errors and don't run the debugger. */
13887 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13889 redisplay_window_error
);
13890 if (update_miniwindow_p
)
13891 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13893 redisplay_window_error
);
13895 /* Compare desired and current matrices, perform output. */
13898 /* If fonts changed, display again. */
13899 if (sf
->fonts_changed
)
13902 /* Prevent freeing of realized faces, since desired matrices are
13903 pending that reference the faces we computed and cached. */
13904 inhibit_free_realized_faces
= true;
13906 /* Prevent various kinds of signals during display update.
13907 stdio is not robust about handling signals,
13908 which can cause an apparent I/O error. */
13909 if (interrupt_input
)
13910 unrequest_sigio ();
13913 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13915 if (hscroll_windows (selected_window
))
13918 XWINDOW (selected_window
)->must_be_updated_p
= true;
13919 pending
= update_frame (sf
, false, false);
13920 sf
->cursor_type_changed
= false;
13923 /* We may have called echo_area_display at the top of this
13924 function. If the echo area is on another frame, that may
13925 have put text on a frame other than the selected one, so the
13926 above call to update_frame would not have caught it. Catch
13928 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13929 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13931 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13933 XWINDOW (mini_window
)->must_be_updated_p
= true;
13934 pending
|= update_frame (mini_frame
, false, false);
13935 mini_frame
->cursor_type_changed
= false;
13936 if (!pending
&& hscroll_windows (mini_window
))
13941 /* If display was paused because of pending input, make sure we do a
13942 thorough update the next time. */
13945 /* Prevent the optimization at the beginning of
13946 redisplay_internal that tries a single-line update of the
13947 line containing the cursor in the selected window. */
13948 CHARPOS (this_line_start_pos
) = 0;
13950 /* Let the overlay arrow be updated the next time. */
13951 update_overlay_arrows (0);
13953 /* If we pause after scrolling, some rows in the current
13954 matrices of some windows are not valid. */
13955 if (!WINDOW_FULL_WIDTH_P (w
)
13956 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13957 update_mode_lines
= 36;
13961 if (!consider_all_windows_p
)
13963 /* This has already been done above if
13964 consider_all_windows_p is set. */
13965 if (XBUFFER (w
->contents
)->text
->redisplay
13966 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
13967 /* This can happen if b->text->redisplay was set during
13969 propagate_buffer_redisplay ();
13970 mark_window_display_accurate_1 (w
, true);
13972 /* Say overlay arrows are up to date. */
13973 update_overlay_arrows (1);
13975 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13976 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13979 update_mode_lines
= 0;
13980 windows_or_buffers_changed
= 0;
13983 /* Start SIGIO interrupts coming again. Having them off during the
13984 code above makes it less likely one will discard output, but not
13985 impossible, since there might be stuff in the system buffer here.
13986 But it is much hairier to try to do anything about that. */
13987 if (interrupt_input
)
13991 /* If a frame has become visible which was not before, redisplay
13992 again, so that we display it. Expose events for such a frame
13993 (which it gets when becoming visible) don't call the parts of
13994 redisplay constructing glyphs, so simply exposing a frame won't
13995 display anything in this case. So, we have to display these
13996 frames here explicitly. */
14001 FOR_EACH_FRAME (tail
, frame
)
14003 if (XFRAME (frame
)->visible
)
14007 if (new_count
!= number_of_visible_frames
)
14008 windows_or_buffers_changed
= 52;
14011 /* Change frame size now if a change is pending. */
14012 do_pending_window_change (true);
14014 /* If we just did a pending size change, or have additional
14015 visible frames, or selected_window changed, redisplay again. */
14016 if ((windows_or_buffers_changed
&& !pending
)
14017 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14020 /* Clear the face and image caches.
14022 We used to do this only if consider_all_windows_p. But the cache
14023 needs to be cleared if a timer creates images in the current
14024 buffer (e.g. the test case in Bug#6230). */
14026 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14028 clear_face_cache (false);
14029 clear_face_cache_count
= 0;
14032 #ifdef HAVE_WINDOW_SYSTEM
14033 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14035 clear_image_caches (Qnil
);
14036 clear_image_cache_count
= 0;
14038 #endif /* HAVE_WINDOW_SYSTEM */
14042 ns_set_doc_edited ();
14044 if (interrupt_input
&& interrupts_deferred
)
14047 unbind_to (count
, Qnil
);
14052 /* Redisplay, but leave alone any recent echo area message unless
14053 another message has been requested in its place.
14055 This is useful in situations where you need to redisplay but no
14056 user action has occurred, making it inappropriate for the message
14057 area to be cleared. See tracking_off and
14058 wait_reading_process_output for examples of these situations.
14060 FROM_WHERE is an integer saying from where this function was
14061 called. This is useful for debugging. */
14064 redisplay_preserve_echo_area (int from_where
)
14066 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14068 if (!NILP (echo_area_buffer
[1]))
14070 /* We have a previously displayed message, but no current
14071 message. Redisplay the previous message. */
14072 display_last_displayed_message_p
= true;
14073 redisplay_internal ();
14074 display_last_displayed_message_p
= false;
14077 redisplay_internal ();
14079 flush_frame (SELECTED_FRAME ());
14083 /* Function registered with record_unwind_protect in redisplay_internal. */
14086 unwind_redisplay (void)
14088 redisplaying_p
= false;
14092 /* Mark the display of leaf window W as accurate or inaccurate.
14093 If ACCURATE_P, mark display of W as accurate.
14094 If !ACCURATE_P, arrange for W to be redisplayed the next
14095 time redisplay_internal is called. */
14098 mark_window_display_accurate_1 (struct window
*w
, bool accurate_p
)
14100 struct buffer
*b
= XBUFFER (w
->contents
);
14102 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14103 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14104 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14108 b
->clip_changed
= false;
14109 b
->prevent_redisplay_optimizations_p
= false;
14110 eassert (buffer_window_count (b
) > 0);
14111 /* Resetting b->text->redisplay is problematic!
14112 In order to make it safer to do it here, redisplay_internal must
14113 have copied all b->text->redisplay to their respective windows. */
14114 b
->text
->redisplay
= false;
14116 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14117 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14118 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14119 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14121 w
->current_matrix
->buffer
= b
;
14122 w
->current_matrix
->begv
= BUF_BEGV (b
);
14123 w
->current_matrix
->zv
= BUF_ZV (b
);
14125 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14126 w
->last_cursor_off_p
= w
->cursor_off_p
;
14128 if (w
== XWINDOW (selected_window
))
14129 w
->last_point
= BUF_PT (b
);
14131 w
->last_point
= marker_position (w
->pointm
);
14133 w
->window_end_valid
= true;
14134 w
->update_mode_line
= false;
14137 w
->redisplay
= !accurate_p
;
14141 /* Mark the display of windows in the window tree rooted at WINDOW as
14142 accurate or inaccurate. If ACCURATE_P, mark display of
14143 windows as accurate. If !ACCURATE_P, arrange for windows to
14144 be redisplayed the next time redisplay_internal is called. */
14147 mark_window_display_accurate (Lisp_Object window
, bool accurate_p
)
14151 for (; !NILP (window
); window
= w
->next
)
14153 w
= XWINDOW (window
);
14154 if (WINDOWP (w
->contents
))
14155 mark_window_display_accurate (w
->contents
, accurate_p
);
14157 mark_window_display_accurate_1 (w
, accurate_p
);
14161 update_overlay_arrows (1);
14163 /* Force a thorough redisplay the next time by setting
14164 last_arrow_position and last_arrow_string to t, which is
14165 unequal to any useful value of Voverlay_arrow_... */
14166 update_overlay_arrows (-1);
14170 /* Return value in display table DP (Lisp_Char_Table *) for character
14171 C. Since a display table doesn't have any parent, we don't have to
14172 follow parent. Do not call this function directly but use the
14173 macro DISP_CHAR_VECTOR. */
14176 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14180 if (ASCII_CHAR_P (c
))
14183 if (SUB_CHAR_TABLE_P (val
))
14184 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14190 XSETCHAR_TABLE (table
, dp
);
14191 val
= char_table_ref (table
, c
);
14200 /***********************************************************************
14202 ***********************************************************************/
14204 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14207 redisplay_windows (Lisp_Object window
)
14209 while (!NILP (window
))
14211 struct window
*w
= XWINDOW (window
);
14213 if (WINDOWP (w
->contents
))
14214 redisplay_windows (w
->contents
);
14215 else if (BUFFERP (w
->contents
))
14217 displayed_buffer
= XBUFFER (w
->contents
);
14218 /* Use list_of_error, not Qerror, so that
14219 we catch only errors and don't run the debugger. */
14220 internal_condition_case_1 (redisplay_window_0
, window
,
14222 redisplay_window_error
);
14230 redisplay_window_error (Lisp_Object ignore
)
14232 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14237 redisplay_window_0 (Lisp_Object window
)
14239 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14240 redisplay_window (window
, false);
14245 redisplay_window_1 (Lisp_Object window
)
14247 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14248 redisplay_window (window
, true);
14253 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14254 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14255 which positions recorded in ROW differ from current buffer
14258 Return true iff cursor is on this row. */
14261 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14262 struct glyph_matrix
*matrix
,
14263 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14266 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14267 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14268 struct glyph
*cursor
= NULL
;
14269 /* The last known character position in row. */
14270 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14272 ptrdiff_t pt_old
= PT
- delta
;
14273 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14274 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14275 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14276 /* A glyph beyond the edge of TEXT_AREA which we should never
14278 struct glyph
*glyphs_end
= end
;
14279 /* True means we've found a match for cursor position, but that
14280 glyph has the avoid_cursor_p flag set. */
14281 bool match_with_avoid_cursor
= false;
14282 /* True means we've seen at least one glyph that came from a
14284 bool string_seen
= false;
14285 /* Largest and smallest buffer positions seen so far during scan of
14287 ptrdiff_t bpos_max
= pos_before
;
14288 ptrdiff_t bpos_min
= pos_after
;
14289 /* Last buffer position covered by an overlay string with an integer
14290 `cursor' property. */
14291 ptrdiff_t bpos_covered
= 0;
14292 /* True means the display string on which to display the cursor
14293 comes from a text property, not from an overlay. */
14294 bool string_from_text_prop
= false;
14296 /* Don't even try doing anything if called for a mode-line or
14297 header-line row, since the rest of the code isn't prepared to
14298 deal with such calamities. */
14299 eassert (!row
->mode_line_p
);
14300 if (row
->mode_line_p
)
14303 /* Skip over glyphs not having an object at the start and the end of
14304 the row. These are special glyphs like truncation marks on
14305 terminal frames. */
14306 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14308 if (!row
->reversed_p
)
14311 && NILP (glyph
->object
)
14312 && glyph
->charpos
< 0)
14314 x
+= glyph
->pixel_width
;
14318 && NILP ((end
- 1)->object
)
14319 /* CHARPOS is zero for blanks and stretch glyphs
14320 inserted by extend_face_to_end_of_line. */
14321 && (end
- 1)->charpos
<= 0)
14323 glyph_before
= glyph
- 1;
14330 /* If the glyph row is reversed, we need to process it from back
14331 to front, so swap the edge pointers. */
14332 glyphs_end
= end
= glyph
- 1;
14333 glyph
+= row
->used
[TEXT_AREA
] - 1;
14335 while (glyph
> end
+ 1
14336 && NILP (glyph
->object
)
14337 && glyph
->charpos
< 0)
14340 x
-= glyph
->pixel_width
;
14342 if (NILP (glyph
->object
) && glyph
->charpos
< 0)
14344 /* By default, in reversed rows we put the cursor on the
14345 rightmost (first in the reading order) glyph. */
14346 for (g
= end
+ 1; g
< glyph
; g
++)
14347 x
+= g
->pixel_width
;
14349 && NILP ((end
+ 1)->object
)
14350 && (end
+ 1)->charpos
<= 0)
14352 glyph_before
= glyph
+ 1;
14356 else if (row
->reversed_p
)
14358 /* In R2L rows that don't display text, put the cursor on the
14359 rightmost glyph. Case in point: an empty last line that is
14360 part of an R2L paragraph. */
14362 /* Avoid placing the cursor on the last glyph of the row, where
14363 on terminal frames we hold the vertical border between
14364 adjacent windows. */
14365 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14366 && !WINDOW_RIGHTMOST_P (w
)
14367 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14369 x
= -1; /* will be computed below, at label compute_x */
14372 /* Step 1: Try to find the glyph whose character position
14373 corresponds to point. If that's not possible, find 2 glyphs
14374 whose character positions are the closest to point, one before
14375 point, the other after it. */
14376 if (!row
->reversed_p
)
14377 while (/* not marched to end of glyph row */
14379 /* glyph was not inserted by redisplay for internal purposes */
14380 && !NILP (glyph
->object
))
14382 if (BUFFERP (glyph
->object
))
14384 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14386 if (glyph
->charpos
> bpos_max
)
14387 bpos_max
= glyph
->charpos
;
14388 if (glyph
->charpos
< bpos_min
)
14389 bpos_min
= glyph
->charpos
;
14390 if (!glyph
->avoid_cursor_p
)
14392 /* If we hit point, we've found the glyph on which to
14393 display the cursor. */
14396 match_with_avoid_cursor
= false;
14399 /* See if we've found a better approximation to
14400 POS_BEFORE or to POS_AFTER. */
14401 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14403 pos_before
= glyph
->charpos
;
14404 glyph_before
= glyph
;
14406 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14408 pos_after
= glyph
->charpos
;
14409 glyph_after
= glyph
;
14412 else if (dpos
== 0)
14413 match_with_avoid_cursor
= true;
14415 else if (STRINGP (glyph
->object
))
14417 Lisp_Object chprop
;
14418 ptrdiff_t glyph_pos
= glyph
->charpos
;
14420 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14422 if (!NILP (chprop
))
14424 /* If the string came from a `display' text property,
14425 look up the buffer position of that property and
14426 use that position to update bpos_max, as if we
14427 actually saw such a position in one of the row's
14428 glyphs. This helps with supporting integer values
14429 of `cursor' property on the display string in
14430 situations where most or all of the row's buffer
14431 text is completely covered by display properties,
14432 so that no glyph with valid buffer positions is
14433 ever seen in the row. */
14434 ptrdiff_t prop_pos
=
14435 string_buffer_position_lim (glyph
->object
, pos_before
,
14438 if (prop_pos
>= pos_before
)
14439 bpos_max
= prop_pos
;
14441 if (INTEGERP (chprop
))
14443 bpos_covered
= bpos_max
+ XINT (chprop
);
14444 /* If the `cursor' property covers buffer positions up
14445 to and including point, we should display cursor on
14446 this glyph. Note that, if a `cursor' property on one
14447 of the string's characters has an integer value, we
14448 will break out of the loop below _before_ we get to
14449 the position match above. IOW, integer values of
14450 the `cursor' property override the "exact match for
14451 point" strategy of positioning the cursor. */
14452 /* Implementation note: bpos_max == pt_old when, e.g.,
14453 we are in an empty line, where bpos_max is set to
14454 MATRIX_ROW_START_CHARPOS, see above. */
14455 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14462 string_seen
= true;
14464 x
+= glyph
->pixel_width
;
14467 else if (glyph
> end
) /* row is reversed */
14468 while (!NILP (glyph
->object
))
14470 if (BUFFERP (glyph
->object
))
14472 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14474 if (glyph
->charpos
> bpos_max
)
14475 bpos_max
= glyph
->charpos
;
14476 if (glyph
->charpos
< bpos_min
)
14477 bpos_min
= glyph
->charpos
;
14478 if (!glyph
->avoid_cursor_p
)
14482 match_with_avoid_cursor
= false;
14485 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14487 pos_before
= glyph
->charpos
;
14488 glyph_before
= glyph
;
14490 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14492 pos_after
= glyph
->charpos
;
14493 glyph_after
= glyph
;
14496 else if (dpos
== 0)
14497 match_with_avoid_cursor
= true;
14499 else if (STRINGP (glyph
->object
))
14501 Lisp_Object chprop
;
14502 ptrdiff_t glyph_pos
= glyph
->charpos
;
14504 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14506 if (!NILP (chprop
))
14508 ptrdiff_t prop_pos
=
14509 string_buffer_position_lim (glyph
->object
, pos_before
,
14512 if (prop_pos
>= pos_before
)
14513 bpos_max
= prop_pos
;
14515 if (INTEGERP (chprop
))
14517 bpos_covered
= bpos_max
+ XINT (chprop
);
14518 /* If the `cursor' property covers buffer positions up
14519 to and including point, we should display cursor on
14521 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14527 string_seen
= true;
14530 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14532 x
--; /* can't use any pixel_width */
14535 x
-= glyph
->pixel_width
;
14538 /* Step 2: If we didn't find an exact match for point, we need to
14539 look for a proper place to put the cursor among glyphs between
14540 GLYPH_BEFORE and GLYPH_AFTER. */
14541 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14542 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14543 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14545 /* An empty line has a single glyph whose OBJECT is nil and
14546 whose CHARPOS is the position of a newline on that line.
14547 Note that on a TTY, there are more glyphs after that, which
14548 were produced by extend_face_to_end_of_line, but their
14549 CHARPOS is zero or negative. */
14550 bool empty_line_p
=
14551 ((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14552 && NILP (glyph
->object
) && glyph
->charpos
> 0
14553 /* On a TTY, continued and truncated rows also have a glyph at
14554 their end whose OBJECT is nil and whose CHARPOS is
14555 positive (the continuation and truncation glyphs), but such
14556 rows are obviously not "empty". */
14557 && !(row
->continued_p
|| row
->truncated_on_right_p
));
14559 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14561 ptrdiff_t ellipsis_pos
;
14563 /* Scan back over the ellipsis glyphs. */
14564 if (!row
->reversed_p
)
14566 ellipsis_pos
= (glyph
- 1)->charpos
;
14567 while (glyph
> row
->glyphs
[TEXT_AREA
]
14568 && (glyph
- 1)->charpos
== ellipsis_pos
)
14569 glyph
--, x
-= glyph
->pixel_width
;
14570 /* That loop always goes one position too far, including
14571 the glyph before the ellipsis. So scan forward over
14573 x
+= glyph
->pixel_width
;
14576 else /* row is reversed */
14578 ellipsis_pos
= (glyph
+ 1)->charpos
;
14579 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14580 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14581 glyph
++, x
+= glyph
->pixel_width
;
14582 x
-= glyph
->pixel_width
;
14586 else if (match_with_avoid_cursor
)
14588 cursor
= glyph_after
;
14591 else if (string_seen
)
14593 int incr
= row
->reversed_p
? -1 : +1;
14595 /* Need to find the glyph that came out of a string which is
14596 present at point. That glyph is somewhere between
14597 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14598 positioned between POS_BEFORE and POS_AFTER in the
14600 struct glyph
*start
, *stop
;
14601 ptrdiff_t pos
= pos_before
;
14605 /* If the row ends in a newline from a display string,
14606 reordering could have moved the glyphs belonging to the
14607 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14608 in this case we extend the search to the last glyph in
14609 the row that was not inserted by redisplay. */
14610 if (row
->ends_in_newline_from_string_p
)
14613 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14616 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14617 correspond to POS_BEFORE and POS_AFTER, respectively. We
14618 need START and STOP in the order that corresponds to the
14619 row's direction as given by its reversed_p flag. If the
14620 directionality of characters between POS_BEFORE and
14621 POS_AFTER is the opposite of the row's base direction,
14622 these characters will have been reordered for display,
14623 and we need to reverse START and STOP. */
14624 if (!row
->reversed_p
)
14626 start
= min (glyph_before
, glyph_after
);
14627 stop
= max (glyph_before
, glyph_after
);
14631 start
= max (glyph_before
, glyph_after
);
14632 stop
= min (glyph_before
, glyph_after
);
14634 for (glyph
= start
+ incr
;
14635 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14638 /* Any glyphs that come from the buffer are here because
14639 of bidi reordering. Skip them, and only pay
14640 attention to glyphs that came from some string. */
14641 if (STRINGP (glyph
->object
))
14645 /* If the display property covers the newline, we
14646 need to search for it one position farther. */
14647 ptrdiff_t lim
= pos_after
14648 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14650 string_from_text_prop
= false;
14651 str
= glyph
->object
;
14652 tem
= string_buffer_position_lim (str
, pos
, lim
, false);
14653 if (tem
== 0 /* from overlay */
14656 /* If the string from which this glyph came is
14657 found in the buffer at point, or at position
14658 that is closer to point than pos_after, then
14659 we've found the glyph we've been looking for.
14660 If it comes from an overlay (tem == 0), and
14661 it has the `cursor' property on one of its
14662 glyphs, record that glyph as a candidate for
14663 displaying the cursor. (As in the
14664 unidirectional version, we will display the
14665 cursor on the last candidate we find.) */
14668 || (tem
- pt_old
> 0 && tem
< pos_after
))
14670 /* The glyphs from this string could have
14671 been reordered. Find the one with the
14672 smallest string position. Or there could
14673 be a character in the string with the
14674 `cursor' property, which means display
14675 cursor on that character's glyph. */
14676 ptrdiff_t strpos
= glyph
->charpos
;
14681 string_from_text_prop
= true;
14684 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14685 && EQ (glyph
->object
, str
);
14689 ptrdiff_t gpos
= glyph
->charpos
;
14691 cprop
= Fget_char_property (make_number (gpos
),
14699 if (tem
&& glyph
->charpos
< strpos
)
14701 strpos
= glyph
->charpos
;
14707 || (tem
- pt_old
> 0 && tem
< pos_after
))
14711 pos
= tem
+ 1; /* don't find previous instances */
14713 /* This string is not what we want; skip all of the
14714 glyphs that came from it. */
14715 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14716 && EQ (glyph
->object
, str
))
14723 /* If we reached the end of the line, and END was from a string,
14724 the cursor is not on this line. */
14726 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14727 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14728 && STRINGP (end
->object
)
14729 && row
->continued_p
)
14732 /* A truncated row may not include PT among its character positions.
14733 Setting the cursor inside the scroll margin will trigger
14734 recalculation of hscroll in hscroll_window_tree. But if a
14735 display string covers point, defer to the string-handling
14736 code below to figure this out. */
14737 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14739 cursor
= glyph_before
;
14742 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14743 /* Zero-width characters produce no glyphs. */
14745 && (row
->reversed_p
14746 ? glyph_after
> glyphs_end
14747 : glyph_after
< glyphs_end
)))
14749 cursor
= glyph_after
;
14755 if (cursor
!= NULL
)
14757 else if (glyph
== glyphs_end
14758 && pos_before
== pos_after
14759 && STRINGP ((row
->reversed_p
14760 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14761 : row
->glyphs
[TEXT_AREA
])->object
))
14763 /* If all the glyphs of this row came from strings, put the
14764 cursor on the first glyph of the row. This avoids having the
14765 cursor outside of the text area in this very rare and hard
14769 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14770 : row
->glyphs
[TEXT_AREA
];
14776 /* Need to compute x that corresponds to GLYPH. */
14777 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14779 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14781 x
+= g
->pixel_width
;
14785 /* ROW could be part of a continued line, which, under bidi
14786 reordering, might have other rows whose start and end charpos
14787 occlude point. Only set w->cursor if we found a better
14788 approximation to the cursor position than we have from previously
14789 examined candidate rows belonging to the same continued line. */
14790 if (/* We already have a candidate row. */
14791 w
->cursor
.vpos
>= 0
14792 /* That candidate is not the row we are processing. */
14793 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14794 /* Make sure cursor.vpos specifies a row whose start and end
14795 charpos occlude point, and it is valid candidate for being a
14796 cursor-row. This is because some callers of this function
14797 leave cursor.vpos at the row where the cursor was displayed
14798 during the last redisplay cycle. */
14799 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14800 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14801 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14804 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14806 /* Don't consider glyphs that are outside TEXT_AREA. */
14807 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14809 /* Keep the candidate whose buffer position is the closest to
14810 point or has the `cursor' property. */
14811 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14812 w
->cursor
.hpos
>= 0
14813 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14814 && ((BUFFERP (g1
->object
)
14815 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14816 || (BUFFERP (glyph
->object
)
14817 && eabs (g1
->charpos
- pt_old
)
14818 < eabs (glyph
->charpos
- pt_old
))))
14819 /* Previous candidate is a glyph from a string that has
14820 a non-nil `cursor' property. */
14821 || (STRINGP (g1
->object
)
14822 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14823 Qcursor
, g1
->object
))
14824 /* Previous candidate is from the same display
14825 string as this one, and the display string
14826 came from a text property. */
14827 || (EQ (g1
->object
, glyph
->object
)
14828 && string_from_text_prop
)
14829 /* this candidate is from newline and its
14830 position is not an exact match */
14831 || (NILP (glyph
->object
)
14832 && glyph
->charpos
!= pt_old
)))))
14834 /* If this candidate gives an exact match, use that. */
14835 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14836 /* If this candidate is a glyph created for the
14837 terminating newline of a line, and point is on that
14838 newline, it wins because it's an exact match. */
14839 || (!row
->continued_p
14840 && NILP (glyph
->object
)
14841 && glyph
->charpos
== 0
14842 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14843 /* Otherwise, keep the candidate that comes from a row
14844 spanning less buffer positions. This may win when one or
14845 both candidate positions are on glyphs that came from
14846 display strings, for which we cannot compare buffer
14848 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14849 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14850 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14853 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14855 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14856 w
->cursor
.y
= row
->y
+ dy
;
14858 if (w
== XWINDOW (selected_window
))
14860 if (!row
->continued_p
14861 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14864 this_line_buffer
= XBUFFER (w
->contents
);
14866 CHARPOS (this_line_start_pos
)
14867 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14868 BYTEPOS (this_line_start_pos
)
14869 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14871 CHARPOS (this_line_end_pos
)
14872 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14873 BYTEPOS (this_line_end_pos
)
14874 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14876 this_line_y
= w
->cursor
.y
;
14877 this_line_pixel_height
= row
->height
;
14878 this_line_vpos
= w
->cursor
.vpos
;
14879 this_line_start_x
= row
->x
;
14882 CHARPOS (this_line_start_pos
) = 0;
14889 /* Run window scroll functions, if any, for WINDOW with new window
14890 start STARTP. Sets the window start of WINDOW to that position.
14892 We assume that the window's buffer is really current. */
14894 static struct text_pos
14895 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14897 struct window
*w
= XWINDOW (window
);
14898 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14900 eassert (current_buffer
== XBUFFER (w
->contents
));
14902 if (!NILP (Vwindow_scroll_functions
))
14904 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14905 make_number (CHARPOS (startp
)));
14906 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14907 /* In case the hook functions switch buffers. */
14908 set_buffer_internal (XBUFFER (w
->contents
));
14915 /* Make sure the line containing the cursor is fully visible.
14916 A value of true means there is nothing to be done.
14917 (Either the line is fully visible, or it cannot be made so,
14918 or we cannot tell.)
14920 If FORCE_P, return false even if partial visible cursor row
14921 is higher than window.
14923 If CURRENT_MATRIX_P, use the information from the
14924 window's current glyph matrix; otherwise use the desired glyph
14927 A value of false means the caller should do scrolling
14928 as if point had gone off the screen. */
14931 cursor_row_fully_visible_p (struct window
*w
, bool force_p
,
14932 bool current_matrix_p
)
14934 struct glyph_matrix
*matrix
;
14935 struct glyph_row
*row
;
14938 if (!make_cursor_line_fully_visible_p
)
14941 /* It's not always possible to find the cursor, e.g, when a window
14942 is full of overlay strings. Don't do anything in that case. */
14943 if (w
->cursor
.vpos
< 0)
14946 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14947 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14949 /* If the cursor row is not partially visible, there's nothing to do. */
14950 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14953 /* If the row the cursor is in is taller than the window's height,
14954 it's not clear what to do, so do nothing. */
14955 window_height
= window_box_height (w
);
14956 if (row
->height
>= window_height
)
14958 if (!force_p
|| MINI_WINDOW_P (w
)
14959 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14966 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14967 means only WINDOW is redisplayed in redisplay_internal.
14968 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14969 in redisplay_window to bring a partially visible line into view in
14970 the case that only the cursor has moved.
14972 LAST_LINE_MISFIT should be true if we're scrolling because the
14973 last screen line's vertical height extends past the end of the screen.
14977 1 if scrolling succeeded
14979 0 if scrolling didn't find point.
14981 -1 if new fonts have been loaded so that we must interrupt
14982 redisplay, adjust glyph matrices, and try again. */
14988 SCROLLING_NEED_LARGER_MATRICES
14991 /* If scroll-conservatively is more than this, never recenter.
14993 If you change this, don't forget to update the doc string of
14994 `scroll-conservatively' and the Emacs manual. */
14995 #define SCROLL_LIMIT 100
14998 try_scrolling (Lisp_Object window
, bool just_this_one_p
,
14999 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
15000 bool temp_scroll_step
, bool last_line_misfit
)
15002 struct window
*w
= XWINDOW (window
);
15003 struct frame
*f
= XFRAME (w
->frame
);
15004 struct text_pos pos
, startp
;
15006 int this_scroll_margin
, scroll_max
, rc
, height
;
15007 int dy
= 0, amount_to_scroll
= 0;
15008 bool scroll_down_p
= false;
15009 int extra_scroll_margin_lines
= last_line_misfit
;
15010 Lisp_Object aggressive
;
15011 /* We will never try scrolling more than this number of lines. */
15012 int scroll_limit
= SCROLL_LIMIT
;
15013 int frame_line_height
= default_line_pixel_height (w
);
15014 int window_total_lines
15015 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15018 debug_method_add (w
, "try_scrolling");
15021 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15023 /* Compute scroll margin height in pixels. We scroll when point is
15024 within this distance from the top or bottom of the window. */
15025 if (scroll_margin
> 0)
15026 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15027 * frame_line_height
;
15029 this_scroll_margin
= 0;
15031 /* Force arg_scroll_conservatively to have a reasonable value, to
15032 avoid scrolling too far away with slow move_it_* functions. Note
15033 that the user can supply scroll-conservatively equal to
15034 `most-positive-fixnum', which can be larger than INT_MAX. */
15035 if (arg_scroll_conservatively
> scroll_limit
)
15037 arg_scroll_conservatively
= scroll_limit
+ 1;
15038 scroll_max
= scroll_limit
* frame_line_height
;
15040 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15041 /* Compute how much we should try to scroll maximally to bring
15042 point into view. */
15043 scroll_max
= (max (scroll_step
,
15044 max (arg_scroll_conservatively
, temp_scroll_step
))
15045 * frame_line_height
);
15046 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15047 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15048 /* We're trying to scroll because of aggressive scrolling but no
15049 scroll_step is set. Choose an arbitrary one. */
15050 scroll_max
= 10 * frame_line_height
;
15056 /* Decide whether to scroll down. */
15057 if (PT
> CHARPOS (startp
))
15059 int scroll_margin_y
;
15061 /* Compute the pixel ypos of the scroll margin, then move IT to
15062 either that ypos or PT, whichever comes first. */
15063 start_display (&it
, w
, startp
);
15064 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15065 - frame_line_height
* extra_scroll_margin_lines
;
15066 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15067 (MOVE_TO_POS
| MOVE_TO_Y
));
15069 if (PT
> CHARPOS (it
.current
.pos
))
15071 int y0
= line_bottom_y (&it
);
15072 /* Compute how many pixels below window bottom to stop searching
15073 for PT. This avoids costly search for PT that is far away if
15074 the user limited scrolling by a small number of lines, but
15075 always finds PT if scroll_conservatively is set to a large
15076 number, such as most-positive-fixnum. */
15077 int slack
= max (scroll_max
, 10 * frame_line_height
);
15078 int y_to_move
= it
.last_visible_y
+ slack
;
15080 /* Compute the distance from the scroll margin to PT or to
15081 the scroll limit, whichever comes first. This should
15082 include the height of the cursor line, to make that line
15084 move_it_to (&it
, PT
, -1, y_to_move
,
15085 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15086 dy
= line_bottom_y (&it
) - y0
;
15088 if (dy
> scroll_max
)
15089 return SCROLLING_FAILED
;
15092 scroll_down_p
= true;
15098 /* Point is in or below the bottom scroll margin, so move the
15099 window start down. If scrolling conservatively, move it just
15100 enough down to make point visible. If scroll_step is set,
15101 move it down by scroll_step. */
15102 if (arg_scroll_conservatively
)
15104 = min (max (dy
, frame_line_height
),
15105 frame_line_height
* arg_scroll_conservatively
);
15106 else if (scroll_step
|| temp_scroll_step
)
15107 amount_to_scroll
= scroll_max
;
15110 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15111 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15112 if (NUMBERP (aggressive
))
15114 double float_amount
= XFLOATINT (aggressive
) * height
;
15115 int aggressive_scroll
= float_amount
;
15116 if (aggressive_scroll
== 0 && float_amount
> 0)
15117 aggressive_scroll
= 1;
15118 /* Don't let point enter the scroll margin near top of
15119 the window. This could happen if the value of
15120 scroll_up_aggressively is too large and there are
15121 non-zero margins, because scroll_up_aggressively
15122 means put point that fraction of window height
15123 _from_the_bottom_margin_. */
15124 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15125 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15126 amount_to_scroll
= dy
+ aggressive_scroll
;
15130 if (amount_to_scroll
<= 0)
15131 return SCROLLING_FAILED
;
15133 start_display (&it
, w
, startp
);
15134 if (arg_scroll_conservatively
<= scroll_limit
)
15135 move_it_vertically (&it
, amount_to_scroll
);
15138 /* Extra precision for users who set scroll-conservatively
15139 to a large number: make sure the amount we scroll
15140 the window start is never less than amount_to_scroll,
15141 which was computed as distance from window bottom to
15142 point. This matters when lines at window top and lines
15143 below window bottom have different height. */
15145 void *it1data
= NULL
;
15146 /* We use a temporary it1 because line_bottom_y can modify
15147 its argument, if it moves one line down; see there. */
15150 SAVE_IT (it1
, it
, it1data
);
15151 start_y
= line_bottom_y (&it1
);
15153 RESTORE_IT (&it
, &it
, it1data
);
15154 move_it_by_lines (&it
, 1);
15155 SAVE_IT (it1
, it
, it1data
);
15156 } while (IT_CHARPOS (it
) < ZV
15157 && line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15158 bidi_unshelve_cache (it1data
, true);
15161 /* If STARTP is unchanged, move it down another screen line. */
15162 if (IT_CHARPOS (it
) == CHARPOS (startp
))
15163 move_it_by_lines (&it
, 1);
15164 startp
= it
.current
.pos
;
15168 struct text_pos scroll_margin_pos
= startp
;
15171 /* See if point is inside the scroll margin at the top of the
15173 if (this_scroll_margin
)
15177 start_display (&it
, w
, startp
);
15178 y_start
= it
.current_y
;
15179 move_it_vertically (&it
, this_scroll_margin
);
15180 scroll_margin_pos
= it
.current
.pos
;
15181 /* If we didn't move enough before hitting ZV, request
15182 additional amount of scroll, to move point out of the
15184 if (IT_CHARPOS (it
) == ZV
15185 && it
.current_y
- y_start
< this_scroll_margin
)
15186 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15189 if (PT
< CHARPOS (scroll_margin_pos
))
15191 /* Point is in the scroll margin at the top of the window or
15192 above what is displayed in the window. */
15195 /* Compute the vertical distance from PT to the scroll
15196 margin position. Move as far as scroll_max allows, or
15197 one screenful, or 10 screen lines, whichever is largest.
15198 Give up if distance is greater than scroll_max or if we
15199 didn't reach the scroll margin position. */
15200 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15201 start_display (&it
, w
, pos
);
15203 y_to_move
= max (it
.last_visible_y
,
15204 max (scroll_max
, 10 * frame_line_height
));
15205 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15207 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15208 dy
= it
.current_y
- y0
;
15209 if (dy
> scroll_max
15210 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15211 return SCROLLING_FAILED
;
15213 /* Additional scroll for when ZV was too close to point. */
15216 /* Compute new window start. */
15217 start_display (&it
, w
, startp
);
15219 if (arg_scroll_conservatively
)
15220 amount_to_scroll
= max (dy
, frame_line_height
15221 * max (scroll_step
, temp_scroll_step
));
15222 else if (scroll_step
|| temp_scroll_step
)
15223 amount_to_scroll
= scroll_max
;
15226 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15227 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15228 if (NUMBERP (aggressive
))
15230 double float_amount
= XFLOATINT (aggressive
) * height
;
15231 int aggressive_scroll
= float_amount
;
15232 if (aggressive_scroll
== 0 && float_amount
> 0)
15233 aggressive_scroll
= 1;
15234 /* Don't let point enter the scroll margin near
15235 bottom of the window, if the value of
15236 scroll_down_aggressively happens to be too
15238 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15239 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15240 amount_to_scroll
= dy
+ aggressive_scroll
;
15244 if (amount_to_scroll
<= 0)
15245 return SCROLLING_FAILED
;
15247 move_it_vertically_backward (&it
, amount_to_scroll
);
15248 startp
= it
.current
.pos
;
15252 /* Run window scroll functions. */
15253 startp
= run_window_scroll_functions (window
, startp
);
15255 /* Display the window. Give up if new fonts are loaded, or if point
15257 if (!try_window (window
, startp
, 0))
15258 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15259 else if (w
->cursor
.vpos
< 0)
15261 clear_glyph_matrix (w
->desired_matrix
);
15262 rc
= SCROLLING_FAILED
;
15266 /* Maybe forget recorded base line for line number display. */
15267 if (!just_this_one_p
15268 || current_buffer
->clip_changed
15269 || BEG_UNCHANGED
< CHARPOS (startp
))
15270 w
->base_line_number
= 0;
15272 /* If cursor ends up on a partially visible line,
15273 treat that as being off the bottom of the screen. */
15274 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1,
15276 /* It's possible that the cursor is on the first line of the
15277 buffer, which is partially obscured due to a vscroll
15278 (Bug#7537). In that case, avoid looping forever. */
15279 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15281 clear_glyph_matrix (w
->desired_matrix
);
15282 ++extra_scroll_margin_lines
;
15285 rc
= SCROLLING_SUCCESS
;
15292 /* Compute a suitable window start for window W if display of W starts
15293 on a continuation line. Value is true if a new window start
15296 The new window start will be computed, based on W's width, starting
15297 from the start of the continued line. It is the start of the
15298 screen line with the minimum distance from the old start W->start. */
15301 compute_window_start_on_continuation_line (struct window
*w
)
15303 struct text_pos pos
, start_pos
;
15304 bool window_start_changed_p
= false;
15306 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15308 /* If window start is on a continuation line... Window start may be
15309 < BEGV in case there's invisible text at the start of the
15310 buffer (M-x rmail, for example). */
15311 if (CHARPOS (start_pos
) > BEGV
15312 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15315 struct glyph_row
*row
;
15317 /* Handle the case that the window start is out of range. */
15318 if (CHARPOS (start_pos
) < BEGV
)
15319 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15320 else if (CHARPOS (start_pos
) > ZV
)
15321 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15323 /* Find the start of the continued line. This should be fast
15324 because find_newline is fast (newline cache). */
15325 row
= w
->desired_matrix
->rows
+ WINDOW_WANTS_HEADER_LINE_P (w
);
15326 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15327 row
, DEFAULT_FACE_ID
);
15328 reseat_at_previous_visible_line_start (&it
);
15330 /* If the line start is "too far" away from the window start,
15331 say it takes too much time to compute a new window start. */
15332 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15333 /* PXW: Do we need upper bounds here? */
15334 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15336 int min_distance
, distance
;
15338 /* Move forward by display lines to find the new window
15339 start. If window width was enlarged, the new start can
15340 be expected to be > the old start. If window width was
15341 decreased, the new window start will be < the old start.
15342 So, we're looking for the display line start with the
15343 minimum distance from the old window start. */
15344 pos
= it
.current
.pos
;
15345 min_distance
= INFINITY
;
15346 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15347 distance
< min_distance
)
15349 min_distance
= distance
;
15350 pos
= it
.current
.pos
;
15351 if (it
.line_wrap
== WORD_WRAP
)
15353 /* Under WORD_WRAP, move_it_by_lines is likely to
15354 overshoot and stop not at the first, but the
15355 second character from the left margin. So in
15356 that case, we need a more tight control on the X
15357 coordinate of the iterator than move_it_by_lines
15358 promises in its contract. The method is to first
15359 go to the last (rightmost) visible character of a
15360 line, then move to the leftmost character on the
15361 next line in a separate call. */
15362 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15363 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15364 move_it_to (&it
, ZV
, 0,
15365 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15366 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15369 move_it_by_lines (&it
, 1);
15372 /* Set the window start there. */
15373 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15374 window_start_changed_p
= true;
15378 return window_start_changed_p
;
15382 /* Try cursor movement in case text has not changed in window WINDOW,
15383 with window start STARTP. Value is
15385 CURSOR_MOVEMENT_SUCCESS if successful
15387 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15389 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15390 display. *SCROLL_STEP is set to true, under certain circumstances, if
15391 we want to scroll as if scroll-step were set to 1. See the code.
15393 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15394 which case we have to abort this redisplay, and adjust matrices
15399 CURSOR_MOVEMENT_SUCCESS
,
15400 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15401 CURSOR_MOVEMENT_MUST_SCROLL
,
15402 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15406 try_cursor_movement (Lisp_Object window
, struct text_pos startp
,
15409 struct window
*w
= XWINDOW (window
);
15410 struct frame
*f
= XFRAME (w
->frame
);
15411 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15414 if (inhibit_try_cursor_movement
)
15418 /* Previously, there was a check for Lisp integer in the
15419 if-statement below. Now, this field is converted to
15420 ptrdiff_t, thus zero means invalid position in a buffer. */
15421 eassert (w
->last_point
> 0);
15422 /* Likewise there was a check whether window_end_vpos is nil or larger
15423 than the window. Now window_end_vpos is int and so never nil, but
15424 let's leave eassert to check whether it fits in the window. */
15425 eassert (!w
->window_end_valid
15426 || w
->window_end_vpos
< w
->current_matrix
->nrows
);
15428 /* Handle case where text has not changed, only point, and it has
15429 not moved off the frame. */
15430 if (/* Point may be in this window. */
15431 PT
>= CHARPOS (startp
)
15432 /* Selective display hasn't changed. */
15433 && !current_buffer
->clip_changed
15434 /* Function force-mode-line-update is used to force a thorough
15435 redisplay. It sets either windows_or_buffers_changed or
15436 update_mode_lines. So don't take a shortcut here for these
15438 && !update_mode_lines
15439 && !windows_or_buffers_changed
15440 && !f
->cursor_type_changed
15441 && !(f
!= SELECTED_FRAME () && f
->redisplay
)
15442 && NILP (Vshow_trailing_whitespace
)
15443 /* This code is not used for mini-buffer for the sake of the case
15444 of redisplaying to replace an echo area message; since in
15445 that case the mini-buffer contents per se are usually
15446 unchanged. This code is of no real use in the mini-buffer
15447 since the handling of this_line_start_pos, etc., in redisplay
15448 handles the same cases. */
15449 && !EQ (window
, minibuf_window
)
15450 && (FRAME_WINDOW_P (f
)
15451 || !overlay_arrow_in_current_buffer_p ()))
15453 int this_scroll_margin
, top_scroll_margin
;
15454 struct glyph_row
*row
= NULL
;
15455 int frame_line_height
= default_line_pixel_height (w
);
15456 int window_total_lines
15457 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15460 debug_method_add (w
, "cursor movement");
15463 /* Scroll if point within this distance from the top or bottom
15464 of the window. This is a pixel value. */
15465 if (scroll_margin
> 0)
15467 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15468 this_scroll_margin
*= frame_line_height
;
15471 this_scroll_margin
= 0;
15473 top_scroll_margin
= this_scroll_margin
;
15474 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15475 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15477 /* Start with the row the cursor was displayed during the last
15478 not paused redisplay. Give up if that row is not valid. */
15479 if (w
->last_cursor_vpos
< 0
15480 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15481 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15484 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15485 if (row
->mode_line_p
)
15487 if (!row
->enabled_p
)
15488 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15491 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15493 bool scroll_p
= false, must_scroll
= false;
15494 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15496 if (PT
> w
->last_point
)
15498 /* Point has moved forward. */
15499 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15500 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15502 eassert (row
->enabled_p
);
15506 /* If the end position of a row equals the start
15507 position of the next row, and PT is at that position,
15508 we would rather display cursor in the next line. */
15509 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15510 && MATRIX_ROW_END_CHARPOS (row
) == PT
15511 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15512 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15513 && !cursor_row_p (row
))
15516 /* If within the scroll margin, scroll. Note that
15517 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15518 the next line would be drawn, and that
15519 this_scroll_margin can be zero. */
15520 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15521 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15522 /* Line is completely visible last line in window
15523 and PT is to be set in the next line. */
15524 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15525 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15526 && !row
->ends_at_zv_p
15527 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15530 else if (PT
< w
->last_point
)
15532 /* Cursor has to be moved backward. Note that PT >=
15533 CHARPOS (startp) because of the outer if-statement. */
15534 while (!row
->mode_line_p
15535 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15536 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15537 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15538 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15539 row
> w
->current_matrix
->rows
15540 && (row
-1)->ends_in_newline_from_string_p
))))
15541 && (row
->y
> top_scroll_margin
15542 || CHARPOS (startp
) == BEGV
))
15544 eassert (row
->enabled_p
);
15548 /* Consider the following case: Window starts at BEGV,
15549 there is invisible, intangible text at BEGV, so that
15550 display starts at some point START > BEGV. It can
15551 happen that we are called with PT somewhere between
15552 BEGV and START. Try to handle that case. */
15553 if (row
< w
->current_matrix
->rows
15554 || row
->mode_line_p
)
15556 row
= w
->current_matrix
->rows
;
15557 if (row
->mode_line_p
)
15561 /* Due to newlines in overlay strings, we may have to
15562 skip forward over overlay strings. */
15563 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15564 && MATRIX_ROW_END_CHARPOS (row
) == PT
15565 && !cursor_row_p (row
))
15568 /* If within the scroll margin, scroll. */
15569 if (row
->y
< top_scroll_margin
15570 && CHARPOS (startp
) != BEGV
)
15575 /* Cursor did not move. So don't scroll even if cursor line
15576 is partially visible, as it was so before. */
15577 rc
= CURSOR_MOVEMENT_SUCCESS
;
15580 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15581 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15583 /* if PT is not in the glyph row, give up. */
15584 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15585 must_scroll
= true;
15587 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15588 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15590 struct glyph_row
*row1
;
15592 /* If rows are bidi-reordered and point moved, back up
15593 until we find a row that does not belong to a
15594 continuation line. This is because we must consider
15595 all rows of a continued line as candidates for the
15596 new cursor positioning, since row start and end
15597 positions change non-linearly with vertical position
15599 /* FIXME: Revisit this when glyph ``spilling'' in
15600 continuation lines' rows is implemented for
15601 bidi-reordered rows. */
15602 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15603 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15606 /* If we hit the beginning of the displayed portion
15607 without finding the first row of a continued
15611 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15614 eassert (row
->enabled_p
);
15619 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15620 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15621 /* Make sure this isn't a header line by any chance, since
15622 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield true. */
15623 && !row
->mode_line_p
15624 && make_cursor_line_fully_visible_p
)
15626 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15627 && !row
->ends_at_zv_p
15628 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15629 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15630 else if (row
->height
> window_box_height (w
))
15632 /* If we end up in a partially visible line, let's
15633 make it fully visible, except when it's taller
15634 than the window, in which case we can't do much
15636 *scroll_step
= true;
15637 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15641 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15642 if (!cursor_row_fully_visible_p (w
, false, true))
15643 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15645 rc
= CURSOR_MOVEMENT_SUCCESS
;
15649 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15650 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15651 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15653 /* With bidi-reordered rows, there could be more than
15654 one candidate row whose start and end positions
15655 occlude point. We need to let set_cursor_from_row
15656 find the best candidate. */
15657 /* FIXME: Revisit this when glyph ``spilling'' in
15658 continuation lines' rows is implemented for
15659 bidi-reordered rows. */
15664 bool at_zv_p
= false, exact_match_p
= false;
15666 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15667 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15668 && cursor_row_p (row
))
15669 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15671 /* As soon as we've found the exact match for point,
15672 or the first suitable row whose ends_at_zv_p flag
15673 is set, we are done. */
15676 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15677 w
->cursor
.vpos
)->ends_at_zv_p
;
15679 && w
->cursor
.hpos
>= 0
15680 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15683 struct glyph_row
*candidate
=
15684 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15686 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15687 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15690 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15691 || (NILP (g
->object
)
15692 && (g
->charpos
== PT
15693 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15695 if (at_zv_p
|| exact_match_p
)
15697 rc
= CURSOR_MOVEMENT_SUCCESS
;
15701 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15705 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15706 || row
->continued_p
)
15707 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15708 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15709 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15710 /* If we didn't find any candidate rows, or exited the
15711 loop before all the candidates were examined, signal
15712 to the caller that this method failed. */
15713 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15715 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15716 && !row
->continued_p
))
15717 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15719 rc
= CURSOR_MOVEMENT_SUCCESS
;
15725 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15727 rc
= CURSOR_MOVEMENT_SUCCESS
;
15732 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15733 && MATRIX_ROW_START_CHARPOS (row
) == PT
15734 && cursor_row_p (row
));
15744 set_vertical_scroll_bar (struct window
*w
)
15746 ptrdiff_t start
, end
, whole
;
15748 /* Calculate the start and end positions for the current window.
15749 At some point, it would be nice to choose between scrollbars
15750 which reflect the whole buffer size, with special markers
15751 indicating narrowing, and scrollbars which reflect only the
15754 Note that mini-buffers sometimes aren't displaying any text. */
15755 if (!MINI_WINDOW_P (w
)
15756 || (w
== XWINDOW (minibuf_window
)
15757 && NILP (echo_area_buffer
[0])))
15759 struct buffer
*buf
= XBUFFER (w
->contents
);
15760 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15761 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15762 /* I don't think this is guaranteed to be right. For the
15763 moment, we'll pretend it is. */
15764 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15768 if (whole
< (end
- start
))
15769 whole
= end
- start
;
15772 start
= end
= whole
= 0;
15774 /* Indicate what this scroll bar ought to be displaying now. */
15775 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15776 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15777 (w
, end
- start
, whole
, start
);
15782 set_horizontal_scroll_bar (struct window
*w
)
15784 int start
, end
, whole
, portion
;
15786 if (!MINI_WINDOW_P (w
)
15787 || (w
== XWINDOW (minibuf_window
)
15788 && NILP (echo_area_buffer
[0])))
15790 struct buffer
*b
= XBUFFER (w
->contents
);
15791 struct buffer
*old_buffer
= NULL
;
15793 struct text_pos startp
;
15795 if (b
!= current_buffer
)
15797 old_buffer
= current_buffer
;
15798 set_buffer_internal (b
);
15801 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15802 start_display (&it
, w
, startp
);
15803 it
.last_visible_x
= INT_MAX
;
15804 whole
= move_it_to (&it
, -1, INT_MAX
, window_box_height (w
), -1,
15805 MOVE_TO_X
| MOVE_TO_Y
);
15806 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
15807 window_box_height (w), -1,
15808 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
15810 start
= w
->hscroll
* FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
));
15811 end
= start
+ window_box_width (w
, TEXT_AREA
);
15812 portion
= end
- start
;
15813 /* After enlarging a horizontally scrolled window such that it
15814 gets at least as wide as the text it contains, make sure that
15815 the thumb doesn't fill the entire scroll bar so we can still
15816 drag it back to see the entire text. */
15817 whole
= max (whole
, end
);
15823 pdir
= Fcurrent_bidi_paragraph_direction (Qnil
);
15824 if (EQ (pdir
, Qright_to_left
))
15826 start
= whole
- end
;
15827 end
= start
+ portion
;
15832 set_buffer_internal (old_buffer
);
15835 start
= end
= whole
= portion
= 0;
15837 w
->hscroll_whole
= whole
;
15839 /* Indicate what this scroll bar ought to be displaying now. */
15840 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15841 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15842 (w
, portion
, whole
, start
);
15846 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P means only
15847 selected_window is redisplayed.
15849 We can return without actually redisplaying the window if fonts has been
15850 changed on window's frame. In that case, redisplay_internal will retry.
15852 As one of the important parts of redisplaying a window, we need to
15853 decide whether the previous window-start position (stored in the
15854 window's w->start marker position) is still valid, and if it isn't,
15855 recompute it. Some details about that:
15857 . The previous window-start could be in a continuation line, in
15858 which case we need to recompute it when the window width
15859 changes. See compute_window_start_on_continuation_line and its
15862 . The text that changed since last redisplay could include the
15863 previous window-start position. In that case, we try to salvage
15864 what we can from the current glyph matrix by calling
15865 try_scrolling, which see.
15867 . Some Emacs command could force us to use a specific window-start
15868 position by setting the window's force_start flag, or gently
15869 propose doing that by setting the window's optional_new_start
15870 flag. In these cases, we try using the specified start point if
15871 that succeeds (i.e. the window desired matrix is successfully
15872 recomputed, and point location is within the window). In case
15873 of optional_new_start, we first check if the specified start
15874 position is feasible, i.e. if it will allow point to be
15875 displayed in the window. If using the specified start point
15876 fails, e.g., if new fonts are needed to be loaded, we abort the
15877 redisplay cycle and leave it up to the next cycle to figure out
15880 . Note that the window's force_start flag is sometimes set by
15881 redisplay itself, when it decides that the previous window start
15882 point is fine and should be kept. Search for "goto force_start"
15883 below to see the details. Like the values of window-start
15884 specified outside of redisplay, these internally-deduced values
15885 are tested for feasibility, and ignored if found to be
15888 . Note that the function try_window, used to completely redisplay
15889 a window, accepts the window's start point as its argument.
15890 This is used several times in the redisplay code to control
15891 where the window start will be, according to user options such
15892 as scroll-conservatively, and also to ensure the screen line
15893 showing point will be fully (as opposed to partially) visible on
15897 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15899 struct window
*w
= XWINDOW (window
);
15900 struct frame
*f
= XFRAME (w
->frame
);
15901 struct buffer
*buffer
= XBUFFER (w
->contents
);
15902 struct buffer
*old
= current_buffer
;
15903 struct text_pos lpoint
, opoint
, startp
;
15904 bool update_mode_line
;
15907 /* Record it now because it's overwritten. */
15908 bool current_matrix_up_to_date_p
= false;
15909 bool used_current_matrix_p
= false;
15910 /* This is less strict than current_matrix_up_to_date_p.
15911 It indicates that the buffer contents and narrowing are unchanged. */
15912 bool buffer_unchanged_p
= false;
15913 bool temp_scroll_step
= false;
15914 ptrdiff_t count
= SPECPDL_INDEX ();
15916 int centering_position
= -1;
15917 bool last_line_misfit
= false;
15918 ptrdiff_t beg_unchanged
, end_unchanged
;
15919 int frame_line_height
;
15921 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15925 *w
->desired_matrix
->method
= 0;
15928 if (!just_this_one_p
15929 && REDISPLAY_SOME_P ()
15931 && !w
->update_mode_line
15934 && !buffer
->text
->redisplay
15935 && BUF_PT (buffer
) == w
->last_point
)
15938 /* Make sure that both W's markers are valid. */
15939 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15940 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15942 /* We come here again if we need to run window-text-change-functions
15945 reconsider_clip_changes (w
);
15946 frame_line_height
= default_line_pixel_height (w
);
15948 /* Has the mode line to be updated? */
15949 update_mode_line
= (w
->update_mode_line
15950 || update_mode_lines
15951 || buffer
->clip_changed
15952 || buffer
->prevent_redisplay_optimizations_p
);
15954 if (!just_this_one_p
)
15955 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15956 cleverly elsewhere. */
15957 w
->must_be_updated_p
= true;
15959 if (MINI_WINDOW_P (w
))
15961 if (w
== XWINDOW (echo_area_window
)
15962 && !NILP (echo_area_buffer
[0]))
15964 if (update_mode_line
)
15965 /* We may have to update a tty frame's menu bar or a
15966 tool-bar. Example `M-x C-h C-h C-g'. */
15967 goto finish_menu_bars
;
15969 /* We've already displayed the echo area glyphs in this window. */
15970 goto finish_scroll_bars
;
15972 else if ((w
!= XWINDOW (minibuf_window
)
15973 || minibuf_level
== 0)
15974 /* When buffer is nonempty, redisplay window normally. */
15975 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
15976 /* Quail displays non-mini buffers in minibuffer window.
15977 In that case, redisplay the window normally. */
15978 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
15980 /* W is a mini-buffer window, but it's not active, so clear
15982 int yb
= window_text_bottom_y (w
);
15983 struct glyph_row
*row
;
15986 for (y
= 0, row
= w
->desired_matrix
->rows
;
15988 y
+= row
->height
, ++row
)
15989 blank_row (w
, row
, y
);
15990 goto finish_scroll_bars
;
15993 clear_glyph_matrix (w
->desired_matrix
);
15996 /* Otherwise set up data on this window; select its buffer and point
15998 /* Really select the buffer, for the sake of buffer-local
16000 set_buffer_internal_1 (XBUFFER (w
->contents
));
16002 current_matrix_up_to_date_p
16003 = (w
->window_end_valid
16004 && !current_buffer
->clip_changed
16005 && !current_buffer
->prevent_redisplay_optimizations_p
16006 && !window_outdated (w
));
16008 /* Run the window-text-change-functions
16009 if it is possible that the text on the screen has changed
16010 (either due to modification of the text, or any other reason). */
16011 if (!current_matrix_up_to_date_p
16012 && !NILP (Vwindow_text_change_functions
))
16014 safe_run_hooks (Qwindow_text_change_functions
);
16018 beg_unchanged
= BEG_UNCHANGED
;
16019 end_unchanged
= END_UNCHANGED
;
16021 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
16023 specbind (Qinhibit_point_motion_hooks
, Qt
);
16026 = (w
->window_end_valid
16027 && !current_buffer
->clip_changed
16028 && !window_outdated (w
));
16030 /* When windows_or_buffers_changed is non-zero, we can't rely
16031 on the window end being valid, so set it to zero there. */
16032 if (windows_or_buffers_changed
)
16034 /* If window starts on a continuation line, maybe adjust the
16035 window start in case the window's width changed. */
16036 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16037 compute_window_start_on_continuation_line (w
);
16039 w
->window_end_valid
= false;
16040 /* If so, we also can't rely on current matrix
16041 and should not fool try_cursor_movement below. */
16042 current_matrix_up_to_date_p
= false;
16045 /* Some sanity checks. */
16046 CHECK_WINDOW_END (w
);
16047 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16049 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16052 if (mode_line_update_needed (w
))
16053 update_mode_line
= true;
16055 /* Point refers normally to the selected window. For any other
16056 window, set up appropriate value. */
16057 if (!EQ (window
, selected_window
))
16059 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16060 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16065 new_pt_byte
= BEGV_BYTE
;
16066 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16068 else if (new_pt
> (ZV
- 1))
16071 new_pt_byte
= ZV_BYTE
;
16072 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16075 /* We don't use SET_PT so that the point-motion hooks don't run. */
16076 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16079 /* If any of the character widths specified in the display table
16080 have changed, invalidate the width run cache. It's true that
16081 this may be a bit late to catch such changes, but the rest of
16082 redisplay goes (non-fatally) haywire when the display table is
16083 changed, so why should we worry about doing any better? */
16084 if (current_buffer
->width_run_cache
16085 || (current_buffer
->base_buffer
16086 && current_buffer
->base_buffer
->width_run_cache
))
16088 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16090 if (! disptab_matches_widthtab
16091 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16093 struct buffer
*buf
= current_buffer
;
16095 if (buf
->base_buffer
)
16096 buf
= buf
->base_buffer
;
16097 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16098 recompute_width_table (current_buffer
, disptab
);
16102 /* If window-start is screwed up, choose a new one. */
16103 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16106 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16108 /* If someone specified a new starting point but did not insist,
16109 check whether it can be used. */
16110 if ((w
->optional_new_start
|| window_frozen_p (w
))
16111 && CHARPOS (startp
) >= BEGV
16112 && CHARPOS (startp
) <= ZV
)
16114 ptrdiff_t it_charpos
;
16116 w
->optional_new_start
= false;
16117 start_display (&it
, w
, startp
);
16118 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16119 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16120 /* Record IT's position now, since line_bottom_y might change
16122 it_charpos
= IT_CHARPOS (it
);
16123 /* Make sure we set the force_start flag only if the cursor row
16124 will be fully visible. Otherwise, the code under force_start
16125 label below will try to move point back into view, which is
16126 not what the code which sets optional_new_start wants. */
16127 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
16128 && !w
->force_start
)
16130 if (it_charpos
== PT
)
16131 w
->force_start
= true;
16132 /* IT may overshoot PT if text at PT is invisible. */
16133 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16134 w
->force_start
= true;
16136 if (w
->force_start
)
16138 if (window_frozen_p (w
))
16139 debug_method_add (w
, "set force_start from frozen window start");
16141 debug_method_add (w
, "set force_start from optional_new_start");
16149 /* Handle case where place to start displaying has been specified,
16150 unless the specified location is outside the accessible range. */
16151 if (w
->force_start
)
16153 /* We set this later on if we have to adjust point. */
16156 w
->force_start
= false;
16158 w
->window_end_valid
= false;
16160 /* Forget any recorded base line for line number display. */
16161 if (!buffer_unchanged_p
)
16162 w
->base_line_number
= 0;
16164 /* Redisplay the mode line. Select the buffer properly for that.
16165 Also, run the hook window-scroll-functions
16166 because we have scrolled. */
16167 /* Note, we do this after clearing force_start because
16168 if there's an error, it is better to forget about force_start
16169 than to get into an infinite loop calling the hook functions
16170 and having them get more errors. */
16171 if (!update_mode_line
16172 || ! NILP (Vwindow_scroll_functions
))
16174 update_mode_line
= true;
16175 w
->update_mode_line
= true;
16176 startp
= run_window_scroll_functions (window
, startp
);
16179 if (CHARPOS (startp
) < BEGV
)
16180 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16181 else if (CHARPOS (startp
) > ZV
)
16182 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16184 /* Redisplay, then check if cursor has been set during the
16185 redisplay. Give up if new fonts were loaded. */
16186 /* We used to issue a CHECK_MARGINS argument to try_window here,
16187 but this causes scrolling to fail when point begins inside
16188 the scroll margin (bug#148) -- cyd */
16189 if (!try_window (window
, startp
, 0))
16191 w
->force_start
= true;
16192 clear_glyph_matrix (w
->desired_matrix
);
16193 goto need_larger_matrices
;
16196 if (w
->cursor
.vpos
< 0)
16198 /* If point does not appear, try to move point so it does
16199 appear. The desired matrix has been built above, so we
16200 can use it here. */
16201 new_vpos
= window_box_height (w
) / 2;
16204 if (!cursor_row_fully_visible_p (w
, false, false))
16206 /* Point does appear, but on a line partly visible at end of window.
16207 Move it back to a fully-visible line. */
16208 new_vpos
= window_box_height (w
);
16209 /* But if window_box_height suggests a Y coordinate that is
16210 not less than we already have, that line will clearly not
16211 be fully visible, so give up and scroll the display.
16212 This can happen when the default face uses a font whose
16213 dimensions are different from the frame's default
16215 if (new_vpos
>= w
->cursor
.y
)
16217 w
->cursor
.vpos
= -1;
16218 clear_glyph_matrix (w
->desired_matrix
);
16219 goto try_to_scroll
;
16222 else if (w
->cursor
.vpos
>= 0)
16224 /* Some people insist on not letting point enter the scroll
16225 margin, even though this part handles windows that didn't
16227 int window_total_lines
16228 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16229 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16230 int pixel_margin
= margin
* frame_line_height
;
16231 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16233 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16234 below, which finds the row to move point to, advances by
16235 the Y coordinate of the _next_ row, see the definition of
16236 MATRIX_ROW_BOTTOM_Y. */
16237 if (w
->cursor
.vpos
< margin
+ header_line
)
16239 w
->cursor
.vpos
= -1;
16240 clear_glyph_matrix (w
->desired_matrix
);
16241 goto try_to_scroll
;
16245 int window_height
= window_box_height (w
);
16248 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16249 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16251 w
->cursor
.vpos
= -1;
16252 clear_glyph_matrix (w
->desired_matrix
);
16253 goto try_to_scroll
;
16258 /* If we need to move point for either of the above reasons,
16259 now actually do it. */
16262 struct glyph_row
*row
;
16264 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16265 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16268 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16269 MATRIX_ROW_START_BYTEPOS (row
));
16271 if (w
!= XWINDOW (selected_window
))
16272 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16273 else if (current_buffer
== old
)
16274 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16276 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16278 /* Re-run pre-redisplay-function so it can update the region
16279 according to the new position of point. */
16280 /* Other than the cursor, w's redisplay is done so we can set its
16281 redisplay to false. Also the buffer's redisplay can be set to
16282 false, since propagate_buffer_redisplay should have already
16283 propagated its info to `w' anyway. */
16284 w
->redisplay
= false;
16285 XBUFFER (w
->contents
)->text
->redisplay
= false;
16286 safe__call1 (true, Vpre_redisplay_function
, Fcons (window
, Qnil
));
16288 if (w
->redisplay
|| XBUFFER (w
->contents
)->text
->redisplay
)
16290 /* pre-redisplay-function made changes (e.g. move the region)
16291 that require another round of redisplay. */
16292 clear_glyph_matrix (w
->desired_matrix
);
16293 if (!try_window (window
, startp
, 0))
16294 goto need_larger_matrices
;
16297 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, false, false))
16299 clear_glyph_matrix (w
->desired_matrix
);
16300 goto try_to_scroll
;
16304 debug_method_add (w
, "forced window start");
16309 /* Handle case where text has not changed, only point, and it has
16310 not moved off the frame, and we are not retrying after hscroll.
16311 (current_matrix_up_to_date_p is true when retrying.) */
16312 if (current_matrix_up_to_date_p
16313 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16314 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16318 case CURSOR_MOVEMENT_SUCCESS
:
16319 used_current_matrix_p
= true;
16322 case CURSOR_MOVEMENT_MUST_SCROLL
:
16323 goto try_to_scroll
;
16329 /* If current starting point was originally the beginning of a line
16330 but no longer is, find a new starting point. */
16331 else if (w
->start_at_line_beg
16332 && !(CHARPOS (startp
) <= BEGV
16333 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16336 debug_method_add (w
, "recenter 1");
16341 /* Try scrolling with try_window_id. Value is > 0 if update has
16342 been done, it is -1 if we know that the same window start will
16343 not work. It is 0 if unsuccessful for some other reason. */
16344 else if ((tem
= try_window_id (w
)) != 0)
16347 debug_method_add (w
, "try_window_id %d", tem
);
16350 if (f
->fonts_changed
)
16351 goto need_larger_matrices
;
16355 /* Otherwise try_window_id has returned -1 which means that we
16356 don't want the alternative below this comment to execute. */
16358 else if (CHARPOS (startp
) >= BEGV
16359 && CHARPOS (startp
) <= ZV
16360 && PT
>= CHARPOS (startp
)
16361 && (CHARPOS (startp
) < ZV
16362 /* Avoid starting at end of buffer. */
16363 || CHARPOS (startp
) == BEGV
16364 || !window_outdated (w
)))
16366 int d1
, d2
, d5
, d6
;
16369 /* If first window line is a continuation line, and window start
16370 is inside the modified region, but the first change is before
16371 current window start, we must select a new window start.
16373 However, if this is the result of a down-mouse event (e.g. by
16374 extending the mouse-drag-overlay), we don't want to select a
16375 new window start, since that would change the position under
16376 the mouse, resulting in an unwanted mouse-movement rather
16377 than a simple mouse-click. */
16378 if (!w
->start_at_line_beg
16379 && NILP (do_mouse_tracking
)
16380 && CHARPOS (startp
) > BEGV
16381 && CHARPOS (startp
) > BEG
+ beg_unchanged
16382 && CHARPOS (startp
) <= Z
- end_unchanged
16383 /* Even if w->start_at_line_beg is nil, a new window may
16384 start at a line_beg, since that's how set_buffer_window
16385 sets it. So, we need to check the return value of
16386 compute_window_start_on_continuation_line. (See also
16388 && XMARKER (w
->start
)->buffer
== current_buffer
16389 && compute_window_start_on_continuation_line (w
)
16390 /* It doesn't make sense to force the window start like we
16391 do at label force_start if it is already known that point
16392 will not be fully visible in the resulting window, because
16393 doing so will move point from its correct position
16394 instead of scrolling the window to bring point into view.
16396 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16397 /* A very tall row could need more than the window height,
16398 in which case we accept that it is partially visible. */
16399 && (rtop
!= 0) == (rbot
!= 0))
16401 w
->force_start
= true;
16402 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16404 debug_method_add (w
, "recomputed window start in continuation line");
16410 debug_method_add (w
, "same window start");
16413 /* Try to redisplay starting at same place as before.
16414 If point has not moved off frame, accept the results. */
16415 if (!current_matrix_up_to_date_p
16416 /* Don't use try_window_reusing_current_matrix in this case
16417 because a window scroll function can have changed the
16419 || !NILP (Vwindow_scroll_functions
)
16420 || MINI_WINDOW_P (w
)
16421 || !(used_current_matrix_p
16422 = try_window_reusing_current_matrix (w
)))
16424 IF_DEBUG (debug_method_add (w
, "1"));
16425 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16426 /* -1 means we need to scroll.
16427 0 means we need new matrices, but fonts_changed
16428 is set in that case, so we will detect it below. */
16429 goto try_to_scroll
;
16432 if (f
->fonts_changed
)
16433 goto need_larger_matrices
;
16435 if (w
->cursor
.vpos
>= 0)
16437 if (!just_this_one_p
16438 || current_buffer
->clip_changed
16439 || BEG_UNCHANGED
< CHARPOS (startp
))
16440 /* Forget any recorded base line for line number display. */
16441 w
->base_line_number
= 0;
16443 if (!cursor_row_fully_visible_p (w
, true, false))
16445 clear_glyph_matrix (w
->desired_matrix
);
16446 last_line_misfit
= true;
16448 /* Drop through and scroll. */
16453 clear_glyph_matrix (w
->desired_matrix
);
16458 /* Redisplay the mode line. Select the buffer properly for that. */
16459 if (!update_mode_line
)
16461 update_mode_line
= true;
16462 w
->update_mode_line
= true;
16465 /* Try to scroll by specified few lines. */
16466 if ((scroll_conservatively
16467 || emacs_scroll_step
16468 || temp_scroll_step
16469 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16470 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16471 && CHARPOS (startp
) >= BEGV
16472 && CHARPOS (startp
) <= ZV
)
16474 /* The function returns -1 if new fonts were loaded, 1 if
16475 successful, 0 if not successful. */
16476 int ss
= try_scrolling (window
, just_this_one_p
,
16477 scroll_conservatively
,
16479 temp_scroll_step
, last_line_misfit
);
16482 case SCROLLING_SUCCESS
:
16485 case SCROLLING_NEED_LARGER_MATRICES
:
16486 goto need_larger_matrices
;
16488 case SCROLLING_FAILED
:
16496 /* Finally, just choose a place to start which positions point
16497 according to user preferences. */
16502 debug_method_add (w
, "recenter");
16505 /* Forget any previously recorded base line for line number display. */
16506 if (!buffer_unchanged_p
)
16507 w
->base_line_number
= 0;
16509 /* Determine the window start relative to point. */
16510 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16511 it
.current_y
= it
.last_visible_y
;
16512 if (centering_position
< 0)
16514 int window_total_lines
16515 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16517 = scroll_margin
> 0
16518 ? min (scroll_margin
, window_total_lines
/ 4)
16520 ptrdiff_t margin_pos
= CHARPOS (startp
);
16521 Lisp_Object aggressive
;
16524 /* If there is a scroll margin at the top of the window, find
16525 its character position. */
16527 /* Cannot call start_display if startp is not in the
16528 accessible region of the buffer. This can happen when we
16529 have just switched to a different buffer and/or changed
16530 its restriction. In that case, startp is initialized to
16531 the character position 1 (BEGV) because we did not yet
16532 have chance to display the buffer even once. */
16533 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16536 void *it1data
= NULL
;
16538 SAVE_IT (it1
, it
, it1data
);
16539 start_display (&it1
, w
, startp
);
16540 move_it_vertically (&it1
, margin
* frame_line_height
);
16541 margin_pos
= IT_CHARPOS (it1
);
16542 RESTORE_IT (&it
, &it
, it1data
);
16544 scrolling_up
= PT
> margin_pos
;
16547 ? BVAR (current_buffer
, scroll_up_aggressively
)
16548 : BVAR (current_buffer
, scroll_down_aggressively
);
16550 if (!MINI_WINDOW_P (w
)
16551 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16555 /* Setting scroll-conservatively overrides
16556 scroll-*-aggressively. */
16557 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16559 double float_amount
= XFLOATINT (aggressive
);
16561 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16562 if (pt_offset
== 0 && float_amount
> 0)
16564 if (pt_offset
&& margin
> 0)
16567 /* Compute how much to move the window start backward from
16568 point so that point will be displayed where the user
16572 centering_position
= it
.last_visible_y
;
16574 centering_position
-= pt_offset
;
16575 centering_position
-=
16576 (frame_line_height
* (1 + margin
+ last_line_misfit
)
16577 + WINDOW_HEADER_LINE_HEIGHT (w
));
16578 /* Don't let point enter the scroll margin near top of
16580 if (centering_position
< margin
* frame_line_height
)
16581 centering_position
= margin
* frame_line_height
;
16584 centering_position
= margin
* frame_line_height
+ pt_offset
;
16587 /* Set the window start half the height of the window backward
16589 centering_position
= window_box_height (w
) / 2;
16591 move_it_vertically_backward (&it
, centering_position
);
16593 eassert (IT_CHARPOS (it
) >= BEGV
);
16595 /* The function move_it_vertically_backward may move over more
16596 than the specified y-distance. If it->w is small, e.g. a
16597 mini-buffer window, we may end up in front of the window's
16598 display area. Start displaying at the start of the line
16599 containing PT in this case. */
16600 if (it
.current_y
<= 0)
16602 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16603 move_it_vertically_backward (&it
, 0);
16607 it
.current_x
= it
.hpos
= 0;
16609 /* Set the window start position here explicitly, to avoid an
16610 infinite loop in case the functions in window-scroll-functions
16612 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16614 /* Run scroll hooks. */
16615 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16617 /* Redisplay the window. */
16618 if (!current_matrix_up_to_date_p
16619 || windows_or_buffers_changed
16620 || f
->cursor_type_changed
16621 /* Don't use try_window_reusing_current_matrix in this case
16622 because it can have changed the buffer. */
16623 || !NILP (Vwindow_scroll_functions
)
16624 || !just_this_one_p
16625 || MINI_WINDOW_P (w
)
16626 || !(used_current_matrix_p
16627 = try_window_reusing_current_matrix (w
)))
16628 try_window (window
, startp
, 0);
16630 /* If new fonts have been loaded (due to fontsets), give up. We
16631 have to start a new redisplay since we need to re-adjust glyph
16633 if (f
->fonts_changed
)
16634 goto need_larger_matrices
;
16636 /* If cursor did not appear assume that the middle of the window is
16637 in the first line of the window. Do it again with the next line.
16638 (Imagine a window of height 100, displaying two lines of height
16639 60. Moving back 50 from it->last_visible_y will end in the first
16641 if (w
->cursor
.vpos
< 0)
16643 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16645 clear_glyph_matrix (w
->desired_matrix
);
16646 move_it_by_lines (&it
, 1);
16647 try_window (window
, it
.current
.pos
, 0);
16649 else if (PT
< IT_CHARPOS (it
))
16651 clear_glyph_matrix (w
->desired_matrix
);
16652 move_it_by_lines (&it
, -1);
16653 try_window (window
, it
.current
.pos
, 0);
16657 /* Not much we can do about it. */
16661 /* Consider the following case: Window starts at BEGV, there is
16662 invisible, intangible text at BEGV, so that display starts at
16663 some point START > BEGV. It can happen that we are called with
16664 PT somewhere between BEGV and START. Try to handle that case,
16665 and similar ones. */
16666 if (w
->cursor
.vpos
< 0)
16668 /* First, try locating the proper glyph row for PT. */
16669 struct glyph_row
*row
=
16670 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16672 /* Sometimes point is at the beginning of invisible text that is
16673 before the 1st character displayed in the row. In that case,
16674 row_containing_pos fails to find the row, because no glyphs
16675 with appropriate buffer positions are present in the row.
16676 Therefore, we next try to find the row which shows the 1st
16677 position after the invisible text. */
16681 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16684 if (TEXT_PROP_MEANS_INVISIBLE (val
) != 0)
16687 Lisp_Object invis_end
=
16688 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16691 if (NATNUMP (invis_end
))
16692 alt_pos
= XFASTINT (invis_end
);
16695 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16699 /* Finally, fall back on the first row of the window after the
16700 header line (if any). This is slightly better than not
16701 displaying the cursor at all. */
16704 row
= w
->current_matrix
->rows
;
16705 if (row
->mode_line_p
)
16708 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16711 if (!cursor_row_fully_visible_p (w
, false, false))
16713 /* If vscroll is enabled, disable it and try again. */
16717 clear_glyph_matrix (w
->desired_matrix
);
16721 /* Users who set scroll-conservatively to a large number want
16722 point just above/below the scroll margin. If we ended up
16723 with point's row partially visible, move the window start to
16724 make that row fully visible and out of the margin. */
16725 if (scroll_conservatively
> SCROLL_LIMIT
)
16727 int window_total_lines
16728 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16731 ? min (scroll_margin
, window_total_lines
/ 4)
16733 bool move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16735 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16736 clear_glyph_matrix (w
->desired_matrix
);
16737 if (1 == try_window (window
, it
.current
.pos
,
16738 TRY_WINDOW_CHECK_MARGINS
))
16742 /* If centering point failed to make the whole line visible,
16743 put point at the top instead. That has to make the whole line
16744 visible, if it can be done. */
16745 if (centering_position
== 0)
16748 clear_glyph_matrix (w
->desired_matrix
);
16749 centering_position
= 0;
16755 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16756 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16757 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16759 /* Display the mode line, if we must. */
16760 if ((update_mode_line
16761 /* If window not full width, must redo its mode line
16762 if (a) the window to its side is being redone and
16763 (b) we do a frame-based redisplay. This is a consequence
16764 of how inverted lines are drawn in frame-based redisplay. */
16765 || (!just_this_one_p
16766 && !FRAME_WINDOW_P (f
)
16767 && !WINDOW_FULL_WIDTH_P (w
))
16768 /* Line number to display. */
16769 || w
->base_line_pos
> 0
16770 /* Column number is displayed and different from the one displayed. */
16771 || (w
->column_number_displayed
!= -1
16772 && (w
->column_number_displayed
!= current_column ())))
16773 /* This means that the window has a mode line. */
16774 && (WINDOW_WANTS_MODELINE_P (w
)
16775 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16778 display_mode_lines (w
);
16780 /* If mode line height has changed, arrange for a thorough
16781 immediate redisplay using the correct mode line height. */
16782 if (WINDOW_WANTS_MODELINE_P (w
)
16783 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16785 f
->fonts_changed
= true;
16786 w
->mode_line_height
= -1;
16787 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16788 = DESIRED_MODE_LINE_HEIGHT (w
);
16791 /* If header line height has changed, arrange for a thorough
16792 immediate redisplay using the correct header line height. */
16793 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16794 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16796 f
->fonts_changed
= true;
16797 w
->header_line_height
= -1;
16798 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16799 = DESIRED_HEADER_LINE_HEIGHT (w
);
16802 if (f
->fonts_changed
)
16803 goto need_larger_matrices
;
16806 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16808 w
->base_line_pos
= 0;
16809 w
->base_line_number
= 0;
16814 /* When we reach a frame's selected window, redo the frame's menu bar. */
16815 if (update_mode_line
16816 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16818 bool redisplay_menu_p
;
16820 if (FRAME_WINDOW_P (f
))
16822 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16823 || defined (HAVE_NS) || defined (USE_GTK)
16824 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16826 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16830 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16832 if (redisplay_menu_p
)
16833 display_menu_bar (w
);
16835 #ifdef HAVE_WINDOW_SYSTEM
16836 if (FRAME_WINDOW_P (f
))
16838 #if defined (USE_GTK) || defined (HAVE_NS)
16839 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16840 redisplay_tool_bar (f
);
16842 if (WINDOWP (f
->tool_bar_window
)
16843 && (FRAME_TOOL_BAR_LINES (f
) > 0
16844 || !NILP (Vauto_resize_tool_bars
))
16845 && redisplay_tool_bar (f
))
16846 ignore_mouse_drag_p
= true;
16852 #ifdef HAVE_WINDOW_SYSTEM
16853 if (FRAME_WINDOW_P (f
)
16854 && update_window_fringes (w
, (just_this_one_p
16855 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16856 || w
->pseudo_window_p
)))
16860 if (draw_window_fringes (w
, true))
16862 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16863 x_draw_right_divider (w
);
16865 x_draw_vertical_border (w
);
16871 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16872 x_draw_bottom_divider (w
);
16873 #endif /* HAVE_WINDOW_SYSTEM */
16875 /* We go to this label, with fonts_changed set, if it is
16876 necessary to try again using larger glyph matrices.
16877 We have to redeem the scroll bar even in this case,
16878 because the loop in redisplay_internal expects that. */
16879 need_larger_matrices
:
16881 finish_scroll_bars
:
16883 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16885 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16886 /* Set the thumb's position and size. */
16887 set_vertical_scroll_bar (w
);
16889 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16890 /* Set the thumb's position and size. */
16891 set_horizontal_scroll_bar (w
);
16893 /* Note that we actually used the scroll bar attached to this
16894 window, so it shouldn't be deleted at the end of redisplay. */
16895 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16896 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16899 /* Restore current_buffer and value of point in it. The window
16900 update may have changed the buffer, so first make sure `opoint'
16901 is still valid (Bug#6177). */
16902 if (CHARPOS (opoint
) < BEGV
)
16903 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16904 else if (CHARPOS (opoint
) > ZV
)
16905 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16907 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16909 set_buffer_internal_1 (old
);
16910 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16911 shorter. This can be caused by log truncation in *Messages*. */
16912 if (CHARPOS (lpoint
) <= ZV
)
16913 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16915 unbind_to (count
, Qnil
);
16919 /* Build the complete desired matrix of WINDOW with a window start
16920 buffer position POS.
16922 Value is 1 if successful. It is zero if fonts were loaded during
16923 redisplay which makes re-adjusting glyph matrices necessary, and -1
16924 if point would appear in the scroll margins.
16925 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16926 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16930 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16932 struct window
*w
= XWINDOW (window
);
16934 struct glyph_row
*last_text_row
= NULL
;
16935 struct frame
*f
= XFRAME (w
->frame
);
16936 int frame_line_height
= default_line_pixel_height (w
);
16938 /* Make POS the new window start. */
16939 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16941 /* Mark cursor position as unknown. No overlay arrow seen. */
16942 w
->cursor
.vpos
= -1;
16943 overlay_arrow_seen
= false;
16945 /* Initialize iterator and info to start at POS. */
16946 start_display (&it
, w
, pos
);
16947 it
.glyph_row
->reversed_p
= false;
16949 /* Display all lines of W. */
16950 while (it
.current_y
< it
.last_visible_y
)
16952 if (display_line (&it
))
16953 last_text_row
= it
.glyph_row
- 1;
16954 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16958 /* Don't let the cursor end in the scroll margins. */
16959 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16960 && !MINI_WINDOW_P (w
))
16962 int this_scroll_margin
;
16963 int window_total_lines
16964 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16966 if (scroll_margin
> 0)
16968 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
16969 this_scroll_margin
*= frame_line_height
;
16972 this_scroll_margin
= 0;
16974 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16975 && w
->cursor
.y
< this_scroll_margin
16976 && CHARPOS (pos
) > BEGV
16977 && IT_CHARPOS (it
) < ZV
)
16978 /* rms: considering make_cursor_line_fully_visible_p here
16979 seems to give wrong results. We don't want to recenter
16980 when the last line is partly visible, we want to allow
16981 that case to be handled in the usual way. */
16982 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16984 w
->cursor
.vpos
= -1;
16985 clear_glyph_matrix (w
->desired_matrix
);
16990 /* If bottom moved off end of frame, change mode line percentage. */
16991 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
16992 w
->update_mode_line
= true;
16994 /* Set window_end_pos to the offset of the last character displayed
16995 on the window from the end of current_buffer. Set
16996 window_end_vpos to its row number. */
16999 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
17000 adjust_window_ends (w
, last_text_row
, false);
17002 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
17003 w
->window_end_vpos
)));
17007 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17008 w
->window_end_pos
= Z
- ZV
;
17009 w
->window_end_vpos
= 0;
17012 /* But that is not valid info until redisplay finishes. */
17013 w
->window_end_valid
= false;
17019 /************************************************************************
17020 Window redisplay reusing current matrix when buffer has not changed
17021 ************************************************************************/
17023 /* Try redisplay of window W showing an unchanged buffer with a
17024 different window start than the last time it was displayed by
17025 reusing its current matrix. Value is true if successful.
17026 W->start is the new window start. */
17029 try_window_reusing_current_matrix (struct window
*w
)
17031 struct frame
*f
= XFRAME (w
->frame
);
17032 struct glyph_row
*bottom_row
;
17035 struct text_pos start
, new_start
;
17036 int nrows_scrolled
, i
;
17037 struct glyph_row
*last_text_row
;
17038 struct glyph_row
*last_reused_text_row
;
17039 struct glyph_row
*start_row
;
17040 int start_vpos
, min_y
, max_y
;
17043 if (inhibit_try_window_reusing
)
17047 if (/* This function doesn't handle terminal frames. */
17048 !FRAME_WINDOW_P (f
)
17049 /* Don't try to reuse the display if windows have been split
17051 || windows_or_buffers_changed
17052 || (f
!= SELECTED_FRAME () && f
->redisplay
)
17053 || f
->cursor_type_changed
)
17056 /* Can't do this if showing trailing whitespace. */
17057 if (!NILP (Vshow_trailing_whitespace
))
17060 /* If top-line visibility has changed, give up. */
17061 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17062 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17065 /* Give up if old or new display is scrolled vertically. We could
17066 make this function handle this, but right now it doesn't. */
17067 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17068 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17071 /* The variable new_start now holds the new window start. The old
17072 start `start' can be determined from the current matrix. */
17073 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17074 start
= start_row
->minpos
;
17075 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17077 /* Clear the desired matrix for the display below. */
17078 clear_glyph_matrix (w
->desired_matrix
);
17080 if (CHARPOS (new_start
) <= CHARPOS (start
))
17082 /* Don't use this method if the display starts with an ellipsis
17083 displayed for invisible text. It's not easy to handle that case
17084 below, and it's certainly not worth the effort since this is
17085 not a frequent case. */
17086 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17089 IF_DEBUG (debug_method_add (w
, "twu1"));
17091 /* Display up to a row that can be reused. The variable
17092 last_text_row is set to the last row displayed that displays
17093 text. Note that it.vpos == 0 if or if not there is a
17094 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17095 start_display (&it
, w
, new_start
);
17096 w
->cursor
.vpos
= -1;
17097 last_text_row
= last_reused_text_row
= NULL
;
17099 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17101 /* If we have reached into the characters in the START row,
17102 that means the line boundaries have changed. So we
17103 can't start copying with the row START. Maybe it will
17104 work to start copying with the following row. */
17105 while (IT_CHARPOS (it
) > CHARPOS (start
))
17107 /* Advance to the next row as the "start". */
17109 start
= start_row
->minpos
;
17110 /* If there are no more rows to try, or just one, give up. */
17111 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17112 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17113 || CHARPOS (start
) == ZV
)
17115 clear_glyph_matrix (w
->desired_matrix
);
17119 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17121 /* If we have reached alignment, we can copy the rest of the
17123 if (IT_CHARPOS (it
) == CHARPOS (start
)
17124 /* Don't accept "alignment" inside a display vector,
17125 since start_row could have started in the middle of
17126 that same display vector (thus their character
17127 positions match), and we have no way of telling if
17128 that is the case. */
17129 && it
.current
.dpvec_index
< 0)
17132 it
.glyph_row
->reversed_p
= false;
17133 if (display_line (&it
))
17134 last_text_row
= it
.glyph_row
- 1;
17138 /* A value of current_y < last_visible_y means that we stopped
17139 at the previous window start, which in turn means that we
17140 have at least one reusable row. */
17141 if (it
.current_y
< it
.last_visible_y
)
17143 struct glyph_row
*row
;
17145 /* IT.vpos always starts from 0; it counts text lines. */
17146 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17148 /* Find PT if not already found in the lines displayed. */
17149 if (w
->cursor
.vpos
< 0)
17151 int dy
= it
.current_y
- start_row
->y
;
17153 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17154 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17156 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17157 dy
, nrows_scrolled
);
17160 clear_glyph_matrix (w
->desired_matrix
);
17165 /* Scroll the display. Do it before the current matrix is
17166 changed. The problem here is that update has not yet
17167 run, i.e. part of the current matrix is not up to date.
17168 scroll_run_hook will clear the cursor, and use the
17169 current matrix to get the height of the row the cursor is
17171 run
.current_y
= start_row
->y
;
17172 run
.desired_y
= it
.current_y
;
17173 run
.height
= it
.last_visible_y
- it
.current_y
;
17175 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17178 FRAME_RIF (f
)->update_window_begin_hook (w
);
17179 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17180 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17181 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17185 /* Shift current matrix down by nrows_scrolled lines. */
17186 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17187 rotate_matrix (w
->current_matrix
,
17189 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17192 /* Disable lines that must be updated. */
17193 for (i
= 0; i
< nrows_scrolled
; ++i
)
17194 (start_row
+ i
)->enabled_p
= false;
17196 /* Re-compute Y positions. */
17197 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17198 max_y
= it
.last_visible_y
;
17199 for (row
= start_row
+ nrows_scrolled
;
17203 row
->y
= it
.current_y
;
17204 row
->visible_height
= row
->height
;
17206 if (row
->y
< min_y
)
17207 row
->visible_height
-= min_y
- row
->y
;
17208 if (row
->y
+ row
->height
> max_y
)
17209 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17210 if (row
->fringe_bitmap_periodic_p
)
17211 row
->redraw_fringe_bitmaps_p
= true;
17213 it
.current_y
+= row
->height
;
17215 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17216 last_reused_text_row
= row
;
17217 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17221 /* Disable lines in the current matrix which are now
17222 below the window. */
17223 for (++row
; row
< bottom_row
; ++row
)
17224 row
->enabled_p
= row
->mode_line_p
= false;
17227 /* Update window_end_pos etc.; last_reused_text_row is the last
17228 reused row from the current matrix containing text, if any.
17229 The value of last_text_row is the last displayed line
17230 containing text. */
17231 if (last_reused_text_row
)
17232 adjust_window_ends (w
, last_reused_text_row
, true);
17233 else if (last_text_row
)
17234 adjust_window_ends (w
, last_text_row
, false);
17237 /* This window must be completely empty. */
17238 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17239 w
->window_end_pos
= Z
- ZV
;
17240 w
->window_end_vpos
= 0;
17242 w
->window_end_valid
= false;
17244 /* Update hint: don't try scrolling again in update_window. */
17245 w
->desired_matrix
->no_scrolling_p
= true;
17248 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17252 else if (CHARPOS (new_start
) > CHARPOS (start
))
17254 struct glyph_row
*pt_row
, *row
;
17255 struct glyph_row
*first_reusable_row
;
17256 struct glyph_row
*first_row_to_display
;
17258 int yb
= window_text_bottom_y (w
);
17260 /* Find the row starting at new_start, if there is one. Don't
17261 reuse a partially visible line at the end. */
17262 first_reusable_row
= start_row
;
17263 while (first_reusable_row
->enabled_p
17264 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17265 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17266 < CHARPOS (new_start
)))
17267 ++first_reusable_row
;
17269 /* Give up if there is no row to reuse. */
17270 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17271 || !first_reusable_row
->enabled_p
17272 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17273 != CHARPOS (new_start
)))
17276 /* We can reuse fully visible rows beginning with
17277 first_reusable_row to the end of the window. Set
17278 first_row_to_display to the first row that cannot be reused.
17279 Set pt_row to the row containing point, if there is any. */
17281 for (first_row_to_display
= first_reusable_row
;
17282 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17283 ++first_row_to_display
)
17285 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17286 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17287 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17288 && first_row_to_display
->ends_at_zv_p
17289 && pt_row
== NULL
)))
17290 pt_row
= first_row_to_display
;
17293 /* Start displaying at the start of first_row_to_display. */
17294 eassert (first_row_to_display
->y
< yb
);
17295 init_to_row_start (&it
, w
, first_row_to_display
);
17297 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17299 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17301 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17302 + WINDOW_HEADER_LINE_HEIGHT (w
));
17304 /* Display lines beginning with first_row_to_display in the
17305 desired matrix. Set last_text_row to the last row displayed
17306 that displays text. */
17307 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17308 if (pt_row
== NULL
)
17309 w
->cursor
.vpos
= -1;
17310 last_text_row
= NULL
;
17311 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17312 if (display_line (&it
))
17313 last_text_row
= it
.glyph_row
- 1;
17315 /* If point is in a reused row, adjust y and vpos of the cursor
17319 w
->cursor
.vpos
-= nrows_scrolled
;
17320 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17323 /* Give up if point isn't in a row displayed or reused. (This
17324 also handles the case where w->cursor.vpos < nrows_scrolled
17325 after the calls to display_line, which can happen with scroll
17326 margins. See bug#1295.) */
17327 if (w
->cursor
.vpos
< 0)
17329 clear_glyph_matrix (w
->desired_matrix
);
17333 /* Scroll the display. */
17334 run
.current_y
= first_reusable_row
->y
;
17335 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17336 run
.height
= it
.last_visible_y
- run
.current_y
;
17337 dy
= run
.current_y
- run
.desired_y
;
17342 FRAME_RIF (f
)->update_window_begin_hook (w
);
17343 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17344 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17345 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17349 /* Adjust Y positions of reused rows. */
17350 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17351 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17352 max_y
= it
.last_visible_y
;
17353 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17356 row
->visible_height
= row
->height
;
17357 if (row
->y
< min_y
)
17358 row
->visible_height
-= min_y
- row
->y
;
17359 if (row
->y
+ row
->height
> max_y
)
17360 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17361 if (row
->fringe_bitmap_periodic_p
)
17362 row
->redraw_fringe_bitmaps_p
= true;
17365 /* Scroll the current matrix. */
17366 eassert (nrows_scrolled
> 0);
17367 rotate_matrix (w
->current_matrix
,
17369 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17372 /* Disable rows not reused. */
17373 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17374 row
->enabled_p
= false;
17376 /* Point may have moved to a different line, so we cannot assume that
17377 the previous cursor position is valid; locate the correct row. */
17380 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17382 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17383 && !row
->ends_at_zv_p
;
17387 w
->cursor
.y
= row
->y
;
17389 if (row
< bottom_row
)
17391 /* Can't simply scan the row for point with
17392 bidi-reordered glyph rows. Let set_cursor_from_row
17393 figure out where to put the cursor, and if it fails,
17395 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17397 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17400 clear_glyph_matrix (w
->desired_matrix
);
17406 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17407 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17410 && (!BUFFERP (glyph
->object
)
17411 || glyph
->charpos
< PT
);
17415 w
->cursor
.x
+= glyph
->pixel_width
;
17421 /* Adjust window end. A null value of last_text_row means that
17422 the window end is in reused rows which in turn means that
17423 only its vpos can have changed. */
17425 adjust_window_ends (w
, last_text_row
, false);
17427 w
->window_end_vpos
-= nrows_scrolled
;
17429 w
->window_end_valid
= false;
17430 w
->desired_matrix
->no_scrolling_p
= true;
17433 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17443 /************************************************************************
17444 Window redisplay reusing current matrix when buffer has changed
17445 ************************************************************************/
17447 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17448 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17449 ptrdiff_t *, ptrdiff_t *);
17450 static struct glyph_row
*
17451 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17452 struct glyph_row
*);
17455 /* Return the last row in MATRIX displaying text. If row START is
17456 non-null, start searching with that row. IT gives the dimensions
17457 of the display. Value is null if matrix is empty; otherwise it is
17458 a pointer to the row found. */
17460 static struct glyph_row
*
17461 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17462 struct glyph_row
*start
)
17464 struct glyph_row
*row
, *row_found
;
17466 /* Set row_found to the last row in IT->w's current matrix
17467 displaying text. The loop looks funny but think of partially
17470 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17471 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17473 eassert (row
->enabled_p
);
17475 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17484 /* Return the last row in the current matrix of W that is not affected
17485 by changes at the start of current_buffer that occurred since W's
17486 current matrix was built. Value is null if no such row exists.
17488 BEG_UNCHANGED us the number of characters unchanged at the start of
17489 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17490 first changed character in current_buffer. Characters at positions <
17491 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17492 when the current matrix was built. */
17494 static struct glyph_row
*
17495 find_last_unchanged_at_beg_row (struct window
*w
)
17497 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17498 struct glyph_row
*row
;
17499 struct glyph_row
*row_found
= NULL
;
17500 int yb
= window_text_bottom_y (w
);
17502 /* Find the last row displaying unchanged text. */
17503 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17504 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17505 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17508 if (/* If row ends before first_changed_pos, it is unchanged,
17509 except in some case. */
17510 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17511 /* When row ends in ZV and we write at ZV it is not
17513 && !row
->ends_at_zv_p
17514 /* When first_changed_pos is the end of a continued line,
17515 row is not unchanged because it may be no longer
17517 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17518 && (row
->continued_p
17519 || row
->exact_window_width_line_p
))
17520 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17521 needs to be recomputed, so don't consider this row as
17522 unchanged. This happens when the last line was
17523 bidi-reordered and was killed immediately before this
17524 redisplay cycle. In that case, ROW->end stores the
17525 buffer position of the first visual-order character of
17526 the killed text, which is now beyond ZV. */
17527 && CHARPOS (row
->end
.pos
) <= ZV
)
17530 /* Stop if last visible row. */
17531 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17539 /* Find the first glyph row in the current matrix of W that is not
17540 affected by changes at the end of current_buffer since the
17541 time W's current matrix was built.
17543 Return in *DELTA the number of chars by which buffer positions in
17544 unchanged text at the end of current_buffer must be adjusted.
17546 Return in *DELTA_BYTES the corresponding number of bytes.
17548 Value is null if no such row exists, i.e. all rows are affected by
17551 static struct glyph_row
*
17552 find_first_unchanged_at_end_row (struct window
*w
,
17553 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17555 struct glyph_row
*row
;
17556 struct glyph_row
*row_found
= NULL
;
17558 *delta
= *delta_bytes
= 0;
17560 /* Display must not have been paused, otherwise the current matrix
17561 is not up to date. */
17562 eassert (w
->window_end_valid
);
17564 /* A value of window_end_pos >= END_UNCHANGED means that the window
17565 end is in the range of changed text. If so, there is no
17566 unchanged row at the end of W's current matrix. */
17567 if (w
->window_end_pos
>= END_UNCHANGED
)
17570 /* Set row to the last row in W's current matrix displaying text. */
17571 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17573 /* If matrix is entirely empty, no unchanged row exists. */
17574 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17576 /* The value of row is the last glyph row in the matrix having a
17577 meaningful buffer position in it. The end position of row
17578 corresponds to window_end_pos. This allows us to translate
17579 buffer positions in the current matrix to current buffer
17580 positions for characters not in changed text. */
17582 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17583 ptrdiff_t Z_BYTE_old
=
17584 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17585 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17586 struct glyph_row
*first_text_row
17587 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17589 *delta
= Z
- Z_old
;
17590 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17592 /* Set last_unchanged_pos to the buffer position of the last
17593 character in the buffer that has not been changed. Z is the
17594 index + 1 of the last character in current_buffer, i.e. by
17595 subtracting END_UNCHANGED we get the index of the last
17596 unchanged character, and we have to add BEG to get its buffer
17598 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17599 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17601 /* Search backward from ROW for a row displaying a line that
17602 starts at a minimum position >= last_unchanged_pos_old. */
17603 for (; row
> first_text_row
; --row
)
17605 /* This used to abort, but it can happen.
17606 It is ok to just stop the search instead here. KFS. */
17607 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17610 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17615 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17621 /* Make sure that glyph rows in the current matrix of window W
17622 reference the same glyph memory as corresponding rows in the
17623 frame's frame matrix. This function is called after scrolling W's
17624 current matrix on a terminal frame in try_window_id and
17625 try_window_reusing_current_matrix. */
17628 sync_frame_with_window_matrix_rows (struct window
*w
)
17630 struct frame
*f
= XFRAME (w
->frame
);
17631 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17633 /* Preconditions: W must be a leaf window and full-width. Its frame
17634 must have a frame matrix. */
17635 eassert (BUFFERP (w
->contents
));
17636 eassert (WINDOW_FULL_WIDTH_P (w
));
17637 eassert (!FRAME_WINDOW_P (f
));
17639 /* If W is a full-width window, glyph pointers in W's current matrix
17640 have, by definition, to be the same as glyph pointers in the
17641 corresponding frame matrix. Note that frame matrices have no
17642 marginal areas (see build_frame_matrix). */
17643 window_row
= w
->current_matrix
->rows
;
17644 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17645 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17646 while (window_row
< window_row_end
)
17648 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17649 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17651 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17652 frame_row
->glyphs
[TEXT_AREA
] = start
;
17653 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17654 frame_row
->glyphs
[LAST_AREA
] = end
;
17656 /* Disable frame rows whose corresponding window rows have
17657 been disabled in try_window_id. */
17658 if (!window_row
->enabled_p
)
17659 frame_row
->enabled_p
= false;
17661 ++window_row
, ++frame_row
;
17666 /* Find the glyph row in window W containing CHARPOS. Consider all
17667 rows between START and END (not inclusive). END null means search
17668 all rows to the end of the display area of W. Value is the row
17669 containing CHARPOS or null. */
17672 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17673 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17675 struct glyph_row
*row
= start
;
17676 struct glyph_row
*best_row
= NULL
;
17677 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17680 /* If we happen to start on a header-line, skip that. */
17681 if (row
->mode_line_p
)
17684 if ((end
&& row
>= end
) || !row
->enabled_p
)
17687 last_y
= window_text_bottom_y (w
) - dy
;
17691 /* Give up if we have gone too far. */
17692 if (end
&& row
>= end
)
17694 /* This formerly returned if they were equal.
17695 I think that both quantities are of a "last plus one" type;
17696 if so, when they are equal, the row is within the screen. -- rms. */
17697 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17700 /* If it is in this row, return this row. */
17701 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17702 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17703 /* The end position of a row equals the start
17704 position of the next row. If CHARPOS is there, we
17705 would rather consider it displayed in the next
17706 line, except when this line ends in ZV. */
17707 && !row_for_charpos_p (row
, charpos
)))
17708 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17712 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17713 || (!best_row
&& !row
->continued_p
))
17715 /* In bidi-reordered rows, there could be several rows whose
17716 edges surround CHARPOS, all of these rows belonging to
17717 the same continued line. We need to find the row which
17718 fits CHARPOS the best. */
17719 for (g
= row
->glyphs
[TEXT_AREA
];
17720 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17723 if (!STRINGP (g
->object
))
17725 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17727 mindif
= eabs (g
->charpos
- charpos
);
17729 /* Exact match always wins. */
17736 else if (best_row
&& !row
->continued_p
)
17743 /* Try to redisplay window W by reusing its existing display. W's
17744 current matrix must be up to date when this function is called,
17745 i.e., window_end_valid must be true.
17749 >= 1 if successful, i.e. display has been updated
17751 1 means the changes were in front of a newline that precedes
17752 the window start, and the whole current matrix was reused
17753 2 means the changes were after the last position displayed
17754 in the window, and the whole current matrix was reused
17755 3 means portions of the current matrix were reused, while
17756 some of the screen lines were redrawn
17757 -1 if redisplay with same window start is known not to succeed
17758 0 if otherwise unsuccessful
17760 The following steps are performed:
17762 1. Find the last row in the current matrix of W that is not
17763 affected by changes at the start of current_buffer. If no such row
17766 2. Find the first row in W's current matrix that is not affected by
17767 changes at the end of current_buffer. Maybe there is no such row.
17769 3. Display lines beginning with the row + 1 found in step 1 to the
17770 row found in step 2 or, if step 2 didn't find a row, to the end of
17773 4. If cursor is not known to appear on the window, give up.
17775 5. If display stopped at the row found in step 2, scroll the
17776 display and current matrix as needed.
17778 6. Maybe display some lines at the end of W, if we must. This can
17779 happen under various circumstances, like a partially visible line
17780 becoming fully visible, or because newly displayed lines are displayed
17781 in smaller font sizes.
17783 7. Update W's window end information. */
17786 try_window_id (struct window
*w
)
17788 struct frame
*f
= XFRAME (w
->frame
);
17789 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17790 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17791 struct glyph_row
*last_unchanged_at_beg_row
;
17792 struct glyph_row
*first_unchanged_at_end_row
;
17793 struct glyph_row
*row
;
17794 struct glyph_row
*bottom_row
;
17797 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17799 struct text_pos start_pos
;
17801 int first_unchanged_at_end_vpos
= 0;
17802 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17803 struct text_pos start
;
17804 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17807 if (inhibit_try_window_id
)
17811 /* This is handy for debugging. */
17813 #define GIVE_UP(X) \
17815 TRACE ((stderr, "try_window_id give up %d\n", (X))); \
17819 #define GIVE_UP(X) return 0
17822 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17824 /* Don't use this for mini-windows because these can show
17825 messages and mini-buffers, and we don't handle that here. */
17826 if (MINI_WINDOW_P (w
))
17829 /* This flag is used to prevent redisplay optimizations. */
17830 if (windows_or_buffers_changed
|| f
->cursor_type_changed
17831 || (f
!= SELECTED_FRAME () && f
->redisplay
))
17834 /* This function's optimizations cannot be used if overlays have
17835 changed in the buffer displayed by the window, so give up if they
17837 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17840 /* Verify that narrowing has not changed.
17841 Also verify that we were not told to prevent redisplay optimizations.
17842 It would be nice to further
17843 reduce the number of cases where this prevents try_window_id. */
17844 if (current_buffer
->clip_changed
17845 || current_buffer
->prevent_redisplay_optimizations_p
)
17848 /* Window must either use window-based redisplay or be full width. */
17849 if (!FRAME_WINDOW_P (f
)
17850 && (!FRAME_LINE_INS_DEL_OK (f
)
17851 || !WINDOW_FULL_WIDTH_P (w
)))
17854 /* Give up if point is known NOT to appear in W. */
17855 if (PT
< CHARPOS (start
))
17858 /* Another way to prevent redisplay optimizations. */
17859 if (w
->last_modified
== 0)
17862 /* Verify that window is not hscrolled. */
17863 if (w
->hscroll
!= 0)
17866 /* Verify that display wasn't paused. */
17867 if (!w
->window_end_valid
)
17870 /* Likewise if highlighting trailing whitespace. */
17871 if (!NILP (Vshow_trailing_whitespace
))
17874 /* Can't use this if overlay arrow position and/or string have
17876 if (overlay_arrows_changed_p ())
17879 /* When word-wrap is on, adding a space to the first word of a
17880 wrapped line can change the wrap position, altering the line
17881 above it. It might be worthwhile to handle this more
17882 intelligently, but for now just redisplay from scratch. */
17883 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17886 /* Under bidi reordering, adding or deleting a character in the
17887 beginning of a paragraph, before the first strong directional
17888 character, can change the base direction of the paragraph (unless
17889 the buffer specifies a fixed paragraph direction), which will
17890 require to redisplay the whole paragraph. It might be worthwhile
17891 to find the paragraph limits and widen the range of redisplayed
17892 lines to that, but for now just give up this optimization and
17893 redisplay from scratch. */
17894 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17895 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17898 /* Give up if the buffer has line-spacing set, as Lisp-level changes
17899 to that variable require thorough redisplay. */
17900 if (!NILP (BVAR (XBUFFER (w
->contents
), extra_line_spacing
)))
17903 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17904 only if buffer has really changed. The reason is that the gap is
17905 initially at Z for freshly visited files. The code below would
17906 set end_unchanged to 0 in that case. */
17907 if (MODIFF
> SAVE_MODIFF
17908 /* This seems to happen sometimes after saving a buffer. */
17909 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17911 if (GPT
- BEG
< BEG_UNCHANGED
)
17912 BEG_UNCHANGED
= GPT
- BEG
;
17913 if (Z
- GPT
< END_UNCHANGED
)
17914 END_UNCHANGED
= Z
- GPT
;
17917 /* The position of the first and last character that has been changed. */
17918 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17919 last_changed_charpos
= Z
- END_UNCHANGED
;
17921 /* If window starts after a line end, and the last change is in
17922 front of that newline, then changes don't affect the display.
17923 This case happens with stealth-fontification. Note that although
17924 the display is unchanged, glyph positions in the matrix have to
17925 be adjusted, of course. */
17926 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17927 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17928 && ((last_changed_charpos
< CHARPOS (start
)
17929 && CHARPOS (start
) == BEGV
)
17930 || (last_changed_charpos
< CHARPOS (start
) - 1
17931 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17933 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17934 struct glyph_row
*r0
;
17936 /* Compute how many chars/bytes have been added to or removed
17937 from the buffer. */
17938 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17939 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17940 Z_delta
= Z
- Z_old
;
17941 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17943 /* Give up if PT is not in the window. Note that it already has
17944 been checked at the start of try_window_id that PT is not in
17945 front of the window start. */
17946 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17949 /* If window start is unchanged, we can reuse the whole matrix
17950 as is, after adjusting glyph positions. No need to compute
17951 the window end again, since its offset from Z hasn't changed. */
17952 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17953 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17954 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17955 /* PT must not be in a partially visible line. */
17956 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17957 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17959 /* Adjust positions in the glyph matrix. */
17960 if (Z_delta
|| Z_delta_bytes
)
17962 struct glyph_row
*r1
17963 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17964 increment_matrix_positions (w
->current_matrix
,
17965 MATRIX_ROW_VPOS (r0
, current_matrix
),
17966 MATRIX_ROW_VPOS (r1
, current_matrix
),
17967 Z_delta
, Z_delta_bytes
);
17970 /* Set the cursor. */
17971 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17973 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17978 /* Handle the case that changes are all below what is displayed in
17979 the window, and that PT is in the window. This shortcut cannot
17980 be taken if ZV is visible in the window, and text has been added
17981 there that is visible in the window. */
17982 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17983 /* ZV is not visible in the window, or there are no
17984 changes at ZV, actually. */
17985 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17986 || first_changed_charpos
== last_changed_charpos
))
17988 struct glyph_row
*r0
;
17990 /* Give up if PT is not in the window. Note that it already has
17991 been checked at the start of try_window_id that PT is not in
17992 front of the window start. */
17993 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17996 /* If window start is unchanged, we can reuse the whole matrix
17997 as is, without changing glyph positions since no text has
17998 been added/removed in front of the window end. */
17999 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18000 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
18001 /* PT must not be in a partially visible line. */
18002 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
18003 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18005 /* We have to compute the window end anew since text
18006 could have been added/removed after it. */
18007 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18008 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18010 /* Set the cursor. */
18011 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18013 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18018 /* Give up if window start is in the changed area.
18020 The condition used to read
18022 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18024 but why that was tested escapes me at the moment. */
18025 if (CHARPOS (start
) >= first_changed_charpos
18026 && CHARPOS (start
) <= last_changed_charpos
)
18029 /* Check that window start agrees with the start of the first glyph
18030 row in its current matrix. Check this after we know the window
18031 start is not in changed text, otherwise positions would not be
18033 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18034 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
18037 /* Give up if the window ends in strings. Overlay strings
18038 at the end are difficult to handle, so don't try. */
18039 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
18040 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
18043 /* Compute the position at which we have to start displaying new
18044 lines. Some of the lines at the top of the window might be
18045 reusable because they are not displaying changed text. Find the
18046 last row in W's current matrix not affected by changes at the
18047 start of current_buffer. Value is null if changes start in the
18048 first line of window. */
18049 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18050 if (last_unchanged_at_beg_row
)
18052 /* Avoid starting to display in the middle of a character, a TAB
18053 for instance. This is easier than to set up the iterator
18054 exactly, and it's not a frequent case, so the additional
18055 effort wouldn't really pay off. */
18056 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18057 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18058 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18059 --last_unchanged_at_beg_row
;
18061 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18064 if (! init_to_row_end (&it
, w
, last_unchanged_at_beg_row
))
18066 start_pos
= it
.current
.pos
;
18068 /* Start displaying new lines in the desired matrix at the same
18069 vpos we would use in the current matrix, i.e. below
18070 last_unchanged_at_beg_row. */
18071 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18073 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18074 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18076 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18080 /* There are no reusable lines at the start of the window.
18081 Start displaying in the first text line. */
18082 start_display (&it
, w
, start
);
18083 it
.vpos
= it
.first_vpos
;
18084 start_pos
= it
.current
.pos
;
18087 /* Find the first row that is not affected by changes at the end of
18088 the buffer. Value will be null if there is no unchanged row, in
18089 which case we must redisplay to the end of the window. delta
18090 will be set to the value by which buffer positions beginning with
18091 first_unchanged_at_end_row have to be adjusted due to text
18093 first_unchanged_at_end_row
18094 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18095 IF_DEBUG (debug_delta
= delta
);
18096 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18098 /* Set stop_pos to the buffer position up to which we will have to
18099 display new lines. If first_unchanged_at_end_row != NULL, this
18100 is the buffer position of the start of the line displayed in that
18101 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18102 that we don't stop at a buffer position. */
18104 if (first_unchanged_at_end_row
)
18106 eassert (last_unchanged_at_beg_row
== NULL
18107 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18109 /* If this is a continuation line, move forward to the next one
18110 that isn't. Changes in lines above affect this line.
18111 Caution: this may move first_unchanged_at_end_row to a row
18112 not displaying text. */
18113 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18114 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18115 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18116 < it
.last_visible_y
))
18117 ++first_unchanged_at_end_row
;
18119 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18120 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18121 >= it
.last_visible_y
))
18122 first_unchanged_at_end_row
= NULL
;
18125 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18127 first_unchanged_at_end_vpos
18128 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18129 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18132 else if (last_unchanged_at_beg_row
== NULL
)
18138 /* Either there is no unchanged row at the end, or the one we have
18139 now displays text. This is a necessary condition for the window
18140 end pos calculation at the end of this function. */
18141 eassert (first_unchanged_at_end_row
== NULL
18142 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18144 debug_last_unchanged_at_beg_vpos
18145 = (last_unchanged_at_beg_row
18146 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18148 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18150 #endif /* GLYPH_DEBUG */
18153 /* Display new lines. Set last_text_row to the last new line
18154 displayed which has text on it, i.e. might end up as being the
18155 line where the window_end_vpos is. */
18156 w
->cursor
.vpos
= -1;
18157 last_text_row
= NULL
;
18158 overlay_arrow_seen
= false;
18159 if (it
.current_y
< it
.last_visible_y
18160 && !f
->fonts_changed
18161 && (first_unchanged_at_end_row
== NULL
18162 || IT_CHARPOS (it
) < stop_pos
))
18163 it
.glyph_row
->reversed_p
= false;
18164 while (it
.current_y
< it
.last_visible_y
18165 && !f
->fonts_changed
18166 && (first_unchanged_at_end_row
== NULL
18167 || IT_CHARPOS (it
) < stop_pos
))
18169 if (display_line (&it
))
18170 last_text_row
= it
.glyph_row
- 1;
18173 if (f
->fonts_changed
)
18176 /* The redisplay iterations in display_line above could have
18177 triggered font-lock, which could have done something that
18178 invalidates IT->w window's end-point information, on which we
18179 rely below. E.g., one package, which will remain unnamed, used
18180 to install a font-lock-fontify-region-function that called
18181 bury-buffer, whose side effect is to switch the buffer displayed
18182 by IT->w, and that predictably resets IT->w's window_end_valid
18183 flag, which we already tested at the entry to this function.
18184 Amply punish such packages/modes by giving up on this
18185 optimization in those cases. */
18186 if (!w
->window_end_valid
)
18188 clear_glyph_matrix (w
->desired_matrix
);
18192 /* Compute differences in buffer positions, y-positions etc. for
18193 lines reused at the bottom of the window. Compute what we can
18195 if (first_unchanged_at_end_row
18196 /* No lines reused because we displayed everything up to the
18197 bottom of the window. */
18198 && it
.current_y
< it
.last_visible_y
)
18201 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18203 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18204 run
.current_y
= first_unchanged_at_end_row
->y
;
18205 run
.desired_y
= run
.current_y
+ dy
;
18206 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18210 delta
= delta_bytes
= dvpos
= dy
18211 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18212 first_unchanged_at_end_row
= NULL
;
18214 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18217 /* Find the cursor if not already found. We have to decide whether
18218 PT will appear on this window (it sometimes doesn't, but this is
18219 not a very frequent case.) This decision has to be made before
18220 the current matrix is altered. A value of cursor.vpos < 0 means
18221 that PT is either in one of the lines beginning at
18222 first_unchanged_at_end_row or below the window. Don't care for
18223 lines that might be displayed later at the window end; as
18224 mentioned, this is not a frequent case. */
18225 if (w
->cursor
.vpos
< 0)
18227 /* Cursor in unchanged rows at the top? */
18228 if (PT
< CHARPOS (start_pos
)
18229 && last_unchanged_at_beg_row
)
18231 row
= row_containing_pos (w
, PT
,
18232 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18233 last_unchanged_at_beg_row
+ 1, 0);
18235 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18238 /* Start from first_unchanged_at_end_row looking for PT. */
18239 else if (first_unchanged_at_end_row
)
18241 row
= row_containing_pos (w
, PT
- delta
,
18242 first_unchanged_at_end_row
, NULL
, 0);
18244 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18245 delta_bytes
, dy
, dvpos
);
18248 /* Give up if cursor was not found. */
18249 if (w
->cursor
.vpos
< 0)
18251 clear_glyph_matrix (w
->desired_matrix
);
18256 /* Don't let the cursor end in the scroll margins. */
18258 int this_scroll_margin
, cursor_height
;
18259 int frame_line_height
= default_line_pixel_height (w
);
18260 int window_total_lines
18261 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18263 this_scroll_margin
=
18264 max (0, min (scroll_margin
, window_total_lines
/ 4));
18265 this_scroll_margin
*= frame_line_height
;
18266 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18268 if ((w
->cursor
.y
< this_scroll_margin
18269 && CHARPOS (start
) > BEGV
)
18270 /* Old redisplay didn't take scroll margin into account at the bottom,
18271 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18272 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18273 ? cursor_height
+ this_scroll_margin
18274 : 1)) > it
.last_visible_y
)
18276 w
->cursor
.vpos
= -1;
18277 clear_glyph_matrix (w
->desired_matrix
);
18282 /* Scroll the display. Do it before changing the current matrix so
18283 that xterm.c doesn't get confused about where the cursor glyph is
18285 if (dy
&& run
.height
)
18289 if (FRAME_WINDOW_P (f
))
18291 FRAME_RIF (f
)->update_window_begin_hook (w
);
18292 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18293 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18294 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
18298 /* Terminal frame. In this case, dvpos gives the number of
18299 lines to scroll by; dvpos < 0 means scroll up. */
18301 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18302 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18303 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18304 + WINDOW_WANTS_HEADER_LINE_P (w
)
18305 + window_internal_height (w
));
18307 #if defined (HAVE_GPM) || defined (MSDOS)
18308 x_clear_window_mouse_face (w
);
18310 /* Perform the operation on the screen. */
18313 /* Scroll last_unchanged_at_beg_row to the end of the
18314 window down dvpos lines. */
18315 set_terminal_window (f
, end
);
18317 /* On dumb terminals delete dvpos lines at the end
18318 before inserting dvpos empty lines. */
18319 if (!FRAME_SCROLL_REGION_OK (f
))
18320 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18322 /* Insert dvpos empty lines in front of
18323 last_unchanged_at_beg_row. */
18324 ins_del_lines (f
, from
, dvpos
);
18326 else if (dvpos
< 0)
18328 /* Scroll up last_unchanged_at_beg_vpos to the end of
18329 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18330 set_terminal_window (f
, end
);
18332 /* Delete dvpos lines in front of
18333 last_unchanged_at_beg_vpos. ins_del_lines will set
18334 the cursor to the given vpos and emit |dvpos| delete
18336 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18338 /* On a dumb terminal insert dvpos empty lines at the
18340 if (!FRAME_SCROLL_REGION_OK (f
))
18341 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18344 set_terminal_window (f
, 0);
18350 /* Shift reused rows of the current matrix to the right position.
18351 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18353 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18354 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18357 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18358 bottom_vpos
, dvpos
);
18359 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18362 else if (dvpos
> 0)
18364 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18365 bottom_vpos
, dvpos
);
18366 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18367 first_unchanged_at_end_vpos
+ dvpos
);
18370 /* For frame-based redisplay, make sure that current frame and window
18371 matrix are in sync with respect to glyph memory. */
18372 if (!FRAME_WINDOW_P (f
))
18373 sync_frame_with_window_matrix_rows (w
);
18375 /* Adjust buffer positions in reused rows. */
18376 if (delta
|| delta_bytes
)
18377 increment_matrix_positions (current_matrix
,
18378 first_unchanged_at_end_vpos
+ dvpos
,
18379 bottom_vpos
, delta
, delta_bytes
);
18381 /* Adjust Y positions. */
18383 shift_glyph_matrix (w
, current_matrix
,
18384 first_unchanged_at_end_vpos
+ dvpos
,
18387 if (first_unchanged_at_end_row
)
18389 first_unchanged_at_end_row
+= dvpos
;
18390 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18391 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18392 first_unchanged_at_end_row
= NULL
;
18395 /* If scrolling up, there may be some lines to display at the end of
18397 last_text_row_at_end
= NULL
;
18400 /* Scrolling up can leave for example a partially visible line
18401 at the end of the window to be redisplayed. */
18402 /* Set last_row to the glyph row in the current matrix where the
18403 window end line is found. It has been moved up or down in
18404 the matrix by dvpos. */
18405 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18406 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18408 /* If last_row is the window end line, it should display text. */
18409 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18411 /* If window end line was partially visible before, begin
18412 displaying at that line. Otherwise begin displaying with the
18413 line following it. */
18414 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18416 init_to_row_start (&it
, w
, last_row
);
18417 it
.vpos
= last_vpos
;
18418 it
.current_y
= last_row
->y
;
18422 init_to_row_end (&it
, w
, last_row
);
18423 it
.vpos
= 1 + last_vpos
;
18424 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18428 /* We may start in a continuation line. If so, we have to
18429 get the right continuation_lines_width and current_x. */
18430 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18431 it
.hpos
= it
.current_x
= 0;
18433 /* Display the rest of the lines at the window end. */
18434 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18435 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18437 /* Is it always sure that the display agrees with lines in
18438 the current matrix? I don't think so, so we mark rows
18439 displayed invalid in the current matrix by setting their
18440 enabled_p flag to false. */
18441 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18442 if (display_line (&it
))
18443 last_text_row_at_end
= it
.glyph_row
- 1;
18447 /* Update window_end_pos and window_end_vpos. */
18448 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18450 /* Window end line if one of the preserved rows from the current
18451 matrix. Set row to the last row displaying text in current
18452 matrix starting at first_unchanged_at_end_row, after
18454 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18455 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18456 first_unchanged_at_end_row
);
18457 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18458 adjust_window_ends (w
, row
, true);
18459 eassert (w
->window_end_bytepos
>= 0);
18460 IF_DEBUG (debug_method_add (w
, "A"));
18462 else if (last_text_row_at_end
)
18464 adjust_window_ends (w
, last_text_row_at_end
, false);
18465 eassert (w
->window_end_bytepos
>= 0);
18466 IF_DEBUG (debug_method_add (w
, "B"));
18468 else if (last_text_row
)
18470 /* We have displayed either to the end of the window or at the
18471 end of the window, i.e. the last row with text is to be found
18472 in the desired matrix. */
18473 adjust_window_ends (w
, last_text_row
, false);
18474 eassert (w
->window_end_bytepos
>= 0);
18476 else if (first_unchanged_at_end_row
== NULL
18477 && last_text_row
== NULL
18478 && last_text_row_at_end
== NULL
)
18480 /* Displayed to end of window, but no line containing text was
18481 displayed. Lines were deleted at the end of the window. */
18482 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
18483 int vpos
= w
->window_end_vpos
;
18484 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18485 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18488 row
== NULL
&& vpos
>= first_vpos
;
18489 --vpos
, --current_row
, --desired_row
)
18491 if (desired_row
->enabled_p
)
18493 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18496 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18500 eassert (row
!= NULL
);
18501 w
->window_end_vpos
= vpos
+ 1;
18502 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18503 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18504 eassert (w
->window_end_bytepos
>= 0);
18505 IF_DEBUG (debug_method_add (w
, "C"));
18510 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18511 debug_end_vpos
= w
->window_end_vpos
));
18513 /* Record that display has not been completed. */
18514 w
->window_end_valid
= false;
18515 w
->desired_matrix
->no_scrolling_p
= true;
18523 /***********************************************************************
18524 More debugging support
18525 ***********************************************************************/
18529 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18530 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18531 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18534 /* Dump the contents of glyph matrix MATRIX on stderr.
18536 GLYPHS 0 means don't show glyph contents.
18537 GLYPHS 1 means show glyphs in short form
18538 GLYPHS > 1 means show glyphs in long form. */
18541 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18544 for (i
= 0; i
< matrix
->nrows
; ++i
)
18545 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18549 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18550 the glyph row and area where the glyph comes from. */
18553 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18555 if (glyph
->type
== CHAR_GLYPH
18556 || glyph
->type
== GLYPHLESS_GLYPH
)
18559 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18560 glyph
- row
->glyphs
[TEXT_AREA
],
18561 (glyph
->type
== CHAR_GLYPH
18565 (BUFFERP (glyph
->object
)
18567 : (STRINGP (glyph
->object
)
18569 : (NILP (glyph
->object
)
18572 glyph
->pixel_width
,
18574 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18578 glyph
->left_box_line_p
,
18579 glyph
->right_box_line_p
);
18581 else if (glyph
->type
== STRETCH_GLYPH
)
18584 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18585 glyph
- row
->glyphs
[TEXT_AREA
],
18588 (BUFFERP (glyph
->object
)
18590 : (STRINGP (glyph
->object
)
18592 : (NILP (glyph
->object
)
18595 glyph
->pixel_width
,
18599 glyph
->left_box_line_p
,
18600 glyph
->right_box_line_p
);
18602 else if (glyph
->type
== IMAGE_GLYPH
)
18605 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18606 glyph
- row
->glyphs
[TEXT_AREA
],
18609 (BUFFERP (glyph
->object
)
18611 : (STRINGP (glyph
->object
)
18613 : (NILP (glyph
->object
)
18616 glyph
->pixel_width
,
18620 glyph
->left_box_line_p
,
18621 glyph
->right_box_line_p
);
18623 else if (glyph
->type
== COMPOSITE_GLYPH
)
18626 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18627 glyph
- row
->glyphs
[TEXT_AREA
],
18630 (BUFFERP (glyph
->object
)
18632 : (STRINGP (glyph
->object
)
18634 : (NILP (glyph
->object
)
18637 glyph
->pixel_width
,
18639 if (glyph
->u
.cmp
.automatic
)
18642 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18643 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18645 glyph
->left_box_line_p
,
18646 glyph
->right_box_line_p
);
18651 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18652 GLYPHS 0 means don't show glyph contents.
18653 GLYPHS 1 means show glyphs in short form
18654 GLYPHS > 1 means show glyphs in long form. */
18657 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18661 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18662 fprintf (stderr
, "==============================================================================\n");
18664 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18665 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18667 MATRIX_ROW_START_CHARPOS (row
),
18668 MATRIX_ROW_END_CHARPOS (row
),
18669 row
->used
[TEXT_AREA
],
18670 row
->contains_overlapping_glyphs_p
,
18672 row
->truncated_on_left_p
,
18673 row
->truncated_on_right_p
,
18675 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18676 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18679 row
->ends_in_middle_of_char_p
,
18680 row
->starts_in_middle_of_char_p
,
18686 row
->visible_height
,
18689 /* The next 3 lines should align to "Start" in the header. */
18690 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18691 row
->end
.overlay_string_index
,
18692 row
->continuation_lines_width
);
18693 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18694 CHARPOS (row
->start
.string_pos
),
18695 CHARPOS (row
->end
.string_pos
));
18696 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18697 row
->end
.dpvec_index
);
18704 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18706 struct glyph
*glyph
= row
->glyphs
[area
];
18707 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18709 /* Glyph for a line end in text. */
18710 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18713 if (glyph
< glyph_end
)
18714 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18716 for (; glyph
< glyph_end
; ++glyph
)
18717 dump_glyph (row
, glyph
, area
);
18720 else if (glyphs
== 1)
18723 char s
[SHRT_MAX
+ 4];
18725 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18729 for (i
= 0; i
< row
->used
[area
]; ++i
)
18731 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18732 if (i
== row
->used
[area
] - 1
18733 && area
== TEXT_AREA
18734 && NILP (glyph
->object
)
18735 && glyph
->type
== CHAR_GLYPH
18736 && glyph
->u
.ch
== ' ')
18738 strcpy (&s
[i
], "[\\n]");
18741 else if (glyph
->type
== CHAR_GLYPH
18742 && glyph
->u
.ch
< 0x80
18743 && glyph
->u
.ch
>= ' ')
18744 s
[i
] = glyph
->u
.ch
;
18750 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18756 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18757 Sdump_glyph_matrix
, 0, 1, "p",
18758 doc
: /* Dump the current matrix of the selected window to stderr.
18759 Shows contents of glyph row structures. With non-nil
18760 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18761 glyphs in short form, otherwise show glyphs in long form.
18763 Interactively, no argument means show glyphs in short form;
18764 with numeric argument, its value is passed as the GLYPHS flag. */)
18765 (Lisp_Object glyphs
)
18767 struct window
*w
= XWINDOW (selected_window
);
18768 struct buffer
*buffer
= XBUFFER (w
->contents
);
18770 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18771 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18772 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18773 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18774 fprintf (stderr
, "=============================================\n");
18775 dump_glyph_matrix (w
->current_matrix
,
18776 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18781 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18782 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* Dump the current glyph matrix of the selected frame to stderr.
18783 Only text-mode frames have frame glyph matrices. */)
18786 struct frame
*f
= XFRAME (selected_frame
);
18788 if (f
->current_matrix
)
18789 dump_glyph_matrix (f
->current_matrix
, 1);
18791 fprintf (stderr
, "*** This frame doesn't have a frame glyph matrix ***\n");
18796 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18797 doc
: /* Dump glyph row ROW to stderr.
18798 GLYPH 0 means don't dump glyphs.
18799 GLYPH 1 means dump glyphs in short form.
18800 GLYPH > 1 or omitted means dump glyphs in long form. */)
18801 (Lisp_Object row
, Lisp_Object glyphs
)
18803 struct glyph_matrix
*matrix
;
18806 CHECK_NUMBER (row
);
18807 matrix
= XWINDOW (selected_window
)->current_matrix
;
18809 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18810 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18812 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18817 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18818 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18819 GLYPH 0 means don't dump glyphs.
18820 GLYPH 1 means dump glyphs in short form.
18821 GLYPH > 1 or omitted means dump glyphs in long form.
18823 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18825 (Lisp_Object row
, Lisp_Object glyphs
)
18827 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18828 struct frame
*sf
= SELECTED_FRAME ();
18829 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18832 CHECK_NUMBER (row
);
18834 if (vpos
>= 0 && vpos
< m
->nrows
)
18835 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18836 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18842 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18843 doc
: /* Toggle tracing of redisplay.
18844 With ARG, turn tracing on if and only if ARG is positive. */)
18848 trace_redisplay_p
= !trace_redisplay_p
;
18851 arg
= Fprefix_numeric_value (arg
);
18852 trace_redisplay_p
= XINT (arg
) > 0;
18859 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18860 doc
: /* Like `format', but print result to stderr.
18861 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18862 (ptrdiff_t nargs
, Lisp_Object
*args
)
18864 Lisp_Object s
= Fformat (nargs
, args
);
18865 fwrite (SDATA (s
), 1, SBYTES (s
), stderr
);
18869 #endif /* GLYPH_DEBUG */
18873 /***********************************************************************
18874 Building Desired Matrix Rows
18875 ***********************************************************************/
18877 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18878 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18880 static struct glyph_row
*
18881 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18883 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18884 struct buffer
*buffer
= XBUFFER (w
->contents
);
18885 struct buffer
*old
= current_buffer
;
18886 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18887 ptrdiff_t arrow_len
= SCHARS (overlay_arrow_string
);
18888 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18889 const unsigned char *p
;
18892 int n_glyphs_before
;
18894 set_buffer_temp (buffer
);
18895 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18896 scratch_glyph_row
.reversed_p
= false;
18897 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18898 SET_TEXT_POS (it
.position
, 0, 0);
18900 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18902 while (p
< arrow_end
)
18904 Lisp_Object face
, ilisp
;
18906 /* Get the next character. */
18908 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18911 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18912 if (! ASCII_CHAR_P (it
.c
))
18913 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18917 /* Get its face. */
18918 ilisp
= make_number (p
- arrow_string
);
18919 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18920 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18922 /* Compute its width, get its glyphs. */
18923 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18924 SET_TEXT_POS (it
.position
, -1, -1);
18925 PRODUCE_GLYPHS (&it
);
18927 /* If this character doesn't fit any more in the line, we have
18928 to remove some glyphs. */
18929 if (it
.current_x
> it
.last_visible_x
)
18931 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18936 set_buffer_temp (old
);
18937 return it
.glyph_row
;
18941 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18942 glyphs to insert is determined by produce_special_glyphs. */
18945 insert_left_trunc_glyphs (struct it
*it
)
18947 struct it truncate_it
;
18948 struct glyph
*from
, *end
, *to
, *toend
;
18950 eassert (!FRAME_WINDOW_P (it
->f
)
18951 || (!it
->glyph_row
->reversed_p
18952 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18953 || (it
->glyph_row
->reversed_p
18954 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18956 /* Get the truncation glyphs. */
18958 truncate_it
.current_x
= 0;
18959 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18960 truncate_it
.glyph_row
= &scratch_glyph_row
;
18961 truncate_it
.area
= TEXT_AREA
;
18962 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18963 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18964 truncate_it
.object
= Qnil
;
18965 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18967 /* Overwrite glyphs from IT with truncation glyphs. */
18968 if (!it
->glyph_row
->reversed_p
)
18970 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18972 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18973 end
= from
+ tused
;
18974 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18975 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18976 if (FRAME_WINDOW_P (it
->f
))
18978 /* On GUI frames, when variable-size fonts are displayed,
18979 the truncation glyphs may need more pixels than the row's
18980 glyphs they overwrite. We overwrite more glyphs to free
18981 enough screen real estate, and enlarge the stretch glyph
18982 on the right (see display_line), if there is one, to
18983 preserve the screen position of the truncation glyphs on
18986 struct glyph
*g
= to
;
18989 /* The first glyph could be partially visible, in which case
18990 it->glyph_row->x will be negative. But we want the left
18991 truncation glyphs to be aligned at the left margin of the
18992 window, so we override the x coordinate at which the row
18994 it
->glyph_row
->x
= 0;
18995 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18997 w
+= g
->pixel_width
;
19000 if (g
- to
- tused
> 0)
19002 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
19003 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
19005 used
= it
->glyph_row
->used
[TEXT_AREA
];
19006 if (it
->glyph_row
->truncated_on_right_p
19007 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
19008 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
19011 int extra
= w
- it
->truncation_pixel_width
;
19013 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
19020 /* There may be padding glyphs left over. Overwrite them too. */
19021 if (!FRAME_WINDOW_P (it
->f
))
19023 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
19025 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19032 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
19036 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19038 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19039 that back to front. */
19040 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19041 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19042 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19043 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19044 if (FRAME_WINDOW_P (it
->f
))
19047 struct glyph
*g
= to
;
19049 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19051 w
+= g
->pixel_width
;
19054 if (to
- g
- tused
> 0)
19056 if (it
->glyph_row
->truncated_on_right_p
19057 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19058 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19060 int extra
= w
- it
->truncation_pixel_width
;
19062 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19066 while (from
>= end
&& to
>= toend
)
19068 if (!FRAME_WINDOW_P (it
->f
))
19070 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19073 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19074 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19075 while (from
>= end
&& to
>= toend
)
19081 /* Need to free some room before prepending additional
19083 int move_by
= from
- end
+ 1;
19084 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19085 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19087 for ( ; g
>= g0
; g
--)
19089 while (from
>= end
)
19091 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19096 /* Compute the hash code for ROW. */
19098 row_hash (struct glyph_row
*row
)
19101 unsigned hashval
= 0;
19103 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19104 for (k
= 0; k
< row
->used
[area
]; ++k
)
19105 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19106 + row
->glyphs
[area
][k
].u
.val
19107 + row
->glyphs
[area
][k
].face_id
19108 + row
->glyphs
[area
][k
].padding_p
19109 + (row
->glyphs
[area
][k
].type
<< 2));
19114 /* Compute the pixel height and width of IT->glyph_row.
19116 Most of the time, ascent and height of a display line will be equal
19117 to the max_ascent and max_height values of the display iterator
19118 structure. This is not the case if
19120 1. We hit ZV without displaying anything. In this case, max_ascent
19121 and max_height will be zero.
19123 2. We have some glyphs that don't contribute to the line height.
19124 (The glyph row flag contributes_to_line_height_p is for future
19125 pixmap extensions).
19127 The first case is easily covered by using default values because in
19128 these cases, the line height does not really matter, except that it
19129 must not be zero. */
19132 compute_line_metrics (struct it
*it
)
19134 struct glyph_row
*row
= it
->glyph_row
;
19136 if (FRAME_WINDOW_P (it
->f
))
19138 int i
, min_y
, max_y
;
19140 /* The line may consist of one space only, that was added to
19141 place the cursor on it. If so, the row's height hasn't been
19143 if (row
->height
== 0)
19145 if (it
->max_ascent
+ it
->max_descent
== 0)
19146 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19147 row
->ascent
= it
->max_ascent
;
19148 row
->height
= it
->max_ascent
+ it
->max_descent
;
19149 row
->phys_ascent
= it
->max_phys_ascent
;
19150 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19151 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19154 /* Compute the width of this line. */
19155 row
->pixel_width
= row
->x
;
19156 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19157 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19159 eassert (row
->pixel_width
>= 0);
19160 eassert (row
->ascent
>= 0 && row
->height
> 0);
19162 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19163 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19165 /* If first line's physical ascent is larger than its logical
19166 ascent, use the physical ascent, and make the row taller.
19167 This makes accented characters fully visible. */
19168 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19169 && row
->phys_ascent
> row
->ascent
)
19171 row
->height
+= row
->phys_ascent
- row
->ascent
;
19172 row
->ascent
= row
->phys_ascent
;
19175 /* Compute how much of the line is visible. */
19176 row
->visible_height
= row
->height
;
19178 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19179 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19181 if (row
->y
< min_y
)
19182 row
->visible_height
-= min_y
- row
->y
;
19183 if (row
->y
+ row
->height
> max_y
)
19184 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19188 row
->pixel_width
= row
->used
[TEXT_AREA
];
19189 if (row
->continued_p
)
19190 row
->pixel_width
-= it
->continuation_pixel_width
;
19191 else if (row
->truncated_on_right_p
)
19192 row
->pixel_width
-= it
->truncation_pixel_width
;
19193 row
->ascent
= row
->phys_ascent
= 0;
19194 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19195 row
->extra_line_spacing
= 0;
19198 /* Compute a hash code for this row. */
19199 row
->hash
= row_hash (row
);
19201 it
->max_ascent
= it
->max_descent
= 0;
19202 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19206 /* Append one space to the glyph row of iterator IT if doing a
19207 window-based redisplay. The space has the same face as
19208 IT->face_id. Value is true if a space was added.
19210 This function is called to make sure that there is always one glyph
19211 at the end of a glyph row that the cursor can be set on under
19212 window-systems. (If there weren't such a glyph we would not know
19213 how wide and tall a box cursor should be displayed).
19215 At the same time this space let's a nicely handle clearing to the
19216 end of the line if the row ends in italic text. */
19219 append_space_for_newline (struct it
*it
, bool default_face_p
)
19221 if (FRAME_WINDOW_P (it
->f
))
19223 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19225 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19226 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19228 /* Save some values that must not be changed.
19229 Must save IT->c and IT->len because otherwise
19230 ITERATOR_AT_END_P wouldn't work anymore after
19231 append_space_for_newline has been called. */
19232 enum display_element_type saved_what
= it
->what
;
19233 int saved_c
= it
->c
, saved_len
= it
->len
;
19234 int saved_char_to_display
= it
->char_to_display
;
19235 int saved_x
= it
->current_x
;
19236 int saved_face_id
= it
->face_id
;
19237 bool saved_box_end
= it
->end_of_box_run_p
;
19238 struct text_pos saved_pos
;
19239 Lisp_Object saved_object
;
19243 saved_object
= it
->object
;
19244 saved_pos
= it
->position
;
19246 it
->what
= IT_CHARACTER
;
19247 memset (&it
->position
, 0, sizeof it
->position
);
19249 it
->c
= it
->char_to_display
= ' ';
19252 /* If the default face was remapped, be sure to use the
19253 remapped face for the appended newline. */
19254 if (default_face_p
)
19255 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19256 else if (it
->face_before_selective_p
)
19257 it
->face_id
= it
->saved_face_id
;
19258 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19259 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19260 /* In R2L rows, we will prepend a stretch glyph that will
19261 have the end_of_box_run_p flag set for it, so there's no
19262 need for the appended newline glyph to have that flag
19264 if (it
->glyph_row
->reversed_p
19265 /* But if the appended newline glyph goes all the way to
19266 the end of the row, there will be no stretch glyph,
19267 so leave the box flag set. */
19268 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19269 it
->end_of_box_run_p
= false;
19271 PRODUCE_GLYPHS (it
);
19273 #ifdef HAVE_WINDOW_SYSTEM
19274 /* Make sure this space glyph has the right ascent and
19275 descent values, or else cursor at end of line will look
19276 funny, and height of empty lines will be incorrect. */
19277 g
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19278 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
19281 Lisp_Object height
, total_height
;
19282 int extra_line_spacing
= it
->extra_line_spacing
;
19283 int boff
= font
->baseline_offset
;
19285 if (font
->vertical_centering
)
19286 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
19288 it
->object
= saved_object
; /* get_it_property needs this */
19289 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
19290 /* Must do a subset of line height processing from
19291 x_produce_glyph for newline characters. */
19292 height
= get_it_property (it
, Qline_height
);
19294 && CONSP (XCDR (height
))
19295 && NILP (XCDR (XCDR (height
))))
19297 total_height
= XCAR (XCDR (height
));
19298 height
= XCAR (height
);
19301 total_height
= Qnil
;
19302 height
= calc_line_height_property (it
, height
, font
, boff
, true);
19304 if (it
->override_ascent
>= 0)
19306 it
->ascent
= it
->override_ascent
;
19307 it
->descent
= it
->override_descent
;
19308 boff
= it
->override_boff
;
19310 if (EQ (height
, Qt
))
19311 extra_line_spacing
= 0;
19314 Lisp_Object spacing
;
19316 it
->phys_ascent
= it
->ascent
;
19317 it
->phys_descent
= it
->descent
;
19319 && XINT (height
) > it
->ascent
+ it
->descent
)
19320 it
->ascent
= XINT (height
) - it
->descent
;
19322 if (!NILP (total_height
))
19323 spacing
= calc_line_height_property (it
, total_height
, font
,
19327 spacing
= get_it_property (it
, Qline_spacing
);
19328 spacing
= calc_line_height_property (it
, spacing
, font
,
19331 if (INTEGERP (spacing
))
19333 extra_line_spacing
= XINT (spacing
);
19334 if (!NILP (total_height
))
19335 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
19338 if (extra_line_spacing
> 0)
19340 it
->descent
+= extra_line_spacing
;
19341 if (extra_line_spacing
> it
->max_extra_line_spacing
)
19342 it
->max_extra_line_spacing
= extra_line_spacing
;
19344 it
->max_ascent
= it
->ascent
;
19345 it
->max_descent
= it
->descent
;
19346 /* Make sure compute_line_metrics recomputes the row height. */
19347 it
->glyph_row
->height
= 0;
19350 g
->ascent
= it
->max_ascent
;
19351 g
->descent
= it
->max_descent
;
19354 it
->override_ascent
= -1;
19355 it
->constrain_row_ascent_descent_p
= false;
19356 it
->current_x
= saved_x
;
19357 it
->object
= saved_object
;
19358 it
->position
= saved_pos
;
19359 it
->what
= saved_what
;
19360 it
->face_id
= saved_face_id
;
19361 it
->len
= saved_len
;
19363 it
->char_to_display
= saved_char_to_display
;
19364 it
->end_of_box_run_p
= saved_box_end
;
19373 /* Extend the face of the last glyph in the text area of IT->glyph_row
19374 to the end of the display line. Called from display_line. If the
19375 glyph row is empty, add a space glyph to it so that we know the
19376 face to draw. Set the glyph row flag fill_line_p. If the glyph
19377 row is R2L, prepend a stretch glyph to cover the empty space to the
19378 left of the leftmost glyph. */
19381 extend_face_to_end_of_line (struct it
*it
)
19383 struct face
*face
, *default_face
;
19384 struct frame
*f
= it
->f
;
19386 /* If line is already filled, do nothing. Non window-system frames
19387 get a grace of one more ``pixel'' because their characters are
19388 1-``pixel'' wide, so they hit the equality too early. This grace
19389 is needed only for R2L rows that are not continued, to produce
19390 one extra blank where we could display the cursor. */
19391 if ((it
->current_x
>= it
->last_visible_x
19392 + (!FRAME_WINDOW_P (f
)
19393 && it
->glyph_row
->reversed_p
19394 && !it
->glyph_row
->continued_p
))
19395 /* If the window has display margins, we will need to extend
19396 their face even if the text area is filled. */
19397 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19398 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19401 /* The default face, possibly remapped. */
19402 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19404 /* Face extension extends the background and box of IT->face_id
19405 to the end of the line. If the background equals the background
19406 of the frame, we don't have to do anything. */
19407 if (it
->face_before_selective_p
)
19408 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19410 face
= FACE_FROM_ID (f
, it
->face_id
);
19412 if (FRAME_WINDOW_P (f
)
19413 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19414 && face
->box
== FACE_NO_BOX
19415 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19416 #ifdef HAVE_WINDOW_SYSTEM
19419 && !it
->glyph_row
->reversed_p
)
19422 /* Set the glyph row flag indicating that the face of the last glyph
19423 in the text area has to be drawn to the end of the text area. */
19424 it
->glyph_row
->fill_line_p
= true;
19426 /* If current character of IT is not ASCII, make sure we have the
19427 ASCII face. This will be automatically undone the next time
19428 get_next_display_element returns a multibyte character. Note
19429 that the character will always be single byte in unibyte
19431 if (!ASCII_CHAR_P (it
->c
))
19433 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19436 if (FRAME_WINDOW_P (f
))
19438 /* If the row is empty, add a space with the current face of IT,
19439 so that we know which face to draw. */
19440 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19442 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19443 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19444 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19446 /* Mode line and the header line don't have margins, and
19447 likewise the frame's tool-bar window, if there is any. */
19448 if (!(it
->glyph_row
->mode_line_p
19449 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19450 || (WINDOWP (f
->tool_bar_window
)
19451 && it
->w
== XWINDOW (f
->tool_bar_window
))
19455 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19456 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19458 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19459 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19461 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19463 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19464 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19466 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19467 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19469 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19472 #ifdef HAVE_WINDOW_SYSTEM
19473 if (it
->glyph_row
->reversed_p
)
19475 /* Prepend a stretch glyph to the row, such that the
19476 rightmost glyph will be drawn flushed all the way to the
19477 right margin of the window. The stretch glyph that will
19478 occupy the empty space, if any, to the left of the
19480 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19481 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19482 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19484 int row_width
, stretch_ascent
, stretch_width
;
19485 struct text_pos saved_pos
;
19487 bool saved_avoid_cursor
, saved_box_start
;
19489 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19490 row_width
+= g
->pixel_width
;
19492 /* FIXME: There are various minor display glitches in R2L
19493 rows when only one of the fringes is missing. The
19494 strange condition below produces the least bad effect. */
19495 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19496 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19497 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19498 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19500 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19501 stretch_width
-= row_width
;
19503 if (stretch_width
> 0)
19506 (((it
->ascent
+ it
->descent
)
19507 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19508 saved_pos
= it
->position
;
19509 memset (&it
->position
, 0, sizeof it
->position
);
19510 saved_avoid_cursor
= it
->avoid_cursor_p
;
19511 it
->avoid_cursor_p
= true;
19512 saved_face_id
= it
->face_id
;
19513 saved_box_start
= it
->start_of_box_run_p
;
19514 /* The last row's stretch glyph should get the default
19515 face, to avoid painting the rest of the window with
19516 the region face, if the region ends at ZV. */
19517 if (it
->glyph_row
->ends_at_zv_p
)
19518 it
->face_id
= default_face
->id
;
19520 it
->face_id
= face
->id
;
19521 it
->start_of_box_run_p
= false;
19522 append_stretch_glyph (it
, Qnil
, stretch_width
,
19523 it
->ascent
+ it
->descent
, stretch_ascent
);
19524 it
->position
= saved_pos
;
19525 it
->avoid_cursor_p
= saved_avoid_cursor
;
19526 it
->face_id
= saved_face_id
;
19527 it
->start_of_box_run_p
= saved_box_start
;
19529 /* If stretch_width comes out negative, it means that the
19530 last glyph is only partially visible. In R2L rows, we
19531 want the leftmost glyph to be partially visible, so we
19532 need to give the row the corresponding left offset. */
19533 if (stretch_width
< 0)
19534 it
->glyph_row
->x
= stretch_width
;
19536 #endif /* HAVE_WINDOW_SYSTEM */
19540 /* Save some values that must not be changed. */
19541 int saved_x
= it
->current_x
;
19542 struct text_pos saved_pos
;
19543 Lisp_Object saved_object
;
19544 enum display_element_type saved_what
= it
->what
;
19545 int saved_face_id
= it
->face_id
;
19547 saved_object
= it
->object
;
19548 saved_pos
= it
->position
;
19550 it
->what
= IT_CHARACTER
;
19551 memset (&it
->position
, 0, sizeof it
->position
);
19553 it
->c
= it
->char_to_display
= ' ';
19556 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19557 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19558 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19559 && !it
->glyph_row
->mode_line_p
19560 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19562 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19563 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19565 for (it
->current_x
= 0; g
< e
; g
++)
19566 it
->current_x
+= g
->pixel_width
;
19568 it
->area
= LEFT_MARGIN_AREA
;
19569 it
->face_id
= default_face
->id
;
19570 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19571 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19573 PRODUCE_GLYPHS (it
);
19574 /* term.c:produce_glyphs advances it->current_x only for
19576 it
->current_x
+= it
->pixel_width
;
19579 it
->current_x
= saved_x
;
19580 it
->area
= TEXT_AREA
;
19583 /* The last row's blank glyphs should get the default face, to
19584 avoid painting the rest of the window with the region face,
19585 if the region ends at ZV. */
19586 if (it
->glyph_row
->ends_at_zv_p
)
19587 it
->face_id
= default_face
->id
;
19589 it
->face_id
= face
->id
;
19590 PRODUCE_GLYPHS (it
);
19592 while (it
->current_x
<= it
->last_visible_x
)
19593 PRODUCE_GLYPHS (it
);
19595 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19596 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19597 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19598 && !it
->glyph_row
->mode_line_p
19599 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19601 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19602 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19604 for ( ; g
< e
; g
++)
19605 it
->current_x
+= g
->pixel_width
;
19607 it
->area
= RIGHT_MARGIN_AREA
;
19608 it
->face_id
= default_face
->id
;
19609 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19610 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19612 PRODUCE_GLYPHS (it
);
19613 it
->current_x
+= it
->pixel_width
;
19616 it
->area
= TEXT_AREA
;
19619 /* Don't count these blanks really. It would let us insert a left
19620 truncation glyph below and make us set the cursor on them, maybe. */
19621 it
->current_x
= saved_x
;
19622 it
->object
= saved_object
;
19623 it
->position
= saved_pos
;
19624 it
->what
= saved_what
;
19625 it
->face_id
= saved_face_id
;
19630 /* Value is true if text starting at CHARPOS in current_buffer is
19631 trailing whitespace. */
19634 trailing_whitespace_p (ptrdiff_t charpos
)
19636 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19639 while (bytepos
< ZV_BYTE
19640 && (c
= FETCH_CHAR (bytepos
),
19641 c
== ' ' || c
== '\t'))
19644 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19646 if (bytepos
!= PT_BYTE
)
19653 /* Highlight trailing whitespace, if any, in ROW. */
19656 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19658 int used
= row
->used
[TEXT_AREA
];
19662 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19663 struct glyph
*glyph
= start
+ used
- 1;
19665 if (row
->reversed_p
)
19667 /* Right-to-left rows need to be processed in the opposite
19668 direction, so swap the edge pointers. */
19670 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19673 /* Skip over glyphs inserted to display the cursor at the
19674 end of a line, for extending the face of the last glyph
19675 to the end of the line on terminals, and for truncation
19676 and continuation glyphs. */
19677 if (!row
->reversed_p
)
19679 while (glyph
>= start
19680 && glyph
->type
== CHAR_GLYPH
19681 && NILP (glyph
->object
))
19686 while (glyph
<= start
19687 && glyph
->type
== CHAR_GLYPH
19688 && NILP (glyph
->object
))
19692 /* If last glyph is a space or stretch, and it's trailing
19693 whitespace, set the face of all trailing whitespace glyphs in
19694 IT->glyph_row to `trailing-whitespace'. */
19695 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19696 && BUFFERP (glyph
->object
)
19697 && (glyph
->type
== STRETCH_GLYPH
19698 || (glyph
->type
== CHAR_GLYPH
19699 && glyph
->u
.ch
== ' '))
19700 && trailing_whitespace_p (glyph
->charpos
))
19702 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, false);
19706 if (!row
->reversed_p
)
19708 while (glyph
>= start
19709 && BUFFERP (glyph
->object
)
19710 && (glyph
->type
== STRETCH_GLYPH
19711 || (glyph
->type
== CHAR_GLYPH
19712 && glyph
->u
.ch
== ' ')))
19713 (glyph
--)->face_id
= face_id
;
19717 while (glyph
<= start
19718 && BUFFERP (glyph
->object
)
19719 && (glyph
->type
== STRETCH_GLYPH
19720 || (glyph
->type
== CHAR_GLYPH
19721 && glyph
->u
.ch
== ' ')))
19722 (glyph
++)->face_id
= face_id
;
19729 /* Value is true if glyph row ROW should be
19730 considered to hold the buffer position CHARPOS. */
19733 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19735 bool result
= true;
19737 if (charpos
== CHARPOS (row
->end
.pos
)
19738 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19740 /* Suppose the row ends on a string.
19741 Unless the row is continued, that means it ends on a newline
19742 in the string. If it's anything other than a display string
19743 (e.g., a before-string from an overlay), we don't want the
19744 cursor there. (This heuristic seems to give the optimal
19745 behavior for the various types of multi-line strings.)
19746 One exception: if the string has `cursor' property on one of
19747 its characters, we _do_ want the cursor there. */
19748 if (CHARPOS (row
->end
.string_pos
) >= 0)
19750 if (row
->continued_p
)
19754 /* Check for `display' property. */
19755 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19756 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19757 struct glyph
*glyph
;
19760 for (glyph
= end
; glyph
>= beg
; --glyph
)
19761 if (STRINGP (glyph
->object
))
19764 = Fget_char_property (make_number (charpos
),
19768 && display_prop_string_p (prop
, glyph
->object
));
19769 /* If there's a `cursor' property on one of the
19770 string's characters, this row is a cursor row,
19771 even though this is not a display string. */
19774 Lisp_Object s
= glyph
->object
;
19776 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19778 ptrdiff_t gpos
= glyph
->charpos
;
19780 if (!NILP (Fget_char_property (make_number (gpos
),
19792 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19794 /* If the row ends in middle of a real character,
19795 and the line is continued, we want the cursor here.
19796 That's because CHARPOS (ROW->end.pos) would equal
19797 PT if PT is before the character. */
19798 if (!row
->ends_in_ellipsis_p
)
19799 result
= row
->continued_p
;
19801 /* If the row ends in an ellipsis, then
19802 CHARPOS (ROW->end.pos) will equal point after the
19803 invisible text. We want that position to be displayed
19804 after the ellipsis. */
19807 /* If the row ends at ZV, display the cursor at the end of that
19808 row instead of at the start of the row below. */
19810 result
= row
->ends_at_zv_p
;
19816 /* Value is true if glyph row ROW should be
19817 used to hold the cursor. */
19820 cursor_row_p (struct glyph_row
*row
)
19822 return row_for_charpos_p (row
, PT
);
19827 /* Push the property PROP so that it will be rendered at the current
19828 position in IT. Return true if PROP was successfully pushed, false
19829 otherwise. Called from handle_line_prefix to handle the
19830 `line-prefix' and `wrap-prefix' properties. */
19833 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19835 struct text_pos pos
=
19836 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19838 eassert (it
->method
== GET_FROM_BUFFER
19839 || it
->method
== GET_FROM_DISPLAY_VECTOR
19840 || it
->method
== GET_FROM_STRING
19841 || it
->method
== GET_FROM_IMAGE
);
19843 /* We need to save the current buffer/string position, so it will be
19844 restored by pop_it, because iterate_out_of_display_property
19845 depends on that being set correctly, but some situations leave
19846 it->position not yet set when this function is called. */
19847 push_it (it
, &pos
);
19849 if (STRINGP (prop
))
19851 if (SCHARS (prop
) == 0)
19858 it
->string_from_prefix_prop_p
= true;
19859 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19860 it
->current
.overlay_string_index
= -1;
19861 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19862 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19863 it
->method
= GET_FROM_STRING
;
19864 it
->stop_charpos
= 0;
19866 it
->base_level_stop
= 0;
19868 /* Force paragraph direction to be that of the parent
19870 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19871 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19873 it
->paragraph_embedding
= L2R
;
19875 /* Set up the bidi iterator for this display string. */
19878 it
->bidi_it
.string
.lstring
= it
->string
;
19879 it
->bidi_it
.string
.s
= NULL
;
19880 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19881 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19882 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19883 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19884 it
->bidi_it
.w
= it
->w
;
19885 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19888 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19890 it
->method
= GET_FROM_STRETCH
;
19893 #ifdef HAVE_WINDOW_SYSTEM
19894 else if (IMAGEP (prop
))
19896 it
->what
= IT_IMAGE
;
19897 it
->image_id
= lookup_image (it
->f
, prop
);
19898 it
->method
= GET_FROM_IMAGE
;
19900 #endif /* HAVE_WINDOW_SYSTEM */
19903 pop_it (it
); /* bogus display property, give up */
19910 /* Return the character-property PROP at the current position in IT. */
19913 get_it_property (struct it
*it
, Lisp_Object prop
)
19915 Lisp_Object position
, object
= it
->object
;
19917 if (STRINGP (object
))
19918 position
= make_number (IT_STRING_CHARPOS (*it
));
19919 else if (BUFFERP (object
))
19921 position
= make_number (IT_CHARPOS (*it
));
19922 object
= it
->window
;
19927 return Fget_char_property (position
, prop
, object
);
19930 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19933 handle_line_prefix (struct it
*it
)
19935 Lisp_Object prefix
;
19937 if (it
->continuation_lines_width
> 0)
19939 prefix
= get_it_property (it
, Qwrap_prefix
);
19941 prefix
= Vwrap_prefix
;
19945 prefix
= get_it_property (it
, Qline_prefix
);
19947 prefix
= Vline_prefix
;
19949 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19951 /* If the prefix is wider than the window, and we try to wrap
19952 it, it would acquire its own wrap prefix, and so on till the
19953 iterator stack overflows. So, don't wrap the prefix. */
19954 it
->line_wrap
= TRUNCATE
;
19955 it
->avoid_cursor_p
= true;
19961 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19962 only for R2L lines from display_line and display_string, when they
19963 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19964 the line/string needs to be continued on the next glyph row. */
19966 unproduce_glyphs (struct it
*it
, int n
)
19968 struct glyph
*glyph
, *end
;
19970 eassert (it
->glyph_row
);
19971 eassert (it
->glyph_row
->reversed_p
);
19972 eassert (it
->area
== TEXT_AREA
);
19973 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19975 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19976 n
= it
->glyph_row
->used
[TEXT_AREA
];
19977 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19978 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19979 for ( ; glyph
< end
; glyph
++)
19980 glyph
[-n
] = *glyph
;
19983 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19984 and ROW->maxpos. */
19986 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19987 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19988 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19990 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19991 lines' rows is implemented for bidi-reordered rows. */
19993 /* ROW->minpos is the value of min_pos, the minimal buffer position
19994 we have in ROW, or ROW->start.pos if that is smaller. */
19995 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19996 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19998 /* We didn't find buffer positions smaller than ROW->start, or
19999 didn't find _any_ valid buffer positions in any of the glyphs,
20000 so we must trust the iterator's computed positions. */
20001 row
->minpos
= row
->start
.pos
;
20004 max_pos
= CHARPOS (it
->current
.pos
);
20005 max_bpos
= BYTEPOS (it
->current
.pos
);
20008 /* Here are the various use-cases for ending the row, and the
20009 corresponding values for ROW->maxpos:
20011 Line ends in a newline from buffer eol_pos + 1
20012 Line is continued from buffer max_pos + 1
20013 Line is truncated on right it->current.pos
20014 Line ends in a newline from string max_pos + 1(*)
20015 (*) + 1 only when line ends in a forward scan
20016 Line is continued from string max_pos
20017 Line is continued from display vector max_pos
20018 Line is entirely from a string min_pos == max_pos
20019 Line is entirely from a display vector min_pos == max_pos
20020 Line that ends at ZV ZV
20022 If you discover other use-cases, please add them here as
20024 if (row
->ends_at_zv_p
)
20025 row
->maxpos
= it
->current
.pos
;
20026 else if (row
->used
[TEXT_AREA
])
20028 bool seen_this_string
= false;
20029 struct glyph_row
*r1
= row
- 1;
20031 /* Did we see the same display string on the previous row? */
20032 if (STRINGP (it
->object
)
20033 /* this is not the first row */
20034 && row
> it
->w
->desired_matrix
->rows
20035 /* previous row is not the header line */
20036 && !r1
->mode_line_p
20037 /* previous row also ends in a newline from a string */
20038 && r1
->ends_in_newline_from_string_p
)
20040 struct glyph
*start
, *end
;
20042 /* Search for the last glyph of the previous row that came
20043 from buffer or string. Depending on whether the row is
20044 L2R or R2L, we need to process it front to back or the
20045 other way round. */
20046 if (!r1
->reversed_p
)
20048 start
= r1
->glyphs
[TEXT_AREA
];
20049 end
= start
+ r1
->used
[TEXT_AREA
];
20050 /* Glyphs inserted by redisplay have nil as their object. */
20052 && NILP ((end
- 1)->object
)
20053 && (end
- 1)->charpos
<= 0)
20057 if (EQ ((end
- 1)->object
, it
->object
))
20058 seen_this_string
= true;
20061 /* If all the glyphs of the previous row were inserted
20062 by redisplay, it means the previous row was
20063 produced from a single newline, which is only
20064 possible if that newline came from the same string
20065 as the one which produced this ROW. */
20066 seen_this_string
= true;
20070 end
= r1
->glyphs
[TEXT_AREA
] - 1;
20071 start
= end
+ r1
->used
[TEXT_AREA
];
20073 && NILP ((end
+ 1)->object
)
20074 && (end
+ 1)->charpos
<= 0)
20078 if (EQ ((end
+ 1)->object
, it
->object
))
20079 seen_this_string
= true;
20082 seen_this_string
= true;
20085 /* Take note of each display string that covers a newline only
20086 once, the first time we see it. This is for when a display
20087 string includes more than one newline in it. */
20088 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
20090 /* If we were scanning the buffer forward when we displayed
20091 the string, we want to account for at least one buffer
20092 position that belongs to this row (position covered by
20093 the display string), so that cursor positioning will
20094 consider this row as a candidate when point is at the end
20095 of the visual line represented by this row. This is not
20096 required when scanning back, because max_pos will already
20097 have a much larger value. */
20098 if (CHARPOS (row
->end
.pos
) > max_pos
)
20099 INC_BOTH (max_pos
, max_bpos
);
20100 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20102 else if (CHARPOS (it
->eol_pos
) > 0)
20103 SET_TEXT_POS (row
->maxpos
,
20104 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
20105 else if (row
->continued_p
)
20107 /* If max_pos is different from IT's current position, it
20108 means IT->method does not belong to the display element
20109 at max_pos. However, it also means that the display
20110 element at max_pos was displayed in its entirety on this
20111 line, which is equivalent to saying that the next line
20112 starts at the next buffer position. */
20113 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
20114 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20117 INC_BOTH (max_pos
, max_bpos
);
20118 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20121 else if (row
->truncated_on_right_p
)
20122 /* display_line already called reseat_at_next_visible_line_start,
20123 which puts the iterator at the beginning of the next line, in
20124 the logical order. */
20125 row
->maxpos
= it
->current
.pos
;
20126 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20127 /* A line that is entirely from a string/image/stretch... */
20128 row
->maxpos
= row
->minpos
;
20133 row
->maxpos
= it
->current
.pos
;
20136 /* Construct the glyph row IT->glyph_row in the desired matrix of
20137 IT->w from text at the current position of IT. See dispextern.h
20138 for an overview of struct it. Value is true if
20139 IT->glyph_row displays text, as opposed to a line displaying ZV
20143 display_line (struct it
*it
)
20145 struct glyph_row
*row
= it
->glyph_row
;
20146 Lisp_Object overlay_arrow_string
;
20148 void *wrap_data
= NULL
;
20149 bool may_wrap
= false;
20150 int wrap_x
IF_LINT (= 0);
20151 int wrap_row_used
= -1;
20152 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
20153 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
20154 int wrap_row_extra_line_spacing
IF_LINT (= 0);
20155 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
20156 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
20158 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20159 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
20160 bool pending_handle_line_prefix
= false;
20162 /* We always start displaying at hpos zero even if hscrolled. */
20163 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20165 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20166 >= it
->w
->desired_matrix
->nrows
)
20168 it
->w
->nrows_scale_factor
++;
20169 it
->f
->fonts_changed
= true;
20173 /* Clear the result glyph row and enable it. */
20174 prepare_desired_row (it
->w
, row
, false);
20176 row
->y
= it
->current_y
;
20177 row
->start
= it
->start
;
20178 row
->continuation_lines_width
= it
->continuation_lines_width
;
20179 row
->displays_text_p
= true;
20180 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20181 it
->starts_in_middle_of_char_p
= false;
20183 /* Arrange the overlays nicely for our purposes. Usually, we call
20184 display_line on only one line at a time, in which case this
20185 can't really hurt too much, or we call it on lines which appear
20186 one after another in the buffer, in which case all calls to
20187 recenter_overlay_lists but the first will be pretty cheap. */
20188 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20190 /* Move over display elements that are not visible because we are
20191 hscrolled. This may stop at an x-position < IT->first_visible_x
20192 if the first glyph is partially visible or if we hit a line end. */
20193 if (it
->current_x
< it
->first_visible_x
)
20195 enum move_it_result move_result
;
20197 this_line_min_pos
= row
->start
.pos
;
20198 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20199 MOVE_TO_POS
| MOVE_TO_X
);
20200 /* If we are under a large hscroll, move_it_in_display_line_to
20201 could hit the end of the line without reaching
20202 it->first_visible_x. Pretend that we did reach it. This is
20203 especially important on a TTY, where we will call
20204 extend_face_to_end_of_line, which needs to know how many
20205 blank glyphs to produce. */
20206 if (it
->current_x
< it
->first_visible_x
20207 && (move_result
== MOVE_NEWLINE_OR_CR
20208 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20209 it
->current_x
= it
->first_visible_x
;
20211 /* Record the smallest positions seen while we moved over
20212 display elements that are not visible. This is needed by
20213 redisplay_internal for optimizing the case where the cursor
20214 stays inside the same line. The rest of this function only
20215 considers positions that are actually displayed, so
20216 RECORD_MAX_MIN_POS will not otherwise record positions that
20217 are hscrolled to the left of the left edge of the window. */
20218 min_pos
= CHARPOS (this_line_min_pos
);
20219 min_bpos
= BYTEPOS (this_line_min_pos
);
20221 else if (it
->area
== TEXT_AREA
)
20223 /* We only do this when not calling move_it_in_display_line_to
20224 above, because that function calls itself handle_line_prefix. */
20225 handle_line_prefix (it
);
20229 /* Line-prefix and wrap-prefix are always displayed in the text
20230 area. But if this is the first call to display_line after
20231 init_iterator, the iterator might have been set up to write
20232 into a marginal area, e.g. if the line begins with some
20233 display property that writes to the margins. So we need to
20234 wait with the call to handle_line_prefix until whatever
20235 writes to the margin has done its job. */
20236 pending_handle_line_prefix
= true;
20239 /* Get the initial row height. This is either the height of the
20240 text hscrolled, if there is any, or zero. */
20241 row
->ascent
= it
->max_ascent
;
20242 row
->height
= it
->max_ascent
+ it
->max_descent
;
20243 row
->phys_ascent
= it
->max_phys_ascent
;
20244 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20245 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20247 /* Utility macro to record max and min buffer positions seen until now. */
20248 #define RECORD_MAX_MIN_POS(IT) \
20251 bool composition_p \
20252 = !STRINGP ((IT)->string) && ((IT)->what == IT_COMPOSITION); \
20253 ptrdiff_t current_pos = \
20254 composition_p ? (IT)->cmp_it.charpos \
20255 : IT_CHARPOS (*(IT)); \
20256 ptrdiff_t current_bpos = \
20257 composition_p ? CHAR_TO_BYTE (current_pos) \
20258 : IT_BYTEPOS (*(IT)); \
20259 if (current_pos < min_pos) \
20261 min_pos = current_pos; \
20262 min_bpos = current_bpos; \
20264 if (IT_CHARPOS (*it) > max_pos) \
20266 max_pos = IT_CHARPOS (*it); \
20267 max_bpos = IT_BYTEPOS (*it); \
20272 /* Loop generating characters. The loop is left with IT on the next
20273 character to display. */
20276 int n_glyphs_before
, hpos_before
, x_before
;
20278 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20280 /* Retrieve the next thing to display. Value is false if end of
20282 if (!get_next_display_element (it
))
20284 /* Maybe add a space at the end of this line that is used to
20285 display the cursor there under X. Set the charpos of the
20286 first glyph of blank lines not corresponding to any text
20288 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20289 row
->exact_window_width_line_p
= true;
20290 else if ((append_space_for_newline (it
, true)
20291 && row
->used
[TEXT_AREA
] == 1)
20292 || row
->used
[TEXT_AREA
] == 0)
20294 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20295 row
->displays_text_p
= false;
20297 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20298 && (!MINI_WINDOW_P (it
->w
)
20299 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20300 row
->indicate_empty_line_p
= true;
20303 it
->continuation_lines_width
= 0;
20304 row
->ends_at_zv_p
= true;
20305 /* A row that displays right-to-left text must always have
20306 its last face extended all the way to the end of line,
20307 even if this row ends in ZV, because we still write to
20308 the screen left to right. We also need to extend the
20309 last face if the default face is remapped to some
20310 different face, otherwise the functions that clear
20311 portions of the screen will clear with the default face's
20312 background color. */
20313 if (row
->reversed_p
20314 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20315 extend_face_to_end_of_line (it
);
20319 /* Now, get the metrics of what we want to display. This also
20320 generates glyphs in `row' (which is IT->glyph_row). */
20321 n_glyphs_before
= row
->used
[TEXT_AREA
];
20324 /* Remember the line height so far in case the next element doesn't
20325 fit on the line. */
20326 if (it
->line_wrap
!= TRUNCATE
)
20328 ascent
= it
->max_ascent
;
20329 descent
= it
->max_descent
;
20330 phys_ascent
= it
->max_phys_ascent
;
20331 phys_descent
= it
->max_phys_descent
;
20333 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20335 if (IT_DISPLAYING_WHITESPACE (it
))
20339 SAVE_IT (wrap_it
, *it
, wrap_data
);
20341 wrap_row_used
= row
->used
[TEXT_AREA
];
20342 wrap_row_ascent
= row
->ascent
;
20343 wrap_row_height
= row
->height
;
20344 wrap_row_phys_ascent
= row
->phys_ascent
;
20345 wrap_row_phys_height
= row
->phys_height
;
20346 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20347 wrap_row_min_pos
= min_pos
;
20348 wrap_row_min_bpos
= min_bpos
;
20349 wrap_row_max_pos
= max_pos
;
20350 wrap_row_max_bpos
= max_bpos
;
20356 PRODUCE_GLYPHS (it
);
20358 /* If this display element was in marginal areas, continue with
20360 if (it
->area
!= TEXT_AREA
)
20362 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20363 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20364 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20365 row
->phys_height
= max (row
->phys_height
,
20366 it
->max_phys_ascent
+ it
->max_phys_descent
);
20367 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20368 it
->max_extra_line_spacing
);
20369 set_iterator_to_next (it
, true);
20370 /* If we didn't handle the line/wrap prefix above, and the
20371 call to set_iterator_to_next just switched to TEXT_AREA,
20372 process the prefix now. */
20373 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20375 pending_handle_line_prefix
= false;
20376 handle_line_prefix (it
);
20381 /* Does the display element fit on the line? If we truncate
20382 lines, we should draw past the right edge of the window. If
20383 we don't truncate, we want to stop so that we can display the
20384 continuation glyph before the right margin. If lines are
20385 continued, there are two possible strategies for characters
20386 resulting in more than 1 glyph (e.g. tabs): Display as many
20387 glyphs as possible in this line and leave the rest for the
20388 continuation line, or display the whole element in the next
20389 line. Original redisplay did the former, so we do it also. */
20390 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20391 hpos_before
= it
->hpos
;
20394 if (/* Not a newline. */
20396 /* Glyphs produced fit entirely in the line. */
20397 && it
->current_x
< it
->last_visible_x
)
20399 it
->hpos
+= nglyphs
;
20400 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20401 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20402 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20403 row
->phys_height
= max (row
->phys_height
,
20404 it
->max_phys_ascent
+ it
->max_phys_descent
);
20405 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20406 it
->max_extra_line_spacing
);
20407 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20408 /* In R2L rows, we arrange in extend_face_to_end_of_line
20409 to add a right offset to the line, by a suitable
20410 change to the stretch glyph that is the leftmost
20411 glyph of the line. */
20412 && !row
->reversed_p
)
20413 row
->x
= x
- it
->first_visible_x
;
20414 /* Record the maximum and minimum buffer positions seen so
20415 far in glyphs that will be displayed by this row. */
20417 RECORD_MAX_MIN_POS (it
);
20422 struct glyph
*glyph
;
20424 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20426 /* Identify the glyphs added by the last call to
20427 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20428 the previous glyphs. */
20429 if (!row
->reversed_p
)
20430 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20432 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20433 new_x
= x
+ glyph
->pixel_width
;
20435 if (/* Lines are continued. */
20436 it
->line_wrap
!= TRUNCATE
20437 && (/* Glyph doesn't fit on the line. */
20438 new_x
> it
->last_visible_x
20439 /* Or it fits exactly on a window system frame. */
20440 || (new_x
== it
->last_visible_x
20441 && FRAME_WINDOW_P (it
->f
)
20442 && (row
->reversed_p
20443 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20444 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20446 /* End of a continued line. */
20449 || (new_x
== it
->last_visible_x
20450 && FRAME_WINDOW_P (it
->f
)
20451 && (row
->reversed_p
20452 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20453 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20455 /* Current glyph is the only one on the line or
20456 fits exactly on the line. We must continue
20457 the line because we can't draw the cursor
20458 after the glyph. */
20459 row
->continued_p
= true;
20460 it
->current_x
= new_x
;
20461 it
->continuation_lines_width
+= new_x
;
20463 if (i
== nglyphs
- 1)
20465 /* If line-wrap is on, check if a previous
20466 wrap point was found. */
20467 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)
20468 && wrap_row_used
> 0
20469 /* Even if there is a previous wrap
20470 point, continue the line here as
20471 usual, if (i) the previous character
20472 was a space or tab AND (ii) the
20473 current character is not. */
20475 || IT_DISPLAYING_WHITESPACE (it
)))
20478 /* Record the maximum and minimum buffer
20479 positions seen so far in glyphs that will be
20480 displayed by this row. */
20482 RECORD_MAX_MIN_POS (it
);
20483 set_iterator_to_next (it
, true);
20484 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20486 if (!get_next_display_element (it
))
20488 row
->exact_window_width_line_p
= true;
20489 it
->continuation_lines_width
= 0;
20490 row
->continued_p
= false;
20491 row
->ends_at_zv_p
= true;
20493 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20495 row
->continued_p
= false;
20496 row
->exact_window_width_line_p
= true;
20498 /* If line-wrap is on, check if a
20499 previous wrap point was found. */
20500 else if (wrap_row_used
> 0
20501 /* Even if there is a previous wrap
20502 point, continue the line here as
20503 usual, if (i) the previous character
20504 was a space or tab AND (ii) the
20505 current character is not. */
20507 || IT_DISPLAYING_WHITESPACE (it
)))
20512 else if (it
->bidi_p
)
20513 RECORD_MAX_MIN_POS (it
);
20514 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20515 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20516 extend_face_to_end_of_line (it
);
20518 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20519 && !FRAME_WINDOW_P (it
->f
))
20521 /* A padding glyph that doesn't fit on this line.
20522 This means the whole character doesn't fit
20524 if (row
->reversed_p
)
20525 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20526 - n_glyphs_before
);
20527 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20529 /* Fill the rest of the row with continuation
20530 glyphs like in 20.x. */
20531 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20532 < row
->glyphs
[1 + TEXT_AREA
])
20533 produce_special_glyphs (it
, IT_CONTINUATION
);
20535 row
->continued_p
= true;
20536 it
->current_x
= x_before
;
20537 it
->continuation_lines_width
+= x_before
;
20539 /* Restore the height to what it was before the
20540 element not fitting on the line. */
20541 it
->max_ascent
= ascent
;
20542 it
->max_descent
= descent
;
20543 it
->max_phys_ascent
= phys_ascent
;
20544 it
->max_phys_descent
= phys_descent
;
20545 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20546 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20547 extend_face_to_end_of_line (it
);
20549 else if (wrap_row_used
> 0)
20552 if (row
->reversed_p
)
20553 unproduce_glyphs (it
,
20554 row
->used
[TEXT_AREA
] - wrap_row_used
);
20555 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20556 it
->continuation_lines_width
+= wrap_x
;
20557 row
->used
[TEXT_AREA
] = wrap_row_used
;
20558 row
->ascent
= wrap_row_ascent
;
20559 row
->height
= wrap_row_height
;
20560 row
->phys_ascent
= wrap_row_phys_ascent
;
20561 row
->phys_height
= wrap_row_phys_height
;
20562 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20563 min_pos
= wrap_row_min_pos
;
20564 min_bpos
= wrap_row_min_bpos
;
20565 max_pos
= wrap_row_max_pos
;
20566 max_bpos
= wrap_row_max_bpos
;
20567 row
->continued_p
= true;
20568 row
->ends_at_zv_p
= false;
20569 row
->exact_window_width_line_p
= false;
20570 it
->continuation_lines_width
+= x
;
20572 /* Make sure that a non-default face is extended
20573 up to the right margin of the window. */
20574 extend_face_to_end_of_line (it
);
20576 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20578 /* A TAB that extends past the right edge of the
20579 window. This produces a single glyph on
20580 window system frames. We leave the glyph in
20581 this row and let it fill the row, but don't
20582 consume the TAB. */
20583 if ((row
->reversed_p
20584 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20585 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20586 produce_special_glyphs (it
, IT_CONTINUATION
);
20587 it
->continuation_lines_width
+= it
->last_visible_x
;
20588 row
->ends_in_middle_of_char_p
= true;
20589 row
->continued_p
= true;
20590 glyph
->pixel_width
= it
->last_visible_x
- x
;
20591 it
->starts_in_middle_of_char_p
= true;
20592 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20593 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20594 extend_face_to_end_of_line (it
);
20598 /* Something other than a TAB that draws past
20599 the right edge of the window. Restore
20600 positions to values before the element. */
20601 if (row
->reversed_p
)
20602 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20603 - (n_glyphs_before
+ i
));
20604 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20606 /* Display continuation glyphs. */
20607 it
->current_x
= x_before
;
20608 it
->continuation_lines_width
+= x
;
20609 if (!FRAME_WINDOW_P (it
->f
)
20610 || (row
->reversed_p
20611 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20612 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20613 produce_special_glyphs (it
, IT_CONTINUATION
);
20614 row
->continued_p
= true;
20616 extend_face_to_end_of_line (it
);
20618 if (nglyphs
> 1 && i
> 0)
20620 row
->ends_in_middle_of_char_p
= true;
20621 it
->starts_in_middle_of_char_p
= true;
20624 /* Restore the height to what it was before the
20625 element not fitting on the line. */
20626 it
->max_ascent
= ascent
;
20627 it
->max_descent
= descent
;
20628 it
->max_phys_ascent
= phys_ascent
;
20629 it
->max_phys_descent
= phys_descent
;
20634 else if (new_x
> it
->first_visible_x
)
20636 /* Increment number of glyphs actually displayed. */
20639 /* Record the maximum and minimum buffer positions
20640 seen so far in glyphs that will be displayed by
20643 RECORD_MAX_MIN_POS (it
);
20645 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20646 /* Glyph is partially visible, i.e. row starts at
20647 negative X position. Don't do that in R2L
20648 rows, where we arrange to add a right offset to
20649 the line in extend_face_to_end_of_line, by a
20650 suitable change to the stretch glyph that is
20651 the leftmost glyph of the line. */
20652 row
->x
= x
- it
->first_visible_x
;
20653 /* When the last glyph of an R2L row only fits
20654 partially on the line, we need to set row->x to a
20655 negative offset, so that the leftmost glyph is
20656 the one that is partially visible. But if we are
20657 going to produce the truncation glyph, this will
20658 be taken care of in produce_special_glyphs. */
20659 if (row
->reversed_p
20660 && new_x
> it
->last_visible_x
20661 && !(it
->line_wrap
== TRUNCATE
20662 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
20664 eassert (FRAME_WINDOW_P (it
->f
));
20665 row
->x
= it
->last_visible_x
- new_x
;
20670 /* Glyph is completely off the left margin of the
20671 window. This should not happen because of the
20672 move_it_in_display_line at the start of this
20673 function, unless the text display area of the
20674 window is empty. */
20675 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20678 /* Even if this display element produced no glyphs at all,
20679 we want to record its position. */
20680 if (it
->bidi_p
&& nglyphs
== 0)
20681 RECORD_MAX_MIN_POS (it
);
20683 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20684 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20685 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20686 row
->phys_height
= max (row
->phys_height
,
20687 it
->max_phys_ascent
+ it
->max_phys_descent
);
20688 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20689 it
->max_extra_line_spacing
);
20691 /* End of this display line if row is continued. */
20692 if (row
->continued_p
|| row
->ends_at_zv_p
)
20697 /* Is this a line end? If yes, we're also done, after making
20698 sure that a non-default face is extended up to the right
20699 margin of the window. */
20700 if (ITERATOR_AT_END_OF_LINE_P (it
))
20702 int used_before
= row
->used
[TEXT_AREA
];
20704 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20706 /* Add a space at the end of the line that is used to
20707 display the cursor there. */
20708 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20709 append_space_for_newline (it
, false);
20711 /* Extend the face to the end of the line. */
20712 extend_face_to_end_of_line (it
);
20714 /* Make sure we have the position. */
20715 if (used_before
== 0)
20716 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20718 /* Record the position of the newline, for use in
20720 it
->eol_pos
= it
->current
.pos
;
20722 /* Consume the line end. This skips over invisible lines. */
20723 set_iterator_to_next (it
, true);
20724 it
->continuation_lines_width
= 0;
20728 /* Proceed with next display element. Note that this skips
20729 over lines invisible because of selective display. */
20730 set_iterator_to_next (it
, true);
20732 /* If we truncate lines, we are done when the last displayed
20733 glyphs reach past the right margin of the window. */
20734 if (it
->line_wrap
== TRUNCATE
20735 && ((FRAME_WINDOW_P (it
->f
)
20736 /* Images are preprocessed in produce_image_glyph such
20737 that they are cropped at the right edge of the
20738 window, so an image glyph will always end exactly at
20739 last_visible_x, even if there's no right fringe. */
20740 && ((row
->reversed_p
20741 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20742 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
20743 || it
->what
== IT_IMAGE
))
20744 ? (it
->current_x
>= it
->last_visible_x
)
20745 : (it
->current_x
> it
->last_visible_x
)))
20747 /* Maybe add truncation glyphs. */
20748 if (!FRAME_WINDOW_P (it
->f
)
20749 || (row
->reversed_p
20750 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20751 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20755 if (!row
->reversed_p
)
20757 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20758 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20763 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20764 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20766 /* Remove any padding glyphs at the front of ROW, to
20767 make room for the truncation glyphs we will be
20768 adding below. The loop below always inserts at
20769 least one truncation glyph, so also remove the
20770 last glyph added to ROW. */
20771 unproduce_glyphs (it
, i
+ 1);
20772 /* Adjust i for the loop below. */
20773 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20776 /* produce_special_glyphs overwrites the last glyph, so
20777 we don't want that if we want to keep that last
20778 glyph, which means it's an image. */
20779 if (it
->current_x
> it
->last_visible_x
)
20781 it
->current_x
= x_before
;
20782 if (!FRAME_WINDOW_P (it
->f
))
20784 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20786 row
->used
[TEXT_AREA
] = i
;
20787 produce_special_glyphs (it
, IT_TRUNCATION
);
20792 row
->used
[TEXT_AREA
] = i
;
20793 produce_special_glyphs (it
, IT_TRUNCATION
);
20795 it
->hpos
= hpos_before
;
20798 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20800 /* Don't truncate if we can overflow newline into fringe. */
20801 if (!get_next_display_element (it
))
20803 it
->continuation_lines_width
= 0;
20804 row
->ends_at_zv_p
= true;
20805 row
->exact_window_width_line_p
= true;
20808 if (ITERATOR_AT_END_OF_LINE_P (it
))
20810 row
->exact_window_width_line_p
= true;
20811 goto at_end_of_line
;
20813 it
->current_x
= x_before
;
20814 it
->hpos
= hpos_before
;
20817 row
->truncated_on_right_p
= true;
20818 it
->continuation_lines_width
= 0;
20819 reseat_at_next_visible_line_start (it
, false);
20820 /* We insist below that IT's position be at ZV because in
20821 bidi-reordered lines the character at visible line start
20822 might not be the character that follows the newline in
20823 the logical order. */
20824 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
20825 row
->ends_at_zv_p
=
20826 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
20828 row
->ends_at_zv_p
= false;
20834 bidi_unshelve_cache (wrap_data
, true);
20836 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20837 at the left window margin. */
20838 if (it
->first_visible_x
20839 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20841 if (!FRAME_WINDOW_P (it
->f
)
20842 || (((row
->reversed_p
20843 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20844 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20845 /* Don't let insert_left_trunc_glyphs overwrite the
20846 first glyph of the row if it is an image. */
20847 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20848 insert_left_trunc_glyphs (it
);
20849 row
->truncated_on_left_p
= true;
20852 /* Remember the position at which this line ends.
20854 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20855 cannot be before the call to find_row_edges below, since that is
20856 where these positions are determined. */
20857 row
->end
= it
->current
;
20860 row
->minpos
= row
->start
.pos
;
20861 row
->maxpos
= row
->end
.pos
;
20865 /* ROW->minpos and ROW->maxpos must be the smallest and
20866 `1 + the largest' buffer positions in ROW. But if ROW was
20867 bidi-reordered, these two positions can be anywhere in the
20868 row, so we must determine them now. */
20869 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20872 /* If the start of this line is the overlay arrow-position, then
20873 mark this glyph row as the one containing the overlay arrow.
20874 This is clearly a mess with variable size fonts. It would be
20875 better to let it be displayed like cursors under X. */
20876 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20877 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20878 !NILP (overlay_arrow_string
)))
20880 /* Overlay arrow in window redisplay is a fringe bitmap. */
20881 if (STRINGP (overlay_arrow_string
))
20883 struct glyph_row
*arrow_row
20884 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20885 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20886 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20887 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20888 struct glyph
*p2
, *end
;
20890 /* Copy the arrow glyphs. */
20891 while (glyph
< arrow_end
)
20894 /* Throw away padding glyphs. */
20896 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20897 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20903 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20908 eassert (INTEGERP (overlay_arrow_string
));
20909 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20911 overlay_arrow_seen
= true;
20914 /* Highlight trailing whitespace. */
20915 if (!NILP (Vshow_trailing_whitespace
))
20916 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20918 /* Compute pixel dimensions of this line. */
20919 compute_line_metrics (it
);
20921 /* Implementation note: No changes in the glyphs of ROW or in their
20922 faces can be done past this point, because compute_line_metrics
20923 computes ROW's hash value and stores it within the glyph_row
20926 /* Record whether this row ends inside an ellipsis. */
20927 row
->ends_in_ellipsis_p
20928 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20929 && it
->ellipsis_p
);
20931 /* Save fringe bitmaps in this row. */
20932 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20933 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20934 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20935 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20937 it
->left_user_fringe_bitmap
= 0;
20938 it
->left_user_fringe_face_id
= 0;
20939 it
->right_user_fringe_bitmap
= 0;
20940 it
->right_user_fringe_face_id
= 0;
20942 /* Maybe set the cursor. */
20943 cvpos
= it
->w
->cursor
.vpos
;
20945 /* In bidi-reordered rows, keep checking for proper cursor
20946 position even if one has been found already, because buffer
20947 positions in such rows change non-linearly with ROW->VPOS,
20948 when a line is continued. One exception: when we are at ZV,
20949 display cursor on the first suitable glyph row, since all
20950 the empty rows after that also have their position set to ZV. */
20951 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20952 lines' rows is implemented for bidi-reordered rows. */
20954 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20955 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20956 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20957 && cursor_row_p (row
))
20958 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20960 /* Prepare for the next line. This line starts horizontally at (X
20961 HPOS) = (0 0). Vertical positions are incremented. As a
20962 convenience for the caller, IT->glyph_row is set to the next
20964 it
->current_x
= it
->hpos
= 0;
20965 it
->current_y
+= row
->height
;
20966 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20969 /* The next row should by default use the same value of the
20970 reversed_p flag as this one. set_iterator_to_next decides when
20971 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20972 the flag accordingly. */
20973 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20974 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20975 it
->start
= row
->end
;
20976 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
20978 #undef RECORD_MAX_MIN_POS
20981 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20982 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20983 doc
: /* Return paragraph direction at point in BUFFER.
20984 Value is either `left-to-right' or `right-to-left'.
20985 If BUFFER is omitted or nil, it defaults to the current buffer.
20987 Paragraph direction determines how the text in the paragraph is displayed.
20988 In left-to-right paragraphs, text begins at the left margin of the window
20989 and the reading direction is generally left to right. In right-to-left
20990 paragraphs, text begins at the right margin and is read from right to left.
20992 See also `bidi-paragraph-direction'. */)
20993 (Lisp_Object buffer
)
20995 struct buffer
*buf
= current_buffer
;
20996 struct buffer
*old
= buf
;
20998 if (! NILP (buffer
))
21000 CHECK_BUFFER (buffer
);
21001 buf
= XBUFFER (buffer
);
21004 if (NILP (BVAR (buf
, bidi_display_reordering
))
21005 || NILP (BVAR (buf
, enable_multibyte_characters
))
21006 /* When we are loading loadup.el, the character property tables
21007 needed for bidi iteration are not yet available. */
21008 || !NILP (Vpurify_flag
))
21009 return Qleft_to_right
;
21010 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
21011 return BVAR (buf
, bidi_paragraph_direction
);
21014 /* Determine the direction from buffer text. We could try to
21015 use current_matrix if it is up to date, but this seems fast
21016 enough as it is. */
21017 struct bidi_it itb
;
21018 ptrdiff_t pos
= BUF_PT (buf
);
21019 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
21021 void *itb_data
= bidi_shelve_cache ();
21023 set_buffer_temp (buf
);
21024 /* bidi_paragraph_init finds the base direction of the paragraph
21025 by searching forward from paragraph start. We need the base
21026 direction of the current or _previous_ paragraph, so we need
21027 to make sure we are within that paragraph. To that end, find
21028 the previous non-empty line. */
21029 if (pos
>= ZV
&& pos
> BEGV
)
21030 DEC_BOTH (pos
, bytepos
);
21031 AUTO_STRING (trailing_white_space
, "[\f\t ]*\n");
21032 if (fast_looking_at (trailing_white_space
,
21033 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
21035 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
21036 || c
== ' ' || c
== '\t' || c
== '\f')
21038 if (bytepos
<= BEGV_BYTE
)
21043 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
21046 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
21047 itb
.paragraph_dir
= NEUTRAL_DIR
;
21048 itb
.string
.s
= NULL
;
21049 itb
.string
.lstring
= Qnil
;
21050 itb
.string
.bufpos
= 0;
21051 itb
.string
.from_disp_str
= false;
21052 itb
.string
.unibyte
= false;
21053 /* We have no window to use here for ignoring window-specific
21054 overlays. Using NULL for window pointer will cause
21055 compute_display_string_pos to use the current buffer. */
21057 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, true);
21058 bidi_unshelve_cache (itb_data
, false);
21059 set_buffer_temp (old
);
21060 switch (itb
.paragraph_dir
)
21063 return Qleft_to_right
;
21066 return Qright_to_left
;
21074 DEFUN ("bidi-find-overridden-directionality",
21075 Fbidi_find_overridden_directionality
,
21076 Sbidi_find_overridden_directionality
, 2, 3, 0,
21077 doc
: /* Return position between FROM and TO where directionality was overridden.
21079 This function returns the first character position in the specified
21080 region of OBJECT where there is a character whose `bidi-class' property
21081 is `L', but which was forced to display as `R' by a directional
21082 override, and likewise with characters whose `bidi-class' is `R'
21083 or `AL' that were forced to display as `L'.
21085 If no such character is found, the function returns nil.
21087 OBJECT is a Lisp string or buffer to search for overridden
21088 directionality, and defaults to the current buffer if nil or omitted.
21089 OBJECT can also be a window, in which case the function will search
21090 the buffer displayed in that window. Passing the window instead of
21091 a buffer is preferable when the buffer is displayed in some window,
21092 because this function will then be able to correctly account for
21093 window-specific overlays, which can affect the results.
21095 Strong directional characters `L', `R', and `AL' can have their
21096 intrinsic directionality overridden by directional override
21097 control characters RLO (u+202e) and LRO (u+202d). See the
21098 function `get-char-code-property' for a way to inquire about
21099 the `bidi-class' property of a character. */)
21100 (Lisp_Object from
, Lisp_Object to
, Lisp_Object object
)
21102 struct buffer
*buf
= current_buffer
;
21103 struct buffer
*old
= buf
;
21104 struct window
*w
= NULL
;
21105 bool frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ());
21106 struct bidi_it itb
;
21107 ptrdiff_t from_pos
, to_pos
, from_bpos
;
21110 if (!NILP (object
))
21112 if (BUFFERP (object
))
21113 buf
= XBUFFER (object
);
21114 else if (WINDOWP (object
))
21116 w
= decode_live_window (object
);
21117 buf
= XBUFFER (w
->contents
);
21118 frame_window_p
= FRAME_WINDOW_P (XFRAME (w
->frame
));
21121 CHECK_STRING (object
);
21124 if (STRINGP (object
))
21126 /* Characters in unibyte strings are always treated by bidi.c as
21128 if (!STRING_MULTIBYTE (object
)
21129 /* When we are loading loadup.el, the character property
21130 tables needed for bidi iteration are not yet
21132 || !NILP (Vpurify_flag
))
21135 validate_subarray (object
, from
, to
, SCHARS (object
), &from_pos
, &to_pos
);
21136 if (from_pos
>= SCHARS (object
))
21139 /* Set up the bidi iterator. */
21140 itb_data
= bidi_shelve_cache ();
21141 itb
.paragraph_dir
= NEUTRAL_DIR
;
21142 itb
.string
.lstring
= object
;
21143 itb
.string
.s
= NULL
;
21144 itb
.string
.schars
= SCHARS (object
);
21145 itb
.string
.bufpos
= 0;
21146 itb
.string
.from_disp_str
= false;
21147 itb
.string
.unibyte
= false;
21149 bidi_init_it (0, 0, frame_window_p
, &itb
);
21153 /* Nothing this fancy can happen in unibyte buffers, or in a
21154 buffer that disabled reordering, or if FROM is at EOB. */
21155 if (NILP (BVAR (buf
, bidi_display_reordering
))
21156 || NILP (BVAR (buf
, enable_multibyte_characters
))
21157 /* When we are loading loadup.el, the character property
21158 tables needed for bidi iteration are not yet
21160 || !NILP (Vpurify_flag
))
21163 set_buffer_temp (buf
);
21164 validate_region (&from
, &to
);
21165 from_pos
= XINT (from
);
21166 to_pos
= XINT (to
);
21167 if (from_pos
>= ZV
)
21170 /* Set up the bidi iterator. */
21171 itb_data
= bidi_shelve_cache ();
21172 from_bpos
= CHAR_TO_BYTE (from_pos
);
21173 if (from_pos
== BEGV
)
21175 itb
.charpos
= BEGV
;
21176 itb
.bytepos
= BEGV_BYTE
;
21178 else if (FETCH_CHAR (from_bpos
- 1) == '\n')
21180 itb
.charpos
= from_pos
;
21181 itb
.bytepos
= from_bpos
;
21184 itb
.charpos
= find_newline_no_quit (from_pos
, CHAR_TO_BYTE (from_pos
),
21186 itb
.paragraph_dir
= NEUTRAL_DIR
;
21187 itb
.string
.s
= NULL
;
21188 itb
.string
.lstring
= Qnil
;
21189 itb
.string
.bufpos
= 0;
21190 itb
.string
.from_disp_str
= false;
21191 itb
.string
.unibyte
= false;
21193 bidi_init_it (itb
.charpos
, itb
.bytepos
, frame_window_p
, &itb
);
21198 /* For the purposes of this function, the actual base direction of
21199 the paragraph doesn't matter, so just set it to L2R. */
21200 bidi_paragraph_init (L2R
, &itb
, false);
21201 while ((found
= bidi_find_first_overridden (&itb
)) < from_pos
)
21203 } while (found
== ZV
&& itb
.ch
== '\n' && itb
.charpos
< to_pos
);
21205 bidi_unshelve_cache (itb_data
, false);
21206 set_buffer_temp (old
);
21208 return (from_pos
<= found
&& found
< to_pos
) ? make_number (found
) : Qnil
;
21211 DEFUN ("move-point-visually", Fmove_point_visually
,
21212 Smove_point_visually
, 1, 1, 0,
21213 doc
: /* Move point in the visual order in the specified DIRECTION.
21214 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
21217 Value is the new character position of point. */)
21218 (Lisp_Object direction
)
21220 struct window
*w
= XWINDOW (selected_window
);
21221 struct buffer
*b
= XBUFFER (w
->contents
);
21222 struct glyph_row
*row
;
21224 Lisp_Object paragraph_dir
;
21226 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21227 (!(ROW)->continued_p \
21228 && NILP ((GLYPH)->object) \
21229 && (GLYPH)->type == CHAR_GLYPH \
21230 && (GLYPH)->u.ch == ' ' \
21231 && (GLYPH)->charpos >= 0 \
21232 && !(GLYPH)->avoid_cursor_p)
21234 CHECK_NUMBER (direction
);
21235 dir
= XINT (direction
);
21241 /* If current matrix is up-to-date, we can use the information
21242 recorded in the glyphs, at least as long as the goal is on the
21244 if (w
->window_end_valid
21245 && !windows_or_buffers_changed
21247 && !b
->clip_changed
21248 && !b
->prevent_redisplay_optimizations_p
21249 && !window_outdated (w
)
21250 /* We rely below on the cursor coordinates to be up to date, but
21251 we cannot trust them if some command moved point since the
21252 last complete redisplay. */
21253 && w
->last_point
== BUF_PT (b
)
21254 && w
->cursor
.vpos
>= 0
21255 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21256 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21258 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21259 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21260 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21262 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21264 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21266 SET_PT (g
->charpos
);
21267 w
->cursor
.vpos
= -1;
21268 return make_number (PT
);
21270 else if (!NILP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21274 if (BUFFERP (gpt
->object
))
21277 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21278 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21280 new_pos
-= (row
->reversed_p
? -dir
: dir
);
21282 else if (BUFFERP (g
->object
))
21283 new_pos
= g
->charpos
;
21287 w
->cursor
.vpos
= -1;
21288 return make_number (PT
);
21290 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21292 /* Glyphs inserted at the end of a non-empty line for
21293 positioning the cursor have zero charpos, so we must
21294 deduce the value of point by other means. */
21295 if (g
->charpos
> 0)
21296 SET_PT (g
->charpos
);
21297 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21299 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21300 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21303 w
->cursor
.vpos
= -1;
21304 return make_number (PT
);
21307 if (g
== e
|| NILP (g
->object
))
21309 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21310 goto simulate_display
;
21311 if (!row
->reversed_p
)
21315 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21316 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21317 goto simulate_display
;
21321 if (row
->reversed_p
&& !row
->continued_p
)
21323 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21324 w
->cursor
.vpos
= -1;
21325 return make_number (PT
);
21327 g
= row
->glyphs
[TEXT_AREA
];
21328 e
= g
+ row
->used
[TEXT_AREA
];
21329 for ( ; g
< e
; g
++)
21331 if (BUFFERP (g
->object
)
21332 /* Empty lines have only one glyph, which stands
21333 for the newline, and whose charpos is the
21334 buffer position of the newline. */
21335 || ROW_GLYPH_NEWLINE_P (row
, g
)
21336 /* When the buffer ends in a newline, the line at
21337 EOB also has one glyph, but its charpos is -1. */
21338 || (row
->ends_at_zv_p
21339 && !row
->reversed_p
21340 && NILP (g
->object
)
21341 && g
->type
== CHAR_GLYPH
21342 && g
->u
.ch
== ' '))
21344 if (g
->charpos
> 0)
21345 SET_PT (g
->charpos
);
21346 else if (!row
->reversed_p
21347 && row
->ends_at_zv_p
21352 w
->cursor
.vpos
= -1;
21353 return make_number (PT
);
21359 if (!row
->reversed_p
&& !row
->continued_p
)
21361 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21362 w
->cursor
.vpos
= -1;
21363 return make_number (PT
);
21365 e
= row
->glyphs
[TEXT_AREA
];
21366 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21367 for ( ; g
>= e
; g
--)
21369 if (BUFFERP (g
->object
)
21370 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21372 /* Empty R2L lines on GUI frames have the buffer
21373 position of the newline stored in the stretch
21375 || g
->type
== STRETCH_GLYPH
21376 || (row
->ends_at_zv_p
21378 && NILP (g
->object
)
21379 && g
->type
== CHAR_GLYPH
21380 && g
->u
.ch
== ' '))
21382 if (g
->charpos
> 0)
21383 SET_PT (g
->charpos
);
21384 else if (row
->reversed_p
21385 && row
->ends_at_zv_p
21390 w
->cursor
.vpos
= -1;
21391 return make_number (PT
);
21400 /* If we wind up here, we failed to move by using the glyphs, so we
21401 need to simulate display instead. */
21404 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21406 paragraph_dir
= Qleft_to_right
;
21407 if (EQ (paragraph_dir
, Qright_to_left
))
21409 if (PT
<= BEGV
&& dir
< 0)
21410 xsignal0 (Qbeginning_of_buffer
);
21411 else if (PT
>= ZV
&& dir
> 0)
21412 xsignal0 (Qend_of_buffer
);
21415 struct text_pos pt
;
21417 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21419 bool overshoot_expected
= false;
21420 bool target_is_eol_p
= false;
21422 /* Setup the arena. */
21423 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21424 start_display (&it
, w
, pt
);
21425 /* When lines are truncated, we could be called with point
21426 outside of the windows edges, in which case move_it_*
21427 functions either prematurely stop at window's edge or jump to
21428 the next screen line, whereas we rely below on our ability to
21429 reach point, in order to start from its X coordinate. So we
21430 need to disregard the window's horizontal extent in that case. */
21431 if (it
.line_wrap
== TRUNCATE
)
21432 it
.last_visible_x
= INFINITY
;
21434 if (it
.cmp_it
.id
< 0
21435 && it
.method
== GET_FROM_STRING
21436 && it
.area
== TEXT_AREA
21437 && it
.string_from_display_prop_p
21438 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21439 overshoot_expected
= true;
21441 /* Find the X coordinate of point. We start from the beginning
21442 of this or previous line to make sure we are before point in
21443 the logical order (since the move_it_* functions can only
21446 reseat_at_previous_visible_line_start (&it
);
21447 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21448 if (IT_CHARPOS (it
) != PT
)
21450 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21451 -1, -1, -1, MOVE_TO_POS
);
21452 /* If we missed point because the character there is
21453 displayed out of a display vector that has more than one
21454 glyph, retry expecting overshoot. */
21455 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21456 && it
.current
.dpvec_index
> 0
21457 && !overshoot_expected
)
21459 overshoot_expected
= true;
21462 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21463 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21465 pt_x
= it
.current_x
;
21467 if (dir
> 0 || overshoot_expected
)
21469 struct glyph_row
*row
= it
.glyph_row
;
21471 /* When point is at beginning of line, we don't have
21472 information about the glyph there loaded into struct
21473 it. Calling get_next_display_element fixes that. */
21475 get_next_display_element (&it
);
21476 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21477 it
.glyph_row
= NULL
;
21478 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21479 it
.glyph_row
= row
;
21480 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21481 it, lest it will become out of sync with it's buffer
21483 it
.current_x
= pt_x
;
21486 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21487 pixel_width
= it
.pixel_width
;
21488 if (overshoot_expected
&& at_eol_p
)
21490 else if (pixel_width
<= 0)
21493 /* If there's a display string (or something similar) at point,
21494 we are actually at the glyph to the left of point, so we need
21495 to correct the X coordinate. */
21496 if (overshoot_expected
)
21499 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21501 pt_x
+= pixel_width
;
21504 /* Compute target X coordinate, either to the left or to the
21505 right of point. On TTY frames, all characters have the same
21506 pixel width of 1, so we can use that. On GUI frames we don't
21507 have an easy way of getting at the pixel width of the
21508 character to the left of point, so we use a different method
21509 of getting to that place. */
21511 target_x
= pt_x
+ pixel_width
;
21513 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21515 /* Target X coordinate could be one line above or below the line
21516 of point, in which case we need to adjust the target X
21517 coordinate. Also, if moving to the left, we need to begin at
21518 the left edge of the point's screen line. */
21523 start_display (&it
, w
, pt
);
21524 if (it
.line_wrap
== TRUNCATE
)
21525 it
.last_visible_x
= INFINITY
;
21526 reseat_at_previous_visible_line_start (&it
);
21527 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21529 move_it_by_lines (&it
, pt_vpos
);
21533 move_it_by_lines (&it
, -1);
21534 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21535 target_is_eol_p
= true;
21536 /* Under word-wrap, we don't know the x coordinate of
21537 the last character displayed on the previous line,
21538 which immediately precedes the wrap point. To find
21539 out its x coordinate, we try moving to the right
21540 margin of the window, which will stop at the wrap
21541 point, and then reset target_x to point at the
21542 character that precedes the wrap point. This is not
21543 needed on GUI frames, because (see below) there we
21544 move from the left margin one grapheme cluster at a
21545 time, and stop when we hit the wrap point. */
21546 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21548 void *it_data
= NULL
;
21551 SAVE_IT (it2
, it
, it_data
);
21552 move_it_in_display_line_to (&it
, ZV
, target_x
,
21553 MOVE_TO_POS
| MOVE_TO_X
);
21554 /* If we arrived at target_x, that _is_ the last
21555 character on the previous line. */
21556 if (it
.current_x
!= target_x
)
21557 target_x
= it
.current_x
- 1;
21558 RESTORE_IT (&it
, &it2
, it_data
);
21565 || (target_x
>= it
.last_visible_x
21566 && it
.line_wrap
!= TRUNCATE
))
21569 move_it_by_lines (&it
, 0);
21570 move_it_by_lines (&it
, 1);
21575 /* Move to the target X coordinate. */
21576 #ifdef HAVE_WINDOW_SYSTEM
21577 /* On GUI frames, as we don't know the X coordinate of the
21578 character to the left of point, moving point to the left
21579 requires walking, one grapheme cluster at a time, until we
21580 find ourself at a place immediately to the left of the
21581 character at point. */
21582 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21584 struct text_pos new_pos
;
21585 enum move_it_result rc
= MOVE_X_REACHED
;
21587 if (it
.current_x
== 0)
21588 get_next_display_element (&it
);
21589 if (it
.what
== IT_COMPOSITION
)
21591 new_pos
.charpos
= it
.cmp_it
.charpos
;
21592 new_pos
.bytepos
= -1;
21595 new_pos
= it
.current
.pos
;
21597 while (it
.current_x
+ it
.pixel_width
<= target_x
21598 && (rc
== MOVE_X_REACHED
21599 /* Under word-wrap, move_it_in_display_line_to
21600 stops at correct coordinates, but sometimes
21601 returns MOVE_POS_MATCH_OR_ZV. */
21602 || (it
.line_wrap
== WORD_WRAP
21603 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21605 int new_x
= it
.current_x
+ it
.pixel_width
;
21607 /* For composed characters, we want the position of the
21608 first character in the grapheme cluster (usually, the
21609 composition's base character), whereas it.current
21610 might give us the position of the _last_ one, e.g. if
21611 the composition is rendered in reverse due to bidi
21613 if (it
.what
== IT_COMPOSITION
)
21615 new_pos
.charpos
= it
.cmp_it
.charpos
;
21616 new_pos
.bytepos
= -1;
21619 new_pos
= it
.current
.pos
;
21620 if (new_x
== it
.current_x
)
21622 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21623 MOVE_TO_POS
| MOVE_TO_X
);
21624 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21627 /* The previous position we saw in the loop is the one we
21629 if (new_pos
.bytepos
== -1)
21630 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21631 it
.current
.pos
= new_pos
;
21635 if (it
.current_x
!= target_x
)
21636 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21638 /* If we ended up in a display string that covers point, move to
21639 buffer position to the right in the visual order. */
21642 while (IT_CHARPOS (it
) == PT
)
21644 set_iterator_to_next (&it
, false);
21645 if (!get_next_display_element (&it
))
21650 /* Move point to that position. */
21651 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21654 return make_number (PT
);
21656 #undef ROW_GLYPH_NEWLINE_P
21659 DEFUN ("bidi-resolved-levels", Fbidi_resolved_levels
,
21660 Sbidi_resolved_levels
, 0, 1, 0,
21661 doc
: /* Return the resolved bidirectional levels of characters at VPOS.
21663 The resolved levels are produced by the Emacs bidi reordering engine
21664 that implements the UBA, the Unicode Bidirectional Algorithm. Please
21665 read the Unicode Standard Annex 9 (UAX#9) for background information
21666 about these levels.
21668 VPOS is the zero-based number of the current window's screen line
21669 for which to produce the resolved levels. If VPOS is nil or omitted,
21670 it defaults to the screen line of point. If the window displays a
21671 header line, VPOS of zero will report on the header line, and first
21672 line of text in the window will have VPOS of 1.
21674 Value is an array of resolved levels, indexed by glyph number.
21675 Glyphs are numbered from zero starting from the beginning of the
21676 screen line, i.e. the left edge of the window for left-to-right lines
21677 and from the right edge for right-to-left lines. The resolved levels
21678 are produced only for the window's text area; text in display margins
21681 If the selected window's display is not up-to-date, or if the specified
21682 screen line does not display text, this function returns nil. It is
21683 highly recommended to bind this function to some simple key, like F8,
21684 in order to avoid these problems.
21686 This function exists mainly for testing the correctness of the
21687 Emacs UBA implementation, in particular with the test suite. */)
21690 struct window
*w
= XWINDOW (selected_window
);
21691 struct buffer
*b
= XBUFFER (w
->contents
);
21693 struct glyph_row
*row
;
21697 int d1
, d2
, d3
, d4
, d5
;
21699 pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &nrow
);
21703 CHECK_NUMBER_COERCE_MARKER (vpos
);
21704 nrow
= XINT (vpos
);
21707 /* We require up-to-date glyph matrix for this window. */
21708 if (w
->window_end_valid
21709 && !windows_or_buffers_changed
21711 && !b
->clip_changed
21712 && !b
->prevent_redisplay_optimizations_p
21713 && !window_outdated (w
)
21715 && nrow
< w
->current_matrix
->nrows
21716 && (row
= MATRIX_ROW (w
->current_matrix
, nrow
))->enabled_p
21717 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
21719 struct glyph
*g
, *e
, *g1
;
21721 Lisp_Object levels
;
21723 if (!row
->reversed_p
) /* Left-to-right glyph row. */
21725 g
= g1
= row
->glyphs
[TEXT_AREA
];
21726 e
= g
+ row
->used
[TEXT_AREA
];
21728 /* Skip over glyphs at the start of the row that was
21729 generated by redisplay for its own needs. */
21731 && NILP (g
->object
)
21736 /* Count the "interesting" glyphs in this row. */
21737 for (nglyphs
= 0; g
< e
&& !NILP (g
->object
); g
++)
21740 /* Create and fill the array. */
21741 levels
= make_uninit_vector (nglyphs
);
21742 for (i
= 0; g1
< g
; i
++, g1
++)
21743 ASET (levels
, i
, make_number (g1
->resolved_level
));
21745 else /* Right-to-left glyph row. */
21747 g
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
21748 e
= row
->glyphs
[TEXT_AREA
] - 1;
21750 && NILP (g
->object
)
21754 for (nglyphs
= 0; g
> e
&& !NILP (g
->object
); g
--)
21756 levels
= make_uninit_vector (nglyphs
);
21757 for (i
= 0; g1
> g
; i
++, g1
--)
21758 ASET (levels
, i
, make_number (g1
->resolved_level
));
21768 /***********************************************************************
21770 ***********************************************************************/
21772 /* Redisplay the menu bar in the frame for window W.
21774 The menu bar of X frames that don't have X toolkit support is
21775 displayed in a special window W->frame->menu_bar_window.
21777 The menu bar of terminal frames is treated specially as far as
21778 glyph matrices are concerned. Menu bar lines are not part of
21779 windows, so the update is done directly on the frame matrix rows
21780 for the menu bar. */
21783 display_menu_bar (struct window
*w
)
21785 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21790 /* Don't do all this for graphical frames. */
21792 if (FRAME_W32_P (f
))
21795 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21801 if (FRAME_NS_P (f
))
21803 #endif /* HAVE_NS */
21805 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21806 eassert (!FRAME_WINDOW_P (f
));
21807 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21808 it
.first_visible_x
= 0;
21809 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21810 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21811 if (FRAME_WINDOW_P (f
))
21813 /* Menu bar lines are displayed in the desired matrix of the
21814 dummy window menu_bar_window. */
21815 struct window
*menu_w
;
21816 menu_w
= XWINDOW (f
->menu_bar_window
);
21817 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21819 it
.first_visible_x
= 0;
21820 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21823 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21825 /* This is a TTY frame, i.e. character hpos/vpos are used as
21827 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21829 it
.first_visible_x
= 0;
21830 it
.last_visible_x
= FRAME_COLS (f
);
21833 /* FIXME: This should be controlled by a user option. See the
21834 comments in redisplay_tool_bar and display_mode_line about
21836 it
.paragraph_embedding
= L2R
;
21838 /* Clear all rows of the menu bar. */
21839 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21841 struct glyph_row
*row
= it
.glyph_row
+ i
;
21842 clear_glyph_row (row
);
21843 row
->enabled_p
= true;
21844 row
->full_width_p
= true;
21845 row
->reversed_p
= false;
21848 /* Display all items of the menu bar. */
21849 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21850 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21852 Lisp_Object string
;
21854 /* Stop at nil string. */
21855 string
= AREF (items
, i
+ 1);
21859 /* Remember where item was displayed. */
21860 ASET (items
, i
+ 3, make_number (it
.hpos
));
21862 /* Display the item, pad with one space. */
21863 if (it
.current_x
< it
.last_visible_x
)
21864 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21865 SCHARS (string
) + 1, 0, 0, -1);
21868 /* Fill out the line with spaces. */
21869 if (it
.current_x
< it
.last_visible_x
)
21870 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21872 /* Compute the total height of the lines. */
21873 compute_line_metrics (&it
);
21876 /* Deep copy of a glyph row, including the glyphs. */
21878 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21880 struct glyph
*pointers
[1 + LAST_AREA
];
21881 int to_used
= to
->used
[TEXT_AREA
];
21883 /* Save glyph pointers of TO. */
21884 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21886 /* Do a structure assignment. */
21889 /* Restore original glyph pointers of TO. */
21890 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21892 /* Copy the glyphs. */
21893 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21894 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21896 /* If we filled only part of the TO row, fill the rest with
21897 space_glyph (which will display as empty space). */
21898 if (to_used
> from
->used
[TEXT_AREA
])
21899 fill_up_frame_row_with_spaces (to
, to_used
);
21902 /* Display one menu item on a TTY, by overwriting the glyphs in the
21903 frame F's desired glyph matrix with glyphs produced from the menu
21904 item text. Called from term.c to display TTY drop-down menus one
21907 ITEM_TEXT is the menu item text as a C string.
21909 FACE_ID is the face ID to be used for this menu item. FACE_ID
21910 could specify one of 3 faces: a face for an enabled item, a face
21911 for a disabled item, or a face for a selected item.
21913 X and Y are coordinates of the first glyph in the frame's desired
21914 matrix to be overwritten by the menu item. Since this is a TTY, Y
21915 is the zero-based number of the glyph row and X is the zero-based
21916 glyph number in the row, starting from left, where to start
21917 displaying the item.
21919 SUBMENU means this menu item drops down a submenu, which
21920 should be indicated by displaying a proper visual cue after the
21924 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21925 int x
, int y
, bool submenu
)
21928 struct frame
*f
= SELECTED_FRAME ();
21929 struct window
*w
= XWINDOW (f
->selected_window
);
21930 struct glyph_row
*row
;
21931 size_t item_len
= strlen (item_text
);
21933 eassert (FRAME_TERMCAP_P (f
));
21935 /* Don't write beyond the matrix's last row. This can happen for
21936 TTY screens that are not high enough to show the entire menu.
21937 (This is actually a bit of defensive programming, as
21938 tty_menu_display already limits the number of menu items to one
21939 less than the number of screen lines.) */
21940 if (y
>= f
->desired_matrix
->nrows
)
21943 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21944 it
.first_visible_x
= 0;
21945 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21946 row
= it
.glyph_row
;
21947 /* Start with the row contents from the current matrix. */
21948 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21949 bool saved_width
= row
->full_width_p
;
21950 row
->full_width_p
= true;
21951 bool saved_reversed
= row
->reversed_p
;
21952 row
->reversed_p
= false;
21953 row
->enabled_p
= true;
21955 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21957 eassert (x
< f
->desired_matrix
->matrix_w
);
21958 it
.current_x
= it
.hpos
= x
;
21959 it
.current_y
= it
.vpos
= y
;
21960 int saved_used
= row
->used
[TEXT_AREA
];
21961 bool saved_truncated
= row
->truncated_on_right_p
;
21962 row
->used
[TEXT_AREA
] = x
;
21963 it
.face_id
= face_id
;
21964 it
.line_wrap
= TRUNCATE
;
21966 /* FIXME: This should be controlled by a user option. See the
21967 comments in redisplay_tool_bar and display_mode_line about this.
21968 Also, if paragraph_embedding could ever be R2L, changes will be
21969 needed to avoid shifting to the right the row characters in
21970 term.c:append_glyph. */
21971 it
.paragraph_embedding
= L2R
;
21973 /* Pad with a space on the left. */
21974 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
21976 /* Display the menu item, pad with spaces to WIDTH. */
21979 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21980 item_len
, 0, FRAME_COLS (f
) - 1, -1);
21982 /* Indicate with " >" that there's a submenu. */
21983 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
21984 FRAME_COLS (f
) - 1, -1);
21987 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21988 width
, 0, FRAME_COLS (f
) - 1, -1);
21990 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
21991 row
->truncated_on_right_p
= saved_truncated
;
21992 row
->hash
= row_hash (row
);
21993 row
->full_width_p
= saved_width
;
21994 row
->reversed_p
= saved_reversed
;
21997 /***********************************************************************
21999 ***********************************************************************/
22001 /* Redisplay mode lines in the window tree whose root is WINDOW.
22002 If FORCE, redisplay mode lines unconditionally.
22003 Otherwise, redisplay only mode lines that are garbaged. Value is
22004 the number of windows whose mode lines were redisplayed. */
22007 redisplay_mode_lines (Lisp_Object window
, bool force
)
22011 while (!NILP (window
))
22013 struct window
*w
= XWINDOW (window
);
22015 if (WINDOWP (w
->contents
))
22016 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
22018 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
22019 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
22021 struct text_pos lpoint
;
22022 struct buffer
*old
= current_buffer
;
22024 /* Set the window's buffer for the mode line display. */
22025 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
22026 set_buffer_internal_1 (XBUFFER (w
->contents
));
22028 /* Point refers normally to the selected window. For any
22029 other window, set up appropriate value. */
22030 if (!EQ (window
, selected_window
))
22032 struct text_pos pt
;
22034 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
22035 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
22038 /* Display mode lines. */
22039 clear_glyph_matrix (w
->desired_matrix
);
22040 if (display_mode_lines (w
))
22043 /* Restore old settings. */
22044 set_buffer_internal_1 (old
);
22045 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
22055 /* Display the mode and/or header line of window W. Value is the
22056 sum number of mode lines and header lines displayed. */
22059 display_mode_lines (struct window
*w
)
22061 Lisp_Object old_selected_window
= selected_window
;
22062 Lisp_Object old_selected_frame
= selected_frame
;
22063 Lisp_Object new_frame
= w
->frame
;
22064 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
22067 selected_frame
= new_frame
;
22068 /* FIXME: If we were to allow the mode-line's computation changing the buffer
22069 or window's point, then we'd need select_window_1 here as well. */
22070 XSETWINDOW (selected_window
, w
);
22071 XFRAME (new_frame
)->selected_window
= selected_window
;
22073 /* These will be set while the mode line specs are processed. */
22074 line_number_displayed
= false;
22075 w
->column_number_displayed
= -1;
22077 if (WINDOW_WANTS_MODELINE_P (w
))
22079 struct window
*sel_w
= XWINDOW (old_selected_window
);
22081 /* Select mode line face based on the real selected window. */
22082 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
22083 BVAR (current_buffer
, mode_line_format
));
22087 if (WINDOW_WANTS_HEADER_LINE_P (w
))
22089 display_mode_line (w
, HEADER_LINE_FACE_ID
,
22090 BVAR (current_buffer
, header_line_format
));
22094 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
22095 selected_frame
= old_selected_frame
;
22096 selected_window
= old_selected_window
;
22098 w
->must_be_updated_p
= true;
22103 /* Display mode or header line of window W. FACE_ID specifies which
22104 line to display; it is either MODE_LINE_FACE_ID or
22105 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
22106 display. Value is the pixel height of the mode/header line
22110 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
22114 ptrdiff_t count
= SPECPDL_INDEX ();
22116 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22117 /* Don't extend on a previously drawn mode-line.
22118 This may happen if called from pos_visible_p. */
22119 it
.glyph_row
->enabled_p
= false;
22120 prepare_desired_row (w
, it
.glyph_row
, true);
22122 it
.glyph_row
->mode_line_p
= true;
22124 /* FIXME: This should be controlled by a user option. But
22125 supporting such an option is not trivial, since the mode line is
22126 made up of many separate strings. */
22127 it
.paragraph_embedding
= L2R
;
22129 record_unwind_protect (unwind_format_mode_line
,
22130 format_mode_line_unwind_data (NULL
, NULL
,
22133 mode_line_target
= MODE_LINE_DISPLAY
;
22135 /* Temporarily make frame's keyboard the current kboard so that
22136 kboard-local variables in the mode_line_format will get the right
22138 push_kboard (FRAME_KBOARD (it
.f
));
22139 record_unwind_save_match_data ();
22140 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22143 unbind_to (count
, Qnil
);
22145 /* Fill up with spaces. */
22146 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
22148 compute_line_metrics (&it
);
22149 it
.glyph_row
->full_width_p
= true;
22150 it
.glyph_row
->continued_p
= false;
22151 it
.glyph_row
->truncated_on_left_p
= false;
22152 it
.glyph_row
->truncated_on_right_p
= false;
22154 /* Make a 3D mode-line have a shadow at its right end. */
22155 face
= FACE_FROM_ID (it
.f
, face_id
);
22156 extend_face_to_end_of_line (&it
);
22157 if (face
->box
!= FACE_NO_BOX
)
22159 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
22160 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
22161 last
->right_box_line_p
= true;
22164 return it
.glyph_row
->height
;
22167 /* Move element ELT in LIST to the front of LIST.
22168 Return the updated list. */
22171 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
22173 register Lisp_Object tail
, prev
;
22174 register Lisp_Object tem
;
22178 while (CONSP (tail
))
22184 /* Splice out the link TAIL. */
22186 list
= XCDR (tail
);
22188 Fsetcdr (prev
, XCDR (tail
));
22190 /* Now make it the first. */
22191 Fsetcdr (tail
, list
);
22196 tail
= XCDR (tail
);
22200 /* Not found--return unchanged LIST. */
22204 /* Contribute ELT to the mode line for window IT->w. How it
22205 translates into text depends on its data type.
22207 IT describes the display environment in which we display, as usual.
22209 DEPTH is the depth in recursion. It is used to prevent
22210 infinite recursion here.
22212 FIELD_WIDTH is the number of characters the display of ELT should
22213 occupy in the mode line, and PRECISION is the maximum number of
22214 characters to display from ELT's representation. See
22215 display_string for details.
22217 Returns the hpos of the end of the text generated by ELT.
22219 PROPS is a property list to add to any string we encounter.
22221 If RISKY, remove (disregard) any properties in any string
22222 we encounter, and ignore :eval and :propertize.
22224 The global variable `mode_line_target' determines whether the
22225 output is passed to `store_mode_line_noprop',
22226 `store_mode_line_string', or `display_string'. */
22229 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
22230 Lisp_Object elt
, Lisp_Object props
, bool risky
)
22232 int n
= 0, field
, prec
;
22233 bool literal
= false;
22237 elt
= build_string ("*too-deep*");
22241 switch (XTYPE (elt
))
22245 /* A string: output it and check for %-constructs within it. */
22247 ptrdiff_t offset
= 0;
22249 if (SCHARS (elt
) > 0
22250 && (!NILP (props
) || risky
))
22252 Lisp_Object oprops
, aelt
;
22253 oprops
= Ftext_properties_at (make_number (0), elt
);
22255 /* If the starting string's properties are not what
22256 we want, translate the string. Also, if the string
22257 is risky, do that anyway. */
22259 if (NILP (Fequal (props
, oprops
)) || risky
)
22261 /* If the starting string has properties,
22262 merge the specified ones onto the existing ones. */
22263 if (! NILP (oprops
) && !risky
)
22267 oprops
= Fcopy_sequence (oprops
);
22269 while (CONSP (tem
))
22271 oprops
= Fplist_put (oprops
, XCAR (tem
),
22272 XCAR (XCDR (tem
)));
22273 tem
= XCDR (XCDR (tem
));
22278 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
22279 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
22281 /* AELT is what we want. Move it to the front
22282 without consing. */
22284 mode_line_proptrans_alist
22285 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
22291 /* If AELT has the wrong props, it is useless.
22292 so get rid of it. */
22294 mode_line_proptrans_alist
22295 = Fdelq (aelt
, mode_line_proptrans_alist
);
22297 elt
= Fcopy_sequence (elt
);
22298 Fset_text_properties (make_number (0), Flength (elt
),
22300 /* Add this item to mode_line_proptrans_alist. */
22301 mode_line_proptrans_alist
22302 = Fcons (Fcons (elt
, props
),
22303 mode_line_proptrans_alist
);
22304 /* Truncate mode_line_proptrans_alist
22305 to at most 50 elements. */
22306 tem
= Fnthcdr (make_number (50),
22307 mode_line_proptrans_alist
);
22309 XSETCDR (tem
, Qnil
);
22318 prec
= precision
- n
;
22319 switch (mode_line_target
)
22321 case MODE_LINE_NOPROP
:
22322 case MODE_LINE_TITLE
:
22323 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
22325 case MODE_LINE_STRING
:
22326 n
+= store_mode_line_string (NULL
, elt
, true, 0, prec
, Qnil
);
22328 case MODE_LINE_DISPLAY
:
22329 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
22330 0, prec
, 0, STRING_MULTIBYTE (elt
));
22337 /* Handle the non-literal case. */
22339 while ((precision
<= 0 || n
< precision
)
22340 && SREF (elt
, offset
) != 0
22341 && (mode_line_target
!= MODE_LINE_DISPLAY
22342 || it
->current_x
< it
->last_visible_x
))
22344 ptrdiff_t last_offset
= offset
;
22346 /* Advance to end of string or next format specifier. */
22347 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22350 if (offset
- 1 != last_offset
)
22352 ptrdiff_t nchars
, nbytes
;
22354 /* Output to end of string or up to '%'. Field width
22355 is length of string. Don't output more than
22356 PRECISION allows us. */
22359 prec
= c_string_width (SDATA (elt
) + last_offset
,
22360 offset
- last_offset
, precision
- n
,
22363 switch (mode_line_target
)
22365 case MODE_LINE_NOPROP
:
22366 case MODE_LINE_TITLE
:
22367 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22369 case MODE_LINE_STRING
:
22371 ptrdiff_t bytepos
= last_offset
;
22372 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22373 ptrdiff_t endpos
= (precision
<= 0
22374 ? string_byte_to_char (elt
, offset
)
22375 : charpos
+ nchars
);
22376 Lisp_Object mode_string
22377 = Fsubstring (elt
, make_number (charpos
),
22378 make_number (endpos
));
22379 n
+= store_mode_line_string (NULL
, mode_string
, false,
22383 case MODE_LINE_DISPLAY
:
22385 ptrdiff_t bytepos
= last_offset
;
22386 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22388 if (precision
<= 0)
22389 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22390 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22392 STRING_MULTIBYTE (elt
));
22397 else /* c == '%' */
22399 ptrdiff_t percent_position
= offset
;
22401 /* Get the specified minimum width. Zero means
22404 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22405 field
= field
* 10 + c
- '0';
22407 /* Don't pad beyond the total padding allowed. */
22408 if (field_width
- n
> 0 && field
> field_width
- n
)
22409 field
= field_width
- n
;
22411 /* Note that either PRECISION <= 0 or N < PRECISION. */
22412 prec
= precision
- n
;
22415 n
+= display_mode_element (it
, depth
, field
, prec
,
22416 Vglobal_mode_string
, props
,
22421 ptrdiff_t bytepos
, charpos
;
22423 Lisp_Object string
;
22425 bytepos
= percent_position
;
22426 charpos
= (STRING_MULTIBYTE (elt
)
22427 ? string_byte_to_char (elt
, bytepos
)
22429 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22430 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22432 switch (mode_line_target
)
22434 case MODE_LINE_NOPROP
:
22435 case MODE_LINE_TITLE
:
22436 n
+= store_mode_line_noprop (spec
, field
, prec
);
22438 case MODE_LINE_STRING
:
22440 Lisp_Object tem
= build_string (spec
);
22441 props
= Ftext_properties_at (make_number (charpos
), elt
);
22442 /* Should only keep face property in props */
22443 n
+= store_mode_line_string (NULL
, tem
, false,
22444 field
, prec
, props
);
22447 case MODE_LINE_DISPLAY
:
22449 int nglyphs_before
, nwritten
;
22451 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22452 nwritten
= display_string (spec
, string
, elt
,
22457 /* Assign to the glyphs written above the
22458 string where the `%x' came from, position
22462 struct glyph
*glyph
22463 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22467 for (i
= 0; i
< nwritten
; ++i
)
22469 glyph
[i
].object
= elt
;
22470 glyph
[i
].charpos
= charpos
;
22487 /* A symbol: process the value of the symbol recursively
22488 as if it appeared here directly. Avoid error if symbol void.
22489 Special case: if value of symbol is a string, output the string
22492 register Lisp_Object tem
;
22494 /* If the variable is not marked as risky to set
22495 then its contents are risky to use. */
22496 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22499 tem
= Fboundp (elt
);
22502 tem
= Fsymbol_value (elt
);
22503 /* If value is a string, output that string literally:
22504 don't check for % within it. */
22508 if (!EQ (tem
, elt
))
22510 /* Give up right away for nil or t. */
22520 register Lisp_Object car
, tem
;
22522 /* A cons cell: five distinct cases.
22523 If first element is :eval or :propertize, do something special.
22524 If first element is a string or a cons, process all the elements
22525 and effectively concatenate them.
22526 If first element is a negative number, truncate displaying cdr to
22527 at most that many characters. If positive, pad (with spaces)
22528 to at least that many characters.
22529 If first element is a symbol, process the cadr or caddr recursively
22530 according to whether the symbol's value is non-nil or nil. */
22532 if (EQ (car
, QCeval
))
22534 /* An element of the form (:eval FORM) means evaluate FORM
22535 and use the result as mode line elements. */
22540 if (CONSP (XCDR (elt
)))
22543 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22544 n
+= display_mode_element (it
, depth
, field_width
- n
,
22545 precision
- n
, spec
, props
,
22549 else if (EQ (car
, QCpropertize
))
22551 /* An element of the form (:propertize ELT PROPS...)
22552 means display ELT but applying properties PROPS. */
22557 if (CONSP (XCDR (elt
)))
22558 n
+= display_mode_element (it
, depth
, field_width
- n
,
22559 precision
- n
, XCAR (XCDR (elt
)),
22560 XCDR (XCDR (elt
)), risky
);
22562 else if (SYMBOLP (car
))
22564 tem
= Fboundp (car
);
22568 /* elt is now the cdr, and we know it is a cons cell.
22569 Use its car if CAR has a non-nil value. */
22572 tem
= Fsymbol_value (car
);
22579 /* Symbol's value is nil (or symbol is unbound)
22580 Get the cddr of the original list
22581 and if possible find the caddr and use that. */
22585 else if (!CONSP (elt
))
22590 else if (INTEGERP (car
))
22592 register int lim
= XINT (car
);
22596 /* Negative int means reduce maximum width. */
22597 if (precision
<= 0)
22600 precision
= min (precision
, -lim
);
22604 /* Padding specified. Don't let it be more than
22605 current maximum. */
22607 lim
= min (precision
, lim
);
22609 /* If that's more padding than already wanted, queue it.
22610 But don't reduce padding already specified even if
22611 that is beyond the current truncation point. */
22612 field_width
= max (lim
, field_width
);
22616 else if (STRINGP (car
) || CONSP (car
))
22618 Lisp_Object halftail
= elt
;
22622 && (precision
<= 0 || n
< precision
))
22624 n
+= display_mode_element (it
, depth
,
22625 /* Do padding only after the last
22626 element in the list. */
22627 (! CONSP (XCDR (elt
))
22630 precision
- n
, XCAR (elt
),
22634 if ((len
& 1) == 0)
22635 halftail
= XCDR (halftail
);
22636 /* Check for cycle. */
22637 if (EQ (halftail
, elt
))
22646 elt
= build_string ("*invalid*");
22650 /* Pad to FIELD_WIDTH. */
22651 if (field_width
> 0 && n
< field_width
)
22653 switch (mode_line_target
)
22655 case MODE_LINE_NOPROP
:
22656 case MODE_LINE_TITLE
:
22657 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22659 case MODE_LINE_STRING
:
22660 n
+= store_mode_line_string ("", Qnil
, false, field_width
- n
, 0,
22663 case MODE_LINE_DISPLAY
:
22664 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22673 /* Store a mode-line string element in mode_line_string_list.
22675 If STRING is non-null, display that C string. Otherwise, the Lisp
22676 string LISP_STRING is displayed.
22678 FIELD_WIDTH is the minimum number of output glyphs to produce.
22679 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22680 with spaces. FIELD_WIDTH <= 0 means don't pad.
22682 PRECISION is the maximum number of characters to output from
22683 STRING. PRECISION <= 0 means don't truncate the string.
22685 If COPY_STRING, make a copy of LISP_STRING before adding
22686 properties to the string.
22688 PROPS are the properties to add to the string.
22689 The mode_line_string_face face property is always added to the string.
22693 store_mode_line_string (const char *string
, Lisp_Object lisp_string
,
22695 int field_width
, int precision
, Lisp_Object props
)
22700 if (string
!= NULL
)
22702 len
= strlen (string
);
22703 if (precision
> 0 && len
> precision
)
22705 lisp_string
= make_string (string
, len
);
22707 props
= mode_line_string_face_prop
;
22708 else if (!NILP (mode_line_string_face
))
22710 Lisp_Object face
= Fplist_get (props
, Qface
);
22711 props
= Fcopy_sequence (props
);
22713 face
= mode_line_string_face
;
22715 face
= list2 (face
, mode_line_string_face
);
22716 props
= Fplist_put (props
, Qface
, face
);
22718 Fadd_text_properties (make_number (0), make_number (len
),
22719 props
, lisp_string
);
22723 len
= XFASTINT (Flength (lisp_string
));
22724 if (precision
> 0 && len
> precision
)
22727 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22730 if (!NILP (mode_line_string_face
))
22734 props
= Ftext_properties_at (make_number (0), lisp_string
);
22735 face
= Fplist_get (props
, Qface
);
22737 face
= mode_line_string_face
;
22739 face
= list2 (face
, mode_line_string_face
);
22740 props
= list2 (Qface
, face
);
22742 lisp_string
= Fcopy_sequence (lisp_string
);
22745 Fadd_text_properties (make_number (0), make_number (len
),
22746 props
, lisp_string
);
22751 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22755 if (field_width
> len
)
22757 field_width
-= len
;
22758 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22760 Fadd_text_properties (make_number (0), make_number (field_width
),
22761 props
, lisp_string
);
22762 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22770 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22772 doc
: /* Format a string out of a mode line format specification.
22773 First arg FORMAT specifies the mode line format (see `mode-line-format'
22774 for details) to use.
22776 By default, the format is evaluated for the currently selected window.
22778 Optional second arg FACE specifies the face property to put on all
22779 characters for which no face is specified. The value nil means the
22780 default face. The value t means whatever face the window's mode line
22781 currently uses (either `mode-line' or `mode-line-inactive',
22782 depending on whether the window is the selected window or not).
22783 An integer value means the value string has no text
22786 Optional third and fourth args WINDOW and BUFFER specify the window
22787 and buffer to use as the context for the formatting (defaults
22788 are the selected window and the WINDOW's buffer). */)
22789 (Lisp_Object format
, Lisp_Object face
,
22790 Lisp_Object window
, Lisp_Object buffer
)
22795 struct buffer
*old_buffer
= NULL
;
22797 bool no_props
= INTEGERP (face
);
22798 ptrdiff_t count
= SPECPDL_INDEX ();
22800 int string_start
= 0;
22802 w
= decode_any_window (window
);
22803 XSETWINDOW (window
, w
);
22806 buffer
= w
->contents
;
22807 CHECK_BUFFER (buffer
);
22809 /* Make formatting the modeline a non-op when noninteractive, otherwise
22810 there will be problems later caused by a partially initialized frame. */
22811 if (NILP (format
) || noninteractive
)
22812 return empty_unibyte_string
;
22817 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22818 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22819 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22820 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22821 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22822 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22823 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22826 old_buffer
= current_buffer
;
22828 /* Save things including mode_line_proptrans_alist,
22829 and set that to nil so that we don't alter the outer value. */
22830 record_unwind_protect (unwind_format_mode_line
,
22831 format_mode_line_unwind_data
22832 (XFRAME (WINDOW_FRAME (w
)),
22833 old_buffer
, selected_window
, true));
22834 mode_line_proptrans_alist
= Qnil
;
22836 Fselect_window (window
, Qt
);
22837 set_buffer_internal_1 (XBUFFER (buffer
));
22839 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22843 mode_line_target
= MODE_LINE_NOPROP
;
22844 mode_line_string_face_prop
= Qnil
;
22845 mode_line_string_list
= Qnil
;
22846 string_start
= MODE_LINE_NOPROP_LEN (0);
22850 mode_line_target
= MODE_LINE_STRING
;
22851 mode_line_string_list
= Qnil
;
22852 mode_line_string_face
= face
;
22853 mode_line_string_face_prop
22854 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22857 push_kboard (FRAME_KBOARD (it
.f
));
22858 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22863 len
= MODE_LINE_NOPROP_LEN (string_start
);
22864 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22868 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22869 str
= Fmapconcat (Qidentity
, mode_line_string_list
,
22870 empty_unibyte_string
);
22873 unbind_to (count
, Qnil
);
22877 /* Write a null-terminated, right justified decimal representation of
22878 the positive integer D to BUF using a minimal field width WIDTH. */
22881 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22883 register char *p
= buf
;
22891 *p
++ = d
% 10 + '0';
22896 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22907 /* Write a null-terminated, right justified decimal and "human
22908 readable" representation of the nonnegative integer D to BUF using
22909 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22911 static const char power_letter
[] =
22925 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22927 /* We aim to represent the nonnegative integer D as
22928 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22929 ptrdiff_t quotient
= d
;
22931 /* -1 means: do not use TENTHS. */
22935 /* Length of QUOTIENT.TENTHS as a string. */
22941 if (quotient
>= 1000)
22943 /* Scale to the appropriate EXPONENT. */
22946 remainder
= quotient
% 1000;
22950 while (quotient
>= 1000);
22952 /* Round to nearest and decide whether to use TENTHS or not. */
22955 tenths
= remainder
/ 100;
22956 if (remainder
% 100 >= 50)
22963 if (quotient
== 10)
22971 if (remainder
>= 500)
22973 if (quotient
< 999)
22984 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22985 if (tenths
== -1 && quotient
<= 99)
22992 p
= psuffix
= buf
+ max (width
, length
);
22994 /* Print EXPONENT. */
22995 *psuffix
++ = power_letter
[exponent
];
22998 /* Print TENTHS. */
23001 *--p
= '0' + tenths
;
23005 /* Print QUOTIENT. */
23008 int digit
= quotient
% 10;
23009 *--p
= '0' + digit
;
23011 while ((quotient
/= 10) != 0);
23013 /* Print leading spaces. */
23018 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
23019 If EOL_FLAG, set also a mnemonic character for end-of-line
23020 type of CODING_SYSTEM. Return updated pointer into BUF. */
23022 static unsigned char invalid_eol_type
[] = "(*invalid*)";
23025 decode_mode_spec_coding (Lisp_Object coding_system
, char *buf
, bool eol_flag
)
23028 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
23029 const unsigned char *eol_str
;
23031 /* The EOL conversion we are using. */
23032 Lisp_Object eoltype
;
23034 val
= CODING_SYSTEM_SPEC (coding_system
);
23037 if (!VECTORP (val
)) /* Not yet decided. */
23039 *buf
++ = multibyte
? '-' : ' ';
23041 eoltype
= eol_mnemonic_undecided
;
23042 /* Don't mention EOL conversion if it isn't decided. */
23047 Lisp_Object eolvalue
;
23049 attrs
= AREF (val
, 0);
23050 eolvalue
= AREF (val
, 2);
23053 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
23058 /* The EOL conversion that is normal on this system. */
23060 if (NILP (eolvalue
)) /* Not yet decided. */
23061 eoltype
= eol_mnemonic_undecided
;
23062 else if (VECTORP (eolvalue
)) /* Not yet decided. */
23063 eoltype
= eol_mnemonic_undecided
;
23064 else /* eolvalue is Qunix, Qdos, or Qmac. */
23065 eoltype
= (EQ (eolvalue
, Qunix
)
23066 ? eol_mnemonic_unix
23067 : EQ (eolvalue
, Qdos
)
23068 ? eol_mnemonic_dos
: eol_mnemonic_mac
);
23074 /* Mention the EOL conversion if it is not the usual one. */
23075 if (STRINGP (eoltype
))
23077 eol_str
= SDATA (eoltype
);
23078 eol_str_len
= SBYTES (eoltype
);
23080 else if (CHARACTERP (eoltype
))
23082 int c
= XFASTINT (eoltype
);
23083 return buf
+ CHAR_STRING (c
, (unsigned char *) buf
);
23087 eol_str
= invalid_eol_type
;
23088 eol_str_len
= sizeof (invalid_eol_type
) - 1;
23090 memcpy (buf
, eol_str
, eol_str_len
);
23091 buf
+= eol_str_len
;
23097 /* Return a string for the output of a mode line %-spec for window W,
23098 generated by character C. FIELD_WIDTH > 0 means pad the string
23099 returned with spaces to that value. Return a Lisp string in
23100 *STRING if the resulting string is taken from that Lisp string.
23102 Note we operate on the current buffer for most purposes. */
23104 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
23106 static const char *
23107 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
23108 Lisp_Object
*string
)
23111 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23112 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
23113 /* We are going to use f->decode_mode_spec_buffer as the buffer to
23114 produce strings from numerical values, so limit preposterously
23115 large values of FIELD_WIDTH to avoid overrunning the buffer's
23116 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
23117 bytes plus the terminating null. */
23118 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
23119 struct buffer
*b
= current_buffer
;
23127 if (!NILP (BVAR (b
, read_only
)))
23129 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23134 /* This differs from %* only for a modified read-only buffer. */
23135 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23137 if (!NILP (BVAR (b
, read_only
)))
23142 /* This differs from %* in ignoring read-only-ness. */
23143 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23155 if (command_loop_level
> 5)
23157 p
= decode_mode_spec_buf
;
23158 for (i
= 0; i
< command_loop_level
; i
++)
23161 return decode_mode_spec_buf
;
23169 if (command_loop_level
> 5)
23171 p
= decode_mode_spec_buf
;
23172 for (i
= 0; i
< command_loop_level
; i
++)
23175 return decode_mode_spec_buf
;
23182 /* Let lots_of_dashes be a string of infinite length. */
23183 if (mode_line_target
== MODE_LINE_NOPROP
23184 || mode_line_target
== MODE_LINE_STRING
)
23186 if (field_width
<= 0
23187 || field_width
> sizeof (lots_of_dashes
))
23189 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
23190 decode_mode_spec_buf
[i
] = '-';
23191 decode_mode_spec_buf
[i
] = '\0';
23192 return decode_mode_spec_buf
;
23195 return lots_of_dashes
;
23199 obj
= BVAR (b
, name
);
23203 /* %c and %l are ignored in `frame-title-format'.
23204 (In redisplay_internal, the frame title is drawn _before_ the
23205 windows are updated, so the stuff which depends on actual
23206 window contents (such as %l) may fail to render properly, or
23207 even crash emacs.) */
23208 if (mode_line_target
== MODE_LINE_TITLE
)
23212 ptrdiff_t col
= current_column ();
23213 w
->column_number_displayed
= col
;
23214 pint2str (decode_mode_spec_buf
, width
, col
);
23215 return decode_mode_spec_buf
;
23219 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
23221 if (NILP (Vmemory_full
))
23224 return "!MEM FULL! ";
23231 /* %F displays the frame name. */
23232 if (!NILP (f
->title
))
23233 return SSDATA (f
->title
);
23234 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
23235 return SSDATA (f
->name
);
23239 obj
= BVAR (b
, filename
);
23244 ptrdiff_t size
= ZV
- BEGV
;
23245 pint2str (decode_mode_spec_buf
, width
, size
);
23246 return decode_mode_spec_buf
;
23251 ptrdiff_t size
= ZV
- BEGV
;
23252 pint2hrstr (decode_mode_spec_buf
, width
, size
);
23253 return decode_mode_spec_buf
;
23258 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
23259 ptrdiff_t topline
, nlines
, height
;
23262 /* %c and %l are ignored in `frame-title-format'. */
23263 if (mode_line_target
== MODE_LINE_TITLE
)
23266 startpos
= marker_position (w
->start
);
23267 startpos_byte
= marker_byte_position (w
->start
);
23268 height
= WINDOW_TOTAL_LINES (w
);
23270 /* If we decided that this buffer isn't suitable for line numbers,
23271 don't forget that too fast. */
23272 if (w
->base_line_pos
== -1)
23275 /* If the buffer is very big, don't waste time. */
23276 if (INTEGERP (Vline_number_display_limit
)
23277 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
23279 w
->base_line_pos
= 0;
23280 w
->base_line_number
= 0;
23284 if (w
->base_line_number
> 0
23285 && w
->base_line_pos
> 0
23286 && w
->base_line_pos
<= startpos
)
23288 line
= w
->base_line_number
;
23289 linepos
= w
->base_line_pos
;
23290 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
23295 linepos
= BUF_BEGV (b
);
23296 linepos_byte
= BUF_BEGV_BYTE (b
);
23299 /* Count lines from base line to window start position. */
23300 nlines
= display_count_lines (linepos_byte
,
23304 topline
= nlines
+ line
;
23306 /* Determine a new base line, if the old one is too close
23307 or too far away, or if we did not have one.
23308 "Too close" means it's plausible a scroll-down would
23309 go back past it. */
23310 if (startpos
== BUF_BEGV (b
))
23312 w
->base_line_number
= topline
;
23313 w
->base_line_pos
= BUF_BEGV (b
);
23315 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
23316 || linepos
== BUF_BEGV (b
))
23318 ptrdiff_t limit
= BUF_BEGV (b
);
23319 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
23320 ptrdiff_t position
;
23321 ptrdiff_t distance
=
23322 (height
* 2 + 30) * line_number_display_limit_width
;
23324 if (startpos
- distance
> limit
)
23326 limit
= startpos
- distance
;
23327 limit_byte
= CHAR_TO_BYTE (limit
);
23330 nlines
= display_count_lines (startpos_byte
,
23332 - (height
* 2 + 30),
23334 /* If we couldn't find the lines we wanted within
23335 line_number_display_limit_width chars per line,
23336 give up on line numbers for this window. */
23337 if (position
== limit_byte
&& limit
== startpos
- distance
)
23339 w
->base_line_pos
= -1;
23340 w
->base_line_number
= 0;
23344 w
->base_line_number
= topline
- nlines
;
23345 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23348 /* Now count lines from the start pos to point. */
23349 nlines
= display_count_lines (startpos_byte
,
23350 PT_BYTE
, PT
, &junk
);
23352 /* Record that we did display the line number. */
23353 line_number_displayed
= true;
23355 /* Make the string to show. */
23356 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23357 return decode_mode_spec_buf
;
23360 char *p
= decode_mode_spec_buf
;
23361 int pad
= width
- 2;
23367 return decode_mode_spec_buf
;
23373 obj
= BVAR (b
, mode_name
);
23377 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23383 ptrdiff_t pos
= marker_position (w
->start
);
23384 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23386 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23388 if (pos
<= BUF_BEGV (b
))
23393 else if (pos
<= BUF_BEGV (b
))
23397 if (total
> 1000000)
23398 /* Do it differently for a large value, to avoid overflow. */
23399 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23401 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23402 /* We can't normally display a 3-digit number,
23403 so get us a 2-digit number that is close. */
23406 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23407 return decode_mode_spec_buf
;
23411 /* Display percentage of size above the bottom of the screen. */
23414 ptrdiff_t toppos
= marker_position (w
->start
);
23415 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23416 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23418 if (botpos
>= BUF_ZV (b
))
23420 if (toppos
<= BUF_BEGV (b
))
23427 if (total
> 1000000)
23428 /* Do it differently for a large value, to avoid overflow. */
23429 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23431 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23432 /* We can't normally display a 3-digit number,
23433 so get us a 2-digit number that is close. */
23436 if (toppos
<= BUF_BEGV (b
))
23437 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23439 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23440 return decode_mode_spec_buf
;
23445 /* status of process */
23446 obj
= Fget_buffer_process (Fcurrent_buffer ());
23448 return "no process";
23450 obj
= Fsymbol_name (Fprocess_status (obj
));
23456 ptrdiff_t count
= inhibit_garbage_collection ();
23457 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23458 Lisp_Object val
= Qnil
;
23460 if (STRINGP (curdir
))
23461 val
= call1 (intern ("file-remote-p"), curdir
);
23463 unbind_to (count
, Qnil
);
23472 /* coding-system (not including end-of-line format) */
23474 /* coding-system (including end-of-line type) */
23476 bool eol_flag
= (c
== 'Z');
23477 char *p
= decode_mode_spec_buf
;
23479 if (! FRAME_WINDOW_P (f
))
23481 /* No need to mention EOL here--the terminal never needs
23482 to do EOL conversion. */
23483 p
= decode_mode_spec_coding (CODING_ID_NAME
23484 (FRAME_KEYBOARD_CODING (f
)->id
),
23486 p
= decode_mode_spec_coding (CODING_ID_NAME
23487 (FRAME_TERMINAL_CODING (f
)->id
),
23490 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23493 #if false /* This proves to be annoying; I think we can do without. -- rms. */
23494 #ifdef subprocesses
23495 obj
= Fget_buffer_process (Fcurrent_buffer ());
23496 if (PROCESSP (obj
))
23498 p
= decode_mode_spec_coding
23499 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23500 p
= decode_mode_spec_coding
23501 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23503 #endif /* subprocesses */
23506 return decode_mode_spec_buf
;
23513 return SSDATA (obj
);
23520 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23521 means count lines back from START_BYTE. But don't go beyond
23522 LIMIT_BYTE. Return the number of lines thus found (always
23525 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23526 either the position COUNT lines after/before START_BYTE, if we
23527 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23531 display_count_lines (ptrdiff_t start_byte
,
23532 ptrdiff_t limit_byte
, ptrdiff_t count
,
23533 ptrdiff_t *byte_pos_ptr
)
23535 register unsigned char *cursor
;
23536 unsigned char *base
;
23538 register ptrdiff_t ceiling
;
23539 register unsigned char *ceiling_addr
;
23540 ptrdiff_t orig_count
= count
;
23542 /* If we are not in selective display mode,
23543 check only for newlines. */
23544 bool selective_display
23545 = (!NILP (BVAR (current_buffer
, selective_display
))
23546 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23550 while (start_byte
< limit_byte
)
23552 ceiling
= BUFFER_CEILING_OF (start_byte
);
23553 ceiling
= min (limit_byte
- 1, ceiling
);
23554 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23555 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23559 if (selective_display
)
23561 while (*cursor
!= '\n' && *cursor
!= 015
23562 && ++cursor
!= ceiling_addr
)
23564 if (cursor
== ceiling_addr
)
23569 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23578 start_byte
+= cursor
- base
;
23579 *byte_pos_ptr
= start_byte
;
23583 while (cursor
< ceiling_addr
);
23585 start_byte
+= ceiling_addr
- base
;
23590 while (start_byte
> limit_byte
)
23592 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23593 ceiling
= max (limit_byte
, ceiling
);
23594 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23595 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23598 if (selective_display
)
23600 while (--cursor
>= ceiling_addr
23601 && *cursor
!= '\n' && *cursor
!= 015)
23603 if (cursor
< ceiling_addr
)
23608 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23615 start_byte
+= cursor
- base
+ 1;
23616 *byte_pos_ptr
= start_byte
;
23617 /* When scanning backwards, we should
23618 not count the newline posterior to which we stop. */
23619 return - orig_count
- 1;
23622 start_byte
+= ceiling_addr
- base
;
23626 *byte_pos_ptr
= limit_byte
;
23629 return - orig_count
+ count
;
23630 return orig_count
- count
;
23636 /***********************************************************************
23638 ***********************************************************************/
23640 /* Display a NUL-terminated string, starting with index START.
23642 If STRING is non-null, display that C string. Otherwise, the Lisp
23643 string LISP_STRING is displayed. There's a case that STRING is
23644 non-null and LISP_STRING is not nil. It means STRING is a string
23645 data of LISP_STRING. In that case, we display LISP_STRING while
23646 ignoring its text properties.
23648 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23649 FACE_STRING. Display STRING or LISP_STRING with the face at
23650 FACE_STRING_POS in FACE_STRING:
23652 Display the string in the environment given by IT, but use the
23653 standard display table, temporarily.
23655 FIELD_WIDTH is the minimum number of output glyphs to produce.
23656 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23657 with spaces. If STRING has more characters, more than FIELD_WIDTH
23658 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23660 PRECISION is the maximum number of characters to output from
23661 STRING. PRECISION < 0 means don't truncate the string.
23663 This is roughly equivalent to printf format specifiers:
23665 FIELD_WIDTH PRECISION PRINTF
23666 ----------------------------------------
23672 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23673 display them, and < 0 means obey the current buffer's value of
23674 enable_multibyte_characters.
23676 Value is the number of columns displayed. */
23679 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23680 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23681 int field_width
, int precision
, int max_x
, int multibyte
)
23683 int hpos_at_start
= it
->hpos
;
23684 int saved_face_id
= it
->face_id
;
23685 struct glyph_row
*row
= it
->glyph_row
;
23686 ptrdiff_t it_charpos
;
23688 /* Initialize the iterator IT for iteration over STRING beginning
23689 with index START. */
23690 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23691 precision
, field_width
, multibyte
);
23692 if (string
&& STRINGP (lisp_string
))
23693 /* LISP_STRING is the one returned by decode_mode_spec. We should
23694 ignore its text properties. */
23695 it
->stop_charpos
= it
->end_charpos
;
23697 /* If displaying STRING, set up the face of the iterator from
23698 FACE_STRING, if that's given. */
23699 if (STRINGP (face_string
))
23705 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23706 0, &endptr
, it
->base_face_id
, false);
23707 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23708 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23711 /* Set max_x to the maximum allowed X position. Don't let it go
23712 beyond the right edge of the window. */
23714 max_x
= it
->last_visible_x
;
23716 max_x
= min (max_x
, it
->last_visible_x
);
23718 /* Skip over display elements that are not visible. because IT->w is
23720 if (it
->current_x
< it
->first_visible_x
)
23721 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23722 MOVE_TO_POS
| MOVE_TO_X
);
23724 row
->ascent
= it
->max_ascent
;
23725 row
->height
= it
->max_ascent
+ it
->max_descent
;
23726 row
->phys_ascent
= it
->max_phys_ascent
;
23727 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23728 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23730 if (STRINGP (it
->string
))
23731 it_charpos
= IT_STRING_CHARPOS (*it
);
23733 it_charpos
= IT_CHARPOS (*it
);
23735 /* This condition is for the case that we are called with current_x
23736 past last_visible_x. */
23737 while (it
->current_x
< max_x
)
23739 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23741 /* Get the next display element. */
23742 if (!get_next_display_element (it
))
23745 /* Produce glyphs. */
23746 x_before
= it
->current_x
;
23747 n_glyphs_before
= row
->used
[TEXT_AREA
];
23748 PRODUCE_GLYPHS (it
);
23750 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23753 while (i
< nglyphs
)
23755 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23757 if (it
->line_wrap
!= TRUNCATE
23758 && x
+ glyph
->pixel_width
> max_x
)
23760 /* End of continued line or max_x reached. */
23761 if (CHAR_GLYPH_PADDING_P (*glyph
))
23763 /* A wide character is unbreakable. */
23764 if (row
->reversed_p
)
23765 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23766 - n_glyphs_before
);
23767 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23768 it
->current_x
= x_before
;
23772 if (row
->reversed_p
)
23773 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23774 - (n_glyphs_before
+ i
));
23775 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23780 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23782 /* Glyph is at least partially visible. */
23784 if (x
< it
->first_visible_x
)
23785 row
->x
= x
- it
->first_visible_x
;
23789 /* Glyph is off the left margin of the display area.
23790 Should not happen. */
23794 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23795 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23796 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23797 row
->phys_height
= max (row
->phys_height
,
23798 it
->max_phys_ascent
+ it
->max_phys_descent
);
23799 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23800 it
->max_extra_line_spacing
);
23801 x
+= glyph
->pixel_width
;
23805 /* Stop if max_x reached. */
23809 /* Stop at line ends. */
23810 if (ITERATOR_AT_END_OF_LINE_P (it
))
23812 it
->continuation_lines_width
= 0;
23816 set_iterator_to_next (it
, true);
23817 if (STRINGP (it
->string
))
23818 it_charpos
= IT_STRING_CHARPOS (*it
);
23820 it_charpos
= IT_CHARPOS (*it
);
23822 /* Stop if truncating at the right edge. */
23823 if (it
->line_wrap
== TRUNCATE
23824 && it
->current_x
>= it
->last_visible_x
)
23826 /* Add truncation mark, but don't do it if the line is
23827 truncated at a padding space. */
23828 if (it_charpos
< it
->string_nchars
)
23830 if (!FRAME_WINDOW_P (it
->f
))
23834 if (it
->current_x
> it
->last_visible_x
)
23836 if (!row
->reversed_p
)
23838 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23839 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23844 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23845 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23847 unproduce_glyphs (it
, ii
+ 1);
23848 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23850 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23852 row
->used
[TEXT_AREA
] = ii
;
23853 produce_special_glyphs (it
, IT_TRUNCATION
);
23856 produce_special_glyphs (it
, IT_TRUNCATION
);
23858 row
->truncated_on_right_p
= true;
23864 /* Maybe insert a truncation at the left. */
23865 if (it
->first_visible_x
23868 if (!FRAME_WINDOW_P (it
->f
)
23869 || (row
->reversed_p
23870 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23871 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23872 insert_left_trunc_glyphs (it
);
23873 row
->truncated_on_left_p
= true;
23876 it
->face_id
= saved_face_id
;
23878 /* Value is number of columns displayed. */
23879 return it
->hpos
- hpos_at_start
;
23884 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23885 appears as an element of LIST or as the car of an element of LIST.
23886 If PROPVAL is a list, compare each element against LIST in that
23887 way, and return 1/2 if any element of PROPVAL is found in LIST.
23888 Otherwise return 0. This function cannot quit.
23889 The return value is 2 if the text is invisible but with an ellipsis
23890 and 1 if it's invisible and without an ellipsis. */
23893 invisible_prop (Lisp_Object propval
, Lisp_Object list
)
23895 Lisp_Object tail
, proptail
;
23897 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23899 register Lisp_Object tem
;
23901 if (EQ (propval
, tem
))
23903 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23904 return NILP (XCDR (tem
)) ? 1 : 2;
23907 if (CONSP (propval
))
23909 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23911 Lisp_Object propelt
;
23912 propelt
= XCAR (proptail
);
23913 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23915 register Lisp_Object tem
;
23917 if (EQ (propelt
, tem
))
23919 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23920 return NILP (XCDR (tem
)) ? 1 : 2;
23928 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23929 doc
: /* Non-nil if the property makes the text invisible.
23930 POS-OR-PROP can be a marker or number, in which case it is taken to be
23931 a position in the current buffer and the value of the `invisible' property
23932 is checked; or it can be some other value, which is then presumed to be the
23933 value of the `invisible' property of the text of interest.
23934 The non-nil value returned can be t for truly invisible text or something
23935 else if the text is replaced by an ellipsis. */)
23936 (Lisp_Object pos_or_prop
)
23939 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23940 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23942 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23943 return (invis
== 0 ? Qnil
23945 : make_number (invis
));
23948 /* Calculate a width or height in pixels from a specification using
23949 the following elements:
23952 NUM - a (fractional) multiple of the default font width/height
23953 (NUM) - specifies exactly NUM pixels
23954 UNIT - a fixed number of pixels, see below.
23955 ELEMENT - size of a display element in pixels, see below.
23956 (NUM . SPEC) - equals NUM * SPEC
23957 (+ SPEC SPEC ...) - add pixel values
23958 (- SPEC SPEC ...) - subtract pixel values
23959 (- SPEC) - negate pixel value
23962 INT or FLOAT - a number constant
23963 SYMBOL - use symbol's (buffer local) variable binding.
23966 in - pixels per inch *)
23967 mm - pixels per 1/1000 meter *)
23968 cm - pixels per 1/100 meter *)
23969 width - width of current font in pixels.
23970 height - height of current font in pixels.
23972 *) using the ratio(s) defined in display-pixels-per-inch.
23976 left-fringe - left fringe width in pixels
23977 right-fringe - right fringe width in pixels
23979 left-margin - left margin width in pixels
23980 right-margin - right margin width in pixels
23982 scroll-bar - scroll-bar area width in pixels
23986 Pixels corresponding to 5 inches:
23989 Total width of non-text areas on left side of window (if scroll-bar is on left):
23990 '(space :width (+ left-fringe left-margin scroll-bar))
23992 Align to first text column (in header line):
23993 '(space :align-to 0)
23995 Align to middle of text area minus half the width of variable `my-image'
23996 containing a loaded image:
23997 '(space :align-to (0.5 . (- text my-image)))
23999 Width of left margin minus width of 1 character in the default font:
24000 '(space :width (- left-margin 1))
24002 Width of left margin minus width of 2 characters in the current font:
24003 '(space :width (- left-margin (2 . width)))
24005 Center 1 character over left-margin (in header line):
24006 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
24008 Different ways to express width of left fringe plus left margin minus one pixel:
24009 '(space :width (- (+ left-fringe left-margin) (1)))
24010 '(space :width (+ left-fringe left-margin (- (1))))
24011 '(space :width (+ left-fringe left-margin (-1)))
24016 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
24017 struct font
*font
, bool width_p
, int *align_to
)
24021 # define OK_PIXELS(val) (*res = (val), true)
24022 # define OK_ALIGN_TO(val) (*align_to = (val), true)
24025 return OK_PIXELS (0);
24027 eassert (FRAME_LIVE_P (it
->f
));
24029 if (SYMBOLP (prop
))
24031 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
24033 char *unit
= SSDATA (SYMBOL_NAME (prop
));
24035 if (unit
[0] == 'i' && unit
[1] == 'n')
24037 else if (unit
[0] == 'm' && unit
[1] == 'm')
24039 else if (unit
[0] == 'c' && unit
[1] == 'm')
24045 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
24046 : FRAME_RES_Y (it
->f
));
24049 return OK_PIXELS (ppi
/ pixels
);
24054 #ifdef HAVE_WINDOW_SYSTEM
24055 if (EQ (prop
, Qheight
))
24056 return OK_PIXELS (font
24057 ? normal_char_height (font
, -1)
24058 : FRAME_LINE_HEIGHT (it
->f
));
24059 if (EQ (prop
, Qwidth
))
24060 return OK_PIXELS (font
24061 ? FONT_WIDTH (font
)
24062 : FRAME_COLUMN_WIDTH (it
->f
));
24064 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
24065 return OK_PIXELS (1);
24068 if (EQ (prop
, Qtext
))
24069 return OK_PIXELS (width_p
24070 ? window_box_width (it
->w
, TEXT_AREA
)
24071 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
24073 if (align_to
&& *align_to
< 0)
24076 if (EQ (prop
, Qleft
))
24077 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
24078 if (EQ (prop
, Qright
))
24079 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
24080 if (EQ (prop
, Qcenter
))
24081 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
24082 + window_box_width (it
->w
, TEXT_AREA
) / 2);
24083 if (EQ (prop
, Qleft_fringe
))
24084 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24085 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
24086 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
24087 if (EQ (prop
, Qright_fringe
))
24088 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24089 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24090 : window_box_right_offset (it
->w
, TEXT_AREA
));
24091 if (EQ (prop
, Qleft_margin
))
24092 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
24093 if (EQ (prop
, Qright_margin
))
24094 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
24095 if (EQ (prop
, Qscroll_bar
))
24096 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
24098 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24099 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24100 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24105 if (EQ (prop
, Qleft_fringe
))
24106 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
24107 if (EQ (prop
, Qright_fringe
))
24108 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
24109 if (EQ (prop
, Qleft_margin
))
24110 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
24111 if (EQ (prop
, Qright_margin
))
24112 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
24113 if (EQ (prop
, Qscroll_bar
))
24114 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
24117 prop
= buffer_local_value (prop
, it
->w
->contents
);
24118 if (EQ (prop
, Qunbound
))
24122 if (NUMBERP (prop
))
24124 int base_unit
= (width_p
24125 ? FRAME_COLUMN_WIDTH (it
->f
)
24126 : FRAME_LINE_HEIGHT (it
->f
));
24127 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
24132 Lisp_Object car
= XCAR (prop
);
24133 Lisp_Object cdr
= XCDR (prop
);
24137 #ifdef HAVE_WINDOW_SYSTEM
24138 if (FRAME_WINDOW_P (it
->f
)
24139 && valid_image_p (prop
))
24141 ptrdiff_t id
= lookup_image (it
->f
, prop
);
24142 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
24144 return OK_PIXELS (width_p
? img
->width
: img
->height
);
24147 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
24153 while (CONSP (cdr
))
24155 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
24156 font
, width_p
, align_to
))
24159 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= false;
24164 if (EQ (car
, Qminus
))
24166 return OK_PIXELS (pixels
);
24169 car
= buffer_local_value (car
, it
->w
->contents
);
24170 if (EQ (car
, Qunbound
))
24177 pixels
= XFLOATINT (car
);
24179 return OK_PIXELS (pixels
);
24180 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
24181 font
, width_p
, align_to
))
24182 return OK_PIXELS (pixels
* fact
);
24193 get_font_ascent_descent (struct font
*font
, int *ascent
, int *descent
)
24195 #ifdef HAVE_WINDOW_SYSTEM
24196 normal_char_ascent_descent (font
, -1, ascent
, descent
);
24204 /***********************************************************************
24206 ***********************************************************************/
24208 #ifdef HAVE_WINDOW_SYSTEM
24213 dump_glyph_string (struct glyph_string
*s
)
24215 fprintf (stderr
, "glyph string\n");
24216 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
24217 s
->x
, s
->y
, s
->width
, s
->height
);
24218 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
24219 fprintf (stderr
, " hl = %d\n", s
->hl
);
24220 fprintf (stderr
, " left overhang = %d, right = %d\n",
24221 s
->left_overhang
, s
->right_overhang
);
24222 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
24223 fprintf (stderr
, " extends to end of line = %d\n",
24224 s
->extends_to_end_of_line_p
);
24225 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
24226 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
24229 #endif /* GLYPH_DEBUG */
24231 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
24232 of XChar2b structures for S; it can't be allocated in
24233 init_glyph_string because it must be allocated via `alloca'. W
24234 is the window on which S is drawn. ROW and AREA are the glyph row
24235 and area within the row from which S is constructed. START is the
24236 index of the first glyph structure covered by S. HL is a
24237 face-override for drawing S. */
24240 #define OPTIONAL_HDC(hdc) HDC hdc,
24241 #define DECLARE_HDC(hdc) HDC hdc;
24242 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
24243 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
24246 #ifndef OPTIONAL_HDC
24247 #define OPTIONAL_HDC(hdc)
24248 #define DECLARE_HDC(hdc)
24249 #define ALLOCATE_HDC(hdc, f)
24250 #define RELEASE_HDC(hdc, f)
24254 init_glyph_string (struct glyph_string
*s
,
24256 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
24257 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
24259 memset (s
, 0, sizeof *s
);
24261 s
->f
= XFRAME (w
->frame
);
24265 s
->display
= FRAME_X_DISPLAY (s
->f
);
24266 s
->window
= FRAME_X_WINDOW (s
->f
);
24267 s
->char2b
= char2b
;
24271 s
->first_glyph
= row
->glyphs
[area
] + start
;
24272 s
->height
= row
->height
;
24273 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
24274 s
->ybase
= s
->y
+ row
->ascent
;
24278 /* Append the list of glyph strings with head H and tail T to the list
24279 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
24282 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24283 struct glyph_string
*h
, struct glyph_string
*t
)
24297 /* Prepend the list of glyph strings with head H and tail T to the
24298 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
24302 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24303 struct glyph_string
*h
, struct glyph_string
*t
)
24317 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
24318 Set *HEAD and *TAIL to the resulting list. */
24321 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
24322 struct glyph_string
*s
)
24324 s
->next
= s
->prev
= NULL
;
24325 append_glyph_string_lists (head
, tail
, s
, s
);
24329 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24330 The encoding of C is returned in *CHAR2B. DISPLAY_P means
24331 make sure that X resources for the face returned are allocated.
24332 Value is a pointer to a realized face that is ready for display if
24335 static struct face
*
24336 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
24337 XChar2b
*char2b
, bool display_p
)
24339 struct face
*face
= FACE_FROM_ID (f
, face_id
);
24344 code
= face
->font
->driver
->encode_char (face
->font
, c
);
24346 if (code
== FONT_INVALID_CODE
)
24349 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24351 /* Make sure X resources of the face are allocated. */
24352 #ifdef HAVE_X_WINDOWS
24356 eassert (face
!= NULL
);
24357 prepare_face_for_display (f
, face
);
24364 /* Get face and two-byte form of character glyph GLYPH on frame F.
24365 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24366 a pointer to a realized face that is ready for display. */
24368 static struct face
*
24369 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24375 eassert (glyph
->type
== CHAR_GLYPH
);
24376 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24378 /* Make sure X resources of the face are allocated. */
24379 eassert (face
!= NULL
);
24380 prepare_face_for_display (f
, face
);
24384 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24385 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24387 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24389 if (code
== FONT_INVALID_CODE
)
24393 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24398 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24399 Return true iff FONT has a glyph for C. */
24402 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24406 if (CHAR_BYTE8_P (c
))
24407 code
= CHAR_TO_BYTE8 (c
);
24409 code
= font
->driver
->encode_char (font
, c
);
24411 if (code
== FONT_INVALID_CODE
)
24413 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24418 /* Fill glyph string S with composition components specified by S->cmp.
24420 BASE_FACE is the base face of the composition.
24421 S->cmp_from is the index of the first component for S.
24423 OVERLAPS non-zero means S should draw the foreground only, and use
24424 its physical height for clipping. See also draw_glyphs.
24426 Value is the index of a component not in S. */
24429 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24433 /* For all glyphs of this composition, starting at the offset
24434 S->cmp_from, until we reach the end of the definition or encounter a
24435 glyph that requires the different face, add it to S. */
24440 s
->for_overlaps
= overlaps
;
24443 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24445 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24447 /* TAB in a composition means display glyphs with padding space
24448 on the left or right. */
24451 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24454 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24455 s
->char2b
+ i
, true);
24461 s
->font
= s
->face
->font
;
24463 else if (s
->face
!= face
)
24471 if (s
->face
== NULL
)
24473 s
->face
= base_face
->ascii_face
;
24474 s
->font
= s
->face
->font
;
24477 /* All glyph strings for the same composition has the same width,
24478 i.e. the width set for the first component of the composition. */
24479 s
->width
= s
->first_glyph
->pixel_width
;
24481 /* If the specified font could not be loaded, use the frame's
24482 default font, but record the fact that we couldn't load it in
24483 the glyph string so that we can draw rectangles for the
24484 characters of the glyph string. */
24485 if (s
->font
== NULL
)
24487 s
->font_not_found_p
= true;
24488 s
->font
= FRAME_FONT (s
->f
);
24491 /* Adjust base line for subscript/superscript text. */
24492 s
->ybase
+= s
->first_glyph
->voffset
;
24498 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24499 int start
, int end
, int overlaps
)
24501 struct glyph
*glyph
, *last
;
24502 Lisp_Object lgstring
;
24505 s
->for_overlaps
= overlaps
;
24506 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24507 last
= s
->row
->glyphs
[s
->area
] + end
;
24508 s
->cmp_id
= glyph
->u
.cmp
.id
;
24509 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24510 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24511 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24512 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24513 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24515 while (glyph
< last
24516 && glyph
->u
.cmp
.automatic
24517 && glyph
->u
.cmp
.id
== s
->cmp_id
24518 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24519 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24521 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24523 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24524 unsigned code
= LGLYPH_CODE (lglyph
);
24526 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24528 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24529 return glyph
- s
->row
->glyphs
[s
->area
];
24533 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24534 See the comment of fill_glyph_string for arguments.
24535 Value is the index of the first glyph not in S. */
24539 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24540 int start
, int end
, int overlaps
)
24542 struct glyph
*glyph
, *last
;
24545 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24546 s
->for_overlaps
= overlaps
;
24547 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24548 last
= s
->row
->glyphs
[s
->area
] + end
;
24549 voffset
= glyph
->voffset
;
24550 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24551 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24553 s
->width
= glyph
->pixel_width
;
24555 while (glyph
< last
24556 && glyph
->type
== GLYPHLESS_GLYPH
24557 && glyph
->voffset
== voffset
24558 && glyph
->face_id
== face_id
)
24561 s
->width
+= glyph
->pixel_width
;
24564 s
->ybase
+= voffset
;
24565 return glyph
- s
->row
->glyphs
[s
->area
];
24569 /* Fill glyph string S from a sequence of character glyphs.
24571 FACE_ID is the face id of the string. START is the index of the
24572 first glyph to consider, END is the index of the last + 1.
24573 OVERLAPS non-zero means S should draw the foreground only, and use
24574 its physical height for clipping. See also draw_glyphs.
24576 Value is the index of the first glyph not in S. */
24579 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24580 int start
, int end
, int overlaps
)
24582 struct glyph
*glyph
, *last
;
24584 bool glyph_not_available_p
;
24586 eassert (s
->f
== XFRAME (s
->w
->frame
));
24587 eassert (s
->nchars
== 0);
24588 eassert (start
>= 0 && end
> start
);
24590 s
->for_overlaps
= overlaps
;
24591 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24592 last
= s
->row
->glyphs
[s
->area
] + end
;
24593 voffset
= glyph
->voffset
;
24594 s
->padding_p
= glyph
->padding_p
;
24595 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24597 while (glyph
< last
24598 && glyph
->type
== CHAR_GLYPH
24599 && glyph
->voffset
== voffset
24600 /* Same face id implies same font, nowadays. */
24601 && glyph
->face_id
== face_id
24602 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24604 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24605 s
->char2b
+ s
->nchars
);
24607 eassert (s
->nchars
<= end
- start
);
24608 s
->width
+= glyph
->pixel_width
;
24609 if (glyph
++->padding_p
!= s
->padding_p
)
24613 s
->font
= s
->face
->font
;
24615 /* If the specified font could not be loaded, use the frame's font,
24616 but record the fact that we couldn't load it in
24617 S->font_not_found_p so that we can draw rectangles for the
24618 characters of the glyph string. */
24619 if (s
->font
== NULL
|| glyph_not_available_p
)
24621 s
->font_not_found_p
= true;
24622 s
->font
= FRAME_FONT (s
->f
);
24625 /* Adjust base line for subscript/superscript text. */
24626 s
->ybase
+= voffset
;
24628 eassert (s
->face
&& s
->face
->gc
);
24629 return glyph
- s
->row
->glyphs
[s
->area
];
24633 /* Fill glyph string S from image glyph S->first_glyph. */
24636 fill_image_glyph_string (struct glyph_string
*s
)
24638 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24639 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24641 s
->slice
= s
->first_glyph
->slice
.img
;
24642 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24643 s
->font
= s
->face
->font
;
24644 s
->width
= s
->first_glyph
->pixel_width
;
24646 /* Adjust base line for subscript/superscript text. */
24647 s
->ybase
+= s
->first_glyph
->voffset
;
24651 /* Fill glyph string S from a sequence of stretch glyphs.
24653 START is the index of the first glyph to consider,
24654 END is the index of the last + 1.
24656 Value is the index of the first glyph not in S. */
24659 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24661 struct glyph
*glyph
, *last
;
24662 int voffset
, face_id
;
24664 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24666 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24667 last
= s
->row
->glyphs
[s
->area
] + end
;
24668 face_id
= glyph
->face_id
;
24669 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24670 s
->font
= s
->face
->font
;
24671 s
->width
= glyph
->pixel_width
;
24673 voffset
= glyph
->voffset
;
24677 && glyph
->type
== STRETCH_GLYPH
24678 && glyph
->voffset
== voffset
24679 && glyph
->face_id
== face_id
);
24681 s
->width
+= glyph
->pixel_width
;
24683 /* Adjust base line for subscript/superscript text. */
24684 s
->ybase
+= voffset
;
24686 /* The case that face->gc == 0 is handled when drawing the glyph
24687 string by calling prepare_face_for_display. */
24689 return glyph
- s
->row
->glyphs
[s
->area
];
24692 static struct font_metrics
*
24693 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24695 static struct font_metrics metrics
;
24700 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24701 if (code
== FONT_INVALID_CODE
)
24703 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24707 /* A subroutine that computes "normal" values of ASCENT and DESCENT
24708 for FONT. Values are taken from font-global ones, except for fonts
24709 that claim preposterously large values, but whose glyphs actually
24710 have reasonable dimensions. C is the character to use for metrics
24711 if the font-global values are too large; if C is negative, the
24712 function selects a default character. */
24714 normal_char_ascent_descent (struct font
*font
, int c
, int *ascent
, int *descent
)
24716 *ascent
= FONT_BASE (font
);
24717 *descent
= FONT_DESCENT (font
);
24719 if (FONT_TOO_HIGH (font
))
24723 /* Get metrics of C, defaulting to a reasonably sized ASCII
24725 if (get_char_glyph_code (c
>= 0 ? c
: '{', font
, &char2b
))
24727 struct font_metrics
*pcm
= get_per_char_metric (font
, &char2b
);
24729 if (!(pcm
->width
== 0 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0))
24731 /* We add 1 pixel to character dimensions as heuristics
24732 that produces nicer display, e.g. when the face has
24733 the box attribute. */
24734 *ascent
= pcm
->ascent
+ 1;
24735 *descent
= pcm
->descent
+ 1;
24741 /* A subroutine that computes a reasonable "normal character height"
24742 for fonts that claim preposterously large vertical dimensions, but
24743 whose glyphs are actually reasonably sized. C is the character
24744 whose metrics to use for those fonts, or -1 for default
24747 normal_char_height (struct font
*font
, int c
)
24749 int ascent
, descent
;
24751 normal_char_ascent_descent (font
, c
, &ascent
, &descent
);
24753 return ascent
+ descent
;
24757 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24758 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24759 assumed to be zero. */
24762 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24764 *left
= *right
= 0;
24766 if (glyph
->type
== CHAR_GLYPH
)
24769 struct face
*face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
);
24772 struct font_metrics
*pcm
= get_per_char_metric (face
->font
, &char2b
);
24775 if (pcm
->rbearing
> pcm
->width
)
24776 *right
= pcm
->rbearing
- pcm
->width
;
24777 if (pcm
->lbearing
< 0)
24778 *left
= -pcm
->lbearing
;
24782 else if (glyph
->type
== COMPOSITE_GLYPH
)
24784 if (! glyph
->u
.cmp
.automatic
)
24786 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24788 if (cmp
->rbearing
> cmp
->pixel_width
)
24789 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24790 if (cmp
->lbearing
< 0)
24791 *left
= - cmp
->lbearing
;
24795 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24796 struct font_metrics metrics
;
24798 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24799 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24800 if (metrics
.rbearing
> metrics
.width
)
24801 *right
= metrics
.rbearing
- metrics
.width
;
24802 if (metrics
.lbearing
< 0)
24803 *left
= - metrics
.lbearing
;
24809 /* Return the index of the first glyph preceding glyph string S that
24810 is overwritten by S because of S's left overhang. Value is -1
24811 if no glyphs are overwritten. */
24814 left_overwritten (struct glyph_string
*s
)
24818 if (s
->left_overhang
)
24821 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24822 int first
= s
->first_glyph
- glyphs
;
24824 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24825 x
-= glyphs
[i
].pixel_width
;
24836 /* Return the index of the first glyph preceding glyph string S that
24837 is overwriting S because of its right overhang. Value is -1 if no
24838 glyph in front of S overwrites S. */
24841 left_overwriting (struct glyph_string
*s
)
24844 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24845 int first
= s
->first_glyph
- glyphs
;
24849 for (i
= first
- 1; i
>= 0; --i
)
24852 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24855 x
-= glyphs
[i
].pixel_width
;
24862 /* Return the index of the last glyph following glyph string S that is
24863 overwritten by S because of S's right overhang. Value is -1 if
24864 no such glyph is found. */
24867 right_overwritten (struct glyph_string
*s
)
24871 if (s
->right_overhang
)
24874 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24875 int first
= (s
->first_glyph
- glyphs
24876 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24877 int end
= s
->row
->used
[s
->area
];
24879 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24880 x
+= glyphs
[i
].pixel_width
;
24889 /* Return the index of the last glyph following glyph string S that
24890 overwrites S because of its left overhang. Value is negative
24891 if no such glyph is found. */
24894 right_overwriting (struct glyph_string
*s
)
24897 int end
= s
->row
->used
[s
->area
];
24898 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24899 int first
= (s
->first_glyph
- glyphs
24900 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24904 for (i
= first
; i
< end
; ++i
)
24907 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24910 x
+= glyphs
[i
].pixel_width
;
24917 /* Set background width of glyph string S. START is the index of the
24918 first glyph following S. LAST_X is the right-most x-position + 1
24919 in the drawing area. */
24922 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24924 /* If the face of this glyph string has to be drawn to the end of
24925 the drawing area, set S->extends_to_end_of_line_p. */
24927 if (start
== s
->row
->used
[s
->area
]
24928 && ((s
->row
->fill_line_p
24929 && (s
->hl
== DRAW_NORMAL_TEXT
24930 || s
->hl
== DRAW_IMAGE_RAISED
24931 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24932 || s
->hl
== DRAW_MOUSE_FACE
))
24933 s
->extends_to_end_of_line_p
= true;
24935 /* If S extends its face to the end of the line, set its
24936 background_width to the distance to the right edge of the drawing
24938 if (s
->extends_to_end_of_line_p
)
24939 s
->background_width
= last_x
- s
->x
+ 1;
24941 s
->background_width
= s
->width
;
24945 /* Compute overhangs and x-positions for glyph string S and its
24946 predecessors, or successors. X is the starting x-position for S.
24947 BACKWARD_P means process predecessors. */
24950 compute_overhangs_and_x (struct glyph_string
*s
, int x
, bool backward_p
)
24956 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24957 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24967 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24968 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24978 /* The following macros are only called from draw_glyphs below.
24979 They reference the following parameters of that function directly:
24980 `w', `row', `area', and `overlap_p'
24981 as well as the following local variables:
24982 `s', `f', and `hdc' (in W32) */
24985 /* On W32, silently add local `hdc' variable to argument list of
24986 init_glyph_string. */
24987 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24988 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24990 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24991 init_glyph_string (s, char2b, w, row, area, start, hl)
24994 /* Add a glyph string for a stretch glyph to the list of strings
24995 between HEAD and TAIL. START is the index of the stretch glyph in
24996 row area AREA of glyph row ROW. END is the index of the last glyph
24997 in that glyph row area. X is the current output position assigned
24998 to the new glyph string constructed. HL overrides that face of the
24999 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25000 is the right-most x-position of the drawing area. */
25002 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
25003 and below -- keep them on one line. */
25004 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25007 s = alloca (sizeof *s); \
25008 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25009 START = fill_stretch_glyph_string (s, START, END); \
25010 append_glyph_string (&HEAD, &TAIL, s); \
25016 /* Add a glyph string for an image glyph to the list of strings
25017 between HEAD and TAIL. START is the index of the image glyph in
25018 row area AREA of glyph row ROW. END is the index of the last glyph
25019 in that glyph row area. X is the current output position assigned
25020 to the new glyph string constructed. HL overrides that face of the
25021 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25022 is the right-most x-position of the drawing area. */
25024 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25027 s = alloca (sizeof *s); \
25028 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25029 fill_image_glyph_string (s); \
25030 append_glyph_string (&HEAD, &TAIL, s); \
25037 /* Add a glyph string for a sequence of character glyphs to the list
25038 of strings between HEAD and TAIL. START is the index of the first
25039 glyph in row area AREA of glyph row ROW that is part of the new
25040 glyph string. END is the index of the last glyph in that glyph row
25041 area. X is the current output position assigned to the new glyph
25042 string constructed. HL overrides that face of the glyph; e.g. it
25043 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
25044 right-most x-position of the drawing area. */
25046 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25052 face_id = (row)->glyphs[area][START].face_id; \
25054 s = alloca (sizeof *s); \
25055 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
25056 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25057 append_glyph_string (&HEAD, &TAIL, s); \
25059 START = fill_glyph_string (s, face_id, START, END, overlaps); \
25064 /* Add a glyph string for a composite sequence to the list of strings
25065 between HEAD and TAIL. START is the index of the first glyph in
25066 row area AREA of glyph row ROW that is part of the new glyph
25067 string. END is the index of the last glyph in that glyph row area.
25068 X is the current output position assigned to the new glyph string
25069 constructed. HL overrides that face of the glyph; e.g. it is
25070 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
25071 x-position of the drawing area. */
25073 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25075 int face_id = (row)->glyphs[area][START].face_id; \
25076 struct face *base_face = FACE_FROM_ID (f, face_id); \
25077 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
25078 struct composition *cmp = composition_table[cmp_id]; \
25080 struct glyph_string *first_s = NULL; \
25083 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
25085 /* Make glyph_strings for each glyph sequence that is drawable by \
25086 the same face, and append them to HEAD/TAIL. */ \
25087 for (n = 0; n < cmp->glyph_len;) \
25089 s = alloca (sizeof *s); \
25090 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25091 append_glyph_string (&(HEAD), &(TAIL), s); \
25097 n = fill_composite_glyph_string (s, base_face, overlaps); \
25105 /* Add a glyph string for a glyph-string sequence to the list of strings
25106 between HEAD and TAIL. */
25108 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25112 Lisp_Object gstring; \
25114 face_id = (row)->glyphs[area][START].face_id; \
25115 gstring = (composition_gstring_from_id \
25116 ((row)->glyphs[area][START].u.cmp.id)); \
25117 s = alloca (sizeof *s); \
25118 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
25119 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25120 append_glyph_string (&(HEAD), &(TAIL), s); \
25122 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
25126 /* Add a glyph string for a sequence of glyphless character's glyphs
25127 to the list of strings between HEAD and TAIL. The meanings of
25128 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
25130 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25135 face_id = (row)->glyphs[area][START].face_id; \
25137 s = alloca (sizeof *s); \
25138 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25139 append_glyph_string (&HEAD, &TAIL, s); \
25141 START = fill_glyphless_glyph_string (s, face_id, START, END, \
25147 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
25148 of AREA of glyph row ROW on window W between indices START and END.
25149 HL overrides the face for drawing glyph strings, e.g. it is
25150 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
25151 x-positions of the drawing area.
25153 This is an ugly monster macro construct because we must use alloca
25154 to allocate glyph strings (because draw_glyphs can be called
25155 asynchronously). */
25157 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25160 HEAD = TAIL = NULL; \
25161 while (START < END) \
25163 struct glyph *first_glyph = (row)->glyphs[area] + START; \
25164 switch (first_glyph->type) \
25167 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
25171 case COMPOSITE_GLYPH: \
25172 if (first_glyph->u.cmp.automatic) \
25173 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
25176 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
25180 case STRETCH_GLYPH: \
25181 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
25185 case IMAGE_GLYPH: \
25186 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
25190 case GLYPHLESS_GLYPH: \
25191 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
25201 set_glyph_string_background_width (s, START, LAST_X); \
25208 /* Draw glyphs between START and END in AREA of ROW on window W,
25209 starting at x-position X. X is relative to AREA in W. HL is a
25210 face-override with the following meaning:
25212 DRAW_NORMAL_TEXT draw normally
25213 DRAW_CURSOR draw in cursor face
25214 DRAW_MOUSE_FACE draw in mouse face.
25215 DRAW_INVERSE_VIDEO draw in mode line face
25216 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
25217 DRAW_IMAGE_RAISED draw an image with a raised relief around it
25219 If OVERLAPS is non-zero, draw only the foreground of characters and
25220 clip to the physical height of ROW. Non-zero value also defines
25221 the overlapping part to be drawn:
25223 OVERLAPS_PRED overlap with preceding rows
25224 OVERLAPS_SUCC overlap with succeeding rows
25225 OVERLAPS_BOTH overlap with both preceding/succeeding rows
25226 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
25228 Value is the x-position reached, relative to AREA of W. */
25231 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
25232 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
25233 enum draw_glyphs_face hl
, int overlaps
)
25235 struct glyph_string
*head
, *tail
;
25236 struct glyph_string
*s
;
25237 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
25238 int i
, j
, x_reached
, last_x
, area_left
= 0;
25239 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25242 ALLOCATE_HDC (hdc
, f
);
25244 /* Let's rather be paranoid than getting a SEGV. */
25245 end
= min (end
, row
->used
[area
]);
25246 start
= clip_to_bounds (0, start
, end
);
25248 /* Translate X to frame coordinates. Set last_x to the right
25249 end of the drawing area. */
25250 if (row
->full_width_p
)
25252 /* X is relative to the left edge of W, without scroll bars
25254 area_left
= WINDOW_LEFT_EDGE_X (w
);
25255 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
25256 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
25260 area_left
= window_box_left (w
, area
);
25261 last_x
= area_left
+ window_box_width (w
, area
);
25265 /* Build a doubly-linked list of glyph_string structures between
25266 head and tail from what we have to draw. Note that the macro
25267 BUILD_GLYPH_STRINGS will modify its start parameter. That's
25268 the reason we use a separate variable `i'. */
25271 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
25273 x_reached
= tail
->x
+ tail
->background_width
;
25277 /* If there are any glyphs with lbearing < 0 or rbearing > width in
25278 the row, redraw some glyphs in front or following the glyph
25279 strings built above. */
25280 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
25282 struct glyph_string
*h
, *t
;
25283 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25284 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
25285 bool check_mouse_face
= false;
25288 /* If mouse highlighting is on, we may need to draw adjacent
25289 glyphs using mouse-face highlighting. */
25290 if (area
== TEXT_AREA
&& row
->mouse_face_p
25291 && hlinfo
->mouse_face_beg_row
>= 0
25292 && hlinfo
->mouse_face_end_row
>= 0)
25294 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
25296 if (row_vpos
>= hlinfo
->mouse_face_beg_row
25297 && row_vpos
<= hlinfo
->mouse_face_end_row
)
25299 check_mouse_face
= true;
25300 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
25301 ? hlinfo
->mouse_face_beg_col
: 0;
25302 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
25303 ? hlinfo
->mouse_face_end_col
25304 : row
->used
[TEXT_AREA
];
25308 /* Compute overhangs for all glyph strings. */
25309 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
25310 for (s
= head
; s
; s
= s
->next
)
25311 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
25313 /* Prepend glyph strings for glyphs in front of the first glyph
25314 string that are overwritten because of the first glyph
25315 string's left overhang. The background of all strings
25316 prepended must be drawn because the first glyph string
25318 i
= left_overwritten (head
);
25321 enum draw_glyphs_face overlap_hl
;
25323 /* If this row contains mouse highlighting, attempt to draw
25324 the overlapped glyphs with the correct highlight. This
25325 code fails if the overlap encompasses more than one glyph
25326 and mouse-highlight spans only some of these glyphs.
25327 However, making it work perfectly involves a lot more
25328 code, and I don't know if the pathological case occurs in
25329 practice, so we'll stick to this for now. --- cyd */
25330 if (check_mouse_face
25331 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25332 overlap_hl
= DRAW_MOUSE_FACE
;
25334 overlap_hl
= DRAW_NORMAL_TEXT
;
25336 if (hl
!= overlap_hl
)
25339 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
25340 overlap_hl
, dummy_x
, last_x
);
25342 compute_overhangs_and_x (t
, head
->x
, true);
25343 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25344 if (clip_head
== NULL
)
25348 /* Prepend glyph strings for glyphs in front of the first glyph
25349 string that overwrite that glyph string because of their
25350 right overhang. For these strings, only the foreground must
25351 be drawn, because it draws over the glyph string at `head'.
25352 The background must not be drawn because this would overwrite
25353 right overhangs of preceding glyphs for which no glyph
25355 i
= left_overwriting (head
);
25358 enum draw_glyphs_face overlap_hl
;
25360 if (check_mouse_face
25361 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25362 overlap_hl
= DRAW_MOUSE_FACE
;
25364 overlap_hl
= DRAW_NORMAL_TEXT
;
25366 if (hl
== overlap_hl
|| clip_head
== NULL
)
25368 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
25369 overlap_hl
, dummy_x
, last_x
);
25370 for (s
= h
; s
; s
= s
->next
)
25371 s
->background_filled_p
= true;
25372 compute_overhangs_and_x (t
, head
->x
, true);
25373 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25376 /* Append glyphs strings for glyphs following the last glyph
25377 string tail that are overwritten by tail. The background of
25378 these strings has to be drawn because tail's foreground draws
25380 i
= right_overwritten (tail
);
25383 enum draw_glyphs_face overlap_hl
;
25385 if (check_mouse_face
25386 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25387 overlap_hl
= DRAW_MOUSE_FACE
;
25389 overlap_hl
= DRAW_NORMAL_TEXT
;
25391 if (hl
!= overlap_hl
)
25393 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25394 overlap_hl
, x
, last_x
);
25395 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25396 we don't have `end = i;' here. */
25397 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25398 append_glyph_string_lists (&head
, &tail
, h
, t
);
25399 if (clip_tail
== NULL
)
25403 /* Append glyph strings for glyphs following the last glyph
25404 string tail that overwrite tail. The foreground of such
25405 glyphs has to be drawn because it writes into the background
25406 of tail. The background must not be drawn because it could
25407 paint over the foreground of following glyphs. */
25408 i
= right_overwriting (tail
);
25411 enum draw_glyphs_face overlap_hl
;
25412 if (check_mouse_face
25413 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25414 overlap_hl
= DRAW_MOUSE_FACE
;
25416 overlap_hl
= DRAW_NORMAL_TEXT
;
25418 if (hl
== overlap_hl
|| clip_tail
== NULL
)
25420 i
++; /* We must include the Ith glyph. */
25421 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25422 overlap_hl
, x
, last_x
);
25423 for (s
= h
; s
; s
= s
->next
)
25424 s
->background_filled_p
= true;
25425 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25426 append_glyph_string_lists (&head
, &tail
, h
, t
);
25428 if (clip_head
|| clip_tail
)
25429 for (s
= head
; s
; s
= s
->next
)
25431 s
->clip_head
= clip_head
;
25432 s
->clip_tail
= clip_tail
;
25436 /* Draw all strings. */
25437 for (s
= head
; s
; s
= s
->next
)
25438 FRAME_RIF (f
)->draw_glyph_string (s
);
25441 /* When focus a sole frame and move horizontally, this clears on_p
25442 causing a failure to erase prev cursor position. */
25443 if (area
== TEXT_AREA
25444 && !row
->full_width_p
25445 /* When drawing overlapping rows, only the glyph strings'
25446 foreground is drawn, which doesn't erase a cursor
25450 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25451 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25452 : (tail
? tail
->x
+ tail
->background_width
: x
));
25456 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25457 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25461 /* Value is the x-position up to which drawn, relative to AREA of W.
25462 This doesn't include parts drawn because of overhangs. */
25463 if (row
->full_width_p
)
25464 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25466 x_reached
-= area_left
;
25468 RELEASE_HDC (hdc
, f
);
25474 /* Expand row matrix if too narrow. Don't expand if area
25477 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25479 if (!it->f->fonts_changed \
25480 && (it->glyph_row->glyphs[area] \
25481 < it->glyph_row->glyphs[area + 1])) \
25483 it->w->ncols_scale_factor++; \
25484 it->f->fonts_changed = true; \
25488 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25489 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25492 append_glyph (struct it
*it
)
25494 struct glyph
*glyph
;
25495 enum glyph_row_area area
= it
->area
;
25497 eassert (it
->glyph_row
);
25498 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25500 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25501 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25503 /* If the glyph row is reversed, we need to prepend the glyph
25504 rather than append it. */
25505 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25509 /* Make room for the additional glyph. */
25510 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25512 glyph
= it
->glyph_row
->glyphs
[area
];
25514 glyph
->charpos
= CHARPOS (it
->position
);
25515 glyph
->object
= it
->object
;
25516 if (it
->pixel_width
> 0)
25518 glyph
->pixel_width
= it
->pixel_width
;
25519 glyph
->padding_p
= false;
25523 /* Assure at least 1-pixel width. Otherwise, cursor can't
25524 be displayed correctly. */
25525 glyph
->pixel_width
= 1;
25526 glyph
->padding_p
= true;
25528 glyph
->ascent
= it
->ascent
;
25529 glyph
->descent
= it
->descent
;
25530 glyph
->voffset
= it
->voffset
;
25531 glyph
->type
= CHAR_GLYPH
;
25532 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25533 glyph
->multibyte_p
= it
->multibyte_p
;
25534 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25536 /* In R2L rows, the left and the right box edges need to be
25537 drawn in reverse direction. */
25538 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25539 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25543 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25544 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25546 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25547 || it
->phys_descent
> it
->descent
);
25548 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25549 glyph
->face_id
= it
->face_id
;
25550 glyph
->u
.ch
= it
->char_to_display
;
25551 glyph
->slice
.img
= null_glyph_slice
;
25552 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25555 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25556 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25557 glyph
->bidi_type
= it
->bidi_it
.type
;
25561 glyph
->resolved_level
= 0;
25562 glyph
->bidi_type
= UNKNOWN_BT
;
25564 ++it
->glyph_row
->used
[area
];
25567 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25570 /* Store one glyph for the composition IT->cmp_it.id in
25571 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25575 append_composite_glyph (struct it
*it
)
25577 struct glyph
*glyph
;
25578 enum glyph_row_area area
= it
->area
;
25580 eassert (it
->glyph_row
);
25582 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25583 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25585 /* If the glyph row is reversed, we need to prepend the glyph
25586 rather than append it. */
25587 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25591 /* Make room for the new glyph. */
25592 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25594 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25596 glyph
->charpos
= it
->cmp_it
.charpos
;
25597 glyph
->object
= it
->object
;
25598 glyph
->pixel_width
= it
->pixel_width
;
25599 glyph
->ascent
= it
->ascent
;
25600 glyph
->descent
= it
->descent
;
25601 glyph
->voffset
= it
->voffset
;
25602 glyph
->type
= COMPOSITE_GLYPH
;
25603 if (it
->cmp_it
.ch
< 0)
25605 glyph
->u
.cmp
.automatic
= false;
25606 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25607 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25611 glyph
->u
.cmp
.automatic
= true;
25612 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25613 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25614 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25616 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25617 glyph
->multibyte_p
= it
->multibyte_p
;
25618 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25620 /* In R2L rows, the left and the right box edges need to be
25621 drawn in reverse direction. */
25622 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25623 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25627 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25628 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25630 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25631 || it
->phys_descent
> it
->descent
);
25632 glyph
->padding_p
= false;
25633 glyph
->glyph_not_available_p
= false;
25634 glyph
->face_id
= it
->face_id
;
25635 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25638 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25639 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25640 glyph
->bidi_type
= it
->bidi_it
.type
;
25642 ++it
->glyph_row
->used
[area
];
25645 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25649 /* Change IT->ascent and IT->height according to the setting of
25653 take_vertical_position_into_account (struct it
*it
)
25657 if (it
->voffset
< 0)
25658 /* Increase the ascent so that we can display the text higher
25660 it
->ascent
-= it
->voffset
;
25662 /* Increase the descent so that we can display the text lower
25664 it
->descent
+= it
->voffset
;
25669 /* Produce glyphs/get display metrics for the image IT is loaded with.
25670 See the description of struct display_iterator in dispextern.h for
25671 an overview of struct display_iterator. */
25674 produce_image_glyph (struct it
*it
)
25678 int glyph_ascent
, crop
;
25679 struct glyph_slice slice
;
25681 eassert (it
->what
== IT_IMAGE
);
25683 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25685 /* Make sure X resources of the face is loaded. */
25686 prepare_face_for_display (it
->f
, face
);
25688 if (it
->image_id
< 0)
25690 /* Fringe bitmap. */
25691 it
->ascent
= it
->phys_ascent
= 0;
25692 it
->descent
= it
->phys_descent
= 0;
25693 it
->pixel_width
= 0;
25698 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25700 /* Make sure X resources of the image is loaded. */
25701 prepare_image_for_display (it
->f
, img
);
25703 slice
.x
= slice
.y
= 0;
25704 slice
.width
= img
->width
;
25705 slice
.height
= img
->height
;
25707 if (INTEGERP (it
->slice
.x
))
25708 slice
.x
= XINT (it
->slice
.x
);
25709 else if (FLOATP (it
->slice
.x
))
25710 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25712 if (INTEGERP (it
->slice
.y
))
25713 slice
.y
= XINT (it
->slice
.y
);
25714 else if (FLOATP (it
->slice
.y
))
25715 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25717 if (INTEGERP (it
->slice
.width
))
25718 slice
.width
= XINT (it
->slice
.width
);
25719 else if (FLOATP (it
->slice
.width
))
25720 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25722 if (INTEGERP (it
->slice
.height
))
25723 slice
.height
= XINT (it
->slice
.height
);
25724 else if (FLOATP (it
->slice
.height
))
25725 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25727 if (slice
.x
>= img
->width
)
25728 slice
.x
= img
->width
;
25729 if (slice
.y
>= img
->height
)
25730 slice
.y
= img
->height
;
25731 if (slice
.x
+ slice
.width
>= img
->width
)
25732 slice
.width
= img
->width
- slice
.x
;
25733 if (slice
.y
+ slice
.height
> img
->height
)
25734 slice
.height
= img
->height
- slice
.y
;
25736 if (slice
.width
== 0 || slice
.height
== 0)
25739 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25741 it
->descent
= slice
.height
- glyph_ascent
;
25743 it
->descent
+= img
->vmargin
;
25744 if (slice
.y
+ slice
.height
== img
->height
)
25745 it
->descent
+= img
->vmargin
;
25746 it
->phys_descent
= it
->descent
;
25748 it
->pixel_width
= slice
.width
;
25750 it
->pixel_width
+= img
->hmargin
;
25751 if (slice
.x
+ slice
.width
== img
->width
)
25752 it
->pixel_width
+= img
->hmargin
;
25754 /* It's quite possible for images to have an ascent greater than
25755 their height, so don't get confused in that case. */
25756 if (it
->descent
< 0)
25761 if (face
->box
!= FACE_NO_BOX
)
25763 if (face
->box_line_width
> 0)
25766 it
->ascent
+= face
->box_line_width
;
25767 if (slice
.y
+ slice
.height
== img
->height
)
25768 it
->descent
+= face
->box_line_width
;
25771 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25772 it
->pixel_width
+= eabs (face
->box_line_width
);
25773 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25774 it
->pixel_width
+= eabs (face
->box_line_width
);
25777 take_vertical_position_into_account (it
);
25779 /* Automatically crop wide image glyphs at right edge so we can
25780 draw the cursor on same display row. */
25781 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25782 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25784 it
->pixel_width
-= crop
;
25785 slice
.width
-= crop
;
25790 struct glyph
*glyph
;
25791 enum glyph_row_area area
= it
->area
;
25793 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25794 if (it
->glyph_row
->reversed_p
)
25798 /* Make room for the new glyph. */
25799 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25801 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25803 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25805 glyph
->charpos
= CHARPOS (it
->position
);
25806 glyph
->object
= it
->object
;
25807 glyph
->pixel_width
= it
->pixel_width
;
25808 glyph
->ascent
= glyph_ascent
;
25809 glyph
->descent
= it
->descent
;
25810 glyph
->voffset
= it
->voffset
;
25811 glyph
->type
= IMAGE_GLYPH
;
25812 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25813 glyph
->multibyte_p
= it
->multibyte_p
;
25814 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25816 /* In R2L rows, the left and the right box edges need to be
25817 drawn in reverse direction. */
25818 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25819 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25823 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25824 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25826 glyph
->overlaps_vertically_p
= false;
25827 glyph
->padding_p
= false;
25828 glyph
->glyph_not_available_p
= false;
25829 glyph
->face_id
= it
->face_id
;
25830 glyph
->u
.img_id
= img
->id
;
25831 glyph
->slice
.img
= slice
;
25832 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25835 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25836 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25837 glyph
->bidi_type
= it
->bidi_it
.type
;
25839 ++it
->glyph_row
->used
[area
];
25842 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25847 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25848 of the glyph, WIDTH and HEIGHT are the width and height of the
25849 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25852 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25853 int width
, int height
, int ascent
)
25855 struct glyph
*glyph
;
25856 enum glyph_row_area area
= it
->area
;
25858 eassert (ascent
>= 0 && ascent
<= height
);
25860 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25861 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25863 /* If the glyph row is reversed, we need to prepend the glyph
25864 rather than append it. */
25865 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25869 /* Make room for the additional glyph. */
25870 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25872 glyph
= it
->glyph_row
->glyphs
[area
];
25874 /* Decrease the width of the first glyph of the row that
25875 begins before first_visible_x (e.g., due to hscroll).
25876 This is so the overall width of the row becomes smaller
25877 by the scroll amount, and the stretch glyph appended by
25878 extend_face_to_end_of_line will be wider, to shift the
25879 row glyphs to the right. (In L2R rows, the corresponding
25880 left-shift effect is accomplished by setting row->x to a
25881 negative value, which won't work with R2L rows.)
25883 This must leave us with a positive value of WIDTH, since
25884 otherwise the call to move_it_in_display_line_to at the
25885 beginning of display_line would have got past the entire
25886 first glyph, and then it->current_x would have been
25887 greater or equal to it->first_visible_x. */
25888 if (it
->current_x
< it
->first_visible_x
)
25889 width
-= it
->first_visible_x
- it
->current_x
;
25890 eassert (width
> 0);
25892 glyph
->charpos
= CHARPOS (it
->position
);
25893 glyph
->object
= object
;
25894 glyph
->pixel_width
= width
;
25895 glyph
->ascent
= ascent
;
25896 glyph
->descent
= height
- ascent
;
25897 glyph
->voffset
= it
->voffset
;
25898 glyph
->type
= STRETCH_GLYPH
;
25899 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25900 glyph
->multibyte_p
= it
->multibyte_p
;
25901 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25903 /* In R2L rows, the left and the right box edges need to be
25904 drawn in reverse direction. */
25905 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25906 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25910 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25911 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25913 glyph
->overlaps_vertically_p
= false;
25914 glyph
->padding_p
= false;
25915 glyph
->glyph_not_available_p
= false;
25916 glyph
->face_id
= it
->face_id
;
25917 glyph
->u
.stretch
.ascent
= ascent
;
25918 glyph
->u
.stretch
.height
= height
;
25919 glyph
->slice
.img
= null_glyph_slice
;
25920 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25923 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25924 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25925 glyph
->bidi_type
= it
->bidi_it
.type
;
25929 glyph
->resolved_level
= 0;
25930 glyph
->bidi_type
= UNKNOWN_BT
;
25932 ++it
->glyph_row
->used
[area
];
25935 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25938 #endif /* HAVE_WINDOW_SYSTEM */
25940 /* Produce a stretch glyph for iterator IT. IT->object is the value
25941 of the glyph property displayed. The value must be a list
25942 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25945 1. `:width WIDTH' specifies that the space should be WIDTH *
25946 canonical char width wide. WIDTH may be an integer or floating
25949 2. `:relative-width FACTOR' specifies that the width of the stretch
25950 should be computed from the width of the first character having the
25951 `glyph' property, and should be FACTOR times that width.
25953 3. `:align-to HPOS' specifies that the space should be wide enough
25954 to reach HPOS, a value in canonical character units.
25956 Exactly one of the above pairs must be present.
25958 4. `:height HEIGHT' specifies that the height of the stretch produced
25959 should be HEIGHT, measured in canonical character units.
25961 5. `:relative-height FACTOR' specifies that the height of the
25962 stretch should be FACTOR times the height of the characters having
25963 the glyph property.
25965 Either none or exactly one of 4 or 5 must be present.
25967 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25968 of the stretch should be used for the ascent of the stretch.
25969 ASCENT must be in the range 0 <= ASCENT <= 100. */
25972 produce_stretch_glyph (struct it
*it
)
25974 /* (space :width WIDTH :height HEIGHT ...) */
25975 Lisp_Object prop
, plist
;
25976 int width
= 0, height
= 0, align_to
= -1;
25977 bool zero_width_ok_p
= false;
25979 struct font
*font
= NULL
;
25981 #ifdef HAVE_WINDOW_SYSTEM
25983 bool zero_height_ok_p
= false;
25985 if (FRAME_WINDOW_P (it
->f
))
25987 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25988 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25989 prepare_face_for_display (it
->f
, face
);
25993 /* List should start with `space'. */
25994 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
25995 plist
= XCDR (it
->object
);
25997 /* Compute the width of the stretch. */
25998 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
25999 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true, 0))
26001 /* Absolute width `:width WIDTH' specified and valid. */
26002 zero_width_ok_p
= true;
26005 else if (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0)
26007 /* Relative width `:relative-width FACTOR' specified and valid.
26008 Compute the width of the characters having the `glyph'
26011 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
26014 if (it
->multibyte_p
)
26015 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
26018 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
26019 if (! ASCII_CHAR_P (it2
.c
))
26020 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
26023 it2
.glyph_row
= NULL
;
26024 it2
.what
= IT_CHARACTER
;
26025 PRODUCE_GLYPHS (&it2
);
26026 width
= NUMVAL (prop
) * it2
.pixel_width
;
26028 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
26029 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true,
26032 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
26033 align_to
= (align_to
< 0
26035 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
26036 else if (align_to
< 0)
26037 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
26038 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
26039 zero_width_ok_p
= true;
26042 /* Nothing specified -> width defaults to canonical char width. */
26043 width
= FRAME_COLUMN_WIDTH (it
->f
);
26045 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
26048 #ifdef HAVE_WINDOW_SYSTEM
26049 /* Compute height. */
26050 if (FRAME_WINDOW_P (it
->f
))
26052 int default_height
= normal_char_height (font
, ' ');
26054 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
26055 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26058 zero_height_ok_p
= true;
26060 else if (prop
= Fplist_get (plist
, QCrelative_height
),
26062 height
= default_height
* NUMVAL (prop
);
26064 height
= default_height
;
26066 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
26069 /* Compute percentage of height used for ascent. If
26070 `:ascent ASCENT' is present and valid, use that. Otherwise,
26071 derive the ascent from the font in use. */
26072 if (prop
= Fplist_get (plist
, QCascent
),
26073 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
26074 ascent
= height
* NUMVAL (prop
) / 100.0;
26075 else if (!NILP (prop
)
26076 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26077 ascent
= min (max (0, (int)tem
), height
);
26079 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
26082 #endif /* HAVE_WINDOW_SYSTEM */
26085 if (width
> 0 && it
->line_wrap
!= TRUNCATE
26086 && it
->current_x
+ width
> it
->last_visible_x
)
26088 width
= it
->last_visible_x
- it
->current_x
;
26089 #ifdef HAVE_WINDOW_SYSTEM
26090 /* Subtract one more pixel from the stretch width, but only on
26091 GUI frames, since on a TTY each glyph is one "pixel" wide. */
26092 width
-= FRAME_WINDOW_P (it
->f
);
26096 if (width
> 0 && height
> 0 && it
->glyph_row
)
26098 Lisp_Object o_object
= it
->object
;
26099 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
26102 if (!STRINGP (object
))
26103 object
= it
->w
->contents
;
26104 #ifdef HAVE_WINDOW_SYSTEM
26105 if (FRAME_WINDOW_P (it
->f
))
26106 append_stretch_glyph (it
, object
, width
, height
, ascent
);
26110 it
->object
= object
;
26111 it
->char_to_display
= ' ';
26112 it
->pixel_width
= it
->len
= 1;
26114 tty_append_glyph (it
);
26115 it
->object
= o_object
;
26119 it
->pixel_width
= width
;
26120 #ifdef HAVE_WINDOW_SYSTEM
26121 if (FRAME_WINDOW_P (it
->f
))
26123 it
->ascent
= it
->phys_ascent
= ascent
;
26124 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
26125 it
->nglyphs
= width
> 0 && height
> 0;
26126 take_vertical_position_into_account (it
);
26130 it
->nglyphs
= width
;
26133 /* Get information about special display element WHAT in an
26134 environment described by IT. WHAT is one of IT_TRUNCATION or
26135 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
26136 non-null glyph_row member. This function ensures that fields like
26137 face_id, c, len of IT are left untouched. */
26140 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
26147 temp_it
.object
= Qnil
;
26148 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
26150 if (what
== IT_CONTINUATION
)
26152 /* Continuation glyph. For R2L lines, we mirror it by hand. */
26153 if (it
->bidi_it
.paragraph_dir
== R2L
)
26154 SET_GLYPH_FROM_CHAR (glyph
, '/');
26156 SET_GLYPH_FROM_CHAR (glyph
, '\\');
26158 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26160 /* FIXME: Should we mirror GC for R2L lines? */
26161 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26162 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26165 else if (what
== IT_TRUNCATION
)
26167 /* Truncation glyph. */
26168 SET_GLYPH_FROM_CHAR (glyph
, '$');
26170 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26172 /* FIXME: Should we mirror GC for R2L lines? */
26173 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26174 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26180 #ifdef HAVE_WINDOW_SYSTEM
26181 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
26182 is turned off, we precede the truncation/continuation glyphs by a
26183 stretch glyph whose width is computed such that these special
26184 glyphs are aligned at the window margin, even when very different
26185 fonts are used in different glyph rows. */
26186 if (FRAME_WINDOW_P (temp_it
.f
)
26187 /* init_iterator calls this with it->glyph_row == NULL, and it
26188 wants only the pixel width of the truncation/continuation
26190 && temp_it
.glyph_row
26191 /* insert_left_trunc_glyphs calls us at the beginning of the
26192 row, and it has its own calculation of the stretch glyph
26194 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
26195 && (temp_it
.glyph_row
->reversed_p
26196 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
26197 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
26199 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
26201 if (stretch_width
> 0)
26203 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
26204 struct font
*font
=
26205 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
26206 int stretch_ascent
=
26207 (((temp_it
.ascent
+ temp_it
.descent
)
26208 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
26210 append_stretch_glyph (&temp_it
, Qnil
, stretch_width
,
26211 temp_it
.ascent
+ temp_it
.descent
,
26218 temp_it
.what
= IT_CHARACTER
;
26219 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
26220 temp_it
.face_id
= GLYPH_FACE (glyph
);
26221 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
26223 PRODUCE_GLYPHS (&temp_it
);
26224 it
->pixel_width
= temp_it
.pixel_width
;
26225 it
->nglyphs
= temp_it
.nglyphs
;
26228 #ifdef HAVE_WINDOW_SYSTEM
26230 /* Calculate line-height and line-spacing properties.
26231 An integer value specifies explicit pixel value.
26232 A float value specifies relative value to current face height.
26233 A cons (float . face-name) specifies relative value to
26234 height of specified face font.
26236 Returns height in pixels, or nil. */
26239 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
26240 int boff
, bool override
)
26242 Lisp_Object face_name
= Qnil
;
26243 int ascent
, descent
, height
;
26245 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
26250 face_name
= XCAR (val
);
26252 if (!NUMBERP (val
))
26253 val
= make_number (1);
26254 if (NILP (face_name
))
26256 height
= it
->ascent
+ it
->descent
;
26261 if (NILP (face_name
))
26263 font
= FRAME_FONT (it
->f
);
26264 boff
= FRAME_BASELINE_OFFSET (it
->f
);
26266 else if (EQ (face_name
, Qt
))
26275 face_id
= lookup_named_face (it
->f
, face_name
, false);
26277 return make_number (-1);
26279 face
= FACE_FROM_ID (it
->f
, face_id
);
26282 return make_number (-1);
26283 boff
= font
->baseline_offset
;
26284 if (font
->vertical_centering
)
26285 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26288 normal_char_ascent_descent (font
, -1, &ascent
, &descent
);
26292 it
->override_ascent
= ascent
;
26293 it
->override_descent
= descent
;
26294 it
->override_boff
= boff
;
26297 height
= ascent
+ descent
;
26301 height
= (int)(XFLOAT_DATA (val
) * height
);
26302 else if (INTEGERP (val
))
26303 height
*= XINT (val
);
26305 return make_number (height
);
26309 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
26310 is a face ID to be used for the glyph. FOR_NO_FONT is true if
26311 and only if this is for a character for which no font was found.
26313 If the display method (it->glyphless_method) is
26314 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
26315 length of the acronym or the hexadecimal string, UPPER_XOFF and
26316 UPPER_YOFF are pixel offsets for the upper part of the string,
26317 LOWER_XOFF and LOWER_YOFF are for the lower part.
26319 For the other display methods, LEN through LOWER_YOFF are zero. */
26322 append_glyphless_glyph (struct it
*it
, int face_id
, bool for_no_font
, int len
,
26323 short upper_xoff
, short upper_yoff
,
26324 short lower_xoff
, short lower_yoff
)
26326 struct glyph
*glyph
;
26327 enum glyph_row_area area
= it
->area
;
26329 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26330 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26332 /* If the glyph row is reversed, we need to prepend the glyph
26333 rather than append it. */
26334 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26338 /* Make room for the additional glyph. */
26339 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26341 glyph
= it
->glyph_row
->glyphs
[area
];
26343 glyph
->charpos
= CHARPOS (it
->position
);
26344 glyph
->object
= it
->object
;
26345 glyph
->pixel_width
= it
->pixel_width
;
26346 glyph
->ascent
= it
->ascent
;
26347 glyph
->descent
= it
->descent
;
26348 glyph
->voffset
= it
->voffset
;
26349 glyph
->type
= GLYPHLESS_GLYPH
;
26350 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
26351 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
26352 glyph
->u
.glyphless
.len
= len
;
26353 glyph
->u
.glyphless
.ch
= it
->c
;
26354 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
26355 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
26356 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
26357 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
26358 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26359 glyph
->multibyte_p
= it
->multibyte_p
;
26360 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26362 /* In R2L rows, the left and the right box edges need to be
26363 drawn in reverse direction. */
26364 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26365 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26369 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26370 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26372 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
26373 || it
->phys_descent
> it
->descent
);
26374 glyph
->padding_p
= false;
26375 glyph
->glyph_not_available_p
= false;
26376 glyph
->face_id
= face_id
;
26377 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26380 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26381 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26382 glyph
->bidi_type
= it
->bidi_it
.type
;
26384 ++it
->glyph_row
->used
[area
];
26387 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26391 /* Produce a glyph for a glyphless character for iterator IT.
26392 IT->glyphless_method specifies which method to use for displaying
26393 the character. See the description of enum
26394 glyphless_display_method in dispextern.h for the detail.
26396 FOR_NO_FONT is true if and only if this is for a character for
26397 which no font was found. ACRONYM, if non-nil, is an acronym string
26398 for the character. */
26401 produce_glyphless_glyph (struct it
*it
, bool for_no_font
, Lisp_Object acronym
)
26406 int base_width
, base_height
, width
, height
;
26407 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26410 /* Get the metrics of the base font. We always refer to the current
26412 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26413 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26414 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
26415 it
->ascent
+= font
->baseline_offset
;
26416 it
->descent
-= font
->baseline_offset
;
26417 base_height
= it
->ascent
+ it
->descent
;
26418 base_width
= font
->average_width
;
26420 face_id
= merge_glyphless_glyph_face (it
);
26422 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26424 it
->pixel_width
= THIN_SPACE_WIDTH
;
26426 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26428 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26430 width
= CHAR_WIDTH (it
->c
);
26433 else if (width
> 4)
26435 it
->pixel_width
= base_width
* width
;
26437 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26443 unsigned int code
[6];
26445 int ascent
, descent
;
26446 struct font_metrics metrics_upper
, metrics_lower
;
26448 face
= FACE_FROM_ID (it
->f
, face_id
);
26449 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26450 prepare_face_for_display (it
->f
, face
);
26452 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26454 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26455 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26456 if (CONSP (acronym
))
26457 acronym
= XCAR (acronym
);
26458 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26462 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26463 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
+ 0u);
26466 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
26467 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26468 upper_len
= (len
+ 1) / 2;
26469 font
->driver
->text_extents (font
, code
, upper_len
,
26471 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26476 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26477 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26478 upper_xoff
= upper_yoff
= 2; /* the typical case */
26479 if (base_width
>= width
)
26481 /* Align the upper to the left, the lower to the right. */
26482 it
->pixel_width
= base_width
;
26483 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26487 /* Center the shorter one. */
26488 it
->pixel_width
= width
;
26489 if (metrics_upper
.width
>= metrics_lower
.width
)
26490 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26493 /* FIXME: This code doesn't look right. It formerly was
26494 missing the "lower_xoff = 0;", which couldn't have
26495 been right since it left lower_xoff uninitialized. */
26497 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26501 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26502 top, bottom, and between upper and lower strings. */
26503 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26504 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26505 /* Center vertically.
26506 H:base_height, D:base_descent
26507 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26509 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26510 descent = D - H/2 + h/2;
26511 lower_yoff = descent - 2 - ld;
26512 upper_yoff = lower_yoff - la - 1 - ud; */
26513 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26514 descent
= it
->descent
- (base_height
- height
) / 2;
26515 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26516 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26517 - metrics_upper
.descent
);
26518 /* Don't make the height shorter than the base height. */
26519 if (height
> base_height
)
26521 it
->ascent
= ascent
;
26522 it
->descent
= descent
;
26526 it
->phys_ascent
= it
->ascent
;
26527 it
->phys_descent
= it
->descent
;
26529 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26530 upper_xoff
, upper_yoff
,
26531 lower_xoff
, lower_yoff
);
26533 take_vertical_position_into_account (it
);
26538 Produce glyphs/get display metrics for the display element IT is
26539 loaded with. See the description of struct it in dispextern.h
26540 for an overview of struct it. */
26543 x_produce_glyphs (struct it
*it
)
26545 int extra_line_spacing
= it
->extra_line_spacing
;
26547 it
->glyph_not_available_p
= false;
26549 if (it
->what
== IT_CHARACTER
)
26552 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26553 struct font
*font
= face
->font
;
26554 struct font_metrics
*pcm
= NULL
;
26555 int boff
; /* Baseline offset. */
26559 /* When no suitable font is found, display this character by
26560 the method specified in the first extra slot of
26561 Vglyphless_char_display. */
26562 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26564 eassert (it
->what
== IT_GLYPHLESS
);
26565 produce_glyphless_glyph (it
, true,
26566 STRINGP (acronym
) ? acronym
: Qnil
);
26570 boff
= font
->baseline_offset
;
26571 if (font
->vertical_centering
)
26572 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26574 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26578 if (it
->override_ascent
>= 0)
26580 it
->ascent
= it
->override_ascent
;
26581 it
->descent
= it
->override_descent
;
26582 boff
= it
->override_boff
;
26586 it
->ascent
= FONT_BASE (font
) + boff
;
26587 it
->descent
= FONT_DESCENT (font
) - boff
;
26590 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
26592 pcm
= get_per_char_metric (font
, &char2b
);
26593 if (pcm
->width
== 0
26594 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26600 it
->phys_ascent
= pcm
->ascent
+ boff
;
26601 it
->phys_descent
= pcm
->descent
- boff
;
26602 it
->pixel_width
= pcm
->width
;
26603 /* Don't use font-global values for ascent and descent
26604 if they result in an exceedingly large line height. */
26605 if (it
->override_ascent
< 0)
26607 if (FONT_TOO_HIGH (font
))
26609 it
->ascent
= it
->phys_ascent
;
26610 it
->descent
= it
->phys_descent
;
26611 /* These limitations are enforced by an
26612 assertion near the end of this function. */
26613 if (it
->ascent
< 0)
26615 if (it
->descent
< 0)
26622 it
->glyph_not_available_p
= true;
26623 it
->phys_ascent
= it
->ascent
;
26624 it
->phys_descent
= it
->descent
;
26625 it
->pixel_width
= font
->space_width
;
26628 if (it
->constrain_row_ascent_descent_p
)
26630 if (it
->descent
> it
->max_descent
)
26632 it
->ascent
+= it
->descent
- it
->max_descent
;
26633 it
->descent
= it
->max_descent
;
26635 if (it
->ascent
> it
->max_ascent
)
26637 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26638 it
->ascent
= it
->max_ascent
;
26640 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26641 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26642 extra_line_spacing
= 0;
26645 /* If this is a space inside a region of text with
26646 `space-width' property, change its width. */
26648 = it
->char_to_display
== ' ' && !NILP (it
->space_width
);
26650 it
->pixel_width
*= XFLOATINT (it
->space_width
);
26652 /* If face has a box, add the box thickness to the character
26653 height. If character has a box line to the left and/or
26654 right, add the box line width to the character's width. */
26655 if (face
->box
!= FACE_NO_BOX
)
26657 int thick
= face
->box_line_width
;
26661 it
->ascent
+= thick
;
26662 it
->descent
+= thick
;
26667 if (it
->start_of_box_run_p
)
26668 it
->pixel_width
+= thick
;
26669 if (it
->end_of_box_run_p
)
26670 it
->pixel_width
+= thick
;
26673 /* If face has an overline, add the height of the overline
26674 (1 pixel) and a 1 pixel margin to the character height. */
26675 if (face
->overline_p
)
26676 it
->ascent
+= overline_margin
;
26678 if (it
->constrain_row_ascent_descent_p
)
26680 if (it
->ascent
> it
->max_ascent
)
26681 it
->ascent
= it
->max_ascent
;
26682 if (it
->descent
> it
->max_descent
)
26683 it
->descent
= it
->max_descent
;
26686 take_vertical_position_into_account (it
);
26688 /* If we have to actually produce glyphs, do it. */
26693 /* Translate a space with a `space-width' property
26694 into a stretch glyph. */
26695 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
26696 / FONT_HEIGHT (font
));
26697 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26698 it
->ascent
+ it
->descent
, ascent
);
26703 /* If characters with lbearing or rbearing are displayed
26704 in this line, record that fact in a flag of the
26705 glyph row. This is used to optimize X output code. */
26706 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
26707 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
26709 if (! stretched_p
&& it
->pixel_width
== 0)
26710 /* We assure that all visible glyphs have at least 1-pixel
26712 it
->pixel_width
= 1;
26714 else if (it
->char_to_display
== '\n')
26716 /* A newline has no width, but we need the height of the
26717 line. But if previous part of the line sets a height,
26718 don't increase that height. */
26720 Lisp_Object height
;
26721 Lisp_Object total_height
= Qnil
;
26723 it
->override_ascent
= -1;
26724 it
->pixel_width
= 0;
26727 height
= get_it_property (it
, Qline_height
);
26728 /* Split (line-height total-height) list. */
26730 && CONSP (XCDR (height
))
26731 && NILP (XCDR (XCDR (height
))))
26733 total_height
= XCAR (XCDR (height
));
26734 height
= XCAR (height
);
26736 height
= calc_line_height_property (it
, height
, font
, boff
, true);
26738 if (it
->override_ascent
>= 0)
26740 it
->ascent
= it
->override_ascent
;
26741 it
->descent
= it
->override_descent
;
26742 boff
= it
->override_boff
;
26746 if (FONT_TOO_HIGH (font
))
26748 it
->ascent
= font
->pixel_size
+ boff
- 1;
26749 it
->descent
= -boff
+ 1;
26750 if (it
->descent
< 0)
26755 it
->ascent
= FONT_BASE (font
) + boff
;
26756 it
->descent
= FONT_DESCENT (font
) - boff
;
26760 if (EQ (height
, Qt
))
26762 if (it
->descent
> it
->max_descent
)
26764 it
->ascent
+= it
->descent
- it
->max_descent
;
26765 it
->descent
= it
->max_descent
;
26767 if (it
->ascent
> it
->max_ascent
)
26769 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26770 it
->ascent
= it
->max_ascent
;
26772 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26773 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26774 it
->constrain_row_ascent_descent_p
= true;
26775 extra_line_spacing
= 0;
26779 Lisp_Object spacing
;
26781 it
->phys_ascent
= it
->ascent
;
26782 it
->phys_descent
= it
->descent
;
26784 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26785 && face
->box
!= FACE_NO_BOX
26786 && face
->box_line_width
> 0)
26788 it
->ascent
+= face
->box_line_width
;
26789 it
->descent
+= face
->box_line_width
;
26792 && XINT (height
) > it
->ascent
+ it
->descent
)
26793 it
->ascent
= XINT (height
) - it
->descent
;
26795 if (!NILP (total_height
))
26796 spacing
= calc_line_height_property (it
, total_height
, font
,
26800 spacing
= get_it_property (it
, Qline_spacing
);
26801 spacing
= calc_line_height_property (it
, spacing
, font
,
26804 if (INTEGERP (spacing
))
26806 extra_line_spacing
= XINT (spacing
);
26807 if (!NILP (total_height
))
26808 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26812 else /* i.e. (it->char_to_display == '\t') */
26814 if (font
->space_width
> 0)
26816 int tab_width
= it
->tab_width
* font
->space_width
;
26817 int x
= it
->current_x
+ it
->continuation_lines_width
;
26818 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26820 /* If the distance from the current position to the next tab
26821 stop is less than a space character width, use the
26822 tab stop after that. */
26823 if (next_tab_x
- x
< font
->space_width
)
26824 next_tab_x
+= tab_width
;
26826 it
->pixel_width
= next_tab_x
- x
;
26828 if (FONT_TOO_HIGH (font
))
26830 if (get_char_glyph_code (' ', font
, &char2b
))
26832 pcm
= get_per_char_metric (font
, &char2b
);
26833 if (pcm
->width
== 0
26834 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26840 it
->ascent
= pcm
->ascent
+ boff
;
26841 it
->descent
= pcm
->descent
- boff
;
26845 it
->ascent
= font
->pixel_size
+ boff
- 1;
26846 it
->descent
= -boff
+ 1;
26848 if (it
->ascent
< 0)
26850 if (it
->descent
< 0)
26855 it
->ascent
= FONT_BASE (font
) + boff
;
26856 it
->descent
= FONT_DESCENT (font
) - boff
;
26858 it
->phys_ascent
= it
->ascent
;
26859 it
->phys_descent
= it
->descent
;
26863 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26864 it
->ascent
+ it
->descent
, it
->ascent
);
26869 it
->pixel_width
= 0;
26874 if (FONT_TOO_HIGH (font
))
26876 int font_ascent
, font_descent
;
26878 /* For very large fonts, where we ignore the declared font
26879 dimensions, and go by per-character metrics instead,
26880 don't let the row ascent and descent values (and the row
26881 height computed from them) be smaller than the "normal"
26882 character metrics. This avoids unpleasant effects
26883 whereby lines on display would change their height
26884 depending on which characters are shown. */
26885 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
26886 it
->max_ascent
= max (it
->max_ascent
, font_ascent
);
26887 it
->max_descent
= max (it
->max_descent
, font_descent
);
26890 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26892 /* A static composition.
26894 Note: A composition is represented as one glyph in the
26895 glyph matrix. There are no padding glyphs.
26897 Important note: pixel_width, ascent, and descent are the
26898 values of what is drawn by draw_glyphs (i.e. the values of
26899 the overall glyphs composed). */
26900 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26901 int boff
; /* baseline offset */
26902 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26903 int glyph_len
= cmp
->glyph_len
;
26904 struct font
*font
= face
->font
;
26908 /* If we have not yet calculated pixel size data of glyphs of
26909 the composition for the current face font, calculate them
26910 now. Theoretically, we have to check all fonts for the
26911 glyphs, but that requires much time and memory space. So,
26912 here we check only the font of the first glyph. This may
26913 lead to incorrect display, but it's very rare, and C-l
26914 (recenter-top-bottom) can correct the display anyway. */
26915 if (! cmp
->font
|| cmp
->font
!= font
)
26917 /* Ascent and descent of the font of the first character
26918 of this composition (adjusted by baseline offset).
26919 Ascent and descent of overall glyphs should not be less
26920 than these, respectively. */
26921 int font_ascent
, font_descent
, font_height
;
26922 /* Bounding box of the overall glyphs. */
26923 int leftmost
, rightmost
, lowest
, highest
;
26924 int lbearing
, rbearing
;
26925 int i
, width
, ascent
, descent
;
26926 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26928 struct font_metrics
*pcm
;
26931 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26932 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26934 bool right_padded
= glyph_len
< cmp
->glyph_len
;
26935 for (i
= 0; i
< glyph_len
; i
++)
26937 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26939 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26941 bool left_padded
= i
> 0;
26943 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26944 : IT_CHARPOS (*it
));
26945 /* If no suitable font is found, use the default font. */
26946 bool font_not_found_p
= font
== NULL
;
26947 if (font_not_found_p
)
26949 face
= face
->ascii_face
;
26952 boff
= font
->baseline_offset
;
26953 if (font
->vertical_centering
)
26954 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26955 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
26956 font_ascent
+= boff
;
26957 font_descent
-= boff
;
26958 font_height
= font_ascent
+ font_descent
;
26963 if (! font_not_found_p
)
26965 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
26967 pcm
= get_per_char_metric (font
, &char2b
);
26970 /* Initialize the bounding box. */
26973 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
26974 ascent
= pcm
->ascent
;
26975 descent
= pcm
->descent
;
26976 lbearing
= pcm
->lbearing
;
26977 rbearing
= pcm
->rbearing
;
26981 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
26982 ascent
= FONT_BASE (font
);
26983 descent
= FONT_DESCENT (font
);
26990 lowest
= - descent
+ boff
;
26991 highest
= ascent
+ boff
;
26993 if (! font_not_found_p
26994 && font
->default_ascent
26995 && CHAR_TABLE_P (Vuse_default_ascent
)
26996 && !NILP (Faref (Vuse_default_ascent
,
26997 make_number (it
->char_to_display
))))
26998 highest
= font
->default_ascent
+ boff
;
27000 /* Draw the first glyph at the normal position. It may be
27001 shifted to right later if some other glyphs are drawn
27003 cmp
->offsets
[i
* 2] = 0;
27004 cmp
->offsets
[i
* 2 + 1] = boff
;
27005 cmp
->lbearing
= lbearing
;
27006 cmp
->rbearing
= rbearing
;
27008 /* Set cmp->offsets for the remaining glyphs. */
27009 for (i
++; i
< glyph_len
; i
++)
27011 int left
, right
, btm
, top
;
27012 int ch
= COMPOSITION_GLYPH (cmp
, i
);
27014 struct face
*this_face
;
27018 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
27019 this_face
= FACE_FROM_ID (it
->f
, face_id
);
27020 font
= this_face
->font
;
27026 get_char_face_and_encoding (it
->f
, ch
, face_id
,
27028 pcm
= get_per_char_metric (font
, &char2b
);
27031 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
27034 width
= pcm
->width
;
27035 ascent
= pcm
->ascent
;
27036 descent
= pcm
->descent
;
27037 lbearing
= pcm
->lbearing
;
27038 rbearing
= pcm
->rbearing
;
27039 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
27041 /* Relative composition with or without
27042 alternate chars. */
27043 left
= (leftmost
+ rightmost
- width
) / 2;
27044 btm
= - descent
+ boff
;
27045 if (font
->relative_compose
27046 && (! CHAR_TABLE_P (Vignore_relative_composition
)
27047 || NILP (Faref (Vignore_relative_composition
,
27048 make_number (ch
)))))
27051 if (- descent
>= font
->relative_compose
)
27052 /* One extra pixel between two glyphs. */
27054 else if (ascent
<= 0)
27055 /* One extra pixel between two glyphs. */
27056 btm
= lowest
- 1 - ascent
- descent
;
27061 /* A composition rule is specified by an integer
27062 value that encodes global and new reference
27063 points (GREF and NREF). GREF and NREF are
27064 specified by numbers as below:
27066 0---1---2 -- ascent
27070 9--10--11 -- center
27072 ---3---4---5--- baseline
27074 6---7---8 -- descent
27076 int rule
= COMPOSITION_RULE (cmp
, i
);
27077 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
27079 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
27080 grefx
= gref
% 3, nrefx
= nref
% 3;
27081 grefy
= gref
/ 3, nrefy
= nref
/ 3;
27083 xoff
= font_height
* (xoff
- 128) / 256;
27085 yoff
= font_height
* (yoff
- 128) / 256;
27088 + grefx
* (rightmost
- leftmost
) / 2
27089 - nrefx
* width
/ 2
27092 btm
= ((grefy
== 0 ? highest
27094 : grefy
== 2 ? lowest
27095 : (highest
+ lowest
) / 2)
27096 - (nrefy
== 0 ? ascent
+ descent
27097 : nrefy
== 1 ? descent
- boff
27099 : (ascent
+ descent
) / 2)
27103 cmp
->offsets
[i
* 2] = left
;
27104 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
27106 /* Update the bounding box of the overall glyphs. */
27109 right
= left
+ width
;
27110 if (left
< leftmost
)
27112 if (right
> rightmost
)
27115 top
= btm
+ descent
+ ascent
;
27121 if (cmp
->lbearing
> left
+ lbearing
)
27122 cmp
->lbearing
= left
+ lbearing
;
27123 if (cmp
->rbearing
< left
+ rbearing
)
27124 cmp
->rbearing
= left
+ rbearing
;
27128 /* If there are glyphs whose x-offsets are negative,
27129 shift all glyphs to the right and make all x-offsets
27133 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27134 cmp
->offsets
[i
* 2] -= leftmost
;
27135 rightmost
-= leftmost
;
27136 cmp
->lbearing
-= leftmost
;
27137 cmp
->rbearing
-= leftmost
;
27140 if (left_padded
&& cmp
->lbearing
< 0)
27142 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27143 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
27144 rightmost
-= cmp
->lbearing
;
27145 cmp
->rbearing
-= cmp
->lbearing
;
27148 if (right_padded
&& rightmost
< cmp
->rbearing
)
27150 rightmost
= cmp
->rbearing
;
27153 cmp
->pixel_width
= rightmost
;
27154 cmp
->ascent
= highest
;
27155 cmp
->descent
= - lowest
;
27156 if (cmp
->ascent
< font_ascent
)
27157 cmp
->ascent
= font_ascent
;
27158 if (cmp
->descent
< font_descent
)
27159 cmp
->descent
= font_descent
;
27163 && (cmp
->lbearing
< 0
27164 || cmp
->rbearing
> cmp
->pixel_width
))
27165 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27167 it
->pixel_width
= cmp
->pixel_width
;
27168 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
27169 it
->descent
= it
->phys_descent
= cmp
->descent
;
27170 if (face
->box
!= FACE_NO_BOX
)
27172 int thick
= face
->box_line_width
;
27176 it
->ascent
+= thick
;
27177 it
->descent
+= thick
;
27182 if (it
->start_of_box_run_p
)
27183 it
->pixel_width
+= thick
;
27184 if (it
->end_of_box_run_p
)
27185 it
->pixel_width
+= thick
;
27188 /* If face has an overline, add the height of the overline
27189 (1 pixel) and a 1 pixel margin to the character height. */
27190 if (face
->overline_p
)
27191 it
->ascent
+= overline_margin
;
27193 take_vertical_position_into_account (it
);
27194 if (it
->ascent
< 0)
27196 if (it
->descent
< 0)
27199 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
27200 append_composite_glyph (it
);
27202 else if (it
->what
== IT_COMPOSITION
)
27204 /* A dynamic (automatic) composition. */
27205 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27206 Lisp_Object gstring
;
27207 struct font_metrics metrics
;
27211 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
27213 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
27216 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
27217 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27218 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
27219 it
->descent
= it
->phys_descent
= metrics
.descent
;
27220 if (face
->box
!= FACE_NO_BOX
)
27222 int thick
= face
->box_line_width
;
27226 it
->ascent
+= thick
;
27227 it
->descent
+= thick
;
27232 if (it
->start_of_box_run_p
)
27233 it
->pixel_width
+= thick
;
27234 if (it
->end_of_box_run_p
)
27235 it
->pixel_width
+= thick
;
27237 /* If face has an overline, add the height of the overline
27238 (1 pixel) and a 1 pixel margin to the character height. */
27239 if (face
->overline_p
)
27240 it
->ascent
+= overline_margin
;
27241 take_vertical_position_into_account (it
);
27242 if (it
->ascent
< 0)
27244 if (it
->descent
< 0)
27248 append_composite_glyph (it
);
27250 else if (it
->what
== IT_GLYPHLESS
)
27251 produce_glyphless_glyph (it
, false, Qnil
);
27252 else if (it
->what
== IT_IMAGE
)
27253 produce_image_glyph (it
);
27254 else if (it
->what
== IT_STRETCH
)
27255 produce_stretch_glyph (it
);
27258 /* Accumulate dimensions. Note: can't assume that it->descent > 0
27259 because this isn't true for images with `:ascent 100'. */
27260 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
27261 if (it
->area
== TEXT_AREA
)
27262 it
->current_x
+= it
->pixel_width
;
27264 if (extra_line_spacing
> 0)
27266 it
->descent
+= extra_line_spacing
;
27267 if (extra_line_spacing
> it
->max_extra_line_spacing
)
27268 it
->max_extra_line_spacing
= extra_line_spacing
;
27271 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
27272 it
->max_descent
= max (it
->max_descent
, it
->descent
);
27273 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
27274 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
27278 Output LEN glyphs starting at START at the nominal cursor position.
27279 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
27280 being updated, and UPDATED_AREA is the area of that row being updated. */
27283 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27284 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27286 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
27288 eassert (updated_row
);
27289 /* When the window is hscrolled, cursor hpos can legitimately be out
27290 of bounds, but we draw the cursor at the corresponding window
27291 margin in that case. */
27292 if (!updated_row
->reversed_p
&& chpos
< 0)
27294 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
27295 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
27299 /* Write glyphs. */
27301 hpos
= start
- updated_row
->glyphs
[updated_area
];
27302 x
= draw_glyphs (w
, w
->output_cursor
.x
,
27303 updated_row
, updated_area
,
27305 DRAW_NORMAL_TEXT
, 0);
27307 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
27308 if (updated_area
== TEXT_AREA
27309 && w
->phys_cursor_on_p
27310 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
27312 && chpos
< hpos
+ len
)
27313 w
->phys_cursor_on_p
= false;
27317 /* Advance the output cursor. */
27318 w
->output_cursor
.hpos
+= len
;
27319 w
->output_cursor
.x
= x
;
27324 Insert LEN glyphs from START at the nominal cursor position. */
27327 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27328 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27331 int line_height
, shift_by_width
, shifted_region_width
;
27332 struct glyph_row
*row
;
27333 struct glyph
*glyph
;
27334 int frame_x
, frame_y
;
27337 eassert (updated_row
);
27339 f
= XFRAME (WINDOW_FRAME (w
));
27341 /* Get the height of the line we are in. */
27343 line_height
= row
->height
;
27345 /* Get the width of the glyphs to insert. */
27346 shift_by_width
= 0;
27347 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
27348 shift_by_width
+= glyph
->pixel_width
;
27350 /* Get the width of the region to shift right. */
27351 shifted_region_width
= (window_box_width (w
, updated_area
)
27352 - w
->output_cursor
.x
27356 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
27357 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
27359 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
27360 line_height
, shift_by_width
);
27362 /* Write the glyphs. */
27363 hpos
= start
- row
->glyphs
[updated_area
];
27364 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
27366 DRAW_NORMAL_TEXT
, 0);
27368 /* Advance the output cursor. */
27369 w
->output_cursor
.hpos
+= len
;
27370 w
->output_cursor
.x
+= shift_by_width
;
27376 Erase the current text line from the nominal cursor position
27377 (inclusive) to pixel column TO_X (exclusive). The idea is that
27378 everything from TO_X onward is already erased.
27380 TO_X is a pixel position relative to UPDATED_AREA of currently
27381 updated window W. TO_X == -1 means clear to the end of this area. */
27384 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
27385 enum glyph_row_area updated_area
, int to_x
)
27388 int max_x
, min_y
, max_y
;
27389 int from_x
, from_y
, to_y
;
27391 eassert (updated_row
);
27392 f
= XFRAME (w
->frame
);
27394 if (updated_row
->full_width_p
)
27395 max_x
= (WINDOW_PIXEL_WIDTH (w
)
27396 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
27398 max_x
= window_box_width (w
, updated_area
);
27399 max_y
= window_text_bottom_y (w
);
27401 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
27402 of window. For TO_X > 0, truncate to end of drawing area. */
27408 to_x
= min (to_x
, max_x
);
27410 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
27412 /* Notice if the cursor will be cleared by this operation. */
27413 if (!updated_row
->full_width_p
)
27414 notice_overwritten_cursor (w
, updated_area
,
27415 w
->output_cursor
.x
, -1,
27417 MATRIX_ROW_BOTTOM_Y (updated_row
));
27419 from_x
= w
->output_cursor
.x
;
27421 /* Translate to frame coordinates. */
27422 if (updated_row
->full_width_p
)
27424 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
27425 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
27429 int area_left
= window_box_left (w
, updated_area
);
27430 from_x
+= area_left
;
27434 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
27435 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
27436 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
27438 /* Prevent inadvertently clearing to end of the X window. */
27439 if (to_x
> from_x
&& to_y
> from_y
)
27442 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
27443 to_x
- from_x
, to_y
- from_y
);
27448 #endif /* HAVE_WINDOW_SYSTEM */
27452 /***********************************************************************
27454 ***********************************************************************/
27456 /* Value is the internal representation of the specified cursor type
27457 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27458 of the bar cursor. */
27460 static enum text_cursor_kinds
27461 get_specified_cursor_type (Lisp_Object arg
, int *width
)
27463 enum text_cursor_kinds type
;
27468 if (EQ (arg
, Qbox
))
27469 return FILLED_BOX_CURSOR
;
27471 if (EQ (arg
, Qhollow
))
27472 return HOLLOW_BOX_CURSOR
;
27474 if (EQ (arg
, Qbar
))
27481 && EQ (XCAR (arg
), Qbar
)
27482 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27484 *width
= XINT (XCDR (arg
));
27488 if (EQ (arg
, Qhbar
))
27491 return HBAR_CURSOR
;
27495 && EQ (XCAR (arg
), Qhbar
)
27496 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27498 *width
= XINT (XCDR (arg
));
27499 return HBAR_CURSOR
;
27502 /* Treat anything unknown as "hollow box cursor".
27503 It was bad to signal an error; people have trouble fixing
27504 .Xdefaults with Emacs, when it has something bad in it. */
27505 type
= HOLLOW_BOX_CURSOR
;
27510 /* Set the default cursor types for specified frame. */
27512 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27517 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27518 FRAME_CURSOR_WIDTH (f
) = width
;
27520 /* By default, set up the blink-off state depending on the on-state. */
27522 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27525 FRAME_BLINK_OFF_CURSOR (f
)
27526 = get_specified_cursor_type (XCDR (tem
), &width
);
27527 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27530 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27532 /* Make sure the cursor gets redrawn. */
27533 f
->cursor_type_changed
= true;
27537 #ifdef HAVE_WINDOW_SYSTEM
27539 /* Return the cursor we want to be displayed in window W. Return
27540 width of bar/hbar cursor through WIDTH arg. Return with
27541 ACTIVE_CURSOR arg set to true if cursor in window W is `active'
27542 (i.e. if the `system caret' should track this cursor).
27544 In a mini-buffer window, we want the cursor only to appear if we
27545 are reading input from this window. For the selected window, we
27546 want the cursor type given by the frame parameter or buffer local
27547 setting of cursor-type. If explicitly marked off, draw no cursor.
27548 In all other cases, we want a hollow box cursor. */
27550 static enum text_cursor_kinds
27551 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27552 bool *active_cursor
)
27554 struct frame
*f
= XFRAME (w
->frame
);
27555 struct buffer
*b
= XBUFFER (w
->contents
);
27556 int cursor_type
= DEFAULT_CURSOR
;
27557 Lisp_Object alt_cursor
;
27558 bool non_selected
= false;
27560 *active_cursor
= true;
27563 if (cursor_in_echo_area
27564 && FRAME_HAS_MINIBUF_P (f
)
27565 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27567 if (w
== XWINDOW (echo_area_window
))
27569 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27571 *width
= FRAME_CURSOR_WIDTH (f
);
27572 return FRAME_DESIRED_CURSOR (f
);
27575 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27578 *active_cursor
= false;
27579 non_selected
= true;
27582 /* Detect a nonselected window or nonselected frame. */
27583 else if (w
!= XWINDOW (f
->selected_window
)
27584 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
27586 *active_cursor
= false;
27588 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
27591 non_selected
= true;
27594 /* Never display a cursor in a window in which cursor-type is nil. */
27595 if (NILP (BVAR (b
, cursor_type
)))
27598 /* Get the normal cursor type for this window. */
27599 if (EQ (BVAR (b
, cursor_type
), Qt
))
27601 cursor_type
= FRAME_DESIRED_CURSOR (f
);
27602 *width
= FRAME_CURSOR_WIDTH (f
);
27605 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27607 /* Use cursor-in-non-selected-windows instead
27608 for non-selected window or frame. */
27611 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
27612 if (!EQ (Qt
, alt_cursor
))
27613 return get_specified_cursor_type (alt_cursor
, width
);
27614 /* t means modify the normal cursor type. */
27615 if (cursor_type
== FILLED_BOX_CURSOR
)
27616 cursor_type
= HOLLOW_BOX_CURSOR
;
27617 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
27619 return cursor_type
;
27622 /* Use normal cursor if not blinked off. */
27623 if (!w
->cursor_off_p
)
27625 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27627 if (cursor_type
== FILLED_BOX_CURSOR
)
27629 /* Using a block cursor on large images can be very annoying.
27630 So use a hollow cursor for "large" images.
27631 If image is not transparent (no mask), also use hollow cursor. */
27632 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27633 if (img
!= NULL
&& IMAGEP (img
->spec
))
27635 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27636 where N = size of default frame font size.
27637 This should cover most of the "tiny" icons people may use. */
27639 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
27640 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
27641 cursor_type
= HOLLOW_BOX_CURSOR
;
27644 else if (cursor_type
!= NO_CURSOR
)
27646 /* Display current only supports BOX and HOLLOW cursors for images.
27647 So for now, unconditionally use a HOLLOW cursor when cursor is
27648 not a solid box cursor. */
27649 cursor_type
= HOLLOW_BOX_CURSOR
;
27652 return cursor_type
;
27655 /* Cursor is blinked off, so determine how to "toggle" it. */
27657 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27658 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
27659 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
27661 /* Then see if frame has specified a specific blink off cursor type. */
27662 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
27664 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
27665 return FRAME_BLINK_OFF_CURSOR (f
);
27669 /* Some people liked having a permanently visible blinking cursor,
27670 while others had very strong opinions against it. So it was
27671 decided to remove it. KFS 2003-09-03 */
27673 /* Finally perform built-in cursor blinking:
27674 filled box <-> hollow box
27675 wide [h]bar <-> narrow [h]bar
27676 narrow [h]bar <-> no cursor
27677 other type <-> no cursor */
27679 if (cursor_type
== FILLED_BOX_CURSOR
)
27680 return HOLLOW_BOX_CURSOR
;
27682 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
27685 return cursor_type
;
27693 /* Notice when the text cursor of window W has been completely
27694 overwritten by a drawing operation that outputs glyphs in AREA
27695 starting at X0 and ending at X1 in the line starting at Y0 and
27696 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27697 the rest of the line after X0 has been written. Y coordinates
27698 are window-relative. */
27701 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
27702 int x0
, int x1
, int y0
, int y1
)
27704 int cx0
, cx1
, cy0
, cy1
;
27705 struct glyph_row
*row
;
27707 if (!w
->phys_cursor_on_p
)
27709 if (area
!= TEXT_AREA
)
27712 if (w
->phys_cursor
.vpos
< 0
27713 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
27714 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
27715 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
27718 if (row
->cursor_in_fringe_p
)
27720 row
->cursor_in_fringe_p
= false;
27721 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
27722 w
->phys_cursor_on_p
= false;
27726 cx0
= w
->phys_cursor
.x
;
27727 cx1
= cx0
+ w
->phys_cursor_width
;
27728 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
27731 /* The cursor image will be completely removed from the
27732 screen if the output area intersects the cursor area in
27733 y-direction. When we draw in [y0 y1[, and some part of
27734 the cursor is at y < y0, that part must have been drawn
27735 before. When scrolling, the cursor is erased before
27736 actually scrolling, so we don't come here. When not
27737 scrolling, the rows above the old cursor row must have
27738 changed, and in this case these rows must have written
27739 over the cursor image.
27741 Likewise if part of the cursor is below y1, with the
27742 exception of the cursor being in the first blank row at
27743 the buffer and window end because update_text_area
27744 doesn't draw that row. (Except when it does, but
27745 that's handled in update_text_area.) */
27747 cy0
= w
->phys_cursor
.y
;
27748 cy1
= cy0
+ w
->phys_cursor_height
;
27749 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
27752 w
->phys_cursor_on_p
= false;
27755 #endif /* HAVE_WINDOW_SYSTEM */
27758 /************************************************************************
27760 ************************************************************************/
27762 #ifdef HAVE_WINDOW_SYSTEM
27765 Fix the display of area AREA of overlapping row ROW in window W
27766 with respect to the overlapping part OVERLAPS. */
27769 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
27770 enum glyph_row_area area
, int overlaps
)
27777 for (i
= 0; i
< row
->used
[area
];)
27779 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
27781 int start
= i
, start_x
= x
;
27785 x
+= row
->glyphs
[area
][i
].pixel_width
;
27788 while (i
< row
->used
[area
]
27789 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
27791 draw_glyphs (w
, start_x
, row
, area
,
27793 DRAW_NORMAL_TEXT
, overlaps
);
27797 x
+= row
->glyphs
[area
][i
].pixel_width
;
27807 Draw the cursor glyph of window W in glyph row ROW. See the
27808 comment of draw_glyphs for the meaning of HL. */
27811 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27812 enum draw_glyphs_face hl
)
27814 /* If cursor hpos is out of bounds, don't draw garbage. This can
27815 happen in mini-buffer windows when switching between echo area
27816 glyphs and mini-buffer. */
27817 if ((row
->reversed_p
27818 ? (w
->phys_cursor
.hpos
>= 0)
27819 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27821 bool on_p
= w
->phys_cursor_on_p
;
27823 int hpos
= w
->phys_cursor
.hpos
;
27825 /* When the window is hscrolled, cursor hpos can legitimately be
27826 out of bounds, but we draw the cursor at the corresponding
27827 window margin in that case. */
27828 if (!row
->reversed_p
&& hpos
< 0)
27830 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27831 hpos
= row
->used
[TEXT_AREA
] - 1;
27833 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27835 w
->phys_cursor_on_p
= on_p
;
27837 if (hl
== DRAW_CURSOR
)
27838 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27839 /* When we erase the cursor, and ROW is overlapped by other
27840 rows, make sure that these overlapping parts of other rows
27842 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27844 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27846 if (row
> w
->current_matrix
->rows
27847 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27848 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27849 OVERLAPS_ERASED_CURSOR
);
27851 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27852 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27853 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27854 OVERLAPS_ERASED_CURSOR
);
27860 /* Erase the image of a cursor of window W from the screen. */
27863 erase_phys_cursor (struct window
*w
)
27865 struct frame
*f
= XFRAME (w
->frame
);
27866 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27867 int hpos
= w
->phys_cursor
.hpos
;
27868 int vpos
= w
->phys_cursor
.vpos
;
27869 bool mouse_face_here_p
= false;
27870 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27871 struct glyph_row
*cursor_row
;
27872 struct glyph
*cursor_glyph
;
27873 enum draw_glyphs_face hl
;
27875 /* No cursor displayed or row invalidated => nothing to do on the
27877 if (w
->phys_cursor_type
== NO_CURSOR
)
27878 goto mark_cursor_off
;
27880 /* VPOS >= active_glyphs->nrows means that window has been resized.
27881 Don't bother to erase the cursor. */
27882 if (vpos
>= active_glyphs
->nrows
)
27883 goto mark_cursor_off
;
27885 /* If row containing cursor is marked invalid, there is nothing we
27887 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27888 if (!cursor_row
->enabled_p
)
27889 goto mark_cursor_off
;
27891 /* If line spacing is > 0, old cursor may only be partially visible in
27892 window after split-window. So adjust visible height. */
27893 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27894 window_text_bottom_y (w
) - cursor_row
->y
);
27896 /* If row is completely invisible, don't attempt to delete a cursor which
27897 isn't there. This can happen if cursor is at top of a window, and
27898 we switch to a buffer with a header line in that window. */
27899 if (cursor_row
->visible_height
<= 0)
27900 goto mark_cursor_off
;
27902 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27903 if (cursor_row
->cursor_in_fringe_p
)
27905 cursor_row
->cursor_in_fringe_p
= false;
27906 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27907 goto mark_cursor_off
;
27910 /* This can happen when the new row is shorter than the old one.
27911 In this case, either draw_glyphs or clear_end_of_line
27912 should have cleared the cursor. Note that we wouldn't be
27913 able to erase the cursor in this case because we don't have a
27914 cursor glyph at hand. */
27915 if ((cursor_row
->reversed_p
27916 ? (w
->phys_cursor
.hpos
< 0)
27917 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27918 goto mark_cursor_off
;
27920 /* When the window is hscrolled, cursor hpos can legitimately be out
27921 of bounds, but we draw the cursor at the corresponding window
27922 margin in that case. */
27923 if (!cursor_row
->reversed_p
&& hpos
< 0)
27925 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27926 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27928 /* If the cursor is in the mouse face area, redisplay that when
27929 we clear the cursor. */
27930 if (! NILP (hlinfo
->mouse_face_window
)
27931 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27932 /* Don't redraw the cursor's spot in mouse face if it is at the
27933 end of a line (on a newline). The cursor appears there, but
27934 mouse highlighting does not. */
27935 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27936 mouse_face_here_p
= true;
27938 /* Maybe clear the display under the cursor. */
27939 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27942 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27945 cursor_glyph
= get_phys_cursor_glyph (w
);
27946 if (cursor_glyph
== NULL
)
27947 goto mark_cursor_off
;
27949 width
= cursor_glyph
->pixel_width
;
27950 x
= w
->phys_cursor
.x
;
27956 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27957 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27958 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
27961 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27964 /* Erase the cursor by redrawing the character underneath it. */
27965 if (mouse_face_here_p
)
27966 hl
= DRAW_MOUSE_FACE
;
27968 hl
= DRAW_NORMAL_TEXT
;
27969 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
27972 w
->phys_cursor_on_p
= false;
27973 w
->phys_cursor_type
= NO_CURSOR
;
27977 /* Display or clear cursor of window W. If !ON, clear the cursor.
27978 If ON, display the cursor; where to put the cursor is specified by
27979 HPOS, VPOS, X and Y. */
27982 display_and_set_cursor (struct window
*w
, bool on
,
27983 int hpos
, int vpos
, int x
, int y
)
27985 struct frame
*f
= XFRAME (w
->frame
);
27986 int new_cursor_type
;
27987 int new_cursor_width
;
27988 bool active_cursor
;
27989 struct glyph_row
*glyph_row
;
27990 struct glyph
*glyph
;
27992 /* This is pointless on invisible frames, and dangerous on garbaged
27993 windows and frames; in the latter case, the frame or window may
27994 be in the midst of changing its size, and x and y may be off the
27996 if (! FRAME_VISIBLE_P (f
)
27997 || FRAME_GARBAGED_P (f
)
27998 || vpos
>= w
->current_matrix
->nrows
27999 || hpos
>= w
->current_matrix
->matrix_w
)
28002 /* If cursor is off and we want it off, return quickly. */
28003 if (!on
&& !w
->phys_cursor_on_p
)
28006 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28007 /* If cursor row is not enabled, we don't really know where to
28008 display the cursor. */
28009 if (!glyph_row
->enabled_p
)
28011 w
->phys_cursor_on_p
= false;
28016 if (!glyph_row
->exact_window_width_line_p
28017 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
28018 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
28020 eassert (input_blocked_p ());
28022 /* Set new_cursor_type to the cursor we want to be displayed. */
28023 new_cursor_type
= get_window_cursor_type (w
, glyph
,
28024 &new_cursor_width
, &active_cursor
);
28026 /* If cursor is currently being shown and we don't want it to be or
28027 it is in the wrong place, or the cursor type is not what we want,
28029 if (w
->phys_cursor_on_p
28031 || w
->phys_cursor
.x
!= x
28032 || w
->phys_cursor
.y
!= y
28033 /* HPOS can be negative in R2L rows whose
28034 exact_window_width_line_p flag is set (i.e. their newline
28035 would "overflow into the fringe"). */
28037 || new_cursor_type
!= w
->phys_cursor_type
28038 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
28039 && new_cursor_width
!= w
->phys_cursor_width
)))
28040 erase_phys_cursor (w
);
28042 /* Don't check phys_cursor_on_p here because that flag is only set
28043 to false in some cases where we know that the cursor has been
28044 completely erased, to avoid the extra work of erasing the cursor
28045 twice. In other words, phys_cursor_on_p can be true and the cursor
28046 still not be visible, or it has only been partly erased. */
28049 w
->phys_cursor_ascent
= glyph_row
->ascent
;
28050 w
->phys_cursor_height
= glyph_row
->height
;
28052 /* Set phys_cursor_.* before x_draw_.* is called because some
28053 of them may need the information. */
28054 w
->phys_cursor
.x
= x
;
28055 w
->phys_cursor
.y
= glyph_row
->y
;
28056 w
->phys_cursor
.hpos
= hpos
;
28057 w
->phys_cursor
.vpos
= vpos
;
28060 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
28061 new_cursor_type
, new_cursor_width
,
28062 on
, active_cursor
);
28066 /* Switch the display of W's cursor on or off, according to the value
28070 update_window_cursor (struct window
*w
, bool on
)
28072 /* Don't update cursor in windows whose frame is in the process
28073 of being deleted. */
28074 if (w
->current_matrix
)
28076 int hpos
= w
->phys_cursor
.hpos
;
28077 int vpos
= w
->phys_cursor
.vpos
;
28078 struct glyph_row
*row
;
28080 if (vpos
>= w
->current_matrix
->nrows
28081 || hpos
>= w
->current_matrix
->matrix_w
)
28084 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28086 /* When the window is hscrolled, cursor hpos can legitimately be
28087 out of bounds, but we draw the cursor at the corresponding
28088 window margin in that case. */
28089 if (!row
->reversed_p
&& hpos
< 0)
28091 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28092 hpos
= row
->used
[TEXT_AREA
] - 1;
28095 display_and_set_cursor (w
, on
, hpos
, vpos
,
28096 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28102 /* Call update_window_cursor with parameter ON_P on all leaf windows
28103 in the window tree rooted at W. */
28106 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
28110 if (WINDOWP (w
->contents
))
28111 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
28113 update_window_cursor (w
, on_p
);
28115 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
28121 Display the cursor on window W, or clear it, according to ON_P.
28122 Don't change the cursor's position. */
28125 x_update_cursor (struct frame
*f
, bool on_p
)
28127 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
28132 Clear the cursor of window W to background color, and mark the
28133 cursor as not shown. This is used when the text where the cursor
28134 is about to be rewritten. */
28137 x_clear_cursor (struct window
*w
)
28139 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
28140 update_window_cursor (w
, false);
28143 #endif /* HAVE_WINDOW_SYSTEM */
28145 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
28148 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
28149 int start_hpos
, int end_hpos
,
28150 enum draw_glyphs_face draw
)
28152 #ifdef HAVE_WINDOW_SYSTEM
28153 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
28155 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
28159 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
28160 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
28164 /* Display the active region described by mouse_face_* according to DRAW. */
28167 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
28169 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
28170 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28172 if (/* If window is in the process of being destroyed, don't bother
28174 w
->current_matrix
!= NULL
28175 /* Don't update mouse highlight if hidden. */
28176 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
28177 /* Recognize when we are called to operate on rows that don't exist
28178 anymore. This can happen when a window is split. */
28179 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
28181 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
28182 struct glyph_row
*row
, *first
, *last
;
28184 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
28185 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
28187 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
28189 int start_hpos
, end_hpos
, start_x
;
28191 /* For all but the first row, the highlight starts at column 0. */
28194 /* R2L rows have BEG and END in reversed order, but the
28195 screen drawing geometry is always left to right. So
28196 we need to mirror the beginning and end of the
28197 highlighted area in R2L rows. */
28198 if (!row
->reversed_p
)
28200 start_hpos
= hlinfo
->mouse_face_beg_col
;
28201 start_x
= hlinfo
->mouse_face_beg_x
;
28203 else if (row
== last
)
28205 start_hpos
= hlinfo
->mouse_face_end_col
;
28206 start_x
= hlinfo
->mouse_face_end_x
;
28214 else if (row
->reversed_p
&& row
== last
)
28216 start_hpos
= hlinfo
->mouse_face_end_col
;
28217 start_x
= hlinfo
->mouse_face_end_x
;
28227 if (!row
->reversed_p
)
28228 end_hpos
= hlinfo
->mouse_face_end_col
;
28229 else if (row
== first
)
28230 end_hpos
= hlinfo
->mouse_face_beg_col
;
28233 end_hpos
= row
->used
[TEXT_AREA
];
28234 if (draw
== DRAW_NORMAL_TEXT
)
28235 row
->fill_line_p
= true; /* Clear to end of line. */
28238 else if (row
->reversed_p
&& row
== first
)
28239 end_hpos
= hlinfo
->mouse_face_beg_col
;
28242 end_hpos
= row
->used
[TEXT_AREA
];
28243 if (draw
== DRAW_NORMAL_TEXT
)
28244 row
->fill_line_p
= true; /* Clear to end of line. */
28247 if (end_hpos
> start_hpos
)
28249 draw_row_with_mouse_face (w
, start_x
, row
,
28250 start_hpos
, end_hpos
, draw
);
28253 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
28257 #ifdef HAVE_WINDOW_SYSTEM
28258 /* When we've written over the cursor, arrange for it to
28259 be displayed again. */
28260 if (FRAME_WINDOW_P (f
)
28261 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
28263 int hpos
= w
->phys_cursor
.hpos
;
28265 /* When the window is hscrolled, cursor hpos can legitimately be
28266 out of bounds, but we draw the cursor at the corresponding
28267 window margin in that case. */
28268 if (!row
->reversed_p
&& hpos
< 0)
28270 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28271 hpos
= row
->used
[TEXT_AREA
] - 1;
28274 display_and_set_cursor (w
, true, hpos
, w
->phys_cursor
.vpos
,
28275 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28278 #endif /* HAVE_WINDOW_SYSTEM */
28281 #ifdef HAVE_WINDOW_SYSTEM
28282 /* Change the mouse cursor. */
28283 if (FRAME_WINDOW_P (f
) && NILP (do_mouse_tracking
))
28285 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
28286 if (draw
== DRAW_NORMAL_TEXT
28287 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
28288 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
28291 if (draw
== DRAW_MOUSE_FACE
)
28292 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
28294 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
28296 #endif /* HAVE_WINDOW_SYSTEM */
28300 Clear out the mouse-highlighted active region.
28301 Redraw it un-highlighted first. Value is true if mouse
28302 face was actually drawn unhighlighted. */
28305 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
28308 = !hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
);
28310 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
28311 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28312 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28313 hlinfo
->mouse_face_window
= Qnil
;
28314 hlinfo
->mouse_face_overlay
= Qnil
;
28318 /* Return true if the coordinates HPOS and VPOS on windows W are
28319 within the mouse face on that window. */
28321 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
28323 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28325 /* Quickly resolve the easy cases. */
28326 if (!(WINDOWP (hlinfo
->mouse_face_window
)
28327 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
28329 if (vpos
< hlinfo
->mouse_face_beg_row
28330 || vpos
> hlinfo
->mouse_face_end_row
)
28332 if (vpos
> hlinfo
->mouse_face_beg_row
28333 && vpos
< hlinfo
->mouse_face_end_row
)
28336 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
28338 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28340 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
28343 else if ((vpos
== hlinfo
->mouse_face_beg_row
28344 && hpos
>= hlinfo
->mouse_face_beg_col
)
28345 || (vpos
== hlinfo
->mouse_face_end_row
28346 && hpos
< hlinfo
->mouse_face_end_col
))
28351 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28353 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
28356 else if ((vpos
== hlinfo
->mouse_face_beg_row
28357 && hpos
<= hlinfo
->mouse_face_beg_col
)
28358 || (vpos
== hlinfo
->mouse_face_end_row
28359 && hpos
> hlinfo
->mouse_face_end_col
))
28367 True if physical cursor of window W is within mouse face. */
28370 cursor_in_mouse_face_p (struct window
*w
)
28372 int hpos
= w
->phys_cursor
.hpos
;
28373 int vpos
= w
->phys_cursor
.vpos
;
28374 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28376 /* When the window is hscrolled, cursor hpos can legitimately be out
28377 of bounds, but we draw the cursor at the corresponding window
28378 margin in that case. */
28379 if (!row
->reversed_p
&& hpos
< 0)
28381 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28382 hpos
= row
->used
[TEXT_AREA
] - 1;
28384 return coords_in_mouse_face_p (w
, hpos
, vpos
);
28389 /* Find the glyph rows START_ROW and END_ROW of window W that display
28390 characters between buffer positions START_CHARPOS and END_CHARPOS
28391 (excluding END_CHARPOS). DISP_STRING is a display string that
28392 covers these buffer positions. This is similar to
28393 row_containing_pos, but is more accurate when bidi reordering makes
28394 buffer positions change non-linearly with glyph rows. */
28396 rows_from_pos_range (struct window
*w
,
28397 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
28398 Lisp_Object disp_string
,
28399 struct glyph_row
**start
, struct glyph_row
**end
)
28401 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28402 int last_y
= window_text_bottom_y (w
);
28403 struct glyph_row
*row
;
28408 while (!first
->enabled_p
28409 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
28412 /* Find the START row. */
28414 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
28417 /* A row can potentially be the START row if the range of the
28418 characters it displays intersects the range
28419 [START_CHARPOS..END_CHARPOS). */
28420 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
28421 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
28422 /* See the commentary in row_containing_pos, for the
28423 explanation of the complicated way to check whether
28424 some position is beyond the end of the characters
28425 displayed by a row. */
28426 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28427 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28428 && !row
->ends_at_zv_p
28429 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
28430 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28431 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28432 && !row
->ends_at_zv_p
28433 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
28435 /* Found a candidate row. Now make sure at least one of the
28436 glyphs it displays has a charpos from the range
28437 [START_CHARPOS..END_CHARPOS).
28439 This is not obvious because bidi reordering could make
28440 buffer positions of a row be 1,2,3,102,101,100, and if we
28441 want to highlight characters in [50..60), we don't want
28442 this row, even though [50..60) does intersect [1..103),
28443 the range of character positions given by the row's start
28444 and end positions. */
28445 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
28446 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
28450 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28451 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28452 /* A glyph that comes from DISP_STRING is by
28453 definition to be highlighted. */
28454 || EQ (g
->object
, disp_string
))
28463 /* Find the END row. */
28465 /* If the last row is partially visible, start looking for END
28466 from that row, instead of starting from FIRST. */
28467 && !(row
->enabled_p
28468 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
28470 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
28472 struct glyph_row
*next
= row
+ 1;
28473 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
28475 if (!next
->enabled_p
28476 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
28477 /* The first row >= START whose range of displayed characters
28478 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28479 is the row END + 1. */
28480 || (start_charpos
< next_start
28481 && end_charpos
< next_start
)
28482 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28483 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28484 && !next
->ends_at_zv_p
28485 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28486 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28487 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28488 && !next
->ends_at_zv_p
28489 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28496 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28497 but none of the characters it displays are in the range, it is
28499 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28500 struct glyph
*s
= g
;
28501 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28505 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28506 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28507 /* If the buffer position of the first glyph in
28508 the row is equal to END_CHARPOS, it means
28509 the last character to be highlighted is the
28510 newline of ROW, and we must consider NEXT as
28512 || (((!next
->reversed_p
&& g
== s
)
28513 || (next
->reversed_p
&& g
== e
- 1))
28514 && (g
->charpos
== end_charpos
28515 /* Special case for when NEXT is an
28516 empty line at ZV. */
28517 || (g
->charpos
== -1
28518 && !row
->ends_at_zv_p
28519 && next_start
== end_charpos
)))))
28520 /* A glyph that comes from DISP_STRING is by
28521 definition to be highlighted. */
28522 || EQ (g
->object
, disp_string
))
28531 /* The first row that ends at ZV must be the last to be
28533 else if (next
->ends_at_zv_p
)
28542 /* This function sets the mouse_face_* elements of HLINFO, assuming
28543 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28544 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28545 for the overlay or run of text properties specifying the mouse
28546 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28547 before-string and after-string that must also be highlighted.
28548 DISP_STRING, if non-nil, is a display string that may cover some
28549 or all of the highlighted text. */
28552 mouse_face_from_buffer_pos (Lisp_Object window
,
28553 Mouse_HLInfo
*hlinfo
,
28554 ptrdiff_t mouse_charpos
,
28555 ptrdiff_t start_charpos
,
28556 ptrdiff_t end_charpos
,
28557 Lisp_Object before_string
,
28558 Lisp_Object after_string
,
28559 Lisp_Object disp_string
)
28561 struct window
*w
= XWINDOW (window
);
28562 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28563 struct glyph_row
*r1
, *r2
;
28564 struct glyph
*glyph
, *end
;
28565 ptrdiff_t ignore
, pos
;
28568 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28569 eassert (NILP (before_string
) || STRINGP (before_string
));
28570 eassert (NILP (after_string
) || STRINGP (after_string
));
28572 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28573 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
28575 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28576 /* If the before-string or display-string contains newlines,
28577 rows_from_pos_range skips to its last row. Move back. */
28578 if (!NILP (before_string
) || !NILP (disp_string
))
28580 struct glyph_row
*prev
;
28581 while ((prev
= r1
- 1, prev
>= first
)
28582 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
28583 && prev
->used
[TEXT_AREA
] > 0)
28585 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
28586 glyph
= beg
+ prev
->used
[TEXT_AREA
];
28587 while (--glyph
>= beg
&& NILP (glyph
->object
));
28589 || !(EQ (glyph
->object
, before_string
)
28590 || EQ (glyph
->object
, disp_string
)))
28597 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28598 hlinfo
->mouse_face_past_end
= true;
28600 else if (!NILP (after_string
))
28602 /* If the after-string has newlines, advance to its last row. */
28603 struct glyph_row
*next
;
28604 struct glyph_row
*last
28605 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28607 for (next
= r2
+ 1;
28609 && next
->used
[TEXT_AREA
] > 0
28610 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
28614 /* The rest of the display engine assumes that mouse_face_beg_row is
28615 either above mouse_face_end_row or identical to it. But with
28616 bidi-reordered continued lines, the row for START_CHARPOS could
28617 be below the row for END_CHARPOS. If so, swap the rows and store
28618 them in correct order. */
28621 struct glyph_row
*tem
= r2
;
28627 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
28628 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
28630 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28631 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28632 could be anywhere in the row and in any order. The strategy
28633 below is to find the leftmost and the rightmost glyph that
28634 belongs to either of these 3 strings, or whose position is
28635 between START_CHARPOS and END_CHARPOS, and highlight all the
28636 glyphs between those two. This may cover more than just the text
28637 between START_CHARPOS and END_CHARPOS if the range of characters
28638 strides the bidi level boundary, e.g. if the beginning is in R2L
28639 text while the end is in L2R text or vice versa. */
28640 if (!r1
->reversed_p
)
28642 /* This row is in a left to right paragraph. Scan it left to
28644 glyph
= r1
->glyphs
[TEXT_AREA
];
28645 end
= glyph
+ r1
->used
[TEXT_AREA
];
28648 /* Skip truncation glyphs at the start of the glyph row. */
28649 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28651 && NILP (glyph
->object
)
28652 && glyph
->charpos
< 0;
28654 x
+= glyph
->pixel_width
;
28656 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28657 or DISP_STRING, and the first glyph from buffer whose
28658 position is between START_CHARPOS and END_CHARPOS. */
28660 && !NILP (glyph
->object
)
28661 && !EQ (glyph
->object
, disp_string
)
28662 && !(BUFFERP (glyph
->object
)
28663 && (glyph
->charpos
>= start_charpos
28664 && glyph
->charpos
< end_charpos
));
28667 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28668 are present at buffer positions between START_CHARPOS and
28669 END_CHARPOS, or if they come from an overlay. */
28670 if (EQ (glyph
->object
, before_string
))
28672 pos
= string_buffer_position (before_string
,
28674 /* If pos == 0, it means before_string came from an
28675 overlay, not from a buffer position. */
28676 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28679 else if (EQ (glyph
->object
, after_string
))
28681 pos
= string_buffer_position (after_string
, end_charpos
);
28682 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28685 x
+= glyph
->pixel_width
;
28687 hlinfo
->mouse_face_beg_x
= x
;
28688 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28692 /* This row is in a right to left paragraph. Scan it right to
28696 end
= r1
->glyphs
[TEXT_AREA
] - 1;
28697 glyph
= end
+ r1
->used
[TEXT_AREA
];
28699 /* Skip truncation glyphs at the start of the glyph row. */
28700 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28702 && NILP (glyph
->object
)
28703 && glyph
->charpos
< 0;
28707 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28708 or DISP_STRING, and the first glyph from buffer whose
28709 position is between START_CHARPOS and END_CHARPOS. */
28711 && !NILP (glyph
->object
)
28712 && !EQ (glyph
->object
, disp_string
)
28713 && !(BUFFERP (glyph
->object
)
28714 && (glyph
->charpos
>= start_charpos
28715 && glyph
->charpos
< end_charpos
));
28718 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28719 are present at buffer positions between START_CHARPOS and
28720 END_CHARPOS, or if they come from an overlay. */
28721 if (EQ (glyph
->object
, before_string
))
28723 pos
= string_buffer_position (before_string
, start_charpos
);
28724 /* If pos == 0, it means before_string came from an
28725 overlay, not from a buffer position. */
28726 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28729 else if (EQ (glyph
->object
, after_string
))
28731 pos
= string_buffer_position (after_string
, end_charpos
);
28732 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28737 glyph
++; /* first glyph to the right of the highlighted area */
28738 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
28739 x
+= g
->pixel_width
;
28740 hlinfo
->mouse_face_beg_x
= x
;
28741 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28744 /* If the highlight ends in a different row, compute GLYPH and END
28745 for the end row. Otherwise, reuse the values computed above for
28746 the row where the highlight begins. */
28749 if (!r2
->reversed_p
)
28751 glyph
= r2
->glyphs
[TEXT_AREA
];
28752 end
= glyph
+ r2
->used
[TEXT_AREA
];
28757 end
= r2
->glyphs
[TEXT_AREA
] - 1;
28758 glyph
= end
+ r2
->used
[TEXT_AREA
];
28762 if (!r2
->reversed_p
)
28764 /* Skip truncation and continuation glyphs near the end of the
28765 row, and also blanks and stretch glyphs inserted by
28766 extend_face_to_end_of_line. */
28768 && NILP ((end
- 1)->object
))
28770 /* Scan the rest of the glyph row from the end, looking for the
28771 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28772 DISP_STRING, or whose position is between START_CHARPOS
28776 && !NILP (end
->object
)
28777 && !EQ (end
->object
, disp_string
)
28778 && !(BUFFERP (end
->object
)
28779 && (end
->charpos
>= start_charpos
28780 && end
->charpos
< end_charpos
));
28783 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28784 are present at buffer positions between START_CHARPOS and
28785 END_CHARPOS, or if they come from an overlay. */
28786 if (EQ (end
->object
, before_string
))
28788 pos
= string_buffer_position (before_string
, start_charpos
);
28789 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28792 else if (EQ (end
->object
, after_string
))
28794 pos
= string_buffer_position (after_string
, end_charpos
);
28795 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28799 /* Find the X coordinate of the last glyph to be highlighted. */
28800 for (; glyph
<= end
; ++glyph
)
28801 x
+= glyph
->pixel_width
;
28803 hlinfo
->mouse_face_end_x
= x
;
28804 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28808 /* Skip truncation and continuation glyphs near the end of the
28809 row, and also blanks and stretch glyphs inserted by
28810 extend_face_to_end_of_line. */
28814 && NILP (end
->object
))
28816 x
+= end
->pixel_width
;
28819 /* Scan the rest of the glyph row from the end, looking for the
28820 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28821 DISP_STRING, or whose position is between START_CHARPOS
28825 && !NILP (end
->object
)
28826 && !EQ (end
->object
, disp_string
)
28827 && !(BUFFERP (end
->object
)
28828 && (end
->charpos
>= start_charpos
28829 && end
->charpos
< end_charpos
));
28832 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28833 are present at buffer positions between START_CHARPOS and
28834 END_CHARPOS, or if they come from an overlay. */
28835 if (EQ (end
->object
, before_string
))
28837 pos
= string_buffer_position (before_string
, start_charpos
);
28838 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28841 else if (EQ (end
->object
, after_string
))
28843 pos
= string_buffer_position (after_string
, end_charpos
);
28844 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28847 x
+= end
->pixel_width
;
28849 /* If we exited the above loop because we arrived at the last
28850 glyph of the row, and its buffer position is still not in
28851 range, it means the last character in range is the preceding
28852 newline. Bump the end column and x values to get past the
28855 && BUFFERP (end
->object
)
28856 && (end
->charpos
< start_charpos
28857 || end
->charpos
>= end_charpos
))
28859 x
+= end
->pixel_width
;
28862 hlinfo
->mouse_face_end_x
= x
;
28863 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28866 hlinfo
->mouse_face_window
= window
;
28867 hlinfo
->mouse_face_face_id
28868 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28870 !hlinfo
->mouse_face_hidden
, -1);
28871 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28874 /* The following function is not used anymore (replaced with
28875 mouse_face_from_string_pos), but I leave it here for the time
28876 being, in case someone would. */
28878 #if false /* not used */
28880 /* Find the position of the glyph for position POS in OBJECT in
28881 window W's current matrix, and return in *X, *Y the pixel
28882 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28884 RIGHT_P means return the position of the right edge of the glyph.
28885 !RIGHT_P means return the left edge position.
28887 If no glyph for POS exists in the matrix, return the position of
28888 the glyph with the next smaller position that is in the matrix, if
28889 RIGHT_P is false. If RIGHT_P, and no glyph for POS
28890 exists in the matrix, return the position of the glyph with the
28891 next larger position in OBJECT.
28893 Value is true if a glyph was found. */
28896 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28897 int *hpos
, int *vpos
, int *x
, int *y
, bool right_p
)
28899 int yb
= window_text_bottom_y (w
);
28900 struct glyph_row
*r
;
28901 struct glyph
*best_glyph
= NULL
;
28902 struct glyph_row
*best_row
= NULL
;
28905 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28906 r
->enabled_p
&& r
->y
< yb
;
28909 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28910 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28913 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28914 if (EQ (g
->object
, object
))
28916 if (g
->charpos
== pos
)
28923 else if (best_glyph
== NULL
28924 || ((eabs (g
->charpos
- pos
)
28925 < eabs (best_glyph
->charpos
- pos
))
28928 : g
->charpos
> pos
)))
28942 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28946 *x
+= best_glyph
->pixel_width
;
28951 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28954 return best_glyph
!= NULL
;
28956 #endif /* not used */
28958 /* Find the positions of the first and the last glyphs in window W's
28959 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28960 (assumed to be a string), and return in HLINFO's mouse_face_*
28961 members the pixel and column/row coordinates of those glyphs. */
28964 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
28965 Lisp_Object object
,
28966 ptrdiff_t startpos
, ptrdiff_t endpos
)
28968 int yb
= window_text_bottom_y (w
);
28969 struct glyph_row
*r
;
28970 struct glyph
*g
, *e
;
28972 bool found
= false;
28974 /* Find the glyph row with at least one position in the range
28975 [STARTPOS..ENDPOS), and the first glyph in that row whose
28976 position belongs to that range. */
28977 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28978 r
->enabled_p
&& r
->y
< yb
;
28981 if (!r
->reversed_p
)
28983 g
= r
->glyphs
[TEXT_AREA
];
28984 e
= g
+ r
->used
[TEXT_AREA
];
28985 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28986 if (EQ (g
->object
, object
)
28987 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28989 hlinfo
->mouse_face_beg_row
28990 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28991 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28992 hlinfo
->mouse_face_beg_x
= gx
;
29001 e
= r
->glyphs
[TEXT_AREA
];
29002 g
= e
+ r
->used
[TEXT_AREA
];
29003 for ( ; g
> e
; --g
)
29004 if (EQ ((g
-1)->object
, object
)
29005 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
29007 hlinfo
->mouse_face_beg_row
29008 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29009 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29010 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
29011 gx
+= g1
->pixel_width
;
29012 hlinfo
->mouse_face_beg_x
= gx
;
29024 /* Starting with the next row, look for the first row which does NOT
29025 include any glyphs whose positions are in the range. */
29026 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
29028 g
= r
->glyphs
[TEXT_AREA
];
29029 e
= g
+ r
->used
[TEXT_AREA
];
29031 for ( ; g
< e
; ++g
)
29032 if (EQ (g
->object
, object
)
29033 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29042 /* The highlighted region ends on the previous row. */
29045 /* Set the end row. */
29046 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29048 /* Compute and set the end column and the end column's horizontal
29049 pixel coordinate. */
29050 if (!r
->reversed_p
)
29052 g
= r
->glyphs
[TEXT_AREA
];
29053 e
= g
+ r
->used
[TEXT_AREA
];
29054 for ( ; e
> g
; --e
)
29055 if (EQ ((e
-1)->object
, object
)
29056 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
29058 hlinfo
->mouse_face_end_col
= e
- g
;
29060 for (gx
= r
->x
; g
< e
; ++g
)
29061 gx
+= g
->pixel_width
;
29062 hlinfo
->mouse_face_end_x
= gx
;
29066 e
= r
->glyphs
[TEXT_AREA
];
29067 g
= e
+ r
->used
[TEXT_AREA
];
29068 for (gx
= r
->x
; e
< g
; ++e
)
29070 if (EQ (e
->object
, object
)
29071 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
29073 gx
+= e
->pixel_width
;
29075 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
29076 hlinfo
->mouse_face_end_x
= gx
;
29080 #ifdef HAVE_WINDOW_SYSTEM
29082 /* See if position X, Y is within a hot-spot of an image. */
29085 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
29087 if (!CONSP (hot_spot
))
29090 if (EQ (XCAR (hot_spot
), Qrect
))
29092 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
29093 Lisp_Object rect
= XCDR (hot_spot
);
29097 if (!CONSP (XCAR (rect
)))
29099 if (!CONSP (XCDR (rect
)))
29101 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
29103 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
29105 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
29107 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
29111 else if (EQ (XCAR (hot_spot
), Qcircle
))
29113 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
29114 Lisp_Object circ
= XCDR (hot_spot
);
29115 Lisp_Object lr
, lx0
, ly0
;
29117 && CONSP (XCAR (circ
))
29118 && (lr
= XCDR (circ
), NUMBERP (lr
))
29119 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
29120 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
29122 double r
= XFLOATINT (lr
);
29123 double dx
= XINT (lx0
) - x
;
29124 double dy
= XINT (ly0
) - y
;
29125 return (dx
* dx
+ dy
* dy
<= r
* r
);
29128 else if (EQ (XCAR (hot_spot
), Qpoly
))
29130 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
29131 if (VECTORP (XCDR (hot_spot
)))
29133 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
29134 Lisp_Object
*poly
= v
->contents
;
29135 ptrdiff_t n
= v
->header
.size
;
29137 bool inside
= false;
29138 Lisp_Object lx
, ly
;
29141 /* Need an even number of coordinates, and at least 3 edges. */
29142 if (n
< 6 || n
& 1)
29145 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
29146 If count is odd, we are inside polygon. Pixels on edges
29147 may or may not be included depending on actual geometry of the
29149 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
29150 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
29152 x0
= XINT (lx
), y0
= XINT (ly
);
29153 for (i
= 0; i
< n
; i
+= 2)
29155 int x1
= x0
, y1
= y0
;
29156 if ((lx
= poly
[i
], !INTEGERP (lx
))
29157 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
29159 x0
= XINT (lx
), y0
= XINT (ly
);
29161 /* Does this segment cross the X line? */
29169 if (y
> y0
&& y
> y1
)
29171 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
29181 find_hot_spot (Lisp_Object map
, int x
, int y
)
29183 while (CONSP (map
))
29185 if (CONSP (XCAR (map
))
29186 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
29194 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
29196 doc
: /* Lookup in image map MAP coordinates X and Y.
29197 An image map is an alist where each element has the format (AREA ID PLIST).
29198 An AREA is specified as either a rectangle, a circle, or a polygon:
29199 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
29200 pixel coordinates of the upper left and bottom right corners.
29201 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
29202 and the radius of the circle; r may be a float or integer.
29203 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
29204 vector describes one corner in the polygon.
29205 Returns the alist element for the first matching AREA in MAP. */)
29206 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
29214 return find_hot_spot (map
,
29215 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
29216 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
29220 /* Display frame CURSOR, optionally using shape defined by POINTER. */
29222 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
29224 /* Do not change cursor shape while dragging mouse. */
29225 if (EQ (do_mouse_tracking
, Qdragging
))
29228 if (!NILP (pointer
))
29230 if (EQ (pointer
, Qarrow
))
29231 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29232 else if (EQ (pointer
, Qhand
))
29233 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
29234 else if (EQ (pointer
, Qtext
))
29235 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29236 else if (EQ (pointer
, intern ("hdrag")))
29237 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29238 else if (EQ (pointer
, intern ("nhdrag")))
29239 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29240 #ifdef HAVE_X_WINDOWS
29241 else if (EQ (pointer
, intern ("vdrag")))
29242 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29244 else if (EQ (pointer
, intern ("hourglass")))
29245 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
29246 else if (EQ (pointer
, Qmodeline
))
29247 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
29249 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29252 if (cursor
!= No_Cursor
)
29253 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
29256 #endif /* HAVE_WINDOW_SYSTEM */
29258 /* Take proper action when mouse has moved to the mode or header line
29259 or marginal area AREA of window W, x-position X and y-position Y.
29260 X is relative to the start of the text display area of W, so the
29261 width of bitmap areas and scroll bars must be subtracted to get a
29262 position relative to the start of the mode line. */
29265 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
29266 enum window_part area
)
29268 struct window
*w
= XWINDOW (window
);
29269 struct frame
*f
= XFRAME (w
->frame
);
29270 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29271 #ifdef HAVE_WINDOW_SYSTEM
29272 Display_Info
*dpyinfo
;
29274 Cursor cursor
= No_Cursor
;
29275 Lisp_Object pointer
= Qnil
;
29276 int dx
, dy
, width
, height
;
29278 Lisp_Object string
, object
= Qnil
;
29279 Lisp_Object pos
IF_LINT (= Qnil
), help
;
29281 Lisp_Object mouse_face
;
29282 int original_x_pixel
= x
;
29283 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
29284 struct glyph_row
*row
IF_LINT (= 0);
29286 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
29291 /* Kludge alert: mode_line_string takes X/Y in pixels, but
29292 returns them in row/column units! */
29293 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
29294 &object
, &dx
, &dy
, &width
, &height
);
29296 row
= (area
== ON_MODE_LINE
29297 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
29298 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
29300 /* Find the glyph under the mouse pointer. */
29301 if (row
->mode_line_p
&& row
->enabled_p
)
29303 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
29304 end
= glyph
+ row
->used
[TEXT_AREA
];
29306 for (x0
= original_x_pixel
;
29307 glyph
< end
&& x0
>= glyph
->pixel_width
;
29309 x0
-= glyph
->pixel_width
;
29317 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
29318 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
29319 returns them in row/column units! */
29320 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
29321 &object
, &dx
, &dy
, &width
, &height
);
29326 #ifdef HAVE_WINDOW_SYSTEM
29327 if (IMAGEP (object
))
29329 Lisp_Object image_map
, hotspot
;
29330 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
29332 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
29334 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29338 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
29339 If so, we could look for mouse-enter, mouse-leave
29340 properties in PLIST (and do something...). */
29341 hotspot
= XCDR (hotspot
);
29342 if (CONSP (hotspot
)
29343 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29345 pointer
= Fplist_get (plist
, Qpointer
);
29346 if (NILP (pointer
))
29348 help
= Fplist_get (plist
, Qhelp_echo
);
29351 help_echo_string
= help
;
29352 XSETWINDOW (help_echo_window
, w
);
29353 help_echo_object
= w
->contents
;
29354 help_echo_pos
= charpos
;
29358 if (NILP (pointer
))
29359 pointer
= Fplist_get (XCDR (object
), QCpointer
);
29361 #endif /* HAVE_WINDOW_SYSTEM */
29363 if (STRINGP (string
))
29364 pos
= make_number (charpos
);
29366 /* Set the help text and mouse pointer. If the mouse is on a part
29367 of the mode line without any text (e.g. past the right edge of
29368 the mode line text), use the default help text and pointer. */
29369 if (STRINGP (string
) || area
== ON_MODE_LINE
)
29371 /* Arrange to display the help by setting the global variables
29372 help_echo_string, help_echo_object, and help_echo_pos. */
29375 if (STRINGP (string
))
29376 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
29380 help_echo_string
= help
;
29381 XSETWINDOW (help_echo_window
, w
);
29382 help_echo_object
= string
;
29383 help_echo_pos
= charpos
;
29385 else if (area
== ON_MODE_LINE
)
29387 Lisp_Object default_help
29388 = buffer_local_value (Qmode_line_default_help_echo
,
29391 if (STRINGP (default_help
))
29393 help_echo_string
= default_help
;
29394 XSETWINDOW (help_echo_window
, w
);
29395 help_echo_object
= Qnil
;
29396 help_echo_pos
= -1;
29401 #ifdef HAVE_WINDOW_SYSTEM
29402 /* Change the mouse pointer according to what is under it. */
29403 if (FRAME_WINDOW_P (f
))
29405 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
29407 || NILP (Vresize_mini_windows
));
29409 dpyinfo
= FRAME_DISPLAY_INFO (f
);
29410 if (STRINGP (string
))
29412 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29414 if (NILP (pointer
))
29415 pointer
= Fget_text_property (pos
, Qpointer
, string
);
29417 /* Change the mouse pointer according to what is under X/Y. */
29419 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
29422 map
= Fget_text_property (pos
, Qlocal_map
, string
);
29423 if (!KEYMAPP (map
))
29424 map
= Fget_text_property (pos
, Qkeymap
, string
);
29425 if (!KEYMAPP (map
) && draggable
)
29426 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
29429 else if (draggable
)
29430 /* Default mode-line pointer. */
29431 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29436 /* Change the mouse face according to what is under X/Y. */
29437 bool mouse_face_shown
= false;
29438 if (STRINGP (string
))
29440 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
29441 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
29442 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29447 struct glyph
* tmp_glyph
;
29451 int total_pixel_width
;
29452 ptrdiff_t begpos
, endpos
, ignore
;
29456 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
29457 Qmouse_face
, string
, Qnil
);
29463 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
29465 endpos
= SCHARS (string
);
29469 /* Calculate the glyph position GPOS of GLYPH in the
29470 displayed string, relative to the beginning of the
29471 highlighted part of the string.
29473 Note: GPOS is different from CHARPOS. CHARPOS is the
29474 position of GLYPH in the internal string object. A mode
29475 line string format has structures which are converted to
29476 a flattened string by the Emacs Lisp interpreter. The
29477 internal string is an element of those structures. The
29478 displayed string is the flattened string. */
29479 tmp_glyph
= row_start_glyph
;
29480 while (tmp_glyph
< glyph
29481 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29482 && begpos
<= tmp_glyph
->charpos
29483 && tmp_glyph
->charpos
< endpos
)))
29485 gpos
= glyph
- tmp_glyph
;
29487 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29488 the highlighted part of the displayed string to which
29489 GLYPH belongs. Note: GSEQ_LENGTH is different from
29490 SCHARS (STRING), because the latter returns the length of
29491 the internal string. */
29492 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29494 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29495 && begpos
<= tmp_glyph
->charpos
29496 && tmp_glyph
->charpos
< endpos
));
29499 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29501 /* Calculate the total pixel width of all the glyphs between
29502 the beginning of the highlighted area and GLYPH. */
29503 total_pixel_width
= 0;
29504 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29505 total_pixel_width
+= tmp_glyph
->pixel_width
;
29507 /* Pre calculation of re-rendering position. Note: X is in
29508 column units here, after the call to mode_line_string or
29509 marginal_area_string. */
29511 vpos
= (area
== ON_MODE_LINE
29512 ? (w
->current_matrix
)->nrows
- 1
29515 /* If GLYPH's position is included in the region that is
29516 already drawn in mouse face, we have nothing to do. */
29517 if ( EQ (window
, hlinfo
->mouse_face_window
)
29518 && (!row
->reversed_p
29519 ? (hlinfo
->mouse_face_beg_col
<= hpos
29520 && hpos
< hlinfo
->mouse_face_end_col
)
29521 /* In R2L rows we swap BEG and END, see below. */
29522 : (hlinfo
->mouse_face_end_col
<= hpos
29523 && hpos
< hlinfo
->mouse_face_beg_col
))
29524 && hlinfo
->mouse_face_beg_row
== vpos
)
29527 if (clear_mouse_face (hlinfo
))
29528 cursor
= No_Cursor
;
29530 if (!row
->reversed_p
)
29532 hlinfo
->mouse_face_beg_col
= hpos
;
29533 hlinfo
->mouse_face_beg_x
= original_x_pixel
29534 - (total_pixel_width
+ dx
);
29535 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29536 hlinfo
->mouse_face_end_x
= 0;
29540 /* In R2L rows, show_mouse_face expects BEG and END
29541 coordinates to be swapped. */
29542 hlinfo
->mouse_face_end_col
= hpos
;
29543 hlinfo
->mouse_face_end_x
= original_x_pixel
29544 - (total_pixel_width
+ dx
);
29545 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29546 hlinfo
->mouse_face_beg_x
= 0;
29549 hlinfo
->mouse_face_beg_row
= vpos
;
29550 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29551 hlinfo
->mouse_face_past_end
= false;
29552 hlinfo
->mouse_face_window
= window
;
29554 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29559 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29560 mouse_face_shown
= true;
29562 if (NILP (pointer
))
29567 /* If mouse-face doesn't need to be shown, clear any existing
29569 if ((area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
) && !mouse_face_shown
)
29570 clear_mouse_face (hlinfo
);
29572 #ifdef HAVE_WINDOW_SYSTEM
29573 if (FRAME_WINDOW_P (f
))
29574 define_frame_cursor1 (f
, cursor
, pointer
);
29580 Take proper action when the mouse has moved to position X, Y on
29581 frame F with regards to highlighting portions of display that have
29582 mouse-face properties. Also de-highlight portions of display where
29583 the mouse was before, set the mouse pointer shape as appropriate
29584 for the mouse coordinates, and activate help echo (tooltips).
29585 X and Y can be negative or out of range. */
29588 note_mouse_highlight (struct frame
*f
, int x
, int y
)
29590 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29591 enum window_part part
= ON_NOTHING
;
29592 Lisp_Object window
;
29594 Cursor cursor
= No_Cursor
;
29595 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
29598 /* When a menu is active, don't highlight because this looks odd. */
29599 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29600 if (popup_activated ())
29604 if (!f
->glyphs_initialized_p
29605 || f
->pointer_invisible
)
29608 hlinfo
->mouse_face_mouse_x
= x
;
29609 hlinfo
->mouse_face_mouse_y
= y
;
29610 hlinfo
->mouse_face_mouse_frame
= f
;
29612 if (hlinfo
->mouse_face_defer
)
29615 /* Which window is that in? */
29616 window
= window_from_coordinates (f
, x
, y
, &part
, true);
29618 /* If displaying active text in another window, clear that. */
29619 if (! EQ (window
, hlinfo
->mouse_face_window
)
29620 /* Also clear if we move out of text area in same window. */
29621 || (!NILP (hlinfo
->mouse_face_window
)
29624 && part
!= ON_MODE_LINE
29625 && part
!= ON_HEADER_LINE
))
29626 clear_mouse_face (hlinfo
);
29628 /* Not on a window -> return. */
29629 if (!WINDOWP (window
))
29632 /* Reset help_echo_string. It will get recomputed below. */
29633 help_echo_string
= Qnil
;
29635 /* Convert to window-relative pixel coordinates. */
29636 w
= XWINDOW (window
);
29637 frame_to_window_pixel_xy (w
, &x
, &y
);
29639 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29640 /* Handle tool-bar window differently since it doesn't display a
29642 if (EQ (window
, f
->tool_bar_window
))
29644 note_tool_bar_highlight (f
, x
, y
);
29649 /* Mouse is on the mode, header line or margin? */
29650 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
29651 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29653 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
29655 #ifdef HAVE_WINDOW_SYSTEM
29656 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29658 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29659 /* Show non-text cursor (Bug#16647). */
29667 #ifdef HAVE_WINDOW_SYSTEM
29668 if (part
== ON_VERTICAL_BORDER
)
29670 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29671 help_echo_string
= build_string ("drag-mouse-1: resize");
29673 else if (part
== ON_RIGHT_DIVIDER
)
29675 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29676 help_echo_string
= build_string ("drag-mouse-1: resize");
29678 else if (part
== ON_BOTTOM_DIVIDER
)
29679 if (! WINDOW_BOTTOMMOST_P (w
)
29681 || NILP (Vresize_mini_windows
))
29683 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29684 help_echo_string
= build_string ("drag-mouse-1: resize");
29687 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29688 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
29689 || part
== ON_VERTICAL_SCROLL_BAR
29690 || part
== ON_HORIZONTAL_SCROLL_BAR
)
29691 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29693 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29696 /* Are we in a window whose display is up to date?
29697 And verify the buffer's text has not changed. */
29698 b
= XBUFFER (w
->contents
);
29699 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
29701 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
29703 struct glyph
*glyph
;
29704 Lisp_Object object
;
29705 Lisp_Object mouse_face
= Qnil
, position
;
29706 Lisp_Object
*overlay_vec
= NULL
;
29707 ptrdiff_t i
, noverlays
;
29708 struct buffer
*obuf
;
29709 ptrdiff_t obegv
, ozv
;
29712 /* Find the glyph under X/Y. */
29713 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
29715 #ifdef HAVE_WINDOW_SYSTEM
29716 /* Look for :pointer property on image. */
29717 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
29719 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
29720 if (img
!= NULL
&& IMAGEP (img
->spec
))
29722 Lisp_Object image_map
, hotspot
;
29723 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
29725 && (hotspot
= find_hot_spot (image_map
,
29726 glyph
->slice
.img
.x
+ dx
,
29727 glyph
->slice
.img
.y
+ dy
),
29729 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29733 /* Could check XCAR (hotspot) to see if we enter/leave
29735 If so, we could look for mouse-enter, mouse-leave
29736 properties in PLIST (and do something...). */
29737 hotspot
= XCDR (hotspot
);
29738 if (CONSP (hotspot
)
29739 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29741 pointer
= Fplist_get (plist
, Qpointer
);
29742 if (NILP (pointer
))
29744 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
29745 if (!NILP (help_echo_string
))
29747 help_echo_window
= window
;
29748 help_echo_object
= glyph
->object
;
29749 help_echo_pos
= glyph
->charpos
;
29753 if (NILP (pointer
))
29754 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
29757 #endif /* HAVE_WINDOW_SYSTEM */
29759 /* Clear mouse face if X/Y not over text. */
29761 || area
!= TEXT_AREA
29762 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
29763 /* Glyph's OBJECT is nil for glyphs inserted by the
29764 display engine for its internal purposes, like truncation
29765 and continuation glyphs and blanks beyond the end of
29766 line's text on text terminals. If we are over such a
29767 glyph, we are not over any text. */
29768 || NILP (glyph
->object
)
29769 /* R2L rows have a stretch glyph at their front, which
29770 stands for no text, whereas L2R rows have no glyphs at
29771 all beyond the end of text. Treat such stretch glyphs
29772 like we do with NULL glyphs in L2R rows. */
29773 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
29774 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
29775 && glyph
->type
== STRETCH_GLYPH
29776 && glyph
->avoid_cursor_p
))
29778 if (clear_mouse_face (hlinfo
))
29779 cursor
= No_Cursor
;
29780 #ifdef HAVE_WINDOW_SYSTEM
29781 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29783 if (area
!= TEXT_AREA
)
29784 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29786 pointer
= Vvoid_text_area_pointer
;
29792 pos
= glyph
->charpos
;
29793 object
= glyph
->object
;
29794 if (!STRINGP (object
) && !BUFFERP (object
))
29797 /* If we get an out-of-range value, return now; avoid an error. */
29798 if (BUFFERP (object
) && pos
> BUF_Z (b
))
29801 /* Make the window's buffer temporarily current for
29802 overlays_at and compute_char_face. */
29803 obuf
= current_buffer
;
29804 current_buffer
= b
;
29810 /* Is this char mouse-active or does it have help-echo? */
29811 position
= make_number (pos
);
29815 if (BUFFERP (object
))
29817 /* Put all the overlays we want in a vector in overlay_vec. */
29818 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, false);
29819 /* Sort overlays into increasing priority order. */
29820 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29825 if (NILP (Vmouse_highlight
))
29827 clear_mouse_face (hlinfo
);
29828 goto check_help_echo
;
29831 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29834 cursor
= No_Cursor
;
29836 /* Check mouse-face highlighting. */
29838 /* If there exists an overlay with mouse-face overlapping
29839 the one we are currently highlighting, we have to
29840 check if we enter the overlapping overlay, and then
29841 highlight only that. */
29842 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29843 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29845 /* Find the highest priority overlay with a mouse-face. */
29846 Lisp_Object overlay
= Qnil
;
29847 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29849 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29850 if (!NILP (mouse_face
))
29851 overlay
= overlay_vec
[i
];
29854 /* If we're highlighting the same overlay as before, there's
29855 no need to do that again. */
29856 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29857 goto check_help_echo
;
29858 hlinfo
->mouse_face_overlay
= overlay
;
29860 /* Clear the display of the old active region, if any. */
29861 if (clear_mouse_face (hlinfo
))
29862 cursor
= No_Cursor
;
29864 /* If no overlay applies, get a text property. */
29865 if (NILP (overlay
))
29866 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29868 /* Next, compute the bounds of the mouse highlighting and
29870 if (!NILP (mouse_face
) && STRINGP (object
))
29872 /* The mouse-highlighting comes from a display string
29873 with a mouse-face. */
29877 s
= Fprevious_single_property_change
29878 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29879 e
= Fnext_single_property_change
29880 (position
, Qmouse_face
, object
, Qnil
);
29882 s
= make_number (0);
29884 e
= make_number (SCHARS (object
));
29885 mouse_face_from_string_pos (w
, hlinfo
, object
,
29886 XINT (s
), XINT (e
));
29887 hlinfo
->mouse_face_past_end
= false;
29888 hlinfo
->mouse_face_window
= window
;
29889 hlinfo
->mouse_face_face_id
29890 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29891 glyph
->face_id
, true);
29892 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29893 cursor
= No_Cursor
;
29897 /* The mouse-highlighting, if any, comes from an overlay
29898 or text property in the buffer. */
29899 Lisp_Object buffer
IF_LINT (= Qnil
);
29900 Lisp_Object disp_string
IF_LINT (= Qnil
);
29902 if (STRINGP (object
))
29904 /* If we are on a display string with no mouse-face,
29905 check if the text under it has one. */
29906 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29907 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29908 pos
= string_buffer_position (object
, start
);
29911 mouse_face
= get_char_property_and_overlay
29912 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29913 buffer
= w
->contents
;
29914 disp_string
= object
;
29920 disp_string
= Qnil
;
29923 if (!NILP (mouse_face
))
29925 Lisp_Object before
, after
;
29926 Lisp_Object before_string
, after_string
;
29927 /* To correctly find the limits of mouse highlight
29928 in a bidi-reordered buffer, we must not use the
29929 optimization of limiting the search in
29930 previous-single-property-change and
29931 next-single-property-change, because
29932 rows_from_pos_range needs the real start and end
29933 positions to DTRT in this case. That's because
29934 the first row visible in a window does not
29935 necessarily display the character whose position
29936 is the smallest. */
29938 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29939 ? Fmarker_position (w
->start
)
29942 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29943 ? make_number (BUF_Z (XBUFFER (buffer
))
29944 - w
->window_end_pos
)
29947 if (NILP (overlay
))
29949 /* Handle the text property case. */
29950 before
= Fprevious_single_property_change
29951 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29952 after
= Fnext_single_property_change
29953 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29954 before_string
= after_string
= Qnil
;
29958 /* Handle the overlay case. */
29959 before
= Foverlay_start (overlay
);
29960 after
= Foverlay_end (overlay
);
29961 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29962 after_string
= Foverlay_get (overlay
, Qafter_string
);
29964 if (!STRINGP (before_string
)) before_string
= Qnil
;
29965 if (!STRINGP (after_string
)) after_string
= Qnil
;
29968 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
29971 : XFASTINT (before
),
29973 ? BUF_Z (XBUFFER (buffer
))
29974 : XFASTINT (after
),
29975 before_string
, after_string
,
29977 cursor
= No_Cursor
;
29984 /* Look for a `help-echo' property. */
29985 if (NILP (help_echo_string
)) {
29986 Lisp_Object help
, overlay
;
29988 /* Check overlays first. */
29989 help
= overlay
= Qnil
;
29990 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
29992 overlay
= overlay_vec
[i
];
29993 help
= Foverlay_get (overlay
, Qhelp_echo
);
29998 help_echo_string
= help
;
29999 help_echo_window
= window
;
30000 help_echo_object
= overlay
;
30001 help_echo_pos
= pos
;
30005 Lisp_Object obj
= glyph
->object
;
30006 ptrdiff_t charpos
= glyph
->charpos
;
30008 /* Try text properties. */
30011 && charpos
< SCHARS (obj
))
30013 help
= Fget_text_property (make_number (charpos
),
30017 /* If the string itself doesn't specify a help-echo,
30018 see if the buffer text ``under'' it does. */
30019 struct glyph_row
*r
30020 = MATRIX_ROW (w
->current_matrix
, vpos
);
30021 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30022 ptrdiff_t p
= string_buffer_position (obj
, start
);
30025 help
= Fget_char_property (make_number (p
),
30026 Qhelp_echo
, w
->contents
);
30035 else if (BUFFERP (obj
)
30038 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
30043 help_echo_string
= help
;
30044 help_echo_window
= window
;
30045 help_echo_object
= obj
;
30046 help_echo_pos
= charpos
;
30051 #ifdef HAVE_WINDOW_SYSTEM
30052 /* Look for a `pointer' property. */
30053 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30055 /* Check overlays first. */
30056 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
30057 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
30059 if (NILP (pointer
))
30061 Lisp_Object obj
= glyph
->object
;
30062 ptrdiff_t charpos
= glyph
->charpos
;
30064 /* Try text properties. */
30067 && charpos
< SCHARS (obj
))
30069 pointer
= Fget_text_property (make_number (charpos
),
30071 if (NILP (pointer
))
30073 /* If the string itself doesn't specify a pointer,
30074 see if the buffer text ``under'' it does. */
30075 struct glyph_row
*r
30076 = MATRIX_ROW (w
->current_matrix
, vpos
);
30077 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30078 ptrdiff_t p
= string_buffer_position (obj
, start
);
30080 pointer
= Fget_char_property (make_number (p
),
30081 Qpointer
, w
->contents
);
30084 else if (BUFFERP (obj
)
30087 pointer
= Fget_text_property (make_number (charpos
),
30091 #endif /* HAVE_WINDOW_SYSTEM */
30095 current_buffer
= obuf
;
30101 #ifdef HAVE_WINDOW_SYSTEM
30102 if (FRAME_WINDOW_P (f
))
30103 define_frame_cursor1 (f
, cursor
, pointer
);
30105 /* This is here to prevent a compiler error, about "label at end of
30106 compound statement". */
30113 Clear any mouse-face on window W. This function is part of the
30114 redisplay interface, and is called from try_window_id and similar
30115 functions to ensure the mouse-highlight is off. */
30118 x_clear_window_mouse_face (struct window
*w
)
30120 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
30121 Lisp_Object window
;
30124 XSETWINDOW (window
, w
);
30125 if (EQ (window
, hlinfo
->mouse_face_window
))
30126 clear_mouse_face (hlinfo
);
30132 Just discard the mouse face information for frame F, if any.
30133 This is used when the size of F is changed. */
30136 cancel_mouse_face (struct frame
*f
)
30138 Lisp_Object window
;
30139 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30141 window
= hlinfo
->mouse_face_window
;
30142 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
30143 reset_mouse_highlight (hlinfo
);
30148 /***********************************************************************
30150 ***********************************************************************/
30152 #ifdef HAVE_WINDOW_SYSTEM
30154 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
30155 which intersects rectangle R. R is in window-relative coordinates. */
30158 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
30159 enum glyph_row_area area
)
30161 struct glyph
*first
= row
->glyphs
[area
];
30162 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
30163 struct glyph
*last
;
30164 int first_x
, start_x
, x
;
30166 if (area
== TEXT_AREA
&& row
->fill_line_p
)
30167 /* If row extends face to end of line write the whole line. */
30168 draw_glyphs (w
, 0, row
, area
,
30169 0, row
->used
[area
],
30170 DRAW_NORMAL_TEXT
, 0);
30173 /* Set START_X to the window-relative start position for drawing glyphs of
30174 AREA. The first glyph of the text area can be partially visible.
30175 The first glyphs of other areas cannot. */
30176 start_x
= window_box_left_offset (w
, area
);
30178 if (area
== TEXT_AREA
)
30181 /* Find the first glyph that must be redrawn. */
30183 && x
+ first
->pixel_width
< r
->x
)
30185 x
+= first
->pixel_width
;
30189 /* Find the last one. */
30192 /* Use a signed int intermediate value to avoid catastrophic
30193 failures due to comparison between signed and unsigned, when
30194 x is negative (can happen for wide images that are hscrolled). */
30195 int r_end
= r
->x
+ r
->width
;
30196 while (last
< end
&& x
< r_end
)
30198 x
+= last
->pixel_width
;
30204 draw_glyphs (w
, first_x
- start_x
, row
, area
,
30205 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
30206 DRAW_NORMAL_TEXT
, 0);
30211 /* Redraw the parts of the glyph row ROW on window W intersecting
30212 rectangle R. R is in window-relative coordinates. Value is
30213 true if mouse-face was overwritten. */
30216 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
30218 eassert (row
->enabled_p
);
30220 if (row
->mode_line_p
|| w
->pseudo_window_p
)
30221 draw_glyphs (w
, 0, row
, TEXT_AREA
,
30222 0, row
->used
[TEXT_AREA
],
30223 DRAW_NORMAL_TEXT
, 0);
30226 if (row
->used
[LEFT_MARGIN_AREA
])
30227 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
30228 if (row
->used
[TEXT_AREA
])
30229 expose_area (w
, row
, r
, TEXT_AREA
);
30230 if (row
->used
[RIGHT_MARGIN_AREA
])
30231 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
30232 draw_row_fringe_bitmaps (w
, row
);
30235 return row
->mouse_face_p
;
30239 /* Redraw those parts of glyphs rows during expose event handling that
30240 overlap other rows. Redrawing of an exposed line writes over parts
30241 of lines overlapping that exposed line; this function fixes that.
30243 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
30244 row in W's current matrix that is exposed and overlaps other rows.
30245 LAST_OVERLAPPING_ROW is the last such row. */
30248 expose_overlaps (struct window
*w
,
30249 struct glyph_row
*first_overlapping_row
,
30250 struct glyph_row
*last_overlapping_row
,
30253 struct glyph_row
*row
;
30255 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
30256 if (row
->overlapping_p
)
30258 eassert (row
->enabled_p
&& !row
->mode_line_p
);
30261 if (row
->used
[LEFT_MARGIN_AREA
])
30262 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
30264 if (row
->used
[TEXT_AREA
])
30265 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
30267 if (row
->used
[RIGHT_MARGIN_AREA
])
30268 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
30274 /* Return true if W's cursor intersects rectangle R. */
30277 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
30279 XRectangle cr
, result
;
30280 struct glyph
*cursor_glyph
;
30281 struct glyph_row
*row
;
30283 if (w
->phys_cursor
.vpos
>= 0
30284 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
30285 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
30287 && row
->cursor_in_fringe_p
)
30289 /* Cursor is in the fringe. */
30290 cr
.x
= window_box_right_offset (w
,
30291 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
30292 ? RIGHT_MARGIN_AREA
30295 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
30296 cr
.height
= row
->height
;
30297 return x_intersect_rectangles (&cr
, r
, &result
);
30300 cursor_glyph
= get_phys_cursor_glyph (w
);
30303 /* r is relative to W's box, but w->phys_cursor.x is relative
30304 to left edge of W's TEXT area. Adjust it. */
30305 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
30306 cr
.y
= w
->phys_cursor
.y
;
30307 cr
.width
= cursor_glyph
->pixel_width
;
30308 cr
.height
= w
->phys_cursor_height
;
30309 /* ++KFS: W32 version used W32-specific IntersectRect here, but
30310 I assume the effect is the same -- and this is portable. */
30311 return x_intersect_rectangles (&cr
, r
, &result
);
30313 /* If we don't understand the format, pretend we're not in the hot-spot. */
30319 Draw a vertical window border to the right of window W if W doesn't
30320 have vertical scroll bars. */
30323 x_draw_vertical_border (struct window
*w
)
30325 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30327 /* We could do better, if we knew what type of scroll-bar the adjacent
30328 windows (on either side) have... But we don't :-(
30329 However, I think this works ok. ++KFS 2003-04-25 */
30331 /* Redraw borders between horizontally adjacent windows. Don't
30332 do it for frames with vertical scroll bars because either the
30333 right scroll bar of a window, or the left scroll bar of its
30334 neighbor will suffice as a border. */
30335 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
30338 /* Note: It is necessary to redraw both the left and the right
30339 borders, for when only this single window W is being
30341 if (!WINDOW_RIGHTMOST_P (w
)
30342 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
30344 int x0
, x1
, y0
, y1
;
30346 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30349 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30352 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
30355 if (!WINDOW_LEFTMOST_P (w
)
30356 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
30358 int x0
, x1
, y0
, y1
;
30360 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30363 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30366 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
30371 /* Draw window dividers for window W. */
30374 x_draw_right_divider (struct window
*w
)
30376 struct frame
*f
= WINDOW_XFRAME (w
);
30378 if (w
->mini
|| w
->pseudo_window_p
)
30380 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30382 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
30383 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30384 int y0
= WINDOW_TOP_EDGE_Y (w
);
30385 /* The bottom divider prevails. */
30386 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30388 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30393 x_draw_bottom_divider (struct window
*w
)
30395 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30397 if (w
->mini
|| w
->pseudo_window_p
)
30399 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30401 int x0
= WINDOW_LEFT_EDGE_X (w
);
30402 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30403 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30404 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
30406 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30410 /* Redraw the part of window W intersection rectangle FR. Pixel
30411 coordinates in FR are frame-relative. Call this function with
30412 input blocked. Value is true if the exposure overwrites
30416 expose_window (struct window
*w
, XRectangle
*fr
)
30418 struct frame
*f
= XFRAME (w
->frame
);
30420 bool mouse_face_overwritten_p
= false;
30422 /* If window is not yet fully initialized, do nothing. This can
30423 happen when toolkit scroll bars are used and a window is split.
30424 Reconfiguring the scroll bar will generate an expose for a newly
30426 if (w
->current_matrix
== NULL
)
30429 /* When we're currently updating the window, display and current
30430 matrix usually don't agree. Arrange for a thorough display
30432 if (w
->must_be_updated_p
)
30434 SET_FRAME_GARBAGED (f
);
30438 /* Frame-relative pixel rectangle of W. */
30439 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
30440 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
30441 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
30442 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
30444 if (x_intersect_rectangles (fr
, &wr
, &r
))
30446 int yb
= window_text_bottom_y (w
);
30447 struct glyph_row
*row
;
30448 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
30450 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
30451 r
.x
, r
.y
, r
.width
, r
.height
));
30453 /* Convert to window coordinates. */
30454 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
30455 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
30457 /* Turn off the cursor. */
30458 bool cursor_cleared_p
= (!w
->pseudo_window_p
30459 && phys_cursor_in_rect_p (w
, &r
));
30460 if (cursor_cleared_p
)
30461 x_clear_cursor (w
);
30463 /* If the row containing the cursor extends face to end of line,
30464 then expose_area might overwrite the cursor outside the
30465 rectangle and thus notice_overwritten_cursor might clear
30466 w->phys_cursor_on_p. We remember the original value and
30467 check later if it is changed. */
30468 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
30470 /* Use a signed int intermediate value to avoid catastrophic
30471 failures due to comparison between signed and unsigned, when
30472 y0 or y1 is negative (can happen for tall images). */
30473 int r_bottom
= r
.y
+ r
.height
;
30475 /* Update lines intersecting rectangle R. */
30476 first_overlapping_row
= last_overlapping_row
= NULL
;
30477 for (row
= w
->current_matrix
->rows
;
30482 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
30484 if ((y0
>= r
.y
&& y0
< r_bottom
)
30485 || (y1
> r
.y
&& y1
< r_bottom
)
30486 || (r
.y
>= y0
&& r
.y
< y1
)
30487 || (r_bottom
> y0
&& r_bottom
< y1
))
30489 /* A header line may be overlapping, but there is no need
30490 to fix overlapping areas for them. KFS 2005-02-12 */
30491 if (row
->overlapping_p
&& !row
->mode_line_p
)
30493 if (first_overlapping_row
== NULL
)
30494 first_overlapping_row
= row
;
30495 last_overlapping_row
= row
;
30499 if (expose_line (w
, row
, &r
))
30500 mouse_face_overwritten_p
= true;
30503 else if (row
->overlapping_p
)
30505 /* We must redraw a row overlapping the exposed area. */
30507 ? y0
+ row
->phys_height
> r
.y
30508 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30510 if (first_overlapping_row
== NULL
)
30511 first_overlapping_row
= row
;
30512 last_overlapping_row
= row
;
30520 /* Display the mode line if there is one. */
30521 if (WINDOW_WANTS_MODELINE_P (w
)
30522 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30524 && row
->y
< r_bottom
)
30526 if (expose_line (w
, row
, &r
))
30527 mouse_face_overwritten_p
= true;
30530 if (!w
->pseudo_window_p
)
30532 /* Fix the display of overlapping rows. */
30533 if (first_overlapping_row
)
30534 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30537 /* Draw border between windows. */
30538 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30539 x_draw_right_divider (w
);
30541 x_draw_vertical_border (w
);
30543 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30544 x_draw_bottom_divider (w
);
30546 /* Turn the cursor on again. */
30547 if (cursor_cleared_p
30548 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30549 update_window_cursor (w
, true);
30553 return mouse_face_overwritten_p
;
30558 /* Redraw (parts) of all windows in the window tree rooted at W that
30559 intersect R. R contains frame pixel coordinates. Value is
30560 true if the exposure overwrites mouse-face. */
30563 expose_window_tree (struct window
*w
, XRectangle
*r
)
30565 struct frame
*f
= XFRAME (w
->frame
);
30566 bool mouse_face_overwritten_p
= false;
30568 while (w
&& !FRAME_GARBAGED_P (f
))
30570 mouse_face_overwritten_p
30571 |= (WINDOWP (w
->contents
)
30572 ? expose_window_tree (XWINDOW (w
->contents
), r
)
30573 : expose_window (w
, r
));
30575 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
30578 return mouse_face_overwritten_p
;
30583 Redisplay an exposed area of frame F. X and Y are the upper-left
30584 corner of the exposed rectangle. W and H are width and height of
30585 the exposed area. All are pixel values. W or H zero means redraw
30586 the entire frame. */
30589 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
30592 bool mouse_face_overwritten_p
= false;
30594 TRACE ((stderr
, "expose_frame "));
30596 /* No need to redraw if frame will be redrawn soon. */
30597 if (FRAME_GARBAGED_P (f
))
30599 TRACE ((stderr
, " garbaged\n"));
30603 /* If basic faces haven't been realized yet, there is no point in
30604 trying to redraw anything. This can happen when we get an expose
30605 event while Emacs is starting, e.g. by moving another window. */
30606 if (FRAME_FACE_CACHE (f
) == NULL
30607 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
30609 TRACE ((stderr
, " no faces\n"));
30613 if (w
== 0 || h
== 0)
30616 r
.width
= FRAME_TEXT_WIDTH (f
);
30617 r
.height
= FRAME_TEXT_HEIGHT (f
);
30627 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
30628 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
30630 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30631 if (WINDOWP (f
->tool_bar_window
))
30632 mouse_face_overwritten_p
30633 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
30636 #ifdef HAVE_X_WINDOWS
30638 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30639 if (WINDOWP (f
->menu_bar_window
))
30640 mouse_face_overwritten_p
30641 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
30642 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30646 /* Some window managers support a focus-follows-mouse style with
30647 delayed raising of frames. Imagine a partially obscured frame,
30648 and moving the mouse into partially obscured mouse-face on that
30649 frame. The visible part of the mouse-face will be highlighted,
30650 then the WM raises the obscured frame. With at least one WM, KDE
30651 2.1, Emacs is not getting any event for the raising of the frame
30652 (even tried with SubstructureRedirectMask), only Expose events.
30653 These expose events will draw text normally, i.e. not
30654 highlighted. Which means we must redo the highlight here.
30655 Subsume it under ``we love X''. --gerd 2001-08-15 */
30656 /* Included in Windows version because Windows most likely does not
30657 do the right thing if any third party tool offers
30658 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30659 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
30661 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30662 if (f
== hlinfo
->mouse_face_mouse_frame
)
30664 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
30665 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
30666 clear_mouse_face (hlinfo
);
30667 note_mouse_highlight (f
, mouse_x
, mouse_y
);
30674 Determine the intersection of two rectangles R1 and R2. Return
30675 the intersection in *RESULT. Value is true if RESULT is not
30679 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
30681 XRectangle
*left
, *right
;
30682 XRectangle
*upper
, *lower
;
30683 bool intersection_p
= false;
30685 /* Rearrange so that R1 is the left-most rectangle. */
30687 left
= r1
, right
= r2
;
30689 left
= r2
, right
= r1
;
30691 /* X0 of the intersection is right.x0, if this is inside R1,
30692 otherwise there is no intersection. */
30693 if (right
->x
<= left
->x
+ left
->width
)
30695 result
->x
= right
->x
;
30697 /* The right end of the intersection is the minimum of
30698 the right ends of left and right. */
30699 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
30702 /* Same game for Y. */
30704 upper
= r1
, lower
= r2
;
30706 upper
= r2
, lower
= r1
;
30708 /* The upper end of the intersection is lower.y0, if this is inside
30709 of upper. Otherwise, there is no intersection. */
30710 if (lower
->y
<= upper
->y
+ upper
->height
)
30712 result
->y
= lower
->y
;
30714 /* The lower end of the intersection is the minimum of the lower
30715 ends of upper and lower. */
30716 result
->height
= (min (lower
->y
+ lower
->height
,
30717 upper
->y
+ upper
->height
)
30719 intersection_p
= true;
30723 return intersection_p
;
30726 #endif /* HAVE_WINDOW_SYSTEM */
30729 /***********************************************************************
30731 ***********************************************************************/
30734 syms_of_xdisp (void)
30736 Vwith_echo_area_save_vector
= Qnil
;
30737 staticpro (&Vwith_echo_area_save_vector
);
30739 Vmessage_stack
= Qnil
;
30740 staticpro (&Vmessage_stack
);
30742 /* Non-nil means don't actually do any redisplay. */
30743 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
30745 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
30747 DEFVAR_BOOL("inhibit-message", inhibit_message
,
30748 doc
: /* Non-nil means calls to `message' are not displayed.
30749 They are still logged to the *Messages* buffer. */);
30750 inhibit_message
= 0;
30752 message_dolog_marker1
= Fmake_marker ();
30753 staticpro (&message_dolog_marker1
);
30754 message_dolog_marker2
= Fmake_marker ();
30755 staticpro (&message_dolog_marker2
);
30756 message_dolog_marker3
= Fmake_marker ();
30757 staticpro (&message_dolog_marker3
);
30760 defsubr (&Sdump_frame_glyph_matrix
);
30761 defsubr (&Sdump_glyph_matrix
);
30762 defsubr (&Sdump_glyph_row
);
30763 defsubr (&Sdump_tool_bar_row
);
30764 defsubr (&Strace_redisplay
);
30765 defsubr (&Strace_to_stderr
);
30767 #ifdef HAVE_WINDOW_SYSTEM
30768 defsubr (&Stool_bar_height
);
30769 defsubr (&Slookup_image_map
);
30771 defsubr (&Sline_pixel_height
);
30772 defsubr (&Sformat_mode_line
);
30773 defsubr (&Sinvisible_p
);
30774 defsubr (&Scurrent_bidi_paragraph_direction
);
30775 defsubr (&Swindow_text_pixel_size
);
30776 defsubr (&Smove_point_visually
);
30777 defsubr (&Sbidi_find_overridden_directionality
);
30779 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
30780 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
30781 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
30782 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
30783 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
30784 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
30785 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
30786 DEFSYM (Qeval
, "eval");
30787 DEFSYM (QCdata
, ":data");
30789 /* Names of text properties relevant for redisplay. */
30790 DEFSYM (Qdisplay
, "display");
30791 DEFSYM (Qspace_width
, "space-width");
30792 DEFSYM (Qraise
, "raise");
30793 DEFSYM (Qslice
, "slice");
30794 DEFSYM (Qspace
, "space");
30795 DEFSYM (Qmargin
, "margin");
30796 DEFSYM (Qpointer
, "pointer");
30797 DEFSYM (Qleft_margin
, "left-margin");
30798 DEFSYM (Qright_margin
, "right-margin");
30799 DEFSYM (Qcenter
, "center");
30800 DEFSYM (Qline_height
, "line-height");
30801 DEFSYM (QCalign_to
, ":align-to");
30802 DEFSYM (QCrelative_width
, ":relative-width");
30803 DEFSYM (QCrelative_height
, ":relative-height");
30804 DEFSYM (QCeval
, ":eval");
30805 DEFSYM (QCpropertize
, ":propertize");
30806 DEFSYM (QCfile
, ":file");
30807 DEFSYM (Qfontified
, "fontified");
30808 DEFSYM (Qfontification_functions
, "fontification-functions");
30810 /* Name of the face used to highlight trailing whitespace. */
30811 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
30813 /* Name and number of the face used to highlight escape glyphs. */
30814 DEFSYM (Qescape_glyph
, "escape-glyph");
30816 /* Name and number of the face used to highlight non-breaking spaces. */
30817 DEFSYM (Qnobreak_space
, "nobreak-space");
30819 /* The symbol 'image' which is the car of the lists used to represent
30820 images in Lisp. Also a tool bar style. */
30821 DEFSYM (Qimage
, "image");
30823 /* Tool bar styles. */
30824 DEFSYM (Qtext
, "text");
30825 DEFSYM (Qboth
, "both");
30826 DEFSYM (Qboth_horiz
, "both-horiz");
30827 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
30829 /* The image map types. */
30830 DEFSYM (QCmap
, ":map");
30831 DEFSYM (QCpointer
, ":pointer");
30832 DEFSYM (Qrect
, "rect");
30833 DEFSYM (Qcircle
, "circle");
30834 DEFSYM (Qpoly
, "poly");
30836 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
30838 DEFSYM (Qgrow_only
, "grow-only");
30839 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
30840 DEFSYM (Qposition
, "position");
30841 DEFSYM (Qbuffer_position
, "buffer-position");
30842 DEFSYM (Qobject
, "object");
30844 /* Cursor shapes. */
30845 DEFSYM (Qbar
, "bar");
30846 DEFSYM (Qhbar
, "hbar");
30847 DEFSYM (Qbox
, "box");
30848 DEFSYM (Qhollow
, "hollow");
30850 /* Pointer shapes. */
30851 DEFSYM (Qhand
, "hand");
30852 DEFSYM (Qarrow
, "arrow");
30855 DEFSYM (Qdragging
, "dragging");
30857 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30859 list_of_error
= list1 (list2 (Qerror
, Qvoid_variable
));
30860 staticpro (&list_of_error
);
30862 /* Values of those variables at last redisplay are stored as
30863 properties on 'overlay-arrow-position' symbol. However, if
30864 Voverlay_arrow_position is a marker, last-arrow-position is its
30865 numerical position. */
30866 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30867 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30869 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
30870 properties on a symbol in overlay-arrow-variable-list. */
30871 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30872 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30874 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30875 staticpro (&echo_buffer
[0]);
30876 staticpro (&echo_buffer
[1]);
30878 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30879 staticpro (&echo_area_buffer
[0]);
30880 staticpro (&echo_area_buffer
[1]);
30882 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30883 staticpro (&Vmessages_buffer_name
);
30885 mode_line_proptrans_alist
= Qnil
;
30886 staticpro (&mode_line_proptrans_alist
);
30887 mode_line_string_list
= Qnil
;
30888 staticpro (&mode_line_string_list
);
30889 mode_line_string_face
= Qnil
;
30890 staticpro (&mode_line_string_face
);
30891 mode_line_string_face_prop
= Qnil
;
30892 staticpro (&mode_line_string_face_prop
);
30893 Vmode_line_unwind_vector
= Qnil
;
30894 staticpro (&Vmode_line_unwind_vector
);
30896 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30898 help_echo_string
= Qnil
;
30899 staticpro (&help_echo_string
);
30900 help_echo_object
= Qnil
;
30901 staticpro (&help_echo_object
);
30902 help_echo_window
= Qnil
;
30903 staticpro (&help_echo_window
);
30904 previous_help_echo_string
= Qnil
;
30905 staticpro (&previous_help_echo_string
);
30906 help_echo_pos
= -1;
30908 DEFSYM (Qright_to_left
, "right-to-left");
30909 DEFSYM (Qleft_to_right
, "left-to-right");
30910 defsubr (&Sbidi_resolved_levels
);
30912 #ifdef HAVE_WINDOW_SYSTEM
30913 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30914 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30915 For example, if a block cursor is over a tab, it will be drawn as
30916 wide as that tab on the display. */);
30917 x_stretch_cursor_p
= 0;
30920 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30921 doc
: /* Non-nil means highlight trailing whitespace.
30922 The face used for trailing whitespace is `trailing-whitespace'. */);
30923 Vshow_trailing_whitespace
= Qnil
;
30925 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30926 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30927 If the value is t, Emacs highlights non-ASCII chars which have the
30928 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30929 or `escape-glyph' face respectively.
30931 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30932 U+2011 (non-breaking hyphen) are affected.
30934 Any other non-nil value means to display these characters as a escape
30935 glyph followed by an ordinary space or hyphen.
30937 A value of nil means no special handling of these characters. */);
30938 Vnobreak_char_display
= Qt
;
30940 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30941 doc
: /* The pointer shape to show in void text areas.
30942 A value of nil means to show the text pointer. Other options are
30943 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
30945 Vvoid_text_area_pointer
= Qarrow
;
30947 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
30948 doc
: /* Non-nil means don't actually do any redisplay.
30949 This is used for internal purposes. */);
30950 Vinhibit_redisplay
= Qnil
;
30952 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
30953 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30954 Vglobal_mode_string
= Qnil
;
30956 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
30957 doc
: /* Marker for where to display an arrow on top of the buffer text.
30958 This must be the beginning of a line in order to work.
30959 See also `overlay-arrow-string'. */);
30960 Voverlay_arrow_position
= Qnil
;
30962 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
30963 doc
: /* String to display as an arrow in non-window frames.
30964 See also `overlay-arrow-position'. */);
30965 Voverlay_arrow_string
= build_pure_c_string ("=>");
30967 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
30968 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
30969 The symbols on this list are examined during redisplay to determine
30970 where to display overlay arrows. */);
30971 Voverlay_arrow_variable_list
30972 = list1 (intern_c_string ("overlay-arrow-position"));
30974 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
30975 doc
: /* The number of lines to try scrolling a window by when point moves out.
30976 If that fails to bring point back on frame, point is centered instead.
30977 If this is zero, point is always centered after it moves off frame.
30978 If you want scrolling to always be a line at a time, you should set
30979 `scroll-conservatively' to a large value rather than set this to 1. */);
30981 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
30982 doc
: /* Scroll up to this many lines, to bring point back on screen.
30983 If point moves off-screen, redisplay will scroll by up to
30984 `scroll-conservatively' lines in order to bring point just barely
30985 onto the screen again. If that cannot be done, then redisplay
30986 recenters point as usual.
30988 If the value is greater than 100, redisplay will never recenter point,
30989 but will always scroll just enough text to bring point into view, even
30990 if you move far away.
30992 A value of zero means always recenter point if it moves off screen. */);
30993 scroll_conservatively
= 0;
30995 DEFVAR_INT ("scroll-margin", scroll_margin
,
30996 doc
: /* Number of lines of margin at the top and bottom of a window.
30997 Recenter the window whenever point gets within this many lines
30998 of the top or bottom of the window. */);
31001 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
31002 doc
: /* Pixels per inch value for non-window system displays.
31003 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
31004 Vdisplay_pixels_per_inch
= make_float (72.0);
31007 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
31010 DEFVAR_LISP ("truncate-partial-width-windows",
31011 Vtruncate_partial_width_windows
,
31012 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
31013 For an integer value, truncate lines in each window narrower than the
31014 full frame width, provided the window width is less than that integer;
31015 otherwise, respect the value of `truncate-lines'.
31017 For any other non-nil value, truncate lines in all windows that do
31018 not span the full frame width.
31020 A value of nil means to respect the value of `truncate-lines'.
31022 If `word-wrap' is enabled, you might want to reduce this. */);
31023 Vtruncate_partial_width_windows
= make_number (50);
31025 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
31026 doc
: /* Maximum buffer size for which line number should be displayed.
31027 If the buffer is bigger than this, the line number does not appear
31028 in the mode line. A value of nil means no limit. */);
31029 Vline_number_display_limit
= Qnil
;
31031 DEFVAR_INT ("line-number-display-limit-width",
31032 line_number_display_limit_width
,
31033 doc
: /* Maximum line width (in characters) for line number display.
31034 If the average length of the lines near point is bigger than this, then the
31035 line number may be omitted from the mode line. */);
31036 line_number_display_limit_width
= 200;
31038 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
31039 doc
: /* Non-nil means highlight region even in nonselected windows. */);
31040 highlight_nonselected_windows
= false;
31042 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
31043 doc
: /* Non-nil if more than one frame is visible on this display.
31044 Minibuffer-only frames don't count, but iconified frames do.
31045 This variable is not guaranteed to be accurate except while processing
31046 `frame-title-format' and `icon-title-format'. */);
31048 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
31049 doc
: /* Template for displaying the title bar of visible frames.
31050 (Assuming the window manager supports this feature.)
31052 This variable has the same structure as `mode-line-format', except that
31053 the %c and %l constructs are ignored. It is used only on frames for
31054 which no explicit name has been set (see `modify-frame-parameters'). */);
31056 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
31057 doc
: /* Template for displaying the title bar of an iconified frame.
31058 (Assuming the window manager supports this feature.)
31059 This variable has the same structure as `mode-line-format' (which see),
31060 and is used only on frames for which no explicit name has been set
31061 (see `modify-frame-parameters'). */);
31063 = Vframe_title_format
31064 = listn (CONSTYPE_PURE
, 3,
31065 intern_c_string ("multiple-frames"),
31066 build_pure_c_string ("%b"),
31067 listn (CONSTYPE_PURE
, 4,
31068 empty_unibyte_string
,
31069 intern_c_string ("invocation-name"),
31070 build_pure_c_string ("@"),
31071 intern_c_string ("system-name")));
31073 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
31074 doc
: /* Maximum number of lines to keep in the message log buffer.
31075 If nil, disable message logging. If t, log messages but don't truncate
31076 the buffer when it becomes large. */);
31077 Vmessage_log_max
= make_number (1000);
31079 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
31080 doc
: /* Functions called before redisplay, if window sizes have changed.
31081 The value should be a list of functions that take one argument.
31082 Just before redisplay, for each frame, if any of its windows have changed
31083 size since the last redisplay, or have been split or deleted,
31084 all the functions in the list are called, with the frame as argument. */);
31085 Vwindow_size_change_functions
= Qnil
;
31087 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
31088 doc
: /* List of functions to call before redisplaying a window with scrolling.
31089 Each function is called with two arguments, the window and its new
31090 display-start position.
31091 These functions are called whenever the `window-start' marker is modified,
31092 either to point into another buffer (e.g. via `set-window-buffer') or another
31093 place in the same buffer.
31094 Note that the value of `window-end' is not valid when these functions are
31097 Warning: Do not use this feature to alter the way the window
31098 is scrolled. It is not designed for that, and such use probably won't
31100 Vwindow_scroll_functions
= Qnil
;
31102 DEFVAR_LISP ("window-text-change-functions",
31103 Vwindow_text_change_functions
,
31104 doc
: /* Functions to call in redisplay when text in the window might change. */);
31105 Vwindow_text_change_functions
= Qnil
;
31107 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
31108 doc
: /* Functions called when redisplay of a window reaches the end trigger.
31109 Each function is called with two arguments, the window and the end trigger value.
31110 See `set-window-redisplay-end-trigger'. */);
31111 Vredisplay_end_trigger_functions
= Qnil
;
31113 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
31114 doc
: /* Non-nil means autoselect window with mouse pointer.
31115 If nil, do not autoselect windows.
31116 A positive number means delay autoselection by that many seconds: a
31117 window is autoselected only after the mouse has remained in that
31118 window for the duration of the delay.
31119 A negative number has a similar effect, but causes windows to be
31120 autoselected only after the mouse has stopped moving. (Because of
31121 the way Emacs compares mouse events, you will occasionally wait twice
31122 that time before the window gets selected.)
31123 Any other value means to autoselect window instantaneously when the
31124 mouse pointer enters it.
31126 Autoselection selects the minibuffer only if it is active, and never
31127 unselects the minibuffer if it is active.
31129 When customizing this variable make sure that the actual value of
31130 `focus-follows-mouse' matches the behavior of your window manager. */);
31131 Vmouse_autoselect_window
= Qnil
;
31133 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
31134 doc
: /* Non-nil means automatically resize tool-bars.
31135 This dynamically changes the tool-bar's height to the minimum height
31136 that is needed to make all tool-bar items visible.
31137 If value is `grow-only', the tool-bar's height is only increased
31138 automatically; to decrease the tool-bar height, use \\[recenter]. */);
31139 Vauto_resize_tool_bars
= Qt
;
31141 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
31142 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
31143 auto_raise_tool_bar_buttons_p
= true;
31145 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
31146 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
31147 make_cursor_line_fully_visible_p
= true;
31149 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
31150 doc
: /* Border below tool-bar in pixels.
31151 If an integer, use it as the height of the border.
31152 If it is one of `internal-border-width' or `border-width', use the
31153 value of the corresponding frame parameter.
31154 Otherwise, no border is added below the tool-bar. */);
31155 Vtool_bar_border
= Qinternal_border_width
;
31157 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
31158 doc
: /* Margin around tool-bar buttons in pixels.
31159 If an integer, use that for both horizontal and vertical margins.
31160 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
31161 HORZ specifying the horizontal margin, and VERT specifying the
31162 vertical margin. */);
31163 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
31165 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
31166 doc
: /* Relief thickness of tool-bar buttons. */);
31167 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
31169 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
31170 doc
: /* Tool bar style to use.
31172 image - show images only
31173 text - show text only
31174 both - show both, text below image
31175 both-horiz - show text to the right of the image
31176 text-image-horiz - show text to the left of the image
31177 any other - use system default or image if no system default.
31179 This variable only affects the GTK+ toolkit version of Emacs. */);
31180 Vtool_bar_style
= Qnil
;
31182 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
31183 doc
: /* Maximum number of characters a label can have to be shown.
31184 The tool bar style must also show labels for this to have any effect, see
31185 `tool-bar-style'. */);
31186 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
31188 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
31189 doc
: /* List of functions to call to fontify regions of text.
31190 Each function is called with one argument POS. Functions must
31191 fontify a region starting at POS in the current buffer, and give
31192 fontified regions the property `fontified'. */);
31193 Vfontification_functions
= Qnil
;
31194 Fmake_variable_buffer_local (Qfontification_functions
);
31196 DEFVAR_BOOL ("unibyte-display-via-language-environment",
31197 unibyte_display_via_language_environment
,
31198 doc
: /* Non-nil means display unibyte text according to language environment.
31199 Specifically, this means that raw bytes in the range 160-255 decimal
31200 are displayed by converting them to the equivalent multibyte characters
31201 according to the current language environment. As a result, they are
31202 displayed according to the current fontset.
31204 Note that this variable affects only how these bytes are displayed,
31205 but does not change the fact they are interpreted as raw bytes. */);
31206 unibyte_display_via_language_environment
= false;
31208 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
31209 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
31210 If a float, it specifies a fraction of the mini-window frame's height.
31211 If an integer, it specifies a number of lines. */);
31212 Vmax_mini_window_height
= make_float (0.25);
31214 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
31215 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
31216 A value of nil means don't automatically resize mini-windows.
31217 A value of t means resize them to fit the text displayed in them.
31218 A value of `grow-only', the default, means let mini-windows grow only;
31219 they return to their normal size when the minibuffer is closed, or the
31220 echo area becomes empty. */);
31221 Vresize_mini_windows
= Qgrow_only
;
31223 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
31224 doc
: /* Alist specifying how to blink the cursor off.
31225 Each element has the form (ON-STATE . OFF-STATE). Whenever the
31226 `cursor-type' frame-parameter or variable equals ON-STATE,
31227 comparing using `equal', Emacs uses OFF-STATE to specify
31228 how to blink it off. ON-STATE and OFF-STATE are values for
31229 the `cursor-type' frame parameter.
31231 If a frame's ON-STATE has no entry in this list,
31232 the frame's other specifications determine how to blink the cursor off. */);
31233 Vblink_cursor_alist
= Qnil
;
31235 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
31236 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
31237 If non-nil, windows are automatically scrolled horizontally to make
31238 point visible. */);
31239 automatic_hscrolling_p
= true;
31240 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
31242 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
31243 doc
: /* How many columns away from the window edge point is allowed to get
31244 before automatic hscrolling will horizontally scroll the window. */);
31245 hscroll_margin
= 5;
31247 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
31248 doc
: /* How many columns to scroll the window when point gets too close to the edge.
31249 When point is less than `hscroll-margin' columns from the window
31250 edge, automatic hscrolling will scroll the window by the amount of columns
31251 determined by this variable. If its value is a positive integer, scroll that
31252 many columns. If it's a positive floating-point number, it specifies the
31253 fraction of the window's width to scroll. If it's nil or zero, point will be
31254 centered horizontally after the scroll. Any other value, including negative
31255 numbers, are treated as if the value were zero.
31257 Automatic hscrolling always moves point outside the scroll margin, so if
31258 point was more than scroll step columns inside the margin, the window will
31259 scroll more than the value given by the scroll step.
31261 Note that the lower bound for automatic hscrolling specified by `scroll-left'
31262 and `scroll-right' overrides this variable's effect. */);
31263 Vhscroll_step
= make_number (0);
31265 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
31266 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
31267 Bind this around calls to `message' to let it take effect. */);
31268 message_truncate_lines
= false;
31270 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
31271 doc
: /* Normal hook run to update the menu bar definitions.
31272 Redisplay runs this hook before it redisplays the menu bar.
31273 This is used to update menus such as Buffers, whose contents depend on
31275 Vmenu_bar_update_hook
= Qnil
;
31277 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
31278 doc
: /* Frame for which we are updating a menu.
31279 The enable predicate for a menu binding should check this variable. */);
31280 Vmenu_updating_frame
= Qnil
;
31282 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
31283 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
31284 inhibit_menubar_update
= false;
31286 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
31287 doc
: /* Prefix prepended to all continuation lines at display time.
31288 The value may be a string, an image, or a stretch-glyph; it is
31289 interpreted in the same way as the value of a `display' text property.
31291 This variable is overridden by any `wrap-prefix' text or overlay
31294 To add a prefix to non-continuation lines, use `line-prefix'. */);
31295 Vwrap_prefix
= Qnil
;
31296 DEFSYM (Qwrap_prefix
, "wrap-prefix");
31297 Fmake_variable_buffer_local (Qwrap_prefix
);
31299 DEFVAR_LISP ("line-prefix", Vline_prefix
,
31300 doc
: /* Prefix prepended to all non-continuation lines at display time.
31301 The value may be a string, an image, or a stretch-glyph; it is
31302 interpreted in the same way as the value of a `display' text property.
31304 This variable is overridden by any `line-prefix' text or overlay
31307 To add a prefix to continuation lines, use `wrap-prefix'. */);
31308 Vline_prefix
= Qnil
;
31309 DEFSYM (Qline_prefix
, "line-prefix");
31310 Fmake_variable_buffer_local (Qline_prefix
);
31312 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
31313 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
31314 inhibit_eval_during_redisplay
= false;
31316 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
31317 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
31318 inhibit_free_realized_faces
= false;
31320 DEFVAR_BOOL ("inhibit-bidi-mirroring", inhibit_bidi_mirroring
,
31321 doc
: /* Non-nil means don't mirror characters even when bidi context requires that.
31322 Intended for use during debugging and for testing bidi display;
31323 see biditest.el in the test suite. */);
31324 inhibit_bidi_mirroring
= false;
31327 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
31328 doc
: /* Inhibit try_window_id display optimization. */);
31329 inhibit_try_window_id
= false;
31331 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
31332 doc
: /* Inhibit try_window_reusing display optimization. */);
31333 inhibit_try_window_reusing
= false;
31335 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
31336 doc
: /* Inhibit try_cursor_movement display optimization. */);
31337 inhibit_try_cursor_movement
= false;
31338 #endif /* GLYPH_DEBUG */
31340 DEFVAR_INT ("overline-margin", overline_margin
,
31341 doc
: /* Space between overline and text, in pixels.
31342 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
31343 margin to the character height. */);
31344 overline_margin
= 2;
31346 DEFVAR_INT ("underline-minimum-offset",
31347 underline_minimum_offset
,
31348 doc
: /* Minimum distance between baseline and underline.
31349 This can improve legibility of underlined text at small font sizes,
31350 particularly when using variable `x-use-underline-position-properties'
31351 with fonts that specify an UNDERLINE_POSITION relatively close to the
31352 baseline. The default value is 1. */);
31353 underline_minimum_offset
= 1;
31355 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
31356 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
31357 This feature only works when on a window system that can change
31358 cursor shapes. */);
31359 display_hourglass_p
= true;
31361 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
31362 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
31363 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
31365 #ifdef HAVE_WINDOW_SYSTEM
31366 hourglass_atimer
= NULL
;
31367 hourglass_shown_p
= false;
31368 #endif /* HAVE_WINDOW_SYSTEM */
31370 /* Name of the face used to display glyphless characters. */
31371 DEFSYM (Qglyphless_char
, "glyphless-char");
31373 /* Method symbols for Vglyphless_char_display. */
31374 DEFSYM (Qhex_code
, "hex-code");
31375 DEFSYM (Qempty_box
, "empty-box");
31376 DEFSYM (Qthin_space
, "thin-space");
31377 DEFSYM (Qzero_width
, "zero-width");
31379 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
31380 doc
: /* Function run just before redisplay.
31381 It is called with one argument, which is the set of windows that are to
31382 be redisplayed. This set can be nil (meaning, only the selected window),
31383 or t (meaning all windows). */);
31384 Vpre_redisplay_function
= intern ("ignore");
31386 /* Symbol for the purpose of Vglyphless_char_display. */
31387 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
31388 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
31390 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
31391 doc
: /* Char-table defining glyphless characters.
31392 Each element, if non-nil, should be one of the following:
31393 an ASCII acronym string: display this string in a box
31394 `hex-code': display the hexadecimal code of a character in a box
31395 `empty-box': display as an empty box
31396 `thin-space': display as 1-pixel width space
31397 `zero-width': don't display
31398 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
31399 display method for graphical terminals and text terminals respectively.
31400 GRAPHICAL and TEXT should each have one of the values listed above.
31402 The char-table has one extra slot to control the display of a character for
31403 which no font is found. This slot only takes effect on graphical terminals.
31404 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
31405 `thin-space'. The default is `empty-box'.
31407 If a character has a non-nil entry in an active display table, the
31408 display table takes effect; in this case, Emacs does not consult
31409 `glyphless-char-display' at all. */);
31410 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
31411 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
31414 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
31415 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
31416 Vdebug_on_message
= Qnil
;
31418 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
31420 Vredisplay__all_windows_cause
= Fmake_hash_table (0, NULL
);
31422 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
31424 Vredisplay__mode_lines_cause
= Fmake_hash_table (0, NULL
);
31428 /* Initialize this module when Emacs starts. */
31433 CHARPOS (this_line_start_pos
) = 0;
31435 if (!noninteractive
)
31437 struct window
*m
= XWINDOW (minibuf_window
);
31438 Lisp_Object frame
= m
->frame
;
31439 struct frame
*f
= XFRAME (frame
);
31440 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
31441 struct window
*r
= XWINDOW (root
);
31444 echo_area_window
= minibuf_window
;
31446 r
->top_line
= FRAME_TOP_MARGIN (f
);
31447 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
31448 r
->total_cols
= FRAME_COLS (f
);
31449 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31450 r
->total_lines
= FRAME_TOTAL_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
31451 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
31453 m
->top_line
= FRAME_TOTAL_LINES (f
) - 1;
31454 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
31455 m
->total_cols
= FRAME_COLS (f
);
31456 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31457 m
->total_lines
= 1;
31458 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
31460 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
31461 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
31462 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
31464 /* The default ellipsis glyphs `...'. */
31465 for (i
= 0; i
< 3; ++i
)
31466 default_invis_vector
[i
] = make_number ('.');
31470 /* Allocate the buffer for frame titles.
31471 Also used for `format-mode-line'. */
31473 mode_line_noprop_buf
= xmalloc (size
);
31474 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
31475 mode_line_noprop_ptr
= mode_line_noprop_buf
;
31476 mode_line_target
= MODE_LINE_DISPLAY
;
31479 help_echo_showing_p
= false;
31482 #ifdef HAVE_WINDOW_SYSTEM
31484 /* Platform-independent portion of hourglass implementation. */
31486 /* Timer function of hourglass_atimer. */
31489 show_hourglass (struct atimer
*timer
)
31491 /* The timer implementation will cancel this timer automatically
31492 after this function has run. Set hourglass_atimer to null
31493 so that we know the timer doesn't have to be canceled. */
31494 hourglass_atimer
= NULL
;
31496 if (!hourglass_shown_p
)
31498 Lisp_Object tail
, frame
;
31502 FOR_EACH_FRAME (tail
, frame
)
31504 struct frame
*f
= XFRAME (frame
);
31506 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31507 && FRAME_RIF (f
)->show_hourglass
)
31508 FRAME_RIF (f
)->show_hourglass (f
);
31511 hourglass_shown_p
= true;
31516 /* Cancel a currently active hourglass timer, and start a new one. */
31519 start_hourglass (void)
31521 struct timespec delay
;
31523 cancel_hourglass ();
31525 if (INTEGERP (Vhourglass_delay
)
31526 && XINT (Vhourglass_delay
) > 0)
31527 delay
= make_timespec (min (XINT (Vhourglass_delay
),
31528 TYPE_MAXIMUM (time_t)),
31530 else if (FLOATP (Vhourglass_delay
)
31531 && XFLOAT_DATA (Vhourglass_delay
) > 0)
31532 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
31534 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
31536 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
31537 show_hourglass
, NULL
);
31540 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31544 cancel_hourglass (void)
31546 if (hourglass_atimer
)
31548 cancel_atimer (hourglass_atimer
);
31549 hourglass_atimer
= NULL
;
31552 if (hourglass_shown_p
)
31554 Lisp_Object tail
, frame
;
31558 FOR_EACH_FRAME (tail
, frame
)
31560 struct frame
*f
= XFRAME (frame
);
31562 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31563 && FRAME_RIF (f
)->hide_hourglass
)
31564 FRAME_RIF (f
)->hide_hourglass (f
);
31566 /* No cursors on non GUI frames - restore to stock arrow cursor. */
31567 else if (!FRAME_W32_P (f
))
31568 w32_arrow_cursor ();
31572 hourglass_shown_p
= false;
31577 #endif /* HAVE_WINDOW_SYSTEM */