1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2016 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 (at
11 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 "composite.h"
296 #include "keyboard.h"
300 #include "termchar.h"
301 #include "dispextern.h"
302 #include "character.h"
306 #include "commands.h"
309 #include "termhooks.h"
310 #include "termopts.h"
311 #include "intervals.h"
313 #include "region-cache.h"
316 #include "blockinput.h"
318 #ifdef HAVE_WINDOW_SYSTEM
320 #endif /* HAVE_WINDOW_SYSTEM */
322 #ifndef FRAME_X_OUTPUT
323 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
326 #define INFINITY 10000000
328 /* Holds the list (error). */
329 static Lisp_Object list_of_error
;
331 #ifdef HAVE_WINDOW_SYSTEM
333 /* Test if overflow newline into fringe. Called with iterator IT
334 at or past right window margin, and with IT->current_x set. */
336 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
337 (!NILP (Voverflow_newline_into_fringe) \
338 && FRAME_WINDOW_P ((IT)->f) \
339 && ((IT)->bidi_it.paragraph_dir == R2L \
340 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
341 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
342 && (IT)->current_x == (IT)->last_visible_x)
344 #else /* !HAVE_WINDOW_SYSTEM */
345 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) false
346 #endif /* HAVE_WINDOW_SYSTEM */
348 /* Test if the display element loaded in IT, or the underlying buffer
349 or string character, is a space or a TAB character. This is used
350 to determine where word wrapping can occur. */
352 #define IT_DISPLAYING_WHITESPACE(it) \
353 ((it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t')) \
354 || ((STRINGP (it->string) \
355 && (SREF (it->string, IT_STRING_BYTEPOS (*it)) == ' ' \
356 || SREF (it->string, IT_STRING_BYTEPOS (*it)) == '\t')) \
358 && (it->s[IT_BYTEPOS (*it)] == ' ' \
359 || it->s[IT_BYTEPOS (*it)] == '\t')) \
360 || (IT_BYTEPOS (*it) < ZV_BYTE \
361 && (*BYTE_POS_ADDR (IT_BYTEPOS (*it)) == ' ' \
362 || *BYTE_POS_ADDR (IT_BYTEPOS (*it)) == '\t')))) \
364 /* True means print newline to stdout before next mini-buffer message. */
366 bool noninteractive_need_newline
;
368 /* True means print newline to message log before next message. */
370 static bool message_log_need_newline
;
372 /* Three markers that message_dolog uses.
373 It could allocate them itself, but that causes trouble
374 in handling memory-full errors. */
375 static Lisp_Object message_dolog_marker1
;
376 static Lisp_Object message_dolog_marker2
;
377 static Lisp_Object message_dolog_marker3
;
379 /* The buffer position of the first character appearing entirely or
380 partially on the line of the selected window which contains the
381 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
382 redisplay optimization in redisplay_internal. */
384 static struct text_pos this_line_start_pos
;
386 /* Number of characters past the end of the line above, including the
387 terminating newline. */
389 static struct text_pos this_line_end_pos
;
391 /* The vertical positions and the height of this line. */
393 static int this_line_vpos
;
394 static int this_line_y
;
395 static int this_line_pixel_height
;
397 /* X position at which this display line starts. Usually zero;
398 negative if first character is partially visible. */
400 static int this_line_start_x
;
402 /* The smallest character position seen by move_it_* functions as they
403 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
404 hscrolled lines, see display_line. */
406 static struct text_pos this_line_min_pos
;
408 /* Buffer that this_line_.* variables are referring to. */
410 static struct buffer
*this_line_buffer
;
412 /* True if an overlay arrow has been displayed in this window. */
414 static bool overlay_arrow_seen
;
416 /* Vector containing glyphs for an ellipsis `...'. */
418 static Lisp_Object default_invis_vector
[3];
420 /* This is the window where the echo area message was displayed. It
421 is always a mini-buffer window, but it may not be the same window
422 currently active as a mini-buffer. */
424 Lisp_Object echo_area_window
;
426 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
427 pushes the current message and the value of
428 message_enable_multibyte on the stack, the function restore_message
429 pops the stack and displays MESSAGE again. */
431 static Lisp_Object Vmessage_stack
;
433 /* True means multibyte characters were enabled when the echo area
434 message was specified. */
436 static bool message_enable_multibyte
;
438 /* At each redisplay cycle, we should refresh everything there is to refresh.
439 To do that efficiently, we use many optimizations that try to make sure we
440 don't waste too much time updating things that haven't changed.
441 The coarsest such optimization is that, in the most common cases, we only
442 look at the selected-window.
444 To know whether other windows should be considered for redisplay, we use the
445 variable windows_or_buffers_changed: as long as it is 0, it means that we
446 have not noticed anything that should require updating anything else than
447 the selected-window. If it is set to REDISPLAY_SOME, it means that since
448 last redisplay, some changes have been made which could impact other
449 windows. To know which ones need redisplay, every buffer, window, and frame
450 has a `redisplay' bit, which (if true) means that this object needs to be
451 redisplayed. If windows_or_buffers_changed is 0, we know there's no point
452 looking for those `redisplay' bits (actually, there might be some such bits
453 set, but then only on objects which aren't displayed anyway).
455 OTOH if it's non-zero we wil have to loop through all windows and then check
456 the `redisplay' bit of the corresponding window, frame, and buffer, in order
457 to decide whether that window needs attention or not. Note that we can't
458 just look at the frame's redisplay bit to decide that the whole frame can be
459 skipped, since even if the frame's redisplay bit is unset, some of its
460 windows's redisplay bits may be set.
462 Mostly for historical reasons, windows_or_buffers_changed can also take
463 other non-zero values. In that case, the precise value doesn't matter (it
464 encodes the cause of the setting but is only used for debugging purposes),
465 and what it means is that we shouldn't pay attention to any `redisplay' bits
466 and we should simply try and redisplay every window out there. */
468 int windows_or_buffers_changed
;
470 /* Nonzero if we should redraw the mode lines on the next redisplay.
471 Similarly to `windows_or_buffers_changed', If it has value REDISPLAY_SOME,
472 then only redisplay the mode lines in those buffers/windows/frames where the
473 `redisplay' bit has been set.
474 For any other value, redisplay all mode lines (the number used is then only
475 used to track down the cause for this full-redisplay).
477 Since the frame title uses the same %-constructs as the mode line
478 (except %c and %l), if this variable is non-zero, we also consider
479 redisplaying the title of each frame, see x_consider_frame_title.
481 The `redisplay' bits are the same as those used for
482 windows_or_buffers_changed, and setting windows_or_buffers_changed also
483 causes recomputation of the mode lines of all those windows. IOW this
484 variable only has an effect if windows_or_buffers_changed is zero, in which
485 case we should only need to redisplay the mode-line of those objects with
486 a `redisplay' bit set but not the window's text content (tho we may still
487 need to refresh the text content of the selected-window). */
489 int update_mode_lines
;
491 /* True after display_mode_line if %l was used and it displayed a
494 static bool line_number_displayed
;
496 /* The name of the *Messages* buffer, a string. */
498 static Lisp_Object Vmessages_buffer_name
;
500 /* Current, index 0, and last displayed echo area message. Either
501 buffers from echo_buffers, or nil to indicate no message. */
503 Lisp_Object echo_area_buffer
[2];
505 /* The buffers referenced from echo_area_buffer. */
507 static Lisp_Object echo_buffer
[2];
509 /* A vector saved used in with_area_buffer to reduce consing. */
511 static Lisp_Object Vwith_echo_area_save_vector
;
513 /* True means display_echo_area should display the last echo area
514 message again. Set by redisplay_preserve_echo_area. */
516 static bool display_last_displayed_message_p
;
518 /* True if echo area is being used by print; false if being used by
521 static bool message_buf_print
;
523 /* Set to true in clear_message to make redisplay_internal aware
524 of an emptied echo area. */
526 static bool message_cleared_p
;
528 /* A scratch glyph row with contents used for generating truncation
529 glyphs. Also used in direct_output_for_insert. */
531 #define MAX_SCRATCH_GLYPHS 100
532 static struct glyph_row scratch_glyph_row
;
533 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
535 /* Ascent and height of the last line processed by move_it_to. */
537 static int last_height
;
539 /* True if there's a help-echo in the echo area. */
541 bool help_echo_showing_p
;
543 /* The maximum distance to look ahead for text properties. Values
544 that are too small let us call compute_char_face and similar
545 functions too often which is expensive. Values that are too large
546 let us call compute_char_face and alike too often because we
547 might not be interested in text properties that far away. */
549 #define TEXT_PROP_DISTANCE_LIMIT 100
551 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
552 iterator state and later restore it. This is needed because the
553 bidi iterator on bidi.c keeps a stacked cache of its states, which
554 is really a singleton. When we use scratch iterator objects to
555 move around the buffer, we can cause the bidi cache to be pushed or
556 popped, and therefore we need to restore the cache state when we
557 return to the original iterator. */
558 #define SAVE_IT(ITCOPY, ITORIG, CACHE) \
561 bidi_unshelve_cache (CACHE, true); \
563 CACHE = bidi_shelve_cache (); \
566 #define RESTORE_IT(pITORIG, pITCOPY, CACHE) \
568 if (pITORIG != pITCOPY) \
569 *(pITORIG) = *(pITCOPY); \
570 bidi_unshelve_cache (CACHE, false); \
574 /* Functions to mark elements as needing redisplay. */
575 enum { REDISPLAY_SOME
= 2}; /* Arbitrary choice. */
578 redisplay_other_windows (void)
580 if (!windows_or_buffers_changed
)
581 windows_or_buffers_changed
= REDISPLAY_SOME
;
585 wset_redisplay (struct window
*w
)
587 /* Beware: selected_window can be nil during early stages. */
588 if (!EQ (make_lisp_ptr (w
, Lisp_Vectorlike
), selected_window
))
589 redisplay_other_windows ();
594 fset_redisplay (struct frame
*f
)
596 redisplay_other_windows ();
601 bset_redisplay (struct buffer
*b
)
603 int count
= buffer_window_count (b
);
606 /* ... it's visible in other window than selected, */
607 if (count
> 1 || b
!= XBUFFER (XWINDOW (selected_window
)->contents
))
608 redisplay_other_windows ();
609 /* Even if we don't set windows_or_buffers_changed, do set `redisplay'
610 so that if we later set windows_or_buffers_changed, this buffer will
612 b
->text
->redisplay
= true;
617 bset_update_mode_line (struct buffer
*b
)
619 if (!update_mode_lines
)
620 update_mode_lines
= REDISPLAY_SOME
;
621 b
->text
->redisplay
= true;
625 maybe_set_redisplay (Lisp_Object symbol
)
627 if (HASH_TABLE_P (Vredisplay__variables
)
628 && hash_lookup (XHASH_TABLE (Vredisplay__variables
), symbol
, NULL
) >= 0)
630 bset_update_mode_line (current_buffer
);
631 current_buffer
->prevent_redisplay_optimizations_p
= true;
637 /* True means print traces of redisplay if compiled with
638 GLYPH_DEBUG defined. */
640 bool trace_redisplay_p
;
642 #endif /* GLYPH_DEBUG */
644 #ifdef DEBUG_TRACE_MOVE
645 /* True means trace with TRACE_MOVE to stderr. */
646 static bool trace_move
;
648 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
650 #define TRACE_MOVE(x) (void) 0
653 /* Buffer being redisplayed -- for redisplay_window_error. */
655 static struct buffer
*displayed_buffer
;
657 /* Value returned from text property handlers (see below). */
662 HANDLED_RECOMPUTE_PROPS
,
663 HANDLED_OVERLAY_STRING_CONSUMED
,
667 /* A description of text properties that redisplay is interested
672 /* The symbol index of the name of the property. */
675 /* A unique index for the property. */
678 /* A handler function called to set up iterator IT from the property
679 at IT's current position. Value is used to steer handle_stop. */
680 enum prop_handled (*handler
) (struct it
*it
);
683 static enum prop_handled
handle_face_prop (struct it
*);
684 static enum prop_handled
handle_invisible_prop (struct it
*);
685 static enum prop_handled
handle_display_prop (struct it
*);
686 static enum prop_handled
handle_composition_prop (struct it
*);
687 static enum prop_handled
handle_overlay_change (struct it
*);
688 static enum prop_handled
handle_fontified_prop (struct it
*);
690 /* Properties handled by iterators. */
692 static struct props it_props
[] =
694 {SYMBOL_INDEX (Qfontified
), FONTIFIED_PROP_IDX
, handle_fontified_prop
},
695 /* Handle `face' before `display' because some sub-properties of
696 `display' need to know the face. */
697 {SYMBOL_INDEX (Qface
), FACE_PROP_IDX
, handle_face_prop
},
698 {SYMBOL_INDEX (Qdisplay
), DISPLAY_PROP_IDX
, handle_display_prop
},
699 {SYMBOL_INDEX (Qinvisible
), INVISIBLE_PROP_IDX
, handle_invisible_prop
},
700 {SYMBOL_INDEX (Qcomposition
), COMPOSITION_PROP_IDX
, handle_composition_prop
},
704 /* Value is the position described by X. If X is a marker, value is
705 the marker_position of X. Otherwise, value is X. */
707 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
709 /* Enumeration returned by some move_it_.* functions internally. */
713 /* Not used. Undefined value. */
716 /* Move ended at the requested buffer position or ZV. */
717 MOVE_POS_MATCH_OR_ZV
,
719 /* Move ended at the requested X pixel position. */
722 /* Move within a line ended at the end of a line that must be
726 /* Move within a line ended at the end of a line that would
727 be displayed truncated. */
730 /* Move within a line ended at a line end. */
734 /* This counter is used to clear the face cache every once in a while
735 in redisplay_internal. It is incremented for each redisplay.
736 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
739 #define CLEAR_FACE_CACHE_COUNT 500
740 static int clear_face_cache_count
;
742 /* Similarly for the image cache. */
744 #ifdef HAVE_WINDOW_SYSTEM
745 #define CLEAR_IMAGE_CACHE_COUNT 101
746 static int clear_image_cache_count
;
748 /* Null glyph slice */
749 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
752 /* True while redisplay_internal is in progress. */
756 /* If a string, XTread_socket generates an event to display that string.
757 (The display is done in read_char.) */
759 Lisp_Object help_echo_string
;
760 Lisp_Object help_echo_window
;
761 Lisp_Object help_echo_object
;
762 ptrdiff_t help_echo_pos
;
764 /* Temporary variable for XTread_socket. */
766 Lisp_Object previous_help_echo_string
;
768 /* Platform-independent portion of hourglass implementation. */
770 #ifdef HAVE_WINDOW_SYSTEM
772 /* True means an hourglass cursor is currently shown. */
773 static bool hourglass_shown_p
;
775 /* If non-null, an asynchronous timer that, when it expires, displays
776 an hourglass cursor on all frames. */
777 static struct atimer
*hourglass_atimer
;
779 #endif /* HAVE_WINDOW_SYSTEM */
781 /* Default number of seconds to wait before displaying an hourglass
783 #define DEFAULT_HOURGLASS_DELAY 1
785 #ifdef HAVE_WINDOW_SYSTEM
787 /* Default pixel width of `thin-space' display method. */
788 #define THIN_SPACE_WIDTH 1
790 #endif /* HAVE_WINDOW_SYSTEM */
792 /* Function prototypes. */
794 static void setup_for_ellipsis (struct it
*, int);
795 static void set_iterator_to_next (struct it
*, bool);
796 static void mark_window_display_accurate_1 (struct window
*, bool);
797 static bool row_for_charpos_p (struct glyph_row
*, ptrdiff_t);
798 static bool cursor_row_p (struct glyph_row
*);
799 static int redisplay_mode_lines (Lisp_Object
, bool);
801 static void handle_line_prefix (struct it
*);
803 static void handle_stop_backwards (struct it
*, ptrdiff_t);
804 static void unwind_with_echo_area_buffer (Lisp_Object
);
805 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
806 static bool current_message_1 (ptrdiff_t, Lisp_Object
);
807 static bool truncate_message_1 (ptrdiff_t, Lisp_Object
);
808 static void set_message (Lisp_Object
);
809 static bool set_message_1 (ptrdiff_t, Lisp_Object
);
810 static bool display_echo_area_1 (ptrdiff_t, Lisp_Object
);
811 static bool resize_mini_window_1 (ptrdiff_t, Lisp_Object
);
812 static void unwind_redisplay (void);
813 static void extend_face_to_end_of_line (struct it
*);
814 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
815 static void push_it (struct it
*, struct text_pos
*);
816 static void iterate_out_of_display_property (struct it
*);
817 static void pop_it (struct it
*);
818 static void redisplay_internal (void);
819 static void echo_area_display (bool);
820 static void redisplay_windows (Lisp_Object
);
821 static void redisplay_window (Lisp_Object
, bool);
822 static Lisp_Object
redisplay_window_error (Lisp_Object
);
823 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
824 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
825 static bool set_cursor_from_row (struct window
*, struct glyph_row
*,
826 struct glyph_matrix
*, ptrdiff_t, ptrdiff_t,
828 static bool cursor_row_fully_visible_p (struct window
*, bool, bool);
829 static bool update_menu_bar (struct frame
*, bool, bool);
830 static bool try_window_reusing_current_matrix (struct window
*);
831 static int try_window_id (struct window
*);
832 static bool display_line (struct it
*);
833 static int display_mode_lines (struct window
*);
834 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
835 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
,
837 static int store_mode_line_string (const char *, Lisp_Object
, bool, int, int,
839 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
840 static void display_menu_bar (struct window
*);
841 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
843 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
844 ptrdiff_t, ptrdiff_t, struct it
*, int, int, int, int);
845 static void compute_line_metrics (struct it
*);
846 static void run_redisplay_end_trigger_hook (struct it
*);
847 static bool get_overlay_strings (struct it
*, ptrdiff_t);
848 static bool get_overlay_strings_1 (struct it
*, ptrdiff_t, bool);
849 static void next_overlay_string (struct it
*);
850 static void reseat (struct it
*, struct text_pos
, bool);
851 static void reseat_1 (struct it
*, struct text_pos
, bool);
852 static bool next_element_from_display_vector (struct it
*);
853 static bool next_element_from_string (struct it
*);
854 static bool next_element_from_c_string (struct it
*);
855 static bool next_element_from_buffer (struct it
*);
856 static bool next_element_from_composition (struct it
*);
857 static bool next_element_from_image (struct it
*);
858 static bool next_element_from_stretch (struct it
*);
859 static bool next_element_from_xwidget (struct it
*);
860 static void load_overlay_strings (struct it
*, ptrdiff_t);
861 static bool get_next_display_element (struct it
*);
862 static enum move_it_result
863 move_it_in_display_line_to (struct it
*, ptrdiff_t, int,
864 enum move_operation_enum
);
865 static void get_visually_first_element (struct it
*);
866 static void compute_stop_pos (struct it
*);
867 static int face_before_or_after_it_pos (struct it
*, bool);
868 static ptrdiff_t next_overlay_change (ptrdiff_t);
869 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
870 Lisp_Object
, struct text_pos
*, ptrdiff_t, bool);
871 static int handle_single_display_spec (struct it
*, Lisp_Object
,
872 Lisp_Object
, Lisp_Object
,
873 struct text_pos
*, ptrdiff_t, int, bool);
874 static int underlying_face_id (struct it
*);
876 #define face_before_it_pos(IT) face_before_or_after_it_pos (IT, true)
877 #define face_after_it_pos(IT) face_before_or_after_it_pos (IT, false)
879 #ifdef HAVE_WINDOW_SYSTEM
881 static void update_tool_bar (struct frame
*, bool);
882 static void x_draw_bottom_divider (struct window
*w
);
883 static void notice_overwritten_cursor (struct window
*,
886 static int normal_char_height (struct font
*, int);
887 static void normal_char_ascent_descent (struct font
*, int, int *, int *);
889 static void append_stretch_glyph (struct it
*, Lisp_Object
,
892 static Lisp_Object
get_it_property (struct it
*, Lisp_Object
);
893 static Lisp_Object
calc_line_height_property (struct it
*, Lisp_Object
,
894 struct font
*, int, bool);
896 #endif /* HAVE_WINDOW_SYSTEM */
898 static void produce_special_glyphs (struct it
*, enum display_element_type
);
899 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
900 static bool coords_in_mouse_face_p (struct window
*, int, int);
904 /***********************************************************************
905 Window display dimensions
906 ***********************************************************************/
908 /* Return the bottom boundary y-position for text lines in window W.
909 This is the first y position at which a line cannot start.
910 It is relative to the top of the window.
912 This is the height of W minus the height of a mode line, if any. */
915 window_text_bottom_y (struct window
*w
)
917 int height
= WINDOW_PIXEL_HEIGHT (w
);
919 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
921 if (WINDOW_WANTS_MODELINE_P (w
))
922 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
924 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
929 /* Return the pixel width of display area AREA of window W.
930 ANY_AREA means return the total width of W, not including
931 fringes to the left and right of the window. */
934 window_box_width (struct window
*w
, enum glyph_row_area area
)
936 int width
= w
->pixel_width
;
938 if (!w
->pseudo_window_p
)
940 width
-= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
941 width
-= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
943 if (area
== TEXT_AREA
)
944 width
-= (WINDOW_MARGINS_WIDTH (w
)
945 + WINDOW_FRINGES_WIDTH (w
));
946 else if (area
== LEFT_MARGIN_AREA
)
947 width
= WINDOW_LEFT_MARGIN_WIDTH (w
);
948 else if (area
== RIGHT_MARGIN_AREA
)
949 width
= WINDOW_RIGHT_MARGIN_WIDTH (w
);
952 /* With wide margins, fringes, etc. we might end up with a negative
953 width, correct that here. */
954 return max (0, width
);
958 /* Return the pixel height of the display area of window W, not
959 including mode lines of W, if any. */
962 window_box_height (struct window
*w
)
964 struct frame
*f
= XFRAME (w
->frame
);
965 int height
= WINDOW_PIXEL_HEIGHT (w
);
967 eassert (height
>= 0);
969 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
970 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
972 /* Note: the code below that determines the mode-line/header-line
973 height is essentially the same as that contained in the macro
974 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
975 the appropriate glyph row has its `mode_line_p' flag set,
976 and if it doesn't, uses estimate_mode_line_height instead. */
978 if (WINDOW_WANTS_MODELINE_P (w
))
980 struct glyph_row
*ml_row
981 = (w
->current_matrix
&& w
->current_matrix
->rows
982 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
984 if (ml_row
&& ml_row
->mode_line_p
)
985 height
-= ml_row
->height
;
987 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
990 if (WINDOW_WANTS_HEADER_LINE_P (w
))
992 struct glyph_row
*hl_row
993 = (w
->current_matrix
&& w
->current_matrix
->rows
994 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
996 if (hl_row
&& hl_row
->mode_line_p
)
997 height
-= hl_row
->height
;
999 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1002 /* With a very small font and a mode-line that's taller than
1003 default, we might end up with a negative height. */
1004 return max (0, height
);
1007 /* Return the window-relative coordinate of the left edge of display
1008 area AREA of window W. ANY_AREA means return the left edge of the
1009 whole window, to the right of the left fringe of W. */
1012 window_box_left_offset (struct window
*w
, enum glyph_row_area area
)
1016 if (w
->pseudo_window_p
)
1019 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1021 if (area
== TEXT_AREA
)
1022 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1023 + window_box_width (w
, LEFT_MARGIN_AREA
));
1024 else if (area
== RIGHT_MARGIN_AREA
)
1025 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1026 + window_box_width (w
, LEFT_MARGIN_AREA
)
1027 + window_box_width (w
, TEXT_AREA
)
1028 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1030 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1031 else if (area
== LEFT_MARGIN_AREA
1032 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1033 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1035 /* Don't return more than the window's pixel width. */
1036 return min (x
, w
->pixel_width
);
1040 /* Return the window-relative coordinate of the right edge of display
1041 area AREA of window W. ANY_AREA means return the right edge of the
1042 whole window, to the left of the right fringe of W. */
1045 window_box_right_offset (struct window
*w
, enum glyph_row_area area
)
1047 /* Don't return more than the window's pixel width. */
1048 return min (window_box_left_offset (w
, area
) + window_box_width (w
, area
),
1052 /* Return the frame-relative coordinate of the left edge of display
1053 area AREA of window W. ANY_AREA means return the left edge of the
1054 whole window, to the right of the left fringe of W. */
1057 window_box_left (struct window
*w
, enum glyph_row_area area
)
1059 struct frame
*f
= XFRAME (w
->frame
);
1062 if (w
->pseudo_window_p
)
1063 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1065 x
= (WINDOW_LEFT_EDGE_X (w
)
1066 + window_box_left_offset (w
, area
));
1072 /* Return the frame-relative coordinate of the right edge of display
1073 area AREA of window W. ANY_AREA means return the right edge of the
1074 whole window, to the left of the right fringe of W. */
1077 window_box_right (struct window
*w
, enum glyph_row_area area
)
1079 return window_box_left (w
, area
) + window_box_width (w
, area
);
1082 /* Get the bounding box of the display area AREA of window W, without
1083 mode lines, in frame-relative coordinates. ANY_AREA means the
1084 whole window, not including the left and right fringes of
1085 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1086 coordinates of the upper-left corner of the box. Return in
1087 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1090 window_box (struct window
*w
, enum glyph_row_area area
, int *box_x
,
1091 int *box_y
, int *box_width
, int *box_height
)
1094 *box_width
= window_box_width (w
, area
);
1096 *box_height
= window_box_height (w
);
1098 *box_x
= window_box_left (w
, area
);
1101 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1102 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1103 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1107 #ifdef HAVE_WINDOW_SYSTEM
1109 /* Get the bounding box of the display area AREA of window W, without
1110 mode lines and both fringes of the window. Return in *TOP_LEFT_X
1111 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1112 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1113 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1117 window_box_edges (struct window
*w
, int *top_left_x
, int *top_left_y
,
1118 int *bottom_right_x
, int *bottom_right_y
)
1120 window_box (w
, ANY_AREA
, top_left_x
, top_left_y
,
1121 bottom_right_x
, bottom_right_y
);
1122 *bottom_right_x
+= *top_left_x
;
1123 *bottom_right_y
+= *top_left_y
;
1126 #endif /* HAVE_WINDOW_SYSTEM */
1128 /***********************************************************************
1130 ***********************************************************************/
1132 /* Return the bottom y-position of the line the iterator IT is in.
1133 This can modify IT's settings. */
1136 line_bottom_y (struct it
*it
)
1138 int line_height
= it
->max_ascent
+ it
->max_descent
;
1139 int line_top_y
= it
->current_y
;
1141 if (line_height
== 0)
1144 line_height
= last_height
;
1145 else if (IT_CHARPOS (*it
) < ZV
)
1147 move_it_by_lines (it
, 1);
1148 line_height
= (it
->max_ascent
|| it
->max_descent
1149 ? it
->max_ascent
+ it
->max_descent
1154 struct glyph_row
*row
= it
->glyph_row
;
1156 /* Use the default character height. */
1157 it
->glyph_row
= NULL
;
1158 it
->what
= IT_CHARACTER
;
1161 PRODUCE_GLYPHS (it
);
1162 line_height
= it
->ascent
+ it
->descent
;
1163 it
->glyph_row
= row
;
1167 return line_top_y
+ line_height
;
1170 DEFUN ("line-pixel-height", Fline_pixel_height
,
1171 Sline_pixel_height
, 0, 0, 0,
1172 doc
: /* Return height in pixels of text line in the selected window.
1174 Value is the height in pixels of the line at point. */)
1179 struct window
*w
= XWINDOW (selected_window
);
1180 struct buffer
*old_buffer
= NULL
;
1183 if (XBUFFER (w
->contents
) != current_buffer
)
1185 old_buffer
= current_buffer
;
1186 set_buffer_internal_1 (XBUFFER (w
->contents
));
1188 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
1189 start_display (&it
, w
, pt
);
1190 it
.vpos
= it
.current_y
= 0;
1192 result
= make_number (line_bottom_y (&it
));
1194 set_buffer_internal_1 (old_buffer
);
1199 /* Return the default pixel height of text lines in window W. The
1200 value is the canonical height of the W frame's default font, plus
1201 any extra space required by the line-spacing variable or frame
1204 Implementation note: this ignores any line-spacing text properties
1205 put on the newline characters. This is because those properties
1206 only affect the _screen_ line ending in the newline (i.e., in a
1207 continued line, only the last screen line will be affected), which
1208 means only a small number of lines in a buffer can ever use this
1209 feature. Since this function is used to compute the default pixel
1210 equivalent of text lines in a window, we can safely ignore those
1211 few lines. For the same reasons, we ignore the line-height
1214 default_line_pixel_height (struct window
*w
)
1216 struct frame
*f
= WINDOW_XFRAME (w
);
1217 int height
= FRAME_LINE_HEIGHT (f
);
1219 if (!FRAME_INITIAL_P (f
) && BUFFERP (w
->contents
))
1221 struct buffer
*b
= XBUFFER (w
->contents
);
1222 Lisp_Object val
= BVAR (b
, extra_line_spacing
);
1225 val
= BVAR (&buffer_defaults
, extra_line_spacing
);
1228 if (RANGED_INTEGERP (0, val
, INT_MAX
))
1229 height
+= XFASTINT (val
);
1230 else if (FLOATP (val
))
1232 int addon
= XFLOAT_DATA (val
) * height
+ 0.5;
1239 height
+= f
->extra_line_spacing
;
1245 /* Subroutine of pos_visible_p below. Extracts a display string, if
1246 any, from the display spec given as its argument. */
1248 string_from_display_spec (Lisp_Object spec
)
1252 while (CONSP (spec
))
1254 if (STRINGP (XCAR (spec
)))
1259 else if (VECTORP (spec
))
1263 for (i
= 0; i
< ASIZE (spec
); i
++)
1265 if (STRINGP (AREF (spec
, i
)))
1266 return AREF (spec
, i
);
1275 /* Limit insanely large values of W->hscroll on frame F to the largest
1276 value that will still prevent first_visible_x and last_visible_x of
1277 'struct it' from overflowing an int. */
1279 window_hscroll_limited (struct window
*w
, struct frame
*f
)
1281 ptrdiff_t window_hscroll
= w
->hscroll
;
1282 int window_text_width
= window_box_width (w
, TEXT_AREA
);
1283 int colwidth
= FRAME_COLUMN_WIDTH (f
);
1285 if (window_hscroll
> (INT_MAX
- window_text_width
) / colwidth
- 1)
1286 window_hscroll
= (INT_MAX
- window_text_width
) / colwidth
- 1;
1288 return window_hscroll
;
1291 /* Return true if position CHARPOS is visible in window W.
1292 CHARPOS < 0 means return info about WINDOW_END position.
1293 If visible, set *X and *Y to pixel coordinates of top left corner.
1294 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1295 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1298 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1299 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1302 void *itdata
= bidi_shelve_cache ();
1303 struct text_pos top
;
1304 bool visible_p
= false;
1305 struct buffer
*old_buffer
= NULL
;
1308 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1311 if (XBUFFER (w
->contents
) != current_buffer
)
1313 old_buffer
= current_buffer
;
1314 set_buffer_internal_1 (XBUFFER (w
->contents
));
1317 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1318 /* Scrolling a minibuffer window via scroll bar when the echo area
1319 shows long text sometimes resets the minibuffer contents behind
1321 if (CHARPOS (top
) > ZV
)
1322 SET_TEXT_POS (top
, BEGV
, BEGV_BYTE
);
1324 /* Compute exact mode line heights. */
1325 if (WINDOW_WANTS_MODELINE_P (w
))
1327 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1328 BVAR (current_buffer
, mode_line_format
));
1330 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1331 w
->header_line_height
1332 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1333 BVAR (current_buffer
, header_line_format
));
1335 start_display (&it
, w
, top
);
1336 move_it_to (&it
, charpos
, -1, it
.last_visible_y
- 1, -1,
1337 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1340 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
!= -1)
1341 && IT_CHARPOS (it
) >= charpos
)
1342 /* When scanning backwards under bidi iteration, move_it_to
1343 stops at or _before_ CHARPOS, because it stops at or to
1344 the _right_ of the character at CHARPOS. */
1345 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1346 && IT_CHARPOS (it
) <= charpos
)))
1348 /* We have reached CHARPOS, or passed it. How the call to
1349 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1350 or covered by a display property, move_it_to stops at the end
1351 of the invisible text, to the right of CHARPOS. (ii) If
1352 CHARPOS is in a display vector, move_it_to stops on its last
1354 int top_x
= it
.current_x
;
1355 int top_y
= it
.current_y
;
1356 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1359 void *save_it_data
= NULL
;
1361 /* Calling line_bottom_y may change it.method, it.position, etc. */
1362 SAVE_IT (save_it
, it
, save_it_data
);
1364 bottom_y
= line_bottom_y (&it
);
1365 if (top_y
< window_top_y
)
1366 visible_p
= bottom_y
> window_top_y
;
1367 else if (top_y
< it
.last_visible_y
)
1369 if (bottom_y
>= it
.last_visible_y
1370 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1371 && IT_CHARPOS (it
) < charpos
)
1373 /* When the last line of the window is scanned backwards
1374 under bidi iteration, we could be duped into thinking
1375 that we have passed CHARPOS, when in fact move_it_to
1376 simply stopped short of CHARPOS because it reached
1377 last_visible_y. To see if that's what happened, we call
1378 move_it_to again with a slightly larger vertical limit,
1379 and see if it actually moved vertically; if it did, we
1380 didn't really reach CHARPOS, which is beyond window end. */
1381 /* Why 10? because we don't know how many canonical lines
1382 will the height of the next line(s) be. So we guess. */
1383 int ten_more_lines
= 10 * default_line_pixel_height (w
);
1385 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1386 MOVE_TO_POS
| MOVE_TO_Y
);
1387 if (it
.current_y
> top_y
)
1391 RESTORE_IT (&it
, &save_it
, save_it_data
);
1394 if (it
.method
== GET_FROM_DISPLAY_VECTOR
)
1396 /* We stopped on the last glyph of a display vector.
1397 Try and recompute. Hack alert! */
1398 if (charpos
< 2 || top
.charpos
>= charpos
)
1399 top_x
= it
.glyph_row
->x
;
1402 struct it it2
, it2_prev
;
1403 /* The idea is to get to the previous buffer
1404 position, consume the character there, and use
1405 the pixel coordinates we get after that. But if
1406 the previous buffer position is also displayed
1407 from a display vector, we need to consume all of
1408 the glyphs from that display vector. */
1409 start_display (&it2
, w
, top
);
1410 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1411 /* If we didn't get to CHARPOS - 1, there's some
1412 replacing display property at that position, and
1413 we stopped after it. That is exactly the place
1414 whose coordinates we want. */
1415 if (IT_CHARPOS (it2
) != charpos
- 1)
1419 /* Iterate until we get out of the display
1420 vector that displays the character at
1423 get_next_display_element (&it2
);
1424 PRODUCE_GLYPHS (&it2
);
1426 set_iterator_to_next (&it2
, true);
1427 } while (it2
.method
== GET_FROM_DISPLAY_VECTOR
1428 && IT_CHARPOS (it2
) < charpos
);
1430 if (ITERATOR_AT_END_OF_LINE_P (&it2_prev
)
1431 || it2_prev
.current_x
> it2_prev
.last_visible_x
)
1432 top_x
= it
.glyph_row
->x
;
1435 top_x
= it2_prev
.current_x
;
1436 top_y
= it2_prev
.current_y
;
1440 else if (IT_CHARPOS (it
) != charpos
)
1442 Lisp_Object cpos
= make_number (charpos
);
1443 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1444 Lisp_Object string
= string_from_display_spec (spec
);
1445 struct text_pos tpos
;
1446 bool newline_in_string
1448 && memchr (SDATA (string
), '\n', SBYTES (string
)));
1450 SET_TEXT_POS (tpos
, charpos
, CHAR_TO_BYTE (charpos
));
1451 bool replacing_spec_p
1453 && handle_display_spec (NULL
, spec
, Qnil
, Qnil
, &tpos
,
1454 charpos
, FRAME_WINDOW_P (it
.f
)));
1455 /* The tricky code below is needed because there's a
1456 discrepancy between move_it_to and how we set cursor
1457 when PT is at the beginning of a portion of text
1458 covered by a display property or an overlay with a
1459 display property, or the display line ends in a
1460 newline from a display string. move_it_to will stop
1461 _after_ such display strings, whereas
1462 set_cursor_from_row conspires with cursor_row_p to
1463 place the cursor on the first glyph produced from the
1466 /* We have overshoot PT because it is covered by a
1467 display property that replaces the text it covers.
1468 If the string includes embedded newlines, we are also
1469 in the wrong display line. Backtrack to the correct
1470 line, where the display property begins. */
1471 if (replacing_spec_p
)
1473 Lisp_Object startpos
, endpos
;
1474 EMACS_INT start
, end
;
1477 /* Find the first and the last buffer positions
1478 covered by the display string. */
1480 Fnext_single_char_property_change (cpos
, Qdisplay
,
1483 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1485 start
= XFASTINT (startpos
);
1486 end
= XFASTINT (endpos
);
1487 /* Move to the last buffer position before the
1488 display property. */
1489 start_display (&it3
, w
, top
);
1490 if (start
> CHARPOS (top
))
1491 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1492 /* Move forward one more line if the position before
1493 the display string is a newline or if it is the
1494 rightmost character on a line that is
1495 continued or word-wrapped. */
1496 if (it3
.method
== GET_FROM_BUFFER
1498 || FETCH_BYTE (IT_BYTEPOS (it3
)) == '\n'))
1499 move_it_by_lines (&it3
, 1);
1500 else if (move_it_in_display_line_to (&it3
, -1,
1504 == MOVE_LINE_CONTINUED
)
1506 move_it_by_lines (&it3
, 1);
1507 /* When we are under word-wrap, the #$@%!
1508 move_it_by_lines moves 2 lines, so we need to
1510 if (it3
.line_wrap
== WORD_WRAP
)
1511 move_it_by_lines (&it3
, -1);
1514 /* Record the vertical coordinate of the display
1515 line where we wound up. */
1516 top_y
= it3
.current_y
;
1519 /* When characters are reordered for display,
1520 the character displayed to the left of the
1521 display string could be _after_ the display
1522 property in the logical order. Use the
1523 smallest vertical position of these two. */
1524 start_display (&it3
, w
, top
);
1525 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1526 if (it3
.current_y
< top_y
)
1527 top_y
= it3
.current_y
;
1529 /* Move from the top of the window to the beginning
1530 of the display line where the display string
1532 start_display (&it3
, w
, top
);
1533 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1534 /* If it3_moved stays false after the 'while' loop
1535 below, that means we already were at a newline
1536 before the loop (e.g., the display string begins
1537 with a newline), so we don't need to (and cannot)
1538 inspect the glyphs of it3.glyph_row, because
1539 PRODUCE_GLYPHS will not produce anything for a
1540 newline, and thus it3.glyph_row stays at its
1541 stale content it got at top of the window. */
1542 bool it3_moved
= false;
1543 /* Finally, advance the iterator until we hit the
1544 first display element whose character position is
1545 CHARPOS, or until the first newline from the
1546 display string, which signals the end of the
1548 while (get_next_display_element (&it3
))
1550 PRODUCE_GLYPHS (&it3
);
1551 if (IT_CHARPOS (it3
) == charpos
1552 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1555 set_iterator_to_next (&it3
, false);
1557 top_x
= it3
.current_x
- it3
.pixel_width
;
1558 /* Normally, we would exit the above loop because we
1559 found the display element whose character
1560 position is CHARPOS. For the contingency that we
1561 didn't, and stopped at the first newline from the
1562 display string, move back over the glyphs
1563 produced from the string, until we find the
1564 rightmost glyph not from the string. */
1566 && newline_in_string
1567 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1569 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1570 + it3
.glyph_row
->used
[TEXT_AREA
];
1572 while (EQ ((g
- 1)->object
, string
))
1575 top_x
-= g
->pixel_width
;
1577 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1578 + it3
.glyph_row
->used
[TEXT_AREA
]);
1584 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1585 *rtop
= max (0, window_top_y
- top_y
);
1586 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1587 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1588 - max (top_y
, window_top_y
)));
1590 if (it
.bidi_it
.paragraph_dir
== R2L
)
1596 /* Either we were asked to provide info about WINDOW_END, or
1597 CHARPOS is in the partially visible glyph row at end of
1600 void *it2data
= NULL
;
1602 SAVE_IT (it2
, it
, it2data
);
1603 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1604 move_it_by_lines (&it
, 1);
1605 if (charpos
< IT_CHARPOS (it
)
1606 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1609 RESTORE_IT (&it2
, &it2
, it2data
);
1610 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1612 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1613 *rtop
= max (0, -it2
.current_y
);
1614 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1615 - it
.last_visible_y
));
1616 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1618 - max (it2
.current_y
,
1619 WINDOW_HEADER_LINE_HEIGHT (w
))));
1621 if (it2
.bidi_it
.paragraph_dir
== R2L
)
1625 bidi_unshelve_cache (it2data
, true);
1627 bidi_unshelve_cache (itdata
, false);
1630 set_buffer_internal_1 (old_buffer
);
1636 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1637 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1638 /* For lines in an R2L paragraph, we need to mirror the X pixel
1639 coordinate wrt the text area. For the reasons, see the
1640 commentary in buffer_posn_from_coords and the explanation of
1641 the geometry used by the move_it_* functions at the end of
1642 the large commentary near the beginning of this file. */
1644 *x
= window_box_width (w
, TEXT_AREA
) - *x
- 1;
1648 /* Debugging code. */
1650 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1651 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1653 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1660 /* Return the next character from STR. Return in *LEN the length of
1661 the character. This is like STRING_CHAR_AND_LENGTH but never
1662 returns an invalid character. If we find one, we return a `?', but
1663 with the length of the invalid character. */
1666 string_char_and_length (const unsigned char *str
, int *len
)
1670 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1671 if (!CHAR_VALID_P (c
))
1672 /* We may not change the length here because other places in Emacs
1673 don't use this function, i.e. they silently accept invalid
1682 /* Given a position POS containing a valid character and byte position
1683 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1685 static struct text_pos
1686 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1688 eassert (STRINGP (string
) && nchars
>= 0);
1690 if (STRING_MULTIBYTE (string
))
1692 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1697 string_char_and_length (p
, &len
);
1700 BYTEPOS (pos
) += len
;
1704 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1710 /* Value is the text position, i.e. character and byte position,
1711 for character position CHARPOS in STRING. */
1713 static struct text_pos
1714 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1716 struct text_pos pos
;
1717 eassert (STRINGP (string
));
1718 eassert (charpos
>= 0);
1719 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1724 /* Value is a text position, i.e. character and byte position, for
1725 character position CHARPOS in C string S. MULTIBYTE_P
1726 means recognize multibyte characters. */
1728 static struct text_pos
1729 c_string_pos (ptrdiff_t charpos
, const char *s
, bool multibyte_p
)
1731 struct text_pos pos
;
1733 eassert (s
!= NULL
);
1734 eassert (charpos
>= 0);
1740 SET_TEXT_POS (pos
, 0, 0);
1743 string_char_and_length ((const unsigned char *) s
, &len
);
1746 BYTEPOS (pos
) += len
;
1750 SET_TEXT_POS (pos
, charpos
, charpos
);
1756 /* Value is the number of characters in C string S. MULTIBYTE_P
1757 means recognize multibyte characters. */
1760 number_of_chars (const char *s
, bool multibyte_p
)
1766 ptrdiff_t rest
= strlen (s
);
1768 const unsigned char *p
= (const unsigned char *) s
;
1770 for (nchars
= 0; rest
> 0; ++nchars
)
1772 string_char_and_length (p
, &len
);
1773 rest
-= len
, p
+= len
;
1777 nchars
= strlen (s
);
1783 /* Compute byte position NEWPOS->bytepos corresponding to
1784 NEWPOS->charpos. POS is a known position in string STRING.
1785 NEWPOS->charpos must be >= POS.charpos. */
1788 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1790 eassert (STRINGP (string
));
1791 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1793 if (STRING_MULTIBYTE (string
))
1794 *newpos
= string_pos_nchars_ahead (pos
, string
,
1795 CHARPOS (*newpos
) - CHARPOS (pos
));
1797 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1801 Return an estimation of the pixel height of mode or header lines on
1802 frame F. FACE_ID specifies what line's height to estimate. */
1805 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1807 #ifdef HAVE_WINDOW_SYSTEM
1808 if (FRAME_WINDOW_P (f
))
1810 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1812 /* This function is called so early when Emacs starts that the face
1813 cache and mode line face are not yet initialized. */
1814 if (FRAME_FACE_CACHE (f
))
1816 struct face
*face
= FACE_OPT_FROM_ID (f
, face_id
);
1820 height
= normal_char_height (face
->font
, -1);
1821 if (face
->box_line_width
> 0)
1822 height
+= 2 * face
->box_line_width
;
1833 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1834 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1835 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP, do
1836 not force the value into range. */
1839 pixel_to_glyph_coords (struct frame
*f
, int pix_x
, int pix_y
, int *x
, int *y
,
1840 NativeRectangle
*bounds
, bool noclip
)
1843 #ifdef HAVE_WINDOW_SYSTEM
1844 if (FRAME_WINDOW_P (f
))
1846 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1847 even for negative values. */
1849 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1851 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1853 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1854 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1857 STORE_NATIVE_RECT (*bounds
,
1858 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1859 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1860 FRAME_COLUMN_WIDTH (f
) - 1,
1861 FRAME_LINE_HEIGHT (f
) - 1);
1863 /* PXW: Should we clip pixels before converting to columns/lines? */
1868 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1869 pix_x
= FRAME_TOTAL_COLS (f
);
1873 else if (pix_y
> FRAME_TOTAL_LINES (f
))
1874 pix_y
= FRAME_TOTAL_LINES (f
);
1884 /* Find the glyph under window-relative coordinates X/Y in window W.
1885 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1886 strings. Return in *HPOS and *VPOS the row and column number of
1887 the glyph found. Return in *AREA the glyph area containing X.
1888 Value is a pointer to the glyph found or null if X/Y is not on
1889 text, or we can't tell because W's current matrix is not up to
1892 static struct glyph
*
1893 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1894 int *dx
, int *dy
, int *area
)
1896 struct glyph
*glyph
, *end
;
1897 struct glyph_row
*row
= NULL
;
1900 /* Find row containing Y. Give up if some row is not enabled. */
1901 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1903 row
= MATRIX_ROW (w
->current_matrix
, i
);
1904 if (!row
->enabled_p
)
1906 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1913 /* Give up if Y is not in the window. */
1914 if (i
== w
->current_matrix
->nrows
)
1917 /* Get the glyph area containing X. */
1918 if (w
->pseudo_window_p
)
1925 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1927 *area
= LEFT_MARGIN_AREA
;
1928 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1930 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1933 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1937 *area
= RIGHT_MARGIN_AREA
;
1938 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1942 /* Find glyph containing X. */
1943 glyph
= row
->glyphs
[*area
];
1944 end
= glyph
+ row
->used
[*area
];
1946 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1948 x
-= glyph
->pixel_width
;
1958 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1961 *hpos
= glyph
- row
->glyphs
[*area
];
1965 /* Convert frame-relative x/y to coordinates relative to window W.
1966 Takes pseudo-windows into account. */
1969 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1971 if (w
->pseudo_window_p
)
1973 /* A pseudo-window is always full-width, and starts at the
1974 left edge of the frame, plus a frame border. */
1975 struct frame
*f
= XFRAME (w
->frame
);
1976 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1977 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1981 *x
-= WINDOW_LEFT_EDGE_X (w
);
1982 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1986 #ifdef HAVE_WINDOW_SYSTEM
1989 Return in RECTS[] at most N clipping rectangles for glyph string S.
1990 Return the number of stored rectangles. */
1993 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
2000 if (s
->row
->full_width_p
)
2002 /* Draw full-width. X coordinates are relative to S->w->left_col. */
2003 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
2004 if (s
->row
->mode_line_p
)
2005 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
) - WINDOW_RIGHT_DIVIDER_WIDTH (s
->w
);
2007 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
);
2009 /* Unless displaying a mode or menu bar line, which are always
2010 fully visible, clip to the visible part of the row. */
2011 if (s
->w
->pseudo_window_p
)
2012 r
.height
= s
->row
->visible_height
;
2014 r
.height
= s
->height
;
2018 /* This is a text line that may be partially visible. */
2019 r
.x
= window_box_left (s
->w
, s
->area
);
2020 r
.width
= window_box_width (s
->w
, s
->area
);
2021 r
.height
= s
->row
->visible_height
;
2025 if (r
.x
< s
->clip_head
->x
)
2027 if (r
.width
>= s
->clip_head
->x
- r
.x
)
2028 r
.width
-= s
->clip_head
->x
- r
.x
;
2031 r
.x
= s
->clip_head
->x
;
2034 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
2036 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
2037 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
2042 /* If S draws overlapping rows, it's sufficient to use the top and
2043 bottom of the window for clipping because this glyph string
2044 intentionally draws over other lines. */
2045 if (s
->for_overlaps
)
2047 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2048 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
2050 /* Alas, the above simple strategy does not work for the
2051 environments with anti-aliased text: if the same text is
2052 drawn onto the same place multiple times, it gets thicker.
2053 If the overlap we are processing is for the erased cursor, we
2054 take the intersection with the rectangle of the cursor. */
2055 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
2057 XRectangle rc
, r_save
= r
;
2059 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
2060 rc
.y
= s
->w
->phys_cursor
.y
;
2061 rc
.width
= s
->w
->phys_cursor_width
;
2062 rc
.height
= s
->w
->phys_cursor_height
;
2064 x_intersect_rectangles (&r_save
, &rc
, &r
);
2069 /* Don't use S->y for clipping because it doesn't take partially
2070 visible lines into account. For example, it can be negative for
2071 partially visible lines at the top of a window. */
2072 if (!s
->row
->full_width_p
2073 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2074 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2076 r
.y
= max (0, s
->row
->y
);
2079 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2081 /* If drawing the cursor, don't let glyph draw outside its
2082 advertised boundaries. Cleartype does this under some circumstances. */
2083 if (s
->hl
== DRAW_CURSOR
)
2085 struct glyph
*glyph
= s
->first_glyph
;
2090 if (r
.width
>= s
->x
- r
.x
)
2091 r
.width
-= s
->x
- r
.x
;
2092 else /* R2L hscrolled row with cursor outside text area */
2096 r
.width
= min (r
.width
, glyph
->pixel_width
);
2098 /* If r.y is below window bottom, ensure that we still see a cursor. */
2099 height
= min (glyph
->ascent
+ glyph
->descent
,
2100 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2101 max_y
= window_text_bottom_y (s
->w
) - height
;
2102 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2103 if (s
->ybase
- glyph
->ascent
> max_y
)
2110 /* Don't draw cursor glyph taller than our actual glyph. */
2111 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2112 if (height
< r
.height
)
2114 max_y
= r
.y
+ r
.height
;
2115 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2116 r
.height
= min (max_y
- r
.y
, height
);
2123 XRectangle r_save
= r
;
2125 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2129 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2130 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2132 #ifdef CONVERT_FROM_XRECT
2133 CONVERT_FROM_XRECT (r
, *rects
);
2141 /* If we are processing overlapping and allowed to return
2142 multiple clipping rectangles, we exclude the row of the glyph
2143 string from the clipping rectangle. This is to avoid drawing
2144 the same text on the environment with anti-aliasing. */
2145 #ifdef CONVERT_FROM_XRECT
2148 XRectangle
*rs
= rects
;
2150 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2152 if (s
->for_overlaps
& OVERLAPS_PRED
)
2155 if (r
.y
+ r
.height
> row_y
)
2158 rs
[i
].height
= row_y
- r
.y
;
2164 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2167 if (r
.y
< row_y
+ s
->row
->visible_height
)
2169 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2171 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2172 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2181 #ifdef CONVERT_FROM_XRECT
2182 for (i
= 0; i
< n
; i
++)
2183 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2190 Return in *NR the clipping rectangle for glyph string S. */
2193 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2195 get_glyph_string_clip_rects (s
, nr
, 1);
2200 Return the position and height of the phys cursor in window W.
2201 Set w->phys_cursor_width to width of phys cursor.
2205 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2206 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2208 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2209 int x
, y
, wd
, h
, h0
, y0
, ascent
;
2211 /* Compute the width of the rectangle to draw. If on a stretch
2212 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2213 rectangle as wide as the glyph, but use a canonical character
2215 wd
= glyph
->pixel_width
;
2217 x
= w
->phys_cursor
.x
;
2224 if (glyph
->type
== STRETCH_GLYPH
2225 && !x_stretch_cursor_p
)
2226 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2227 w
->phys_cursor_width
= wd
;
2229 /* Don't let the hollow cursor glyph descend below the glyph row's
2230 ascent value, lest the hollow cursor looks funny. */
2231 y
= w
->phys_cursor
.y
;
2232 ascent
= row
->ascent
;
2233 if (row
->ascent
< glyph
->ascent
)
2235 y
=- glyph
->ascent
- row
->ascent
;
2236 ascent
= glyph
->ascent
;
2239 /* If y is below window bottom, ensure that we still see a cursor. */
2240 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2242 h
= max (h0
, ascent
+ glyph
->descent
);
2243 h0
= min (h0
, ascent
+ glyph
->descent
);
2245 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2248 h
= max (h
- (y0
- y
) + 1, h0
);
2253 y0
= window_text_bottom_y (w
) - h0
;
2261 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2262 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2267 * Remember which glyph the mouse is over.
2271 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2275 struct glyph_row
*r
, *gr
, *end_row
;
2276 enum window_part part
;
2277 enum glyph_row_area area
;
2278 int x
, y
, width
, height
;
2280 /* Try to determine frame pixel position and size of the glyph under
2281 frame pixel coordinates X/Y on frame F. */
2283 if (window_resize_pixelwise
)
2288 else if (!f
->glyphs_initialized_p
2289 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, false),
2292 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2293 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2297 w
= XWINDOW (window
);
2298 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2299 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2301 x
= window_relative_x_coord (w
, part
, gx
);
2302 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2304 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2305 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2307 if (w
->pseudo_window_p
)
2310 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2316 case ON_LEFT_MARGIN
:
2317 area
= LEFT_MARGIN_AREA
;
2320 case ON_RIGHT_MARGIN
:
2321 area
= RIGHT_MARGIN_AREA
;
2324 case ON_HEADER_LINE
:
2326 gr
= (part
== ON_HEADER_LINE
2327 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2328 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2331 goto text_glyph_row_found
;
2338 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2339 if (r
->y
+ r
->height
> y
)
2345 text_glyph_row_found
:
2348 struct glyph
*g
= gr
->glyphs
[area
];
2349 struct glyph
*end
= g
+ gr
->used
[area
];
2351 height
= gr
->height
;
2352 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2353 if (gx
+ g
->pixel_width
> x
)
2358 if (g
->type
== IMAGE_GLYPH
)
2360 /* Don't remember when mouse is over image, as
2361 image may have hot-spots. */
2362 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2365 width
= g
->pixel_width
;
2369 /* Use nominal char spacing at end of line. */
2371 gx
+= (x
/ width
) * width
;
2374 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2376 gx
+= window_box_left_offset (w
, area
);
2377 /* Don't expand over the modeline to make sure the vertical
2378 drag cursor is shown early enough. */
2379 height
= min (height
,
2380 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2385 /* Use nominal line height at end of window. */
2386 gx
= (x
/ width
) * width
;
2388 gy
+= (y
/ height
) * height
;
2389 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2390 /* See comment above. */
2391 height
= min (height
,
2392 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2396 case ON_LEFT_FRINGE
:
2397 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2398 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2399 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2400 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2403 case ON_RIGHT_FRINGE
:
2404 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2405 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2406 : window_box_right_offset (w
, TEXT_AREA
));
2407 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
) == 0
2408 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w
)
2409 && !WINDOW_RIGHTMOST_P (w
))
2410 if (gx
< WINDOW_PIXEL_WIDTH (w
) - width
)
2411 /* Make sure the vertical border can get her own glyph to the
2412 right of the one we build here. */
2413 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
) - width
;
2415 width
= WINDOW_PIXEL_WIDTH (w
) - gx
;
2417 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2421 case ON_VERTICAL_BORDER
:
2422 gx
= WINDOW_PIXEL_WIDTH (w
) - width
;
2425 case ON_VERTICAL_SCROLL_BAR
:
2426 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2428 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2429 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2430 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2432 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2436 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2437 if (r
->y
+ r
->height
> y
)
2444 height
= gr
->height
;
2447 /* Use nominal line height at end of window. */
2449 gy
+= (y
/ height
) * height
;
2453 case ON_RIGHT_DIVIDER
:
2454 gx
= WINDOW_PIXEL_WIDTH (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2455 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2457 /* The bottom divider prevails. */
2458 height
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2461 case ON_BOTTOM_DIVIDER
:
2463 width
= WINDOW_PIXEL_WIDTH (w
);
2464 gy
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2465 height
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2471 /* If there is no glyph under the mouse, then we divide the screen
2472 into a grid of the smallest glyph in the frame, and use that
2475 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2476 round down even for negative values. */
2482 gx
= (gx
/ width
) * width
;
2483 gy
= (gy
/ height
) * height
;
2489 gx
+= WINDOW_LEFT_EDGE_X (w
);
2490 gy
+= WINDOW_TOP_EDGE_Y (w
);
2493 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2495 /* Visible feedback for debugging. */
2496 #if false && defined HAVE_X_WINDOWS
2497 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2498 f
->output_data
.x
->normal_gc
,
2499 gx
, gy
, width
, height
);
2504 #endif /* HAVE_WINDOW_SYSTEM */
2507 adjust_window_ends (struct window
*w
, struct glyph_row
*row
, bool current
)
2510 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
2511 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
2513 = MATRIX_ROW_VPOS (row
, current
? w
->current_matrix
: w
->desired_matrix
);
2516 /***********************************************************************
2517 Lisp form evaluation
2518 ***********************************************************************/
2520 /* Error handler for safe_eval and safe_call. */
2523 safe_eval_handler (Lisp_Object arg
, ptrdiff_t nargs
, Lisp_Object
*args
)
2525 add_to_log ("Error during redisplay: %S signaled %S",
2526 Flist (nargs
, args
), arg
);
2530 /* Call function FUNC with the rest of NARGS - 1 arguments
2531 following. Return the result, or nil if something went
2532 wrong. Prevent redisplay during the evaluation. */
2535 safe__call (bool inhibit_quit
, ptrdiff_t nargs
, Lisp_Object func
, va_list ap
)
2539 if (inhibit_eval_during_redisplay
)
2544 ptrdiff_t count
= SPECPDL_INDEX ();
2547 SAFE_ALLOCA_LISP (args
, nargs
);
2550 for (i
= 1; i
< nargs
; i
++)
2551 args
[i
] = va_arg (ap
, Lisp_Object
);
2553 specbind (Qinhibit_redisplay
, Qt
);
2555 specbind (Qinhibit_quit
, Qt
);
2556 /* Use Qt to ensure debugger does not run,
2557 so there is no possibility of wanting to redisplay. */
2558 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2561 val
= unbind_to (count
, val
);
2568 safe_call (ptrdiff_t nargs
, Lisp_Object func
, ...)
2573 va_start (ap
, func
);
2574 retval
= safe__call (false, nargs
, func
, ap
);
2579 /* Call function FN with one argument ARG.
2580 Return the result, or nil if something went wrong. */
2583 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2585 return safe_call (2, fn
, arg
);
2589 safe__call1 (bool inhibit_quit
, Lisp_Object fn
, ...)
2595 retval
= safe__call (inhibit_quit
, 2, fn
, ap
);
2601 safe_eval (Lisp_Object sexpr
)
2603 return safe__call1 (false, Qeval
, sexpr
);
2607 safe__eval (bool inhibit_quit
, Lisp_Object sexpr
)
2609 return safe__call1 (inhibit_quit
, Qeval
, sexpr
);
2612 /* Call function FN with two arguments ARG1 and ARG2.
2613 Return the result, or nil if something went wrong. */
2616 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2618 return safe_call (3, fn
, arg1
, arg2
);
2623 /***********************************************************************
2625 ***********************************************************************/
2627 /* Define CHECK_IT to perform sanity checks on iterators.
2628 This is for debugging. It is too slow to do unconditionally. */
2631 CHECK_IT (struct it
*it
)
2634 if (it
->method
== GET_FROM_STRING
)
2636 eassert (STRINGP (it
->string
));
2637 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2641 eassert (IT_STRING_CHARPOS (*it
) < 0);
2642 if (it
->method
== GET_FROM_BUFFER
)
2644 /* Check that character and byte positions agree. */
2645 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2650 eassert (it
->current
.dpvec_index
>= 0);
2652 eassert (it
->current
.dpvec_index
< 0);
2657 /* Check that the window end of window W is what we expect it
2658 to be---the last row in the current matrix displaying text. */
2661 CHECK_WINDOW_END (struct window
*w
)
2663 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2664 if (!MINI_WINDOW_P (w
) && w
->window_end_valid
)
2666 struct glyph_row
*row
;
2667 eassert ((row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
),
2669 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2670 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2675 /***********************************************************************
2676 Iterator initialization
2677 ***********************************************************************/
2679 /* Initialize IT for displaying current_buffer in window W, starting
2680 at character position CHARPOS. CHARPOS < 0 means that no buffer
2681 position is specified which is useful when the iterator is assigned
2682 a position later. BYTEPOS is the byte position corresponding to
2685 If ROW is not null, calls to produce_glyphs with IT as parameter
2686 will produce glyphs in that row.
2688 BASE_FACE_ID is the id of a base face to use. It must be one of
2689 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2690 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2691 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2693 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2694 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2695 will be initialized to use the corresponding mode line glyph row of
2696 the desired matrix of W. */
2699 init_iterator (struct it
*it
, struct window
*w
,
2700 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2701 struct glyph_row
*row
, enum face_id base_face_id
)
2703 enum face_id remapped_base_face_id
= base_face_id
;
2705 /* Some precondition checks. */
2706 eassert (w
!= NULL
&& it
!= NULL
);
2707 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2710 /* If face attributes have been changed since the last redisplay,
2711 free realized faces now because they depend on face definitions
2712 that might have changed. Don't free faces while there might be
2713 desired matrices pending which reference these faces. */
2714 if (!inhibit_free_realized_faces
)
2718 face_change
= false;
2719 free_all_realized_faces (Qnil
);
2721 else if (XFRAME (w
->frame
)->face_change
)
2723 XFRAME (w
->frame
)->face_change
= 0;
2724 free_all_realized_faces (w
->frame
);
2728 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2729 if (! NILP (Vface_remapping_alist
))
2730 remapped_base_face_id
2731 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2733 /* Use one of the mode line rows of W's desired matrix if
2737 if (base_face_id
== MODE_LINE_FACE_ID
2738 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2739 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2740 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2741 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2744 /* Clear IT, and set it->object and other IT's Lisp objects to Qnil.
2745 Other parts of redisplay rely on that. */
2746 memclear (it
, sizeof *it
);
2747 it
->current
.overlay_string_index
= -1;
2748 it
->current
.dpvec_index
= -1;
2749 it
->base_face_id
= remapped_base_face_id
;
2750 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2751 it
->paragraph_embedding
= L2R
;
2754 /* The window in which we iterate over current_buffer: */
2755 XSETWINDOW (it
->window
, w
);
2757 it
->f
= XFRAME (w
->frame
);
2761 /* Extra space between lines (on window systems only). */
2762 if (base_face_id
== DEFAULT_FACE_ID
2763 && FRAME_WINDOW_P (it
->f
))
2765 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2766 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2767 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2768 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2769 * FRAME_LINE_HEIGHT (it
->f
));
2770 else if (it
->f
->extra_line_spacing
> 0)
2771 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2774 /* If realized faces have been removed, e.g. because of face
2775 attribute changes of named faces, recompute them. When running
2776 in batch mode, the face cache of the initial frame is null. If
2777 we happen to get called, make a dummy face cache. */
2778 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2779 init_frame_faces (it
->f
);
2780 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2781 recompute_basic_faces (it
->f
);
2783 it
->override_ascent
= -1;
2785 /* Are control characters displayed as `^C'? */
2786 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2788 /* -1 means everything between a CR and the following line end
2789 is invisible. >0 means lines indented more than this value are
2791 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2793 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2795 : (!NILP (BVAR (current_buffer
, selective_display
))
2797 it
->selective_display_ellipsis_p
2798 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2800 /* Display table to use. */
2801 it
->dp
= window_display_table (w
);
2803 /* Are multibyte characters enabled in current_buffer? */
2804 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2806 /* Get the position at which the redisplay_end_trigger hook should
2807 be run, if it is to be run at all. */
2808 if (MARKERP (w
->redisplay_end_trigger
)
2809 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2810 it
->redisplay_end_trigger_charpos
2811 = marker_position (w
->redisplay_end_trigger
);
2812 else if (INTEGERP (w
->redisplay_end_trigger
))
2813 it
->redisplay_end_trigger_charpos
2814 = clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
),
2817 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2819 /* Are lines in the display truncated? */
2821 it
->line_wrap
= TRUNCATE
;
2822 if (base_face_id
== DEFAULT_FACE_ID
2824 && (WINDOW_FULL_WIDTH_P (it
->w
)
2825 || NILP (Vtruncate_partial_width_windows
)
2826 || (INTEGERP (Vtruncate_partial_width_windows
)
2827 /* PXW: Shall we do something about this? */
2828 && (XINT (Vtruncate_partial_width_windows
)
2829 <= WINDOW_TOTAL_COLS (it
->w
))))
2830 && NILP (BVAR (current_buffer
, truncate_lines
)))
2831 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2832 ? WINDOW_WRAP
: WORD_WRAP
;
2834 /* Get dimensions of truncation and continuation glyphs. These are
2835 displayed as fringe bitmaps under X, but we need them for such
2836 frames when the fringes are turned off. But leave the dimensions
2837 zero for tooltip frames, as these glyphs look ugly there and also
2838 sabotage calculations of tooltip dimensions in x-show-tip. */
2839 #ifdef HAVE_WINDOW_SYSTEM
2840 if (!(FRAME_WINDOW_P (it
->f
)
2841 && FRAMEP (tip_frame
)
2842 && it
->f
== XFRAME (tip_frame
)))
2845 if (it
->line_wrap
== TRUNCATE
)
2847 /* We will need the truncation glyph. */
2848 eassert (it
->glyph_row
== NULL
);
2849 produce_special_glyphs (it
, IT_TRUNCATION
);
2850 it
->truncation_pixel_width
= it
->pixel_width
;
2854 /* We will need the continuation glyph. */
2855 eassert (it
->glyph_row
== NULL
);
2856 produce_special_glyphs (it
, IT_CONTINUATION
);
2857 it
->continuation_pixel_width
= it
->pixel_width
;
2861 /* Reset these values to zero because the produce_special_glyphs
2862 above has changed them. */
2863 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2864 it
->phys_ascent
= it
->phys_descent
= 0;
2866 /* Set this after getting the dimensions of truncation and
2867 continuation glyphs, so that we don't produce glyphs when calling
2868 produce_special_glyphs, above. */
2869 it
->glyph_row
= row
;
2870 it
->area
= TEXT_AREA
;
2872 /* Get the dimensions of the display area. The display area
2873 consists of the visible window area plus a horizontally scrolled
2874 part to the left of the window. All x-values are relative to the
2875 start of this total display area. */
2876 if (base_face_id
!= DEFAULT_FACE_ID
)
2878 /* Mode lines, menu bar in terminal frames. */
2879 it
->first_visible_x
= 0;
2880 it
->last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
2885 = window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2886 it
->last_visible_x
= (it
->first_visible_x
2887 + window_box_width (w
, TEXT_AREA
));
2889 /* If we truncate lines, leave room for the truncation glyph(s) at
2890 the right margin. Otherwise, leave room for the continuation
2891 glyph(s). Done only if the window has no right fringe. */
2892 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
2894 if (it
->line_wrap
== TRUNCATE
)
2895 it
->last_visible_x
-= it
->truncation_pixel_width
;
2897 it
->last_visible_x
-= it
->continuation_pixel_width
;
2900 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2901 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2904 /* Leave room for a border glyph. */
2905 if (!FRAME_WINDOW_P (it
->f
)
2906 && !WINDOW_RIGHTMOST_P (it
->w
))
2907 it
->last_visible_x
-= 1;
2909 it
->last_visible_y
= window_text_bottom_y (w
);
2911 /* For mode lines and alike, arrange for the first glyph having a
2912 left box line if the face specifies a box. */
2913 if (base_face_id
!= DEFAULT_FACE_ID
)
2917 it
->face_id
= remapped_base_face_id
;
2919 /* If we have a boxed mode line, make the first character appear
2920 with a left box line. */
2921 face
= FACE_OPT_FROM_ID (it
->f
, remapped_base_face_id
);
2922 if (face
&& face
->box
!= FACE_NO_BOX
)
2923 it
->start_of_box_run_p
= true;
2926 /* If a buffer position was specified, set the iterator there,
2927 getting overlays and face properties from that position. */
2928 if (charpos
>= BUF_BEG (current_buffer
))
2930 it
->stop_charpos
= charpos
;
2931 it
->end_charpos
= ZV
;
2932 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
2933 IT_CHARPOS (*it
) = charpos
;
2934 IT_BYTEPOS (*it
) = bytepos
;
2936 /* We will rely on `reseat' to set this up properly, via
2937 handle_face_prop. */
2938 it
->face_id
= it
->base_face_id
;
2940 it
->start
= it
->current
;
2941 /* Do we need to reorder bidirectional text? Not if this is a
2942 unibyte buffer: by definition, none of the single-byte
2943 characters are strong R2L, so no reordering is needed. And
2944 bidi.c doesn't support unibyte buffers anyway. Also, don't
2945 reorder while we are loading loadup.el, since the tables of
2946 character properties needed for reordering are not yet
2949 !redisplay__inhibit_bidi
2950 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2953 /* If we are to reorder bidirectional text, init the bidi
2957 /* Since we don't know at this point whether there will be
2958 any R2L lines in the window, we reserve space for
2959 truncation/continuation glyphs even if only the left
2960 fringe is absent. */
2961 if (base_face_id
== DEFAULT_FACE_ID
2962 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
2963 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
2965 if (it
->line_wrap
== TRUNCATE
)
2966 it
->last_visible_x
-= it
->truncation_pixel_width
;
2968 it
->last_visible_x
-= it
->continuation_pixel_width
;
2970 /* Note the paragraph direction that this buffer wants to
2972 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2974 it
->paragraph_embedding
= L2R
;
2975 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2977 it
->paragraph_embedding
= R2L
;
2979 it
->paragraph_embedding
= NEUTRAL_DIR
;
2980 bidi_unshelve_cache (NULL
, false);
2981 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2985 /* Compute faces etc. */
2986 reseat (it
, it
->current
.pos
, true);
2993 /* Initialize IT for the display of window W with window start POS. */
2996 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2998 struct glyph_row
*row
;
2999 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
3001 row
= w
->desired_matrix
->rows
+ first_vpos
;
3002 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
3003 it
->first_vpos
= first_vpos
;
3005 /* Don't reseat to previous visible line start if current start
3006 position is in a string or image. */
3007 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
3009 int first_y
= it
->current_y
;
3011 /* If window start is not at a line start, skip forward to POS to
3012 get the correct continuation lines width. */
3013 bool start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
3014 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
3015 if (!start_at_line_beg_p
)
3019 reseat_at_previous_visible_line_start (it
);
3020 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
3022 new_x
= it
->current_x
+ it
->pixel_width
;
3024 /* If lines are continued, this line may end in the middle
3025 of a multi-glyph character (e.g. a control character
3026 displayed as \003, or in the middle of an overlay
3027 string). In this case move_it_to above will not have
3028 taken us to the start of the continuation line but to the
3029 end of the continued line. */
3030 if (it
->current_x
> 0
3031 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
3032 && (/* And glyph doesn't fit on the line. */
3033 new_x
> it
->last_visible_x
3034 /* Or it fits exactly and we're on a window
3036 || (new_x
== it
->last_visible_x
3037 && FRAME_WINDOW_P (it
->f
)
3038 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
3039 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
3040 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
3042 if ((it
->current
.dpvec_index
>= 0
3043 || it
->current
.overlay_string_index
>= 0)
3044 /* If we are on a newline from a display vector or
3045 overlay string, then we are already at the end of
3046 a screen line; no need to go to the next line in
3047 that case, as this line is not really continued.
3048 (If we do go to the next line, C-e will not DTRT.) */
3051 set_iterator_to_next (it
, true);
3052 move_it_in_display_line_to (it
, -1, -1, 0);
3055 it
->continuation_lines_width
+= it
->current_x
;
3057 /* If the character at POS is displayed via a display
3058 vector, move_it_to above stops at the final glyph of
3059 IT->dpvec. To make the caller redisplay that character
3060 again (a.k.a. start at POS), we need to reset the
3061 dpvec_index to the beginning of IT->dpvec. */
3062 else if (it
->current
.dpvec_index
>= 0)
3063 it
->current
.dpvec_index
= 0;
3065 /* We're starting a new display line, not affected by the
3066 height of the continued line, so clear the appropriate
3067 fields in the iterator structure. */
3068 it
->max_ascent
= it
->max_descent
= 0;
3069 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3071 it
->current_y
= first_y
;
3073 it
->current_x
= it
->hpos
= 0;
3079 /* Return true if POS is a position in ellipses displayed for invisible
3080 text. W is the window we display, for text property lookup. */
3083 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3085 Lisp_Object prop
, window
;
3086 bool ellipses_p
= false;
3087 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3089 /* If POS specifies a position in a display vector, this might
3090 be for an ellipsis displayed for invisible text. We won't
3091 get the iterator set up for delivering that ellipsis unless
3092 we make sure that it gets aware of the invisible text. */
3093 if (pos
->dpvec_index
>= 0
3094 && pos
->overlay_string_index
< 0
3095 && CHARPOS (pos
->string_pos
) < 0
3097 && (XSETWINDOW (window
, w
),
3098 prop
= Fget_char_property (make_number (charpos
),
3099 Qinvisible
, window
),
3100 TEXT_PROP_MEANS_INVISIBLE (prop
) == 0))
3102 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3104 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3111 /* Initialize IT for stepping through current_buffer in window W,
3112 starting at position POS that includes overlay string and display
3113 vector/ control character translation position information. Value
3114 is false if there are overlay strings with newlines at POS. */
3117 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3119 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3121 bool overlay_strings_with_newlines
= false;
3123 /* If POS specifies a position in a display vector, this might
3124 be for an ellipsis displayed for invisible text. We won't
3125 get the iterator set up for delivering that ellipsis unless
3126 we make sure that it gets aware of the invisible text. */
3127 if (in_ellipses_for_invisible_text_p (pos
, w
))
3133 /* Keep in mind: the call to reseat in init_iterator skips invisible
3134 text, so we might end up at a position different from POS. This
3135 is only a problem when POS is a row start after a newline and an
3136 overlay starts there with an after-string, and the overlay has an
3137 invisible property. Since we don't skip invisible text in
3138 display_line and elsewhere immediately after consuming the
3139 newline before the row start, such a POS will not be in a string,
3140 but the call to init_iterator below will move us to the
3142 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3144 /* This only scans the current chunk -- it should scan all chunks.
3145 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3146 to 16 in 22.1 to make this a lesser problem. */
3147 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3149 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3150 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3152 while (s
< e
&& *s
!= '\n')
3157 overlay_strings_with_newlines
= true;
3162 /* If position is within an overlay string, set up IT to the right
3164 if (pos
->overlay_string_index
>= 0)
3168 /* If the first overlay string happens to have a `display'
3169 property for an image, the iterator will be set up for that
3170 image, and we have to undo that setup first before we can
3171 correct the overlay string index. */
3172 if (it
->method
== GET_FROM_IMAGE
)
3175 /* We already have the first chunk of overlay strings in
3176 IT->overlay_strings. Load more until the one for
3177 pos->overlay_string_index is in IT->overlay_strings. */
3178 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3180 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3181 it
->current
.overlay_string_index
= 0;
3184 load_overlay_strings (it
, 0);
3185 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3189 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3190 relative_index
= (it
->current
.overlay_string_index
3191 % OVERLAY_STRING_CHUNK_SIZE
);
3192 it
->string
= it
->overlay_strings
[relative_index
];
3193 eassert (STRINGP (it
->string
));
3194 it
->current
.string_pos
= pos
->string_pos
;
3195 it
->method
= GET_FROM_STRING
;
3196 it
->end_charpos
= SCHARS (it
->string
);
3197 /* Set up the bidi iterator for this overlay string. */
3200 it
->bidi_it
.string
.lstring
= it
->string
;
3201 it
->bidi_it
.string
.s
= NULL
;
3202 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3203 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3204 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3205 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3206 it
->bidi_it
.w
= it
->w
;
3207 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3208 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3210 /* Synchronize the state of the bidi iterator with
3211 pos->string_pos. For any string position other than
3212 zero, this will be done automagically when we resume
3213 iteration over the string and get_visually_first_element
3214 is called. But if string_pos is zero, and the string is
3215 to be reordered for display, we need to resync manually,
3216 since it could be that the iteration state recorded in
3217 pos ended at string_pos of 0 moving backwards in string. */
3218 if (CHARPOS (pos
->string_pos
) == 0)
3220 get_visually_first_element (it
);
3221 if (IT_STRING_CHARPOS (*it
) != 0)
3224 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3225 bidi_move_to_visually_next (&it
->bidi_it
);
3226 } while (it
->bidi_it
.charpos
!= 0);
3228 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3229 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3233 if (CHARPOS (pos
->string_pos
) >= 0)
3235 /* Recorded position is not in an overlay string, but in another
3236 string. This can only be a string from a `display' property.
3237 IT should already be filled with that string. */
3238 it
->current
.string_pos
= pos
->string_pos
;
3239 eassert (STRINGP (it
->string
));
3241 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3242 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3245 /* Restore position in display vector translations, control
3246 character translations or ellipses. */
3247 if (pos
->dpvec_index
>= 0)
3249 if (it
->dpvec
== NULL
)
3250 get_next_display_element (it
);
3251 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3252 it
->current
.dpvec_index
= pos
->dpvec_index
;
3256 return !overlay_strings_with_newlines
;
3260 /* Initialize IT for stepping through current_buffer in window W
3261 starting at ROW->start. */
3264 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3266 init_from_display_pos (it
, w
, &row
->start
);
3267 it
->start
= row
->start
;
3268 it
->continuation_lines_width
= row
->continuation_lines_width
;
3273 /* Initialize IT for stepping through current_buffer in window W
3274 starting in the line following ROW, i.e. starting at ROW->end.
3275 Value is false if there are overlay strings with newlines at ROW's
3279 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3281 bool success
= false;
3283 if (init_from_display_pos (it
, w
, &row
->end
))
3285 if (row
->continued_p
)
3286 it
->continuation_lines_width
3287 = row
->continuation_lines_width
+ row
->pixel_width
;
3298 /***********************************************************************
3300 ***********************************************************************/
3302 /* Called when IT reaches IT->stop_charpos. Handle text property and
3303 overlay changes. Set IT->stop_charpos to the next position where
3307 handle_stop (struct it
*it
)
3309 enum prop_handled handled
;
3310 bool handle_overlay_change_p
;
3314 it
->current
.dpvec_index
= -1;
3315 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3316 it
->ellipsis_p
= false;
3318 /* Use face of preceding text for ellipsis (if invisible) */
3319 if (it
->selective_display_ellipsis_p
)
3320 it
->saved_face_id
= it
->face_id
;
3322 /* Here's the description of the semantics of, and the logic behind,
3323 the various HANDLED_* statuses:
3325 HANDLED_NORMALLY means the handler did its job, and the loop
3326 should proceed to calling the next handler in order.
3328 HANDLED_RECOMPUTE_PROPS means the handler caused a significant
3329 change in the properties and overlays at current position, so the
3330 loop should be restarted, to re-invoke the handlers that were
3331 already called. This happens when fontification-functions were
3332 called by handle_fontified_prop, and actually fontified
3333 something. Another case where HANDLED_RECOMPUTE_PROPS is
3334 returned is when we discover overlay strings that need to be
3335 displayed right away. The loop below will continue for as long
3336 as the status is HANDLED_RECOMPUTE_PROPS.
3338 HANDLED_RETURN means return immediately to the caller, to
3339 continue iteration without calling any further handlers. This is
3340 used when we need to act on some property right away, for example
3341 when we need to display the ellipsis or a replacing display
3342 property, such as display string or image.
3344 HANDLED_OVERLAY_STRING_CONSUMED means an overlay string was just
3345 consumed, and the handler switched to the next overlay string.
3346 This signals the loop below to refrain from looking for more
3347 overlays before all the overlay strings of the current overlay
3350 Some of the handlers called by the loop push the iterator state
3351 onto the stack (see 'push_it'), and arrange for the iteration to
3352 continue with another object, such as an image, a display string,
3353 or an overlay string. In most such cases, it->stop_charpos is
3354 set to the first character of the string, so that when the
3355 iteration resumes, this function will immediately be called
3356 again, to examine the properties at the beginning of the string.
3358 When a display or overlay string is exhausted, the iterator state
3359 is popped (see 'pop_it'), and iteration continues with the
3360 previous object. Again, in many such cases this function is
3361 called again to find the next position where properties might
3366 handled
= HANDLED_NORMALLY
;
3368 /* Call text property handlers. */
3369 for (p
= it_props
; p
->handler
; ++p
)
3371 handled
= p
->handler (it
);
3373 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3375 else if (handled
== HANDLED_RETURN
)
3377 /* We still want to show before and after strings from
3378 overlays even if the actual buffer text is replaced. */
3379 if (!handle_overlay_change_p
3381 /* Don't call get_overlay_strings_1 if we already
3382 have overlay strings loaded, because doing so
3383 will load them again and push the iterator state
3384 onto the stack one more time, which is not
3385 expected by the rest of the code that processes
3387 || (it
->current
.overlay_string_index
< 0
3388 && !get_overlay_strings_1 (it
, 0, false)))
3391 setup_for_ellipsis (it
, 0);
3392 /* When handling a display spec, we might load an
3393 empty string. In that case, discard it here. We
3394 used to discard it in handle_single_display_spec,
3395 but that causes get_overlay_strings_1, above, to
3396 ignore overlay strings that we must check. */
3397 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3401 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3405 it
->string_from_display_prop_p
= false;
3406 it
->from_disp_prop_p
= false;
3407 handle_overlay_change_p
= false;
3409 handled
= HANDLED_RECOMPUTE_PROPS
;
3412 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3413 handle_overlay_change_p
= false;
3416 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3418 /* Don't check for overlay strings below when set to deliver
3419 characters from a display vector. */
3420 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3421 handle_overlay_change_p
= false;
3423 /* Handle overlay changes.
3424 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3425 if it finds overlays. */
3426 if (handle_overlay_change_p
)
3427 handled
= handle_overlay_change (it
);
3432 setup_for_ellipsis (it
, 0);
3436 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3438 /* Determine where to stop next. */
3439 if (handled
== HANDLED_NORMALLY
)
3440 compute_stop_pos (it
);
3444 /* Compute IT->stop_charpos from text property and overlay change
3445 information for IT's current position. */
3448 compute_stop_pos (struct it
*it
)
3450 register INTERVAL iv
, next_iv
;
3451 Lisp_Object object
, limit
, position
;
3452 ptrdiff_t charpos
, bytepos
;
3454 if (STRINGP (it
->string
))
3456 /* Strings are usually short, so don't limit the search for
3458 it
->stop_charpos
= it
->end_charpos
;
3459 object
= it
->string
;
3461 charpos
= IT_STRING_CHARPOS (*it
);
3462 bytepos
= IT_STRING_BYTEPOS (*it
);
3468 /* If end_charpos is out of range for some reason, such as a
3469 misbehaving display function, rationalize it (Bug#5984). */
3470 if (it
->end_charpos
> ZV
)
3471 it
->end_charpos
= ZV
;
3472 it
->stop_charpos
= it
->end_charpos
;
3474 /* If next overlay change is in front of the current stop pos
3475 (which is IT->end_charpos), stop there. Note: value of
3476 next_overlay_change is point-max if no overlay change
3478 charpos
= IT_CHARPOS (*it
);
3479 bytepos
= IT_BYTEPOS (*it
);
3480 pos
= next_overlay_change (charpos
);
3481 if (pos
< it
->stop_charpos
)
3482 it
->stop_charpos
= pos
;
3484 /* Set up variables for computing the stop position from text
3485 property changes. */
3486 XSETBUFFER (object
, current_buffer
);
3487 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3490 /* Get the interval containing IT's position. Value is a null
3491 interval if there isn't such an interval. */
3492 position
= make_number (charpos
);
3493 iv
= validate_interval_range (object
, &position
, &position
, false);
3496 Lisp_Object values_here
[LAST_PROP_IDX
];
3499 /* Get properties here. */
3500 for (p
= it_props
; p
->handler
; ++p
)
3501 values_here
[p
->idx
] = textget (iv
->plist
,
3502 builtin_lisp_symbol (p
->name
));
3504 /* Look for an interval following iv that has different
3506 for (next_iv
= next_interval (iv
);
3509 || XFASTINT (limit
) > next_iv
->position
));
3510 next_iv
= next_interval (next_iv
))
3512 for (p
= it_props
; p
->handler
; ++p
)
3514 Lisp_Object new_value
= textget (next_iv
->plist
,
3515 builtin_lisp_symbol (p
->name
));
3516 if (!EQ (values_here
[p
->idx
], new_value
))
3526 if (INTEGERP (limit
)
3527 && next_iv
->position
>= XFASTINT (limit
))
3528 /* No text property change up to limit. */
3529 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3531 /* Text properties change in next_iv. */
3532 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3536 if (it
->cmp_it
.id
< 0)
3538 ptrdiff_t stoppos
= it
->end_charpos
;
3540 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3542 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3543 stoppos
, it
->string
);
3546 eassert (STRINGP (it
->string
)
3547 || (it
->stop_charpos
>= BEGV
3548 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3552 /* Return the position of the next overlay change after POS in
3553 current_buffer. Value is point-max if no overlay change
3554 follows. This is like `next-overlay-change' but doesn't use
3558 next_overlay_change (ptrdiff_t pos
)
3560 ptrdiff_t i
, noverlays
;
3562 Lisp_Object
*overlays
;
3565 /* Get all overlays at the given position. */
3566 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, true);
3568 /* If any of these overlays ends before endpos,
3569 use its ending point instead. */
3570 for (i
= 0; i
< noverlays
; ++i
)
3575 oend
= OVERLAY_END (overlays
[i
]);
3576 oendpos
= OVERLAY_POSITION (oend
);
3577 endpos
= min (endpos
, oendpos
);
3584 /* How many characters forward to search for a display property or
3585 display string. Searching too far forward makes the bidi display
3586 sluggish, especially in small windows. */
3587 #define MAX_DISP_SCAN 250
3589 /* Return the character position of a display string at or after
3590 position specified by POSITION. If no display string exists at or
3591 after POSITION, return ZV. A display string is either an overlay
3592 with `display' property whose value is a string, or a `display'
3593 text property whose value is a string. STRING is data about the
3594 string to iterate; if STRING->lstring is nil, we are iterating a
3595 buffer. FRAME_WINDOW_P is true when we are displaying a window
3596 on a GUI frame. DISP_PROP is set to zero if we searched
3597 MAX_DISP_SCAN characters forward without finding any display
3598 strings, non-zero otherwise. It is set to 2 if the display string
3599 uses any kind of `(space ...)' spec that will produce a stretch of
3600 white space in the text area. */
3602 compute_display_string_pos (struct text_pos
*position
,
3603 struct bidi_string_data
*string
,
3605 bool frame_window_p
, int *disp_prop
)
3607 /* OBJECT = nil means current buffer. */
3608 Lisp_Object object
, object1
;
3609 Lisp_Object pos
, spec
, limpos
;
3610 bool string_p
= string
&& (STRINGP (string
->lstring
) || string
->s
);
3611 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3612 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3613 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3615 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3616 struct text_pos tpos
;
3619 if (string
&& STRINGP (string
->lstring
))
3620 object1
= object
= string
->lstring
;
3621 else if (w
&& !string_p
)
3623 XSETWINDOW (object
, w
);
3627 object1
= object
= Qnil
;
3632 /* We don't support display properties whose values are strings
3633 that have display string properties. */
3634 || string
->from_disp_str
3635 /* C strings cannot have display properties. */
3636 || (string
->s
&& !STRINGP (object
)))
3642 /* If the character at CHARPOS is where the display string begins,
3644 pos
= make_number (charpos
);
3645 if (STRINGP (object
))
3646 bufpos
= string
->bufpos
;
3650 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3652 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3655 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3663 /* Look forward for the first character with a `display' property
3664 that will replace the underlying text when displayed. */
3665 limpos
= make_number (lim
);
3667 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3668 CHARPOS (tpos
) = XFASTINT (pos
);
3669 if (CHARPOS (tpos
) >= lim
)
3674 if (STRINGP (object
))
3675 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3677 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3678 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3679 if (!STRINGP (object
))
3680 bufpos
= CHARPOS (tpos
);
3681 } while (NILP (spec
)
3682 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3683 bufpos
, frame_window_p
)));
3687 return CHARPOS (tpos
);
3690 /* Return the character position of the end of the display string that
3691 started at CHARPOS. If there's no display string at CHARPOS,
3692 return -1. A display string is either an overlay with `display'
3693 property whose value is a string or a `display' text property whose
3694 value is a string. */
3696 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3698 /* OBJECT = nil means current buffer. */
3699 Lisp_Object object
=
3700 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3701 Lisp_Object pos
= make_number (charpos
);
3703 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3705 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3708 /* It could happen that the display property or overlay was removed
3709 since we found it in compute_display_string_pos above. One way
3710 this can happen is if JIT font-lock was called (through
3711 handle_fontified_prop), and jit-lock-functions remove text
3712 properties or overlays from the portion of buffer that includes
3713 CHARPOS. Muse mode is known to do that, for example. In this
3714 case, we return -1 to the caller, to signal that no display
3715 string is actually present at CHARPOS. See bidi_fetch_char for
3716 how this is handled.
3718 An alternative would be to never look for display properties past
3719 it->stop_charpos. But neither compute_display_string_pos nor
3720 bidi_fetch_char that calls it know or care where the next
3722 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3725 /* Look forward for the first character where the `display' property
3727 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3729 return XFASTINT (pos
);
3734 /***********************************************************************
3736 ***********************************************************************/
3738 /* Handle changes in the `fontified' property of the current buffer by
3739 calling hook functions from Qfontification_functions to fontify
3742 static enum prop_handled
3743 handle_fontified_prop (struct it
*it
)
3745 Lisp_Object prop
, pos
;
3746 enum prop_handled handled
= HANDLED_NORMALLY
;
3748 if (!NILP (Vmemory_full
))
3751 /* Get the value of the `fontified' property at IT's current buffer
3752 position. (The `fontified' property doesn't have a special
3753 meaning in strings.) If the value is nil, call functions from
3754 Qfontification_functions. */
3755 if (!STRINGP (it
->string
)
3757 && !NILP (Vfontification_functions
)
3758 && !NILP (Vrun_hooks
)
3759 && (pos
= make_number (IT_CHARPOS (*it
)),
3760 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3761 /* Ignore the special cased nil value always present at EOB since
3762 no amount of fontifying will be able to change it. */
3763 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3765 ptrdiff_t count
= SPECPDL_INDEX ();
3767 struct buffer
*obuf
= current_buffer
;
3768 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3769 bool old_clip_changed
= current_buffer
->clip_changed
;
3771 val
= Vfontification_functions
;
3772 specbind (Qfontification_functions
, Qnil
);
3774 eassert (it
->end_charpos
== ZV
);
3776 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3777 safe_call1 (val
, pos
);
3780 Lisp_Object fns
, fn
;
3784 for (; CONSP (val
); val
= XCDR (val
))
3790 /* A value of t indicates this hook has a local
3791 binding; it means to run the global binding too.
3792 In a global value, t should not occur. If it
3793 does, we must ignore it to avoid an endless
3795 for (fns
= Fdefault_value (Qfontification_functions
);
3801 safe_call1 (fn
, pos
);
3805 safe_call1 (fn
, pos
);
3809 unbind_to (count
, Qnil
);
3811 /* Fontification functions routinely call `save-restriction'.
3812 Normally, this tags clip_changed, which can confuse redisplay
3813 (see discussion in Bug#6671). Since we don't perform any
3814 special handling of fontification changes in the case where
3815 `save-restriction' isn't called, there's no point doing so in
3816 this case either. So, if the buffer's restrictions are
3817 actually left unchanged, reset clip_changed. */
3818 if (obuf
== current_buffer
)
3820 if (begv
== BEGV
&& zv
== ZV
)
3821 current_buffer
->clip_changed
= old_clip_changed
;
3823 /* There isn't much we can reasonably do to protect against
3824 misbehaving fontification, but here's a fig leaf. */
3825 else if (BUFFER_LIVE_P (obuf
))
3826 set_buffer_internal_1 (obuf
);
3828 /* The fontification code may have added/removed text.
3829 It could do even a lot worse, but let's at least protect against
3830 the most obvious case where only the text past `pos' gets changed',
3831 as is/was done in grep.el where some escapes sequences are turned
3832 into face properties (bug#7876). */
3833 it
->end_charpos
= ZV
;
3835 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3836 something. This avoids an endless loop if they failed to
3837 fontify the text for which reason ever. */
3838 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3839 handled
= HANDLED_RECOMPUTE_PROPS
;
3847 /***********************************************************************
3849 ***********************************************************************/
3851 /* Set up iterator IT from face properties at its current position.
3852 Called from handle_stop. */
3854 static enum prop_handled
3855 handle_face_prop (struct it
*it
)
3858 ptrdiff_t next_stop
;
3860 if (!STRINGP (it
->string
))
3863 = face_at_buffer_position (it
->w
,
3867 + TEXT_PROP_DISTANCE_LIMIT
),
3868 false, it
->base_face_id
);
3870 /* Is this a start of a run of characters with box face?
3871 Caveat: this can be called for a freshly initialized
3872 iterator; face_id is -1 in this case. We know that the new
3873 face will not change until limit, i.e. if the new face has a
3874 box, all characters up to limit will have one. But, as
3875 usual, we don't know whether limit is really the end. */
3876 if (new_face_id
!= it
->face_id
)
3878 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3879 /* If it->face_id is -1, old_face below will be NULL, see
3880 the definition of FACE_OPT_FROM_ID. This will happen if this
3881 is the initial call that gets the face. */
3882 struct face
*old_face
= FACE_OPT_FROM_ID (it
->f
, it
->face_id
);
3884 /* If the value of face_id of the iterator is -1, we have to
3885 look in front of IT's position and see whether there is a
3886 face there that's different from new_face_id. */
3887 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
3889 int prev_face_id
= face_before_it_pos (it
);
3891 old_face
= FACE_OPT_FROM_ID (it
->f
, prev_face_id
);
3894 /* If the new face has a box, but the old face does not,
3895 this is the start of a run of characters with box face,
3896 i.e. this character has a shadow on the left side. */
3897 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
3898 && (old_face
== NULL
|| !old_face
->box
));
3899 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3907 Lisp_Object from_overlay
3908 = (it
->current
.overlay_string_index
>= 0
3909 ? it
->string_overlays
[it
->current
.overlay_string_index
3910 % OVERLAY_STRING_CHUNK_SIZE
]
3913 /* See if we got to this string directly or indirectly from
3914 an overlay property. That includes the before-string or
3915 after-string of an overlay, strings in display properties
3916 provided by an overlay, their text properties, etc.
3918 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3919 if (! NILP (from_overlay
))
3920 for (i
= it
->sp
- 1; i
>= 0; i
--)
3922 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3924 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3925 % OVERLAY_STRING_CHUNK_SIZE
];
3926 else if (! NILP (it
->stack
[i
].from_overlay
))
3927 from_overlay
= it
->stack
[i
].from_overlay
;
3929 if (!NILP (from_overlay
))
3933 if (! NILP (from_overlay
))
3935 bufpos
= IT_CHARPOS (*it
);
3936 /* For a string from an overlay, the base face depends
3937 only on text properties and ignores overlays. */
3939 = face_for_overlay_string (it
->w
,
3943 + TEXT_PROP_DISTANCE_LIMIT
),
3951 /* For strings from a `display' property, use the face at
3952 IT's current buffer position as the base face to merge
3953 with, so that overlay strings appear in the same face as
3954 surrounding text, unless they specify their own faces.
3955 For strings from wrap-prefix and line-prefix properties,
3956 use the default face, possibly remapped via
3957 Vface_remapping_alist. */
3958 /* Note that the fact that we use the face at _buffer_
3959 position means that a 'display' property on an overlay
3960 string will not inherit the face of that overlay string,
3961 but will instead revert to the face of buffer text
3962 covered by the overlay. This is visible, e.g., when the
3963 overlay specifies a box face, but neither the buffer nor
3964 the display string do. This sounds like a design bug,
3965 but Emacs always did that since v21.1, so changing that
3966 might be a big deal. */
3967 base_face_id
= it
->string_from_prefix_prop_p
3968 ? (!NILP (Vface_remapping_alist
)
3969 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
3971 : underlying_face_id (it
);
3974 new_face_id
= face_at_string_position (it
->w
,
3976 IT_STRING_CHARPOS (*it
),
3979 base_face_id
, false);
3981 /* Is this a start of a run of characters with box? Caveat:
3982 this can be called for a freshly allocated iterator; face_id
3983 is -1 is this case. We know that the new face will not
3984 change until the next check pos, i.e. if the new face has a
3985 box, all characters up to that position will have a
3986 box. But, as usual, we don't know whether that position
3987 is really the end. */
3988 if (new_face_id
!= it
->face_id
)
3990 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3991 struct face
*old_face
= FACE_OPT_FROM_ID (it
->f
, it
->face_id
);
3993 /* If new face has a box but old face hasn't, this is the
3994 start of a run of characters with box, i.e. it has a
3995 shadow on the left side. */
3996 it
->start_of_box_run_p
3997 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3998 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
4002 it
->face_id
= new_face_id
;
4003 return HANDLED_NORMALLY
;
4007 /* Return the ID of the face ``underlying'' IT's current position,
4008 which is in a string. If the iterator is associated with a
4009 buffer, return the face at IT's current buffer position.
4010 Otherwise, use the iterator's base_face_id. */
4013 underlying_face_id (struct it
*it
)
4015 int face_id
= it
->base_face_id
, i
;
4017 eassert (STRINGP (it
->string
));
4019 for (i
= it
->sp
- 1; i
>= 0; --i
)
4020 if (NILP (it
->stack
[i
].string
))
4021 face_id
= it
->stack
[i
].face_id
;
4027 /* Compute the face one character before or after the current position
4028 of IT, in the visual order. BEFORE_P means get the face
4029 in front (to the left in L2R paragraphs, to the right in R2L
4030 paragraphs) of IT's screen position. Value is the ID of the face. */
4033 face_before_or_after_it_pos (struct it
*it
, bool before_p
)
4036 ptrdiff_t next_check_charpos
;
4038 void *it_copy_data
= NULL
;
4040 eassert (it
->s
== NULL
);
4042 if (STRINGP (it
->string
))
4044 ptrdiff_t bufpos
, charpos
;
4047 /* No face change past the end of the string (for the case
4048 we are padding with spaces). No face change before the
4050 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
4051 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
4056 /* Set charpos to the position before or after IT's current
4057 position, in the logical order, which in the non-bidi
4058 case is the same as the visual order. */
4060 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4061 else if (it
->what
== IT_COMPOSITION
)
4062 /* For composition, we must check the character after the
4064 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4066 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4072 /* With bidi iteration, the character before the current
4073 in the visual order cannot be found by simple
4074 iteration, because "reverse" reordering is not
4075 supported. Instead, we need to start from the string
4076 beginning and go all the way to the current string
4077 position, remembering the previous position. */
4078 /* Ignore face changes before the first visible
4079 character on this display line. */
4080 if (it
->current_x
<= it
->first_visible_x
)
4082 SAVE_IT (it_copy
, *it
, it_copy_data
);
4083 IT_STRING_CHARPOS (it_copy
) = 0;
4084 bidi_init_it (0, 0, FRAME_WINDOW_P (it_copy
.f
), &it_copy
.bidi_it
);
4088 charpos
= IT_STRING_CHARPOS (it_copy
);
4089 if (charpos
>= SCHARS (it
->string
))
4091 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4093 while (IT_STRING_CHARPOS (it_copy
) != IT_STRING_CHARPOS (*it
));
4095 RESTORE_IT (it
, it
, it_copy_data
);
4099 /* Set charpos to the string position of the character
4100 that comes after IT's current position in the visual
4102 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4106 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4108 charpos
= it_copy
.bidi_it
.charpos
;
4111 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4113 if (it
->current
.overlay_string_index
>= 0)
4114 bufpos
= IT_CHARPOS (*it
);
4118 base_face_id
= underlying_face_id (it
);
4120 /* Get the face for ASCII, or unibyte. */
4121 face_id
= face_at_string_position (it
->w
,
4125 &next_check_charpos
,
4126 base_face_id
, false);
4128 /* Correct the face for charsets different from ASCII. Do it
4129 for the multibyte case only. The face returned above is
4130 suitable for unibyte text if IT->string is unibyte. */
4131 if (STRING_MULTIBYTE (it
->string
))
4133 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4134 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4136 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4138 c
= string_char_and_length (p
, &len
);
4139 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4144 struct text_pos pos
;
4146 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4147 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4150 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4151 pos
= it
->current
.pos
;
4156 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4159 if (it
->what
== IT_COMPOSITION
)
4161 /* For composition, we must check the position after
4163 pos
.charpos
+= it
->cmp_it
.nchars
;
4164 pos
.bytepos
+= it
->len
;
4167 INC_TEXT_POS (pos
, it
->multibyte_p
);
4176 /* With bidi iteration, the character before the current
4177 in the visual order cannot be found by simple
4178 iteration, because "reverse" reordering is not
4179 supported. Instead, we need to use the move_it_*
4180 family of functions, and move to the previous
4181 character starting from the beginning of the visual
4183 /* Ignore face changes before the first visible
4184 character on this display line. */
4185 if (it
->current_x
<= it
->first_visible_x
)
4187 SAVE_IT (it_copy
, *it
, it_copy_data
);
4188 /* Implementation note: Since move_it_in_display_line
4189 works in the iterator geometry, and thinks the first
4190 character is always the leftmost, even in R2L lines,
4191 we don't need to distinguish between the R2L and L2R
4193 current_x
= it_copy
.current_x
;
4194 move_it_vertically_backward (&it_copy
, 0);
4195 move_it_in_display_line (&it_copy
, ZV
, current_x
- 1, MOVE_TO_X
);
4196 pos
= it_copy
.current
.pos
;
4197 RESTORE_IT (it
, it
, it_copy_data
);
4201 /* Set charpos to the buffer position of the character
4202 that comes after IT's current position in the visual
4204 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4208 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4211 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4214 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4216 /* Determine face for CHARSET_ASCII, or unibyte. */
4217 face_id
= face_at_buffer_position (it
->w
,
4219 &next_check_charpos
,
4222 /* Correct the face for charsets different from ASCII. Do it
4223 for the multibyte case only. The face returned above is
4224 suitable for unibyte text if current_buffer is unibyte. */
4225 if (it
->multibyte_p
)
4227 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4228 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4229 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4238 /***********************************************************************
4240 ***********************************************************************/
4242 /* Set up iterator IT from invisible properties at its current
4243 position. Called from handle_stop. */
4245 static enum prop_handled
4246 handle_invisible_prop (struct it
*it
)
4248 enum prop_handled handled
= HANDLED_NORMALLY
;
4252 if (STRINGP (it
->string
))
4254 Lisp_Object end_charpos
, limit
;
4256 /* Get the value of the invisible text property at the
4257 current position. Value will be nil if there is no such
4259 end_charpos
= make_number (IT_STRING_CHARPOS (*it
));
4260 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4261 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4263 if (invis
!= 0 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4265 /* Record whether we have to display an ellipsis for the
4267 bool display_ellipsis_p
= (invis
== 2);
4268 ptrdiff_t len
, endpos
;
4270 handled
= HANDLED_RECOMPUTE_PROPS
;
4272 /* Get the position at which the next visible text can be
4273 found in IT->string, if any. */
4274 endpos
= len
= SCHARS (it
->string
);
4275 XSETINT (limit
, len
);
4279 = Fnext_single_property_change (end_charpos
, Qinvisible
,
4281 /* Since LIMIT is always an integer, so should be the
4282 value returned by Fnext_single_property_change. */
4283 eassert (INTEGERP (end_charpos
));
4284 if (INTEGERP (end_charpos
))
4286 endpos
= XFASTINT (end_charpos
);
4287 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4288 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4290 display_ellipsis_p
= true;
4292 else /* Should never happen; but if it does, exit the loop. */
4295 while (invis
!= 0 && endpos
< len
);
4297 if (display_ellipsis_p
)
4298 it
->ellipsis_p
= true;
4302 /* Text at END_CHARPOS is visible. Move IT there. */
4303 struct text_pos old
;
4306 old
= it
->current
.string_pos
;
4307 oldpos
= CHARPOS (old
);
4310 if (it
->bidi_it
.first_elt
4311 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4312 bidi_paragraph_init (it
->paragraph_embedding
,
4313 &it
->bidi_it
, true);
4314 /* Bidi-iterate out of the invisible text. */
4317 bidi_move_to_visually_next (&it
->bidi_it
);
4319 while (oldpos
<= it
->bidi_it
.charpos
4320 && it
->bidi_it
.charpos
< endpos
);
4322 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4323 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4324 if (IT_CHARPOS (*it
) >= endpos
)
4325 it
->prev_stop
= endpos
;
4329 IT_STRING_CHARPOS (*it
) = endpos
;
4330 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4335 /* The rest of the string is invisible. If this is an
4336 overlay string, proceed with the next overlay string
4337 or whatever comes and return a character from there. */
4338 if (it
->current
.overlay_string_index
>= 0
4339 && !display_ellipsis_p
)
4341 next_overlay_string (it
);
4342 /* Don't check for overlay strings when we just
4343 finished processing them. */
4344 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4348 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4349 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4356 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4357 Lisp_Object pos
, overlay
;
4359 /* First of all, is there invisible text at this position? */
4360 tem
= start_charpos
= IT_CHARPOS (*it
);
4361 pos
= make_number (tem
);
4362 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4364 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4366 /* If we are on invisible text, skip over it. */
4367 if (invis
!= 0 && start_charpos
< it
->end_charpos
)
4369 /* Record whether we have to display an ellipsis for the
4371 bool display_ellipsis_p
= invis
== 2;
4373 handled
= HANDLED_RECOMPUTE_PROPS
;
4375 /* Loop skipping over invisible text. The loop is left at
4376 ZV or with IT on the first char being visible again. */
4379 /* Try to skip some invisible text. Return value is the
4380 position reached which can be equal to where we start
4381 if there is nothing invisible there. This skips both
4382 over invisible text properties and overlays with
4383 invisible property. */
4384 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4386 /* If we skipped nothing at all we weren't at invisible
4387 text in the first place. If everything to the end of
4388 the buffer was skipped, end the loop. */
4389 if (newpos
== tem
|| newpos
>= ZV
)
4393 /* We skipped some characters but not necessarily
4394 all there are. Check if we ended up on visible
4395 text. Fget_char_property returns the property of
4396 the char before the given position, i.e. if we
4397 get invis = 0, this means that the char at
4398 newpos is visible. */
4399 pos
= make_number (newpos
);
4400 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4401 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4404 /* If we ended up on invisible text, proceed to
4405 skip starting with next_stop. */
4409 /* If there are adjacent invisible texts, don't lose the
4410 second one's ellipsis. */
4412 display_ellipsis_p
= true;
4416 /* The position newpos is now either ZV or on visible text. */
4419 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4421 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4423 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4425 /* If the invisible text ends on a newline or on a
4426 character after a newline, we can avoid the costly,
4427 character by character, bidi iteration to NEWPOS, and
4428 instead simply reseat the iterator there. That's
4429 because all bidi reordering information is tossed at
4430 the newline. This is a big win for modes that hide
4431 complete lines, like Outline, Org, etc. */
4432 if (on_newline
|| after_newline
)
4434 struct text_pos tpos
;
4435 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4437 SET_TEXT_POS (tpos
, newpos
, bpos
);
4438 reseat_1 (it
, tpos
, false);
4439 /* If we reseat on a newline/ZV, we need to prep the
4440 bidi iterator for advancing to the next character
4441 after the newline/EOB, keeping the current paragraph
4442 direction (so that PRODUCE_GLYPHS does TRT wrt
4443 prepending/appending glyphs to a glyph row). */
4446 it
->bidi_it
.first_elt
= false;
4447 it
->bidi_it
.paragraph_dir
= pdir
;
4448 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4449 it
->bidi_it
.nchars
= 1;
4450 it
->bidi_it
.ch_len
= 1;
4453 else /* Must use the slow method. */
4455 /* With bidi iteration, the region of invisible text
4456 could start and/or end in the middle of a
4457 non-base embedding level. Therefore, we need to
4458 skip invisible text using the bidi iterator,
4459 starting at IT's current position, until we find
4460 ourselves outside of the invisible text.
4461 Skipping invisible text _after_ bidi iteration
4462 avoids affecting the visual order of the
4463 displayed text when invisible properties are
4464 added or removed. */
4465 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4467 /* If we were `reseat'ed to a new paragraph,
4468 determine the paragraph base direction. We
4469 need to do it now because
4470 next_element_from_buffer may not have a
4471 chance to do it, if we are going to skip any
4472 text at the beginning, which resets the
4474 bidi_paragraph_init (it
->paragraph_embedding
,
4475 &it
->bidi_it
, true);
4479 bidi_move_to_visually_next (&it
->bidi_it
);
4481 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4482 && it
->bidi_it
.charpos
< newpos
);
4483 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4484 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4485 /* If we overstepped NEWPOS, record its position in
4486 the iterator, so that we skip invisible text if
4487 later the bidi iteration lands us in the
4488 invisible region again. */
4489 if (IT_CHARPOS (*it
) >= newpos
)
4490 it
->prev_stop
= newpos
;
4495 IT_CHARPOS (*it
) = newpos
;
4496 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4499 if (display_ellipsis_p
)
4501 /* Make sure that the glyphs of the ellipsis will get
4502 correct `charpos' values. If we would not update
4503 it->position here, the glyphs would belong to the
4504 last visible character _before_ the invisible
4505 text, which confuses `set_cursor_from_row'.
4507 We use the last invisible position instead of the
4508 first because this way the cursor is always drawn on
4509 the first "." of the ellipsis, whenever PT is inside
4510 the invisible text. Otherwise the cursor would be
4511 placed _after_ the ellipsis when the point is after the
4512 first invisible character. */
4513 if (!STRINGP (it
->object
))
4515 it
->position
.charpos
= newpos
- 1;
4516 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4520 /* If there are before-strings at the start of invisible
4521 text, and the text is invisible because of a text
4522 property, arrange to show before-strings because 20.x did
4523 it that way. (If the text is invisible because of an
4524 overlay property instead of a text property, this is
4525 already handled in the overlay code.) */
4527 && get_overlay_strings (it
, it
->stop_charpos
))
4529 handled
= HANDLED_RECOMPUTE_PROPS
;
4532 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4533 /* The call to get_overlay_strings above recomputes
4534 it->stop_charpos, but it only considers changes
4535 in properties and overlays beyond iterator's
4536 current position. This causes us to miss changes
4537 that happen exactly where the invisible property
4538 ended. So we play it safe here and force the
4539 iterator to check for potential stop positions
4540 immediately after the invisible text. Note that
4541 if get_overlay_strings returns true, it
4542 normally also pushed the iterator stack, so we
4543 need to update the stop position in the slot
4544 below the current one. */
4545 it
->stack
[it
->sp
- 1].stop_charpos
4546 = CHARPOS (it
->stack
[it
->sp
- 1].current
.pos
);
4549 else if (display_ellipsis_p
)
4551 it
->ellipsis_p
= true;
4552 /* Let the ellipsis display before
4553 considering any properties of the following char.
4554 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4555 handled
= HANDLED_RETURN
;
4564 /* Make iterator IT return `...' next.
4565 Replaces LEN characters from buffer. */
4568 setup_for_ellipsis (struct it
*it
, int len
)
4570 /* Use the display table definition for `...'. Invalid glyphs
4571 will be handled by the method returning elements from dpvec. */
4572 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4574 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4575 it
->dpvec
= v
->contents
;
4576 it
->dpend
= v
->contents
+ v
->header
.size
;
4580 /* Default `...'. */
4581 it
->dpvec
= default_invis_vector
;
4582 it
->dpend
= default_invis_vector
+ 3;
4585 it
->dpvec_char_len
= len
;
4586 it
->current
.dpvec_index
= 0;
4587 it
->dpvec_face_id
= -1;
4589 /* Use IT->saved_face_id for the ellipsis, so that it has the same
4590 face as the preceding text. IT->saved_face_id was set in
4591 handle_stop to the face of the preceding character, and will be
4592 different from IT->face_id only if the invisible text skipped in
4593 handle_invisible_prop has some non-default face on its first
4594 character. We thus ignore the face of the invisible text when we
4595 display the ellipsis. IT's face is restored in set_iterator_to_next. */
4596 if (it
->saved_face_id
>= 0)
4597 it
->face_id
= it
->saved_face_id
;
4599 /* If the ellipsis represents buffer text, it means we advanced in
4600 the buffer, so we should no longer ignore overlay strings. */
4601 if (it
->method
== GET_FROM_BUFFER
)
4602 it
->ignore_overlay_strings_at_pos_p
= false;
4604 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4605 it
->ellipsis_p
= true;
4610 /***********************************************************************
4612 ***********************************************************************/
4614 /* Set up iterator IT from `display' property at its current position.
4615 Called from handle_stop.
4616 We return HANDLED_RETURN if some part of the display property
4617 overrides the display of the buffer text itself.
4618 Otherwise we return HANDLED_NORMALLY. */
4620 static enum prop_handled
4621 handle_display_prop (struct it
*it
)
4623 Lisp_Object propval
, object
, overlay
;
4624 struct text_pos
*position
;
4626 /* Nonzero if some property replaces the display of the text itself. */
4627 int display_replaced
= 0;
4629 if (STRINGP (it
->string
))
4631 object
= it
->string
;
4632 position
= &it
->current
.string_pos
;
4633 bufpos
= CHARPOS (it
->current
.pos
);
4637 XSETWINDOW (object
, it
->w
);
4638 position
= &it
->current
.pos
;
4639 bufpos
= CHARPOS (*position
);
4642 /* Reset those iterator values set from display property values. */
4643 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4644 it
->space_width
= Qnil
;
4645 it
->font_height
= Qnil
;
4648 /* We don't support recursive `display' properties, i.e. string
4649 values that have a string `display' property, that have a string
4650 `display' property etc. */
4651 if (!it
->string_from_display_prop_p
)
4652 it
->area
= TEXT_AREA
;
4654 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4655 Qdisplay
, object
, &overlay
);
4657 return HANDLED_NORMALLY
;
4658 /* Now OVERLAY is the overlay that gave us this property, or nil
4659 if it was a text property. */
4661 if (!STRINGP (it
->string
))
4662 object
= it
->w
->contents
;
4664 display_replaced
= handle_display_spec (it
, propval
, object
, overlay
,
4666 FRAME_WINDOW_P (it
->f
));
4667 return display_replaced
!= 0 ? HANDLED_RETURN
: HANDLED_NORMALLY
;
4670 /* Subroutine of handle_display_prop. Returns non-zero if the display
4671 specification in SPEC is a replacing specification, i.e. it would
4672 replace the text covered by `display' property with something else,
4673 such as an image or a display string. If SPEC includes any kind or
4674 `(space ...) specification, the value is 2; this is used by
4675 compute_display_string_pos, which see.
4677 See handle_single_display_spec for documentation of arguments.
4678 FRAME_WINDOW_P is true if the window being redisplayed is on a
4679 GUI frame; this argument is used only if IT is NULL, see below.
4681 IT can be NULL, if this is called by the bidi reordering code
4682 through compute_display_string_pos, which see. In that case, this
4683 function only examines SPEC, but does not otherwise "handle" it, in
4684 the sense that it doesn't set up members of IT from the display
4687 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4688 Lisp_Object overlay
, struct text_pos
*position
,
4689 ptrdiff_t bufpos
, bool frame_window_p
)
4694 /* Simple specifications. */
4695 && !EQ (XCAR (spec
), Qimage
)
4696 #ifdef HAVE_XWIDGETS
4697 && !EQ (XCAR (spec
), Qxwidget
)
4699 && !EQ (XCAR (spec
), Qspace
)
4700 && !EQ (XCAR (spec
), Qwhen
)
4701 && !EQ (XCAR (spec
), Qslice
)
4702 && !EQ (XCAR (spec
), Qspace_width
)
4703 && !EQ (XCAR (spec
), Qheight
)
4704 && !EQ (XCAR (spec
), Qraise
)
4705 /* Marginal area specifications. */
4706 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4707 && !EQ (XCAR (spec
), Qleft_fringe
)
4708 && !EQ (XCAR (spec
), Qright_fringe
)
4709 && !NILP (XCAR (spec
)))
4711 for (; CONSP (spec
); spec
= XCDR (spec
))
4713 int rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4714 overlay
, position
, bufpos
,
4715 replacing
, frame_window_p
);
4719 /* If some text in a string is replaced, `position' no
4720 longer points to the position of `object'. */
4721 if (!it
|| STRINGP (object
))
4726 else if (VECTORP (spec
))
4729 for (i
= 0; i
< ASIZE (spec
); ++i
)
4731 int rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4732 overlay
, position
, bufpos
,
4733 replacing
, frame_window_p
);
4737 /* If some text in a string is replaced, `position' no
4738 longer points to the position of `object'. */
4739 if (!it
|| STRINGP (object
))
4745 replacing
= handle_single_display_spec (it
, spec
, object
, overlay
, position
,
4746 bufpos
, 0, frame_window_p
);
4750 /* Value is the position of the end of the `display' property starting
4751 at START_POS in OBJECT. */
4753 static struct text_pos
4754 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4757 struct text_pos end_pos
;
4759 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4760 Qdisplay
, object
, Qnil
);
4761 CHARPOS (end_pos
) = XFASTINT (end
);
4762 if (STRINGP (object
))
4763 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4765 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4771 /* Set up IT from a single `display' property specification SPEC. OBJECT
4772 is the object in which the `display' property was found. *POSITION
4773 is the position in OBJECT at which the `display' property was found.
4774 BUFPOS is the buffer position of OBJECT (different from POSITION if
4775 OBJECT is not a buffer). DISPLAY_REPLACED non-zero means that we
4776 previously saw a display specification which already replaced text
4777 display with something else, for example an image; we ignore such
4778 properties after the first one has been processed.
4780 OVERLAY is the overlay this `display' property came from,
4781 or nil if it was a text property.
4783 If SPEC is a `space' or `image' specification, and in some other
4784 cases too, set *POSITION to the position where the `display'
4787 If IT is NULL, only examine the property specification in SPEC, but
4788 don't set up IT. In that case, FRAME_WINDOW_P means SPEC
4789 is intended to be displayed in a window on a GUI frame.
4791 Value is non-zero if something was found which replaces the display
4792 of buffer or string text. */
4795 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4796 Lisp_Object overlay
, struct text_pos
*position
,
4797 ptrdiff_t bufpos
, int display_replaced
,
4798 bool frame_window_p
)
4801 Lisp_Object location
, value
;
4802 struct text_pos start_pos
= *position
;
4804 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4805 If the result is non-nil, use VALUE instead of SPEC. */
4807 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4816 if (!NILP (form
) && !EQ (form
, Qt
))
4818 ptrdiff_t count
= SPECPDL_INDEX ();
4820 /* Bind `object' to the object having the `display' property, a
4821 buffer or string. Bind `position' to the position in the
4822 object where the property was found, and `buffer-position'
4823 to the current position in the buffer. */
4826 XSETBUFFER (object
, current_buffer
);
4827 specbind (Qobject
, object
);
4828 specbind (Qposition
, make_number (CHARPOS (*position
)));
4829 specbind (Qbuffer_position
, make_number (bufpos
));
4830 form
= safe_eval (form
);
4831 unbind_to (count
, Qnil
);
4837 /* Handle `(height HEIGHT)' specifications. */
4839 && EQ (XCAR (spec
), Qheight
)
4840 && CONSP (XCDR (spec
)))
4844 if (!FRAME_WINDOW_P (it
->f
))
4847 it
->font_height
= XCAR (XCDR (spec
));
4848 if (!NILP (it
->font_height
))
4850 int new_height
= -1;
4852 if (CONSP (it
->font_height
)
4853 && (EQ (XCAR (it
->font_height
), Qplus
)
4854 || EQ (XCAR (it
->font_height
), Qminus
))
4855 && CONSP (XCDR (it
->font_height
))
4856 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4858 /* `(+ N)' or `(- N)' where N is an integer. */
4859 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4860 if (EQ (XCAR (it
->font_height
), Qplus
))
4862 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4864 else if (FUNCTIONP (it
->font_height
))
4866 /* Call function with current height as argument.
4867 Value is the new height. */
4868 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4870 height
= safe_call1 (it
->font_height
,
4871 face
->lface
[LFACE_HEIGHT_INDEX
]);
4872 if (NUMBERP (height
))
4873 new_height
= XFLOATINT (height
);
4875 else if (NUMBERP (it
->font_height
))
4877 /* Value is a multiple of the canonical char height. */
4880 f
= FACE_FROM_ID (it
->f
,
4881 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4882 new_height
= (XFLOATINT (it
->font_height
)
4883 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4887 /* Evaluate IT->font_height with `height' bound to the
4888 current specified height to get the new height. */
4889 ptrdiff_t count
= SPECPDL_INDEX ();
4890 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4892 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4893 value
= safe_eval (it
->font_height
);
4894 unbind_to (count
, Qnil
);
4896 if (NUMBERP (value
))
4897 new_height
= XFLOATINT (value
);
4901 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4908 /* Handle `(space-width WIDTH)'. */
4910 && EQ (XCAR (spec
), Qspace_width
)
4911 && CONSP (XCDR (spec
)))
4915 if (!FRAME_WINDOW_P (it
->f
))
4918 value
= XCAR (XCDR (spec
));
4919 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4920 it
->space_width
= value
;
4926 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4928 && EQ (XCAR (spec
), Qslice
))
4934 if (!FRAME_WINDOW_P (it
->f
))
4937 if (tem
= XCDR (spec
), CONSP (tem
))
4939 it
->slice
.x
= XCAR (tem
);
4940 if (tem
= XCDR (tem
), CONSP (tem
))
4942 it
->slice
.y
= XCAR (tem
);
4943 if (tem
= XCDR (tem
), CONSP (tem
))
4945 it
->slice
.width
= XCAR (tem
);
4946 if (tem
= XCDR (tem
), CONSP (tem
))
4947 it
->slice
.height
= XCAR (tem
);
4956 /* Handle `(raise FACTOR)'. */
4958 && EQ (XCAR (spec
), Qraise
)
4959 && CONSP (XCDR (spec
)))
4963 if (!FRAME_WINDOW_P (it
->f
))
4966 #ifdef HAVE_WINDOW_SYSTEM
4967 value
= XCAR (XCDR (spec
));
4968 if (NUMBERP (value
))
4970 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4971 it
->voffset
= - (XFLOATINT (value
)
4972 * (normal_char_height (face
->font
, -1)));
4974 #endif /* HAVE_WINDOW_SYSTEM */
4980 /* Don't handle the other kinds of display specifications
4981 inside a string that we got from a `display' property. */
4982 if (it
&& it
->string_from_display_prop_p
)
4985 /* Characters having this form of property are not displayed, so
4986 we have to find the end of the property. */
4989 start_pos
= *position
;
4990 *position
= display_prop_end (it
, object
, start_pos
);
4991 /* If the display property comes from an overlay, don't consider
4992 any potential stop_charpos values before the end of that
4993 overlay. Since display_prop_end will happily find another
4994 'display' property coming from some other overlay or text
4995 property on buffer positions before this overlay's end, we
4996 need to ignore them, or else we risk displaying this
4997 overlay's display string/image twice. */
4998 if (!NILP (overlay
))
5000 ptrdiff_t ovendpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5002 if (ovendpos
> CHARPOS (*position
))
5003 SET_TEXT_POS (*position
, ovendpos
, CHAR_TO_BYTE (ovendpos
));
5008 /* Stop the scan at that end position--we assume that all
5009 text properties change there. */
5011 it
->stop_charpos
= position
->charpos
;
5013 /* Handle `(left-fringe BITMAP [FACE])'
5014 and `(right-fringe BITMAP [FACE])'. */
5016 && (EQ (XCAR (spec
), Qleft_fringe
)
5017 || EQ (XCAR (spec
), Qright_fringe
))
5018 && CONSP (XCDR (spec
)))
5022 if (!FRAME_WINDOW_P (it
->f
))
5023 /* If we return here, POSITION has been advanced
5024 across the text with this property. */
5026 /* Synchronize the bidi iterator with POSITION. This is
5027 needed because we are not going to push the iterator
5028 on behalf of this display property, so there will be
5029 no pop_it call to do this synchronization for us. */
5032 it
->position
= *position
;
5033 iterate_out_of_display_property (it
);
5034 *position
= it
->position
;
5039 else if (!frame_window_p
)
5042 #ifdef HAVE_WINDOW_SYSTEM
5045 value
= XCAR (XCDR (spec
));
5046 if (!SYMBOLP (value
)
5047 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
5048 /* If we return here, POSITION has been advanced
5049 across the text with this property. */
5051 if (it
&& it
->bidi_p
)
5053 it
->position
= *position
;
5054 iterate_out_of_display_property (it
);
5055 *position
= it
->position
;
5062 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
5064 if (CONSP (XCDR (XCDR (spec
))))
5066 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
5067 int face_id2
= lookup_derived_face (it
->f
, face_name
,
5068 FRINGE_FACE_ID
, false);
5073 /* Save current settings of IT so that we can restore them
5074 when we are finished with the glyph property value. */
5075 push_it (it
, position
);
5077 it
->area
= TEXT_AREA
;
5078 it
->what
= IT_IMAGE
;
5079 it
->image_id
= -1; /* no image */
5080 it
->position
= start_pos
;
5081 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5082 it
->method
= GET_FROM_IMAGE
;
5083 it
->from_overlay
= Qnil
;
5084 it
->face_id
= face_id
;
5085 it
->from_disp_prop_p
= true;
5087 /* Say that we haven't consumed the characters with
5088 `display' property yet. The call to pop_it in
5089 set_iterator_to_next will clean this up. */
5090 *position
= start_pos
;
5092 if (EQ (XCAR (spec
), Qleft_fringe
))
5094 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5095 it
->left_user_fringe_face_id
= face_id
;
5099 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5100 it
->right_user_fringe_face_id
= face_id
;
5103 #endif /* HAVE_WINDOW_SYSTEM */
5107 /* Prepare to handle `((margin left-margin) ...)',
5108 `((margin right-margin) ...)' and `((margin nil) ...)'
5109 prefixes for display specifications. */
5110 location
= Qunbound
;
5111 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5115 value
= XCDR (spec
);
5117 value
= XCAR (value
);
5120 if (EQ (XCAR (tem
), Qmargin
)
5121 && (tem
= XCDR (tem
),
5122 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5124 || EQ (tem
, Qleft_margin
)
5125 || EQ (tem
, Qright_margin
))))
5129 if (EQ (location
, Qunbound
))
5135 /* After this point, VALUE is the property after any
5136 margin prefix has been stripped. It must be a string,
5137 an image specification, or `(space ...)'.
5139 LOCATION specifies where to display: `left-margin',
5140 `right-margin' or nil. */
5142 bool valid_p
= (STRINGP (value
)
5143 #ifdef HAVE_WINDOW_SYSTEM
5144 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5145 && valid_image_p (value
))
5146 #endif /* not HAVE_WINDOW_SYSTEM */
5147 || (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5148 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5149 && valid_xwidget_spec_p (value
)));
5151 if (valid_p
&& display_replaced
== 0)
5157 /* Callers need to know whether the display spec is any kind
5158 of `(space ...)' spec that is about to affect text-area
5160 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5165 /* Save current settings of IT so that we can restore them
5166 when we are finished with the glyph property value. */
5167 push_it (it
, position
);
5168 it
->from_overlay
= overlay
;
5169 it
->from_disp_prop_p
= true;
5171 if (NILP (location
))
5172 it
->area
= TEXT_AREA
;
5173 else if (EQ (location
, Qleft_margin
))
5174 it
->area
= LEFT_MARGIN_AREA
;
5176 it
->area
= RIGHT_MARGIN_AREA
;
5178 if (STRINGP (value
))
5181 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5182 it
->current
.overlay_string_index
= -1;
5183 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5184 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5185 it
->method
= GET_FROM_STRING
;
5186 it
->stop_charpos
= 0;
5188 it
->base_level_stop
= 0;
5189 it
->string_from_display_prop_p
= true;
5190 /* Say that we haven't consumed the characters with
5191 `display' property yet. The call to pop_it in
5192 set_iterator_to_next will clean this up. */
5193 if (BUFFERP (object
))
5194 *position
= start_pos
;
5196 /* Force paragraph direction to be that of the parent
5197 object. If the parent object's paragraph direction is
5198 not yet determined, default to L2R. */
5199 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5200 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5202 it
->paragraph_embedding
= L2R
;
5204 /* Set up the bidi iterator for this display string. */
5207 it
->bidi_it
.string
.lstring
= it
->string
;
5208 it
->bidi_it
.string
.s
= NULL
;
5209 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5210 it
->bidi_it
.string
.bufpos
= bufpos
;
5211 it
->bidi_it
.string
.from_disp_str
= true;
5212 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5213 it
->bidi_it
.w
= it
->w
;
5214 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5217 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5219 it
->method
= GET_FROM_STRETCH
;
5221 *position
= it
->position
= start_pos
;
5222 retval
= 1 + (it
->area
== TEXT_AREA
);
5224 else if (valid_xwidget_spec_p (value
))
5226 it
->what
= IT_XWIDGET
;
5227 it
->method
= GET_FROM_XWIDGET
;
5228 it
->position
= start_pos
;
5229 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5230 *position
= start_pos
;
5231 it
->xwidget
= lookup_xwidget (value
);
5233 #ifdef HAVE_WINDOW_SYSTEM
5236 it
->what
= IT_IMAGE
;
5237 it
->image_id
= lookup_image (it
->f
, value
);
5238 it
->position
= start_pos
;
5239 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5240 it
->method
= GET_FROM_IMAGE
;
5242 /* Say that we haven't consumed the characters with
5243 `display' property yet. The call to pop_it in
5244 set_iterator_to_next will clean this up. */
5245 *position
= start_pos
;
5247 #endif /* HAVE_WINDOW_SYSTEM */
5252 /* Invalid property or property not supported. Restore
5253 POSITION to what it was before. */
5254 *position
= start_pos
;
5258 /* Check if PROP is a display property value whose text should be
5259 treated as intangible. OVERLAY is the overlay from which PROP
5260 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5261 specify the buffer position covered by PROP. */
5264 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5265 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5267 bool frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5268 struct text_pos position
;
5270 SET_TEXT_POS (position
, charpos
, bytepos
);
5271 return (handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5272 &position
, charpos
, frame_window_p
)
5277 /* Return true if PROP is a display sub-property value containing STRING.
5279 Implementation note: this and the following function are really
5280 special cases of handle_display_spec and
5281 handle_single_display_spec, and should ideally use the same code.
5282 Until they do, these two pairs must be consistent and must be
5283 modified in sync. */
5286 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5288 if (EQ (string
, prop
))
5291 /* Skip over `when FORM'. */
5292 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5297 /* Actually, the condition following `when' should be eval'ed,
5298 like handle_single_display_spec does, and we should return
5299 false if it evaluates to nil. However, this function is
5300 called only when the buffer was already displayed and some
5301 glyph in the glyph matrix was found to come from a display
5302 string. Therefore, the condition was already evaluated, and
5303 the result was non-nil, otherwise the display string wouldn't
5304 have been displayed and we would have never been called for
5305 this property. Thus, we can skip the evaluation and assume
5306 its result is non-nil. */
5311 /* Skip over `margin LOCATION'. */
5312 if (EQ (XCAR (prop
), Qmargin
))
5323 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5327 /* Return true if STRING appears in the `display' property PROP. */
5330 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5333 && !EQ (XCAR (prop
), Qwhen
)
5334 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5336 /* A list of sub-properties. */
5337 while (CONSP (prop
))
5339 if (single_display_spec_string_p (XCAR (prop
), string
))
5344 else if (VECTORP (prop
))
5346 /* A vector of sub-properties. */
5348 for (i
= 0; i
< ASIZE (prop
); ++i
)
5349 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5353 return single_display_spec_string_p (prop
, string
);
5358 /* Look for STRING in overlays and text properties in the current
5359 buffer, between character positions FROM and TO (excluding TO).
5360 BACK_P means look back (in this case, TO is supposed to be
5362 Value is the first character position where STRING was found, or
5363 zero if it wasn't found before hitting TO.
5365 This function may only use code that doesn't eval because it is
5366 called asynchronously from note_mouse_highlight. */
5369 string_buffer_position_lim (Lisp_Object string
,
5370 ptrdiff_t from
, ptrdiff_t to
, bool back_p
)
5372 Lisp_Object limit
, prop
, pos
;
5375 pos
= make_number (max (from
, BEGV
));
5377 if (!back_p
) /* looking forward */
5379 limit
= make_number (min (to
, ZV
));
5380 while (!found
&& !EQ (pos
, limit
))
5382 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5383 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5386 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5390 else /* looking back */
5392 limit
= make_number (max (to
, BEGV
));
5393 while (!found
&& !EQ (pos
, limit
))
5395 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5396 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5399 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5404 return found
? XINT (pos
) : 0;
5407 /* Determine which buffer position in current buffer STRING comes from.
5408 AROUND_CHARPOS is an approximate position where it could come from.
5409 Value is the buffer position or 0 if it couldn't be determined.
5411 This function is necessary because we don't record buffer positions
5412 in glyphs generated from strings (to keep struct glyph small).
5413 This function may only use code that doesn't eval because it is
5414 called asynchronously from note_mouse_highlight. */
5417 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5419 const int MAX_DISTANCE
= 1000;
5420 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5421 around_charpos
+ MAX_DISTANCE
,
5425 found
= string_buffer_position_lim (string
, around_charpos
,
5426 around_charpos
- MAX_DISTANCE
, true);
5432 /***********************************************************************
5433 `composition' property
5434 ***********************************************************************/
5436 /* Set up iterator IT from `composition' property at its current
5437 position. Called from handle_stop. */
5439 static enum prop_handled
5440 handle_composition_prop (struct it
*it
)
5442 Lisp_Object prop
, string
;
5443 ptrdiff_t pos
, pos_byte
, start
, end
;
5445 if (STRINGP (it
->string
))
5449 pos
= IT_STRING_CHARPOS (*it
);
5450 pos_byte
= IT_STRING_BYTEPOS (*it
);
5451 string
= it
->string
;
5452 s
= SDATA (string
) + pos_byte
;
5453 it
->c
= STRING_CHAR (s
);
5457 pos
= IT_CHARPOS (*it
);
5458 pos_byte
= IT_BYTEPOS (*it
);
5460 it
->c
= FETCH_CHAR (pos_byte
);
5463 /* If there's a valid composition and point is not inside of the
5464 composition (in the case that the composition is from the current
5465 buffer), draw a glyph composed from the composition components. */
5466 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5467 && composition_valid_p (start
, end
, prop
)
5468 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5471 /* As we can't handle this situation (perhaps font-lock added
5472 a new composition), we just return here hoping that next
5473 redisplay will detect this composition much earlier. */
5474 return HANDLED_NORMALLY
;
5477 if (STRINGP (it
->string
))
5478 pos_byte
= string_char_to_byte (it
->string
, start
);
5480 pos_byte
= CHAR_TO_BYTE (start
);
5482 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5485 if (it
->cmp_it
.id
>= 0)
5488 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5489 it
->cmp_it
.nglyphs
= -1;
5493 return HANDLED_NORMALLY
;
5498 /***********************************************************************
5500 ***********************************************************************/
5502 /* The following structure is used to record overlay strings for
5503 later sorting in load_overlay_strings. */
5505 struct overlay_entry
5507 Lisp_Object overlay
;
5510 bool after_string_p
;
5514 /* Set up iterator IT from overlay strings at its current position.
5515 Called from handle_stop. */
5517 static enum prop_handled
5518 handle_overlay_change (struct it
*it
)
5520 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5521 return HANDLED_RECOMPUTE_PROPS
;
5523 return HANDLED_NORMALLY
;
5527 /* Set up the next overlay string for delivery by IT, if there is an
5528 overlay string to deliver. Called by set_iterator_to_next when the
5529 end of the current overlay string is reached. If there are more
5530 overlay strings to display, IT->string and
5531 IT->current.overlay_string_index are set appropriately here.
5532 Otherwise IT->string is set to nil. */
5535 next_overlay_string (struct it
*it
)
5537 ++it
->current
.overlay_string_index
;
5538 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5540 /* No more overlay strings. Restore IT's settings to what
5541 they were before overlay strings were processed, and
5542 continue to deliver from current_buffer. */
5544 it
->ellipsis_p
= it
->stack
[it
->sp
- 1].display_ellipsis_p
;
5547 || (NILP (it
->string
)
5548 && it
->method
== GET_FROM_BUFFER
5549 && it
->stop_charpos
>= BEGV
5550 && it
->stop_charpos
<= it
->end_charpos
));
5551 it
->current
.overlay_string_index
= -1;
5552 it
->n_overlay_strings
= 0;
5553 /* If there's an empty display string on the stack, pop the
5554 stack, to resync the bidi iterator with IT's position. Such
5555 empty strings are pushed onto the stack in
5556 get_overlay_strings_1. */
5557 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5560 /* Since we've exhausted overlay strings at this buffer
5561 position, set the flag to ignore overlays until we move to
5562 another position. The flag is reset in
5563 next_element_from_buffer. */
5564 it
->ignore_overlay_strings_at_pos_p
= true;
5566 /* If we're at the end of the buffer, record that we have
5567 processed the overlay strings there already, so that
5568 next_element_from_buffer doesn't try it again. */
5569 if (NILP (it
->string
)
5570 && IT_CHARPOS (*it
) >= it
->end_charpos
5571 && it
->overlay_strings_charpos
>= it
->end_charpos
)
5572 it
->overlay_strings_at_end_processed_p
= true;
5573 /* Note: we reset overlay_strings_charpos only here, to make
5574 sure the just-processed overlays were indeed at EOB.
5575 Otherwise, overlays on text with invisible text property,
5576 which are processed with IT's position past the invisible
5577 text, might fool us into thinking the overlays at EOB were
5578 already processed (linum-mode can cause this, for
5580 it
->overlay_strings_charpos
= -1;
5584 /* There are more overlay strings to process. If
5585 IT->current.overlay_string_index has advanced to a position
5586 where we must load IT->overlay_strings with more strings, do
5587 it. We must load at the IT->overlay_strings_charpos where
5588 IT->n_overlay_strings was originally computed; when invisible
5589 text is present, this might not be IT_CHARPOS (Bug#7016). */
5590 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5592 if (it
->current
.overlay_string_index
&& i
== 0)
5593 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5595 /* Initialize IT to deliver display elements from the overlay
5597 it
->string
= it
->overlay_strings
[i
];
5598 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5599 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5600 it
->method
= GET_FROM_STRING
;
5601 it
->stop_charpos
= 0;
5602 it
->end_charpos
= SCHARS (it
->string
);
5603 if (it
->cmp_it
.stop_pos
>= 0)
5604 it
->cmp_it
.stop_pos
= 0;
5606 it
->base_level_stop
= 0;
5608 /* Set up the bidi iterator for this overlay string. */
5611 it
->bidi_it
.string
.lstring
= it
->string
;
5612 it
->bidi_it
.string
.s
= NULL
;
5613 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5614 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5615 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5616 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5617 it
->bidi_it
.w
= it
->w
;
5618 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5626 /* Compare two overlay_entry structures E1 and E2. Used as a
5627 comparison function for qsort in load_overlay_strings. Overlay
5628 strings for the same position are sorted so that
5630 1. All after-strings come in front of before-strings, except
5631 when they come from the same overlay.
5633 2. Within after-strings, strings are sorted so that overlay strings
5634 from overlays with higher priorities come first.
5636 2. Within before-strings, strings are sorted so that overlay
5637 strings from overlays with higher priorities come last.
5639 Value is analogous to strcmp. */
5643 compare_overlay_entries (const void *e1
, const void *e2
)
5645 struct overlay_entry
const *entry1
= e1
;
5646 struct overlay_entry
const *entry2
= e2
;
5649 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5651 /* Let after-strings appear in front of before-strings if
5652 they come from different overlays. */
5653 if (EQ (entry1
->overlay
, entry2
->overlay
))
5654 result
= entry1
->after_string_p
? 1 : -1;
5656 result
= entry1
->after_string_p
? -1 : 1;
5658 else if (entry1
->priority
!= entry2
->priority
)
5660 if (entry1
->after_string_p
)
5661 /* After-strings sorted in order of decreasing priority. */
5662 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5664 /* Before-strings sorted in order of increasing priority. */
5665 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5674 /* Load the vector IT->overlay_strings with overlay strings from IT's
5675 current buffer position, or from CHARPOS if that is > 0. Set
5676 IT->n_overlays to the total number of overlay strings found.
5678 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5679 a time. On entry into load_overlay_strings,
5680 IT->current.overlay_string_index gives the number of overlay
5681 strings that have already been loaded by previous calls to this
5684 IT->add_overlay_start contains an additional overlay start
5685 position to consider for taking overlay strings from, if non-zero.
5686 This position comes into play when the overlay has an `invisible'
5687 property, and both before and after-strings. When we've skipped to
5688 the end of the overlay, because of its `invisible' property, we
5689 nevertheless want its before-string to appear.
5690 IT->add_overlay_start will contain the overlay start position
5693 Overlay strings are sorted so that after-string strings come in
5694 front of before-string strings. Within before and after-strings,
5695 strings are sorted by overlay priority. See also function
5696 compare_overlay_entries. */
5699 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5701 Lisp_Object overlay
, window
, str
, invisible
;
5702 struct Lisp_Overlay
*ov
;
5703 ptrdiff_t start
, end
;
5704 ptrdiff_t n
= 0, i
, j
;
5706 struct overlay_entry entriesbuf
[20];
5707 ptrdiff_t size
= ARRAYELTS (entriesbuf
);
5708 struct overlay_entry
*entries
= entriesbuf
;
5712 charpos
= IT_CHARPOS (*it
);
5714 /* Append the overlay string STRING of overlay OVERLAY to vector
5715 `entries' which has size `size' and currently contains `n'
5716 elements. AFTER_P means STRING is an after-string of
5718 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5721 Lisp_Object priority; \
5725 struct overlay_entry *old = entries; \
5726 SAFE_NALLOCA (entries, 2, size); \
5727 memcpy (entries, old, size * sizeof *entries); \
5731 entries[n].string = (STRING); \
5732 entries[n].overlay = (OVERLAY); \
5733 priority = Foverlay_get ((OVERLAY), Qpriority); \
5734 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5735 entries[n].after_string_p = (AFTER_P); \
5740 /* Process overlay before the overlay center. */
5741 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5743 XSETMISC (overlay
, ov
);
5744 eassert (OVERLAYP (overlay
));
5745 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5746 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5751 /* Skip this overlay if it doesn't start or end at IT's current
5753 if (end
!= charpos
&& start
!= charpos
)
5756 /* Skip this overlay if it doesn't apply to IT->w. */
5757 window
= Foverlay_get (overlay
, Qwindow
);
5758 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5761 /* If the text ``under'' the overlay is invisible, both before-
5762 and after-strings from this overlay are visible; start and
5763 end position are indistinguishable. */
5764 invisible
= Foverlay_get (overlay
, Qinvisible
);
5765 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5767 /* If overlay has a non-empty before-string, record it. */
5768 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5769 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5771 RECORD_OVERLAY_STRING (overlay
, str
, false);
5773 /* If overlay has a non-empty after-string, record it. */
5774 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5775 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5777 RECORD_OVERLAY_STRING (overlay
, str
, true);
5780 /* Process overlays after the overlay center. */
5781 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5783 XSETMISC (overlay
, ov
);
5784 eassert (OVERLAYP (overlay
));
5785 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5786 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5788 if (start
> charpos
)
5791 /* Skip this overlay if it doesn't start or end at IT's current
5793 if (end
!= charpos
&& start
!= charpos
)
5796 /* Skip this overlay if it doesn't apply to IT->w. */
5797 window
= Foverlay_get (overlay
, Qwindow
);
5798 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5801 /* If the text ``under'' the overlay is invisible, it has a zero
5802 dimension, and both before- and after-strings apply. */
5803 invisible
= Foverlay_get (overlay
, Qinvisible
);
5804 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5806 /* If overlay has a non-empty before-string, record it. */
5807 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5808 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5810 RECORD_OVERLAY_STRING (overlay
, str
, false);
5812 /* If overlay has a non-empty after-string, record it. */
5813 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5814 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5816 RECORD_OVERLAY_STRING (overlay
, str
, true);
5819 #undef RECORD_OVERLAY_STRING
5823 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5825 /* Record number of overlay strings, and where we computed it. */
5826 it
->n_overlay_strings
= n
;
5827 it
->overlay_strings_charpos
= charpos
;
5829 /* IT->current.overlay_string_index is the number of overlay strings
5830 that have already been consumed by IT. Copy some of the
5831 remaining overlay strings to IT->overlay_strings. */
5833 j
= it
->current
.overlay_string_index
;
5834 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5836 it
->overlay_strings
[i
] = entries
[j
].string
;
5837 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5845 /* Get the first chunk of overlay strings at IT's current buffer
5846 position, or at CHARPOS if that is > 0. Value is true if at
5847 least one overlay string was found. */
5850 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, bool compute_stop_p
)
5852 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5853 process. This fills IT->overlay_strings with strings, and sets
5854 IT->n_overlay_strings to the total number of strings to process.
5855 IT->pos.overlay_string_index has to be set temporarily to zero
5856 because load_overlay_strings needs this; it must be set to -1
5857 when no overlay strings are found because a zero value would
5858 indicate a position in the first overlay string. */
5859 it
->current
.overlay_string_index
= 0;
5860 load_overlay_strings (it
, charpos
);
5862 /* If we found overlay strings, set up IT to deliver display
5863 elements from the first one. Otherwise set up IT to deliver
5864 from current_buffer. */
5865 if (it
->n_overlay_strings
)
5867 /* Make sure we know settings in current_buffer, so that we can
5868 restore meaningful values when we're done with the overlay
5871 compute_stop_pos (it
);
5872 eassert (it
->face_id
>= 0);
5874 /* Save IT's settings. They are restored after all overlay
5875 strings have been processed. */
5876 eassert (!compute_stop_p
|| it
->sp
== 0);
5878 /* When called from handle_stop, there might be an empty display
5879 string loaded. In that case, don't bother saving it. But
5880 don't use this optimization with the bidi iterator, since we
5881 need the corresponding pop_it call to resync the bidi
5882 iterator's position with IT's position, after we are done
5883 with the overlay strings. (The corresponding call to pop_it
5884 in case of an empty display string is in
5885 next_overlay_string.) */
5887 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5890 /* Set up IT to deliver display elements from the first overlay
5892 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5893 it
->string
= it
->overlay_strings
[0];
5894 it
->from_overlay
= Qnil
;
5895 it
->stop_charpos
= 0;
5896 eassert (STRINGP (it
->string
));
5897 it
->end_charpos
= SCHARS (it
->string
);
5899 it
->base_level_stop
= 0;
5900 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5901 it
->method
= GET_FROM_STRING
;
5902 it
->from_disp_prop_p
= 0;
5904 /* Force paragraph direction to be that of the parent
5906 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5907 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5909 it
->paragraph_embedding
= L2R
;
5911 /* Set up the bidi iterator for this overlay string. */
5914 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5916 it
->bidi_it
.string
.lstring
= it
->string
;
5917 it
->bidi_it
.string
.s
= NULL
;
5918 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5919 it
->bidi_it
.string
.bufpos
= pos
;
5920 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5921 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5922 it
->bidi_it
.w
= it
->w
;
5923 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5928 it
->current
.overlay_string_index
= -1;
5933 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5936 it
->method
= GET_FROM_BUFFER
;
5938 get_overlay_strings_1 (it
, charpos
, true);
5942 /* Value is true if we found at least one overlay string. */
5943 return STRINGP (it
->string
);
5948 /***********************************************************************
5949 Saving and restoring state
5950 ***********************************************************************/
5952 /* Save current settings of IT on IT->stack. Called, for example,
5953 before setting up IT for an overlay string, to be able to restore
5954 IT's settings to what they were after the overlay string has been
5955 processed. If POSITION is non-NULL, it is the position to save on
5956 the stack instead of IT->position. */
5959 push_it (struct it
*it
, struct text_pos
*position
)
5961 struct iterator_stack_entry
*p
;
5963 eassert (it
->sp
< IT_STACK_SIZE
);
5964 p
= it
->stack
+ it
->sp
;
5966 p
->stop_charpos
= it
->stop_charpos
;
5967 p
->prev_stop
= it
->prev_stop
;
5968 p
->base_level_stop
= it
->base_level_stop
;
5969 p
->cmp_it
= it
->cmp_it
;
5970 eassert (it
->face_id
>= 0);
5971 p
->face_id
= it
->face_id
;
5972 p
->string
= it
->string
;
5973 p
->method
= it
->method
;
5974 p
->from_overlay
= it
->from_overlay
;
5977 case GET_FROM_IMAGE
:
5978 p
->u
.image
.object
= it
->object
;
5979 p
->u
.image
.image_id
= it
->image_id
;
5980 p
->u
.image
.slice
= it
->slice
;
5982 case GET_FROM_STRETCH
:
5983 p
->u
.stretch
.object
= it
->object
;
5985 case GET_FROM_XWIDGET
:
5986 p
->u
.xwidget
.object
= it
->object
;
5988 case GET_FROM_BUFFER
:
5989 case GET_FROM_DISPLAY_VECTOR
:
5990 case GET_FROM_STRING
:
5991 case GET_FROM_C_STRING
:
5996 p
->position
= position
? *position
: it
->position
;
5997 p
->current
= it
->current
;
5998 p
->end_charpos
= it
->end_charpos
;
5999 p
->string_nchars
= it
->string_nchars
;
6001 p
->multibyte_p
= it
->multibyte_p
;
6002 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
6003 p
->space_width
= it
->space_width
;
6004 p
->font_height
= it
->font_height
;
6005 p
->voffset
= it
->voffset
;
6006 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
6007 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
6008 p
->display_ellipsis_p
= false;
6009 p
->line_wrap
= it
->line_wrap
;
6010 p
->bidi_p
= it
->bidi_p
;
6011 p
->paragraph_embedding
= it
->paragraph_embedding
;
6012 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
6015 /* Save the state of the bidi iterator as well. */
6017 bidi_push_it (&it
->bidi_it
);
6021 iterate_out_of_display_property (struct it
*it
)
6023 bool buffer_p
= !STRINGP (it
->string
);
6024 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
6025 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
6027 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
6029 /* Maybe initialize paragraph direction. If we are at the beginning
6030 of a new paragraph, next_element_from_buffer may not have a
6031 chance to do that. */
6032 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
6033 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
6034 /* prev_stop can be zero, so check against BEGV as well. */
6035 while (it
->bidi_it
.charpos
>= bob
6036 && it
->prev_stop
<= it
->bidi_it
.charpos
6037 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
6038 && it
->bidi_it
.charpos
< eob
)
6039 bidi_move_to_visually_next (&it
->bidi_it
);
6040 /* Record the stop_pos we just crossed, for when we cross it
6042 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
6043 it
->prev_stop
= CHARPOS (it
->position
);
6044 /* If we ended up not where pop_it put us, resync IT's
6045 positional members with the bidi iterator. */
6046 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
6047 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
6049 it
->current
.pos
= it
->position
;
6051 it
->current
.string_pos
= it
->position
;
6054 /* Restore IT's settings from IT->stack. Called, for example, when no
6055 more overlay strings must be processed, and we return to delivering
6056 display elements from a buffer, or when the end of a string from a
6057 `display' property is reached and we return to delivering display
6058 elements from an overlay string, or from a buffer. */
6061 pop_it (struct it
*it
)
6063 struct iterator_stack_entry
*p
;
6064 bool from_display_prop
= it
->from_disp_prop_p
;
6065 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
6067 eassert (it
->sp
> 0);
6069 p
= it
->stack
+ it
->sp
;
6070 it
->stop_charpos
= p
->stop_charpos
;
6071 it
->prev_stop
= p
->prev_stop
;
6072 it
->base_level_stop
= p
->base_level_stop
;
6073 it
->cmp_it
= p
->cmp_it
;
6074 it
->face_id
= p
->face_id
;
6075 it
->current
= p
->current
;
6076 it
->position
= p
->position
;
6077 it
->string
= p
->string
;
6078 it
->from_overlay
= p
->from_overlay
;
6079 if (NILP (it
->string
))
6080 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
6081 it
->method
= p
->method
;
6084 case GET_FROM_IMAGE
:
6085 it
->image_id
= p
->u
.image
.image_id
;
6086 it
->object
= p
->u
.image
.object
;
6087 it
->slice
= p
->u
.image
.slice
;
6089 case GET_FROM_XWIDGET
:
6090 it
->object
= p
->u
.xwidget
.object
;
6092 case GET_FROM_STRETCH
:
6093 it
->object
= p
->u
.stretch
.object
;
6095 case GET_FROM_BUFFER
:
6096 it
->object
= it
->w
->contents
;
6098 case GET_FROM_STRING
:
6100 struct face
*face
= FACE_OPT_FROM_ID (it
->f
, it
->face_id
);
6102 /* Restore the face_box_p flag, since it could have been
6103 overwritten by the face of the object that we just finished
6106 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6107 it
->object
= it
->string
;
6110 case GET_FROM_DISPLAY_VECTOR
:
6112 it
->method
= GET_FROM_C_STRING
;
6113 else if (STRINGP (it
->string
))
6114 it
->method
= GET_FROM_STRING
;
6117 it
->method
= GET_FROM_BUFFER
;
6118 it
->object
= it
->w
->contents
;
6121 case GET_FROM_C_STRING
:
6126 it
->end_charpos
= p
->end_charpos
;
6127 it
->string_nchars
= p
->string_nchars
;
6129 it
->multibyte_p
= p
->multibyte_p
;
6130 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6131 it
->space_width
= p
->space_width
;
6132 it
->font_height
= p
->font_height
;
6133 it
->voffset
= p
->voffset
;
6134 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6135 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6136 it
->line_wrap
= p
->line_wrap
;
6137 it
->bidi_p
= p
->bidi_p
;
6138 it
->paragraph_embedding
= p
->paragraph_embedding
;
6139 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6142 bidi_pop_it (&it
->bidi_it
);
6143 /* Bidi-iterate until we get out of the portion of text, if any,
6144 covered by a `display' text property or by an overlay with
6145 `display' property. (We cannot just jump there, because the
6146 internal coherency of the bidi iterator state can not be
6147 preserved across such jumps.) We also must determine the
6148 paragraph base direction if the overlay we just processed is
6149 at the beginning of a new paragraph. */
6150 if (from_display_prop
6151 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6152 iterate_out_of_display_property (it
);
6154 eassert ((BUFFERP (it
->object
)
6155 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6156 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6157 || (STRINGP (it
->object
)
6158 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6159 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6160 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6162 /* If we move the iterator over text covered by a display property
6163 to a new buffer position, any info about previously seen overlays
6164 is no longer valid. */
6165 if (from_display_prop
&& it
->sp
== 0 && CHARPOS (it
->position
) != prev_pos
)
6166 it
->ignore_overlay_strings_at_pos_p
= false;
6171 /***********************************************************************
6173 ***********************************************************************/
6175 /* Set IT's current position to the previous line start. */
6178 back_to_previous_line_start (struct it
*it
)
6180 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6183 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6187 /* Move IT to the next line start.
6189 Value is true if a newline was found. Set *SKIPPED_P to true if
6190 we skipped over part of the text (as opposed to moving the iterator
6191 continuously over the text). Otherwise, don't change the value
6194 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6195 iterator on the newline, if it was found.
6197 Newlines may come from buffer text, overlay strings, or strings
6198 displayed via the `display' property. That's the reason we can't
6199 simply use find_newline_no_quit.
6201 Note that this function may not skip over invisible text that is so
6202 because of text properties and immediately follows a newline. If
6203 it would, function reseat_at_next_visible_line_start, when called
6204 from set_iterator_to_next, would effectively make invisible
6205 characters following a newline part of the wrong glyph row, which
6206 leads to wrong cursor motion. */
6209 forward_to_next_line_start (struct it
*it
, bool *skipped_p
,
6210 struct bidi_it
*bidi_it_prev
)
6212 ptrdiff_t old_selective
;
6213 bool newline_found_p
= false;
6215 const int MAX_NEWLINE_DISTANCE
= 500;
6217 /* If already on a newline, just consume it to avoid unintended
6218 skipping over invisible text below. */
6219 if (it
->what
== IT_CHARACTER
6221 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6223 if (it
->bidi_p
&& bidi_it_prev
)
6224 *bidi_it_prev
= it
->bidi_it
;
6225 set_iterator_to_next (it
, false);
6230 /* Don't handle selective display in the following. It's (a)
6231 unnecessary because it's done by the caller, and (b) leads to an
6232 infinite recursion because next_element_from_ellipsis indirectly
6233 calls this function. */
6234 old_selective
= it
->selective
;
6237 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6238 from buffer text. */
6240 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6241 n
+= !STRINGP (it
->string
))
6243 if (!get_next_display_element (it
))
6245 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6246 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6247 *bidi_it_prev
= it
->bidi_it
;
6248 set_iterator_to_next (it
, false);
6251 /* If we didn't find a newline near enough, see if we can use a
6253 if (!newline_found_p
)
6255 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6256 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6260 eassert (!STRINGP (it
->string
));
6262 /* If there isn't any `display' property in sight, and no
6263 overlays, we can just use the position of the newline in
6265 if (it
->stop_charpos
>= limit
6266 || ((pos
= Fnext_single_property_change (make_number (start
),
6268 make_number (limit
)),
6270 && next_overlay_change (start
) == ZV
))
6274 IT_CHARPOS (*it
) = limit
;
6275 IT_BYTEPOS (*it
) = bytepos
;
6279 struct bidi_it bprev
;
6281 /* Help bidi.c avoid expensive searches for display
6282 properties and overlays, by telling it that there are
6283 none up to `limit'. */
6284 if (it
->bidi_it
.disp_pos
< limit
)
6286 it
->bidi_it
.disp_pos
= limit
;
6287 it
->bidi_it
.disp_prop
= 0;
6290 bprev
= it
->bidi_it
;
6291 bidi_move_to_visually_next (&it
->bidi_it
);
6292 } while (it
->bidi_it
.charpos
!= limit
);
6293 IT_CHARPOS (*it
) = limit
;
6294 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6296 *bidi_it_prev
= bprev
;
6298 *skipped_p
= newline_found_p
= true;
6302 while (get_next_display_element (it
)
6303 && !newline_found_p
)
6305 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6306 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6307 *bidi_it_prev
= it
->bidi_it
;
6308 set_iterator_to_next (it
, false);
6313 it
->selective
= old_selective
;
6314 return newline_found_p
;
6318 /* Set IT's current position to the previous visible line start. Skip
6319 invisible text that is so either due to text properties or due to
6320 selective display. Caution: this does not change IT->current_x and
6324 back_to_previous_visible_line_start (struct it
*it
)
6326 while (IT_CHARPOS (*it
) > BEGV
)
6328 back_to_previous_line_start (it
);
6330 if (IT_CHARPOS (*it
) <= BEGV
)
6333 /* If selective > 0, then lines indented more than its value are
6335 if (it
->selective
> 0
6336 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6340 /* Check the newline before point for invisibility. */
6343 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6344 Qinvisible
, it
->window
);
6345 if (TEXT_PROP_MEANS_INVISIBLE (prop
) != 0)
6349 if (IT_CHARPOS (*it
) <= BEGV
)
6354 void *it2data
= NULL
;
6357 Lisp_Object val
, overlay
;
6359 SAVE_IT (it2
, *it
, it2data
);
6361 /* If newline is part of a composition, continue from start of composition */
6362 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6363 && beg
< IT_CHARPOS (*it
))
6366 /* If newline is replaced by a display property, find start of overlay
6367 or interval and continue search from that point. */
6368 pos
= --IT_CHARPOS (it2
);
6371 bidi_unshelve_cache (NULL
, false);
6372 it2
.string_from_display_prop_p
= false;
6373 it2
.from_disp_prop_p
= false;
6374 if (handle_display_prop (&it2
) == HANDLED_RETURN
6375 && !NILP (val
= get_char_property_and_overlay
6376 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6377 && (OVERLAYP (overlay
)
6378 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6379 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6381 RESTORE_IT (it
, it
, it2data
);
6385 /* Newline is not replaced by anything -- so we are done. */
6386 RESTORE_IT (it
, it
, it2data
);
6392 IT_CHARPOS (*it
) = beg
;
6393 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6397 it
->continuation_lines_width
= 0;
6399 eassert (IT_CHARPOS (*it
) >= BEGV
);
6400 eassert (IT_CHARPOS (*it
) == BEGV
6401 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6406 /* Reseat iterator IT at the previous visible line start. Skip
6407 invisible text that is so either due to text properties or due to
6408 selective display. At the end, update IT's overlay information,
6409 face information etc. */
6412 reseat_at_previous_visible_line_start (struct it
*it
)
6414 back_to_previous_visible_line_start (it
);
6415 reseat (it
, it
->current
.pos
, true);
6420 /* Reseat iterator IT on the next visible line start in the current
6421 buffer. ON_NEWLINE_P means position IT on the newline
6422 preceding the line start. Skip over invisible text that is so
6423 because of selective display. Compute faces, overlays etc at the
6424 new position. Note that this function does not skip over text that
6425 is invisible because of text properties. */
6428 reseat_at_next_visible_line_start (struct it
*it
, bool on_newline_p
)
6430 bool skipped_p
= false;
6431 struct bidi_it bidi_it_prev
;
6432 bool newline_found_p
6433 = forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6435 /* Skip over lines that are invisible because they are indented
6436 more than the value of IT->selective. */
6437 if (it
->selective
> 0)
6438 while (IT_CHARPOS (*it
) < ZV
6439 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6442 eassert (IT_BYTEPOS (*it
) == BEGV
6443 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6445 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6448 /* Position on the newline if that's what's requested. */
6449 if (on_newline_p
&& newline_found_p
)
6451 if (STRINGP (it
->string
))
6453 if (IT_STRING_CHARPOS (*it
) > 0)
6457 --IT_STRING_CHARPOS (*it
);
6458 --IT_STRING_BYTEPOS (*it
);
6462 /* We need to restore the bidi iterator to the state
6463 it had on the newline, and resync the IT's
6464 position with that. */
6465 it
->bidi_it
= bidi_it_prev
;
6466 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6467 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6471 else if (IT_CHARPOS (*it
) > BEGV
)
6480 /* We need to restore the bidi iterator to the state it
6481 had on the newline and resync IT with that. */
6482 it
->bidi_it
= bidi_it_prev
;
6483 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6484 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6486 reseat (it
, it
->current
.pos
, false);
6490 reseat (it
, it
->current
.pos
, false);
6497 /***********************************************************************
6498 Changing an iterator's position
6499 ***********************************************************************/
6501 /* Change IT's current position to POS in current_buffer.
6502 If FORCE_P, always check for text properties at the new position.
6503 Otherwise, text properties are only looked up if POS >=
6504 IT->check_charpos of a property. */
6507 reseat (struct it
*it
, struct text_pos pos
, bool force_p
)
6509 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6511 reseat_1 (it
, pos
, false);
6513 /* Determine where to check text properties. Avoid doing it
6514 where possible because text property lookup is very expensive. */
6516 || CHARPOS (pos
) > it
->stop_charpos
6517 || CHARPOS (pos
) < original_pos
)
6521 /* For bidi iteration, we need to prime prev_stop and
6522 base_level_stop with our best estimations. */
6523 /* Implementation note: Of course, POS is not necessarily a
6524 stop position, so assigning prev_pos to it is a lie; we
6525 should have called compute_stop_backwards. However, if
6526 the current buffer does not include any R2L characters,
6527 that call would be a waste of cycles, because the
6528 iterator will never move back, and thus never cross this
6529 "fake" stop position. So we delay that backward search
6530 until the time we really need it, in next_element_from_buffer. */
6531 if (CHARPOS (pos
) != it
->prev_stop
)
6532 it
->prev_stop
= CHARPOS (pos
);
6533 if (CHARPOS (pos
) < it
->base_level_stop
)
6534 it
->base_level_stop
= 0; /* meaning it's unknown */
6540 it
->prev_stop
= it
->base_level_stop
= 0;
6549 /* Change IT's buffer position to POS. SET_STOP_P means set
6550 IT->stop_pos to POS, also. */
6553 reseat_1 (struct it
*it
, struct text_pos pos
, bool set_stop_p
)
6555 /* Don't call this function when scanning a C string. */
6556 eassert (it
->s
== NULL
);
6558 /* POS must be a reasonable value. */
6559 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6561 it
->current
.pos
= it
->position
= pos
;
6562 it
->end_charpos
= ZV
;
6564 it
->current
.dpvec_index
= -1;
6565 it
->current
.overlay_string_index
= -1;
6566 IT_STRING_CHARPOS (*it
) = -1;
6567 IT_STRING_BYTEPOS (*it
) = -1;
6569 it
->method
= GET_FROM_BUFFER
;
6570 it
->object
= it
->w
->contents
;
6571 it
->area
= TEXT_AREA
;
6572 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6574 it
->string_from_display_prop_p
= false;
6575 it
->string_from_prefix_prop_p
= false;
6577 it
->from_disp_prop_p
= false;
6578 it
->face_before_selective_p
= false;
6581 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6583 bidi_unshelve_cache (NULL
, false);
6584 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6585 it
->bidi_it
.string
.s
= NULL
;
6586 it
->bidi_it
.string
.lstring
= Qnil
;
6587 it
->bidi_it
.string
.bufpos
= 0;
6588 it
->bidi_it
.string
.from_disp_str
= false;
6589 it
->bidi_it
.string
.unibyte
= false;
6590 it
->bidi_it
.w
= it
->w
;
6595 it
->stop_charpos
= CHARPOS (pos
);
6596 it
->base_level_stop
= CHARPOS (pos
);
6598 /* This make the information stored in it->cmp_it invalidate. */
6603 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6604 If S is non-null, it is a C string to iterate over. Otherwise,
6605 STRING gives a Lisp string to iterate over.
6607 If PRECISION > 0, don't return more then PRECISION number of
6608 characters from the string.
6610 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6611 characters have been returned. FIELD_WIDTH < 0 means an infinite
6614 MULTIBYTE = 0 means disable processing of multibyte characters,
6615 MULTIBYTE > 0 means enable it,
6616 MULTIBYTE < 0 means use IT->multibyte_p.
6618 IT must be initialized via a prior call to init_iterator before
6619 calling this function. */
6622 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6623 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6626 /* No text property checks performed by default, but see below. */
6627 it
->stop_charpos
= -1;
6629 /* Set iterator position and end position. */
6630 memset (&it
->current
, 0, sizeof it
->current
);
6631 it
->current
.overlay_string_index
= -1;
6632 it
->current
.dpvec_index
= -1;
6633 eassert (charpos
>= 0);
6635 /* If STRING is specified, use its multibyteness, otherwise use the
6636 setting of MULTIBYTE, if specified. */
6638 it
->multibyte_p
= multibyte
> 0;
6640 /* Bidirectional reordering of strings is controlled by the default
6641 value of bidi-display-reordering. Don't try to reorder while
6642 loading loadup.el, as the necessary character property tables are
6643 not yet available. */
6645 !redisplay__inhibit_bidi
6646 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6650 eassert (STRINGP (string
));
6651 it
->string
= string
;
6653 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6654 it
->method
= GET_FROM_STRING
;
6655 it
->current
.string_pos
= string_pos (charpos
, string
);
6659 it
->bidi_it
.string
.lstring
= string
;
6660 it
->bidi_it
.string
.s
= NULL
;
6661 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6662 it
->bidi_it
.string
.bufpos
= 0;
6663 it
->bidi_it
.string
.from_disp_str
= false;
6664 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6665 it
->bidi_it
.w
= it
->w
;
6666 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6667 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6672 it
->s
= (const unsigned char *) s
;
6675 /* Note that we use IT->current.pos, not it->current.string_pos,
6676 for displaying C strings. */
6677 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6678 if (it
->multibyte_p
)
6680 it
->current
.pos
= c_string_pos (charpos
, s
, true);
6681 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, true);
6685 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6686 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6691 it
->bidi_it
.string
.lstring
= Qnil
;
6692 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6693 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6694 it
->bidi_it
.string
.bufpos
= 0;
6695 it
->bidi_it
.string
.from_disp_str
= false;
6696 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6697 it
->bidi_it
.w
= it
->w
;
6698 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6701 it
->method
= GET_FROM_C_STRING
;
6704 /* PRECISION > 0 means don't return more than PRECISION characters
6706 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6708 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6710 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6713 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6714 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6715 FIELD_WIDTH < 0 means infinite field width. This is useful for
6716 padding with `-' at the end of a mode line. */
6717 if (field_width
< 0)
6718 field_width
= INFINITY
;
6719 /* Implementation note: We deliberately don't enlarge
6720 it->bidi_it.string.schars here to fit it->end_charpos, because
6721 the bidi iterator cannot produce characters out of thin air. */
6722 if (field_width
> it
->end_charpos
- charpos
)
6723 it
->end_charpos
= charpos
+ field_width
;
6725 /* Use the standard display table for displaying strings. */
6726 if (DISP_TABLE_P (Vstandard_display_table
))
6727 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6729 it
->stop_charpos
= charpos
;
6730 it
->prev_stop
= charpos
;
6731 it
->base_level_stop
= 0;
6734 it
->bidi_it
.first_elt
= true;
6735 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6736 it
->bidi_it
.disp_pos
= -1;
6738 if (s
== NULL
&& it
->multibyte_p
)
6740 ptrdiff_t endpos
= SCHARS (it
->string
);
6741 if (endpos
> it
->end_charpos
)
6742 endpos
= it
->end_charpos
;
6743 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6751 /***********************************************************************
6753 ***********************************************************************/
6755 /* Map enum it_method value to corresponding next_element_from_* function. */
6757 typedef bool (*next_element_function
) (struct it
*);
6759 static next_element_function
const get_next_element
[NUM_IT_METHODS
] =
6761 next_element_from_buffer
,
6762 next_element_from_display_vector
,
6763 next_element_from_string
,
6764 next_element_from_c_string
,
6765 next_element_from_image
,
6766 next_element_from_stretch
,
6767 next_element_from_xwidget
,
6770 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6773 /* Return true iff a character at CHARPOS (and BYTEPOS) is composed
6774 (possibly with the following characters). */
6776 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6777 ((IT)->cmp_it.id >= 0 \
6778 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6779 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6780 END_CHARPOS, (IT)->w, \
6781 FACE_OPT_FROM_ID ((IT)->f, (IT)->face_id), \
6785 /* Lookup the char-table Vglyphless_char_display for character C (-1
6786 if we want information for no-font case), and return the display
6787 method symbol. By side-effect, update it->what and
6788 it->glyphless_method. This function is called from
6789 get_next_display_element for each character element, and from
6790 x_produce_glyphs when no suitable font was found. */
6793 lookup_glyphless_char_display (int c
, struct it
*it
)
6795 Lisp_Object glyphless_method
= Qnil
;
6797 if (CHAR_TABLE_P (Vglyphless_char_display
)
6798 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6802 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6803 if (CONSP (glyphless_method
))
6804 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6805 ? XCAR (glyphless_method
)
6806 : XCDR (glyphless_method
);
6809 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6813 if (NILP (glyphless_method
))
6816 /* The default is to display the character by a proper font. */
6818 /* The default for the no-font case is to display an empty box. */
6819 glyphless_method
= Qempty_box
;
6821 if (EQ (glyphless_method
, Qzero_width
))
6824 return glyphless_method
;
6825 /* This method can't be used for the no-font case. */
6826 glyphless_method
= Qempty_box
;
6828 if (EQ (glyphless_method
, Qthin_space
))
6829 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6830 else if (EQ (glyphless_method
, Qempty_box
))
6831 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6832 else if (EQ (glyphless_method
, Qhex_code
))
6833 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6834 else if (STRINGP (glyphless_method
))
6835 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6838 /* Invalid value. We use the default method. */
6839 glyphless_method
= Qnil
;
6842 it
->what
= IT_GLYPHLESS
;
6843 return glyphless_method
;
6846 /* Merge escape glyph face and cache the result. */
6848 static struct frame
*last_escape_glyph_frame
= NULL
;
6849 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6850 static int last_escape_glyph_merged_face_id
= 0;
6853 merge_escape_glyph_face (struct it
*it
)
6857 if (it
->f
== last_escape_glyph_frame
6858 && it
->face_id
== last_escape_glyph_face_id
)
6859 face_id
= last_escape_glyph_merged_face_id
;
6862 /* Merge the `escape-glyph' face into the current face. */
6863 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6864 last_escape_glyph_frame
= it
->f
;
6865 last_escape_glyph_face_id
= it
->face_id
;
6866 last_escape_glyph_merged_face_id
= face_id
;
6871 /* Likewise for glyphless glyph face. */
6873 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6874 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6875 static int last_glyphless_glyph_merged_face_id
= 0;
6878 merge_glyphless_glyph_face (struct it
*it
)
6882 if (it
->f
== last_glyphless_glyph_frame
6883 && it
->face_id
== last_glyphless_glyph_face_id
)
6884 face_id
= last_glyphless_glyph_merged_face_id
;
6887 /* Merge the `glyphless-char' face into the current face. */
6888 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6889 last_glyphless_glyph_frame
= it
->f
;
6890 last_glyphless_glyph_face_id
= it
->face_id
;
6891 last_glyphless_glyph_merged_face_id
= face_id
;
6896 /* Forget the `escape-glyph' and `glyphless-char' faces. This should
6897 be called before redisplaying windows, and when the frame's face
6900 forget_escape_and_glyphless_faces (void)
6902 last_escape_glyph_frame
= NULL
;
6903 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6904 last_glyphless_glyph_frame
= NULL
;
6905 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6908 /* Load IT's display element fields with information about the next
6909 display element from the current position of IT. Value is false if
6910 end of buffer (or C string) is reached. */
6913 get_next_display_element (struct it
*it
)
6915 /* True means that we found a display element. False means that
6916 we hit the end of what we iterate over. Performance note: the
6917 function pointer `method' used here turns out to be faster than
6918 using a sequence of if-statements. */
6922 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6924 if (it
->what
== IT_CHARACTER
)
6926 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6927 and only if (a) the resolved directionality of that character
6929 /* FIXME: Do we need an exception for characters from display
6931 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
6932 && !inhibit_bidi_mirroring
)
6933 it
->c
= bidi_mirror_char (it
->c
);
6934 /* Map via display table or translate control characters.
6935 IT->c, IT->len etc. have been set to the next character by
6936 the function call above. If we have a display table, and it
6937 contains an entry for IT->c, translate it. Don't do this if
6938 IT->c itself comes from a display table, otherwise we could
6939 end up in an infinite recursion. (An alternative could be to
6940 count the recursion depth of this function and signal an
6941 error when a certain maximum depth is reached.) Is it worth
6943 if (success_p
&& it
->dpvec
== NULL
)
6946 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6947 bool nonascii_space_p
= false;
6948 bool nonascii_hyphen_p
= false;
6949 int c
= it
->c
; /* This is the character to display. */
6951 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6953 eassert (SINGLE_BYTE_CHAR_P (c
));
6954 if (unibyte_display_via_language_environment
)
6956 c
= DECODE_CHAR (unibyte
, c
);
6958 c
= BYTE8_TO_CHAR (it
->c
);
6961 c
= BYTE8_TO_CHAR (it
->c
);
6965 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6968 struct Lisp_Vector
*v
= XVECTOR (dv
);
6970 /* Return the first character from the display table
6971 entry, if not empty. If empty, don't display the
6972 current character. */
6975 it
->dpvec_char_len
= it
->len
;
6976 it
->dpvec
= v
->contents
;
6977 it
->dpend
= v
->contents
+ v
->header
.size
;
6978 it
->current
.dpvec_index
= 0;
6979 it
->dpvec_face_id
= -1;
6980 it
->saved_face_id
= it
->face_id
;
6981 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6982 it
->ellipsis_p
= false;
6986 set_iterator_to_next (it
, false);
6991 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6993 if (it
->what
== IT_GLYPHLESS
)
6995 /* Don't display this character. */
6996 set_iterator_to_next (it
, false);
7000 /* If `nobreak-char-display' is non-nil, we display
7001 non-ASCII spaces and hyphens specially. */
7002 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
7004 if (c
== NO_BREAK_SPACE
)
7005 nonascii_space_p
= true;
7006 else if (c
== SOFT_HYPHEN
|| c
== HYPHEN
7007 || c
== NON_BREAKING_HYPHEN
)
7008 nonascii_hyphen_p
= true;
7011 /* Translate control characters into `\003' or `^C' form.
7012 Control characters coming from a display table entry are
7013 currently not translated because we use IT->dpvec to hold
7014 the translation. This could easily be changed but I
7015 don't believe that it is worth doing.
7017 The characters handled by `nobreak-char-display' must be
7020 Non-printable characters and raw-byte characters are also
7021 translated to octal form. */
7022 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
7023 ? (it
->area
!= TEXT_AREA
7024 /* In mode line, treat \n, \t like other crl chars. */
7027 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
7028 || (c
!= '\n' && c
!= '\t'))
7030 || nonascii_hyphen_p
7032 || ! CHAR_PRINTABLE_P (c
))))
7034 /* C is a control character, non-ASCII space/hyphen,
7035 raw-byte, or a non-printable character which must be
7036 displayed either as '\003' or as `^C' where the '\\'
7037 and '^' can be defined in the display table. Fill
7038 IT->ctl_chars with glyphs for what we have to
7039 display. Then, set IT->dpvec to these glyphs. */
7046 /* Handle control characters with ^. */
7048 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
7052 g
= '^'; /* default glyph for Control */
7053 /* Set IT->ctl_chars[0] to the glyph for `^'. */
7055 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7057 g
= GLYPH_CODE_CHAR (gc
);
7058 lface_id
= GLYPH_CODE_FACE (gc
);
7062 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7063 : merge_escape_glyph_face (it
));
7065 XSETINT (it
->ctl_chars
[0], g
);
7066 XSETINT (it
->ctl_chars
[1], c
^ 0100);
7068 goto display_control
;
7071 /* Handle non-ascii space in the mode where it only gets
7074 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
7076 /* Merge `nobreak-space' into the current face. */
7077 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
7079 XSETINT (it
->ctl_chars
[0], ' ');
7081 goto display_control
;
7084 /* Handle non-ascii hyphens in the mode where it only
7085 gets highlighting. */
7087 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
7089 /* Merge `nobreak-space' into the current face. */
7090 face_id
= merge_faces (it
->f
, Qnobreak_hyphen
, 0,
7092 XSETINT (it
->ctl_chars
[0], '-');
7094 goto display_control
;
7097 /* Handle sequences that start with the "escape glyph". */
7099 /* the default escape glyph is \. */
7100 escape_glyph
= '\\';
7103 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7105 escape_glyph
= GLYPH_CODE_CHAR (gc
);
7106 lface_id
= GLYPH_CODE_FACE (gc
);
7110 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7111 : merge_escape_glyph_face (it
));
7113 /* Draw non-ASCII space/hyphen with escape glyph: */
7115 if (nonascii_space_p
|| nonascii_hyphen_p
)
7117 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7118 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7120 goto display_control
;
7127 if (CHAR_BYTE8_P (c
))
7128 /* Display \200 instead of \17777600. */
7129 c
= CHAR_TO_BYTE8 (c
);
7130 len
= sprintf (str
, "%03o", c
+ 0u);
7132 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7133 for (i
= 0; i
< len
; i
++)
7134 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7139 /* Set up IT->dpvec and return first character from it. */
7140 it
->dpvec_char_len
= it
->len
;
7141 it
->dpvec
= it
->ctl_chars
;
7142 it
->dpend
= it
->dpvec
+ ctl_len
;
7143 it
->current
.dpvec_index
= 0;
7144 it
->dpvec_face_id
= face_id
;
7145 it
->saved_face_id
= it
->face_id
;
7146 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7147 it
->ellipsis_p
= false;
7150 it
->char_to_display
= c
;
7154 it
->char_to_display
= it
->c
;
7158 #ifdef HAVE_WINDOW_SYSTEM
7159 /* Adjust face id for a multibyte character. There are no multibyte
7160 character in unibyte text. */
7161 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7164 && FRAME_WINDOW_P (it
->f
))
7166 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7168 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7170 /* Automatic composition with glyph-string. */
7171 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7173 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7177 ptrdiff_t pos
= (it
->s
? -1
7178 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7179 : IT_CHARPOS (*it
));
7182 if (it
->what
== IT_CHARACTER
)
7183 c
= it
->char_to_display
;
7186 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7190 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7191 /* TAB in a composition means display glyphs with
7192 padding space on the left or right. */
7193 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7196 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7199 #endif /* HAVE_WINDOW_SYSTEM */
7202 /* Is this character the last one of a run of characters with
7203 box? If yes, set IT->end_of_box_run_p to true. */
7207 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7209 int face_id
= underlying_face_id (it
);
7210 struct face
*face
= FACE_OPT_FROM_ID (it
->f
, face_id
);
7214 if (face
->box
== FACE_NO_BOX
)
7216 /* If the box comes from face properties in a
7217 display string, check faces in that string. */
7218 int string_face_id
= face_after_it_pos (it
);
7219 it
->end_of_box_run_p
7220 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7223 /* Otherwise, the box comes from the underlying face.
7224 If this is the last string character displayed, check
7225 the next buffer location. */
7226 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7227 /* n_overlay_strings is unreliable unless
7228 overlay_string_index is non-negative. */
7229 && ((it
->current
.overlay_string_index
>= 0
7230 && (it
->current
.overlay_string_index
7231 == it
->n_overlay_strings
- 1))
7232 /* A string from display property. */
7233 || it
->from_disp_prop_p
))
7237 bool text_from_string
= false;
7238 /* Normally, the next buffer location is stored in
7239 IT->current.pos... */
7240 struct text_pos pos
= it
->current
.pos
;
7242 /* ...but for a string from a display property, the
7243 next buffer position is stored in the 'position'
7244 member of the iteration stack slot below the
7245 current one, see handle_single_display_spec. By
7246 contrast, it->current.pos was not yet updated to
7247 point to that buffer position; that will happen
7248 in pop_it, after we finish displaying the current
7249 string. Note that we already checked above that
7250 it->sp is positive, so subtracting one from it is
7252 if (it
->from_disp_prop_p
)
7254 int stackp
= it
->sp
- 1;
7256 /* Find the stack level with data from buffer. */
7258 && STRINGP ((it
->stack
+ stackp
)->string
))
7262 /* If no stack slot was found for iterating
7263 a buffer, we are displaying text from a
7264 string, most probably the mode line or
7265 the header line, and that string has a
7266 display string on some of its
7268 text_from_string
= true;
7269 pos
= it
->stack
[it
->sp
- 1].position
;
7272 pos
= (it
->stack
+ stackp
)->position
;
7275 INC_TEXT_POS (pos
, it
->multibyte_p
);
7277 if (text_from_string
)
7279 Lisp_Object base_string
= it
->stack
[it
->sp
- 1].string
;
7281 if (CHARPOS (pos
) >= SCHARS (base_string
) - 1)
7282 it
->end_of_box_run_p
= true;
7286 = face_at_string_position (it
->w
, base_string
,
7288 &ignore
, face_id
, false);
7289 it
->end_of_box_run_p
7290 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7294 else if (CHARPOS (pos
) >= ZV
)
7295 it
->end_of_box_run_p
= true;
7299 face_at_buffer_position (it
->w
, CHARPOS (pos
), &ignore
,
7301 + TEXT_PROP_DISTANCE_LIMIT
,
7303 it
->end_of_box_run_p
7304 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7310 /* next_element_from_display_vector sets this flag according to
7311 faces of the display vector glyphs, see there. */
7312 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7314 int face_id
= face_after_it_pos (it
);
7315 it
->end_of_box_run_p
7316 = (face_id
!= it
->face_id
7317 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7320 /* If we reached the end of the object we've been iterating (e.g., a
7321 display string or an overlay string), and there's something on
7322 IT->stack, proceed with what's on the stack. It doesn't make
7323 sense to return false if there's unprocessed stuff on the stack,
7324 because otherwise that stuff will never be displayed. */
7325 if (!success_p
&& it
->sp
> 0)
7327 set_iterator_to_next (it
, false);
7328 success_p
= get_next_display_element (it
);
7331 /* Value is false if end of buffer or string reached. */
7336 /* Move IT to the next display element.
7338 RESEAT_P means if called on a newline in buffer text,
7339 skip to the next visible line start.
7341 Functions get_next_display_element and set_iterator_to_next are
7342 separate because I find this arrangement easier to handle than a
7343 get_next_display_element function that also increments IT's
7344 position. The way it is we can first look at an iterator's current
7345 display element, decide whether it fits on a line, and if it does,
7346 increment the iterator position. The other way around we probably
7347 would either need a flag indicating whether the iterator has to be
7348 incremented the next time, or we would have to implement a
7349 decrement position function which would not be easy to write. */
7352 set_iterator_to_next (struct it
*it
, bool reseat_p
)
7354 /* Reset flags indicating start and end of a sequence of characters
7355 with box. Reset them at the start of this function because
7356 moving the iterator to a new position might set them. */
7357 it
->start_of_box_run_p
= it
->end_of_box_run_p
= false;
7361 case GET_FROM_BUFFER
:
7362 /* The current display element of IT is a character from
7363 current_buffer. Advance in the buffer, and maybe skip over
7364 invisible lines that are so because of selective display. */
7365 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7366 reseat_at_next_visible_line_start (it
, false);
7367 else if (it
->cmp_it
.id
>= 0)
7369 /* We are currently getting glyphs from a composition. */
7372 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7373 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7379 /* Update IT's char/byte positions to point to the first
7380 character of the next grapheme cluster, or to the
7381 character visually after the current composition. */
7382 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7383 bidi_move_to_visually_next (&it
->bidi_it
);
7384 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7385 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7388 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7389 && it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7391 /* Composition created while scanning forward. Proceed
7392 to the next grapheme cluster. */
7393 it
->cmp_it
.from
= it
->cmp_it
.to
;
7395 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7396 && it
->cmp_it
.from
> 0)
7398 /* Composition created while scanning backward. Proceed
7399 to the previous grapheme cluster. */
7400 it
->cmp_it
.to
= it
->cmp_it
.from
;
7404 /* No more grapheme clusters in this composition.
7405 Find the next stop position. */
7406 ptrdiff_t stop
= it
->end_charpos
;
7408 if (it
->bidi_it
.scan_dir
< 0)
7409 /* Now we are scanning backward and don't know
7412 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7413 IT_BYTEPOS (*it
), stop
, Qnil
);
7418 eassert (it
->len
!= 0);
7422 IT_BYTEPOS (*it
) += it
->len
;
7423 IT_CHARPOS (*it
) += 1;
7427 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7428 /* If this is a new paragraph, determine its base
7429 direction (a.k.a. its base embedding level). */
7430 if (it
->bidi_it
.new_paragraph
)
7431 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
7433 bidi_move_to_visually_next (&it
->bidi_it
);
7434 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7435 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7436 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7438 /* As the scan direction was changed, we must
7439 re-compute the stop position for composition. */
7440 ptrdiff_t stop
= it
->end_charpos
;
7441 if (it
->bidi_it
.scan_dir
< 0)
7443 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7444 IT_BYTEPOS (*it
), stop
, Qnil
);
7447 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7451 case GET_FROM_C_STRING
:
7452 /* Current display element of IT is from a C string. */
7454 /* If the string position is beyond string's end, it means
7455 next_element_from_c_string is padding the string with
7456 blanks, in which case we bypass the bidi iterator,
7457 because it cannot deal with such virtual characters. */
7458 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7460 IT_BYTEPOS (*it
) += it
->len
;
7461 IT_CHARPOS (*it
) += 1;
7465 bidi_move_to_visually_next (&it
->bidi_it
);
7466 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7467 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7471 case GET_FROM_DISPLAY_VECTOR
:
7472 /* Current display element of IT is from a display table entry.
7473 Advance in the display table definition. Reset it to null if
7474 end reached, and continue with characters from buffers/
7476 ++it
->current
.dpvec_index
;
7478 /* Restore face of the iterator to what they were before the
7479 display vector entry (these entries may contain faces). */
7480 it
->face_id
= it
->saved_face_id
;
7482 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7484 bool recheck_faces
= it
->ellipsis_p
;
7487 it
->method
= GET_FROM_C_STRING
;
7488 else if (STRINGP (it
->string
))
7489 it
->method
= GET_FROM_STRING
;
7492 it
->method
= GET_FROM_BUFFER
;
7493 it
->object
= it
->w
->contents
;
7497 it
->current
.dpvec_index
= -1;
7499 /* Skip over characters which were displayed via IT->dpvec. */
7500 if (it
->dpvec_char_len
< 0)
7501 reseat_at_next_visible_line_start (it
, true);
7502 else if (it
->dpvec_char_len
> 0)
7504 it
->len
= it
->dpvec_char_len
;
7505 set_iterator_to_next (it
, reseat_p
);
7508 /* Maybe recheck faces after display vector. */
7511 if (it
->method
== GET_FROM_STRING
)
7512 it
->stop_charpos
= IT_STRING_CHARPOS (*it
);
7514 it
->stop_charpos
= IT_CHARPOS (*it
);
7519 case GET_FROM_STRING
:
7520 /* Current display element is a character from a Lisp string. */
7521 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7522 /* Don't advance past string end. These conditions are true
7523 when set_iterator_to_next is called at the end of
7524 get_next_display_element, in which case the Lisp string is
7525 already exhausted, and all we want is pop the iterator
7527 if (it
->current
.overlay_string_index
>= 0)
7529 /* This is an overlay string, so there's no padding with
7530 spaces, and the number of characters in the string is
7531 where the string ends. */
7532 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7533 goto consider_string_end
;
7537 /* Not an overlay string. There could be padding, so test
7538 against it->end_charpos. */
7539 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7540 goto consider_string_end
;
7542 if (it
->cmp_it
.id
>= 0)
7544 /* We are delivering display elements from a composition.
7545 Update the string position past the grapheme cluster
7546 we've just processed. */
7549 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7550 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7556 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7557 bidi_move_to_visually_next (&it
->bidi_it
);
7558 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7559 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7562 /* Did we exhaust all the grapheme clusters of this
7564 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7565 && (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
))
7567 /* Not all the grapheme clusters were processed yet;
7568 advance to the next cluster. */
7569 it
->cmp_it
.from
= it
->cmp_it
.to
;
7571 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7572 && it
->cmp_it
.from
> 0)
7574 /* Likewise: advance to the next cluster, but going in
7575 the reverse direction. */
7576 it
->cmp_it
.to
= it
->cmp_it
.from
;
7580 /* This composition was fully processed; find the next
7581 candidate place for checking for composed
7583 /* Always limit string searches to the string length;
7584 any padding spaces are not part of the string, and
7585 there cannot be any compositions in that padding. */
7586 ptrdiff_t stop
= SCHARS (it
->string
);
7588 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
7590 else if (it
->end_charpos
< stop
)
7592 /* Cf. PRECISION in reseat_to_string: we might be
7593 limited in how many of the string characters we
7595 stop
= it
->end_charpos
;
7597 composition_compute_stop_pos (&it
->cmp_it
,
7598 IT_STRING_CHARPOS (*it
),
7599 IT_STRING_BYTEPOS (*it
), stop
,
7606 /* If the string position is beyond string's end, it
7607 means next_element_from_string is padding the string
7608 with blanks, in which case we bypass the bidi
7609 iterator, because it cannot deal with such virtual
7611 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7613 IT_STRING_BYTEPOS (*it
) += it
->len
;
7614 IT_STRING_CHARPOS (*it
) += 1;
7618 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7620 bidi_move_to_visually_next (&it
->bidi_it
);
7621 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7622 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7623 /* If the scan direction changes, we may need to update
7624 the place where to check for composed characters. */
7625 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7627 ptrdiff_t stop
= SCHARS (it
->string
);
7629 if (it
->bidi_it
.scan_dir
< 0)
7631 else if (it
->end_charpos
< stop
)
7632 stop
= it
->end_charpos
;
7634 composition_compute_stop_pos (&it
->cmp_it
,
7635 IT_STRING_CHARPOS (*it
),
7636 IT_STRING_BYTEPOS (*it
), stop
,
7642 consider_string_end
:
7644 if (it
->current
.overlay_string_index
>= 0)
7646 /* IT->string is an overlay string. Advance to the
7647 next, if there is one. */
7648 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7650 it
->ellipsis_p
= false;
7651 next_overlay_string (it
);
7653 setup_for_ellipsis (it
, 0);
7658 /* IT->string is not an overlay string. If we reached
7659 its end, and there is something on IT->stack, proceed
7660 with what is on the stack. This can be either another
7661 string, this time an overlay string, or a buffer. */
7662 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7666 if (it
->method
== GET_FROM_STRING
)
7667 goto consider_string_end
;
7672 case GET_FROM_IMAGE
:
7673 case GET_FROM_STRETCH
:
7674 case GET_FROM_XWIDGET
:
7676 /* The position etc with which we have to proceed are on
7677 the stack. The position may be at the end of a string,
7678 if the `display' property takes up the whole string. */
7679 eassert (it
->sp
> 0);
7681 if (it
->method
== GET_FROM_STRING
)
7682 goto consider_string_end
;
7686 /* There are no other methods defined, so this should be a bug. */
7690 eassert (it
->method
!= GET_FROM_STRING
7691 || (STRINGP (it
->string
)
7692 && IT_STRING_CHARPOS (*it
) >= 0));
7695 /* Load IT's display element fields with information about the next
7696 display element which comes from a display table entry or from the
7697 result of translating a control character to one of the forms `^C'
7700 IT->dpvec holds the glyphs to return as characters.
7701 IT->saved_face_id holds the face id before the display vector--it
7702 is restored into IT->face_id in set_iterator_to_next. */
7705 next_element_from_display_vector (struct it
*it
)
7708 int prev_face_id
= it
->face_id
;
7712 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7714 it
->face_id
= it
->saved_face_id
;
7716 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7717 That seemed totally bogus - so I changed it... */
7718 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7720 if (GLYPH_CODE_P (gc
))
7722 struct face
*this_face
, *prev_face
, *next_face
;
7724 it
->c
= GLYPH_CODE_CHAR (gc
);
7725 it
->len
= CHAR_BYTES (it
->c
);
7727 /* The entry may contain a face id to use. Such a face id is
7728 the id of a Lisp face, not a realized face. A face id of
7729 zero means no face is specified. */
7730 if (it
->dpvec_face_id
>= 0)
7731 it
->face_id
= it
->dpvec_face_id
;
7734 int lface_id
= GLYPH_CODE_FACE (gc
);
7736 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7740 /* Glyphs in the display vector could have the box face, so we
7741 need to set the related flags in the iterator, as
7743 this_face
= FACE_OPT_FROM_ID (it
->f
, it
->face_id
);
7744 prev_face
= FACE_OPT_FROM_ID (it
->f
, prev_face_id
);
7746 /* Is this character the first character of a box-face run? */
7747 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7749 || prev_face
->box
== FACE_NO_BOX
));
7751 /* For the last character of the box-face run, we need to look
7752 either at the next glyph from the display vector, or at the
7753 face we saw before the display vector. */
7754 next_face_id
= it
->saved_face_id
;
7755 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7757 if (it
->dpvec_face_id
>= 0)
7758 next_face_id
= it
->dpvec_face_id
;
7762 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7765 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7769 next_face
= FACE_OPT_FROM_ID (it
->f
, next_face_id
);
7770 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7772 || next_face
->box
== FACE_NO_BOX
));
7773 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7776 /* Display table entry is invalid. Return a space. */
7777 it
->c
= ' ', it
->len
= 1;
7779 /* Don't change position and object of the iterator here. They are
7780 still the values of the character that had this display table
7781 entry or was translated, and that's what we want. */
7782 it
->what
= IT_CHARACTER
;
7786 /* Get the first element of string/buffer in the visual order, after
7787 being reseated to a new position in a string or a buffer. */
7789 get_visually_first_element (struct it
*it
)
7791 bool string_p
= STRINGP (it
->string
) || it
->s
;
7792 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7793 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7795 if (STRINGP (it
->string
))
7797 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7798 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7802 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7803 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7806 if (it
->bidi_it
.charpos
== eob
)
7808 /* Nothing to do, but reset the FIRST_ELT flag, like
7809 bidi_paragraph_init does, because we are not going to
7811 it
->bidi_it
.first_elt
= false;
7813 else if (it
->bidi_it
.charpos
== bob
7815 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7816 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7818 /* If we are at the beginning of a line/string, we can produce
7819 the next element right away. */
7820 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7821 bidi_move_to_visually_next (&it
->bidi_it
);
7825 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7827 /* We need to prime the bidi iterator starting at the line's or
7828 string's beginning, before we will be able to produce the
7831 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7833 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7834 IT_BYTEPOS (*it
), -1,
7835 &it
->bidi_it
.bytepos
);
7836 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7839 /* Now return to buffer/string position where we were asked
7840 to get the next display element, and produce that. */
7841 bidi_move_to_visually_next (&it
->bidi_it
);
7843 while (it
->bidi_it
.bytepos
!= orig_bytepos
7844 && it
->bidi_it
.charpos
< eob
);
7847 /* Adjust IT's position information to where we ended up. */
7848 if (STRINGP (it
->string
))
7850 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7851 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7855 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7856 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7859 if (STRINGP (it
->string
) || !it
->s
)
7861 ptrdiff_t stop
, charpos
, bytepos
;
7863 if (STRINGP (it
->string
))
7866 stop
= SCHARS (it
->string
);
7867 if (stop
> it
->end_charpos
)
7868 stop
= it
->end_charpos
;
7869 charpos
= IT_STRING_CHARPOS (*it
);
7870 bytepos
= IT_STRING_BYTEPOS (*it
);
7874 stop
= it
->end_charpos
;
7875 charpos
= IT_CHARPOS (*it
);
7876 bytepos
= IT_BYTEPOS (*it
);
7878 if (it
->bidi_it
.scan_dir
< 0)
7880 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7885 /* Load IT with the next display element from Lisp string IT->string.
7886 IT->current.string_pos is the current position within the string.
7887 If IT->current.overlay_string_index >= 0, the Lisp string is an
7891 next_element_from_string (struct it
*it
)
7893 struct text_pos position
;
7895 eassert (STRINGP (it
->string
));
7896 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7897 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7898 position
= it
->current
.string_pos
;
7900 /* With bidi reordering, the character to display might not be the
7901 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT means
7902 that we were reseat()ed to a new string, whose paragraph
7903 direction is not known. */
7904 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7906 get_visually_first_element (it
);
7907 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7910 /* Time to check for invisible text? */
7911 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7913 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7916 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7917 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7919 /* With bidi non-linear iteration, we could find
7920 ourselves far beyond the last computed stop_charpos,
7921 with several other stop positions in between that we
7922 missed. Scan them all now, in buffer's logical
7923 order, until we find and handle the last stop_charpos
7924 that precedes our current position. */
7925 handle_stop_backwards (it
, it
->stop_charpos
);
7926 return GET_NEXT_DISPLAY_ELEMENT (it
);
7932 /* Take note of the stop position we just moved
7933 across, for when we will move back across it. */
7934 it
->prev_stop
= it
->stop_charpos
;
7935 /* If we are at base paragraph embedding level, take
7936 note of the last stop position seen at this
7938 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7939 it
->base_level_stop
= it
->stop_charpos
;
7943 /* Since a handler may have changed IT->method, we must
7945 return GET_NEXT_DISPLAY_ELEMENT (it
);
7949 /* If we are before prev_stop, we may have overstepped
7950 on our way backwards a stop_pos, and if so, we need
7951 to handle that stop_pos. */
7952 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7953 /* We can sometimes back up for reasons that have nothing
7954 to do with bidi reordering. E.g., compositions. The
7955 code below is only needed when we are above the base
7956 embedding level, so test for that explicitly. */
7957 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7959 /* If we lost track of base_level_stop, we have no better
7960 place for handle_stop_backwards to start from than string
7961 beginning. This happens, e.g., when we were reseated to
7962 the previous screenful of text by vertical-motion. */
7963 if (it
->base_level_stop
<= 0
7964 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7965 it
->base_level_stop
= 0;
7966 handle_stop_backwards (it
, it
->base_level_stop
);
7967 return GET_NEXT_DISPLAY_ELEMENT (it
);
7971 if (it
->current
.overlay_string_index
>= 0)
7973 /* Get the next character from an overlay string. In overlay
7974 strings, there is no field width or padding with spaces to
7976 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7981 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7982 IT_STRING_BYTEPOS (*it
),
7983 it
->bidi_it
.scan_dir
< 0
7985 : SCHARS (it
->string
))
7986 && next_element_from_composition (it
))
7990 else if (STRING_MULTIBYTE (it
->string
))
7992 const unsigned char *s
= (SDATA (it
->string
)
7993 + IT_STRING_BYTEPOS (*it
));
7994 it
->c
= string_char_and_length (s
, &it
->len
);
7998 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
8004 /* Get the next character from a Lisp string that is not an
8005 overlay string. Such strings come from the mode line, for
8006 example. We may have to pad with spaces, or truncate the
8007 string. See also next_element_from_c_string. */
8008 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
8013 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
8015 /* Pad with spaces. */
8016 it
->c
= ' ', it
->len
= 1;
8017 CHARPOS (position
) = BYTEPOS (position
) = -1;
8019 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
8020 IT_STRING_BYTEPOS (*it
),
8021 it
->bidi_it
.scan_dir
< 0
8023 : it
->string_nchars
)
8024 && next_element_from_composition (it
))
8028 else if (STRING_MULTIBYTE (it
->string
))
8030 const unsigned char *s
= (SDATA (it
->string
)
8031 + IT_STRING_BYTEPOS (*it
));
8032 it
->c
= string_char_and_length (s
, &it
->len
);
8036 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
8041 /* Record what we have and where it came from. */
8042 it
->what
= IT_CHARACTER
;
8043 it
->object
= it
->string
;
8044 it
->position
= position
;
8049 /* Load IT with next display element from C string IT->s.
8050 IT->string_nchars is the maximum number of characters to return
8051 from the string. IT->end_charpos may be greater than
8052 IT->string_nchars when this function is called, in which case we
8053 may have to return padding spaces. Value is false if end of string
8054 reached, including padding spaces. */
8057 next_element_from_c_string (struct it
*it
)
8059 bool success_p
= true;
8062 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
8063 it
->what
= IT_CHARACTER
;
8064 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
8065 it
->object
= make_number (0);
8067 /* With bidi reordering, the character to display might not be the
8068 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
8069 we were reseated to a new string, whose paragraph direction is
8071 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8072 get_visually_first_element (it
);
8074 /* IT's position can be greater than IT->string_nchars in case a
8075 field width or precision has been specified when the iterator was
8077 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8079 /* End of the game. */
8083 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
8085 /* Pad with spaces. */
8086 it
->c
= ' ', it
->len
= 1;
8087 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
8089 else if (it
->multibyte_p
)
8090 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
8092 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
8098 /* Set up IT to return characters from an ellipsis, if appropriate.
8099 The definition of the ellipsis glyphs may come from a display table
8100 entry. This function fills IT with the first glyph from the
8101 ellipsis if an ellipsis is to be displayed. */
8104 next_element_from_ellipsis (struct it
*it
)
8106 if (it
->selective_display_ellipsis_p
)
8107 setup_for_ellipsis (it
, it
->len
);
8110 /* The face at the current position may be different from the
8111 face we find after the invisible text. Remember what it
8112 was in IT->saved_face_id, and signal that it's there by
8113 setting face_before_selective_p. */
8114 it
->saved_face_id
= it
->face_id
;
8115 it
->method
= GET_FROM_BUFFER
;
8116 it
->object
= it
->w
->contents
;
8117 reseat_at_next_visible_line_start (it
, true);
8118 it
->face_before_selective_p
= true;
8121 return GET_NEXT_DISPLAY_ELEMENT (it
);
8125 /* Deliver an image display element. The iterator IT is already
8126 filled with image information (done in handle_display_prop). Value
8131 next_element_from_image (struct it
*it
)
8133 it
->what
= IT_IMAGE
;
8138 next_element_from_xwidget (struct it
*it
)
8140 it
->what
= IT_XWIDGET
;
8145 /* Fill iterator IT with next display element from a stretch glyph
8146 property. IT->object is the value of the text property. Value is
8150 next_element_from_stretch (struct it
*it
)
8152 it
->what
= IT_STRETCH
;
8156 /* Scan backwards from IT's current position until we find a stop
8157 position, or until BEGV. This is called when we find ourself
8158 before both the last known prev_stop and base_level_stop while
8159 reordering bidirectional text. */
8162 compute_stop_pos_backwards (struct it
*it
)
8164 const int SCAN_BACK_LIMIT
= 1000;
8165 struct text_pos pos
;
8166 struct display_pos save_current
= it
->current
;
8167 struct text_pos save_position
= it
->position
;
8168 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8169 ptrdiff_t where_we_are
= charpos
;
8170 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8171 ptrdiff_t save_end_pos
= it
->end_charpos
;
8173 eassert (NILP (it
->string
) && !it
->s
);
8174 eassert (it
->bidi_p
);
8178 it
->end_charpos
= min (charpos
+ 1, ZV
);
8179 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8180 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8181 reseat_1 (it
, pos
, false);
8182 compute_stop_pos (it
);
8183 /* We must advance forward, right? */
8184 if (it
->stop_charpos
<= charpos
)
8187 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8189 if (it
->stop_charpos
<= where_we_are
)
8190 it
->prev_stop
= it
->stop_charpos
;
8192 it
->prev_stop
= BEGV
;
8194 it
->current
= save_current
;
8195 it
->position
= save_position
;
8196 it
->stop_charpos
= save_stop_pos
;
8197 it
->end_charpos
= save_end_pos
;
8200 /* Scan forward from CHARPOS in the current buffer/string, until we
8201 find a stop position > current IT's position. Then handle the stop
8202 position before that. This is called when we bump into a stop
8203 position while reordering bidirectional text. CHARPOS should be
8204 the last previously processed stop_pos (or BEGV/0, if none were
8205 processed yet) whose position is less that IT's current
8209 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8211 bool bufp
= !STRINGP (it
->string
);
8212 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8213 struct display_pos save_current
= it
->current
;
8214 struct text_pos save_position
= it
->position
;
8215 struct text_pos pos1
;
8216 ptrdiff_t next_stop
;
8218 /* Scan in strict logical order. */
8219 eassert (it
->bidi_p
);
8223 it
->prev_stop
= charpos
;
8226 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8227 reseat_1 (it
, pos1
, false);
8230 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8231 compute_stop_pos (it
);
8232 /* We must advance forward, right? */
8233 if (it
->stop_charpos
<= it
->prev_stop
)
8235 charpos
= it
->stop_charpos
;
8237 while (charpos
<= where_we_are
);
8240 it
->current
= save_current
;
8241 it
->position
= save_position
;
8242 next_stop
= it
->stop_charpos
;
8243 it
->stop_charpos
= it
->prev_stop
;
8245 it
->stop_charpos
= next_stop
;
8248 /* Load IT with the next display element from current_buffer. Value
8249 is false if end of buffer reached. IT->stop_charpos is the next
8250 position at which to stop and check for text properties or buffer
8254 next_element_from_buffer (struct it
*it
)
8256 bool success_p
= true;
8258 eassert (IT_CHARPOS (*it
) >= BEGV
);
8259 eassert (NILP (it
->string
) && !it
->s
);
8260 eassert (!it
->bidi_p
8261 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8262 && it
->bidi_it
.string
.s
== NULL
));
8264 /* With bidi reordering, the character to display might not be the
8265 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
8266 we were reseat()ed to a new buffer position, which is potentially
8267 a different paragraph. */
8268 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8270 get_visually_first_element (it
);
8271 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8274 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8276 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8278 bool overlay_strings_follow_p
;
8280 /* End of the game, except when overlay strings follow that
8281 haven't been returned yet. */
8282 if (it
->overlay_strings_at_end_processed_p
)
8283 overlay_strings_follow_p
= false;
8286 it
->overlay_strings_at_end_processed_p
= true;
8287 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8290 if (overlay_strings_follow_p
)
8291 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8295 it
->position
= it
->current
.pos
;
8299 else if (!(!it
->bidi_p
8300 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8301 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8303 /* With bidi non-linear iteration, we could find ourselves
8304 far beyond the last computed stop_charpos, with several
8305 other stop positions in between that we missed. Scan
8306 them all now, in buffer's logical order, until we find
8307 and handle the last stop_charpos that precedes our
8308 current position. */
8309 handle_stop_backwards (it
, it
->stop_charpos
);
8310 it
->ignore_overlay_strings_at_pos_p
= false;
8311 return GET_NEXT_DISPLAY_ELEMENT (it
);
8317 /* Take note of the stop position we just moved across,
8318 for when we will move back across it. */
8319 it
->prev_stop
= it
->stop_charpos
;
8320 /* If we are at base paragraph embedding level, take
8321 note of the last stop position seen at this
8323 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8324 it
->base_level_stop
= it
->stop_charpos
;
8327 it
->ignore_overlay_strings_at_pos_p
= false;
8328 return GET_NEXT_DISPLAY_ELEMENT (it
);
8332 /* If we are before prev_stop, we may have overstepped on
8333 our way backwards a stop_pos, and if so, we need to
8334 handle that stop_pos. */
8335 && IT_CHARPOS (*it
) < it
->prev_stop
8336 /* We can sometimes back up for reasons that have nothing
8337 to do with bidi reordering. E.g., compositions. The
8338 code below is only needed when we are above the base
8339 embedding level, so test for that explicitly. */
8340 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8342 if (it
->base_level_stop
<= 0
8343 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8345 /* If we lost track of base_level_stop, we need to find
8346 prev_stop by looking backwards. This happens, e.g., when
8347 we were reseated to the previous screenful of text by
8349 it
->base_level_stop
= BEGV
;
8350 compute_stop_pos_backwards (it
);
8351 handle_stop_backwards (it
, it
->prev_stop
);
8354 handle_stop_backwards (it
, it
->base_level_stop
);
8355 it
->ignore_overlay_strings_at_pos_p
= false;
8356 return GET_NEXT_DISPLAY_ELEMENT (it
);
8360 /* No face changes, overlays etc. in sight, so just return a
8361 character from current_buffer. */
8365 /* We moved to the next buffer position, so any info about
8366 previously seen overlays is no longer valid. */
8367 it
->ignore_overlay_strings_at_pos_p
= false;
8369 /* Maybe run the redisplay end trigger hook. Performance note:
8370 This doesn't seem to cost measurable time. */
8371 if (it
->redisplay_end_trigger_charpos
8373 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8374 run_redisplay_end_trigger_hook (it
);
8376 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8377 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8379 && next_element_from_composition (it
))
8384 /* Get the next character, maybe multibyte. */
8385 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8386 if (it
->multibyte_p
&& !ASCII_CHAR_P (*p
))
8387 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8389 it
->c
= *p
, it
->len
= 1;
8391 /* Record what we have and where it came from. */
8392 it
->what
= IT_CHARACTER
;
8393 it
->object
= it
->w
->contents
;
8394 it
->position
= it
->current
.pos
;
8396 /* Normally we return the character found above, except when we
8397 really want to return an ellipsis for selective display. */
8402 /* A value of selective > 0 means hide lines indented more
8403 than that number of columns. */
8404 if (it
->selective
> 0
8405 && IT_CHARPOS (*it
) + 1 < ZV
8406 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8407 IT_BYTEPOS (*it
) + 1,
8410 success_p
= next_element_from_ellipsis (it
);
8411 it
->dpvec_char_len
= -1;
8414 else if (it
->c
== '\r' && it
->selective
== -1)
8416 /* A value of selective == -1 means that everything from the
8417 CR to the end of the line is invisible, with maybe an
8418 ellipsis displayed for it. */
8419 success_p
= next_element_from_ellipsis (it
);
8420 it
->dpvec_char_len
= -1;
8425 /* Value is false if end of buffer reached. */
8426 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8431 /* Run the redisplay end trigger hook for IT. */
8434 run_redisplay_end_trigger_hook (struct it
*it
)
8436 /* IT->glyph_row should be non-null, i.e. we should be actually
8437 displaying something, or otherwise we should not run the hook. */
8438 eassert (it
->glyph_row
);
8440 ptrdiff_t charpos
= it
->redisplay_end_trigger_charpos
;
8441 it
->redisplay_end_trigger_charpos
= 0;
8443 /* Since we are *trying* to run these functions, don't try to run
8444 them again, even if they get an error. */
8445 wset_redisplay_end_trigger (it
->w
, Qnil
);
8446 CALLN (Frun_hook_with_args
, Qredisplay_end_trigger_functions
, it
->window
,
8447 make_number (charpos
));
8449 /* Notice if it changed the face of the character we are on. */
8450 handle_face_prop (it
);
8454 /* Deliver a composition display element. Unlike the other
8455 next_element_from_XXX, this function is not registered in the array
8456 get_next_element[]. It is called from next_element_from_buffer and
8457 next_element_from_string when necessary. */
8460 next_element_from_composition (struct it
*it
)
8462 it
->what
= IT_COMPOSITION
;
8463 it
->len
= it
->cmp_it
.nbytes
;
8464 if (STRINGP (it
->string
))
8468 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8469 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8472 it
->position
= it
->current
.string_pos
;
8473 it
->object
= it
->string
;
8474 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8475 IT_STRING_BYTEPOS (*it
), it
->string
);
8481 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8482 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8485 if (it
->bidi_it
.new_paragraph
)
8486 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
8488 /* Resync the bidi iterator with IT's new position.
8489 FIXME: this doesn't support bidirectional text. */
8490 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8491 bidi_move_to_visually_next (&it
->bidi_it
);
8495 it
->position
= it
->current
.pos
;
8496 it
->object
= it
->w
->contents
;
8497 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8498 IT_BYTEPOS (*it
), Qnil
);
8505 /***********************************************************************
8506 Moving an iterator without producing glyphs
8507 ***********************************************************************/
8509 /* Check if iterator is at a position corresponding to a valid buffer
8510 position after some move_it_ call. */
8512 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8513 ((it)->method != GET_FROM_STRING || IT_STRING_CHARPOS (*it) == 0)
8516 /* Move iterator IT to a specified buffer or X position within one
8517 line on the display without producing glyphs.
8519 OP should be a bit mask including some or all of these bits:
8520 MOVE_TO_X: Stop upon reaching x-position TO_X.
8521 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8522 Regardless of OP's value, stop upon reaching the end of the display line.
8524 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8525 This means, in particular, that TO_X includes window's horizontal
8528 The return value has several possible values that
8529 say what condition caused the scan to stop:
8531 MOVE_POS_MATCH_OR_ZV
8532 - when TO_POS or ZV was reached.
8535 -when TO_X was reached before TO_POS or ZV were reached.
8538 - when we reached the end of the display area and the line must
8542 - when we reached the end of the display area and the line is
8546 - when we stopped at a line end, i.e. a newline or a CR and selective
8549 static enum move_it_result
8550 move_it_in_display_line_to (struct it
*it
,
8551 ptrdiff_t to_charpos
, int to_x
,
8552 enum move_operation_enum op
)
8554 enum move_it_result result
= MOVE_UNDEFINED
;
8555 struct glyph_row
*saved_glyph_row
;
8556 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8557 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8558 void *ppos_data
= NULL
;
8559 bool may_wrap
= false;
8560 enum it_method prev_method
= it
->method
;
8561 ptrdiff_t closest_pos UNINIT
;
8562 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
8563 bool saw_smaller_pos
= prev_pos
< to_charpos
;
8565 /* Don't produce glyphs in produce_glyphs. */
8566 saved_glyph_row
= it
->glyph_row
;
8567 it
->glyph_row
= NULL
;
8569 /* Use wrap_it to save a copy of IT wherever a word wrap could
8570 occur. Use atpos_it to save a copy of IT at the desired buffer
8571 position, if found, so that we can scan ahead and check if the
8572 word later overshoots the window edge. Use atx_it similarly, for
8578 /* Use ppos_it under bidi reordering to save a copy of IT for the
8579 initial position. We restore that position in IT when we have
8580 scanned the entire display line without finding a match for
8581 TO_CHARPOS and all the character positions are greater than
8582 TO_CHARPOS. We then restart the scan from the initial position,
8583 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8584 the closest to TO_CHARPOS. */
8587 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8589 SAVE_IT (ppos_it
, *it
, ppos_data
);
8590 closest_pos
= IT_CHARPOS (*it
);
8596 #define BUFFER_POS_REACHED_P() \
8597 ((op & MOVE_TO_POS) != 0 \
8598 && BUFFERP (it->object) \
8599 && (IT_CHARPOS (*it) == to_charpos \
8601 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8602 && IT_CHARPOS (*it) > to_charpos) \
8603 || (it->what == IT_COMPOSITION \
8604 && ((IT_CHARPOS (*it) > to_charpos \
8605 && to_charpos >= it->cmp_it.charpos) \
8606 || (IT_CHARPOS (*it) < to_charpos \
8607 && to_charpos <= it->cmp_it.charpos)))) \
8608 && (it->method == GET_FROM_BUFFER \
8609 || (it->method == GET_FROM_DISPLAY_VECTOR \
8610 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8612 /* If there's a line-/wrap-prefix, handle it. */
8613 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8614 && it
->current_y
< it
->last_visible_y
)
8615 handle_line_prefix (it
);
8617 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8618 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8622 int x
, i
, ascent
= 0, descent
= 0;
8624 /* Utility macro to reset an iterator with x, ascent, and descent. */
8625 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8626 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8627 (IT)->max_descent = descent)
8629 /* Stop if we move beyond TO_CHARPOS (after an image or a
8630 display string or stretch glyph). */
8631 if ((op
& MOVE_TO_POS
) != 0
8632 && BUFFERP (it
->object
)
8633 && it
->method
== GET_FROM_BUFFER
8635 /* When the iterator is at base embedding level, we
8636 are guaranteed that characters are delivered for
8637 display in strictly increasing order of their
8638 buffer positions. */
8639 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8640 && IT_CHARPOS (*it
) > to_charpos
)
8642 && (prev_method
== GET_FROM_IMAGE
8643 || prev_method
== GET_FROM_STRETCH
8644 || prev_method
== GET_FROM_STRING
)
8645 /* Passed TO_CHARPOS from left to right. */
8646 && ((prev_pos
< to_charpos
8647 && IT_CHARPOS (*it
) > to_charpos
)
8648 /* Passed TO_CHARPOS from right to left. */
8649 || (prev_pos
> to_charpos
8650 && IT_CHARPOS (*it
) < to_charpos
)))))
8652 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8654 result
= MOVE_POS_MATCH_OR_ZV
;
8657 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8658 /* If wrap_it is valid, the current position might be in a
8659 word that is wrapped. So, save the iterator in
8660 atpos_it and continue to see if wrapping happens. */
8661 SAVE_IT (atpos_it
, *it
, atpos_data
);
8664 /* Stop when ZV reached.
8665 We used to stop here when TO_CHARPOS reached as well, but that is
8666 too soon if this glyph does not fit on this line. So we handle it
8667 explicitly below. */
8668 if (!get_next_display_element (it
))
8670 result
= MOVE_POS_MATCH_OR_ZV
;
8674 if (it
->line_wrap
== TRUNCATE
)
8676 if (BUFFER_POS_REACHED_P ())
8678 result
= MOVE_POS_MATCH_OR_ZV
;
8684 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8686 if (IT_DISPLAYING_WHITESPACE (it
))
8690 /* We have reached a glyph that follows one or more
8691 whitespace characters. If the position is
8692 already found, we are done. */
8693 if (atpos_it
.sp
>= 0)
8695 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8696 result
= MOVE_POS_MATCH_OR_ZV
;
8701 RESTORE_IT (it
, &atx_it
, atx_data
);
8702 result
= MOVE_X_REACHED
;
8705 /* Otherwise, we can wrap here. */
8706 SAVE_IT (wrap_it
, *it
, wrap_data
);
8712 /* Remember the line height for the current line, in case
8713 the next element doesn't fit on the line. */
8714 ascent
= it
->max_ascent
;
8715 descent
= it
->max_descent
;
8717 /* The call to produce_glyphs will get the metrics of the
8718 display element IT is loaded with. Record the x-position
8719 before this display element, in case it doesn't fit on the
8723 PRODUCE_GLYPHS (it
);
8725 if (it
->area
!= TEXT_AREA
)
8727 prev_method
= it
->method
;
8728 if (it
->method
== GET_FROM_BUFFER
)
8729 prev_pos
= IT_CHARPOS (*it
);
8730 set_iterator_to_next (it
, true);
8731 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8732 SET_TEXT_POS (this_line_min_pos
,
8733 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8735 && (op
& MOVE_TO_POS
)
8736 && IT_CHARPOS (*it
) > to_charpos
8737 && IT_CHARPOS (*it
) < closest_pos
)
8738 closest_pos
= IT_CHARPOS (*it
);
8742 /* The number of glyphs we get back in IT->nglyphs will normally
8743 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8744 character on a terminal frame, or (iii) a line end. For the
8745 second case, IT->nglyphs - 1 padding glyphs will be present.
8746 (On X frames, there is only one glyph produced for a
8747 composite character.)
8749 The behavior implemented below means, for continuation lines,
8750 that as many spaces of a TAB as fit on the current line are
8751 displayed there. For terminal frames, as many glyphs of a
8752 multi-glyph character are displayed in the current line, too.
8753 This is what the old redisplay code did, and we keep it that
8754 way. Under X, the whole shape of a complex character must
8755 fit on the line or it will be completely displayed in the
8758 Note that both for tabs and padding glyphs, all glyphs have
8762 /* More than one glyph or glyph doesn't fit on line. All
8763 glyphs have the same width. */
8764 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8766 int x_before_this_char
= x
;
8767 int hpos_before_this_char
= it
->hpos
;
8769 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8771 new_x
= x
+ single_glyph_width
;
8773 /* We want to leave anything reaching TO_X to the caller. */
8774 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8776 if (BUFFER_POS_REACHED_P ())
8778 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8779 goto buffer_pos_reached
;
8780 if (atpos_it
.sp
< 0)
8782 SAVE_IT (atpos_it
, *it
, atpos_data
);
8783 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8788 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8791 result
= MOVE_X_REACHED
;
8796 SAVE_IT (atx_it
, *it
, atx_data
);
8797 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8802 if (/* Lines are continued. */
8803 it
->line_wrap
!= TRUNCATE
8804 && (/* And glyph doesn't fit on the line. */
8805 new_x
> it
->last_visible_x
8806 /* Or it fits exactly and we're on a window
8808 || (new_x
== it
->last_visible_x
8809 && FRAME_WINDOW_P (it
->f
)
8810 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8811 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8812 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8814 bool moved_forward
= false;
8816 if (/* IT->hpos == 0 means the very first glyph
8817 doesn't fit on the line, e.g. a wide image. */
8819 || (new_x
== it
->last_visible_x
8820 && FRAME_WINDOW_P (it
->f
)))
8823 it
->current_x
= new_x
;
8825 /* The character's last glyph just barely fits
8827 if (i
== it
->nglyphs
- 1)
8829 /* If this is the destination position,
8830 return a position *before* it in this row,
8831 now that we know it fits in this row. */
8832 if (BUFFER_POS_REACHED_P ())
8834 bool can_wrap
= true;
8836 /* If we are at a whitespace character
8837 that barely fits on this screen line,
8838 but the next character is also
8839 whitespace, we cannot wrap here. */
8840 if (it
->line_wrap
== WORD_WRAP
8843 && IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8846 void *tem_data
= NULL
;
8848 SAVE_IT (tem_it
, *it
, tem_data
);
8849 set_iterator_to_next (it
, true);
8850 if (get_next_display_element (it
)
8851 && IT_DISPLAYING_WHITESPACE (it
))
8853 RESTORE_IT (it
, &tem_it
, tem_data
);
8855 if (it
->line_wrap
!= WORD_WRAP
8857 /* If we've just found whitespace
8858 where we can wrap, effectively
8859 ignore the previous wrap point --
8860 it is no longer relevant, but we
8861 won't have an opportunity to
8862 update it, since we've reached
8863 the edge of this screen line. */
8864 || (may_wrap
&& can_wrap
8865 && IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8867 it
->hpos
= hpos_before_this_char
;
8868 it
->current_x
= x_before_this_char
;
8869 result
= MOVE_POS_MATCH_OR_ZV
;
8872 if (it
->line_wrap
== WORD_WRAP
8875 SAVE_IT (atpos_it
, *it
, atpos_data
);
8876 atpos_it
.current_x
= x_before_this_char
;
8877 atpos_it
.hpos
= hpos_before_this_char
;
8881 prev_method
= it
->method
;
8882 if (it
->method
== GET_FROM_BUFFER
)
8883 prev_pos
= IT_CHARPOS (*it
);
8884 set_iterator_to_next (it
, true);
8885 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8886 SET_TEXT_POS (this_line_min_pos
,
8887 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8888 /* On graphical terminals, newlines may
8889 "overflow" into the fringe if
8890 overflow-newline-into-fringe is non-nil.
8891 On text terminals, and on graphical
8892 terminals with no right margin, newlines
8893 may overflow into the last glyph on the
8895 if (!FRAME_WINDOW_P (it
->f
)
8897 && it
->bidi_it
.paragraph_dir
== R2L
)
8898 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8899 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8900 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8902 if (!get_next_display_element (it
))
8904 result
= MOVE_POS_MATCH_OR_ZV
;
8907 moved_forward
= true;
8908 if (BUFFER_POS_REACHED_P ())
8910 if (ITERATOR_AT_END_OF_LINE_P (it
))
8911 result
= MOVE_POS_MATCH_OR_ZV
;
8913 result
= MOVE_LINE_CONTINUED
;
8916 if (ITERATOR_AT_END_OF_LINE_P (it
)
8917 && (it
->line_wrap
!= WORD_WRAP
8919 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8921 result
= MOVE_NEWLINE_OR_CR
;
8928 IT_RESET_X_ASCENT_DESCENT (it
);
8930 /* If the screen line ends with whitespace, and we
8931 are under word-wrap, don't use wrap_it: it is no
8932 longer relevant, but we won't have an opportunity
8933 to update it, since we are done with this screen
8935 if (may_wrap
&& IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)
8936 /* If the character after the one which set the
8937 may_wrap flag is also whitespace, we can't
8938 wrap here, since the screen line cannot be
8939 wrapped in the middle of whitespace.
8940 Therefore, wrap_it _is_ relevant in that
8942 && !(moved_forward
&& IT_DISPLAYING_WHITESPACE (it
)))
8944 /* If we've found TO_X, go back there, as we now
8945 know the last word fits on this screen line. */
8946 if ((op
& MOVE_TO_X
) && new_x
== it
->last_visible_x
8949 RESTORE_IT (it
, &atx_it
, atx_data
);
8952 result
= MOVE_X_REACHED
;
8956 else if (wrap_it
.sp
>= 0)
8958 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8963 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8965 result
= MOVE_LINE_CONTINUED
;
8969 if (BUFFER_POS_REACHED_P ())
8971 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8972 goto buffer_pos_reached
;
8973 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8975 SAVE_IT (atpos_it
, *it
, atpos_data
);
8976 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8980 if (new_x
> it
->first_visible_x
)
8982 /* Glyph is visible. Increment number of glyphs that
8983 would be displayed. */
8988 if (result
!= MOVE_UNDEFINED
)
8991 else if (BUFFER_POS_REACHED_P ())
8994 IT_RESET_X_ASCENT_DESCENT (it
);
8995 result
= MOVE_POS_MATCH_OR_ZV
;
8998 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
9000 /* Stop when TO_X specified and reached. This check is
9001 necessary here because of lines consisting of a line end,
9002 only. The line end will not produce any glyphs and we
9003 would never get MOVE_X_REACHED. */
9004 eassert (it
->nglyphs
== 0);
9005 result
= MOVE_X_REACHED
;
9009 /* Is this a line end? If yes, we're done. */
9010 if (ITERATOR_AT_END_OF_LINE_P (it
))
9012 /* If we are past TO_CHARPOS, but never saw any character
9013 positions smaller than TO_CHARPOS, return
9014 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
9016 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
9018 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
9020 if (closest_pos
< ZV
)
9022 RESTORE_IT (it
, &ppos_it
, ppos_data
);
9023 /* Don't recurse if closest_pos is equal to
9024 to_charpos, since we have just tried that. */
9025 if (closest_pos
!= to_charpos
)
9026 move_it_in_display_line_to (it
, closest_pos
, -1,
9028 result
= MOVE_POS_MATCH_OR_ZV
;
9031 goto buffer_pos_reached
;
9033 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
9034 && IT_CHARPOS (*it
) > to_charpos
)
9035 goto buffer_pos_reached
;
9037 result
= MOVE_NEWLINE_OR_CR
;
9040 result
= MOVE_NEWLINE_OR_CR
;
9041 /* If we've processed the newline, make sure this flag is
9042 reset, as it must only be set when the newline itself is
9044 if (result
== MOVE_NEWLINE_OR_CR
)
9045 it
->constrain_row_ascent_descent_p
= false;
9049 prev_method
= it
->method
;
9050 if (it
->method
== GET_FROM_BUFFER
)
9051 prev_pos
= IT_CHARPOS (*it
);
9052 /* The current display element has been consumed. Advance
9054 set_iterator_to_next (it
, true);
9055 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
9056 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
9057 if (IT_CHARPOS (*it
) < to_charpos
)
9058 saw_smaller_pos
= true;
9060 && (op
& MOVE_TO_POS
)
9061 && IT_CHARPOS (*it
) >= to_charpos
9062 && IT_CHARPOS (*it
) < closest_pos
)
9063 closest_pos
= IT_CHARPOS (*it
);
9065 /* Stop if lines are truncated and IT's current x-position is
9066 past the right edge of the window now. */
9067 if (it
->line_wrap
== TRUNCATE
9068 && it
->current_x
>= it
->last_visible_x
)
9070 if (!FRAME_WINDOW_P (it
->f
)
9071 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
9072 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
9073 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
9074 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
9076 bool at_eob_p
= false;
9078 if ((at_eob_p
= !get_next_display_element (it
))
9079 || BUFFER_POS_REACHED_P ()
9080 /* If we are past TO_CHARPOS, but never saw any
9081 character positions smaller than TO_CHARPOS,
9082 return MOVE_POS_MATCH_OR_ZV, like the
9083 unidirectional display did. */
9084 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
9086 && IT_CHARPOS (*it
) > to_charpos
))
9089 && !BUFFER_POS_REACHED_P ()
9090 && !at_eob_p
&& closest_pos
< ZV
)
9092 RESTORE_IT (it
, &ppos_it
, ppos_data
);
9093 if (closest_pos
!= to_charpos
)
9094 move_it_in_display_line_to (it
, closest_pos
, -1,
9097 result
= MOVE_POS_MATCH_OR_ZV
;
9100 if (ITERATOR_AT_END_OF_LINE_P (it
))
9102 result
= MOVE_NEWLINE_OR_CR
;
9106 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
9108 && IT_CHARPOS (*it
) > to_charpos
)
9110 if (closest_pos
< ZV
)
9112 RESTORE_IT (it
, &ppos_it
, ppos_data
);
9113 if (closest_pos
!= to_charpos
)
9114 move_it_in_display_line_to (it
, closest_pos
, -1,
9117 result
= MOVE_POS_MATCH_OR_ZV
;
9120 result
= MOVE_LINE_TRUNCATED
;
9123 #undef IT_RESET_X_ASCENT_DESCENT
9126 #undef BUFFER_POS_REACHED_P
9128 /* If we scanned beyond TO_POS, restore the saved iterator either to
9129 the wrap point (if found), or to atpos/atx location. We decide which
9130 data to use to restore the saved iterator state by their X coordinates,
9131 since buffer positions might increase non-monotonically with screen
9132 coordinates due to bidi reordering. */
9133 if (result
== MOVE_LINE_CONTINUED
9134 && it
->line_wrap
== WORD_WRAP
9136 && ((atpos_it
.sp
>= 0 && wrap_it
.current_x
< atpos_it
.current_x
)
9137 || (atx_it
.sp
>= 0 && wrap_it
.current_x
< atx_it
.current_x
)))
9138 RESTORE_IT (it
, &wrap_it
, wrap_data
);
9139 else if (atpos_it
.sp
>= 0)
9140 RESTORE_IT (it
, &atpos_it
, atpos_data
);
9141 else if (atx_it
.sp
>= 0)
9142 RESTORE_IT (it
, &atx_it
, atx_data
);
9147 bidi_unshelve_cache (atpos_data
, true);
9149 bidi_unshelve_cache (atx_data
, true);
9151 bidi_unshelve_cache (wrap_data
, true);
9153 bidi_unshelve_cache (ppos_data
, true);
9155 /* Restore the iterator settings altered at the beginning of this
9157 it
->glyph_row
= saved_glyph_row
;
9161 /* For external use. */
9163 move_it_in_display_line (struct it
*it
,
9164 ptrdiff_t to_charpos
, int to_x
,
9165 enum move_operation_enum op
)
9167 if (it
->line_wrap
== WORD_WRAP
9168 && (op
& MOVE_TO_X
))
9171 void *save_data
= NULL
;
9174 SAVE_IT (save_it
, *it
, save_data
);
9175 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9176 /* When word-wrap is on, TO_X may lie past the end
9177 of a wrapped line. Then it->current is the
9178 character on the next line, so backtrack to the
9179 space before the wrap point. */
9180 if (skip
== MOVE_LINE_CONTINUED
)
9182 int prev_x
= max (it
->current_x
- 1, 0);
9183 RESTORE_IT (it
, &save_it
, save_data
);
9184 move_it_in_display_line_to
9185 (it
, -1, prev_x
, MOVE_TO_X
);
9188 bidi_unshelve_cache (save_data
, true);
9191 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9195 /* Move IT forward until it satisfies one or more of the criteria in
9196 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9198 OP is a bit-mask that specifies where to stop, and in particular,
9199 which of those four position arguments makes a difference. See the
9200 description of enum move_operation_enum.
9202 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9203 screen line, this function will set IT to the next position that is
9204 displayed to the right of TO_CHARPOS on the screen.
9206 Return the maximum pixel length of any line scanned but never more
9207 than it.last_visible_x. */
9210 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9212 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9213 int line_height
, line_start_x
= 0, reached
= 0;
9214 int max_current_x
= 0;
9215 void *backup_data
= NULL
;
9219 if (op
& MOVE_TO_VPOS
)
9221 /* If no TO_CHARPOS and no TO_X specified, stop at the
9222 start of the line TO_VPOS. */
9223 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9225 if (it
->vpos
== to_vpos
)
9231 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9235 /* TO_VPOS >= 0 means stop at TO_X in the line at
9236 TO_VPOS, or at TO_POS, whichever comes first. */
9237 if (it
->vpos
== to_vpos
)
9243 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9245 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9250 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9252 /* We have reached TO_X but not in the line we want. */
9253 skip
= move_it_in_display_line_to (it
, to_charpos
,
9255 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9263 else if (op
& MOVE_TO_Y
)
9265 struct it it_backup
;
9267 if (it
->line_wrap
== WORD_WRAP
)
9268 SAVE_IT (it_backup
, *it
, backup_data
);
9270 /* TO_Y specified means stop at TO_X in the line containing
9271 TO_Y---or at TO_CHARPOS if this is reached first. The
9272 problem is that we can't really tell whether the line
9273 contains TO_Y before we have completely scanned it, and
9274 this may skip past TO_X. What we do is to first scan to
9277 If TO_X is not specified, use a TO_X of zero. The reason
9278 is to make the outcome of this function more predictable.
9279 If we didn't use TO_X == 0, we would stop at the end of
9280 the line which is probably not what a caller would expect
9282 skip
= move_it_in_display_line_to
9283 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9284 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9286 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9287 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9289 else if (skip
== MOVE_X_REACHED
)
9291 /* If TO_X was reached, we want to know whether TO_Y is
9292 in the line. We know this is the case if the already
9293 scanned glyphs make the line tall enough. Otherwise,
9294 we must check by scanning the rest of the line. */
9295 line_height
= it
->max_ascent
+ it
->max_descent
;
9296 if (to_y
>= it
->current_y
9297 && to_y
< it
->current_y
+ line_height
)
9302 SAVE_IT (it_backup
, *it
, backup_data
);
9303 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9304 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9306 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9307 line_height
= it
->max_ascent
+ it
->max_descent
;
9308 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9310 if (to_y
>= it
->current_y
9311 && to_y
< it
->current_y
+ line_height
)
9313 /* If TO_Y is in this line and TO_X was reached
9314 above, we scanned too far. We have to restore
9315 IT's settings to the ones before skipping. But
9316 keep the more accurate values of max_ascent and
9317 max_descent we've found while skipping the rest
9318 of the line, for the sake of callers, such as
9319 pos_visible_p, that need to know the line
9321 int max_ascent
= it
->max_ascent
;
9322 int max_descent
= it
->max_descent
;
9324 RESTORE_IT (it
, &it_backup
, backup_data
);
9325 it
->max_ascent
= max_ascent
;
9326 it
->max_descent
= max_descent
;
9332 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9338 /* Check whether TO_Y is in this line. */
9339 line_height
= it
->max_ascent
+ it
->max_descent
;
9340 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9342 if (to_y
>= it
->current_y
9343 && to_y
< it
->current_y
+ line_height
)
9345 if (to_y
> it
->current_y
)
9346 max_current_x
= max (it
->current_x
, max_current_x
);
9348 /* When word-wrap is on, TO_X may lie past the end
9349 of a wrapped line. Then it->current is the
9350 character on the next line, so backtrack to the
9351 space before the wrap point. */
9352 if (skip
== MOVE_LINE_CONTINUED
9353 && it
->line_wrap
== WORD_WRAP
)
9355 int prev_x
= max (it
->current_x
- 1, 0);
9356 RESTORE_IT (it
, &it_backup
, backup_data
);
9357 skip
= move_it_in_display_line_to
9358 (it
, -1, prev_x
, MOVE_TO_X
);
9367 max_current_x
= max (it
->current_x
, max_current_x
);
9371 else if (BUFFERP (it
->object
)
9372 && (it
->method
== GET_FROM_BUFFER
9373 || it
->method
== GET_FROM_STRETCH
)
9374 && IT_CHARPOS (*it
) >= to_charpos
9375 /* Under bidi iteration, a call to set_iterator_to_next
9376 can scan far beyond to_charpos if the initial
9377 portion of the next line needs to be reordered. In
9378 that case, give move_it_in_display_line_to another
9381 && it
->bidi_it
.scan_dir
== -1))
9382 skip
= MOVE_POS_MATCH_OR_ZV
;
9384 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9388 case MOVE_POS_MATCH_OR_ZV
:
9389 max_current_x
= max (it
->current_x
, max_current_x
);
9393 case MOVE_NEWLINE_OR_CR
:
9394 max_current_x
= max (it
->current_x
, max_current_x
);
9395 set_iterator_to_next (it
, true);
9396 it
->continuation_lines_width
= 0;
9399 case MOVE_LINE_TRUNCATED
:
9400 max_current_x
= it
->last_visible_x
;
9401 it
->continuation_lines_width
= 0;
9402 reseat_at_next_visible_line_start (it
, false);
9403 if ((op
& MOVE_TO_POS
) != 0
9404 && IT_CHARPOS (*it
) > to_charpos
)
9411 case MOVE_LINE_CONTINUED
:
9412 max_current_x
= it
->last_visible_x
;
9413 /* For continued lines ending in a tab, some of the glyphs
9414 associated with the tab are displayed on the current
9415 line. Since it->current_x does not include these glyphs,
9416 we use it->last_visible_x instead. */
9419 it
->continuation_lines_width
+= it
->last_visible_x
;
9420 /* When moving by vpos, ensure that the iterator really
9421 advances to the next line (bug#847, bug#969). Fixme:
9422 do we need to do this in other circumstances? */
9423 if (it
->current_x
!= it
->last_visible_x
9424 && (op
& MOVE_TO_VPOS
)
9425 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9427 line_start_x
= it
->current_x
+ it
->pixel_width
9428 - it
->last_visible_x
;
9429 if (FRAME_WINDOW_P (it
->f
))
9431 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9432 struct font
*face_font
= face
->font
;
9434 /* When display_line produces a continued line
9435 that ends in a TAB, it skips a tab stop that
9436 is closer than the font's space character
9437 width (see x_produce_glyphs where it produces
9438 the stretch glyph which represents a TAB).
9439 We need to reproduce the same logic here. */
9440 eassert (face_font
);
9443 if (line_start_x
< face_font
->space_width
)
9445 += it
->tab_width
* face_font
->space_width
;
9448 set_iterator_to_next (it
, false);
9452 it
->continuation_lines_width
+= it
->current_x
;
9459 /* Reset/increment for the next run. */
9460 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9461 it
->current_x
= line_start_x
;
9464 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9466 last_height
= it
->max_ascent
+ it
->max_descent
;
9467 it
->max_ascent
= it
->max_descent
= 0;
9472 /* On text terminals, we may stop at the end of a line in the middle
9473 of a multi-character glyph. If the glyph itself is continued,
9474 i.e. it is actually displayed on the next line, don't treat this
9475 stopping point as valid; move to the next line instead (unless
9476 that brings us offscreen). */
9477 if (!FRAME_WINDOW_P (it
->f
)
9479 && IT_CHARPOS (*it
) == to_charpos
9480 && it
->what
== IT_CHARACTER
9482 && it
->line_wrap
== WINDOW_WRAP
9483 && it
->current_x
== it
->last_visible_x
- 1
9486 && it
->w
->window_end_valid
9487 && it
->vpos
< it
->w
->window_end_vpos
)
9489 it
->continuation_lines_width
+= it
->current_x
;
9490 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9491 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9493 last_height
= it
->max_ascent
+ it
->max_descent
;
9497 bidi_unshelve_cache (backup_data
, true);
9499 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9501 return max_current_x
;
9505 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9507 If DY > 0, move IT backward at least that many pixels. DY = 0
9508 means move IT backward to the preceding line start or BEGV. This
9509 function may move over more than DY pixels if IT->current_y - DY
9510 ends up in the middle of a line; in this case IT->current_y will be
9511 set to the top of the line moved to. */
9514 move_it_vertically_backward (struct it
*it
, int dy
)
9518 void *it2data
= NULL
, *it3data
= NULL
;
9519 ptrdiff_t start_pos
;
9521 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9522 ptrdiff_t pos_limit
;
9527 start_pos
= IT_CHARPOS (*it
);
9529 /* Estimate how many newlines we must move back. */
9530 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9531 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9534 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9536 /* Set the iterator's position that many lines back. But don't go
9537 back more than NLINES full screen lines -- this wins a day with
9538 buffers which have very long lines. */
9539 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9540 back_to_previous_visible_line_start (it
);
9542 /* Reseat the iterator here. When moving backward, we don't want
9543 reseat to skip forward over invisible text, set up the iterator
9544 to deliver from overlay strings at the new position etc. So,
9545 use reseat_1 here. */
9546 reseat_1 (it
, it
->current
.pos
, true);
9548 /* We are now surely at a line start. */
9549 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9550 reordering is in effect. */
9551 it
->continuation_lines_width
= 0;
9553 /* Move forward and see what y-distance we moved. First move to the
9554 start of the next line so that we get its height. We need this
9555 height to be able to tell whether we reached the specified
9557 SAVE_IT (it2
, *it
, it2data
);
9558 it2
.max_ascent
= it2
.max_descent
= 0;
9561 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9562 MOVE_TO_POS
| MOVE_TO_VPOS
);
9564 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9565 /* If we are in a display string which starts at START_POS,
9566 and that display string includes a newline, and we are
9567 right after that newline (i.e. at the beginning of a
9568 display line), exit the loop, because otherwise we will
9569 infloop, since move_it_to will see that it is already at
9570 START_POS and will not move. */
9571 || (it2
.method
== GET_FROM_STRING
9572 && IT_CHARPOS (it2
) == start_pos
9573 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9574 eassert (IT_CHARPOS (*it
) >= BEGV
);
9575 SAVE_IT (it3
, it2
, it3data
);
9577 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9578 eassert (IT_CHARPOS (*it
) >= BEGV
);
9579 /* H is the actual vertical distance from the position in *IT
9580 and the starting position. */
9581 h
= it2
.current_y
- it
->current_y
;
9582 /* NLINES is the distance in number of lines. */
9583 nlines
= it2
.vpos
- it
->vpos
;
9585 /* Correct IT's y and vpos position
9586 so that they are relative to the starting point. */
9592 /* DY == 0 means move to the start of the screen line. The
9593 value of nlines is > 0 if continuation lines were involved,
9594 or if the original IT position was at start of a line. */
9595 RESTORE_IT (it
, it
, it2data
);
9597 move_it_by_lines (it
, nlines
);
9598 /* The above code moves us to some position NLINES down,
9599 usually to its first glyph (leftmost in an L2R line), but
9600 that's not necessarily the start of the line, under bidi
9601 reordering. We want to get to the character position
9602 that is immediately after the newline of the previous
9605 && !it
->continuation_lines_width
9606 && !STRINGP (it
->string
)
9607 && IT_CHARPOS (*it
) > BEGV
9608 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9610 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9613 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9614 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9616 bidi_unshelve_cache (it3data
, true);
9620 /* The y-position we try to reach, relative to *IT.
9621 Note that H has been subtracted in front of the if-statement. */
9622 int target_y
= it
->current_y
+ h
- dy
;
9623 int y0
= it3
.current_y
;
9627 RESTORE_IT (&it3
, &it3
, it3data
);
9628 y1
= line_bottom_y (&it3
);
9629 line_height
= y1
- y0
;
9630 RESTORE_IT (it
, it
, it2data
);
9631 /* If we did not reach target_y, try to move further backward if
9632 we can. If we moved too far backward, try to move forward. */
9633 if (target_y
< it
->current_y
9634 /* This is heuristic. In a window that's 3 lines high, with
9635 a line height of 13 pixels each, recentering with point
9636 on the bottom line will try to move -39/2 = 19 pixels
9637 backward. Try to avoid moving into the first line. */
9638 && (it
->current_y
- target_y
9639 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9640 && IT_CHARPOS (*it
) > BEGV
)
9642 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9643 target_y
- it
->current_y
));
9644 dy
= it
->current_y
- target_y
;
9645 goto move_further_back
;
9647 else if (target_y
>= it
->current_y
+ line_height
9648 && IT_CHARPOS (*it
) < ZV
)
9650 /* Should move forward by at least one line, maybe more.
9652 Note: Calling move_it_by_lines can be expensive on
9653 terminal frames, where compute_motion is used (via
9654 vmotion) to do the job, when there are very long lines
9655 and truncate-lines is nil. That's the reason for
9656 treating terminal frames specially here. */
9658 if (!FRAME_WINDOW_P (it
->f
))
9659 move_it_vertically (it
, target_y
- it
->current_y
);
9664 move_it_by_lines (it
, 1);
9666 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9673 /* Move IT by a specified amount of pixel lines DY. DY negative means
9674 move backwards. DY = 0 means move to start of screen line. At the
9675 end, IT will be on the start of a screen line. */
9678 move_it_vertically (struct it
*it
, int dy
)
9681 move_it_vertically_backward (it
, -dy
);
9684 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9685 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9686 MOVE_TO_POS
| MOVE_TO_Y
);
9687 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9689 /* If buffer ends in ZV without a newline, move to the start of
9690 the line to satisfy the post-condition. */
9691 if (IT_CHARPOS (*it
) == ZV
9693 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9694 move_it_by_lines (it
, 0);
9699 /* Move iterator IT past the end of the text line it is in. */
9702 move_it_past_eol (struct it
*it
)
9704 enum move_it_result rc
;
9706 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9707 if (rc
== MOVE_NEWLINE_OR_CR
)
9708 set_iterator_to_next (it
, false);
9712 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9713 negative means move up. DVPOS == 0 means move to the start of the
9716 Optimization idea: If we would know that IT->f doesn't use
9717 a face with proportional font, we could be faster for
9718 truncate-lines nil. */
9721 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9724 /* The commented-out optimization uses vmotion on terminals. This
9725 gives bad results, because elements like it->what, on which
9726 callers such as pos_visible_p rely, aren't updated. */
9727 /* struct position pos;
9728 if (!FRAME_WINDOW_P (it->f))
9730 struct text_pos textpos;
9732 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9733 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9734 reseat (it, textpos, true);
9735 it->vpos += pos.vpos;
9736 it->current_y += pos.vpos;
9742 /* DVPOS == 0 means move to the start of the screen line. */
9743 move_it_vertically_backward (it
, 0);
9744 /* Let next call to line_bottom_y calculate real line height. */
9749 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9750 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9752 /* Only move to the next buffer position if we ended up in a
9753 string from display property, not in an overlay string
9754 (before-string or after-string). That is because the
9755 latter don't conceal the underlying buffer position, so
9756 we can ask to move the iterator to the exact position we
9757 are interested in. Note that, even if we are already at
9758 IT_CHARPOS (*it), the call below is not a no-op, as it
9759 will detect that we are at the end of the string, pop the
9760 iterator, and compute it->current_x and it->hpos
9762 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9763 -1, -1, -1, MOVE_TO_POS
);
9769 void *it2data
= NULL
;
9770 ptrdiff_t start_charpos
, i
;
9772 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9773 bool hit_pos_limit
= false;
9774 ptrdiff_t pos_limit
;
9776 /* Start at the beginning of the screen line containing IT's
9777 position. This may actually move vertically backwards,
9778 in case of overlays, so adjust dvpos accordingly. */
9780 move_it_vertically_backward (it
, 0);
9783 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9784 screen lines, and reseat the iterator there. */
9785 start_charpos
= IT_CHARPOS (*it
);
9786 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9789 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9791 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9792 back_to_previous_visible_line_start (it
);
9793 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9794 hit_pos_limit
= true;
9795 reseat (it
, it
->current
.pos
, true);
9797 /* Move further back if we end up in a string or an image. */
9798 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9800 /* First try to move to start of display line. */
9802 move_it_vertically_backward (it
, 0);
9804 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9806 /* If start of line is still in string or image,
9807 move further back. */
9808 back_to_previous_visible_line_start (it
);
9809 reseat (it
, it
->current
.pos
, true);
9813 it
->current_x
= it
->hpos
= 0;
9815 /* Above call may have moved too far if continuation lines
9816 are involved. Scan forward and see if it did. */
9817 SAVE_IT (it2
, *it
, it2data
);
9818 it2
.vpos
= it2
.current_y
= 0;
9819 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9820 it
->vpos
-= it2
.vpos
;
9821 it
->current_y
-= it2
.current_y
;
9822 it
->current_x
= it
->hpos
= 0;
9824 /* If we moved too far back, move IT some lines forward. */
9825 if (it2
.vpos
> -dvpos
)
9827 int delta
= it2
.vpos
+ dvpos
;
9829 RESTORE_IT (&it2
, &it2
, it2data
);
9830 SAVE_IT (it2
, *it
, it2data
);
9831 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9832 /* Move back again if we got too far ahead. */
9833 if (IT_CHARPOS (*it
) >= start_charpos
)
9834 RESTORE_IT (it
, &it2
, it2data
);
9836 bidi_unshelve_cache (it2data
, true);
9838 else if (hit_pos_limit
&& pos_limit
> BEGV
9839 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9841 /* If we hit the limit, but still didn't make it far enough
9842 back, that means there's a display string with a newline
9843 covering a large chunk of text, and that caused
9844 back_to_previous_visible_line_start try to go too far.
9845 Punish those who commit such atrocities by going back
9846 until we've reached DVPOS, after lifting the limit, which
9847 could make it slow for very long lines. "If it hurts,
9850 RESTORE_IT (it
, it
, it2data
);
9851 for (i
= -dvpos
; i
> 0; --i
)
9853 back_to_previous_visible_line_start (it
);
9856 reseat_1 (it
, it
->current
.pos
, true);
9859 RESTORE_IT (it
, it
, it2data
);
9863 /* Return true if IT points into the middle of a display vector. */
9866 in_display_vector_p (struct it
*it
)
9868 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9869 && it
->current
.dpvec_index
> 0
9870 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9873 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9874 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9875 WINDOW must be a live window and defaults to the selected one. The
9876 return value is a cons of the maximum pixel-width of any text line and
9877 the maximum pixel-height of all text lines.
9879 The optional argument FROM, if non-nil, specifies the first text
9880 position and defaults to the minimum accessible position of the buffer.
9881 If FROM is t, use the minimum accessible position that starts a
9882 non-empty line. TO, if non-nil, specifies the last text position and
9883 defaults to the maximum accessible position of the buffer. If TO is t,
9884 use the maximum accessible position that ends a non-empty line.
9886 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9887 width that can be returned. X-LIMIT nil or omitted, means to use the
9888 pixel-width of WINDOW's body; use this if you want to know how high
9889 WINDOW should be become in order to fit all of its buffer's text with
9890 the width of WINDOW unaltered. Use the maximum width WINDOW may assume
9891 if you intend to change WINDOW's width. In any case, text whose
9892 x-coordinate is beyond X-LIMIT is ignored. Since calculating the width
9893 of long lines can take some time, it's always a good idea to make this
9894 argument as small as possible; in particular, if the buffer contains
9895 long lines that shall be truncated anyway.
9897 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9898 height (excluding the height of the mode- or header-line, if any) that
9899 can be returned. Text lines whose y-coordinate is beyond Y-LIMIT are
9900 ignored. Since calculating the text height of a large buffer can take
9901 some time, it makes sense to specify this argument if the size of the
9902 buffer is large or unknown.
9904 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9905 include the height of the mode- or header-line of WINDOW in the return
9906 value. If it is either the symbol `mode-line' or `header-line', include
9907 only the height of that line, if present, in the return value. If t,
9908 include the height of both, if present, in the return value. */)
9909 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
,
9910 Lisp_Object y_limit
, Lisp_Object mode_and_header_line
)
9912 struct window
*w
= decode_live_window (window
);
9913 Lisp_Object buffer
= w
->contents
;
9916 struct buffer
*old_b
= NULL
;
9917 ptrdiff_t start
, end
, pos
;
9918 struct text_pos startp
;
9919 void *itdata
= NULL
;
9920 int c
, max_x
= 0, max_y
= 0, x
= 0, y
= 0;
9922 CHECK_BUFFER (buffer
);
9923 b
= XBUFFER (buffer
);
9925 if (b
!= current_buffer
)
9927 old_b
= current_buffer
;
9928 set_buffer_internal (b
);
9933 else if (EQ (from
, Qt
))
9936 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9937 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9939 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9944 CHECK_NUMBER_COERCE_MARKER (from
);
9945 start
= min (max (XINT (from
), BEGV
), ZV
);
9950 else if (EQ (to
, Qt
))
9953 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9954 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9956 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9961 CHECK_NUMBER_COERCE_MARKER (to
);
9962 end
= max (start
, min (XINT (to
), ZV
));
9965 if (!NILP (x_limit
) && RANGED_INTEGERP (0, x_limit
, INT_MAX
))
9966 max_x
= XINT (x_limit
);
9970 else if (RANGED_INTEGERP (0, y_limit
, INT_MAX
))
9971 max_y
= XINT (y_limit
);
9973 itdata
= bidi_shelve_cache ();
9974 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9975 start_display (&it
, w
, startp
);
9978 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9981 it
.last_visible_x
= max_x
;
9982 /* Actually, we never want move_it_to stop at to_x. But to make
9983 sure that move_it_in_display_line_to always moves far enough,
9984 we set it to INT_MAX and specify MOVE_TO_X. Also bound width
9985 value by X-LIMIT. */
9986 x
= min (move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9987 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
),
9991 /* Subtract height of header-line which was counted automatically by
9993 y
= min (it
.current_y
+ it
.max_ascent
+ it
.max_descent
9994 - WINDOW_HEADER_LINE_HEIGHT (w
),
9997 if (EQ (mode_and_header_line
, Qheader_line
)
9998 || EQ (mode_and_header_line
, Qt
))
9999 /* Re-add height of header-line as requested. */
10000 y
= y
+ WINDOW_HEADER_LINE_HEIGHT (w
);
10002 if (EQ (mode_and_header_line
, Qmode_line
)
10003 || EQ (mode_and_header_line
, Qt
))
10004 /* Add height of mode-line as requested. */
10005 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
10007 bidi_unshelve_cache (itdata
, false);
10010 set_buffer_internal (old_b
);
10012 return Fcons (make_number (x
), make_number (y
));
10015 /***********************************************************************
10017 ***********************************************************************/
10019 /* Return the number of arguments the format string FORMAT needs. */
10022 format_nargs (char const *format
)
10024 ptrdiff_t nargs
= 0;
10025 for (char const *p
= format
; (p
= strchr (p
, '%')); p
++)
10033 /* Add a message with format string FORMAT and formatted arguments
10037 add_to_log (const char *format
, ...)
10040 va_start (ap
, format
);
10041 vadd_to_log (format
, ap
);
10046 vadd_to_log (char const *format
, va_list ap
)
10048 ptrdiff_t form_nargs
= format_nargs (format
);
10049 ptrdiff_t nargs
= 1 + form_nargs
;
10050 Lisp_Object args
[10];
10051 eassert (nargs
<= ARRAYELTS (args
));
10052 AUTO_STRING (args0
, format
);
10054 for (ptrdiff_t i
= 1; i
<= nargs
; i
++)
10055 args
[i
] = va_arg (ap
, Lisp_Object
);
10056 Lisp_Object msg
= Qnil
;
10057 msg
= Fformat_message (nargs
, args
);
10059 ptrdiff_t len
= SBYTES (msg
) + 1;
10061 char *buffer
= SAFE_ALLOCA (len
);
10062 memcpy (buffer
, SDATA (msg
), len
);
10064 message_dolog (buffer
, len
- 1, true, STRING_MULTIBYTE (msg
));
10069 /* Output a newline in the *Messages* buffer if "needs" one. */
10072 message_log_maybe_newline (void)
10074 if (message_log_need_newline
)
10075 message_dolog ("", 0, true, false);
10079 /* Add a string M of length NBYTES to the message log, optionally
10080 terminated with a newline when NLFLAG is true. MULTIBYTE, if
10081 true, means interpret the contents of M as multibyte. This
10082 function calls low-level routines in order to bypass text property
10083 hooks, etc. which might not be safe to run.
10085 This may GC (insert may run before/after change hooks),
10086 so the buffer M must NOT point to a Lisp string. */
10089 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
10091 const unsigned char *msg
= (const unsigned char *) m
;
10093 if (!NILP (Vmemory_full
))
10096 if (!NILP (Vmessage_log_max
))
10098 struct buffer
*oldbuf
;
10099 Lisp_Object oldpoint
, oldbegv
, oldzv
;
10100 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
10101 ptrdiff_t point_at_end
= 0;
10102 ptrdiff_t zv_at_end
= 0;
10103 Lisp_Object old_deactivate_mark
;
10105 old_deactivate_mark
= Vdeactivate_mark
;
10106 oldbuf
= current_buffer
;
10108 /* Ensure the Messages buffer exists, and switch to it.
10109 If we created it, set the major-mode. */
10110 bool newbuffer
= NILP (Fget_buffer (Vmessages_buffer_name
));
10111 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
10113 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
10114 call0 (intern ("messages-buffer-mode"));
10116 bset_undo_list (current_buffer
, Qt
);
10117 bset_cache_long_scans (current_buffer
, Qnil
);
10119 oldpoint
= message_dolog_marker1
;
10120 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
10121 oldbegv
= message_dolog_marker2
;
10122 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
10123 oldzv
= message_dolog_marker3
;
10124 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
10132 BEGV_BYTE
= BEG_BYTE
;
10135 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10137 /* Insert the string--maybe converting multibyte to single byte
10138 or vice versa, so that all the text fits the buffer. */
10140 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10146 /* Convert a multibyte string to single-byte
10147 for the *Message* buffer. */
10148 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
10150 c
= string_char_and_length (msg
+ i
, &char_bytes
);
10151 work
[0] = CHAR_TO_BYTE8 (c
);
10152 insert_1_both (work
, 1, 1, true, false, false);
10155 else if (! multibyte
10156 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10160 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10161 /* Convert a single-byte string to multibyte
10162 for the *Message* buffer. */
10163 for (i
= 0; i
< nbytes
; i
++)
10166 MAKE_CHAR_MULTIBYTE (c
);
10167 char_bytes
= CHAR_STRING (c
, str
);
10168 insert_1_both ((char *) str
, 1, char_bytes
, true, false, false);
10172 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
,
10173 true, false, false);
10177 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
10180 insert_1_both ("\n", 1, 1, true, false, false);
10182 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, false);
10184 this_bol_byte
= PT_BYTE
;
10186 /* See if this line duplicates the previous one.
10187 If so, combine duplicates. */
10188 if (this_bol
> BEG
)
10190 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, false);
10192 prev_bol_byte
= PT_BYTE
;
10194 dups
= message_log_check_duplicate (prev_bol_byte
,
10198 del_range_both (prev_bol
, prev_bol_byte
,
10199 this_bol
, this_bol_byte
, false);
10202 char dupstr
[sizeof " [ times]"
10203 + INT_STRLEN_BOUND (printmax_t
)];
10205 /* If you change this format, don't forget to also
10206 change message_log_check_duplicate. */
10207 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
10208 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
10209 insert_1_both (dupstr
, duplen
, duplen
,
10210 true, false, true);
10215 /* If we have more than the desired maximum number of lines
10216 in the *Messages* buffer now, delete the oldest ones.
10217 This is safe because we don't have undo in this buffer. */
10219 if (NATNUMP (Vmessage_log_max
))
10221 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10222 -XFASTINT (Vmessage_log_max
) - 1, false);
10223 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, false);
10226 BEGV
= marker_position (oldbegv
);
10227 BEGV_BYTE
= marker_byte_position (oldbegv
);
10236 ZV
= marker_position (oldzv
);
10237 ZV_BYTE
= marker_byte_position (oldzv
);
10241 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10243 /* We can't do Fgoto_char (oldpoint) because it will run some
10245 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10246 marker_byte_position (oldpoint
));
10248 unchain_marker (XMARKER (oldpoint
));
10249 unchain_marker (XMARKER (oldbegv
));
10250 unchain_marker (XMARKER (oldzv
));
10252 /* We called insert_1_both above with its 5th argument (PREPARE)
10253 false, which prevents insert_1_both from calling
10254 prepare_to_modify_buffer, which in turns prevents us from
10255 incrementing windows_or_buffers_changed even if *Messages* is
10256 shown in some window. So we must manually set
10257 windows_or_buffers_changed here to make up for that. */
10258 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10259 bset_redisplay (current_buffer
);
10261 set_buffer_internal (oldbuf
);
10263 message_log_need_newline
= !nlflag
;
10264 Vdeactivate_mark
= old_deactivate_mark
;
10269 /* We are at the end of the buffer after just having inserted a newline.
10270 (Note: We depend on the fact we won't be crossing the gap.)
10271 Check to see if the most recent message looks a lot like the previous one.
10272 Return 0 if different, 1 if the new one should just replace it, or a
10273 value N > 1 if we should also append " [N times]". */
10276 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10279 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10280 bool seen_dots
= false;
10281 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10282 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10284 for (i
= 0; i
< len
; i
++)
10286 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10288 if (p1
[i
] != p2
[i
])
10294 if (*p1
++ == ' ' && *p1
++ == '[')
10297 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10298 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10305 /* Display an echo area message M with a specified length of NBYTES
10306 bytes. The string may include null characters. If M is not a
10307 string, clear out any existing message, and let the mini-buffer
10310 This function cancels echoing. */
10313 message3 (Lisp_Object m
)
10315 clear_message (true, true);
10318 /* First flush out any partial line written with print. */
10319 message_log_maybe_newline ();
10322 ptrdiff_t nbytes
= SBYTES (m
);
10323 bool multibyte
= STRING_MULTIBYTE (m
);
10326 SAFE_ALLOCA_STRING (buffer
, m
);
10327 message_dolog (buffer
, nbytes
, true, multibyte
);
10330 if (! inhibit_message
)
10331 message3_nolog (m
);
10334 /* Log the message M to stderr. Log an empty line if M is not a string. */
10337 message_to_stderr (Lisp_Object m
)
10339 if (noninteractive_need_newline
)
10341 noninteractive_need_newline
= false;
10342 fputc ('\n', stderr
);
10346 Lisp_Object coding_system
= Vlocale_coding_system
;
10349 if (!NILP (Vcoding_system_for_write
))
10350 coding_system
= Vcoding_system_for_write
;
10351 if (!NILP (coding_system
))
10352 s
= code_convert_string_norecord (m
, coding_system
, true);
10356 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10358 if (!cursor_in_echo_area
)
10359 fputc ('\n', stderr
);
10363 /* The non-logging version of message3.
10364 This does not cancel echoing, because it is used for echoing.
10365 Perhaps we need to make a separate function for echoing
10366 and make this cancel echoing. */
10369 message3_nolog (Lisp_Object m
)
10371 struct frame
*sf
= SELECTED_FRAME ();
10373 if (FRAME_INITIAL_P (sf
))
10374 message_to_stderr (m
);
10375 /* Error messages get reported properly by cmd_error, so this must be just an
10376 informative message; if the frame hasn't really been initialized yet, just
10378 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10380 /* Get the frame containing the mini-buffer
10381 that the selected frame is using. */
10382 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10383 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10384 struct frame
*f
= XFRAME (frame
);
10386 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10387 Fmake_frame_visible (frame
);
10389 if (STRINGP (m
) && SCHARS (m
) > 0)
10392 if (minibuffer_auto_raise
)
10393 Fraise_frame (frame
);
10394 /* Assume we are not echoing.
10395 (If we are, echo_now will override this.) */
10396 echo_message_buffer
= Qnil
;
10399 clear_message (true, true);
10401 do_pending_window_change (false);
10402 echo_area_display (true);
10403 do_pending_window_change (false);
10404 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10405 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10410 /* Display a null-terminated echo area message M. If M is 0, clear
10411 out any existing message, and let the mini-buffer text show through.
10413 The buffer M must continue to exist until after the echo area gets
10414 cleared or some other message gets displayed there. Do not pass
10415 text that is stored in a Lisp string. Do not pass text in a buffer
10416 that was alloca'd. */
10419 message1 (const char *m
)
10421 message3 (m
? build_unibyte_string (m
) : Qnil
);
10425 /* The non-logging counterpart of message1. */
10428 message1_nolog (const char *m
)
10430 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10433 /* Display a message M which contains a single %s
10434 which gets replaced with STRING. */
10437 message_with_string (const char *m
, Lisp_Object string
, bool log
)
10439 CHECK_STRING (string
);
10442 if (noninteractive
)
10443 need_message
= !!m
;
10444 else if (!INTERACTIVE
)
10445 need_message
= false;
10448 /* The frame whose minibuffer we're going to display the message on.
10449 It may be larger than the selected frame, so we need
10450 to use its buffer, not the selected frame's buffer. */
10451 Lisp_Object mini_window
;
10452 struct frame
*f
, *sf
= SELECTED_FRAME ();
10454 /* Get the frame containing the minibuffer
10455 that the selected frame is using. */
10456 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10457 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10459 /* Error messages get reported properly by cmd_error, so this must be
10460 just an informative message; if the frame hasn't really been
10461 initialized yet, just toss it. */
10462 need_message
= f
->glyphs_initialized_p
;
10467 AUTO_STRING (fmt
, m
);
10468 Lisp_Object msg
= CALLN (Fformat_message
, fmt
, string
);
10470 if (noninteractive
)
10471 message_to_stderr (msg
);
10477 message3_nolog (msg
);
10479 /* Print should start at the beginning of the message
10480 buffer next time. */
10481 message_buf_print
= false;
10487 /* Dump an informative message to the minibuf. If M is 0, clear out
10488 any existing message, and let the mini-buffer text show through.
10490 The message must be safe ASCII and the format must not contain ` or
10491 '. If your message and format do not fit into this category,
10492 convert your arguments to Lisp objects and use Fmessage instead. */
10494 static void ATTRIBUTE_FORMAT_PRINTF (1, 0)
10495 vmessage (const char *m
, va_list ap
)
10497 if (noninteractive
)
10501 if (noninteractive_need_newline
)
10502 putc ('\n', stderr
);
10503 noninteractive_need_newline
= false;
10504 vfprintf (stderr
, m
, ap
);
10505 if (!cursor_in_echo_area
)
10506 fprintf (stderr
, "\n");
10510 else if (INTERACTIVE
)
10512 /* The frame whose mini-buffer we're going to display the message
10513 on. It may be larger than the selected frame, so we need to
10514 use its buffer, not the selected frame's buffer. */
10515 Lisp_Object mini_window
;
10516 struct frame
*f
, *sf
= SELECTED_FRAME ();
10518 /* Get the frame containing the mini-buffer
10519 that the selected frame is using. */
10520 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10521 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10523 /* Error messages get reported properly by cmd_error, so this must be
10524 just an informative message; if the frame hasn't really been
10525 initialized yet, just toss it. */
10526 if (f
->glyphs_initialized_p
)
10531 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10533 char *message_buf
= SAFE_ALLOCA (maxsize
+ 1);
10535 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10537 message3 (make_string (message_buf
, len
));
10543 /* Print should start at the beginning of the message
10544 buffer next time. */
10545 message_buf_print
= false;
10551 message (const char *m
, ...)
10560 /* Display the current message in the current mini-buffer. This is
10561 only called from error handlers in process.c, and is not time
10565 update_echo_area (void)
10567 if (!NILP (echo_area_buffer
[0]))
10569 Lisp_Object string
;
10570 string
= Fcurrent_message ();
10576 /* Make sure echo area buffers in `echo_buffers' are live.
10577 If they aren't, make new ones. */
10580 ensure_echo_area_buffers (void)
10582 for (int i
= 0; i
< 2; i
++)
10583 if (!BUFFERP (echo_buffer
[i
])
10584 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10586 Lisp_Object old_buffer
= echo_buffer
[i
];
10587 static char const name_fmt
[] = " *Echo Area %d*";
10588 char name
[sizeof name_fmt
+ INT_STRLEN_BOUND (int)];
10589 AUTO_STRING_WITH_LEN (lname
, name
, sprintf (name
, name_fmt
, i
));
10590 echo_buffer
[i
] = Fget_buffer_create (lname
);
10591 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10592 /* to force word wrap in echo area -
10593 it was decided to postpone this*/
10594 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10596 for (int j
= 0; j
< 2; j
++)
10597 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10598 echo_area_buffer
[j
] = echo_buffer
[i
];
10603 /* Call FN with args A1..A2 with either the current or last displayed
10604 echo_area_buffer as current buffer.
10606 WHICH zero means use the current message buffer
10607 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10608 from echo_buffer[] and clear it.
10610 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10611 suitable buffer from echo_buffer[] and clear it.
10613 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10614 that the current message becomes the last displayed one, choose a
10615 suitable buffer for echo_area_buffer[0], and clear it.
10617 Value is what FN returns. */
10620 with_echo_area_buffer (struct window
*w
, int which
,
10621 bool (*fn
) (ptrdiff_t, Lisp_Object
),
10622 ptrdiff_t a1
, Lisp_Object a2
)
10624 Lisp_Object buffer
;
10625 bool this_one
, the_other
, clear_buffer_p
, rc
;
10626 ptrdiff_t count
= SPECPDL_INDEX ();
10628 /* If buffers aren't live, make new ones. */
10629 ensure_echo_area_buffers ();
10631 clear_buffer_p
= false;
10634 this_one
= false, the_other
= true;
10635 else if (which
> 0)
10636 this_one
= true, the_other
= false;
10639 this_one
= false, the_other
= true;
10640 clear_buffer_p
= true;
10642 /* We need a fresh one in case the current echo buffer equals
10643 the one containing the last displayed echo area message. */
10644 if (!NILP (echo_area_buffer
[this_one
])
10645 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10646 echo_area_buffer
[this_one
] = Qnil
;
10649 /* Choose a suitable buffer from echo_buffer[] if we don't
10651 if (NILP (echo_area_buffer
[this_one
]))
10653 echo_area_buffer
[this_one
]
10654 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10655 ? echo_buffer
[the_other
]
10656 : echo_buffer
[this_one
]);
10657 clear_buffer_p
= true;
10660 buffer
= echo_area_buffer
[this_one
];
10662 /* Don't get confused by reusing the buffer used for echoing
10663 for a different purpose. */
10664 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10667 record_unwind_protect (unwind_with_echo_area_buffer
,
10668 with_echo_area_buffer_unwind_data (w
));
10670 /* Make the echo area buffer current. Note that for display
10671 purposes, it is not necessary that the displayed window's buffer
10672 == current_buffer, except for text property lookup. So, let's
10673 only set that buffer temporarily here without doing a full
10674 Fset_window_buffer. We must also change w->pointm, though,
10675 because otherwise an assertions in unshow_buffer fails, and Emacs
10677 set_buffer_internal_1 (XBUFFER (buffer
));
10680 wset_buffer (w
, buffer
);
10681 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10682 set_marker_both (w
->old_pointm
, buffer
, BEG
, BEG_BYTE
);
10685 bset_undo_list (current_buffer
, Qt
);
10686 bset_read_only (current_buffer
, Qnil
);
10687 specbind (Qinhibit_read_only
, Qt
);
10688 specbind (Qinhibit_modification_hooks
, Qt
);
10690 if (clear_buffer_p
&& Z
> BEG
)
10691 del_range (BEG
, Z
);
10693 eassert (BEGV
>= BEG
);
10694 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10698 eassert (BEGV
>= BEG
);
10699 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10701 unbind_to (count
, Qnil
);
10706 /* Save state that should be preserved around the call to the function
10707 FN called in with_echo_area_buffer. */
10710 with_echo_area_buffer_unwind_data (struct window
*w
)
10713 Lisp_Object vector
, tmp
;
10715 /* Reduce consing by keeping one vector in
10716 Vwith_echo_area_save_vector. */
10717 vector
= Vwith_echo_area_save_vector
;
10718 Vwith_echo_area_save_vector
= Qnil
;
10721 vector
= Fmake_vector (make_number (11), Qnil
);
10723 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10724 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10725 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10729 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10730 ASET (vector
, i
, w
->contents
); ++i
;
10731 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10732 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10733 ASET (vector
, i
, make_number (marker_position (w
->old_pointm
))); ++i
;
10734 ASET (vector
, i
, make_number (marker_byte_position (w
->old_pointm
))); ++i
;
10735 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10736 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10741 for (; i
< end
; ++i
)
10742 ASET (vector
, i
, Qnil
);
10745 eassert (i
== ASIZE (vector
));
10750 /* Restore global state from VECTOR which was created by
10751 with_echo_area_buffer_unwind_data. */
10754 unwind_with_echo_area_buffer (Lisp_Object vector
)
10756 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10757 Vdeactivate_mark
= AREF (vector
, 1);
10758 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10760 if (WINDOWP (AREF (vector
, 3)))
10763 Lisp_Object buffer
;
10765 w
= XWINDOW (AREF (vector
, 3));
10766 buffer
= AREF (vector
, 4);
10768 wset_buffer (w
, buffer
);
10769 set_marker_both (w
->pointm
, buffer
,
10770 XFASTINT (AREF (vector
, 5)),
10771 XFASTINT (AREF (vector
, 6)));
10772 set_marker_both (w
->old_pointm
, buffer
,
10773 XFASTINT (AREF (vector
, 7)),
10774 XFASTINT (AREF (vector
, 8)));
10775 set_marker_both (w
->start
, buffer
,
10776 XFASTINT (AREF (vector
, 9)),
10777 XFASTINT (AREF (vector
, 10)));
10780 Vwith_echo_area_save_vector
= vector
;
10784 /* Set up the echo area for use by print functions. MULTIBYTE_P
10785 means we will print multibyte. */
10788 setup_echo_area_for_printing (bool multibyte_p
)
10790 /* If we can't find an echo area any more, exit. */
10791 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10792 Fkill_emacs (Qnil
);
10794 ensure_echo_area_buffers ();
10796 if (!message_buf_print
)
10798 /* A message has been output since the last time we printed.
10799 Choose a fresh echo area buffer. */
10800 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10801 echo_area_buffer
[0] = echo_buffer
[1];
10803 echo_area_buffer
[0] = echo_buffer
[0];
10805 /* Switch to that buffer and clear it. */
10806 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10807 bset_truncate_lines (current_buffer
, Qnil
);
10811 ptrdiff_t count
= SPECPDL_INDEX ();
10812 specbind (Qinhibit_read_only
, Qt
);
10813 /* Note that undo recording is always disabled. */
10814 del_range (BEG
, Z
);
10815 unbind_to (count
, Qnil
);
10817 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10819 /* Set up the buffer for the multibyteness we need. */
10821 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10822 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10824 /* Raise the frame containing the echo area. */
10825 if (minibuffer_auto_raise
)
10827 struct frame
*sf
= SELECTED_FRAME ();
10828 Lisp_Object mini_window
;
10829 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10830 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10833 message_log_maybe_newline ();
10834 message_buf_print
= true;
10838 if (NILP (echo_area_buffer
[0]))
10840 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10841 echo_area_buffer
[0] = echo_buffer
[1];
10843 echo_area_buffer
[0] = echo_buffer
[0];
10846 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10848 /* Someone switched buffers between print requests. */
10849 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10850 bset_truncate_lines (current_buffer
, Qnil
);
10856 /* Display an echo area message in window W. Value is true if W's
10857 height is changed. If display_last_displayed_message_p,
10858 display the message that was last displayed, otherwise
10859 display the current message. */
10862 display_echo_area (struct window
*w
)
10864 bool no_message_p
, window_height_changed_p
;
10866 /* Temporarily disable garbage collections while displaying the echo
10867 area. This is done because a GC can print a message itself.
10868 That message would modify the echo area buffer's contents while a
10869 redisplay of the buffer is going on, and seriously confuse
10871 ptrdiff_t count
= inhibit_garbage_collection ();
10873 /* If there is no message, we must call display_echo_area_1
10874 nevertheless because it resizes the window. But we will have to
10875 reset the echo_area_buffer in question to nil at the end because
10876 with_echo_area_buffer will sets it to an empty buffer. */
10877 bool i
= display_last_displayed_message_p
;
10878 /* According to the C99, C11 and C++11 standards, the integral value
10879 of a "bool" is always 0 or 1, so this array access is safe here,
10881 no_message_p
= NILP (echo_area_buffer
[i
]);
10883 window_height_changed_p
10884 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10885 display_echo_area_1
,
10886 (intptr_t) w
, Qnil
);
10889 echo_area_buffer
[i
] = Qnil
;
10891 unbind_to (count
, Qnil
);
10892 return window_height_changed_p
;
10896 /* Helper for display_echo_area. Display the current buffer which
10897 contains the current echo area message in window W, a mini-window,
10898 a pointer to which is passed in A1. A2..A4 are currently not used.
10899 Change the height of W so that all of the message is displayed.
10900 Value is true if height of W was changed. */
10903 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10906 struct window
*w
= (struct window
*) i1
;
10907 Lisp_Object window
;
10908 struct text_pos start
;
10910 /* We are about to enter redisplay without going through
10911 redisplay_internal, so we need to forget these faces by hand
10913 forget_escape_and_glyphless_faces ();
10915 /* Do this before displaying, so that we have a large enough glyph
10916 matrix for the display. If we can't get enough space for the
10917 whole text, display the last N lines. That works by setting w->start. */
10918 bool window_height_changed_p
= resize_mini_window (w
, false);
10920 /* Use the starting position chosen by resize_mini_window. */
10921 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10924 clear_glyph_matrix (w
->desired_matrix
);
10925 XSETWINDOW (window
, w
);
10926 try_window (window
, start
, 0);
10928 return window_height_changed_p
;
10932 /* Resize the echo area window to exactly the size needed for the
10933 currently displayed message, if there is one. If a mini-buffer
10934 is active, don't shrink it. */
10937 resize_echo_area_exactly (void)
10939 if (BUFFERP (echo_area_buffer
[0])
10940 && WINDOWP (echo_area_window
))
10942 struct window
*w
= XWINDOW (echo_area_window
);
10943 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10944 bool resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10945 (intptr_t) w
, resize_exactly
);
10948 windows_or_buffers_changed
= 42;
10949 update_mode_lines
= 30;
10950 redisplay_internal ();
10956 /* Callback function for with_echo_area_buffer, when used from
10957 resize_echo_area_exactly. A1 contains a pointer to the window to
10958 resize, EXACTLY non-nil means resize the mini-window exactly to the
10959 size of the text displayed. A3 and A4 are not used. Value is what
10960 resize_mini_window returns. */
10963 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10966 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10970 /* Resize mini-window W to fit the size of its contents. EXACT_P
10971 means size the window exactly to the size needed. Otherwise, it's
10972 only enlarged until W's buffer is empty.
10974 Set W->start to the right place to begin display. If the whole
10975 contents fit, start at the beginning. Otherwise, start so as
10976 to make the end of the contents appear. This is particularly
10977 important for y-or-n-p, but seems desirable generally.
10979 Value is true if the window height has been changed. */
10982 resize_mini_window (struct window
*w
, bool exact_p
)
10984 struct frame
*f
= XFRAME (w
->frame
);
10985 bool window_height_changed_p
= false;
10987 eassert (MINI_WINDOW_P (w
));
10989 /* By default, start display at the beginning. */
10990 set_marker_both (w
->start
, w
->contents
,
10991 BUF_BEGV (XBUFFER (w
->contents
)),
10992 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10994 /* Don't resize windows while redisplaying a window; it would
10995 confuse redisplay functions when the size of the window they are
10996 displaying changes from under them. Such a resizing can happen,
10997 for instance, when which-func prints a long message while
10998 we are running fontification-functions. We're running these
10999 functions with safe_call which binds inhibit-redisplay to t. */
11000 if (!NILP (Vinhibit_redisplay
))
11003 /* Nil means don't try to resize. */
11004 if (NILP (Vresize_mini_windows
)
11005 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
11008 if (!FRAME_MINIBUF_ONLY_P (f
))
11011 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
11012 + WINDOW_PIXEL_HEIGHT (w
));
11013 int unit
= FRAME_LINE_HEIGHT (f
);
11014 int height
, max_height
;
11015 struct text_pos start
;
11016 struct buffer
*old_current_buffer
= NULL
;
11018 if (current_buffer
!= XBUFFER (w
->contents
))
11020 old_current_buffer
= current_buffer
;
11021 set_buffer_internal (XBUFFER (w
->contents
));
11024 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
11026 /* Compute the max. number of lines specified by the user. */
11027 if (FLOATP (Vmax_mini_window_height
))
11028 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
11029 else if (INTEGERP (Vmax_mini_window_height
))
11030 max_height
= XINT (Vmax_mini_window_height
) * unit
;
11032 max_height
= total_height
/ 4;
11034 /* Correct that max. height if it's bogus. */
11035 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
11037 /* Find out the height of the text in the window. */
11038 if (it
.line_wrap
== TRUNCATE
)
11043 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
11044 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
11045 height
= it
.current_y
+ last_height
;
11047 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
11048 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
11051 /* Compute a suitable window start. */
11052 if (height
> max_height
)
11054 height
= (max_height
/ unit
) * unit
;
11055 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
11056 move_it_vertically_backward (&it
, height
- unit
);
11057 start
= it
.current
.pos
;
11060 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
11061 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
11063 if (EQ (Vresize_mini_windows
, Qgrow_only
))
11065 /* Let it grow only, until we display an empty message, in which
11066 case the window shrinks again. */
11067 if (height
> WINDOW_PIXEL_HEIGHT (w
))
11069 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11071 FRAME_WINDOWS_FROZEN (f
) = true;
11072 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
11073 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11075 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
11076 && (exact_p
|| BEGV
== ZV
))
11078 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11080 FRAME_WINDOWS_FROZEN (f
) = false;
11081 shrink_mini_window (w
, true);
11082 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11087 /* Always resize to exact size needed. */
11088 if (height
> WINDOW_PIXEL_HEIGHT (w
))
11090 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11092 FRAME_WINDOWS_FROZEN (f
) = true;
11093 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
11094 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11096 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
11098 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11100 FRAME_WINDOWS_FROZEN (f
) = false;
11101 shrink_mini_window (w
, true);
11105 FRAME_WINDOWS_FROZEN (f
) = true;
11106 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
11109 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11113 if (old_current_buffer
)
11114 set_buffer_internal (old_current_buffer
);
11117 return window_height_changed_p
;
11121 /* Value is the current message, a string, or nil if there is no
11122 current message. */
11125 current_message (void)
11129 if (!BUFFERP (echo_area_buffer
[0]))
11133 with_echo_area_buffer (0, 0, current_message_1
,
11134 (intptr_t) &msg
, Qnil
);
11136 echo_area_buffer
[0] = Qnil
;
11144 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
11147 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
11150 *msg
= make_buffer_string (BEG
, Z
, true);
11157 /* Push the current message on Vmessage_stack for later restoration
11158 by restore_message. Value is true if the current message isn't
11159 empty. This is a relatively infrequent operation, so it's not
11160 worth optimizing. */
11163 push_message (void)
11165 Lisp_Object msg
= current_message ();
11166 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
11167 return STRINGP (msg
);
11171 /* Restore message display from the top of Vmessage_stack. */
11174 restore_message (void)
11176 eassert (CONSP (Vmessage_stack
));
11177 message3_nolog (XCAR (Vmessage_stack
));
11181 /* Handler for unwind-protect calling pop_message. */
11184 pop_message_unwind (void)
11186 /* Pop the top-most entry off Vmessage_stack. */
11187 eassert (CONSP (Vmessage_stack
));
11188 Vmessage_stack
= XCDR (Vmessage_stack
);
11192 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11193 exits. If the stack is not empty, we have a missing pop_message
11197 check_message_stack (void)
11199 if (!NILP (Vmessage_stack
))
11204 /* Truncate to NCHARS what will be displayed in the echo area the next
11205 time we display it---but don't redisplay it now. */
11208 truncate_echo_area (ptrdiff_t nchars
)
11211 echo_area_buffer
[0] = Qnil
;
11212 else if (!noninteractive
11214 && !NILP (echo_area_buffer
[0]))
11216 struct frame
*sf
= SELECTED_FRAME ();
11217 /* Error messages get reported properly by cmd_error, so this must be
11218 just an informative message; if the frame hasn't really been
11219 initialized yet, just toss it. */
11220 if (sf
->glyphs_initialized_p
)
11221 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11226 /* Helper function for truncate_echo_area. Truncate the current
11227 message to at most NCHARS characters. */
11230 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11232 if (BEG
+ nchars
< Z
)
11233 del_range (BEG
+ nchars
, Z
);
11235 echo_area_buffer
[0] = Qnil
;
11239 /* Set the current message to STRING. */
11242 set_message (Lisp_Object string
)
11244 eassert (STRINGP (string
));
11246 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11248 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11249 message_buf_print
= false;
11250 help_echo_showing_p
= false;
11252 if (STRINGP (Vdebug_on_message
)
11253 && STRINGP (string
)
11254 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11255 call_debugger (list2 (Qerror
, string
));
11259 /* Helper function for set_message. First argument is ignored and second
11260 argument has the same meaning as for set_message.
11261 This function is called with the echo area buffer being current. */
11264 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11266 eassert (STRINGP (string
));
11268 /* Change multibyteness of the echo buffer appropriately. */
11269 if (message_enable_multibyte
11270 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11271 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11273 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11274 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11275 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11277 /* Insert new message at BEG. */
11278 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11280 /* This function takes care of single/multibyte conversion.
11281 We just have to ensure that the echo area buffer has the right
11282 setting of enable_multibyte_characters. */
11283 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), true);
11289 /* Clear messages. CURRENT_P means clear the current message.
11290 LAST_DISPLAYED_P means clear the message last displayed. */
11293 clear_message (bool current_p
, bool last_displayed_p
)
11297 echo_area_buffer
[0] = Qnil
;
11298 message_cleared_p
= true;
11301 if (last_displayed_p
)
11302 echo_area_buffer
[1] = Qnil
;
11304 message_buf_print
= false;
11307 /* Clear garbaged frames.
11309 This function is used where the old redisplay called
11310 redraw_garbaged_frames which in turn called redraw_frame which in
11311 turn called clear_frame. The call to clear_frame was a source of
11312 flickering. I believe a clear_frame is not necessary. It should
11313 suffice in the new redisplay to invalidate all current matrices,
11314 and ensure a complete redisplay of all windows. */
11317 clear_garbaged_frames (void)
11319 if (frame_garbaged
)
11321 Lisp_Object tail
, frame
;
11322 struct frame
*sf
= SELECTED_FRAME ();
11324 FOR_EACH_FRAME (tail
, frame
)
11326 struct frame
*f
= XFRAME (frame
);
11328 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11331 /* It makes no sense to redraw a non-selected TTY
11332 frame, since that will actually clear the
11333 selected frame, and might leave the selected
11334 frame with corrupted display, if it happens not
11335 to be marked garbaged. */
11336 && !(f
!= sf
&& (FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))))
11339 clear_current_matrices (f
);
11340 fset_redisplay (f
);
11341 f
->garbaged
= false;
11342 f
->resized_p
= false;
11346 frame_garbaged
= false;
11351 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P, update
11355 echo_area_display (bool update_frame_p
)
11357 Lisp_Object mini_window
;
11360 bool window_height_changed_p
= false;
11361 struct frame
*sf
= SELECTED_FRAME ();
11363 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11364 w
= XWINDOW (mini_window
);
11365 f
= XFRAME (WINDOW_FRAME (w
));
11367 /* Don't display if frame is invisible or not yet initialized. */
11368 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11371 #ifdef HAVE_WINDOW_SYSTEM
11372 /* When Emacs starts, selected_frame may be the initial terminal
11373 frame. If we let this through, a message would be displayed on
11375 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11377 #endif /* HAVE_WINDOW_SYSTEM */
11379 /* Redraw garbaged frames. */
11380 clear_garbaged_frames ();
11382 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11384 echo_area_window
= mini_window
;
11385 window_height_changed_p
= display_echo_area (w
);
11386 w
->must_be_updated_p
= true;
11388 /* Update the display, unless called from redisplay_internal.
11389 Also don't update the screen during redisplay itself. The
11390 update will happen at the end of redisplay, and an update
11391 here could cause confusion. */
11392 if (update_frame_p
&& !redisplaying_p
)
11396 /* If the display update has been interrupted by pending
11397 input, update mode lines in the frame. Due to the
11398 pending input, it might have been that redisplay hasn't
11399 been called, so that mode lines above the echo area are
11400 garbaged. This looks odd, so we prevent it here. */
11401 if (!display_completed
)
11402 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11404 if (window_height_changed_p
11405 /* Don't do this if Emacs is shutting down. Redisplay
11406 needs to run hooks. */
11407 && !NILP (Vrun_hooks
))
11409 /* Must update other windows. Likewise as in other
11410 cases, don't let this update be interrupted by
11412 ptrdiff_t count
= SPECPDL_INDEX ();
11413 specbind (Qredisplay_dont_pause
, Qt
);
11414 fset_redisplay (f
);
11415 redisplay_internal ();
11416 unbind_to (count
, Qnil
);
11418 else if (FRAME_WINDOW_P (f
) && n
== 0)
11420 /* Window configuration is the same as before.
11421 Can do with a display update of the echo area,
11422 unless we displayed some mode lines. */
11423 update_single_window (w
);
11427 update_frame (f
, true, true);
11429 /* If cursor is in the echo area, make sure that the next
11430 redisplay displays the minibuffer, so that the cursor will
11431 be replaced with what the minibuffer wants. */
11432 if (cursor_in_echo_area
)
11433 wset_redisplay (XWINDOW (mini_window
));
11436 else if (!EQ (mini_window
, selected_window
))
11437 wset_redisplay (XWINDOW (mini_window
));
11439 /* Last displayed message is now the current message. */
11440 echo_area_buffer
[1] = echo_area_buffer
[0];
11441 /* Inform read_char that we're not echoing. */
11442 echo_message_buffer
= Qnil
;
11444 /* Prevent redisplay optimization in redisplay_internal by resetting
11445 this_line_start_pos. This is done because the mini-buffer now
11446 displays the message instead of its buffer text. */
11447 if (EQ (mini_window
, selected_window
))
11448 CHARPOS (this_line_start_pos
) = 0;
11450 if (window_height_changed_p
)
11452 fset_redisplay (f
);
11454 /* If window configuration was changed, frames may have been
11455 marked garbaged. Clear them or we will experience
11456 surprises wrt scrolling.
11457 FIXME: How/why/when? */
11458 clear_garbaged_frames ();
11462 /* True if W's buffer was changed but not saved. */
11465 window_buffer_changed (struct window
*w
)
11467 struct buffer
*b
= XBUFFER (w
->contents
);
11469 eassert (BUFFER_LIVE_P (b
));
11471 return (BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
;
11474 /* True if W has %c in its mode line and mode line should be updated. */
11477 mode_line_update_needed (struct window
*w
)
11479 return (w
->column_number_displayed
!= -1
11480 && !(PT
== w
->last_point
&& !window_outdated (w
))
11481 && (w
->column_number_displayed
!= current_column ()));
11484 /* True if window start of W is frozen and may not be changed during
11488 window_frozen_p (struct window
*w
)
11490 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11492 Lisp_Object window
;
11494 XSETWINDOW (window
, w
);
11495 if (MINI_WINDOW_P (w
))
11497 else if (EQ (window
, selected_window
))
11499 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11500 && EQ (window
, Vminibuf_scroll_window
))
11501 /* This special window can't be frozen too. */
11509 /***********************************************************************
11510 Mode Lines and Frame Titles
11511 ***********************************************************************/
11513 /* A buffer for constructing non-propertized mode-line strings and
11514 frame titles in it; allocated from the heap in init_xdisp and
11515 resized as needed in store_mode_line_noprop_char. */
11517 static char *mode_line_noprop_buf
;
11519 /* The buffer's end, and a current output position in it. */
11521 static char *mode_line_noprop_buf_end
;
11522 static char *mode_line_noprop_ptr
;
11524 #define MODE_LINE_NOPROP_LEN(start) \
11525 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11528 MODE_LINE_DISPLAY
= 0,
11532 } mode_line_target
;
11534 /* Alist that caches the results of :propertize.
11535 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11536 static Lisp_Object mode_line_proptrans_alist
;
11538 /* List of strings making up the mode-line. */
11539 static Lisp_Object mode_line_string_list
;
11541 /* Base face property when building propertized mode line string. */
11542 static Lisp_Object mode_line_string_face
;
11543 static Lisp_Object mode_line_string_face_prop
;
11546 /* Unwind data for mode line strings */
11548 static Lisp_Object Vmode_line_unwind_vector
;
11551 format_mode_line_unwind_data (struct frame
*target_frame
,
11552 struct buffer
*obuf
,
11554 bool save_proptrans
)
11556 Lisp_Object vector
, tmp
;
11558 /* Reduce consing by keeping one vector in
11559 Vwith_echo_area_save_vector. */
11560 vector
= Vmode_line_unwind_vector
;
11561 Vmode_line_unwind_vector
= Qnil
;
11564 vector
= Fmake_vector (make_number (10), Qnil
);
11566 ASET (vector
, 0, make_number (mode_line_target
));
11567 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11568 ASET (vector
, 2, mode_line_string_list
);
11569 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11570 ASET (vector
, 4, mode_line_string_face
);
11571 ASET (vector
, 5, mode_line_string_face_prop
);
11574 XSETBUFFER (tmp
, obuf
);
11577 ASET (vector
, 6, tmp
);
11578 ASET (vector
, 7, owin
);
11581 /* Similarly to `with-selected-window', if the operation selects
11582 a window on another frame, we must restore that frame's
11583 selected window, and (for a tty) the top-frame. */
11584 ASET (vector
, 8, target_frame
->selected_window
);
11585 if (FRAME_TERMCAP_P (target_frame
))
11586 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11593 unwind_format_mode_line (Lisp_Object vector
)
11595 Lisp_Object old_window
= AREF (vector
, 7);
11596 Lisp_Object target_frame_window
= AREF (vector
, 8);
11597 Lisp_Object old_top_frame
= AREF (vector
, 9);
11599 mode_line_target
= XINT (AREF (vector
, 0));
11600 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11601 mode_line_string_list
= AREF (vector
, 2);
11602 if (! EQ (AREF (vector
, 3), Qt
))
11603 mode_line_proptrans_alist
= AREF (vector
, 3);
11604 mode_line_string_face
= AREF (vector
, 4);
11605 mode_line_string_face_prop
= AREF (vector
, 5);
11607 /* Select window before buffer, since it may change the buffer. */
11608 if (!NILP (old_window
))
11610 /* If the operation that we are unwinding had selected a window
11611 on a different frame, reset its frame-selected-window. For a
11612 text terminal, reset its top-frame if necessary. */
11613 if (!NILP (target_frame_window
))
11616 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11618 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11619 Fselect_window (target_frame_window
, Qt
);
11621 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11622 Fselect_frame (old_top_frame
, Qt
);
11625 Fselect_window (old_window
, Qt
);
11628 if (!NILP (AREF (vector
, 6)))
11630 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11631 ASET (vector
, 6, Qnil
);
11634 Vmode_line_unwind_vector
= vector
;
11638 /* Store a single character C for the frame title in mode_line_noprop_buf.
11639 Re-allocate mode_line_noprop_buf if necessary. */
11642 store_mode_line_noprop_char (char c
)
11644 /* If output position has reached the end of the allocated buffer,
11645 increase the buffer's size. */
11646 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11648 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11649 ptrdiff_t size
= len
;
11650 mode_line_noprop_buf
=
11651 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11652 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11653 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11656 *mode_line_noprop_ptr
++ = c
;
11660 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11661 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11662 characters that yield more columns than PRECISION; PRECISION <= 0
11663 means copy the whole string. Pad with spaces until FIELD_WIDTH
11664 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11665 pad. Called from display_mode_element when it is used to build a
11669 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11671 const unsigned char *str
= (const unsigned char *) string
;
11673 ptrdiff_t dummy
, nbytes
;
11675 /* Copy at most PRECISION chars from STR. */
11676 nbytes
= strlen (string
);
11677 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11679 store_mode_line_noprop_char (*str
++);
11681 /* Fill up with spaces until FIELD_WIDTH reached. */
11682 while (field_width
> 0
11683 && n
< field_width
)
11685 store_mode_line_noprop_char (' ');
11692 /***********************************************************************
11694 ***********************************************************************/
11696 #ifdef HAVE_WINDOW_SYSTEM
11698 /* Set the title of FRAME, if it has changed. The title format is
11699 Vicon_title_format if FRAME is iconified, otherwise it is
11700 frame_title_format. */
11703 x_consider_frame_title (Lisp_Object frame
)
11705 struct frame
*f
= XFRAME (frame
);
11707 if ((FRAME_WINDOW_P (f
)
11708 || FRAME_MINIBUF_ONLY_P (f
)
11709 || f
->explicit_name
)
11710 && NILP (Fframe_parameter (frame
, Qtooltip
)))
11712 /* Do we have more than one visible frame on this X display? */
11713 Lisp_Object tail
, other_frame
, fmt
;
11714 ptrdiff_t title_start
;
11718 ptrdiff_t count
= SPECPDL_INDEX ();
11720 FOR_EACH_FRAME (tail
, other_frame
)
11722 struct frame
*tf
= XFRAME (other_frame
);
11725 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11726 && !FRAME_MINIBUF_ONLY_P (tf
)
11727 && !EQ (other_frame
, tip_frame
)
11728 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11732 /* Set global variable indicating that multiple frames exist. */
11733 multiple_frames
= CONSP (tail
);
11735 /* Switch to the buffer of selected window of the frame. Set up
11736 mode_line_target so that display_mode_element will output into
11737 mode_line_noprop_buf; then display the title. */
11738 record_unwind_protect (unwind_format_mode_line
,
11739 format_mode_line_unwind_data
11740 (f
, current_buffer
, selected_window
, false));
11742 Fselect_window (f
->selected_window
, Qt
);
11743 set_buffer_internal_1
11744 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11745 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11747 mode_line_target
= MODE_LINE_TITLE
;
11748 title_start
= MODE_LINE_NOPROP_LEN (0);
11749 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11750 NULL
, DEFAULT_FACE_ID
);
11751 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, false);
11752 len
= MODE_LINE_NOPROP_LEN (title_start
);
11753 title
= mode_line_noprop_buf
+ title_start
;
11754 unbind_to (count
, Qnil
);
11756 /* Set the title only if it's changed. This avoids consing in
11757 the common case where it hasn't. (If it turns out that we've
11758 already wasted too much time by walking through the list with
11759 display_mode_element, then we might need to optimize at a
11760 higher level than this.) */
11761 if (! STRINGP (f
->name
)
11762 || SBYTES (f
->name
) != len
11763 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11764 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11768 #endif /* not HAVE_WINDOW_SYSTEM */
11771 /***********************************************************************
11773 ***********************************************************************/
11775 /* True if we will not redisplay all visible windows. */
11776 #define REDISPLAY_SOME_P() \
11777 ((windows_or_buffers_changed == 0 \
11778 || windows_or_buffers_changed == REDISPLAY_SOME) \
11779 && (update_mode_lines == 0 \
11780 || update_mode_lines == REDISPLAY_SOME))
11782 /* Prepare for redisplay by updating menu-bar item lists when
11783 appropriate. This can call eval. */
11786 prepare_menu_bars (void)
11788 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11789 bool some_windows
= REDISPLAY_SOME_P ();
11790 Lisp_Object tooltip_frame
;
11792 #ifdef HAVE_WINDOW_SYSTEM
11793 tooltip_frame
= tip_frame
;
11795 tooltip_frame
= Qnil
;
11798 if (FUNCTIONP (Vpre_redisplay_function
))
11800 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11801 if (all_windows
&& some_windows
)
11803 Lisp_Object ws
= window_list ();
11804 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11806 Lisp_Object
this = XCAR (ws
);
11807 struct window
*w
= XWINDOW (this);
11809 || XFRAME (w
->frame
)->redisplay
11810 || XBUFFER (w
->contents
)->text
->redisplay
)
11812 windows
= Fcons (this, windows
);
11816 safe__call1 (true, Vpre_redisplay_function
, windows
);
11819 /* Update all frame titles based on their buffer names, etc. We do
11820 this before the menu bars so that the buffer-menu will show the
11821 up-to-date frame titles. */
11822 #ifdef HAVE_WINDOW_SYSTEM
11825 Lisp_Object tail
, frame
;
11827 FOR_EACH_FRAME (tail
, frame
)
11829 struct frame
*f
= XFRAME (frame
);
11830 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11834 && !XBUFFER (w
->contents
)->text
->redisplay
)
11837 if (!EQ (frame
, tooltip_frame
)
11838 && (FRAME_ICONIFIED_P (f
)
11839 || FRAME_VISIBLE_P (f
) == 1
11840 /* Exclude TTY frames that are obscured because they
11841 are not the top frame on their console. This is
11842 because x_consider_frame_title actually switches
11843 to the frame, which for TTY frames means it is
11844 marked as garbaged, and will be completely
11845 redrawn on the next redisplay cycle. This causes
11846 TTY frames to be completely redrawn, when there
11847 are more than one of them, even though nothing
11848 should be changed on display. */
11849 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11850 x_consider_frame_title (frame
);
11853 #endif /* HAVE_WINDOW_SYSTEM */
11855 /* Update the menu bar item lists, if appropriate. This has to be
11856 done before any actual redisplay or generation of display lines. */
11860 Lisp_Object tail
, frame
;
11861 ptrdiff_t count
= SPECPDL_INDEX ();
11862 /* True means that update_menu_bar has run its hooks
11863 so any further calls to update_menu_bar shouldn't do so again. */
11864 bool menu_bar_hooks_run
= false;
11866 record_unwind_save_match_data ();
11868 FOR_EACH_FRAME (tail
, frame
)
11870 struct frame
*f
= XFRAME (frame
);
11871 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11873 /* Ignore tooltip frame. */
11874 if (EQ (frame
, tooltip_frame
))
11880 && !XBUFFER (w
->contents
)->text
->redisplay
)
11883 run_window_size_change_functions (frame
);
11884 menu_bar_hooks_run
= update_menu_bar (f
, false, menu_bar_hooks_run
);
11885 #ifdef HAVE_WINDOW_SYSTEM
11886 update_tool_bar (f
, false);
11890 unbind_to (count
, Qnil
);
11894 struct frame
*sf
= SELECTED_FRAME ();
11895 update_menu_bar (sf
, true, false);
11896 #ifdef HAVE_WINDOW_SYSTEM
11897 update_tool_bar (sf
, true);
11903 /* Update the menu bar item list for frame F. This has to be done
11904 before we start to fill in any display lines, because it can call
11907 If SAVE_MATCH_DATA, we must save and restore it here.
11909 If HOOKS_RUN, a previous call to update_menu_bar
11910 already ran the menu bar hooks for this redisplay, so there
11911 is no need to run them again. The return value is the
11912 updated value of this flag, to pass to the next call. */
11915 update_menu_bar (struct frame
*f
, bool save_match_data
, bool hooks_run
)
11917 Lisp_Object window
;
11920 /* If called recursively during a menu update, do nothing. This can
11921 happen when, for instance, an activate-menubar-hook causes a
11923 if (inhibit_menubar_update
)
11926 window
= FRAME_SELECTED_WINDOW (f
);
11927 w
= XWINDOW (window
);
11929 if (FRAME_WINDOW_P (f
)
11931 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11932 || defined (HAVE_NS) || defined (USE_GTK)
11933 FRAME_EXTERNAL_MENU_BAR (f
)
11935 FRAME_MENU_BAR_LINES (f
) > 0
11937 : FRAME_MENU_BAR_LINES (f
) > 0)
11939 /* If the user has switched buffers or windows, we need to
11940 recompute to reflect the new bindings. But we'll
11941 recompute when update_mode_lines is set too; that means
11942 that people can use force-mode-line-update to request
11943 that the menu bar be recomputed. The adverse effect on
11944 the rest of the redisplay algorithm is about the same as
11945 windows_or_buffers_changed anyway. */
11946 if (windows_or_buffers_changed
11947 /* This used to test w->update_mode_line, but we believe
11948 there is no need to recompute the menu in that case. */
11949 || update_mode_lines
11950 || window_buffer_changed (w
))
11952 struct buffer
*prev
= current_buffer
;
11953 ptrdiff_t count
= SPECPDL_INDEX ();
11955 specbind (Qinhibit_menubar_update
, Qt
);
11957 set_buffer_internal_1 (XBUFFER (w
->contents
));
11958 if (save_match_data
)
11959 record_unwind_save_match_data ();
11960 if (NILP (Voverriding_local_map_menu_flag
))
11962 specbind (Qoverriding_terminal_local_map
, Qnil
);
11963 specbind (Qoverriding_local_map
, Qnil
);
11968 /* Run the Lucid hook. */
11969 safe_run_hooks (Qactivate_menubar_hook
);
11971 /* If it has changed current-menubar from previous value,
11972 really recompute the menu-bar from the value. */
11973 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11974 call0 (Qrecompute_lucid_menubar
);
11976 safe_run_hooks (Qmenu_bar_update_hook
);
11981 XSETFRAME (Vmenu_updating_frame
, f
);
11982 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11984 /* Redisplay the menu bar in case we changed it. */
11985 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11986 || defined (HAVE_NS) || defined (USE_GTK)
11987 if (FRAME_WINDOW_P (f
))
11989 #if defined (HAVE_NS)
11990 /* All frames on Mac OS share the same menubar. So only
11991 the selected frame should be allowed to set it. */
11992 if (f
== SELECTED_FRAME ())
11994 set_frame_menubar (f
, false, false);
11997 /* On a terminal screen, the menu bar is an ordinary screen
11998 line, and this makes it get updated. */
11999 w
->update_mode_line
= true;
12000 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
12001 /* In the non-toolkit version, the menu bar is an ordinary screen
12002 line, and this makes it get updated. */
12003 w
->update_mode_line
= true;
12004 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
12006 unbind_to (count
, Qnil
);
12007 set_buffer_internal_1 (prev
);
12014 /***********************************************************************
12016 ***********************************************************************/
12018 #ifdef HAVE_WINDOW_SYSTEM
12020 /* Select `frame' temporarily without running all the code in
12022 FIXME: Maybe do_switch_frame should be trimmed down similarly
12023 when `norecord' is set. */
12025 fast_set_selected_frame (Lisp_Object frame
)
12027 if (!EQ (selected_frame
, frame
))
12029 selected_frame
= frame
;
12030 selected_window
= XFRAME (frame
)->selected_window
;
12034 /* Update the tool-bar item list for frame F. This has to be done
12035 before we start to fill in any display lines. Called from
12036 prepare_menu_bars. If SAVE_MATCH_DATA, we must save
12037 and restore it here. */
12040 update_tool_bar (struct frame
*f
, bool save_match_data
)
12042 #if defined (USE_GTK) || defined (HAVE_NS)
12043 bool do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
12045 bool do_update
= (WINDOWP (f
->tool_bar_window
)
12046 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0);
12051 Lisp_Object window
;
12054 window
= FRAME_SELECTED_WINDOW (f
);
12055 w
= XWINDOW (window
);
12057 /* If the user has switched buffers or windows, we need to
12058 recompute to reflect the new bindings. But we'll
12059 recompute when update_mode_lines is set too; that means
12060 that people can use force-mode-line-update to request
12061 that the menu bar be recomputed. The adverse effect on
12062 the rest of the redisplay algorithm is about the same as
12063 windows_or_buffers_changed anyway. */
12064 if (windows_or_buffers_changed
12065 || w
->update_mode_line
12066 || update_mode_lines
12067 || window_buffer_changed (w
))
12069 struct buffer
*prev
= current_buffer
;
12070 ptrdiff_t count
= SPECPDL_INDEX ();
12071 Lisp_Object frame
, new_tool_bar
;
12072 int new_n_tool_bar
;
12074 /* Set current_buffer to the buffer of the selected
12075 window of the frame, so that we get the right local
12077 set_buffer_internal_1 (XBUFFER (w
->contents
));
12079 /* Save match data, if we must. */
12080 if (save_match_data
)
12081 record_unwind_save_match_data ();
12083 /* Make sure that we don't accidentally use bogus keymaps. */
12084 if (NILP (Voverriding_local_map_menu_flag
))
12086 specbind (Qoverriding_terminal_local_map
, Qnil
);
12087 specbind (Qoverriding_local_map
, Qnil
);
12090 /* We must temporarily set the selected frame to this frame
12091 before calling tool_bar_items, because the calculation of
12092 the tool-bar keymap uses the selected frame (see
12093 `tool-bar-make-keymap' in tool-bar.el). */
12094 eassert (EQ (selected_window
,
12095 /* Since we only explicitly preserve selected_frame,
12096 check that selected_window would be redundant. */
12097 XFRAME (selected_frame
)->selected_window
));
12098 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
12099 XSETFRAME (frame
, f
);
12100 fast_set_selected_frame (frame
);
12102 /* Build desired tool-bar items from keymaps. */
12104 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
12107 /* Redisplay the tool-bar if we changed it. */
12108 if (new_n_tool_bar
!= f
->n_tool_bar_items
12109 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
12111 /* Redisplay that happens asynchronously due to an expose event
12112 may access f->tool_bar_items. Make sure we update both
12113 variables within BLOCK_INPUT so no such event interrupts. */
12115 fset_tool_bar_items (f
, new_tool_bar
);
12116 f
->n_tool_bar_items
= new_n_tool_bar
;
12117 w
->update_mode_line
= true;
12121 unbind_to (count
, Qnil
);
12122 set_buffer_internal_1 (prev
);
12127 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12129 /* Set F->desired_tool_bar_string to a Lisp string representing frame
12130 F's desired tool-bar contents. F->tool_bar_items must have
12131 been set up previously by calling prepare_menu_bars. */
12134 build_desired_tool_bar_string (struct frame
*f
)
12136 int i
, size
, size_needed
;
12137 Lisp_Object image
, plist
;
12139 image
= plist
= Qnil
;
12141 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
12142 Otherwise, make a new string. */
12144 /* The size of the string we might be able to reuse. */
12145 size
= (STRINGP (f
->desired_tool_bar_string
)
12146 ? SCHARS (f
->desired_tool_bar_string
)
12149 /* We need one space in the string for each image. */
12150 size_needed
= f
->n_tool_bar_items
;
12152 /* Reuse f->desired_tool_bar_string, if possible. */
12153 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
12154 fset_desired_tool_bar_string
12155 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
12158 AUTO_LIST4 (props
, Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
12159 Fremove_text_properties (make_number (0), make_number (size
),
12160 props
, f
->desired_tool_bar_string
);
12163 /* Put a `display' property on the string for the images to display,
12164 put a `menu_item' property on tool-bar items with a value that
12165 is the index of the item in F's tool-bar item vector. */
12166 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
12168 #define PROP(IDX) \
12169 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
12171 bool enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
12172 bool selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
12173 int hmargin
, vmargin
, relief
, idx
, end
;
12175 /* If image is a vector, choose the image according to the
12177 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
12178 if (VECTORP (image
))
12182 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12183 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
12186 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12187 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
12189 eassert (ASIZE (image
) >= idx
);
12190 image
= AREF (image
, idx
);
12195 /* Ignore invalid image specifications. */
12196 if (!valid_image_p (image
))
12199 /* Display the tool-bar button pressed, or depressed. */
12200 plist
= Fcopy_sequence (XCDR (image
));
12202 /* Compute margin and relief to draw. */
12203 relief
= (tool_bar_button_relief
>= 0
12204 ? tool_bar_button_relief
12205 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12206 hmargin
= vmargin
= relief
;
12208 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12209 INT_MAX
- max (hmargin
, vmargin
)))
12211 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12212 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12214 else if (CONSP (Vtool_bar_button_margin
))
12216 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12217 INT_MAX
- hmargin
))
12218 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12220 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12221 INT_MAX
- vmargin
))
12222 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12225 if (auto_raise_tool_bar_buttons_p
)
12227 /* Add a `:relief' property to the image spec if the item is
12231 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12238 /* If image is selected, display it pressed, i.e. with a
12239 negative relief. If it's not selected, display it with a
12241 plist
= Fplist_put (plist
, QCrelief
,
12243 ? make_number (-relief
)
12244 : make_number (relief
)));
12249 /* Put a margin around the image. */
12250 if (hmargin
|| vmargin
)
12252 if (hmargin
== vmargin
)
12253 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12255 plist
= Fplist_put (plist
, QCmargin
,
12256 Fcons (make_number (hmargin
),
12257 make_number (vmargin
)));
12260 /* If button is not enabled, and we don't have special images
12261 for the disabled state, make the image appear disabled by
12262 applying an appropriate algorithm to it. */
12263 if (!enabled_p
&& idx
< 0)
12264 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12266 /* Put a `display' text property on the string for the image to
12267 display. Put a `menu-item' property on the string that gives
12268 the start of this item's properties in the tool-bar items
12270 image
= Fcons (Qimage
, plist
);
12271 AUTO_LIST4 (props
, Qdisplay
, image
, Qmenu_item
,
12272 make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12274 /* Let the last image hide all remaining spaces in the tool bar
12275 string. The string can be longer than needed when we reuse a
12276 previous string. */
12277 if (i
+ 1 == f
->n_tool_bar_items
)
12278 end
= SCHARS (f
->desired_tool_bar_string
);
12281 Fadd_text_properties (make_number (i
), make_number (end
),
12282 props
, f
->desired_tool_bar_string
);
12288 /* Display one line of the tool-bar of frame IT->f.
12290 HEIGHT specifies the desired height of the tool-bar line.
12291 If the actual height of the glyph row is less than HEIGHT, the
12292 row's height is increased to HEIGHT, and the icons are centered
12293 vertically in the new height.
12295 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12296 count a final empty row in case the tool-bar width exactly matches
12301 display_tool_bar_line (struct it
*it
, int height
)
12303 struct glyph_row
*row
= it
->glyph_row
;
12304 int max_x
= it
->last_visible_x
;
12305 struct glyph
*last
;
12307 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12308 clear_glyph_row (row
);
12309 row
->enabled_p
= true;
12310 row
->y
= it
->current_y
;
12312 /* Note that this isn't made use of if the face hasn't a box,
12313 so there's no need to check the face here. */
12314 it
->start_of_box_run_p
= true;
12316 while (it
->current_x
< max_x
)
12318 int x
, n_glyphs_before
, i
, nglyphs
;
12319 struct it it_before
;
12321 /* Get the next display element. */
12322 if (!get_next_display_element (it
))
12324 /* Don't count empty row if we are counting needed tool-bar lines. */
12325 if (height
< 0 && !it
->hpos
)
12330 /* Produce glyphs. */
12331 n_glyphs_before
= row
->used
[TEXT_AREA
];
12334 PRODUCE_GLYPHS (it
);
12336 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12338 x
= it_before
.current_x
;
12339 while (i
< nglyphs
)
12341 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12343 if (x
+ glyph
->pixel_width
> max_x
)
12345 /* Glyph doesn't fit on line. Backtrack. */
12346 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12348 /* If this is the only glyph on this line, it will never fit on the
12349 tool-bar, so skip it. But ensure there is at least one glyph,
12350 so we don't accidentally disable the tool-bar. */
12351 if (n_glyphs_before
== 0
12352 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12358 x
+= glyph
->pixel_width
;
12362 /* Stop at line end. */
12363 if (ITERATOR_AT_END_OF_LINE_P (it
))
12366 set_iterator_to_next (it
, true);
12371 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12373 /* Use default face for the border below the tool bar.
12375 FIXME: When auto-resize-tool-bars is grow-only, there is
12376 no additional border below the possibly empty tool-bar lines.
12377 So to make the extra empty lines look "normal", we have to
12378 use the tool-bar face for the border too. */
12379 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12380 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12381 it
->face_id
= DEFAULT_FACE_ID
;
12383 extend_face_to_end_of_line (it
);
12384 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12385 last
->right_box_line_p
= true;
12386 if (last
== row
->glyphs
[TEXT_AREA
])
12387 last
->left_box_line_p
= true;
12389 /* Make line the desired height and center it vertically. */
12390 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12392 /* Don't add more than one line height. */
12393 height
%= FRAME_LINE_HEIGHT (it
->f
);
12394 it
->max_ascent
+= height
/ 2;
12395 it
->max_descent
+= (height
+ 1) / 2;
12398 compute_line_metrics (it
);
12400 /* If line is empty, make it occupy the rest of the tool-bar. */
12401 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12403 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12404 row
->visible_height
= row
->height
;
12405 row
->ascent
= row
->phys_ascent
= 0;
12406 row
->extra_line_spacing
= 0;
12409 row
->full_width_p
= true;
12410 row
->continued_p
= false;
12411 row
->truncated_on_left_p
= false;
12412 row
->truncated_on_right_p
= false;
12414 it
->current_x
= it
->hpos
= 0;
12415 it
->current_y
+= row
->height
;
12421 /* Value is the number of pixels needed to make all tool-bar items of
12422 frame F visible. The actual number of glyph rows needed is
12423 returned in *N_ROWS if non-NULL. */
12425 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12427 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12429 /* tool_bar_height is called from redisplay_tool_bar after building
12430 the desired matrix, so use (unused) mode-line row as temporary row to
12431 avoid destroying the first tool-bar row. */
12432 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12434 /* Initialize an iterator for iteration over
12435 F->desired_tool_bar_string in the tool-bar window of frame F. */
12436 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12437 temp_row
->reversed_p
= false;
12438 it
.first_visible_x
= 0;
12439 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12440 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12441 it
.paragraph_embedding
= L2R
;
12443 while (!ITERATOR_AT_END_P (&it
))
12445 clear_glyph_row (temp_row
);
12446 it
.glyph_row
= temp_row
;
12447 display_tool_bar_line (&it
, -1);
12449 clear_glyph_row (temp_row
);
12451 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12453 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12456 return it
.current_y
;
12458 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12461 #endif /* !USE_GTK && !HAVE_NS */
12463 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12465 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12466 If FRAME is nil or omitted, use the selected frame. Optional argument
12467 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12468 (Lisp_Object frame
, Lisp_Object pixelwise
)
12472 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12473 struct frame
*f
= decode_any_frame (frame
);
12475 if (WINDOWP (f
->tool_bar_window
)
12476 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12478 update_tool_bar (f
, true);
12479 if (f
->n_tool_bar_items
)
12481 build_desired_tool_bar_string (f
);
12482 height
= tool_bar_height (f
, NULL
, !NILP (pixelwise
));
12487 return make_number (height
);
12491 /* Display the tool-bar of frame F. Value is true if tool-bar's
12492 height should be changed. */
12494 redisplay_tool_bar (struct frame
*f
)
12496 f
->tool_bar_redisplayed
= true;
12497 #if defined (USE_GTK) || defined (HAVE_NS)
12499 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12500 update_frame_tool_bar (f
);
12503 #else /* !USE_GTK && !HAVE_NS */
12507 struct glyph_row
*row
;
12509 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12510 do anything. This means you must start with tool-bar-lines
12511 non-zero to get the auto-sizing effect. Or in other words, you
12512 can turn off tool-bars by specifying tool-bar-lines zero. */
12513 if (!WINDOWP (f
->tool_bar_window
)
12514 || (w
= XWINDOW (f
->tool_bar_window
),
12515 WINDOW_TOTAL_LINES (w
) == 0))
12518 /* Set up an iterator for the tool-bar window. */
12519 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12520 it
.first_visible_x
= 0;
12521 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12522 row
= it
.glyph_row
;
12523 row
->reversed_p
= false;
12525 /* Build a string that represents the contents of the tool-bar. */
12526 build_desired_tool_bar_string (f
);
12527 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12528 /* FIXME: This should be controlled by a user option. But it
12529 doesn't make sense to have an R2L tool bar if the menu bar cannot
12530 be drawn also R2L, and making the menu bar R2L is tricky due
12531 toolkit-specific code that implements it. If an R2L tool bar is
12532 ever supported, display_tool_bar_line should also be augmented to
12533 call unproduce_glyphs like display_line and display_string
12535 it
.paragraph_embedding
= L2R
;
12537 if (f
->n_tool_bar_rows
== 0)
12539 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, true);
12541 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12543 x_change_tool_bar_height (f
, new_height
);
12544 frame_default_tool_bar_height
= new_height
;
12545 /* Always do that now. */
12546 clear_glyph_matrix (w
->desired_matrix
);
12547 f
->fonts_changed
= true;
12552 /* Display as many lines as needed to display all tool-bar items. */
12554 if (f
->n_tool_bar_rows
> 0)
12556 int border
, rows
, height
, extra
;
12558 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12559 border
= XINT (Vtool_bar_border
);
12560 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12561 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12562 else if (EQ (Vtool_bar_border
, Qborder_width
))
12563 border
= f
->border_width
;
12569 rows
= f
->n_tool_bar_rows
;
12570 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12571 extra
= it
.last_visible_y
- border
- height
* rows
;
12573 while (it
.current_y
< it
.last_visible_y
)
12576 if (extra
> 0 && rows
-- > 0)
12578 h
= (extra
+ rows
- 1) / rows
;
12581 display_tool_bar_line (&it
, height
+ h
);
12586 while (it
.current_y
< it
.last_visible_y
)
12587 display_tool_bar_line (&it
, 0);
12590 /* It doesn't make much sense to try scrolling in the tool-bar
12591 window, so don't do it. */
12592 w
->desired_matrix
->no_scrolling_p
= true;
12593 w
->must_be_updated_p
= true;
12595 if (!NILP (Vauto_resize_tool_bars
))
12597 bool change_height_p
= true;
12599 /* If we couldn't display everything, change the tool-bar's
12600 height if there is room for more. */
12601 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
12602 change_height_p
= true;
12604 /* We subtract 1 because display_tool_bar_line advances the
12605 glyph_row pointer before returning to its caller. We want to
12606 examine the last glyph row produced by
12607 display_tool_bar_line. */
12608 row
= it
.glyph_row
- 1;
12610 /* If there are blank lines at the end, except for a partially
12611 visible blank line at the end that is smaller than
12612 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12613 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12614 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12615 change_height_p
= true;
12617 /* If row displays tool-bar items, but is partially visible,
12618 change the tool-bar's height. */
12619 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12620 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
12621 change_height_p
= true;
12623 /* Resize windows as needed by changing the `tool-bar-lines'
12624 frame parameter. */
12625 if (change_height_p
)
12628 int new_height
= tool_bar_height (f
, &nrows
, true);
12630 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12631 && !f
->minimize_tool_bar_window_p
)
12632 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12633 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12634 f
->minimize_tool_bar_window_p
= false;
12636 if (change_height_p
)
12638 x_change_tool_bar_height (f
, new_height
);
12639 frame_default_tool_bar_height
= new_height
;
12640 clear_glyph_matrix (w
->desired_matrix
);
12641 f
->n_tool_bar_rows
= nrows
;
12642 f
->fonts_changed
= true;
12649 f
->minimize_tool_bar_window_p
= false;
12652 #endif /* USE_GTK || HAVE_NS */
12655 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12657 /* Get information about the tool-bar item which is displayed in GLYPH
12658 on frame F. Return in *PROP_IDX the index where tool-bar item
12659 properties start in F->tool_bar_items. Value is false if
12660 GLYPH doesn't display a tool-bar item. */
12663 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12668 /* This function can be called asynchronously, which means we must
12669 exclude any possibility that Fget_text_property signals an
12671 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12672 charpos
= max (0, charpos
);
12674 /* Get the text property `menu-item' at pos. The value of that
12675 property is the start index of this item's properties in
12676 F->tool_bar_items. */
12677 prop
= Fget_text_property (make_number (charpos
),
12678 Qmenu_item
, f
->current_tool_bar_string
);
12679 if (! INTEGERP (prop
))
12681 *prop_idx
= XINT (prop
);
12686 /* Get information about the tool-bar item at position X/Y on frame F.
12687 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12688 the current matrix of the tool-bar window of F, or NULL if not
12689 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12690 item in F->tool_bar_items. Value is
12692 -1 if X/Y is not on a tool-bar item
12693 0 if X/Y is on the same item that was highlighted before.
12697 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12698 int *hpos
, int *vpos
, int *prop_idx
)
12700 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12701 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12704 /* Find the glyph under X/Y. */
12705 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12706 if (*glyph
== NULL
)
12709 /* Get the start of this tool-bar item's properties in
12710 f->tool_bar_items. */
12711 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12714 /* Is mouse on the highlighted item? */
12715 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12716 && *vpos
>= hlinfo
->mouse_face_beg_row
12717 && *vpos
<= hlinfo
->mouse_face_end_row
12718 && (*vpos
> hlinfo
->mouse_face_beg_row
12719 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12720 && (*vpos
< hlinfo
->mouse_face_end_row
12721 || *hpos
< hlinfo
->mouse_face_end_col
12722 || hlinfo
->mouse_face_past_end
))
12730 Handle mouse button event on the tool-bar of frame F, at
12731 frame-relative coordinates X/Y. DOWN_P is true for a button press,
12732 false for button release. MODIFIERS is event modifiers for button
12736 handle_tool_bar_click (struct frame
*f
, int x
, int y
, bool down_p
,
12739 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12740 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12741 int hpos
, vpos
, prop_idx
;
12742 struct glyph
*glyph
;
12743 Lisp_Object enabled_p
;
12746 /* If not on the highlighted tool-bar item, and mouse-highlight is
12747 non-nil, return. This is so we generate the tool-bar button
12748 click only when the mouse button is released on the same item as
12749 where it was pressed. However, when mouse-highlight is disabled,
12750 generate the click when the button is released regardless of the
12751 highlight, since tool-bar items are not highlighted in that
12753 frame_to_window_pixel_xy (w
, &x
, &y
);
12754 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12756 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12759 /* When mouse-highlight is off, generate the click for the item
12760 where the button was pressed, disregarding where it was
12762 if (NILP (Vmouse_highlight
) && !down_p
)
12763 prop_idx
= f
->last_tool_bar_item
;
12765 /* If item is disabled, do nothing. */
12766 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12767 if (NILP (enabled_p
))
12772 /* Show item in pressed state. */
12773 if (!NILP (Vmouse_highlight
))
12774 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12775 f
->last_tool_bar_item
= prop_idx
;
12779 Lisp_Object key
, frame
;
12780 struct input_event event
;
12781 EVENT_INIT (event
);
12783 /* Show item in released state. */
12784 if (!NILP (Vmouse_highlight
))
12785 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12787 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12789 XSETFRAME (frame
, f
);
12790 event
.kind
= TOOL_BAR_EVENT
;
12791 event
.frame_or_window
= frame
;
12793 kbd_buffer_store_event (&event
);
12795 event
.kind
= TOOL_BAR_EVENT
;
12796 event
.frame_or_window
= frame
;
12798 event
.modifiers
= modifiers
;
12799 kbd_buffer_store_event (&event
);
12800 f
->last_tool_bar_item
= -1;
12805 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12806 tool-bar window-relative coordinates X/Y. Called from
12807 note_mouse_highlight. */
12810 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12812 Lisp_Object window
= f
->tool_bar_window
;
12813 struct window
*w
= XWINDOW (window
);
12814 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12815 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12817 struct glyph
*glyph
;
12818 struct glyph_row
*row
;
12820 Lisp_Object enabled_p
;
12822 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12826 /* Function note_mouse_highlight is called with negative X/Y
12827 values when mouse moves outside of the frame. */
12828 if (x
<= 0 || y
<= 0)
12830 clear_mouse_face (hlinfo
);
12834 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12837 /* Not on tool-bar item. */
12838 clear_mouse_face (hlinfo
);
12842 /* On same tool-bar item as before. */
12843 goto set_help_echo
;
12845 clear_mouse_face (hlinfo
);
12847 /* Mouse is down, but on different tool-bar item? */
12848 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12849 && f
== dpyinfo
->last_mouse_frame
);
12851 if (mouse_down_p
&& f
->last_tool_bar_item
!= prop_idx
)
12854 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12856 /* If tool-bar item is not enabled, don't highlight it. */
12857 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12858 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12860 /* Compute the x-position of the glyph. In front and past the
12861 image is a space. We include this in the highlighted area. */
12862 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12863 for (i
= x
= 0; i
< hpos
; ++i
)
12864 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12866 /* Record this as the current active region. */
12867 hlinfo
->mouse_face_beg_col
= hpos
;
12868 hlinfo
->mouse_face_beg_row
= vpos
;
12869 hlinfo
->mouse_face_beg_x
= x
;
12870 hlinfo
->mouse_face_past_end
= false;
12872 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12873 hlinfo
->mouse_face_end_row
= vpos
;
12874 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12875 hlinfo
->mouse_face_window
= window
;
12876 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12878 /* Display it as active. */
12879 show_mouse_face (hlinfo
, draw
);
12884 /* Set help_echo_string to a help string to display for this tool-bar item.
12885 XTread_socket does the rest. */
12886 help_echo_object
= help_echo_window
= Qnil
;
12887 help_echo_pos
= -1;
12888 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12889 if (NILP (help_echo_string
))
12890 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12893 #endif /* !USE_GTK && !HAVE_NS */
12895 #endif /* HAVE_WINDOW_SYSTEM */
12899 /************************************************************************
12900 Horizontal scrolling
12901 ************************************************************************/
12903 /* For all leaf windows in the window tree rooted at WINDOW, set their
12904 hscroll value so that PT is (i) visible in the window, and (ii) so
12905 that it is not within a certain margin at the window's left and
12906 right border. Value is true if any window's hscroll has been
12910 hscroll_window_tree (Lisp_Object window
)
12912 bool hscrolled_p
= false;
12913 bool hscroll_relative_p
= FLOATP (Vhscroll_step
);
12914 int hscroll_step_abs
= 0;
12915 double hscroll_step_rel
= 0;
12917 if (hscroll_relative_p
)
12919 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12920 if (hscroll_step_rel
< 0)
12922 hscroll_relative_p
= false;
12923 hscroll_step_abs
= 0;
12926 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12928 hscroll_step_abs
= XINT (Vhscroll_step
);
12929 if (hscroll_step_abs
< 0)
12930 hscroll_step_abs
= 0;
12933 hscroll_step_abs
= 0;
12935 while (WINDOWP (window
))
12937 struct window
*w
= XWINDOW (window
);
12939 if (WINDOWP (w
->contents
))
12940 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12941 else if (w
->cursor
.vpos
>= 0)
12944 int text_area_width
;
12945 struct glyph_row
*cursor_row
;
12946 struct glyph_row
*bottom_row
;
12948 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12949 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12950 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12952 cursor_row
= bottom_row
- 1;
12954 if (!cursor_row
->enabled_p
)
12956 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12957 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12958 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12960 cursor_row
= bottom_row
- 1;
12962 bool row_r2l_p
= cursor_row
->reversed_p
;
12964 text_area_width
= window_box_width (w
, TEXT_AREA
);
12966 /* Scroll when cursor is inside this scroll margin. */
12967 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12969 /* If the position of this window's point has explicitly
12970 changed, no more suspend auto hscrolling. */
12971 if (NILP (Fequal (Fwindow_point (window
), Fwindow_old_point (window
))))
12972 w
->suspend_auto_hscroll
= false;
12974 /* Remember window point. */
12975 Fset_marker (w
->old_pointm
,
12976 ((w
== XWINDOW (selected_window
))
12977 ? make_number (BUF_PT (XBUFFER (w
->contents
)))
12978 : Fmarker_position (w
->pointm
)),
12981 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12982 && !w
->suspend_auto_hscroll
12983 /* In some pathological cases, like restoring a window
12984 configuration into a frame that is much smaller than
12985 the one from which the configuration was saved, we
12986 get glyph rows whose start and end have zero buffer
12987 positions, which we cannot handle below. Just skip
12989 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12990 /* For left-to-right rows, hscroll when cursor is either
12991 (i) inside the right hscroll margin, or (ii) if it is
12992 inside the left margin and the window is already
12995 && ((w
->hscroll
&& w
->cursor
.x
<= h_margin
)
12996 || (cursor_row
->enabled_p
12997 && cursor_row
->truncated_on_right_p
12998 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12999 /* For right-to-left rows, the logic is similar,
13000 except that rules for scrolling to left and right
13001 are reversed. E.g., if cursor.x <= h_margin, we
13002 need to hscroll "to the right" unconditionally,
13003 and that will scroll the screen to the left so as
13004 to reveal the next portion of the row. */
13006 && ((cursor_row
->enabled_p
13007 /* FIXME: It is confusing to set the
13008 truncated_on_right_p flag when R2L rows
13009 are actually truncated on the left. */
13010 && cursor_row
->truncated_on_right_p
13011 && w
->cursor
.x
<= h_margin
)
13013 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
13017 struct buffer
*saved_current_buffer
;
13021 /* Find point in a display of infinite width. */
13022 saved_current_buffer
= current_buffer
;
13023 current_buffer
= XBUFFER (w
->contents
);
13025 if (w
== XWINDOW (selected_window
))
13028 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
13030 /* Move iterator to pt starting at cursor_row->start in
13031 a line with infinite width. */
13032 init_to_row_start (&it
, w
, cursor_row
);
13033 it
.last_visible_x
= INFINITY
;
13034 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
13035 current_buffer
= saved_current_buffer
;
13037 /* Position cursor in window. */
13038 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
13039 hscroll
= max (0, (it
.current_x
13040 - (ITERATOR_AT_END_OF_LINE_P (&it
)
13041 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
13042 : (text_area_width
/ 2))))
13043 / FRAME_COLUMN_WIDTH (it
.f
);
13044 else if ((!row_r2l_p
13045 && w
->cursor
.x
>= text_area_width
- h_margin
)
13046 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
13048 if (hscroll_relative_p
)
13049 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
13052 wanted_x
= text_area_width
13053 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
13056 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
13060 if (hscroll_relative_p
)
13061 wanted_x
= text_area_width
* hscroll_step_rel
13064 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
13067 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
13069 hscroll
= max (hscroll
, w
->min_hscroll
);
13071 /* Don't prevent redisplay optimizations if hscroll
13072 hasn't changed, as it will unnecessarily slow down
13074 if (w
->hscroll
!= hscroll
)
13076 struct buffer
*b
= XBUFFER (w
->contents
);
13077 b
->prevent_redisplay_optimizations_p
= true;
13078 w
->hscroll
= hscroll
;
13079 hscrolled_p
= true;
13087 /* Value is true if hscroll of any leaf window has been changed. */
13088 return hscrolled_p
;
13092 /* Set hscroll so that cursor is visible and not inside horizontal
13093 scroll margins for all windows in the tree rooted at WINDOW. See
13094 also hscroll_window_tree above. Value is true if any window's
13095 hscroll has been changed. If it has, desired matrices on the frame
13096 of WINDOW are cleared. */
13099 hscroll_windows (Lisp_Object window
)
13101 bool hscrolled_p
= hscroll_window_tree (window
);
13103 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
13104 return hscrolled_p
;
13109 /************************************************************************
13111 ************************************************************************/
13113 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined.
13114 This is sometimes handy to have in a debugger session. */
13118 /* First and last unchanged row for try_window_id. */
13120 static int debug_first_unchanged_at_end_vpos
;
13121 static int debug_last_unchanged_at_beg_vpos
;
13123 /* Delta vpos and y. */
13125 static int debug_dvpos
, debug_dy
;
13127 /* Delta in characters and bytes for try_window_id. */
13129 static ptrdiff_t debug_delta
, debug_delta_bytes
;
13131 /* Values of window_end_pos and window_end_vpos at the end of
13134 static ptrdiff_t debug_end_vpos
;
13136 /* Append a string to W->desired_matrix->method. FMT is a printf
13137 format string. If trace_redisplay_p is true also printf the
13138 resulting string to stderr. */
13140 static void debug_method_add (struct window
*, char const *, ...)
13141 ATTRIBUTE_FORMAT_PRINTF (2, 3);
13144 debug_method_add (struct window
*w
, char const *fmt
, ...)
13147 char *method
= w
->desired_matrix
->method
;
13148 int len
= strlen (method
);
13149 int size
= sizeof w
->desired_matrix
->method
;
13150 int remaining
= size
- len
- 1;
13153 if (len
&& remaining
)
13156 --remaining
, ++len
;
13159 va_start (ap
, fmt
);
13160 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
13163 if (trace_redisplay_p
)
13164 fprintf (stderr
, "%p (%s): %s\n",
13166 ((BUFFERP (w
->contents
)
13167 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
13168 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13173 #endif /* GLYPH_DEBUG */
13176 /* Value is true if all changes in window W, which displays
13177 current_buffer, are in the text between START and END. START is a
13178 buffer position, END is given as a distance from Z. Used in
13179 redisplay_internal for display optimization. */
13182 text_outside_line_unchanged_p (struct window
*w
,
13183 ptrdiff_t start
, ptrdiff_t end
)
13185 bool unchanged_p
= true;
13187 /* If text or overlays have changed, see where. */
13188 if (window_outdated (w
))
13190 /* Gap in the line? */
13191 if (GPT
< start
|| Z
- GPT
< end
)
13192 unchanged_p
= false;
13194 /* Changes start in front of the line, or end after it? */
13196 && (BEG_UNCHANGED
< start
- 1
13197 || END_UNCHANGED
< end
))
13198 unchanged_p
= false;
13200 /* If selective display, can't optimize if changes start at the
13201 beginning of the line. */
13203 && INTEGERP (BVAR (current_buffer
, selective_display
))
13204 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13205 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13206 unchanged_p
= false;
13208 /* If there are overlays at the start or end of the line, these
13209 may have overlay strings with newlines in them. A change at
13210 START, for instance, may actually concern the display of such
13211 overlay strings as well, and they are displayed on different
13212 lines. So, quickly rule out this case. (For the future, it
13213 might be desirable to implement something more telling than
13214 just BEG/END_UNCHANGED.) */
13217 if (BEG
+ BEG_UNCHANGED
== start
13218 && overlay_touches_p (start
))
13219 unchanged_p
= false;
13220 if (END_UNCHANGED
== end
13221 && overlay_touches_p (Z
- end
))
13222 unchanged_p
= false;
13225 /* Under bidi reordering, adding or deleting a character in the
13226 beginning of a paragraph, before the first strong directional
13227 character, can change the base direction of the paragraph (unless
13228 the buffer specifies a fixed paragraph direction), which will
13229 require redisplaying the whole paragraph. It might be worthwhile
13230 to find the paragraph limits and widen the range of redisplayed
13231 lines to that, but for now just give up this optimization. */
13232 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13233 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13234 unchanged_p
= false;
13237 return unchanged_p
;
13241 /* Do a frame update, taking possible shortcuts into account. This is
13242 the main external entry point for redisplay.
13244 If the last redisplay displayed an echo area message and that message
13245 is no longer requested, we clear the echo area or bring back the
13246 mini-buffer if that is in use. */
13251 redisplay_internal ();
13256 overlay_arrow_string_or_property (Lisp_Object var
)
13260 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13263 return Voverlay_arrow_string
;
13266 /* Return true if there are any overlay-arrows in current_buffer. */
13268 overlay_arrow_in_current_buffer_p (void)
13272 for (vlist
= Voverlay_arrow_variable_list
;
13274 vlist
= XCDR (vlist
))
13276 Lisp_Object var
= XCAR (vlist
);
13279 if (!SYMBOLP (var
))
13281 val
= find_symbol_value (var
);
13283 && current_buffer
== XMARKER (val
)->buffer
)
13290 /* Return true if any overlay_arrows have moved or overlay-arrow-string
13294 overlay_arrows_changed_p (void)
13298 for (vlist
= Voverlay_arrow_variable_list
;
13300 vlist
= XCDR (vlist
))
13302 Lisp_Object var
= XCAR (vlist
);
13303 Lisp_Object val
, pstr
;
13305 if (!SYMBOLP (var
))
13307 val
= find_symbol_value (var
);
13308 if (!MARKERP (val
))
13310 if (! EQ (COERCE_MARKER (val
),
13311 Fget (var
, Qlast_arrow_position
))
13312 || ! (pstr
= overlay_arrow_string_or_property (var
),
13313 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13319 /* Mark overlay arrows to be updated on next redisplay. */
13322 update_overlay_arrows (int up_to_date
)
13326 for (vlist
= Voverlay_arrow_variable_list
;
13328 vlist
= XCDR (vlist
))
13330 Lisp_Object var
= XCAR (vlist
);
13332 if (!SYMBOLP (var
))
13335 if (up_to_date
> 0)
13337 Lisp_Object val
= find_symbol_value (var
);
13338 Fput (var
, Qlast_arrow_position
,
13339 COERCE_MARKER (val
));
13340 Fput (var
, Qlast_arrow_string
,
13341 overlay_arrow_string_or_property (var
));
13343 else if (up_to_date
< 0
13344 || !NILP (Fget (var
, Qlast_arrow_position
)))
13346 Fput (var
, Qlast_arrow_position
, Qt
);
13347 Fput (var
, Qlast_arrow_string
, Qt
);
13353 /* Return overlay arrow string to display at row.
13354 Return integer (bitmap number) for arrow bitmap in left fringe.
13355 Return nil if no overlay arrow. */
13358 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13362 for (vlist
= Voverlay_arrow_variable_list
;
13364 vlist
= XCDR (vlist
))
13366 Lisp_Object var
= XCAR (vlist
);
13369 if (!SYMBOLP (var
))
13372 val
= find_symbol_value (var
);
13375 && current_buffer
== XMARKER (val
)->buffer
13376 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13378 if (FRAME_WINDOW_P (it
->f
)
13379 /* FIXME: if ROW->reversed_p is set, this should test
13380 the right fringe, not the left one. */
13381 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13383 #ifdef HAVE_WINDOW_SYSTEM
13384 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13386 int fringe_bitmap
= lookup_fringe_bitmap (val
);
13387 if (fringe_bitmap
!= 0)
13388 return make_number (fringe_bitmap
);
13391 return make_number (-1); /* Use default arrow bitmap. */
13393 return overlay_arrow_string_or_property (var
);
13400 /* Return true if point moved out of or into a composition. Otherwise
13401 return false. PREV_BUF and PREV_PT are the last point buffer and
13402 position. BUF and PT are the current point buffer and position. */
13405 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13406 struct buffer
*buf
, ptrdiff_t pt
)
13408 ptrdiff_t start
, end
;
13410 Lisp_Object buffer
;
13412 XSETBUFFER (buffer
, buf
);
13413 /* Check a composition at the last point if point moved within the
13415 if (prev_buf
== buf
)
13418 /* Point didn't move. */
13421 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13422 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13423 && composition_valid_p (start
, end
, prop
)
13424 && start
< prev_pt
&& end
> prev_pt
)
13425 /* The last point was within the composition. Return true iff
13426 point moved out of the composition. */
13427 return (pt
<= start
|| pt
>= end
);
13430 /* Check a composition at the current point. */
13431 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13432 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13433 && composition_valid_p (start
, end
, prop
)
13434 && start
< pt
&& end
> pt
);
13437 /* Reconsider the clip changes of buffer which is displayed in W. */
13440 reconsider_clip_changes (struct window
*w
)
13442 struct buffer
*b
= XBUFFER (w
->contents
);
13444 if (b
->clip_changed
13445 && w
->window_end_valid
13446 && w
->current_matrix
->buffer
== b
13447 && w
->current_matrix
->zv
== BUF_ZV (b
)
13448 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13449 b
->clip_changed
= false;
13451 /* If display wasn't paused, and W is not a tool bar window, see if
13452 point has been moved into or out of a composition. In that case,
13453 set b->clip_changed to force updating the screen. If
13454 b->clip_changed has already been set, skip this check. */
13455 if (!b
->clip_changed
&& w
->window_end_valid
)
13457 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13458 ? PT
: marker_position (w
->pointm
));
13460 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13461 && check_point_in_composition (w
->current_matrix
->buffer
,
13462 w
->last_point
, b
, pt
))
13463 b
->clip_changed
= true;
13468 propagate_buffer_redisplay (void)
13469 { /* Resetting b->text->redisplay is problematic!
13470 We can't just reset it in the case that some window that displays
13471 it has not been redisplayed; and such a window can stay
13472 unredisplayed for a long time if it's currently invisible.
13473 But we do want to reset it at the end of redisplay otherwise
13474 its displayed windows will keep being redisplayed over and over
13476 So we copy all b->text->redisplay flags up to their windows here,
13477 such that mark_window_display_accurate can safely reset
13478 b->text->redisplay. */
13479 Lisp_Object ws
= window_list ();
13480 for (; CONSP (ws
); ws
= XCDR (ws
))
13482 struct window
*thisw
= XWINDOW (XCAR (ws
));
13483 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13484 if (thisb
->text
->redisplay
)
13485 thisw
->redisplay
= true;
13489 #define STOP_POLLING \
13490 do { if (! polling_stopped_here) stop_polling (); \
13491 polling_stopped_here = true; } while (false)
13493 #define RESUME_POLLING \
13494 do { if (polling_stopped_here) start_polling (); \
13495 polling_stopped_here = false; } while (false)
13498 /* Perhaps in the future avoid recentering windows if it
13499 is not necessary; currently that causes some problems. */
13502 redisplay_internal (void)
13504 struct window
*w
= XWINDOW (selected_window
);
13508 bool must_finish
= false, match_p
;
13509 struct text_pos tlbufpos
, tlendpos
;
13510 int number_of_visible_frames
;
13513 bool polling_stopped_here
= false;
13514 Lisp_Object tail
, frame
;
13516 /* True means redisplay has to consider all windows on all
13517 frames. False, only selected_window is considered. */
13518 bool consider_all_windows_p
;
13520 /* True means redisplay has to redisplay the miniwindow. */
13521 bool update_miniwindow_p
= false;
13523 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13525 /* No redisplay if running in batch mode or frame is not yet fully
13526 initialized, or redisplay is explicitly turned off by setting
13527 Vinhibit_redisplay. */
13528 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13529 || !NILP (Vinhibit_redisplay
))
13532 /* Don't examine these until after testing Vinhibit_redisplay.
13533 When Emacs is shutting down, perhaps because its connection to
13534 X has dropped, we should not look at them at all. */
13535 fr
= XFRAME (w
->frame
);
13536 sf
= SELECTED_FRAME ();
13538 if (!fr
->glyphs_initialized_p
)
13541 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13542 if (popup_activated ())
13546 /* I don't think this happens but let's be paranoid. */
13547 if (redisplaying_p
)
13550 /* Record a function that clears redisplaying_p
13551 when we leave this function. */
13552 count
= SPECPDL_INDEX ();
13553 record_unwind_protect_void (unwind_redisplay
);
13554 redisplaying_p
= true;
13555 specbind (Qinhibit_free_realized_faces
, Qnil
);
13557 /* Record this function, so it appears on the profiler's backtraces. */
13558 record_in_backtrace (Qredisplay_internal_xC_functionx
, 0, 0);
13560 FOR_EACH_FRAME (tail
, frame
)
13561 XFRAME (frame
)->already_hscrolled_p
= false;
13564 /* Remember the currently selected window. */
13568 forget_escape_and_glyphless_faces ();
13570 inhibit_free_realized_faces
= false;
13572 /* If face_change, init_iterator will free all realized faces, which
13573 includes the faces referenced from current matrices. So, we
13574 can't reuse current matrices in this case. */
13576 windows_or_buffers_changed
= 47;
13578 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13579 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13581 /* Since frames on a single ASCII terminal share the same
13582 display area, displaying a different frame means redisplay
13583 the whole thing. */
13584 SET_FRAME_GARBAGED (sf
);
13586 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13588 FRAME_TTY (sf
)->previous_frame
= sf
;
13591 /* Set the visible flags for all frames. Do this before checking for
13592 resized or garbaged frames; they want to know if their frames are
13593 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13594 number_of_visible_frames
= 0;
13596 FOR_EACH_FRAME (tail
, frame
)
13598 struct frame
*f
= XFRAME (frame
);
13600 if (FRAME_VISIBLE_P (f
))
13602 ++number_of_visible_frames
;
13603 /* Adjust matrices for visible frames only. */
13604 if (f
->fonts_changed
)
13606 adjust_frame_glyphs (f
);
13607 /* Disable all redisplay optimizations for this frame.
13608 This is because adjust_frame_glyphs resets the
13609 enabled_p flag for all glyph rows of all windows, so
13610 many optimizations will fail anyway, and some might
13611 fail to test that flag and do bogus things as
13613 SET_FRAME_GARBAGED (f
);
13614 f
->fonts_changed
= false;
13616 /* If cursor type has been changed on the frame
13617 other than selected, consider all frames. */
13618 if (f
!= sf
&& f
->cursor_type_changed
)
13619 fset_redisplay (f
);
13621 clear_desired_matrices (f
);
13624 /* Notice any pending interrupt request to change frame size. */
13625 do_pending_window_change (true);
13627 /* do_pending_window_change could change the selected_window due to
13628 frame resizing which makes the selected window too small. */
13629 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13632 /* Clear frames marked as garbaged. */
13633 clear_garbaged_frames ();
13635 /* Build menubar and tool-bar items. */
13636 if (NILP (Vmemory_full
))
13637 prepare_menu_bars ();
13639 reconsider_clip_changes (w
);
13641 /* In most cases selected window displays current buffer. */
13642 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13645 /* Detect case that we need to write or remove a star in the mode line. */
13646 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13647 w
->update_mode_line
= true;
13649 if (mode_line_update_needed (w
))
13650 w
->update_mode_line
= true;
13652 /* If reconsider_clip_changes above decided that the narrowing
13653 in the current buffer changed, make sure all other windows
13654 showing that buffer will be redisplayed. */
13655 if (current_buffer
->clip_changed
)
13656 bset_update_mode_line (current_buffer
);
13659 /* Normally the message* functions will have already displayed and
13660 updated the echo area, but the frame may have been trashed, or
13661 the update may have been preempted, so display the echo area
13662 again here. Checking message_cleared_p captures the case that
13663 the echo area should be cleared. */
13664 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13665 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13666 || (message_cleared_p
13667 && minibuf_level
== 0
13668 /* If the mini-window is currently selected, this means the
13669 echo-area doesn't show through. */
13670 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13672 echo_area_display (false);
13674 /* If echo_area_display resizes the mini-window, the redisplay and
13675 window_sizes_changed flags of the selected frame are set, but
13676 it's too late for the hooks in window-size-change-functions,
13677 which have been examined already in prepare_menu_bars. So in
13678 that case we call the hooks here only for the selected frame. */
13681 ptrdiff_t count1
= SPECPDL_INDEX ();
13683 record_unwind_save_match_data ();
13684 run_window_size_change_functions (selected_frame
);
13685 unbind_to (count1
, Qnil
);
13688 if (message_cleared_p
)
13689 update_miniwindow_p
= true;
13691 must_finish
= true;
13693 /* If we don't display the current message, don't clear the
13694 message_cleared_p flag, because, if we did, we wouldn't clear
13695 the echo area in the next redisplay which doesn't preserve
13697 if (!display_last_displayed_message_p
)
13698 message_cleared_p
= false;
13700 else if (EQ (selected_window
, minibuf_window
)
13701 && (current_buffer
->clip_changed
|| window_outdated (w
))
13702 && resize_mini_window (w
, false))
13706 ptrdiff_t count1
= SPECPDL_INDEX ();
13708 record_unwind_save_match_data ();
13709 run_window_size_change_functions (selected_frame
);
13710 unbind_to (count1
, Qnil
);
13713 /* Resized active mini-window to fit the size of what it is
13714 showing if its contents might have changed. */
13715 must_finish
= true;
13717 /* If window configuration was changed, frames may have been
13718 marked garbaged. Clear them or we will experience
13719 surprises wrt scrolling. */
13720 clear_garbaged_frames ();
13723 if (windows_or_buffers_changed
&& !update_mode_lines
)
13724 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13725 only the windows's contents needs to be refreshed, or whether the
13726 mode-lines also need a refresh. */
13727 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13728 ? REDISPLAY_SOME
: 32);
13730 /* If specs for an arrow have changed, do thorough redisplay
13731 to ensure we remove any arrow that should no longer exist. */
13732 if (overlay_arrows_changed_p ())
13733 /* Apparently, this is the only case where we update other windows,
13734 without updating other mode-lines. */
13735 windows_or_buffers_changed
= 49;
13737 consider_all_windows_p
= (update_mode_lines
13738 || windows_or_buffers_changed
);
13740 #define AINC(a,i) \
13742 Lisp_Object entry = Fgethash (make_number (i), a, make_number (0)); \
13743 if (INTEGERP (entry)) \
13744 Fputhash (make_number (i), make_number (1 + XINT (entry)), a); \
13747 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13748 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13750 /* Optimize the case that only the line containing the cursor in the
13751 selected window has changed. Variables starting with this_ are
13752 set in display_line and record information about the line
13753 containing the cursor. */
13754 tlbufpos
= this_line_start_pos
;
13755 tlendpos
= this_line_end_pos
;
13756 if (!consider_all_windows_p
13757 && CHARPOS (tlbufpos
) > 0
13758 && !w
->update_mode_line
13759 && !current_buffer
->clip_changed
13760 && !current_buffer
->prevent_redisplay_optimizations_p
13761 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13762 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13763 && !XFRAME (w
->frame
)->cursor_type_changed
13764 && !XFRAME (w
->frame
)->face_change
13765 /* Make sure recorded data applies to current buffer, etc. */
13766 && this_line_buffer
== current_buffer
13769 && !w
->optional_new_start
13770 /* Point must be on the line that we have info recorded about. */
13771 && PT
>= CHARPOS (tlbufpos
)
13772 && PT
<= Z
- CHARPOS (tlendpos
)
13773 /* All text outside that line, including its final newline,
13774 must be unchanged. */
13775 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13776 CHARPOS (tlendpos
)))
13778 if (CHARPOS (tlbufpos
) > BEGV
13779 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13780 && (CHARPOS (tlbufpos
) == ZV
13781 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13782 /* Former continuation line has disappeared by becoming empty. */
13784 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13786 /* We have to handle the case of continuation around a
13787 wide-column character (see the comment in indent.c around
13790 For instance, in the following case:
13792 -------- Insert --------
13793 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13794 J_I_ ==> J_I_ `^^' are cursors.
13798 As we have to redraw the line above, we cannot use this
13802 int line_height_before
= this_line_pixel_height
;
13804 /* Note that start_display will handle the case that the
13805 line starting at tlbufpos is a continuation line. */
13806 start_display (&it
, w
, tlbufpos
);
13808 /* Implementation note: It this still necessary? */
13809 if (it
.current_x
!= this_line_start_x
)
13812 TRACE ((stderr
, "trying display optimization 1\n"));
13813 w
->cursor
.vpos
= -1;
13814 overlay_arrow_seen
= false;
13815 it
.vpos
= this_line_vpos
;
13816 it
.current_y
= this_line_y
;
13817 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13818 display_line (&it
);
13820 /* If line contains point, is not continued,
13821 and ends at same distance from eob as before, we win. */
13822 if (w
->cursor
.vpos
>= 0
13823 /* Line is not continued, otherwise this_line_start_pos
13824 would have been set to 0 in display_line. */
13825 && CHARPOS (this_line_start_pos
)
13826 /* Line ends as before. */
13827 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13828 /* Line has same height as before. Otherwise other lines
13829 would have to be shifted up or down. */
13830 && this_line_pixel_height
== line_height_before
)
13832 /* If this is not the window's last line, we must adjust
13833 the charstarts of the lines below. */
13834 if (it
.current_y
< it
.last_visible_y
)
13836 struct glyph_row
*row
13837 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13838 ptrdiff_t delta
, delta_bytes
;
13840 /* We used to distinguish between two cases here,
13841 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13842 when the line ends in a newline or the end of the
13843 buffer's accessible portion. But both cases did
13844 the same, so they were collapsed. */
13846 - CHARPOS (tlendpos
)
13847 - MATRIX_ROW_START_CHARPOS (row
));
13848 delta_bytes
= (Z_BYTE
13849 - BYTEPOS (tlendpos
)
13850 - MATRIX_ROW_START_BYTEPOS (row
));
13852 increment_matrix_positions (w
->current_matrix
,
13853 this_line_vpos
+ 1,
13854 w
->current_matrix
->nrows
,
13855 delta
, delta_bytes
);
13858 /* If this row displays text now but previously didn't,
13859 or vice versa, w->window_end_vpos may have to be
13861 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13863 if (w
->window_end_vpos
< this_line_vpos
)
13864 w
->window_end_vpos
= this_line_vpos
;
13866 else if (w
->window_end_vpos
== this_line_vpos
13867 && this_line_vpos
> 0)
13868 w
->window_end_vpos
= this_line_vpos
- 1;
13869 w
->window_end_valid
= false;
13871 /* Update hint: No need to try to scroll in update_window. */
13872 w
->desired_matrix
->no_scrolling_p
= true;
13875 *w
->desired_matrix
->method
= 0;
13876 debug_method_add (w
, "optimization 1");
13878 #ifdef HAVE_WINDOW_SYSTEM
13879 update_window_fringes (w
, false);
13886 else if (/* Cursor position hasn't changed. */
13887 PT
== w
->last_point
13888 /* Make sure the cursor was last displayed
13889 in this window. Otherwise we have to reposition it. */
13891 /* PXW: Must be converted to pixels, probably. */
13892 && 0 <= w
->cursor
.vpos
13893 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13897 do_pending_window_change (true);
13898 /* If selected_window changed, redisplay again. */
13899 if (WINDOWP (selected_window
)
13900 && (w
= XWINDOW (selected_window
)) != sw
)
13903 /* We used to always goto end_of_redisplay here, but this
13904 isn't enough if we have a blinking cursor. */
13905 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13906 goto end_of_redisplay
;
13910 /* If highlighting the region, or if the cursor is in the echo area,
13911 then we can't just move the cursor. */
13912 else if (NILP (Vshow_trailing_whitespace
)
13913 && !cursor_in_echo_area
)
13916 struct glyph_row
*row
;
13918 /* Skip from tlbufpos to PT and see where it is. Note that
13919 PT may be in invisible text. If so, we will end at the
13920 next visible position. */
13921 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13922 NULL
, DEFAULT_FACE_ID
);
13923 it
.current_x
= this_line_start_x
;
13924 it
.current_y
= this_line_y
;
13925 it
.vpos
= this_line_vpos
;
13927 /* The call to move_it_to stops in front of PT, but
13928 moves over before-strings. */
13929 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13931 if (it
.vpos
== this_line_vpos
13932 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13935 eassert (this_line_vpos
== it
.vpos
);
13936 eassert (this_line_y
== it
.current_y
);
13937 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13938 if (cursor_row_fully_visible_p (w
, false, true))
13941 *w
->desired_matrix
->method
= 0;
13942 debug_method_add (w
, "optimization 3");
13954 /* Text changed drastically or point moved off of line. */
13955 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13958 CHARPOS (this_line_start_pos
) = 0;
13959 ++clear_face_cache_count
;
13960 #ifdef HAVE_WINDOW_SYSTEM
13961 ++clear_image_cache_count
;
13964 /* Build desired matrices, and update the display. If
13965 consider_all_windows_p, do it for all windows on all frames that
13966 require redisplay, as specified by their 'redisplay' flag.
13967 Otherwise do it for selected_window, only. */
13969 if (consider_all_windows_p
)
13971 FOR_EACH_FRAME (tail
, frame
)
13972 XFRAME (frame
)->updated_p
= false;
13974 propagate_buffer_redisplay ();
13976 FOR_EACH_FRAME (tail
, frame
)
13978 struct frame
*f
= XFRAME (frame
);
13980 /* We don't have to do anything for unselected terminal
13982 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13983 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13987 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13990 /* Only GC scrollbars when we redisplay the whole frame. */
13991 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13992 bool f_redisplay_flag
= f
->redisplay
;
13993 /* Mark all the scroll bars to be removed; we'll redeem
13994 the ones we want when we redisplay their windows. */
13995 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13996 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13998 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13999 redisplay_windows (FRAME_ROOT_WINDOW (f
));
14000 /* Remember that the invisible frames need to be redisplayed next
14001 time they're visible. */
14002 else if (!REDISPLAY_SOME_P ())
14003 f
->redisplay
= true;
14005 /* The X error handler may have deleted that frame. */
14006 if (!FRAME_LIVE_P (f
))
14009 /* Any scroll bars which redisplay_windows should have
14010 nuked should now go away. */
14011 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
14012 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
14014 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
14016 /* If fonts changed on visible frame, display again. */
14017 if (f
->fonts_changed
)
14019 adjust_frame_glyphs (f
);
14020 /* Disable all redisplay optimizations for this
14021 frame. For the reasons, see the comment near
14022 the previous call to adjust_frame_glyphs above. */
14023 SET_FRAME_GARBAGED (f
);
14024 f
->fonts_changed
= false;
14028 /* See if we have to hscroll. */
14029 if (!f
->already_hscrolled_p
)
14031 f
->already_hscrolled_p
= true;
14032 if (hscroll_windows (f
->root_window
))
14036 /* If the frame's redisplay flag was not set before
14037 we went about redisplaying its windows, but it is
14038 set now, that means we employed some redisplay
14039 optimizations inside redisplay_windows, and
14040 bypassed producing some screen lines. But if
14041 f->redisplay is now set, it might mean the old
14042 faces are no longer valid (e.g., if redisplaying
14043 some window called some Lisp which defined a new
14044 face or redefined an existing face), so trying to
14045 use them in update_frame will segfault.
14046 Therefore, we must redisplay this frame. */
14047 if (!f_redisplay_flag
&& f
->redisplay
)
14050 /* Prevent various kinds of signals during display
14051 update. stdio is not robust about handling
14052 signals, which can cause an apparent I/O error. */
14053 if (interrupt_input
)
14054 unrequest_sigio ();
14057 pending
|= update_frame (f
, false, false);
14058 f
->cursor_type_changed
= false;
14059 f
->updated_p
= true;
14064 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
14068 /* Do the mark_window_display_accurate after all windows have
14069 been redisplayed because this call resets flags in buffers
14070 which are needed for proper redisplay. */
14071 FOR_EACH_FRAME (tail
, frame
)
14073 struct frame
*f
= XFRAME (frame
);
14076 f
->redisplay
= false;
14077 mark_window_display_accurate (f
->root_window
, true);
14078 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
14079 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
14084 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
14086 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
14087 /* Use list_of_error, not Qerror, so that
14088 we catch only errors and don't run the debugger. */
14089 internal_condition_case_1 (redisplay_window_1
, selected_window
,
14091 redisplay_window_error
);
14092 if (update_miniwindow_p
)
14093 internal_condition_case_1 (redisplay_window_1
,
14094 FRAME_MINIBUF_WINDOW (sf
), list_of_error
,
14095 redisplay_window_error
);
14097 /* Compare desired and current matrices, perform output. */
14100 /* If fonts changed, display again. Likewise if redisplay_window_1
14101 above caused some change (e.g., a change in faces) that requires
14102 considering the entire frame again. */
14103 if (sf
->fonts_changed
|| sf
->redisplay
)
14107 /* Set this to force a more thorough redisplay.
14108 Otherwise, we might immediately loop back to the
14109 above "else-if" clause (since all the conditions that
14110 led here might still be true), and we will then
14111 infloop, because the selected-frame's redisplay flag
14112 is not (and cannot be) reset. */
14113 windows_or_buffers_changed
= 50;
14118 /* Prevent freeing of realized faces, since desired matrices are
14119 pending that reference the faces we computed and cached. */
14120 inhibit_free_realized_faces
= true;
14122 /* Prevent various kinds of signals during display update.
14123 stdio is not robust about handling signals,
14124 which can cause an apparent I/O error. */
14125 if (interrupt_input
)
14126 unrequest_sigio ();
14129 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
14131 if (hscroll_windows (selected_window
))
14134 XWINDOW (selected_window
)->must_be_updated_p
= true;
14135 pending
= update_frame (sf
, false, false);
14136 sf
->cursor_type_changed
= false;
14139 /* We may have called echo_area_display at the top of this
14140 function. If the echo area is on another frame, that may
14141 have put text on a frame other than the selected one, so the
14142 above call to update_frame would not have caught it. Catch
14144 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
14145 struct frame
*mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
14147 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
14149 XWINDOW (mini_window
)->must_be_updated_p
= true;
14150 pending
|= update_frame (mini_frame
, false, false);
14151 mini_frame
->cursor_type_changed
= false;
14152 if (!pending
&& hscroll_windows (mini_window
))
14157 /* If display was paused because of pending input, make sure we do a
14158 thorough update the next time. */
14161 /* Prevent the optimization at the beginning of
14162 redisplay_internal that tries a single-line update of the
14163 line containing the cursor in the selected window. */
14164 CHARPOS (this_line_start_pos
) = 0;
14166 /* Let the overlay arrow be updated the next time. */
14167 update_overlay_arrows (0);
14169 /* If we pause after scrolling, some rows in the current
14170 matrices of some windows are not valid. */
14171 if (!WINDOW_FULL_WIDTH_P (w
)
14172 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
14173 update_mode_lines
= 36;
14177 if (!consider_all_windows_p
)
14179 /* This has already been done above if
14180 consider_all_windows_p is set. */
14181 if (XBUFFER (w
->contents
)->text
->redisplay
14182 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
14183 /* This can happen if b->text->redisplay was set during
14185 propagate_buffer_redisplay ();
14186 mark_window_display_accurate_1 (w
, true);
14188 /* Say overlay arrows are up to date. */
14189 update_overlay_arrows (1);
14191 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
14192 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
14195 update_mode_lines
= 0;
14196 windows_or_buffers_changed
= 0;
14199 /* Start SIGIO interrupts coming again. Having them off during the
14200 code above makes it less likely one will discard output, but not
14201 impossible, since there might be stuff in the system buffer here.
14202 But it is much hairier to try to do anything about that. */
14203 if (interrupt_input
)
14207 /* If a frame has become visible which was not before, redisplay
14208 again, so that we display it. Expose events for such a frame
14209 (which it gets when becoming visible) don't call the parts of
14210 redisplay constructing glyphs, so simply exposing a frame won't
14211 display anything in this case. So, we have to display these
14212 frames here explicitly. */
14217 FOR_EACH_FRAME (tail
, frame
)
14219 if (XFRAME (frame
)->visible
)
14223 if (new_count
!= number_of_visible_frames
)
14224 windows_or_buffers_changed
= 52;
14227 /* Change frame size now if a change is pending. */
14228 do_pending_window_change (true);
14230 /* If we just did a pending size change, or have additional
14231 visible frames, or selected_window changed, redisplay again. */
14232 if ((windows_or_buffers_changed
&& !pending
)
14233 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14236 /* Clear the face and image caches.
14238 We used to do this only if consider_all_windows_p. But the cache
14239 needs to be cleared if a timer creates images in the current
14240 buffer (e.g. the test case in Bug#6230). */
14242 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14244 clear_face_cache (false);
14245 clear_face_cache_count
= 0;
14248 #ifdef HAVE_WINDOW_SYSTEM
14249 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14251 clear_image_caches (Qnil
);
14252 clear_image_cache_count
= 0;
14254 #endif /* HAVE_WINDOW_SYSTEM */
14258 ns_set_doc_edited ();
14260 if (interrupt_input
&& interrupts_deferred
)
14263 unbind_to (count
, Qnil
);
14268 /* Redisplay, but leave alone any recent echo area message unless
14269 another message has been requested in its place.
14271 This is useful in situations where you need to redisplay but no
14272 user action has occurred, making it inappropriate for the message
14273 area to be cleared. See tracking_off and
14274 wait_reading_process_output for examples of these situations.
14276 FROM_WHERE is an integer saying from where this function was
14277 called. This is useful for debugging. */
14280 redisplay_preserve_echo_area (int from_where
)
14282 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14284 if (!NILP (echo_area_buffer
[1]))
14286 /* We have a previously displayed message, but no current
14287 message. Redisplay the previous message. */
14288 display_last_displayed_message_p
= true;
14289 redisplay_internal ();
14290 display_last_displayed_message_p
= false;
14293 redisplay_internal ();
14295 flush_frame (SELECTED_FRAME ());
14299 /* Function registered with record_unwind_protect in redisplay_internal. */
14302 unwind_redisplay (void)
14304 redisplaying_p
= false;
14308 /* Mark the display of leaf window W as accurate or inaccurate.
14309 If ACCURATE_P, mark display of W as accurate.
14310 If !ACCURATE_P, arrange for W to be redisplayed the next
14311 time redisplay_internal is called. */
14314 mark_window_display_accurate_1 (struct window
*w
, bool accurate_p
)
14316 struct buffer
*b
= XBUFFER (w
->contents
);
14318 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14319 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14320 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14324 b
->clip_changed
= false;
14325 b
->prevent_redisplay_optimizations_p
= false;
14326 eassert (buffer_window_count (b
) > 0);
14327 /* Resetting b->text->redisplay is problematic!
14328 In order to make it safer to do it here, redisplay_internal must
14329 have copied all b->text->redisplay to their respective windows. */
14330 b
->text
->redisplay
= false;
14332 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14333 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14334 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14335 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14337 w
->current_matrix
->buffer
= b
;
14338 w
->current_matrix
->begv
= BUF_BEGV (b
);
14339 w
->current_matrix
->zv
= BUF_ZV (b
);
14341 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14342 w
->last_cursor_off_p
= w
->cursor_off_p
;
14344 if (w
== XWINDOW (selected_window
))
14345 w
->last_point
= BUF_PT (b
);
14347 w
->last_point
= marker_position (w
->pointm
);
14349 w
->window_end_valid
= true;
14350 w
->update_mode_line
= false;
14353 w
->redisplay
= !accurate_p
;
14357 /* Mark the display of windows in the window tree rooted at WINDOW as
14358 accurate or inaccurate. If ACCURATE_P, mark display of
14359 windows as accurate. If !ACCURATE_P, arrange for windows to
14360 be redisplayed the next time redisplay_internal is called. */
14363 mark_window_display_accurate (Lisp_Object window
, bool accurate_p
)
14367 for (; !NILP (window
); window
= w
->next
)
14369 w
= XWINDOW (window
);
14370 if (WINDOWP (w
->contents
))
14371 mark_window_display_accurate (w
->contents
, accurate_p
);
14373 mark_window_display_accurate_1 (w
, accurate_p
);
14377 update_overlay_arrows (1);
14379 /* Force a thorough redisplay the next time by setting
14380 last_arrow_position and last_arrow_string to t, which is
14381 unequal to any useful value of Voverlay_arrow_... */
14382 update_overlay_arrows (-1);
14386 /* Return value in display table DP (Lisp_Char_Table *) for character
14387 C. Since a display table doesn't have any parent, we don't have to
14388 follow parent. Do not call this function directly but use the
14389 macro DISP_CHAR_VECTOR. */
14392 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14396 if (ASCII_CHAR_P (c
))
14399 if (SUB_CHAR_TABLE_P (val
))
14400 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14406 XSETCHAR_TABLE (table
, dp
);
14407 val
= char_table_ref (table
, c
);
14416 /***********************************************************************
14418 ***********************************************************************/
14420 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14423 redisplay_windows (Lisp_Object window
)
14425 while (!NILP (window
))
14427 struct window
*w
= XWINDOW (window
);
14429 if (WINDOWP (w
->contents
))
14430 redisplay_windows (w
->contents
);
14431 else if (BUFFERP (w
->contents
))
14433 displayed_buffer
= XBUFFER (w
->contents
);
14434 /* Use list_of_error, not Qerror, so that
14435 we catch only errors and don't run the debugger. */
14436 internal_condition_case_1 (redisplay_window_0
, window
,
14438 redisplay_window_error
);
14446 redisplay_window_error (Lisp_Object ignore
)
14448 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14453 redisplay_window_0 (Lisp_Object window
)
14455 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14456 redisplay_window (window
, false);
14461 redisplay_window_1 (Lisp_Object window
)
14463 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14464 redisplay_window (window
, true);
14469 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14470 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14471 which positions recorded in ROW differ from current buffer
14474 Return true iff cursor is on this row. */
14477 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14478 struct glyph_matrix
*matrix
,
14479 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14482 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14483 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14484 struct glyph
*cursor
= NULL
;
14485 /* The last known character position in row. */
14486 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14488 ptrdiff_t pt_old
= PT
- delta
;
14489 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14490 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14491 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14492 /* A glyph beyond the edge of TEXT_AREA which we should never
14494 struct glyph
*glyphs_end
= end
;
14495 /* True means we've found a match for cursor position, but that
14496 glyph has the avoid_cursor_p flag set. */
14497 bool match_with_avoid_cursor
= false;
14498 /* True means we've seen at least one glyph that came from a
14500 bool string_seen
= false;
14501 /* Largest and smallest buffer positions seen so far during scan of
14503 ptrdiff_t bpos_max
= pos_before
;
14504 ptrdiff_t bpos_min
= pos_after
;
14505 /* Last buffer position covered by an overlay string with an integer
14506 `cursor' property. */
14507 ptrdiff_t bpos_covered
= 0;
14508 /* True means the display string on which to display the cursor
14509 comes from a text property, not from an overlay. */
14510 bool string_from_text_prop
= false;
14512 /* Don't even try doing anything if called for a mode-line or
14513 header-line row, since the rest of the code isn't prepared to
14514 deal with such calamities. */
14515 eassert (!row
->mode_line_p
);
14516 if (row
->mode_line_p
)
14519 /* Skip over glyphs not having an object at the start and the end of
14520 the row. These are special glyphs like truncation marks on
14521 terminal frames. */
14522 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14524 if (!row
->reversed_p
)
14527 && NILP (glyph
->object
)
14528 && glyph
->charpos
< 0)
14530 x
+= glyph
->pixel_width
;
14534 && NILP ((end
- 1)->object
)
14535 /* CHARPOS is zero for blanks and stretch glyphs
14536 inserted by extend_face_to_end_of_line. */
14537 && (end
- 1)->charpos
<= 0)
14539 glyph_before
= glyph
- 1;
14546 /* If the glyph row is reversed, we need to process it from back
14547 to front, so swap the edge pointers. */
14548 glyphs_end
= end
= glyph
- 1;
14549 glyph
+= row
->used
[TEXT_AREA
] - 1;
14551 while (glyph
> end
+ 1
14552 && NILP (glyph
->object
)
14553 && glyph
->charpos
< 0)
14556 x
-= glyph
->pixel_width
;
14558 if (NILP (glyph
->object
) && glyph
->charpos
< 0)
14560 /* By default, in reversed rows we put the cursor on the
14561 rightmost (first in the reading order) glyph. */
14562 for (g
= end
+ 1; g
< glyph
; g
++)
14563 x
+= g
->pixel_width
;
14565 && NILP ((end
+ 1)->object
)
14566 && (end
+ 1)->charpos
<= 0)
14568 glyph_before
= glyph
+ 1;
14572 else if (row
->reversed_p
)
14574 /* In R2L rows that don't display text, put the cursor on the
14575 rightmost glyph. Case in point: an empty last line that is
14576 part of an R2L paragraph. */
14578 /* Avoid placing the cursor on the last glyph of the row, where
14579 on terminal frames we hold the vertical border between
14580 adjacent windows. */
14581 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14582 && !WINDOW_RIGHTMOST_P (w
)
14583 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14585 x
= -1; /* will be computed below, at label compute_x */
14588 /* Step 1: Try to find the glyph whose character position
14589 corresponds to point. If that's not possible, find 2 glyphs
14590 whose character positions are the closest to point, one before
14591 point, the other after it. */
14592 if (!row
->reversed_p
)
14593 while (/* not marched to end of glyph row */
14595 /* glyph was not inserted by redisplay for internal purposes */
14596 && !NILP (glyph
->object
))
14598 if (BUFFERP (glyph
->object
))
14600 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14602 if (glyph
->charpos
> bpos_max
)
14603 bpos_max
= glyph
->charpos
;
14604 if (glyph
->charpos
< bpos_min
)
14605 bpos_min
= glyph
->charpos
;
14606 if (!glyph
->avoid_cursor_p
)
14608 /* If we hit point, we've found the glyph on which to
14609 display the cursor. */
14612 match_with_avoid_cursor
= false;
14615 /* See if we've found a better approximation to
14616 POS_BEFORE or to POS_AFTER. */
14617 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14619 pos_before
= glyph
->charpos
;
14620 glyph_before
= glyph
;
14622 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14624 pos_after
= glyph
->charpos
;
14625 glyph_after
= glyph
;
14628 else if (dpos
== 0)
14629 match_with_avoid_cursor
= true;
14631 else if (STRINGP (glyph
->object
))
14633 Lisp_Object chprop
;
14634 ptrdiff_t glyph_pos
= glyph
->charpos
;
14636 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14638 if (!NILP (chprop
))
14640 /* If the string came from a `display' text property,
14641 look up the buffer position of that property and
14642 use that position to update bpos_max, as if we
14643 actually saw such a position in one of the row's
14644 glyphs. This helps with supporting integer values
14645 of `cursor' property on the display string in
14646 situations where most or all of the row's buffer
14647 text is completely covered by display properties,
14648 so that no glyph with valid buffer positions is
14649 ever seen in the row. */
14650 ptrdiff_t prop_pos
=
14651 string_buffer_position_lim (glyph
->object
, pos_before
,
14654 if (prop_pos
>= pos_before
)
14655 bpos_max
= prop_pos
;
14657 if (INTEGERP (chprop
))
14659 bpos_covered
= bpos_max
+ XINT (chprop
);
14660 /* If the `cursor' property covers buffer positions up
14661 to and including point, we should display cursor on
14662 this glyph. Note that, if a `cursor' property on one
14663 of the string's characters has an integer value, we
14664 will break out of the loop below _before_ we get to
14665 the position match above. IOW, integer values of
14666 the `cursor' property override the "exact match for
14667 point" strategy of positioning the cursor. */
14668 /* Implementation note: bpos_max == pt_old when, e.g.,
14669 we are in an empty line, where bpos_max is set to
14670 MATRIX_ROW_START_CHARPOS, see above. */
14671 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14678 string_seen
= true;
14680 x
+= glyph
->pixel_width
;
14683 else if (glyph
> end
) /* row is reversed */
14684 while (!NILP (glyph
->object
))
14686 if (BUFFERP (glyph
->object
))
14688 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14690 if (glyph
->charpos
> bpos_max
)
14691 bpos_max
= glyph
->charpos
;
14692 if (glyph
->charpos
< bpos_min
)
14693 bpos_min
= glyph
->charpos
;
14694 if (!glyph
->avoid_cursor_p
)
14698 match_with_avoid_cursor
= false;
14701 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14703 pos_before
= glyph
->charpos
;
14704 glyph_before
= glyph
;
14706 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14708 pos_after
= glyph
->charpos
;
14709 glyph_after
= glyph
;
14712 else if (dpos
== 0)
14713 match_with_avoid_cursor
= true;
14715 else if (STRINGP (glyph
->object
))
14717 Lisp_Object chprop
;
14718 ptrdiff_t glyph_pos
= glyph
->charpos
;
14720 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14722 if (!NILP (chprop
))
14724 ptrdiff_t prop_pos
=
14725 string_buffer_position_lim (glyph
->object
, pos_before
,
14728 if (prop_pos
>= pos_before
)
14729 bpos_max
= prop_pos
;
14731 if (INTEGERP (chprop
))
14733 bpos_covered
= bpos_max
+ XINT (chprop
);
14734 /* If the `cursor' property covers buffer positions up
14735 to and including point, we should display cursor on
14737 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14743 string_seen
= true;
14746 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14748 x
--; /* can't use any pixel_width */
14751 x
-= glyph
->pixel_width
;
14754 /* Step 2: If we didn't find an exact match for point, we need to
14755 look for a proper place to put the cursor among glyphs between
14756 GLYPH_BEFORE and GLYPH_AFTER. */
14757 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14758 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14759 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14761 /* An empty line has a single glyph whose OBJECT is nil and
14762 whose CHARPOS is the position of a newline on that line.
14763 Note that on a TTY, there are more glyphs after that, which
14764 were produced by extend_face_to_end_of_line, but their
14765 CHARPOS is zero or negative. */
14766 bool empty_line_p
=
14767 ((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14768 && NILP (glyph
->object
) && glyph
->charpos
> 0
14769 /* On a TTY, continued and truncated rows also have a glyph at
14770 their end whose OBJECT is nil and whose CHARPOS is
14771 positive (the continuation and truncation glyphs), but such
14772 rows are obviously not "empty". */
14773 && !(row
->continued_p
|| row
->truncated_on_right_p
));
14775 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14777 ptrdiff_t ellipsis_pos
;
14779 /* Scan back over the ellipsis glyphs. */
14780 if (!row
->reversed_p
)
14782 ellipsis_pos
= (glyph
- 1)->charpos
;
14783 while (glyph
> row
->glyphs
[TEXT_AREA
]
14784 && (glyph
- 1)->charpos
== ellipsis_pos
)
14785 glyph
--, x
-= glyph
->pixel_width
;
14786 /* That loop always goes one position too far, including
14787 the glyph before the ellipsis. So scan forward over
14789 x
+= glyph
->pixel_width
;
14792 else /* row is reversed */
14794 ellipsis_pos
= (glyph
+ 1)->charpos
;
14795 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14796 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14797 glyph
++, x
+= glyph
->pixel_width
;
14798 x
-= glyph
->pixel_width
;
14802 else if (match_with_avoid_cursor
)
14804 cursor
= glyph_after
;
14807 else if (string_seen
)
14809 int incr
= row
->reversed_p
? -1 : +1;
14811 /* Need to find the glyph that came out of a string which is
14812 present at point. That glyph is somewhere between
14813 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14814 positioned between POS_BEFORE and POS_AFTER in the
14816 struct glyph
*start
, *stop
;
14817 ptrdiff_t pos
= pos_before
;
14821 /* If the row ends in a newline from a display string,
14822 reordering could have moved the glyphs belonging to the
14823 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14824 in this case we extend the search to the last glyph in
14825 the row that was not inserted by redisplay. */
14826 if (row
->ends_in_newline_from_string_p
)
14829 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14832 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14833 correspond to POS_BEFORE and POS_AFTER, respectively. We
14834 need START and STOP in the order that corresponds to the
14835 row's direction as given by its reversed_p flag. If the
14836 directionality of characters between POS_BEFORE and
14837 POS_AFTER is the opposite of the row's base direction,
14838 these characters will have been reordered for display,
14839 and we need to reverse START and STOP. */
14840 if (!row
->reversed_p
)
14842 start
= min (glyph_before
, glyph_after
);
14843 stop
= max (glyph_before
, glyph_after
);
14847 start
= max (glyph_before
, glyph_after
);
14848 stop
= min (glyph_before
, glyph_after
);
14850 for (glyph
= start
+ incr
;
14851 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14854 /* Any glyphs that come from the buffer are here because
14855 of bidi reordering. Skip them, and only pay
14856 attention to glyphs that came from some string. */
14857 if (STRINGP (glyph
->object
))
14861 /* If the display property covers the newline, we
14862 need to search for it one position farther. */
14863 ptrdiff_t lim
= pos_after
14864 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14866 string_from_text_prop
= false;
14867 str
= glyph
->object
;
14868 tem
= string_buffer_position_lim (str
, pos
, lim
, false);
14869 if (tem
== 0 /* from overlay */
14872 /* If the string from which this glyph came is
14873 found in the buffer at point, or at position
14874 that is closer to point than pos_after, then
14875 we've found the glyph we've been looking for.
14876 If it comes from an overlay (tem == 0), and
14877 it has the `cursor' property on one of its
14878 glyphs, record that glyph as a candidate for
14879 displaying the cursor. (As in the
14880 unidirectional version, we will display the
14881 cursor on the last candidate we find.) */
14884 || (tem
- pt_old
> 0 && tem
< pos_after
))
14886 /* The glyphs from this string could have
14887 been reordered. Find the one with the
14888 smallest string position. Or there could
14889 be a character in the string with the
14890 `cursor' property, which means display
14891 cursor on that character's glyph. */
14892 ptrdiff_t strpos
= glyph
->charpos
;
14897 string_from_text_prop
= true;
14900 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14901 && EQ (glyph
->object
, str
);
14905 ptrdiff_t gpos
= glyph
->charpos
;
14907 cprop
= Fget_char_property (make_number (gpos
),
14915 if (tem
&& glyph
->charpos
< strpos
)
14917 strpos
= glyph
->charpos
;
14923 || (tem
- pt_old
> 0 && tem
< pos_after
))
14927 pos
= tem
+ 1; /* don't find previous instances */
14929 /* This string is not what we want; skip all of the
14930 glyphs that came from it. */
14931 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14932 && EQ (glyph
->object
, str
))
14939 /* If we reached the end of the line, and END was from a string,
14940 the cursor is not on this line. */
14942 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14943 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14944 && STRINGP (end
->object
)
14945 && row
->continued_p
)
14948 /* A truncated row may not include PT among its character positions.
14949 Setting the cursor inside the scroll margin will trigger
14950 recalculation of hscroll in hscroll_window_tree. But if a
14951 display string covers point, defer to the string-handling
14952 code below to figure this out. */
14953 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14955 cursor
= glyph_before
;
14958 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14959 /* Zero-width characters produce no glyphs. */
14961 && (row
->reversed_p
14962 ? glyph_after
> glyphs_end
14963 : glyph_after
< glyphs_end
)))
14965 cursor
= glyph_after
;
14971 if (cursor
!= NULL
)
14973 else if (glyph
== glyphs_end
14974 && pos_before
== pos_after
14975 && STRINGP ((row
->reversed_p
14976 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14977 : row
->glyphs
[TEXT_AREA
])->object
))
14979 /* If all the glyphs of this row came from strings, put the
14980 cursor on the first glyph of the row. This avoids having the
14981 cursor outside of the text area in this very rare and hard
14985 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14986 : row
->glyphs
[TEXT_AREA
];
14992 /* Need to compute x that corresponds to GLYPH. */
14993 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14995 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14997 x
+= g
->pixel_width
;
15001 /* ROW could be part of a continued line, which, under bidi
15002 reordering, might have other rows whose start and end charpos
15003 occlude point. Only set w->cursor if we found a better
15004 approximation to the cursor position than we have from previously
15005 examined candidate rows belonging to the same continued line. */
15006 if (/* We already have a candidate row. */
15007 w
->cursor
.vpos
>= 0
15008 /* That candidate is not the row we are processing. */
15009 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
15010 /* Make sure cursor.vpos specifies a row whose start and end
15011 charpos occlude point, and it is valid candidate for being a
15012 cursor-row. This is because some callers of this function
15013 leave cursor.vpos at the row where the cursor was displayed
15014 during the last redisplay cycle. */
15015 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
15016 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
15017 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
15020 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
15022 /* Don't consider glyphs that are outside TEXT_AREA. */
15023 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
15025 /* Keep the candidate whose buffer position is the closest to
15026 point or has the `cursor' property. */
15027 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
15028 w
->cursor
.hpos
>= 0
15029 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
15030 && ((BUFFERP (g1
->object
)
15031 && (g1
->charpos
== pt_old
/* An exact match always wins. */
15032 || (BUFFERP (glyph
->object
)
15033 && eabs (g1
->charpos
- pt_old
)
15034 < eabs (glyph
->charpos
- pt_old
))))
15035 /* Previous candidate is a glyph from a string that has
15036 a non-nil `cursor' property. */
15037 || (STRINGP (g1
->object
)
15038 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
15039 Qcursor
, g1
->object
))
15040 /* Previous candidate is from the same display
15041 string as this one, and the display string
15042 came from a text property. */
15043 || (EQ (g1
->object
, glyph
->object
)
15044 && string_from_text_prop
)
15045 /* this candidate is from newline and its
15046 position is not an exact match */
15047 || (NILP (glyph
->object
)
15048 && glyph
->charpos
!= pt_old
)))))
15050 /* If this candidate gives an exact match, use that. */
15051 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
15052 /* If this candidate is a glyph created for the
15053 terminating newline of a line, and point is on that
15054 newline, it wins because it's an exact match. */
15055 || (!row
->continued_p
15056 && NILP (glyph
->object
)
15057 && glyph
->charpos
== 0
15058 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
15059 /* Otherwise, keep the candidate that comes from a row
15060 spanning less buffer positions. This may win when one or
15061 both candidate positions are on glyphs that came from
15062 display strings, for which we cannot compare buffer
15064 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
15065 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
15066 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
15069 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
15071 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
15072 w
->cursor
.y
= row
->y
+ dy
;
15074 if (w
== XWINDOW (selected_window
))
15076 if (!row
->continued_p
15077 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15080 this_line_buffer
= XBUFFER (w
->contents
);
15082 CHARPOS (this_line_start_pos
)
15083 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
15084 BYTEPOS (this_line_start_pos
)
15085 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
15087 CHARPOS (this_line_end_pos
)
15088 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
15089 BYTEPOS (this_line_end_pos
)
15090 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
15092 this_line_y
= w
->cursor
.y
;
15093 this_line_pixel_height
= row
->height
;
15094 this_line_vpos
= w
->cursor
.vpos
;
15095 this_line_start_x
= row
->x
;
15098 CHARPOS (this_line_start_pos
) = 0;
15105 /* Run window scroll functions, if any, for WINDOW with new window
15106 start STARTP. Sets the window start of WINDOW to that position.
15108 We assume that the window's buffer is really current. */
15110 static struct text_pos
15111 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
15113 struct window
*w
= XWINDOW (window
);
15114 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
15116 eassert (current_buffer
== XBUFFER (w
->contents
));
15118 if (!NILP (Vwindow_scroll_functions
))
15120 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
15121 make_number (CHARPOS (startp
)));
15122 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15123 /* In case the hook functions switch buffers. */
15124 set_buffer_internal (XBUFFER (w
->contents
));
15131 /* Make sure the line containing the cursor is fully visible.
15132 A value of true means there is nothing to be done.
15133 (Either the line is fully visible, or it cannot be made so,
15134 or we cannot tell.)
15136 If FORCE_P, return false even if partial visible cursor row
15137 is higher than window.
15139 If CURRENT_MATRIX_P, use the information from the
15140 window's current glyph matrix; otherwise use the desired glyph
15143 A value of false means the caller should do scrolling
15144 as if point had gone off the screen. */
15147 cursor_row_fully_visible_p (struct window
*w
, bool force_p
,
15148 bool current_matrix_p
)
15150 struct glyph_matrix
*matrix
;
15151 struct glyph_row
*row
;
15154 if (!make_cursor_line_fully_visible_p
)
15157 /* It's not always possible to find the cursor, e.g, when a window
15158 is full of overlay strings. Don't do anything in that case. */
15159 if (w
->cursor
.vpos
< 0)
15162 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
15163 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
15165 /* If the cursor row is not partially visible, there's nothing to do. */
15166 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
15169 /* If the row the cursor is in is taller than the window's height,
15170 it's not clear what to do, so do nothing. */
15171 window_height
= window_box_height (w
);
15172 if (row
->height
>= window_height
)
15174 if (!force_p
|| MINI_WINDOW_P (w
)
15175 || w
->vscroll
|| w
->cursor
.vpos
== 0)
15182 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
15183 means only WINDOW is redisplayed in redisplay_internal.
15184 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
15185 in redisplay_window to bring a partially visible line into view in
15186 the case that only the cursor has moved.
15188 LAST_LINE_MISFIT should be true if we're scrolling because the
15189 last screen line's vertical height extends past the end of the screen.
15193 1 if scrolling succeeded
15195 0 if scrolling didn't find point.
15197 -1 if new fonts have been loaded so that we must interrupt
15198 redisplay, adjust glyph matrices, and try again. */
15204 SCROLLING_NEED_LARGER_MATRICES
15207 /* If scroll-conservatively is more than this, never recenter.
15209 If you change this, don't forget to update the doc string of
15210 `scroll-conservatively' and the Emacs manual. */
15211 #define SCROLL_LIMIT 100
15214 try_scrolling (Lisp_Object window
, bool just_this_one_p
,
15215 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
15216 bool temp_scroll_step
, bool last_line_misfit
)
15218 struct window
*w
= XWINDOW (window
);
15219 struct frame
*f
= XFRAME (w
->frame
);
15220 struct text_pos pos
, startp
;
15222 int this_scroll_margin
, scroll_max
, rc
, height
;
15223 int dy
= 0, amount_to_scroll
= 0;
15224 bool scroll_down_p
= false;
15225 int extra_scroll_margin_lines
= last_line_misfit
;
15226 Lisp_Object aggressive
;
15227 /* We will never try scrolling more than this number of lines. */
15228 int scroll_limit
= SCROLL_LIMIT
;
15229 int frame_line_height
= default_line_pixel_height (w
);
15230 int window_total_lines
15231 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15234 debug_method_add (w
, "try_scrolling");
15237 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15239 /* Compute scroll margin height in pixels. We scroll when point is
15240 within this distance from the top or bottom of the window. */
15241 if (scroll_margin
> 0)
15242 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15243 * frame_line_height
;
15245 this_scroll_margin
= 0;
15247 /* Force arg_scroll_conservatively to have a reasonable value, to
15248 avoid scrolling too far away with slow move_it_* functions. Note
15249 that the user can supply scroll-conservatively equal to
15250 `most-positive-fixnum', which can be larger than INT_MAX. */
15251 if (arg_scroll_conservatively
> scroll_limit
)
15253 arg_scroll_conservatively
= scroll_limit
+ 1;
15254 scroll_max
= scroll_limit
* frame_line_height
;
15256 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15257 /* Compute how much we should try to scroll maximally to bring
15258 point into view. */
15259 scroll_max
= (max (scroll_step
,
15260 max (arg_scroll_conservatively
, temp_scroll_step
))
15261 * frame_line_height
);
15262 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15263 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15264 /* We're trying to scroll because of aggressive scrolling but no
15265 scroll_step is set. Choose an arbitrary one. */
15266 scroll_max
= 10 * frame_line_height
;
15272 /* Decide whether to scroll down. */
15273 if (PT
> CHARPOS (startp
))
15275 int scroll_margin_y
;
15277 /* Compute the pixel ypos of the scroll margin, then move IT to
15278 either that ypos or PT, whichever comes first. */
15279 start_display (&it
, w
, startp
);
15280 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15281 - frame_line_height
* extra_scroll_margin_lines
;
15282 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15283 (MOVE_TO_POS
| MOVE_TO_Y
));
15285 if (PT
> CHARPOS (it
.current
.pos
))
15287 int y0
= line_bottom_y (&it
);
15288 /* Compute how many pixels below window bottom to stop searching
15289 for PT. This avoids costly search for PT that is far away if
15290 the user limited scrolling by a small number of lines, but
15291 always finds PT if scroll_conservatively is set to a large
15292 number, such as most-positive-fixnum. */
15293 int slack
= max (scroll_max
, 10 * frame_line_height
);
15294 int y_to_move
= it
.last_visible_y
+ slack
;
15296 /* Compute the distance from the scroll margin to PT or to
15297 the scroll limit, whichever comes first. This should
15298 include the height of the cursor line, to make that line
15300 move_it_to (&it
, PT
, -1, y_to_move
,
15301 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15302 dy
= line_bottom_y (&it
) - y0
;
15304 if (dy
> scroll_max
)
15305 return SCROLLING_FAILED
;
15308 scroll_down_p
= true;
15314 /* Point is in or below the bottom scroll margin, so move the
15315 window start down. If scrolling conservatively, move it just
15316 enough down to make point visible. If scroll_step is set,
15317 move it down by scroll_step. */
15318 if (arg_scroll_conservatively
)
15320 = min (max (dy
, frame_line_height
),
15321 frame_line_height
* arg_scroll_conservatively
);
15322 else if (scroll_step
|| temp_scroll_step
)
15323 amount_to_scroll
= scroll_max
;
15326 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15327 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15328 if (NUMBERP (aggressive
))
15330 double float_amount
= XFLOATINT (aggressive
) * height
;
15331 int aggressive_scroll
= float_amount
;
15332 if (aggressive_scroll
== 0 && float_amount
> 0)
15333 aggressive_scroll
= 1;
15334 /* Don't let point enter the scroll margin near top of
15335 the window. This could happen if the value of
15336 scroll_up_aggressively is too large and there are
15337 non-zero margins, because scroll_up_aggressively
15338 means put point that fraction of window height
15339 _from_the_bottom_margin_. */
15340 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15341 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15342 amount_to_scroll
= dy
+ aggressive_scroll
;
15346 if (amount_to_scroll
<= 0)
15347 return SCROLLING_FAILED
;
15349 start_display (&it
, w
, startp
);
15350 if (arg_scroll_conservatively
<= scroll_limit
)
15351 move_it_vertically (&it
, amount_to_scroll
);
15354 /* Extra precision for users who set scroll-conservatively
15355 to a large number: make sure the amount we scroll
15356 the window start is never less than amount_to_scroll,
15357 which was computed as distance from window bottom to
15358 point. This matters when lines at window top and lines
15359 below window bottom have different height. */
15361 void *it1data
= NULL
;
15362 /* We use a temporary it1 because line_bottom_y can modify
15363 its argument, if it moves one line down; see there. */
15366 SAVE_IT (it1
, it
, it1data
);
15367 start_y
= line_bottom_y (&it1
);
15369 RESTORE_IT (&it
, &it
, it1data
);
15370 move_it_by_lines (&it
, 1);
15371 SAVE_IT (it1
, it
, it1data
);
15372 } while (IT_CHARPOS (it
) < ZV
15373 && line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15374 bidi_unshelve_cache (it1data
, true);
15377 /* If STARTP is unchanged, move it down another screen line. */
15378 if (IT_CHARPOS (it
) == CHARPOS (startp
))
15379 move_it_by_lines (&it
, 1);
15380 startp
= it
.current
.pos
;
15384 struct text_pos scroll_margin_pos
= startp
;
15387 /* See if point is inside the scroll margin at the top of the
15389 if (this_scroll_margin
)
15393 start_display (&it
, w
, startp
);
15394 y_start
= it
.current_y
;
15395 move_it_vertically (&it
, this_scroll_margin
);
15396 scroll_margin_pos
= it
.current
.pos
;
15397 /* If we didn't move enough before hitting ZV, request
15398 additional amount of scroll, to move point out of the
15400 if (IT_CHARPOS (it
) == ZV
15401 && it
.current_y
- y_start
< this_scroll_margin
)
15402 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15405 if (PT
< CHARPOS (scroll_margin_pos
))
15407 /* Point is in the scroll margin at the top of the window or
15408 above what is displayed in the window. */
15411 /* Compute the vertical distance from PT to the scroll
15412 margin position. Move as far as scroll_max allows, or
15413 one screenful, or 10 screen lines, whichever is largest.
15414 Give up if distance is greater than scroll_max or if we
15415 didn't reach the scroll margin position. */
15416 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15417 start_display (&it
, w
, pos
);
15419 y_to_move
= max (it
.last_visible_y
,
15420 max (scroll_max
, 10 * frame_line_height
));
15421 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15423 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15424 dy
= it
.current_y
- y0
;
15425 if (dy
> scroll_max
15426 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15427 return SCROLLING_FAILED
;
15429 /* Additional scroll for when ZV was too close to point. */
15432 /* Compute new window start. */
15433 start_display (&it
, w
, startp
);
15435 if (arg_scroll_conservatively
)
15436 amount_to_scroll
= max (dy
, frame_line_height
15437 * max (scroll_step
, temp_scroll_step
));
15438 else if (scroll_step
|| temp_scroll_step
)
15439 amount_to_scroll
= scroll_max
;
15442 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15443 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15444 if (NUMBERP (aggressive
))
15446 double float_amount
= XFLOATINT (aggressive
) * height
;
15447 int aggressive_scroll
= float_amount
;
15448 if (aggressive_scroll
== 0 && float_amount
> 0)
15449 aggressive_scroll
= 1;
15450 /* Don't let point enter the scroll margin near
15451 bottom of the window, if the value of
15452 scroll_down_aggressively happens to be too
15454 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15455 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15456 amount_to_scroll
= dy
+ aggressive_scroll
;
15460 if (amount_to_scroll
<= 0)
15461 return SCROLLING_FAILED
;
15463 move_it_vertically_backward (&it
, amount_to_scroll
);
15464 startp
= it
.current
.pos
;
15468 /* Run window scroll functions. */
15469 startp
= run_window_scroll_functions (window
, startp
);
15471 /* Display the window. Give up if new fonts are loaded, or if point
15473 if (!try_window (window
, startp
, 0))
15474 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15475 else if (w
->cursor
.vpos
< 0)
15477 clear_glyph_matrix (w
->desired_matrix
);
15478 rc
= SCROLLING_FAILED
;
15482 /* Maybe forget recorded base line for line number display. */
15483 if (!just_this_one_p
15484 || current_buffer
->clip_changed
15485 || BEG_UNCHANGED
< CHARPOS (startp
))
15486 w
->base_line_number
= 0;
15488 /* If cursor ends up on a partially visible line,
15489 treat that as being off the bottom of the screen. */
15490 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1,
15492 /* It's possible that the cursor is on the first line of the
15493 buffer, which is partially obscured due to a vscroll
15494 (Bug#7537). In that case, avoid looping forever. */
15495 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15497 clear_glyph_matrix (w
->desired_matrix
);
15498 ++extra_scroll_margin_lines
;
15501 rc
= SCROLLING_SUCCESS
;
15508 /* Compute a suitable window start for window W if display of W starts
15509 on a continuation line. Value is true if a new window start
15512 The new window start will be computed, based on W's width, starting
15513 from the start of the continued line. It is the start of the
15514 screen line with the minimum distance from the old start W->start. */
15517 compute_window_start_on_continuation_line (struct window
*w
)
15519 struct text_pos pos
, start_pos
;
15520 bool window_start_changed_p
= false;
15522 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15524 /* If window start is on a continuation line... Window start may be
15525 < BEGV in case there's invisible text at the start of the
15526 buffer (M-x rmail, for example). */
15527 if (CHARPOS (start_pos
) > BEGV
15528 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15531 struct glyph_row
*row
;
15533 /* Handle the case that the window start is out of range. */
15534 if (CHARPOS (start_pos
) < BEGV
)
15535 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15536 else if (CHARPOS (start_pos
) > ZV
)
15537 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15539 /* Find the start of the continued line. This should be fast
15540 because find_newline is fast (newline cache). */
15541 row
= w
->desired_matrix
->rows
+ WINDOW_WANTS_HEADER_LINE_P (w
);
15542 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15543 row
, DEFAULT_FACE_ID
);
15544 reseat_at_previous_visible_line_start (&it
);
15546 /* If the line start is "too far" away from the window start,
15547 say it takes too much time to compute a new window start. */
15548 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15549 /* PXW: Do we need upper bounds here? */
15550 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15552 int min_distance
, distance
;
15554 /* Move forward by display lines to find the new window
15555 start. If window width was enlarged, the new start can
15556 be expected to be > the old start. If window width was
15557 decreased, the new window start will be < the old start.
15558 So, we're looking for the display line start with the
15559 minimum distance from the old window start. */
15560 pos
= it
.current
.pos
;
15561 min_distance
= INFINITY
;
15562 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15563 distance
< min_distance
)
15565 min_distance
= distance
;
15566 pos
= it
.current
.pos
;
15567 if (it
.line_wrap
== WORD_WRAP
)
15569 /* Under WORD_WRAP, move_it_by_lines is likely to
15570 overshoot and stop not at the first, but the
15571 second character from the left margin. So in
15572 that case, we need a more tight control on the X
15573 coordinate of the iterator than move_it_by_lines
15574 promises in its contract. The method is to first
15575 go to the last (rightmost) visible character of a
15576 line, then move to the leftmost character on the
15577 next line in a separate call. */
15578 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15579 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15580 move_it_to (&it
, ZV
, 0,
15581 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15582 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15585 move_it_by_lines (&it
, 1);
15588 /* Set the window start there. */
15589 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15590 window_start_changed_p
= true;
15594 return window_start_changed_p
;
15598 /* Try cursor movement in case text has not changed in window WINDOW,
15599 with window start STARTP. Value is
15601 CURSOR_MOVEMENT_SUCCESS if successful
15603 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15605 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15606 display. *SCROLL_STEP is set to true, under certain circumstances, if
15607 we want to scroll as if scroll-step were set to 1. See the code.
15609 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15610 which case we have to abort this redisplay, and adjust matrices
15615 CURSOR_MOVEMENT_SUCCESS
,
15616 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15617 CURSOR_MOVEMENT_MUST_SCROLL
,
15618 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15622 try_cursor_movement (Lisp_Object window
, struct text_pos startp
,
15625 struct window
*w
= XWINDOW (window
);
15626 struct frame
*f
= XFRAME (w
->frame
);
15627 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15630 if (inhibit_try_cursor_movement
)
15634 /* Previously, there was a check for Lisp integer in the
15635 if-statement below. Now, this field is converted to
15636 ptrdiff_t, thus zero means invalid position in a buffer. */
15637 eassert (w
->last_point
> 0);
15638 /* Likewise there was a check whether window_end_vpos is nil or larger
15639 than the window. Now window_end_vpos is int and so never nil, but
15640 let's leave eassert to check whether it fits in the window. */
15641 eassert (!w
->window_end_valid
15642 || w
->window_end_vpos
< w
->current_matrix
->nrows
);
15644 /* Handle case where text has not changed, only point, and it has
15645 not moved off the frame. */
15646 if (/* Point may be in this window. */
15647 PT
>= CHARPOS (startp
)
15648 /* Selective display hasn't changed. */
15649 && !current_buffer
->clip_changed
15650 /* Function force-mode-line-update is used to force a thorough
15651 redisplay. It sets either windows_or_buffers_changed or
15652 update_mode_lines. So don't take a shortcut here for these
15654 && !update_mode_lines
15655 && !windows_or_buffers_changed
15656 && !f
->cursor_type_changed
15657 && NILP (Vshow_trailing_whitespace
)
15658 /* This code is not used for mini-buffer for the sake of the case
15659 of redisplaying to replace an echo area message; since in
15660 that case the mini-buffer contents per se are usually
15661 unchanged. This code is of no real use in the mini-buffer
15662 since the handling of this_line_start_pos, etc., in redisplay
15663 handles the same cases. */
15664 && !EQ (window
, minibuf_window
)
15665 && (FRAME_WINDOW_P (f
)
15666 || !overlay_arrow_in_current_buffer_p ()))
15668 int this_scroll_margin
, top_scroll_margin
;
15669 struct glyph_row
*row
= NULL
;
15670 int frame_line_height
= default_line_pixel_height (w
);
15671 int window_total_lines
15672 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15675 debug_method_add (w
, "cursor movement");
15678 /* Scroll if point within this distance from the top or bottom
15679 of the window. This is a pixel value. */
15680 if (scroll_margin
> 0)
15682 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15683 this_scroll_margin
*= frame_line_height
;
15686 this_scroll_margin
= 0;
15688 top_scroll_margin
= this_scroll_margin
;
15689 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15690 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15692 /* Start with the row the cursor was displayed during the last
15693 not paused redisplay. Give up if that row is not valid. */
15694 if (w
->last_cursor_vpos
< 0
15695 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15696 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15699 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15700 if (row
->mode_line_p
)
15702 if (!row
->enabled_p
)
15703 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15706 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15708 bool scroll_p
= false, must_scroll
= false;
15709 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15711 if (PT
> w
->last_point
)
15713 /* Point has moved forward. */
15714 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15715 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15717 eassert (row
->enabled_p
);
15721 /* If the end position of a row equals the start
15722 position of the next row, and PT is at that position,
15723 we would rather display cursor in the next line. */
15724 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15725 && MATRIX_ROW_END_CHARPOS (row
) == PT
15726 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15727 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15728 && !cursor_row_p (row
))
15731 /* If within the scroll margin, scroll. Note that
15732 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15733 the next line would be drawn, and that
15734 this_scroll_margin can be zero. */
15735 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15736 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15737 /* Line is completely visible last line in window
15738 and PT is to be set in the next line. */
15739 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15740 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15741 && !row
->ends_at_zv_p
15742 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15745 else if (PT
< w
->last_point
)
15747 /* Cursor has to be moved backward. Note that PT >=
15748 CHARPOS (startp) because of the outer if-statement. */
15749 while (!row
->mode_line_p
15750 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15751 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15752 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15753 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15754 row
> w
->current_matrix
->rows
15755 && (row
-1)->ends_in_newline_from_string_p
))))
15756 && (row
->y
> top_scroll_margin
15757 || CHARPOS (startp
) == BEGV
))
15759 eassert (row
->enabled_p
);
15763 /* Consider the following case: Window starts at BEGV,
15764 there is invisible, intangible text at BEGV, so that
15765 display starts at some point START > BEGV. It can
15766 happen that we are called with PT somewhere between
15767 BEGV and START. Try to handle that case. */
15768 if (row
< w
->current_matrix
->rows
15769 || row
->mode_line_p
)
15771 row
= w
->current_matrix
->rows
;
15772 if (row
->mode_line_p
)
15776 /* Due to newlines in overlay strings, we may have to
15777 skip forward over overlay strings. */
15778 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15779 && MATRIX_ROW_END_CHARPOS (row
) == PT
15780 && !cursor_row_p (row
))
15783 /* If within the scroll margin, scroll. */
15784 if (row
->y
< top_scroll_margin
15785 && CHARPOS (startp
) != BEGV
)
15790 /* Cursor did not move. So don't scroll even if cursor line
15791 is partially visible, as it was so before. */
15792 rc
= CURSOR_MOVEMENT_SUCCESS
;
15795 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15796 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15798 /* if PT is not in the glyph row, give up. */
15799 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15800 must_scroll
= true;
15802 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15803 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15805 struct glyph_row
*row1
;
15807 /* If rows are bidi-reordered and point moved, back up
15808 until we find a row that does not belong to a
15809 continuation line. This is because we must consider
15810 all rows of a continued line as candidates for the
15811 new cursor positioning, since row start and end
15812 positions change non-linearly with vertical position
15814 /* FIXME: Revisit this when glyph ``spilling'' in
15815 continuation lines' rows is implemented for
15816 bidi-reordered rows. */
15817 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15818 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15821 /* If we hit the beginning of the displayed portion
15822 without finding the first row of a continued
15826 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15829 eassert (row
->enabled_p
);
15834 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15835 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15836 /* Make sure this isn't a header line by any chance, since
15837 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield true. */
15838 && !row
->mode_line_p
15839 && make_cursor_line_fully_visible_p
)
15841 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15842 && !row
->ends_at_zv_p
15843 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15844 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15845 else if (row
->height
> window_box_height (w
))
15847 /* If we end up in a partially visible line, let's
15848 make it fully visible, except when it's taller
15849 than the window, in which case we can't do much
15851 *scroll_step
= true;
15852 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15856 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15857 if (!cursor_row_fully_visible_p (w
, false, true))
15858 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15860 rc
= CURSOR_MOVEMENT_SUCCESS
;
15864 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15865 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15866 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15868 /* With bidi-reordered rows, there could be more than
15869 one candidate row whose start and end positions
15870 occlude point. We need to let set_cursor_from_row
15871 find the best candidate. */
15872 /* FIXME: Revisit this when glyph ``spilling'' in
15873 continuation lines' rows is implemented for
15874 bidi-reordered rows. */
15879 bool at_zv_p
= false, exact_match_p
= false;
15881 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15882 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15883 && cursor_row_p (row
))
15884 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15886 /* As soon as we've found the exact match for point,
15887 or the first suitable row whose ends_at_zv_p flag
15888 is set, we are done. */
15891 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15892 w
->cursor
.vpos
)->ends_at_zv_p
;
15894 && w
->cursor
.hpos
>= 0
15895 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15898 struct glyph_row
*candidate
=
15899 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15901 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15902 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15905 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15906 || (NILP (g
->object
)
15907 && (g
->charpos
== PT
15908 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15910 if (at_zv_p
|| exact_match_p
)
15912 rc
= CURSOR_MOVEMENT_SUCCESS
;
15916 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15920 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15921 || row
->continued_p
)
15922 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15923 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15924 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15925 /* If we didn't find any candidate rows, or exited the
15926 loop before all the candidates were examined, signal
15927 to the caller that this method failed. */
15928 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15930 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15931 && !row
->continued_p
))
15932 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15934 rc
= CURSOR_MOVEMENT_SUCCESS
;
15940 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15942 rc
= CURSOR_MOVEMENT_SUCCESS
;
15947 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15948 && MATRIX_ROW_START_CHARPOS (row
) == PT
15949 && cursor_row_p (row
));
15959 set_vertical_scroll_bar (struct window
*w
)
15961 ptrdiff_t start
, end
, whole
;
15963 /* Calculate the start and end positions for the current window.
15964 At some point, it would be nice to choose between scrollbars
15965 which reflect the whole buffer size, with special markers
15966 indicating narrowing, and scrollbars which reflect only the
15969 Note that mini-buffers sometimes aren't displaying any text. */
15970 if (!MINI_WINDOW_P (w
)
15971 || (w
== XWINDOW (minibuf_window
)
15972 && NILP (echo_area_buffer
[0])))
15974 struct buffer
*buf
= XBUFFER (w
->contents
);
15975 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15976 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15977 /* I don't think this is guaranteed to be right. For the
15978 moment, we'll pretend it is. */
15979 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15983 if (whole
< (end
- start
))
15984 whole
= end
- start
;
15987 start
= end
= whole
= 0;
15989 /* Indicate what this scroll bar ought to be displaying now. */
15990 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15991 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15992 (w
, end
- start
, whole
, start
);
15997 set_horizontal_scroll_bar (struct window
*w
)
15999 int start
, end
, whole
, portion
;
16001 if (!MINI_WINDOW_P (w
)
16002 || (w
== XWINDOW (minibuf_window
)
16003 && NILP (echo_area_buffer
[0])))
16005 struct buffer
*b
= XBUFFER (w
->contents
);
16006 struct buffer
*old_buffer
= NULL
;
16008 struct text_pos startp
;
16010 if (b
!= current_buffer
)
16012 old_buffer
= current_buffer
;
16013 set_buffer_internal (b
);
16016 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16017 start_display (&it
, w
, startp
);
16018 it
.last_visible_x
= INT_MAX
;
16019 whole
= move_it_to (&it
, -1, INT_MAX
, window_box_height (w
), -1,
16020 MOVE_TO_X
| MOVE_TO_Y
);
16021 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
16022 window_box_height (w), -1,
16023 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
16025 start
= w
->hscroll
* FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
));
16026 end
= start
+ window_box_width (w
, TEXT_AREA
);
16027 portion
= end
- start
;
16028 /* After enlarging a horizontally scrolled window such that it
16029 gets at least as wide as the text it contains, make sure that
16030 the thumb doesn't fill the entire scroll bar so we can still
16031 drag it back to see the entire text. */
16032 whole
= max (whole
, end
);
16038 pdir
= Fcurrent_bidi_paragraph_direction (Qnil
);
16039 if (EQ (pdir
, Qright_to_left
))
16041 start
= whole
- end
;
16042 end
= start
+ portion
;
16047 set_buffer_internal (old_buffer
);
16050 start
= end
= whole
= portion
= 0;
16052 w
->hscroll_whole
= whole
;
16054 /* Indicate what this scroll bar ought to be displaying now. */
16055 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
16056 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
16057 (w
, portion
, whole
, start
);
16061 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P means only
16062 selected_window is redisplayed.
16064 We can return without actually redisplaying the window if fonts has been
16065 changed on window's frame. In that case, redisplay_internal will retry.
16067 As one of the important parts of redisplaying a window, we need to
16068 decide whether the previous window-start position (stored in the
16069 window's w->start marker position) is still valid, and if it isn't,
16070 recompute it. Some details about that:
16072 . The previous window-start could be in a continuation line, in
16073 which case we need to recompute it when the window width
16074 changes. See compute_window_start_on_continuation_line and its
16077 . The text that changed since last redisplay could include the
16078 previous window-start position. In that case, we try to salvage
16079 what we can from the current glyph matrix by calling
16080 try_scrolling, which see.
16082 . Some Emacs command could force us to use a specific window-start
16083 position by setting the window's force_start flag, or gently
16084 propose doing that by setting the window's optional_new_start
16085 flag. In these cases, we try using the specified start point if
16086 that succeeds (i.e. the window desired matrix is successfully
16087 recomputed, and point location is within the window). In case
16088 of optional_new_start, we first check if the specified start
16089 position is feasible, i.e. if it will allow point to be
16090 displayed in the window. If using the specified start point
16091 fails, e.g., if new fonts are needed to be loaded, we abort the
16092 redisplay cycle and leave it up to the next cycle to figure out
16095 . Note that the window's force_start flag is sometimes set by
16096 redisplay itself, when it decides that the previous window start
16097 point is fine and should be kept. Search for "goto force_start"
16098 below to see the details. Like the values of window-start
16099 specified outside of redisplay, these internally-deduced values
16100 are tested for feasibility, and ignored if found to be
16103 . Note that the function try_window, used to completely redisplay
16104 a window, accepts the window's start point as its argument.
16105 This is used several times in the redisplay code to control
16106 where the window start will be, according to user options such
16107 as scroll-conservatively, and also to ensure the screen line
16108 showing point will be fully (as opposed to partially) visible on
16112 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
16114 struct window
*w
= XWINDOW (window
);
16115 struct frame
*f
= XFRAME (w
->frame
);
16116 struct buffer
*buffer
= XBUFFER (w
->contents
);
16117 struct buffer
*old
= current_buffer
;
16118 struct text_pos lpoint
, opoint
, startp
;
16119 bool update_mode_line
;
16122 /* Record it now because it's overwritten. */
16123 bool current_matrix_up_to_date_p
= false;
16124 bool used_current_matrix_p
= false;
16125 /* This is less strict than current_matrix_up_to_date_p.
16126 It indicates that the buffer contents and narrowing are unchanged. */
16127 bool buffer_unchanged_p
= false;
16128 bool temp_scroll_step
= false;
16129 ptrdiff_t count
= SPECPDL_INDEX ();
16131 int centering_position
= -1;
16132 bool last_line_misfit
= false;
16133 ptrdiff_t beg_unchanged
, end_unchanged
;
16134 int frame_line_height
;
16135 bool use_desired_matrix
;
16137 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16141 *w
->desired_matrix
->method
= 0;
16144 if (!just_this_one_p
16145 && REDISPLAY_SOME_P ()
16147 && !w
->update_mode_line
16150 && !buffer
->text
->redisplay
16151 && BUF_PT (buffer
) == w
->last_point
)
16154 /* Make sure that both W's markers are valid. */
16155 eassert (XMARKER (w
->start
)->buffer
== buffer
);
16156 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
16158 /* We come here again if we need to run window-text-change-functions
16161 reconsider_clip_changes (w
);
16162 frame_line_height
= default_line_pixel_height (w
);
16164 /* Has the mode line to be updated? */
16165 update_mode_line
= (w
->update_mode_line
16166 || update_mode_lines
16167 || buffer
->clip_changed
16168 || buffer
->prevent_redisplay_optimizations_p
);
16170 if (!just_this_one_p
)
16171 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
16172 cleverly elsewhere. */
16173 w
->must_be_updated_p
= true;
16175 if (MINI_WINDOW_P (w
))
16177 if (w
== XWINDOW (echo_area_window
)
16178 && !NILP (echo_area_buffer
[0]))
16180 if (update_mode_line
)
16181 /* We may have to update a tty frame's menu bar or a
16182 tool-bar. Example `M-x C-h C-h C-g'. */
16183 goto finish_menu_bars
;
16185 /* We've already displayed the echo area glyphs in this window. */
16186 goto finish_scroll_bars
;
16188 else if ((w
!= XWINDOW (minibuf_window
)
16189 || minibuf_level
== 0)
16190 /* When buffer is nonempty, redisplay window normally. */
16191 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
16192 /* Quail displays non-mini buffers in minibuffer window.
16193 In that case, redisplay the window normally. */
16194 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
16196 /* W is a mini-buffer window, but it's not active, so clear
16198 int yb
= window_text_bottom_y (w
);
16199 struct glyph_row
*row
;
16202 for (y
= 0, row
= w
->desired_matrix
->rows
;
16204 y
+= row
->height
, ++row
)
16205 blank_row (w
, row
, y
);
16206 goto finish_scroll_bars
;
16209 clear_glyph_matrix (w
->desired_matrix
);
16212 /* Otherwise set up data on this window; select its buffer and point
16214 /* Really select the buffer, for the sake of buffer-local
16216 set_buffer_internal_1 (XBUFFER (w
->contents
));
16218 current_matrix_up_to_date_p
16219 = (w
->window_end_valid
16220 && !current_buffer
->clip_changed
16221 && !current_buffer
->prevent_redisplay_optimizations_p
16222 && !window_outdated (w
));
16224 /* Run the window-text-change-functions
16225 if it is possible that the text on the screen has changed
16226 (either due to modification of the text, or any other reason). */
16227 if (!current_matrix_up_to_date_p
16228 && !NILP (Vwindow_text_change_functions
))
16230 safe_run_hooks (Qwindow_text_change_functions
);
16234 beg_unchanged
= BEG_UNCHANGED
;
16235 end_unchanged
= END_UNCHANGED
;
16237 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
16239 specbind (Qinhibit_point_motion_hooks
, Qt
);
16242 = (w
->window_end_valid
16243 && !current_buffer
->clip_changed
16244 && !window_outdated (w
));
16246 /* When windows_or_buffers_changed is non-zero, we can't rely
16247 on the window end being valid, so set it to zero there. */
16248 if (windows_or_buffers_changed
)
16250 /* If window starts on a continuation line, maybe adjust the
16251 window start in case the window's width changed. */
16252 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16253 compute_window_start_on_continuation_line (w
);
16255 w
->window_end_valid
= false;
16256 /* If so, we also can't rely on current matrix
16257 and should not fool try_cursor_movement below. */
16258 current_matrix_up_to_date_p
= false;
16261 /* Some sanity checks. */
16262 CHECK_WINDOW_END (w
);
16263 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16265 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16268 if (mode_line_update_needed (w
))
16269 update_mode_line
= true;
16271 /* Point refers normally to the selected window. For any other
16272 window, set up appropriate value. */
16273 if (!EQ (window
, selected_window
))
16275 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16276 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16281 new_pt_byte
= BEGV_BYTE
;
16282 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16284 else if (new_pt
> (ZV
- 1))
16287 new_pt_byte
= ZV_BYTE
;
16288 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16291 /* We don't use SET_PT so that the point-motion hooks don't run. */
16292 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16295 /* If any of the character widths specified in the display table
16296 have changed, invalidate the width run cache. It's true that
16297 this may be a bit late to catch such changes, but the rest of
16298 redisplay goes (non-fatally) haywire when the display table is
16299 changed, so why should we worry about doing any better? */
16300 if (current_buffer
->width_run_cache
16301 || (current_buffer
->base_buffer
16302 && current_buffer
->base_buffer
->width_run_cache
))
16304 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16306 if (! disptab_matches_widthtab
16307 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16309 struct buffer
*buf
= current_buffer
;
16311 if (buf
->base_buffer
)
16312 buf
= buf
->base_buffer
;
16313 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16314 recompute_width_table (current_buffer
, disptab
);
16318 /* If window-start is screwed up, choose a new one. */
16319 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16322 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16324 /* If someone specified a new starting point but did not insist,
16325 check whether it can be used. */
16326 if ((w
->optional_new_start
|| window_frozen_p (w
))
16327 && CHARPOS (startp
) >= BEGV
16328 && CHARPOS (startp
) <= ZV
)
16330 ptrdiff_t it_charpos
;
16332 w
->optional_new_start
= false;
16333 start_display (&it
, w
, startp
);
16334 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16335 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16336 /* Record IT's position now, since line_bottom_y might change
16338 it_charpos
= IT_CHARPOS (it
);
16339 /* Make sure we set the force_start flag only if the cursor row
16340 will be fully visible. Otherwise, the code under force_start
16341 label below will try to move point back into view, which is
16342 not what the code which sets optional_new_start wants. */
16343 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
16344 && !w
->force_start
)
16346 if (it_charpos
== PT
)
16347 w
->force_start
= true;
16348 /* IT may overshoot PT if text at PT is invisible. */
16349 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16350 w
->force_start
= true;
16352 if (w
->force_start
)
16354 if (window_frozen_p (w
))
16355 debug_method_add (w
, "set force_start from frozen window start");
16357 debug_method_add (w
, "set force_start from optional_new_start");
16365 /* Handle case where place to start displaying has been specified,
16366 unless the specified location is outside the accessible range. */
16367 if (w
->force_start
)
16369 /* We set this later on if we have to adjust point. */
16372 w
->force_start
= false;
16374 w
->window_end_valid
= false;
16376 /* Forget any recorded base line for line number display. */
16377 if (!buffer_unchanged_p
)
16378 w
->base_line_number
= 0;
16380 /* Redisplay the mode line. Select the buffer properly for that.
16381 Also, run the hook window-scroll-functions
16382 because we have scrolled. */
16383 /* Note, we do this after clearing force_start because
16384 if there's an error, it is better to forget about force_start
16385 than to get into an infinite loop calling the hook functions
16386 and having them get more errors. */
16387 if (!update_mode_line
16388 || ! NILP (Vwindow_scroll_functions
))
16390 update_mode_line
= true;
16391 w
->update_mode_line
= true;
16392 startp
= run_window_scroll_functions (window
, startp
);
16395 if (CHARPOS (startp
) < BEGV
)
16396 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16397 else if (CHARPOS (startp
) > ZV
)
16398 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16400 /* Redisplay, then check if cursor has been set during the
16401 redisplay. Give up if new fonts were loaded. */
16402 /* We used to issue a CHECK_MARGINS argument to try_window here,
16403 but this causes scrolling to fail when point begins inside
16404 the scroll margin (bug#148) -- cyd */
16405 if (!try_window (window
, startp
, 0))
16407 w
->force_start
= true;
16408 clear_glyph_matrix (w
->desired_matrix
);
16409 goto need_larger_matrices
;
16412 if (w
->cursor
.vpos
< 0)
16414 /* If point does not appear, try to move point so it does
16415 appear. The desired matrix has been built above, so we
16416 can use it here. First see if point is in invisible
16417 text, and if so, move it to the first visible buffer
16418 position past that. */
16419 struct glyph_row
*r
= NULL
;
16420 Lisp_Object invprop
=
16421 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16424 if (TEXT_PROP_MEANS_INVISIBLE (invprop
) != 0)
16427 Lisp_Object invprop_end
=
16428 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16431 if (NATNUMP (invprop_end
))
16432 alt_pt
= XFASTINT (invprop_end
);
16435 r
= row_containing_pos (w
, alt_pt
, w
->desired_matrix
->rows
,
16439 new_vpos
= MATRIX_ROW_BOTTOM_Y (r
);
16440 else /* Give up and just move to the middle of the window. */
16441 new_vpos
= window_box_height (w
) / 2;
16444 if (!cursor_row_fully_visible_p (w
, false, false))
16446 /* Point does appear, but on a line partly visible at end of window.
16447 Move it back to a fully-visible line. */
16448 new_vpos
= window_box_height (w
);
16449 /* But if window_box_height suggests a Y coordinate that is
16450 not less than we already have, that line will clearly not
16451 be fully visible, so give up and scroll the display.
16452 This can happen when the default face uses a font whose
16453 dimensions are different from the frame's default
16455 if (new_vpos
>= w
->cursor
.y
)
16457 w
->cursor
.vpos
= -1;
16458 clear_glyph_matrix (w
->desired_matrix
);
16459 goto try_to_scroll
;
16462 else if (w
->cursor
.vpos
>= 0)
16464 /* Some people insist on not letting point enter the scroll
16465 margin, even though this part handles windows that didn't
16467 int window_total_lines
16468 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16469 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16470 int pixel_margin
= margin
* frame_line_height
;
16471 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16473 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16474 below, which finds the row to move point to, advances by
16475 the Y coordinate of the _next_ row, see the definition of
16476 MATRIX_ROW_BOTTOM_Y. */
16477 if (w
->cursor
.vpos
< margin
+ header_line
)
16479 w
->cursor
.vpos
= -1;
16480 clear_glyph_matrix (w
->desired_matrix
);
16481 goto try_to_scroll
;
16485 int window_height
= window_box_height (w
);
16488 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16489 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16491 w
->cursor
.vpos
= -1;
16492 clear_glyph_matrix (w
->desired_matrix
);
16493 goto try_to_scroll
;
16498 /* If we need to move point for either of the above reasons,
16499 now actually do it. */
16502 struct glyph_row
*row
;
16504 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16505 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16508 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16509 MATRIX_ROW_START_BYTEPOS (row
));
16511 if (w
!= XWINDOW (selected_window
))
16512 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16513 else if (current_buffer
== old
)
16514 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16516 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16518 /* Re-run pre-redisplay-function so it can update the region
16519 according to the new position of point. */
16520 /* Other than the cursor, w's redisplay is done so we can set its
16521 redisplay to false. Also the buffer's redisplay can be set to
16522 false, since propagate_buffer_redisplay should have already
16523 propagated its info to `w' anyway. */
16524 w
->redisplay
= false;
16525 XBUFFER (w
->contents
)->text
->redisplay
= false;
16526 safe__call1 (true, Vpre_redisplay_function
, Fcons (window
, Qnil
));
16528 if (w
->redisplay
|| XBUFFER (w
->contents
)->text
->redisplay
)
16530 /* pre-redisplay-function made changes (e.g. move the region)
16531 that require another round of redisplay. */
16532 clear_glyph_matrix (w
->desired_matrix
);
16533 if (!try_window (window
, startp
, 0))
16534 goto need_larger_matrices
;
16537 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, false, false))
16539 clear_glyph_matrix (w
->desired_matrix
);
16540 goto try_to_scroll
;
16544 debug_method_add (w
, "forced window start");
16549 /* Handle case where text has not changed, only point, and it has
16550 not moved off the frame, and we are not retrying after hscroll.
16551 (current_matrix_up_to_date_p is true when retrying.) */
16552 if (current_matrix_up_to_date_p
16553 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16554 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16558 case CURSOR_MOVEMENT_SUCCESS
:
16559 used_current_matrix_p
= true;
16562 case CURSOR_MOVEMENT_MUST_SCROLL
:
16563 goto try_to_scroll
;
16569 /* If current starting point was originally the beginning of a line
16570 but no longer is, find a new starting point. */
16571 else if (w
->start_at_line_beg
16572 && !(CHARPOS (startp
) <= BEGV
16573 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16576 debug_method_add (w
, "recenter 1");
16581 /* Try scrolling with try_window_id. Value is > 0 if update has
16582 been done, it is -1 if we know that the same window start will
16583 not work. It is 0 if unsuccessful for some other reason. */
16584 else if ((tem
= try_window_id (w
)) != 0)
16587 debug_method_add (w
, "try_window_id %d", tem
);
16590 if (f
->fonts_changed
)
16591 goto need_larger_matrices
;
16595 /* Otherwise try_window_id has returned -1 which means that we
16596 don't want the alternative below this comment to execute. */
16598 else if (CHARPOS (startp
) >= BEGV
16599 && CHARPOS (startp
) <= ZV
16600 && PT
>= CHARPOS (startp
)
16601 && (CHARPOS (startp
) < ZV
16602 /* Avoid starting at end of buffer. */
16603 || CHARPOS (startp
) == BEGV
16604 || !window_outdated (w
)))
16606 int d1
, d2
, d5
, d6
;
16609 /* If first window line is a continuation line, and window start
16610 is inside the modified region, but the first change is before
16611 current window start, we must select a new window start.
16613 However, if this is the result of a down-mouse event (e.g. by
16614 extending the mouse-drag-overlay), we don't want to select a
16615 new window start, since that would change the position under
16616 the mouse, resulting in an unwanted mouse-movement rather
16617 than a simple mouse-click. */
16618 if (!w
->start_at_line_beg
16619 && NILP (do_mouse_tracking
)
16620 && CHARPOS (startp
) > BEGV
16621 && CHARPOS (startp
) > BEG
+ beg_unchanged
16622 && CHARPOS (startp
) <= Z
- end_unchanged
16623 /* Even if w->start_at_line_beg is nil, a new window may
16624 start at a line_beg, since that's how set_buffer_window
16625 sets it. So, we need to check the return value of
16626 compute_window_start_on_continuation_line. (See also
16628 && XMARKER (w
->start
)->buffer
== current_buffer
16629 && compute_window_start_on_continuation_line (w
)
16630 /* It doesn't make sense to force the window start like we
16631 do at label force_start if it is already known that point
16632 will not be fully visible in the resulting window, because
16633 doing so will move point from its correct position
16634 instead of scrolling the window to bring point into view.
16636 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16637 /* A very tall row could need more than the window height,
16638 in which case we accept that it is partially visible. */
16639 && (rtop
!= 0) == (rbot
!= 0))
16641 w
->force_start
= true;
16642 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16644 debug_method_add (w
, "recomputed window start in continuation line");
16650 debug_method_add (w
, "same window start");
16653 /* Try to redisplay starting at same place as before.
16654 If point has not moved off frame, accept the results. */
16655 if (!current_matrix_up_to_date_p
16656 /* Don't use try_window_reusing_current_matrix in this case
16657 because a window scroll function can have changed the
16659 || !NILP (Vwindow_scroll_functions
)
16660 || MINI_WINDOW_P (w
)
16661 || !(used_current_matrix_p
16662 = try_window_reusing_current_matrix (w
)))
16664 IF_DEBUG (debug_method_add (w
, "1"));
16665 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16666 /* -1 means we need to scroll.
16667 0 means we need new matrices, but fonts_changed
16668 is set in that case, so we will detect it below. */
16669 goto try_to_scroll
;
16672 if (f
->fonts_changed
)
16673 goto need_larger_matrices
;
16675 if (w
->cursor
.vpos
>= 0)
16677 if (!just_this_one_p
16678 || current_buffer
->clip_changed
16679 || BEG_UNCHANGED
< CHARPOS (startp
))
16680 /* Forget any recorded base line for line number display. */
16681 w
->base_line_number
= 0;
16683 if (!cursor_row_fully_visible_p (w
, true, false))
16685 clear_glyph_matrix (w
->desired_matrix
);
16686 last_line_misfit
= true;
16688 /* Drop through and scroll. */
16693 clear_glyph_matrix (w
->desired_matrix
);
16698 /* Redisplay the mode line. Select the buffer properly for that. */
16699 if (!update_mode_line
)
16701 update_mode_line
= true;
16702 w
->update_mode_line
= true;
16705 /* Try to scroll by specified few lines. */
16706 if ((scroll_conservatively
16707 || emacs_scroll_step
16708 || temp_scroll_step
16709 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16710 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16711 && CHARPOS (startp
) >= BEGV
16712 && CHARPOS (startp
) <= ZV
)
16714 /* The function returns -1 if new fonts were loaded, 1 if
16715 successful, 0 if not successful. */
16716 int ss
= try_scrolling (window
, just_this_one_p
,
16717 scroll_conservatively
,
16719 temp_scroll_step
, last_line_misfit
);
16722 case SCROLLING_SUCCESS
:
16725 case SCROLLING_NEED_LARGER_MATRICES
:
16726 goto need_larger_matrices
;
16728 case SCROLLING_FAILED
:
16736 /* Finally, just choose a place to start which positions point
16737 according to user preferences. */
16742 debug_method_add (w
, "recenter");
16745 /* Forget any previously recorded base line for line number display. */
16746 if (!buffer_unchanged_p
)
16747 w
->base_line_number
= 0;
16749 /* Determine the window start relative to point. */
16750 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16751 it
.current_y
= it
.last_visible_y
;
16752 if (centering_position
< 0)
16754 int window_total_lines
16755 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16757 = scroll_margin
> 0
16758 ? min (scroll_margin
, window_total_lines
/ 4)
16760 ptrdiff_t margin_pos
= CHARPOS (startp
);
16761 Lisp_Object aggressive
;
16764 /* If there is a scroll margin at the top of the window, find
16765 its character position. */
16767 /* Cannot call start_display if startp is not in the
16768 accessible region of the buffer. This can happen when we
16769 have just switched to a different buffer and/or changed
16770 its restriction. In that case, startp is initialized to
16771 the character position 1 (BEGV) because we did not yet
16772 have chance to display the buffer even once. */
16773 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16776 void *it1data
= NULL
;
16778 SAVE_IT (it1
, it
, it1data
);
16779 start_display (&it1
, w
, startp
);
16780 move_it_vertically (&it1
, margin
* frame_line_height
);
16781 margin_pos
= IT_CHARPOS (it1
);
16782 RESTORE_IT (&it
, &it
, it1data
);
16784 scrolling_up
= PT
> margin_pos
;
16787 ? BVAR (current_buffer
, scroll_up_aggressively
)
16788 : BVAR (current_buffer
, scroll_down_aggressively
);
16790 if (!MINI_WINDOW_P (w
)
16791 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16795 /* Setting scroll-conservatively overrides
16796 scroll-*-aggressively. */
16797 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16799 double float_amount
= XFLOATINT (aggressive
);
16801 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16802 if (pt_offset
== 0 && float_amount
> 0)
16804 if (pt_offset
&& margin
> 0)
16807 /* Compute how much to move the window start backward from
16808 point so that point will be displayed where the user
16812 centering_position
= it
.last_visible_y
;
16814 centering_position
-= pt_offset
;
16815 centering_position
-=
16816 (frame_line_height
* (1 + margin
+ last_line_misfit
)
16817 + WINDOW_HEADER_LINE_HEIGHT (w
));
16818 /* Don't let point enter the scroll margin near top of
16820 if (centering_position
< margin
* frame_line_height
)
16821 centering_position
= margin
* frame_line_height
;
16824 centering_position
= margin
* frame_line_height
+ pt_offset
;
16827 /* Set the window start half the height of the window backward
16829 centering_position
= window_box_height (w
) / 2;
16831 move_it_vertically_backward (&it
, centering_position
);
16833 eassert (IT_CHARPOS (it
) >= BEGV
);
16835 /* The function move_it_vertically_backward may move over more
16836 than the specified y-distance. If it->w is small, e.g. a
16837 mini-buffer window, we may end up in front of the window's
16838 display area. Start displaying at the start of the line
16839 containing PT in this case. */
16840 if (it
.current_y
<= 0)
16842 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16843 move_it_vertically_backward (&it
, 0);
16847 it
.current_x
= it
.hpos
= 0;
16849 /* Set the window start position here explicitly, to avoid an
16850 infinite loop in case the functions in window-scroll-functions
16852 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16854 /* Run scroll hooks. */
16855 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16857 /* Redisplay the window. */
16858 use_desired_matrix
= false;
16859 if (!current_matrix_up_to_date_p
16860 || windows_or_buffers_changed
16861 || f
->cursor_type_changed
16862 /* Don't use try_window_reusing_current_matrix in this case
16863 because it can have changed the buffer. */
16864 || !NILP (Vwindow_scroll_functions
)
16865 || !just_this_one_p
16866 || MINI_WINDOW_P (w
)
16867 || !(used_current_matrix_p
16868 = try_window_reusing_current_matrix (w
)))
16869 use_desired_matrix
= (try_window (window
, startp
, 0) == 1);
16871 /* If new fonts have been loaded (due to fontsets), give up. We
16872 have to start a new redisplay since we need to re-adjust glyph
16874 if (f
->fonts_changed
)
16875 goto need_larger_matrices
;
16877 /* If cursor did not appear assume that the middle of the window is
16878 in the first line of the window. Do it again with the next line.
16879 (Imagine a window of height 100, displaying two lines of height
16880 60. Moving back 50 from it->last_visible_y will end in the first
16882 if (w
->cursor
.vpos
< 0)
16884 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16886 clear_glyph_matrix (w
->desired_matrix
);
16887 move_it_by_lines (&it
, 1);
16888 try_window (window
, it
.current
.pos
, 0);
16890 else if (PT
< IT_CHARPOS (it
))
16892 clear_glyph_matrix (w
->desired_matrix
);
16893 move_it_by_lines (&it
, -1);
16894 try_window (window
, it
.current
.pos
, 0);
16898 /* Not much we can do about it. */
16902 /* Consider the following case: Window starts at BEGV, there is
16903 invisible, intangible text at BEGV, so that display starts at
16904 some point START > BEGV. It can happen that we are called with
16905 PT somewhere between BEGV and START. Try to handle that case,
16906 and similar ones. */
16907 if (w
->cursor
.vpos
< 0)
16909 /* Prefer the desired matrix to the current matrix, if possible,
16910 in the fallback calculations below. This is because using
16911 the current matrix might completely goof, e.g. if its first
16912 row is after point. */
16913 struct glyph_matrix
*matrix
=
16914 use_desired_matrix
? w
->desired_matrix
: w
->current_matrix
;
16915 /* First, try locating the proper glyph row for PT. */
16916 struct glyph_row
*row
=
16917 row_containing_pos (w
, PT
, matrix
->rows
, NULL
, 0);
16919 /* Sometimes point is at the beginning of invisible text that is
16920 before the 1st character displayed in the row. In that case,
16921 row_containing_pos fails to find the row, because no glyphs
16922 with appropriate buffer positions are present in the row.
16923 Therefore, we next try to find the row which shows the 1st
16924 position after the invisible text. */
16928 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16931 if (TEXT_PROP_MEANS_INVISIBLE (val
) != 0)
16934 Lisp_Object invis_end
=
16935 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16938 if (NATNUMP (invis_end
))
16939 alt_pos
= XFASTINT (invis_end
);
16942 row
= row_containing_pos (w
, alt_pos
, matrix
->rows
, NULL
, 0);
16945 /* Finally, fall back on the first row of the window after the
16946 header line (if any). This is slightly better than not
16947 displaying the cursor at all. */
16950 row
= matrix
->rows
;
16951 if (row
->mode_line_p
)
16954 set_cursor_from_row (w
, row
, matrix
, 0, 0, 0, 0);
16957 if (!cursor_row_fully_visible_p (w
, false, false))
16959 /* If vscroll is enabled, disable it and try again. */
16963 clear_glyph_matrix (w
->desired_matrix
);
16967 /* Users who set scroll-conservatively to a large number want
16968 point just above/below the scroll margin. If we ended up
16969 with point's row partially visible, move the window start to
16970 make that row fully visible and out of the margin. */
16971 if (scroll_conservatively
> SCROLL_LIMIT
)
16973 int window_total_lines
16974 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16977 ? min (scroll_margin
, window_total_lines
/ 4)
16979 bool move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16981 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16982 clear_glyph_matrix (w
->desired_matrix
);
16983 if (1 == try_window (window
, it
.current
.pos
,
16984 TRY_WINDOW_CHECK_MARGINS
))
16988 /* If centering point failed to make the whole line visible,
16989 put point at the top instead. That has to make the whole line
16990 visible, if it can be done. */
16991 if (centering_position
== 0)
16994 clear_glyph_matrix (w
->desired_matrix
);
16995 centering_position
= 0;
17001 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
17002 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
17003 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
17005 /* Display the mode line, if we must. */
17006 if ((update_mode_line
17007 /* If window not full width, must redo its mode line
17008 if (a) the window to its side is being redone and
17009 (b) we do a frame-based redisplay. This is a consequence
17010 of how inverted lines are drawn in frame-based redisplay. */
17011 || (!just_this_one_p
17012 && !FRAME_WINDOW_P (f
)
17013 && !WINDOW_FULL_WIDTH_P (w
))
17014 /* Line number to display. */
17015 || w
->base_line_pos
> 0
17016 /* Column number is displayed and different from the one displayed. */
17017 || (w
->column_number_displayed
!= -1
17018 && (w
->column_number_displayed
!= current_column ())))
17019 /* This means that the window has a mode line. */
17020 && (WINDOW_WANTS_MODELINE_P (w
)
17021 || WINDOW_WANTS_HEADER_LINE_P (w
)))
17024 display_mode_lines (w
);
17026 /* If mode line height has changed, arrange for a thorough
17027 immediate redisplay using the correct mode line height. */
17028 if (WINDOW_WANTS_MODELINE_P (w
)
17029 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
17031 f
->fonts_changed
= true;
17032 w
->mode_line_height
= -1;
17033 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
17034 = DESIRED_MODE_LINE_HEIGHT (w
);
17037 /* If header line height has changed, arrange for a thorough
17038 immediate redisplay using the correct header line height. */
17039 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17040 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
17042 f
->fonts_changed
= true;
17043 w
->header_line_height
= -1;
17044 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
17045 = DESIRED_HEADER_LINE_HEIGHT (w
);
17048 if (f
->fonts_changed
)
17049 goto need_larger_matrices
;
17052 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
17054 w
->base_line_pos
= 0;
17055 w
->base_line_number
= 0;
17060 /* When we reach a frame's selected window, redo the frame's menu
17061 bar and the frame's title. */
17062 if (update_mode_line
17063 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
17065 bool redisplay_menu_p
;
17067 if (FRAME_WINDOW_P (f
))
17069 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
17070 || defined (HAVE_NS) || defined (USE_GTK)
17071 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
17073 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
17077 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
17079 if (redisplay_menu_p
)
17080 display_menu_bar (w
);
17082 #ifdef HAVE_WINDOW_SYSTEM
17083 if (FRAME_WINDOW_P (f
))
17085 #if defined (USE_GTK) || defined (HAVE_NS)
17086 if (FRAME_EXTERNAL_TOOL_BAR (f
))
17087 redisplay_tool_bar (f
);
17089 if (WINDOWP (f
->tool_bar_window
)
17090 && (FRAME_TOOL_BAR_LINES (f
) > 0
17091 || !NILP (Vauto_resize_tool_bars
))
17092 && redisplay_tool_bar (f
))
17093 ignore_mouse_drag_p
= true;
17096 ptrdiff_t count1
= SPECPDL_INDEX ();
17097 /* x_consider_frame_title calls select-frame, which calls
17098 resize_mini_window, which could resize the mini-window and by
17099 that undo the effect of this redisplay cycle wrt minibuffer
17100 and echo-area display. Binding inhibit-redisplay to t makes
17101 the call to resize_mini_window a no-op, thus avoiding the
17102 adverse side effects. */
17103 specbind (Qinhibit_redisplay
, Qt
);
17104 x_consider_frame_title (w
->frame
);
17105 unbind_to (count1
, Qnil
);
17109 #ifdef HAVE_WINDOW_SYSTEM
17110 if (FRAME_WINDOW_P (f
)
17111 && update_window_fringes (w
, (just_this_one_p
17112 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
17113 || w
->pseudo_window_p
)))
17117 if (draw_window_fringes (w
, true))
17119 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
17120 x_draw_right_divider (w
);
17122 x_draw_vertical_border (w
);
17128 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
17129 x_draw_bottom_divider (w
);
17130 #endif /* HAVE_WINDOW_SYSTEM */
17132 /* We go to this label, with fonts_changed set, if it is
17133 necessary to try again using larger glyph matrices.
17134 We have to redeem the scroll bar even in this case,
17135 because the loop in redisplay_internal expects that. */
17136 need_larger_matrices
:
17138 finish_scroll_bars
:
17140 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
17142 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
17143 /* Set the thumb's position and size. */
17144 set_vertical_scroll_bar (w
);
17146 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
17147 /* Set the thumb's position and size. */
17148 set_horizontal_scroll_bar (w
);
17150 /* Note that we actually used the scroll bar attached to this
17151 window, so it shouldn't be deleted at the end of redisplay. */
17152 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
17153 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
17156 /* Restore current_buffer and value of point in it. The window
17157 update may have changed the buffer, so first make sure `opoint'
17158 is still valid (Bug#6177). */
17159 if (CHARPOS (opoint
) < BEGV
)
17160 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
17161 else if (CHARPOS (opoint
) > ZV
)
17162 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
17164 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
17166 set_buffer_internal_1 (old
);
17167 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
17168 shorter. This can be caused by log truncation in *Messages*. */
17169 if (CHARPOS (lpoint
) <= ZV
)
17170 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
17172 unbind_to (count
, Qnil
);
17176 /* Build the complete desired matrix of WINDOW with a window start
17177 buffer position POS.
17179 Value is 1 if successful. It is zero if fonts were loaded during
17180 redisplay which makes re-adjusting glyph matrices necessary, and -1
17181 if point would appear in the scroll margins.
17182 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
17183 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
17187 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
17189 struct window
*w
= XWINDOW (window
);
17191 struct glyph_row
*last_text_row
= NULL
;
17192 struct frame
*f
= XFRAME (w
->frame
);
17193 int frame_line_height
= default_line_pixel_height (w
);
17195 /* Make POS the new window start. */
17196 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
17198 /* Mark cursor position as unknown. No overlay arrow seen. */
17199 w
->cursor
.vpos
= -1;
17200 overlay_arrow_seen
= false;
17202 /* Initialize iterator and info to start at POS. */
17203 start_display (&it
, w
, pos
);
17204 it
.glyph_row
->reversed_p
= false;
17206 /* Display all lines of W. */
17207 while (it
.current_y
< it
.last_visible_y
)
17209 if (display_line (&it
))
17210 last_text_row
= it
.glyph_row
- 1;
17211 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
17215 /* Don't let the cursor end in the scroll margins. */
17216 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
17217 && !MINI_WINDOW_P (w
))
17219 int this_scroll_margin
;
17220 int window_total_lines
17221 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
17223 if (scroll_margin
> 0)
17225 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
17226 this_scroll_margin
*= frame_line_height
;
17229 this_scroll_margin
= 0;
17231 if ((w
->cursor
.y
>= 0 /* not vscrolled */
17232 && w
->cursor
.y
< this_scroll_margin
17233 && CHARPOS (pos
) > BEGV
17234 && IT_CHARPOS (it
) < ZV
)
17235 /* rms: considering make_cursor_line_fully_visible_p here
17236 seems to give wrong results. We don't want to recenter
17237 when the last line is partly visible, we want to allow
17238 that case to be handled in the usual way. */
17239 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
17241 w
->cursor
.vpos
= -1;
17242 clear_glyph_matrix (w
->desired_matrix
);
17247 /* If bottom moved off end of frame, change mode line percentage. */
17248 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
17249 w
->update_mode_line
= true;
17251 /* Set window_end_pos to the offset of the last character displayed
17252 on the window from the end of current_buffer. Set
17253 window_end_vpos to its row number. */
17256 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
17257 adjust_window_ends (w
, last_text_row
, false);
17259 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
17260 w
->window_end_vpos
)));
17264 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17265 w
->window_end_pos
= Z
- ZV
;
17266 w
->window_end_vpos
= 0;
17269 /* But that is not valid info until redisplay finishes. */
17270 w
->window_end_valid
= false;
17276 /************************************************************************
17277 Window redisplay reusing current matrix when buffer has not changed
17278 ************************************************************************/
17280 /* Try redisplay of window W showing an unchanged buffer with a
17281 different window start than the last time it was displayed by
17282 reusing its current matrix. Value is true if successful.
17283 W->start is the new window start. */
17286 try_window_reusing_current_matrix (struct window
*w
)
17288 struct frame
*f
= XFRAME (w
->frame
);
17289 struct glyph_row
*bottom_row
;
17292 struct text_pos start
, new_start
;
17293 int nrows_scrolled
, i
;
17294 struct glyph_row
*last_text_row
;
17295 struct glyph_row
*last_reused_text_row
;
17296 struct glyph_row
*start_row
;
17297 int start_vpos
, min_y
, max_y
;
17300 if (inhibit_try_window_reusing
)
17304 if (/* This function doesn't handle terminal frames. */
17305 !FRAME_WINDOW_P (f
)
17306 /* Don't try to reuse the display if windows have been split
17308 || windows_or_buffers_changed
17309 || f
->cursor_type_changed
)
17312 /* Can't do this if showing trailing whitespace. */
17313 if (!NILP (Vshow_trailing_whitespace
))
17316 /* If top-line visibility has changed, give up. */
17317 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17318 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17321 /* Give up if old or new display is scrolled vertically. We could
17322 make this function handle this, but right now it doesn't. */
17323 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17324 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17327 /* The variable new_start now holds the new window start. The old
17328 start `start' can be determined from the current matrix. */
17329 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17330 start
= start_row
->minpos
;
17331 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17333 /* Clear the desired matrix for the display below. */
17334 clear_glyph_matrix (w
->desired_matrix
);
17336 if (CHARPOS (new_start
) <= CHARPOS (start
))
17338 /* Don't use this method if the display starts with an ellipsis
17339 displayed for invisible text. It's not easy to handle that case
17340 below, and it's certainly not worth the effort since this is
17341 not a frequent case. */
17342 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17345 IF_DEBUG (debug_method_add (w
, "twu1"));
17347 /* Display up to a row that can be reused. The variable
17348 last_text_row is set to the last row displayed that displays
17349 text. Note that it.vpos == 0 if or if not there is a
17350 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17351 start_display (&it
, w
, new_start
);
17352 w
->cursor
.vpos
= -1;
17353 last_text_row
= last_reused_text_row
= NULL
;
17355 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17357 /* If we have reached into the characters in the START row,
17358 that means the line boundaries have changed. So we
17359 can't start copying with the row START. Maybe it will
17360 work to start copying with the following row. */
17361 while (IT_CHARPOS (it
) > CHARPOS (start
))
17363 /* Advance to the next row as the "start". */
17365 start
= start_row
->minpos
;
17366 /* If there are no more rows to try, or just one, give up. */
17367 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17368 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17369 || CHARPOS (start
) == ZV
)
17371 clear_glyph_matrix (w
->desired_matrix
);
17375 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17377 /* If we have reached alignment, we can copy the rest of the
17379 if (IT_CHARPOS (it
) == CHARPOS (start
)
17380 /* Don't accept "alignment" inside a display vector,
17381 since start_row could have started in the middle of
17382 that same display vector (thus their character
17383 positions match), and we have no way of telling if
17384 that is the case. */
17385 && it
.current
.dpvec_index
< 0)
17388 it
.glyph_row
->reversed_p
= false;
17389 if (display_line (&it
))
17390 last_text_row
= it
.glyph_row
- 1;
17394 /* A value of current_y < last_visible_y means that we stopped
17395 at the previous window start, which in turn means that we
17396 have at least one reusable row. */
17397 if (it
.current_y
< it
.last_visible_y
)
17399 struct glyph_row
*row
;
17401 /* IT.vpos always starts from 0; it counts text lines. */
17402 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17404 /* Find PT if not already found in the lines displayed. */
17405 if (w
->cursor
.vpos
< 0)
17407 int dy
= it
.current_y
- start_row
->y
;
17409 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17410 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17412 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17413 dy
, nrows_scrolled
);
17416 clear_glyph_matrix (w
->desired_matrix
);
17421 /* Scroll the display. Do it before the current matrix is
17422 changed. The problem here is that update has not yet
17423 run, i.e. part of the current matrix is not up to date.
17424 scroll_run_hook will clear the cursor, and use the
17425 current matrix to get the height of the row the cursor is
17427 run
.current_y
= start_row
->y
;
17428 run
.desired_y
= it
.current_y
;
17429 run
.height
= it
.last_visible_y
- it
.current_y
;
17431 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17434 FRAME_RIF (f
)->update_window_begin_hook (w
);
17435 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17436 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17437 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17441 /* Shift current matrix down by nrows_scrolled lines. */
17442 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17443 rotate_matrix (w
->current_matrix
,
17445 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17448 /* Disable lines that must be updated. */
17449 for (i
= 0; i
< nrows_scrolled
; ++i
)
17450 (start_row
+ i
)->enabled_p
= false;
17452 /* Re-compute Y positions. */
17453 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17454 max_y
= it
.last_visible_y
;
17455 for (row
= start_row
+ nrows_scrolled
;
17459 row
->y
= it
.current_y
;
17460 row
->visible_height
= row
->height
;
17462 if (row
->y
< min_y
)
17463 row
->visible_height
-= min_y
- row
->y
;
17464 if (row
->y
+ row
->height
> max_y
)
17465 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17466 if (row
->fringe_bitmap_periodic_p
)
17467 row
->redraw_fringe_bitmaps_p
= true;
17469 it
.current_y
+= row
->height
;
17471 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17472 last_reused_text_row
= row
;
17473 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17477 /* Disable lines in the current matrix which are now
17478 below the window. */
17479 for (++row
; row
< bottom_row
; ++row
)
17480 row
->enabled_p
= row
->mode_line_p
= false;
17483 /* Update window_end_pos etc.; last_reused_text_row is the last
17484 reused row from the current matrix containing text, if any.
17485 The value of last_text_row is the last displayed line
17486 containing text. */
17487 if (last_reused_text_row
)
17488 adjust_window_ends (w
, last_reused_text_row
, true);
17489 else if (last_text_row
)
17490 adjust_window_ends (w
, last_text_row
, false);
17493 /* This window must be completely empty. */
17494 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17495 w
->window_end_pos
= Z
- ZV
;
17496 w
->window_end_vpos
= 0;
17498 w
->window_end_valid
= false;
17500 /* Update hint: don't try scrolling again in update_window. */
17501 w
->desired_matrix
->no_scrolling_p
= true;
17504 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17508 else if (CHARPOS (new_start
) > CHARPOS (start
))
17510 struct glyph_row
*pt_row
, *row
;
17511 struct glyph_row
*first_reusable_row
;
17512 struct glyph_row
*first_row_to_display
;
17514 int yb
= window_text_bottom_y (w
);
17516 /* Find the row starting at new_start, if there is one. Don't
17517 reuse a partially visible line at the end. */
17518 first_reusable_row
= start_row
;
17519 while (first_reusable_row
->enabled_p
17520 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17521 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17522 < CHARPOS (new_start
)))
17523 ++first_reusable_row
;
17525 /* Give up if there is no row to reuse. */
17526 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17527 || !first_reusable_row
->enabled_p
17528 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17529 != CHARPOS (new_start
)))
17532 /* We can reuse fully visible rows beginning with
17533 first_reusable_row to the end of the window. Set
17534 first_row_to_display to the first row that cannot be reused.
17535 Set pt_row to the row containing point, if there is any. */
17537 for (first_row_to_display
= first_reusable_row
;
17538 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17539 ++first_row_to_display
)
17541 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17542 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17543 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17544 && first_row_to_display
->ends_at_zv_p
17545 && pt_row
== NULL
)))
17546 pt_row
= first_row_to_display
;
17549 /* Start displaying at the start of first_row_to_display. */
17550 eassert (first_row_to_display
->y
< yb
);
17551 init_to_row_start (&it
, w
, first_row_to_display
);
17553 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17555 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17557 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17558 + WINDOW_HEADER_LINE_HEIGHT (w
));
17560 /* Display lines beginning with first_row_to_display in the
17561 desired matrix. Set last_text_row to the last row displayed
17562 that displays text. */
17563 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17564 if (pt_row
== NULL
)
17565 w
->cursor
.vpos
= -1;
17566 last_text_row
= NULL
;
17567 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17568 if (display_line (&it
))
17569 last_text_row
= it
.glyph_row
- 1;
17571 /* If point is in a reused row, adjust y and vpos of the cursor
17575 w
->cursor
.vpos
-= nrows_scrolled
;
17576 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17579 /* Give up if point isn't in a row displayed or reused. (This
17580 also handles the case where w->cursor.vpos < nrows_scrolled
17581 after the calls to display_line, which can happen with scroll
17582 margins. See bug#1295.) */
17583 if (w
->cursor
.vpos
< 0)
17585 clear_glyph_matrix (w
->desired_matrix
);
17589 /* Scroll the display. */
17590 run
.current_y
= first_reusable_row
->y
;
17591 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17592 run
.height
= it
.last_visible_y
- run
.current_y
;
17593 dy
= run
.current_y
- run
.desired_y
;
17598 FRAME_RIF (f
)->update_window_begin_hook (w
);
17599 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17600 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17601 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17605 /* Adjust Y positions of reused rows. */
17606 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17607 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17608 max_y
= it
.last_visible_y
;
17609 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17612 row
->visible_height
= row
->height
;
17613 if (row
->y
< min_y
)
17614 row
->visible_height
-= min_y
- row
->y
;
17615 if (row
->y
+ row
->height
> max_y
)
17616 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17617 if (row
->fringe_bitmap_periodic_p
)
17618 row
->redraw_fringe_bitmaps_p
= true;
17621 /* Scroll the current matrix. */
17622 eassert (nrows_scrolled
> 0);
17623 rotate_matrix (w
->current_matrix
,
17625 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17628 /* Disable rows not reused. */
17629 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17630 row
->enabled_p
= false;
17632 /* Point may have moved to a different line, so we cannot assume that
17633 the previous cursor position is valid; locate the correct row. */
17636 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17638 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17639 && !row
->ends_at_zv_p
;
17643 w
->cursor
.y
= row
->y
;
17645 if (row
< bottom_row
)
17647 /* Can't simply scan the row for point with
17648 bidi-reordered glyph rows. Let set_cursor_from_row
17649 figure out where to put the cursor, and if it fails,
17651 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17653 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17656 clear_glyph_matrix (w
->desired_matrix
);
17662 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17663 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17666 && (!BUFFERP (glyph
->object
)
17667 || glyph
->charpos
< PT
);
17671 w
->cursor
.x
+= glyph
->pixel_width
;
17677 /* Adjust window end. A null value of last_text_row means that
17678 the window end is in reused rows which in turn means that
17679 only its vpos can have changed. */
17681 adjust_window_ends (w
, last_text_row
, false);
17683 w
->window_end_vpos
-= nrows_scrolled
;
17685 w
->window_end_valid
= false;
17686 w
->desired_matrix
->no_scrolling_p
= true;
17689 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17699 /************************************************************************
17700 Window redisplay reusing current matrix when buffer has changed
17701 ************************************************************************/
17703 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17704 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17705 ptrdiff_t *, ptrdiff_t *);
17706 static struct glyph_row
*
17707 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17708 struct glyph_row
*);
17711 /* Return the last row in MATRIX displaying text. If row START is
17712 non-null, start searching with that row. IT gives the dimensions
17713 of the display. Value is null if matrix is empty; otherwise it is
17714 a pointer to the row found. */
17716 static struct glyph_row
*
17717 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17718 struct glyph_row
*start
)
17720 struct glyph_row
*row
, *row_found
;
17722 /* Set row_found to the last row in IT->w's current matrix
17723 displaying text. The loop looks funny but think of partially
17726 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17727 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17729 eassert (row
->enabled_p
);
17731 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17740 /* Return the last row in the current matrix of W that is not affected
17741 by changes at the start of current_buffer that occurred since W's
17742 current matrix was built. Value is null if no such row exists.
17744 BEG_UNCHANGED us the number of characters unchanged at the start of
17745 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17746 first changed character in current_buffer. Characters at positions <
17747 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17748 when the current matrix was built. */
17750 static struct glyph_row
*
17751 find_last_unchanged_at_beg_row (struct window
*w
)
17753 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17754 struct glyph_row
*row
;
17755 struct glyph_row
*row_found
= NULL
;
17756 int yb
= window_text_bottom_y (w
);
17758 /* Find the last row displaying unchanged text. */
17759 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17760 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17761 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17764 if (/* If row ends before first_changed_pos, it is unchanged,
17765 except in some case. */
17766 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17767 /* When row ends in ZV and we write at ZV it is not
17769 && !row
->ends_at_zv_p
17770 /* When first_changed_pos is the end of a continued line,
17771 row is not unchanged because it may be no longer
17773 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17774 && (row
->continued_p
17775 || row
->exact_window_width_line_p
))
17776 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17777 needs to be recomputed, so don't consider this row as
17778 unchanged. This happens when the last line was
17779 bidi-reordered and was killed immediately before this
17780 redisplay cycle. In that case, ROW->end stores the
17781 buffer position of the first visual-order character of
17782 the killed text, which is now beyond ZV. */
17783 && CHARPOS (row
->end
.pos
) <= ZV
)
17786 /* Stop if last visible row. */
17787 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17795 /* Find the first glyph row in the current matrix of W that is not
17796 affected by changes at the end of current_buffer since the
17797 time W's current matrix was built.
17799 Return in *DELTA the number of chars by which buffer positions in
17800 unchanged text at the end of current_buffer must be adjusted.
17802 Return in *DELTA_BYTES the corresponding number of bytes.
17804 Value is null if no such row exists, i.e. all rows are affected by
17807 static struct glyph_row
*
17808 find_first_unchanged_at_end_row (struct window
*w
,
17809 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17811 struct glyph_row
*row
;
17812 struct glyph_row
*row_found
= NULL
;
17814 *delta
= *delta_bytes
= 0;
17816 /* Display must not have been paused, otherwise the current matrix
17817 is not up to date. */
17818 eassert (w
->window_end_valid
);
17820 /* A value of window_end_pos >= END_UNCHANGED means that the window
17821 end is in the range of changed text. If so, there is no
17822 unchanged row at the end of W's current matrix. */
17823 if (w
->window_end_pos
>= END_UNCHANGED
)
17826 /* Set row to the last row in W's current matrix displaying text. */
17827 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17829 /* If matrix is entirely empty, no unchanged row exists. */
17830 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17832 /* The value of row is the last glyph row in the matrix having a
17833 meaningful buffer position in it. The end position of row
17834 corresponds to window_end_pos. This allows us to translate
17835 buffer positions in the current matrix to current buffer
17836 positions for characters not in changed text. */
17838 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17839 ptrdiff_t Z_BYTE_old
=
17840 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17841 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17842 struct glyph_row
*first_text_row
17843 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17845 *delta
= Z
- Z_old
;
17846 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17848 /* Set last_unchanged_pos to the buffer position of the last
17849 character in the buffer that has not been changed. Z is the
17850 index + 1 of the last character in current_buffer, i.e. by
17851 subtracting END_UNCHANGED we get the index of the last
17852 unchanged character, and we have to add BEG to get its buffer
17854 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17855 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17857 /* Search backward from ROW for a row displaying a line that
17858 starts at a minimum position >= last_unchanged_pos_old. */
17859 for (; row
> first_text_row
; --row
)
17861 /* This used to abort, but it can happen.
17862 It is ok to just stop the search instead here. KFS. */
17863 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17866 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17871 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17877 /* Make sure that glyph rows in the current matrix of window W
17878 reference the same glyph memory as corresponding rows in the
17879 frame's frame matrix. This function is called after scrolling W's
17880 current matrix on a terminal frame in try_window_id and
17881 try_window_reusing_current_matrix. */
17884 sync_frame_with_window_matrix_rows (struct window
*w
)
17886 struct frame
*f
= XFRAME (w
->frame
);
17887 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17889 /* Preconditions: W must be a leaf window and full-width. Its frame
17890 must have a frame matrix. */
17891 eassert (BUFFERP (w
->contents
));
17892 eassert (WINDOW_FULL_WIDTH_P (w
));
17893 eassert (!FRAME_WINDOW_P (f
));
17895 /* If W is a full-width window, glyph pointers in W's current matrix
17896 have, by definition, to be the same as glyph pointers in the
17897 corresponding frame matrix. Note that frame matrices have no
17898 marginal areas (see build_frame_matrix). */
17899 window_row
= w
->current_matrix
->rows
;
17900 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17901 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17902 while (window_row
< window_row_end
)
17904 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17905 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17907 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17908 frame_row
->glyphs
[TEXT_AREA
] = start
;
17909 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17910 frame_row
->glyphs
[LAST_AREA
] = end
;
17912 /* Disable frame rows whose corresponding window rows have
17913 been disabled in try_window_id. */
17914 if (!window_row
->enabled_p
)
17915 frame_row
->enabled_p
= false;
17917 ++window_row
, ++frame_row
;
17922 /* Find the glyph row in window W containing CHARPOS. Consider all
17923 rows between START and END (not inclusive). END null means search
17924 all rows to the end of the display area of W. Value is the row
17925 containing CHARPOS or null. */
17928 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17929 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17931 struct glyph_row
*row
= start
;
17932 struct glyph_row
*best_row
= NULL
;
17933 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17936 /* If we happen to start on a header-line, skip that. */
17937 if (row
->mode_line_p
)
17940 if ((end
&& row
>= end
) || !row
->enabled_p
)
17943 last_y
= window_text_bottom_y (w
) - dy
;
17947 /* Give up if we have gone too far. */
17948 if ((end
&& row
>= end
) || !row
->enabled_p
)
17950 /* This formerly returned if they were equal.
17951 I think that both quantities are of a "last plus one" type;
17952 if so, when they are equal, the row is within the screen. -- rms. */
17953 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17956 /* If it is in this row, return this row. */
17957 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17958 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17959 /* The end position of a row equals the start
17960 position of the next row. If CHARPOS is there, we
17961 would rather consider it displayed in the next
17962 line, except when this line ends in ZV. */
17963 && !row_for_charpos_p (row
, charpos
)))
17964 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17968 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17969 || (!best_row
&& !row
->continued_p
))
17971 /* In bidi-reordered rows, there could be several rows whose
17972 edges surround CHARPOS, all of these rows belonging to
17973 the same continued line. We need to find the row which
17974 fits CHARPOS the best. */
17975 for (g
= row
->glyphs
[TEXT_AREA
];
17976 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17979 if (!STRINGP (g
->object
))
17981 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17983 mindif
= eabs (g
->charpos
- charpos
);
17985 /* Exact match always wins. */
17992 else if (best_row
&& !row
->continued_p
)
17999 /* Try to redisplay window W by reusing its existing display. W's
18000 current matrix must be up to date when this function is called,
18001 i.e., window_end_valid must be true.
18005 >= 1 if successful, i.e. display has been updated
18007 1 means the changes were in front of a newline that precedes
18008 the window start, and the whole current matrix was reused
18009 2 means the changes were after the last position displayed
18010 in the window, and the whole current matrix was reused
18011 3 means portions of the current matrix were reused, while
18012 some of the screen lines were redrawn
18013 -1 if redisplay with same window start is known not to succeed
18014 0 if otherwise unsuccessful
18016 The following steps are performed:
18018 1. Find the last row in the current matrix of W that is not
18019 affected by changes at the start of current_buffer. If no such row
18022 2. Find the first row in W's current matrix that is not affected by
18023 changes at the end of current_buffer. Maybe there is no such row.
18025 3. Display lines beginning with the row + 1 found in step 1 to the
18026 row found in step 2 or, if step 2 didn't find a row, to the end of
18029 4. If cursor is not known to appear on the window, give up.
18031 5. If display stopped at the row found in step 2, scroll the
18032 display and current matrix as needed.
18034 6. Maybe display some lines at the end of W, if we must. This can
18035 happen under various circumstances, like a partially visible line
18036 becoming fully visible, or because newly displayed lines are displayed
18037 in smaller font sizes.
18039 7. Update W's window end information. */
18042 try_window_id (struct window
*w
)
18044 struct frame
*f
= XFRAME (w
->frame
);
18045 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
18046 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
18047 struct glyph_row
*last_unchanged_at_beg_row
;
18048 struct glyph_row
*first_unchanged_at_end_row
;
18049 struct glyph_row
*row
;
18050 struct glyph_row
*bottom_row
;
18053 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
18055 struct text_pos start_pos
;
18057 int first_unchanged_at_end_vpos
= 0;
18058 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
18059 struct text_pos start
;
18060 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
18063 if (inhibit_try_window_id
)
18067 /* This is handy for debugging. */
18069 #define GIVE_UP(X) \
18071 TRACE ((stderr, "try_window_id give up %d\n", (X))); \
18075 #define GIVE_UP(X) return 0
18078 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
18080 /* Don't use this for mini-windows because these can show
18081 messages and mini-buffers, and we don't handle that here. */
18082 if (MINI_WINDOW_P (w
))
18085 /* This flag is used to prevent redisplay optimizations. */
18086 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
18089 /* This function's optimizations cannot be used if overlays have
18090 changed in the buffer displayed by the window, so give up if they
18092 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
18095 /* Verify that narrowing has not changed.
18096 Also verify that we were not told to prevent redisplay optimizations.
18097 It would be nice to further
18098 reduce the number of cases where this prevents try_window_id. */
18099 if (current_buffer
->clip_changed
18100 || current_buffer
->prevent_redisplay_optimizations_p
)
18103 /* Window must either use window-based redisplay or be full width. */
18104 if (!FRAME_WINDOW_P (f
)
18105 && (!FRAME_LINE_INS_DEL_OK (f
)
18106 || !WINDOW_FULL_WIDTH_P (w
)))
18109 /* Give up if point is known NOT to appear in W. */
18110 if (PT
< CHARPOS (start
))
18113 /* Another way to prevent redisplay optimizations. */
18114 if (w
->last_modified
== 0)
18117 /* Verify that window is not hscrolled. */
18118 if (w
->hscroll
!= 0)
18121 /* Verify that display wasn't paused. */
18122 if (!w
->window_end_valid
)
18125 /* Likewise if highlighting trailing whitespace. */
18126 if (!NILP (Vshow_trailing_whitespace
))
18129 /* Can't use this if overlay arrow position and/or string have
18131 if (overlay_arrows_changed_p ())
18134 /* When word-wrap is on, adding a space to the first word of a
18135 wrapped line can change the wrap position, altering the line
18136 above it. It might be worthwhile to handle this more
18137 intelligently, but for now just redisplay from scratch. */
18138 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
18141 /* Under bidi reordering, adding or deleting a character in the
18142 beginning of a paragraph, before the first strong directional
18143 character, can change the base direction of the paragraph (unless
18144 the buffer specifies a fixed paragraph direction), which will
18145 require redisplaying the whole paragraph. It might be worthwhile
18146 to find the paragraph limits and widen the range of redisplayed
18147 lines to that, but for now just give up this optimization and
18148 redisplay from scratch. */
18149 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
18150 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
18153 /* Give up if the buffer has line-spacing set, as Lisp-level changes
18154 to that variable require thorough redisplay. */
18155 if (!NILP (BVAR (XBUFFER (w
->contents
), extra_line_spacing
)))
18158 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
18159 only if buffer has really changed. The reason is that the gap is
18160 initially at Z for freshly visited files. The code below would
18161 set end_unchanged to 0 in that case. */
18162 if (MODIFF
> SAVE_MODIFF
18163 /* This seems to happen sometimes after saving a buffer. */
18164 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
18166 if (GPT
- BEG
< BEG_UNCHANGED
)
18167 BEG_UNCHANGED
= GPT
- BEG
;
18168 if (Z
- GPT
< END_UNCHANGED
)
18169 END_UNCHANGED
= Z
- GPT
;
18172 /* The position of the first and last character that has been changed. */
18173 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
18174 last_changed_charpos
= Z
- END_UNCHANGED
;
18176 /* If window starts after a line end, and the last change is in
18177 front of that newline, then changes don't affect the display.
18178 This case happens with stealth-fontification. Note that although
18179 the display is unchanged, glyph positions in the matrix have to
18180 be adjusted, of course. */
18181 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
18182 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
18183 && ((last_changed_charpos
< CHARPOS (start
)
18184 && CHARPOS (start
) == BEGV
)
18185 || (last_changed_charpos
< CHARPOS (start
) - 1
18186 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
18188 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
18189 struct glyph_row
*r0
;
18191 /* Compute how many chars/bytes have been added to or removed
18192 from the buffer. */
18193 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
18194 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
18195 Z_delta
= Z
- Z_old
;
18196 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
18198 /* Give up if PT is not in the window. Note that it already has
18199 been checked at the start of try_window_id that PT is not in
18200 front of the window start. */
18201 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
18204 /* If window start is unchanged, we can reuse the whole matrix
18205 as is, after adjusting glyph positions. No need to compute
18206 the window end again, since its offset from Z hasn't changed. */
18207 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18208 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
18209 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
18210 /* PT must not be in a partially visible line. */
18211 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
18212 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18214 /* Adjust positions in the glyph matrix. */
18215 if (Z_delta
|| Z_delta_bytes
)
18217 struct glyph_row
*r1
18218 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18219 increment_matrix_positions (w
->current_matrix
,
18220 MATRIX_ROW_VPOS (r0
, current_matrix
),
18221 MATRIX_ROW_VPOS (r1
, current_matrix
),
18222 Z_delta
, Z_delta_bytes
);
18225 /* Set the cursor. */
18226 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18228 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18233 /* Handle the case that changes are all below what is displayed in
18234 the window, and that PT is in the window. This shortcut cannot
18235 be taken if ZV is visible in the window, and text has been added
18236 there that is visible in the window. */
18237 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
18238 /* ZV is not visible in the window, or there are no
18239 changes at ZV, actually. */
18240 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
18241 || first_changed_charpos
== last_changed_charpos
))
18243 struct glyph_row
*r0
;
18245 /* Give up if PT is not in the window. Note that it already has
18246 been checked at the start of try_window_id that PT is not in
18247 front of the window start. */
18248 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
18251 /* If window start is unchanged, we can reuse the whole matrix
18252 as is, without changing glyph positions since no text has
18253 been added/removed in front of the window end. */
18254 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18255 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
18256 /* PT must not be in a partially visible line. */
18257 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
18258 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18260 /* We have to compute the window end anew since text
18261 could have been added/removed after it. */
18262 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18263 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18265 /* Set the cursor. */
18266 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18268 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18273 /* Give up if window start is in the changed area.
18275 The condition used to read
18277 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18279 but why that was tested escapes me at the moment. */
18280 if (CHARPOS (start
) >= first_changed_charpos
18281 && CHARPOS (start
) <= last_changed_charpos
)
18284 /* Check that window start agrees with the start of the first glyph
18285 row in its current matrix. Check this after we know the window
18286 start is not in changed text, otherwise positions would not be
18288 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18289 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
18292 /* Give up if the window ends in strings. Overlay strings
18293 at the end are difficult to handle, so don't try. */
18294 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
18295 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
18298 /* Compute the position at which we have to start displaying new
18299 lines. Some of the lines at the top of the window might be
18300 reusable because they are not displaying changed text. Find the
18301 last row in W's current matrix not affected by changes at the
18302 start of current_buffer. Value is null if changes start in the
18303 first line of window. */
18304 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18305 if (last_unchanged_at_beg_row
)
18307 /* Avoid starting to display in the middle of a character, a TAB
18308 for instance. This is easier than to set up the iterator
18309 exactly, and it's not a frequent case, so the additional
18310 effort wouldn't really pay off. */
18311 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18312 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18313 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18314 --last_unchanged_at_beg_row
;
18316 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18319 if (! init_to_row_end (&it
, w
, last_unchanged_at_beg_row
))
18321 start_pos
= it
.current
.pos
;
18323 /* Start displaying new lines in the desired matrix at the same
18324 vpos we would use in the current matrix, i.e. below
18325 last_unchanged_at_beg_row. */
18326 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18328 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18329 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18331 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18335 /* There are no reusable lines at the start of the window.
18336 Start displaying in the first text line. */
18337 start_display (&it
, w
, start
);
18338 it
.vpos
= it
.first_vpos
;
18339 start_pos
= it
.current
.pos
;
18342 /* Find the first row that is not affected by changes at the end of
18343 the buffer. Value will be null if there is no unchanged row, in
18344 which case we must redisplay to the end of the window. delta
18345 will be set to the value by which buffer positions beginning with
18346 first_unchanged_at_end_row have to be adjusted due to text
18348 first_unchanged_at_end_row
18349 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18350 IF_DEBUG (debug_delta
= delta
);
18351 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18353 /* Set stop_pos to the buffer position up to which we will have to
18354 display new lines. If first_unchanged_at_end_row != NULL, this
18355 is the buffer position of the start of the line displayed in that
18356 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18357 that we don't stop at a buffer position. */
18359 if (first_unchanged_at_end_row
)
18361 eassert (last_unchanged_at_beg_row
== NULL
18362 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18364 /* If this is a continuation line, move forward to the next one
18365 that isn't. Changes in lines above affect this line.
18366 Caution: this may move first_unchanged_at_end_row to a row
18367 not displaying text. */
18368 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18369 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18370 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18371 < it
.last_visible_y
))
18372 ++first_unchanged_at_end_row
;
18374 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18375 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18376 >= it
.last_visible_y
))
18377 first_unchanged_at_end_row
= NULL
;
18380 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18382 first_unchanged_at_end_vpos
18383 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18384 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18387 else if (last_unchanged_at_beg_row
== NULL
)
18393 /* Either there is no unchanged row at the end, or the one we have
18394 now displays text. This is a necessary condition for the window
18395 end pos calculation at the end of this function. */
18396 eassert (first_unchanged_at_end_row
== NULL
18397 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18399 debug_last_unchanged_at_beg_vpos
18400 = (last_unchanged_at_beg_row
18401 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18403 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18405 #endif /* GLYPH_DEBUG */
18408 /* Display new lines. Set last_text_row to the last new line
18409 displayed which has text on it, i.e. might end up as being the
18410 line where the window_end_vpos is. */
18411 w
->cursor
.vpos
= -1;
18412 last_text_row
= NULL
;
18413 overlay_arrow_seen
= false;
18414 if (it
.current_y
< it
.last_visible_y
18415 && !f
->fonts_changed
18416 && (first_unchanged_at_end_row
== NULL
18417 || IT_CHARPOS (it
) < stop_pos
))
18418 it
.glyph_row
->reversed_p
= false;
18419 while (it
.current_y
< it
.last_visible_y
18420 && !f
->fonts_changed
18421 && (first_unchanged_at_end_row
== NULL
18422 || IT_CHARPOS (it
) < stop_pos
))
18424 if (display_line (&it
))
18425 last_text_row
= it
.glyph_row
- 1;
18428 if (f
->fonts_changed
)
18431 /* The redisplay iterations in display_line above could have
18432 triggered font-lock, which could have done something that
18433 invalidates IT->w window's end-point information, on which we
18434 rely below. E.g., one package, which will remain unnamed, used
18435 to install a font-lock-fontify-region-function that called
18436 bury-buffer, whose side effect is to switch the buffer displayed
18437 by IT->w, and that predictably resets IT->w's window_end_valid
18438 flag, which we already tested at the entry to this function.
18439 Amply punish such packages/modes by giving up on this
18440 optimization in those cases. */
18441 if (!w
->window_end_valid
)
18443 clear_glyph_matrix (w
->desired_matrix
);
18447 /* Compute differences in buffer positions, y-positions etc. for
18448 lines reused at the bottom of the window. Compute what we can
18450 if (first_unchanged_at_end_row
18451 /* No lines reused because we displayed everything up to the
18452 bottom of the window. */
18453 && it
.current_y
< it
.last_visible_y
)
18456 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18458 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18459 run
.current_y
= first_unchanged_at_end_row
->y
;
18460 run
.desired_y
= run
.current_y
+ dy
;
18461 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18465 delta
= delta_bytes
= dvpos
= dy
18466 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18467 first_unchanged_at_end_row
= NULL
;
18469 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18472 /* Find the cursor if not already found. We have to decide whether
18473 PT will appear on this window (it sometimes doesn't, but this is
18474 not a very frequent case.) This decision has to be made before
18475 the current matrix is altered. A value of cursor.vpos < 0 means
18476 that PT is either in one of the lines beginning at
18477 first_unchanged_at_end_row or below the window. Don't care for
18478 lines that might be displayed later at the window end; as
18479 mentioned, this is not a frequent case. */
18480 if (w
->cursor
.vpos
< 0)
18482 /* Cursor in unchanged rows at the top? */
18483 if (PT
< CHARPOS (start_pos
)
18484 && last_unchanged_at_beg_row
)
18486 row
= row_containing_pos (w
, PT
,
18487 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18488 last_unchanged_at_beg_row
+ 1, 0);
18490 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18493 /* Start from first_unchanged_at_end_row looking for PT. */
18494 else if (first_unchanged_at_end_row
)
18496 row
= row_containing_pos (w
, PT
- delta
,
18497 first_unchanged_at_end_row
, NULL
, 0);
18499 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18500 delta_bytes
, dy
, dvpos
);
18503 /* Give up if cursor was not found. */
18504 if (w
->cursor
.vpos
< 0)
18506 clear_glyph_matrix (w
->desired_matrix
);
18511 /* Don't let the cursor end in the scroll margins. */
18513 int this_scroll_margin
, cursor_height
;
18514 int frame_line_height
= default_line_pixel_height (w
);
18515 int window_total_lines
18516 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18518 this_scroll_margin
=
18519 max (0, min (scroll_margin
, window_total_lines
/ 4));
18520 this_scroll_margin
*= frame_line_height
;
18521 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18523 if ((w
->cursor
.y
< this_scroll_margin
18524 && CHARPOS (start
) > BEGV
)
18525 /* Old redisplay didn't take scroll margin into account at the bottom,
18526 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18527 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18528 ? cursor_height
+ this_scroll_margin
18529 : 1)) > it
.last_visible_y
)
18531 w
->cursor
.vpos
= -1;
18532 clear_glyph_matrix (w
->desired_matrix
);
18537 /* Scroll the display. Do it before changing the current matrix so
18538 that xterm.c doesn't get confused about where the cursor glyph is
18540 if (dy
&& run
.height
)
18544 if (FRAME_WINDOW_P (f
))
18546 FRAME_RIF (f
)->update_window_begin_hook (w
);
18547 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18548 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18549 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
18553 /* Terminal frame. In this case, dvpos gives the number of
18554 lines to scroll by; dvpos < 0 means scroll up. */
18556 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18557 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18558 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18559 + WINDOW_WANTS_HEADER_LINE_P (w
)
18560 + window_internal_height (w
));
18562 #if defined (HAVE_GPM) || defined (MSDOS)
18563 x_clear_window_mouse_face (w
);
18565 /* Perform the operation on the screen. */
18568 /* Scroll last_unchanged_at_beg_row to the end of the
18569 window down dvpos lines. */
18570 set_terminal_window (f
, end
);
18572 /* On dumb terminals delete dvpos lines at the end
18573 before inserting dvpos empty lines. */
18574 if (!FRAME_SCROLL_REGION_OK (f
))
18575 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18577 /* Insert dvpos empty lines in front of
18578 last_unchanged_at_beg_row. */
18579 ins_del_lines (f
, from
, dvpos
);
18581 else if (dvpos
< 0)
18583 /* Scroll up last_unchanged_at_beg_vpos to the end of
18584 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18585 set_terminal_window (f
, end
);
18587 /* Delete dvpos lines in front of
18588 last_unchanged_at_beg_vpos. ins_del_lines will set
18589 the cursor to the given vpos and emit |dvpos| delete
18591 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18593 /* On a dumb terminal insert dvpos empty lines at the
18595 if (!FRAME_SCROLL_REGION_OK (f
))
18596 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18599 set_terminal_window (f
, 0);
18605 /* Shift reused rows of the current matrix to the right position.
18606 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18608 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18609 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18612 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18613 bottom_vpos
, dvpos
);
18614 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18617 else if (dvpos
> 0)
18619 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18620 bottom_vpos
, dvpos
);
18621 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18622 first_unchanged_at_end_vpos
+ dvpos
);
18625 /* For frame-based redisplay, make sure that current frame and window
18626 matrix are in sync with respect to glyph memory. */
18627 if (!FRAME_WINDOW_P (f
))
18628 sync_frame_with_window_matrix_rows (w
);
18630 /* Adjust buffer positions in reused rows. */
18631 if (delta
|| delta_bytes
)
18632 increment_matrix_positions (current_matrix
,
18633 first_unchanged_at_end_vpos
+ dvpos
,
18634 bottom_vpos
, delta
, delta_bytes
);
18636 /* Adjust Y positions. */
18638 shift_glyph_matrix (w
, current_matrix
,
18639 first_unchanged_at_end_vpos
+ dvpos
,
18642 if (first_unchanged_at_end_row
)
18644 first_unchanged_at_end_row
+= dvpos
;
18645 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18646 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18647 first_unchanged_at_end_row
= NULL
;
18650 /* If scrolling up, there may be some lines to display at the end of
18652 last_text_row_at_end
= NULL
;
18655 /* Scrolling up can leave for example a partially visible line
18656 at the end of the window to be redisplayed. */
18657 /* Set last_row to the glyph row in the current matrix where the
18658 window end line is found. It has been moved up or down in
18659 the matrix by dvpos. */
18660 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18661 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18663 /* If last_row is the window end line, it should display text. */
18664 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18666 /* If window end line was partially visible before, begin
18667 displaying at that line. Otherwise begin displaying with the
18668 line following it. */
18669 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18671 init_to_row_start (&it
, w
, last_row
);
18672 it
.vpos
= last_vpos
;
18673 it
.current_y
= last_row
->y
;
18677 init_to_row_end (&it
, w
, last_row
);
18678 it
.vpos
= 1 + last_vpos
;
18679 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18683 /* We may start in a continuation line. If so, we have to
18684 get the right continuation_lines_width and current_x. */
18685 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18686 it
.hpos
= it
.current_x
= 0;
18688 /* Display the rest of the lines at the window end. */
18689 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18690 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18692 /* Is it always sure that the display agrees with lines in
18693 the current matrix? I don't think so, so we mark rows
18694 displayed invalid in the current matrix by setting their
18695 enabled_p flag to false. */
18696 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18697 if (display_line (&it
))
18698 last_text_row_at_end
= it
.glyph_row
- 1;
18702 /* Update window_end_pos and window_end_vpos. */
18703 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18705 /* Window end line if one of the preserved rows from the current
18706 matrix. Set row to the last row displaying text in current
18707 matrix starting at first_unchanged_at_end_row, after
18709 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18710 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18711 first_unchanged_at_end_row
);
18712 eassume (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18713 adjust_window_ends (w
, row
, true);
18714 eassert (w
->window_end_bytepos
>= 0);
18715 IF_DEBUG (debug_method_add (w
, "A"));
18717 else if (last_text_row_at_end
)
18719 adjust_window_ends (w
, last_text_row_at_end
, false);
18720 eassert (w
->window_end_bytepos
>= 0);
18721 IF_DEBUG (debug_method_add (w
, "B"));
18723 else if (last_text_row
)
18725 /* We have displayed either to the end of the window or at the
18726 end of the window, i.e. the last row with text is to be found
18727 in the desired matrix. */
18728 adjust_window_ends (w
, last_text_row
, false);
18729 eassert (w
->window_end_bytepos
>= 0);
18731 else if (first_unchanged_at_end_row
== NULL
18732 && last_text_row
== NULL
18733 && last_text_row_at_end
== NULL
)
18735 /* Displayed to end of window, but no line containing text was
18736 displayed. Lines were deleted at the end of the window. */
18737 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
18738 int vpos
= w
->window_end_vpos
;
18739 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18740 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18742 for (row
= NULL
; !row
; --vpos
, --current_row
, --desired_row
)
18744 eassert (first_vpos
<= vpos
);
18745 if (desired_row
->enabled_p
)
18747 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18750 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18754 w
->window_end_vpos
= vpos
+ 1;
18755 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18756 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18757 eassert (w
->window_end_bytepos
>= 0);
18758 IF_DEBUG (debug_method_add (w
, "C"));
18763 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18764 debug_end_vpos
= w
->window_end_vpos
));
18766 /* Record that display has not been completed. */
18767 w
->window_end_valid
= false;
18768 w
->desired_matrix
->no_scrolling_p
= true;
18776 /***********************************************************************
18777 More debugging support
18778 ***********************************************************************/
18782 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18783 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18784 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18787 /* Dump the contents of glyph matrix MATRIX on stderr.
18789 GLYPHS 0 means don't show glyph contents.
18790 GLYPHS 1 means show glyphs in short form
18791 GLYPHS > 1 means show glyphs in long form. */
18794 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18797 for (i
= 0; i
< matrix
->nrows
; ++i
)
18798 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18802 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18803 the glyph row and area where the glyph comes from. */
18806 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18808 if (glyph
->type
== CHAR_GLYPH
18809 || glyph
->type
== GLYPHLESS_GLYPH
)
18812 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18813 glyph
- row
->glyphs
[TEXT_AREA
],
18814 (glyph
->type
== CHAR_GLYPH
18818 (BUFFERP (glyph
->object
)
18820 : (STRINGP (glyph
->object
)
18822 : (NILP (glyph
->object
)
18825 glyph
->pixel_width
,
18827 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18831 glyph
->left_box_line_p
,
18832 glyph
->right_box_line_p
);
18834 else if (glyph
->type
== STRETCH_GLYPH
)
18837 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18838 glyph
- row
->glyphs
[TEXT_AREA
],
18841 (BUFFERP (glyph
->object
)
18843 : (STRINGP (glyph
->object
)
18845 : (NILP (glyph
->object
)
18848 glyph
->pixel_width
,
18852 glyph
->left_box_line_p
,
18853 glyph
->right_box_line_p
);
18855 else if (glyph
->type
== IMAGE_GLYPH
)
18858 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18859 glyph
- row
->glyphs
[TEXT_AREA
],
18862 (BUFFERP (glyph
->object
)
18864 : (STRINGP (glyph
->object
)
18866 : (NILP (glyph
->object
)
18869 glyph
->pixel_width
,
18873 glyph
->left_box_line_p
,
18874 glyph
->right_box_line_p
);
18876 else if (glyph
->type
== COMPOSITE_GLYPH
)
18879 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18880 glyph
- row
->glyphs
[TEXT_AREA
],
18883 (BUFFERP (glyph
->object
)
18885 : (STRINGP (glyph
->object
)
18887 : (NILP (glyph
->object
)
18890 glyph
->pixel_width
,
18892 if (glyph
->u
.cmp
.automatic
)
18895 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18896 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18898 glyph
->left_box_line_p
,
18899 glyph
->right_box_line_p
);
18901 else if (glyph
->type
== XWIDGET_GLYPH
)
18903 #ifndef HAVE_XWIDGETS
18907 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
18908 glyph
- row
->glyphs
[TEXT_AREA
],
18911 (BUFFERP (glyph
->object
)
18913 : (STRINGP (glyph
->object
)
18916 glyph
->pixel_width
,
18920 glyph
->left_box_line_p
,
18921 glyph
->right_box_line_p
);
18927 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18928 GLYPHS 0 means don't show glyph contents.
18929 GLYPHS 1 means show glyphs in short form
18930 GLYPHS > 1 means show glyphs in long form. */
18933 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18937 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18938 fprintf (stderr
, "==============================================================================\n");
18940 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18941 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18943 MATRIX_ROW_START_CHARPOS (row
),
18944 MATRIX_ROW_END_CHARPOS (row
),
18945 row
->used
[TEXT_AREA
],
18946 row
->contains_overlapping_glyphs_p
,
18948 row
->truncated_on_left_p
,
18949 row
->truncated_on_right_p
,
18951 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18952 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18955 row
->ends_in_middle_of_char_p
,
18956 row
->starts_in_middle_of_char_p
,
18962 row
->visible_height
,
18965 /* The next 3 lines should align to "Start" in the header. */
18966 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18967 row
->end
.overlay_string_index
,
18968 row
->continuation_lines_width
);
18969 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18970 CHARPOS (row
->start
.string_pos
),
18971 CHARPOS (row
->end
.string_pos
));
18972 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18973 row
->end
.dpvec_index
);
18980 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18982 struct glyph
*glyph
= row
->glyphs
[area
];
18983 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18985 /* Glyph for a line end in text. */
18986 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18989 if (glyph
< glyph_end
)
18990 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18992 for (; glyph
< glyph_end
; ++glyph
)
18993 dump_glyph (row
, glyph
, area
);
18996 else if (glyphs
== 1)
18999 char s
[SHRT_MAX
+ 4];
19001 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19005 for (i
= 0; i
< row
->used
[area
]; ++i
)
19007 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
19008 if (i
== row
->used
[area
] - 1
19009 && area
== TEXT_AREA
19010 && NILP (glyph
->object
)
19011 && glyph
->type
== CHAR_GLYPH
19012 && glyph
->u
.ch
== ' ')
19014 strcpy (&s
[i
], "[\\n]");
19017 else if (glyph
->type
== CHAR_GLYPH
19018 && glyph
->u
.ch
< 0x80
19019 && glyph
->u
.ch
>= ' ')
19020 s
[i
] = glyph
->u
.ch
;
19026 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
19032 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
19033 Sdump_glyph_matrix
, 0, 1, "p",
19034 doc
: /* Dump the current matrix of the selected window to stderr.
19035 Shows contents of glyph row structures. With non-nil
19036 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
19037 glyphs in short form, otherwise show glyphs in long form.
19039 Interactively, no argument means show glyphs in short form;
19040 with numeric argument, its value is passed as the GLYPHS flag. */)
19041 (Lisp_Object glyphs
)
19043 struct window
*w
= XWINDOW (selected_window
);
19044 struct buffer
*buffer
= XBUFFER (w
->contents
);
19046 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
19047 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
19048 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
19049 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
19050 fprintf (stderr
, "=============================================\n");
19051 dump_glyph_matrix (w
->current_matrix
,
19052 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
19057 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
19058 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* Dump the current glyph matrix of the selected frame to stderr.
19059 Only text-mode frames have frame glyph matrices. */)
19062 struct frame
*f
= XFRAME (selected_frame
);
19064 if (f
->current_matrix
)
19065 dump_glyph_matrix (f
->current_matrix
, 1);
19067 fprintf (stderr
, "*** This frame doesn't have a frame glyph matrix ***\n");
19072 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
19073 doc
: /* Dump glyph row ROW to stderr.
19074 GLYPH 0 means don't dump glyphs.
19075 GLYPH 1 means dump glyphs in short form.
19076 GLYPH > 1 or omitted means dump glyphs in long form. */)
19077 (Lisp_Object row
, Lisp_Object glyphs
)
19079 struct glyph_matrix
*matrix
;
19082 CHECK_NUMBER (row
);
19083 matrix
= XWINDOW (selected_window
)->current_matrix
;
19085 if (vpos
>= 0 && vpos
< matrix
->nrows
)
19086 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
19088 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
19093 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
19094 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
19095 GLYPH 0 means don't dump glyphs.
19096 GLYPH 1 means dump glyphs in short form.
19097 GLYPH > 1 or omitted means dump glyphs in long form.
19099 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
19101 (Lisp_Object row
, Lisp_Object glyphs
)
19103 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19104 struct frame
*sf
= SELECTED_FRAME ();
19105 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
19108 CHECK_NUMBER (row
);
19110 if (vpos
>= 0 && vpos
< m
->nrows
)
19111 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
19112 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
19118 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
19119 doc
: /* Toggle tracing of redisplay.
19120 With ARG, turn tracing on if and only if ARG is positive. */)
19124 trace_redisplay_p
= !trace_redisplay_p
;
19127 arg
= Fprefix_numeric_value (arg
);
19128 trace_redisplay_p
= XINT (arg
) > 0;
19135 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
19136 doc
: /* Like `format', but print result to stderr.
19137 usage: (trace-to-stderr STRING &rest OBJECTS) */)
19138 (ptrdiff_t nargs
, Lisp_Object
*args
)
19140 Lisp_Object s
= Fformat (nargs
, args
);
19141 fwrite (SDATA (s
), 1, SBYTES (s
), stderr
);
19145 #endif /* GLYPH_DEBUG */
19149 /***********************************************************************
19150 Building Desired Matrix Rows
19151 ***********************************************************************/
19153 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
19154 Used for non-window-redisplay windows, and for windows w/o left fringe. */
19156 static struct glyph_row
*
19157 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
19159 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19160 struct buffer
*buffer
= XBUFFER (w
->contents
);
19161 struct buffer
*old
= current_buffer
;
19162 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
19163 ptrdiff_t arrow_len
= SCHARS (overlay_arrow_string
);
19164 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
19165 const unsigned char *p
;
19168 int n_glyphs_before
;
19170 set_buffer_temp (buffer
);
19171 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
19172 scratch_glyph_row
.reversed_p
= false;
19173 it
.glyph_row
->used
[TEXT_AREA
] = 0;
19174 SET_TEXT_POS (it
.position
, 0, 0);
19176 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
19178 while (p
< arrow_end
)
19180 Lisp_Object face
, ilisp
;
19182 /* Get the next character. */
19184 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
19187 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
19188 if (! ASCII_CHAR_P (it
.c
))
19189 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
19193 /* Get its face. */
19194 ilisp
= make_number (p
- arrow_string
);
19195 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
19196 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
19198 /* Compute its width, get its glyphs. */
19199 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
19200 SET_TEXT_POS (it
.position
, -1, -1);
19201 PRODUCE_GLYPHS (&it
);
19203 /* If this character doesn't fit any more in the line, we have
19204 to remove some glyphs. */
19205 if (it
.current_x
> it
.last_visible_x
)
19207 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19212 set_buffer_temp (old
);
19213 return it
.glyph_row
;
19217 /* Insert truncation glyphs at the start of IT->glyph_row. Which
19218 glyphs to insert is determined by produce_special_glyphs. */
19221 insert_left_trunc_glyphs (struct it
*it
)
19223 struct it truncate_it
;
19224 struct glyph
*from
, *end
, *to
, *toend
;
19226 eassert (!FRAME_WINDOW_P (it
->f
)
19227 || (!it
->glyph_row
->reversed_p
19228 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19229 || (it
->glyph_row
->reversed_p
19230 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
19232 /* Get the truncation glyphs. */
19234 truncate_it
.current_x
= 0;
19235 truncate_it
.face_id
= DEFAULT_FACE_ID
;
19236 truncate_it
.glyph_row
= &scratch_glyph_row
;
19237 truncate_it
.area
= TEXT_AREA
;
19238 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
19239 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
19240 truncate_it
.object
= Qnil
;
19241 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
19243 /* Overwrite glyphs from IT with truncation glyphs. */
19244 if (!it
->glyph_row
->reversed_p
)
19246 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19248 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19249 end
= from
+ tused
;
19250 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19251 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
19252 if (FRAME_WINDOW_P (it
->f
))
19254 /* On GUI frames, when variable-size fonts are displayed,
19255 the truncation glyphs may need more pixels than the row's
19256 glyphs they overwrite. We overwrite more glyphs to free
19257 enough screen real estate, and enlarge the stretch glyph
19258 on the right (see display_line), if there is one, to
19259 preserve the screen position of the truncation glyphs on
19262 struct glyph
*g
= to
;
19265 /* The first glyph could be partially visible, in which case
19266 it->glyph_row->x will be negative. But we want the left
19267 truncation glyphs to be aligned at the left margin of the
19268 window, so we override the x coordinate at which the row
19270 it
->glyph_row
->x
= 0;
19271 while (g
< toend
&& w
< it
->truncation_pixel_width
)
19273 w
+= g
->pixel_width
;
19276 if (g
- to
- tused
> 0)
19278 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
19279 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
19281 used
= it
->glyph_row
->used
[TEXT_AREA
];
19282 if (it
->glyph_row
->truncated_on_right_p
19283 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
19284 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
19287 int extra
= w
- it
->truncation_pixel_width
;
19289 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
19296 /* There may be padding glyphs left over. Overwrite them too. */
19297 if (!FRAME_WINDOW_P (it
->f
))
19299 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
19301 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19308 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
19312 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19314 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19315 that back to front. */
19316 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19317 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19318 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19319 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19320 if (FRAME_WINDOW_P (it
->f
))
19323 struct glyph
*g
= to
;
19325 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19327 w
+= g
->pixel_width
;
19330 if (to
- g
- tused
> 0)
19332 if (it
->glyph_row
->truncated_on_right_p
19333 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19334 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19336 int extra
= w
- it
->truncation_pixel_width
;
19338 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19342 while (from
>= end
&& to
>= toend
)
19344 if (!FRAME_WINDOW_P (it
->f
))
19346 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19349 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19350 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19351 while (from
>= end
&& to
>= toend
)
19357 /* Need to free some room before prepending additional
19359 int move_by
= from
- end
+ 1;
19360 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19361 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19363 for ( ; g
>= g0
; g
--)
19365 while (from
>= end
)
19367 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19372 /* Compute the hash code for ROW. */
19374 row_hash (struct glyph_row
*row
)
19377 unsigned hashval
= 0;
19379 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19380 for (k
= 0; k
< row
->used
[area
]; ++k
)
19381 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19382 + row
->glyphs
[area
][k
].u
.val
19383 + row
->glyphs
[area
][k
].face_id
19384 + row
->glyphs
[area
][k
].padding_p
19385 + (row
->glyphs
[area
][k
].type
<< 2));
19390 /* Compute the pixel height and width of IT->glyph_row.
19392 Most of the time, ascent and height of a display line will be equal
19393 to the max_ascent and max_height values of the display iterator
19394 structure. This is not the case if
19396 1. We hit ZV without displaying anything. In this case, max_ascent
19397 and max_height will be zero.
19399 2. We have some glyphs that don't contribute to the line height.
19400 (The glyph row flag contributes_to_line_height_p is for future
19401 pixmap extensions).
19403 The first case is easily covered by using default values because in
19404 these cases, the line height does not really matter, except that it
19405 must not be zero. */
19408 compute_line_metrics (struct it
*it
)
19410 struct glyph_row
*row
= it
->glyph_row
;
19412 if (FRAME_WINDOW_P (it
->f
))
19414 int i
, min_y
, max_y
;
19416 /* The line may consist of one space only, that was added to
19417 place the cursor on it. If so, the row's height hasn't been
19419 if (row
->height
== 0)
19421 if (it
->max_ascent
+ it
->max_descent
== 0)
19422 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19423 row
->ascent
= it
->max_ascent
;
19424 row
->height
= it
->max_ascent
+ it
->max_descent
;
19425 row
->phys_ascent
= it
->max_phys_ascent
;
19426 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19427 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19430 /* Compute the width of this line. */
19431 row
->pixel_width
= row
->x
;
19432 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19433 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19435 eassert (row
->pixel_width
>= 0);
19436 eassert (row
->ascent
>= 0 && row
->height
> 0);
19438 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19439 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19441 /* If first line's physical ascent is larger than its logical
19442 ascent, use the physical ascent, and make the row taller.
19443 This makes accented characters fully visible. */
19444 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19445 && row
->phys_ascent
> row
->ascent
)
19447 row
->height
+= row
->phys_ascent
- row
->ascent
;
19448 row
->ascent
= row
->phys_ascent
;
19451 /* Compute how much of the line is visible. */
19452 row
->visible_height
= row
->height
;
19454 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19455 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19457 if (row
->y
< min_y
)
19458 row
->visible_height
-= min_y
- row
->y
;
19459 if (row
->y
+ row
->height
> max_y
)
19460 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19464 row
->pixel_width
= row
->used
[TEXT_AREA
];
19465 if (row
->continued_p
)
19466 row
->pixel_width
-= it
->continuation_pixel_width
;
19467 else if (row
->truncated_on_right_p
)
19468 row
->pixel_width
-= it
->truncation_pixel_width
;
19469 row
->ascent
= row
->phys_ascent
= 0;
19470 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19471 row
->extra_line_spacing
= 0;
19474 /* Compute a hash code for this row. */
19475 row
->hash
= row_hash (row
);
19477 it
->max_ascent
= it
->max_descent
= 0;
19478 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19482 /* Append one space to the glyph row of iterator IT if doing a
19483 window-based redisplay. The space has the same face as
19484 IT->face_id. Value is true if a space was added.
19486 This function is called to make sure that there is always one glyph
19487 at the end of a glyph row that the cursor can be set on under
19488 window-systems. (If there weren't such a glyph we would not know
19489 how wide and tall a box cursor should be displayed).
19491 At the same time this space let's a nicely handle clearing to the
19492 end of the line if the row ends in italic text. */
19495 append_space_for_newline (struct it
*it
, bool default_face_p
)
19497 if (FRAME_WINDOW_P (it
->f
))
19499 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19501 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19502 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19504 /* Save some values that must not be changed.
19505 Must save IT->c and IT->len because otherwise
19506 ITERATOR_AT_END_P wouldn't work anymore after
19507 append_space_for_newline has been called. */
19508 enum display_element_type saved_what
= it
->what
;
19509 int saved_c
= it
->c
, saved_len
= it
->len
;
19510 int saved_char_to_display
= it
->char_to_display
;
19511 int saved_x
= it
->current_x
;
19512 int saved_face_id
= it
->face_id
;
19513 bool saved_box_end
= it
->end_of_box_run_p
;
19514 struct text_pos saved_pos
;
19515 Lisp_Object saved_object
;
19518 saved_object
= it
->object
;
19519 saved_pos
= it
->position
;
19521 it
->what
= IT_CHARACTER
;
19522 memset (&it
->position
, 0, sizeof it
->position
);
19524 it
->c
= it
->char_to_display
= ' ';
19527 /* If the default face was remapped, be sure to use the
19528 remapped face for the appended newline. */
19529 if (default_face_p
)
19530 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19531 else if (it
->face_before_selective_p
)
19532 it
->face_id
= it
->saved_face_id
;
19533 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19534 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19535 /* In R2L rows, we will prepend a stretch glyph that will
19536 have the end_of_box_run_p flag set for it, so there's no
19537 need for the appended newline glyph to have that flag
19539 if (it
->glyph_row
->reversed_p
19540 /* But if the appended newline glyph goes all the way to
19541 the end of the row, there will be no stretch glyph,
19542 so leave the box flag set. */
19543 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19544 it
->end_of_box_run_p
= false;
19546 PRODUCE_GLYPHS (it
);
19548 #ifdef HAVE_WINDOW_SYSTEM
19549 /* Make sure this space glyph has the right ascent and
19550 descent values, or else cursor at end of line will look
19551 funny, and height of empty lines will be incorrect. */
19552 struct glyph
*g
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19553 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
19556 Lisp_Object height
, total_height
;
19557 int extra_line_spacing
= it
->extra_line_spacing
;
19558 int boff
= font
->baseline_offset
;
19560 if (font
->vertical_centering
)
19561 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
19563 it
->object
= saved_object
; /* get_it_property needs this */
19564 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
19565 /* Must do a subset of line height processing from
19566 x_produce_glyph for newline characters. */
19567 height
= get_it_property (it
, Qline_height
);
19569 && CONSP (XCDR (height
))
19570 && NILP (XCDR (XCDR (height
))))
19572 total_height
= XCAR (XCDR (height
));
19573 height
= XCAR (height
);
19576 total_height
= Qnil
;
19577 height
= calc_line_height_property (it
, height
, font
, boff
, true);
19579 if (it
->override_ascent
>= 0)
19581 it
->ascent
= it
->override_ascent
;
19582 it
->descent
= it
->override_descent
;
19583 boff
= it
->override_boff
;
19585 if (EQ (height
, Qt
))
19586 extra_line_spacing
= 0;
19589 Lisp_Object spacing
;
19591 it
->phys_ascent
= it
->ascent
;
19592 it
->phys_descent
= it
->descent
;
19594 && XINT (height
) > it
->ascent
+ it
->descent
)
19595 it
->ascent
= XINT (height
) - it
->descent
;
19597 if (!NILP (total_height
))
19598 spacing
= calc_line_height_property (it
, total_height
, font
,
19602 spacing
= get_it_property (it
, Qline_spacing
);
19603 spacing
= calc_line_height_property (it
, spacing
, font
,
19606 if (INTEGERP (spacing
))
19608 extra_line_spacing
= XINT (spacing
);
19609 if (!NILP (total_height
))
19610 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
19613 if (extra_line_spacing
> 0)
19615 it
->descent
+= extra_line_spacing
;
19616 if (extra_line_spacing
> it
->max_extra_line_spacing
)
19617 it
->max_extra_line_spacing
= extra_line_spacing
;
19619 it
->max_ascent
= it
->ascent
;
19620 it
->max_descent
= it
->descent
;
19621 /* Make sure compute_line_metrics recomputes the row height. */
19622 it
->glyph_row
->height
= 0;
19625 g
->ascent
= it
->max_ascent
;
19626 g
->descent
= it
->max_descent
;
19629 it
->override_ascent
= -1;
19630 it
->constrain_row_ascent_descent_p
= false;
19631 it
->current_x
= saved_x
;
19632 it
->object
= saved_object
;
19633 it
->position
= saved_pos
;
19634 it
->what
= saved_what
;
19635 it
->face_id
= saved_face_id
;
19636 it
->len
= saved_len
;
19638 it
->char_to_display
= saved_char_to_display
;
19639 it
->end_of_box_run_p
= saved_box_end
;
19648 /* Extend the face of the last glyph in the text area of IT->glyph_row
19649 to the end of the display line. Called from display_line. If the
19650 glyph row is empty, add a space glyph to it so that we know the
19651 face to draw. Set the glyph row flag fill_line_p. If the glyph
19652 row is R2L, prepend a stretch glyph to cover the empty space to the
19653 left of the leftmost glyph. */
19656 extend_face_to_end_of_line (struct it
*it
)
19658 struct face
*face
, *default_face
;
19659 struct frame
*f
= it
->f
;
19661 /* If line is already filled, do nothing. Non window-system frames
19662 get a grace of one more ``pixel'' because their characters are
19663 1-``pixel'' wide, so they hit the equality too early. This grace
19664 is needed only for R2L rows that are not continued, to produce
19665 one extra blank where we could display the cursor. */
19666 if ((it
->current_x
>= it
->last_visible_x
19667 + (!FRAME_WINDOW_P (f
)
19668 && it
->glyph_row
->reversed_p
19669 && !it
->glyph_row
->continued_p
))
19670 /* If the window has display margins, we will need to extend
19671 their face even if the text area is filled. */
19672 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19673 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19676 /* The default face, possibly remapped. */
19677 default_face
= FACE_OPT_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19679 /* Face extension extends the background and box of IT->face_id
19680 to the end of the line. If the background equals the background
19681 of the frame, we don't have to do anything. */
19682 face
= FACE_OPT_FROM_ID (f
, (it
->face_before_selective_p
19683 ? it
->saved_face_id
19686 if (FRAME_WINDOW_P (f
)
19687 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19688 && face
->box
== FACE_NO_BOX
19689 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19690 #ifdef HAVE_WINDOW_SYSTEM
19693 && !it
->glyph_row
->reversed_p
)
19696 /* Set the glyph row flag indicating that the face of the last glyph
19697 in the text area has to be drawn to the end of the text area. */
19698 it
->glyph_row
->fill_line_p
= true;
19700 /* If current character of IT is not ASCII, make sure we have the
19701 ASCII face. This will be automatically undone the next time
19702 get_next_display_element returns a multibyte character. Note
19703 that the character will always be single byte in unibyte
19705 if (!ASCII_CHAR_P (it
->c
))
19707 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19710 if (FRAME_WINDOW_P (f
))
19712 /* If the row is empty, add a space with the current face of IT,
19713 so that we know which face to draw. */
19714 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19716 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19717 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19718 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19720 /* Mode line and the header line don't have margins, and
19721 likewise the frame's tool-bar window, if there is any. */
19722 if (!(it
->glyph_row
->mode_line_p
19723 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19724 || (WINDOWP (f
->tool_bar_window
)
19725 && it
->w
== XWINDOW (f
->tool_bar_window
))
19729 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19730 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19732 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19733 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19735 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19737 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19738 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19740 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19741 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19743 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19746 #ifdef HAVE_WINDOW_SYSTEM
19747 if (it
->glyph_row
->reversed_p
)
19749 /* Prepend a stretch glyph to the row, such that the
19750 rightmost glyph will be drawn flushed all the way to the
19751 right margin of the window. The stretch glyph that will
19752 occupy the empty space, if any, to the left of the
19754 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19755 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19756 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19758 int row_width
, stretch_ascent
, stretch_width
;
19759 struct text_pos saved_pos
;
19761 bool saved_avoid_cursor
, saved_box_start
;
19763 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19764 row_width
+= g
->pixel_width
;
19766 /* FIXME: There are various minor display glitches in R2L
19767 rows when only one of the fringes is missing. The
19768 strange condition below produces the least bad effect. */
19769 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19770 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19771 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19772 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19774 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19775 stretch_width
-= row_width
;
19777 if (stretch_width
> 0)
19780 (((it
->ascent
+ it
->descent
)
19781 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19782 saved_pos
= it
->position
;
19783 memset (&it
->position
, 0, sizeof it
->position
);
19784 saved_avoid_cursor
= it
->avoid_cursor_p
;
19785 it
->avoid_cursor_p
= true;
19786 saved_face_id
= it
->face_id
;
19787 saved_box_start
= it
->start_of_box_run_p
;
19788 /* The last row's stretch glyph should get the default
19789 face, to avoid painting the rest of the window with
19790 the region face, if the region ends at ZV. */
19791 if (it
->glyph_row
->ends_at_zv_p
)
19792 it
->face_id
= default_face
->id
;
19794 it
->face_id
= face
->id
;
19795 it
->start_of_box_run_p
= false;
19796 append_stretch_glyph (it
, Qnil
, stretch_width
,
19797 it
->ascent
+ it
->descent
, stretch_ascent
);
19798 it
->position
= saved_pos
;
19799 it
->avoid_cursor_p
= saved_avoid_cursor
;
19800 it
->face_id
= saved_face_id
;
19801 it
->start_of_box_run_p
= saved_box_start
;
19803 /* If stretch_width comes out negative, it means that the
19804 last glyph is only partially visible. In R2L rows, we
19805 want the leftmost glyph to be partially visible, so we
19806 need to give the row the corresponding left offset. */
19807 if (stretch_width
< 0)
19808 it
->glyph_row
->x
= stretch_width
;
19810 #endif /* HAVE_WINDOW_SYSTEM */
19814 /* Save some values that must not be changed. */
19815 int saved_x
= it
->current_x
;
19816 struct text_pos saved_pos
;
19817 Lisp_Object saved_object
;
19818 enum display_element_type saved_what
= it
->what
;
19819 int saved_face_id
= it
->face_id
;
19821 saved_object
= it
->object
;
19822 saved_pos
= it
->position
;
19824 it
->what
= IT_CHARACTER
;
19825 memset (&it
->position
, 0, sizeof it
->position
);
19827 it
->c
= it
->char_to_display
= ' ';
19830 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19831 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19832 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19833 && !it
->glyph_row
->mode_line_p
19834 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19836 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19837 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19839 for (it
->current_x
= 0; g
< e
; g
++)
19840 it
->current_x
+= g
->pixel_width
;
19842 it
->area
= LEFT_MARGIN_AREA
;
19843 it
->face_id
= default_face
->id
;
19844 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19845 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19847 PRODUCE_GLYPHS (it
);
19848 /* term.c:produce_glyphs advances it->current_x only for
19850 it
->current_x
+= it
->pixel_width
;
19853 it
->current_x
= saved_x
;
19854 it
->area
= TEXT_AREA
;
19857 /* The last row's blank glyphs should get the default face, to
19858 avoid painting the rest of the window with the region face,
19859 if the region ends at ZV. */
19860 if (it
->glyph_row
->ends_at_zv_p
)
19861 it
->face_id
= default_face
->id
;
19863 it
->face_id
= face
->id
;
19864 PRODUCE_GLYPHS (it
);
19866 while (it
->current_x
<= it
->last_visible_x
)
19867 PRODUCE_GLYPHS (it
);
19869 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19870 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19871 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19872 && !it
->glyph_row
->mode_line_p
19873 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19875 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19876 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19878 for ( ; g
< e
; g
++)
19879 it
->current_x
+= g
->pixel_width
;
19881 it
->area
= RIGHT_MARGIN_AREA
;
19882 it
->face_id
= default_face
->id
;
19883 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19884 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19886 PRODUCE_GLYPHS (it
);
19887 it
->current_x
+= it
->pixel_width
;
19890 it
->area
= TEXT_AREA
;
19893 /* Don't count these blanks really. It would let us insert a left
19894 truncation glyph below and make us set the cursor on them, maybe. */
19895 it
->current_x
= saved_x
;
19896 it
->object
= saved_object
;
19897 it
->position
= saved_pos
;
19898 it
->what
= saved_what
;
19899 it
->face_id
= saved_face_id
;
19904 /* Value is true if text starting at CHARPOS in current_buffer is
19905 trailing whitespace. */
19908 trailing_whitespace_p (ptrdiff_t charpos
)
19910 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19913 while (bytepos
< ZV_BYTE
19914 && (c
= FETCH_CHAR (bytepos
),
19915 c
== ' ' || c
== '\t'))
19918 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19920 if (bytepos
!= PT_BYTE
)
19927 /* Highlight trailing whitespace, if any, in ROW. */
19930 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19932 int used
= row
->used
[TEXT_AREA
];
19936 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19937 struct glyph
*glyph
= start
+ used
- 1;
19939 if (row
->reversed_p
)
19941 /* Right-to-left rows need to be processed in the opposite
19942 direction, so swap the edge pointers. */
19944 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19947 /* Skip over glyphs inserted to display the cursor at the
19948 end of a line, for extending the face of the last glyph
19949 to the end of the line on terminals, and for truncation
19950 and continuation glyphs. */
19951 if (!row
->reversed_p
)
19953 while (glyph
>= start
19954 && glyph
->type
== CHAR_GLYPH
19955 && NILP (glyph
->object
))
19960 while (glyph
<= start
19961 && glyph
->type
== CHAR_GLYPH
19962 && NILP (glyph
->object
))
19966 /* If last glyph is a space or stretch, and it's trailing
19967 whitespace, set the face of all trailing whitespace glyphs in
19968 IT->glyph_row to `trailing-whitespace'. */
19969 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19970 && BUFFERP (glyph
->object
)
19971 && (glyph
->type
== STRETCH_GLYPH
19972 || (glyph
->type
== CHAR_GLYPH
19973 && glyph
->u
.ch
== ' '))
19974 && trailing_whitespace_p (glyph
->charpos
))
19976 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, false);
19980 if (!row
->reversed_p
)
19982 while (glyph
>= start
19983 && BUFFERP (glyph
->object
)
19984 && (glyph
->type
== STRETCH_GLYPH
19985 || (glyph
->type
== CHAR_GLYPH
19986 && glyph
->u
.ch
== ' ')))
19987 (glyph
--)->face_id
= face_id
;
19991 while (glyph
<= start
19992 && BUFFERP (glyph
->object
)
19993 && (glyph
->type
== STRETCH_GLYPH
19994 || (glyph
->type
== CHAR_GLYPH
19995 && glyph
->u
.ch
== ' ')))
19996 (glyph
++)->face_id
= face_id
;
20003 /* Value is true if glyph row ROW should be
20004 considered to hold the buffer position CHARPOS. */
20007 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
20009 bool result
= true;
20011 if (charpos
== CHARPOS (row
->end
.pos
)
20012 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
20014 /* Suppose the row ends on a string.
20015 Unless the row is continued, that means it ends on a newline
20016 in the string. If it's anything other than a display string
20017 (e.g., a before-string from an overlay), we don't want the
20018 cursor there. (This heuristic seems to give the optimal
20019 behavior for the various types of multi-line strings.)
20020 One exception: if the string has `cursor' property on one of
20021 its characters, we _do_ want the cursor there. */
20022 if (CHARPOS (row
->end
.string_pos
) >= 0)
20024 if (row
->continued_p
)
20028 /* Check for `display' property. */
20029 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
20030 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
20031 struct glyph
*glyph
;
20034 for (glyph
= end
; glyph
>= beg
; --glyph
)
20035 if (STRINGP (glyph
->object
))
20038 = Fget_char_property (make_number (charpos
),
20042 && display_prop_string_p (prop
, glyph
->object
));
20043 /* If there's a `cursor' property on one of the
20044 string's characters, this row is a cursor row,
20045 even though this is not a display string. */
20048 Lisp_Object s
= glyph
->object
;
20050 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
20052 ptrdiff_t gpos
= glyph
->charpos
;
20054 if (!NILP (Fget_char_property (make_number (gpos
),
20066 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
20068 /* If the row ends in middle of a real character,
20069 and the line is continued, we want the cursor here.
20070 That's because CHARPOS (ROW->end.pos) would equal
20071 PT if PT is before the character. */
20072 if (!row
->ends_in_ellipsis_p
)
20073 result
= row
->continued_p
;
20075 /* If the row ends in an ellipsis, then
20076 CHARPOS (ROW->end.pos) will equal point after the
20077 invisible text. We want that position to be displayed
20078 after the ellipsis. */
20081 /* If the row ends at ZV, display the cursor at the end of that
20082 row instead of at the start of the row below. */
20084 result
= row
->ends_at_zv_p
;
20090 /* Value is true if glyph row ROW should be
20091 used to hold the cursor. */
20094 cursor_row_p (struct glyph_row
*row
)
20096 return row_for_charpos_p (row
, PT
);
20101 /* Push the property PROP so that it will be rendered at the current
20102 position in IT. Return true if PROP was successfully pushed, false
20103 otherwise. Called from handle_line_prefix to handle the
20104 `line-prefix' and `wrap-prefix' properties. */
20107 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
20109 struct text_pos pos
=
20110 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
20112 eassert (it
->method
== GET_FROM_BUFFER
20113 || it
->method
== GET_FROM_DISPLAY_VECTOR
20114 || it
->method
== GET_FROM_STRING
20115 || it
->method
== GET_FROM_IMAGE
);
20117 /* We need to save the current buffer/string position, so it will be
20118 restored by pop_it, because iterate_out_of_display_property
20119 depends on that being set correctly, but some situations leave
20120 it->position not yet set when this function is called. */
20121 push_it (it
, &pos
);
20123 if (STRINGP (prop
))
20125 if (SCHARS (prop
) == 0)
20132 it
->string_from_prefix_prop_p
= true;
20133 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
20134 it
->current
.overlay_string_index
= -1;
20135 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
20136 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
20137 it
->method
= GET_FROM_STRING
;
20138 it
->stop_charpos
= 0;
20140 it
->base_level_stop
= 0;
20142 /* Force paragraph direction to be that of the parent
20144 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
20145 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
20147 it
->paragraph_embedding
= L2R
;
20149 /* Set up the bidi iterator for this display string. */
20152 it
->bidi_it
.string
.lstring
= it
->string
;
20153 it
->bidi_it
.string
.s
= NULL
;
20154 it
->bidi_it
.string
.schars
= it
->end_charpos
;
20155 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
20156 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
20157 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
20158 it
->bidi_it
.w
= it
->w
;
20159 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
20162 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
20164 it
->method
= GET_FROM_STRETCH
;
20167 #ifdef HAVE_WINDOW_SYSTEM
20168 else if (IMAGEP (prop
))
20170 it
->what
= IT_IMAGE
;
20171 it
->image_id
= lookup_image (it
->f
, prop
);
20172 it
->method
= GET_FROM_IMAGE
;
20174 #endif /* HAVE_WINDOW_SYSTEM */
20177 pop_it (it
); /* bogus display property, give up */
20184 /* Return the character-property PROP at the current position in IT. */
20187 get_it_property (struct it
*it
, Lisp_Object prop
)
20189 Lisp_Object position
, object
= it
->object
;
20191 if (STRINGP (object
))
20192 position
= make_number (IT_STRING_CHARPOS (*it
));
20193 else if (BUFFERP (object
))
20195 position
= make_number (IT_CHARPOS (*it
));
20196 object
= it
->window
;
20201 return Fget_char_property (position
, prop
, object
);
20204 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
20207 handle_line_prefix (struct it
*it
)
20209 Lisp_Object prefix
;
20211 if (it
->continuation_lines_width
> 0)
20213 prefix
= get_it_property (it
, Qwrap_prefix
);
20215 prefix
= Vwrap_prefix
;
20219 prefix
= get_it_property (it
, Qline_prefix
);
20221 prefix
= Vline_prefix
;
20223 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
20225 /* If the prefix is wider than the window, and we try to wrap
20226 it, it would acquire its own wrap prefix, and so on till the
20227 iterator stack overflows. So, don't wrap the prefix. */
20228 it
->line_wrap
= TRUNCATE
;
20229 it
->avoid_cursor_p
= true;
20235 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
20236 only for R2L lines from display_line and display_string, when they
20237 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
20238 the line/string needs to be continued on the next glyph row. */
20240 unproduce_glyphs (struct it
*it
, int n
)
20242 struct glyph
*glyph
, *end
;
20244 eassert (it
->glyph_row
);
20245 eassert (it
->glyph_row
->reversed_p
);
20246 eassert (it
->area
== TEXT_AREA
);
20247 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
20249 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
20250 n
= it
->glyph_row
->used
[TEXT_AREA
];
20251 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
20252 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
20253 for ( ; glyph
< end
; glyph
++)
20254 glyph
[-n
] = *glyph
;
20257 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
20258 and ROW->maxpos. */
20260 find_row_edges (struct it
*it
, struct glyph_row
*row
,
20261 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
20262 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
20264 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20265 lines' rows is implemented for bidi-reordered rows. */
20267 /* ROW->minpos is the value of min_pos, the minimal buffer position
20268 we have in ROW, or ROW->start.pos if that is smaller. */
20269 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
20270 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
20272 /* We didn't find buffer positions smaller than ROW->start, or
20273 didn't find _any_ valid buffer positions in any of the glyphs,
20274 so we must trust the iterator's computed positions. */
20275 row
->minpos
= row
->start
.pos
;
20278 max_pos
= CHARPOS (it
->current
.pos
);
20279 max_bpos
= BYTEPOS (it
->current
.pos
);
20282 /* Here are the various use-cases for ending the row, and the
20283 corresponding values for ROW->maxpos:
20285 Line ends in a newline from buffer eol_pos + 1
20286 Line is continued from buffer max_pos + 1
20287 Line is truncated on right it->current.pos
20288 Line ends in a newline from string max_pos + 1(*)
20289 (*) + 1 only when line ends in a forward scan
20290 Line is continued from string max_pos
20291 Line is continued from display vector max_pos
20292 Line is entirely from a string min_pos == max_pos
20293 Line is entirely from a display vector min_pos == max_pos
20294 Line that ends at ZV ZV
20296 If you discover other use-cases, please add them here as
20298 if (row
->ends_at_zv_p
)
20299 row
->maxpos
= it
->current
.pos
;
20300 else if (row
->used
[TEXT_AREA
])
20302 bool seen_this_string
= false;
20303 struct glyph_row
*r1
= row
- 1;
20305 /* Did we see the same display string on the previous row? */
20306 if (STRINGP (it
->object
)
20307 /* this is not the first row */
20308 && row
> it
->w
->desired_matrix
->rows
20309 /* previous row is not the header line */
20310 && !r1
->mode_line_p
20311 /* previous row also ends in a newline from a string */
20312 && r1
->ends_in_newline_from_string_p
)
20314 struct glyph
*start
, *end
;
20316 /* Search for the last glyph of the previous row that came
20317 from buffer or string. Depending on whether the row is
20318 L2R or R2L, we need to process it front to back or the
20319 other way round. */
20320 if (!r1
->reversed_p
)
20322 start
= r1
->glyphs
[TEXT_AREA
];
20323 end
= start
+ r1
->used
[TEXT_AREA
];
20324 /* Glyphs inserted by redisplay have nil as their object. */
20326 && NILP ((end
- 1)->object
)
20327 && (end
- 1)->charpos
<= 0)
20331 if (EQ ((end
- 1)->object
, it
->object
))
20332 seen_this_string
= true;
20335 /* If all the glyphs of the previous row were inserted
20336 by redisplay, it means the previous row was
20337 produced from a single newline, which is only
20338 possible if that newline came from the same string
20339 as the one which produced this ROW. */
20340 seen_this_string
= true;
20344 end
= r1
->glyphs
[TEXT_AREA
] - 1;
20345 start
= end
+ r1
->used
[TEXT_AREA
];
20347 && NILP ((end
+ 1)->object
)
20348 && (end
+ 1)->charpos
<= 0)
20352 if (EQ ((end
+ 1)->object
, it
->object
))
20353 seen_this_string
= true;
20356 seen_this_string
= true;
20359 /* Take note of each display string that covers a newline only
20360 once, the first time we see it. This is for when a display
20361 string includes more than one newline in it. */
20362 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
20364 /* If we were scanning the buffer forward when we displayed
20365 the string, we want to account for at least one buffer
20366 position that belongs to this row (position covered by
20367 the display string), so that cursor positioning will
20368 consider this row as a candidate when point is at the end
20369 of the visual line represented by this row. This is not
20370 required when scanning back, because max_pos will already
20371 have a much larger value. */
20372 if (CHARPOS (row
->end
.pos
) > max_pos
)
20373 INC_BOTH (max_pos
, max_bpos
);
20374 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20376 else if (CHARPOS (it
->eol_pos
) > 0)
20377 SET_TEXT_POS (row
->maxpos
,
20378 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
20379 else if (row
->continued_p
)
20381 /* If max_pos is different from IT's current position, it
20382 means IT->method does not belong to the display element
20383 at max_pos. However, it also means that the display
20384 element at max_pos was displayed in its entirety on this
20385 line, which is equivalent to saying that the next line
20386 starts at the next buffer position. */
20387 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
20388 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20391 INC_BOTH (max_pos
, max_bpos
);
20392 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20395 else if (row
->truncated_on_right_p
)
20396 /* display_line already called reseat_at_next_visible_line_start,
20397 which puts the iterator at the beginning of the next line, in
20398 the logical order. */
20399 row
->maxpos
= it
->current
.pos
;
20400 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20401 /* A line that is entirely from a string/image/stretch... */
20402 row
->maxpos
= row
->minpos
;
20407 row
->maxpos
= it
->current
.pos
;
20410 /* Construct the glyph row IT->glyph_row in the desired matrix of
20411 IT->w from text at the current position of IT. See dispextern.h
20412 for an overview of struct it. Value is true if
20413 IT->glyph_row displays text, as opposed to a line displaying ZV
20417 display_line (struct it
*it
)
20419 struct glyph_row
*row
= it
->glyph_row
;
20420 Lisp_Object overlay_arrow_string
;
20422 void *wrap_data
= NULL
;
20423 bool may_wrap
= false;
20425 int wrap_row_used
= -1;
20426 int wrap_row_ascent UNINIT
, wrap_row_height UNINIT
;
20427 int wrap_row_phys_ascent UNINIT
, wrap_row_phys_height UNINIT
;
20428 int wrap_row_extra_line_spacing UNINIT
;
20429 ptrdiff_t wrap_row_min_pos UNINIT
, wrap_row_min_bpos UNINIT
;
20430 ptrdiff_t wrap_row_max_pos UNINIT
, wrap_row_max_bpos UNINIT
;
20432 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20433 ptrdiff_t min_bpos UNINIT
, max_bpos UNINIT
;
20434 bool pending_handle_line_prefix
= false;
20436 /* We always start displaying at hpos zero even if hscrolled. */
20437 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20439 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20440 >= it
->w
->desired_matrix
->nrows
)
20442 it
->w
->nrows_scale_factor
++;
20443 it
->f
->fonts_changed
= true;
20447 /* Clear the result glyph row and enable it. */
20448 prepare_desired_row (it
->w
, row
, false);
20450 row
->y
= it
->current_y
;
20451 row
->start
= it
->start
;
20452 row
->continuation_lines_width
= it
->continuation_lines_width
;
20453 row
->displays_text_p
= true;
20454 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20455 it
->starts_in_middle_of_char_p
= false;
20457 /* Arrange the overlays nicely for our purposes. Usually, we call
20458 display_line on only one line at a time, in which case this
20459 can't really hurt too much, or we call it on lines which appear
20460 one after another in the buffer, in which case all calls to
20461 recenter_overlay_lists but the first will be pretty cheap. */
20462 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20464 /* Move over display elements that are not visible because we are
20465 hscrolled. This may stop at an x-position < IT->first_visible_x
20466 if the first glyph is partially visible or if we hit a line end. */
20467 if (it
->current_x
< it
->first_visible_x
)
20469 enum move_it_result move_result
;
20471 this_line_min_pos
= row
->start
.pos
;
20472 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20473 MOVE_TO_POS
| MOVE_TO_X
);
20474 /* If we are under a large hscroll, move_it_in_display_line_to
20475 could hit the end of the line without reaching
20476 it->first_visible_x. Pretend that we did reach it. This is
20477 especially important on a TTY, where we will call
20478 extend_face_to_end_of_line, which needs to know how many
20479 blank glyphs to produce. */
20480 if (it
->current_x
< it
->first_visible_x
20481 && (move_result
== MOVE_NEWLINE_OR_CR
20482 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20483 it
->current_x
= it
->first_visible_x
;
20485 /* Record the smallest positions seen while we moved over
20486 display elements that are not visible. This is needed by
20487 redisplay_internal for optimizing the case where the cursor
20488 stays inside the same line. The rest of this function only
20489 considers positions that are actually displayed, so
20490 RECORD_MAX_MIN_POS will not otherwise record positions that
20491 are hscrolled to the left of the left edge of the window. */
20492 min_pos
= CHARPOS (this_line_min_pos
);
20493 min_bpos
= BYTEPOS (this_line_min_pos
);
20495 else if (it
->area
== TEXT_AREA
)
20497 /* We only do this when not calling move_it_in_display_line_to
20498 above, because that function calls itself handle_line_prefix. */
20499 handle_line_prefix (it
);
20503 /* Line-prefix and wrap-prefix are always displayed in the text
20504 area. But if this is the first call to display_line after
20505 init_iterator, the iterator might have been set up to write
20506 into a marginal area, e.g. if the line begins with some
20507 display property that writes to the margins. So we need to
20508 wait with the call to handle_line_prefix until whatever
20509 writes to the margin has done its job. */
20510 pending_handle_line_prefix
= true;
20513 /* Get the initial row height. This is either the height of the
20514 text hscrolled, if there is any, or zero. */
20515 row
->ascent
= it
->max_ascent
;
20516 row
->height
= it
->max_ascent
+ it
->max_descent
;
20517 row
->phys_ascent
= it
->max_phys_ascent
;
20518 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20519 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20521 /* Utility macro to record max and min buffer positions seen until now. */
20522 #define RECORD_MAX_MIN_POS(IT) \
20525 bool composition_p \
20526 = !STRINGP ((IT)->string) && ((IT)->what == IT_COMPOSITION); \
20527 ptrdiff_t current_pos = \
20528 composition_p ? (IT)->cmp_it.charpos \
20529 : IT_CHARPOS (*(IT)); \
20530 ptrdiff_t current_bpos = \
20531 composition_p ? CHAR_TO_BYTE (current_pos) \
20532 : IT_BYTEPOS (*(IT)); \
20533 if (current_pos < min_pos) \
20535 min_pos = current_pos; \
20536 min_bpos = current_bpos; \
20538 if (IT_CHARPOS (*it) > max_pos) \
20540 max_pos = IT_CHARPOS (*it); \
20541 max_bpos = IT_BYTEPOS (*it); \
20546 /* Loop generating characters. The loop is left with IT on the next
20547 character to display. */
20550 int n_glyphs_before
, hpos_before
, x_before
;
20552 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20554 /* Retrieve the next thing to display. Value is false if end of
20556 if (!get_next_display_element (it
))
20558 /* Maybe add a space at the end of this line that is used to
20559 display the cursor there under X. Set the charpos of the
20560 first glyph of blank lines not corresponding to any text
20562 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20563 row
->exact_window_width_line_p
= true;
20564 else if ((append_space_for_newline (it
, true)
20565 && row
->used
[TEXT_AREA
] == 1)
20566 || row
->used
[TEXT_AREA
] == 0)
20568 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20569 row
->displays_text_p
= false;
20571 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20572 && (!MINI_WINDOW_P (it
->w
)
20573 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20574 row
->indicate_empty_line_p
= true;
20577 it
->continuation_lines_width
= 0;
20578 row
->ends_at_zv_p
= true;
20579 /* A row that displays right-to-left text must always have
20580 its last face extended all the way to the end of line,
20581 even if this row ends in ZV, because we still write to
20582 the screen left to right. We also need to extend the
20583 last face if the default face is remapped to some
20584 different face, otherwise the functions that clear
20585 portions of the screen will clear with the default face's
20586 background color. */
20587 if (row
->reversed_p
20588 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20589 extend_face_to_end_of_line (it
);
20593 /* Now, get the metrics of what we want to display. This also
20594 generates glyphs in `row' (which is IT->glyph_row). */
20595 n_glyphs_before
= row
->used
[TEXT_AREA
];
20598 /* Remember the line height so far in case the next element doesn't
20599 fit on the line. */
20600 if (it
->line_wrap
!= TRUNCATE
)
20602 ascent
= it
->max_ascent
;
20603 descent
= it
->max_descent
;
20604 phys_ascent
= it
->max_phys_ascent
;
20605 phys_descent
= it
->max_phys_descent
;
20607 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20609 if (IT_DISPLAYING_WHITESPACE (it
))
20613 SAVE_IT (wrap_it
, *it
, wrap_data
);
20615 wrap_row_used
= row
->used
[TEXT_AREA
];
20616 wrap_row_ascent
= row
->ascent
;
20617 wrap_row_height
= row
->height
;
20618 wrap_row_phys_ascent
= row
->phys_ascent
;
20619 wrap_row_phys_height
= row
->phys_height
;
20620 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20621 wrap_row_min_pos
= min_pos
;
20622 wrap_row_min_bpos
= min_bpos
;
20623 wrap_row_max_pos
= max_pos
;
20624 wrap_row_max_bpos
= max_bpos
;
20630 PRODUCE_GLYPHS (it
);
20632 /* If this display element was in marginal areas, continue with
20634 if (it
->area
!= TEXT_AREA
)
20636 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20637 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20638 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20639 row
->phys_height
= max (row
->phys_height
,
20640 it
->max_phys_ascent
+ it
->max_phys_descent
);
20641 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20642 it
->max_extra_line_spacing
);
20643 set_iterator_to_next (it
, true);
20644 /* If we didn't handle the line/wrap prefix above, and the
20645 call to set_iterator_to_next just switched to TEXT_AREA,
20646 process the prefix now. */
20647 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20649 pending_handle_line_prefix
= false;
20650 handle_line_prefix (it
);
20655 /* Does the display element fit on the line? If we truncate
20656 lines, we should draw past the right edge of the window. If
20657 we don't truncate, we want to stop so that we can display the
20658 continuation glyph before the right margin. If lines are
20659 continued, there are two possible strategies for characters
20660 resulting in more than 1 glyph (e.g. tabs): Display as many
20661 glyphs as possible in this line and leave the rest for the
20662 continuation line, or display the whole element in the next
20663 line. Original redisplay did the former, so we do it also. */
20664 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20665 hpos_before
= it
->hpos
;
20668 if (/* Not a newline. */
20670 /* Glyphs produced fit entirely in the line. */
20671 && it
->current_x
< it
->last_visible_x
)
20673 it
->hpos
+= nglyphs
;
20674 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20675 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20676 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20677 row
->phys_height
= max (row
->phys_height
,
20678 it
->max_phys_ascent
+ it
->max_phys_descent
);
20679 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20680 it
->max_extra_line_spacing
);
20681 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20682 /* In R2L rows, we arrange in extend_face_to_end_of_line
20683 to add a right offset to the line, by a suitable
20684 change to the stretch glyph that is the leftmost
20685 glyph of the line. */
20686 && !row
->reversed_p
)
20687 row
->x
= x
- it
->first_visible_x
;
20688 /* Record the maximum and minimum buffer positions seen so
20689 far in glyphs that will be displayed by this row. */
20691 RECORD_MAX_MIN_POS (it
);
20696 struct glyph
*glyph
;
20698 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20700 /* Identify the glyphs added by the last call to
20701 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20702 the previous glyphs. */
20703 if (!row
->reversed_p
)
20704 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20706 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20707 new_x
= x
+ glyph
->pixel_width
;
20709 if (/* Lines are continued. */
20710 it
->line_wrap
!= TRUNCATE
20711 && (/* Glyph doesn't fit on the line. */
20712 new_x
> it
->last_visible_x
20713 /* Or it fits exactly on a window system frame. */
20714 || (new_x
== it
->last_visible_x
20715 && FRAME_WINDOW_P (it
->f
)
20716 && (row
->reversed_p
20717 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20718 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20720 /* End of a continued line. */
20723 || (new_x
== it
->last_visible_x
20724 && FRAME_WINDOW_P (it
->f
)
20725 && (row
->reversed_p
20726 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20727 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20729 /* Current glyph is the only one on the line or
20730 fits exactly on the line. We must continue
20731 the line because we can't draw the cursor
20732 after the glyph. */
20733 row
->continued_p
= true;
20734 it
->current_x
= new_x
;
20735 it
->continuation_lines_width
+= new_x
;
20737 if (i
== nglyphs
- 1)
20739 /* If line-wrap is on, check if a previous
20740 wrap point was found. */
20741 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)
20742 && wrap_row_used
> 0
20743 /* Even if there is a previous wrap
20744 point, continue the line here as
20745 usual, if (i) the previous character
20746 was a space or tab AND (ii) the
20747 current character is not. */
20749 || IT_DISPLAYING_WHITESPACE (it
)))
20752 /* Record the maximum and minimum buffer
20753 positions seen so far in glyphs that will be
20754 displayed by this row. */
20756 RECORD_MAX_MIN_POS (it
);
20757 set_iterator_to_next (it
, true);
20758 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20760 if (!get_next_display_element (it
))
20762 row
->exact_window_width_line_p
= true;
20763 it
->continuation_lines_width
= 0;
20764 row
->continued_p
= false;
20765 row
->ends_at_zv_p
= true;
20767 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20769 row
->continued_p
= false;
20770 row
->exact_window_width_line_p
= true;
20772 /* If line-wrap is on, check if a
20773 previous wrap point was found. */
20774 else if (wrap_row_used
> 0
20775 /* Even if there is a previous wrap
20776 point, continue the line here as
20777 usual, if (i) the previous character
20778 was a space or tab AND (ii) the
20779 current character is not. */
20781 || IT_DISPLAYING_WHITESPACE (it
)))
20786 else if (it
->bidi_p
)
20787 RECORD_MAX_MIN_POS (it
);
20788 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20789 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20790 extend_face_to_end_of_line (it
);
20792 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20793 && !FRAME_WINDOW_P (it
->f
))
20795 /* A padding glyph that doesn't fit on this line.
20796 This means the whole character doesn't fit
20798 if (row
->reversed_p
)
20799 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20800 - n_glyphs_before
);
20801 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20803 /* Fill the rest of the row with continuation
20804 glyphs like in 20.x. */
20805 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20806 < row
->glyphs
[1 + TEXT_AREA
])
20807 produce_special_glyphs (it
, IT_CONTINUATION
);
20809 row
->continued_p
= true;
20810 it
->current_x
= x_before
;
20811 it
->continuation_lines_width
+= x_before
;
20813 /* Restore the height to what it was before the
20814 element not fitting on the line. */
20815 it
->max_ascent
= ascent
;
20816 it
->max_descent
= descent
;
20817 it
->max_phys_ascent
= phys_ascent
;
20818 it
->max_phys_descent
= phys_descent
;
20819 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20820 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20821 extend_face_to_end_of_line (it
);
20823 else if (wrap_row_used
> 0)
20826 if (row
->reversed_p
)
20827 unproduce_glyphs (it
,
20828 row
->used
[TEXT_AREA
] - wrap_row_used
);
20829 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20830 it
->continuation_lines_width
+= wrap_x
;
20831 row
->used
[TEXT_AREA
] = wrap_row_used
;
20832 row
->ascent
= wrap_row_ascent
;
20833 row
->height
= wrap_row_height
;
20834 row
->phys_ascent
= wrap_row_phys_ascent
;
20835 row
->phys_height
= wrap_row_phys_height
;
20836 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20837 min_pos
= wrap_row_min_pos
;
20838 min_bpos
= wrap_row_min_bpos
;
20839 max_pos
= wrap_row_max_pos
;
20840 max_bpos
= wrap_row_max_bpos
;
20841 row
->continued_p
= true;
20842 row
->ends_at_zv_p
= false;
20843 row
->exact_window_width_line_p
= false;
20844 it
->continuation_lines_width
+= x
;
20846 /* Make sure that a non-default face is extended
20847 up to the right margin of the window. */
20848 extend_face_to_end_of_line (it
);
20850 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20852 /* A TAB that extends past the right edge of the
20853 window. This produces a single glyph on
20854 window system frames. We leave the glyph in
20855 this row and let it fill the row, but don't
20856 consume the TAB. */
20857 if ((row
->reversed_p
20858 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20859 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20860 produce_special_glyphs (it
, IT_CONTINUATION
);
20861 it
->continuation_lines_width
+= it
->last_visible_x
;
20862 row
->ends_in_middle_of_char_p
= true;
20863 row
->continued_p
= true;
20864 glyph
->pixel_width
= it
->last_visible_x
- x
;
20865 it
->starts_in_middle_of_char_p
= true;
20866 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20867 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20868 extend_face_to_end_of_line (it
);
20872 /* Something other than a TAB that draws past
20873 the right edge of the window. Restore
20874 positions to values before the element. */
20875 if (row
->reversed_p
)
20876 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20877 - (n_glyphs_before
+ i
));
20878 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20880 /* Display continuation glyphs. */
20881 it
->current_x
= x_before
;
20882 it
->continuation_lines_width
+= x
;
20883 if (!FRAME_WINDOW_P (it
->f
)
20884 || (row
->reversed_p
20885 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20886 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20887 produce_special_glyphs (it
, IT_CONTINUATION
);
20888 row
->continued_p
= true;
20890 extend_face_to_end_of_line (it
);
20892 if (nglyphs
> 1 && i
> 0)
20894 row
->ends_in_middle_of_char_p
= true;
20895 it
->starts_in_middle_of_char_p
= true;
20898 /* Restore the height to what it was before the
20899 element not fitting on the line. */
20900 it
->max_ascent
= ascent
;
20901 it
->max_descent
= descent
;
20902 it
->max_phys_ascent
= phys_ascent
;
20903 it
->max_phys_descent
= phys_descent
;
20908 else if (new_x
> it
->first_visible_x
)
20910 /* Increment number of glyphs actually displayed. */
20913 /* Record the maximum and minimum buffer positions
20914 seen so far in glyphs that will be displayed by
20917 RECORD_MAX_MIN_POS (it
);
20919 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20920 /* Glyph is partially visible, i.e. row starts at
20921 negative X position. Don't do that in R2L
20922 rows, where we arrange to add a right offset to
20923 the line in extend_face_to_end_of_line, by a
20924 suitable change to the stretch glyph that is
20925 the leftmost glyph of the line. */
20926 row
->x
= x
- it
->first_visible_x
;
20927 /* When the last glyph of an R2L row only fits
20928 partially on the line, we need to set row->x to a
20929 negative offset, so that the leftmost glyph is
20930 the one that is partially visible. But if we are
20931 going to produce the truncation glyph, this will
20932 be taken care of in produce_special_glyphs. */
20933 if (row
->reversed_p
20934 && new_x
> it
->last_visible_x
20935 && !(it
->line_wrap
== TRUNCATE
20936 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
20938 eassert (FRAME_WINDOW_P (it
->f
));
20939 row
->x
= it
->last_visible_x
- new_x
;
20944 /* Glyph is completely off the left margin of the
20945 window. This should not happen because of the
20946 move_it_in_display_line at the start of this
20947 function, unless the text display area of the
20948 window is empty. */
20949 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20952 /* Even if this display element produced no glyphs at all,
20953 we want to record its position. */
20954 if (it
->bidi_p
&& nglyphs
== 0)
20955 RECORD_MAX_MIN_POS (it
);
20957 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20958 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20959 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20960 row
->phys_height
= max (row
->phys_height
,
20961 it
->max_phys_ascent
+ it
->max_phys_descent
);
20962 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20963 it
->max_extra_line_spacing
);
20965 /* End of this display line if row is continued. */
20966 if (row
->continued_p
|| row
->ends_at_zv_p
)
20971 /* Is this a line end? If yes, we're also done, after making
20972 sure that a non-default face is extended up to the right
20973 margin of the window. */
20974 if (ITERATOR_AT_END_OF_LINE_P (it
))
20976 int used_before
= row
->used
[TEXT_AREA
];
20978 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20980 /* Add a space at the end of the line that is used to
20981 display the cursor there. */
20982 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20983 append_space_for_newline (it
, false);
20985 /* Extend the face to the end of the line. */
20986 extend_face_to_end_of_line (it
);
20988 /* Make sure we have the position. */
20989 if (used_before
== 0)
20990 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20992 /* Record the position of the newline, for use in
20994 it
->eol_pos
= it
->current
.pos
;
20996 /* Consume the line end. This skips over invisible lines. */
20997 set_iterator_to_next (it
, true);
20998 it
->continuation_lines_width
= 0;
21002 /* Proceed with next display element. Note that this skips
21003 over lines invisible because of selective display. */
21004 set_iterator_to_next (it
, true);
21006 /* If we truncate lines, we are done when the last displayed
21007 glyphs reach past the right margin of the window. */
21008 if (it
->line_wrap
== TRUNCATE
21009 && ((FRAME_WINDOW_P (it
->f
)
21010 /* Images are preprocessed in produce_image_glyph such
21011 that they are cropped at the right edge of the
21012 window, so an image glyph will always end exactly at
21013 last_visible_x, even if there's no right fringe. */
21014 && ((row
->reversed_p
21015 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
21016 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
21017 || it
->what
== IT_IMAGE
))
21018 ? (it
->current_x
>= it
->last_visible_x
)
21019 : (it
->current_x
> it
->last_visible_x
)))
21021 /* Maybe add truncation glyphs. */
21022 if (!FRAME_WINDOW_P (it
->f
)
21023 || (row
->reversed_p
21024 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
21025 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
21029 if (!row
->reversed_p
)
21031 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
21032 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
21037 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
21038 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
21040 /* Remove any padding glyphs at the front of ROW, to
21041 make room for the truncation glyphs we will be
21042 adding below. The loop below always inserts at
21043 least one truncation glyph, so also remove the
21044 last glyph added to ROW. */
21045 unproduce_glyphs (it
, i
+ 1);
21046 /* Adjust i for the loop below. */
21047 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
21050 /* produce_special_glyphs overwrites the last glyph, so
21051 we don't want that if we want to keep that last
21052 glyph, which means it's an image. */
21053 if (it
->current_x
> it
->last_visible_x
)
21055 it
->current_x
= x_before
;
21056 if (!FRAME_WINDOW_P (it
->f
))
21058 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
21060 row
->used
[TEXT_AREA
] = i
;
21061 produce_special_glyphs (it
, IT_TRUNCATION
);
21066 row
->used
[TEXT_AREA
] = i
;
21067 produce_special_glyphs (it
, IT_TRUNCATION
);
21069 it
->hpos
= hpos_before
;
21072 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
21074 /* Don't truncate if we can overflow newline into fringe. */
21075 if (!get_next_display_element (it
))
21077 it
->continuation_lines_width
= 0;
21078 row
->ends_at_zv_p
= true;
21079 row
->exact_window_width_line_p
= true;
21082 if (ITERATOR_AT_END_OF_LINE_P (it
))
21084 row
->exact_window_width_line_p
= true;
21085 goto at_end_of_line
;
21087 it
->current_x
= x_before
;
21088 it
->hpos
= hpos_before
;
21091 row
->truncated_on_right_p
= true;
21092 it
->continuation_lines_width
= 0;
21093 reseat_at_next_visible_line_start (it
, false);
21094 /* We insist below that IT's position be at ZV because in
21095 bidi-reordered lines the character at visible line start
21096 might not be the character that follows the newline in
21097 the logical order. */
21098 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
21099 row
->ends_at_zv_p
=
21100 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
21102 row
->ends_at_zv_p
= false;
21108 bidi_unshelve_cache (wrap_data
, true);
21110 /* If line is not empty and hscrolled, maybe insert truncation glyphs
21111 at the left window margin. */
21112 if (it
->first_visible_x
21113 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
21115 if (!FRAME_WINDOW_P (it
->f
)
21116 || (((row
->reversed_p
21117 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21118 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
21119 /* Don't let insert_left_trunc_glyphs overwrite the
21120 first glyph of the row if it is an image. */
21121 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
21122 insert_left_trunc_glyphs (it
);
21123 row
->truncated_on_left_p
= true;
21126 /* Remember the position at which this line ends.
21128 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
21129 cannot be before the call to find_row_edges below, since that is
21130 where these positions are determined. */
21131 row
->end
= it
->current
;
21134 row
->minpos
= row
->start
.pos
;
21135 row
->maxpos
= row
->end
.pos
;
21139 /* ROW->minpos and ROW->maxpos must be the smallest and
21140 `1 + the largest' buffer positions in ROW. But if ROW was
21141 bidi-reordered, these two positions can be anywhere in the
21142 row, so we must determine them now. */
21143 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
21146 /* If the start of this line is the overlay arrow-position, then
21147 mark this glyph row as the one containing the overlay arrow.
21148 This is clearly a mess with variable size fonts. It would be
21149 better to let it be displayed like cursors under X. */
21150 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
21151 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
21152 !NILP (overlay_arrow_string
)))
21154 /* Overlay arrow in window redisplay is a fringe bitmap. */
21155 if (STRINGP (overlay_arrow_string
))
21157 struct glyph_row
*arrow_row
21158 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
21159 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
21160 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
21161 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
21162 struct glyph
*p2
, *end
;
21164 /* Copy the arrow glyphs. */
21165 while (glyph
< arrow_end
)
21168 /* Throw away padding glyphs. */
21170 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
21171 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
21177 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
21182 eassert (INTEGERP (overlay_arrow_string
));
21183 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
21185 overlay_arrow_seen
= true;
21188 /* Highlight trailing whitespace. */
21189 if (!NILP (Vshow_trailing_whitespace
))
21190 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
21192 /* Compute pixel dimensions of this line. */
21193 compute_line_metrics (it
);
21195 /* Implementation note: No changes in the glyphs of ROW or in their
21196 faces can be done past this point, because compute_line_metrics
21197 computes ROW's hash value and stores it within the glyph_row
21200 /* Record whether this row ends inside an ellipsis. */
21201 row
->ends_in_ellipsis_p
21202 = (it
->method
== GET_FROM_DISPLAY_VECTOR
21203 && it
->ellipsis_p
);
21205 /* Save fringe bitmaps in this row. */
21206 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
21207 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
21208 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
21209 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
21211 it
->left_user_fringe_bitmap
= 0;
21212 it
->left_user_fringe_face_id
= 0;
21213 it
->right_user_fringe_bitmap
= 0;
21214 it
->right_user_fringe_face_id
= 0;
21216 /* Maybe set the cursor. */
21217 cvpos
= it
->w
->cursor
.vpos
;
21219 /* In bidi-reordered rows, keep checking for proper cursor
21220 position even if one has been found already, because buffer
21221 positions in such rows change non-linearly with ROW->VPOS,
21222 when a line is continued. One exception: when we are at ZV,
21223 display cursor on the first suitable glyph row, since all
21224 the empty rows after that also have their position set to ZV. */
21225 /* FIXME: Revisit this when glyph ``spilling'' in continuation
21226 lines' rows is implemented for bidi-reordered rows. */
21228 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
21229 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
21230 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
21231 && cursor_row_p (row
))
21232 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
21234 /* Prepare for the next line. This line starts horizontally at (X
21235 HPOS) = (0 0). Vertical positions are incremented. As a
21236 convenience for the caller, IT->glyph_row is set to the next
21238 it
->current_x
= it
->hpos
= 0;
21239 it
->current_y
+= row
->height
;
21240 SET_TEXT_POS (it
->eol_pos
, 0, 0);
21243 /* The next row should by default use the same value of the
21244 reversed_p flag as this one. set_iterator_to_next decides when
21245 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
21246 the flag accordingly. */
21247 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
21248 it
->glyph_row
->reversed_p
= row
->reversed_p
;
21249 it
->start
= row
->end
;
21250 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
21252 #undef RECORD_MAX_MIN_POS
21255 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
21256 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
21257 doc
: /* Return paragraph direction at point in BUFFER.
21258 Value is either `left-to-right' or `right-to-left'.
21259 If BUFFER is omitted or nil, it defaults to the current buffer.
21261 Paragraph direction determines how the text in the paragraph is displayed.
21262 In left-to-right paragraphs, text begins at the left margin of the window
21263 and the reading direction is generally left to right. In right-to-left
21264 paragraphs, text begins at the right margin and is read from right to left.
21266 See also `bidi-paragraph-direction'. */)
21267 (Lisp_Object buffer
)
21269 struct buffer
*buf
= current_buffer
;
21270 struct buffer
*old
= buf
;
21272 if (! NILP (buffer
))
21274 CHECK_BUFFER (buffer
);
21275 buf
= XBUFFER (buffer
);
21278 if (NILP (BVAR (buf
, bidi_display_reordering
))
21279 || NILP (BVAR (buf
, enable_multibyte_characters
))
21280 /* When we are loading loadup.el, the character property tables
21281 needed for bidi iteration are not yet available. */
21282 || redisplay__inhibit_bidi
)
21283 return Qleft_to_right
;
21284 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
21285 return BVAR (buf
, bidi_paragraph_direction
);
21288 /* Determine the direction from buffer text. We could try to
21289 use current_matrix if it is up to date, but this seems fast
21290 enough as it is. */
21291 struct bidi_it itb
;
21292 ptrdiff_t pos
= BUF_PT (buf
);
21293 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
21295 void *itb_data
= bidi_shelve_cache ();
21297 set_buffer_temp (buf
);
21298 /* bidi_paragraph_init finds the base direction of the paragraph
21299 by searching forward from paragraph start. We need the base
21300 direction of the current or _previous_ paragraph, so we need
21301 to make sure we are within that paragraph. To that end, find
21302 the previous non-empty line. */
21303 if (pos
>= ZV
&& pos
> BEGV
)
21304 DEC_BOTH (pos
, bytepos
);
21305 AUTO_STRING (trailing_white_space
, "[\f\t ]*\n");
21306 if (fast_looking_at (trailing_white_space
,
21307 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
21309 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
21310 || c
== ' ' || c
== '\t' || c
== '\f')
21312 if (bytepos
<= BEGV_BYTE
)
21317 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
21320 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
21321 itb
.paragraph_dir
= NEUTRAL_DIR
;
21322 itb
.string
.s
= NULL
;
21323 itb
.string
.lstring
= Qnil
;
21324 itb
.string
.bufpos
= 0;
21325 itb
.string
.from_disp_str
= false;
21326 itb
.string
.unibyte
= false;
21327 /* We have no window to use here for ignoring window-specific
21328 overlays. Using NULL for window pointer will cause
21329 compute_display_string_pos to use the current buffer. */
21331 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, true);
21332 bidi_unshelve_cache (itb_data
, false);
21333 set_buffer_temp (old
);
21334 switch (itb
.paragraph_dir
)
21337 return Qleft_to_right
;
21340 return Qright_to_left
;
21348 DEFUN ("bidi-find-overridden-directionality",
21349 Fbidi_find_overridden_directionality
,
21350 Sbidi_find_overridden_directionality
, 2, 3, 0,
21351 doc
: /* Return position between FROM and TO where directionality was overridden.
21353 This function returns the first character position in the specified
21354 region of OBJECT where there is a character whose `bidi-class' property
21355 is `L', but which was forced to display as `R' by a directional
21356 override, and likewise with characters whose `bidi-class' is `R'
21357 or `AL' that were forced to display as `L'.
21359 If no such character is found, the function returns nil.
21361 OBJECT is a Lisp string or buffer to search for overridden
21362 directionality, and defaults to the current buffer if nil or omitted.
21363 OBJECT can also be a window, in which case the function will search
21364 the buffer displayed in that window. Passing the window instead of
21365 a buffer is preferable when the buffer is displayed in some window,
21366 because this function will then be able to correctly account for
21367 window-specific overlays, which can affect the results.
21369 Strong directional characters `L', `R', and `AL' can have their
21370 intrinsic directionality overridden by directional override
21371 control characters RLO (u+202e) and LRO (u+202d). See the
21372 function `get-char-code-property' for a way to inquire about
21373 the `bidi-class' property of a character. */)
21374 (Lisp_Object from
, Lisp_Object to
, Lisp_Object object
)
21376 struct buffer
*buf
= current_buffer
;
21377 struct buffer
*old
= buf
;
21378 struct window
*w
= NULL
;
21379 bool frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ());
21380 struct bidi_it itb
;
21381 ptrdiff_t from_pos
, to_pos
, from_bpos
;
21384 if (!NILP (object
))
21386 if (BUFFERP (object
))
21387 buf
= XBUFFER (object
);
21388 else if (WINDOWP (object
))
21390 w
= decode_live_window (object
);
21391 buf
= XBUFFER (w
->contents
);
21392 frame_window_p
= FRAME_WINDOW_P (XFRAME (w
->frame
));
21395 CHECK_STRING (object
);
21398 if (STRINGP (object
))
21400 /* Characters in unibyte strings are always treated by bidi.c as
21402 if (!STRING_MULTIBYTE (object
)
21403 /* When we are loading loadup.el, the character property
21404 tables needed for bidi iteration are not yet
21406 || redisplay__inhibit_bidi
)
21409 validate_subarray (object
, from
, to
, SCHARS (object
), &from_pos
, &to_pos
);
21410 if (from_pos
>= SCHARS (object
))
21413 /* Set up the bidi iterator. */
21414 itb_data
= bidi_shelve_cache ();
21415 itb
.paragraph_dir
= NEUTRAL_DIR
;
21416 itb
.string
.lstring
= object
;
21417 itb
.string
.s
= NULL
;
21418 itb
.string
.schars
= SCHARS (object
);
21419 itb
.string
.bufpos
= 0;
21420 itb
.string
.from_disp_str
= false;
21421 itb
.string
.unibyte
= false;
21423 bidi_init_it (0, 0, frame_window_p
, &itb
);
21427 /* Nothing this fancy can happen in unibyte buffers, or in a
21428 buffer that disabled reordering, or if FROM is at EOB. */
21429 if (NILP (BVAR (buf
, bidi_display_reordering
))
21430 || NILP (BVAR (buf
, enable_multibyte_characters
))
21431 /* When we are loading loadup.el, the character property
21432 tables needed for bidi iteration are not yet
21434 || redisplay__inhibit_bidi
)
21437 set_buffer_temp (buf
);
21438 validate_region (&from
, &to
);
21439 from_pos
= XINT (from
);
21440 to_pos
= XINT (to
);
21441 if (from_pos
>= ZV
)
21444 /* Set up the bidi iterator. */
21445 itb_data
= bidi_shelve_cache ();
21446 from_bpos
= CHAR_TO_BYTE (from_pos
);
21447 if (from_pos
== BEGV
)
21449 itb
.charpos
= BEGV
;
21450 itb
.bytepos
= BEGV_BYTE
;
21452 else if (FETCH_CHAR (from_bpos
- 1) == '\n')
21454 itb
.charpos
= from_pos
;
21455 itb
.bytepos
= from_bpos
;
21458 itb
.charpos
= find_newline_no_quit (from_pos
, CHAR_TO_BYTE (from_pos
),
21460 itb
.paragraph_dir
= NEUTRAL_DIR
;
21461 itb
.string
.s
= NULL
;
21462 itb
.string
.lstring
= Qnil
;
21463 itb
.string
.bufpos
= 0;
21464 itb
.string
.from_disp_str
= false;
21465 itb
.string
.unibyte
= false;
21467 bidi_init_it (itb
.charpos
, itb
.bytepos
, frame_window_p
, &itb
);
21472 /* For the purposes of this function, the actual base direction of
21473 the paragraph doesn't matter, so just set it to L2R. */
21474 bidi_paragraph_init (L2R
, &itb
, false);
21475 while ((found
= bidi_find_first_overridden (&itb
)) < from_pos
)
21477 } while (found
== ZV
&& itb
.ch
== '\n' && itb
.charpos
< to_pos
);
21479 bidi_unshelve_cache (itb_data
, false);
21480 set_buffer_temp (old
);
21482 return (from_pos
<= found
&& found
< to_pos
) ? make_number (found
) : Qnil
;
21485 DEFUN ("move-point-visually", Fmove_point_visually
,
21486 Smove_point_visually
, 1, 1, 0,
21487 doc
: /* Move point in the visual order in the specified DIRECTION.
21488 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
21491 Value is the new character position of point. */)
21492 (Lisp_Object direction
)
21494 struct window
*w
= XWINDOW (selected_window
);
21495 struct buffer
*b
= XBUFFER (w
->contents
);
21496 struct glyph_row
*row
;
21498 Lisp_Object paragraph_dir
;
21500 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21501 (!(ROW)->continued_p \
21502 && NILP ((GLYPH)->object) \
21503 && (GLYPH)->type == CHAR_GLYPH \
21504 && (GLYPH)->u.ch == ' ' \
21505 && (GLYPH)->charpos >= 0 \
21506 && !(GLYPH)->avoid_cursor_p)
21508 CHECK_NUMBER (direction
);
21509 dir
= XINT (direction
);
21515 /* If current matrix is up-to-date, we can use the information
21516 recorded in the glyphs, at least as long as the goal is on the
21518 if (w
->window_end_valid
21519 && !windows_or_buffers_changed
21521 && !b
->clip_changed
21522 && !b
->prevent_redisplay_optimizations_p
21523 && !window_outdated (w
)
21524 /* We rely below on the cursor coordinates to be up to date, but
21525 we cannot trust them if some command moved point since the
21526 last complete redisplay. */
21527 && w
->last_point
== BUF_PT (b
)
21528 && w
->cursor
.vpos
>= 0
21529 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21530 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21532 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21533 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21534 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21536 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21538 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21540 SET_PT (g
->charpos
);
21541 w
->cursor
.vpos
= -1;
21542 return make_number (PT
);
21544 else if (!NILP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21548 if (BUFFERP (gpt
->object
))
21551 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21552 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21554 new_pos
-= (row
->reversed_p
? -dir
: dir
);
21556 else if (BUFFERP (g
->object
))
21557 new_pos
= g
->charpos
;
21561 w
->cursor
.vpos
= -1;
21562 return make_number (PT
);
21564 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21566 /* Glyphs inserted at the end of a non-empty line for
21567 positioning the cursor have zero charpos, so we must
21568 deduce the value of point by other means. */
21569 if (g
->charpos
> 0)
21570 SET_PT (g
->charpos
);
21571 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21573 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21574 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21577 w
->cursor
.vpos
= -1;
21578 return make_number (PT
);
21581 if (g
== e
|| NILP (g
->object
))
21583 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21584 goto simulate_display
;
21585 if (!row
->reversed_p
)
21589 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21590 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21591 goto simulate_display
;
21595 if (row
->reversed_p
&& !row
->continued_p
)
21597 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21598 w
->cursor
.vpos
= -1;
21599 return make_number (PT
);
21601 g
= row
->glyphs
[TEXT_AREA
];
21602 e
= g
+ row
->used
[TEXT_AREA
];
21603 for ( ; g
< e
; g
++)
21605 if (BUFFERP (g
->object
)
21606 /* Empty lines have only one glyph, which stands
21607 for the newline, and whose charpos is the
21608 buffer position of the newline. */
21609 || ROW_GLYPH_NEWLINE_P (row
, g
)
21610 /* When the buffer ends in a newline, the line at
21611 EOB also has one glyph, but its charpos is -1. */
21612 || (row
->ends_at_zv_p
21613 && !row
->reversed_p
21614 && NILP (g
->object
)
21615 && g
->type
== CHAR_GLYPH
21616 && g
->u
.ch
== ' '))
21618 if (g
->charpos
> 0)
21619 SET_PT (g
->charpos
);
21620 else if (!row
->reversed_p
21621 && row
->ends_at_zv_p
21626 w
->cursor
.vpos
= -1;
21627 return make_number (PT
);
21633 if (!row
->reversed_p
&& !row
->continued_p
)
21635 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21636 w
->cursor
.vpos
= -1;
21637 return make_number (PT
);
21639 e
= row
->glyphs
[TEXT_AREA
];
21640 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21641 for ( ; g
>= e
; g
--)
21643 if (BUFFERP (g
->object
)
21644 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21646 /* Empty R2L lines on GUI frames have the buffer
21647 position of the newline stored in the stretch
21649 || g
->type
== STRETCH_GLYPH
21650 || (row
->ends_at_zv_p
21652 && NILP (g
->object
)
21653 && g
->type
== CHAR_GLYPH
21654 && g
->u
.ch
== ' '))
21656 if (g
->charpos
> 0)
21657 SET_PT (g
->charpos
);
21658 else if (row
->reversed_p
21659 && row
->ends_at_zv_p
21664 w
->cursor
.vpos
= -1;
21665 return make_number (PT
);
21674 /* If we wind up here, we failed to move by using the glyphs, so we
21675 need to simulate display instead. */
21678 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21680 paragraph_dir
= Qleft_to_right
;
21681 if (EQ (paragraph_dir
, Qright_to_left
))
21683 if (PT
<= BEGV
&& dir
< 0)
21684 xsignal0 (Qbeginning_of_buffer
);
21685 else if (PT
>= ZV
&& dir
> 0)
21686 xsignal0 (Qend_of_buffer
);
21689 struct text_pos pt
;
21691 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21693 bool overshoot_expected
= false;
21694 #ifdef HAVE_WINDOW_SYSTEM
21695 bool target_is_eol_p
= false;
21698 /* Setup the arena. */
21699 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21700 start_display (&it
, w
, pt
);
21701 /* When lines are truncated, we could be called with point
21702 outside of the windows edges, in which case move_it_*
21703 functions either prematurely stop at window's edge or jump to
21704 the next screen line, whereas we rely below on our ability to
21705 reach point, in order to start from its X coordinate. So we
21706 need to disregard the window's horizontal extent in that case. */
21707 if (it
.line_wrap
== TRUNCATE
)
21708 it
.last_visible_x
= INFINITY
;
21710 if (it
.cmp_it
.id
< 0
21711 && it
.method
== GET_FROM_STRING
21712 && it
.area
== TEXT_AREA
21713 && it
.string_from_display_prop_p
21714 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21715 overshoot_expected
= true;
21717 /* Find the X coordinate of point. We start from the beginning
21718 of this or previous line to make sure we are before point in
21719 the logical order (since the move_it_* functions can only
21722 reseat_at_previous_visible_line_start (&it
);
21723 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21724 if (IT_CHARPOS (it
) != PT
)
21726 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21727 -1, -1, -1, MOVE_TO_POS
);
21728 /* If we missed point because the character there is
21729 displayed out of a display vector that has more than one
21730 glyph, retry expecting overshoot. */
21731 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21732 && it
.current
.dpvec_index
> 0
21733 && !overshoot_expected
)
21735 overshoot_expected
= true;
21738 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21739 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21741 pt_x
= it
.current_x
;
21743 if (dir
> 0 || overshoot_expected
)
21745 struct glyph_row
*row
= it
.glyph_row
;
21747 /* When point is at beginning of line, we don't have
21748 information about the glyph there loaded into struct
21749 it. Calling get_next_display_element fixes that. */
21751 get_next_display_element (&it
);
21752 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21753 it
.glyph_row
= NULL
;
21754 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21755 it
.glyph_row
= row
;
21756 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21757 it, lest it will become out of sync with it's buffer
21759 it
.current_x
= pt_x
;
21762 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21763 pixel_width
= it
.pixel_width
;
21764 if (overshoot_expected
&& at_eol_p
)
21766 else if (pixel_width
<= 0)
21769 /* If there's a display string (or something similar) at point,
21770 we are actually at the glyph to the left of point, so we need
21771 to correct the X coordinate. */
21772 if (overshoot_expected
)
21775 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21777 pt_x
+= pixel_width
;
21780 /* Compute target X coordinate, either to the left or to the
21781 right of point. On TTY frames, all characters have the same
21782 pixel width of 1, so we can use that. On GUI frames we don't
21783 have an easy way of getting at the pixel width of the
21784 character to the left of point, so we use a different method
21785 of getting to that place. */
21787 target_x
= pt_x
+ pixel_width
;
21789 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21791 /* Target X coordinate could be one line above or below the line
21792 of point, in which case we need to adjust the target X
21793 coordinate. Also, if moving to the left, we need to begin at
21794 the left edge of the point's screen line. */
21799 start_display (&it
, w
, pt
);
21800 if (it
.line_wrap
== TRUNCATE
)
21801 it
.last_visible_x
= INFINITY
;
21802 reseat_at_previous_visible_line_start (&it
);
21803 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21805 move_it_by_lines (&it
, pt_vpos
);
21809 move_it_by_lines (&it
, -1);
21810 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21811 #ifdef HAVE_WINDOW_SYSTEM
21812 target_is_eol_p
= true;
21814 /* Under word-wrap, we don't know the x coordinate of
21815 the last character displayed on the previous line,
21816 which immediately precedes the wrap point. To find
21817 out its x coordinate, we try moving to the right
21818 margin of the window, which will stop at the wrap
21819 point, and then reset target_x to point at the
21820 character that precedes the wrap point. This is not
21821 needed on GUI frames, because (see below) there we
21822 move from the left margin one grapheme cluster at a
21823 time, and stop when we hit the wrap point. */
21824 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21826 void *it_data
= NULL
;
21829 SAVE_IT (it2
, it
, it_data
);
21830 move_it_in_display_line_to (&it
, ZV
, target_x
,
21831 MOVE_TO_POS
| MOVE_TO_X
);
21832 /* If we arrived at target_x, that _is_ the last
21833 character on the previous line. */
21834 if (it
.current_x
!= target_x
)
21835 target_x
= it
.current_x
- 1;
21836 RESTORE_IT (&it
, &it2
, it_data
);
21843 || (target_x
>= it
.last_visible_x
21844 && it
.line_wrap
!= TRUNCATE
))
21847 move_it_by_lines (&it
, 0);
21848 move_it_by_lines (&it
, 1);
21853 /* Move to the target X coordinate. */
21854 #ifdef HAVE_WINDOW_SYSTEM
21855 /* On GUI frames, as we don't know the X coordinate of the
21856 character to the left of point, moving point to the left
21857 requires walking, one grapheme cluster at a time, until we
21858 find ourself at a place immediately to the left of the
21859 character at point. */
21860 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21862 struct text_pos new_pos
;
21863 enum move_it_result rc
= MOVE_X_REACHED
;
21865 if (it
.current_x
== 0)
21866 get_next_display_element (&it
);
21867 if (it
.what
== IT_COMPOSITION
)
21869 new_pos
.charpos
= it
.cmp_it
.charpos
;
21870 new_pos
.bytepos
= -1;
21873 new_pos
= it
.current
.pos
;
21875 while (it
.current_x
+ it
.pixel_width
<= target_x
21876 && (rc
== MOVE_X_REACHED
21877 /* Under word-wrap, move_it_in_display_line_to
21878 stops at correct coordinates, but sometimes
21879 returns MOVE_POS_MATCH_OR_ZV. */
21880 || (it
.line_wrap
== WORD_WRAP
21881 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21883 int new_x
= it
.current_x
+ it
.pixel_width
;
21885 /* For composed characters, we want the position of the
21886 first character in the grapheme cluster (usually, the
21887 composition's base character), whereas it.current
21888 might give us the position of the _last_ one, e.g. if
21889 the composition is rendered in reverse due to bidi
21891 if (it
.what
== IT_COMPOSITION
)
21893 new_pos
.charpos
= it
.cmp_it
.charpos
;
21894 new_pos
.bytepos
= -1;
21897 new_pos
= it
.current
.pos
;
21898 if (new_x
== it
.current_x
)
21900 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21901 MOVE_TO_POS
| MOVE_TO_X
);
21902 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21905 /* The previous position we saw in the loop is the one we
21907 if (new_pos
.bytepos
== -1)
21908 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21909 it
.current
.pos
= new_pos
;
21913 if (it
.current_x
!= target_x
)
21914 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21916 /* If we ended up in a display string that covers point, move to
21917 buffer position to the right in the visual order. */
21920 while (IT_CHARPOS (it
) == PT
)
21922 set_iterator_to_next (&it
, false);
21923 if (!get_next_display_element (&it
))
21928 /* Move point to that position. */
21929 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21932 return make_number (PT
);
21934 #undef ROW_GLYPH_NEWLINE_P
21937 DEFUN ("bidi-resolved-levels", Fbidi_resolved_levels
,
21938 Sbidi_resolved_levels
, 0, 1, 0,
21939 doc
: /* Return the resolved bidirectional levels of characters at VPOS.
21941 The resolved levels are produced by the Emacs bidi reordering engine
21942 that implements the UBA, the Unicode Bidirectional Algorithm. Please
21943 read the Unicode Standard Annex 9 (UAX#9) for background information
21944 about these levels.
21946 VPOS is the zero-based number of the current window's screen line
21947 for which to produce the resolved levels. If VPOS is nil or omitted,
21948 it defaults to the screen line of point. If the window displays a
21949 header line, VPOS of zero will report on the header line, and first
21950 line of text in the window will have VPOS of 1.
21952 Value is an array of resolved levels, indexed by glyph number.
21953 Glyphs are numbered from zero starting from the beginning of the
21954 screen line, i.e. the left edge of the window for left-to-right lines
21955 and from the right edge for right-to-left lines. The resolved levels
21956 are produced only for the window's text area; text in display margins
21959 If the selected window's display is not up-to-date, or if the specified
21960 screen line does not display text, this function returns nil. It is
21961 highly recommended to bind this function to some simple key, like F8,
21962 in order to avoid these problems.
21964 This function exists mainly for testing the correctness of the
21965 Emacs UBA implementation, in particular with the test suite. */)
21968 struct window
*w
= XWINDOW (selected_window
);
21969 struct buffer
*b
= XBUFFER (w
->contents
);
21971 struct glyph_row
*row
;
21975 int d1
, d2
, d3
, d4
, d5
;
21977 pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &nrow
);
21981 CHECK_NUMBER_COERCE_MARKER (vpos
);
21982 nrow
= XINT (vpos
);
21985 /* We require up-to-date glyph matrix for this window. */
21986 if (w
->window_end_valid
21987 && !windows_or_buffers_changed
21989 && !b
->clip_changed
21990 && !b
->prevent_redisplay_optimizations_p
21991 && !window_outdated (w
)
21993 && nrow
< w
->current_matrix
->nrows
21994 && (row
= MATRIX_ROW (w
->current_matrix
, nrow
))->enabled_p
21995 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
21997 struct glyph
*g
, *e
, *g1
;
21999 Lisp_Object levels
;
22001 if (!row
->reversed_p
) /* Left-to-right glyph row. */
22003 g
= g1
= row
->glyphs
[TEXT_AREA
];
22004 e
= g
+ row
->used
[TEXT_AREA
];
22006 /* Skip over glyphs at the start of the row that was
22007 generated by redisplay for its own needs. */
22009 && NILP (g
->object
)
22014 /* Count the "interesting" glyphs in this row. */
22015 for (nglyphs
= 0; g
< e
&& !NILP (g
->object
); g
++)
22018 /* Create and fill the array. */
22019 levels
= make_uninit_vector (nglyphs
);
22020 for (i
= 0; g1
< g
; i
++, g1
++)
22021 ASET (levels
, i
, make_number (g1
->resolved_level
));
22023 else /* Right-to-left glyph row. */
22025 g
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
22026 e
= row
->glyphs
[TEXT_AREA
] - 1;
22028 && NILP (g
->object
)
22032 for (nglyphs
= 0; g
> e
&& !NILP (g
->object
); g
--)
22034 levels
= make_uninit_vector (nglyphs
);
22035 for (i
= 0; g1
> g
; i
++, g1
--)
22036 ASET (levels
, i
, make_number (g1
->resolved_level
));
22046 /***********************************************************************
22048 ***********************************************************************/
22050 /* Redisplay the menu bar in the frame for window W.
22052 The menu bar of X frames that don't have X toolkit support is
22053 displayed in a special window W->frame->menu_bar_window.
22055 The menu bar of terminal frames is treated specially as far as
22056 glyph matrices are concerned. Menu bar lines are not part of
22057 windows, so the update is done directly on the frame matrix rows
22058 for the menu bar. */
22061 display_menu_bar (struct window
*w
)
22063 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22068 /* Don't do all this for graphical frames. */
22070 if (FRAME_W32_P (f
))
22073 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
22079 if (FRAME_NS_P (f
))
22081 #endif /* HAVE_NS */
22083 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
22084 eassert (!FRAME_WINDOW_P (f
));
22085 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
22086 it
.first_visible_x
= 0;
22087 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
22088 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
22089 if (FRAME_WINDOW_P (f
))
22091 /* Menu bar lines are displayed in the desired matrix of the
22092 dummy window menu_bar_window. */
22093 struct window
*menu_w
;
22094 menu_w
= XWINDOW (f
->menu_bar_window
);
22095 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
22097 it
.first_visible_x
= 0;
22098 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
22101 #endif /* not USE_X_TOOLKIT and not USE_GTK */
22103 /* This is a TTY frame, i.e. character hpos/vpos are used as
22105 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
22107 it
.first_visible_x
= 0;
22108 it
.last_visible_x
= FRAME_COLS (f
);
22111 /* FIXME: This should be controlled by a user option. See the
22112 comments in redisplay_tool_bar and display_mode_line about
22114 it
.paragraph_embedding
= L2R
;
22116 /* Clear all rows of the menu bar. */
22117 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
22119 struct glyph_row
*row
= it
.glyph_row
+ i
;
22120 clear_glyph_row (row
);
22121 row
->enabled_p
= true;
22122 row
->full_width_p
= true;
22123 row
->reversed_p
= false;
22126 /* Display all items of the menu bar. */
22127 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
22128 for (i
= 0; i
< ASIZE (items
); i
+= 4)
22130 Lisp_Object string
;
22132 /* Stop at nil string. */
22133 string
= AREF (items
, i
+ 1);
22137 /* Remember where item was displayed. */
22138 ASET (items
, i
+ 3, make_number (it
.hpos
));
22140 /* Display the item, pad with one space. */
22141 if (it
.current_x
< it
.last_visible_x
)
22142 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
22143 SCHARS (string
) + 1, 0, 0, -1);
22146 /* Fill out the line with spaces. */
22147 if (it
.current_x
< it
.last_visible_x
)
22148 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
22150 /* Compute the total height of the lines. */
22151 compute_line_metrics (&it
);
22154 /* Deep copy of a glyph row, including the glyphs. */
22156 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
22158 struct glyph
*pointers
[1 + LAST_AREA
];
22159 int to_used
= to
->used
[TEXT_AREA
];
22161 /* Save glyph pointers of TO. */
22162 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
22164 /* Do a structure assignment. */
22167 /* Restore original glyph pointers of TO. */
22168 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
22170 /* Copy the glyphs. */
22171 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
22172 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
22174 /* If we filled only part of the TO row, fill the rest with
22175 space_glyph (which will display as empty space). */
22176 if (to_used
> from
->used
[TEXT_AREA
])
22177 fill_up_frame_row_with_spaces (to
, to_used
);
22180 /* Display one menu item on a TTY, by overwriting the glyphs in the
22181 frame F's desired glyph matrix with glyphs produced from the menu
22182 item text. Called from term.c to display TTY drop-down menus one
22185 ITEM_TEXT is the menu item text as a C string.
22187 FACE_ID is the face ID to be used for this menu item. FACE_ID
22188 could specify one of 3 faces: a face for an enabled item, a face
22189 for a disabled item, or a face for a selected item.
22191 X and Y are coordinates of the first glyph in the frame's desired
22192 matrix to be overwritten by the menu item. Since this is a TTY, Y
22193 is the zero-based number of the glyph row and X is the zero-based
22194 glyph number in the row, starting from left, where to start
22195 displaying the item.
22197 SUBMENU means this menu item drops down a submenu, which
22198 should be indicated by displaying a proper visual cue after the
22202 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
22203 int x
, int y
, bool submenu
)
22206 struct frame
*f
= SELECTED_FRAME ();
22207 struct window
*w
= XWINDOW (f
->selected_window
);
22208 struct glyph_row
*row
;
22209 size_t item_len
= strlen (item_text
);
22211 eassert (FRAME_TERMCAP_P (f
));
22213 /* Don't write beyond the matrix's last row. This can happen for
22214 TTY screens that are not high enough to show the entire menu.
22215 (This is actually a bit of defensive programming, as
22216 tty_menu_display already limits the number of menu items to one
22217 less than the number of screen lines.) */
22218 if (y
>= f
->desired_matrix
->nrows
)
22221 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
22222 it
.first_visible_x
= 0;
22223 it
.last_visible_x
= FRAME_COLS (f
) - 1;
22224 row
= it
.glyph_row
;
22225 /* Start with the row contents from the current matrix. */
22226 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
22227 bool saved_width
= row
->full_width_p
;
22228 row
->full_width_p
= true;
22229 bool saved_reversed
= row
->reversed_p
;
22230 row
->reversed_p
= false;
22231 row
->enabled_p
= true;
22233 /* Arrange for the menu item glyphs to start at (X,Y) and have the
22235 eassert (x
< f
->desired_matrix
->matrix_w
);
22236 it
.current_x
= it
.hpos
= x
;
22237 it
.current_y
= it
.vpos
= y
;
22238 int saved_used
= row
->used
[TEXT_AREA
];
22239 bool saved_truncated
= row
->truncated_on_right_p
;
22240 row
->used
[TEXT_AREA
] = x
;
22241 it
.face_id
= face_id
;
22242 it
.line_wrap
= TRUNCATE
;
22244 /* FIXME: This should be controlled by a user option. See the
22245 comments in redisplay_tool_bar and display_mode_line about this.
22246 Also, if paragraph_embedding could ever be R2L, changes will be
22247 needed to avoid shifting to the right the row characters in
22248 term.c:append_glyph. */
22249 it
.paragraph_embedding
= L2R
;
22251 /* Pad with a space on the left. */
22252 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
22254 /* Display the menu item, pad with spaces to WIDTH. */
22257 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
22258 item_len
, 0, FRAME_COLS (f
) - 1, -1);
22260 /* Indicate with " >" that there's a submenu. */
22261 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
22262 FRAME_COLS (f
) - 1, -1);
22265 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
22266 width
, 0, FRAME_COLS (f
) - 1, -1);
22268 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
22269 row
->truncated_on_right_p
= saved_truncated
;
22270 row
->hash
= row_hash (row
);
22271 row
->full_width_p
= saved_width
;
22272 row
->reversed_p
= saved_reversed
;
22275 /***********************************************************************
22277 ***********************************************************************/
22279 /* Redisplay mode lines in the window tree whose root is WINDOW.
22280 If FORCE, redisplay mode lines unconditionally.
22281 Otherwise, redisplay only mode lines that are garbaged. Value is
22282 the number of windows whose mode lines were redisplayed. */
22285 redisplay_mode_lines (Lisp_Object window
, bool force
)
22289 while (!NILP (window
))
22291 struct window
*w
= XWINDOW (window
);
22293 if (WINDOWP (w
->contents
))
22294 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
22296 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
22297 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
22299 struct text_pos lpoint
;
22300 struct buffer
*old
= current_buffer
;
22302 /* Set the window's buffer for the mode line display. */
22303 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
22304 set_buffer_internal_1 (XBUFFER (w
->contents
));
22306 /* Point refers normally to the selected window. For any
22307 other window, set up appropriate value. */
22308 if (!EQ (window
, selected_window
))
22310 struct text_pos pt
;
22312 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
22313 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
22316 /* Display mode lines. */
22317 clear_glyph_matrix (w
->desired_matrix
);
22318 if (display_mode_lines (w
))
22321 /* Restore old settings. */
22322 set_buffer_internal_1 (old
);
22323 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
22333 /* Display the mode and/or header line of window W. Value is the
22334 sum number of mode lines and header lines displayed. */
22337 display_mode_lines (struct window
*w
)
22339 Lisp_Object old_selected_window
= selected_window
;
22340 Lisp_Object old_selected_frame
= selected_frame
;
22341 Lisp_Object new_frame
= w
->frame
;
22342 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
22345 selected_frame
= new_frame
;
22346 /* FIXME: If we were to allow the mode-line's computation changing the buffer
22347 or window's point, then we'd need select_window_1 here as well. */
22348 XSETWINDOW (selected_window
, w
);
22349 XFRAME (new_frame
)->selected_window
= selected_window
;
22351 /* These will be set while the mode line specs are processed. */
22352 line_number_displayed
= false;
22353 w
->column_number_displayed
= -1;
22355 if (WINDOW_WANTS_MODELINE_P (w
))
22357 struct window
*sel_w
= XWINDOW (old_selected_window
);
22359 /* Select mode line face based on the real selected window. */
22360 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
22361 BVAR (current_buffer
, mode_line_format
));
22365 if (WINDOW_WANTS_HEADER_LINE_P (w
))
22367 display_mode_line (w
, HEADER_LINE_FACE_ID
,
22368 BVAR (current_buffer
, header_line_format
));
22372 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
22373 selected_frame
= old_selected_frame
;
22374 selected_window
= old_selected_window
;
22376 w
->must_be_updated_p
= true;
22381 /* Display mode or header line of window W. FACE_ID specifies which
22382 line to display; it is either MODE_LINE_FACE_ID or
22383 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
22384 display. Value is the pixel height of the mode/header line
22388 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
22392 ptrdiff_t count
= SPECPDL_INDEX ();
22394 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22395 /* Don't extend on a previously drawn mode-line.
22396 This may happen if called from pos_visible_p. */
22397 it
.glyph_row
->enabled_p
= false;
22398 prepare_desired_row (w
, it
.glyph_row
, true);
22400 it
.glyph_row
->mode_line_p
= true;
22402 /* FIXME: This should be controlled by a user option. But
22403 supporting such an option is not trivial, since the mode line is
22404 made up of many separate strings. */
22405 it
.paragraph_embedding
= L2R
;
22407 record_unwind_protect (unwind_format_mode_line
,
22408 format_mode_line_unwind_data (NULL
, NULL
,
22411 mode_line_target
= MODE_LINE_DISPLAY
;
22413 /* Temporarily make frame's keyboard the current kboard so that
22414 kboard-local variables in the mode_line_format will get the right
22416 push_kboard (FRAME_KBOARD (it
.f
));
22417 record_unwind_save_match_data ();
22418 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22421 unbind_to (count
, Qnil
);
22423 /* Fill up with spaces. */
22424 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
22426 compute_line_metrics (&it
);
22427 it
.glyph_row
->full_width_p
= true;
22428 it
.glyph_row
->continued_p
= false;
22429 it
.glyph_row
->truncated_on_left_p
= false;
22430 it
.glyph_row
->truncated_on_right_p
= false;
22432 /* Make a 3D mode-line have a shadow at its right end. */
22433 face
= FACE_FROM_ID (it
.f
, face_id
);
22434 extend_face_to_end_of_line (&it
);
22435 if (face
->box
!= FACE_NO_BOX
)
22437 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
22438 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
22439 last
->right_box_line_p
= true;
22442 return it
.glyph_row
->height
;
22445 /* Move element ELT in LIST to the front of LIST.
22446 Return the updated list. */
22449 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
22451 register Lisp_Object tail
, prev
;
22452 register Lisp_Object tem
;
22456 while (CONSP (tail
))
22462 /* Splice out the link TAIL. */
22464 list
= XCDR (tail
);
22466 Fsetcdr (prev
, XCDR (tail
));
22468 /* Now make it the first. */
22469 Fsetcdr (tail
, list
);
22474 tail
= XCDR (tail
);
22478 /* Not found--return unchanged LIST. */
22482 /* Contribute ELT to the mode line for window IT->w. How it
22483 translates into text depends on its data type.
22485 IT describes the display environment in which we display, as usual.
22487 DEPTH is the depth in recursion. It is used to prevent
22488 infinite recursion here.
22490 FIELD_WIDTH is the number of characters the display of ELT should
22491 occupy in the mode line, and PRECISION is the maximum number of
22492 characters to display from ELT's representation. See
22493 display_string for details.
22495 Returns the hpos of the end of the text generated by ELT.
22497 PROPS is a property list to add to any string we encounter.
22499 If RISKY, remove (disregard) any properties in any string
22500 we encounter, and ignore :eval and :propertize.
22502 The global variable `mode_line_target' determines whether the
22503 output is passed to `store_mode_line_noprop',
22504 `store_mode_line_string', or `display_string'. */
22507 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
22508 Lisp_Object elt
, Lisp_Object props
, bool risky
)
22510 int n
= 0, field
, prec
;
22511 bool literal
= false;
22515 elt
= build_string ("*too-deep*");
22519 switch (XTYPE (elt
))
22523 /* A string: output it and check for %-constructs within it. */
22525 ptrdiff_t offset
= 0;
22527 if (SCHARS (elt
) > 0
22528 && (!NILP (props
) || risky
))
22530 Lisp_Object oprops
, aelt
;
22531 oprops
= Ftext_properties_at (make_number (0), elt
);
22533 /* If the starting string's properties are not what
22534 we want, translate the string. Also, if the string
22535 is risky, do that anyway. */
22537 if (NILP (Fequal (props
, oprops
)) || risky
)
22539 /* If the starting string has properties,
22540 merge the specified ones onto the existing ones. */
22541 if (! NILP (oprops
) && !risky
)
22545 oprops
= Fcopy_sequence (oprops
);
22547 while (CONSP (tem
))
22549 oprops
= Fplist_put (oprops
, XCAR (tem
),
22550 XCAR (XCDR (tem
)));
22551 tem
= XCDR (XCDR (tem
));
22556 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
22557 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
22559 /* AELT is what we want. Move it to the front
22560 without consing. */
22562 mode_line_proptrans_alist
22563 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
22569 /* If AELT has the wrong props, it is useless.
22570 so get rid of it. */
22572 mode_line_proptrans_alist
22573 = Fdelq (aelt
, mode_line_proptrans_alist
);
22575 elt
= Fcopy_sequence (elt
);
22576 Fset_text_properties (make_number (0), Flength (elt
),
22578 /* Add this item to mode_line_proptrans_alist. */
22579 mode_line_proptrans_alist
22580 = Fcons (Fcons (elt
, props
),
22581 mode_line_proptrans_alist
);
22582 /* Truncate mode_line_proptrans_alist
22583 to at most 50 elements. */
22584 tem
= Fnthcdr (make_number (50),
22585 mode_line_proptrans_alist
);
22587 XSETCDR (tem
, Qnil
);
22596 prec
= precision
- n
;
22597 switch (mode_line_target
)
22599 case MODE_LINE_NOPROP
:
22600 case MODE_LINE_TITLE
:
22601 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
22603 case MODE_LINE_STRING
:
22604 n
+= store_mode_line_string (NULL
, elt
, true, 0, prec
, Qnil
);
22606 case MODE_LINE_DISPLAY
:
22607 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
22608 0, prec
, 0, STRING_MULTIBYTE (elt
));
22615 /* Handle the non-literal case. */
22617 while ((precision
<= 0 || n
< precision
)
22618 && SREF (elt
, offset
) != 0
22619 && (mode_line_target
!= MODE_LINE_DISPLAY
22620 || it
->current_x
< it
->last_visible_x
))
22622 ptrdiff_t last_offset
= offset
;
22624 /* Advance to end of string or next format specifier. */
22625 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22628 if (offset
- 1 != last_offset
)
22630 ptrdiff_t nchars
, nbytes
;
22632 /* Output to end of string or up to '%'. Field width
22633 is length of string. Don't output more than
22634 PRECISION allows us. */
22637 prec
= c_string_width (SDATA (elt
) + last_offset
,
22638 offset
- last_offset
, precision
- n
,
22641 switch (mode_line_target
)
22643 case MODE_LINE_NOPROP
:
22644 case MODE_LINE_TITLE
:
22645 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22647 case MODE_LINE_STRING
:
22649 ptrdiff_t bytepos
= last_offset
;
22650 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22651 ptrdiff_t endpos
= (precision
<= 0
22652 ? string_byte_to_char (elt
, offset
)
22653 : charpos
+ nchars
);
22654 Lisp_Object mode_string
22655 = Fsubstring (elt
, make_number (charpos
),
22656 make_number (endpos
));
22657 n
+= store_mode_line_string (NULL
, mode_string
, false,
22661 case MODE_LINE_DISPLAY
:
22663 ptrdiff_t bytepos
= last_offset
;
22664 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22666 if (precision
<= 0)
22667 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22668 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22670 STRING_MULTIBYTE (elt
));
22675 else /* c == '%' */
22677 ptrdiff_t percent_position
= offset
;
22679 /* Get the specified minimum width. Zero means
22682 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22683 field
= field
* 10 + c
- '0';
22685 /* Don't pad beyond the total padding allowed. */
22686 if (field_width
- n
> 0 && field
> field_width
- n
)
22687 field
= field_width
- n
;
22689 /* Note that either PRECISION <= 0 or N < PRECISION. */
22690 prec
= precision
- n
;
22693 n
+= display_mode_element (it
, depth
, field
, prec
,
22694 Vglobal_mode_string
, props
,
22699 ptrdiff_t bytepos
, charpos
;
22701 Lisp_Object string
;
22703 bytepos
= percent_position
;
22704 charpos
= (STRING_MULTIBYTE (elt
)
22705 ? string_byte_to_char (elt
, bytepos
)
22707 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22708 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22710 switch (mode_line_target
)
22712 case MODE_LINE_NOPROP
:
22713 case MODE_LINE_TITLE
:
22714 n
+= store_mode_line_noprop (spec
, field
, prec
);
22716 case MODE_LINE_STRING
:
22718 Lisp_Object tem
= build_string (spec
);
22719 props
= Ftext_properties_at (make_number (charpos
), elt
);
22720 /* Should only keep face property in props */
22721 n
+= store_mode_line_string (NULL
, tem
, false,
22722 field
, prec
, props
);
22725 case MODE_LINE_DISPLAY
:
22727 int nglyphs_before
, nwritten
;
22729 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22730 nwritten
= display_string (spec
, string
, elt
,
22735 /* Assign to the glyphs written above the
22736 string where the `%x' came from, position
22740 struct glyph
*glyph
22741 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22745 for (i
= 0; i
< nwritten
; ++i
)
22747 glyph
[i
].object
= elt
;
22748 glyph
[i
].charpos
= charpos
;
22765 /* A symbol: process the value of the symbol recursively
22766 as if it appeared here directly. Avoid error if symbol void.
22767 Special case: if value of symbol is a string, output the string
22770 register Lisp_Object tem
;
22772 /* If the variable is not marked as risky to set
22773 then its contents are risky to use. */
22774 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22777 tem
= Fboundp (elt
);
22780 tem
= Fsymbol_value (elt
);
22781 /* If value is a string, output that string literally:
22782 don't check for % within it. */
22786 if (!EQ (tem
, elt
))
22788 /* Give up right away for nil or t. */
22798 register Lisp_Object car
, tem
;
22800 /* A cons cell: five distinct cases.
22801 If first element is :eval or :propertize, do something special.
22802 If first element is a string or a cons, process all the elements
22803 and effectively concatenate them.
22804 If first element is a negative number, truncate displaying cdr to
22805 at most that many characters. If positive, pad (with spaces)
22806 to at least that many characters.
22807 If first element is a symbol, process the cadr or caddr recursively
22808 according to whether the symbol's value is non-nil or nil. */
22810 if (EQ (car
, QCeval
))
22812 /* An element of the form (:eval FORM) means evaluate FORM
22813 and use the result as mode line elements. */
22818 if (CONSP (XCDR (elt
)))
22821 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22822 n
+= display_mode_element (it
, depth
, field_width
- n
,
22823 precision
- n
, spec
, props
,
22827 else if (EQ (car
, QCpropertize
))
22829 /* An element of the form (:propertize ELT PROPS...)
22830 means display ELT but applying properties PROPS. */
22835 if (CONSP (XCDR (elt
)))
22836 n
+= display_mode_element (it
, depth
, field_width
- n
,
22837 precision
- n
, XCAR (XCDR (elt
)),
22838 XCDR (XCDR (elt
)), risky
);
22840 else if (SYMBOLP (car
))
22842 tem
= Fboundp (car
);
22846 /* elt is now the cdr, and we know it is a cons cell.
22847 Use its car if CAR has a non-nil value. */
22850 tem
= Fsymbol_value (car
);
22857 /* Symbol's value is nil (or symbol is unbound)
22858 Get the cddr of the original list
22859 and if possible find the caddr and use that. */
22863 else if (!CONSP (elt
))
22868 else if (INTEGERP (car
))
22870 register int lim
= XINT (car
);
22874 /* Negative int means reduce maximum width. */
22875 if (precision
<= 0)
22878 precision
= min (precision
, -lim
);
22882 /* Padding specified. Don't let it be more than
22883 current maximum. */
22885 lim
= min (precision
, lim
);
22887 /* If that's more padding than already wanted, queue it.
22888 But don't reduce padding already specified even if
22889 that is beyond the current truncation point. */
22890 field_width
= max (lim
, field_width
);
22894 else if (STRINGP (car
) || CONSP (car
))
22896 Lisp_Object halftail
= elt
;
22900 && (precision
<= 0 || n
< precision
))
22902 n
+= display_mode_element (it
, depth
,
22903 /* Do padding only after the last
22904 element in the list. */
22905 (! CONSP (XCDR (elt
))
22908 precision
- n
, XCAR (elt
),
22912 if ((len
& 1) == 0)
22913 halftail
= XCDR (halftail
);
22914 /* Check for cycle. */
22915 if (EQ (halftail
, elt
))
22924 elt
= build_string ("*invalid*");
22928 /* Pad to FIELD_WIDTH. */
22929 if (field_width
> 0 && n
< field_width
)
22931 switch (mode_line_target
)
22933 case MODE_LINE_NOPROP
:
22934 case MODE_LINE_TITLE
:
22935 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22937 case MODE_LINE_STRING
:
22938 n
+= store_mode_line_string ("", Qnil
, false, field_width
- n
, 0,
22941 case MODE_LINE_DISPLAY
:
22942 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22951 /* Store a mode-line string element in mode_line_string_list.
22953 If STRING is non-null, display that C string. Otherwise, the Lisp
22954 string LISP_STRING is displayed.
22956 FIELD_WIDTH is the minimum number of output glyphs to produce.
22957 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22958 with spaces. FIELD_WIDTH <= 0 means don't pad.
22960 PRECISION is the maximum number of characters to output from
22961 STRING. PRECISION <= 0 means don't truncate the string.
22963 If COPY_STRING, make a copy of LISP_STRING before adding
22964 properties to the string.
22966 PROPS are the properties to add to the string.
22967 The mode_line_string_face face property is always added to the string.
22971 store_mode_line_string (const char *string
, Lisp_Object lisp_string
,
22973 int field_width
, int precision
, Lisp_Object props
)
22978 if (string
!= NULL
)
22980 len
= strlen (string
);
22981 if (precision
> 0 && len
> precision
)
22983 lisp_string
= make_string (string
, len
);
22985 props
= mode_line_string_face_prop
;
22986 else if (!NILP (mode_line_string_face
))
22988 Lisp_Object face
= Fplist_get (props
, Qface
);
22989 props
= Fcopy_sequence (props
);
22991 face
= mode_line_string_face
;
22993 face
= list2 (face
, mode_line_string_face
);
22994 props
= Fplist_put (props
, Qface
, face
);
22996 Fadd_text_properties (make_number (0), make_number (len
),
22997 props
, lisp_string
);
23001 len
= XFASTINT (Flength (lisp_string
));
23002 if (precision
> 0 && len
> precision
)
23005 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
23008 if (!NILP (mode_line_string_face
))
23012 props
= Ftext_properties_at (make_number (0), lisp_string
);
23013 face
= Fplist_get (props
, Qface
);
23015 face
= mode_line_string_face
;
23017 face
= list2 (face
, mode_line_string_face
);
23018 props
= list2 (Qface
, face
);
23020 lisp_string
= Fcopy_sequence (lisp_string
);
23023 Fadd_text_properties (make_number (0), make_number (len
),
23024 props
, lisp_string
);
23029 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
23033 if (field_width
> len
)
23035 field_width
-= len
;
23036 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
23038 Fadd_text_properties (make_number (0), make_number (field_width
),
23039 props
, lisp_string
);
23040 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
23048 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
23050 doc
: /* Format a string out of a mode line format specification.
23051 First arg FORMAT specifies the mode line format (see `mode-line-format'
23052 for details) to use.
23054 By default, the format is evaluated for the currently selected window.
23056 Optional second arg FACE specifies the face property to put on all
23057 characters for which no face is specified. The value nil means the
23058 default face. The value t means whatever face the window's mode line
23059 currently uses (either `mode-line' or `mode-line-inactive',
23060 depending on whether the window is the selected window or not).
23061 An integer value means the value string has no text
23064 Optional third and fourth args WINDOW and BUFFER specify the window
23065 and buffer to use as the context for the formatting (defaults
23066 are the selected window and the WINDOW's buffer). */)
23067 (Lisp_Object format
, Lisp_Object face
,
23068 Lisp_Object window
, Lisp_Object buffer
)
23073 struct buffer
*old_buffer
= NULL
;
23075 bool no_props
= INTEGERP (face
);
23076 ptrdiff_t count
= SPECPDL_INDEX ();
23078 int string_start
= 0;
23080 w
= decode_any_window (window
);
23081 XSETWINDOW (window
, w
);
23084 buffer
= w
->contents
;
23085 CHECK_BUFFER (buffer
);
23087 /* Make formatting the modeline a non-op when noninteractive, otherwise
23088 there will be problems later caused by a partially initialized frame. */
23089 if (NILP (format
) || noninteractive
)
23090 return empty_unibyte_string
;
23095 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
23096 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
23097 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
23098 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
23099 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
23100 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
23101 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
23104 old_buffer
= current_buffer
;
23106 /* Save things including mode_line_proptrans_alist,
23107 and set that to nil so that we don't alter the outer value. */
23108 record_unwind_protect (unwind_format_mode_line
,
23109 format_mode_line_unwind_data
23110 (XFRAME (WINDOW_FRAME (w
)),
23111 old_buffer
, selected_window
, true));
23112 mode_line_proptrans_alist
= Qnil
;
23114 Fselect_window (window
, Qt
);
23115 set_buffer_internal_1 (XBUFFER (buffer
));
23117 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
23121 mode_line_target
= MODE_LINE_NOPROP
;
23122 mode_line_string_face_prop
= Qnil
;
23123 mode_line_string_list
= Qnil
;
23124 string_start
= MODE_LINE_NOPROP_LEN (0);
23128 mode_line_target
= MODE_LINE_STRING
;
23129 mode_line_string_list
= Qnil
;
23130 mode_line_string_face
= face
;
23131 mode_line_string_face_prop
23132 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
23135 push_kboard (FRAME_KBOARD (it
.f
));
23136 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
23141 len
= MODE_LINE_NOPROP_LEN (string_start
);
23142 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
23146 mode_line_string_list
= Fnreverse (mode_line_string_list
);
23147 str
= Fmapconcat (Qidentity
, mode_line_string_list
,
23148 empty_unibyte_string
);
23151 unbind_to (count
, Qnil
);
23155 /* Write a null-terminated, right justified decimal representation of
23156 the positive integer D to BUF using a minimal field width WIDTH. */
23159 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
23161 register char *p
= buf
;
23169 *p
++ = d
% 10 + '0';
23174 for (width
-= (int) (p
- buf
); width
> 0; --width
)
23185 /* Write a null-terminated, right justified decimal and "human
23186 readable" representation of the nonnegative integer D to BUF using
23187 a minimal field width WIDTH. D should be smaller than 999.5e24. */
23189 static const char power_letter
[] =
23203 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
23205 /* We aim to represent the nonnegative integer D as
23206 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
23207 ptrdiff_t quotient
= d
;
23209 /* -1 means: do not use TENTHS. */
23213 /* Length of QUOTIENT.TENTHS as a string. */
23219 if (quotient
>= 1000)
23221 /* Scale to the appropriate EXPONENT. */
23224 remainder
= quotient
% 1000;
23228 while (quotient
>= 1000);
23230 /* Round to nearest and decide whether to use TENTHS or not. */
23233 tenths
= remainder
/ 100;
23234 if (remainder
% 100 >= 50)
23241 if (quotient
== 10)
23249 if (remainder
>= 500)
23251 if (quotient
< 999)
23262 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
23263 if (tenths
== -1 && quotient
<= 99)
23270 p
= psuffix
= buf
+ max (width
, length
);
23272 /* Print EXPONENT. */
23273 *psuffix
++ = power_letter
[exponent
];
23276 /* Print TENTHS. */
23279 *--p
= '0' + tenths
;
23283 /* Print QUOTIENT. */
23286 int digit
= quotient
% 10;
23287 *--p
= '0' + digit
;
23289 while ((quotient
/= 10) != 0);
23291 /* Print leading spaces. */
23296 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
23297 If EOL_FLAG, set also a mnemonic character for end-of-line
23298 type of CODING_SYSTEM. Return updated pointer into BUF. */
23300 static unsigned char invalid_eol_type
[] = "(*invalid*)";
23303 decode_mode_spec_coding (Lisp_Object coding_system
, char *buf
, bool eol_flag
)
23306 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
23307 const unsigned char *eol_str
;
23309 /* The EOL conversion we are using. */
23310 Lisp_Object eoltype
;
23312 val
= CODING_SYSTEM_SPEC (coding_system
);
23315 if (!VECTORP (val
)) /* Not yet decided. */
23317 *buf
++ = multibyte
? '-' : ' ';
23319 eoltype
= eol_mnemonic_undecided
;
23320 /* Don't mention EOL conversion if it isn't decided. */
23325 Lisp_Object eolvalue
;
23327 attrs
= AREF (val
, 0);
23328 eolvalue
= AREF (val
, 2);
23331 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
23336 /* The EOL conversion that is normal on this system. */
23338 if (NILP (eolvalue
)) /* Not yet decided. */
23339 eoltype
= eol_mnemonic_undecided
;
23340 else if (VECTORP (eolvalue
)) /* Not yet decided. */
23341 eoltype
= eol_mnemonic_undecided
;
23342 else /* eolvalue is Qunix, Qdos, or Qmac. */
23343 eoltype
= (EQ (eolvalue
, Qunix
)
23344 ? eol_mnemonic_unix
23345 : EQ (eolvalue
, Qdos
)
23346 ? eol_mnemonic_dos
: eol_mnemonic_mac
);
23352 /* Mention the EOL conversion if it is not the usual one. */
23353 if (STRINGP (eoltype
))
23355 eol_str
= SDATA (eoltype
);
23356 eol_str_len
= SBYTES (eoltype
);
23358 else if (CHARACTERP (eoltype
))
23360 int c
= XFASTINT (eoltype
);
23361 return buf
+ CHAR_STRING (c
, (unsigned char *) buf
);
23365 eol_str
= invalid_eol_type
;
23366 eol_str_len
= sizeof (invalid_eol_type
) - 1;
23368 memcpy (buf
, eol_str
, eol_str_len
);
23369 buf
+= eol_str_len
;
23375 /* Return a string for the output of a mode line %-spec for window W,
23376 generated by character C. FIELD_WIDTH > 0 means pad the string
23377 returned with spaces to that value. Return a Lisp string in
23378 *STRING if the resulting string is taken from that Lisp string.
23380 Note we operate on the current buffer for most purposes. */
23382 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
23384 static const char *
23385 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
23386 Lisp_Object
*string
)
23389 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23390 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
23391 /* We are going to use f->decode_mode_spec_buffer as the buffer to
23392 produce strings from numerical values, so limit preposterously
23393 large values of FIELD_WIDTH to avoid overrunning the buffer's
23394 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
23395 bytes plus the terminating null. */
23396 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
23397 struct buffer
*b
= current_buffer
;
23405 if (!NILP (BVAR (b
, read_only
)))
23407 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23412 /* This differs from %* only for a modified read-only buffer. */
23413 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23415 if (!NILP (BVAR (b
, read_only
)))
23420 /* This differs from %* in ignoring read-only-ness. */
23421 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23433 if (command_loop_level
> 5)
23435 p
= decode_mode_spec_buf
;
23436 for (i
= 0; i
< command_loop_level
; i
++)
23439 return decode_mode_spec_buf
;
23447 if (command_loop_level
> 5)
23449 p
= decode_mode_spec_buf
;
23450 for (i
= 0; i
< command_loop_level
; i
++)
23453 return decode_mode_spec_buf
;
23460 /* Let lots_of_dashes be a string of infinite length. */
23461 if (mode_line_target
== MODE_LINE_NOPROP
23462 || mode_line_target
== MODE_LINE_STRING
)
23464 if (field_width
<= 0
23465 || field_width
> sizeof (lots_of_dashes
))
23467 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
23468 decode_mode_spec_buf
[i
] = '-';
23469 decode_mode_spec_buf
[i
] = '\0';
23470 return decode_mode_spec_buf
;
23473 return lots_of_dashes
;
23477 obj
= BVAR (b
, name
);
23481 /* %c and %l are ignored in `frame-title-format'.
23482 (In redisplay_internal, the frame title is drawn _before_ the
23483 windows are updated, so the stuff which depends on actual
23484 window contents (such as %l) may fail to render properly, or
23485 even crash emacs.) */
23486 if (mode_line_target
== MODE_LINE_TITLE
)
23490 ptrdiff_t col
= current_column ();
23491 w
->column_number_displayed
= col
;
23492 pint2str (decode_mode_spec_buf
, width
, col
);
23493 return decode_mode_spec_buf
;
23497 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
23499 if (NILP (Vmemory_full
))
23502 return "!MEM FULL! ";
23509 /* %F displays the frame name. */
23510 if (!NILP (f
->title
))
23511 return SSDATA (f
->title
);
23512 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
23513 return SSDATA (f
->name
);
23517 obj
= BVAR (b
, filename
);
23522 ptrdiff_t size
= ZV
- BEGV
;
23523 pint2str (decode_mode_spec_buf
, width
, size
);
23524 return decode_mode_spec_buf
;
23529 ptrdiff_t size
= ZV
- BEGV
;
23530 pint2hrstr (decode_mode_spec_buf
, width
, size
);
23531 return decode_mode_spec_buf
;
23536 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
23537 ptrdiff_t topline
, nlines
, height
;
23540 /* %c and %l are ignored in `frame-title-format'. */
23541 if (mode_line_target
== MODE_LINE_TITLE
)
23544 startpos
= marker_position (w
->start
);
23545 startpos_byte
= marker_byte_position (w
->start
);
23546 height
= WINDOW_TOTAL_LINES (w
);
23548 /* If we decided that this buffer isn't suitable for line numbers,
23549 don't forget that too fast. */
23550 if (w
->base_line_pos
== -1)
23553 /* If the buffer is very big, don't waste time. */
23554 if (INTEGERP (Vline_number_display_limit
)
23555 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
23557 w
->base_line_pos
= 0;
23558 w
->base_line_number
= 0;
23562 if (w
->base_line_number
> 0
23563 && w
->base_line_pos
> 0
23564 && w
->base_line_pos
<= startpos
)
23566 line
= w
->base_line_number
;
23567 linepos
= w
->base_line_pos
;
23568 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
23573 linepos
= BUF_BEGV (b
);
23574 linepos_byte
= BUF_BEGV_BYTE (b
);
23577 /* Count lines from base line to window start position. */
23578 nlines
= display_count_lines (linepos_byte
,
23582 topline
= nlines
+ line
;
23584 /* Determine a new base line, if the old one is too close
23585 or too far away, or if we did not have one.
23586 "Too close" means it's plausible a scroll-down would
23587 go back past it. */
23588 if (startpos
== BUF_BEGV (b
))
23590 w
->base_line_number
= topline
;
23591 w
->base_line_pos
= BUF_BEGV (b
);
23593 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
23594 || linepos
== BUF_BEGV (b
))
23596 ptrdiff_t limit
= BUF_BEGV (b
);
23597 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
23598 ptrdiff_t position
;
23599 ptrdiff_t distance
=
23600 (height
* 2 + 30) * line_number_display_limit_width
;
23602 if (startpos
- distance
> limit
)
23604 limit
= startpos
- distance
;
23605 limit_byte
= CHAR_TO_BYTE (limit
);
23608 nlines
= display_count_lines (startpos_byte
,
23610 - (height
* 2 + 30),
23612 /* If we couldn't find the lines we wanted within
23613 line_number_display_limit_width chars per line,
23614 give up on line numbers for this window. */
23615 if (position
== limit_byte
&& limit
== startpos
- distance
)
23617 w
->base_line_pos
= -1;
23618 w
->base_line_number
= 0;
23622 w
->base_line_number
= topline
- nlines
;
23623 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23626 /* Now count lines from the start pos to point. */
23627 nlines
= display_count_lines (startpos_byte
,
23628 PT_BYTE
, PT
, &junk
);
23630 /* Record that we did display the line number. */
23631 line_number_displayed
= true;
23633 /* Make the string to show. */
23634 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23635 return decode_mode_spec_buf
;
23638 char *p
= decode_mode_spec_buf
;
23639 int pad
= width
- 2;
23645 return decode_mode_spec_buf
;
23651 obj
= BVAR (b
, mode_name
);
23655 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23661 ptrdiff_t pos
= marker_position (w
->start
);
23662 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23664 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23666 if (pos
<= BUF_BEGV (b
))
23671 else if (pos
<= BUF_BEGV (b
))
23675 if (total
> 1000000)
23676 /* Do it differently for a large value, to avoid overflow. */
23677 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23679 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23680 /* We can't normally display a 3-digit number,
23681 so get us a 2-digit number that is close. */
23684 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23685 return decode_mode_spec_buf
;
23689 /* Display percentage of size above the bottom of the screen. */
23692 ptrdiff_t toppos
= marker_position (w
->start
);
23693 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23694 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23696 if (botpos
>= BUF_ZV (b
))
23698 if (toppos
<= BUF_BEGV (b
))
23705 if (total
> 1000000)
23706 /* Do it differently for a large value, to avoid overflow. */
23707 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23709 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23710 /* We can't normally display a 3-digit number,
23711 so get us a 2-digit number that is close. */
23714 if (toppos
<= BUF_BEGV (b
))
23715 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23717 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23718 return decode_mode_spec_buf
;
23723 /* status of process */
23724 obj
= Fget_buffer_process (Fcurrent_buffer ());
23726 return "no process";
23728 obj
= Fsymbol_name (Fprocess_status (obj
));
23734 ptrdiff_t count
= inhibit_garbage_collection ();
23735 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23736 Lisp_Object val
= Qnil
;
23738 if (STRINGP (curdir
))
23739 val
= call1 (intern ("file-remote-p"), curdir
);
23741 unbind_to (count
, Qnil
);
23750 /* coding-system (not including end-of-line format) */
23752 /* coding-system (including end-of-line type) */
23754 bool eol_flag
= (c
== 'Z');
23755 char *p
= decode_mode_spec_buf
;
23757 if (! FRAME_WINDOW_P (f
))
23759 /* No need to mention EOL here--the terminal never needs
23760 to do EOL conversion. */
23761 p
= decode_mode_spec_coding (CODING_ID_NAME
23762 (FRAME_KEYBOARD_CODING (f
)->id
),
23764 p
= decode_mode_spec_coding (CODING_ID_NAME
23765 (FRAME_TERMINAL_CODING (f
)->id
),
23768 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23771 #if false /* This proves to be annoying; I think we can do without. -- rms. */
23772 #ifdef subprocesses
23773 obj
= Fget_buffer_process (Fcurrent_buffer ());
23774 if (PROCESSP (obj
))
23776 p
= decode_mode_spec_coding
23777 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23778 p
= decode_mode_spec_coding
23779 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23781 #endif /* subprocesses */
23784 return decode_mode_spec_buf
;
23791 return SSDATA (obj
);
23798 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23799 means count lines back from START_BYTE. But don't go beyond
23800 LIMIT_BYTE. Return the number of lines thus found (always
23803 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23804 either the position COUNT lines after/before START_BYTE, if we
23805 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23809 display_count_lines (ptrdiff_t start_byte
,
23810 ptrdiff_t limit_byte
, ptrdiff_t count
,
23811 ptrdiff_t *byte_pos_ptr
)
23813 register unsigned char *cursor
;
23814 unsigned char *base
;
23816 register ptrdiff_t ceiling
;
23817 register unsigned char *ceiling_addr
;
23818 ptrdiff_t orig_count
= count
;
23820 /* If we are not in selective display mode,
23821 check only for newlines. */
23822 bool selective_display
23823 = (!NILP (BVAR (current_buffer
, selective_display
))
23824 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23828 while (start_byte
< limit_byte
)
23830 ceiling
= BUFFER_CEILING_OF (start_byte
);
23831 ceiling
= min (limit_byte
- 1, ceiling
);
23832 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23833 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23837 if (selective_display
)
23839 while (*cursor
!= '\n' && *cursor
!= 015
23840 && ++cursor
!= ceiling_addr
)
23842 if (cursor
== ceiling_addr
)
23847 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23856 start_byte
+= cursor
- base
;
23857 *byte_pos_ptr
= start_byte
;
23861 while (cursor
< ceiling_addr
);
23863 start_byte
+= ceiling_addr
- base
;
23868 while (start_byte
> limit_byte
)
23870 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23871 ceiling
= max (limit_byte
, ceiling
);
23872 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23873 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23876 if (selective_display
)
23878 while (--cursor
>= ceiling_addr
23879 && *cursor
!= '\n' && *cursor
!= 015)
23881 if (cursor
< ceiling_addr
)
23886 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23893 start_byte
+= cursor
- base
+ 1;
23894 *byte_pos_ptr
= start_byte
;
23895 /* When scanning backwards, we should
23896 not count the newline posterior to which we stop. */
23897 return - orig_count
- 1;
23900 start_byte
+= ceiling_addr
- base
;
23904 *byte_pos_ptr
= limit_byte
;
23907 return - orig_count
+ count
;
23908 return orig_count
- count
;
23914 /***********************************************************************
23916 ***********************************************************************/
23918 /* Display a NUL-terminated string, starting with index START.
23920 If STRING is non-null, display that C string. Otherwise, the Lisp
23921 string LISP_STRING is displayed. There's a case that STRING is
23922 non-null and LISP_STRING is not nil. It means STRING is a string
23923 data of LISP_STRING. In that case, we display LISP_STRING while
23924 ignoring its text properties.
23926 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23927 FACE_STRING. Display STRING or LISP_STRING with the face at
23928 FACE_STRING_POS in FACE_STRING:
23930 Display the string in the environment given by IT, but use the
23931 standard display table, temporarily.
23933 FIELD_WIDTH is the minimum number of output glyphs to produce.
23934 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23935 with spaces. If STRING has more characters, more than FIELD_WIDTH
23936 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23938 PRECISION is the maximum number of characters to output from
23939 STRING. PRECISION < 0 means don't truncate the string.
23941 This is roughly equivalent to printf format specifiers:
23943 FIELD_WIDTH PRECISION PRINTF
23944 ----------------------------------------
23950 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23951 display them, and < 0 means obey the current buffer's value of
23952 enable_multibyte_characters.
23954 Value is the number of columns displayed. */
23957 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23958 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23959 int field_width
, int precision
, int max_x
, int multibyte
)
23961 int hpos_at_start
= it
->hpos
;
23962 int saved_face_id
= it
->face_id
;
23963 struct glyph_row
*row
= it
->glyph_row
;
23964 ptrdiff_t it_charpos
;
23966 /* Initialize the iterator IT for iteration over STRING beginning
23967 with index START. */
23968 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23969 precision
, field_width
, multibyte
);
23970 if (string
&& STRINGP (lisp_string
))
23971 /* LISP_STRING is the one returned by decode_mode_spec. We should
23972 ignore its text properties. */
23973 it
->stop_charpos
= it
->end_charpos
;
23975 /* If displaying STRING, set up the face of the iterator from
23976 FACE_STRING, if that's given. */
23977 if (STRINGP (face_string
))
23983 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23984 0, &endptr
, it
->base_face_id
, false);
23985 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23986 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23989 /* Set max_x to the maximum allowed X position. Don't let it go
23990 beyond the right edge of the window. */
23992 max_x
= it
->last_visible_x
;
23994 max_x
= min (max_x
, it
->last_visible_x
);
23996 /* Skip over display elements that are not visible. because IT->w is
23998 if (it
->current_x
< it
->first_visible_x
)
23999 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
24000 MOVE_TO_POS
| MOVE_TO_X
);
24002 row
->ascent
= it
->max_ascent
;
24003 row
->height
= it
->max_ascent
+ it
->max_descent
;
24004 row
->phys_ascent
= it
->max_phys_ascent
;
24005 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
24006 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
24008 if (STRINGP (it
->string
))
24009 it_charpos
= IT_STRING_CHARPOS (*it
);
24011 it_charpos
= IT_CHARPOS (*it
);
24013 /* This condition is for the case that we are called with current_x
24014 past last_visible_x. */
24015 while (it
->current_x
< max_x
)
24017 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
24019 /* Get the next display element. */
24020 if (!get_next_display_element (it
))
24023 /* Produce glyphs. */
24024 x_before
= it
->current_x
;
24025 n_glyphs_before
= row
->used
[TEXT_AREA
];
24026 PRODUCE_GLYPHS (it
);
24028 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
24031 while (i
< nglyphs
)
24033 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
24035 if (it
->line_wrap
!= TRUNCATE
24036 && x
+ glyph
->pixel_width
> max_x
)
24038 /* End of continued line or max_x reached. */
24039 if (CHAR_GLYPH_PADDING_P (*glyph
))
24041 /* A wide character is unbreakable. */
24042 if (row
->reversed_p
)
24043 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
24044 - n_glyphs_before
);
24045 row
->used
[TEXT_AREA
] = n_glyphs_before
;
24046 it
->current_x
= x_before
;
24050 if (row
->reversed_p
)
24051 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
24052 - (n_glyphs_before
+ i
));
24053 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
24058 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
24060 /* Glyph is at least partially visible. */
24062 if (x
< it
->first_visible_x
)
24063 row
->x
= x
- it
->first_visible_x
;
24067 /* Glyph is off the left margin of the display area.
24068 Should not happen. */
24072 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
24073 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
24074 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
24075 row
->phys_height
= max (row
->phys_height
,
24076 it
->max_phys_ascent
+ it
->max_phys_descent
);
24077 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
24078 it
->max_extra_line_spacing
);
24079 x
+= glyph
->pixel_width
;
24083 /* Stop if max_x reached. */
24087 /* Stop at line ends. */
24088 if (ITERATOR_AT_END_OF_LINE_P (it
))
24090 it
->continuation_lines_width
= 0;
24094 set_iterator_to_next (it
, true);
24095 if (STRINGP (it
->string
))
24096 it_charpos
= IT_STRING_CHARPOS (*it
);
24098 it_charpos
= IT_CHARPOS (*it
);
24100 /* Stop if truncating at the right edge. */
24101 if (it
->line_wrap
== TRUNCATE
24102 && it
->current_x
>= it
->last_visible_x
)
24104 /* Add truncation mark, but don't do it if the line is
24105 truncated at a padding space. */
24106 if (it_charpos
< it
->string_nchars
)
24108 if (!FRAME_WINDOW_P (it
->f
))
24112 if (it
->current_x
> it
->last_visible_x
)
24114 if (!row
->reversed_p
)
24116 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
24117 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
24122 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
24123 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
24125 unproduce_glyphs (it
, ii
+ 1);
24126 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
24128 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
24130 row
->used
[TEXT_AREA
] = ii
;
24131 produce_special_glyphs (it
, IT_TRUNCATION
);
24134 produce_special_glyphs (it
, IT_TRUNCATION
);
24136 row
->truncated_on_right_p
= true;
24142 /* Maybe insert a truncation at the left. */
24143 if (it
->first_visible_x
24146 if (!FRAME_WINDOW_P (it
->f
)
24147 || (row
->reversed_p
24148 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24149 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
24150 insert_left_trunc_glyphs (it
);
24151 row
->truncated_on_left_p
= true;
24154 it
->face_id
= saved_face_id
;
24156 /* Value is number of columns displayed. */
24157 return it
->hpos
- hpos_at_start
;
24162 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
24163 appears as an element of LIST or as the car of an element of LIST.
24164 If PROPVAL is a list, compare each element against LIST in that
24165 way, and return 1/2 if any element of PROPVAL is found in LIST.
24166 Otherwise return 0. This function cannot quit.
24167 The return value is 2 if the text is invisible but with an ellipsis
24168 and 1 if it's invisible and without an ellipsis. */
24171 invisible_prop (Lisp_Object propval
, Lisp_Object list
)
24173 Lisp_Object tail
, proptail
;
24175 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
24177 register Lisp_Object tem
;
24179 if (EQ (propval
, tem
))
24181 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
24182 return NILP (XCDR (tem
)) ? 1 : 2;
24185 if (CONSP (propval
))
24187 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
24189 Lisp_Object propelt
;
24190 propelt
= XCAR (proptail
);
24191 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
24193 register Lisp_Object tem
;
24195 if (EQ (propelt
, tem
))
24197 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
24198 return NILP (XCDR (tem
)) ? 1 : 2;
24206 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
24207 doc
: /* Non-nil if the property makes the text invisible.
24208 POS-OR-PROP can be a marker or number, in which case it is taken to be
24209 a position in the current buffer and the value of the `invisible' property
24210 is checked; or it can be some other value, which is then presumed to be the
24211 value of the `invisible' property of the text of interest.
24212 The non-nil value returned can be t for truly invisible text or something
24213 else if the text is replaced by an ellipsis. */)
24214 (Lisp_Object pos_or_prop
)
24217 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
24218 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
24220 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
24221 return (invis
== 0 ? Qnil
24223 : make_number (invis
));
24226 /* Calculate a width or height in pixels from a specification using
24227 the following elements:
24230 NUM - a (fractional) multiple of the default font width/height
24231 (NUM) - specifies exactly NUM pixels
24232 UNIT - a fixed number of pixels, see below.
24233 ELEMENT - size of a display element in pixels, see below.
24234 (NUM . SPEC) - equals NUM * SPEC
24235 (+ SPEC SPEC ...) - add pixel values
24236 (- SPEC SPEC ...) - subtract pixel values
24237 (- SPEC) - negate pixel value
24240 INT or FLOAT - a number constant
24241 SYMBOL - use symbol's (buffer local) variable binding.
24244 in - pixels per inch *)
24245 mm - pixels per 1/1000 meter *)
24246 cm - pixels per 1/100 meter *)
24247 width - width of current font in pixels.
24248 height - height of current font in pixels.
24250 *) using the ratio(s) defined in display-pixels-per-inch.
24254 left-fringe - left fringe width in pixels
24255 right-fringe - right fringe width in pixels
24257 left-margin - left margin width in pixels
24258 right-margin - right margin width in pixels
24260 scroll-bar - scroll-bar area width in pixels
24264 Pixels corresponding to 5 inches:
24267 Total width of non-text areas on left side of window (if scroll-bar is on left):
24268 '(space :width (+ left-fringe left-margin scroll-bar))
24270 Align to first text column (in header line):
24271 '(space :align-to 0)
24273 Align to middle of text area minus half the width of variable `my-image'
24274 containing a loaded image:
24275 '(space :align-to (0.5 . (- text my-image)))
24277 Width of left margin minus width of 1 character in the default font:
24278 '(space :width (- left-margin 1))
24280 Width of left margin minus width of 2 characters in the current font:
24281 '(space :width (- left-margin (2 . width)))
24283 Center 1 character over left-margin (in header line):
24284 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
24286 Different ways to express width of left fringe plus left margin minus one pixel:
24287 '(space :width (- (+ left-fringe left-margin) (1)))
24288 '(space :width (+ left-fringe left-margin (- (1))))
24289 '(space :width (+ left-fringe left-margin (-1)))
24294 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
24295 struct font
*font
, bool width_p
, int *align_to
)
24299 # define OK_PIXELS(val) (*res = (val), true)
24300 # define OK_ALIGN_TO(val) (*align_to = (val), true)
24303 return OK_PIXELS (0);
24305 eassert (FRAME_LIVE_P (it
->f
));
24307 if (SYMBOLP (prop
))
24309 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
24311 char *unit
= SSDATA (SYMBOL_NAME (prop
));
24313 if (unit
[0] == 'i' && unit
[1] == 'n')
24315 else if (unit
[0] == 'm' && unit
[1] == 'm')
24317 else if (unit
[0] == 'c' && unit
[1] == 'm')
24323 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
24324 : FRAME_RES_Y (it
->f
));
24327 return OK_PIXELS (ppi
/ pixels
);
24332 #ifdef HAVE_WINDOW_SYSTEM
24333 if (EQ (prop
, Qheight
))
24334 return OK_PIXELS (font
24335 ? normal_char_height (font
, -1)
24336 : FRAME_LINE_HEIGHT (it
->f
));
24337 if (EQ (prop
, Qwidth
))
24338 return OK_PIXELS (font
24339 ? FONT_WIDTH (font
)
24340 : FRAME_COLUMN_WIDTH (it
->f
));
24342 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
24343 return OK_PIXELS (1);
24346 if (EQ (prop
, Qtext
))
24347 return OK_PIXELS (width_p
24348 ? window_box_width (it
->w
, TEXT_AREA
)
24349 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
24351 if (align_to
&& *align_to
< 0)
24354 if (EQ (prop
, Qleft
))
24355 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
24356 if (EQ (prop
, Qright
))
24357 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
24358 if (EQ (prop
, Qcenter
))
24359 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
24360 + window_box_width (it
->w
, TEXT_AREA
) / 2);
24361 if (EQ (prop
, Qleft_fringe
))
24362 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24363 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
24364 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
24365 if (EQ (prop
, Qright_fringe
))
24366 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24367 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24368 : window_box_right_offset (it
->w
, TEXT_AREA
));
24369 if (EQ (prop
, Qleft_margin
))
24370 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
24371 if (EQ (prop
, Qright_margin
))
24372 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
24373 if (EQ (prop
, Qscroll_bar
))
24374 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
24376 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24377 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24378 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24383 if (EQ (prop
, Qleft_fringe
))
24384 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
24385 if (EQ (prop
, Qright_fringe
))
24386 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
24387 if (EQ (prop
, Qleft_margin
))
24388 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
24389 if (EQ (prop
, Qright_margin
))
24390 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
24391 if (EQ (prop
, Qscroll_bar
))
24392 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
24395 prop
= buffer_local_value (prop
, it
->w
->contents
);
24396 if (EQ (prop
, Qunbound
))
24400 if (NUMBERP (prop
))
24402 int base_unit
= (width_p
24403 ? FRAME_COLUMN_WIDTH (it
->f
)
24404 : FRAME_LINE_HEIGHT (it
->f
));
24405 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
24410 Lisp_Object car
= XCAR (prop
);
24411 Lisp_Object cdr
= XCDR (prop
);
24415 #ifdef HAVE_WINDOW_SYSTEM
24416 if (FRAME_WINDOW_P (it
->f
)
24417 && valid_image_p (prop
))
24419 ptrdiff_t id
= lookup_image (it
->f
, prop
);
24420 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
24422 return OK_PIXELS (width_p
? img
->width
: img
->height
);
24424 if (FRAME_WINDOW_P (it
->f
) && valid_xwidget_spec_p (prop
))
24426 // TODO: Don't return dummy size.
24427 return OK_PIXELS (100);
24430 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
24436 while (CONSP (cdr
))
24438 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
24439 font
, width_p
, align_to
))
24442 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= false;
24447 if (EQ (car
, Qminus
))
24449 return OK_PIXELS (pixels
);
24452 car
= buffer_local_value (car
, it
->w
->contents
);
24453 if (EQ (car
, Qunbound
))
24460 pixels
= XFLOATINT (car
);
24462 return OK_PIXELS (pixels
);
24463 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
24464 font
, width_p
, align_to
))
24465 return OK_PIXELS (pixels
* fact
);
24476 get_font_ascent_descent (struct font
*font
, int *ascent
, int *descent
)
24478 #ifdef HAVE_WINDOW_SYSTEM
24479 normal_char_ascent_descent (font
, -1, ascent
, descent
);
24487 /***********************************************************************
24489 ***********************************************************************/
24491 #ifdef HAVE_WINDOW_SYSTEM
24496 dump_glyph_string (struct glyph_string
*s
)
24498 fprintf (stderr
, "glyph string\n");
24499 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
24500 s
->x
, s
->y
, s
->width
, s
->height
);
24501 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
24502 fprintf (stderr
, " hl = %d\n", s
->hl
);
24503 fprintf (stderr
, " left overhang = %d, right = %d\n",
24504 s
->left_overhang
, s
->right_overhang
);
24505 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
24506 fprintf (stderr
, " extends to end of line = %d\n",
24507 s
->extends_to_end_of_line_p
);
24508 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
24509 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
24512 #endif /* GLYPH_DEBUG */
24514 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
24515 of XChar2b structures for S; it can't be allocated in
24516 init_glyph_string because it must be allocated via `alloca'. W
24517 is the window on which S is drawn. ROW and AREA are the glyph row
24518 and area within the row from which S is constructed. START is the
24519 index of the first glyph structure covered by S. HL is a
24520 face-override for drawing S. */
24523 #define OPTIONAL_HDC(hdc) HDC hdc,
24524 #define DECLARE_HDC(hdc) HDC hdc;
24525 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
24526 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
24529 #ifndef OPTIONAL_HDC
24530 #define OPTIONAL_HDC(hdc)
24531 #define DECLARE_HDC(hdc)
24532 #define ALLOCATE_HDC(hdc, f)
24533 #define RELEASE_HDC(hdc, f)
24537 init_glyph_string (struct glyph_string
*s
,
24539 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
24540 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
24542 memset (s
, 0, sizeof *s
);
24544 s
->f
= XFRAME (w
->frame
);
24548 s
->display
= FRAME_X_DISPLAY (s
->f
);
24549 s
->window
= FRAME_X_WINDOW (s
->f
);
24550 s
->char2b
= char2b
;
24554 s
->first_glyph
= row
->glyphs
[area
] + start
;
24555 s
->height
= row
->height
;
24556 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
24557 s
->ybase
= s
->y
+ row
->ascent
;
24561 /* Append the list of glyph strings with head H and tail T to the list
24562 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
24565 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24566 struct glyph_string
*h
, struct glyph_string
*t
)
24580 /* Prepend the list of glyph strings with head H and tail T to the
24581 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
24585 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24586 struct glyph_string
*h
, struct glyph_string
*t
)
24600 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
24601 Set *HEAD and *TAIL to the resulting list. */
24604 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
24605 struct glyph_string
*s
)
24607 s
->next
= s
->prev
= NULL
;
24608 append_glyph_string_lists (head
, tail
, s
, s
);
24612 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24613 The encoding of C is returned in *CHAR2B. DISPLAY_P means
24614 make sure that X resources for the face returned are allocated.
24615 Value is a pointer to a realized face that is ready for display if
24618 static struct face
*
24619 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
24620 XChar2b
*char2b
, bool display_p
)
24622 struct face
*face
= FACE_FROM_ID (f
, face_id
);
24627 code
= face
->font
->driver
->encode_char (face
->font
, c
);
24629 if (code
== FONT_INVALID_CODE
)
24632 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24634 /* Make sure X resources of the face are allocated. */
24635 #ifdef HAVE_X_WINDOWS
24639 eassert (face
!= NULL
);
24640 prepare_face_for_display (f
, face
);
24647 /* Get face and two-byte form of character glyph GLYPH on frame F.
24648 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24649 a pointer to a realized face that is ready for display. */
24651 static struct face
*
24652 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24658 eassert (glyph
->type
== CHAR_GLYPH
);
24659 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24661 /* Make sure X resources of the face are allocated. */
24662 prepare_face_for_display (f
, face
);
24666 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24667 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24669 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24671 if (code
== FONT_INVALID_CODE
)
24675 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24680 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24681 Return true iff FONT has a glyph for C. */
24684 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24688 if (CHAR_BYTE8_P (c
))
24689 code
= CHAR_TO_BYTE8 (c
);
24691 code
= font
->driver
->encode_char (font
, c
);
24693 if (code
== FONT_INVALID_CODE
)
24695 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24700 /* Fill glyph string S with composition components specified by S->cmp.
24702 BASE_FACE is the base face of the composition.
24703 S->cmp_from is the index of the first component for S.
24705 OVERLAPS non-zero means S should draw the foreground only, and use
24706 its physical height for clipping. See also draw_glyphs.
24708 Value is the index of a component not in S. */
24711 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24715 /* For all glyphs of this composition, starting at the offset
24716 S->cmp_from, until we reach the end of the definition or encounter a
24717 glyph that requires the different face, add it to S. */
24722 s
->for_overlaps
= overlaps
;
24725 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24727 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24729 /* TAB in a composition means display glyphs with padding space
24730 on the left or right. */
24733 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24736 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24737 s
->char2b
+ i
, true);
24743 s
->font
= s
->face
->font
;
24745 else if (s
->face
!= face
)
24753 if (s
->face
== NULL
)
24755 s
->face
= base_face
->ascii_face
;
24756 s
->font
= s
->face
->font
;
24759 /* All glyph strings for the same composition has the same width,
24760 i.e. the width set for the first component of the composition. */
24761 s
->width
= s
->first_glyph
->pixel_width
;
24763 /* If the specified font could not be loaded, use the frame's
24764 default font, but record the fact that we couldn't load it in
24765 the glyph string so that we can draw rectangles for the
24766 characters of the glyph string. */
24767 if (s
->font
== NULL
)
24769 s
->font_not_found_p
= true;
24770 s
->font
= FRAME_FONT (s
->f
);
24773 /* Adjust base line for subscript/superscript text. */
24774 s
->ybase
+= s
->first_glyph
->voffset
;
24780 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24781 int start
, int end
, int overlaps
)
24783 struct glyph
*glyph
, *last
;
24784 Lisp_Object lgstring
;
24787 s
->for_overlaps
= overlaps
;
24788 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24789 last
= s
->row
->glyphs
[s
->area
] + end
;
24790 s
->cmp_id
= glyph
->u
.cmp
.id
;
24791 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24792 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24793 s
->face
= FACE_OPT_FROM_ID (s
->f
, face_id
);
24794 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24795 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24797 while (glyph
< last
24798 && glyph
->u
.cmp
.automatic
24799 && glyph
->u
.cmp
.id
== s
->cmp_id
24800 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24801 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24803 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24805 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24806 unsigned code
= LGLYPH_CODE (lglyph
);
24808 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24810 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24811 return glyph
- s
->row
->glyphs
[s
->area
];
24815 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24816 See the comment of fill_glyph_string for arguments.
24817 Value is the index of the first glyph not in S. */
24821 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24822 int start
, int end
, int overlaps
)
24824 struct glyph
*glyph
, *last
;
24827 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24828 s
->for_overlaps
= overlaps
;
24829 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24830 last
= s
->row
->glyphs
[s
->area
] + end
;
24831 voffset
= glyph
->voffset
;
24832 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24833 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24835 s
->width
= glyph
->pixel_width
;
24837 while (glyph
< last
24838 && glyph
->type
== GLYPHLESS_GLYPH
24839 && glyph
->voffset
== voffset
24840 && glyph
->face_id
== face_id
)
24843 s
->width
+= glyph
->pixel_width
;
24846 s
->ybase
+= voffset
;
24847 return glyph
- s
->row
->glyphs
[s
->area
];
24851 /* Fill glyph string S from a sequence of character glyphs.
24853 FACE_ID is the face id of the string. START is the index of the
24854 first glyph to consider, END is the index of the last + 1.
24855 OVERLAPS non-zero means S should draw the foreground only, and use
24856 its physical height for clipping. See also draw_glyphs.
24858 Value is the index of the first glyph not in S. */
24861 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24862 int start
, int end
, int overlaps
)
24864 struct glyph
*glyph
, *last
;
24866 bool glyph_not_available_p
;
24868 eassert (s
->f
== XFRAME (s
->w
->frame
));
24869 eassert (s
->nchars
== 0);
24870 eassert (start
>= 0 && end
> start
);
24872 s
->for_overlaps
= overlaps
;
24873 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24874 last
= s
->row
->glyphs
[s
->area
] + end
;
24875 voffset
= glyph
->voffset
;
24876 s
->padding_p
= glyph
->padding_p
;
24877 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24879 while (glyph
< last
24880 && glyph
->type
== CHAR_GLYPH
24881 && glyph
->voffset
== voffset
24882 /* Same face id implies same font, nowadays. */
24883 && glyph
->face_id
== face_id
24884 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24886 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24887 s
->char2b
+ s
->nchars
);
24889 eassert (s
->nchars
<= end
- start
);
24890 s
->width
+= glyph
->pixel_width
;
24891 if (glyph
++->padding_p
!= s
->padding_p
)
24895 s
->font
= s
->face
->font
;
24897 /* If the specified font could not be loaded, use the frame's font,
24898 but record the fact that we couldn't load it in
24899 S->font_not_found_p so that we can draw rectangles for the
24900 characters of the glyph string. */
24901 if (s
->font
== NULL
|| glyph_not_available_p
)
24903 s
->font_not_found_p
= true;
24904 s
->font
= FRAME_FONT (s
->f
);
24907 /* Adjust base line for subscript/superscript text. */
24908 s
->ybase
+= voffset
;
24910 eassert (s
->face
&& s
->face
->gc
);
24911 return glyph
- s
->row
->glyphs
[s
->area
];
24915 /* Fill glyph string S from image glyph S->first_glyph. */
24918 fill_image_glyph_string (struct glyph_string
*s
)
24920 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24921 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24923 s
->slice
= s
->first_glyph
->slice
.img
;
24924 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24925 s
->font
= s
->face
->font
;
24926 s
->width
= s
->first_glyph
->pixel_width
;
24928 /* Adjust base line for subscript/superscript text. */
24929 s
->ybase
+= s
->first_glyph
->voffset
;
24933 #ifdef HAVE_XWIDGETS
24935 fill_xwidget_glyph_string (struct glyph_string
*s
)
24937 eassert (s
->first_glyph
->type
== XWIDGET_GLYPH
);
24938 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24939 s
->font
= s
->face
->font
;
24940 s
->width
= s
->first_glyph
->pixel_width
;
24941 s
->ybase
+= s
->first_glyph
->voffset
;
24942 s
->xwidget
= s
->first_glyph
->u
.xwidget
;
24945 /* Fill glyph string S from a sequence of stretch glyphs.
24947 START is the index of the first glyph to consider,
24948 END is the index of the last + 1.
24950 Value is the index of the first glyph not in S. */
24953 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24955 struct glyph
*glyph
, *last
;
24956 int voffset
, face_id
;
24958 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24960 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24961 last
= s
->row
->glyphs
[s
->area
] + end
;
24962 face_id
= glyph
->face_id
;
24963 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24964 s
->font
= s
->face
->font
;
24965 s
->width
= glyph
->pixel_width
;
24967 voffset
= glyph
->voffset
;
24971 && glyph
->type
== STRETCH_GLYPH
24972 && glyph
->voffset
== voffset
24973 && glyph
->face_id
== face_id
);
24975 s
->width
+= glyph
->pixel_width
;
24977 /* Adjust base line for subscript/superscript text. */
24978 s
->ybase
+= voffset
;
24980 /* The case that face->gc == 0 is handled when drawing the glyph
24981 string by calling prepare_face_for_display. */
24983 return glyph
- s
->row
->glyphs
[s
->area
];
24986 static struct font_metrics
*
24987 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24989 static struct font_metrics metrics
;
24994 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24995 if (code
== FONT_INVALID_CODE
)
24997 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
25001 /* A subroutine that computes "normal" values of ASCENT and DESCENT
25002 for FONT. Values are taken from font-global ones, except for fonts
25003 that claim preposterously large values, but whose glyphs actually
25004 have reasonable dimensions. C is the character to use for metrics
25005 if the font-global values are too large; if C is negative, the
25006 function selects a default character. */
25008 normal_char_ascent_descent (struct font
*font
, int c
, int *ascent
, int *descent
)
25010 *ascent
= FONT_BASE (font
);
25011 *descent
= FONT_DESCENT (font
);
25013 if (FONT_TOO_HIGH (font
))
25017 /* Get metrics of C, defaulting to a reasonably sized ASCII
25019 if (get_char_glyph_code (c
>= 0 ? c
: '{', font
, &char2b
))
25021 struct font_metrics
*pcm
= get_per_char_metric (font
, &char2b
);
25023 if (!(pcm
->width
== 0 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0))
25025 /* We add 1 pixel to character dimensions as heuristics
25026 that produces nicer display, e.g. when the face has
25027 the box attribute. */
25028 *ascent
= pcm
->ascent
+ 1;
25029 *descent
= pcm
->descent
+ 1;
25035 /* A subroutine that computes a reasonable "normal character height"
25036 for fonts that claim preposterously large vertical dimensions, but
25037 whose glyphs are actually reasonably sized. C is the character
25038 whose metrics to use for those fonts, or -1 for default
25041 normal_char_height (struct font
*font
, int c
)
25043 int ascent
, descent
;
25045 normal_char_ascent_descent (font
, c
, &ascent
, &descent
);
25047 return ascent
+ descent
;
25051 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
25052 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
25053 assumed to be zero. */
25056 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
25058 *left
= *right
= 0;
25060 if (glyph
->type
== CHAR_GLYPH
)
25063 struct face
*face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
);
25066 struct font_metrics
*pcm
= get_per_char_metric (face
->font
, &char2b
);
25069 if (pcm
->rbearing
> pcm
->width
)
25070 *right
= pcm
->rbearing
- pcm
->width
;
25071 if (pcm
->lbearing
< 0)
25072 *left
= -pcm
->lbearing
;
25076 else if (glyph
->type
== COMPOSITE_GLYPH
)
25078 if (! glyph
->u
.cmp
.automatic
)
25080 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
25082 if (cmp
->rbearing
> cmp
->pixel_width
)
25083 *right
= cmp
->rbearing
- cmp
->pixel_width
;
25084 if (cmp
->lbearing
< 0)
25085 *left
= - cmp
->lbearing
;
25089 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
25090 struct font_metrics metrics
;
25092 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
25093 glyph
->slice
.cmp
.to
+ 1, &metrics
);
25094 if (metrics
.rbearing
> metrics
.width
)
25095 *right
= metrics
.rbearing
- metrics
.width
;
25096 if (metrics
.lbearing
< 0)
25097 *left
= - metrics
.lbearing
;
25103 /* Return the index of the first glyph preceding glyph string S that
25104 is overwritten by S because of S's left overhang. Value is -1
25105 if no glyphs are overwritten. */
25108 left_overwritten (struct glyph_string
*s
)
25112 if (s
->left_overhang
)
25115 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25116 int first
= s
->first_glyph
- glyphs
;
25118 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
25119 x
-= glyphs
[i
].pixel_width
;
25130 /* Return the index of the first glyph preceding glyph string S that
25131 is overwriting S because of its right overhang. Value is -1 if no
25132 glyph in front of S overwrites S. */
25135 left_overwriting (struct glyph_string
*s
)
25138 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25139 int first
= s
->first_glyph
- glyphs
;
25143 for (i
= first
- 1; i
>= 0; --i
)
25146 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
25149 x
-= glyphs
[i
].pixel_width
;
25156 /* Return the index of the last glyph following glyph string S that is
25157 overwritten by S because of S's right overhang. Value is -1 if
25158 no such glyph is found. */
25161 right_overwritten (struct glyph_string
*s
)
25165 if (s
->right_overhang
)
25168 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25169 int first
= (s
->first_glyph
- glyphs
25170 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
25171 int end
= s
->row
->used
[s
->area
];
25173 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
25174 x
+= glyphs
[i
].pixel_width
;
25183 /* Return the index of the last glyph following glyph string S that
25184 overwrites S because of its left overhang. Value is negative
25185 if no such glyph is found. */
25188 right_overwriting (struct glyph_string
*s
)
25191 int end
= s
->row
->used
[s
->area
];
25192 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25193 int first
= (s
->first_glyph
- glyphs
25194 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
25198 for (i
= first
; i
< end
; ++i
)
25201 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
25204 x
+= glyphs
[i
].pixel_width
;
25211 /* Set background width of glyph string S. START is the index of the
25212 first glyph following S. LAST_X is the right-most x-position + 1
25213 in the drawing area. */
25216 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
25218 /* If the face of this glyph string has to be drawn to the end of
25219 the drawing area, set S->extends_to_end_of_line_p. */
25221 if (start
== s
->row
->used
[s
->area
]
25222 && ((s
->row
->fill_line_p
25223 && (s
->hl
== DRAW_NORMAL_TEXT
25224 || s
->hl
== DRAW_IMAGE_RAISED
25225 || s
->hl
== DRAW_IMAGE_SUNKEN
))
25226 || s
->hl
== DRAW_MOUSE_FACE
))
25227 s
->extends_to_end_of_line_p
= true;
25229 /* If S extends its face to the end of the line, set its
25230 background_width to the distance to the right edge of the drawing
25232 if (s
->extends_to_end_of_line_p
)
25233 s
->background_width
= last_x
- s
->x
+ 1;
25235 s
->background_width
= s
->width
;
25239 /* Compute overhangs and x-positions for glyph string S and its
25240 predecessors, or successors. X is the starting x-position for S.
25241 BACKWARD_P means process predecessors. */
25244 compute_overhangs_and_x (struct glyph_string
*s
, int x
, bool backward_p
)
25250 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
25251 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
25261 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
25262 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
25272 /* The following macros are only called from draw_glyphs below.
25273 They reference the following parameters of that function directly:
25274 `w', `row', `area', and `overlap_p'
25275 as well as the following local variables:
25276 `s', `f', and `hdc' (in W32) */
25279 /* On W32, silently add local `hdc' variable to argument list of
25280 init_glyph_string. */
25281 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
25282 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
25284 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
25285 init_glyph_string (s, char2b, w, row, area, start, hl)
25288 /* Add a glyph string for a stretch glyph to the list of strings
25289 between HEAD and TAIL. START is the index of the stretch glyph in
25290 row area AREA of glyph row ROW. END is the index of the last glyph
25291 in that glyph row area. X is the current output position assigned
25292 to the new glyph string constructed. HL overrides that face of the
25293 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25294 is the right-most x-position of the drawing area. */
25296 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
25297 and below -- keep them on one line. */
25298 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25301 s = alloca (sizeof *s); \
25302 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25303 START = fill_stretch_glyph_string (s, START, END); \
25304 append_glyph_string (&HEAD, &TAIL, s); \
25310 /* Add a glyph string for an image glyph to the list of strings
25311 between HEAD and TAIL. START is the index of the image glyph in
25312 row area AREA of glyph row ROW. END is the index of the last glyph
25313 in that glyph row area. X is the current output position assigned
25314 to the new glyph string constructed. HL overrides that face of the
25315 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25316 is the right-most x-position of the drawing area. */
25318 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25321 s = alloca (sizeof *s); \
25322 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25323 fill_image_glyph_string (s); \
25324 append_glyph_string (&HEAD, &TAIL, s); \
25330 #ifndef HAVE_XWIDGETS
25331 # define BUILD_XWIDGET_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25334 # define BUILD_XWIDGET_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25337 s = alloca (sizeof *s); \
25338 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25339 fill_xwidget_glyph_string (s); \
25340 append_glyph_string (&(HEAD), &(TAIL), s); \
25347 /* Add a glyph string for a sequence of character glyphs to the list
25348 of strings between HEAD and TAIL. START is the index of the first
25349 glyph in row area AREA of glyph row ROW that is part of the new
25350 glyph string. END is the index of the last glyph in that glyph row
25351 area. X is the current output position assigned to the new glyph
25352 string constructed. HL overrides that face of the glyph; e.g. it
25353 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
25354 right-most x-position of the drawing area. */
25356 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25362 face_id = (row)->glyphs[area][START].face_id; \
25364 s = alloca (sizeof *s); \
25365 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
25366 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25367 append_glyph_string (&HEAD, &TAIL, s); \
25369 START = fill_glyph_string (s, face_id, START, END, overlaps); \
25374 /* Add a glyph string for a composite sequence to the list of strings
25375 between HEAD and TAIL. START is the index of the first glyph in
25376 row area AREA of glyph row ROW that is part of the new glyph
25377 string. END is the index of the last glyph in that glyph row area.
25378 X is the current output position assigned to the new glyph string
25379 constructed. HL overrides that face of the glyph; e.g. it is
25380 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
25381 x-position of the drawing area. */
25383 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25385 int face_id = (row)->glyphs[area][START].face_id; \
25386 struct face *base_face = FACE_OPT_FROM_ID (f, face_id); \
25387 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
25388 struct composition *cmp = composition_table[cmp_id]; \
25390 struct glyph_string *first_s = NULL; \
25393 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
25395 /* Make glyph_strings for each glyph sequence that is drawable by \
25396 the same face, and append them to HEAD/TAIL. */ \
25397 for (n = 0; n < cmp->glyph_len;) \
25399 s = alloca (sizeof *s); \
25400 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25401 append_glyph_string (&(HEAD), &(TAIL), s); \
25407 n = fill_composite_glyph_string (s, base_face, overlaps); \
25415 /* Add a glyph string for a glyph-string sequence to the list of strings
25416 between HEAD and TAIL. */
25418 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25422 Lisp_Object gstring; \
25424 face_id = (row)->glyphs[area][START].face_id; \
25425 gstring = (composition_gstring_from_id \
25426 ((row)->glyphs[area][START].u.cmp.id)); \
25427 s = alloca (sizeof *s); \
25428 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
25429 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25430 append_glyph_string (&(HEAD), &(TAIL), s); \
25432 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
25436 /* Add a glyph string for a sequence of glyphless character's glyphs
25437 to the list of strings between HEAD and TAIL. The meanings of
25438 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
25440 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25445 face_id = (row)->glyphs[area][START].face_id; \
25447 s = alloca (sizeof *s); \
25448 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25449 append_glyph_string (&HEAD, &TAIL, s); \
25451 START = fill_glyphless_glyph_string (s, face_id, START, END, \
25457 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
25458 of AREA of glyph row ROW on window W between indices START and END.
25459 HL overrides the face for drawing glyph strings, e.g. it is
25460 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
25461 x-positions of the drawing area.
25463 This is an ugly monster macro construct because we must use alloca
25464 to allocate glyph strings (because draw_glyphs can be called
25465 asynchronously). */
25467 #define BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25470 HEAD = TAIL = NULL; \
25471 while (START < END) \
25473 struct glyph *first_glyph = (row)->glyphs[area] + START; \
25474 switch (first_glyph->type) \
25477 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
25481 case COMPOSITE_GLYPH: \
25482 if (first_glyph->u.cmp.automatic) \
25483 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
25486 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
25490 case STRETCH_GLYPH: \
25491 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
25495 case IMAGE_GLYPH: \
25496 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
25500 #define BUILD_GLYPH_STRINGS_XW(START, END, HEAD, TAIL, HL, X, LAST_X) \
25501 case XWIDGET_GLYPH: \
25502 BUILD_XWIDGET_GLYPH_STRING (START, END, HEAD, TAIL, \
25506 #define BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X) \
25507 case GLYPHLESS_GLYPH: \
25508 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
25518 set_glyph_string_background_width (s, START, LAST_X); \
25525 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25526 BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25527 BUILD_GLYPH_STRINGS_XW(START, END, HEAD, TAIL, HL, X, LAST_X) \
25528 BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X)
25531 /* Draw glyphs between START and END in AREA of ROW on window W,
25532 starting at x-position X. X is relative to AREA in W. HL is a
25533 face-override with the following meaning:
25535 DRAW_NORMAL_TEXT draw normally
25536 DRAW_CURSOR draw in cursor face
25537 DRAW_MOUSE_FACE draw in mouse face.
25538 DRAW_INVERSE_VIDEO draw in mode line face
25539 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
25540 DRAW_IMAGE_RAISED draw an image with a raised relief around it
25542 If OVERLAPS is non-zero, draw only the foreground of characters and
25543 clip to the physical height of ROW. Non-zero value also defines
25544 the overlapping part to be drawn:
25546 OVERLAPS_PRED overlap with preceding rows
25547 OVERLAPS_SUCC overlap with succeeding rows
25548 OVERLAPS_BOTH overlap with both preceding/succeeding rows
25549 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
25551 Value is the x-position reached, relative to AREA of W. */
25554 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
25555 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
25556 enum draw_glyphs_face hl
, int overlaps
)
25558 struct glyph_string
*head
, *tail
;
25559 struct glyph_string
*s
;
25560 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
25561 int i
, j
, x_reached
, last_x
, area_left
= 0;
25562 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25565 ALLOCATE_HDC (hdc
, f
);
25567 /* Let's rather be paranoid than getting a SEGV. */
25568 end
= min (end
, row
->used
[area
]);
25569 start
= clip_to_bounds (0, start
, end
);
25571 /* Translate X to frame coordinates. Set last_x to the right
25572 end of the drawing area. */
25573 if (row
->full_width_p
)
25575 /* X is relative to the left edge of W, without scroll bars
25577 area_left
= WINDOW_LEFT_EDGE_X (w
);
25578 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
25579 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
25583 area_left
= window_box_left (w
, area
);
25584 last_x
= area_left
+ window_box_width (w
, area
);
25588 /* Build a doubly-linked list of glyph_string structures between
25589 head and tail from what we have to draw. Note that the macro
25590 BUILD_GLYPH_STRINGS will modify its start parameter. That's
25591 the reason we use a separate variable `i'. */
25594 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
25596 x_reached
= tail
->x
+ tail
->background_width
;
25600 /* If there are any glyphs with lbearing < 0 or rbearing > width in
25601 the row, redraw some glyphs in front or following the glyph
25602 strings built above. */
25603 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
25605 struct glyph_string
*h
, *t
;
25606 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25607 int mouse_beg_col UNINIT
, mouse_end_col UNINIT
;
25608 bool check_mouse_face
= false;
25611 /* If mouse highlighting is on, we may need to draw adjacent
25612 glyphs using mouse-face highlighting. */
25613 if (area
== TEXT_AREA
&& row
->mouse_face_p
25614 && hlinfo
->mouse_face_beg_row
>= 0
25615 && hlinfo
->mouse_face_end_row
>= 0)
25617 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
25619 if (row_vpos
>= hlinfo
->mouse_face_beg_row
25620 && row_vpos
<= hlinfo
->mouse_face_end_row
)
25622 check_mouse_face
= true;
25623 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
25624 ? hlinfo
->mouse_face_beg_col
: 0;
25625 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
25626 ? hlinfo
->mouse_face_end_col
25627 : row
->used
[TEXT_AREA
];
25631 /* Compute overhangs for all glyph strings. */
25632 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
25633 for (s
= head
; s
; s
= s
->next
)
25634 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
25636 /* Prepend glyph strings for glyphs in front of the first glyph
25637 string that are overwritten because of the first glyph
25638 string's left overhang. The background of all strings
25639 prepended must be drawn because the first glyph string
25641 i
= left_overwritten (head
);
25644 enum draw_glyphs_face overlap_hl
;
25646 /* If this row contains mouse highlighting, attempt to draw
25647 the overlapped glyphs with the correct highlight. This
25648 code fails if the overlap encompasses more than one glyph
25649 and mouse-highlight spans only some of these glyphs.
25650 However, making it work perfectly involves a lot more
25651 code, and I don't know if the pathological case occurs in
25652 practice, so we'll stick to this for now. --- cyd */
25653 if (check_mouse_face
25654 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25655 overlap_hl
= DRAW_MOUSE_FACE
;
25657 overlap_hl
= DRAW_NORMAL_TEXT
;
25659 if (hl
!= overlap_hl
)
25662 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
25663 overlap_hl
, dummy_x
, last_x
);
25665 compute_overhangs_and_x (t
, head
->x
, true);
25666 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25667 if (clip_head
== NULL
)
25671 /* Prepend glyph strings for glyphs in front of the first glyph
25672 string that overwrite that glyph string because of their
25673 right overhang. For these strings, only the foreground must
25674 be drawn, because it draws over the glyph string at `head'.
25675 The background must not be drawn because this would overwrite
25676 right overhangs of preceding glyphs for which no glyph
25678 i
= left_overwriting (head
);
25681 enum draw_glyphs_face overlap_hl
;
25683 if (check_mouse_face
25684 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25685 overlap_hl
= DRAW_MOUSE_FACE
;
25687 overlap_hl
= DRAW_NORMAL_TEXT
;
25689 if (hl
== overlap_hl
|| clip_head
== NULL
)
25691 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
25692 overlap_hl
, dummy_x
, last_x
);
25693 for (s
= h
; s
; s
= s
->next
)
25694 s
->background_filled_p
= true;
25695 compute_overhangs_and_x (t
, head
->x
, true);
25696 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25699 /* Append glyphs strings for glyphs following the last glyph
25700 string tail that are overwritten by tail. The background of
25701 these strings has to be drawn because tail's foreground draws
25703 i
= right_overwritten (tail
);
25706 enum draw_glyphs_face overlap_hl
;
25708 if (check_mouse_face
25709 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25710 overlap_hl
= DRAW_MOUSE_FACE
;
25712 overlap_hl
= DRAW_NORMAL_TEXT
;
25714 if (hl
!= overlap_hl
)
25716 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25717 overlap_hl
, x
, last_x
);
25718 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25719 we don't have `end = i;' here. */
25720 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25721 append_glyph_string_lists (&head
, &tail
, h
, t
);
25722 if (clip_tail
== NULL
)
25726 /* Append glyph strings for glyphs following the last glyph
25727 string tail that overwrite tail. The foreground of such
25728 glyphs has to be drawn because it writes into the background
25729 of tail. The background must not be drawn because it could
25730 paint over the foreground of following glyphs. */
25731 i
= right_overwriting (tail
);
25734 enum draw_glyphs_face overlap_hl
;
25735 if (check_mouse_face
25736 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25737 overlap_hl
= DRAW_MOUSE_FACE
;
25739 overlap_hl
= DRAW_NORMAL_TEXT
;
25741 if (hl
== overlap_hl
|| clip_tail
== NULL
)
25743 i
++; /* We must include the Ith glyph. */
25744 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25745 overlap_hl
, x
, last_x
);
25746 for (s
= h
; s
; s
= s
->next
)
25747 s
->background_filled_p
= true;
25748 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25749 append_glyph_string_lists (&head
, &tail
, h
, t
);
25751 if (clip_head
|| clip_tail
)
25752 for (s
= head
; s
; s
= s
->next
)
25754 s
->clip_head
= clip_head
;
25755 s
->clip_tail
= clip_tail
;
25759 /* Draw all strings. */
25760 for (s
= head
; s
; s
= s
->next
)
25761 FRAME_RIF (f
)->draw_glyph_string (s
);
25764 /* When focus a sole frame and move horizontally, this clears on_p
25765 causing a failure to erase prev cursor position. */
25766 if (area
== TEXT_AREA
25767 && !row
->full_width_p
25768 /* When drawing overlapping rows, only the glyph strings'
25769 foreground is drawn, which doesn't erase a cursor
25773 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25774 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25775 : (tail
? tail
->x
+ tail
->background_width
: x
));
25779 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25780 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25784 /* Value is the x-position up to which drawn, relative to AREA of W.
25785 This doesn't include parts drawn because of overhangs. */
25786 if (row
->full_width_p
)
25787 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25789 x_reached
-= area_left
;
25791 RELEASE_HDC (hdc
, f
);
25797 /* Expand row matrix if too narrow. Don't expand if area
25800 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25802 if (!it->f->fonts_changed \
25803 && (it->glyph_row->glyphs[area] \
25804 < it->glyph_row->glyphs[area + 1])) \
25806 it->w->ncols_scale_factor++; \
25807 it->f->fonts_changed = true; \
25811 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25812 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25815 append_glyph (struct it
*it
)
25817 struct glyph
*glyph
;
25818 enum glyph_row_area area
= it
->area
;
25820 eassert (it
->glyph_row
);
25821 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25823 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25824 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25826 /* If the glyph row is reversed, we need to prepend the glyph
25827 rather than append it. */
25828 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25832 /* Make room for the additional glyph. */
25833 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25835 glyph
= it
->glyph_row
->glyphs
[area
];
25837 glyph
->charpos
= CHARPOS (it
->position
);
25838 glyph
->object
= it
->object
;
25839 if (it
->pixel_width
> 0)
25841 eassert (it
->pixel_width
<= SHRT_MAX
);
25842 glyph
->pixel_width
= it
->pixel_width
;
25843 glyph
->padding_p
= false;
25847 /* Assure at least 1-pixel width. Otherwise, cursor can't
25848 be displayed correctly. */
25849 glyph
->pixel_width
= 1;
25850 glyph
->padding_p
= true;
25852 glyph
->ascent
= it
->ascent
;
25853 glyph
->descent
= it
->descent
;
25854 glyph
->voffset
= it
->voffset
;
25855 glyph
->type
= CHAR_GLYPH
;
25856 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25857 glyph
->multibyte_p
= it
->multibyte_p
;
25858 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25860 /* In R2L rows, the left and the right box edges need to be
25861 drawn in reverse direction. */
25862 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25863 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25867 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25868 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25870 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25871 || it
->phys_descent
> it
->descent
);
25872 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25873 glyph
->face_id
= it
->face_id
;
25874 glyph
->u
.ch
= it
->char_to_display
;
25875 glyph
->slice
.img
= null_glyph_slice
;
25876 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25879 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25880 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25881 glyph
->bidi_type
= it
->bidi_it
.type
;
25885 glyph
->resolved_level
= 0;
25886 glyph
->bidi_type
= UNKNOWN_BT
;
25888 ++it
->glyph_row
->used
[area
];
25891 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25894 /* Store one glyph for the composition IT->cmp_it.id in
25895 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25899 append_composite_glyph (struct it
*it
)
25901 struct glyph
*glyph
;
25902 enum glyph_row_area area
= it
->area
;
25904 eassert (it
->glyph_row
);
25906 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25907 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25909 /* If the glyph row is reversed, we need to prepend the glyph
25910 rather than append it. */
25911 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25915 /* Make room for the new glyph. */
25916 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25918 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25920 glyph
->charpos
= it
->cmp_it
.charpos
;
25921 glyph
->object
= it
->object
;
25922 eassert (it
->pixel_width
<= SHRT_MAX
);
25923 glyph
->pixel_width
= it
->pixel_width
;
25924 glyph
->ascent
= it
->ascent
;
25925 glyph
->descent
= it
->descent
;
25926 glyph
->voffset
= it
->voffset
;
25927 glyph
->type
= COMPOSITE_GLYPH
;
25928 if (it
->cmp_it
.ch
< 0)
25930 glyph
->u
.cmp
.automatic
= false;
25931 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25932 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25936 glyph
->u
.cmp
.automatic
= true;
25937 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25938 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25939 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25941 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25942 glyph
->multibyte_p
= it
->multibyte_p
;
25943 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25945 /* In R2L rows, the left and the right box edges need to be
25946 drawn in reverse direction. */
25947 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25948 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25952 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25953 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25955 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25956 || it
->phys_descent
> it
->descent
);
25957 glyph
->padding_p
= false;
25958 glyph
->glyph_not_available_p
= false;
25959 glyph
->face_id
= it
->face_id
;
25960 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25963 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25964 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25965 glyph
->bidi_type
= it
->bidi_it
.type
;
25967 ++it
->glyph_row
->used
[area
];
25970 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25974 /* Change IT->ascent and IT->height according to the setting of
25978 take_vertical_position_into_account (struct it
*it
)
25982 if (it
->voffset
< 0)
25983 /* Increase the ascent so that we can display the text higher
25985 it
->ascent
-= it
->voffset
;
25987 /* Increase the descent so that we can display the text lower
25989 it
->descent
+= it
->voffset
;
25994 /* Produce glyphs/get display metrics for the image IT is loaded with.
25995 See the description of struct display_iterator in dispextern.h for
25996 an overview of struct display_iterator. */
25999 produce_image_glyph (struct it
*it
)
26003 int glyph_ascent
, crop
;
26004 struct glyph_slice slice
;
26006 eassert (it
->what
== IT_IMAGE
);
26008 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26009 /* Make sure X resources of the face is loaded. */
26010 prepare_face_for_display (it
->f
, face
);
26012 if (it
->image_id
< 0)
26014 /* Fringe bitmap. */
26015 it
->ascent
= it
->phys_ascent
= 0;
26016 it
->descent
= it
->phys_descent
= 0;
26017 it
->pixel_width
= 0;
26022 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
26023 /* Make sure X resources of the image is loaded. */
26024 prepare_image_for_display (it
->f
, img
);
26026 slice
.x
= slice
.y
= 0;
26027 slice
.width
= img
->width
;
26028 slice
.height
= img
->height
;
26030 if (INTEGERP (it
->slice
.x
))
26031 slice
.x
= XINT (it
->slice
.x
);
26032 else if (FLOATP (it
->slice
.x
))
26033 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
26035 if (INTEGERP (it
->slice
.y
))
26036 slice
.y
= XINT (it
->slice
.y
);
26037 else if (FLOATP (it
->slice
.y
))
26038 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
26040 if (INTEGERP (it
->slice
.width
))
26041 slice
.width
= XINT (it
->slice
.width
);
26042 else if (FLOATP (it
->slice
.width
))
26043 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
26045 if (INTEGERP (it
->slice
.height
))
26046 slice
.height
= XINT (it
->slice
.height
);
26047 else if (FLOATP (it
->slice
.height
))
26048 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
26050 if (slice
.x
>= img
->width
)
26051 slice
.x
= img
->width
;
26052 if (slice
.y
>= img
->height
)
26053 slice
.y
= img
->height
;
26054 if (slice
.x
+ slice
.width
>= img
->width
)
26055 slice
.width
= img
->width
- slice
.x
;
26056 if (slice
.y
+ slice
.height
> img
->height
)
26057 slice
.height
= img
->height
- slice
.y
;
26059 if (slice
.width
== 0 || slice
.height
== 0)
26062 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
26064 it
->descent
= slice
.height
- glyph_ascent
;
26066 it
->descent
+= img
->vmargin
;
26067 if (slice
.y
+ slice
.height
== img
->height
)
26068 it
->descent
+= img
->vmargin
;
26069 it
->phys_descent
= it
->descent
;
26071 it
->pixel_width
= slice
.width
;
26073 it
->pixel_width
+= img
->hmargin
;
26074 if (slice
.x
+ slice
.width
== img
->width
)
26075 it
->pixel_width
+= img
->hmargin
;
26077 /* It's quite possible for images to have an ascent greater than
26078 their height, so don't get confused in that case. */
26079 if (it
->descent
< 0)
26084 if (face
->box
!= FACE_NO_BOX
)
26086 if (face
->box_line_width
> 0)
26089 it
->ascent
+= face
->box_line_width
;
26090 if (slice
.y
+ slice
.height
== img
->height
)
26091 it
->descent
+= face
->box_line_width
;
26094 if (it
->start_of_box_run_p
&& slice
.x
== 0)
26095 it
->pixel_width
+= eabs (face
->box_line_width
);
26096 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
26097 it
->pixel_width
+= eabs (face
->box_line_width
);
26100 take_vertical_position_into_account (it
);
26102 /* Automatically crop wide image glyphs at right edge so we can
26103 draw the cursor on same display row. */
26104 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
26105 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
26107 it
->pixel_width
-= crop
;
26108 slice
.width
-= crop
;
26113 struct glyph
*glyph
;
26114 enum glyph_row_area area
= it
->area
;
26116 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26117 if (it
->glyph_row
->reversed_p
)
26121 /* Make room for the new glyph. */
26122 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
26124 glyph
= it
->glyph_row
->glyphs
[it
->area
];
26126 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26128 glyph
->charpos
= CHARPOS (it
->position
);
26129 glyph
->object
= it
->object
;
26130 glyph
->pixel_width
= clip_to_bounds (-1, it
->pixel_width
, SHRT_MAX
);
26131 glyph
->ascent
= glyph_ascent
;
26132 glyph
->descent
= it
->descent
;
26133 glyph
->voffset
= it
->voffset
;
26134 glyph
->type
= IMAGE_GLYPH
;
26135 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26136 glyph
->multibyte_p
= it
->multibyte_p
;
26137 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26139 /* In R2L rows, the left and the right box edges need to be
26140 drawn in reverse direction. */
26141 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26142 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26146 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26147 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26149 glyph
->overlaps_vertically_p
= false;
26150 glyph
->padding_p
= false;
26151 glyph
->glyph_not_available_p
= false;
26152 glyph
->face_id
= it
->face_id
;
26153 glyph
->u
.img_id
= img
->id
;
26154 glyph
->slice
.img
= slice
;
26155 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26158 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26159 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26160 glyph
->bidi_type
= it
->bidi_it
.type
;
26162 ++it
->glyph_row
->used
[area
];
26165 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26170 produce_xwidget_glyph (struct it
*it
)
26172 #ifdef HAVE_XWIDGETS
26173 struct xwidget
*xw
;
26174 int glyph_ascent
, crop
;
26175 eassert (it
->what
== IT_XWIDGET
);
26177 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26178 /* Make sure X resources of the face is loaded. */
26179 prepare_face_for_display (it
->f
, face
);
26182 it
->ascent
= it
->phys_ascent
= glyph_ascent
= xw
->height
/2;
26183 it
->descent
= xw
->height
/2;
26184 it
->phys_descent
= it
->descent
;
26185 it
->pixel_width
= xw
->width
;
26186 /* It's quite possible for images to have an ascent greater than
26187 their height, so don't get confused in that case. */
26188 if (it
->descent
< 0)
26193 if (face
->box
!= FACE_NO_BOX
)
26195 if (face
->box_line_width
> 0)
26197 it
->ascent
+= face
->box_line_width
;
26198 it
->descent
+= face
->box_line_width
;
26201 if (it
->start_of_box_run_p
)
26202 it
->pixel_width
+= eabs (face
->box_line_width
);
26203 it
->pixel_width
+= eabs (face
->box_line_width
);
26206 take_vertical_position_into_account (it
);
26208 /* Automatically crop wide image glyphs at right edge so we can
26209 draw the cursor on same display row. */
26210 crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
);
26211 if (crop
> 0 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
26212 it
->pixel_width
-= crop
;
26216 enum glyph_row_area area
= it
->area
;
26217 struct glyph
*glyph
26218 = it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26220 if (it
->glyph_row
->reversed_p
)
26224 /* Make room for the new glyph. */
26225 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
26227 glyph
= it
->glyph_row
->glyphs
[it
->area
];
26229 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26231 glyph
->charpos
= CHARPOS (it
->position
);
26232 glyph
->object
= it
->object
;
26233 glyph
->pixel_width
= clip_to_bounds (-1, it
->pixel_width
, SHRT_MAX
);
26234 glyph
->ascent
= glyph_ascent
;
26235 glyph
->descent
= it
->descent
;
26236 glyph
->voffset
= it
->voffset
;
26237 glyph
->type
= XWIDGET_GLYPH
;
26238 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26239 glyph
->multibyte_p
= it
->multibyte_p
;
26240 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26242 /* In R2L rows, the left and the right box edges need to be
26243 drawn in reverse direction. */
26244 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26245 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26249 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26250 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26252 glyph
->overlaps_vertically_p
= 0;
26253 glyph
->padding_p
= 0;
26254 glyph
->glyph_not_available_p
= 0;
26255 glyph
->face_id
= it
->face_id
;
26256 glyph
->u
.xwidget
= it
->xwidget
;
26257 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26260 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26261 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26262 glyph
->bidi_type
= it
->bidi_it
.type
;
26264 ++it
->glyph_row
->used
[area
];
26267 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26272 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
26273 of the glyph, WIDTH and HEIGHT are the width and height of the
26274 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
26277 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
26278 int width
, int height
, int ascent
)
26280 struct glyph
*glyph
;
26281 enum glyph_row_area area
= it
->area
;
26283 eassert (ascent
>= 0 && ascent
<= height
);
26285 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26286 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26288 /* If the glyph row is reversed, we need to prepend the glyph
26289 rather than append it. */
26290 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26294 /* Make room for the additional glyph. */
26295 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26297 glyph
= it
->glyph_row
->glyphs
[area
];
26299 /* Decrease the width of the first glyph of the row that
26300 begins before first_visible_x (e.g., due to hscroll).
26301 This is so the overall width of the row becomes smaller
26302 by the scroll amount, and the stretch glyph appended by
26303 extend_face_to_end_of_line will be wider, to shift the
26304 row glyphs to the right. (In L2R rows, the corresponding
26305 left-shift effect is accomplished by setting row->x to a
26306 negative value, which won't work with R2L rows.)
26308 This must leave us with a positive value of WIDTH, since
26309 otherwise the call to move_it_in_display_line_to at the
26310 beginning of display_line would have got past the entire
26311 first glyph, and then it->current_x would have been
26312 greater or equal to it->first_visible_x. */
26313 if (it
->current_x
< it
->first_visible_x
)
26314 width
-= it
->first_visible_x
- it
->current_x
;
26315 eassert (width
> 0);
26317 glyph
->charpos
= CHARPOS (it
->position
);
26318 glyph
->object
= object
;
26319 /* FIXME: It would be better to use TYPE_MAX here, but
26320 __typeof__ is not portable enough... */
26321 glyph
->pixel_width
= clip_to_bounds (-1, width
, SHRT_MAX
);
26322 glyph
->ascent
= ascent
;
26323 glyph
->descent
= height
- ascent
;
26324 glyph
->voffset
= it
->voffset
;
26325 glyph
->type
= STRETCH_GLYPH
;
26326 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26327 glyph
->multibyte_p
= it
->multibyte_p
;
26328 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26330 /* In R2L rows, the left and the right box edges need to be
26331 drawn in reverse direction. */
26332 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26333 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26337 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26338 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26340 glyph
->overlaps_vertically_p
= false;
26341 glyph
->padding_p
= false;
26342 glyph
->glyph_not_available_p
= false;
26343 glyph
->face_id
= it
->face_id
;
26344 glyph
->u
.stretch
.ascent
= ascent
;
26345 glyph
->u
.stretch
.height
= height
;
26346 glyph
->slice
.img
= null_glyph_slice
;
26347 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26350 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26351 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26352 glyph
->bidi_type
= it
->bidi_it
.type
;
26356 glyph
->resolved_level
= 0;
26357 glyph
->bidi_type
= UNKNOWN_BT
;
26359 ++it
->glyph_row
->used
[area
];
26362 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26365 #endif /* HAVE_WINDOW_SYSTEM */
26367 /* Produce a stretch glyph for iterator IT. IT->object is the value
26368 of the glyph property displayed. The value must be a list
26369 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
26372 1. `:width WIDTH' specifies that the space should be WIDTH *
26373 canonical char width wide. WIDTH may be an integer or floating
26376 2. `:relative-width FACTOR' specifies that the width of the stretch
26377 should be computed from the width of the first character having the
26378 `glyph' property, and should be FACTOR times that width.
26380 3. `:align-to HPOS' specifies that the space should be wide enough
26381 to reach HPOS, a value in canonical character units.
26383 Exactly one of the above pairs must be present.
26385 4. `:height HEIGHT' specifies that the height of the stretch produced
26386 should be HEIGHT, measured in canonical character units.
26388 5. `:relative-height FACTOR' specifies that the height of the
26389 stretch should be FACTOR times the height of the characters having
26390 the glyph property.
26392 Either none or exactly one of 4 or 5 must be present.
26394 6. `:ascent ASCENT' specifies that ASCENT percent of the height
26395 of the stretch should be used for the ascent of the stretch.
26396 ASCENT must be in the range 0 <= ASCENT <= 100. */
26399 produce_stretch_glyph (struct it
*it
)
26401 /* (space :width WIDTH :height HEIGHT ...) */
26402 Lisp_Object prop
, plist
;
26403 int width
= 0, height
= 0, align_to
= -1;
26404 bool zero_width_ok_p
= false;
26406 struct font
*font
= NULL
;
26408 #ifdef HAVE_WINDOW_SYSTEM
26410 bool zero_height_ok_p
= false;
26412 if (FRAME_WINDOW_P (it
->f
))
26414 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26415 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26416 prepare_face_for_display (it
->f
, face
);
26420 /* List should start with `space'. */
26421 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
26422 plist
= XCDR (it
->object
);
26424 /* Compute the width of the stretch. */
26425 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
26426 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true, 0))
26428 /* Absolute width `:width WIDTH' specified and valid. */
26429 zero_width_ok_p
= true;
26432 else if (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0)
26434 /* Relative width `:relative-width FACTOR' specified and valid.
26435 Compute the width of the characters having the `glyph'
26438 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
26441 if (it
->multibyte_p
)
26442 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
26445 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
26446 if (! ASCII_CHAR_P (it2
.c
))
26447 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
26450 it2
.glyph_row
= NULL
;
26451 it2
.what
= IT_CHARACTER
;
26452 PRODUCE_GLYPHS (&it2
);
26453 width
= NUMVAL (prop
) * it2
.pixel_width
;
26455 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
26456 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true,
26459 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
26460 align_to
= (align_to
< 0
26462 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
26463 else if (align_to
< 0)
26464 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
26465 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
26466 zero_width_ok_p
= true;
26469 /* Nothing specified -> width defaults to canonical char width. */
26470 width
= FRAME_COLUMN_WIDTH (it
->f
);
26472 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
26475 #ifdef HAVE_WINDOW_SYSTEM
26476 /* Compute height. */
26477 if (FRAME_WINDOW_P (it
->f
))
26479 int default_height
= normal_char_height (font
, ' ');
26481 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
26482 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26485 zero_height_ok_p
= true;
26487 else if (prop
= Fplist_get (plist
, QCrelative_height
),
26489 height
= default_height
* NUMVAL (prop
);
26491 height
= default_height
;
26493 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
26496 /* Compute percentage of height used for ascent. If
26497 `:ascent ASCENT' is present and valid, use that. Otherwise,
26498 derive the ascent from the font in use. */
26499 if (prop
= Fplist_get (plist
, QCascent
),
26500 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
26501 ascent
= height
* NUMVAL (prop
) / 100.0;
26502 else if (!NILP (prop
)
26503 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26504 ascent
= min (max (0, (int)tem
), height
);
26506 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
26509 #endif /* HAVE_WINDOW_SYSTEM */
26512 if (width
> 0 && it
->line_wrap
!= TRUNCATE
26513 && it
->current_x
+ width
> it
->last_visible_x
)
26515 width
= it
->last_visible_x
- it
->current_x
;
26516 #ifdef HAVE_WINDOW_SYSTEM
26517 /* Subtract one more pixel from the stretch width, but only on
26518 GUI frames, since on a TTY each glyph is one "pixel" wide. */
26519 width
-= FRAME_WINDOW_P (it
->f
);
26523 if (width
> 0 && height
> 0 && it
->glyph_row
)
26525 Lisp_Object o_object
= it
->object
;
26526 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
26529 if (!STRINGP (object
))
26530 object
= it
->w
->contents
;
26531 #ifdef HAVE_WINDOW_SYSTEM
26532 if (FRAME_WINDOW_P (it
->f
))
26533 append_stretch_glyph (it
, object
, width
, height
, ascent
);
26537 it
->object
= object
;
26538 it
->char_to_display
= ' ';
26539 it
->pixel_width
= it
->len
= 1;
26541 tty_append_glyph (it
);
26542 it
->object
= o_object
;
26546 it
->pixel_width
= width
;
26547 #ifdef HAVE_WINDOW_SYSTEM
26548 if (FRAME_WINDOW_P (it
->f
))
26550 it
->ascent
= it
->phys_ascent
= ascent
;
26551 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
26552 it
->nglyphs
= width
> 0 && height
> 0;
26553 take_vertical_position_into_account (it
);
26557 it
->nglyphs
= width
;
26560 /* Get information about special display element WHAT in an
26561 environment described by IT. WHAT is one of IT_TRUNCATION or
26562 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
26563 non-null glyph_row member. This function ensures that fields like
26564 face_id, c, len of IT are left untouched. */
26567 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
26574 temp_it
.object
= Qnil
;
26575 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
26577 if (what
== IT_CONTINUATION
)
26579 /* Continuation glyph. For R2L lines, we mirror it by hand. */
26580 if (it
->bidi_it
.paragraph_dir
== R2L
)
26581 SET_GLYPH_FROM_CHAR (glyph
, '/');
26583 SET_GLYPH_FROM_CHAR (glyph
, '\\');
26585 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26587 /* FIXME: Should we mirror GC for R2L lines? */
26588 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26589 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26592 else if (what
== IT_TRUNCATION
)
26594 /* Truncation glyph. */
26595 SET_GLYPH_FROM_CHAR (glyph
, '$');
26597 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26599 /* FIXME: Should we mirror GC for R2L lines? */
26600 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26601 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26607 #ifdef HAVE_WINDOW_SYSTEM
26608 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
26609 is turned off, we precede the truncation/continuation glyphs by a
26610 stretch glyph whose width is computed such that these special
26611 glyphs are aligned at the window margin, even when very different
26612 fonts are used in different glyph rows. */
26613 if (FRAME_WINDOW_P (temp_it
.f
)
26614 /* init_iterator calls this with it->glyph_row == NULL, and it
26615 wants only the pixel width of the truncation/continuation
26617 && temp_it
.glyph_row
26618 /* insert_left_trunc_glyphs calls us at the beginning of the
26619 row, and it has its own calculation of the stretch glyph
26621 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
26622 && (temp_it
.glyph_row
->reversed_p
26623 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
26624 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
26626 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
26628 if (stretch_width
> 0)
26630 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
26631 struct font
*font
=
26632 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
26633 int stretch_ascent
=
26634 (((temp_it
.ascent
+ temp_it
.descent
)
26635 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
26637 append_stretch_glyph (&temp_it
, Qnil
, stretch_width
,
26638 temp_it
.ascent
+ temp_it
.descent
,
26645 temp_it
.what
= IT_CHARACTER
;
26646 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
26647 temp_it
.face_id
= GLYPH_FACE (glyph
);
26648 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
26650 PRODUCE_GLYPHS (&temp_it
);
26651 it
->pixel_width
= temp_it
.pixel_width
;
26652 it
->nglyphs
= temp_it
.nglyphs
;
26655 #ifdef HAVE_WINDOW_SYSTEM
26657 /* Calculate line-height and line-spacing properties.
26658 An integer value specifies explicit pixel value.
26659 A float value specifies relative value to current face height.
26660 A cons (float . face-name) specifies relative value to
26661 height of specified face font.
26663 Returns height in pixels, or nil. */
26666 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
26667 int boff
, bool override
)
26669 Lisp_Object face_name
= Qnil
;
26670 int ascent
, descent
, height
;
26672 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
26677 face_name
= XCAR (val
);
26679 if (!NUMBERP (val
))
26680 val
= make_number (1);
26681 if (NILP (face_name
))
26683 height
= it
->ascent
+ it
->descent
;
26688 if (NILP (face_name
))
26690 font
= FRAME_FONT (it
->f
);
26691 boff
= FRAME_BASELINE_OFFSET (it
->f
);
26693 else if (EQ (face_name
, Qt
))
26702 face_id
= lookup_named_face (it
->f
, face_name
, false);
26704 return make_number (-1);
26706 face
= FACE_FROM_ID (it
->f
, face_id
);
26709 return make_number (-1);
26710 boff
= font
->baseline_offset
;
26711 if (font
->vertical_centering
)
26712 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26715 normal_char_ascent_descent (font
, -1, &ascent
, &descent
);
26719 it
->override_ascent
= ascent
;
26720 it
->override_descent
= descent
;
26721 it
->override_boff
= boff
;
26724 height
= ascent
+ descent
;
26728 height
= (int)(XFLOAT_DATA (val
) * height
);
26729 else if (INTEGERP (val
))
26730 height
*= XINT (val
);
26732 return make_number (height
);
26736 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
26737 is a face ID to be used for the glyph. FOR_NO_FONT is true if
26738 and only if this is for a character for which no font was found.
26740 If the display method (it->glyphless_method) is
26741 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
26742 length of the acronym or the hexadecimal string, UPPER_XOFF and
26743 UPPER_YOFF are pixel offsets for the upper part of the string,
26744 LOWER_XOFF and LOWER_YOFF are for the lower part.
26746 For the other display methods, LEN through LOWER_YOFF are zero. */
26749 append_glyphless_glyph (struct it
*it
, int face_id
, bool for_no_font
, int len
,
26750 short upper_xoff
, short upper_yoff
,
26751 short lower_xoff
, short lower_yoff
)
26753 struct glyph
*glyph
;
26754 enum glyph_row_area area
= it
->area
;
26756 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26757 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26759 /* If the glyph row is reversed, we need to prepend the glyph
26760 rather than append it. */
26761 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26765 /* Make room for the additional glyph. */
26766 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26768 glyph
= it
->glyph_row
->glyphs
[area
];
26770 glyph
->charpos
= CHARPOS (it
->position
);
26771 glyph
->object
= it
->object
;
26772 eassert (it
->pixel_width
<= SHRT_MAX
);
26773 glyph
->pixel_width
= it
->pixel_width
;
26774 glyph
->ascent
= it
->ascent
;
26775 glyph
->descent
= it
->descent
;
26776 glyph
->voffset
= it
->voffset
;
26777 glyph
->type
= GLYPHLESS_GLYPH
;
26778 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
26779 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
26780 glyph
->u
.glyphless
.len
= len
;
26781 glyph
->u
.glyphless
.ch
= it
->c
;
26782 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
26783 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
26784 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
26785 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
26786 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26787 glyph
->multibyte_p
= it
->multibyte_p
;
26788 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26790 /* In R2L rows, the left and the right box edges need to be
26791 drawn in reverse direction. */
26792 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26793 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26797 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26798 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26800 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
26801 || it
->phys_descent
> it
->descent
);
26802 glyph
->padding_p
= false;
26803 glyph
->glyph_not_available_p
= false;
26804 glyph
->face_id
= face_id
;
26805 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26808 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26809 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26810 glyph
->bidi_type
= it
->bidi_it
.type
;
26812 ++it
->glyph_row
->used
[area
];
26815 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26819 /* Produce a glyph for a glyphless character for iterator IT.
26820 IT->glyphless_method specifies which method to use for displaying
26821 the character. See the description of enum
26822 glyphless_display_method in dispextern.h for the detail.
26824 FOR_NO_FONT is true if and only if this is for a character for
26825 which no font was found. ACRONYM, if non-nil, is an acronym string
26826 for the character. */
26829 produce_glyphless_glyph (struct it
*it
, bool for_no_font
, Lisp_Object acronym
)
26834 int base_width
, base_height
, width
, height
;
26835 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26838 /* Get the metrics of the base font. We always refer to the current
26840 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26841 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26842 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
26843 it
->ascent
+= font
->baseline_offset
;
26844 it
->descent
-= font
->baseline_offset
;
26845 base_height
= it
->ascent
+ it
->descent
;
26846 base_width
= font
->average_width
;
26848 face_id
= merge_glyphless_glyph_face (it
);
26850 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26852 it
->pixel_width
= THIN_SPACE_WIDTH
;
26854 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26856 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26858 width
= CHAR_WIDTH (it
->c
);
26861 else if (width
> 4)
26863 it
->pixel_width
= base_width
* width
;
26865 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26871 unsigned int code
[6];
26873 int ascent
, descent
;
26874 struct font_metrics metrics_upper
, metrics_lower
;
26876 face
= FACE_FROM_ID (it
->f
, face_id
);
26877 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26878 prepare_face_for_display (it
->f
, face
);
26880 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26882 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26883 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26884 if (CONSP (acronym
))
26885 acronym
= XCAR (acronym
);
26886 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26890 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26891 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
+ 0u);
26894 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
26895 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26896 upper_len
= (len
+ 1) / 2;
26897 font
->driver
->text_extents (font
, code
, upper_len
,
26899 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26904 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26905 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26906 upper_xoff
= upper_yoff
= 2; /* the typical case */
26907 if (base_width
>= width
)
26909 /* Align the upper to the left, the lower to the right. */
26910 it
->pixel_width
= base_width
;
26911 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26915 /* Center the shorter one. */
26916 it
->pixel_width
= width
;
26917 if (metrics_upper
.width
>= metrics_lower
.width
)
26918 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26921 /* FIXME: This code doesn't look right. It formerly was
26922 missing the "lower_xoff = 0;", which couldn't have
26923 been right since it left lower_xoff uninitialized. */
26925 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26929 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26930 top, bottom, and between upper and lower strings. */
26931 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26932 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26933 /* Center vertically.
26934 H:base_height, D:base_descent
26935 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26937 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26938 descent = D - H/2 + h/2;
26939 lower_yoff = descent - 2 - ld;
26940 upper_yoff = lower_yoff - la - 1 - ud; */
26941 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26942 descent
= it
->descent
- (base_height
- height
) / 2;
26943 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26944 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26945 - metrics_upper
.descent
);
26946 /* Don't make the height shorter than the base height. */
26947 if (height
> base_height
)
26949 it
->ascent
= ascent
;
26950 it
->descent
= descent
;
26954 it
->phys_ascent
= it
->ascent
;
26955 it
->phys_descent
= it
->descent
;
26957 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26958 upper_xoff
, upper_yoff
,
26959 lower_xoff
, lower_yoff
);
26961 take_vertical_position_into_account (it
);
26966 Produce glyphs/get display metrics for the display element IT is
26967 loaded with. See the description of struct it in dispextern.h
26968 for an overview of struct it. */
26971 x_produce_glyphs (struct it
*it
)
26973 int extra_line_spacing
= it
->extra_line_spacing
;
26975 it
->glyph_not_available_p
= false;
26977 if (it
->what
== IT_CHARACTER
)
26980 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26981 struct font
*font
= face
->font
;
26982 struct font_metrics
*pcm
= NULL
;
26983 int boff
; /* Baseline offset. */
26987 /* When no suitable font is found, display this character by
26988 the method specified in the first extra slot of
26989 Vglyphless_char_display. */
26990 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26992 eassert (it
->what
== IT_GLYPHLESS
);
26993 produce_glyphless_glyph (it
, true,
26994 STRINGP (acronym
) ? acronym
: Qnil
);
26998 boff
= font
->baseline_offset
;
26999 if (font
->vertical_centering
)
27000 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
27002 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
27006 if (it
->override_ascent
>= 0)
27008 it
->ascent
= it
->override_ascent
;
27009 it
->descent
= it
->override_descent
;
27010 boff
= it
->override_boff
;
27014 it
->ascent
= FONT_BASE (font
) + boff
;
27015 it
->descent
= FONT_DESCENT (font
) - boff
;
27018 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
27020 pcm
= get_per_char_metric (font
, &char2b
);
27021 if (pcm
->width
== 0
27022 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
27028 it
->phys_ascent
= pcm
->ascent
+ boff
;
27029 it
->phys_descent
= pcm
->descent
- boff
;
27030 it
->pixel_width
= pcm
->width
;
27031 /* Don't use font-global values for ascent and descent
27032 if they result in an exceedingly large line height. */
27033 if (it
->override_ascent
< 0)
27035 if (FONT_TOO_HIGH (font
))
27037 it
->ascent
= it
->phys_ascent
;
27038 it
->descent
= it
->phys_descent
;
27039 /* These limitations are enforced by an
27040 assertion near the end of this function. */
27041 if (it
->ascent
< 0)
27043 if (it
->descent
< 0)
27050 it
->glyph_not_available_p
= true;
27051 it
->phys_ascent
= it
->ascent
;
27052 it
->phys_descent
= it
->descent
;
27053 it
->pixel_width
= font
->space_width
;
27056 if (it
->constrain_row_ascent_descent_p
)
27058 if (it
->descent
> it
->max_descent
)
27060 it
->ascent
+= it
->descent
- it
->max_descent
;
27061 it
->descent
= it
->max_descent
;
27063 if (it
->ascent
> it
->max_ascent
)
27065 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
27066 it
->ascent
= it
->max_ascent
;
27068 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
27069 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
27070 extra_line_spacing
= 0;
27073 /* If this is a space inside a region of text with
27074 `space-width' property, change its width. */
27076 = it
->char_to_display
== ' ' && !NILP (it
->space_width
);
27078 it
->pixel_width
*= XFLOATINT (it
->space_width
);
27080 /* If face has a box, add the box thickness to the character
27081 height. If character has a box line to the left and/or
27082 right, add the box line width to the character's width. */
27083 if (face
->box
!= FACE_NO_BOX
)
27085 int thick
= face
->box_line_width
;
27089 it
->ascent
+= thick
;
27090 it
->descent
+= thick
;
27095 if (it
->start_of_box_run_p
)
27096 it
->pixel_width
+= thick
;
27097 if (it
->end_of_box_run_p
)
27098 it
->pixel_width
+= thick
;
27101 /* If face has an overline, add the height of the overline
27102 (1 pixel) and a 1 pixel margin to the character height. */
27103 if (face
->overline_p
)
27104 it
->ascent
+= overline_margin
;
27106 if (it
->constrain_row_ascent_descent_p
)
27108 if (it
->ascent
> it
->max_ascent
)
27109 it
->ascent
= it
->max_ascent
;
27110 if (it
->descent
> it
->max_descent
)
27111 it
->descent
= it
->max_descent
;
27114 take_vertical_position_into_account (it
);
27116 /* If we have to actually produce glyphs, do it. */
27121 /* Translate a space with a `space-width' property
27122 into a stretch glyph. */
27123 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
27124 / FONT_HEIGHT (font
));
27125 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
27126 it
->ascent
+ it
->descent
, ascent
);
27131 /* If characters with lbearing or rbearing are displayed
27132 in this line, record that fact in a flag of the
27133 glyph row. This is used to optimize X output code. */
27134 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
27135 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27137 if (! stretched_p
&& it
->pixel_width
== 0)
27138 /* We assure that all visible glyphs have at least 1-pixel
27140 it
->pixel_width
= 1;
27142 else if (it
->char_to_display
== '\n')
27144 /* A newline has no width, but we need the height of the
27145 line. But if previous part of the line sets a height,
27146 don't increase that height. */
27148 Lisp_Object height
;
27149 Lisp_Object total_height
= Qnil
;
27151 it
->override_ascent
= -1;
27152 it
->pixel_width
= 0;
27155 height
= get_it_property (it
, Qline_height
);
27156 /* Split (line-height total-height) list. */
27158 && CONSP (XCDR (height
))
27159 && NILP (XCDR (XCDR (height
))))
27161 total_height
= XCAR (XCDR (height
));
27162 height
= XCAR (height
);
27164 height
= calc_line_height_property (it
, height
, font
, boff
, true);
27166 if (it
->override_ascent
>= 0)
27168 it
->ascent
= it
->override_ascent
;
27169 it
->descent
= it
->override_descent
;
27170 boff
= it
->override_boff
;
27174 if (FONT_TOO_HIGH (font
))
27176 it
->ascent
= font
->pixel_size
+ boff
- 1;
27177 it
->descent
= -boff
+ 1;
27178 if (it
->descent
< 0)
27183 it
->ascent
= FONT_BASE (font
) + boff
;
27184 it
->descent
= FONT_DESCENT (font
) - boff
;
27188 if (EQ (height
, Qt
))
27190 if (it
->descent
> it
->max_descent
)
27192 it
->ascent
+= it
->descent
- it
->max_descent
;
27193 it
->descent
= it
->max_descent
;
27195 if (it
->ascent
> it
->max_ascent
)
27197 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
27198 it
->ascent
= it
->max_ascent
;
27200 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
27201 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
27202 it
->constrain_row_ascent_descent_p
= true;
27203 extra_line_spacing
= 0;
27207 Lisp_Object spacing
;
27209 it
->phys_ascent
= it
->ascent
;
27210 it
->phys_descent
= it
->descent
;
27212 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
27213 && face
->box
!= FACE_NO_BOX
27214 && face
->box_line_width
> 0)
27216 it
->ascent
+= face
->box_line_width
;
27217 it
->descent
+= face
->box_line_width
;
27220 && XINT (height
) > it
->ascent
+ it
->descent
)
27221 it
->ascent
= XINT (height
) - it
->descent
;
27223 if (!NILP (total_height
))
27224 spacing
= calc_line_height_property (it
, total_height
, font
,
27228 spacing
= get_it_property (it
, Qline_spacing
);
27229 spacing
= calc_line_height_property (it
, spacing
, font
,
27232 if (INTEGERP (spacing
))
27234 extra_line_spacing
= XINT (spacing
);
27235 if (!NILP (total_height
))
27236 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
27240 else /* i.e. (it->char_to_display == '\t') */
27242 if (font
->space_width
> 0)
27244 int tab_width
= it
->tab_width
* font
->space_width
;
27245 int x
= it
->current_x
+ it
->continuation_lines_width
;
27246 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
27248 /* If the distance from the current position to the next tab
27249 stop is less than a space character width, use the
27250 tab stop after that. */
27251 if (next_tab_x
- x
< font
->space_width
)
27252 next_tab_x
+= tab_width
;
27254 it
->pixel_width
= next_tab_x
- x
;
27256 if (FONT_TOO_HIGH (font
))
27258 if (get_char_glyph_code (' ', font
, &char2b
))
27260 pcm
= get_per_char_metric (font
, &char2b
);
27261 if (pcm
->width
== 0
27262 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
27268 it
->ascent
= pcm
->ascent
+ boff
;
27269 it
->descent
= pcm
->descent
- boff
;
27273 it
->ascent
= font
->pixel_size
+ boff
- 1;
27274 it
->descent
= -boff
+ 1;
27276 if (it
->ascent
< 0)
27278 if (it
->descent
< 0)
27283 it
->ascent
= FONT_BASE (font
) + boff
;
27284 it
->descent
= FONT_DESCENT (font
) - boff
;
27286 it
->phys_ascent
= it
->ascent
;
27287 it
->phys_descent
= it
->descent
;
27291 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
27292 it
->ascent
+ it
->descent
, it
->ascent
);
27297 it
->pixel_width
= 0;
27302 if (FONT_TOO_HIGH (font
))
27304 int font_ascent
, font_descent
;
27306 /* For very large fonts, where we ignore the declared font
27307 dimensions, and go by per-character metrics instead,
27308 don't let the row ascent and descent values (and the row
27309 height computed from them) be smaller than the "normal"
27310 character metrics. This avoids unpleasant effects
27311 whereby lines on display would change their height
27312 depending on which characters are shown. */
27313 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
27314 it
->max_ascent
= max (it
->max_ascent
, font_ascent
);
27315 it
->max_descent
= max (it
->max_descent
, font_descent
);
27318 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
27320 /* A static composition.
27322 Note: A composition is represented as one glyph in the
27323 glyph matrix. There are no padding glyphs.
27325 Important note: pixel_width, ascent, and descent are the
27326 values of what is drawn by draw_glyphs (i.e. the values of
27327 the overall glyphs composed). */
27328 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27329 int boff
; /* baseline offset */
27330 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
27331 int glyph_len
= cmp
->glyph_len
;
27332 struct font
*font
= face
->font
;
27336 /* If we have not yet calculated pixel size data of glyphs of
27337 the composition for the current face font, calculate them
27338 now. Theoretically, we have to check all fonts for the
27339 glyphs, but that requires much time and memory space. So,
27340 here we check only the font of the first glyph. This may
27341 lead to incorrect display, but it's very rare, and C-l
27342 (recenter-top-bottom) can correct the display anyway. */
27343 if (! cmp
->font
|| cmp
->font
!= font
)
27345 /* Ascent and descent of the font of the first character
27346 of this composition (adjusted by baseline offset).
27347 Ascent and descent of overall glyphs should not be less
27348 than these, respectively. */
27349 int font_ascent
, font_descent
, font_height
;
27350 /* Bounding box of the overall glyphs. */
27351 int leftmost
, rightmost
, lowest
, highest
;
27352 int lbearing
, rbearing
;
27353 int i
, width
, ascent
, descent
;
27356 struct font_metrics
*pcm
;
27359 eassume (0 < glyph_len
); /* See Bug#8512. */
27361 c
= COMPOSITION_GLYPH (cmp
, --glyph_len
);
27362 while (c
== '\t' && 0 < glyph_len
);
27364 bool right_padded
= glyph_len
< cmp
->glyph_len
;
27365 for (i
= 0; i
< glyph_len
; i
++)
27367 c
= COMPOSITION_GLYPH (cmp
, i
);
27370 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
27372 bool left_padded
= i
> 0;
27374 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
27375 : IT_CHARPOS (*it
));
27376 /* If no suitable font is found, use the default font. */
27377 bool font_not_found_p
= font
== NULL
;
27378 if (font_not_found_p
)
27380 face
= face
->ascii_face
;
27383 boff
= font
->baseline_offset
;
27384 if (font
->vertical_centering
)
27385 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
27386 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
27387 font_ascent
+= boff
;
27388 font_descent
-= boff
;
27389 font_height
= font_ascent
+ font_descent
;
27394 if (! font_not_found_p
)
27396 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
27398 pcm
= get_per_char_metric (font
, &char2b
);
27401 /* Initialize the bounding box. */
27404 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
27405 ascent
= pcm
->ascent
;
27406 descent
= pcm
->descent
;
27407 lbearing
= pcm
->lbearing
;
27408 rbearing
= pcm
->rbearing
;
27412 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
27413 ascent
= FONT_BASE (font
);
27414 descent
= FONT_DESCENT (font
);
27421 lowest
= - descent
+ boff
;
27422 highest
= ascent
+ boff
;
27424 if (! font_not_found_p
27425 && font
->default_ascent
27426 && CHAR_TABLE_P (Vuse_default_ascent
)
27427 && !NILP (Faref (Vuse_default_ascent
,
27428 make_number (it
->char_to_display
))))
27429 highest
= font
->default_ascent
+ boff
;
27431 /* Draw the first glyph at the normal position. It may be
27432 shifted to right later if some other glyphs are drawn
27434 cmp
->offsets
[i
* 2] = 0;
27435 cmp
->offsets
[i
* 2 + 1] = boff
;
27436 cmp
->lbearing
= lbearing
;
27437 cmp
->rbearing
= rbearing
;
27439 /* Set cmp->offsets for the remaining glyphs. */
27440 for (i
++; i
< glyph_len
; i
++)
27442 int left
, right
, btm
, top
;
27443 int ch
= COMPOSITION_GLYPH (cmp
, i
);
27445 struct face
*this_face
;
27449 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
27450 this_face
= FACE_FROM_ID (it
->f
, face_id
);
27451 font
= this_face
->font
;
27457 get_char_face_and_encoding (it
->f
, ch
, face_id
,
27459 pcm
= get_per_char_metric (font
, &char2b
);
27462 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
27465 width
= pcm
->width
;
27466 ascent
= pcm
->ascent
;
27467 descent
= pcm
->descent
;
27468 lbearing
= pcm
->lbearing
;
27469 rbearing
= pcm
->rbearing
;
27470 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
27472 /* Relative composition with or without
27473 alternate chars. */
27474 left
= (leftmost
+ rightmost
- width
) / 2;
27475 btm
= - descent
+ boff
;
27476 if (font
->relative_compose
27477 && (! CHAR_TABLE_P (Vignore_relative_composition
)
27478 || NILP (Faref (Vignore_relative_composition
,
27479 make_number (ch
)))))
27482 if (- descent
>= font
->relative_compose
)
27483 /* One extra pixel between two glyphs. */
27485 else if (ascent
<= 0)
27486 /* One extra pixel between two glyphs. */
27487 btm
= lowest
- 1 - ascent
- descent
;
27492 /* A composition rule is specified by an integer
27493 value that encodes global and new reference
27494 points (GREF and NREF). GREF and NREF are
27495 specified by numbers as below:
27497 0---1---2 -- ascent
27501 9--10--11 -- center
27503 ---3---4---5--- baseline
27505 6---7---8 -- descent
27507 int rule
= COMPOSITION_RULE (cmp
, i
);
27508 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
27510 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
27511 grefx
= gref
% 3, nrefx
= nref
% 3;
27512 grefy
= gref
/ 3, nrefy
= nref
/ 3;
27514 xoff
= font_height
* (xoff
- 128) / 256;
27516 yoff
= font_height
* (yoff
- 128) / 256;
27519 + grefx
* (rightmost
- leftmost
) / 2
27520 - nrefx
* width
/ 2
27523 btm
= ((grefy
== 0 ? highest
27525 : grefy
== 2 ? lowest
27526 : (highest
+ lowest
) / 2)
27527 - (nrefy
== 0 ? ascent
+ descent
27528 : nrefy
== 1 ? descent
- boff
27530 : (ascent
+ descent
) / 2)
27534 cmp
->offsets
[i
* 2] = left
;
27535 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
27537 /* Update the bounding box of the overall glyphs. */
27540 right
= left
+ width
;
27541 if (left
< leftmost
)
27543 if (right
> rightmost
)
27546 top
= btm
+ descent
+ ascent
;
27552 if (cmp
->lbearing
> left
+ lbearing
)
27553 cmp
->lbearing
= left
+ lbearing
;
27554 if (cmp
->rbearing
< left
+ rbearing
)
27555 cmp
->rbearing
= left
+ rbearing
;
27559 /* If there are glyphs whose x-offsets are negative,
27560 shift all glyphs to the right and make all x-offsets
27564 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27565 cmp
->offsets
[i
* 2] -= leftmost
;
27566 rightmost
-= leftmost
;
27567 cmp
->lbearing
-= leftmost
;
27568 cmp
->rbearing
-= leftmost
;
27571 if (left_padded
&& cmp
->lbearing
< 0)
27573 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27574 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
27575 rightmost
-= cmp
->lbearing
;
27576 cmp
->rbearing
-= cmp
->lbearing
;
27579 if (right_padded
&& rightmost
< cmp
->rbearing
)
27581 rightmost
= cmp
->rbearing
;
27584 cmp
->pixel_width
= rightmost
;
27585 cmp
->ascent
= highest
;
27586 cmp
->descent
= - lowest
;
27587 if (cmp
->ascent
< font_ascent
)
27588 cmp
->ascent
= font_ascent
;
27589 if (cmp
->descent
< font_descent
)
27590 cmp
->descent
= font_descent
;
27594 && (cmp
->lbearing
< 0
27595 || cmp
->rbearing
> cmp
->pixel_width
))
27596 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27598 it
->pixel_width
= cmp
->pixel_width
;
27599 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
27600 it
->descent
= it
->phys_descent
= cmp
->descent
;
27601 if (face
->box
!= FACE_NO_BOX
)
27603 int thick
= face
->box_line_width
;
27607 it
->ascent
+= thick
;
27608 it
->descent
+= thick
;
27613 if (it
->start_of_box_run_p
)
27614 it
->pixel_width
+= thick
;
27615 if (it
->end_of_box_run_p
)
27616 it
->pixel_width
+= thick
;
27619 /* If face has an overline, add the height of the overline
27620 (1 pixel) and a 1 pixel margin to the character height. */
27621 if (face
->overline_p
)
27622 it
->ascent
+= overline_margin
;
27624 take_vertical_position_into_account (it
);
27625 if (it
->ascent
< 0)
27627 if (it
->descent
< 0)
27630 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
27631 append_composite_glyph (it
);
27633 else if (it
->what
== IT_COMPOSITION
)
27635 /* A dynamic (automatic) composition. */
27636 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27637 Lisp_Object gstring
;
27638 struct font_metrics metrics
;
27642 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
27644 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
27647 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
27648 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27649 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
27650 it
->descent
= it
->phys_descent
= metrics
.descent
;
27651 if (face
->box
!= FACE_NO_BOX
)
27653 int thick
= face
->box_line_width
;
27657 it
->ascent
+= thick
;
27658 it
->descent
+= thick
;
27663 if (it
->start_of_box_run_p
)
27664 it
->pixel_width
+= thick
;
27665 if (it
->end_of_box_run_p
)
27666 it
->pixel_width
+= thick
;
27668 /* If face has an overline, add the height of the overline
27669 (1 pixel) and a 1 pixel margin to the character height. */
27670 if (face
->overline_p
)
27671 it
->ascent
+= overline_margin
;
27672 take_vertical_position_into_account (it
);
27673 if (it
->ascent
< 0)
27675 if (it
->descent
< 0)
27679 append_composite_glyph (it
);
27681 else if (it
->what
== IT_GLYPHLESS
)
27682 produce_glyphless_glyph (it
, false, Qnil
);
27683 else if (it
->what
== IT_IMAGE
)
27684 produce_image_glyph (it
);
27685 else if (it
->what
== IT_STRETCH
)
27686 produce_stretch_glyph (it
);
27687 else if (it
->what
== IT_XWIDGET
)
27688 produce_xwidget_glyph (it
);
27691 /* Accumulate dimensions. Note: can't assume that it->descent > 0
27692 because this isn't true for images with `:ascent 100'. */
27693 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
27694 if (it
->area
== TEXT_AREA
)
27695 it
->current_x
+= it
->pixel_width
;
27697 if (extra_line_spacing
> 0)
27699 it
->descent
+= extra_line_spacing
;
27700 if (extra_line_spacing
> it
->max_extra_line_spacing
)
27701 it
->max_extra_line_spacing
= extra_line_spacing
;
27704 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
27705 it
->max_descent
= max (it
->max_descent
, it
->descent
);
27706 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
27707 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
27711 Output LEN glyphs starting at START at the nominal cursor position.
27712 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
27713 being updated, and UPDATED_AREA is the area of that row being updated. */
27716 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27717 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27719 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
27721 eassert (updated_row
);
27722 /* When the window is hscrolled, cursor hpos can legitimately be out
27723 of bounds, but we draw the cursor at the corresponding window
27724 margin in that case. */
27725 if (!updated_row
->reversed_p
&& chpos
< 0)
27727 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
27728 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
27732 /* Write glyphs. */
27734 hpos
= start
- updated_row
->glyphs
[updated_area
];
27735 x
= draw_glyphs (w
, w
->output_cursor
.x
,
27736 updated_row
, updated_area
,
27738 DRAW_NORMAL_TEXT
, 0);
27740 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
27741 if (updated_area
== TEXT_AREA
27742 && w
->phys_cursor_on_p
27743 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
27745 && chpos
< hpos
+ len
)
27746 w
->phys_cursor_on_p
= false;
27750 /* Advance the output cursor. */
27751 w
->output_cursor
.hpos
+= len
;
27752 w
->output_cursor
.x
= x
;
27757 Insert LEN glyphs from START at the nominal cursor position. */
27760 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27761 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27764 int line_height
, shift_by_width
, shifted_region_width
;
27765 struct glyph_row
*row
;
27766 struct glyph
*glyph
;
27767 int frame_x
, frame_y
;
27770 eassert (updated_row
);
27772 f
= XFRAME (WINDOW_FRAME (w
));
27774 /* Get the height of the line we are in. */
27776 line_height
= row
->height
;
27778 /* Get the width of the glyphs to insert. */
27779 shift_by_width
= 0;
27780 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
27781 shift_by_width
+= glyph
->pixel_width
;
27783 /* Get the width of the region to shift right. */
27784 shifted_region_width
= (window_box_width (w
, updated_area
)
27785 - w
->output_cursor
.x
27789 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
27790 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
27792 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
27793 line_height
, shift_by_width
);
27795 /* Write the glyphs. */
27796 hpos
= start
- row
->glyphs
[updated_area
];
27797 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
27799 DRAW_NORMAL_TEXT
, 0);
27801 /* Advance the output cursor. */
27802 w
->output_cursor
.hpos
+= len
;
27803 w
->output_cursor
.x
+= shift_by_width
;
27809 Erase the current text line from the nominal cursor position
27810 (inclusive) to pixel column TO_X (exclusive). The idea is that
27811 everything from TO_X onward is already erased.
27813 TO_X is a pixel position relative to UPDATED_AREA of currently
27814 updated window W. TO_X == -1 means clear to the end of this area. */
27817 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
27818 enum glyph_row_area updated_area
, int to_x
)
27821 int max_x
, min_y
, max_y
;
27822 int from_x
, from_y
, to_y
;
27824 eassert (updated_row
);
27825 f
= XFRAME (w
->frame
);
27827 if (updated_row
->full_width_p
)
27828 max_x
= (WINDOW_PIXEL_WIDTH (w
)
27829 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
27831 max_x
= window_box_width (w
, updated_area
);
27832 max_y
= window_text_bottom_y (w
);
27834 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
27835 of window. For TO_X > 0, truncate to end of drawing area. */
27841 to_x
= min (to_x
, max_x
);
27843 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
27845 /* Notice if the cursor will be cleared by this operation. */
27846 if (!updated_row
->full_width_p
)
27847 notice_overwritten_cursor (w
, updated_area
,
27848 w
->output_cursor
.x
, -1,
27850 MATRIX_ROW_BOTTOM_Y (updated_row
));
27852 from_x
= w
->output_cursor
.x
;
27854 /* Translate to frame coordinates. */
27855 if (updated_row
->full_width_p
)
27857 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
27858 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
27862 int area_left
= window_box_left (w
, updated_area
);
27863 from_x
+= area_left
;
27867 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
27868 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
27869 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
27871 /* Prevent inadvertently clearing to end of the X window. */
27872 if (to_x
> from_x
&& to_y
> from_y
)
27875 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
27876 to_x
- from_x
, to_y
- from_y
);
27881 #endif /* HAVE_WINDOW_SYSTEM */
27885 /***********************************************************************
27887 ***********************************************************************/
27889 /* Value is the internal representation of the specified cursor type
27890 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27891 of the bar cursor. */
27893 static enum text_cursor_kinds
27894 get_specified_cursor_type (Lisp_Object arg
, int *width
)
27896 enum text_cursor_kinds type
;
27901 if (EQ (arg
, Qbox
))
27902 return FILLED_BOX_CURSOR
;
27904 if (EQ (arg
, Qhollow
))
27905 return HOLLOW_BOX_CURSOR
;
27907 if (EQ (arg
, Qbar
))
27914 && EQ (XCAR (arg
), Qbar
)
27915 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27917 *width
= XINT (XCDR (arg
));
27921 if (EQ (arg
, Qhbar
))
27924 return HBAR_CURSOR
;
27928 && EQ (XCAR (arg
), Qhbar
)
27929 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27931 *width
= XINT (XCDR (arg
));
27932 return HBAR_CURSOR
;
27935 /* Treat anything unknown as "hollow box cursor".
27936 It was bad to signal an error; people have trouble fixing
27937 .Xdefaults with Emacs, when it has something bad in it. */
27938 type
= HOLLOW_BOX_CURSOR
;
27943 /* Set the default cursor types for specified frame. */
27945 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27950 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27951 FRAME_CURSOR_WIDTH (f
) = width
;
27953 /* By default, set up the blink-off state depending on the on-state. */
27955 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27958 FRAME_BLINK_OFF_CURSOR (f
)
27959 = get_specified_cursor_type (XCDR (tem
), &width
);
27960 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27963 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27965 /* Make sure the cursor gets redrawn. */
27966 f
->cursor_type_changed
= true;
27970 #ifdef HAVE_WINDOW_SYSTEM
27972 /* Return the cursor we want to be displayed in window W. Return
27973 width of bar/hbar cursor through WIDTH arg. Return with
27974 ACTIVE_CURSOR arg set to true if cursor in window W is `active'
27975 (i.e. if the `system caret' should track this cursor).
27977 In a mini-buffer window, we want the cursor only to appear if we
27978 are reading input from this window. For the selected window, we
27979 want the cursor type given by the frame parameter or buffer local
27980 setting of cursor-type. If explicitly marked off, draw no cursor.
27981 In all other cases, we want a hollow box cursor. */
27983 static enum text_cursor_kinds
27984 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27985 bool *active_cursor
)
27987 struct frame
*f
= XFRAME (w
->frame
);
27988 struct buffer
*b
= XBUFFER (w
->contents
);
27989 int cursor_type
= DEFAULT_CURSOR
;
27990 Lisp_Object alt_cursor
;
27991 bool non_selected
= false;
27993 *active_cursor
= true;
27996 if (cursor_in_echo_area
27997 && FRAME_HAS_MINIBUF_P (f
)
27998 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
28000 if (w
== XWINDOW (echo_area_window
))
28002 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
28004 *width
= FRAME_CURSOR_WIDTH (f
);
28005 return FRAME_DESIRED_CURSOR (f
);
28008 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
28011 *active_cursor
= false;
28012 non_selected
= true;
28015 /* Detect a nonselected window or nonselected frame. */
28016 else if (w
!= XWINDOW (f
->selected_window
)
28017 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
28019 *active_cursor
= false;
28021 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
28024 non_selected
= true;
28027 /* Never display a cursor in a window in which cursor-type is nil. */
28028 if (NILP (BVAR (b
, cursor_type
)))
28031 /* Get the normal cursor type for this window. */
28032 if (EQ (BVAR (b
, cursor_type
), Qt
))
28034 cursor_type
= FRAME_DESIRED_CURSOR (f
);
28035 *width
= FRAME_CURSOR_WIDTH (f
);
28038 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
28040 /* Use cursor-in-non-selected-windows instead
28041 for non-selected window or frame. */
28044 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
28045 if (!EQ (Qt
, alt_cursor
))
28046 return get_specified_cursor_type (alt_cursor
, width
);
28047 /* t means modify the normal cursor type. */
28048 if (cursor_type
== FILLED_BOX_CURSOR
)
28049 cursor_type
= HOLLOW_BOX_CURSOR
;
28050 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
28052 return cursor_type
;
28055 /* Use normal cursor if not blinked off. */
28056 if (!w
->cursor_off_p
)
28058 if (glyph
!= NULL
&& glyph
->type
== XWIDGET_GLYPH
)
28060 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
28062 if (cursor_type
== FILLED_BOX_CURSOR
)
28064 /* Using a block cursor on large images can be very annoying.
28065 So use a hollow cursor for "large" images.
28066 If image is not transparent (no mask), also use hollow cursor. */
28067 struct image
*img
= IMAGE_OPT_FROM_ID (f
, glyph
->u
.img_id
);
28068 if (img
!= NULL
&& IMAGEP (img
->spec
))
28070 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
28071 where N = size of default frame font size.
28072 This should cover most of the "tiny" icons people may use. */
28074 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
28075 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
28076 cursor_type
= HOLLOW_BOX_CURSOR
;
28079 else if (cursor_type
!= NO_CURSOR
)
28081 /* Display current only supports BOX and HOLLOW cursors for images.
28082 So for now, unconditionally use a HOLLOW cursor when cursor is
28083 not a solid box cursor. */
28084 cursor_type
= HOLLOW_BOX_CURSOR
;
28087 return cursor_type
;
28090 /* Cursor is blinked off, so determine how to "toggle" it. */
28092 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
28093 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
28094 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
28096 /* Then see if frame has specified a specific blink off cursor type. */
28097 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
28099 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
28100 return FRAME_BLINK_OFF_CURSOR (f
);
28104 /* Some people liked having a permanently visible blinking cursor,
28105 while others had very strong opinions against it. So it was
28106 decided to remove it. KFS 2003-09-03 */
28108 /* Finally perform built-in cursor blinking:
28109 filled box <-> hollow box
28110 wide [h]bar <-> narrow [h]bar
28111 narrow [h]bar <-> no cursor
28112 other type <-> no cursor */
28114 if (cursor_type
== FILLED_BOX_CURSOR
)
28115 return HOLLOW_BOX_CURSOR
;
28117 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
28120 return cursor_type
;
28128 /* Notice when the text cursor of window W has been completely
28129 overwritten by a drawing operation that outputs glyphs in AREA
28130 starting at X0 and ending at X1 in the line starting at Y0 and
28131 ending at Y1. X coordinates are area-relative. X1 < 0 means all
28132 the rest of the line after X0 has been written. Y coordinates
28133 are window-relative. */
28136 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
28137 int x0
, int x1
, int y0
, int y1
)
28139 int cx0
, cx1
, cy0
, cy1
;
28140 struct glyph_row
*row
;
28142 if (!w
->phys_cursor_on_p
)
28144 if (area
!= TEXT_AREA
)
28147 if (w
->phys_cursor
.vpos
< 0
28148 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
28149 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
28150 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
28153 if (row
->cursor_in_fringe_p
)
28155 row
->cursor_in_fringe_p
= false;
28156 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
28157 w
->phys_cursor_on_p
= false;
28161 cx0
= w
->phys_cursor
.x
;
28162 cx1
= cx0
+ w
->phys_cursor_width
;
28163 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
28166 /* The cursor image will be completely removed from the
28167 screen if the output area intersects the cursor area in
28168 y-direction. When we draw in [y0 y1[, and some part of
28169 the cursor is at y < y0, that part must have been drawn
28170 before. When scrolling, the cursor is erased before
28171 actually scrolling, so we don't come here. When not
28172 scrolling, the rows above the old cursor row must have
28173 changed, and in this case these rows must have written
28174 over the cursor image.
28176 Likewise if part of the cursor is below y1, with the
28177 exception of the cursor being in the first blank row at
28178 the buffer and window end because update_text_area
28179 doesn't draw that row. (Except when it does, but
28180 that's handled in update_text_area.) */
28182 cy0
= w
->phys_cursor
.y
;
28183 cy1
= cy0
+ w
->phys_cursor_height
;
28184 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
28187 w
->phys_cursor_on_p
= false;
28190 #endif /* HAVE_WINDOW_SYSTEM */
28193 /************************************************************************
28195 ************************************************************************/
28197 #ifdef HAVE_WINDOW_SYSTEM
28200 Fix the display of area AREA of overlapping row ROW in window W
28201 with respect to the overlapping part OVERLAPS. */
28204 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
28205 enum glyph_row_area area
, int overlaps
)
28212 for (i
= 0; i
< row
->used
[area
];)
28214 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
28216 int start
= i
, start_x
= x
;
28220 x
+= row
->glyphs
[area
][i
].pixel_width
;
28223 while (i
< row
->used
[area
]
28224 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
28226 draw_glyphs (w
, start_x
, row
, area
,
28228 DRAW_NORMAL_TEXT
, overlaps
);
28232 x
+= row
->glyphs
[area
][i
].pixel_width
;
28242 Draw the cursor glyph of window W in glyph row ROW. See the
28243 comment of draw_glyphs for the meaning of HL. */
28246 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
28247 enum draw_glyphs_face hl
)
28249 /* If cursor hpos is out of bounds, don't draw garbage. This can
28250 happen in mini-buffer windows when switching between echo area
28251 glyphs and mini-buffer. */
28252 if ((row
->reversed_p
28253 ? (w
->phys_cursor
.hpos
>= 0)
28254 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
28256 bool on_p
= w
->phys_cursor_on_p
;
28258 int hpos
= w
->phys_cursor
.hpos
;
28260 /* When the window is hscrolled, cursor hpos can legitimately be
28261 out of bounds, but we draw the cursor at the corresponding
28262 window margin in that case. */
28263 if (!row
->reversed_p
&& hpos
< 0)
28265 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28266 hpos
= row
->used
[TEXT_AREA
] - 1;
28268 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
28270 w
->phys_cursor_on_p
= on_p
;
28272 if (hl
== DRAW_CURSOR
)
28273 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
28274 /* When we erase the cursor, and ROW is overlapped by other
28275 rows, make sure that these overlapping parts of other rows
28277 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
28279 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
28281 if (row
> w
->current_matrix
->rows
28282 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
28283 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
28284 OVERLAPS_ERASED_CURSOR
);
28286 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
28287 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
28288 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
28289 OVERLAPS_ERASED_CURSOR
);
28295 /* Erase the image of a cursor of window W from the screen. */
28298 erase_phys_cursor (struct window
*w
)
28300 struct frame
*f
= XFRAME (w
->frame
);
28301 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28302 int hpos
= w
->phys_cursor
.hpos
;
28303 int vpos
= w
->phys_cursor
.vpos
;
28304 bool mouse_face_here_p
= false;
28305 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
28306 struct glyph_row
*cursor_row
;
28307 struct glyph
*cursor_glyph
;
28308 enum draw_glyphs_face hl
;
28310 /* No cursor displayed or row invalidated => nothing to do on the
28312 if (w
->phys_cursor_type
== NO_CURSOR
)
28313 goto mark_cursor_off
;
28315 /* VPOS >= active_glyphs->nrows means that window has been resized.
28316 Don't bother to erase the cursor. */
28317 if (vpos
>= active_glyphs
->nrows
)
28318 goto mark_cursor_off
;
28320 /* If row containing cursor is marked invalid, there is nothing we
28322 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
28323 if (!cursor_row
->enabled_p
)
28324 goto mark_cursor_off
;
28326 /* If line spacing is > 0, old cursor may only be partially visible in
28327 window after split-window. So adjust visible height. */
28328 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
28329 window_text_bottom_y (w
) - cursor_row
->y
);
28331 /* If row is completely invisible, don't attempt to delete a cursor which
28332 isn't there. This can happen if cursor is at top of a window, and
28333 we switch to a buffer with a header line in that window. */
28334 if (cursor_row
->visible_height
<= 0)
28335 goto mark_cursor_off
;
28337 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
28338 if (cursor_row
->cursor_in_fringe_p
)
28340 cursor_row
->cursor_in_fringe_p
= false;
28341 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
28342 goto mark_cursor_off
;
28345 /* This can happen when the new row is shorter than the old one.
28346 In this case, either draw_glyphs or clear_end_of_line
28347 should have cleared the cursor. Note that we wouldn't be
28348 able to erase the cursor in this case because we don't have a
28349 cursor glyph at hand. */
28350 if ((cursor_row
->reversed_p
28351 ? (w
->phys_cursor
.hpos
< 0)
28352 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
28353 goto mark_cursor_off
;
28355 /* When the window is hscrolled, cursor hpos can legitimately be out
28356 of bounds, but we draw the cursor at the corresponding window
28357 margin in that case. */
28358 if (!cursor_row
->reversed_p
&& hpos
< 0)
28360 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
28361 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
28363 /* If the cursor is in the mouse face area, redisplay that when
28364 we clear the cursor. */
28365 if (! NILP (hlinfo
->mouse_face_window
)
28366 && coords_in_mouse_face_p (w
, hpos
, vpos
)
28367 /* Don't redraw the cursor's spot in mouse face if it is at the
28368 end of a line (on a newline). The cursor appears there, but
28369 mouse highlighting does not. */
28370 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
28371 mouse_face_here_p
= true;
28373 /* Maybe clear the display under the cursor. */
28374 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
28377 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
28380 cursor_glyph
= get_phys_cursor_glyph (w
);
28381 if (cursor_glyph
== NULL
)
28382 goto mark_cursor_off
;
28384 width
= cursor_glyph
->pixel_width
;
28385 x
= w
->phys_cursor
.x
;
28391 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
28392 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
28393 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
28396 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
28399 /* Erase the cursor by redrawing the character underneath it. */
28400 if (mouse_face_here_p
)
28401 hl
= DRAW_MOUSE_FACE
;
28403 hl
= DRAW_NORMAL_TEXT
;
28404 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
28407 w
->phys_cursor_on_p
= false;
28408 w
->phys_cursor_type
= NO_CURSOR
;
28412 /* Display or clear cursor of window W. If !ON, clear the cursor.
28413 If ON, display the cursor; where to put the cursor is specified by
28414 HPOS, VPOS, X and Y. */
28417 display_and_set_cursor (struct window
*w
, bool on
,
28418 int hpos
, int vpos
, int x
, int y
)
28420 struct frame
*f
= XFRAME (w
->frame
);
28421 int new_cursor_type
;
28422 int new_cursor_width
;
28423 bool active_cursor
;
28424 struct glyph_row
*glyph_row
;
28425 struct glyph
*glyph
;
28427 /* This is pointless on invisible frames, and dangerous on garbaged
28428 windows and frames; in the latter case, the frame or window may
28429 be in the midst of changing its size, and x and y may be off the
28431 if (! FRAME_VISIBLE_P (f
)
28432 || FRAME_GARBAGED_P (f
)
28433 || vpos
>= w
->current_matrix
->nrows
28434 || hpos
>= w
->current_matrix
->matrix_w
)
28437 /* If cursor is off and we want it off, return quickly. */
28438 if (!on
&& !w
->phys_cursor_on_p
)
28441 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28442 /* If cursor row is not enabled, we don't really know where to
28443 display the cursor. */
28444 if (!glyph_row
->enabled_p
)
28446 w
->phys_cursor_on_p
= false;
28451 if (!glyph_row
->exact_window_width_line_p
28452 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
28453 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
28455 eassert (input_blocked_p ());
28457 /* Set new_cursor_type to the cursor we want to be displayed. */
28458 new_cursor_type
= get_window_cursor_type (w
, glyph
,
28459 &new_cursor_width
, &active_cursor
);
28461 /* If cursor is currently being shown and we don't want it to be or
28462 it is in the wrong place, or the cursor type is not what we want,
28464 if (w
->phys_cursor_on_p
28466 || w
->phys_cursor
.x
!= x
28467 || w
->phys_cursor
.y
!= y
28468 /* HPOS can be negative in R2L rows whose
28469 exact_window_width_line_p flag is set (i.e. their newline
28470 would "overflow into the fringe"). */
28472 || new_cursor_type
!= w
->phys_cursor_type
28473 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
28474 && new_cursor_width
!= w
->phys_cursor_width
)))
28475 erase_phys_cursor (w
);
28477 /* Don't check phys_cursor_on_p here because that flag is only set
28478 to false in some cases where we know that the cursor has been
28479 completely erased, to avoid the extra work of erasing the cursor
28480 twice. In other words, phys_cursor_on_p can be true and the cursor
28481 still not be visible, or it has only been partly erased. */
28484 w
->phys_cursor_ascent
= glyph_row
->ascent
;
28485 w
->phys_cursor_height
= glyph_row
->height
;
28487 /* Set phys_cursor_.* before x_draw_.* is called because some
28488 of them may need the information. */
28489 w
->phys_cursor
.x
= x
;
28490 w
->phys_cursor
.y
= glyph_row
->y
;
28491 w
->phys_cursor
.hpos
= hpos
;
28492 w
->phys_cursor
.vpos
= vpos
;
28495 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
28496 new_cursor_type
, new_cursor_width
,
28497 on
, active_cursor
);
28501 /* Switch the display of W's cursor on or off, according to the value
28505 update_window_cursor (struct window
*w
, bool on
)
28507 /* Don't update cursor in windows whose frame is in the process
28508 of being deleted. */
28509 if (w
->current_matrix
)
28511 int hpos
= w
->phys_cursor
.hpos
;
28512 int vpos
= w
->phys_cursor
.vpos
;
28513 struct glyph_row
*row
;
28515 if (vpos
>= w
->current_matrix
->nrows
28516 || hpos
>= w
->current_matrix
->matrix_w
)
28519 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28521 /* When the window is hscrolled, cursor hpos can legitimately be
28522 out of bounds, but we draw the cursor at the corresponding
28523 window margin in that case. */
28524 if (!row
->reversed_p
&& hpos
< 0)
28526 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28527 hpos
= row
->used
[TEXT_AREA
] - 1;
28530 display_and_set_cursor (w
, on
, hpos
, vpos
,
28531 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28537 /* Call update_window_cursor with parameter ON_P on all leaf windows
28538 in the window tree rooted at W. */
28541 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
28545 if (WINDOWP (w
->contents
))
28546 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
28548 update_window_cursor (w
, on_p
);
28550 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
28556 Display the cursor on window W, or clear it, according to ON_P.
28557 Don't change the cursor's position. */
28560 x_update_cursor (struct frame
*f
, bool on_p
)
28562 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
28567 Clear the cursor of window W to background color, and mark the
28568 cursor as not shown. This is used when the text where the cursor
28569 is about to be rewritten. */
28572 x_clear_cursor (struct window
*w
)
28574 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
28575 update_window_cursor (w
, false);
28578 #endif /* HAVE_WINDOW_SYSTEM */
28580 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
28583 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
28584 int start_hpos
, int end_hpos
,
28585 enum draw_glyphs_face draw
)
28587 #ifdef HAVE_WINDOW_SYSTEM
28588 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
28590 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
28594 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
28595 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
28599 /* Display the active region described by mouse_face_* according to DRAW. */
28602 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
28604 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
28605 #ifdef HAVE_WINDOW_SYSTEM
28606 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28608 (void) XFRAME (WINDOW_FRAME (w
));
28611 if (/* If window is in the process of being destroyed, don't bother
28613 w
->current_matrix
!= NULL
28614 /* Don't update mouse highlight if hidden. */
28615 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
28616 /* Recognize when we are called to operate on rows that don't exist
28617 anymore. This can happen when a window is split. */
28618 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
28620 #ifdef HAVE_WINDOW_SYSTEM
28621 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
28623 struct glyph_row
*row
, *first
, *last
;
28625 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
28626 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
28628 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
28630 int start_hpos
, end_hpos
, start_x
;
28632 /* For all but the first row, the highlight starts at column 0. */
28635 /* R2L rows have BEG and END in reversed order, but the
28636 screen drawing geometry is always left to right. So
28637 we need to mirror the beginning and end of the
28638 highlighted area in R2L rows. */
28639 if (!row
->reversed_p
)
28641 start_hpos
= hlinfo
->mouse_face_beg_col
;
28642 start_x
= hlinfo
->mouse_face_beg_x
;
28644 else if (row
== last
)
28646 start_hpos
= hlinfo
->mouse_face_end_col
;
28647 start_x
= hlinfo
->mouse_face_end_x
;
28655 else if (row
->reversed_p
&& row
== last
)
28657 start_hpos
= hlinfo
->mouse_face_end_col
;
28658 start_x
= hlinfo
->mouse_face_end_x
;
28668 if (!row
->reversed_p
)
28669 end_hpos
= hlinfo
->mouse_face_end_col
;
28670 else if (row
== first
)
28671 end_hpos
= hlinfo
->mouse_face_beg_col
;
28674 end_hpos
= row
->used
[TEXT_AREA
];
28675 if (draw
== DRAW_NORMAL_TEXT
)
28676 row
->fill_line_p
= true; /* Clear to end of line. */
28679 else if (row
->reversed_p
&& row
== first
)
28680 end_hpos
= hlinfo
->mouse_face_beg_col
;
28683 end_hpos
= row
->used
[TEXT_AREA
];
28684 if (draw
== DRAW_NORMAL_TEXT
)
28685 row
->fill_line_p
= true; /* Clear to end of line. */
28688 if (end_hpos
> start_hpos
)
28690 draw_row_with_mouse_face (w
, start_x
, row
,
28691 start_hpos
, end_hpos
, draw
);
28694 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
28698 #ifdef HAVE_WINDOW_SYSTEM
28699 /* When we've written over the cursor, arrange for it to
28700 be displayed again. */
28701 if (FRAME_WINDOW_P (f
)
28702 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
28704 int hpos
= w
->phys_cursor
.hpos
;
28706 /* When the window is hscrolled, cursor hpos can legitimately be
28707 out of bounds, but we draw the cursor at the corresponding
28708 window margin in that case. */
28709 if (!row
->reversed_p
&& hpos
< 0)
28711 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28712 hpos
= row
->used
[TEXT_AREA
] - 1;
28715 display_and_set_cursor (w
, true, hpos
, w
->phys_cursor
.vpos
,
28716 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28719 #endif /* HAVE_WINDOW_SYSTEM */
28722 #ifdef HAVE_WINDOW_SYSTEM
28723 /* Change the mouse cursor. */
28724 if (FRAME_WINDOW_P (f
) && NILP (do_mouse_tracking
))
28726 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
28727 if (draw
== DRAW_NORMAL_TEXT
28728 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
28729 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
28732 if (draw
== DRAW_MOUSE_FACE
)
28733 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
28735 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
28737 #endif /* HAVE_WINDOW_SYSTEM */
28741 Clear out the mouse-highlighted active region.
28742 Redraw it un-highlighted first. Value is true if mouse
28743 face was actually drawn unhighlighted. */
28746 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
28749 = !hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
);
28751 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
28752 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28753 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28754 hlinfo
->mouse_face_window
= Qnil
;
28755 hlinfo
->mouse_face_overlay
= Qnil
;
28759 /* Return true if the coordinates HPOS and VPOS on windows W are
28760 within the mouse face on that window. */
28762 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
28764 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28766 /* Quickly resolve the easy cases. */
28767 if (!(WINDOWP (hlinfo
->mouse_face_window
)
28768 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
28770 if (vpos
< hlinfo
->mouse_face_beg_row
28771 || vpos
> hlinfo
->mouse_face_end_row
)
28773 if (vpos
> hlinfo
->mouse_face_beg_row
28774 && vpos
< hlinfo
->mouse_face_end_row
)
28777 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
28779 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28781 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
28784 else if ((vpos
== hlinfo
->mouse_face_beg_row
28785 && hpos
>= hlinfo
->mouse_face_beg_col
)
28786 || (vpos
== hlinfo
->mouse_face_end_row
28787 && hpos
< hlinfo
->mouse_face_end_col
))
28792 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28794 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
28797 else if ((vpos
== hlinfo
->mouse_face_beg_row
28798 && hpos
<= hlinfo
->mouse_face_beg_col
)
28799 || (vpos
== hlinfo
->mouse_face_end_row
28800 && hpos
> hlinfo
->mouse_face_end_col
))
28808 True if physical cursor of window W is within mouse face. */
28811 cursor_in_mouse_face_p (struct window
*w
)
28813 int hpos
= w
->phys_cursor
.hpos
;
28814 int vpos
= w
->phys_cursor
.vpos
;
28815 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28817 /* When the window is hscrolled, cursor hpos can legitimately be out
28818 of bounds, but we draw the cursor at the corresponding window
28819 margin in that case. */
28820 if (!row
->reversed_p
&& hpos
< 0)
28822 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28823 hpos
= row
->used
[TEXT_AREA
] - 1;
28825 return coords_in_mouse_face_p (w
, hpos
, vpos
);
28830 /* Find the glyph rows START_ROW and END_ROW of window W that display
28831 characters between buffer positions START_CHARPOS and END_CHARPOS
28832 (excluding END_CHARPOS). DISP_STRING is a display string that
28833 covers these buffer positions. This is similar to
28834 row_containing_pos, but is more accurate when bidi reordering makes
28835 buffer positions change non-linearly with glyph rows. */
28837 rows_from_pos_range (struct window
*w
,
28838 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
28839 Lisp_Object disp_string
,
28840 struct glyph_row
**start
, struct glyph_row
**end
)
28842 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28843 int last_y
= window_text_bottom_y (w
);
28844 struct glyph_row
*row
;
28849 while (!first
->enabled_p
28850 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
28853 /* Find the START row. */
28855 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
28858 /* A row can potentially be the START row if the range of the
28859 characters it displays intersects the range
28860 [START_CHARPOS..END_CHARPOS). */
28861 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
28862 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
28863 /* See the commentary in row_containing_pos, for the
28864 explanation of the complicated way to check whether
28865 some position is beyond the end of the characters
28866 displayed by a row. */
28867 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28868 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28869 && !row
->ends_at_zv_p
28870 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
28871 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28872 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28873 && !row
->ends_at_zv_p
28874 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
28876 /* Found a candidate row. Now make sure at least one of the
28877 glyphs it displays has a charpos from the range
28878 [START_CHARPOS..END_CHARPOS).
28880 This is not obvious because bidi reordering could make
28881 buffer positions of a row be 1,2,3,102,101,100, and if we
28882 want to highlight characters in [50..60), we don't want
28883 this row, even though [50..60) does intersect [1..103),
28884 the range of character positions given by the row's start
28885 and end positions. */
28886 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
28887 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
28891 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28892 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28893 /* A glyph that comes from DISP_STRING is by
28894 definition to be highlighted. */
28895 || EQ (g
->object
, disp_string
))
28904 /* Find the END row. */
28906 /* If the last row is partially visible, start looking for END
28907 from that row, instead of starting from FIRST. */
28908 && !(row
->enabled_p
28909 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
28911 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
28913 struct glyph_row
*next
= row
+ 1;
28914 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
28916 if (!next
->enabled_p
28917 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
28918 /* The first row >= START whose range of displayed characters
28919 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28920 is the row END + 1. */
28921 || (start_charpos
< next_start
28922 && end_charpos
< next_start
)
28923 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28924 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28925 && !next
->ends_at_zv_p
28926 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28927 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28928 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28929 && !next
->ends_at_zv_p
28930 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28937 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28938 but none of the characters it displays are in the range, it is
28940 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28941 struct glyph
*s
= g
;
28942 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28946 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28947 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28948 /* If the buffer position of the first glyph in
28949 the row is equal to END_CHARPOS, it means
28950 the last character to be highlighted is the
28951 newline of ROW, and we must consider NEXT as
28953 || (((!next
->reversed_p
&& g
== s
)
28954 || (next
->reversed_p
&& g
== e
- 1))
28955 && (g
->charpos
== end_charpos
28956 /* Special case for when NEXT is an
28957 empty line at ZV. */
28958 || (g
->charpos
== -1
28959 && !row
->ends_at_zv_p
28960 && next_start
== end_charpos
)))))
28961 /* A glyph that comes from DISP_STRING is by
28962 definition to be highlighted. */
28963 || EQ (g
->object
, disp_string
))
28972 /* The first row that ends at ZV must be the last to be
28974 else if (next
->ends_at_zv_p
)
28983 /* This function sets the mouse_face_* elements of HLINFO, assuming
28984 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28985 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28986 for the overlay or run of text properties specifying the mouse
28987 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28988 before-string and after-string that must also be highlighted.
28989 DISP_STRING, if non-nil, is a display string that may cover some
28990 or all of the highlighted text. */
28993 mouse_face_from_buffer_pos (Lisp_Object window
,
28994 Mouse_HLInfo
*hlinfo
,
28995 ptrdiff_t mouse_charpos
,
28996 ptrdiff_t start_charpos
,
28997 ptrdiff_t end_charpos
,
28998 Lisp_Object before_string
,
28999 Lisp_Object after_string
,
29000 Lisp_Object disp_string
)
29002 struct window
*w
= XWINDOW (window
);
29003 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
29004 struct glyph_row
*r1
, *r2
;
29005 struct glyph
*glyph
, *end
;
29006 ptrdiff_t ignore
, pos
;
29009 eassert (NILP (disp_string
) || STRINGP (disp_string
));
29010 eassert (NILP (before_string
) || STRINGP (before_string
));
29011 eassert (NILP (after_string
) || STRINGP (after_string
));
29013 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
29014 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
29016 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
29017 /* If the before-string or display-string contains newlines,
29018 rows_from_pos_range skips to its last row. Move back. */
29019 if (!NILP (before_string
) || !NILP (disp_string
))
29021 struct glyph_row
*prev
;
29022 while ((prev
= r1
- 1, prev
>= first
)
29023 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
29024 && prev
->used
[TEXT_AREA
] > 0)
29026 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
29027 glyph
= beg
+ prev
->used
[TEXT_AREA
];
29028 while (--glyph
>= beg
&& NILP (glyph
->object
));
29030 || !(EQ (glyph
->object
, before_string
)
29031 || EQ (glyph
->object
, disp_string
)))
29038 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
29039 hlinfo
->mouse_face_past_end
= true;
29041 else if (!NILP (after_string
))
29043 /* If the after-string has newlines, advance to its last row. */
29044 struct glyph_row
*next
;
29045 struct glyph_row
*last
29046 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
29048 for (next
= r2
+ 1;
29050 && next
->used
[TEXT_AREA
] > 0
29051 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
29055 /* The rest of the display engine assumes that mouse_face_beg_row is
29056 either above mouse_face_end_row or identical to it. But with
29057 bidi-reordered continued lines, the row for START_CHARPOS could
29058 be below the row for END_CHARPOS. If so, swap the rows and store
29059 them in correct order. */
29062 struct glyph_row
*tem
= r2
;
29068 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
29069 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
29071 /* For a bidi-reordered row, the positions of BEFORE_STRING,
29072 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
29073 could be anywhere in the row and in any order. The strategy
29074 below is to find the leftmost and the rightmost glyph that
29075 belongs to either of these 3 strings, or whose position is
29076 between START_CHARPOS and END_CHARPOS, and highlight all the
29077 glyphs between those two. This may cover more than just the text
29078 between START_CHARPOS and END_CHARPOS if the range of characters
29079 strides the bidi level boundary, e.g. if the beginning is in R2L
29080 text while the end is in L2R text or vice versa. */
29081 if (!r1
->reversed_p
)
29083 /* This row is in a left to right paragraph. Scan it left to
29085 glyph
= r1
->glyphs
[TEXT_AREA
];
29086 end
= glyph
+ r1
->used
[TEXT_AREA
];
29089 /* Skip truncation glyphs at the start of the glyph row. */
29090 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
29092 && NILP (glyph
->object
)
29093 && glyph
->charpos
< 0;
29095 x
+= glyph
->pixel_width
;
29097 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
29098 or DISP_STRING, and the first glyph from buffer whose
29099 position is between START_CHARPOS and END_CHARPOS. */
29101 && !NILP (glyph
->object
)
29102 && !EQ (glyph
->object
, disp_string
)
29103 && !(BUFFERP (glyph
->object
)
29104 && (glyph
->charpos
>= start_charpos
29105 && glyph
->charpos
< end_charpos
));
29108 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29109 are present at buffer positions between START_CHARPOS and
29110 END_CHARPOS, or if they come from an overlay. */
29111 if (EQ (glyph
->object
, before_string
))
29113 pos
= string_buffer_position (before_string
,
29115 /* If pos == 0, it means before_string came from an
29116 overlay, not from a buffer position. */
29117 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29120 else if (EQ (glyph
->object
, after_string
))
29122 pos
= string_buffer_position (after_string
, end_charpos
);
29123 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29126 x
+= glyph
->pixel_width
;
29128 hlinfo
->mouse_face_beg_x
= x
;
29129 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
29133 /* This row is in a right to left paragraph. Scan it right to
29137 end
= r1
->glyphs
[TEXT_AREA
] - 1;
29138 glyph
= end
+ r1
->used
[TEXT_AREA
];
29140 /* Skip truncation glyphs at the start of the glyph row. */
29141 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
29143 && NILP (glyph
->object
)
29144 && glyph
->charpos
< 0;
29148 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
29149 or DISP_STRING, and the first glyph from buffer whose
29150 position is between START_CHARPOS and END_CHARPOS. */
29152 && !NILP (glyph
->object
)
29153 && !EQ (glyph
->object
, disp_string
)
29154 && !(BUFFERP (glyph
->object
)
29155 && (glyph
->charpos
>= start_charpos
29156 && glyph
->charpos
< end_charpos
));
29159 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29160 are present at buffer positions between START_CHARPOS and
29161 END_CHARPOS, or if they come from an overlay. */
29162 if (EQ (glyph
->object
, before_string
))
29164 pos
= string_buffer_position (before_string
, start_charpos
);
29165 /* If pos == 0, it means before_string came from an
29166 overlay, not from a buffer position. */
29167 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29170 else if (EQ (glyph
->object
, after_string
))
29172 pos
= string_buffer_position (after_string
, end_charpos
);
29173 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29178 glyph
++; /* first glyph to the right of the highlighted area */
29179 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
29180 x
+= g
->pixel_width
;
29181 hlinfo
->mouse_face_beg_x
= x
;
29182 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
29185 /* If the highlight ends in a different row, compute GLYPH and END
29186 for the end row. Otherwise, reuse the values computed above for
29187 the row where the highlight begins. */
29190 if (!r2
->reversed_p
)
29192 glyph
= r2
->glyphs
[TEXT_AREA
];
29193 end
= glyph
+ r2
->used
[TEXT_AREA
];
29198 end
= r2
->glyphs
[TEXT_AREA
] - 1;
29199 glyph
= end
+ r2
->used
[TEXT_AREA
];
29203 if (!r2
->reversed_p
)
29205 /* Skip truncation and continuation glyphs near the end of the
29206 row, and also blanks and stretch glyphs inserted by
29207 extend_face_to_end_of_line. */
29209 && NILP ((end
- 1)->object
))
29211 /* Scan the rest of the glyph row from the end, looking for the
29212 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
29213 DISP_STRING, or whose position is between START_CHARPOS
29217 && !NILP (end
->object
)
29218 && !EQ (end
->object
, disp_string
)
29219 && !(BUFFERP (end
->object
)
29220 && (end
->charpos
>= start_charpos
29221 && end
->charpos
< end_charpos
));
29224 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29225 are present at buffer positions between START_CHARPOS and
29226 END_CHARPOS, or if they come from an overlay. */
29227 if (EQ (end
->object
, before_string
))
29229 pos
= string_buffer_position (before_string
, start_charpos
);
29230 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29233 else if (EQ (end
->object
, after_string
))
29235 pos
= string_buffer_position (after_string
, end_charpos
);
29236 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29240 /* Find the X coordinate of the last glyph to be highlighted. */
29241 for (; glyph
<= end
; ++glyph
)
29242 x
+= glyph
->pixel_width
;
29244 hlinfo
->mouse_face_end_x
= x
;
29245 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
29249 /* Skip truncation and continuation glyphs near the end of the
29250 row, and also blanks and stretch glyphs inserted by
29251 extend_face_to_end_of_line. */
29255 && NILP (end
->object
))
29257 x
+= end
->pixel_width
;
29260 /* Scan the rest of the glyph row from the end, looking for the
29261 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
29262 DISP_STRING, or whose position is between START_CHARPOS
29266 && !NILP (end
->object
)
29267 && !EQ (end
->object
, disp_string
)
29268 && !(BUFFERP (end
->object
)
29269 && (end
->charpos
>= start_charpos
29270 && end
->charpos
< end_charpos
));
29273 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29274 are present at buffer positions between START_CHARPOS and
29275 END_CHARPOS, or if they come from an overlay. */
29276 if (EQ (end
->object
, before_string
))
29278 pos
= string_buffer_position (before_string
, start_charpos
);
29279 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29282 else if (EQ (end
->object
, after_string
))
29284 pos
= string_buffer_position (after_string
, end_charpos
);
29285 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29288 x
+= end
->pixel_width
;
29290 /* If we exited the above loop because we arrived at the last
29291 glyph of the row, and its buffer position is still not in
29292 range, it means the last character in range is the preceding
29293 newline. Bump the end column and x values to get past the
29296 && BUFFERP (end
->object
)
29297 && (end
->charpos
< start_charpos
29298 || end
->charpos
>= end_charpos
))
29300 x
+= end
->pixel_width
;
29303 hlinfo
->mouse_face_end_x
= x
;
29304 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
29307 hlinfo
->mouse_face_window
= window
;
29308 hlinfo
->mouse_face_face_id
29309 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
29311 !hlinfo
->mouse_face_hidden
, -1);
29312 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29315 /* The following function is not used anymore (replaced with
29316 mouse_face_from_string_pos), but I leave it here for the time
29317 being, in case someone would. */
29319 #if false /* not used */
29321 /* Find the position of the glyph for position POS in OBJECT in
29322 window W's current matrix, and return in *X, *Y the pixel
29323 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
29325 RIGHT_P means return the position of the right edge of the glyph.
29326 !RIGHT_P means return the left edge position.
29328 If no glyph for POS exists in the matrix, return the position of
29329 the glyph with the next smaller position that is in the matrix, if
29330 RIGHT_P is false. If RIGHT_P, and no glyph for POS
29331 exists in the matrix, return the position of the glyph with the
29332 next larger position in OBJECT.
29334 Value is true if a glyph was found. */
29337 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
29338 int *hpos
, int *vpos
, int *x
, int *y
, bool right_p
)
29340 int yb
= window_text_bottom_y (w
);
29341 struct glyph_row
*r
;
29342 struct glyph
*best_glyph
= NULL
;
29343 struct glyph_row
*best_row
= NULL
;
29346 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
29347 r
->enabled_p
&& r
->y
< yb
;
29350 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
29351 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
29354 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
29355 if (EQ (g
->object
, object
))
29357 if (g
->charpos
== pos
)
29364 else if (best_glyph
== NULL
29365 || ((eabs (g
->charpos
- pos
)
29366 < eabs (best_glyph
->charpos
- pos
))
29369 : g
->charpos
> pos
)))
29383 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
29387 *x
+= best_glyph
->pixel_width
;
29392 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
29395 return best_glyph
!= NULL
;
29397 #endif /* not used */
29399 /* Find the positions of the first and the last glyphs in window W's
29400 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
29401 (assumed to be a string), and return in HLINFO's mouse_face_*
29402 members the pixel and column/row coordinates of those glyphs. */
29405 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
29406 Lisp_Object object
,
29407 ptrdiff_t startpos
, ptrdiff_t endpos
)
29409 int yb
= window_text_bottom_y (w
);
29410 struct glyph_row
*r
;
29411 struct glyph
*g
, *e
;
29413 bool found
= false;
29415 /* Find the glyph row with at least one position in the range
29416 [STARTPOS..ENDPOS), and the first glyph in that row whose
29417 position belongs to that range. */
29418 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
29419 r
->enabled_p
&& r
->y
< yb
;
29422 if (!r
->reversed_p
)
29424 g
= r
->glyphs
[TEXT_AREA
];
29425 e
= g
+ r
->used
[TEXT_AREA
];
29426 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
29427 if (EQ (g
->object
, object
)
29428 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29430 hlinfo
->mouse_face_beg_row
29431 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29432 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29433 hlinfo
->mouse_face_beg_x
= gx
;
29442 e
= r
->glyphs
[TEXT_AREA
];
29443 g
= e
+ r
->used
[TEXT_AREA
];
29444 for ( ; g
> e
; --g
)
29445 if (EQ ((g
-1)->object
, object
)
29446 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
29448 hlinfo
->mouse_face_beg_row
29449 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29450 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29451 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
29452 gx
+= g1
->pixel_width
;
29453 hlinfo
->mouse_face_beg_x
= gx
;
29465 /* Starting with the next row, look for the first row which does NOT
29466 include any glyphs whose positions are in the range. */
29467 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
29469 g
= r
->glyphs
[TEXT_AREA
];
29470 e
= g
+ r
->used
[TEXT_AREA
];
29472 for ( ; g
< e
; ++g
)
29473 if (EQ (g
->object
, object
)
29474 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29483 /* The highlighted region ends on the previous row. */
29486 /* Set the end row. */
29487 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29489 /* Compute and set the end column and the end column's horizontal
29490 pixel coordinate. */
29491 if (!r
->reversed_p
)
29493 g
= r
->glyphs
[TEXT_AREA
];
29494 e
= g
+ r
->used
[TEXT_AREA
];
29495 for ( ; e
> g
; --e
)
29496 if (EQ ((e
-1)->object
, object
)
29497 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
29499 hlinfo
->mouse_face_end_col
= e
- g
;
29501 for (gx
= r
->x
; g
< e
; ++g
)
29502 gx
+= g
->pixel_width
;
29503 hlinfo
->mouse_face_end_x
= gx
;
29507 e
= r
->glyphs
[TEXT_AREA
];
29508 g
= e
+ r
->used
[TEXT_AREA
];
29509 for (gx
= r
->x
; e
< g
; ++e
)
29511 if (EQ (e
->object
, object
)
29512 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
29514 gx
+= e
->pixel_width
;
29516 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
29517 hlinfo
->mouse_face_end_x
= gx
;
29521 #ifdef HAVE_WINDOW_SYSTEM
29523 /* See if position X, Y is within a hot-spot of an image. */
29526 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
29528 if (!CONSP (hot_spot
))
29531 if (EQ (XCAR (hot_spot
), Qrect
))
29533 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
29534 Lisp_Object rect
= XCDR (hot_spot
);
29538 if (!CONSP (XCAR (rect
)))
29540 if (!CONSP (XCDR (rect
)))
29542 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
29544 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
29546 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
29548 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
29552 else if (EQ (XCAR (hot_spot
), Qcircle
))
29554 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
29555 Lisp_Object circ
= XCDR (hot_spot
);
29556 Lisp_Object lr
, lx0
, ly0
;
29558 && CONSP (XCAR (circ
))
29559 && (lr
= XCDR (circ
), NUMBERP (lr
))
29560 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
29561 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
29563 double r
= XFLOATINT (lr
);
29564 double dx
= XINT (lx0
) - x
;
29565 double dy
= XINT (ly0
) - y
;
29566 return (dx
* dx
+ dy
* dy
<= r
* r
);
29569 else if (EQ (XCAR (hot_spot
), Qpoly
))
29571 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
29572 if (VECTORP (XCDR (hot_spot
)))
29574 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
29575 Lisp_Object
*poly
= v
->contents
;
29576 ptrdiff_t n
= v
->header
.size
;
29578 bool inside
= false;
29579 Lisp_Object lx
, ly
;
29582 /* Need an even number of coordinates, and at least 3 edges. */
29583 if (n
< 6 || n
& 1)
29586 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
29587 If count is odd, we are inside polygon. Pixels on edges
29588 may or may not be included depending on actual geometry of the
29590 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
29591 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
29593 x0
= XINT (lx
), y0
= XINT (ly
);
29594 for (i
= 0; i
< n
; i
+= 2)
29596 int x1
= x0
, y1
= y0
;
29597 if ((lx
= poly
[i
], !INTEGERP (lx
))
29598 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
29600 x0
= XINT (lx
), y0
= XINT (ly
);
29602 /* Does this segment cross the X line? */
29610 if (y
> y0
&& y
> y1
)
29612 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
29622 find_hot_spot (Lisp_Object map
, int x
, int y
)
29624 while (CONSP (map
))
29626 if (CONSP (XCAR (map
))
29627 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
29635 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
29637 doc
: /* Lookup in image map MAP coordinates X and Y.
29638 An image map is an alist where each element has the format (AREA ID PLIST).
29639 An AREA is specified as either a rectangle, a circle, or a polygon:
29640 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
29641 pixel coordinates of the upper left and bottom right corners.
29642 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
29643 and the radius of the circle; r may be a float or integer.
29644 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
29645 vector describes one corner in the polygon.
29646 Returns the alist element for the first matching AREA in MAP. */)
29647 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
29655 return find_hot_spot (map
,
29656 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
29657 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
29661 /* Display frame CURSOR, optionally using shape defined by POINTER. */
29663 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
29665 /* Do not change cursor shape while dragging mouse. */
29666 if (EQ (do_mouse_tracking
, Qdragging
))
29669 if (!NILP (pointer
))
29671 if (EQ (pointer
, Qarrow
))
29672 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29673 else if (EQ (pointer
, Qhand
))
29674 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
29675 else if (EQ (pointer
, Qtext
))
29676 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29677 else if (EQ (pointer
, intern ("hdrag")))
29678 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29679 else if (EQ (pointer
, intern ("nhdrag")))
29680 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29681 #ifdef HAVE_X_WINDOWS
29682 else if (EQ (pointer
, intern ("vdrag")))
29683 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29685 else if (EQ (pointer
, intern ("hourglass")))
29686 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
29687 else if (EQ (pointer
, Qmodeline
))
29688 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
29690 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29693 if (cursor
!= No_Cursor
)
29694 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
29697 #endif /* HAVE_WINDOW_SYSTEM */
29699 /* Take proper action when mouse has moved to the mode or header line
29700 or marginal area AREA of window W, x-position X and y-position Y.
29701 X is relative to the start of the text display area of W, so the
29702 width of bitmap areas and scroll bars must be subtracted to get a
29703 position relative to the start of the mode line. */
29706 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
29707 enum window_part area
)
29709 struct window
*w
= XWINDOW (window
);
29710 struct frame
*f
= XFRAME (w
->frame
);
29711 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29712 #ifdef HAVE_WINDOW_SYSTEM
29713 Display_Info
*dpyinfo
;
29714 Cursor cursor
= No_Cursor
;
29715 Lisp_Object pointer
= Qnil
;
29717 int dx
, dy
, width
, height
;
29719 Lisp_Object string
, object
= Qnil
;
29720 Lisp_Object pos UNINIT
;
29721 Lisp_Object mouse_face
;
29722 int original_x_pixel
= x
;
29723 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
29724 struct glyph_row
*row UNINIT
;
29726 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
29731 /* Kludge alert: mode_line_string takes X/Y in pixels, but
29732 returns them in row/column units! */
29733 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
29734 &object
, &dx
, &dy
, &width
, &height
);
29736 row
= (area
== ON_MODE_LINE
29737 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
29738 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
29740 /* Find the glyph under the mouse pointer. */
29741 if (row
->mode_line_p
&& row
->enabled_p
)
29743 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
29744 end
= glyph
+ row
->used
[TEXT_AREA
];
29746 for (x0
= original_x_pixel
;
29747 glyph
< end
&& x0
>= glyph
->pixel_width
;
29749 x0
-= glyph
->pixel_width
;
29757 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
29758 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
29759 returns them in row/column units! */
29760 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
29761 &object
, &dx
, &dy
, &width
, &height
);
29764 Lisp_Object help
= Qnil
;
29766 #ifdef HAVE_WINDOW_SYSTEM
29767 if (IMAGEP (object
))
29769 Lisp_Object image_map
, hotspot
;
29770 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
29772 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
29774 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29778 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
29779 If so, we could look for mouse-enter, mouse-leave
29780 properties in PLIST (and do something...). */
29781 hotspot
= XCDR (hotspot
);
29782 if (CONSP (hotspot
)
29783 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29785 pointer
= Fplist_get (plist
, Qpointer
);
29786 if (NILP (pointer
))
29788 help
= Fplist_get (plist
, Qhelp_echo
);
29791 help_echo_string
= help
;
29792 XSETWINDOW (help_echo_window
, w
);
29793 help_echo_object
= w
->contents
;
29794 help_echo_pos
= charpos
;
29798 if (NILP (pointer
))
29799 pointer
= Fplist_get (XCDR (object
), QCpointer
);
29801 #endif /* HAVE_WINDOW_SYSTEM */
29803 if (STRINGP (string
))
29804 pos
= make_number (charpos
);
29806 /* Set the help text and mouse pointer. If the mouse is on a part
29807 of the mode line without any text (e.g. past the right edge of
29808 the mode line text), use the default help text and pointer. */
29809 if (STRINGP (string
) || area
== ON_MODE_LINE
)
29811 /* Arrange to display the help by setting the global variables
29812 help_echo_string, help_echo_object, and help_echo_pos. */
29815 if (STRINGP (string
))
29816 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
29820 help_echo_string
= help
;
29821 XSETWINDOW (help_echo_window
, w
);
29822 help_echo_object
= string
;
29823 help_echo_pos
= charpos
;
29825 else if (area
== ON_MODE_LINE
)
29827 Lisp_Object default_help
29828 = buffer_local_value (Qmode_line_default_help_echo
,
29831 if (STRINGP (default_help
))
29833 help_echo_string
= default_help
;
29834 XSETWINDOW (help_echo_window
, w
);
29835 help_echo_object
= Qnil
;
29836 help_echo_pos
= -1;
29841 #ifdef HAVE_WINDOW_SYSTEM
29842 /* Change the mouse pointer according to what is under it. */
29843 if (FRAME_WINDOW_P (f
))
29845 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
29847 || NILP (Vresize_mini_windows
));
29849 dpyinfo
= FRAME_DISPLAY_INFO (f
);
29850 if (STRINGP (string
))
29852 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29854 if (NILP (pointer
))
29855 pointer
= Fget_text_property (pos
, Qpointer
, string
);
29857 /* Change the mouse pointer according to what is under X/Y. */
29859 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
29862 map
= Fget_text_property (pos
, Qlocal_map
, string
);
29863 if (!KEYMAPP (map
))
29864 map
= Fget_text_property (pos
, Qkeymap
, string
);
29865 if (!KEYMAPP (map
) && draggable
)
29866 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
29869 else if (draggable
)
29870 /* Default mode-line pointer. */
29871 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29876 /* Change the mouse face according to what is under X/Y. */
29877 bool mouse_face_shown
= false;
29878 if (STRINGP (string
))
29880 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
29881 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
29882 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29887 struct glyph
* tmp_glyph
;
29891 int total_pixel_width
;
29892 ptrdiff_t begpos
, endpos
, ignore
;
29896 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
29897 Qmouse_face
, string
, Qnil
);
29903 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
29905 endpos
= SCHARS (string
);
29909 /* Calculate the glyph position GPOS of GLYPH in the
29910 displayed string, relative to the beginning of the
29911 highlighted part of the string.
29913 Note: GPOS is different from CHARPOS. CHARPOS is the
29914 position of GLYPH in the internal string object. A mode
29915 line string format has structures which are converted to
29916 a flattened string by the Emacs Lisp interpreter. The
29917 internal string is an element of those structures. The
29918 displayed string is the flattened string. */
29919 tmp_glyph
= row_start_glyph
;
29920 while (tmp_glyph
< glyph
29921 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29922 && begpos
<= tmp_glyph
->charpos
29923 && tmp_glyph
->charpos
< endpos
)))
29925 gpos
= glyph
- tmp_glyph
;
29927 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29928 the highlighted part of the displayed string to which
29929 GLYPH belongs. Note: GSEQ_LENGTH is different from
29930 SCHARS (STRING), because the latter returns the length of
29931 the internal string. */
29932 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29934 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29935 && begpos
<= tmp_glyph
->charpos
29936 && tmp_glyph
->charpos
< endpos
));
29939 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29941 /* Calculate the total pixel width of all the glyphs between
29942 the beginning of the highlighted area and GLYPH. */
29943 total_pixel_width
= 0;
29944 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29945 total_pixel_width
+= tmp_glyph
->pixel_width
;
29947 /* Pre calculation of re-rendering position. Note: X is in
29948 column units here, after the call to mode_line_string or
29949 marginal_area_string. */
29951 vpos
= (area
== ON_MODE_LINE
29952 ? (w
->current_matrix
)->nrows
- 1
29955 /* If GLYPH's position is included in the region that is
29956 already drawn in mouse face, we have nothing to do. */
29957 if ( EQ (window
, hlinfo
->mouse_face_window
)
29958 && (!row
->reversed_p
29959 ? (hlinfo
->mouse_face_beg_col
<= hpos
29960 && hpos
< hlinfo
->mouse_face_end_col
)
29961 /* In R2L rows we swap BEG and END, see below. */
29962 : (hlinfo
->mouse_face_end_col
<= hpos
29963 && hpos
< hlinfo
->mouse_face_beg_col
))
29964 && hlinfo
->mouse_face_beg_row
== vpos
)
29967 #ifdef HAVE_WINDOW_SYSTEM
29968 if (clear_mouse_face (hlinfo
))
29969 cursor
= No_Cursor
;
29971 (void) clear_mouse_face (hlinfo
);
29974 if (!row
->reversed_p
)
29976 hlinfo
->mouse_face_beg_col
= hpos
;
29977 hlinfo
->mouse_face_beg_x
= original_x_pixel
29978 - (total_pixel_width
+ dx
);
29979 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29980 hlinfo
->mouse_face_end_x
= 0;
29984 /* In R2L rows, show_mouse_face expects BEG and END
29985 coordinates to be swapped. */
29986 hlinfo
->mouse_face_end_col
= hpos
;
29987 hlinfo
->mouse_face_end_x
= original_x_pixel
29988 - (total_pixel_width
+ dx
);
29989 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29990 hlinfo
->mouse_face_beg_x
= 0;
29993 hlinfo
->mouse_face_beg_row
= vpos
;
29994 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29995 hlinfo
->mouse_face_past_end
= false;
29996 hlinfo
->mouse_face_window
= window
;
29998 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
30003 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
30004 mouse_face_shown
= true;
30006 #ifdef HAVE_WINDOW_SYSTEM
30007 if (NILP (pointer
))
30013 /* If mouse-face doesn't need to be shown, clear any existing
30015 if ((area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
) && !mouse_face_shown
)
30016 clear_mouse_face (hlinfo
);
30018 #ifdef HAVE_WINDOW_SYSTEM
30019 if (FRAME_WINDOW_P (f
))
30020 define_frame_cursor1 (f
, cursor
, pointer
);
30026 Take proper action when the mouse has moved to position X, Y on
30027 frame F with regards to highlighting portions of display that have
30028 mouse-face properties. Also de-highlight portions of display where
30029 the mouse was before, set the mouse pointer shape as appropriate
30030 for the mouse coordinates, and activate help echo (tooltips).
30031 X and Y can be negative or out of range. */
30034 note_mouse_highlight (struct frame
*f
, int x
, int y
)
30036 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30037 enum window_part part
= ON_NOTHING
;
30038 Lisp_Object window
;
30040 #ifdef HAVE_WINDOW_SYSTEM
30041 Cursor cursor
= No_Cursor
;
30042 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
30046 /* When a menu is active, don't highlight because this looks odd. */
30047 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
30048 if (popup_activated ())
30052 if (!f
->glyphs_initialized_p
30053 || f
->pointer_invisible
)
30056 hlinfo
->mouse_face_mouse_x
= x
;
30057 hlinfo
->mouse_face_mouse_y
= y
;
30058 hlinfo
->mouse_face_mouse_frame
= f
;
30060 if (hlinfo
->mouse_face_defer
)
30063 /* Which window is that in? */
30064 window
= window_from_coordinates (f
, x
, y
, &part
, true);
30066 /* If displaying active text in another window, clear that. */
30067 if (! EQ (window
, hlinfo
->mouse_face_window
)
30068 /* Also clear if we move out of text area in same window. */
30069 || (!NILP (hlinfo
->mouse_face_window
)
30072 && part
!= ON_MODE_LINE
30073 && part
!= ON_HEADER_LINE
))
30074 clear_mouse_face (hlinfo
);
30076 /* Not on a window -> return. */
30077 if (!WINDOWP (window
))
30080 /* Reset help_echo_string. It will get recomputed below. */
30081 help_echo_string
= Qnil
;
30083 /* Convert to window-relative pixel coordinates. */
30084 w
= XWINDOW (window
);
30085 frame_to_window_pixel_xy (w
, &x
, &y
);
30087 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
30088 /* Handle tool-bar window differently since it doesn't display a
30090 if (EQ (window
, f
->tool_bar_window
))
30092 note_tool_bar_highlight (f
, x
, y
);
30097 /* Mouse is on the mode, header line or margin? */
30098 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
30099 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
30101 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
30103 #ifdef HAVE_WINDOW_SYSTEM
30104 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
30106 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30107 /* Show non-text cursor (Bug#16647). */
30115 #ifdef HAVE_WINDOW_SYSTEM
30116 if (part
== ON_VERTICAL_BORDER
)
30118 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
30119 help_echo_string
= build_string ("drag-mouse-1: resize");
30121 else if (part
== ON_RIGHT_DIVIDER
)
30123 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
30124 help_echo_string
= build_string ("drag-mouse-1: resize");
30126 else if (part
== ON_BOTTOM_DIVIDER
)
30127 if (! WINDOW_BOTTOMMOST_P (w
)
30129 || NILP (Vresize_mini_windows
))
30131 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
30132 help_echo_string
= build_string ("drag-mouse-1: resize");
30135 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30136 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
30137 || part
== ON_VERTICAL_SCROLL_BAR
30138 || part
== ON_HORIZONTAL_SCROLL_BAR
)
30139 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30141 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
30144 /* Are we in a window whose display is up to date?
30145 And verify the buffer's text has not changed. */
30146 b
= XBUFFER (w
->contents
);
30147 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
30149 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
30151 struct glyph
*glyph
;
30152 Lisp_Object object
;
30153 Lisp_Object mouse_face
= Qnil
, position
;
30154 Lisp_Object
*overlay_vec
= NULL
;
30155 ptrdiff_t i
, noverlays
;
30156 struct buffer
*obuf
;
30157 ptrdiff_t obegv
, ozv
;
30160 /* Find the glyph under X/Y. */
30161 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
30163 #ifdef HAVE_WINDOW_SYSTEM
30164 /* Look for :pointer property on image. */
30165 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
30167 struct image
*img
= IMAGE_OPT_FROM_ID (f
, glyph
->u
.img_id
);
30168 if (img
!= NULL
&& IMAGEP (img
->spec
))
30170 Lisp_Object image_map
, hotspot
;
30171 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
30173 && (hotspot
= find_hot_spot (image_map
,
30174 glyph
->slice
.img
.x
+ dx
,
30175 glyph
->slice
.img
.y
+ dy
),
30177 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
30181 /* Could check XCAR (hotspot) to see if we enter/leave
30183 If so, we could look for mouse-enter, mouse-leave
30184 properties in PLIST (and do something...). */
30185 hotspot
= XCDR (hotspot
);
30186 if (CONSP (hotspot
)
30187 && (plist
= XCAR (hotspot
), CONSP (plist
)))
30189 pointer
= Fplist_get (plist
, Qpointer
);
30190 if (NILP (pointer
))
30192 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
30193 if (!NILP (help_echo_string
))
30195 help_echo_window
= window
;
30196 help_echo_object
= glyph
->object
;
30197 help_echo_pos
= glyph
->charpos
;
30201 if (NILP (pointer
))
30202 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
30205 #endif /* HAVE_WINDOW_SYSTEM */
30207 /* Clear mouse face if X/Y not over text. */
30209 || area
!= TEXT_AREA
30210 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
30211 /* Glyph's OBJECT is nil for glyphs inserted by the
30212 display engine for its internal purposes, like truncation
30213 and continuation glyphs and blanks beyond the end of
30214 line's text on text terminals. If we are over such a
30215 glyph, we are not over any text. */
30216 || NILP (glyph
->object
)
30217 /* R2L rows have a stretch glyph at their front, which
30218 stands for no text, whereas L2R rows have no glyphs at
30219 all beyond the end of text. Treat such stretch glyphs
30220 like we do with NULL glyphs in L2R rows. */
30221 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
30222 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
30223 && glyph
->type
== STRETCH_GLYPH
30224 && glyph
->avoid_cursor_p
))
30226 #ifndef HAVE_WINDOW_SYSTEM
30227 (void) clear_mouse_face (hlinfo
);
30228 #else /* HAVE_WINDOW_SYSTEM */
30229 if (clear_mouse_face (hlinfo
))
30230 cursor
= No_Cursor
;
30231 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30233 if (area
!= TEXT_AREA
)
30234 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30236 pointer
= Vvoid_text_area_pointer
;
30238 #endif /* HAVE_WINDOW_SYSTEM */
30242 pos
= glyph
->charpos
;
30243 object
= glyph
->object
;
30244 if (!STRINGP (object
) && !BUFFERP (object
))
30247 /* If we get an out-of-range value, return now; avoid an error. */
30248 if (BUFFERP (object
) && pos
> BUF_Z (b
))
30251 /* Make the window's buffer temporarily current for
30252 overlays_at and compute_char_face. */
30253 obuf
= current_buffer
;
30254 current_buffer
= b
;
30260 /* Is this char mouse-active or does it have help-echo? */
30261 position
= make_number (pos
);
30265 if (BUFFERP (object
))
30267 /* Put all the overlays we want in a vector in overlay_vec. */
30268 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, false);
30269 /* Sort overlays into increasing priority order. */
30270 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
30275 if (NILP (Vmouse_highlight
))
30277 clear_mouse_face (hlinfo
);
30278 goto check_help_echo
;
30281 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
30283 #ifdef HAVE_WINDOW_SYSTEM
30285 cursor
= No_Cursor
;
30288 /* Check mouse-face highlighting. */
30290 /* If there exists an overlay with mouse-face overlapping
30291 the one we are currently highlighting, we have to
30292 check if we enter the overlapping overlay, and then
30293 highlight only that. */
30294 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
30295 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
30297 /* Find the highest priority overlay with a mouse-face. */
30298 Lisp_Object overlay
= Qnil
;
30299 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
30301 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
30302 if (!NILP (mouse_face
))
30303 overlay
= overlay_vec
[i
];
30306 /* If we're highlighting the same overlay as before, there's
30307 no need to do that again. */
30308 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
30309 goto check_help_echo
;
30310 hlinfo
->mouse_face_overlay
= overlay
;
30312 /* Clear the display of the old active region, if any. */
30313 #ifdef HAVE_WINDOW_SYSTEM
30314 if (clear_mouse_face (hlinfo
))
30315 cursor
= No_Cursor
;
30317 (void) clear_mouse_face (hlinfo
);
30320 /* If no overlay applies, get a text property. */
30321 if (NILP (overlay
))
30322 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
30324 /* Next, compute the bounds of the mouse highlighting and
30326 if (!NILP (mouse_face
) && STRINGP (object
))
30328 /* The mouse-highlighting comes from a display string
30329 with a mouse-face. */
30333 s
= Fprevious_single_property_change
30334 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
30335 e
= Fnext_single_property_change
30336 (position
, Qmouse_face
, object
, Qnil
);
30338 s
= make_number (0);
30340 e
= make_number (SCHARS (object
));
30341 mouse_face_from_string_pos (w
, hlinfo
, object
,
30342 XINT (s
), XINT (e
));
30343 hlinfo
->mouse_face_past_end
= false;
30344 hlinfo
->mouse_face_window
= window
;
30345 hlinfo
->mouse_face_face_id
30346 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
30347 glyph
->face_id
, true);
30348 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
30349 #ifdef HAVE_WINDOW_SYSTEM
30350 cursor
= No_Cursor
;
30355 /* The mouse-highlighting, if any, comes from an overlay
30356 or text property in the buffer. */
30357 Lisp_Object buffer UNINIT
;
30358 Lisp_Object disp_string UNINIT
;
30360 if (STRINGP (object
))
30362 /* If we are on a display string with no mouse-face,
30363 check if the text under it has one. */
30364 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
30365 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30366 pos
= string_buffer_position (object
, start
);
30369 mouse_face
= get_char_property_and_overlay
30370 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
30371 buffer
= w
->contents
;
30372 disp_string
= object
;
30378 disp_string
= Qnil
;
30381 if (!NILP (mouse_face
))
30383 Lisp_Object before
, after
;
30384 Lisp_Object before_string
, after_string
;
30385 /* To correctly find the limits of mouse highlight
30386 in a bidi-reordered buffer, we must not use the
30387 optimization of limiting the search in
30388 previous-single-property-change and
30389 next-single-property-change, because
30390 rows_from_pos_range needs the real start and end
30391 positions to DTRT in this case. That's because
30392 the first row visible in a window does not
30393 necessarily display the character whose position
30394 is the smallest. */
30396 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
30397 ? Fmarker_position (w
->start
)
30400 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
30401 ? make_number (BUF_Z (XBUFFER (buffer
))
30402 - w
->window_end_pos
)
30405 if (NILP (overlay
))
30407 /* Handle the text property case. */
30408 before
= Fprevious_single_property_change
30409 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
30410 after
= Fnext_single_property_change
30411 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
30412 before_string
= after_string
= Qnil
;
30416 /* Handle the overlay case. */
30417 before
= Foverlay_start (overlay
);
30418 after
= Foverlay_end (overlay
);
30419 before_string
= Foverlay_get (overlay
, Qbefore_string
);
30420 after_string
= Foverlay_get (overlay
, Qafter_string
);
30422 if (!STRINGP (before_string
)) before_string
= Qnil
;
30423 if (!STRINGP (after_string
)) after_string
= Qnil
;
30426 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
30429 : XFASTINT (before
),
30431 ? BUF_Z (XBUFFER (buffer
))
30432 : XFASTINT (after
),
30433 before_string
, after_string
,
30435 #ifdef HAVE_WINDOW_SYSTEM
30436 cursor
= No_Cursor
;
30444 /* Look for a `help-echo' property. */
30445 if (NILP (help_echo_string
)) {
30446 Lisp_Object help
, overlay
;
30448 /* Check overlays first. */
30449 help
= overlay
= Qnil
;
30450 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
30452 overlay
= overlay_vec
[i
];
30453 help
= Foverlay_get (overlay
, Qhelp_echo
);
30458 help_echo_string
= help
;
30459 help_echo_window
= window
;
30460 help_echo_object
= overlay
;
30461 help_echo_pos
= pos
;
30465 Lisp_Object obj
= glyph
->object
;
30466 ptrdiff_t charpos
= glyph
->charpos
;
30468 /* Try text properties. */
30471 && charpos
< SCHARS (obj
))
30473 help
= Fget_text_property (make_number (charpos
),
30477 /* If the string itself doesn't specify a help-echo,
30478 see if the buffer text ``under'' it does. */
30479 struct glyph_row
*r
30480 = MATRIX_ROW (w
->current_matrix
, vpos
);
30481 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30482 ptrdiff_t p
= string_buffer_position (obj
, start
);
30485 help
= Fget_char_property (make_number (p
),
30486 Qhelp_echo
, w
->contents
);
30495 else if (BUFFERP (obj
)
30498 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
30503 help_echo_string
= help
;
30504 help_echo_window
= window
;
30505 help_echo_object
= obj
;
30506 help_echo_pos
= charpos
;
30511 #ifdef HAVE_WINDOW_SYSTEM
30512 /* Look for a `pointer' property. */
30513 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30515 /* Check overlays first. */
30516 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
30517 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
30519 if (NILP (pointer
))
30521 Lisp_Object obj
= glyph
->object
;
30522 ptrdiff_t charpos
= glyph
->charpos
;
30524 /* Try text properties. */
30527 && charpos
< SCHARS (obj
))
30529 pointer
= Fget_text_property (make_number (charpos
),
30531 if (NILP (pointer
))
30533 /* If the string itself doesn't specify a pointer,
30534 see if the buffer text ``under'' it does. */
30535 struct glyph_row
*r
30536 = MATRIX_ROW (w
->current_matrix
, vpos
);
30537 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30538 ptrdiff_t p
= string_buffer_position (obj
, start
);
30540 pointer
= Fget_char_property (make_number (p
),
30541 Qpointer
, w
->contents
);
30544 else if (BUFFERP (obj
)
30547 pointer
= Fget_text_property (make_number (charpos
),
30551 #endif /* HAVE_WINDOW_SYSTEM */
30555 current_buffer
= obuf
;
30561 #ifdef HAVE_WINDOW_SYSTEM
30562 if (FRAME_WINDOW_P (f
))
30563 define_frame_cursor1 (f
, cursor
, pointer
);
30565 /* This is here to prevent a compiler error, about "label at end of
30566 compound statement". */
30573 Clear any mouse-face on window W. This function is part of the
30574 redisplay interface, and is called from try_window_id and similar
30575 functions to ensure the mouse-highlight is off. */
30578 x_clear_window_mouse_face (struct window
*w
)
30580 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
30581 Lisp_Object window
;
30584 XSETWINDOW (window
, w
);
30585 if (EQ (window
, hlinfo
->mouse_face_window
))
30586 clear_mouse_face (hlinfo
);
30592 Just discard the mouse face information for frame F, if any.
30593 This is used when the size of F is changed. */
30596 cancel_mouse_face (struct frame
*f
)
30598 Lisp_Object window
;
30599 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30601 window
= hlinfo
->mouse_face_window
;
30602 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
30603 reset_mouse_highlight (hlinfo
);
30608 /***********************************************************************
30610 ***********************************************************************/
30612 #ifdef HAVE_WINDOW_SYSTEM
30614 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
30615 which intersects rectangle R. R is in window-relative coordinates. */
30618 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
30619 enum glyph_row_area area
)
30621 struct glyph
*first
= row
->glyphs
[area
];
30622 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
30623 struct glyph
*last
;
30624 int first_x
, start_x
, x
;
30626 if (area
== TEXT_AREA
&& row
->fill_line_p
)
30627 /* If row extends face to end of line write the whole line. */
30628 draw_glyphs (w
, 0, row
, area
,
30629 0, row
->used
[area
],
30630 DRAW_NORMAL_TEXT
, 0);
30633 /* Set START_X to the window-relative start position for drawing glyphs of
30634 AREA. The first glyph of the text area can be partially visible.
30635 The first glyphs of other areas cannot. */
30636 start_x
= window_box_left_offset (w
, area
);
30638 if (area
== TEXT_AREA
)
30641 /* Find the first glyph that must be redrawn. */
30643 && x
+ first
->pixel_width
< r
->x
)
30645 x
+= first
->pixel_width
;
30649 /* Find the last one. */
30652 /* Use a signed int intermediate value to avoid catastrophic
30653 failures due to comparison between signed and unsigned, when
30654 x is negative (can happen for wide images that are hscrolled). */
30655 int r_end
= r
->x
+ r
->width
;
30656 while (last
< end
&& x
< r_end
)
30658 x
+= last
->pixel_width
;
30664 draw_glyphs (w
, first_x
- start_x
, row
, area
,
30665 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
30666 DRAW_NORMAL_TEXT
, 0);
30671 /* Redraw the parts of the glyph row ROW on window W intersecting
30672 rectangle R. R is in window-relative coordinates. Value is
30673 true if mouse-face was overwritten. */
30676 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
30678 eassert (row
->enabled_p
);
30680 if (row
->mode_line_p
|| w
->pseudo_window_p
)
30681 draw_glyphs (w
, 0, row
, TEXT_AREA
,
30682 0, row
->used
[TEXT_AREA
],
30683 DRAW_NORMAL_TEXT
, 0);
30686 if (row
->used
[LEFT_MARGIN_AREA
])
30687 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
30688 if (row
->used
[TEXT_AREA
])
30689 expose_area (w
, row
, r
, TEXT_AREA
);
30690 if (row
->used
[RIGHT_MARGIN_AREA
])
30691 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
30692 draw_row_fringe_bitmaps (w
, row
);
30695 return row
->mouse_face_p
;
30699 /* Redraw those parts of glyphs rows during expose event handling that
30700 overlap other rows. Redrawing of an exposed line writes over parts
30701 of lines overlapping that exposed line; this function fixes that.
30703 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
30704 row in W's current matrix that is exposed and overlaps other rows.
30705 LAST_OVERLAPPING_ROW is the last such row. */
30708 expose_overlaps (struct window
*w
,
30709 struct glyph_row
*first_overlapping_row
,
30710 struct glyph_row
*last_overlapping_row
,
30713 struct glyph_row
*row
;
30715 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
30716 if (row
->overlapping_p
)
30718 eassert (row
->enabled_p
&& !row
->mode_line_p
);
30721 if (row
->used
[LEFT_MARGIN_AREA
])
30722 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
30724 if (row
->used
[TEXT_AREA
])
30725 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
30727 if (row
->used
[RIGHT_MARGIN_AREA
])
30728 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
30734 /* Return true if W's cursor intersects rectangle R. */
30737 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
30739 XRectangle cr
, result
;
30740 struct glyph
*cursor_glyph
;
30741 struct glyph_row
*row
;
30743 if (w
->phys_cursor
.vpos
>= 0
30744 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
30745 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
30747 && row
->cursor_in_fringe_p
)
30749 /* Cursor is in the fringe. */
30750 cr
.x
= window_box_right_offset (w
,
30751 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
30752 ? RIGHT_MARGIN_AREA
30755 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
30756 cr
.height
= row
->height
;
30757 return x_intersect_rectangles (&cr
, r
, &result
);
30760 cursor_glyph
= get_phys_cursor_glyph (w
);
30763 /* r is relative to W's box, but w->phys_cursor.x is relative
30764 to left edge of W's TEXT area. Adjust it. */
30765 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
30766 cr
.y
= w
->phys_cursor
.y
;
30767 cr
.width
= cursor_glyph
->pixel_width
;
30768 cr
.height
= w
->phys_cursor_height
;
30769 /* ++KFS: W32 version used W32-specific IntersectRect here, but
30770 I assume the effect is the same -- and this is portable. */
30771 return x_intersect_rectangles (&cr
, r
, &result
);
30773 /* If we don't understand the format, pretend we're not in the hot-spot. */
30779 Draw a vertical window border to the right of window W if W doesn't
30780 have vertical scroll bars. */
30783 x_draw_vertical_border (struct window
*w
)
30785 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30787 /* We could do better, if we knew what type of scroll-bar the adjacent
30788 windows (on either side) have... But we don't :-(
30789 However, I think this works ok. ++KFS 2003-04-25 */
30791 /* Redraw borders between horizontally adjacent windows. Don't
30792 do it for frames with vertical scroll bars because either the
30793 right scroll bar of a window, or the left scroll bar of its
30794 neighbor will suffice as a border. */
30795 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
30798 /* Note: It is necessary to redraw both the left and the right
30799 borders, for when only this single window W is being
30801 if (!WINDOW_RIGHTMOST_P (w
)
30802 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
30804 int x0
, x1
, y0
, y1
;
30806 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30809 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30812 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
30815 if (!WINDOW_LEFTMOST_P (w
)
30816 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
30818 int x0
, x1
, y0
, y1
;
30820 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30823 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30826 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
30831 /* Draw window dividers for window W. */
30834 x_draw_right_divider (struct window
*w
)
30836 struct frame
*f
= WINDOW_XFRAME (w
);
30838 if (w
->mini
|| w
->pseudo_window_p
)
30840 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30842 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
30843 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30844 int y0
= WINDOW_TOP_EDGE_Y (w
);
30845 /* The bottom divider prevails. */
30846 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30848 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30853 x_draw_bottom_divider (struct window
*w
)
30855 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30857 if (w
->mini
|| w
->pseudo_window_p
)
30859 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30861 int x0
= WINDOW_LEFT_EDGE_X (w
);
30862 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30863 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30864 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
30866 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30870 /* Redraw the part of window W intersection rectangle FR. Pixel
30871 coordinates in FR are frame-relative. Call this function with
30872 input blocked. Value is true if the exposure overwrites
30876 expose_window (struct window
*w
, XRectangle
*fr
)
30878 struct frame
*f
= XFRAME (w
->frame
);
30880 bool mouse_face_overwritten_p
= false;
30882 /* If window is not yet fully initialized, do nothing. This can
30883 happen when toolkit scroll bars are used and a window is split.
30884 Reconfiguring the scroll bar will generate an expose for a newly
30886 if (w
->current_matrix
== NULL
)
30889 /* When we're currently updating the window, display and current
30890 matrix usually don't agree. Arrange for a thorough display
30892 if (w
->must_be_updated_p
)
30894 SET_FRAME_GARBAGED (f
);
30898 /* Frame-relative pixel rectangle of W. */
30899 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
30900 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
30901 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
30902 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
30904 if (x_intersect_rectangles (fr
, &wr
, &r
))
30906 int yb
= window_text_bottom_y (w
);
30907 struct glyph_row
*row
;
30908 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
30910 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
30911 r
.x
, r
.y
, r
.width
, r
.height
));
30913 /* Convert to window coordinates. */
30914 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
30915 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
30917 /* Turn off the cursor. */
30918 bool cursor_cleared_p
= (!w
->pseudo_window_p
30919 && phys_cursor_in_rect_p (w
, &r
));
30920 if (cursor_cleared_p
)
30921 x_clear_cursor (w
);
30923 /* If the row containing the cursor extends face to end of line,
30924 then expose_area might overwrite the cursor outside the
30925 rectangle and thus notice_overwritten_cursor might clear
30926 w->phys_cursor_on_p. We remember the original value and
30927 check later if it is changed. */
30928 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
30930 /* Use a signed int intermediate value to avoid catastrophic
30931 failures due to comparison between signed and unsigned, when
30932 y0 or y1 is negative (can happen for tall images). */
30933 int r_bottom
= r
.y
+ r
.height
;
30935 /* Update lines intersecting rectangle R. */
30936 first_overlapping_row
= last_overlapping_row
= NULL
;
30937 for (row
= w
->current_matrix
->rows
;
30942 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
30944 if ((y0
>= r
.y
&& y0
< r_bottom
)
30945 || (y1
> r
.y
&& y1
< r_bottom
)
30946 || (r
.y
>= y0
&& r
.y
< y1
)
30947 || (r_bottom
> y0
&& r_bottom
< y1
))
30949 /* A header line may be overlapping, but there is no need
30950 to fix overlapping areas for them. KFS 2005-02-12 */
30951 if (row
->overlapping_p
&& !row
->mode_line_p
)
30953 if (first_overlapping_row
== NULL
)
30954 first_overlapping_row
= row
;
30955 last_overlapping_row
= row
;
30959 if (expose_line (w
, row
, &r
))
30960 mouse_face_overwritten_p
= true;
30963 else if (row
->overlapping_p
)
30965 /* We must redraw a row overlapping the exposed area. */
30967 ? y0
+ row
->phys_height
> r
.y
30968 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30970 if (first_overlapping_row
== NULL
)
30971 first_overlapping_row
= row
;
30972 last_overlapping_row
= row
;
30980 /* Display the mode line if there is one. */
30981 if (WINDOW_WANTS_MODELINE_P (w
)
30982 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30984 && row
->y
< r_bottom
)
30986 if (expose_line (w
, row
, &r
))
30987 mouse_face_overwritten_p
= true;
30990 if (!w
->pseudo_window_p
)
30992 /* Fix the display of overlapping rows. */
30993 if (first_overlapping_row
)
30994 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30997 /* Draw border between windows. */
30998 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30999 x_draw_right_divider (w
);
31001 x_draw_vertical_border (w
);
31003 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
31004 x_draw_bottom_divider (w
);
31006 /* Turn the cursor on again. */
31007 if (cursor_cleared_p
31008 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
31009 update_window_cursor (w
, true);
31013 return mouse_face_overwritten_p
;
31018 /* Redraw (parts) of all windows in the window tree rooted at W that
31019 intersect R. R contains frame pixel coordinates. Value is
31020 true if the exposure overwrites mouse-face. */
31023 expose_window_tree (struct window
*w
, XRectangle
*r
)
31025 struct frame
*f
= XFRAME (w
->frame
);
31026 bool mouse_face_overwritten_p
= false;
31028 while (w
&& !FRAME_GARBAGED_P (f
))
31030 mouse_face_overwritten_p
31031 |= (WINDOWP (w
->contents
)
31032 ? expose_window_tree (XWINDOW (w
->contents
), r
)
31033 : expose_window (w
, r
));
31035 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
31038 return mouse_face_overwritten_p
;
31043 Redisplay an exposed area of frame F. X and Y are the upper-left
31044 corner of the exposed rectangle. W and H are width and height of
31045 the exposed area. All are pixel values. W or H zero means redraw
31046 the entire frame. */
31049 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
31052 bool mouse_face_overwritten_p
= false;
31054 TRACE ((stderr
, "expose_frame "));
31056 /* No need to redraw if frame will be redrawn soon. */
31057 if (FRAME_GARBAGED_P (f
))
31059 TRACE ((stderr
, " garbaged\n"));
31063 /* If basic faces haven't been realized yet, there is no point in
31064 trying to redraw anything. This can happen when we get an expose
31065 event while Emacs is starting, e.g. by moving another window. */
31066 if (FRAME_FACE_CACHE (f
) == NULL
31067 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
31069 TRACE ((stderr
, " no faces\n"));
31073 if (w
== 0 || h
== 0)
31076 r
.width
= FRAME_TEXT_WIDTH (f
);
31077 r
.height
= FRAME_TEXT_HEIGHT (f
);
31087 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
31088 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
31090 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
31091 if (WINDOWP (f
->tool_bar_window
))
31092 mouse_face_overwritten_p
31093 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
31096 #ifdef HAVE_X_WINDOWS
31098 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
31099 if (WINDOWP (f
->menu_bar_window
))
31100 mouse_face_overwritten_p
31101 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
31102 #endif /* not USE_X_TOOLKIT and not USE_GTK */
31106 /* Some window managers support a focus-follows-mouse style with
31107 delayed raising of frames. Imagine a partially obscured frame,
31108 and moving the mouse into partially obscured mouse-face on that
31109 frame. The visible part of the mouse-face will be highlighted,
31110 then the WM raises the obscured frame. With at least one WM, KDE
31111 2.1, Emacs is not getting any event for the raising of the frame
31112 (even tried with SubstructureRedirectMask), only Expose events.
31113 These expose events will draw text normally, i.e. not
31114 highlighted. Which means we must redo the highlight here.
31115 Subsume it under ``we love X''. --gerd 2001-08-15 */
31116 /* Included in Windows version because Windows most likely does not
31117 do the right thing if any third party tool offers
31118 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
31119 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
31121 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
31122 if (f
== hlinfo
->mouse_face_mouse_frame
)
31124 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
31125 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
31126 clear_mouse_face (hlinfo
);
31127 note_mouse_highlight (f
, mouse_x
, mouse_y
);
31134 Determine the intersection of two rectangles R1 and R2. Return
31135 the intersection in *RESULT. Value is true if RESULT is not
31139 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
31141 XRectangle
*left
, *right
;
31142 XRectangle
*upper
, *lower
;
31143 bool intersection_p
= false;
31145 /* Rearrange so that R1 is the left-most rectangle. */
31147 left
= r1
, right
= r2
;
31149 left
= r2
, right
= r1
;
31151 /* X0 of the intersection is right.x0, if this is inside R1,
31152 otherwise there is no intersection. */
31153 if (right
->x
<= left
->x
+ left
->width
)
31155 result
->x
= right
->x
;
31157 /* The right end of the intersection is the minimum of
31158 the right ends of left and right. */
31159 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
31162 /* Same game for Y. */
31164 upper
= r1
, lower
= r2
;
31166 upper
= r2
, lower
= r1
;
31168 /* The upper end of the intersection is lower.y0, if this is inside
31169 of upper. Otherwise, there is no intersection. */
31170 if (lower
->y
<= upper
->y
+ upper
->height
)
31172 result
->y
= lower
->y
;
31174 /* The lower end of the intersection is the minimum of the lower
31175 ends of upper and lower. */
31176 result
->height
= (min (lower
->y
+ lower
->height
,
31177 upper
->y
+ upper
->height
)
31179 intersection_p
= true;
31183 return intersection_p
;
31186 #endif /* HAVE_WINDOW_SYSTEM */
31189 /***********************************************************************
31191 ***********************************************************************/
31194 syms_of_xdisp (void)
31196 Vwith_echo_area_save_vector
= Qnil
;
31197 staticpro (&Vwith_echo_area_save_vector
);
31199 Vmessage_stack
= Qnil
;
31200 staticpro (&Vmessage_stack
);
31202 /* Non-nil means don't actually do any redisplay. */
31203 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
31205 DEFSYM (Qredisplay_internal_xC_functionx
, "redisplay_internal (C function)");
31207 DEFVAR_BOOL("inhibit-message", inhibit_message
,
31208 doc
: /* Non-nil means calls to `message' are not displayed.
31209 They are still logged to the *Messages* buffer. */);
31210 inhibit_message
= 0;
31212 message_dolog_marker1
= Fmake_marker ();
31213 staticpro (&message_dolog_marker1
);
31214 message_dolog_marker2
= Fmake_marker ();
31215 staticpro (&message_dolog_marker2
);
31216 message_dolog_marker3
= Fmake_marker ();
31217 staticpro (&message_dolog_marker3
);
31220 defsubr (&Sdump_frame_glyph_matrix
);
31221 defsubr (&Sdump_glyph_matrix
);
31222 defsubr (&Sdump_glyph_row
);
31223 defsubr (&Sdump_tool_bar_row
);
31224 defsubr (&Strace_redisplay
);
31225 defsubr (&Strace_to_stderr
);
31227 #ifdef HAVE_WINDOW_SYSTEM
31228 defsubr (&Stool_bar_height
);
31229 defsubr (&Slookup_image_map
);
31231 defsubr (&Sline_pixel_height
);
31232 defsubr (&Sformat_mode_line
);
31233 defsubr (&Sinvisible_p
);
31234 defsubr (&Scurrent_bidi_paragraph_direction
);
31235 defsubr (&Swindow_text_pixel_size
);
31236 defsubr (&Smove_point_visually
);
31237 defsubr (&Sbidi_find_overridden_directionality
);
31239 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
31240 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
31241 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
31242 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
31243 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
31244 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
31245 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
31246 DEFSYM (Qeval
, "eval");
31247 DEFSYM (QCdata
, ":data");
31249 /* Names of text properties relevant for redisplay. */
31250 DEFSYM (Qdisplay
, "display");
31251 DEFSYM (Qspace_width
, "space-width");
31252 DEFSYM (Qraise
, "raise");
31253 DEFSYM (Qslice
, "slice");
31254 DEFSYM (Qspace
, "space");
31255 DEFSYM (Qmargin
, "margin");
31256 DEFSYM (Qpointer
, "pointer");
31257 DEFSYM (Qleft_margin
, "left-margin");
31258 DEFSYM (Qright_margin
, "right-margin");
31259 DEFSYM (Qcenter
, "center");
31260 DEFSYM (Qline_height
, "line-height");
31261 DEFSYM (QCalign_to
, ":align-to");
31262 DEFSYM (QCrelative_width
, ":relative-width");
31263 DEFSYM (QCrelative_height
, ":relative-height");
31264 DEFSYM (QCeval
, ":eval");
31265 DEFSYM (QCpropertize
, ":propertize");
31266 DEFSYM (QCfile
, ":file");
31267 DEFSYM (Qfontified
, "fontified");
31268 DEFSYM (Qfontification_functions
, "fontification-functions");
31270 /* Name of the face used to highlight trailing whitespace. */
31271 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
31273 /* Name and number of the face used to highlight escape glyphs. */
31274 DEFSYM (Qescape_glyph
, "escape-glyph");
31276 /* Name and number of the face used to highlight non-breaking
31278 DEFSYM (Qnobreak_space
, "nobreak-space");
31279 DEFSYM (Qnobreak_hyphen
, "nobreak-hyphen");
31281 /* The symbol 'image' which is the car of the lists used to represent
31282 images in Lisp. Also a tool bar style. */
31283 DEFSYM (Qimage
, "image");
31285 /* Tool bar styles. */
31286 DEFSYM (Qtext
, "text");
31287 DEFSYM (Qboth
, "both");
31288 DEFSYM (Qboth_horiz
, "both-horiz");
31289 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
31291 /* The image map types. */
31292 DEFSYM (QCmap
, ":map");
31293 DEFSYM (QCpointer
, ":pointer");
31294 DEFSYM (Qrect
, "rect");
31295 DEFSYM (Qcircle
, "circle");
31296 DEFSYM (Qpoly
, "poly");
31298 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
31300 DEFSYM (Qgrow_only
, "grow-only");
31301 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
31302 DEFSYM (Qposition
, "position");
31303 DEFSYM (Qbuffer_position
, "buffer-position");
31304 DEFSYM (Qobject
, "object");
31306 /* Cursor shapes. */
31307 DEFSYM (Qbar
, "bar");
31308 DEFSYM (Qhbar
, "hbar");
31309 DEFSYM (Qbox
, "box");
31310 DEFSYM (Qhollow
, "hollow");
31312 /* Pointer shapes. */
31313 DEFSYM (Qhand
, "hand");
31314 DEFSYM (Qarrow
, "arrow");
31317 DEFSYM (Qdragging
, "dragging");
31319 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
31321 list_of_error
= list1 (list2 (Qerror
, Qvoid_variable
));
31322 staticpro (&list_of_error
);
31324 /* Values of those variables at last redisplay are stored as
31325 properties on 'overlay-arrow-position' symbol. However, if
31326 Voverlay_arrow_position is a marker, last-arrow-position is its
31327 numerical position. */
31328 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
31329 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
31331 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
31332 properties on a symbol in overlay-arrow-variable-list. */
31333 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
31334 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
31336 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
31337 staticpro (&echo_buffer
[0]);
31338 staticpro (&echo_buffer
[1]);
31340 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
31341 staticpro (&echo_area_buffer
[0]);
31342 staticpro (&echo_area_buffer
[1]);
31344 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
31345 staticpro (&Vmessages_buffer_name
);
31347 mode_line_proptrans_alist
= Qnil
;
31348 staticpro (&mode_line_proptrans_alist
);
31349 mode_line_string_list
= Qnil
;
31350 staticpro (&mode_line_string_list
);
31351 mode_line_string_face
= Qnil
;
31352 staticpro (&mode_line_string_face
);
31353 mode_line_string_face_prop
= Qnil
;
31354 staticpro (&mode_line_string_face_prop
);
31355 Vmode_line_unwind_vector
= Qnil
;
31356 staticpro (&Vmode_line_unwind_vector
);
31358 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
31360 help_echo_string
= Qnil
;
31361 staticpro (&help_echo_string
);
31362 help_echo_object
= Qnil
;
31363 staticpro (&help_echo_object
);
31364 help_echo_window
= Qnil
;
31365 staticpro (&help_echo_window
);
31366 previous_help_echo_string
= Qnil
;
31367 staticpro (&previous_help_echo_string
);
31368 help_echo_pos
= -1;
31370 DEFSYM (Qright_to_left
, "right-to-left");
31371 DEFSYM (Qleft_to_right
, "left-to-right");
31372 defsubr (&Sbidi_resolved_levels
);
31374 #ifdef HAVE_WINDOW_SYSTEM
31375 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
31376 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
31377 For example, if a block cursor is over a tab, it will be drawn as
31378 wide as that tab on the display. */);
31379 x_stretch_cursor_p
= 0;
31382 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
31383 doc
: /* Non-nil means highlight trailing whitespace.
31384 The face used for trailing whitespace is `trailing-whitespace'. */);
31385 Vshow_trailing_whitespace
= Qnil
;
31387 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
31388 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
31389 If the value is t, Emacs highlights non-ASCII chars which have the
31390 same appearance as an ASCII space or hyphen, using the `nobreak-space'
31391 or `nobreak-hyphen' face respectively.
31393 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
31394 U+2011 (non-breaking hyphen) are affected.
31396 Any other non-nil value means to display these characters as a escape
31397 glyph followed by an ordinary space or hyphen.
31399 A value of nil means no special handling of these characters. */);
31400 Vnobreak_char_display
= Qt
;
31402 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
31403 doc
: /* The pointer shape to show in void text areas.
31404 A value of nil means to show the text pointer. Other options are
31405 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
31407 Vvoid_text_area_pointer
= Qarrow
;
31409 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
31410 doc
: /* Non-nil means don't actually do any redisplay.
31411 This is used for internal purposes. */);
31412 Vinhibit_redisplay
= Qnil
;
31414 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
31415 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
31416 Vglobal_mode_string
= Qnil
;
31418 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
31419 doc
: /* Marker for where to display an arrow on top of the buffer text.
31420 This must be the beginning of a line in order to work.
31421 See also `overlay-arrow-string'. */);
31422 Voverlay_arrow_position
= Qnil
;
31424 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
31425 doc
: /* String to display as an arrow in non-window frames.
31426 See also `overlay-arrow-position'. */);
31427 Voverlay_arrow_string
= build_pure_c_string ("=>");
31429 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
31430 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
31431 The symbols on this list are examined during redisplay to determine
31432 where to display overlay arrows. */);
31433 Voverlay_arrow_variable_list
31434 = list1 (intern_c_string ("overlay-arrow-position"));
31436 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
31437 doc
: /* The number of lines to try scrolling a window by when point moves out.
31438 If that fails to bring point back on frame, point is centered instead.
31439 If this is zero, point is always centered after it moves off frame.
31440 If you want scrolling to always be a line at a time, you should set
31441 `scroll-conservatively' to a large value rather than set this to 1. */);
31443 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
31444 doc
: /* Scroll up to this many lines, to bring point back on screen.
31445 If point moves off-screen, redisplay will scroll by up to
31446 `scroll-conservatively' lines in order to bring point just barely
31447 onto the screen again. If that cannot be done, then redisplay
31448 recenters point as usual.
31450 If the value is greater than 100, redisplay will never recenter point,
31451 but will always scroll just enough text to bring point into view, even
31452 if you move far away.
31454 A value of zero means always recenter point if it moves off screen. */);
31455 scroll_conservatively
= 0;
31457 DEFVAR_INT ("scroll-margin", scroll_margin
,
31458 doc
: /* Number of lines of margin at the top and bottom of a window.
31459 Recenter the window whenever point gets within this many lines
31460 of the top or bottom of the window. */);
31463 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
31464 doc
: /* Pixels per inch value for non-window system displays.
31465 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
31466 Vdisplay_pixels_per_inch
= make_float (72.0);
31469 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
31472 DEFVAR_LISP ("truncate-partial-width-windows",
31473 Vtruncate_partial_width_windows
,
31474 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
31475 For an integer value, truncate lines in each window narrower than the
31476 full frame width, provided the total window width in column units is less
31477 than that integer; otherwise, respect the value of `truncate-lines'.
31478 The total width of the window is as returned by `window-total-width', it
31479 includes the fringes, the continuation and truncation glyphs, the
31480 display margins (if any), and the scroll bar
31482 For any other non-nil value, truncate lines in all windows that do
31483 not span the full frame width.
31485 A value of nil means to respect the value of `truncate-lines'.
31487 If `word-wrap' is enabled, you might want to reduce this. */);
31488 Vtruncate_partial_width_windows
= make_number (50);
31490 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
31491 doc
: /* Maximum buffer size for which line number should be displayed.
31492 If the buffer is bigger than this, the line number does not appear
31493 in the mode line. A value of nil means no limit. */);
31494 Vline_number_display_limit
= Qnil
;
31496 DEFVAR_INT ("line-number-display-limit-width",
31497 line_number_display_limit_width
,
31498 doc
: /* Maximum line width (in characters) for line number display.
31499 If the average length of the lines near point is bigger than this, then the
31500 line number may be omitted from the mode line. */);
31501 line_number_display_limit_width
= 200;
31503 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
31504 doc
: /* Non-nil means highlight region even in nonselected windows. */);
31505 highlight_nonselected_windows
= false;
31507 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
31508 doc
: /* Non-nil if more than one frame is visible on this display.
31509 Minibuffer-only frames don't count, but iconified frames do.
31510 This variable is not guaranteed to be accurate except while processing
31511 `frame-title-format' and `icon-title-format'. */);
31513 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
31514 doc
: /* Template for displaying the title bar of visible frames.
31515 \(Assuming the window manager supports this feature.)
31517 This variable has the same structure as `mode-line-format', except that
31518 the %c and %l constructs are ignored. It is used only on frames for
31519 which no explicit name has been set (see `modify-frame-parameters'). */);
31521 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
31522 doc
: /* Template for displaying the title bar of an iconified frame.
31523 \(Assuming the window manager supports this feature.)
31524 This variable has the same structure as `mode-line-format' (which see),
31525 and is used only on frames for which no explicit name has been set
31526 \(see `modify-frame-parameters'). */);
31528 = Vframe_title_format
31529 = listn (CONSTYPE_PURE
, 3,
31530 intern_c_string ("multiple-frames"),
31531 build_pure_c_string ("%b"),
31532 listn (CONSTYPE_PURE
, 4,
31533 empty_unibyte_string
,
31534 intern_c_string ("invocation-name"),
31535 build_pure_c_string ("@"),
31536 intern_c_string ("system-name")));
31538 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
31539 doc
: /* Maximum number of lines to keep in the message log buffer.
31540 If nil, disable message logging. If t, log messages but don't truncate
31541 the buffer when it becomes large. */);
31542 Vmessage_log_max
= make_number (1000);
31544 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
31545 doc
: /* List of functions to call before redisplaying a window with scrolling.
31546 Each function is called with two arguments, the window and its new
31547 display-start position.
31548 These functions are called whenever the `window-start' marker is modified,
31549 either to point into another buffer (e.g. via `set-window-buffer') or another
31550 place in the same buffer.
31551 Note that the value of `window-end' is not valid when these functions are
31554 Warning: Do not use this feature to alter the way the window
31555 is scrolled. It is not designed for that, and such use probably won't
31557 Vwindow_scroll_functions
= Qnil
;
31559 DEFVAR_LISP ("window-text-change-functions",
31560 Vwindow_text_change_functions
,
31561 doc
: /* Functions to call in redisplay when text in the window might change. */);
31562 Vwindow_text_change_functions
= Qnil
;
31564 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
31565 doc
: /* Functions called when redisplay of a window reaches the end trigger.
31566 Each function is called with two arguments, the window and the end trigger value.
31567 See `set-window-redisplay-end-trigger'. */);
31568 Vredisplay_end_trigger_functions
= Qnil
;
31570 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
31571 doc
: /* Non-nil means autoselect window with mouse pointer.
31572 If nil, do not autoselect windows.
31573 A positive number means delay autoselection by that many seconds: a
31574 window is autoselected only after the mouse has remained in that
31575 window for the duration of the delay.
31576 A negative number has a similar effect, but causes windows to be
31577 autoselected only after the mouse has stopped moving. (Because of
31578 the way Emacs compares mouse events, you will occasionally wait twice
31579 that time before the window gets selected.)
31580 Any other value means to autoselect window instantaneously when the
31581 mouse pointer enters it.
31583 Autoselection selects the minibuffer only if it is active, and never
31584 unselects the minibuffer if it is active.
31586 When customizing this variable make sure that the actual value of
31587 `focus-follows-mouse' matches the behavior of your window manager. */);
31588 Vmouse_autoselect_window
= Qnil
;
31590 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
31591 doc
: /* Non-nil means automatically resize tool-bars.
31592 This dynamically changes the tool-bar's height to the minimum height
31593 that is needed to make all tool-bar items visible.
31594 If value is `grow-only', the tool-bar's height is only increased
31595 automatically; to decrease the tool-bar height, use \\[recenter]. */);
31596 Vauto_resize_tool_bars
= Qt
;
31598 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
31599 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
31600 auto_raise_tool_bar_buttons_p
= true;
31602 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
31603 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
31604 make_cursor_line_fully_visible_p
= true;
31606 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
31607 doc
: /* Border below tool-bar in pixels.
31608 If an integer, use it as the height of the border.
31609 If it is one of `internal-border-width' or `border-width', use the
31610 value of the corresponding frame parameter.
31611 Otherwise, no border is added below the tool-bar. */);
31612 Vtool_bar_border
= Qinternal_border_width
;
31614 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
31615 doc
: /* Margin around tool-bar buttons in pixels.
31616 If an integer, use that for both horizontal and vertical margins.
31617 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
31618 HORZ specifying the horizontal margin, and VERT specifying the
31619 vertical margin. */);
31620 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
31622 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
31623 doc
: /* Relief thickness of tool-bar buttons. */);
31624 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
31626 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
31627 doc
: /* Tool bar style to use.
31629 image - show images only
31630 text - show text only
31631 both - show both, text below image
31632 both-horiz - show text to the right of the image
31633 text-image-horiz - show text to the left of the image
31634 any other - use system default or image if no system default.
31636 This variable only affects the GTK+ toolkit version of Emacs. */);
31637 Vtool_bar_style
= Qnil
;
31639 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
31640 doc
: /* Maximum number of characters a label can have to be shown.
31641 The tool bar style must also show labels for this to have any effect, see
31642 `tool-bar-style'. */);
31643 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
31645 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
31646 doc
: /* List of functions to call to fontify regions of text.
31647 Each function is called with one argument POS. Functions must
31648 fontify a region starting at POS in the current buffer, and give
31649 fontified regions the property `fontified'. */);
31650 Vfontification_functions
= Qnil
;
31651 Fmake_variable_buffer_local (Qfontification_functions
);
31653 DEFVAR_BOOL ("unibyte-display-via-language-environment",
31654 unibyte_display_via_language_environment
,
31655 doc
: /* Non-nil means display unibyte text according to language environment.
31656 Specifically, this means that raw bytes in the range 160-255 decimal
31657 are displayed by converting them to the equivalent multibyte characters
31658 according to the current language environment. As a result, they are
31659 displayed according to the current fontset.
31661 Note that this variable affects only how these bytes are displayed,
31662 but does not change the fact they are interpreted as raw bytes. */);
31663 unibyte_display_via_language_environment
= false;
31665 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
31666 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
31667 If a float, it specifies a fraction of the mini-window frame's height.
31668 If an integer, it specifies a number of lines. */);
31669 Vmax_mini_window_height
= make_float (0.25);
31671 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
31672 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
31673 A value of nil means don't automatically resize mini-windows.
31674 A value of t means resize them to fit the text displayed in them.
31675 A value of `grow-only', the default, means let mini-windows grow only;
31676 they return to their normal size when the minibuffer is closed, or the
31677 echo area becomes empty. */);
31678 /* Contrary to the doc string, we initialize this to nil, so that
31679 loading loadup.el won't try to resize windows before loading
31680 window.el, where some functions we need to call for this live.
31681 We assign the 'grow-only' value right after loading window.el
31683 Vresize_mini_windows
= Qnil
;
31685 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
31686 doc
: /* Alist specifying how to blink the cursor off.
31687 Each element has the form (ON-STATE . OFF-STATE). Whenever the
31688 `cursor-type' frame-parameter or variable equals ON-STATE,
31689 comparing using `equal', Emacs uses OFF-STATE to specify
31690 how to blink it off. ON-STATE and OFF-STATE are values for
31691 the `cursor-type' frame parameter.
31693 If a frame's ON-STATE has no entry in this list,
31694 the frame's other specifications determine how to blink the cursor off. */);
31695 Vblink_cursor_alist
= Qnil
;
31697 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
31698 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
31699 If non-nil, windows are automatically scrolled horizontally to make
31700 point visible. */);
31701 automatic_hscrolling_p
= true;
31702 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
31704 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
31705 doc
: /* How many columns away from the window edge point is allowed to get
31706 before automatic hscrolling will horizontally scroll the window. */);
31707 hscroll_margin
= 5;
31709 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
31710 doc
: /* How many columns to scroll the window when point gets too close to the edge.
31711 When point is less than `hscroll-margin' columns from the window
31712 edge, automatic hscrolling will scroll the window by the amount of columns
31713 determined by this variable. If its value is a positive integer, scroll that
31714 many columns. If it's a positive floating-point number, it specifies the
31715 fraction of the window's width to scroll. If it's nil or zero, point will be
31716 centered horizontally after the scroll. Any other value, including negative
31717 numbers, are treated as if the value were zero.
31719 Automatic hscrolling always moves point outside the scroll margin, so if
31720 point was more than scroll step columns inside the margin, the window will
31721 scroll more than the value given by the scroll step.
31723 Note that the lower bound for automatic hscrolling specified by `scroll-left'
31724 and `scroll-right' overrides this variable's effect. */);
31725 Vhscroll_step
= make_number (0);
31727 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
31728 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
31729 Bind this around calls to `message' to let it take effect. */);
31730 message_truncate_lines
= false;
31732 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
31733 doc
: /* Normal hook run to update the menu bar definitions.
31734 Redisplay runs this hook before it redisplays the menu bar.
31735 This is used to update menus such as Buffers, whose contents depend on
31737 Vmenu_bar_update_hook
= Qnil
;
31739 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
31740 doc
: /* Frame for which we are updating a menu.
31741 The enable predicate for a menu binding should check this variable. */);
31742 Vmenu_updating_frame
= Qnil
;
31744 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
31745 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
31746 inhibit_menubar_update
= false;
31748 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
31749 doc
: /* Prefix prepended to all continuation lines at display time.
31750 The value may be a string, an image, or a stretch-glyph; it is
31751 interpreted in the same way as the value of a `display' text property.
31753 This variable is overridden by any `wrap-prefix' text or overlay
31756 To add a prefix to non-continuation lines, use `line-prefix'. */);
31757 Vwrap_prefix
= Qnil
;
31758 DEFSYM (Qwrap_prefix
, "wrap-prefix");
31759 Fmake_variable_buffer_local (Qwrap_prefix
);
31761 DEFVAR_LISP ("line-prefix", Vline_prefix
,
31762 doc
: /* Prefix prepended to all non-continuation lines at display time.
31763 The value may be a string, an image, or a stretch-glyph; it is
31764 interpreted in the same way as the value of a `display' text property.
31766 This variable is overridden by any `line-prefix' text or overlay
31769 To add a prefix to continuation lines, use `wrap-prefix'. */);
31770 Vline_prefix
= Qnil
;
31771 DEFSYM (Qline_prefix
, "line-prefix");
31772 Fmake_variable_buffer_local (Qline_prefix
);
31774 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
31775 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
31776 inhibit_eval_during_redisplay
= false;
31778 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
31779 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
31780 inhibit_free_realized_faces
= false;
31782 DEFVAR_BOOL ("inhibit-bidi-mirroring", inhibit_bidi_mirroring
,
31783 doc
: /* Non-nil means don't mirror characters even when bidi context requires that.
31784 Intended for use during debugging and for testing bidi display;
31785 see biditest.el in the test suite. */);
31786 inhibit_bidi_mirroring
= false;
31789 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
31790 doc
: /* Inhibit try_window_id display optimization. */);
31791 inhibit_try_window_id
= false;
31793 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
31794 doc
: /* Inhibit try_window_reusing display optimization. */);
31795 inhibit_try_window_reusing
= false;
31797 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
31798 doc
: /* Inhibit try_cursor_movement display optimization. */);
31799 inhibit_try_cursor_movement
= false;
31800 #endif /* GLYPH_DEBUG */
31802 DEFVAR_INT ("overline-margin", overline_margin
,
31803 doc
: /* Space between overline and text, in pixels.
31804 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
31805 margin to the character height. */);
31806 overline_margin
= 2;
31808 DEFVAR_INT ("underline-minimum-offset",
31809 underline_minimum_offset
,
31810 doc
: /* Minimum distance between baseline and underline.
31811 This can improve legibility of underlined text at small font sizes,
31812 particularly when using variable `x-use-underline-position-properties'
31813 with fonts that specify an UNDERLINE_POSITION relatively close to the
31814 baseline. The default value is 1. */);
31815 underline_minimum_offset
= 1;
31817 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
31818 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
31819 This feature only works when on a window system that can change
31820 cursor shapes. */);
31821 display_hourglass_p
= true;
31823 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
31824 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
31825 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
31827 #ifdef HAVE_WINDOW_SYSTEM
31828 hourglass_atimer
= NULL
;
31829 hourglass_shown_p
= false;
31830 #endif /* HAVE_WINDOW_SYSTEM */
31832 /* Name of the face used to display glyphless characters. */
31833 DEFSYM (Qglyphless_char
, "glyphless-char");
31835 /* Method symbols for Vglyphless_char_display. */
31836 DEFSYM (Qhex_code
, "hex-code");
31837 DEFSYM (Qempty_box
, "empty-box");
31838 DEFSYM (Qthin_space
, "thin-space");
31839 DEFSYM (Qzero_width
, "zero-width");
31841 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
31842 doc
: /* Function run just before redisplay.
31843 It is called with one argument, which is the set of windows that are to
31844 be redisplayed. This set can be nil (meaning, only the selected window),
31845 or t (meaning all windows). */);
31846 Vpre_redisplay_function
= intern ("ignore");
31848 /* Symbol for the purpose of Vglyphless_char_display. */
31849 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
31850 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
31852 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
31853 doc
: /* Char-table defining glyphless characters.
31854 Each element, if non-nil, should be one of the following:
31855 an ASCII acronym string: display this string in a box
31856 `hex-code': display the hexadecimal code of a character in a box
31857 `empty-box': display as an empty box
31858 `thin-space': display as 1-pixel width space
31859 `zero-width': don't display
31860 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
31861 display method for graphical terminals and text terminals respectively.
31862 GRAPHICAL and TEXT should each have one of the values listed above.
31864 The char-table has one extra slot to control the display of a character for
31865 which no font is found. This slot only takes effect on graphical terminals.
31866 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
31867 `thin-space'. The default is `empty-box'.
31869 If a character has a non-nil entry in an active display table, the
31870 display table takes effect; in this case, Emacs does not consult
31871 `glyphless-char-display' at all. */);
31872 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
31873 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
31876 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
31877 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
31878 Vdebug_on_message
= Qnil
;
31880 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
31882 Vredisplay__all_windows_cause
= Fmake_hash_table (0, NULL
);
31884 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
31886 Vredisplay__mode_lines_cause
= Fmake_hash_table (0, NULL
);
31888 DEFVAR_LISP ("redisplay--variables", Vredisplay__variables
,
31889 doc
: /* A hash-table of variables changing which triggers a thorough redisplay. */);
31890 Vredisplay__variables
= Qnil
;
31892 DEFVAR_BOOL ("redisplay--inhibit-bidi", redisplay__inhibit_bidi
,
31893 doc
: /* Non-nil means it is not safe to attempt bidi reordering for display. */);
31894 /* Initialize to t, since we need to disable reordering until
31895 loadup.el successfully loads charprop.el. */
31896 redisplay__inhibit_bidi
= true;
31900 /* Initialize this module when Emacs starts. */
31905 CHARPOS (this_line_start_pos
) = 0;
31907 if (!noninteractive
)
31909 struct window
*m
= XWINDOW (minibuf_window
);
31910 Lisp_Object frame
= m
->frame
;
31911 struct frame
*f
= XFRAME (frame
);
31912 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
31913 struct window
*r
= XWINDOW (root
);
31916 echo_area_window
= minibuf_window
;
31918 r
->top_line
= FRAME_TOP_MARGIN (f
);
31919 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
31920 r
->total_cols
= FRAME_COLS (f
);
31921 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31922 r
->total_lines
= FRAME_TOTAL_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
31923 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
31925 m
->top_line
= FRAME_TOTAL_LINES (f
) - 1;
31926 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
31927 m
->total_cols
= FRAME_COLS (f
);
31928 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31929 m
->total_lines
= 1;
31930 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
31932 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
31933 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
31934 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
31936 /* The default ellipsis glyphs `...'. */
31937 for (i
= 0; i
< 3; ++i
)
31938 default_invis_vector
[i
] = make_number ('.');
31942 /* Allocate the buffer for frame titles.
31943 Also used for `format-mode-line'. */
31945 mode_line_noprop_buf
= xmalloc (size
);
31946 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
31947 mode_line_noprop_ptr
= mode_line_noprop_buf
;
31948 mode_line_target
= MODE_LINE_DISPLAY
;
31951 help_echo_showing_p
= false;
31954 #ifdef HAVE_WINDOW_SYSTEM
31956 /* Platform-independent portion of hourglass implementation. */
31958 /* Timer function of hourglass_atimer. */
31961 show_hourglass (struct atimer
*timer
)
31963 /* The timer implementation will cancel this timer automatically
31964 after this function has run. Set hourglass_atimer to null
31965 so that we know the timer doesn't have to be canceled. */
31966 hourglass_atimer
= NULL
;
31968 if (!hourglass_shown_p
)
31970 Lisp_Object tail
, frame
;
31974 FOR_EACH_FRAME (tail
, frame
)
31976 struct frame
*f
= XFRAME (frame
);
31978 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31979 && FRAME_RIF (f
)->show_hourglass
)
31980 FRAME_RIF (f
)->show_hourglass (f
);
31983 hourglass_shown_p
= true;
31988 /* Cancel a currently active hourglass timer, and start a new one. */
31991 start_hourglass (void)
31993 struct timespec delay
;
31995 cancel_hourglass ();
31997 if (INTEGERP (Vhourglass_delay
)
31998 && XINT (Vhourglass_delay
) > 0)
31999 delay
= make_timespec (min (XINT (Vhourglass_delay
),
32000 TYPE_MAXIMUM (time_t)),
32002 else if (FLOATP (Vhourglass_delay
)
32003 && XFLOAT_DATA (Vhourglass_delay
) > 0)
32004 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
32006 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
32008 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
32009 show_hourglass
, NULL
);
32012 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
32016 cancel_hourglass (void)
32018 if (hourglass_atimer
)
32020 cancel_atimer (hourglass_atimer
);
32021 hourglass_atimer
= NULL
;
32024 if (hourglass_shown_p
)
32026 Lisp_Object tail
, frame
;
32030 FOR_EACH_FRAME (tail
, frame
)
32032 struct frame
*f
= XFRAME (frame
);
32034 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
32035 && FRAME_RIF (f
)->hide_hourglass
)
32036 FRAME_RIF (f
)->hide_hourglass (f
);
32038 /* No cursors on non GUI frames - restore to stock arrow cursor. */
32039 else if (!FRAME_W32_P (f
))
32040 w32_arrow_cursor ();
32044 hourglass_shown_p
= false;
32049 #endif /* HAVE_WINDOW_SYSTEM */