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
;
9044 prev_method
= it
->method
;
9045 if (it
->method
== GET_FROM_BUFFER
)
9046 prev_pos
= IT_CHARPOS (*it
);
9047 /* The current display element has been consumed. Advance
9049 set_iterator_to_next (it
, true);
9050 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
9051 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
9052 if (IT_CHARPOS (*it
) < to_charpos
)
9053 saw_smaller_pos
= true;
9055 && (op
& MOVE_TO_POS
)
9056 && IT_CHARPOS (*it
) >= to_charpos
9057 && IT_CHARPOS (*it
) < closest_pos
)
9058 closest_pos
= IT_CHARPOS (*it
);
9060 /* Stop if lines are truncated and IT's current x-position is
9061 past the right edge of the window now. */
9062 if (it
->line_wrap
== TRUNCATE
9063 && it
->current_x
>= it
->last_visible_x
)
9065 if (!FRAME_WINDOW_P (it
->f
)
9066 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
9067 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
9068 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
9069 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
9071 bool at_eob_p
= false;
9073 if ((at_eob_p
= !get_next_display_element (it
))
9074 || BUFFER_POS_REACHED_P ()
9075 /* If we are past TO_CHARPOS, but never saw any
9076 character positions smaller than TO_CHARPOS,
9077 return MOVE_POS_MATCH_OR_ZV, like the
9078 unidirectional display did. */
9079 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
9081 && IT_CHARPOS (*it
) > to_charpos
))
9084 && !BUFFER_POS_REACHED_P ()
9085 && !at_eob_p
&& closest_pos
< ZV
)
9087 RESTORE_IT (it
, &ppos_it
, ppos_data
);
9088 if (closest_pos
!= to_charpos
)
9089 move_it_in_display_line_to (it
, closest_pos
, -1,
9092 result
= MOVE_POS_MATCH_OR_ZV
;
9095 if (ITERATOR_AT_END_OF_LINE_P (it
))
9097 result
= MOVE_NEWLINE_OR_CR
;
9101 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
9103 && IT_CHARPOS (*it
) > to_charpos
)
9105 if (closest_pos
< ZV
)
9107 RESTORE_IT (it
, &ppos_it
, ppos_data
);
9108 if (closest_pos
!= to_charpos
)
9109 move_it_in_display_line_to (it
, closest_pos
, -1,
9112 result
= MOVE_POS_MATCH_OR_ZV
;
9115 result
= MOVE_LINE_TRUNCATED
;
9118 #undef IT_RESET_X_ASCENT_DESCENT
9121 #undef BUFFER_POS_REACHED_P
9123 /* If we scanned beyond TO_POS, restore the saved iterator either to
9124 the wrap point (if found), or to atpos/atx location. We decide which
9125 data to use to restore the saved iterator state by their X coordinates,
9126 since buffer positions might increase non-monotonically with screen
9127 coordinates due to bidi reordering. */
9128 if (result
== MOVE_LINE_CONTINUED
9129 && it
->line_wrap
== WORD_WRAP
9131 && ((atpos_it
.sp
>= 0 && wrap_it
.current_x
< atpos_it
.current_x
)
9132 || (atx_it
.sp
>= 0 && wrap_it
.current_x
< atx_it
.current_x
)))
9133 RESTORE_IT (it
, &wrap_it
, wrap_data
);
9134 else if (atpos_it
.sp
>= 0)
9135 RESTORE_IT (it
, &atpos_it
, atpos_data
);
9136 else if (atx_it
.sp
>= 0)
9137 RESTORE_IT (it
, &atx_it
, atx_data
);
9142 bidi_unshelve_cache (atpos_data
, true);
9144 bidi_unshelve_cache (atx_data
, true);
9146 bidi_unshelve_cache (wrap_data
, true);
9148 bidi_unshelve_cache (ppos_data
, true);
9150 /* Restore the iterator settings altered at the beginning of this
9152 it
->glyph_row
= saved_glyph_row
;
9156 /* For external use. */
9158 move_it_in_display_line (struct it
*it
,
9159 ptrdiff_t to_charpos
, int to_x
,
9160 enum move_operation_enum op
)
9162 if (it
->line_wrap
== WORD_WRAP
9163 && (op
& MOVE_TO_X
))
9166 void *save_data
= NULL
;
9169 SAVE_IT (save_it
, *it
, save_data
);
9170 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9171 /* When word-wrap is on, TO_X may lie past the end
9172 of a wrapped line. Then it->current is the
9173 character on the next line, so backtrack to the
9174 space before the wrap point. */
9175 if (skip
== MOVE_LINE_CONTINUED
)
9177 int prev_x
= max (it
->current_x
- 1, 0);
9178 RESTORE_IT (it
, &save_it
, save_data
);
9179 move_it_in_display_line_to
9180 (it
, -1, prev_x
, MOVE_TO_X
);
9183 bidi_unshelve_cache (save_data
, true);
9186 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9190 /* Move IT forward until it satisfies one or more of the criteria in
9191 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9193 OP is a bit-mask that specifies where to stop, and in particular,
9194 which of those four position arguments makes a difference. See the
9195 description of enum move_operation_enum.
9197 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9198 screen line, this function will set IT to the next position that is
9199 displayed to the right of TO_CHARPOS on the screen.
9201 Return the maximum pixel length of any line scanned but never more
9202 than it.last_visible_x. */
9205 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9207 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9208 int line_height
, line_start_x
= 0, reached
= 0;
9209 int max_current_x
= 0;
9210 void *backup_data
= NULL
;
9214 if (op
& MOVE_TO_VPOS
)
9216 /* If no TO_CHARPOS and no TO_X specified, stop at the
9217 start of the line TO_VPOS. */
9218 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9220 if (it
->vpos
== to_vpos
)
9226 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9230 /* TO_VPOS >= 0 means stop at TO_X in the line at
9231 TO_VPOS, or at TO_POS, whichever comes first. */
9232 if (it
->vpos
== to_vpos
)
9238 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9240 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9245 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9247 /* We have reached TO_X but not in the line we want. */
9248 skip
= move_it_in_display_line_to (it
, to_charpos
,
9250 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9258 else if (op
& MOVE_TO_Y
)
9260 struct it it_backup
;
9262 if (it
->line_wrap
== WORD_WRAP
)
9263 SAVE_IT (it_backup
, *it
, backup_data
);
9265 /* TO_Y specified means stop at TO_X in the line containing
9266 TO_Y---or at TO_CHARPOS if this is reached first. The
9267 problem is that we can't really tell whether the line
9268 contains TO_Y before we have completely scanned it, and
9269 this may skip past TO_X. What we do is to first scan to
9272 If TO_X is not specified, use a TO_X of zero. The reason
9273 is to make the outcome of this function more predictable.
9274 If we didn't use TO_X == 0, we would stop at the end of
9275 the line which is probably not what a caller would expect
9277 skip
= move_it_in_display_line_to
9278 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9279 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9281 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9282 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9284 else if (skip
== MOVE_X_REACHED
)
9286 /* If TO_X was reached, we want to know whether TO_Y is
9287 in the line. We know this is the case if the already
9288 scanned glyphs make the line tall enough. Otherwise,
9289 we must check by scanning the rest of the line. */
9290 line_height
= it
->max_ascent
+ it
->max_descent
;
9291 if (to_y
>= it
->current_y
9292 && to_y
< it
->current_y
+ line_height
)
9297 SAVE_IT (it_backup
, *it
, backup_data
);
9298 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9299 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9301 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9302 line_height
= it
->max_ascent
+ it
->max_descent
;
9303 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9305 if (to_y
>= it
->current_y
9306 && to_y
< it
->current_y
+ line_height
)
9308 /* If TO_Y is in this line and TO_X was reached
9309 above, we scanned too far. We have to restore
9310 IT's settings to the ones before skipping. But
9311 keep the more accurate values of max_ascent and
9312 max_descent we've found while skipping the rest
9313 of the line, for the sake of callers, such as
9314 pos_visible_p, that need to know the line
9316 int max_ascent
= it
->max_ascent
;
9317 int max_descent
= it
->max_descent
;
9319 RESTORE_IT (it
, &it_backup
, backup_data
);
9320 it
->max_ascent
= max_ascent
;
9321 it
->max_descent
= max_descent
;
9327 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9333 /* Check whether TO_Y is in this line. */
9334 line_height
= it
->max_ascent
+ it
->max_descent
;
9335 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9337 if (to_y
>= it
->current_y
9338 && to_y
< it
->current_y
+ line_height
)
9340 if (to_y
> it
->current_y
)
9341 max_current_x
= max (it
->current_x
, max_current_x
);
9343 /* When word-wrap is on, TO_X may lie past the end
9344 of a wrapped line. Then it->current is the
9345 character on the next line, so backtrack to the
9346 space before the wrap point. */
9347 if (skip
== MOVE_LINE_CONTINUED
9348 && it
->line_wrap
== WORD_WRAP
)
9350 int prev_x
= max (it
->current_x
- 1, 0);
9351 RESTORE_IT (it
, &it_backup
, backup_data
);
9352 skip
= move_it_in_display_line_to
9353 (it
, -1, prev_x
, MOVE_TO_X
);
9362 max_current_x
= max (it
->current_x
, max_current_x
);
9366 else if (BUFFERP (it
->object
)
9367 && (it
->method
== GET_FROM_BUFFER
9368 || it
->method
== GET_FROM_STRETCH
)
9369 && IT_CHARPOS (*it
) >= to_charpos
9370 /* Under bidi iteration, a call to set_iterator_to_next
9371 can scan far beyond to_charpos if the initial
9372 portion of the next line needs to be reordered. In
9373 that case, give move_it_in_display_line_to another
9376 && it
->bidi_it
.scan_dir
== -1))
9377 skip
= MOVE_POS_MATCH_OR_ZV
;
9379 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9383 case MOVE_POS_MATCH_OR_ZV
:
9384 max_current_x
= max (it
->current_x
, max_current_x
);
9388 case MOVE_NEWLINE_OR_CR
:
9389 max_current_x
= max (it
->current_x
, max_current_x
);
9390 set_iterator_to_next (it
, true);
9391 it
->continuation_lines_width
= 0;
9394 case MOVE_LINE_TRUNCATED
:
9395 max_current_x
= it
->last_visible_x
;
9396 it
->continuation_lines_width
= 0;
9397 reseat_at_next_visible_line_start (it
, false);
9398 if ((op
& MOVE_TO_POS
) != 0
9399 && IT_CHARPOS (*it
) > to_charpos
)
9406 case MOVE_LINE_CONTINUED
:
9407 max_current_x
= it
->last_visible_x
;
9408 /* For continued lines ending in a tab, some of the glyphs
9409 associated with the tab are displayed on the current
9410 line. Since it->current_x does not include these glyphs,
9411 we use it->last_visible_x instead. */
9414 it
->continuation_lines_width
+= it
->last_visible_x
;
9415 /* When moving by vpos, ensure that the iterator really
9416 advances to the next line (bug#847, bug#969). Fixme:
9417 do we need to do this in other circumstances? */
9418 if (it
->current_x
!= it
->last_visible_x
9419 && (op
& MOVE_TO_VPOS
)
9420 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9422 line_start_x
= it
->current_x
+ it
->pixel_width
9423 - it
->last_visible_x
;
9424 if (FRAME_WINDOW_P (it
->f
))
9426 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9427 struct font
*face_font
= face
->font
;
9429 /* When display_line produces a continued line
9430 that ends in a TAB, it skips a tab stop that
9431 is closer than the font's space character
9432 width (see x_produce_glyphs where it produces
9433 the stretch glyph which represents a TAB).
9434 We need to reproduce the same logic here. */
9435 eassert (face_font
);
9438 if (line_start_x
< face_font
->space_width
)
9440 += it
->tab_width
* face_font
->space_width
;
9443 set_iterator_to_next (it
, false);
9447 it
->continuation_lines_width
+= it
->current_x
;
9454 /* Reset/increment for the next run. */
9455 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9456 it
->current_x
= line_start_x
;
9459 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9461 last_height
= it
->max_ascent
+ it
->max_descent
;
9462 it
->max_ascent
= it
->max_descent
= 0;
9467 /* On text terminals, we may stop at the end of a line in the middle
9468 of a multi-character glyph. If the glyph itself is continued,
9469 i.e. it is actually displayed on the next line, don't treat this
9470 stopping point as valid; move to the next line instead (unless
9471 that brings us offscreen). */
9472 if (!FRAME_WINDOW_P (it
->f
)
9474 && IT_CHARPOS (*it
) == to_charpos
9475 && it
->what
== IT_CHARACTER
9477 && it
->line_wrap
== WINDOW_WRAP
9478 && it
->current_x
== it
->last_visible_x
- 1
9481 && it
->w
->window_end_valid
9482 && it
->vpos
< it
->w
->window_end_vpos
)
9484 it
->continuation_lines_width
+= it
->current_x
;
9485 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9486 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9488 last_height
= it
->max_ascent
+ it
->max_descent
;
9492 bidi_unshelve_cache (backup_data
, true);
9494 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9496 return max_current_x
;
9500 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9502 If DY > 0, move IT backward at least that many pixels. DY = 0
9503 means move IT backward to the preceding line start or BEGV. This
9504 function may move over more than DY pixels if IT->current_y - DY
9505 ends up in the middle of a line; in this case IT->current_y will be
9506 set to the top of the line moved to. */
9509 move_it_vertically_backward (struct it
*it
, int dy
)
9513 void *it2data
= NULL
, *it3data
= NULL
;
9514 ptrdiff_t start_pos
;
9516 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9517 ptrdiff_t pos_limit
;
9522 start_pos
= IT_CHARPOS (*it
);
9524 /* Estimate how many newlines we must move back. */
9525 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9526 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9529 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9531 /* Set the iterator's position that many lines back. But don't go
9532 back more than NLINES full screen lines -- this wins a day with
9533 buffers which have very long lines. */
9534 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9535 back_to_previous_visible_line_start (it
);
9537 /* Reseat the iterator here. When moving backward, we don't want
9538 reseat to skip forward over invisible text, set up the iterator
9539 to deliver from overlay strings at the new position etc. So,
9540 use reseat_1 here. */
9541 reseat_1 (it
, it
->current
.pos
, true);
9543 /* We are now surely at a line start. */
9544 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9545 reordering is in effect. */
9546 it
->continuation_lines_width
= 0;
9548 /* Move forward and see what y-distance we moved. First move to the
9549 start of the next line so that we get its height. We need this
9550 height to be able to tell whether we reached the specified
9552 SAVE_IT (it2
, *it
, it2data
);
9553 it2
.max_ascent
= it2
.max_descent
= 0;
9556 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9557 MOVE_TO_POS
| MOVE_TO_VPOS
);
9559 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9560 /* If we are in a display string which starts at START_POS,
9561 and that display string includes a newline, and we are
9562 right after that newline (i.e. at the beginning of a
9563 display line), exit the loop, because otherwise we will
9564 infloop, since move_it_to will see that it is already at
9565 START_POS and will not move. */
9566 || (it2
.method
== GET_FROM_STRING
9567 && IT_CHARPOS (it2
) == start_pos
9568 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9569 eassert (IT_CHARPOS (*it
) >= BEGV
);
9570 SAVE_IT (it3
, it2
, it3data
);
9572 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9573 eassert (IT_CHARPOS (*it
) >= BEGV
);
9574 /* H is the actual vertical distance from the position in *IT
9575 and the starting position. */
9576 h
= it2
.current_y
- it
->current_y
;
9577 /* NLINES is the distance in number of lines. */
9578 nlines
= it2
.vpos
- it
->vpos
;
9580 /* Correct IT's y and vpos position
9581 so that they are relative to the starting point. */
9587 /* DY == 0 means move to the start of the screen line. The
9588 value of nlines is > 0 if continuation lines were involved,
9589 or if the original IT position was at start of a line. */
9590 RESTORE_IT (it
, it
, it2data
);
9592 move_it_by_lines (it
, nlines
);
9593 /* The above code moves us to some position NLINES down,
9594 usually to its first glyph (leftmost in an L2R line), but
9595 that's not necessarily the start of the line, under bidi
9596 reordering. We want to get to the character position
9597 that is immediately after the newline of the previous
9600 && !it
->continuation_lines_width
9601 && !STRINGP (it
->string
)
9602 && IT_CHARPOS (*it
) > BEGV
9603 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9605 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9608 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9609 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9611 bidi_unshelve_cache (it3data
, true);
9615 /* The y-position we try to reach, relative to *IT.
9616 Note that H has been subtracted in front of the if-statement. */
9617 int target_y
= it
->current_y
+ h
- dy
;
9618 int y0
= it3
.current_y
;
9622 RESTORE_IT (&it3
, &it3
, it3data
);
9623 y1
= line_bottom_y (&it3
);
9624 line_height
= y1
- y0
;
9625 RESTORE_IT (it
, it
, it2data
);
9626 /* If we did not reach target_y, try to move further backward if
9627 we can. If we moved too far backward, try to move forward. */
9628 if (target_y
< it
->current_y
9629 /* This is heuristic. In a window that's 3 lines high, with
9630 a line height of 13 pixels each, recentering with point
9631 on the bottom line will try to move -39/2 = 19 pixels
9632 backward. Try to avoid moving into the first line. */
9633 && (it
->current_y
- target_y
9634 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9635 && IT_CHARPOS (*it
) > BEGV
)
9637 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9638 target_y
- it
->current_y
));
9639 dy
= it
->current_y
- target_y
;
9640 goto move_further_back
;
9642 else if (target_y
>= it
->current_y
+ line_height
9643 && IT_CHARPOS (*it
) < ZV
)
9645 /* Should move forward by at least one line, maybe more.
9647 Note: Calling move_it_by_lines can be expensive on
9648 terminal frames, where compute_motion is used (via
9649 vmotion) to do the job, when there are very long lines
9650 and truncate-lines is nil. That's the reason for
9651 treating terminal frames specially here. */
9653 if (!FRAME_WINDOW_P (it
->f
))
9654 move_it_vertically (it
, target_y
- it
->current_y
);
9659 move_it_by_lines (it
, 1);
9661 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9668 /* Move IT by a specified amount of pixel lines DY. DY negative means
9669 move backwards. DY = 0 means move to start of screen line. At the
9670 end, IT will be on the start of a screen line. */
9673 move_it_vertically (struct it
*it
, int dy
)
9676 move_it_vertically_backward (it
, -dy
);
9679 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9680 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9681 MOVE_TO_POS
| MOVE_TO_Y
);
9682 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9684 /* If buffer ends in ZV without a newline, move to the start of
9685 the line to satisfy the post-condition. */
9686 if (IT_CHARPOS (*it
) == ZV
9688 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9689 move_it_by_lines (it
, 0);
9694 /* Move iterator IT past the end of the text line it is in. */
9697 move_it_past_eol (struct it
*it
)
9699 enum move_it_result rc
;
9701 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9702 if (rc
== MOVE_NEWLINE_OR_CR
)
9703 set_iterator_to_next (it
, false);
9707 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9708 negative means move up. DVPOS == 0 means move to the start of the
9711 Optimization idea: If we would know that IT->f doesn't use
9712 a face with proportional font, we could be faster for
9713 truncate-lines nil. */
9716 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9719 /* The commented-out optimization uses vmotion on terminals. This
9720 gives bad results, because elements like it->what, on which
9721 callers such as pos_visible_p rely, aren't updated. */
9722 /* struct position pos;
9723 if (!FRAME_WINDOW_P (it->f))
9725 struct text_pos textpos;
9727 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9728 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9729 reseat (it, textpos, true);
9730 it->vpos += pos.vpos;
9731 it->current_y += pos.vpos;
9737 /* DVPOS == 0 means move to the start of the screen line. */
9738 move_it_vertically_backward (it
, 0);
9739 /* Let next call to line_bottom_y calculate real line height. */
9744 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9745 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9747 /* Only move to the next buffer position if we ended up in a
9748 string from display property, not in an overlay string
9749 (before-string or after-string). That is because the
9750 latter don't conceal the underlying buffer position, so
9751 we can ask to move the iterator to the exact position we
9752 are interested in. Note that, even if we are already at
9753 IT_CHARPOS (*it), the call below is not a no-op, as it
9754 will detect that we are at the end of the string, pop the
9755 iterator, and compute it->current_x and it->hpos
9757 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9758 -1, -1, -1, MOVE_TO_POS
);
9764 void *it2data
= NULL
;
9765 ptrdiff_t start_charpos
, i
;
9767 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9768 bool hit_pos_limit
= false;
9769 ptrdiff_t pos_limit
;
9771 /* Start at the beginning of the screen line containing IT's
9772 position. This may actually move vertically backwards,
9773 in case of overlays, so adjust dvpos accordingly. */
9775 move_it_vertically_backward (it
, 0);
9778 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9779 screen lines, and reseat the iterator there. */
9780 start_charpos
= IT_CHARPOS (*it
);
9781 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9784 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9786 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9787 back_to_previous_visible_line_start (it
);
9788 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9789 hit_pos_limit
= true;
9790 reseat (it
, it
->current
.pos
, true);
9792 /* Move further back if we end up in a string or an image. */
9793 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9795 /* First try to move to start of display line. */
9797 move_it_vertically_backward (it
, 0);
9799 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9801 /* If start of line is still in string or image,
9802 move further back. */
9803 back_to_previous_visible_line_start (it
);
9804 reseat (it
, it
->current
.pos
, true);
9808 it
->current_x
= it
->hpos
= 0;
9810 /* Above call may have moved too far if continuation lines
9811 are involved. Scan forward and see if it did. */
9812 SAVE_IT (it2
, *it
, it2data
);
9813 it2
.vpos
= it2
.current_y
= 0;
9814 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9815 it
->vpos
-= it2
.vpos
;
9816 it
->current_y
-= it2
.current_y
;
9817 it
->current_x
= it
->hpos
= 0;
9819 /* If we moved too far back, move IT some lines forward. */
9820 if (it2
.vpos
> -dvpos
)
9822 int delta
= it2
.vpos
+ dvpos
;
9824 RESTORE_IT (&it2
, &it2
, it2data
);
9825 SAVE_IT (it2
, *it
, it2data
);
9826 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9827 /* Move back again if we got too far ahead. */
9828 if (IT_CHARPOS (*it
) >= start_charpos
)
9829 RESTORE_IT (it
, &it2
, it2data
);
9831 bidi_unshelve_cache (it2data
, true);
9833 else if (hit_pos_limit
&& pos_limit
> BEGV
9834 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9836 /* If we hit the limit, but still didn't make it far enough
9837 back, that means there's a display string with a newline
9838 covering a large chunk of text, and that caused
9839 back_to_previous_visible_line_start try to go too far.
9840 Punish those who commit such atrocities by going back
9841 until we've reached DVPOS, after lifting the limit, which
9842 could make it slow for very long lines. "If it hurts,
9845 RESTORE_IT (it
, it
, it2data
);
9846 for (i
= -dvpos
; i
> 0; --i
)
9848 back_to_previous_visible_line_start (it
);
9851 reseat_1 (it
, it
->current
.pos
, true);
9854 RESTORE_IT (it
, it
, it2data
);
9858 /* Return true if IT points into the middle of a display vector. */
9861 in_display_vector_p (struct it
*it
)
9863 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9864 && it
->current
.dpvec_index
> 0
9865 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9868 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9869 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9870 WINDOW must be a live window and defaults to the selected one. The
9871 return value is a cons of the maximum pixel-width of any text line and
9872 the maximum pixel-height of all text lines.
9874 The optional argument FROM, if non-nil, specifies the first text
9875 position and defaults to the minimum accessible position of the buffer.
9876 If FROM is t, use the minimum accessible position that starts a
9877 non-empty line. TO, if non-nil, specifies the last text position and
9878 defaults to the maximum accessible position of the buffer. If TO is t,
9879 use the maximum accessible position that ends a non-empty line.
9881 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9882 width that can be returned. X-LIMIT nil or omitted, means to use the
9883 pixel-width of WINDOW's body; use this if you want to know how high
9884 WINDOW should be become in order to fit all of its buffer's text with
9885 the width of WINDOW unaltered. Use the maximum width WINDOW may assume
9886 if you intend to change WINDOW's width. In any case, text whose
9887 x-coordinate is beyond X-LIMIT is ignored. Since calculating the width
9888 of long lines can take some time, it's always a good idea to make this
9889 argument as small as possible; in particular, if the buffer contains
9890 long lines that shall be truncated anyway.
9892 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9893 height (excluding the height of the mode- or header-line, if any) that
9894 can be returned. Text lines whose y-coordinate is beyond Y-LIMIT are
9895 ignored. Since calculating the text height of a large buffer can take
9896 some time, it makes sense to specify this argument if the size of the
9897 buffer is large or unknown.
9899 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9900 include the height of the mode- or header-line of WINDOW in the return
9901 value. If it is either the symbol `mode-line' or `header-line', include
9902 only the height of that line, if present, in the return value. If t,
9903 include the height of both, if present, in the return value. */)
9904 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
,
9905 Lisp_Object y_limit
, Lisp_Object mode_and_header_line
)
9907 struct window
*w
= decode_live_window (window
);
9908 Lisp_Object buffer
= w
->contents
;
9911 struct buffer
*old_b
= NULL
;
9912 ptrdiff_t start
, end
, pos
;
9913 struct text_pos startp
;
9914 void *itdata
= NULL
;
9915 int c
, max_x
= 0, max_y
= 0, x
= 0, y
= 0;
9917 CHECK_BUFFER (buffer
);
9918 b
= XBUFFER (buffer
);
9920 if (b
!= current_buffer
)
9922 old_b
= current_buffer
;
9923 set_buffer_internal (b
);
9928 else if (EQ (from
, Qt
))
9931 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9932 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9934 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9939 CHECK_NUMBER_COERCE_MARKER (from
);
9940 start
= min (max (XINT (from
), BEGV
), ZV
);
9945 else if (EQ (to
, Qt
))
9948 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9949 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9951 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9956 CHECK_NUMBER_COERCE_MARKER (to
);
9957 end
= max (start
, min (XINT (to
), ZV
));
9960 if (!NILP (x_limit
) && RANGED_INTEGERP (0, x_limit
, INT_MAX
))
9961 max_x
= XINT (x_limit
);
9965 else if (RANGED_INTEGERP (0, y_limit
, INT_MAX
))
9966 max_y
= XINT (y_limit
);
9968 itdata
= bidi_shelve_cache ();
9969 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9970 start_display (&it
, w
, startp
);
9973 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9976 it
.last_visible_x
= max_x
;
9977 /* Actually, we never want move_it_to stop at to_x. But to make
9978 sure that move_it_in_display_line_to always moves far enough,
9979 we set it to INT_MAX and specify MOVE_TO_X. Also bound width
9980 value by X-LIMIT. */
9981 x
= min (move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9982 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
),
9986 /* Subtract height of header-line which was counted automatically by
9988 y
= min (it
.current_y
+ it
.max_ascent
+ it
.max_descent
9989 - WINDOW_HEADER_LINE_HEIGHT (w
),
9992 if (EQ (mode_and_header_line
, Qheader_line
)
9993 || EQ (mode_and_header_line
, Qt
))
9994 /* Re-add height of header-line as requested. */
9995 y
= y
+ WINDOW_HEADER_LINE_HEIGHT (w
);
9997 if (EQ (mode_and_header_line
, Qmode_line
)
9998 || EQ (mode_and_header_line
, Qt
))
9999 /* Add height of mode-line as requested. */
10000 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
10002 bidi_unshelve_cache (itdata
, false);
10005 set_buffer_internal (old_b
);
10007 return Fcons (make_number (x
), make_number (y
));
10010 /***********************************************************************
10012 ***********************************************************************/
10014 /* Return the number of arguments the format string FORMAT needs. */
10017 format_nargs (char const *format
)
10019 ptrdiff_t nargs
= 0;
10020 for (char const *p
= format
; (p
= strchr (p
, '%')); p
++)
10028 /* Add a message with format string FORMAT and formatted arguments
10032 add_to_log (const char *format
, ...)
10035 va_start (ap
, format
);
10036 vadd_to_log (format
, ap
);
10041 vadd_to_log (char const *format
, va_list ap
)
10043 ptrdiff_t form_nargs
= format_nargs (format
);
10044 ptrdiff_t nargs
= 1 + form_nargs
;
10045 Lisp_Object args
[10];
10046 eassert (nargs
<= ARRAYELTS (args
));
10047 AUTO_STRING (args0
, format
);
10049 for (ptrdiff_t i
= 1; i
<= nargs
; i
++)
10050 args
[i
] = va_arg (ap
, Lisp_Object
);
10051 Lisp_Object msg
= Qnil
;
10052 msg
= Fformat_message (nargs
, args
);
10054 ptrdiff_t len
= SBYTES (msg
) + 1;
10056 char *buffer
= SAFE_ALLOCA (len
);
10057 memcpy (buffer
, SDATA (msg
), len
);
10059 message_dolog (buffer
, len
- 1, true, STRING_MULTIBYTE (msg
));
10064 /* Output a newline in the *Messages* buffer if "needs" one. */
10067 message_log_maybe_newline (void)
10069 if (message_log_need_newline
)
10070 message_dolog ("", 0, true, false);
10074 /* Add a string M of length NBYTES to the message log, optionally
10075 terminated with a newline when NLFLAG is true. MULTIBYTE, if
10076 true, means interpret the contents of M as multibyte. This
10077 function calls low-level routines in order to bypass text property
10078 hooks, etc. which might not be safe to run.
10080 This may GC (insert may run before/after change hooks),
10081 so the buffer M must NOT point to a Lisp string. */
10084 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
10086 const unsigned char *msg
= (const unsigned char *) m
;
10088 if (!NILP (Vmemory_full
))
10091 if (!NILP (Vmessage_log_max
))
10093 struct buffer
*oldbuf
;
10094 Lisp_Object oldpoint
, oldbegv
, oldzv
;
10095 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
10096 ptrdiff_t point_at_end
= 0;
10097 ptrdiff_t zv_at_end
= 0;
10098 Lisp_Object old_deactivate_mark
;
10100 old_deactivate_mark
= Vdeactivate_mark
;
10101 oldbuf
= current_buffer
;
10103 /* Ensure the Messages buffer exists, and switch to it.
10104 If we created it, set the major-mode. */
10105 bool newbuffer
= NILP (Fget_buffer (Vmessages_buffer_name
));
10106 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
10108 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
10109 call0 (intern ("messages-buffer-mode"));
10111 bset_undo_list (current_buffer
, Qt
);
10112 bset_cache_long_scans (current_buffer
, Qnil
);
10114 oldpoint
= message_dolog_marker1
;
10115 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
10116 oldbegv
= message_dolog_marker2
;
10117 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
10118 oldzv
= message_dolog_marker3
;
10119 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
10127 BEGV_BYTE
= BEG_BYTE
;
10130 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10132 /* Insert the string--maybe converting multibyte to single byte
10133 or vice versa, so that all the text fits the buffer. */
10135 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10141 /* Convert a multibyte string to single-byte
10142 for the *Message* buffer. */
10143 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
10145 c
= string_char_and_length (msg
+ i
, &char_bytes
);
10146 work
[0] = CHAR_TO_BYTE8 (c
);
10147 insert_1_both (work
, 1, 1, true, false, false);
10150 else if (! multibyte
10151 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10155 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10156 /* Convert a single-byte string to multibyte
10157 for the *Message* buffer. */
10158 for (i
= 0; i
< nbytes
; i
++)
10161 MAKE_CHAR_MULTIBYTE (c
);
10162 char_bytes
= CHAR_STRING (c
, str
);
10163 insert_1_both ((char *) str
, 1, char_bytes
, true, false, false);
10167 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
,
10168 true, false, false);
10172 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
10175 insert_1_both ("\n", 1, 1, true, false, false);
10177 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, false);
10179 this_bol_byte
= PT_BYTE
;
10181 /* See if this line duplicates the previous one.
10182 If so, combine duplicates. */
10183 if (this_bol
> BEG
)
10185 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, false);
10187 prev_bol_byte
= PT_BYTE
;
10189 dups
= message_log_check_duplicate (prev_bol_byte
,
10193 del_range_both (prev_bol
, prev_bol_byte
,
10194 this_bol
, this_bol_byte
, false);
10197 char dupstr
[sizeof " [ times]"
10198 + INT_STRLEN_BOUND (printmax_t
)];
10200 /* If you change this format, don't forget to also
10201 change message_log_check_duplicate. */
10202 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
10203 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
10204 insert_1_both (dupstr
, duplen
, duplen
,
10205 true, false, true);
10210 /* If we have more than the desired maximum number of lines
10211 in the *Messages* buffer now, delete the oldest ones.
10212 This is safe because we don't have undo in this buffer. */
10214 if (NATNUMP (Vmessage_log_max
))
10216 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10217 -XFASTINT (Vmessage_log_max
) - 1, false);
10218 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, false);
10221 BEGV
= marker_position (oldbegv
);
10222 BEGV_BYTE
= marker_byte_position (oldbegv
);
10231 ZV
= marker_position (oldzv
);
10232 ZV_BYTE
= marker_byte_position (oldzv
);
10236 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10238 /* We can't do Fgoto_char (oldpoint) because it will run some
10240 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10241 marker_byte_position (oldpoint
));
10243 unchain_marker (XMARKER (oldpoint
));
10244 unchain_marker (XMARKER (oldbegv
));
10245 unchain_marker (XMARKER (oldzv
));
10247 /* We called insert_1_both above with its 5th argument (PREPARE)
10248 false, which prevents insert_1_both from calling
10249 prepare_to_modify_buffer, which in turns prevents us from
10250 incrementing windows_or_buffers_changed even if *Messages* is
10251 shown in some window. So we must manually set
10252 windows_or_buffers_changed here to make up for that. */
10253 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10254 bset_redisplay (current_buffer
);
10256 set_buffer_internal (oldbuf
);
10258 message_log_need_newline
= !nlflag
;
10259 Vdeactivate_mark
= old_deactivate_mark
;
10264 /* We are at the end of the buffer after just having inserted a newline.
10265 (Note: We depend on the fact we won't be crossing the gap.)
10266 Check to see if the most recent message looks a lot like the previous one.
10267 Return 0 if different, 1 if the new one should just replace it, or a
10268 value N > 1 if we should also append " [N times]". */
10271 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10274 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10275 bool seen_dots
= false;
10276 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10277 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10279 for (i
= 0; i
< len
; i
++)
10281 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10283 if (p1
[i
] != p2
[i
])
10289 if (*p1
++ == ' ' && *p1
++ == '[')
10292 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10293 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10300 /* Display an echo area message M with a specified length of NBYTES
10301 bytes. The string may include null characters. If M is not a
10302 string, clear out any existing message, and let the mini-buffer
10305 This function cancels echoing. */
10308 message3 (Lisp_Object m
)
10310 clear_message (true, true);
10313 /* First flush out any partial line written with print. */
10314 message_log_maybe_newline ();
10317 ptrdiff_t nbytes
= SBYTES (m
);
10318 bool multibyte
= STRING_MULTIBYTE (m
);
10321 SAFE_ALLOCA_STRING (buffer
, m
);
10322 message_dolog (buffer
, nbytes
, true, multibyte
);
10325 if (! inhibit_message
)
10326 message3_nolog (m
);
10329 /* Log the message M to stderr. Log an empty line if M is not a string. */
10332 message_to_stderr (Lisp_Object m
)
10334 if (noninteractive_need_newline
)
10336 noninteractive_need_newline
= false;
10337 fputc ('\n', stderr
);
10341 Lisp_Object coding_system
= Vlocale_coding_system
;
10344 if (!NILP (Vcoding_system_for_write
))
10345 coding_system
= Vcoding_system_for_write
;
10346 if (!NILP (coding_system
))
10347 s
= code_convert_string_norecord (m
, coding_system
, true);
10351 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10353 if (!cursor_in_echo_area
)
10354 fputc ('\n', stderr
);
10358 /* The non-logging version of message3.
10359 This does not cancel echoing, because it is used for echoing.
10360 Perhaps we need to make a separate function for echoing
10361 and make this cancel echoing. */
10364 message3_nolog (Lisp_Object m
)
10366 struct frame
*sf
= SELECTED_FRAME ();
10368 if (FRAME_INITIAL_P (sf
))
10369 message_to_stderr (m
);
10370 /* Error messages get reported properly by cmd_error, so this must be just an
10371 informative message; if the frame hasn't really been initialized yet, just
10373 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10375 /* Get the frame containing the mini-buffer
10376 that the selected frame is using. */
10377 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10378 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10379 struct frame
*f
= XFRAME (frame
);
10381 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10382 Fmake_frame_visible (frame
);
10384 if (STRINGP (m
) && SCHARS (m
) > 0)
10387 if (minibuffer_auto_raise
)
10388 Fraise_frame (frame
);
10389 /* Assume we are not echoing.
10390 (If we are, echo_now will override this.) */
10391 echo_message_buffer
= Qnil
;
10394 clear_message (true, true);
10396 do_pending_window_change (false);
10397 echo_area_display (true);
10398 do_pending_window_change (false);
10399 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10400 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10405 /* Display a null-terminated echo area message M. If M is 0, clear
10406 out any existing message, and let the mini-buffer text show through.
10408 The buffer M must continue to exist until after the echo area gets
10409 cleared or some other message gets displayed there. Do not pass
10410 text that is stored in a Lisp string. Do not pass text in a buffer
10411 that was alloca'd. */
10414 message1 (const char *m
)
10416 message3 (m
? build_unibyte_string (m
) : Qnil
);
10420 /* The non-logging counterpart of message1. */
10423 message1_nolog (const char *m
)
10425 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10428 /* Display a message M which contains a single %s
10429 which gets replaced with STRING. */
10432 message_with_string (const char *m
, Lisp_Object string
, bool log
)
10434 CHECK_STRING (string
);
10437 if (noninteractive
)
10438 need_message
= !!m
;
10439 else if (!INTERACTIVE
)
10440 need_message
= false;
10443 /* The frame whose minibuffer we're going to display the message on.
10444 It may be larger than the selected frame, so we need
10445 to use its buffer, not the selected frame's buffer. */
10446 Lisp_Object mini_window
;
10447 struct frame
*f
, *sf
= SELECTED_FRAME ();
10449 /* Get the frame containing the minibuffer
10450 that the selected frame is using. */
10451 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10452 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10454 /* Error messages get reported properly by cmd_error, so this must be
10455 just an informative message; if the frame hasn't really been
10456 initialized yet, just toss it. */
10457 need_message
= f
->glyphs_initialized_p
;
10462 AUTO_STRING (fmt
, m
);
10463 Lisp_Object msg
= CALLN (Fformat_message
, fmt
, string
);
10465 if (noninteractive
)
10466 message_to_stderr (msg
);
10472 message3_nolog (msg
);
10474 /* Print should start at the beginning of the message
10475 buffer next time. */
10476 message_buf_print
= false;
10482 /* Dump an informative message to the minibuf. If M is 0, clear out
10483 any existing message, and let the mini-buffer text show through.
10485 The message must be safe ASCII and the format must not contain ` or
10486 '. If your message and format do not fit into this category,
10487 convert your arguments to Lisp objects and use Fmessage instead. */
10489 static void ATTRIBUTE_FORMAT_PRINTF (1, 0)
10490 vmessage (const char *m
, va_list ap
)
10492 if (noninteractive
)
10496 if (noninteractive_need_newline
)
10497 putc ('\n', stderr
);
10498 noninteractive_need_newline
= false;
10499 vfprintf (stderr
, m
, ap
);
10500 if (!cursor_in_echo_area
)
10501 fprintf (stderr
, "\n");
10505 else if (INTERACTIVE
)
10507 /* The frame whose mini-buffer we're going to display the message
10508 on. It may be larger than the selected frame, so we need to
10509 use its buffer, not the selected frame's buffer. */
10510 Lisp_Object mini_window
;
10511 struct frame
*f
, *sf
= SELECTED_FRAME ();
10513 /* Get the frame containing the mini-buffer
10514 that the selected frame is using. */
10515 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10516 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10518 /* Error messages get reported properly by cmd_error, so this must be
10519 just an informative message; if the frame hasn't really been
10520 initialized yet, just toss it. */
10521 if (f
->glyphs_initialized_p
)
10526 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10528 char *message_buf
= SAFE_ALLOCA (maxsize
+ 1);
10530 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10532 message3 (make_string (message_buf
, len
));
10538 /* Print should start at the beginning of the message
10539 buffer next time. */
10540 message_buf_print
= false;
10546 message (const char *m
, ...)
10555 /* Display the current message in the current mini-buffer. This is
10556 only called from error handlers in process.c, and is not time
10560 update_echo_area (void)
10562 if (!NILP (echo_area_buffer
[0]))
10564 Lisp_Object string
;
10565 string
= Fcurrent_message ();
10571 /* Make sure echo area buffers in `echo_buffers' are live.
10572 If they aren't, make new ones. */
10575 ensure_echo_area_buffers (void)
10577 for (int i
= 0; i
< 2; i
++)
10578 if (!BUFFERP (echo_buffer
[i
])
10579 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10581 Lisp_Object old_buffer
= echo_buffer
[i
];
10582 static char const name_fmt
[] = " *Echo Area %d*";
10583 char name
[sizeof name_fmt
+ INT_STRLEN_BOUND (int)];
10584 AUTO_STRING_WITH_LEN (lname
, name
, sprintf (name
, name_fmt
, i
));
10585 echo_buffer
[i
] = Fget_buffer_create (lname
);
10586 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10587 /* to force word wrap in echo area -
10588 it was decided to postpone this*/
10589 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10591 for (int j
= 0; j
< 2; j
++)
10592 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10593 echo_area_buffer
[j
] = echo_buffer
[i
];
10598 /* Call FN with args A1..A2 with either the current or last displayed
10599 echo_area_buffer as current buffer.
10601 WHICH zero means use the current message buffer
10602 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10603 from echo_buffer[] and clear it.
10605 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10606 suitable buffer from echo_buffer[] and clear it.
10608 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10609 that the current message becomes the last displayed one, choose a
10610 suitable buffer for echo_area_buffer[0], and clear it.
10612 Value is what FN returns. */
10615 with_echo_area_buffer (struct window
*w
, int which
,
10616 bool (*fn
) (ptrdiff_t, Lisp_Object
),
10617 ptrdiff_t a1
, Lisp_Object a2
)
10619 Lisp_Object buffer
;
10620 bool this_one
, the_other
, clear_buffer_p
, rc
;
10621 ptrdiff_t count
= SPECPDL_INDEX ();
10623 /* If buffers aren't live, make new ones. */
10624 ensure_echo_area_buffers ();
10626 clear_buffer_p
= false;
10629 this_one
= false, the_other
= true;
10630 else if (which
> 0)
10631 this_one
= true, the_other
= false;
10634 this_one
= false, the_other
= true;
10635 clear_buffer_p
= true;
10637 /* We need a fresh one in case the current echo buffer equals
10638 the one containing the last displayed echo area message. */
10639 if (!NILP (echo_area_buffer
[this_one
])
10640 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10641 echo_area_buffer
[this_one
] = Qnil
;
10644 /* Choose a suitable buffer from echo_buffer[] if we don't
10646 if (NILP (echo_area_buffer
[this_one
]))
10648 echo_area_buffer
[this_one
]
10649 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10650 ? echo_buffer
[the_other
]
10651 : echo_buffer
[this_one
]);
10652 clear_buffer_p
= true;
10655 buffer
= echo_area_buffer
[this_one
];
10657 /* Don't get confused by reusing the buffer used for echoing
10658 for a different purpose. */
10659 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10662 record_unwind_protect (unwind_with_echo_area_buffer
,
10663 with_echo_area_buffer_unwind_data (w
));
10665 /* Make the echo area buffer current. Note that for display
10666 purposes, it is not necessary that the displayed window's buffer
10667 == current_buffer, except for text property lookup. So, let's
10668 only set that buffer temporarily here without doing a full
10669 Fset_window_buffer. We must also change w->pointm, though,
10670 because otherwise an assertions in unshow_buffer fails, and Emacs
10672 set_buffer_internal_1 (XBUFFER (buffer
));
10675 wset_buffer (w
, buffer
);
10676 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10677 set_marker_both (w
->old_pointm
, buffer
, BEG
, BEG_BYTE
);
10680 bset_undo_list (current_buffer
, Qt
);
10681 bset_read_only (current_buffer
, Qnil
);
10682 specbind (Qinhibit_read_only
, Qt
);
10683 specbind (Qinhibit_modification_hooks
, Qt
);
10685 if (clear_buffer_p
&& Z
> BEG
)
10686 del_range (BEG
, Z
);
10688 eassert (BEGV
>= BEG
);
10689 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10693 eassert (BEGV
>= BEG
);
10694 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10696 unbind_to (count
, Qnil
);
10701 /* Save state that should be preserved around the call to the function
10702 FN called in with_echo_area_buffer. */
10705 with_echo_area_buffer_unwind_data (struct window
*w
)
10708 Lisp_Object vector
, tmp
;
10710 /* Reduce consing by keeping one vector in
10711 Vwith_echo_area_save_vector. */
10712 vector
= Vwith_echo_area_save_vector
;
10713 Vwith_echo_area_save_vector
= Qnil
;
10716 vector
= Fmake_vector (make_number (11), Qnil
);
10718 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10719 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10720 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10724 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10725 ASET (vector
, i
, w
->contents
); ++i
;
10726 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10727 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10728 ASET (vector
, i
, make_number (marker_position (w
->old_pointm
))); ++i
;
10729 ASET (vector
, i
, make_number (marker_byte_position (w
->old_pointm
))); ++i
;
10730 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10731 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10736 for (; i
< end
; ++i
)
10737 ASET (vector
, i
, Qnil
);
10740 eassert (i
== ASIZE (vector
));
10745 /* Restore global state from VECTOR which was created by
10746 with_echo_area_buffer_unwind_data. */
10749 unwind_with_echo_area_buffer (Lisp_Object vector
)
10751 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10752 Vdeactivate_mark
= AREF (vector
, 1);
10753 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10755 if (WINDOWP (AREF (vector
, 3)))
10758 Lisp_Object buffer
;
10760 w
= XWINDOW (AREF (vector
, 3));
10761 buffer
= AREF (vector
, 4);
10763 wset_buffer (w
, buffer
);
10764 set_marker_both (w
->pointm
, buffer
,
10765 XFASTINT (AREF (vector
, 5)),
10766 XFASTINT (AREF (vector
, 6)));
10767 set_marker_both (w
->old_pointm
, buffer
,
10768 XFASTINT (AREF (vector
, 7)),
10769 XFASTINT (AREF (vector
, 8)));
10770 set_marker_both (w
->start
, buffer
,
10771 XFASTINT (AREF (vector
, 9)),
10772 XFASTINT (AREF (vector
, 10)));
10775 Vwith_echo_area_save_vector
= vector
;
10779 /* Set up the echo area for use by print functions. MULTIBYTE_P
10780 means we will print multibyte. */
10783 setup_echo_area_for_printing (bool multibyte_p
)
10785 /* If we can't find an echo area any more, exit. */
10786 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10787 Fkill_emacs (Qnil
);
10789 ensure_echo_area_buffers ();
10791 if (!message_buf_print
)
10793 /* A message has been output since the last time we printed.
10794 Choose a fresh echo area buffer. */
10795 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10796 echo_area_buffer
[0] = echo_buffer
[1];
10798 echo_area_buffer
[0] = echo_buffer
[0];
10800 /* Switch to that buffer and clear it. */
10801 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10802 bset_truncate_lines (current_buffer
, Qnil
);
10806 ptrdiff_t count
= SPECPDL_INDEX ();
10807 specbind (Qinhibit_read_only
, Qt
);
10808 /* Note that undo recording is always disabled. */
10809 del_range (BEG
, Z
);
10810 unbind_to (count
, Qnil
);
10812 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10814 /* Set up the buffer for the multibyteness we need. */
10816 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10817 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10819 /* Raise the frame containing the echo area. */
10820 if (minibuffer_auto_raise
)
10822 struct frame
*sf
= SELECTED_FRAME ();
10823 Lisp_Object mini_window
;
10824 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10825 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10828 message_log_maybe_newline ();
10829 message_buf_print
= true;
10833 if (NILP (echo_area_buffer
[0]))
10835 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10836 echo_area_buffer
[0] = echo_buffer
[1];
10838 echo_area_buffer
[0] = echo_buffer
[0];
10841 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10843 /* Someone switched buffers between print requests. */
10844 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10845 bset_truncate_lines (current_buffer
, Qnil
);
10851 /* Display an echo area message in window W. Value is true if W's
10852 height is changed. If display_last_displayed_message_p,
10853 display the message that was last displayed, otherwise
10854 display the current message. */
10857 display_echo_area (struct window
*w
)
10859 bool no_message_p
, window_height_changed_p
;
10861 /* Temporarily disable garbage collections while displaying the echo
10862 area. This is done because a GC can print a message itself.
10863 That message would modify the echo area buffer's contents while a
10864 redisplay of the buffer is going on, and seriously confuse
10866 ptrdiff_t count
= inhibit_garbage_collection ();
10868 /* If there is no message, we must call display_echo_area_1
10869 nevertheless because it resizes the window. But we will have to
10870 reset the echo_area_buffer in question to nil at the end because
10871 with_echo_area_buffer will sets it to an empty buffer. */
10872 bool i
= display_last_displayed_message_p
;
10873 /* According to the C99, C11 and C++11 standards, the integral value
10874 of a "bool" is always 0 or 1, so this array access is safe here,
10876 no_message_p
= NILP (echo_area_buffer
[i
]);
10878 window_height_changed_p
10879 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10880 display_echo_area_1
,
10881 (intptr_t) w
, Qnil
);
10884 echo_area_buffer
[i
] = Qnil
;
10886 unbind_to (count
, Qnil
);
10887 return window_height_changed_p
;
10891 /* Helper for display_echo_area. Display the current buffer which
10892 contains the current echo area message in window W, a mini-window,
10893 a pointer to which is passed in A1. A2..A4 are currently not used.
10894 Change the height of W so that all of the message is displayed.
10895 Value is true if height of W was changed. */
10898 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10901 struct window
*w
= (struct window
*) i1
;
10902 Lisp_Object window
;
10903 struct text_pos start
;
10905 /* We are about to enter redisplay without going through
10906 redisplay_internal, so we need to forget these faces by hand
10908 forget_escape_and_glyphless_faces ();
10910 /* Do this before displaying, so that we have a large enough glyph
10911 matrix for the display. If we can't get enough space for the
10912 whole text, display the last N lines. That works by setting w->start. */
10913 bool window_height_changed_p
= resize_mini_window (w
, false);
10915 /* Use the starting position chosen by resize_mini_window. */
10916 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10919 clear_glyph_matrix (w
->desired_matrix
);
10920 XSETWINDOW (window
, w
);
10921 try_window (window
, start
, 0);
10923 return window_height_changed_p
;
10927 /* Resize the echo area window to exactly the size needed for the
10928 currently displayed message, if there is one. If a mini-buffer
10929 is active, don't shrink it. */
10932 resize_echo_area_exactly (void)
10934 if (BUFFERP (echo_area_buffer
[0])
10935 && WINDOWP (echo_area_window
))
10937 struct window
*w
= XWINDOW (echo_area_window
);
10938 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10939 bool resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10940 (intptr_t) w
, resize_exactly
);
10943 windows_or_buffers_changed
= 42;
10944 update_mode_lines
= 30;
10945 redisplay_internal ();
10951 /* Callback function for with_echo_area_buffer, when used from
10952 resize_echo_area_exactly. A1 contains a pointer to the window to
10953 resize, EXACTLY non-nil means resize the mini-window exactly to the
10954 size of the text displayed. A3 and A4 are not used. Value is what
10955 resize_mini_window returns. */
10958 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10961 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10965 /* Resize mini-window W to fit the size of its contents. EXACT_P
10966 means size the window exactly to the size needed. Otherwise, it's
10967 only enlarged until W's buffer is empty.
10969 Set W->start to the right place to begin display. If the whole
10970 contents fit, start at the beginning. Otherwise, start so as
10971 to make the end of the contents appear. This is particularly
10972 important for y-or-n-p, but seems desirable generally.
10974 Value is true if the window height has been changed. */
10977 resize_mini_window (struct window
*w
, bool exact_p
)
10979 struct frame
*f
= XFRAME (w
->frame
);
10980 bool window_height_changed_p
= false;
10982 eassert (MINI_WINDOW_P (w
));
10984 /* By default, start display at the beginning. */
10985 set_marker_both (w
->start
, w
->contents
,
10986 BUF_BEGV (XBUFFER (w
->contents
)),
10987 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10989 /* Don't resize windows while redisplaying a window; it would
10990 confuse redisplay functions when the size of the window they are
10991 displaying changes from under them. Such a resizing can happen,
10992 for instance, when which-func prints a long message while
10993 we are running fontification-functions. We're running these
10994 functions with safe_call which binds inhibit-redisplay to t. */
10995 if (!NILP (Vinhibit_redisplay
))
10998 /* Nil means don't try to resize. */
10999 if (NILP (Vresize_mini_windows
)
11000 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
11003 if (!FRAME_MINIBUF_ONLY_P (f
))
11006 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
11007 + WINDOW_PIXEL_HEIGHT (w
));
11008 int unit
= FRAME_LINE_HEIGHT (f
);
11009 int height
, max_height
;
11010 struct text_pos start
;
11011 struct buffer
*old_current_buffer
= NULL
;
11013 if (current_buffer
!= XBUFFER (w
->contents
))
11015 old_current_buffer
= current_buffer
;
11016 set_buffer_internal (XBUFFER (w
->contents
));
11019 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
11021 /* Compute the max. number of lines specified by the user. */
11022 if (FLOATP (Vmax_mini_window_height
))
11023 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
11024 else if (INTEGERP (Vmax_mini_window_height
))
11025 max_height
= XINT (Vmax_mini_window_height
) * unit
;
11027 max_height
= total_height
/ 4;
11029 /* Correct that max. height if it's bogus. */
11030 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
11032 /* Find out the height of the text in the window. */
11033 if (it
.line_wrap
== TRUNCATE
)
11038 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
11039 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
11040 height
= it
.current_y
+ last_height
;
11042 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
11043 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
11046 /* Compute a suitable window start. */
11047 if (height
> max_height
)
11049 height
= (max_height
/ unit
) * unit
;
11050 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
11051 move_it_vertically_backward (&it
, height
- unit
);
11052 start
= it
.current
.pos
;
11055 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
11056 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
11058 if (EQ (Vresize_mini_windows
, Qgrow_only
))
11060 /* Let it grow only, until we display an empty message, in which
11061 case the window shrinks again. */
11062 if (height
> WINDOW_PIXEL_HEIGHT (w
))
11064 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11066 FRAME_WINDOWS_FROZEN (f
) = true;
11067 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
11068 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11070 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
11071 && (exact_p
|| BEGV
== ZV
))
11073 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11075 FRAME_WINDOWS_FROZEN (f
) = false;
11076 shrink_mini_window (w
, true);
11077 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11082 /* Always resize to exact size needed. */
11083 if (height
> WINDOW_PIXEL_HEIGHT (w
))
11085 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11087 FRAME_WINDOWS_FROZEN (f
) = true;
11088 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
11089 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11091 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
11093 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11095 FRAME_WINDOWS_FROZEN (f
) = false;
11096 shrink_mini_window (w
, true);
11100 FRAME_WINDOWS_FROZEN (f
) = true;
11101 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
11104 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11108 if (old_current_buffer
)
11109 set_buffer_internal (old_current_buffer
);
11112 return window_height_changed_p
;
11116 /* Value is the current message, a string, or nil if there is no
11117 current message. */
11120 current_message (void)
11124 if (!BUFFERP (echo_area_buffer
[0]))
11128 with_echo_area_buffer (0, 0, current_message_1
,
11129 (intptr_t) &msg
, Qnil
);
11131 echo_area_buffer
[0] = Qnil
;
11139 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
11142 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
11145 *msg
= make_buffer_string (BEG
, Z
, true);
11152 /* Push the current message on Vmessage_stack for later restoration
11153 by restore_message. Value is true if the current message isn't
11154 empty. This is a relatively infrequent operation, so it's not
11155 worth optimizing. */
11158 push_message (void)
11160 Lisp_Object msg
= current_message ();
11161 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
11162 return STRINGP (msg
);
11166 /* Restore message display from the top of Vmessage_stack. */
11169 restore_message (void)
11171 eassert (CONSP (Vmessage_stack
));
11172 message3_nolog (XCAR (Vmessage_stack
));
11176 /* Handler for unwind-protect calling pop_message. */
11179 pop_message_unwind (void)
11181 /* Pop the top-most entry off Vmessage_stack. */
11182 eassert (CONSP (Vmessage_stack
));
11183 Vmessage_stack
= XCDR (Vmessage_stack
);
11187 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11188 exits. If the stack is not empty, we have a missing pop_message
11192 check_message_stack (void)
11194 if (!NILP (Vmessage_stack
))
11199 /* Truncate to NCHARS what will be displayed in the echo area the next
11200 time we display it---but don't redisplay it now. */
11203 truncate_echo_area (ptrdiff_t nchars
)
11206 echo_area_buffer
[0] = Qnil
;
11207 else if (!noninteractive
11209 && !NILP (echo_area_buffer
[0]))
11211 struct frame
*sf
= SELECTED_FRAME ();
11212 /* Error messages get reported properly by cmd_error, so this must be
11213 just an informative message; if the frame hasn't really been
11214 initialized yet, just toss it. */
11215 if (sf
->glyphs_initialized_p
)
11216 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11221 /* Helper function for truncate_echo_area. Truncate the current
11222 message to at most NCHARS characters. */
11225 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11227 if (BEG
+ nchars
< Z
)
11228 del_range (BEG
+ nchars
, Z
);
11230 echo_area_buffer
[0] = Qnil
;
11234 /* Set the current message to STRING. */
11237 set_message (Lisp_Object string
)
11239 eassert (STRINGP (string
));
11241 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11243 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11244 message_buf_print
= false;
11245 help_echo_showing_p
= false;
11247 if (STRINGP (Vdebug_on_message
)
11248 && STRINGP (string
)
11249 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11250 call_debugger (list2 (Qerror
, string
));
11254 /* Helper function for set_message. First argument is ignored and second
11255 argument has the same meaning as for set_message.
11256 This function is called with the echo area buffer being current. */
11259 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11261 eassert (STRINGP (string
));
11263 /* Change multibyteness of the echo buffer appropriately. */
11264 if (message_enable_multibyte
11265 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11266 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11268 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11269 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11270 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11272 /* Insert new message at BEG. */
11273 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11275 /* This function takes care of single/multibyte conversion.
11276 We just have to ensure that the echo area buffer has the right
11277 setting of enable_multibyte_characters. */
11278 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), true);
11284 /* Clear messages. CURRENT_P means clear the current message.
11285 LAST_DISPLAYED_P means clear the message last displayed. */
11288 clear_message (bool current_p
, bool last_displayed_p
)
11292 echo_area_buffer
[0] = Qnil
;
11293 message_cleared_p
= true;
11296 if (last_displayed_p
)
11297 echo_area_buffer
[1] = Qnil
;
11299 message_buf_print
= false;
11302 /* Clear garbaged frames.
11304 This function is used where the old redisplay called
11305 redraw_garbaged_frames which in turn called redraw_frame which in
11306 turn called clear_frame. The call to clear_frame was a source of
11307 flickering. I believe a clear_frame is not necessary. It should
11308 suffice in the new redisplay to invalidate all current matrices,
11309 and ensure a complete redisplay of all windows. */
11312 clear_garbaged_frames (void)
11314 if (frame_garbaged
)
11316 Lisp_Object tail
, frame
;
11317 struct frame
*sf
= SELECTED_FRAME ();
11319 FOR_EACH_FRAME (tail
, frame
)
11321 struct frame
*f
= XFRAME (frame
);
11323 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11326 /* It makes no sense to redraw a non-selected TTY
11327 frame, since that will actually clear the
11328 selected frame, and might leave the selected
11329 frame with corrupted display, if it happens not
11330 to be marked garbaged. */
11331 && !(f
!= sf
&& (FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))))
11334 clear_current_matrices (f
);
11335 fset_redisplay (f
);
11336 f
->garbaged
= false;
11337 f
->resized_p
= false;
11341 frame_garbaged
= false;
11346 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P, update
11350 echo_area_display (bool update_frame_p
)
11352 Lisp_Object mini_window
;
11355 bool window_height_changed_p
= false;
11356 struct frame
*sf
= SELECTED_FRAME ();
11358 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11359 w
= XWINDOW (mini_window
);
11360 f
= XFRAME (WINDOW_FRAME (w
));
11362 /* Don't display if frame is invisible or not yet initialized. */
11363 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11366 #ifdef HAVE_WINDOW_SYSTEM
11367 /* When Emacs starts, selected_frame may be the initial terminal
11368 frame. If we let this through, a message would be displayed on
11370 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11372 #endif /* HAVE_WINDOW_SYSTEM */
11374 /* Redraw garbaged frames. */
11375 clear_garbaged_frames ();
11377 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11379 echo_area_window
= mini_window
;
11380 window_height_changed_p
= display_echo_area (w
);
11381 w
->must_be_updated_p
= true;
11383 /* Update the display, unless called from redisplay_internal.
11384 Also don't update the screen during redisplay itself. The
11385 update will happen at the end of redisplay, and an update
11386 here could cause confusion. */
11387 if (update_frame_p
&& !redisplaying_p
)
11391 /* If the display update has been interrupted by pending
11392 input, update mode lines in the frame. Due to the
11393 pending input, it might have been that redisplay hasn't
11394 been called, so that mode lines above the echo area are
11395 garbaged. This looks odd, so we prevent it here. */
11396 if (!display_completed
)
11397 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11399 if (window_height_changed_p
11400 /* Don't do this if Emacs is shutting down. Redisplay
11401 needs to run hooks. */
11402 && !NILP (Vrun_hooks
))
11404 /* Must update other windows. Likewise as in other
11405 cases, don't let this update be interrupted by
11407 ptrdiff_t count
= SPECPDL_INDEX ();
11408 specbind (Qredisplay_dont_pause
, Qt
);
11409 fset_redisplay (f
);
11410 redisplay_internal ();
11411 unbind_to (count
, Qnil
);
11413 else if (FRAME_WINDOW_P (f
) && n
== 0)
11415 /* Window configuration is the same as before.
11416 Can do with a display update of the echo area,
11417 unless we displayed some mode lines. */
11418 update_single_window (w
);
11422 update_frame (f
, true, true);
11424 /* If cursor is in the echo area, make sure that the next
11425 redisplay displays the minibuffer, so that the cursor will
11426 be replaced with what the minibuffer wants. */
11427 if (cursor_in_echo_area
)
11428 wset_redisplay (XWINDOW (mini_window
));
11431 else if (!EQ (mini_window
, selected_window
))
11432 wset_redisplay (XWINDOW (mini_window
));
11434 /* Last displayed message is now the current message. */
11435 echo_area_buffer
[1] = echo_area_buffer
[0];
11436 /* Inform read_char that we're not echoing. */
11437 echo_message_buffer
= Qnil
;
11439 /* Prevent redisplay optimization in redisplay_internal by resetting
11440 this_line_start_pos. This is done because the mini-buffer now
11441 displays the message instead of its buffer text. */
11442 if (EQ (mini_window
, selected_window
))
11443 CHARPOS (this_line_start_pos
) = 0;
11445 if (window_height_changed_p
)
11447 fset_redisplay (f
);
11449 /* If window configuration was changed, frames may have been
11450 marked garbaged. Clear them or we will experience
11451 surprises wrt scrolling.
11452 FIXME: How/why/when? */
11453 clear_garbaged_frames ();
11457 /* True if W's buffer was changed but not saved. */
11460 window_buffer_changed (struct window
*w
)
11462 struct buffer
*b
= XBUFFER (w
->contents
);
11464 eassert (BUFFER_LIVE_P (b
));
11466 return (BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
;
11469 /* True if W has %c in its mode line and mode line should be updated. */
11472 mode_line_update_needed (struct window
*w
)
11474 return (w
->column_number_displayed
!= -1
11475 && !(PT
== w
->last_point
&& !window_outdated (w
))
11476 && (w
->column_number_displayed
!= current_column ()));
11479 /* True if window start of W is frozen and may not be changed during
11483 window_frozen_p (struct window
*w
)
11485 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11487 Lisp_Object window
;
11489 XSETWINDOW (window
, w
);
11490 if (MINI_WINDOW_P (w
))
11492 else if (EQ (window
, selected_window
))
11494 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11495 && EQ (window
, Vminibuf_scroll_window
))
11496 /* This special window can't be frozen too. */
11504 /***********************************************************************
11505 Mode Lines and Frame Titles
11506 ***********************************************************************/
11508 /* A buffer for constructing non-propertized mode-line strings and
11509 frame titles in it; allocated from the heap in init_xdisp and
11510 resized as needed in store_mode_line_noprop_char. */
11512 static char *mode_line_noprop_buf
;
11514 /* The buffer's end, and a current output position in it. */
11516 static char *mode_line_noprop_buf_end
;
11517 static char *mode_line_noprop_ptr
;
11519 #define MODE_LINE_NOPROP_LEN(start) \
11520 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11523 MODE_LINE_DISPLAY
= 0,
11527 } mode_line_target
;
11529 /* Alist that caches the results of :propertize.
11530 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11531 static Lisp_Object mode_line_proptrans_alist
;
11533 /* List of strings making up the mode-line. */
11534 static Lisp_Object mode_line_string_list
;
11536 /* Base face property when building propertized mode line string. */
11537 static Lisp_Object mode_line_string_face
;
11538 static Lisp_Object mode_line_string_face_prop
;
11541 /* Unwind data for mode line strings */
11543 static Lisp_Object Vmode_line_unwind_vector
;
11546 format_mode_line_unwind_data (struct frame
*target_frame
,
11547 struct buffer
*obuf
,
11549 bool save_proptrans
)
11551 Lisp_Object vector
, tmp
;
11553 /* Reduce consing by keeping one vector in
11554 Vwith_echo_area_save_vector. */
11555 vector
= Vmode_line_unwind_vector
;
11556 Vmode_line_unwind_vector
= Qnil
;
11559 vector
= Fmake_vector (make_number (10), Qnil
);
11561 ASET (vector
, 0, make_number (mode_line_target
));
11562 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11563 ASET (vector
, 2, mode_line_string_list
);
11564 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11565 ASET (vector
, 4, mode_line_string_face
);
11566 ASET (vector
, 5, mode_line_string_face_prop
);
11569 XSETBUFFER (tmp
, obuf
);
11572 ASET (vector
, 6, tmp
);
11573 ASET (vector
, 7, owin
);
11576 /* Similarly to `with-selected-window', if the operation selects
11577 a window on another frame, we must restore that frame's
11578 selected window, and (for a tty) the top-frame. */
11579 ASET (vector
, 8, target_frame
->selected_window
);
11580 if (FRAME_TERMCAP_P (target_frame
))
11581 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11588 unwind_format_mode_line (Lisp_Object vector
)
11590 Lisp_Object old_window
= AREF (vector
, 7);
11591 Lisp_Object target_frame_window
= AREF (vector
, 8);
11592 Lisp_Object old_top_frame
= AREF (vector
, 9);
11594 mode_line_target
= XINT (AREF (vector
, 0));
11595 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11596 mode_line_string_list
= AREF (vector
, 2);
11597 if (! EQ (AREF (vector
, 3), Qt
))
11598 mode_line_proptrans_alist
= AREF (vector
, 3);
11599 mode_line_string_face
= AREF (vector
, 4);
11600 mode_line_string_face_prop
= AREF (vector
, 5);
11602 /* Select window before buffer, since it may change the buffer. */
11603 if (!NILP (old_window
))
11605 /* If the operation that we are unwinding had selected a window
11606 on a different frame, reset its frame-selected-window. For a
11607 text terminal, reset its top-frame if necessary. */
11608 if (!NILP (target_frame_window
))
11611 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11613 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11614 Fselect_window (target_frame_window
, Qt
);
11616 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11617 Fselect_frame (old_top_frame
, Qt
);
11620 Fselect_window (old_window
, Qt
);
11623 if (!NILP (AREF (vector
, 6)))
11625 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11626 ASET (vector
, 6, Qnil
);
11629 Vmode_line_unwind_vector
= vector
;
11633 /* Store a single character C for the frame title in mode_line_noprop_buf.
11634 Re-allocate mode_line_noprop_buf if necessary. */
11637 store_mode_line_noprop_char (char c
)
11639 /* If output position has reached the end of the allocated buffer,
11640 increase the buffer's size. */
11641 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11643 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11644 ptrdiff_t size
= len
;
11645 mode_line_noprop_buf
=
11646 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11647 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11648 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11651 *mode_line_noprop_ptr
++ = c
;
11655 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11656 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11657 characters that yield more columns than PRECISION; PRECISION <= 0
11658 means copy the whole string. Pad with spaces until FIELD_WIDTH
11659 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11660 pad. Called from display_mode_element when it is used to build a
11664 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11666 const unsigned char *str
= (const unsigned char *) string
;
11668 ptrdiff_t dummy
, nbytes
;
11670 /* Copy at most PRECISION chars from STR. */
11671 nbytes
= strlen (string
);
11672 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11674 store_mode_line_noprop_char (*str
++);
11676 /* Fill up with spaces until FIELD_WIDTH reached. */
11677 while (field_width
> 0
11678 && n
< field_width
)
11680 store_mode_line_noprop_char (' ');
11687 /***********************************************************************
11689 ***********************************************************************/
11691 #ifdef HAVE_WINDOW_SYSTEM
11693 /* Set the title of FRAME, if it has changed. The title format is
11694 Vicon_title_format if FRAME is iconified, otherwise it is
11695 frame_title_format. */
11698 x_consider_frame_title (Lisp_Object frame
)
11700 struct frame
*f
= XFRAME (frame
);
11702 if ((FRAME_WINDOW_P (f
)
11703 || FRAME_MINIBUF_ONLY_P (f
)
11704 || f
->explicit_name
)
11705 && NILP (Fframe_parameter (frame
, Qtooltip
)))
11707 /* Do we have more than one visible frame on this X display? */
11708 Lisp_Object tail
, other_frame
, fmt
;
11709 ptrdiff_t title_start
;
11713 ptrdiff_t count
= SPECPDL_INDEX ();
11715 FOR_EACH_FRAME (tail
, other_frame
)
11717 struct frame
*tf
= XFRAME (other_frame
);
11720 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11721 && !FRAME_MINIBUF_ONLY_P (tf
)
11722 && !EQ (other_frame
, tip_frame
)
11723 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11727 /* Set global variable indicating that multiple frames exist. */
11728 multiple_frames
= CONSP (tail
);
11730 /* Switch to the buffer of selected window of the frame. Set up
11731 mode_line_target so that display_mode_element will output into
11732 mode_line_noprop_buf; then display the title. */
11733 record_unwind_protect (unwind_format_mode_line
,
11734 format_mode_line_unwind_data
11735 (f
, current_buffer
, selected_window
, false));
11737 Fselect_window (f
->selected_window
, Qt
);
11738 set_buffer_internal_1
11739 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11740 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11742 mode_line_target
= MODE_LINE_TITLE
;
11743 title_start
= MODE_LINE_NOPROP_LEN (0);
11744 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11745 NULL
, DEFAULT_FACE_ID
);
11746 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, false);
11747 len
= MODE_LINE_NOPROP_LEN (title_start
);
11748 title
= mode_line_noprop_buf
+ title_start
;
11749 unbind_to (count
, Qnil
);
11751 /* Set the title only if it's changed. This avoids consing in
11752 the common case where it hasn't. (If it turns out that we've
11753 already wasted too much time by walking through the list with
11754 display_mode_element, then we might need to optimize at a
11755 higher level than this.) */
11756 if (! STRINGP (f
->name
)
11757 || SBYTES (f
->name
) != len
11758 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11759 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11763 #endif /* not HAVE_WINDOW_SYSTEM */
11766 /***********************************************************************
11768 ***********************************************************************/
11770 /* True if we will not redisplay all visible windows. */
11771 #define REDISPLAY_SOME_P() \
11772 ((windows_or_buffers_changed == 0 \
11773 || windows_or_buffers_changed == REDISPLAY_SOME) \
11774 && (update_mode_lines == 0 \
11775 || update_mode_lines == REDISPLAY_SOME))
11777 /* Prepare for redisplay by updating menu-bar item lists when
11778 appropriate. This can call eval. */
11781 prepare_menu_bars (void)
11783 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11784 bool some_windows
= REDISPLAY_SOME_P ();
11785 Lisp_Object tooltip_frame
;
11787 #ifdef HAVE_WINDOW_SYSTEM
11788 tooltip_frame
= tip_frame
;
11790 tooltip_frame
= Qnil
;
11793 if (FUNCTIONP (Vpre_redisplay_function
))
11795 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11796 if (all_windows
&& some_windows
)
11798 Lisp_Object ws
= window_list ();
11799 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11801 Lisp_Object
this = XCAR (ws
);
11802 struct window
*w
= XWINDOW (this);
11804 || XFRAME (w
->frame
)->redisplay
11805 || XBUFFER (w
->contents
)->text
->redisplay
)
11807 windows
= Fcons (this, windows
);
11811 safe__call1 (true, Vpre_redisplay_function
, windows
);
11814 /* Update all frame titles based on their buffer names, etc. We do
11815 this before the menu bars so that the buffer-menu will show the
11816 up-to-date frame titles. */
11817 #ifdef HAVE_WINDOW_SYSTEM
11820 Lisp_Object tail
, frame
;
11822 FOR_EACH_FRAME (tail
, frame
)
11824 struct frame
*f
= XFRAME (frame
);
11825 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11829 && !XBUFFER (w
->contents
)->text
->redisplay
)
11832 if (!EQ (frame
, tooltip_frame
)
11833 && (FRAME_ICONIFIED_P (f
)
11834 || FRAME_VISIBLE_P (f
) == 1
11835 /* Exclude TTY frames that are obscured because they
11836 are not the top frame on their console. This is
11837 because x_consider_frame_title actually switches
11838 to the frame, which for TTY frames means it is
11839 marked as garbaged, and will be completely
11840 redrawn on the next redisplay cycle. This causes
11841 TTY frames to be completely redrawn, when there
11842 are more than one of them, even though nothing
11843 should be changed on display. */
11844 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11845 x_consider_frame_title (frame
);
11848 #endif /* HAVE_WINDOW_SYSTEM */
11850 /* Update the menu bar item lists, if appropriate. This has to be
11851 done before any actual redisplay or generation of display lines. */
11855 Lisp_Object tail
, frame
;
11856 ptrdiff_t count
= SPECPDL_INDEX ();
11857 /* True means that update_menu_bar has run its hooks
11858 so any further calls to update_menu_bar shouldn't do so again. */
11859 bool menu_bar_hooks_run
= false;
11861 record_unwind_save_match_data ();
11863 FOR_EACH_FRAME (tail
, frame
)
11865 struct frame
*f
= XFRAME (frame
);
11866 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11868 /* Ignore tooltip frame. */
11869 if (EQ (frame
, tooltip_frame
))
11875 && !XBUFFER (w
->contents
)->text
->redisplay
)
11878 run_window_size_change_functions (frame
);
11879 menu_bar_hooks_run
= update_menu_bar (f
, false, menu_bar_hooks_run
);
11880 #ifdef HAVE_WINDOW_SYSTEM
11881 update_tool_bar (f
, false);
11885 unbind_to (count
, Qnil
);
11889 struct frame
*sf
= SELECTED_FRAME ();
11890 update_menu_bar (sf
, true, false);
11891 #ifdef HAVE_WINDOW_SYSTEM
11892 update_tool_bar (sf
, true);
11898 /* Update the menu bar item list for frame F. This has to be done
11899 before we start to fill in any display lines, because it can call
11902 If SAVE_MATCH_DATA, we must save and restore it here.
11904 If HOOKS_RUN, a previous call to update_menu_bar
11905 already ran the menu bar hooks for this redisplay, so there
11906 is no need to run them again. The return value is the
11907 updated value of this flag, to pass to the next call. */
11910 update_menu_bar (struct frame
*f
, bool save_match_data
, bool hooks_run
)
11912 Lisp_Object window
;
11915 /* If called recursively during a menu update, do nothing. This can
11916 happen when, for instance, an activate-menubar-hook causes a
11918 if (inhibit_menubar_update
)
11921 window
= FRAME_SELECTED_WINDOW (f
);
11922 w
= XWINDOW (window
);
11924 if (FRAME_WINDOW_P (f
)
11926 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11927 || defined (HAVE_NS) || defined (USE_GTK)
11928 FRAME_EXTERNAL_MENU_BAR (f
)
11930 FRAME_MENU_BAR_LINES (f
) > 0
11932 : FRAME_MENU_BAR_LINES (f
) > 0)
11934 /* If the user has switched buffers or windows, we need to
11935 recompute to reflect the new bindings. But we'll
11936 recompute when update_mode_lines is set too; that means
11937 that people can use force-mode-line-update to request
11938 that the menu bar be recomputed. The adverse effect on
11939 the rest of the redisplay algorithm is about the same as
11940 windows_or_buffers_changed anyway. */
11941 if (windows_or_buffers_changed
11942 /* This used to test w->update_mode_line, but we believe
11943 there is no need to recompute the menu in that case. */
11944 || update_mode_lines
11945 || window_buffer_changed (w
))
11947 struct buffer
*prev
= current_buffer
;
11948 ptrdiff_t count
= SPECPDL_INDEX ();
11950 specbind (Qinhibit_menubar_update
, Qt
);
11952 set_buffer_internal_1 (XBUFFER (w
->contents
));
11953 if (save_match_data
)
11954 record_unwind_save_match_data ();
11955 if (NILP (Voverriding_local_map_menu_flag
))
11957 specbind (Qoverriding_terminal_local_map
, Qnil
);
11958 specbind (Qoverriding_local_map
, Qnil
);
11963 /* Run the Lucid hook. */
11964 safe_run_hooks (Qactivate_menubar_hook
);
11966 /* If it has changed current-menubar from previous value,
11967 really recompute the menu-bar from the value. */
11968 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11969 call0 (Qrecompute_lucid_menubar
);
11971 safe_run_hooks (Qmenu_bar_update_hook
);
11976 XSETFRAME (Vmenu_updating_frame
, f
);
11977 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11979 /* Redisplay the menu bar in case we changed it. */
11980 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11981 || defined (HAVE_NS) || defined (USE_GTK)
11982 if (FRAME_WINDOW_P (f
))
11984 #if defined (HAVE_NS)
11985 /* All frames on Mac OS share the same menubar. So only
11986 the selected frame should be allowed to set it. */
11987 if (f
== SELECTED_FRAME ())
11989 set_frame_menubar (f
, false, false);
11992 /* On a terminal screen, the menu bar is an ordinary screen
11993 line, and this makes it get updated. */
11994 w
->update_mode_line
= true;
11995 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11996 /* In the non-toolkit version, the menu bar is an ordinary screen
11997 line, and this makes it get updated. */
11998 w
->update_mode_line
= true;
11999 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
12001 unbind_to (count
, Qnil
);
12002 set_buffer_internal_1 (prev
);
12009 /***********************************************************************
12011 ***********************************************************************/
12013 #ifdef HAVE_WINDOW_SYSTEM
12015 /* Select `frame' temporarily without running all the code in
12017 FIXME: Maybe do_switch_frame should be trimmed down similarly
12018 when `norecord' is set. */
12020 fast_set_selected_frame (Lisp_Object frame
)
12022 if (!EQ (selected_frame
, frame
))
12024 selected_frame
= frame
;
12025 selected_window
= XFRAME (frame
)->selected_window
;
12029 /* Update the tool-bar item list for frame F. This has to be done
12030 before we start to fill in any display lines. Called from
12031 prepare_menu_bars. If SAVE_MATCH_DATA, we must save
12032 and restore it here. */
12035 update_tool_bar (struct frame
*f
, bool save_match_data
)
12037 #if defined (USE_GTK) || defined (HAVE_NS)
12038 bool do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
12040 bool do_update
= (WINDOWP (f
->tool_bar_window
)
12041 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0);
12046 Lisp_Object window
;
12049 window
= FRAME_SELECTED_WINDOW (f
);
12050 w
= XWINDOW (window
);
12052 /* If the user has switched buffers or windows, we need to
12053 recompute to reflect the new bindings. But we'll
12054 recompute when update_mode_lines is set too; that means
12055 that people can use force-mode-line-update to request
12056 that the menu bar be recomputed. The adverse effect on
12057 the rest of the redisplay algorithm is about the same as
12058 windows_or_buffers_changed anyway. */
12059 if (windows_or_buffers_changed
12060 || w
->update_mode_line
12061 || update_mode_lines
12062 || window_buffer_changed (w
))
12064 struct buffer
*prev
= current_buffer
;
12065 ptrdiff_t count
= SPECPDL_INDEX ();
12066 Lisp_Object frame
, new_tool_bar
;
12067 int new_n_tool_bar
;
12069 /* Set current_buffer to the buffer of the selected
12070 window of the frame, so that we get the right local
12072 set_buffer_internal_1 (XBUFFER (w
->contents
));
12074 /* Save match data, if we must. */
12075 if (save_match_data
)
12076 record_unwind_save_match_data ();
12078 /* Make sure that we don't accidentally use bogus keymaps. */
12079 if (NILP (Voverriding_local_map_menu_flag
))
12081 specbind (Qoverriding_terminal_local_map
, Qnil
);
12082 specbind (Qoverriding_local_map
, Qnil
);
12085 /* We must temporarily set the selected frame to this frame
12086 before calling tool_bar_items, because the calculation of
12087 the tool-bar keymap uses the selected frame (see
12088 `tool-bar-make-keymap' in tool-bar.el). */
12089 eassert (EQ (selected_window
,
12090 /* Since we only explicitly preserve selected_frame,
12091 check that selected_window would be redundant. */
12092 XFRAME (selected_frame
)->selected_window
));
12093 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
12094 XSETFRAME (frame
, f
);
12095 fast_set_selected_frame (frame
);
12097 /* Build desired tool-bar items from keymaps. */
12099 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
12102 /* Redisplay the tool-bar if we changed it. */
12103 if (new_n_tool_bar
!= f
->n_tool_bar_items
12104 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
12106 /* Redisplay that happens asynchronously due to an expose event
12107 may access f->tool_bar_items. Make sure we update both
12108 variables within BLOCK_INPUT so no such event interrupts. */
12110 fset_tool_bar_items (f
, new_tool_bar
);
12111 f
->n_tool_bar_items
= new_n_tool_bar
;
12112 w
->update_mode_line
= true;
12116 unbind_to (count
, Qnil
);
12117 set_buffer_internal_1 (prev
);
12122 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12124 /* Set F->desired_tool_bar_string to a Lisp string representing frame
12125 F's desired tool-bar contents. F->tool_bar_items must have
12126 been set up previously by calling prepare_menu_bars. */
12129 build_desired_tool_bar_string (struct frame
*f
)
12131 int i
, size
, size_needed
;
12132 Lisp_Object image
, plist
;
12134 image
= plist
= Qnil
;
12136 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
12137 Otherwise, make a new string. */
12139 /* The size of the string we might be able to reuse. */
12140 size
= (STRINGP (f
->desired_tool_bar_string
)
12141 ? SCHARS (f
->desired_tool_bar_string
)
12144 /* We need one space in the string for each image. */
12145 size_needed
= f
->n_tool_bar_items
;
12147 /* Reuse f->desired_tool_bar_string, if possible. */
12148 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
12149 fset_desired_tool_bar_string
12150 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
12153 AUTO_LIST4 (props
, Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
12154 Fremove_text_properties (make_number (0), make_number (size
),
12155 props
, f
->desired_tool_bar_string
);
12158 /* Put a `display' property on the string for the images to display,
12159 put a `menu_item' property on tool-bar items with a value that
12160 is the index of the item in F's tool-bar item vector. */
12161 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
12163 #define PROP(IDX) \
12164 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
12166 bool enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
12167 bool selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
12168 int hmargin
, vmargin
, relief
, idx
, end
;
12170 /* If image is a vector, choose the image according to the
12172 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
12173 if (VECTORP (image
))
12177 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12178 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
12181 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12182 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
12184 eassert (ASIZE (image
) >= idx
);
12185 image
= AREF (image
, idx
);
12190 /* Ignore invalid image specifications. */
12191 if (!valid_image_p (image
))
12194 /* Display the tool-bar button pressed, or depressed. */
12195 plist
= Fcopy_sequence (XCDR (image
));
12197 /* Compute margin and relief to draw. */
12198 relief
= (tool_bar_button_relief
>= 0
12199 ? tool_bar_button_relief
12200 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12201 hmargin
= vmargin
= relief
;
12203 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12204 INT_MAX
- max (hmargin
, vmargin
)))
12206 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12207 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12209 else if (CONSP (Vtool_bar_button_margin
))
12211 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12212 INT_MAX
- hmargin
))
12213 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12215 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12216 INT_MAX
- vmargin
))
12217 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12220 if (auto_raise_tool_bar_buttons_p
)
12222 /* Add a `:relief' property to the image spec if the item is
12226 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12233 /* If image is selected, display it pressed, i.e. with a
12234 negative relief. If it's not selected, display it with a
12236 plist
= Fplist_put (plist
, QCrelief
,
12238 ? make_number (-relief
)
12239 : make_number (relief
)));
12244 /* Put a margin around the image. */
12245 if (hmargin
|| vmargin
)
12247 if (hmargin
== vmargin
)
12248 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12250 plist
= Fplist_put (plist
, QCmargin
,
12251 Fcons (make_number (hmargin
),
12252 make_number (vmargin
)));
12255 /* If button is not enabled, and we don't have special images
12256 for the disabled state, make the image appear disabled by
12257 applying an appropriate algorithm to it. */
12258 if (!enabled_p
&& idx
< 0)
12259 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12261 /* Put a `display' text property on the string for the image to
12262 display. Put a `menu-item' property on the string that gives
12263 the start of this item's properties in the tool-bar items
12265 image
= Fcons (Qimage
, plist
);
12266 AUTO_LIST4 (props
, Qdisplay
, image
, Qmenu_item
,
12267 make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12269 /* Let the last image hide all remaining spaces in the tool bar
12270 string. The string can be longer than needed when we reuse a
12271 previous string. */
12272 if (i
+ 1 == f
->n_tool_bar_items
)
12273 end
= SCHARS (f
->desired_tool_bar_string
);
12276 Fadd_text_properties (make_number (i
), make_number (end
),
12277 props
, f
->desired_tool_bar_string
);
12283 /* Display one line of the tool-bar of frame IT->f.
12285 HEIGHT specifies the desired height of the tool-bar line.
12286 If the actual height of the glyph row is less than HEIGHT, the
12287 row's height is increased to HEIGHT, and the icons are centered
12288 vertically in the new height.
12290 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12291 count a final empty row in case the tool-bar width exactly matches
12296 display_tool_bar_line (struct it
*it
, int height
)
12298 struct glyph_row
*row
= it
->glyph_row
;
12299 int max_x
= it
->last_visible_x
;
12300 struct glyph
*last
;
12302 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12303 clear_glyph_row (row
);
12304 row
->enabled_p
= true;
12305 row
->y
= it
->current_y
;
12307 /* Note that this isn't made use of if the face hasn't a box,
12308 so there's no need to check the face here. */
12309 it
->start_of_box_run_p
= true;
12311 while (it
->current_x
< max_x
)
12313 int x
, n_glyphs_before
, i
, nglyphs
;
12314 struct it it_before
;
12316 /* Get the next display element. */
12317 if (!get_next_display_element (it
))
12319 /* Don't count empty row if we are counting needed tool-bar lines. */
12320 if (height
< 0 && !it
->hpos
)
12325 /* Produce glyphs. */
12326 n_glyphs_before
= row
->used
[TEXT_AREA
];
12329 PRODUCE_GLYPHS (it
);
12331 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12333 x
= it_before
.current_x
;
12334 while (i
< nglyphs
)
12336 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12338 if (x
+ glyph
->pixel_width
> max_x
)
12340 /* Glyph doesn't fit on line. Backtrack. */
12341 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12343 /* If this is the only glyph on this line, it will never fit on the
12344 tool-bar, so skip it. But ensure there is at least one glyph,
12345 so we don't accidentally disable the tool-bar. */
12346 if (n_glyphs_before
== 0
12347 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12353 x
+= glyph
->pixel_width
;
12357 /* Stop at line end. */
12358 if (ITERATOR_AT_END_OF_LINE_P (it
))
12361 set_iterator_to_next (it
, true);
12366 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12368 /* Use default face for the border below the tool bar.
12370 FIXME: When auto-resize-tool-bars is grow-only, there is
12371 no additional border below the possibly empty tool-bar lines.
12372 So to make the extra empty lines look "normal", we have to
12373 use the tool-bar face for the border too. */
12374 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12375 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12376 it
->face_id
= DEFAULT_FACE_ID
;
12378 extend_face_to_end_of_line (it
);
12379 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12380 last
->right_box_line_p
= true;
12381 if (last
== row
->glyphs
[TEXT_AREA
])
12382 last
->left_box_line_p
= true;
12384 /* Make line the desired height and center it vertically. */
12385 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12387 /* Don't add more than one line height. */
12388 height
%= FRAME_LINE_HEIGHT (it
->f
);
12389 it
->max_ascent
+= height
/ 2;
12390 it
->max_descent
+= (height
+ 1) / 2;
12393 compute_line_metrics (it
);
12395 /* If line is empty, make it occupy the rest of the tool-bar. */
12396 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12398 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12399 row
->visible_height
= row
->height
;
12400 row
->ascent
= row
->phys_ascent
= 0;
12401 row
->extra_line_spacing
= 0;
12404 row
->full_width_p
= true;
12405 row
->continued_p
= false;
12406 row
->truncated_on_left_p
= false;
12407 row
->truncated_on_right_p
= false;
12409 it
->current_x
= it
->hpos
= 0;
12410 it
->current_y
+= row
->height
;
12416 /* Value is the number of pixels needed to make all tool-bar items of
12417 frame F visible. The actual number of glyph rows needed is
12418 returned in *N_ROWS if non-NULL. */
12420 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12422 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12424 /* tool_bar_height is called from redisplay_tool_bar after building
12425 the desired matrix, so use (unused) mode-line row as temporary row to
12426 avoid destroying the first tool-bar row. */
12427 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12429 /* Initialize an iterator for iteration over
12430 F->desired_tool_bar_string in the tool-bar window of frame F. */
12431 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12432 temp_row
->reversed_p
= false;
12433 it
.first_visible_x
= 0;
12434 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12435 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12436 it
.paragraph_embedding
= L2R
;
12438 while (!ITERATOR_AT_END_P (&it
))
12440 clear_glyph_row (temp_row
);
12441 it
.glyph_row
= temp_row
;
12442 display_tool_bar_line (&it
, -1);
12444 clear_glyph_row (temp_row
);
12446 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12448 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12451 return it
.current_y
;
12453 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12456 #endif /* !USE_GTK && !HAVE_NS */
12458 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12460 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12461 If FRAME is nil or omitted, use the selected frame. Optional argument
12462 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12463 (Lisp_Object frame
, Lisp_Object pixelwise
)
12467 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12468 struct frame
*f
= decode_any_frame (frame
);
12470 if (WINDOWP (f
->tool_bar_window
)
12471 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12473 update_tool_bar (f
, true);
12474 if (f
->n_tool_bar_items
)
12476 build_desired_tool_bar_string (f
);
12477 height
= tool_bar_height (f
, NULL
, !NILP (pixelwise
));
12482 return make_number (height
);
12486 /* Display the tool-bar of frame F. Value is true if tool-bar's
12487 height should be changed. */
12489 redisplay_tool_bar (struct frame
*f
)
12491 f
->tool_bar_redisplayed
= true;
12492 #if defined (USE_GTK) || defined (HAVE_NS)
12494 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12495 update_frame_tool_bar (f
);
12498 #else /* !USE_GTK && !HAVE_NS */
12502 struct glyph_row
*row
;
12504 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12505 do anything. This means you must start with tool-bar-lines
12506 non-zero to get the auto-sizing effect. Or in other words, you
12507 can turn off tool-bars by specifying tool-bar-lines zero. */
12508 if (!WINDOWP (f
->tool_bar_window
)
12509 || (w
= XWINDOW (f
->tool_bar_window
),
12510 WINDOW_TOTAL_LINES (w
) == 0))
12513 /* Set up an iterator for the tool-bar window. */
12514 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12515 it
.first_visible_x
= 0;
12516 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12517 row
= it
.glyph_row
;
12518 row
->reversed_p
= false;
12520 /* Build a string that represents the contents of the tool-bar. */
12521 build_desired_tool_bar_string (f
);
12522 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12523 /* FIXME: This should be controlled by a user option. But it
12524 doesn't make sense to have an R2L tool bar if the menu bar cannot
12525 be drawn also R2L, and making the menu bar R2L is tricky due
12526 toolkit-specific code that implements it. If an R2L tool bar is
12527 ever supported, display_tool_bar_line should also be augmented to
12528 call unproduce_glyphs like display_line and display_string
12530 it
.paragraph_embedding
= L2R
;
12532 if (f
->n_tool_bar_rows
== 0)
12534 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, true);
12536 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12538 x_change_tool_bar_height (f
, new_height
);
12539 frame_default_tool_bar_height
= new_height
;
12540 /* Always do that now. */
12541 clear_glyph_matrix (w
->desired_matrix
);
12542 f
->fonts_changed
= true;
12547 /* Display as many lines as needed to display all tool-bar items. */
12549 if (f
->n_tool_bar_rows
> 0)
12551 int border
, rows
, height
, extra
;
12553 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12554 border
= XINT (Vtool_bar_border
);
12555 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12556 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12557 else if (EQ (Vtool_bar_border
, Qborder_width
))
12558 border
= f
->border_width
;
12564 rows
= f
->n_tool_bar_rows
;
12565 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12566 extra
= it
.last_visible_y
- border
- height
* rows
;
12568 while (it
.current_y
< it
.last_visible_y
)
12571 if (extra
> 0 && rows
-- > 0)
12573 h
= (extra
+ rows
- 1) / rows
;
12576 display_tool_bar_line (&it
, height
+ h
);
12581 while (it
.current_y
< it
.last_visible_y
)
12582 display_tool_bar_line (&it
, 0);
12585 /* It doesn't make much sense to try scrolling in the tool-bar
12586 window, so don't do it. */
12587 w
->desired_matrix
->no_scrolling_p
= true;
12588 w
->must_be_updated_p
= true;
12590 if (!NILP (Vauto_resize_tool_bars
))
12592 bool change_height_p
= true;
12594 /* If we couldn't display everything, change the tool-bar's
12595 height if there is room for more. */
12596 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
12597 change_height_p
= true;
12599 /* We subtract 1 because display_tool_bar_line advances the
12600 glyph_row pointer before returning to its caller. We want to
12601 examine the last glyph row produced by
12602 display_tool_bar_line. */
12603 row
= it
.glyph_row
- 1;
12605 /* If there are blank lines at the end, except for a partially
12606 visible blank line at the end that is smaller than
12607 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12608 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12609 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12610 change_height_p
= true;
12612 /* If row displays tool-bar items, but is partially visible,
12613 change the tool-bar's height. */
12614 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12615 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
12616 change_height_p
= true;
12618 /* Resize windows as needed by changing the `tool-bar-lines'
12619 frame parameter. */
12620 if (change_height_p
)
12623 int new_height
= tool_bar_height (f
, &nrows
, true);
12625 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12626 && !f
->minimize_tool_bar_window_p
)
12627 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12628 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12629 f
->minimize_tool_bar_window_p
= false;
12631 if (change_height_p
)
12633 x_change_tool_bar_height (f
, new_height
);
12634 frame_default_tool_bar_height
= new_height
;
12635 clear_glyph_matrix (w
->desired_matrix
);
12636 f
->n_tool_bar_rows
= nrows
;
12637 f
->fonts_changed
= true;
12644 f
->minimize_tool_bar_window_p
= false;
12647 #endif /* USE_GTK || HAVE_NS */
12650 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12652 /* Get information about the tool-bar item which is displayed in GLYPH
12653 on frame F. Return in *PROP_IDX the index where tool-bar item
12654 properties start in F->tool_bar_items. Value is false if
12655 GLYPH doesn't display a tool-bar item. */
12658 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12663 /* This function can be called asynchronously, which means we must
12664 exclude any possibility that Fget_text_property signals an
12666 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12667 charpos
= max (0, charpos
);
12669 /* Get the text property `menu-item' at pos. The value of that
12670 property is the start index of this item's properties in
12671 F->tool_bar_items. */
12672 prop
= Fget_text_property (make_number (charpos
),
12673 Qmenu_item
, f
->current_tool_bar_string
);
12674 if (! INTEGERP (prop
))
12676 *prop_idx
= XINT (prop
);
12681 /* Get information about the tool-bar item at position X/Y on frame F.
12682 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12683 the current matrix of the tool-bar window of F, or NULL if not
12684 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12685 item in F->tool_bar_items. Value is
12687 -1 if X/Y is not on a tool-bar item
12688 0 if X/Y is on the same item that was highlighted before.
12692 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12693 int *hpos
, int *vpos
, int *prop_idx
)
12695 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12696 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12699 /* Find the glyph under X/Y. */
12700 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12701 if (*glyph
== NULL
)
12704 /* Get the start of this tool-bar item's properties in
12705 f->tool_bar_items. */
12706 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12709 /* Is mouse on the highlighted item? */
12710 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12711 && *vpos
>= hlinfo
->mouse_face_beg_row
12712 && *vpos
<= hlinfo
->mouse_face_end_row
12713 && (*vpos
> hlinfo
->mouse_face_beg_row
12714 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12715 && (*vpos
< hlinfo
->mouse_face_end_row
12716 || *hpos
< hlinfo
->mouse_face_end_col
12717 || hlinfo
->mouse_face_past_end
))
12725 Handle mouse button event on the tool-bar of frame F, at
12726 frame-relative coordinates X/Y. DOWN_P is true for a button press,
12727 false for button release. MODIFIERS is event modifiers for button
12731 handle_tool_bar_click (struct frame
*f
, int x
, int y
, bool down_p
,
12734 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12735 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12736 int hpos
, vpos
, prop_idx
;
12737 struct glyph
*glyph
;
12738 Lisp_Object enabled_p
;
12741 /* If not on the highlighted tool-bar item, and mouse-highlight is
12742 non-nil, return. This is so we generate the tool-bar button
12743 click only when the mouse button is released on the same item as
12744 where it was pressed. However, when mouse-highlight is disabled,
12745 generate the click when the button is released regardless of the
12746 highlight, since tool-bar items are not highlighted in that
12748 frame_to_window_pixel_xy (w
, &x
, &y
);
12749 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12751 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12754 /* When mouse-highlight is off, generate the click for the item
12755 where the button was pressed, disregarding where it was
12757 if (NILP (Vmouse_highlight
) && !down_p
)
12758 prop_idx
= f
->last_tool_bar_item
;
12760 /* If item is disabled, do nothing. */
12761 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12762 if (NILP (enabled_p
))
12767 /* Show item in pressed state. */
12768 if (!NILP (Vmouse_highlight
))
12769 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12770 f
->last_tool_bar_item
= prop_idx
;
12774 Lisp_Object key
, frame
;
12775 struct input_event event
;
12776 EVENT_INIT (event
);
12778 /* Show item in released state. */
12779 if (!NILP (Vmouse_highlight
))
12780 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12782 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12784 XSETFRAME (frame
, f
);
12785 event
.kind
= TOOL_BAR_EVENT
;
12786 event
.frame_or_window
= frame
;
12788 kbd_buffer_store_event (&event
);
12790 event
.kind
= TOOL_BAR_EVENT
;
12791 event
.frame_or_window
= frame
;
12793 event
.modifiers
= modifiers
;
12794 kbd_buffer_store_event (&event
);
12795 f
->last_tool_bar_item
= -1;
12800 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12801 tool-bar window-relative coordinates X/Y. Called from
12802 note_mouse_highlight. */
12805 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12807 Lisp_Object window
= f
->tool_bar_window
;
12808 struct window
*w
= XWINDOW (window
);
12809 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12810 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12812 struct glyph
*glyph
;
12813 struct glyph_row
*row
;
12815 Lisp_Object enabled_p
;
12817 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12821 /* Function note_mouse_highlight is called with negative X/Y
12822 values when mouse moves outside of the frame. */
12823 if (x
<= 0 || y
<= 0)
12825 clear_mouse_face (hlinfo
);
12829 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12832 /* Not on tool-bar item. */
12833 clear_mouse_face (hlinfo
);
12837 /* On same tool-bar item as before. */
12838 goto set_help_echo
;
12840 clear_mouse_face (hlinfo
);
12842 /* Mouse is down, but on different tool-bar item? */
12843 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12844 && f
== dpyinfo
->last_mouse_frame
);
12846 if (mouse_down_p
&& f
->last_tool_bar_item
!= prop_idx
)
12849 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12851 /* If tool-bar item is not enabled, don't highlight it. */
12852 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12853 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12855 /* Compute the x-position of the glyph. In front and past the
12856 image is a space. We include this in the highlighted area. */
12857 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12858 for (i
= x
= 0; i
< hpos
; ++i
)
12859 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12861 /* Record this as the current active region. */
12862 hlinfo
->mouse_face_beg_col
= hpos
;
12863 hlinfo
->mouse_face_beg_row
= vpos
;
12864 hlinfo
->mouse_face_beg_x
= x
;
12865 hlinfo
->mouse_face_past_end
= false;
12867 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12868 hlinfo
->mouse_face_end_row
= vpos
;
12869 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12870 hlinfo
->mouse_face_window
= window
;
12871 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12873 /* Display it as active. */
12874 show_mouse_face (hlinfo
, draw
);
12879 /* Set help_echo_string to a help string to display for this tool-bar item.
12880 XTread_socket does the rest. */
12881 help_echo_object
= help_echo_window
= Qnil
;
12882 help_echo_pos
= -1;
12883 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12884 if (NILP (help_echo_string
))
12885 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12888 #endif /* !USE_GTK && !HAVE_NS */
12890 #endif /* HAVE_WINDOW_SYSTEM */
12894 /************************************************************************
12895 Horizontal scrolling
12896 ************************************************************************/
12898 /* For all leaf windows in the window tree rooted at WINDOW, set their
12899 hscroll value so that PT is (i) visible in the window, and (ii) so
12900 that it is not within a certain margin at the window's left and
12901 right border. Value is true if any window's hscroll has been
12905 hscroll_window_tree (Lisp_Object window
)
12907 bool hscrolled_p
= false;
12908 bool hscroll_relative_p
= FLOATP (Vhscroll_step
);
12909 int hscroll_step_abs
= 0;
12910 double hscroll_step_rel
= 0;
12912 if (hscroll_relative_p
)
12914 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12915 if (hscroll_step_rel
< 0)
12917 hscroll_relative_p
= false;
12918 hscroll_step_abs
= 0;
12921 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12923 hscroll_step_abs
= XINT (Vhscroll_step
);
12924 if (hscroll_step_abs
< 0)
12925 hscroll_step_abs
= 0;
12928 hscroll_step_abs
= 0;
12930 while (WINDOWP (window
))
12932 struct window
*w
= XWINDOW (window
);
12934 if (WINDOWP (w
->contents
))
12935 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12936 else if (w
->cursor
.vpos
>= 0)
12939 int text_area_width
;
12940 struct glyph_row
*cursor_row
;
12941 struct glyph_row
*bottom_row
;
12943 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12944 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12945 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12947 cursor_row
= bottom_row
- 1;
12949 if (!cursor_row
->enabled_p
)
12951 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12952 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12953 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12955 cursor_row
= bottom_row
- 1;
12957 bool row_r2l_p
= cursor_row
->reversed_p
;
12959 text_area_width
= window_box_width (w
, TEXT_AREA
);
12961 /* Scroll when cursor is inside this scroll margin. */
12962 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12964 /* If the position of this window's point has explicitly
12965 changed, no more suspend auto hscrolling. */
12966 if (NILP (Fequal (Fwindow_point (window
), Fwindow_old_point (window
))))
12967 w
->suspend_auto_hscroll
= false;
12969 /* Remember window point. */
12970 Fset_marker (w
->old_pointm
,
12971 ((w
== XWINDOW (selected_window
))
12972 ? make_number (BUF_PT (XBUFFER (w
->contents
)))
12973 : Fmarker_position (w
->pointm
)),
12976 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12977 && !w
->suspend_auto_hscroll
12978 /* In some pathological cases, like restoring a window
12979 configuration into a frame that is much smaller than
12980 the one from which the configuration was saved, we
12981 get glyph rows whose start and end have zero buffer
12982 positions, which we cannot handle below. Just skip
12984 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12985 /* For left-to-right rows, hscroll when cursor is either
12986 (i) inside the right hscroll margin, or (ii) if it is
12987 inside the left margin and the window is already
12990 && ((w
->hscroll
&& w
->cursor
.x
<= h_margin
)
12991 || (cursor_row
->enabled_p
12992 && cursor_row
->truncated_on_right_p
12993 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12994 /* For right-to-left rows, the logic is similar,
12995 except that rules for scrolling to left and right
12996 are reversed. E.g., if cursor.x <= h_margin, we
12997 need to hscroll "to the right" unconditionally,
12998 and that will scroll the screen to the left so as
12999 to reveal the next portion of the row. */
13001 && ((cursor_row
->enabled_p
13002 /* FIXME: It is confusing to set the
13003 truncated_on_right_p flag when R2L rows
13004 are actually truncated on the left. */
13005 && cursor_row
->truncated_on_right_p
13006 && w
->cursor
.x
<= h_margin
)
13008 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
13012 struct buffer
*saved_current_buffer
;
13016 /* Find point in a display of infinite width. */
13017 saved_current_buffer
= current_buffer
;
13018 current_buffer
= XBUFFER (w
->contents
);
13020 if (w
== XWINDOW (selected_window
))
13023 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
13025 /* Move iterator to pt starting at cursor_row->start in
13026 a line with infinite width. */
13027 init_to_row_start (&it
, w
, cursor_row
);
13028 it
.last_visible_x
= INFINITY
;
13029 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
13030 current_buffer
= saved_current_buffer
;
13032 /* Position cursor in window. */
13033 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
13034 hscroll
= max (0, (it
.current_x
13035 - (ITERATOR_AT_END_OF_LINE_P (&it
)
13036 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
13037 : (text_area_width
/ 2))))
13038 / FRAME_COLUMN_WIDTH (it
.f
);
13039 else if ((!row_r2l_p
13040 && w
->cursor
.x
>= text_area_width
- h_margin
)
13041 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
13043 if (hscroll_relative_p
)
13044 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
13047 wanted_x
= text_area_width
13048 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
13051 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
13055 if (hscroll_relative_p
)
13056 wanted_x
= text_area_width
* hscroll_step_rel
13059 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
13062 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
13064 hscroll
= max (hscroll
, w
->min_hscroll
);
13066 /* Don't prevent redisplay optimizations if hscroll
13067 hasn't changed, as it will unnecessarily slow down
13069 if (w
->hscroll
!= hscroll
)
13071 struct buffer
*b
= XBUFFER (w
->contents
);
13072 b
->prevent_redisplay_optimizations_p
= true;
13073 w
->hscroll
= hscroll
;
13074 hscrolled_p
= true;
13082 /* Value is true if hscroll of any leaf window has been changed. */
13083 return hscrolled_p
;
13087 /* Set hscroll so that cursor is visible and not inside horizontal
13088 scroll margins for all windows in the tree rooted at WINDOW. See
13089 also hscroll_window_tree above. Value is true if any window's
13090 hscroll has been changed. If it has, desired matrices on the frame
13091 of WINDOW are cleared. */
13094 hscroll_windows (Lisp_Object window
)
13096 bool hscrolled_p
= hscroll_window_tree (window
);
13098 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
13099 return hscrolled_p
;
13104 /************************************************************************
13106 ************************************************************************/
13108 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined.
13109 This is sometimes handy to have in a debugger session. */
13113 /* First and last unchanged row for try_window_id. */
13115 static int debug_first_unchanged_at_end_vpos
;
13116 static int debug_last_unchanged_at_beg_vpos
;
13118 /* Delta vpos and y. */
13120 static int debug_dvpos
, debug_dy
;
13122 /* Delta in characters and bytes for try_window_id. */
13124 static ptrdiff_t debug_delta
, debug_delta_bytes
;
13126 /* Values of window_end_pos and window_end_vpos at the end of
13129 static ptrdiff_t debug_end_vpos
;
13131 /* Append a string to W->desired_matrix->method. FMT is a printf
13132 format string. If trace_redisplay_p is true also printf the
13133 resulting string to stderr. */
13135 static void debug_method_add (struct window
*, char const *, ...)
13136 ATTRIBUTE_FORMAT_PRINTF (2, 3);
13139 debug_method_add (struct window
*w
, char const *fmt
, ...)
13142 char *method
= w
->desired_matrix
->method
;
13143 int len
= strlen (method
);
13144 int size
= sizeof w
->desired_matrix
->method
;
13145 int remaining
= size
- len
- 1;
13148 if (len
&& remaining
)
13151 --remaining
, ++len
;
13154 va_start (ap
, fmt
);
13155 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
13158 if (trace_redisplay_p
)
13159 fprintf (stderr
, "%p (%s): %s\n",
13161 ((BUFFERP (w
->contents
)
13162 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
13163 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13168 #endif /* GLYPH_DEBUG */
13171 /* Value is true if all changes in window W, which displays
13172 current_buffer, are in the text between START and END. START is a
13173 buffer position, END is given as a distance from Z. Used in
13174 redisplay_internal for display optimization. */
13177 text_outside_line_unchanged_p (struct window
*w
,
13178 ptrdiff_t start
, ptrdiff_t end
)
13180 bool unchanged_p
= true;
13182 /* If text or overlays have changed, see where. */
13183 if (window_outdated (w
))
13185 /* Gap in the line? */
13186 if (GPT
< start
|| Z
- GPT
< end
)
13187 unchanged_p
= false;
13189 /* Changes start in front of the line, or end after it? */
13191 && (BEG_UNCHANGED
< start
- 1
13192 || END_UNCHANGED
< end
))
13193 unchanged_p
= false;
13195 /* If selective display, can't optimize if changes start at the
13196 beginning of the line. */
13198 && INTEGERP (BVAR (current_buffer
, selective_display
))
13199 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13200 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13201 unchanged_p
= false;
13203 /* If there are overlays at the start or end of the line, these
13204 may have overlay strings with newlines in them. A change at
13205 START, for instance, may actually concern the display of such
13206 overlay strings as well, and they are displayed on different
13207 lines. So, quickly rule out this case. (For the future, it
13208 might be desirable to implement something more telling than
13209 just BEG/END_UNCHANGED.) */
13212 if (BEG
+ BEG_UNCHANGED
== start
13213 && overlay_touches_p (start
))
13214 unchanged_p
= false;
13215 if (END_UNCHANGED
== end
13216 && overlay_touches_p (Z
- end
))
13217 unchanged_p
= false;
13220 /* Under bidi reordering, adding or deleting a character in the
13221 beginning of a paragraph, before the first strong directional
13222 character, can change the base direction of the paragraph (unless
13223 the buffer specifies a fixed paragraph direction), which will
13224 require redisplaying the whole paragraph. It might be worthwhile
13225 to find the paragraph limits and widen the range of redisplayed
13226 lines to that, but for now just give up this optimization. */
13227 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13228 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13229 unchanged_p
= false;
13232 return unchanged_p
;
13236 /* Do a frame update, taking possible shortcuts into account. This is
13237 the main external entry point for redisplay.
13239 If the last redisplay displayed an echo area message and that message
13240 is no longer requested, we clear the echo area or bring back the
13241 mini-buffer if that is in use. */
13246 redisplay_internal ();
13251 overlay_arrow_string_or_property (Lisp_Object var
)
13255 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13258 return Voverlay_arrow_string
;
13261 /* Return true if there are any overlay-arrows in current_buffer. */
13263 overlay_arrow_in_current_buffer_p (void)
13267 for (vlist
= Voverlay_arrow_variable_list
;
13269 vlist
= XCDR (vlist
))
13271 Lisp_Object var
= XCAR (vlist
);
13274 if (!SYMBOLP (var
))
13276 val
= find_symbol_value (var
);
13278 && current_buffer
== XMARKER (val
)->buffer
)
13285 /* Return true if any overlay_arrows have moved or overlay-arrow-string
13289 overlay_arrows_changed_p (void)
13293 for (vlist
= Voverlay_arrow_variable_list
;
13295 vlist
= XCDR (vlist
))
13297 Lisp_Object var
= XCAR (vlist
);
13298 Lisp_Object val
, pstr
;
13300 if (!SYMBOLP (var
))
13302 val
= find_symbol_value (var
);
13303 if (!MARKERP (val
))
13305 if (! EQ (COERCE_MARKER (val
),
13306 Fget (var
, Qlast_arrow_position
))
13307 || ! (pstr
= overlay_arrow_string_or_property (var
),
13308 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13314 /* Mark overlay arrows to be updated on next redisplay. */
13317 update_overlay_arrows (int up_to_date
)
13321 for (vlist
= Voverlay_arrow_variable_list
;
13323 vlist
= XCDR (vlist
))
13325 Lisp_Object var
= XCAR (vlist
);
13327 if (!SYMBOLP (var
))
13330 if (up_to_date
> 0)
13332 Lisp_Object val
= find_symbol_value (var
);
13333 Fput (var
, Qlast_arrow_position
,
13334 COERCE_MARKER (val
));
13335 Fput (var
, Qlast_arrow_string
,
13336 overlay_arrow_string_or_property (var
));
13338 else if (up_to_date
< 0
13339 || !NILP (Fget (var
, Qlast_arrow_position
)))
13341 Fput (var
, Qlast_arrow_position
, Qt
);
13342 Fput (var
, Qlast_arrow_string
, Qt
);
13348 /* Return overlay arrow string to display at row.
13349 Return integer (bitmap number) for arrow bitmap in left fringe.
13350 Return nil if no overlay arrow. */
13353 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13357 for (vlist
= Voverlay_arrow_variable_list
;
13359 vlist
= XCDR (vlist
))
13361 Lisp_Object var
= XCAR (vlist
);
13364 if (!SYMBOLP (var
))
13367 val
= find_symbol_value (var
);
13370 && current_buffer
== XMARKER (val
)->buffer
13371 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13373 if (FRAME_WINDOW_P (it
->f
)
13374 /* FIXME: if ROW->reversed_p is set, this should test
13375 the right fringe, not the left one. */
13376 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13378 #ifdef HAVE_WINDOW_SYSTEM
13379 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13381 int fringe_bitmap
= lookup_fringe_bitmap (val
);
13382 if (fringe_bitmap
!= 0)
13383 return make_number (fringe_bitmap
);
13386 return make_number (-1); /* Use default arrow bitmap. */
13388 return overlay_arrow_string_or_property (var
);
13395 /* Return true if point moved out of or into a composition. Otherwise
13396 return false. PREV_BUF and PREV_PT are the last point buffer and
13397 position. BUF and PT are the current point buffer and position. */
13400 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13401 struct buffer
*buf
, ptrdiff_t pt
)
13403 ptrdiff_t start
, end
;
13405 Lisp_Object buffer
;
13407 XSETBUFFER (buffer
, buf
);
13408 /* Check a composition at the last point if point moved within the
13410 if (prev_buf
== buf
)
13413 /* Point didn't move. */
13416 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13417 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13418 && composition_valid_p (start
, end
, prop
)
13419 && start
< prev_pt
&& end
> prev_pt
)
13420 /* The last point was within the composition. Return true iff
13421 point moved out of the composition. */
13422 return (pt
<= start
|| pt
>= end
);
13425 /* Check a composition at the current point. */
13426 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13427 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13428 && composition_valid_p (start
, end
, prop
)
13429 && start
< pt
&& end
> pt
);
13432 /* Reconsider the clip changes of buffer which is displayed in W. */
13435 reconsider_clip_changes (struct window
*w
)
13437 struct buffer
*b
= XBUFFER (w
->contents
);
13439 if (b
->clip_changed
13440 && w
->window_end_valid
13441 && w
->current_matrix
->buffer
== b
13442 && w
->current_matrix
->zv
== BUF_ZV (b
)
13443 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13444 b
->clip_changed
= false;
13446 /* If display wasn't paused, and W is not a tool bar window, see if
13447 point has been moved into or out of a composition. In that case,
13448 set b->clip_changed to force updating the screen. If
13449 b->clip_changed has already been set, skip this check. */
13450 if (!b
->clip_changed
&& w
->window_end_valid
)
13452 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13453 ? PT
: marker_position (w
->pointm
));
13455 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13456 && check_point_in_composition (w
->current_matrix
->buffer
,
13457 w
->last_point
, b
, pt
))
13458 b
->clip_changed
= true;
13463 propagate_buffer_redisplay (void)
13464 { /* Resetting b->text->redisplay is problematic!
13465 We can't just reset it in the case that some window that displays
13466 it has not been redisplayed; and such a window can stay
13467 unredisplayed for a long time if it's currently invisible.
13468 But we do want to reset it at the end of redisplay otherwise
13469 its displayed windows will keep being redisplayed over and over
13471 So we copy all b->text->redisplay flags up to their windows here,
13472 such that mark_window_display_accurate can safely reset
13473 b->text->redisplay. */
13474 Lisp_Object ws
= window_list ();
13475 for (; CONSP (ws
); ws
= XCDR (ws
))
13477 struct window
*thisw
= XWINDOW (XCAR (ws
));
13478 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13479 if (thisb
->text
->redisplay
)
13480 thisw
->redisplay
= true;
13484 #define STOP_POLLING \
13485 do { if (! polling_stopped_here) stop_polling (); \
13486 polling_stopped_here = true; } while (false)
13488 #define RESUME_POLLING \
13489 do { if (polling_stopped_here) start_polling (); \
13490 polling_stopped_here = false; } while (false)
13493 /* Perhaps in the future avoid recentering windows if it
13494 is not necessary; currently that causes some problems. */
13497 redisplay_internal (void)
13499 struct window
*w
= XWINDOW (selected_window
);
13503 bool must_finish
= false, match_p
;
13504 struct text_pos tlbufpos
, tlendpos
;
13505 int number_of_visible_frames
;
13508 bool polling_stopped_here
= false;
13509 Lisp_Object tail
, frame
;
13511 /* True means redisplay has to consider all windows on all
13512 frames. False, only selected_window is considered. */
13513 bool consider_all_windows_p
;
13515 /* True means redisplay has to redisplay the miniwindow. */
13516 bool update_miniwindow_p
= false;
13518 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13520 /* No redisplay if running in batch mode or frame is not yet fully
13521 initialized, or redisplay is explicitly turned off by setting
13522 Vinhibit_redisplay. */
13523 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13524 || !NILP (Vinhibit_redisplay
))
13527 /* Don't examine these until after testing Vinhibit_redisplay.
13528 When Emacs is shutting down, perhaps because its connection to
13529 X has dropped, we should not look at them at all. */
13530 fr
= XFRAME (w
->frame
);
13531 sf
= SELECTED_FRAME ();
13533 if (!fr
->glyphs_initialized_p
)
13536 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13537 if (popup_activated ())
13541 /* I don't think this happens but let's be paranoid. */
13542 if (redisplaying_p
)
13545 /* Record a function that clears redisplaying_p
13546 when we leave this function. */
13547 count
= SPECPDL_INDEX ();
13548 record_unwind_protect_void (unwind_redisplay
);
13549 redisplaying_p
= true;
13550 specbind (Qinhibit_free_realized_faces
, Qnil
);
13552 /* Record this function, so it appears on the profiler's backtraces. */
13553 record_in_backtrace (Qredisplay_internal_xC_functionx
, 0, 0);
13555 FOR_EACH_FRAME (tail
, frame
)
13556 XFRAME (frame
)->already_hscrolled_p
= false;
13559 /* Remember the currently selected window. */
13563 forget_escape_and_glyphless_faces ();
13565 inhibit_free_realized_faces
= false;
13567 /* If face_change, init_iterator will free all realized faces, which
13568 includes the faces referenced from current matrices. So, we
13569 can't reuse current matrices in this case. */
13571 windows_or_buffers_changed
= 47;
13573 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13574 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13576 /* Since frames on a single ASCII terminal share the same
13577 display area, displaying a different frame means redisplay
13578 the whole thing. */
13579 SET_FRAME_GARBAGED (sf
);
13581 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13583 FRAME_TTY (sf
)->previous_frame
= sf
;
13586 /* Set the visible flags for all frames. Do this before checking for
13587 resized or garbaged frames; they want to know if their frames are
13588 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13589 number_of_visible_frames
= 0;
13591 FOR_EACH_FRAME (tail
, frame
)
13593 struct frame
*f
= XFRAME (frame
);
13595 if (FRAME_VISIBLE_P (f
))
13597 ++number_of_visible_frames
;
13598 /* Adjust matrices for visible frames only. */
13599 if (f
->fonts_changed
)
13601 adjust_frame_glyphs (f
);
13602 /* Disable all redisplay optimizations for this frame.
13603 This is because adjust_frame_glyphs resets the
13604 enabled_p flag for all glyph rows of all windows, so
13605 many optimizations will fail anyway, and some might
13606 fail to test that flag and do bogus things as
13608 SET_FRAME_GARBAGED (f
);
13609 f
->fonts_changed
= false;
13611 /* If cursor type has been changed on the frame
13612 other than selected, consider all frames. */
13613 if (f
!= sf
&& f
->cursor_type_changed
)
13614 fset_redisplay (f
);
13616 clear_desired_matrices (f
);
13619 /* Notice any pending interrupt request to change frame size. */
13620 do_pending_window_change (true);
13622 /* do_pending_window_change could change the selected_window due to
13623 frame resizing which makes the selected window too small. */
13624 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13627 /* Clear frames marked as garbaged. */
13628 clear_garbaged_frames ();
13630 /* Build menubar and tool-bar items. */
13631 if (NILP (Vmemory_full
))
13632 prepare_menu_bars ();
13634 reconsider_clip_changes (w
);
13636 /* In most cases selected window displays current buffer. */
13637 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13640 /* Detect case that we need to write or remove a star in the mode line. */
13641 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13642 w
->update_mode_line
= true;
13644 if (mode_line_update_needed (w
))
13645 w
->update_mode_line
= true;
13647 /* If reconsider_clip_changes above decided that the narrowing
13648 in the current buffer changed, make sure all other windows
13649 showing that buffer will be redisplayed. */
13650 if (current_buffer
->clip_changed
)
13651 bset_update_mode_line (current_buffer
);
13654 /* Normally the message* functions will have already displayed and
13655 updated the echo area, but the frame may have been trashed, or
13656 the update may have been preempted, so display the echo area
13657 again here. Checking message_cleared_p captures the case that
13658 the echo area should be cleared. */
13659 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13660 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13661 || (message_cleared_p
13662 && minibuf_level
== 0
13663 /* If the mini-window is currently selected, this means the
13664 echo-area doesn't show through. */
13665 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13667 echo_area_display (false);
13669 /* If echo_area_display resizes the mini-window, the redisplay and
13670 window_sizes_changed flags of the selected frame are set, but
13671 it's too late for the hooks in window-size-change-functions,
13672 which have been examined already in prepare_menu_bars. So in
13673 that case we call the hooks here only for the selected frame. */
13676 ptrdiff_t count1
= SPECPDL_INDEX ();
13678 record_unwind_save_match_data ();
13679 run_window_size_change_functions (selected_frame
);
13680 unbind_to (count1
, Qnil
);
13683 if (message_cleared_p
)
13684 update_miniwindow_p
= true;
13686 must_finish
= true;
13688 /* If we don't display the current message, don't clear the
13689 message_cleared_p flag, because, if we did, we wouldn't clear
13690 the echo area in the next redisplay which doesn't preserve
13692 if (!display_last_displayed_message_p
)
13693 message_cleared_p
= false;
13695 else if (EQ (selected_window
, minibuf_window
)
13696 && (current_buffer
->clip_changed
|| window_outdated (w
))
13697 && resize_mini_window (w
, false))
13701 ptrdiff_t count1
= SPECPDL_INDEX ();
13703 record_unwind_save_match_data ();
13704 run_window_size_change_functions (selected_frame
);
13705 unbind_to (count1
, Qnil
);
13708 /* Resized active mini-window to fit the size of what it is
13709 showing if its contents might have changed. */
13710 must_finish
= true;
13712 /* If window configuration was changed, frames may have been
13713 marked garbaged. Clear them or we will experience
13714 surprises wrt scrolling. */
13715 clear_garbaged_frames ();
13718 if (windows_or_buffers_changed
&& !update_mode_lines
)
13719 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13720 only the windows's contents needs to be refreshed, or whether the
13721 mode-lines also need a refresh. */
13722 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13723 ? REDISPLAY_SOME
: 32);
13725 /* If specs for an arrow have changed, do thorough redisplay
13726 to ensure we remove any arrow that should no longer exist. */
13727 if (overlay_arrows_changed_p ())
13728 /* Apparently, this is the only case where we update other windows,
13729 without updating other mode-lines. */
13730 windows_or_buffers_changed
= 49;
13732 consider_all_windows_p
= (update_mode_lines
13733 || windows_or_buffers_changed
);
13735 #define AINC(a,i) \
13737 Lisp_Object entry = Fgethash (make_number (i), a, make_number (0)); \
13738 if (INTEGERP (entry)) \
13739 Fputhash (make_number (i), make_number (1 + XINT (entry)), a); \
13742 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13743 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13745 /* Optimize the case that only the line containing the cursor in the
13746 selected window has changed. Variables starting with this_ are
13747 set in display_line and record information about the line
13748 containing the cursor. */
13749 tlbufpos
= this_line_start_pos
;
13750 tlendpos
= this_line_end_pos
;
13751 if (!consider_all_windows_p
13752 && CHARPOS (tlbufpos
) > 0
13753 && !w
->update_mode_line
13754 && !current_buffer
->clip_changed
13755 && !current_buffer
->prevent_redisplay_optimizations_p
13756 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13757 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13758 && !XFRAME (w
->frame
)->cursor_type_changed
13759 && !XFRAME (w
->frame
)->face_change
13760 /* Make sure recorded data applies to current buffer, etc. */
13761 && this_line_buffer
== current_buffer
13764 && !w
->optional_new_start
13765 /* Point must be on the line that we have info recorded about. */
13766 && PT
>= CHARPOS (tlbufpos
)
13767 && PT
<= Z
- CHARPOS (tlendpos
)
13768 /* All text outside that line, including its final newline,
13769 must be unchanged. */
13770 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13771 CHARPOS (tlendpos
)))
13773 if (CHARPOS (tlbufpos
) > BEGV
13774 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13775 && (CHARPOS (tlbufpos
) == ZV
13776 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13777 /* Former continuation line has disappeared by becoming empty. */
13779 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13781 /* We have to handle the case of continuation around a
13782 wide-column character (see the comment in indent.c around
13785 For instance, in the following case:
13787 -------- Insert --------
13788 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13789 J_I_ ==> J_I_ `^^' are cursors.
13793 As we have to redraw the line above, we cannot use this
13797 int line_height_before
= this_line_pixel_height
;
13799 /* Note that start_display will handle the case that the
13800 line starting at tlbufpos is a continuation line. */
13801 start_display (&it
, w
, tlbufpos
);
13803 /* Implementation note: It this still necessary? */
13804 if (it
.current_x
!= this_line_start_x
)
13807 TRACE ((stderr
, "trying display optimization 1\n"));
13808 w
->cursor
.vpos
= -1;
13809 overlay_arrow_seen
= false;
13810 it
.vpos
= this_line_vpos
;
13811 it
.current_y
= this_line_y
;
13812 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13813 display_line (&it
);
13815 /* If line contains point, is not continued,
13816 and ends at same distance from eob as before, we win. */
13817 if (w
->cursor
.vpos
>= 0
13818 /* Line is not continued, otherwise this_line_start_pos
13819 would have been set to 0 in display_line. */
13820 && CHARPOS (this_line_start_pos
)
13821 /* Line ends as before. */
13822 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13823 /* Line has same height as before. Otherwise other lines
13824 would have to be shifted up or down. */
13825 && this_line_pixel_height
== line_height_before
)
13827 /* If this is not the window's last line, we must adjust
13828 the charstarts of the lines below. */
13829 if (it
.current_y
< it
.last_visible_y
)
13831 struct glyph_row
*row
13832 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13833 ptrdiff_t delta
, delta_bytes
;
13835 /* We used to distinguish between two cases here,
13836 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13837 when the line ends in a newline or the end of the
13838 buffer's accessible portion. But both cases did
13839 the same, so they were collapsed. */
13841 - CHARPOS (tlendpos
)
13842 - MATRIX_ROW_START_CHARPOS (row
));
13843 delta_bytes
= (Z_BYTE
13844 - BYTEPOS (tlendpos
)
13845 - MATRIX_ROW_START_BYTEPOS (row
));
13847 increment_matrix_positions (w
->current_matrix
,
13848 this_line_vpos
+ 1,
13849 w
->current_matrix
->nrows
,
13850 delta
, delta_bytes
);
13853 /* If this row displays text now but previously didn't,
13854 or vice versa, w->window_end_vpos may have to be
13856 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13858 if (w
->window_end_vpos
< this_line_vpos
)
13859 w
->window_end_vpos
= this_line_vpos
;
13861 else if (w
->window_end_vpos
== this_line_vpos
13862 && this_line_vpos
> 0)
13863 w
->window_end_vpos
= this_line_vpos
- 1;
13864 w
->window_end_valid
= false;
13866 /* Update hint: No need to try to scroll in update_window. */
13867 w
->desired_matrix
->no_scrolling_p
= true;
13870 *w
->desired_matrix
->method
= 0;
13871 debug_method_add (w
, "optimization 1");
13873 #ifdef HAVE_WINDOW_SYSTEM
13874 update_window_fringes (w
, false);
13881 else if (/* Cursor position hasn't changed. */
13882 PT
== w
->last_point
13883 /* Make sure the cursor was last displayed
13884 in this window. Otherwise we have to reposition it. */
13886 /* PXW: Must be converted to pixels, probably. */
13887 && 0 <= w
->cursor
.vpos
13888 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13892 do_pending_window_change (true);
13893 /* If selected_window changed, redisplay again. */
13894 if (WINDOWP (selected_window
)
13895 && (w
= XWINDOW (selected_window
)) != sw
)
13898 /* We used to always goto end_of_redisplay here, but this
13899 isn't enough if we have a blinking cursor. */
13900 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13901 goto end_of_redisplay
;
13905 /* If highlighting the region, or if the cursor is in the echo area,
13906 then we can't just move the cursor. */
13907 else if (NILP (Vshow_trailing_whitespace
)
13908 && !cursor_in_echo_area
)
13911 struct glyph_row
*row
;
13913 /* Skip from tlbufpos to PT and see where it is. Note that
13914 PT may be in invisible text. If so, we will end at the
13915 next visible position. */
13916 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13917 NULL
, DEFAULT_FACE_ID
);
13918 it
.current_x
= this_line_start_x
;
13919 it
.current_y
= this_line_y
;
13920 it
.vpos
= this_line_vpos
;
13922 /* The call to move_it_to stops in front of PT, but
13923 moves over before-strings. */
13924 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13926 if (it
.vpos
== this_line_vpos
13927 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13930 eassert (this_line_vpos
== it
.vpos
);
13931 eassert (this_line_y
== it
.current_y
);
13932 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13933 if (cursor_row_fully_visible_p (w
, false, true))
13936 *w
->desired_matrix
->method
= 0;
13937 debug_method_add (w
, "optimization 3");
13949 /* Text changed drastically or point moved off of line. */
13950 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13953 CHARPOS (this_line_start_pos
) = 0;
13954 ++clear_face_cache_count
;
13955 #ifdef HAVE_WINDOW_SYSTEM
13956 ++clear_image_cache_count
;
13959 /* Build desired matrices, and update the display. If
13960 consider_all_windows_p, do it for all windows on all frames that
13961 require redisplay, as specified by their 'redisplay' flag.
13962 Otherwise do it for selected_window, only. */
13964 if (consider_all_windows_p
)
13966 FOR_EACH_FRAME (tail
, frame
)
13967 XFRAME (frame
)->updated_p
= false;
13969 propagate_buffer_redisplay ();
13971 FOR_EACH_FRAME (tail
, frame
)
13973 struct frame
*f
= XFRAME (frame
);
13975 /* We don't have to do anything for unselected terminal
13977 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13978 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13982 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13985 /* Only GC scrollbars when we redisplay the whole frame. */
13986 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13987 bool f_redisplay_flag
= f
->redisplay
;
13988 /* Mark all the scroll bars to be removed; we'll redeem
13989 the ones we want when we redisplay their windows. */
13990 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13991 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13993 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13994 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13995 /* Remember that the invisible frames need to be redisplayed next
13996 time they're visible. */
13997 else if (!REDISPLAY_SOME_P ())
13998 f
->redisplay
= true;
14000 /* The X error handler may have deleted that frame. */
14001 if (!FRAME_LIVE_P (f
))
14004 /* Any scroll bars which redisplay_windows should have
14005 nuked should now go away. */
14006 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
14007 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
14009 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
14011 /* If fonts changed on visible frame, display again. */
14012 if (f
->fonts_changed
)
14014 adjust_frame_glyphs (f
);
14015 /* Disable all redisplay optimizations for this
14016 frame. For the reasons, see the comment near
14017 the previous call to adjust_frame_glyphs above. */
14018 SET_FRAME_GARBAGED (f
);
14019 f
->fonts_changed
= false;
14023 /* See if we have to hscroll. */
14024 if (!f
->already_hscrolled_p
)
14026 f
->already_hscrolled_p
= true;
14027 if (hscroll_windows (f
->root_window
))
14031 /* If the frame's redisplay flag was not set before
14032 we went about redisplaying its windows, but it is
14033 set now, that means we employed some redisplay
14034 optimizations inside redisplay_windows, and
14035 bypassed producing some screen lines. But if
14036 f->redisplay is now set, it might mean the old
14037 faces are no longer valid (e.g., if redisplaying
14038 some window called some Lisp which defined a new
14039 face or redefined an existing face), so trying to
14040 use them in update_frame will segfault.
14041 Therefore, we must redisplay this frame. */
14042 if (!f_redisplay_flag
&& f
->redisplay
)
14045 /* Prevent various kinds of signals during display
14046 update. stdio is not robust about handling
14047 signals, which can cause an apparent I/O error. */
14048 if (interrupt_input
)
14049 unrequest_sigio ();
14052 pending
|= update_frame (f
, false, false);
14053 f
->cursor_type_changed
= false;
14054 f
->updated_p
= true;
14059 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
14063 /* Do the mark_window_display_accurate after all windows have
14064 been redisplayed because this call resets flags in buffers
14065 which are needed for proper redisplay. */
14066 FOR_EACH_FRAME (tail
, frame
)
14068 struct frame
*f
= XFRAME (frame
);
14071 f
->redisplay
= false;
14072 mark_window_display_accurate (f
->root_window
, true);
14073 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
14074 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
14079 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
14081 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
14082 /* Use list_of_error, not Qerror, so that
14083 we catch only errors and don't run the debugger. */
14084 internal_condition_case_1 (redisplay_window_1
, selected_window
,
14086 redisplay_window_error
);
14087 if (update_miniwindow_p
)
14088 internal_condition_case_1 (redisplay_window_1
,
14089 FRAME_MINIBUF_WINDOW (sf
), list_of_error
,
14090 redisplay_window_error
);
14092 /* Compare desired and current matrices, perform output. */
14095 /* If fonts changed, display again. Likewise if redisplay_window_1
14096 above caused some change (e.g., a change in faces) that requires
14097 considering the entire frame again. */
14098 if (sf
->fonts_changed
|| sf
->redisplay
)
14102 /* Set this to force a more thorough redisplay.
14103 Otherwise, we might immediately loop back to the
14104 above "else-if" clause (since all the conditions that
14105 led here might still be true), and we will then
14106 infloop, because the selected-frame's redisplay flag
14107 is not (and cannot be) reset. */
14108 windows_or_buffers_changed
= 50;
14113 /* Prevent freeing of realized faces, since desired matrices are
14114 pending that reference the faces we computed and cached. */
14115 inhibit_free_realized_faces
= true;
14117 /* Prevent various kinds of signals during display update.
14118 stdio is not robust about handling signals,
14119 which can cause an apparent I/O error. */
14120 if (interrupt_input
)
14121 unrequest_sigio ();
14124 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
14126 if (hscroll_windows (selected_window
))
14129 XWINDOW (selected_window
)->must_be_updated_p
= true;
14130 pending
= update_frame (sf
, false, false);
14131 sf
->cursor_type_changed
= false;
14134 /* We may have called echo_area_display at the top of this
14135 function. If the echo area is on another frame, that may
14136 have put text on a frame other than the selected one, so the
14137 above call to update_frame would not have caught it. Catch
14139 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
14140 struct frame
*mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
14142 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
14144 XWINDOW (mini_window
)->must_be_updated_p
= true;
14145 pending
|= update_frame (mini_frame
, false, false);
14146 mini_frame
->cursor_type_changed
= false;
14147 if (!pending
&& hscroll_windows (mini_window
))
14152 /* If display was paused because of pending input, make sure we do a
14153 thorough update the next time. */
14156 /* Prevent the optimization at the beginning of
14157 redisplay_internal that tries a single-line update of the
14158 line containing the cursor in the selected window. */
14159 CHARPOS (this_line_start_pos
) = 0;
14161 /* Let the overlay arrow be updated the next time. */
14162 update_overlay_arrows (0);
14164 /* If we pause after scrolling, some rows in the current
14165 matrices of some windows are not valid. */
14166 if (!WINDOW_FULL_WIDTH_P (w
)
14167 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
14168 update_mode_lines
= 36;
14172 if (!consider_all_windows_p
)
14174 /* This has already been done above if
14175 consider_all_windows_p is set. */
14176 if (XBUFFER (w
->contents
)->text
->redisplay
14177 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
14178 /* This can happen if b->text->redisplay was set during
14180 propagate_buffer_redisplay ();
14181 mark_window_display_accurate_1 (w
, true);
14183 /* Say overlay arrows are up to date. */
14184 update_overlay_arrows (1);
14186 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
14187 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
14190 update_mode_lines
= 0;
14191 windows_or_buffers_changed
= 0;
14194 /* Start SIGIO interrupts coming again. Having them off during the
14195 code above makes it less likely one will discard output, but not
14196 impossible, since there might be stuff in the system buffer here.
14197 But it is much hairier to try to do anything about that. */
14198 if (interrupt_input
)
14202 /* If a frame has become visible which was not before, redisplay
14203 again, so that we display it. Expose events for such a frame
14204 (which it gets when becoming visible) don't call the parts of
14205 redisplay constructing glyphs, so simply exposing a frame won't
14206 display anything in this case. So, we have to display these
14207 frames here explicitly. */
14212 FOR_EACH_FRAME (tail
, frame
)
14214 if (XFRAME (frame
)->visible
)
14218 if (new_count
!= number_of_visible_frames
)
14219 windows_or_buffers_changed
= 52;
14222 /* Change frame size now if a change is pending. */
14223 do_pending_window_change (true);
14225 /* If we just did a pending size change, or have additional
14226 visible frames, or selected_window changed, redisplay again. */
14227 if ((windows_or_buffers_changed
&& !pending
)
14228 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14231 /* Clear the face and image caches.
14233 We used to do this only if consider_all_windows_p. But the cache
14234 needs to be cleared if a timer creates images in the current
14235 buffer (e.g. the test case in Bug#6230). */
14237 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14239 clear_face_cache (false);
14240 clear_face_cache_count
= 0;
14243 #ifdef HAVE_WINDOW_SYSTEM
14244 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14246 clear_image_caches (Qnil
);
14247 clear_image_cache_count
= 0;
14249 #endif /* HAVE_WINDOW_SYSTEM */
14253 ns_set_doc_edited ();
14255 if (interrupt_input
&& interrupts_deferred
)
14258 unbind_to (count
, Qnil
);
14263 /* Redisplay, but leave alone any recent echo area message unless
14264 another message has been requested in its place.
14266 This is useful in situations where you need to redisplay but no
14267 user action has occurred, making it inappropriate for the message
14268 area to be cleared. See tracking_off and
14269 wait_reading_process_output for examples of these situations.
14271 FROM_WHERE is an integer saying from where this function was
14272 called. This is useful for debugging. */
14275 redisplay_preserve_echo_area (int from_where
)
14277 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14279 if (!NILP (echo_area_buffer
[1]))
14281 /* We have a previously displayed message, but no current
14282 message. Redisplay the previous message. */
14283 display_last_displayed_message_p
= true;
14284 redisplay_internal ();
14285 display_last_displayed_message_p
= false;
14288 redisplay_internal ();
14290 flush_frame (SELECTED_FRAME ());
14294 /* Function registered with record_unwind_protect in redisplay_internal. */
14297 unwind_redisplay (void)
14299 redisplaying_p
= false;
14303 /* Mark the display of leaf window W as accurate or inaccurate.
14304 If ACCURATE_P, mark display of W as accurate.
14305 If !ACCURATE_P, arrange for W to be redisplayed the next
14306 time redisplay_internal is called. */
14309 mark_window_display_accurate_1 (struct window
*w
, bool accurate_p
)
14311 struct buffer
*b
= XBUFFER (w
->contents
);
14313 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14314 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14315 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14319 b
->clip_changed
= false;
14320 b
->prevent_redisplay_optimizations_p
= false;
14321 eassert (buffer_window_count (b
) > 0);
14322 /* Resetting b->text->redisplay is problematic!
14323 In order to make it safer to do it here, redisplay_internal must
14324 have copied all b->text->redisplay to their respective windows. */
14325 b
->text
->redisplay
= false;
14327 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14328 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14329 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14330 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14332 w
->current_matrix
->buffer
= b
;
14333 w
->current_matrix
->begv
= BUF_BEGV (b
);
14334 w
->current_matrix
->zv
= BUF_ZV (b
);
14336 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14337 w
->last_cursor_off_p
= w
->cursor_off_p
;
14339 if (w
== XWINDOW (selected_window
))
14340 w
->last_point
= BUF_PT (b
);
14342 w
->last_point
= marker_position (w
->pointm
);
14344 w
->window_end_valid
= true;
14345 w
->update_mode_line
= false;
14348 w
->redisplay
= !accurate_p
;
14352 /* Mark the display of windows in the window tree rooted at WINDOW as
14353 accurate or inaccurate. If ACCURATE_P, mark display of
14354 windows as accurate. If !ACCURATE_P, arrange for windows to
14355 be redisplayed the next time redisplay_internal is called. */
14358 mark_window_display_accurate (Lisp_Object window
, bool accurate_p
)
14362 for (; !NILP (window
); window
= w
->next
)
14364 w
= XWINDOW (window
);
14365 if (WINDOWP (w
->contents
))
14366 mark_window_display_accurate (w
->contents
, accurate_p
);
14368 mark_window_display_accurate_1 (w
, accurate_p
);
14372 update_overlay_arrows (1);
14374 /* Force a thorough redisplay the next time by setting
14375 last_arrow_position and last_arrow_string to t, which is
14376 unequal to any useful value of Voverlay_arrow_... */
14377 update_overlay_arrows (-1);
14381 /* Return value in display table DP (Lisp_Char_Table *) for character
14382 C. Since a display table doesn't have any parent, we don't have to
14383 follow parent. Do not call this function directly but use the
14384 macro DISP_CHAR_VECTOR. */
14387 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14391 if (ASCII_CHAR_P (c
))
14394 if (SUB_CHAR_TABLE_P (val
))
14395 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14401 XSETCHAR_TABLE (table
, dp
);
14402 val
= char_table_ref (table
, c
);
14411 /***********************************************************************
14413 ***********************************************************************/
14415 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14418 redisplay_windows (Lisp_Object window
)
14420 while (!NILP (window
))
14422 struct window
*w
= XWINDOW (window
);
14424 if (WINDOWP (w
->contents
))
14425 redisplay_windows (w
->contents
);
14426 else if (BUFFERP (w
->contents
))
14428 displayed_buffer
= XBUFFER (w
->contents
);
14429 /* Use list_of_error, not Qerror, so that
14430 we catch only errors and don't run the debugger. */
14431 internal_condition_case_1 (redisplay_window_0
, window
,
14433 redisplay_window_error
);
14441 redisplay_window_error (Lisp_Object ignore
)
14443 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14448 redisplay_window_0 (Lisp_Object window
)
14450 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14451 redisplay_window (window
, false);
14456 redisplay_window_1 (Lisp_Object window
)
14458 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14459 redisplay_window (window
, true);
14464 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14465 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14466 which positions recorded in ROW differ from current buffer
14469 Return true iff cursor is on this row. */
14472 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14473 struct glyph_matrix
*matrix
,
14474 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14477 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14478 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14479 struct glyph
*cursor
= NULL
;
14480 /* The last known character position in row. */
14481 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14483 ptrdiff_t pt_old
= PT
- delta
;
14484 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14485 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14486 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14487 /* A glyph beyond the edge of TEXT_AREA which we should never
14489 struct glyph
*glyphs_end
= end
;
14490 /* True means we've found a match for cursor position, but that
14491 glyph has the avoid_cursor_p flag set. */
14492 bool match_with_avoid_cursor
= false;
14493 /* True means we've seen at least one glyph that came from a
14495 bool string_seen
= false;
14496 /* Largest and smallest buffer positions seen so far during scan of
14498 ptrdiff_t bpos_max
= pos_before
;
14499 ptrdiff_t bpos_min
= pos_after
;
14500 /* Last buffer position covered by an overlay string with an integer
14501 `cursor' property. */
14502 ptrdiff_t bpos_covered
= 0;
14503 /* True means the display string on which to display the cursor
14504 comes from a text property, not from an overlay. */
14505 bool string_from_text_prop
= false;
14507 /* Don't even try doing anything if called for a mode-line or
14508 header-line row, since the rest of the code isn't prepared to
14509 deal with such calamities. */
14510 eassert (!row
->mode_line_p
);
14511 if (row
->mode_line_p
)
14514 /* Skip over glyphs not having an object at the start and the end of
14515 the row. These are special glyphs like truncation marks on
14516 terminal frames. */
14517 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14519 if (!row
->reversed_p
)
14522 && NILP (glyph
->object
)
14523 && glyph
->charpos
< 0)
14525 x
+= glyph
->pixel_width
;
14529 && NILP ((end
- 1)->object
)
14530 /* CHARPOS is zero for blanks and stretch glyphs
14531 inserted by extend_face_to_end_of_line. */
14532 && (end
- 1)->charpos
<= 0)
14534 glyph_before
= glyph
- 1;
14541 /* If the glyph row is reversed, we need to process it from back
14542 to front, so swap the edge pointers. */
14543 glyphs_end
= end
= glyph
- 1;
14544 glyph
+= row
->used
[TEXT_AREA
] - 1;
14546 while (glyph
> end
+ 1
14547 && NILP (glyph
->object
)
14548 && glyph
->charpos
< 0)
14551 x
-= glyph
->pixel_width
;
14553 if (NILP (glyph
->object
) && glyph
->charpos
< 0)
14555 /* By default, in reversed rows we put the cursor on the
14556 rightmost (first in the reading order) glyph. */
14557 for (g
= end
+ 1; g
< glyph
; g
++)
14558 x
+= g
->pixel_width
;
14560 && NILP ((end
+ 1)->object
)
14561 && (end
+ 1)->charpos
<= 0)
14563 glyph_before
= glyph
+ 1;
14567 else if (row
->reversed_p
)
14569 /* In R2L rows that don't display text, put the cursor on the
14570 rightmost glyph. Case in point: an empty last line that is
14571 part of an R2L paragraph. */
14573 /* Avoid placing the cursor on the last glyph of the row, where
14574 on terminal frames we hold the vertical border between
14575 adjacent windows. */
14576 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14577 && !WINDOW_RIGHTMOST_P (w
)
14578 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14580 x
= -1; /* will be computed below, at label compute_x */
14583 /* Step 1: Try to find the glyph whose character position
14584 corresponds to point. If that's not possible, find 2 glyphs
14585 whose character positions are the closest to point, one before
14586 point, the other after it. */
14587 if (!row
->reversed_p
)
14588 while (/* not marched to end of glyph row */
14590 /* glyph was not inserted by redisplay for internal purposes */
14591 && !NILP (glyph
->object
))
14593 if (BUFFERP (glyph
->object
))
14595 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14597 if (glyph
->charpos
> bpos_max
)
14598 bpos_max
= glyph
->charpos
;
14599 if (glyph
->charpos
< bpos_min
)
14600 bpos_min
= glyph
->charpos
;
14601 if (!glyph
->avoid_cursor_p
)
14603 /* If we hit point, we've found the glyph on which to
14604 display the cursor. */
14607 match_with_avoid_cursor
= false;
14610 /* See if we've found a better approximation to
14611 POS_BEFORE or to POS_AFTER. */
14612 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14614 pos_before
= glyph
->charpos
;
14615 glyph_before
= glyph
;
14617 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14619 pos_after
= glyph
->charpos
;
14620 glyph_after
= glyph
;
14623 else if (dpos
== 0)
14624 match_with_avoid_cursor
= true;
14626 else if (STRINGP (glyph
->object
))
14628 Lisp_Object chprop
;
14629 ptrdiff_t glyph_pos
= glyph
->charpos
;
14631 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14633 if (!NILP (chprop
))
14635 /* If the string came from a `display' text property,
14636 look up the buffer position of that property and
14637 use that position to update bpos_max, as if we
14638 actually saw such a position in one of the row's
14639 glyphs. This helps with supporting integer values
14640 of `cursor' property on the display string in
14641 situations where most or all of the row's buffer
14642 text is completely covered by display properties,
14643 so that no glyph with valid buffer positions is
14644 ever seen in the row. */
14645 ptrdiff_t prop_pos
=
14646 string_buffer_position_lim (glyph
->object
, pos_before
,
14649 if (prop_pos
>= pos_before
)
14650 bpos_max
= prop_pos
;
14652 if (INTEGERP (chprop
))
14654 bpos_covered
= bpos_max
+ XINT (chprop
);
14655 /* If the `cursor' property covers buffer positions up
14656 to and including point, we should display cursor on
14657 this glyph. Note that, if a `cursor' property on one
14658 of the string's characters has an integer value, we
14659 will break out of the loop below _before_ we get to
14660 the position match above. IOW, integer values of
14661 the `cursor' property override the "exact match for
14662 point" strategy of positioning the cursor. */
14663 /* Implementation note: bpos_max == pt_old when, e.g.,
14664 we are in an empty line, where bpos_max is set to
14665 MATRIX_ROW_START_CHARPOS, see above. */
14666 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14673 string_seen
= true;
14675 x
+= glyph
->pixel_width
;
14678 else if (glyph
> end
) /* row is reversed */
14679 while (!NILP (glyph
->object
))
14681 if (BUFFERP (glyph
->object
))
14683 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14685 if (glyph
->charpos
> bpos_max
)
14686 bpos_max
= glyph
->charpos
;
14687 if (glyph
->charpos
< bpos_min
)
14688 bpos_min
= glyph
->charpos
;
14689 if (!glyph
->avoid_cursor_p
)
14693 match_with_avoid_cursor
= false;
14696 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14698 pos_before
= glyph
->charpos
;
14699 glyph_before
= glyph
;
14701 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14703 pos_after
= glyph
->charpos
;
14704 glyph_after
= glyph
;
14707 else if (dpos
== 0)
14708 match_with_avoid_cursor
= true;
14710 else if (STRINGP (glyph
->object
))
14712 Lisp_Object chprop
;
14713 ptrdiff_t glyph_pos
= glyph
->charpos
;
14715 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14717 if (!NILP (chprop
))
14719 ptrdiff_t prop_pos
=
14720 string_buffer_position_lim (glyph
->object
, pos_before
,
14723 if (prop_pos
>= pos_before
)
14724 bpos_max
= prop_pos
;
14726 if (INTEGERP (chprop
))
14728 bpos_covered
= bpos_max
+ XINT (chprop
);
14729 /* If the `cursor' property covers buffer positions up
14730 to and including point, we should display cursor on
14732 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14738 string_seen
= true;
14741 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14743 x
--; /* can't use any pixel_width */
14746 x
-= glyph
->pixel_width
;
14749 /* Step 2: If we didn't find an exact match for point, we need to
14750 look for a proper place to put the cursor among glyphs between
14751 GLYPH_BEFORE and GLYPH_AFTER. */
14752 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14753 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14754 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14756 /* An empty line has a single glyph whose OBJECT is nil and
14757 whose CHARPOS is the position of a newline on that line.
14758 Note that on a TTY, there are more glyphs after that, which
14759 were produced by extend_face_to_end_of_line, but their
14760 CHARPOS is zero or negative. */
14761 bool empty_line_p
=
14762 ((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14763 && NILP (glyph
->object
) && glyph
->charpos
> 0
14764 /* On a TTY, continued and truncated rows also have a glyph at
14765 their end whose OBJECT is nil and whose CHARPOS is
14766 positive (the continuation and truncation glyphs), but such
14767 rows are obviously not "empty". */
14768 && !(row
->continued_p
|| row
->truncated_on_right_p
));
14770 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14772 ptrdiff_t ellipsis_pos
;
14774 /* Scan back over the ellipsis glyphs. */
14775 if (!row
->reversed_p
)
14777 ellipsis_pos
= (glyph
- 1)->charpos
;
14778 while (glyph
> row
->glyphs
[TEXT_AREA
]
14779 && (glyph
- 1)->charpos
== ellipsis_pos
)
14780 glyph
--, x
-= glyph
->pixel_width
;
14781 /* That loop always goes one position too far, including
14782 the glyph before the ellipsis. So scan forward over
14784 x
+= glyph
->pixel_width
;
14787 else /* row is reversed */
14789 ellipsis_pos
= (glyph
+ 1)->charpos
;
14790 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14791 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14792 glyph
++, x
+= glyph
->pixel_width
;
14793 x
-= glyph
->pixel_width
;
14797 else if (match_with_avoid_cursor
)
14799 cursor
= glyph_after
;
14802 else if (string_seen
)
14804 int incr
= row
->reversed_p
? -1 : +1;
14806 /* Need to find the glyph that came out of a string which is
14807 present at point. That glyph is somewhere between
14808 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14809 positioned between POS_BEFORE and POS_AFTER in the
14811 struct glyph
*start
, *stop
;
14812 ptrdiff_t pos
= pos_before
;
14816 /* If the row ends in a newline from a display string,
14817 reordering could have moved the glyphs belonging to the
14818 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14819 in this case we extend the search to the last glyph in
14820 the row that was not inserted by redisplay. */
14821 if (row
->ends_in_newline_from_string_p
)
14824 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14827 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14828 correspond to POS_BEFORE and POS_AFTER, respectively. We
14829 need START and STOP in the order that corresponds to the
14830 row's direction as given by its reversed_p flag. If the
14831 directionality of characters between POS_BEFORE and
14832 POS_AFTER is the opposite of the row's base direction,
14833 these characters will have been reordered for display,
14834 and we need to reverse START and STOP. */
14835 if (!row
->reversed_p
)
14837 start
= min (glyph_before
, glyph_after
);
14838 stop
= max (glyph_before
, glyph_after
);
14842 start
= max (glyph_before
, glyph_after
);
14843 stop
= min (glyph_before
, glyph_after
);
14845 for (glyph
= start
+ incr
;
14846 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14849 /* Any glyphs that come from the buffer are here because
14850 of bidi reordering. Skip them, and only pay
14851 attention to glyphs that came from some string. */
14852 if (STRINGP (glyph
->object
))
14856 /* If the display property covers the newline, we
14857 need to search for it one position farther. */
14858 ptrdiff_t lim
= pos_after
14859 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14861 string_from_text_prop
= false;
14862 str
= glyph
->object
;
14863 tem
= string_buffer_position_lim (str
, pos
, lim
, false);
14864 if (tem
== 0 /* from overlay */
14867 /* If the string from which this glyph came is
14868 found in the buffer at point, or at position
14869 that is closer to point than pos_after, then
14870 we've found the glyph we've been looking for.
14871 If it comes from an overlay (tem == 0), and
14872 it has the `cursor' property on one of its
14873 glyphs, record that glyph as a candidate for
14874 displaying the cursor. (As in the
14875 unidirectional version, we will display the
14876 cursor on the last candidate we find.) */
14879 || (tem
- pt_old
> 0 && tem
< pos_after
))
14881 /* The glyphs from this string could have
14882 been reordered. Find the one with the
14883 smallest string position. Or there could
14884 be a character in the string with the
14885 `cursor' property, which means display
14886 cursor on that character's glyph. */
14887 ptrdiff_t strpos
= glyph
->charpos
;
14892 string_from_text_prop
= true;
14895 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14896 && EQ (glyph
->object
, str
);
14900 ptrdiff_t gpos
= glyph
->charpos
;
14902 cprop
= Fget_char_property (make_number (gpos
),
14910 if (tem
&& glyph
->charpos
< strpos
)
14912 strpos
= glyph
->charpos
;
14918 || (tem
- pt_old
> 0 && tem
< pos_after
))
14922 pos
= tem
+ 1; /* don't find previous instances */
14924 /* This string is not what we want; skip all of the
14925 glyphs that came from it. */
14926 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14927 && EQ (glyph
->object
, str
))
14934 /* If we reached the end of the line, and END was from a string,
14935 the cursor is not on this line. */
14937 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14938 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14939 && STRINGP (end
->object
)
14940 && row
->continued_p
)
14943 /* A truncated row may not include PT among its character positions.
14944 Setting the cursor inside the scroll margin will trigger
14945 recalculation of hscroll in hscroll_window_tree. But if a
14946 display string covers point, defer to the string-handling
14947 code below to figure this out. */
14948 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14950 cursor
= glyph_before
;
14953 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14954 /* Zero-width characters produce no glyphs. */
14956 && (row
->reversed_p
14957 ? glyph_after
> glyphs_end
14958 : glyph_after
< glyphs_end
)))
14960 cursor
= glyph_after
;
14966 if (cursor
!= NULL
)
14968 else if (glyph
== glyphs_end
14969 && pos_before
== pos_after
14970 && STRINGP ((row
->reversed_p
14971 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14972 : row
->glyphs
[TEXT_AREA
])->object
))
14974 /* If all the glyphs of this row came from strings, put the
14975 cursor on the first glyph of the row. This avoids having the
14976 cursor outside of the text area in this very rare and hard
14980 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14981 : row
->glyphs
[TEXT_AREA
];
14987 /* Need to compute x that corresponds to GLYPH. */
14988 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14990 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14992 x
+= g
->pixel_width
;
14996 /* ROW could be part of a continued line, which, under bidi
14997 reordering, might have other rows whose start and end charpos
14998 occlude point. Only set w->cursor if we found a better
14999 approximation to the cursor position than we have from previously
15000 examined candidate rows belonging to the same continued line. */
15001 if (/* We already have a candidate row. */
15002 w
->cursor
.vpos
>= 0
15003 /* That candidate is not the row we are processing. */
15004 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
15005 /* Make sure cursor.vpos specifies a row whose start and end
15006 charpos occlude point, and it is valid candidate for being a
15007 cursor-row. This is because some callers of this function
15008 leave cursor.vpos at the row where the cursor was displayed
15009 during the last redisplay cycle. */
15010 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
15011 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
15012 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
15015 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
15017 /* Don't consider glyphs that are outside TEXT_AREA. */
15018 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
15020 /* Keep the candidate whose buffer position is the closest to
15021 point or has the `cursor' property. */
15022 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
15023 w
->cursor
.hpos
>= 0
15024 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
15025 && ((BUFFERP (g1
->object
)
15026 && (g1
->charpos
== pt_old
/* An exact match always wins. */
15027 || (BUFFERP (glyph
->object
)
15028 && eabs (g1
->charpos
- pt_old
)
15029 < eabs (glyph
->charpos
- pt_old
))))
15030 /* Previous candidate is a glyph from a string that has
15031 a non-nil `cursor' property. */
15032 || (STRINGP (g1
->object
)
15033 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
15034 Qcursor
, g1
->object
))
15035 /* Previous candidate is from the same display
15036 string as this one, and the display string
15037 came from a text property. */
15038 || (EQ (g1
->object
, glyph
->object
)
15039 && string_from_text_prop
)
15040 /* this candidate is from newline and its
15041 position is not an exact match */
15042 || (NILP (glyph
->object
)
15043 && glyph
->charpos
!= pt_old
)))))
15045 /* If this candidate gives an exact match, use that. */
15046 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
15047 /* If this candidate is a glyph created for the
15048 terminating newline of a line, and point is on that
15049 newline, it wins because it's an exact match. */
15050 || (!row
->continued_p
15051 && NILP (glyph
->object
)
15052 && glyph
->charpos
== 0
15053 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
15054 /* Otherwise, keep the candidate that comes from a row
15055 spanning less buffer positions. This may win when one or
15056 both candidate positions are on glyphs that came from
15057 display strings, for which we cannot compare buffer
15059 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
15060 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
15061 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
15064 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
15066 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
15067 w
->cursor
.y
= row
->y
+ dy
;
15069 if (w
== XWINDOW (selected_window
))
15071 if (!row
->continued_p
15072 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15075 this_line_buffer
= XBUFFER (w
->contents
);
15077 CHARPOS (this_line_start_pos
)
15078 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
15079 BYTEPOS (this_line_start_pos
)
15080 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
15082 CHARPOS (this_line_end_pos
)
15083 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
15084 BYTEPOS (this_line_end_pos
)
15085 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
15087 this_line_y
= w
->cursor
.y
;
15088 this_line_pixel_height
= row
->height
;
15089 this_line_vpos
= w
->cursor
.vpos
;
15090 this_line_start_x
= row
->x
;
15093 CHARPOS (this_line_start_pos
) = 0;
15100 /* Run window scroll functions, if any, for WINDOW with new window
15101 start STARTP. Sets the window start of WINDOW to that position.
15103 We assume that the window's buffer is really current. */
15105 static struct text_pos
15106 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
15108 struct window
*w
= XWINDOW (window
);
15109 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
15111 eassert (current_buffer
== XBUFFER (w
->contents
));
15113 if (!NILP (Vwindow_scroll_functions
))
15115 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
15116 make_number (CHARPOS (startp
)));
15117 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15118 /* In case the hook functions switch buffers. */
15119 set_buffer_internal (XBUFFER (w
->contents
));
15126 /* Make sure the line containing the cursor is fully visible.
15127 A value of true means there is nothing to be done.
15128 (Either the line is fully visible, or it cannot be made so,
15129 or we cannot tell.)
15131 If FORCE_P, return false even if partial visible cursor row
15132 is higher than window.
15134 If CURRENT_MATRIX_P, use the information from the
15135 window's current glyph matrix; otherwise use the desired glyph
15138 A value of false means the caller should do scrolling
15139 as if point had gone off the screen. */
15142 cursor_row_fully_visible_p (struct window
*w
, bool force_p
,
15143 bool current_matrix_p
)
15145 struct glyph_matrix
*matrix
;
15146 struct glyph_row
*row
;
15149 if (!make_cursor_line_fully_visible_p
)
15152 /* It's not always possible to find the cursor, e.g, when a window
15153 is full of overlay strings. Don't do anything in that case. */
15154 if (w
->cursor
.vpos
< 0)
15157 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
15158 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
15160 /* If the cursor row is not partially visible, there's nothing to do. */
15161 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
15164 /* If the row the cursor is in is taller than the window's height,
15165 it's not clear what to do, so do nothing. */
15166 window_height
= window_box_height (w
);
15167 if (row
->height
>= window_height
)
15169 if (!force_p
|| MINI_WINDOW_P (w
)
15170 || w
->vscroll
|| w
->cursor
.vpos
== 0)
15177 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
15178 means only WINDOW is redisplayed in redisplay_internal.
15179 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
15180 in redisplay_window to bring a partially visible line into view in
15181 the case that only the cursor has moved.
15183 LAST_LINE_MISFIT should be true if we're scrolling because the
15184 last screen line's vertical height extends past the end of the screen.
15188 1 if scrolling succeeded
15190 0 if scrolling didn't find point.
15192 -1 if new fonts have been loaded so that we must interrupt
15193 redisplay, adjust glyph matrices, and try again. */
15199 SCROLLING_NEED_LARGER_MATRICES
15202 /* If scroll-conservatively is more than this, never recenter.
15204 If you change this, don't forget to update the doc string of
15205 `scroll-conservatively' and the Emacs manual. */
15206 #define SCROLL_LIMIT 100
15209 try_scrolling (Lisp_Object window
, bool just_this_one_p
,
15210 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
15211 bool temp_scroll_step
, bool last_line_misfit
)
15213 struct window
*w
= XWINDOW (window
);
15214 struct frame
*f
= XFRAME (w
->frame
);
15215 struct text_pos pos
, startp
;
15217 int this_scroll_margin
, scroll_max
, rc
, height
;
15218 int dy
= 0, amount_to_scroll
= 0;
15219 bool scroll_down_p
= false;
15220 int extra_scroll_margin_lines
= last_line_misfit
;
15221 Lisp_Object aggressive
;
15222 /* We will never try scrolling more than this number of lines. */
15223 int scroll_limit
= SCROLL_LIMIT
;
15224 int frame_line_height
= default_line_pixel_height (w
);
15225 int window_total_lines
15226 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15229 debug_method_add (w
, "try_scrolling");
15232 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15234 /* Compute scroll margin height in pixels. We scroll when point is
15235 within this distance from the top or bottom of the window. */
15236 if (scroll_margin
> 0)
15237 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15238 * frame_line_height
;
15240 this_scroll_margin
= 0;
15242 /* Force arg_scroll_conservatively to have a reasonable value, to
15243 avoid scrolling too far away with slow move_it_* functions. Note
15244 that the user can supply scroll-conservatively equal to
15245 `most-positive-fixnum', which can be larger than INT_MAX. */
15246 if (arg_scroll_conservatively
> scroll_limit
)
15248 arg_scroll_conservatively
= scroll_limit
+ 1;
15249 scroll_max
= scroll_limit
* frame_line_height
;
15251 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15252 /* Compute how much we should try to scroll maximally to bring
15253 point into view. */
15254 scroll_max
= (max (scroll_step
,
15255 max (arg_scroll_conservatively
, temp_scroll_step
))
15256 * frame_line_height
);
15257 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15258 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15259 /* We're trying to scroll because of aggressive scrolling but no
15260 scroll_step is set. Choose an arbitrary one. */
15261 scroll_max
= 10 * frame_line_height
;
15267 /* Decide whether to scroll down. */
15268 if (PT
> CHARPOS (startp
))
15270 int scroll_margin_y
;
15272 /* Compute the pixel ypos of the scroll margin, then move IT to
15273 either that ypos or PT, whichever comes first. */
15274 start_display (&it
, w
, startp
);
15275 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15276 - frame_line_height
* extra_scroll_margin_lines
;
15277 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15278 (MOVE_TO_POS
| MOVE_TO_Y
));
15280 if (PT
> CHARPOS (it
.current
.pos
))
15282 int y0
= line_bottom_y (&it
);
15283 /* Compute how many pixels below window bottom to stop searching
15284 for PT. This avoids costly search for PT that is far away if
15285 the user limited scrolling by a small number of lines, but
15286 always finds PT if scroll_conservatively is set to a large
15287 number, such as most-positive-fixnum. */
15288 int slack
= max (scroll_max
, 10 * frame_line_height
);
15289 int y_to_move
= it
.last_visible_y
+ slack
;
15291 /* Compute the distance from the scroll margin to PT or to
15292 the scroll limit, whichever comes first. This should
15293 include the height of the cursor line, to make that line
15295 move_it_to (&it
, PT
, -1, y_to_move
,
15296 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15297 dy
= line_bottom_y (&it
) - y0
;
15299 if (dy
> scroll_max
)
15300 return SCROLLING_FAILED
;
15303 scroll_down_p
= true;
15309 /* Point is in or below the bottom scroll margin, so move the
15310 window start down. If scrolling conservatively, move it just
15311 enough down to make point visible. If scroll_step is set,
15312 move it down by scroll_step. */
15313 if (arg_scroll_conservatively
)
15315 = min (max (dy
, frame_line_height
),
15316 frame_line_height
* arg_scroll_conservatively
);
15317 else if (scroll_step
|| temp_scroll_step
)
15318 amount_to_scroll
= scroll_max
;
15321 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15322 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15323 if (NUMBERP (aggressive
))
15325 double float_amount
= XFLOATINT (aggressive
) * height
;
15326 int aggressive_scroll
= float_amount
;
15327 if (aggressive_scroll
== 0 && float_amount
> 0)
15328 aggressive_scroll
= 1;
15329 /* Don't let point enter the scroll margin near top of
15330 the window. This could happen if the value of
15331 scroll_up_aggressively is too large and there are
15332 non-zero margins, because scroll_up_aggressively
15333 means put point that fraction of window height
15334 _from_the_bottom_margin_. */
15335 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15336 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15337 amount_to_scroll
= dy
+ aggressive_scroll
;
15341 if (amount_to_scroll
<= 0)
15342 return SCROLLING_FAILED
;
15344 start_display (&it
, w
, startp
);
15345 if (arg_scroll_conservatively
<= scroll_limit
)
15346 move_it_vertically (&it
, amount_to_scroll
);
15349 /* Extra precision for users who set scroll-conservatively
15350 to a large number: make sure the amount we scroll
15351 the window start is never less than amount_to_scroll,
15352 which was computed as distance from window bottom to
15353 point. This matters when lines at window top and lines
15354 below window bottom have different height. */
15356 void *it1data
= NULL
;
15357 /* We use a temporary it1 because line_bottom_y can modify
15358 its argument, if it moves one line down; see there. */
15361 SAVE_IT (it1
, it
, it1data
);
15362 start_y
= line_bottom_y (&it1
);
15364 RESTORE_IT (&it
, &it
, it1data
);
15365 move_it_by_lines (&it
, 1);
15366 SAVE_IT (it1
, it
, it1data
);
15367 } while (IT_CHARPOS (it
) < ZV
15368 && line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15369 bidi_unshelve_cache (it1data
, true);
15372 /* If STARTP is unchanged, move it down another screen line. */
15373 if (IT_CHARPOS (it
) == CHARPOS (startp
))
15374 move_it_by_lines (&it
, 1);
15375 startp
= it
.current
.pos
;
15379 struct text_pos scroll_margin_pos
= startp
;
15382 /* See if point is inside the scroll margin at the top of the
15384 if (this_scroll_margin
)
15388 start_display (&it
, w
, startp
);
15389 y_start
= it
.current_y
;
15390 move_it_vertically (&it
, this_scroll_margin
);
15391 scroll_margin_pos
= it
.current
.pos
;
15392 /* If we didn't move enough before hitting ZV, request
15393 additional amount of scroll, to move point out of the
15395 if (IT_CHARPOS (it
) == ZV
15396 && it
.current_y
- y_start
< this_scroll_margin
)
15397 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15400 if (PT
< CHARPOS (scroll_margin_pos
))
15402 /* Point is in the scroll margin at the top of the window or
15403 above what is displayed in the window. */
15406 /* Compute the vertical distance from PT to the scroll
15407 margin position. Move as far as scroll_max allows, or
15408 one screenful, or 10 screen lines, whichever is largest.
15409 Give up if distance is greater than scroll_max or if we
15410 didn't reach the scroll margin position. */
15411 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15412 start_display (&it
, w
, pos
);
15414 y_to_move
= max (it
.last_visible_y
,
15415 max (scroll_max
, 10 * frame_line_height
));
15416 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15418 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15419 dy
= it
.current_y
- y0
;
15420 if (dy
> scroll_max
15421 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15422 return SCROLLING_FAILED
;
15424 /* Additional scroll for when ZV was too close to point. */
15427 /* Compute new window start. */
15428 start_display (&it
, w
, startp
);
15430 if (arg_scroll_conservatively
)
15431 amount_to_scroll
= max (dy
, frame_line_height
15432 * max (scroll_step
, temp_scroll_step
));
15433 else if (scroll_step
|| temp_scroll_step
)
15434 amount_to_scroll
= scroll_max
;
15437 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15438 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15439 if (NUMBERP (aggressive
))
15441 double float_amount
= XFLOATINT (aggressive
) * height
;
15442 int aggressive_scroll
= float_amount
;
15443 if (aggressive_scroll
== 0 && float_amount
> 0)
15444 aggressive_scroll
= 1;
15445 /* Don't let point enter the scroll margin near
15446 bottom of the window, if the value of
15447 scroll_down_aggressively happens to be too
15449 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15450 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15451 amount_to_scroll
= dy
+ aggressive_scroll
;
15455 if (amount_to_scroll
<= 0)
15456 return SCROLLING_FAILED
;
15458 move_it_vertically_backward (&it
, amount_to_scroll
);
15459 startp
= it
.current
.pos
;
15463 /* Run window scroll functions. */
15464 startp
= run_window_scroll_functions (window
, startp
);
15466 /* Display the window. Give up if new fonts are loaded, or if point
15468 if (!try_window (window
, startp
, 0))
15469 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15470 else if (w
->cursor
.vpos
< 0)
15472 clear_glyph_matrix (w
->desired_matrix
);
15473 rc
= SCROLLING_FAILED
;
15477 /* Maybe forget recorded base line for line number display. */
15478 if (!just_this_one_p
15479 || current_buffer
->clip_changed
15480 || BEG_UNCHANGED
< CHARPOS (startp
))
15481 w
->base_line_number
= 0;
15483 /* If cursor ends up on a partially visible line,
15484 treat that as being off the bottom of the screen. */
15485 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1,
15487 /* It's possible that the cursor is on the first line of the
15488 buffer, which is partially obscured due to a vscroll
15489 (Bug#7537). In that case, avoid looping forever. */
15490 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15492 clear_glyph_matrix (w
->desired_matrix
);
15493 ++extra_scroll_margin_lines
;
15496 rc
= SCROLLING_SUCCESS
;
15503 /* Compute a suitable window start for window W if display of W starts
15504 on a continuation line. Value is true if a new window start
15507 The new window start will be computed, based on W's width, starting
15508 from the start of the continued line. It is the start of the
15509 screen line with the minimum distance from the old start W->start. */
15512 compute_window_start_on_continuation_line (struct window
*w
)
15514 struct text_pos pos
, start_pos
;
15515 bool window_start_changed_p
= false;
15517 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15519 /* If window start is on a continuation line... Window start may be
15520 < BEGV in case there's invisible text at the start of the
15521 buffer (M-x rmail, for example). */
15522 if (CHARPOS (start_pos
) > BEGV
15523 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15526 struct glyph_row
*row
;
15528 /* Handle the case that the window start is out of range. */
15529 if (CHARPOS (start_pos
) < BEGV
)
15530 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15531 else if (CHARPOS (start_pos
) > ZV
)
15532 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15534 /* Find the start of the continued line. This should be fast
15535 because find_newline is fast (newline cache). */
15536 row
= w
->desired_matrix
->rows
+ WINDOW_WANTS_HEADER_LINE_P (w
);
15537 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15538 row
, DEFAULT_FACE_ID
);
15539 reseat_at_previous_visible_line_start (&it
);
15541 /* If the line start is "too far" away from the window start,
15542 say it takes too much time to compute a new window start. */
15543 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15544 /* PXW: Do we need upper bounds here? */
15545 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15547 int min_distance
, distance
;
15549 /* Move forward by display lines to find the new window
15550 start. If window width was enlarged, the new start can
15551 be expected to be > the old start. If window width was
15552 decreased, the new window start will be < the old start.
15553 So, we're looking for the display line start with the
15554 minimum distance from the old window start. */
15555 pos
= it
.current
.pos
;
15556 min_distance
= INFINITY
;
15557 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15558 distance
< min_distance
)
15560 min_distance
= distance
;
15561 pos
= it
.current
.pos
;
15562 if (it
.line_wrap
== WORD_WRAP
)
15564 /* Under WORD_WRAP, move_it_by_lines is likely to
15565 overshoot and stop not at the first, but the
15566 second character from the left margin. So in
15567 that case, we need a more tight control on the X
15568 coordinate of the iterator than move_it_by_lines
15569 promises in its contract. The method is to first
15570 go to the last (rightmost) visible character of a
15571 line, then move to the leftmost character on the
15572 next line in a separate call. */
15573 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15574 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15575 move_it_to (&it
, ZV
, 0,
15576 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15577 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15580 move_it_by_lines (&it
, 1);
15583 /* Set the window start there. */
15584 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15585 window_start_changed_p
= true;
15589 return window_start_changed_p
;
15593 /* Try cursor movement in case text has not changed in window WINDOW,
15594 with window start STARTP. Value is
15596 CURSOR_MOVEMENT_SUCCESS if successful
15598 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15600 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15601 display. *SCROLL_STEP is set to true, under certain circumstances, if
15602 we want to scroll as if scroll-step were set to 1. See the code.
15604 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15605 which case we have to abort this redisplay, and adjust matrices
15610 CURSOR_MOVEMENT_SUCCESS
,
15611 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15612 CURSOR_MOVEMENT_MUST_SCROLL
,
15613 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15617 try_cursor_movement (Lisp_Object window
, struct text_pos startp
,
15620 struct window
*w
= XWINDOW (window
);
15621 struct frame
*f
= XFRAME (w
->frame
);
15622 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15625 if (inhibit_try_cursor_movement
)
15629 /* Previously, there was a check for Lisp integer in the
15630 if-statement below. Now, this field is converted to
15631 ptrdiff_t, thus zero means invalid position in a buffer. */
15632 eassert (w
->last_point
> 0);
15633 /* Likewise there was a check whether window_end_vpos is nil or larger
15634 than the window. Now window_end_vpos is int and so never nil, but
15635 let's leave eassert to check whether it fits in the window. */
15636 eassert (!w
->window_end_valid
15637 || w
->window_end_vpos
< w
->current_matrix
->nrows
);
15639 /* Handle case where text has not changed, only point, and it has
15640 not moved off the frame. */
15641 if (/* Point may be in this window. */
15642 PT
>= CHARPOS (startp
)
15643 /* Selective display hasn't changed. */
15644 && !current_buffer
->clip_changed
15645 /* Function force-mode-line-update is used to force a thorough
15646 redisplay. It sets either windows_or_buffers_changed or
15647 update_mode_lines. So don't take a shortcut here for these
15649 && !update_mode_lines
15650 && !windows_or_buffers_changed
15651 && !f
->cursor_type_changed
15652 && NILP (Vshow_trailing_whitespace
)
15653 /* This code is not used for mini-buffer for the sake of the case
15654 of redisplaying to replace an echo area message; since in
15655 that case the mini-buffer contents per se are usually
15656 unchanged. This code is of no real use in the mini-buffer
15657 since the handling of this_line_start_pos, etc., in redisplay
15658 handles the same cases. */
15659 && !EQ (window
, minibuf_window
)
15660 && (FRAME_WINDOW_P (f
)
15661 || !overlay_arrow_in_current_buffer_p ()))
15663 int this_scroll_margin
, top_scroll_margin
;
15664 struct glyph_row
*row
= NULL
;
15665 int frame_line_height
= default_line_pixel_height (w
);
15666 int window_total_lines
15667 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15670 debug_method_add (w
, "cursor movement");
15673 /* Scroll if point within this distance from the top or bottom
15674 of the window. This is a pixel value. */
15675 if (scroll_margin
> 0)
15677 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15678 this_scroll_margin
*= frame_line_height
;
15681 this_scroll_margin
= 0;
15683 top_scroll_margin
= this_scroll_margin
;
15684 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15685 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15687 /* Start with the row the cursor was displayed during the last
15688 not paused redisplay. Give up if that row is not valid. */
15689 if (w
->last_cursor_vpos
< 0
15690 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15691 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15694 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15695 if (row
->mode_line_p
)
15697 if (!row
->enabled_p
)
15698 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15701 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15703 bool scroll_p
= false, must_scroll
= false;
15704 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15706 if (PT
> w
->last_point
)
15708 /* Point has moved forward. */
15709 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15710 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15712 eassert (row
->enabled_p
);
15716 /* If the end position of a row equals the start
15717 position of the next row, and PT is at that position,
15718 we would rather display cursor in the next line. */
15719 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15720 && MATRIX_ROW_END_CHARPOS (row
) == PT
15721 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15722 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15723 && !cursor_row_p (row
))
15726 /* If within the scroll margin, scroll. Note that
15727 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15728 the next line would be drawn, and that
15729 this_scroll_margin can be zero. */
15730 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15731 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15732 /* Line is completely visible last line in window
15733 and PT is to be set in the next line. */
15734 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15735 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15736 && !row
->ends_at_zv_p
15737 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15740 else if (PT
< w
->last_point
)
15742 /* Cursor has to be moved backward. Note that PT >=
15743 CHARPOS (startp) because of the outer if-statement. */
15744 while (!row
->mode_line_p
15745 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15746 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15747 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15748 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15749 row
> w
->current_matrix
->rows
15750 && (row
-1)->ends_in_newline_from_string_p
))))
15751 && (row
->y
> top_scroll_margin
15752 || CHARPOS (startp
) == BEGV
))
15754 eassert (row
->enabled_p
);
15758 /* Consider the following case: Window starts at BEGV,
15759 there is invisible, intangible text at BEGV, so that
15760 display starts at some point START > BEGV. It can
15761 happen that we are called with PT somewhere between
15762 BEGV and START. Try to handle that case. */
15763 if (row
< w
->current_matrix
->rows
15764 || row
->mode_line_p
)
15766 row
= w
->current_matrix
->rows
;
15767 if (row
->mode_line_p
)
15771 /* Due to newlines in overlay strings, we may have to
15772 skip forward over overlay strings. */
15773 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15774 && MATRIX_ROW_END_CHARPOS (row
) == PT
15775 && !cursor_row_p (row
))
15778 /* If within the scroll margin, scroll. */
15779 if (row
->y
< top_scroll_margin
15780 && CHARPOS (startp
) != BEGV
)
15785 /* Cursor did not move. So don't scroll even if cursor line
15786 is partially visible, as it was so before. */
15787 rc
= CURSOR_MOVEMENT_SUCCESS
;
15790 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15791 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15793 /* if PT is not in the glyph row, give up. */
15794 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15795 must_scroll
= true;
15797 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15798 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15800 struct glyph_row
*row1
;
15802 /* If rows are bidi-reordered and point moved, back up
15803 until we find a row that does not belong to a
15804 continuation line. This is because we must consider
15805 all rows of a continued line as candidates for the
15806 new cursor positioning, since row start and end
15807 positions change non-linearly with vertical position
15809 /* FIXME: Revisit this when glyph ``spilling'' in
15810 continuation lines' rows is implemented for
15811 bidi-reordered rows. */
15812 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15813 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15816 /* If we hit the beginning of the displayed portion
15817 without finding the first row of a continued
15821 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15824 eassert (row
->enabled_p
);
15829 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15830 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15831 /* Make sure this isn't a header line by any chance, since
15832 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield true. */
15833 && !row
->mode_line_p
15834 && make_cursor_line_fully_visible_p
)
15836 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15837 && !row
->ends_at_zv_p
15838 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15839 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15840 else if (row
->height
> window_box_height (w
))
15842 /* If we end up in a partially visible line, let's
15843 make it fully visible, except when it's taller
15844 than the window, in which case we can't do much
15846 *scroll_step
= true;
15847 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15851 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15852 if (!cursor_row_fully_visible_p (w
, false, true))
15853 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15855 rc
= CURSOR_MOVEMENT_SUCCESS
;
15859 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15860 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15861 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15863 /* With bidi-reordered rows, there could be more than
15864 one candidate row whose start and end positions
15865 occlude point. We need to let set_cursor_from_row
15866 find the best candidate. */
15867 /* FIXME: Revisit this when glyph ``spilling'' in
15868 continuation lines' rows is implemented for
15869 bidi-reordered rows. */
15874 bool at_zv_p
= false, exact_match_p
= false;
15876 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15877 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15878 && cursor_row_p (row
))
15879 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15881 /* As soon as we've found the exact match for point,
15882 or the first suitable row whose ends_at_zv_p flag
15883 is set, we are done. */
15886 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15887 w
->cursor
.vpos
)->ends_at_zv_p
;
15889 && w
->cursor
.hpos
>= 0
15890 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15893 struct glyph_row
*candidate
=
15894 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15896 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15897 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15900 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15901 || (NILP (g
->object
)
15902 && (g
->charpos
== PT
15903 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15905 if (at_zv_p
|| exact_match_p
)
15907 rc
= CURSOR_MOVEMENT_SUCCESS
;
15911 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15915 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15916 || row
->continued_p
)
15917 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15918 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15919 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15920 /* If we didn't find any candidate rows, or exited the
15921 loop before all the candidates were examined, signal
15922 to the caller that this method failed. */
15923 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15925 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15926 && !row
->continued_p
))
15927 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15929 rc
= CURSOR_MOVEMENT_SUCCESS
;
15935 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15937 rc
= CURSOR_MOVEMENT_SUCCESS
;
15942 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15943 && MATRIX_ROW_START_CHARPOS (row
) == PT
15944 && cursor_row_p (row
));
15954 set_vertical_scroll_bar (struct window
*w
)
15956 ptrdiff_t start
, end
, whole
;
15958 /* Calculate the start and end positions for the current window.
15959 At some point, it would be nice to choose between scrollbars
15960 which reflect the whole buffer size, with special markers
15961 indicating narrowing, and scrollbars which reflect only the
15964 Note that mini-buffers sometimes aren't displaying any text. */
15965 if (!MINI_WINDOW_P (w
)
15966 || (w
== XWINDOW (minibuf_window
)
15967 && NILP (echo_area_buffer
[0])))
15969 struct buffer
*buf
= XBUFFER (w
->contents
);
15970 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15971 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15972 /* I don't think this is guaranteed to be right. For the
15973 moment, we'll pretend it is. */
15974 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15978 if (whole
< (end
- start
))
15979 whole
= end
- start
;
15982 start
= end
= whole
= 0;
15984 /* Indicate what this scroll bar ought to be displaying now. */
15985 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15986 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15987 (w
, end
- start
, whole
, start
);
15992 set_horizontal_scroll_bar (struct window
*w
)
15994 int start
, end
, whole
, portion
;
15996 if (!MINI_WINDOW_P (w
)
15997 || (w
== XWINDOW (minibuf_window
)
15998 && NILP (echo_area_buffer
[0])))
16000 struct buffer
*b
= XBUFFER (w
->contents
);
16001 struct buffer
*old_buffer
= NULL
;
16003 struct text_pos startp
;
16005 if (b
!= current_buffer
)
16007 old_buffer
= current_buffer
;
16008 set_buffer_internal (b
);
16011 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16012 start_display (&it
, w
, startp
);
16013 it
.last_visible_x
= INT_MAX
;
16014 whole
= move_it_to (&it
, -1, INT_MAX
, window_box_height (w
), -1,
16015 MOVE_TO_X
| MOVE_TO_Y
);
16016 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
16017 window_box_height (w), -1,
16018 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
16020 start
= w
->hscroll
* FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
));
16021 end
= start
+ window_box_width (w
, TEXT_AREA
);
16022 portion
= end
- start
;
16023 /* After enlarging a horizontally scrolled window such that it
16024 gets at least as wide as the text it contains, make sure that
16025 the thumb doesn't fill the entire scroll bar so we can still
16026 drag it back to see the entire text. */
16027 whole
= max (whole
, end
);
16033 pdir
= Fcurrent_bidi_paragraph_direction (Qnil
);
16034 if (EQ (pdir
, Qright_to_left
))
16036 start
= whole
- end
;
16037 end
= start
+ portion
;
16042 set_buffer_internal (old_buffer
);
16045 start
= end
= whole
= portion
= 0;
16047 w
->hscroll_whole
= whole
;
16049 /* Indicate what this scroll bar ought to be displaying now. */
16050 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
16051 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
16052 (w
, portion
, whole
, start
);
16056 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P means only
16057 selected_window is redisplayed.
16059 We can return without actually redisplaying the window if fonts has been
16060 changed on window's frame. In that case, redisplay_internal will retry.
16062 As one of the important parts of redisplaying a window, we need to
16063 decide whether the previous window-start position (stored in the
16064 window's w->start marker position) is still valid, and if it isn't,
16065 recompute it. Some details about that:
16067 . The previous window-start could be in a continuation line, in
16068 which case we need to recompute it when the window width
16069 changes. See compute_window_start_on_continuation_line and its
16072 . The text that changed since last redisplay could include the
16073 previous window-start position. In that case, we try to salvage
16074 what we can from the current glyph matrix by calling
16075 try_scrolling, which see.
16077 . Some Emacs command could force us to use a specific window-start
16078 position by setting the window's force_start flag, or gently
16079 propose doing that by setting the window's optional_new_start
16080 flag. In these cases, we try using the specified start point if
16081 that succeeds (i.e. the window desired matrix is successfully
16082 recomputed, and point location is within the window). In case
16083 of optional_new_start, we first check if the specified start
16084 position is feasible, i.e. if it will allow point to be
16085 displayed in the window. If using the specified start point
16086 fails, e.g., if new fonts are needed to be loaded, we abort the
16087 redisplay cycle and leave it up to the next cycle to figure out
16090 . Note that the window's force_start flag is sometimes set by
16091 redisplay itself, when it decides that the previous window start
16092 point is fine and should be kept. Search for "goto force_start"
16093 below to see the details. Like the values of window-start
16094 specified outside of redisplay, these internally-deduced values
16095 are tested for feasibility, and ignored if found to be
16098 . Note that the function try_window, used to completely redisplay
16099 a window, accepts the window's start point as its argument.
16100 This is used several times in the redisplay code to control
16101 where the window start will be, according to user options such
16102 as scroll-conservatively, and also to ensure the screen line
16103 showing point will be fully (as opposed to partially) visible on
16107 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
16109 struct window
*w
= XWINDOW (window
);
16110 struct frame
*f
= XFRAME (w
->frame
);
16111 struct buffer
*buffer
= XBUFFER (w
->contents
);
16112 struct buffer
*old
= current_buffer
;
16113 struct text_pos lpoint
, opoint
, startp
;
16114 bool update_mode_line
;
16117 /* Record it now because it's overwritten. */
16118 bool current_matrix_up_to_date_p
= false;
16119 bool used_current_matrix_p
= false;
16120 /* This is less strict than current_matrix_up_to_date_p.
16121 It indicates that the buffer contents and narrowing are unchanged. */
16122 bool buffer_unchanged_p
= false;
16123 bool temp_scroll_step
= false;
16124 ptrdiff_t count
= SPECPDL_INDEX ();
16126 int centering_position
= -1;
16127 bool last_line_misfit
= false;
16128 ptrdiff_t beg_unchanged
, end_unchanged
;
16129 int frame_line_height
;
16130 bool use_desired_matrix
;
16132 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16136 *w
->desired_matrix
->method
= 0;
16139 if (!just_this_one_p
16140 && REDISPLAY_SOME_P ()
16142 && !w
->update_mode_line
16145 && !buffer
->text
->redisplay
16146 && BUF_PT (buffer
) == w
->last_point
)
16149 /* Make sure that both W's markers are valid. */
16150 eassert (XMARKER (w
->start
)->buffer
== buffer
);
16151 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
16153 /* We come here again if we need to run window-text-change-functions
16156 reconsider_clip_changes (w
);
16157 frame_line_height
= default_line_pixel_height (w
);
16159 /* Has the mode line to be updated? */
16160 update_mode_line
= (w
->update_mode_line
16161 || update_mode_lines
16162 || buffer
->clip_changed
16163 || buffer
->prevent_redisplay_optimizations_p
);
16165 if (!just_this_one_p
)
16166 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
16167 cleverly elsewhere. */
16168 w
->must_be_updated_p
= true;
16170 if (MINI_WINDOW_P (w
))
16172 if (w
== XWINDOW (echo_area_window
)
16173 && !NILP (echo_area_buffer
[0]))
16175 if (update_mode_line
)
16176 /* We may have to update a tty frame's menu bar or a
16177 tool-bar. Example `M-x C-h C-h C-g'. */
16178 goto finish_menu_bars
;
16180 /* We've already displayed the echo area glyphs in this window. */
16181 goto finish_scroll_bars
;
16183 else if ((w
!= XWINDOW (minibuf_window
)
16184 || minibuf_level
== 0)
16185 /* When buffer is nonempty, redisplay window normally. */
16186 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
16187 /* Quail displays non-mini buffers in minibuffer window.
16188 In that case, redisplay the window normally. */
16189 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
16191 /* W is a mini-buffer window, but it's not active, so clear
16193 int yb
= window_text_bottom_y (w
);
16194 struct glyph_row
*row
;
16197 for (y
= 0, row
= w
->desired_matrix
->rows
;
16199 y
+= row
->height
, ++row
)
16200 blank_row (w
, row
, y
);
16201 goto finish_scroll_bars
;
16204 clear_glyph_matrix (w
->desired_matrix
);
16207 /* Otherwise set up data on this window; select its buffer and point
16209 /* Really select the buffer, for the sake of buffer-local
16211 set_buffer_internal_1 (XBUFFER (w
->contents
));
16213 current_matrix_up_to_date_p
16214 = (w
->window_end_valid
16215 && !current_buffer
->clip_changed
16216 && !current_buffer
->prevent_redisplay_optimizations_p
16217 && !window_outdated (w
));
16219 /* Run the window-text-change-functions
16220 if it is possible that the text on the screen has changed
16221 (either due to modification of the text, or any other reason). */
16222 if (!current_matrix_up_to_date_p
16223 && !NILP (Vwindow_text_change_functions
))
16225 safe_run_hooks (Qwindow_text_change_functions
);
16229 beg_unchanged
= BEG_UNCHANGED
;
16230 end_unchanged
= END_UNCHANGED
;
16232 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
16234 specbind (Qinhibit_point_motion_hooks
, Qt
);
16237 = (w
->window_end_valid
16238 && !current_buffer
->clip_changed
16239 && !window_outdated (w
));
16241 /* When windows_or_buffers_changed is non-zero, we can't rely
16242 on the window end being valid, so set it to zero there. */
16243 if (windows_or_buffers_changed
)
16245 /* If window starts on a continuation line, maybe adjust the
16246 window start in case the window's width changed. */
16247 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16248 compute_window_start_on_continuation_line (w
);
16250 w
->window_end_valid
= false;
16251 /* If so, we also can't rely on current matrix
16252 and should not fool try_cursor_movement below. */
16253 current_matrix_up_to_date_p
= false;
16256 /* Some sanity checks. */
16257 CHECK_WINDOW_END (w
);
16258 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16260 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16263 if (mode_line_update_needed (w
))
16264 update_mode_line
= true;
16266 /* Point refers normally to the selected window. For any other
16267 window, set up appropriate value. */
16268 if (!EQ (window
, selected_window
))
16270 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16271 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16276 new_pt_byte
= BEGV_BYTE
;
16277 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16279 else if (new_pt
> (ZV
- 1))
16282 new_pt_byte
= ZV_BYTE
;
16283 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16286 /* We don't use SET_PT so that the point-motion hooks don't run. */
16287 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16290 /* If any of the character widths specified in the display table
16291 have changed, invalidate the width run cache. It's true that
16292 this may be a bit late to catch such changes, but the rest of
16293 redisplay goes (non-fatally) haywire when the display table is
16294 changed, so why should we worry about doing any better? */
16295 if (current_buffer
->width_run_cache
16296 || (current_buffer
->base_buffer
16297 && current_buffer
->base_buffer
->width_run_cache
))
16299 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16301 if (! disptab_matches_widthtab
16302 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16304 struct buffer
*buf
= current_buffer
;
16306 if (buf
->base_buffer
)
16307 buf
= buf
->base_buffer
;
16308 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16309 recompute_width_table (current_buffer
, disptab
);
16313 /* If window-start is screwed up, choose a new one. */
16314 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16317 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16319 /* If someone specified a new starting point but did not insist,
16320 check whether it can be used. */
16321 if ((w
->optional_new_start
|| window_frozen_p (w
))
16322 && CHARPOS (startp
) >= BEGV
16323 && CHARPOS (startp
) <= ZV
)
16325 ptrdiff_t it_charpos
;
16327 w
->optional_new_start
= false;
16328 start_display (&it
, w
, startp
);
16329 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16330 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16331 /* Record IT's position now, since line_bottom_y might change
16333 it_charpos
= IT_CHARPOS (it
);
16334 /* Make sure we set the force_start flag only if the cursor row
16335 will be fully visible. Otherwise, the code under force_start
16336 label below will try to move point back into view, which is
16337 not what the code which sets optional_new_start wants. */
16338 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
16339 && !w
->force_start
)
16341 if (it_charpos
== PT
)
16342 w
->force_start
= true;
16343 /* IT may overshoot PT if text at PT is invisible. */
16344 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16345 w
->force_start
= true;
16347 if (w
->force_start
)
16349 if (window_frozen_p (w
))
16350 debug_method_add (w
, "set force_start from frozen window start");
16352 debug_method_add (w
, "set force_start from optional_new_start");
16360 /* Handle case where place to start displaying has been specified,
16361 unless the specified location is outside the accessible range. */
16362 if (w
->force_start
)
16364 /* We set this later on if we have to adjust point. */
16367 w
->force_start
= false;
16369 w
->window_end_valid
= false;
16371 /* Forget any recorded base line for line number display. */
16372 if (!buffer_unchanged_p
)
16373 w
->base_line_number
= 0;
16375 /* Redisplay the mode line. Select the buffer properly for that.
16376 Also, run the hook window-scroll-functions
16377 because we have scrolled. */
16378 /* Note, we do this after clearing force_start because
16379 if there's an error, it is better to forget about force_start
16380 than to get into an infinite loop calling the hook functions
16381 and having them get more errors. */
16382 if (!update_mode_line
16383 || ! NILP (Vwindow_scroll_functions
))
16385 update_mode_line
= true;
16386 w
->update_mode_line
= true;
16387 startp
= run_window_scroll_functions (window
, startp
);
16390 if (CHARPOS (startp
) < BEGV
)
16391 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16392 else if (CHARPOS (startp
) > ZV
)
16393 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16395 /* Redisplay, then check if cursor has been set during the
16396 redisplay. Give up if new fonts were loaded. */
16397 /* We used to issue a CHECK_MARGINS argument to try_window here,
16398 but this causes scrolling to fail when point begins inside
16399 the scroll margin (bug#148) -- cyd */
16400 if (!try_window (window
, startp
, 0))
16402 w
->force_start
= true;
16403 clear_glyph_matrix (w
->desired_matrix
);
16404 goto need_larger_matrices
;
16407 if (w
->cursor
.vpos
< 0)
16409 /* If point does not appear, try to move point so it does
16410 appear. The desired matrix has been built above, so we
16411 can use it here. First see if point is in invisible
16412 text, and if so, move it to the first visible buffer
16413 position past that. */
16414 struct glyph_row
*r
= NULL
;
16415 Lisp_Object invprop
=
16416 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16419 if (TEXT_PROP_MEANS_INVISIBLE (invprop
) != 0)
16422 Lisp_Object invprop_end
=
16423 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16426 if (NATNUMP (invprop_end
))
16427 alt_pt
= XFASTINT (invprop_end
);
16430 r
= row_containing_pos (w
, alt_pt
, w
->desired_matrix
->rows
,
16434 new_vpos
= MATRIX_ROW_BOTTOM_Y (r
);
16435 else /* Give up and just move to the middle of the window. */
16436 new_vpos
= window_box_height (w
) / 2;
16439 if (!cursor_row_fully_visible_p (w
, false, false))
16441 /* Point does appear, but on a line partly visible at end of window.
16442 Move it back to a fully-visible line. */
16443 new_vpos
= window_box_height (w
);
16444 /* But if window_box_height suggests a Y coordinate that is
16445 not less than we already have, that line will clearly not
16446 be fully visible, so give up and scroll the display.
16447 This can happen when the default face uses a font whose
16448 dimensions are different from the frame's default
16450 if (new_vpos
>= w
->cursor
.y
)
16452 w
->cursor
.vpos
= -1;
16453 clear_glyph_matrix (w
->desired_matrix
);
16454 goto try_to_scroll
;
16457 else if (w
->cursor
.vpos
>= 0)
16459 /* Some people insist on not letting point enter the scroll
16460 margin, even though this part handles windows that didn't
16462 int window_total_lines
16463 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16464 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16465 int pixel_margin
= margin
* frame_line_height
;
16466 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16468 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16469 below, which finds the row to move point to, advances by
16470 the Y coordinate of the _next_ row, see the definition of
16471 MATRIX_ROW_BOTTOM_Y. */
16472 if (w
->cursor
.vpos
< margin
+ header_line
)
16474 w
->cursor
.vpos
= -1;
16475 clear_glyph_matrix (w
->desired_matrix
);
16476 goto try_to_scroll
;
16480 int window_height
= window_box_height (w
);
16483 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16484 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16486 w
->cursor
.vpos
= -1;
16487 clear_glyph_matrix (w
->desired_matrix
);
16488 goto try_to_scroll
;
16493 /* If we need to move point for either of the above reasons,
16494 now actually do it. */
16497 struct glyph_row
*row
;
16499 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16500 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16503 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16504 MATRIX_ROW_START_BYTEPOS (row
));
16506 if (w
!= XWINDOW (selected_window
))
16507 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16508 else if (current_buffer
== old
)
16509 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16511 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16513 /* Re-run pre-redisplay-function so it can update the region
16514 according to the new position of point. */
16515 /* Other than the cursor, w's redisplay is done so we can set its
16516 redisplay to false. Also the buffer's redisplay can be set to
16517 false, since propagate_buffer_redisplay should have already
16518 propagated its info to `w' anyway. */
16519 w
->redisplay
= false;
16520 XBUFFER (w
->contents
)->text
->redisplay
= false;
16521 safe__call1 (true, Vpre_redisplay_function
, Fcons (window
, Qnil
));
16523 if (w
->redisplay
|| XBUFFER (w
->contents
)->text
->redisplay
)
16525 /* pre-redisplay-function made changes (e.g. move the region)
16526 that require another round of redisplay. */
16527 clear_glyph_matrix (w
->desired_matrix
);
16528 if (!try_window (window
, startp
, 0))
16529 goto need_larger_matrices
;
16532 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, false, false))
16534 clear_glyph_matrix (w
->desired_matrix
);
16535 goto try_to_scroll
;
16539 debug_method_add (w
, "forced window start");
16544 /* Handle case where text has not changed, only point, and it has
16545 not moved off the frame, and we are not retrying after hscroll.
16546 (current_matrix_up_to_date_p is true when retrying.) */
16547 if (current_matrix_up_to_date_p
16548 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16549 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16553 case CURSOR_MOVEMENT_SUCCESS
:
16554 used_current_matrix_p
= true;
16557 case CURSOR_MOVEMENT_MUST_SCROLL
:
16558 goto try_to_scroll
;
16564 /* If current starting point was originally the beginning of a line
16565 but no longer is, find a new starting point. */
16566 else if (w
->start_at_line_beg
16567 && !(CHARPOS (startp
) <= BEGV
16568 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16571 debug_method_add (w
, "recenter 1");
16576 /* Try scrolling with try_window_id. Value is > 0 if update has
16577 been done, it is -1 if we know that the same window start will
16578 not work. It is 0 if unsuccessful for some other reason. */
16579 else if ((tem
= try_window_id (w
)) != 0)
16582 debug_method_add (w
, "try_window_id %d", tem
);
16585 if (f
->fonts_changed
)
16586 goto need_larger_matrices
;
16590 /* Otherwise try_window_id has returned -1 which means that we
16591 don't want the alternative below this comment to execute. */
16593 else if (CHARPOS (startp
) >= BEGV
16594 && CHARPOS (startp
) <= ZV
16595 && PT
>= CHARPOS (startp
)
16596 && (CHARPOS (startp
) < ZV
16597 /* Avoid starting at end of buffer. */
16598 || CHARPOS (startp
) == BEGV
16599 || !window_outdated (w
)))
16601 int d1
, d2
, d5
, d6
;
16604 /* If first window line is a continuation line, and window start
16605 is inside the modified region, but the first change is before
16606 current window start, we must select a new window start.
16608 However, if this is the result of a down-mouse event (e.g. by
16609 extending the mouse-drag-overlay), we don't want to select a
16610 new window start, since that would change the position under
16611 the mouse, resulting in an unwanted mouse-movement rather
16612 than a simple mouse-click. */
16613 if (!w
->start_at_line_beg
16614 && NILP (do_mouse_tracking
)
16615 && CHARPOS (startp
) > BEGV
16616 && CHARPOS (startp
) > BEG
+ beg_unchanged
16617 && CHARPOS (startp
) <= Z
- end_unchanged
16618 /* Even if w->start_at_line_beg is nil, a new window may
16619 start at a line_beg, since that's how set_buffer_window
16620 sets it. So, we need to check the return value of
16621 compute_window_start_on_continuation_line. (See also
16623 && XMARKER (w
->start
)->buffer
== current_buffer
16624 && compute_window_start_on_continuation_line (w
)
16625 /* It doesn't make sense to force the window start like we
16626 do at label force_start if it is already known that point
16627 will not be fully visible in the resulting window, because
16628 doing so will move point from its correct position
16629 instead of scrolling the window to bring point into view.
16631 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16632 /* A very tall row could need more than the window height,
16633 in which case we accept that it is partially visible. */
16634 && (rtop
!= 0) == (rbot
!= 0))
16636 w
->force_start
= true;
16637 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16639 debug_method_add (w
, "recomputed window start in continuation line");
16645 debug_method_add (w
, "same window start");
16648 /* Try to redisplay starting at same place as before.
16649 If point has not moved off frame, accept the results. */
16650 if (!current_matrix_up_to_date_p
16651 /* Don't use try_window_reusing_current_matrix in this case
16652 because a window scroll function can have changed the
16654 || !NILP (Vwindow_scroll_functions
)
16655 || MINI_WINDOW_P (w
)
16656 || !(used_current_matrix_p
16657 = try_window_reusing_current_matrix (w
)))
16659 IF_DEBUG (debug_method_add (w
, "1"));
16660 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16661 /* -1 means we need to scroll.
16662 0 means we need new matrices, but fonts_changed
16663 is set in that case, so we will detect it below. */
16664 goto try_to_scroll
;
16667 if (f
->fonts_changed
)
16668 goto need_larger_matrices
;
16670 if (w
->cursor
.vpos
>= 0)
16672 if (!just_this_one_p
16673 || current_buffer
->clip_changed
16674 || BEG_UNCHANGED
< CHARPOS (startp
))
16675 /* Forget any recorded base line for line number display. */
16676 w
->base_line_number
= 0;
16678 if (!cursor_row_fully_visible_p (w
, true, false))
16680 clear_glyph_matrix (w
->desired_matrix
);
16681 last_line_misfit
= true;
16683 /* Drop through and scroll. */
16688 clear_glyph_matrix (w
->desired_matrix
);
16693 /* Redisplay the mode line. Select the buffer properly for that. */
16694 if (!update_mode_line
)
16696 update_mode_line
= true;
16697 w
->update_mode_line
= true;
16700 /* Try to scroll by specified few lines. */
16701 if ((scroll_conservatively
16702 || emacs_scroll_step
16703 || temp_scroll_step
16704 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16705 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16706 && CHARPOS (startp
) >= BEGV
16707 && CHARPOS (startp
) <= ZV
)
16709 /* The function returns -1 if new fonts were loaded, 1 if
16710 successful, 0 if not successful. */
16711 int ss
= try_scrolling (window
, just_this_one_p
,
16712 scroll_conservatively
,
16714 temp_scroll_step
, last_line_misfit
);
16717 case SCROLLING_SUCCESS
:
16720 case SCROLLING_NEED_LARGER_MATRICES
:
16721 goto need_larger_matrices
;
16723 case SCROLLING_FAILED
:
16731 /* Finally, just choose a place to start which positions point
16732 according to user preferences. */
16737 debug_method_add (w
, "recenter");
16740 /* Forget any previously recorded base line for line number display. */
16741 if (!buffer_unchanged_p
)
16742 w
->base_line_number
= 0;
16744 /* Determine the window start relative to point. */
16745 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16746 it
.current_y
= it
.last_visible_y
;
16747 if (centering_position
< 0)
16749 int window_total_lines
16750 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16752 = scroll_margin
> 0
16753 ? min (scroll_margin
, window_total_lines
/ 4)
16755 ptrdiff_t margin_pos
= CHARPOS (startp
);
16756 Lisp_Object aggressive
;
16759 /* If there is a scroll margin at the top of the window, find
16760 its character position. */
16762 /* Cannot call start_display if startp is not in the
16763 accessible region of the buffer. This can happen when we
16764 have just switched to a different buffer and/or changed
16765 its restriction. In that case, startp is initialized to
16766 the character position 1 (BEGV) because we did not yet
16767 have chance to display the buffer even once. */
16768 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16771 void *it1data
= NULL
;
16773 SAVE_IT (it1
, it
, it1data
);
16774 start_display (&it1
, w
, startp
);
16775 move_it_vertically (&it1
, margin
* frame_line_height
);
16776 margin_pos
= IT_CHARPOS (it1
);
16777 RESTORE_IT (&it
, &it
, it1data
);
16779 scrolling_up
= PT
> margin_pos
;
16782 ? BVAR (current_buffer
, scroll_up_aggressively
)
16783 : BVAR (current_buffer
, scroll_down_aggressively
);
16785 if (!MINI_WINDOW_P (w
)
16786 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16790 /* Setting scroll-conservatively overrides
16791 scroll-*-aggressively. */
16792 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16794 double float_amount
= XFLOATINT (aggressive
);
16796 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16797 if (pt_offset
== 0 && float_amount
> 0)
16799 if (pt_offset
&& margin
> 0)
16802 /* Compute how much to move the window start backward from
16803 point so that point will be displayed where the user
16807 centering_position
= it
.last_visible_y
;
16809 centering_position
-= pt_offset
;
16810 centering_position
-=
16811 (frame_line_height
* (1 + margin
+ last_line_misfit
)
16812 + WINDOW_HEADER_LINE_HEIGHT (w
));
16813 /* Don't let point enter the scroll margin near top of
16815 if (centering_position
< margin
* frame_line_height
)
16816 centering_position
= margin
* frame_line_height
;
16819 centering_position
= margin
* frame_line_height
+ pt_offset
;
16822 /* Set the window start half the height of the window backward
16824 centering_position
= window_box_height (w
) / 2;
16826 move_it_vertically_backward (&it
, centering_position
);
16828 eassert (IT_CHARPOS (it
) >= BEGV
);
16830 /* The function move_it_vertically_backward may move over more
16831 than the specified y-distance. If it->w is small, e.g. a
16832 mini-buffer window, we may end up in front of the window's
16833 display area. Start displaying at the start of the line
16834 containing PT in this case. */
16835 if (it
.current_y
<= 0)
16837 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16838 move_it_vertically_backward (&it
, 0);
16842 it
.current_x
= it
.hpos
= 0;
16844 /* Set the window start position here explicitly, to avoid an
16845 infinite loop in case the functions in window-scroll-functions
16847 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16849 /* Run scroll hooks. */
16850 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16852 /* Redisplay the window. */
16853 use_desired_matrix
= false;
16854 if (!current_matrix_up_to_date_p
16855 || windows_or_buffers_changed
16856 || f
->cursor_type_changed
16857 /* Don't use try_window_reusing_current_matrix in this case
16858 because it can have changed the buffer. */
16859 || !NILP (Vwindow_scroll_functions
)
16860 || !just_this_one_p
16861 || MINI_WINDOW_P (w
)
16862 || !(used_current_matrix_p
16863 = try_window_reusing_current_matrix (w
)))
16864 use_desired_matrix
= (try_window (window
, startp
, 0) == 1);
16866 /* If new fonts have been loaded (due to fontsets), give up. We
16867 have to start a new redisplay since we need to re-adjust glyph
16869 if (f
->fonts_changed
)
16870 goto need_larger_matrices
;
16872 /* If cursor did not appear assume that the middle of the window is
16873 in the first line of the window. Do it again with the next line.
16874 (Imagine a window of height 100, displaying two lines of height
16875 60. Moving back 50 from it->last_visible_y will end in the first
16877 if (w
->cursor
.vpos
< 0)
16879 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16881 clear_glyph_matrix (w
->desired_matrix
);
16882 move_it_by_lines (&it
, 1);
16883 try_window (window
, it
.current
.pos
, 0);
16885 else if (PT
< IT_CHARPOS (it
))
16887 clear_glyph_matrix (w
->desired_matrix
);
16888 move_it_by_lines (&it
, -1);
16889 try_window (window
, it
.current
.pos
, 0);
16893 /* Not much we can do about it. */
16897 /* Consider the following case: Window starts at BEGV, there is
16898 invisible, intangible text at BEGV, so that display starts at
16899 some point START > BEGV. It can happen that we are called with
16900 PT somewhere between BEGV and START. Try to handle that case,
16901 and similar ones. */
16902 if (w
->cursor
.vpos
< 0)
16904 /* Prefer the desired matrix to the current matrix, if possible,
16905 in the fallback calculations below. This is because using
16906 the current matrix might completely goof, e.g. if its first
16907 row is after point. */
16908 struct glyph_matrix
*matrix
=
16909 use_desired_matrix
? w
->desired_matrix
: w
->current_matrix
;
16910 /* First, try locating the proper glyph row for PT. */
16911 struct glyph_row
*row
=
16912 row_containing_pos (w
, PT
, matrix
->rows
, NULL
, 0);
16914 /* Sometimes point is at the beginning of invisible text that is
16915 before the 1st character displayed in the row. In that case,
16916 row_containing_pos fails to find the row, because no glyphs
16917 with appropriate buffer positions are present in the row.
16918 Therefore, we next try to find the row which shows the 1st
16919 position after the invisible text. */
16923 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16926 if (TEXT_PROP_MEANS_INVISIBLE (val
) != 0)
16929 Lisp_Object invis_end
=
16930 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16933 if (NATNUMP (invis_end
))
16934 alt_pos
= XFASTINT (invis_end
);
16937 row
= row_containing_pos (w
, alt_pos
, matrix
->rows
, NULL
, 0);
16940 /* Finally, fall back on the first row of the window after the
16941 header line (if any). This is slightly better than not
16942 displaying the cursor at all. */
16945 row
= matrix
->rows
;
16946 if (row
->mode_line_p
)
16949 set_cursor_from_row (w
, row
, matrix
, 0, 0, 0, 0);
16952 if (!cursor_row_fully_visible_p (w
, false, false))
16954 /* If vscroll is enabled, disable it and try again. */
16958 clear_glyph_matrix (w
->desired_matrix
);
16962 /* Users who set scroll-conservatively to a large number want
16963 point just above/below the scroll margin. If we ended up
16964 with point's row partially visible, move the window start to
16965 make that row fully visible and out of the margin. */
16966 if (scroll_conservatively
> SCROLL_LIMIT
)
16968 int window_total_lines
16969 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16972 ? min (scroll_margin
, window_total_lines
/ 4)
16974 bool move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16976 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16977 clear_glyph_matrix (w
->desired_matrix
);
16978 if (1 == try_window (window
, it
.current
.pos
,
16979 TRY_WINDOW_CHECK_MARGINS
))
16983 /* If centering point failed to make the whole line visible,
16984 put point at the top instead. That has to make the whole line
16985 visible, if it can be done. */
16986 if (centering_position
== 0)
16989 clear_glyph_matrix (w
->desired_matrix
);
16990 centering_position
= 0;
16996 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16997 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16998 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
17000 /* Display the mode line, if we must. */
17001 if ((update_mode_line
17002 /* If window not full width, must redo its mode line
17003 if (a) the window to its side is being redone and
17004 (b) we do a frame-based redisplay. This is a consequence
17005 of how inverted lines are drawn in frame-based redisplay. */
17006 || (!just_this_one_p
17007 && !FRAME_WINDOW_P (f
)
17008 && !WINDOW_FULL_WIDTH_P (w
))
17009 /* Line number to display. */
17010 || w
->base_line_pos
> 0
17011 /* Column number is displayed and different from the one displayed. */
17012 || (w
->column_number_displayed
!= -1
17013 && (w
->column_number_displayed
!= current_column ())))
17014 /* This means that the window has a mode line. */
17015 && (WINDOW_WANTS_MODELINE_P (w
)
17016 || WINDOW_WANTS_HEADER_LINE_P (w
)))
17019 display_mode_lines (w
);
17021 /* If mode line height has changed, arrange for a thorough
17022 immediate redisplay using the correct mode line height. */
17023 if (WINDOW_WANTS_MODELINE_P (w
)
17024 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
17026 f
->fonts_changed
= true;
17027 w
->mode_line_height
= -1;
17028 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
17029 = DESIRED_MODE_LINE_HEIGHT (w
);
17032 /* If header line height has changed, arrange for a thorough
17033 immediate redisplay using the correct header line height. */
17034 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17035 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
17037 f
->fonts_changed
= true;
17038 w
->header_line_height
= -1;
17039 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
17040 = DESIRED_HEADER_LINE_HEIGHT (w
);
17043 if (f
->fonts_changed
)
17044 goto need_larger_matrices
;
17047 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
17049 w
->base_line_pos
= 0;
17050 w
->base_line_number
= 0;
17055 /* When we reach a frame's selected window, redo the frame's menu
17056 bar and the frame's title. */
17057 if (update_mode_line
17058 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
17060 bool redisplay_menu_p
;
17062 if (FRAME_WINDOW_P (f
))
17064 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
17065 || defined (HAVE_NS) || defined (USE_GTK)
17066 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
17068 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
17072 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
17074 if (redisplay_menu_p
)
17075 display_menu_bar (w
);
17077 #ifdef HAVE_WINDOW_SYSTEM
17078 if (FRAME_WINDOW_P (f
))
17080 #if defined (USE_GTK) || defined (HAVE_NS)
17081 if (FRAME_EXTERNAL_TOOL_BAR (f
))
17082 redisplay_tool_bar (f
);
17084 if (WINDOWP (f
->tool_bar_window
)
17085 && (FRAME_TOOL_BAR_LINES (f
) > 0
17086 || !NILP (Vauto_resize_tool_bars
))
17087 && redisplay_tool_bar (f
))
17088 ignore_mouse_drag_p
= true;
17091 ptrdiff_t count1
= SPECPDL_INDEX ();
17092 /* x_consider_frame_title calls select-frame, which calls
17093 resize_mini_window, which could resize the mini-window and by
17094 that undo the effect of this redisplay cycle wrt minibuffer
17095 and echo-area display. Binding inhibit-redisplay to t makes
17096 the call to resize_mini_window a no-op, thus avoiding the
17097 adverse side effects. */
17098 specbind (Qinhibit_redisplay
, Qt
);
17099 x_consider_frame_title (w
->frame
);
17100 unbind_to (count1
, Qnil
);
17104 #ifdef HAVE_WINDOW_SYSTEM
17105 if (FRAME_WINDOW_P (f
)
17106 && update_window_fringes (w
, (just_this_one_p
17107 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
17108 || w
->pseudo_window_p
)))
17112 if (draw_window_fringes (w
, true))
17114 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
17115 x_draw_right_divider (w
);
17117 x_draw_vertical_border (w
);
17123 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
17124 x_draw_bottom_divider (w
);
17125 #endif /* HAVE_WINDOW_SYSTEM */
17127 /* We go to this label, with fonts_changed set, if it is
17128 necessary to try again using larger glyph matrices.
17129 We have to redeem the scroll bar even in this case,
17130 because the loop in redisplay_internal expects that. */
17131 need_larger_matrices
:
17133 finish_scroll_bars
:
17135 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
17137 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
17138 /* Set the thumb's position and size. */
17139 set_vertical_scroll_bar (w
);
17141 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
17142 /* Set the thumb's position and size. */
17143 set_horizontal_scroll_bar (w
);
17145 /* Note that we actually used the scroll bar attached to this
17146 window, so it shouldn't be deleted at the end of redisplay. */
17147 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
17148 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
17151 /* Restore current_buffer and value of point in it. The window
17152 update may have changed the buffer, so first make sure `opoint'
17153 is still valid (Bug#6177). */
17154 if (CHARPOS (opoint
) < BEGV
)
17155 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
17156 else if (CHARPOS (opoint
) > ZV
)
17157 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
17159 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
17161 set_buffer_internal_1 (old
);
17162 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
17163 shorter. This can be caused by log truncation in *Messages*. */
17164 if (CHARPOS (lpoint
) <= ZV
)
17165 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
17167 unbind_to (count
, Qnil
);
17171 /* Build the complete desired matrix of WINDOW with a window start
17172 buffer position POS.
17174 Value is 1 if successful. It is zero if fonts were loaded during
17175 redisplay which makes re-adjusting glyph matrices necessary, and -1
17176 if point would appear in the scroll margins.
17177 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
17178 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
17182 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
17184 struct window
*w
= XWINDOW (window
);
17186 struct glyph_row
*last_text_row
= NULL
;
17187 struct frame
*f
= XFRAME (w
->frame
);
17188 int frame_line_height
= default_line_pixel_height (w
);
17190 /* Make POS the new window start. */
17191 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
17193 /* Mark cursor position as unknown. No overlay arrow seen. */
17194 w
->cursor
.vpos
= -1;
17195 overlay_arrow_seen
= false;
17197 /* Initialize iterator and info to start at POS. */
17198 start_display (&it
, w
, pos
);
17199 it
.glyph_row
->reversed_p
= false;
17201 /* Display all lines of W. */
17202 while (it
.current_y
< it
.last_visible_y
)
17204 if (display_line (&it
))
17205 last_text_row
= it
.glyph_row
- 1;
17206 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
17210 /* Don't let the cursor end in the scroll margins. */
17211 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
17212 && !MINI_WINDOW_P (w
))
17214 int this_scroll_margin
;
17215 int window_total_lines
17216 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
17218 if (scroll_margin
> 0)
17220 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
17221 this_scroll_margin
*= frame_line_height
;
17224 this_scroll_margin
= 0;
17226 if ((w
->cursor
.y
>= 0 /* not vscrolled */
17227 && w
->cursor
.y
< this_scroll_margin
17228 && CHARPOS (pos
) > BEGV
17229 && IT_CHARPOS (it
) < ZV
)
17230 /* rms: considering make_cursor_line_fully_visible_p here
17231 seems to give wrong results. We don't want to recenter
17232 when the last line is partly visible, we want to allow
17233 that case to be handled in the usual way. */
17234 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
17236 w
->cursor
.vpos
= -1;
17237 clear_glyph_matrix (w
->desired_matrix
);
17242 /* If bottom moved off end of frame, change mode line percentage. */
17243 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
17244 w
->update_mode_line
= true;
17246 /* Set window_end_pos to the offset of the last character displayed
17247 on the window from the end of current_buffer. Set
17248 window_end_vpos to its row number. */
17251 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
17252 adjust_window_ends (w
, last_text_row
, false);
17254 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
17255 w
->window_end_vpos
)));
17259 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17260 w
->window_end_pos
= Z
- ZV
;
17261 w
->window_end_vpos
= 0;
17264 /* But that is not valid info until redisplay finishes. */
17265 w
->window_end_valid
= false;
17271 /************************************************************************
17272 Window redisplay reusing current matrix when buffer has not changed
17273 ************************************************************************/
17275 /* Try redisplay of window W showing an unchanged buffer with a
17276 different window start than the last time it was displayed by
17277 reusing its current matrix. Value is true if successful.
17278 W->start is the new window start. */
17281 try_window_reusing_current_matrix (struct window
*w
)
17283 struct frame
*f
= XFRAME (w
->frame
);
17284 struct glyph_row
*bottom_row
;
17287 struct text_pos start
, new_start
;
17288 int nrows_scrolled
, i
;
17289 struct glyph_row
*last_text_row
;
17290 struct glyph_row
*last_reused_text_row
;
17291 struct glyph_row
*start_row
;
17292 int start_vpos
, min_y
, max_y
;
17295 if (inhibit_try_window_reusing
)
17299 if (/* This function doesn't handle terminal frames. */
17300 !FRAME_WINDOW_P (f
)
17301 /* Don't try to reuse the display if windows have been split
17303 || windows_or_buffers_changed
17304 || f
->cursor_type_changed
)
17307 /* Can't do this if showing trailing whitespace. */
17308 if (!NILP (Vshow_trailing_whitespace
))
17311 /* If top-line visibility has changed, give up. */
17312 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17313 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17316 /* Give up if old or new display is scrolled vertically. We could
17317 make this function handle this, but right now it doesn't. */
17318 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17319 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17322 /* The variable new_start now holds the new window start. The old
17323 start `start' can be determined from the current matrix. */
17324 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17325 start
= start_row
->minpos
;
17326 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17328 /* Clear the desired matrix for the display below. */
17329 clear_glyph_matrix (w
->desired_matrix
);
17331 if (CHARPOS (new_start
) <= CHARPOS (start
))
17333 /* Don't use this method if the display starts with an ellipsis
17334 displayed for invisible text. It's not easy to handle that case
17335 below, and it's certainly not worth the effort since this is
17336 not a frequent case. */
17337 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17340 IF_DEBUG (debug_method_add (w
, "twu1"));
17342 /* Display up to a row that can be reused. The variable
17343 last_text_row is set to the last row displayed that displays
17344 text. Note that it.vpos == 0 if or if not there is a
17345 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17346 start_display (&it
, w
, new_start
);
17347 w
->cursor
.vpos
= -1;
17348 last_text_row
= last_reused_text_row
= NULL
;
17350 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17352 /* If we have reached into the characters in the START row,
17353 that means the line boundaries have changed. So we
17354 can't start copying with the row START. Maybe it will
17355 work to start copying with the following row. */
17356 while (IT_CHARPOS (it
) > CHARPOS (start
))
17358 /* Advance to the next row as the "start". */
17360 start
= start_row
->minpos
;
17361 /* If there are no more rows to try, or just one, give up. */
17362 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17363 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17364 || CHARPOS (start
) == ZV
)
17366 clear_glyph_matrix (w
->desired_matrix
);
17370 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17372 /* If we have reached alignment, we can copy the rest of the
17374 if (IT_CHARPOS (it
) == CHARPOS (start
)
17375 /* Don't accept "alignment" inside a display vector,
17376 since start_row could have started in the middle of
17377 that same display vector (thus their character
17378 positions match), and we have no way of telling if
17379 that is the case. */
17380 && it
.current
.dpvec_index
< 0)
17383 it
.glyph_row
->reversed_p
= false;
17384 if (display_line (&it
))
17385 last_text_row
= it
.glyph_row
- 1;
17389 /* A value of current_y < last_visible_y means that we stopped
17390 at the previous window start, which in turn means that we
17391 have at least one reusable row. */
17392 if (it
.current_y
< it
.last_visible_y
)
17394 struct glyph_row
*row
;
17396 /* IT.vpos always starts from 0; it counts text lines. */
17397 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17399 /* Find PT if not already found in the lines displayed. */
17400 if (w
->cursor
.vpos
< 0)
17402 int dy
= it
.current_y
- start_row
->y
;
17404 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17405 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17407 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17408 dy
, nrows_scrolled
);
17411 clear_glyph_matrix (w
->desired_matrix
);
17416 /* Scroll the display. Do it before the current matrix is
17417 changed. The problem here is that update has not yet
17418 run, i.e. part of the current matrix is not up to date.
17419 scroll_run_hook will clear the cursor, and use the
17420 current matrix to get the height of the row the cursor is
17422 run
.current_y
= start_row
->y
;
17423 run
.desired_y
= it
.current_y
;
17424 run
.height
= it
.last_visible_y
- it
.current_y
;
17426 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17429 FRAME_RIF (f
)->update_window_begin_hook (w
);
17430 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17431 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17432 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17436 /* Shift current matrix down by nrows_scrolled lines. */
17437 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17438 rotate_matrix (w
->current_matrix
,
17440 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17443 /* Disable lines that must be updated. */
17444 for (i
= 0; i
< nrows_scrolled
; ++i
)
17445 (start_row
+ i
)->enabled_p
= false;
17447 /* Re-compute Y positions. */
17448 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17449 max_y
= it
.last_visible_y
;
17450 for (row
= start_row
+ nrows_scrolled
;
17454 row
->y
= it
.current_y
;
17455 row
->visible_height
= row
->height
;
17457 if (row
->y
< min_y
)
17458 row
->visible_height
-= min_y
- row
->y
;
17459 if (row
->y
+ row
->height
> max_y
)
17460 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17461 if (row
->fringe_bitmap_periodic_p
)
17462 row
->redraw_fringe_bitmaps_p
= true;
17464 it
.current_y
+= row
->height
;
17466 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17467 last_reused_text_row
= row
;
17468 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17472 /* Disable lines in the current matrix which are now
17473 below the window. */
17474 for (++row
; row
< bottom_row
; ++row
)
17475 row
->enabled_p
= row
->mode_line_p
= false;
17478 /* Update window_end_pos etc.; last_reused_text_row is the last
17479 reused row from the current matrix containing text, if any.
17480 The value of last_text_row is the last displayed line
17481 containing text. */
17482 if (last_reused_text_row
)
17483 adjust_window_ends (w
, last_reused_text_row
, true);
17484 else if (last_text_row
)
17485 adjust_window_ends (w
, last_text_row
, false);
17488 /* This window must be completely empty. */
17489 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17490 w
->window_end_pos
= Z
- ZV
;
17491 w
->window_end_vpos
= 0;
17493 w
->window_end_valid
= false;
17495 /* Update hint: don't try scrolling again in update_window. */
17496 w
->desired_matrix
->no_scrolling_p
= true;
17499 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17503 else if (CHARPOS (new_start
) > CHARPOS (start
))
17505 struct glyph_row
*pt_row
, *row
;
17506 struct glyph_row
*first_reusable_row
;
17507 struct glyph_row
*first_row_to_display
;
17509 int yb
= window_text_bottom_y (w
);
17511 /* Find the row starting at new_start, if there is one. Don't
17512 reuse a partially visible line at the end. */
17513 first_reusable_row
= start_row
;
17514 while (first_reusable_row
->enabled_p
17515 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17516 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17517 < CHARPOS (new_start
)))
17518 ++first_reusable_row
;
17520 /* Give up if there is no row to reuse. */
17521 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17522 || !first_reusable_row
->enabled_p
17523 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17524 != CHARPOS (new_start
)))
17527 /* We can reuse fully visible rows beginning with
17528 first_reusable_row to the end of the window. Set
17529 first_row_to_display to the first row that cannot be reused.
17530 Set pt_row to the row containing point, if there is any. */
17532 for (first_row_to_display
= first_reusable_row
;
17533 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17534 ++first_row_to_display
)
17536 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17537 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17538 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17539 && first_row_to_display
->ends_at_zv_p
17540 && pt_row
== NULL
)))
17541 pt_row
= first_row_to_display
;
17544 /* Start displaying at the start of first_row_to_display. */
17545 eassert (first_row_to_display
->y
< yb
);
17546 init_to_row_start (&it
, w
, first_row_to_display
);
17548 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17550 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17552 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17553 + WINDOW_HEADER_LINE_HEIGHT (w
));
17555 /* Display lines beginning with first_row_to_display in the
17556 desired matrix. Set last_text_row to the last row displayed
17557 that displays text. */
17558 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17559 if (pt_row
== NULL
)
17560 w
->cursor
.vpos
= -1;
17561 last_text_row
= NULL
;
17562 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17563 if (display_line (&it
))
17564 last_text_row
= it
.glyph_row
- 1;
17566 /* If point is in a reused row, adjust y and vpos of the cursor
17570 w
->cursor
.vpos
-= nrows_scrolled
;
17571 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17574 /* Give up if point isn't in a row displayed or reused. (This
17575 also handles the case where w->cursor.vpos < nrows_scrolled
17576 after the calls to display_line, which can happen with scroll
17577 margins. See bug#1295.) */
17578 if (w
->cursor
.vpos
< 0)
17580 clear_glyph_matrix (w
->desired_matrix
);
17584 /* Scroll the display. */
17585 run
.current_y
= first_reusable_row
->y
;
17586 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17587 run
.height
= it
.last_visible_y
- run
.current_y
;
17588 dy
= run
.current_y
- run
.desired_y
;
17593 FRAME_RIF (f
)->update_window_begin_hook (w
);
17594 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17595 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17596 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17600 /* Adjust Y positions of reused rows. */
17601 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17602 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17603 max_y
= it
.last_visible_y
;
17604 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17607 row
->visible_height
= row
->height
;
17608 if (row
->y
< min_y
)
17609 row
->visible_height
-= min_y
- row
->y
;
17610 if (row
->y
+ row
->height
> max_y
)
17611 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17612 if (row
->fringe_bitmap_periodic_p
)
17613 row
->redraw_fringe_bitmaps_p
= true;
17616 /* Scroll the current matrix. */
17617 eassert (nrows_scrolled
> 0);
17618 rotate_matrix (w
->current_matrix
,
17620 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17623 /* Disable rows not reused. */
17624 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17625 row
->enabled_p
= false;
17627 /* Point may have moved to a different line, so we cannot assume that
17628 the previous cursor position is valid; locate the correct row. */
17631 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17633 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17634 && !row
->ends_at_zv_p
;
17638 w
->cursor
.y
= row
->y
;
17640 if (row
< bottom_row
)
17642 /* Can't simply scan the row for point with
17643 bidi-reordered glyph rows. Let set_cursor_from_row
17644 figure out where to put the cursor, and if it fails,
17646 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17648 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17651 clear_glyph_matrix (w
->desired_matrix
);
17657 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17658 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17661 && (!BUFFERP (glyph
->object
)
17662 || glyph
->charpos
< PT
);
17666 w
->cursor
.x
+= glyph
->pixel_width
;
17672 /* Adjust window end. A null value of last_text_row means that
17673 the window end is in reused rows which in turn means that
17674 only its vpos can have changed. */
17676 adjust_window_ends (w
, last_text_row
, false);
17678 w
->window_end_vpos
-= nrows_scrolled
;
17680 w
->window_end_valid
= false;
17681 w
->desired_matrix
->no_scrolling_p
= true;
17684 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17694 /************************************************************************
17695 Window redisplay reusing current matrix when buffer has changed
17696 ************************************************************************/
17698 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17699 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17700 ptrdiff_t *, ptrdiff_t *);
17701 static struct glyph_row
*
17702 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17703 struct glyph_row
*);
17706 /* Return the last row in MATRIX displaying text. If row START is
17707 non-null, start searching with that row. IT gives the dimensions
17708 of the display. Value is null if matrix is empty; otherwise it is
17709 a pointer to the row found. */
17711 static struct glyph_row
*
17712 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17713 struct glyph_row
*start
)
17715 struct glyph_row
*row
, *row_found
;
17717 /* Set row_found to the last row in IT->w's current matrix
17718 displaying text. The loop looks funny but think of partially
17721 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17722 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17724 eassert (row
->enabled_p
);
17726 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17735 /* Return the last row in the current matrix of W that is not affected
17736 by changes at the start of current_buffer that occurred since W's
17737 current matrix was built. Value is null if no such row exists.
17739 BEG_UNCHANGED us the number of characters unchanged at the start of
17740 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17741 first changed character in current_buffer. Characters at positions <
17742 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17743 when the current matrix was built. */
17745 static struct glyph_row
*
17746 find_last_unchanged_at_beg_row (struct window
*w
)
17748 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17749 struct glyph_row
*row
;
17750 struct glyph_row
*row_found
= NULL
;
17751 int yb
= window_text_bottom_y (w
);
17753 /* Find the last row displaying unchanged text. */
17754 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17755 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17756 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17759 if (/* If row ends before first_changed_pos, it is unchanged,
17760 except in some case. */
17761 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17762 /* When row ends in ZV and we write at ZV it is not
17764 && !row
->ends_at_zv_p
17765 /* When first_changed_pos is the end of a continued line,
17766 row is not unchanged because it may be no longer
17768 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17769 && (row
->continued_p
17770 || row
->exact_window_width_line_p
))
17771 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17772 needs to be recomputed, so don't consider this row as
17773 unchanged. This happens when the last line was
17774 bidi-reordered and was killed immediately before this
17775 redisplay cycle. In that case, ROW->end stores the
17776 buffer position of the first visual-order character of
17777 the killed text, which is now beyond ZV. */
17778 && CHARPOS (row
->end
.pos
) <= ZV
)
17781 /* Stop if last visible row. */
17782 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17790 /* Find the first glyph row in the current matrix of W that is not
17791 affected by changes at the end of current_buffer since the
17792 time W's current matrix was built.
17794 Return in *DELTA the number of chars by which buffer positions in
17795 unchanged text at the end of current_buffer must be adjusted.
17797 Return in *DELTA_BYTES the corresponding number of bytes.
17799 Value is null if no such row exists, i.e. all rows are affected by
17802 static struct glyph_row
*
17803 find_first_unchanged_at_end_row (struct window
*w
,
17804 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17806 struct glyph_row
*row
;
17807 struct glyph_row
*row_found
= NULL
;
17809 *delta
= *delta_bytes
= 0;
17811 /* Display must not have been paused, otherwise the current matrix
17812 is not up to date. */
17813 eassert (w
->window_end_valid
);
17815 /* A value of window_end_pos >= END_UNCHANGED means that the window
17816 end is in the range of changed text. If so, there is no
17817 unchanged row at the end of W's current matrix. */
17818 if (w
->window_end_pos
>= END_UNCHANGED
)
17821 /* Set row to the last row in W's current matrix displaying text. */
17822 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17824 /* If matrix is entirely empty, no unchanged row exists. */
17825 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17827 /* The value of row is the last glyph row in the matrix having a
17828 meaningful buffer position in it. The end position of row
17829 corresponds to window_end_pos. This allows us to translate
17830 buffer positions in the current matrix to current buffer
17831 positions for characters not in changed text. */
17833 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17834 ptrdiff_t Z_BYTE_old
=
17835 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17836 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17837 struct glyph_row
*first_text_row
17838 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17840 *delta
= Z
- Z_old
;
17841 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17843 /* Set last_unchanged_pos to the buffer position of the last
17844 character in the buffer that has not been changed. Z is the
17845 index + 1 of the last character in current_buffer, i.e. by
17846 subtracting END_UNCHANGED we get the index of the last
17847 unchanged character, and we have to add BEG to get its buffer
17849 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17850 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17852 /* Search backward from ROW for a row displaying a line that
17853 starts at a minimum position >= last_unchanged_pos_old. */
17854 for (; row
> first_text_row
; --row
)
17856 /* This used to abort, but it can happen.
17857 It is ok to just stop the search instead here. KFS. */
17858 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17861 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17866 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17872 /* Make sure that glyph rows in the current matrix of window W
17873 reference the same glyph memory as corresponding rows in the
17874 frame's frame matrix. This function is called after scrolling W's
17875 current matrix on a terminal frame in try_window_id and
17876 try_window_reusing_current_matrix. */
17879 sync_frame_with_window_matrix_rows (struct window
*w
)
17881 struct frame
*f
= XFRAME (w
->frame
);
17882 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17884 /* Preconditions: W must be a leaf window and full-width. Its frame
17885 must have a frame matrix. */
17886 eassert (BUFFERP (w
->contents
));
17887 eassert (WINDOW_FULL_WIDTH_P (w
));
17888 eassert (!FRAME_WINDOW_P (f
));
17890 /* If W is a full-width window, glyph pointers in W's current matrix
17891 have, by definition, to be the same as glyph pointers in the
17892 corresponding frame matrix. Note that frame matrices have no
17893 marginal areas (see build_frame_matrix). */
17894 window_row
= w
->current_matrix
->rows
;
17895 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17896 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17897 while (window_row
< window_row_end
)
17899 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17900 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17902 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17903 frame_row
->glyphs
[TEXT_AREA
] = start
;
17904 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17905 frame_row
->glyphs
[LAST_AREA
] = end
;
17907 /* Disable frame rows whose corresponding window rows have
17908 been disabled in try_window_id. */
17909 if (!window_row
->enabled_p
)
17910 frame_row
->enabled_p
= false;
17912 ++window_row
, ++frame_row
;
17917 /* Find the glyph row in window W containing CHARPOS. Consider all
17918 rows between START and END (not inclusive). END null means search
17919 all rows to the end of the display area of W. Value is the row
17920 containing CHARPOS or null. */
17923 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17924 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17926 struct glyph_row
*row
= start
;
17927 struct glyph_row
*best_row
= NULL
;
17928 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17931 /* If we happen to start on a header-line, skip that. */
17932 if (row
->mode_line_p
)
17935 if ((end
&& row
>= end
) || !row
->enabled_p
)
17938 last_y
= window_text_bottom_y (w
) - dy
;
17942 /* Give up if we have gone too far. */
17943 if ((end
&& row
>= end
) || !row
->enabled_p
)
17945 /* This formerly returned if they were equal.
17946 I think that both quantities are of a "last plus one" type;
17947 if so, when they are equal, the row is within the screen. -- rms. */
17948 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17951 /* If it is in this row, return this row. */
17952 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17953 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17954 /* The end position of a row equals the start
17955 position of the next row. If CHARPOS is there, we
17956 would rather consider it displayed in the next
17957 line, except when this line ends in ZV. */
17958 && !row_for_charpos_p (row
, charpos
)))
17959 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17963 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17964 || (!best_row
&& !row
->continued_p
))
17966 /* In bidi-reordered rows, there could be several rows whose
17967 edges surround CHARPOS, all of these rows belonging to
17968 the same continued line. We need to find the row which
17969 fits CHARPOS the best. */
17970 for (g
= row
->glyphs
[TEXT_AREA
];
17971 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17974 if (!STRINGP (g
->object
))
17976 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17978 mindif
= eabs (g
->charpos
- charpos
);
17980 /* Exact match always wins. */
17987 else if (best_row
&& !row
->continued_p
)
17994 /* Try to redisplay window W by reusing its existing display. W's
17995 current matrix must be up to date when this function is called,
17996 i.e., window_end_valid must be true.
18000 >= 1 if successful, i.e. display has been updated
18002 1 means the changes were in front of a newline that precedes
18003 the window start, and the whole current matrix was reused
18004 2 means the changes were after the last position displayed
18005 in the window, and the whole current matrix was reused
18006 3 means portions of the current matrix were reused, while
18007 some of the screen lines were redrawn
18008 -1 if redisplay with same window start is known not to succeed
18009 0 if otherwise unsuccessful
18011 The following steps are performed:
18013 1. Find the last row in the current matrix of W that is not
18014 affected by changes at the start of current_buffer. If no such row
18017 2. Find the first row in W's current matrix that is not affected by
18018 changes at the end of current_buffer. Maybe there is no such row.
18020 3. Display lines beginning with the row + 1 found in step 1 to the
18021 row found in step 2 or, if step 2 didn't find a row, to the end of
18024 4. If cursor is not known to appear on the window, give up.
18026 5. If display stopped at the row found in step 2, scroll the
18027 display and current matrix as needed.
18029 6. Maybe display some lines at the end of W, if we must. This can
18030 happen under various circumstances, like a partially visible line
18031 becoming fully visible, or because newly displayed lines are displayed
18032 in smaller font sizes.
18034 7. Update W's window end information. */
18037 try_window_id (struct window
*w
)
18039 struct frame
*f
= XFRAME (w
->frame
);
18040 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
18041 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
18042 struct glyph_row
*last_unchanged_at_beg_row
;
18043 struct glyph_row
*first_unchanged_at_end_row
;
18044 struct glyph_row
*row
;
18045 struct glyph_row
*bottom_row
;
18048 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
18050 struct text_pos start_pos
;
18052 int first_unchanged_at_end_vpos
= 0;
18053 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
18054 struct text_pos start
;
18055 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
18058 if (inhibit_try_window_id
)
18062 /* This is handy for debugging. */
18064 #define GIVE_UP(X) \
18066 TRACE ((stderr, "try_window_id give up %d\n", (X))); \
18070 #define GIVE_UP(X) return 0
18073 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
18075 /* Don't use this for mini-windows because these can show
18076 messages and mini-buffers, and we don't handle that here. */
18077 if (MINI_WINDOW_P (w
))
18080 /* This flag is used to prevent redisplay optimizations. */
18081 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
18084 /* This function's optimizations cannot be used if overlays have
18085 changed in the buffer displayed by the window, so give up if they
18087 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
18090 /* Verify that narrowing has not changed.
18091 Also verify that we were not told to prevent redisplay optimizations.
18092 It would be nice to further
18093 reduce the number of cases where this prevents try_window_id. */
18094 if (current_buffer
->clip_changed
18095 || current_buffer
->prevent_redisplay_optimizations_p
)
18098 /* Window must either use window-based redisplay or be full width. */
18099 if (!FRAME_WINDOW_P (f
)
18100 && (!FRAME_LINE_INS_DEL_OK (f
)
18101 || !WINDOW_FULL_WIDTH_P (w
)))
18104 /* Give up if point is known NOT to appear in W. */
18105 if (PT
< CHARPOS (start
))
18108 /* Another way to prevent redisplay optimizations. */
18109 if (w
->last_modified
== 0)
18112 /* Verify that window is not hscrolled. */
18113 if (w
->hscroll
!= 0)
18116 /* Verify that display wasn't paused. */
18117 if (!w
->window_end_valid
)
18120 /* Likewise if highlighting trailing whitespace. */
18121 if (!NILP (Vshow_trailing_whitespace
))
18124 /* Can't use this if overlay arrow position and/or string have
18126 if (overlay_arrows_changed_p ())
18129 /* When word-wrap is on, adding a space to the first word of a
18130 wrapped line can change the wrap position, altering the line
18131 above it. It might be worthwhile to handle this more
18132 intelligently, but for now just redisplay from scratch. */
18133 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
18136 /* Under bidi reordering, adding or deleting a character in the
18137 beginning of a paragraph, before the first strong directional
18138 character, can change the base direction of the paragraph (unless
18139 the buffer specifies a fixed paragraph direction), which will
18140 require redisplaying the whole paragraph. It might be worthwhile
18141 to find the paragraph limits and widen the range of redisplayed
18142 lines to that, but for now just give up this optimization and
18143 redisplay from scratch. */
18144 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
18145 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
18148 /* Give up if the buffer has line-spacing set, as Lisp-level changes
18149 to that variable require thorough redisplay. */
18150 if (!NILP (BVAR (XBUFFER (w
->contents
), extra_line_spacing
)))
18153 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
18154 only if buffer has really changed. The reason is that the gap is
18155 initially at Z for freshly visited files. The code below would
18156 set end_unchanged to 0 in that case. */
18157 if (MODIFF
> SAVE_MODIFF
18158 /* This seems to happen sometimes after saving a buffer. */
18159 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
18161 if (GPT
- BEG
< BEG_UNCHANGED
)
18162 BEG_UNCHANGED
= GPT
- BEG
;
18163 if (Z
- GPT
< END_UNCHANGED
)
18164 END_UNCHANGED
= Z
- GPT
;
18167 /* The position of the first and last character that has been changed. */
18168 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
18169 last_changed_charpos
= Z
- END_UNCHANGED
;
18171 /* If window starts after a line end, and the last change is in
18172 front of that newline, then changes don't affect the display.
18173 This case happens with stealth-fontification. Note that although
18174 the display is unchanged, glyph positions in the matrix have to
18175 be adjusted, of course. */
18176 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
18177 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
18178 && ((last_changed_charpos
< CHARPOS (start
)
18179 && CHARPOS (start
) == BEGV
)
18180 || (last_changed_charpos
< CHARPOS (start
) - 1
18181 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
18183 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
18184 struct glyph_row
*r0
;
18186 /* Compute how many chars/bytes have been added to or removed
18187 from the buffer. */
18188 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
18189 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
18190 Z_delta
= Z
- Z_old
;
18191 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
18193 /* Give up if PT is not in the window. Note that it already has
18194 been checked at the start of try_window_id that PT is not in
18195 front of the window start. */
18196 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
18199 /* If window start is unchanged, we can reuse the whole matrix
18200 as is, after adjusting glyph positions. No need to compute
18201 the window end again, since its offset from Z hasn't changed. */
18202 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18203 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
18204 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
18205 /* PT must not be in a partially visible line. */
18206 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
18207 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18209 /* Adjust positions in the glyph matrix. */
18210 if (Z_delta
|| Z_delta_bytes
)
18212 struct glyph_row
*r1
18213 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18214 increment_matrix_positions (w
->current_matrix
,
18215 MATRIX_ROW_VPOS (r0
, current_matrix
),
18216 MATRIX_ROW_VPOS (r1
, current_matrix
),
18217 Z_delta
, Z_delta_bytes
);
18220 /* Set the cursor. */
18221 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18223 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18228 /* Handle the case that changes are all below what is displayed in
18229 the window, and that PT is in the window. This shortcut cannot
18230 be taken if ZV is visible in the window, and text has been added
18231 there that is visible in the window. */
18232 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
18233 /* ZV is not visible in the window, or there are no
18234 changes at ZV, actually. */
18235 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
18236 || first_changed_charpos
== last_changed_charpos
))
18238 struct glyph_row
*r0
;
18240 /* Give up if PT is not in the window. Note that it already has
18241 been checked at the start of try_window_id that PT is not in
18242 front of the window start. */
18243 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
18246 /* If window start is unchanged, we can reuse the whole matrix
18247 as is, without changing glyph positions since no text has
18248 been added/removed in front of the window end. */
18249 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18250 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
18251 /* PT must not be in a partially visible line. */
18252 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
18253 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18255 /* We have to compute the window end anew since text
18256 could have been added/removed after it. */
18257 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18258 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18260 /* Set the cursor. */
18261 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18263 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18268 /* Give up if window start is in the changed area.
18270 The condition used to read
18272 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18274 but why that was tested escapes me at the moment. */
18275 if (CHARPOS (start
) >= first_changed_charpos
18276 && CHARPOS (start
) <= last_changed_charpos
)
18279 /* Check that window start agrees with the start of the first glyph
18280 row in its current matrix. Check this after we know the window
18281 start is not in changed text, otherwise positions would not be
18283 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18284 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
18287 /* Give up if the window ends in strings. Overlay strings
18288 at the end are difficult to handle, so don't try. */
18289 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
18290 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
18293 /* Compute the position at which we have to start displaying new
18294 lines. Some of the lines at the top of the window might be
18295 reusable because they are not displaying changed text. Find the
18296 last row in W's current matrix not affected by changes at the
18297 start of current_buffer. Value is null if changes start in the
18298 first line of window. */
18299 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18300 if (last_unchanged_at_beg_row
)
18302 /* Avoid starting to display in the middle of a character, a TAB
18303 for instance. This is easier than to set up the iterator
18304 exactly, and it's not a frequent case, so the additional
18305 effort wouldn't really pay off. */
18306 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18307 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18308 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18309 --last_unchanged_at_beg_row
;
18311 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18314 if (! init_to_row_end (&it
, w
, last_unchanged_at_beg_row
))
18316 start_pos
= it
.current
.pos
;
18318 /* Start displaying new lines in the desired matrix at the same
18319 vpos we would use in the current matrix, i.e. below
18320 last_unchanged_at_beg_row. */
18321 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18323 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18324 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18326 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18330 /* There are no reusable lines at the start of the window.
18331 Start displaying in the first text line. */
18332 start_display (&it
, w
, start
);
18333 it
.vpos
= it
.first_vpos
;
18334 start_pos
= it
.current
.pos
;
18337 /* Find the first row that is not affected by changes at the end of
18338 the buffer. Value will be null if there is no unchanged row, in
18339 which case we must redisplay to the end of the window. delta
18340 will be set to the value by which buffer positions beginning with
18341 first_unchanged_at_end_row have to be adjusted due to text
18343 first_unchanged_at_end_row
18344 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18345 IF_DEBUG (debug_delta
= delta
);
18346 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18348 /* Set stop_pos to the buffer position up to which we will have to
18349 display new lines. If first_unchanged_at_end_row != NULL, this
18350 is the buffer position of the start of the line displayed in that
18351 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18352 that we don't stop at a buffer position. */
18354 if (first_unchanged_at_end_row
)
18356 eassert (last_unchanged_at_beg_row
== NULL
18357 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18359 /* If this is a continuation line, move forward to the next one
18360 that isn't. Changes in lines above affect this line.
18361 Caution: this may move first_unchanged_at_end_row to a row
18362 not displaying text. */
18363 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18364 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18365 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18366 < it
.last_visible_y
))
18367 ++first_unchanged_at_end_row
;
18369 if (!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
= NULL
;
18375 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18377 first_unchanged_at_end_vpos
18378 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18379 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18382 else if (last_unchanged_at_beg_row
== NULL
)
18388 /* Either there is no unchanged row at the end, or the one we have
18389 now displays text. This is a necessary condition for the window
18390 end pos calculation at the end of this function. */
18391 eassert (first_unchanged_at_end_row
== NULL
18392 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18394 debug_last_unchanged_at_beg_vpos
18395 = (last_unchanged_at_beg_row
18396 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18398 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18400 #endif /* GLYPH_DEBUG */
18403 /* Display new lines. Set last_text_row to the last new line
18404 displayed which has text on it, i.e. might end up as being the
18405 line where the window_end_vpos is. */
18406 w
->cursor
.vpos
= -1;
18407 last_text_row
= NULL
;
18408 overlay_arrow_seen
= false;
18409 if (it
.current_y
< it
.last_visible_y
18410 && !f
->fonts_changed
18411 && (first_unchanged_at_end_row
== NULL
18412 || IT_CHARPOS (it
) < stop_pos
))
18413 it
.glyph_row
->reversed_p
= false;
18414 while (it
.current_y
< it
.last_visible_y
18415 && !f
->fonts_changed
18416 && (first_unchanged_at_end_row
== NULL
18417 || IT_CHARPOS (it
) < stop_pos
))
18419 if (display_line (&it
))
18420 last_text_row
= it
.glyph_row
- 1;
18423 if (f
->fonts_changed
)
18426 /* The redisplay iterations in display_line above could have
18427 triggered font-lock, which could have done something that
18428 invalidates IT->w window's end-point information, on which we
18429 rely below. E.g., one package, which will remain unnamed, used
18430 to install a font-lock-fontify-region-function that called
18431 bury-buffer, whose side effect is to switch the buffer displayed
18432 by IT->w, and that predictably resets IT->w's window_end_valid
18433 flag, which we already tested at the entry to this function.
18434 Amply punish such packages/modes by giving up on this
18435 optimization in those cases. */
18436 if (!w
->window_end_valid
)
18438 clear_glyph_matrix (w
->desired_matrix
);
18442 /* Compute differences in buffer positions, y-positions etc. for
18443 lines reused at the bottom of the window. Compute what we can
18445 if (first_unchanged_at_end_row
18446 /* No lines reused because we displayed everything up to the
18447 bottom of the window. */
18448 && it
.current_y
< it
.last_visible_y
)
18451 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18453 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18454 run
.current_y
= first_unchanged_at_end_row
->y
;
18455 run
.desired_y
= run
.current_y
+ dy
;
18456 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18460 delta
= delta_bytes
= dvpos
= dy
18461 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18462 first_unchanged_at_end_row
= NULL
;
18464 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18467 /* Find the cursor if not already found. We have to decide whether
18468 PT will appear on this window (it sometimes doesn't, but this is
18469 not a very frequent case.) This decision has to be made before
18470 the current matrix is altered. A value of cursor.vpos < 0 means
18471 that PT is either in one of the lines beginning at
18472 first_unchanged_at_end_row or below the window. Don't care for
18473 lines that might be displayed later at the window end; as
18474 mentioned, this is not a frequent case. */
18475 if (w
->cursor
.vpos
< 0)
18477 /* Cursor in unchanged rows at the top? */
18478 if (PT
< CHARPOS (start_pos
)
18479 && last_unchanged_at_beg_row
)
18481 row
= row_containing_pos (w
, PT
,
18482 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18483 last_unchanged_at_beg_row
+ 1, 0);
18485 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18488 /* Start from first_unchanged_at_end_row looking for PT. */
18489 else if (first_unchanged_at_end_row
)
18491 row
= row_containing_pos (w
, PT
- delta
,
18492 first_unchanged_at_end_row
, NULL
, 0);
18494 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18495 delta_bytes
, dy
, dvpos
);
18498 /* Give up if cursor was not found. */
18499 if (w
->cursor
.vpos
< 0)
18501 clear_glyph_matrix (w
->desired_matrix
);
18506 /* Don't let the cursor end in the scroll margins. */
18508 int this_scroll_margin
, cursor_height
;
18509 int frame_line_height
= default_line_pixel_height (w
);
18510 int window_total_lines
18511 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18513 this_scroll_margin
=
18514 max (0, min (scroll_margin
, window_total_lines
/ 4));
18515 this_scroll_margin
*= frame_line_height
;
18516 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18518 if ((w
->cursor
.y
< this_scroll_margin
18519 && CHARPOS (start
) > BEGV
)
18520 /* Old redisplay didn't take scroll margin into account at the bottom,
18521 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18522 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18523 ? cursor_height
+ this_scroll_margin
18524 : 1)) > it
.last_visible_y
)
18526 w
->cursor
.vpos
= -1;
18527 clear_glyph_matrix (w
->desired_matrix
);
18532 /* Scroll the display. Do it before changing the current matrix so
18533 that xterm.c doesn't get confused about where the cursor glyph is
18535 if (dy
&& run
.height
)
18539 if (FRAME_WINDOW_P (f
))
18541 FRAME_RIF (f
)->update_window_begin_hook (w
);
18542 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18543 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18544 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
18548 /* Terminal frame. In this case, dvpos gives the number of
18549 lines to scroll by; dvpos < 0 means scroll up. */
18551 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18552 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18553 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18554 + WINDOW_WANTS_HEADER_LINE_P (w
)
18555 + window_internal_height (w
));
18557 #if defined (HAVE_GPM) || defined (MSDOS)
18558 x_clear_window_mouse_face (w
);
18560 /* Perform the operation on the screen. */
18563 /* Scroll last_unchanged_at_beg_row to the end of the
18564 window down dvpos lines. */
18565 set_terminal_window (f
, end
);
18567 /* On dumb terminals delete dvpos lines at the end
18568 before inserting dvpos empty lines. */
18569 if (!FRAME_SCROLL_REGION_OK (f
))
18570 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18572 /* Insert dvpos empty lines in front of
18573 last_unchanged_at_beg_row. */
18574 ins_del_lines (f
, from
, dvpos
);
18576 else if (dvpos
< 0)
18578 /* Scroll up last_unchanged_at_beg_vpos to the end of
18579 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18580 set_terminal_window (f
, end
);
18582 /* Delete dvpos lines in front of
18583 last_unchanged_at_beg_vpos. ins_del_lines will set
18584 the cursor to the given vpos and emit |dvpos| delete
18586 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18588 /* On a dumb terminal insert dvpos empty lines at the
18590 if (!FRAME_SCROLL_REGION_OK (f
))
18591 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18594 set_terminal_window (f
, 0);
18600 /* Shift reused rows of the current matrix to the right position.
18601 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18603 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18604 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18607 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18608 bottom_vpos
, dvpos
);
18609 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18612 else if (dvpos
> 0)
18614 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18615 bottom_vpos
, dvpos
);
18616 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18617 first_unchanged_at_end_vpos
+ dvpos
);
18620 /* For frame-based redisplay, make sure that current frame and window
18621 matrix are in sync with respect to glyph memory. */
18622 if (!FRAME_WINDOW_P (f
))
18623 sync_frame_with_window_matrix_rows (w
);
18625 /* Adjust buffer positions in reused rows. */
18626 if (delta
|| delta_bytes
)
18627 increment_matrix_positions (current_matrix
,
18628 first_unchanged_at_end_vpos
+ dvpos
,
18629 bottom_vpos
, delta
, delta_bytes
);
18631 /* Adjust Y positions. */
18633 shift_glyph_matrix (w
, current_matrix
,
18634 first_unchanged_at_end_vpos
+ dvpos
,
18637 if (first_unchanged_at_end_row
)
18639 first_unchanged_at_end_row
+= dvpos
;
18640 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18641 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18642 first_unchanged_at_end_row
= NULL
;
18645 /* If scrolling up, there may be some lines to display at the end of
18647 last_text_row_at_end
= NULL
;
18650 /* Scrolling up can leave for example a partially visible line
18651 at the end of the window to be redisplayed. */
18652 /* Set last_row to the glyph row in the current matrix where the
18653 window end line is found. It has been moved up or down in
18654 the matrix by dvpos. */
18655 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18656 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18658 /* If last_row is the window end line, it should display text. */
18659 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18661 /* If window end line was partially visible before, begin
18662 displaying at that line. Otherwise begin displaying with the
18663 line following it. */
18664 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18666 init_to_row_start (&it
, w
, last_row
);
18667 it
.vpos
= last_vpos
;
18668 it
.current_y
= last_row
->y
;
18672 init_to_row_end (&it
, w
, last_row
);
18673 it
.vpos
= 1 + last_vpos
;
18674 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18678 /* We may start in a continuation line. If so, we have to
18679 get the right continuation_lines_width and current_x. */
18680 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18681 it
.hpos
= it
.current_x
= 0;
18683 /* Display the rest of the lines at the window end. */
18684 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18685 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18687 /* Is it always sure that the display agrees with lines in
18688 the current matrix? I don't think so, so we mark rows
18689 displayed invalid in the current matrix by setting their
18690 enabled_p flag to false. */
18691 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18692 if (display_line (&it
))
18693 last_text_row_at_end
= it
.glyph_row
- 1;
18697 /* Update window_end_pos and window_end_vpos. */
18698 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18700 /* Window end line if one of the preserved rows from the current
18701 matrix. Set row to the last row displaying text in current
18702 matrix starting at first_unchanged_at_end_row, after
18704 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18705 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18706 first_unchanged_at_end_row
);
18707 eassume (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18708 adjust_window_ends (w
, row
, true);
18709 eassert (w
->window_end_bytepos
>= 0);
18710 IF_DEBUG (debug_method_add (w
, "A"));
18712 else if (last_text_row_at_end
)
18714 adjust_window_ends (w
, last_text_row_at_end
, false);
18715 eassert (w
->window_end_bytepos
>= 0);
18716 IF_DEBUG (debug_method_add (w
, "B"));
18718 else if (last_text_row
)
18720 /* We have displayed either to the end of the window or at the
18721 end of the window, i.e. the last row with text is to be found
18722 in the desired matrix. */
18723 adjust_window_ends (w
, last_text_row
, false);
18724 eassert (w
->window_end_bytepos
>= 0);
18726 else if (first_unchanged_at_end_row
== NULL
18727 && last_text_row
== NULL
18728 && last_text_row_at_end
== NULL
)
18730 /* Displayed to end of window, but no line containing text was
18731 displayed. Lines were deleted at the end of the window. */
18732 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
18733 int vpos
= w
->window_end_vpos
;
18734 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18735 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18737 for (row
= NULL
; !row
; --vpos
, --current_row
, --desired_row
)
18739 eassert (first_vpos
<= vpos
);
18740 if (desired_row
->enabled_p
)
18742 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18745 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18749 w
->window_end_vpos
= vpos
+ 1;
18750 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18751 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18752 eassert (w
->window_end_bytepos
>= 0);
18753 IF_DEBUG (debug_method_add (w
, "C"));
18758 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18759 debug_end_vpos
= w
->window_end_vpos
));
18761 /* Record that display has not been completed. */
18762 w
->window_end_valid
= false;
18763 w
->desired_matrix
->no_scrolling_p
= true;
18771 /***********************************************************************
18772 More debugging support
18773 ***********************************************************************/
18777 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18778 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18779 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18782 /* Dump the contents of glyph matrix MATRIX on stderr.
18784 GLYPHS 0 means don't show glyph contents.
18785 GLYPHS 1 means show glyphs in short form
18786 GLYPHS > 1 means show glyphs in long form. */
18789 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18792 for (i
= 0; i
< matrix
->nrows
; ++i
)
18793 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18797 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18798 the glyph row and area where the glyph comes from. */
18801 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18803 if (glyph
->type
== CHAR_GLYPH
18804 || glyph
->type
== GLYPHLESS_GLYPH
)
18807 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18808 glyph
- row
->glyphs
[TEXT_AREA
],
18809 (glyph
->type
== CHAR_GLYPH
18813 (BUFFERP (glyph
->object
)
18815 : (STRINGP (glyph
->object
)
18817 : (NILP (glyph
->object
)
18820 glyph
->pixel_width
,
18822 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18826 glyph
->left_box_line_p
,
18827 glyph
->right_box_line_p
);
18829 else if (glyph
->type
== STRETCH_GLYPH
)
18832 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18833 glyph
- row
->glyphs
[TEXT_AREA
],
18836 (BUFFERP (glyph
->object
)
18838 : (STRINGP (glyph
->object
)
18840 : (NILP (glyph
->object
)
18843 glyph
->pixel_width
,
18847 glyph
->left_box_line_p
,
18848 glyph
->right_box_line_p
);
18850 else if (glyph
->type
== IMAGE_GLYPH
)
18853 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18854 glyph
- row
->glyphs
[TEXT_AREA
],
18857 (BUFFERP (glyph
->object
)
18859 : (STRINGP (glyph
->object
)
18861 : (NILP (glyph
->object
)
18864 glyph
->pixel_width
,
18868 glyph
->left_box_line_p
,
18869 glyph
->right_box_line_p
);
18871 else if (glyph
->type
== COMPOSITE_GLYPH
)
18874 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18875 glyph
- row
->glyphs
[TEXT_AREA
],
18878 (BUFFERP (glyph
->object
)
18880 : (STRINGP (glyph
->object
)
18882 : (NILP (glyph
->object
)
18885 glyph
->pixel_width
,
18887 if (glyph
->u
.cmp
.automatic
)
18890 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18891 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18893 glyph
->left_box_line_p
,
18894 glyph
->right_box_line_p
);
18896 else if (glyph
->type
== XWIDGET_GLYPH
)
18898 #ifndef HAVE_XWIDGETS
18902 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
18903 glyph
- row
->glyphs
[TEXT_AREA
],
18906 (BUFFERP (glyph
->object
)
18908 : (STRINGP (glyph
->object
)
18911 glyph
->pixel_width
,
18915 glyph
->left_box_line_p
,
18916 glyph
->right_box_line_p
);
18922 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18923 GLYPHS 0 means don't show glyph contents.
18924 GLYPHS 1 means show glyphs in short form
18925 GLYPHS > 1 means show glyphs in long form. */
18928 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18932 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18933 fprintf (stderr
, "==============================================================================\n");
18935 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18936 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18938 MATRIX_ROW_START_CHARPOS (row
),
18939 MATRIX_ROW_END_CHARPOS (row
),
18940 row
->used
[TEXT_AREA
],
18941 row
->contains_overlapping_glyphs_p
,
18943 row
->truncated_on_left_p
,
18944 row
->truncated_on_right_p
,
18946 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18947 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18950 row
->ends_in_middle_of_char_p
,
18951 row
->starts_in_middle_of_char_p
,
18957 row
->visible_height
,
18960 /* The next 3 lines should align to "Start" in the header. */
18961 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18962 row
->end
.overlay_string_index
,
18963 row
->continuation_lines_width
);
18964 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18965 CHARPOS (row
->start
.string_pos
),
18966 CHARPOS (row
->end
.string_pos
));
18967 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18968 row
->end
.dpvec_index
);
18975 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18977 struct glyph
*glyph
= row
->glyphs
[area
];
18978 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18980 /* Glyph for a line end in text. */
18981 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18984 if (glyph
< glyph_end
)
18985 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18987 for (; glyph
< glyph_end
; ++glyph
)
18988 dump_glyph (row
, glyph
, area
);
18991 else if (glyphs
== 1)
18994 char s
[SHRT_MAX
+ 4];
18996 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19000 for (i
= 0; i
< row
->used
[area
]; ++i
)
19002 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
19003 if (i
== row
->used
[area
] - 1
19004 && area
== TEXT_AREA
19005 && NILP (glyph
->object
)
19006 && glyph
->type
== CHAR_GLYPH
19007 && glyph
->u
.ch
== ' ')
19009 strcpy (&s
[i
], "[\\n]");
19012 else if (glyph
->type
== CHAR_GLYPH
19013 && glyph
->u
.ch
< 0x80
19014 && glyph
->u
.ch
>= ' ')
19015 s
[i
] = glyph
->u
.ch
;
19021 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
19027 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
19028 Sdump_glyph_matrix
, 0, 1, "p",
19029 doc
: /* Dump the current matrix of the selected window to stderr.
19030 Shows contents of glyph row structures. With non-nil
19031 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
19032 glyphs in short form, otherwise show glyphs in long form.
19034 Interactively, no argument means show glyphs in short form;
19035 with numeric argument, its value is passed as the GLYPHS flag. */)
19036 (Lisp_Object glyphs
)
19038 struct window
*w
= XWINDOW (selected_window
);
19039 struct buffer
*buffer
= XBUFFER (w
->contents
);
19041 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
19042 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
19043 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
19044 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
19045 fprintf (stderr
, "=============================================\n");
19046 dump_glyph_matrix (w
->current_matrix
,
19047 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
19052 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
19053 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* Dump the current glyph matrix of the selected frame to stderr.
19054 Only text-mode frames have frame glyph matrices. */)
19057 struct frame
*f
= XFRAME (selected_frame
);
19059 if (f
->current_matrix
)
19060 dump_glyph_matrix (f
->current_matrix
, 1);
19062 fprintf (stderr
, "*** This frame doesn't have a frame glyph matrix ***\n");
19067 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
19068 doc
: /* Dump glyph row ROW to stderr.
19069 GLYPH 0 means don't dump glyphs.
19070 GLYPH 1 means dump glyphs in short form.
19071 GLYPH > 1 or omitted means dump glyphs in long form. */)
19072 (Lisp_Object row
, Lisp_Object glyphs
)
19074 struct glyph_matrix
*matrix
;
19077 CHECK_NUMBER (row
);
19078 matrix
= XWINDOW (selected_window
)->current_matrix
;
19080 if (vpos
>= 0 && vpos
< matrix
->nrows
)
19081 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
19083 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
19088 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
19089 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
19090 GLYPH 0 means don't dump glyphs.
19091 GLYPH 1 means dump glyphs in short form.
19092 GLYPH > 1 or omitted means dump glyphs in long form.
19094 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
19096 (Lisp_Object row
, Lisp_Object glyphs
)
19098 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19099 struct frame
*sf
= SELECTED_FRAME ();
19100 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
19103 CHECK_NUMBER (row
);
19105 if (vpos
>= 0 && vpos
< m
->nrows
)
19106 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
19107 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
19113 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
19114 doc
: /* Toggle tracing of redisplay.
19115 With ARG, turn tracing on if and only if ARG is positive. */)
19119 trace_redisplay_p
= !trace_redisplay_p
;
19122 arg
= Fprefix_numeric_value (arg
);
19123 trace_redisplay_p
= XINT (arg
) > 0;
19130 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
19131 doc
: /* Like `format', but print result to stderr.
19132 usage: (trace-to-stderr STRING &rest OBJECTS) */)
19133 (ptrdiff_t nargs
, Lisp_Object
*args
)
19135 Lisp_Object s
= Fformat (nargs
, args
);
19136 fwrite (SDATA (s
), 1, SBYTES (s
), stderr
);
19140 #endif /* GLYPH_DEBUG */
19144 /***********************************************************************
19145 Building Desired Matrix Rows
19146 ***********************************************************************/
19148 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
19149 Used for non-window-redisplay windows, and for windows w/o left fringe. */
19151 static struct glyph_row
*
19152 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
19154 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19155 struct buffer
*buffer
= XBUFFER (w
->contents
);
19156 struct buffer
*old
= current_buffer
;
19157 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
19158 ptrdiff_t arrow_len
= SCHARS (overlay_arrow_string
);
19159 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
19160 const unsigned char *p
;
19163 int n_glyphs_before
;
19165 set_buffer_temp (buffer
);
19166 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
19167 scratch_glyph_row
.reversed_p
= false;
19168 it
.glyph_row
->used
[TEXT_AREA
] = 0;
19169 SET_TEXT_POS (it
.position
, 0, 0);
19171 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
19173 while (p
< arrow_end
)
19175 Lisp_Object face
, ilisp
;
19177 /* Get the next character. */
19179 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
19182 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
19183 if (! ASCII_CHAR_P (it
.c
))
19184 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
19188 /* Get its face. */
19189 ilisp
= make_number (p
- arrow_string
);
19190 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
19191 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
19193 /* Compute its width, get its glyphs. */
19194 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
19195 SET_TEXT_POS (it
.position
, -1, -1);
19196 PRODUCE_GLYPHS (&it
);
19198 /* If this character doesn't fit any more in the line, we have
19199 to remove some glyphs. */
19200 if (it
.current_x
> it
.last_visible_x
)
19202 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19207 set_buffer_temp (old
);
19208 return it
.glyph_row
;
19212 /* Insert truncation glyphs at the start of IT->glyph_row. Which
19213 glyphs to insert is determined by produce_special_glyphs. */
19216 insert_left_trunc_glyphs (struct it
*it
)
19218 struct it truncate_it
;
19219 struct glyph
*from
, *end
, *to
, *toend
;
19221 eassert (!FRAME_WINDOW_P (it
->f
)
19222 || (!it
->glyph_row
->reversed_p
19223 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19224 || (it
->glyph_row
->reversed_p
19225 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
19227 /* Get the truncation glyphs. */
19229 truncate_it
.current_x
= 0;
19230 truncate_it
.face_id
= DEFAULT_FACE_ID
;
19231 truncate_it
.glyph_row
= &scratch_glyph_row
;
19232 truncate_it
.area
= TEXT_AREA
;
19233 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
19234 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
19235 truncate_it
.object
= Qnil
;
19236 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
19238 /* Overwrite glyphs from IT with truncation glyphs. */
19239 if (!it
->glyph_row
->reversed_p
)
19241 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19243 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19244 end
= from
+ tused
;
19245 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19246 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
19247 if (FRAME_WINDOW_P (it
->f
))
19249 /* On GUI frames, when variable-size fonts are displayed,
19250 the truncation glyphs may need more pixels than the row's
19251 glyphs they overwrite. We overwrite more glyphs to free
19252 enough screen real estate, and enlarge the stretch glyph
19253 on the right (see display_line), if there is one, to
19254 preserve the screen position of the truncation glyphs on
19257 struct glyph
*g
= to
;
19260 /* The first glyph could be partially visible, in which case
19261 it->glyph_row->x will be negative. But we want the left
19262 truncation glyphs to be aligned at the left margin of the
19263 window, so we override the x coordinate at which the row
19265 it
->glyph_row
->x
= 0;
19266 while (g
< toend
&& w
< it
->truncation_pixel_width
)
19268 w
+= g
->pixel_width
;
19271 if (g
- to
- tused
> 0)
19273 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
19274 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
19276 used
= it
->glyph_row
->used
[TEXT_AREA
];
19277 if (it
->glyph_row
->truncated_on_right_p
19278 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
19279 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
19282 int extra
= w
- it
->truncation_pixel_width
;
19284 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
19291 /* There may be padding glyphs left over. Overwrite them too. */
19292 if (!FRAME_WINDOW_P (it
->f
))
19294 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
19296 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19303 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
19307 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19309 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19310 that back to front. */
19311 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19312 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19313 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19314 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19315 if (FRAME_WINDOW_P (it
->f
))
19318 struct glyph
*g
= to
;
19320 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19322 w
+= g
->pixel_width
;
19325 if (to
- g
- tused
> 0)
19327 if (it
->glyph_row
->truncated_on_right_p
19328 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19329 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19331 int extra
= w
- it
->truncation_pixel_width
;
19333 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19337 while (from
>= end
&& to
>= toend
)
19339 if (!FRAME_WINDOW_P (it
->f
))
19341 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19344 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19345 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19346 while (from
>= end
&& to
>= toend
)
19352 /* Need to free some room before prepending additional
19354 int move_by
= from
- end
+ 1;
19355 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19356 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19358 for ( ; g
>= g0
; g
--)
19360 while (from
>= end
)
19362 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19367 /* Compute the hash code for ROW. */
19369 row_hash (struct glyph_row
*row
)
19372 unsigned hashval
= 0;
19374 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19375 for (k
= 0; k
< row
->used
[area
]; ++k
)
19376 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19377 + row
->glyphs
[area
][k
].u
.val
19378 + row
->glyphs
[area
][k
].face_id
19379 + row
->glyphs
[area
][k
].padding_p
19380 + (row
->glyphs
[area
][k
].type
<< 2));
19385 /* Compute the pixel height and width of IT->glyph_row.
19387 Most of the time, ascent and height of a display line will be equal
19388 to the max_ascent and max_height values of the display iterator
19389 structure. This is not the case if
19391 1. We hit ZV without displaying anything. In this case, max_ascent
19392 and max_height will be zero.
19394 2. We have some glyphs that don't contribute to the line height.
19395 (The glyph row flag contributes_to_line_height_p is for future
19396 pixmap extensions).
19398 The first case is easily covered by using default values because in
19399 these cases, the line height does not really matter, except that it
19400 must not be zero. */
19403 compute_line_metrics (struct it
*it
)
19405 struct glyph_row
*row
= it
->glyph_row
;
19407 if (FRAME_WINDOW_P (it
->f
))
19409 int i
, min_y
, max_y
;
19411 /* The line may consist of one space only, that was added to
19412 place the cursor on it. If so, the row's height hasn't been
19414 if (row
->height
== 0)
19416 if (it
->max_ascent
+ it
->max_descent
== 0)
19417 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19418 row
->ascent
= it
->max_ascent
;
19419 row
->height
= it
->max_ascent
+ it
->max_descent
;
19420 row
->phys_ascent
= it
->max_phys_ascent
;
19421 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19422 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19425 /* Compute the width of this line. */
19426 row
->pixel_width
= row
->x
;
19427 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19428 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19430 eassert (row
->pixel_width
>= 0);
19431 eassert (row
->ascent
>= 0 && row
->height
> 0);
19433 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19434 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19436 /* If first line's physical ascent is larger than its logical
19437 ascent, use the physical ascent, and make the row taller.
19438 This makes accented characters fully visible. */
19439 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19440 && row
->phys_ascent
> row
->ascent
)
19442 row
->height
+= row
->phys_ascent
- row
->ascent
;
19443 row
->ascent
= row
->phys_ascent
;
19446 /* Compute how much of the line is visible. */
19447 row
->visible_height
= row
->height
;
19449 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19450 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19452 if (row
->y
< min_y
)
19453 row
->visible_height
-= min_y
- row
->y
;
19454 if (row
->y
+ row
->height
> max_y
)
19455 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19459 row
->pixel_width
= row
->used
[TEXT_AREA
];
19460 if (row
->continued_p
)
19461 row
->pixel_width
-= it
->continuation_pixel_width
;
19462 else if (row
->truncated_on_right_p
)
19463 row
->pixel_width
-= it
->truncation_pixel_width
;
19464 row
->ascent
= row
->phys_ascent
= 0;
19465 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19466 row
->extra_line_spacing
= 0;
19469 /* Compute a hash code for this row. */
19470 row
->hash
= row_hash (row
);
19472 it
->max_ascent
= it
->max_descent
= 0;
19473 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19477 /* Append one space to the glyph row of iterator IT if doing a
19478 window-based redisplay. The space has the same face as
19479 IT->face_id. Value is true if a space was added.
19481 This function is called to make sure that there is always one glyph
19482 at the end of a glyph row that the cursor can be set on under
19483 window-systems. (If there weren't such a glyph we would not know
19484 how wide and tall a box cursor should be displayed).
19486 At the same time this space let's a nicely handle clearing to the
19487 end of the line if the row ends in italic text. */
19490 append_space_for_newline (struct it
*it
, bool default_face_p
)
19492 if (FRAME_WINDOW_P (it
->f
))
19494 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19496 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19497 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19499 /* Save some values that must not be changed.
19500 Must save IT->c and IT->len because otherwise
19501 ITERATOR_AT_END_P wouldn't work anymore after
19502 append_space_for_newline has been called. */
19503 enum display_element_type saved_what
= it
->what
;
19504 int saved_c
= it
->c
, saved_len
= it
->len
;
19505 int saved_char_to_display
= it
->char_to_display
;
19506 int saved_x
= it
->current_x
;
19507 int saved_face_id
= it
->face_id
;
19508 bool saved_box_end
= it
->end_of_box_run_p
;
19509 struct text_pos saved_pos
;
19510 Lisp_Object saved_object
;
19513 saved_object
= it
->object
;
19514 saved_pos
= it
->position
;
19516 it
->what
= IT_CHARACTER
;
19517 memset (&it
->position
, 0, sizeof it
->position
);
19519 it
->c
= it
->char_to_display
= ' ';
19522 /* If the default face was remapped, be sure to use the
19523 remapped face for the appended newline. */
19524 if (default_face_p
)
19525 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19526 else if (it
->face_before_selective_p
)
19527 it
->face_id
= it
->saved_face_id
;
19528 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19529 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19530 /* In R2L rows, we will prepend a stretch glyph that will
19531 have the end_of_box_run_p flag set for it, so there's no
19532 need for the appended newline glyph to have that flag
19534 if (it
->glyph_row
->reversed_p
19535 /* But if the appended newline glyph goes all the way to
19536 the end of the row, there will be no stretch glyph,
19537 so leave the box flag set. */
19538 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19539 it
->end_of_box_run_p
= false;
19541 PRODUCE_GLYPHS (it
);
19543 #ifdef HAVE_WINDOW_SYSTEM
19544 /* Make sure this space glyph has the right ascent and
19545 descent values, or else cursor at end of line will look
19546 funny, and height of empty lines will be incorrect. */
19547 struct glyph
*g
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19548 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
19551 Lisp_Object height
, total_height
;
19552 int extra_line_spacing
= it
->extra_line_spacing
;
19553 int boff
= font
->baseline_offset
;
19555 if (font
->vertical_centering
)
19556 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
19558 it
->object
= saved_object
; /* get_it_property needs this */
19559 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
19560 /* Must do a subset of line height processing from
19561 x_produce_glyph for newline characters. */
19562 height
= get_it_property (it
, Qline_height
);
19564 && CONSP (XCDR (height
))
19565 && NILP (XCDR (XCDR (height
))))
19567 total_height
= XCAR (XCDR (height
));
19568 height
= XCAR (height
);
19571 total_height
= Qnil
;
19572 height
= calc_line_height_property (it
, height
, font
, boff
, true);
19574 if (it
->override_ascent
>= 0)
19576 it
->ascent
= it
->override_ascent
;
19577 it
->descent
= it
->override_descent
;
19578 boff
= it
->override_boff
;
19580 if (EQ (height
, Qt
))
19581 extra_line_spacing
= 0;
19584 Lisp_Object spacing
;
19586 it
->phys_ascent
= it
->ascent
;
19587 it
->phys_descent
= it
->descent
;
19589 && XINT (height
) > it
->ascent
+ it
->descent
)
19590 it
->ascent
= XINT (height
) - it
->descent
;
19592 if (!NILP (total_height
))
19593 spacing
= calc_line_height_property (it
, total_height
, font
,
19597 spacing
= get_it_property (it
, Qline_spacing
);
19598 spacing
= calc_line_height_property (it
, spacing
, font
,
19601 if (INTEGERP (spacing
))
19603 extra_line_spacing
= XINT (spacing
);
19604 if (!NILP (total_height
))
19605 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
19608 if (extra_line_spacing
> 0)
19610 it
->descent
+= extra_line_spacing
;
19611 if (extra_line_spacing
> it
->max_extra_line_spacing
)
19612 it
->max_extra_line_spacing
= extra_line_spacing
;
19614 it
->max_ascent
= it
->ascent
;
19615 it
->max_descent
= it
->descent
;
19616 /* Make sure compute_line_metrics recomputes the row height. */
19617 it
->glyph_row
->height
= 0;
19620 g
->ascent
= it
->max_ascent
;
19621 g
->descent
= it
->max_descent
;
19624 it
->override_ascent
= -1;
19625 it
->constrain_row_ascent_descent_p
= false;
19626 it
->current_x
= saved_x
;
19627 it
->object
= saved_object
;
19628 it
->position
= saved_pos
;
19629 it
->what
= saved_what
;
19630 it
->face_id
= saved_face_id
;
19631 it
->len
= saved_len
;
19633 it
->char_to_display
= saved_char_to_display
;
19634 it
->end_of_box_run_p
= saved_box_end
;
19643 /* Extend the face of the last glyph in the text area of IT->glyph_row
19644 to the end of the display line. Called from display_line. If the
19645 glyph row is empty, add a space glyph to it so that we know the
19646 face to draw. Set the glyph row flag fill_line_p. If the glyph
19647 row is R2L, prepend a stretch glyph to cover the empty space to the
19648 left of the leftmost glyph. */
19651 extend_face_to_end_of_line (struct it
*it
)
19653 struct face
*face
, *default_face
;
19654 struct frame
*f
= it
->f
;
19656 /* If line is already filled, do nothing. Non window-system frames
19657 get a grace of one more ``pixel'' because their characters are
19658 1-``pixel'' wide, so they hit the equality too early. This grace
19659 is needed only for R2L rows that are not continued, to produce
19660 one extra blank where we could display the cursor. */
19661 if ((it
->current_x
>= it
->last_visible_x
19662 + (!FRAME_WINDOW_P (f
)
19663 && it
->glyph_row
->reversed_p
19664 && !it
->glyph_row
->continued_p
))
19665 /* If the window has display margins, we will need to extend
19666 their face even if the text area is filled. */
19667 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19668 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19671 /* The default face, possibly remapped. */
19672 default_face
= FACE_OPT_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19674 /* Face extension extends the background and box of IT->face_id
19675 to the end of the line. If the background equals the background
19676 of the frame, we don't have to do anything. */
19677 face
= FACE_OPT_FROM_ID (f
, (it
->face_before_selective_p
19678 ? it
->saved_face_id
19681 if (FRAME_WINDOW_P (f
)
19682 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19683 && face
->box
== FACE_NO_BOX
19684 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19685 #ifdef HAVE_WINDOW_SYSTEM
19688 && !it
->glyph_row
->reversed_p
)
19691 /* Set the glyph row flag indicating that the face of the last glyph
19692 in the text area has to be drawn to the end of the text area. */
19693 it
->glyph_row
->fill_line_p
= true;
19695 /* If current character of IT is not ASCII, make sure we have the
19696 ASCII face. This will be automatically undone the next time
19697 get_next_display_element returns a multibyte character. Note
19698 that the character will always be single byte in unibyte
19700 if (!ASCII_CHAR_P (it
->c
))
19702 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19705 if (FRAME_WINDOW_P (f
))
19707 /* If the row is empty, add a space with the current face of IT,
19708 so that we know which face to draw. */
19709 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19711 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19712 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19713 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19715 /* Mode line and the header line don't have margins, and
19716 likewise the frame's tool-bar window, if there is any. */
19717 if (!(it
->glyph_row
->mode_line_p
19718 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19719 || (WINDOWP (f
->tool_bar_window
)
19720 && it
->w
== XWINDOW (f
->tool_bar_window
))
19724 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19725 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19727 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19728 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19730 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19732 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19733 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19735 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19736 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19738 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19741 #ifdef HAVE_WINDOW_SYSTEM
19742 if (it
->glyph_row
->reversed_p
)
19744 /* Prepend a stretch glyph to the row, such that the
19745 rightmost glyph will be drawn flushed all the way to the
19746 right margin of the window. The stretch glyph that will
19747 occupy the empty space, if any, to the left of the
19749 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19750 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19751 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19753 int row_width
, stretch_ascent
, stretch_width
;
19754 struct text_pos saved_pos
;
19756 bool saved_avoid_cursor
, saved_box_start
;
19758 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19759 row_width
+= g
->pixel_width
;
19761 /* FIXME: There are various minor display glitches in R2L
19762 rows when only one of the fringes is missing. The
19763 strange condition below produces the least bad effect. */
19764 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19765 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19766 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19767 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19769 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19770 stretch_width
-= row_width
;
19772 if (stretch_width
> 0)
19775 (((it
->ascent
+ it
->descent
)
19776 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19777 saved_pos
= it
->position
;
19778 memset (&it
->position
, 0, sizeof it
->position
);
19779 saved_avoid_cursor
= it
->avoid_cursor_p
;
19780 it
->avoid_cursor_p
= true;
19781 saved_face_id
= it
->face_id
;
19782 saved_box_start
= it
->start_of_box_run_p
;
19783 /* The last row's stretch glyph should get the default
19784 face, to avoid painting the rest of the window with
19785 the region face, if the region ends at ZV. */
19786 if (it
->glyph_row
->ends_at_zv_p
)
19787 it
->face_id
= default_face
->id
;
19789 it
->face_id
= face
->id
;
19790 it
->start_of_box_run_p
= false;
19791 append_stretch_glyph (it
, Qnil
, stretch_width
,
19792 it
->ascent
+ it
->descent
, stretch_ascent
);
19793 it
->position
= saved_pos
;
19794 it
->avoid_cursor_p
= saved_avoid_cursor
;
19795 it
->face_id
= saved_face_id
;
19796 it
->start_of_box_run_p
= saved_box_start
;
19798 /* If stretch_width comes out negative, it means that the
19799 last glyph is only partially visible. In R2L rows, we
19800 want the leftmost glyph to be partially visible, so we
19801 need to give the row the corresponding left offset. */
19802 if (stretch_width
< 0)
19803 it
->glyph_row
->x
= stretch_width
;
19805 #endif /* HAVE_WINDOW_SYSTEM */
19809 /* Save some values that must not be changed. */
19810 int saved_x
= it
->current_x
;
19811 struct text_pos saved_pos
;
19812 Lisp_Object saved_object
;
19813 enum display_element_type saved_what
= it
->what
;
19814 int saved_face_id
= it
->face_id
;
19816 saved_object
= it
->object
;
19817 saved_pos
= it
->position
;
19819 it
->what
= IT_CHARACTER
;
19820 memset (&it
->position
, 0, sizeof it
->position
);
19822 it
->c
= it
->char_to_display
= ' ';
19825 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19826 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19827 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19828 && !it
->glyph_row
->mode_line_p
19829 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19831 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19832 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19834 for (it
->current_x
= 0; g
< e
; g
++)
19835 it
->current_x
+= g
->pixel_width
;
19837 it
->area
= LEFT_MARGIN_AREA
;
19838 it
->face_id
= default_face
->id
;
19839 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19840 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19842 PRODUCE_GLYPHS (it
);
19843 /* term.c:produce_glyphs advances it->current_x only for
19845 it
->current_x
+= it
->pixel_width
;
19848 it
->current_x
= saved_x
;
19849 it
->area
= TEXT_AREA
;
19852 /* The last row's blank glyphs should get the default face, to
19853 avoid painting the rest of the window with the region face,
19854 if the region ends at ZV. */
19855 if (it
->glyph_row
->ends_at_zv_p
)
19856 it
->face_id
= default_face
->id
;
19858 it
->face_id
= face
->id
;
19859 PRODUCE_GLYPHS (it
);
19861 while (it
->current_x
<= it
->last_visible_x
)
19862 PRODUCE_GLYPHS (it
);
19864 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19865 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19866 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19867 && !it
->glyph_row
->mode_line_p
19868 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19870 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19871 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19873 for ( ; g
< e
; g
++)
19874 it
->current_x
+= g
->pixel_width
;
19876 it
->area
= RIGHT_MARGIN_AREA
;
19877 it
->face_id
= default_face
->id
;
19878 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19879 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19881 PRODUCE_GLYPHS (it
);
19882 it
->current_x
+= it
->pixel_width
;
19885 it
->area
= TEXT_AREA
;
19888 /* Don't count these blanks really. It would let us insert a left
19889 truncation glyph below and make us set the cursor on them, maybe. */
19890 it
->current_x
= saved_x
;
19891 it
->object
= saved_object
;
19892 it
->position
= saved_pos
;
19893 it
->what
= saved_what
;
19894 it
->face_id
= saved_face_id
;
19899 /* Value is true if text starting at CHARPOS in current_buffer is
19900 trailing whitespace. */
19903 trailing_whitespace_p (ptrdiff_t charpos
)
19905 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19908 while (bytepos
< ZV_BYTE
19909 && (c
= FETCH_CHAR (bytepos
),
19910 c
== ' ' || c
== '\t'))
19913 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19915 if (bytepos
!= PT_BYTE
)
19922 /* Highlight trailing whitespace, if any, in ROW. */
19925 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19927 int used
= row
->used
[TEXT_AREA
];
19931 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19932 struct glyph
*glyph
= start
+ used
- 1;
19934 if (row
->reversed_p
)
19936 /* Right-to-left rows need to be processed in the opposite
19937 direction, so swap the edge pointers. */
19939 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19942 /* Skip over glyphs inserted to display the cursor at the
19943 end of a line, for extending the face of the last glyph
19944 to the end of the line on terminals, and for truncation
19945 and continuation glyphs. */
19946 if (!row
->reversed_p
)
19948 while (glyph
>= start
19949 && glyph
->type
== CHAR_GLYPH
19950 && NILP (glyph
->object
))
19955 while (glyph
<= start
19956 && glyph
->type
== CHAR_GLYPH
19957 && NILP (glyph
->object
))
19961 /* If last glyph is a space or stretch, and it's trailing
19962 whitespace, set the face of all trailing whitespace glyphs in
19963 IT->glyph_row to `trailing-whitespace'. */
19964 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19965 && BUFFERP (glyph
->object
)
19966 && (glyph
->type
== STRETCH_GLYPH
19967 || (glyph
->type
== CHAR_GLYPH
19968 && glyph
->u
.ch
== ' '))
19969 && trailing_whitespace_p (glyph
->charpos
))
19971 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, false);
19975 if (!row
->reversed_p
)
19977 while (glyph
>= start
19978 && BUFFERP (glyph
->object
)
19979 && (glyph
->type
== STRETCH_GLYPH
19980 || (glyph
->type
== CHAR_GLYPH
19981 && glyph
->u
.ch
== ' ')))
19982 (glyph
--)->face_id
= face_id
;
19986 while (glyph
<= start
19987 && BUFFERP (glyph
->object
)
19988 && (glyph
->type
== STRETCH_GLYPH
19989 || (glyph
->type
== CHAR_GLYPH
19990 && glyph
->u
.ch
== ' ')))
19991 (glyph
++)->face_id
= face_id
;
19998 /* Value is true if glyph row ROW should be
19999 considered to hold the buffer position CHARPOS. */
20002 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
20004 bool result
= true;
20006 if (charpos
== CHARPOS (row
->end
.pos
)
20007 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
20009 /* Suppose the row ends on a string.
20010 Unless the row is continued, that means it ends on a newline
20011 in the string. If it's anything other than a display string
20012 (e.g., a before-string from an overlay), we don't want the
20013 cursor there. (This heuristic seems to give the optimal
20014 behavior for the various types of multi-line strings.)
20015 One exception: if the string has `cursor' property on one of
20016 its characters, we _do_ want the cursor there. */
20017 if (CHARPOS (row
->end
.string_pos
) >= 0)
20019 if (row
->continued_p
)
20023 /* Check for `display' property. */
20024 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
20025 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
20026 struct glyph
*glyph
;
20029 for (glyph
= end
; glyph
>= beg
; --glyph
)
20030 if (STRINGP (glyph
->object
))
20033 = Fget_char_property (make_number (charpos
),
20037 && display_prop_string_p (prop
, glyph
->object
));
20038 /* If there's a `cursor' property on one of the
20039 string's characters, this row is a cursor row,
20040 even though this is not a display string. */
20043 Lisp_Object s
= glyph
->object
;
20045 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
20047 ptrdiff_t gpos
= glyph
->charpos
;
20049 if (!NILP (Fget_char_property (make_number (gpos
),
20061 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
20063 /* If the row ends in middle of a real character,
20064 and the line is continued, we want the cursor here.
20065 That's because CHARPOS (ROW->end.pos) would equal
20066 PT if PT is before the character. */
20067 if (!row
->ends_in_ellipsis_p
)
20068 result
= row
->continued_p
;
20070 /* If the row ends in an ellipsis, then
20071 CHARPOS (ROW->end.pos) will equal point after the
20072 invisible text. We want that position to be displayed
20073 after the ellipsis. */
20076 /* If the row ends at ZV, display the cursor at the end of that
20077 row instead of at the start of the row below. */
20079 result
= row
->ends_at_zv_p
;
20085 /* Value is true if glyph row ROW should be
20086 used to hold the cursor. */
20089 cursor_row_p (struct glyph_row
*row
)
20091 return row_for_charpos_p (row
, PT
);
20096 /* Push the property PROP so that it will be rendered at the current
20097 position in IT. Return true if PROP was successfully pushed, false
20098 otherwise. Called from handle_line_prefix to handle the
20099 `line-prefix' and `wrap-prefix' properties. */
20102 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
20104 struct text_pos pos
=
20105 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
20107 eassert (it
->method
== GET_FROM_BUFFER
20108 || it
->method
== GET_FROM_DISPLAY_VECTOR
20109 || it
->method
== GET_FROM_STRING
20110 || it
->method
== GET_FROM_IMAGE
);
20112 /* We need to save the current buffer/string position, so it will be
20113 restored by pop_it, because iterate_out_of_display_property
20114 depends on that being set correctly, but some situations leave
20115 it->position not yet set when this function is called. */
20116 push_it (it
, &pos
);
20118 if (STRINGP (prop
))
20120 if (SCHARS (prop
) == 0)
20127 it
->string_from_prefix_prop_p
= true;
20128 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
20129 it
->current
.overlay_string_index
= -1;
20130 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
20131 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
20132 it
->method
= GET_FROM_STRING
;
20133 it
->stop_charpos
= 0;
20135 it
->base_level_stop
= 0;
20137 /* Force paragraph direction to be that of the parent
20139 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
20140 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
20142 it
->paragraph_embedding
= L2R
;
20144 /* Set up the bidi iterator for this display string. */
20147 it
->bidi_it
.string
.lstring
= it
->string
;
20148 it
->bidi_it
.string
.s
= NULL
;
20149 it
->bidi_it
.string
.schars
= it
->end_charpos
;
20150 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
20151 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
20152 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
20153 it
->bidi_it
.w
= it
->w
;
20154 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
20157 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
20159 it
->method
= GET_FROM_STRETCH
;
20162 #ifdef HAVE_WINDOW_SYSTEM
20163 else if (IMAGEP (prop
))
20165 it
->what
= IT_IMAGE
;
20166 it
->image_id
= lookup_image (it
->f
, prop
);
20167 it
->method
= GET_FROM_IMAGE
;
20169 #endif /* HAVE_WINDOW_SYSTEM */
20172 pop_it (it
); /* bogus display property, give up */
20179 /* Return the character-property PROP at the current position in IT. */
20182 get_it_property (struct it
*it
, Lisp_Object prop
)
20184 Lisp_Object position
, object
= it
->object
;
20186 if (STRINGP (object
))
20187 position
= make_number (IT_STRING_CHARPOS (*it
));
20188 else if (BUFFERP (object
))
20190 position
= make_number (IT_CHARPOS (*it
));
20191 object
= it
->window
;
20196 return Fget_char_property (position
, prop
, object
);
20199 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
20202 handle_line_prefix (struct it
*it
)
20204 Lisp_Object prefix
;
20206 if (it
->continuation_lines_width
> 0)
20208 prefix
= get_it_property (it
, Qwrap_prefix
);
20210 prefix
= Vwrap_prefix
;
20214 prefix
= get_it_property (it
, Qline_prefix
);
20216 prefix
= Vline_prefix
;
20218 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
20220 /* If the prefix is wider than the window, and we try to wrap
20221 it, it would acquire its own wrap prefix, and so on till the
20222 iterator stack overflows. So, don't wrap the prefix. */
20223 it
->line_wrap
= TRUNCATE
;
20224 it
->avoid_cursor_p
= true;
20230 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
20231 only for R2L lines from display_line and display_string, when they
20232 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
20233 the line/string needs to be continued on the next glyph row. */
20235 unproduce_glyphs (struct it
*it
, int n
)
20237 struct glyph
*glyph
, *end
;
20239 eassert (it
->glyph_row
);
20240 eassert (it
->glyph_row
->reversed_p
);
20241 eassert (it
->area
== TEXT_AREA
);
20242 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
20244 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
20245 n
= it
->glyph_row
->used
[TEXT_AREA
];
20246 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
20247 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
20248 for ( ; glyph
< end
; glyph
++)
20249 glyph
[-n
] = *glyph
;
20252 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
20253 and ROW->maxpos. */
20255 find_row_edges (struct it
*it
, struct glyph_row
*row
,
20256 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
20257 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
20259 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20260 lines' rows is implemented for bidi-reordered rows. */
20262 /* ROW->minpos is the value of min_pos, the minimal buffer position
20263 we have in ROW, or ROW->start.pos if that is smaller. */
20264 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
20265 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
20267 /* We didn't find buffer positions smaller than ROW->start, or
20268 didn't find _any_ valid buffer positions in any of the glyphs,
20269 so we must trust the iterator's computed positions. */
20270 row
->minpos
= row
->start
.pos
;
20273 max_pos
= CHARPOS (it
->current
.pos
);
20274 max_bpos
= BYTEPOS (it
->current
.pos
);
20277 /* Here are the various use-cases for ending the row, and the
20278 corresponding values for ROW->maxpos:
20280 Line ends in a newline from buffer eol_pos + 1
20281 Line is continued from buffer max_pos + 1
20282 Line is truncated on right it->current.pos
20283 Line ends in a newline from string max_pos + 1(*)
20284 (*) + 1 only when line ends in a forward scan
20285 Line is continued from string max_pos
20286 Line is continued from display vector max_pos
20287 Line is entirely from a string min_pos == max_pos
20288 Line is entirely from a display vector min_pos == max_pos
20289 Line that ends at ZV ZV
20291 If you discover other use-cases, please add them here as
20293 if (row
->ends_at_zv_p
)
20294 row
->maxpos
= it
->current
.pos
;
20295 else if (row
->used
[TEXT_AREA
])
20297 bool seen_this_string
= false;
20298 struct glyph_row
*r1
= row
- 1;
20300 /* Did we see the same display string on the previous row? */
20301 if (STRINGP (it
->object
)
20302 /* this is not the first row */
20303 && row
> it
->w
->desired_matrix
->rows
20304 /* previous row is not the header line */
20305 && !r1
->mode_line_p
20306 /* previous row also ends in a newline from a string */
20307 && r1
->ends_in_newline_from_string_p
)
20309 struct glyph
*start
, *end
;
20311 /* Search for the last glyph of the previous row that came
20312 from buffer or string. Depending on whether the row is
20313 L2R or R2L, we need to process it front to back or the
20314 other way round. */
20315 if (!r1
->reversed_p
)
20317 start
= r1
->glyphs
[TEXT_AREA
];
20318 end
= start
+ r1
->used
[TEXT_AREA
];
20319 /* Glyphs inserted by redisplay have nil as their object. */
20321 && NILP ((end
- 1)->object
)
20322 && (end
- 1)->charpos
<= 0)
20326 if (EQ ((end
- 1)->object
, it
->object
))
20327 seen_this_string
= true;
20330 /* If all the glyphs of the previous row were inserted
20331 by redisplay, it means the previous row was
20332 produced from a single newline, which is only
20333 possible if that newline came from the same string
20334 as the one which produced this ROW. */
20335 seen_this_string
= true;
20339 end
= r1
->glyphs
[TEXT_AREA
] - 1;
20340 start
= end
+ r1
->used
[TEXT_AREA
];
20342 && NILP ((end
+ 1)->object
)
20343 && (end
+ 1)->charpos
<= 0)
20347 if (EQ ((end
+ 1)->object
, it
->object
))
20348 seen_this_string
= true;
20351 seen_this_string
= true;
20354 /* Take note of each display string that covers a newline only
20355 once, the first time we see it. This is for when a display
20356 string includes more than one newline in it. */
20357 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
20359 /* If we were scanning the buffer forward when we displayed
20360 the string, we want to account for at least one buffer
20361 position that belongs to this row (position covered by
20362 the display string), so that cursor positioning will
20363 consider this row as a candidate when point is at the end
20364 of the visual line represented by this row. This is not
20365 required when scanning back, because max_pos will already
20366 have a much larger value. */
20367 if (CHARPOS (row
->end
.pos
) > max_pos
)
20368 INC_BOTH (max_pos
, max_bpos
);
20369 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20371 else if (CHARPOS (it
->eol_pos
) > 0)
20372 SET_TEXT_POS (row
->maxpos
,
20373 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
20374 else if (row
->continued_p
)
20376 /* If max_pos is different from IT's current position, it
20377 means IT->method does not belong to the display element
20378 at max_pos. However, it also means that the display
20379 element at max_pos was displayed in its entirety on this
20380 line, which is equivalent to saying that the next line
20381 starts at the next buffer position. */
20382 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
20383 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20386 INC_BOTH (max_pos
, max_bpos
);
20387 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20390 else if (row
->truncated_on_right_p
)
20391 /* display_line already called reseat_at_next_visible_line_start,
20392 which puts the iterator at the beginning of the next line, in
20393 the logical order. */
20394 row
->maxpos
= it
->current
.pos
;
20395 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20396 /* A line that is entirely from a string/image/stretch... */
20397 row
->maxpos
= row
->minpos
;
20402 row
->maxpos
= it
->current
.pos
;
20405 /* Construct the glyph row IT->glyph_row in the desired matrix of
20406 IT->w from text at the current position of IT. See dispextern.h
20407 for an overview of struct it. Value is true if
20408 IT->glyph_row displays text, as opposed to a line displaying ZV
20412 display_line (struct it
*it
)
20414 struct glyph_row
*row
= it
->glyph_row
;
20415 Lisp_Object overlay_arrow_string
;
20417 void *wrap_data
= NULL
;
20418 bool may_wrap
= false;
20420 int wrap_row_used
= -1;
20421 int wrap_row_ascent UNINIT
, wrap_row_height UNINIT
;
20422 int wrap_row_phys_ascent UNINIT
, wrap_row_phys_height UNINIT
;
20423 int wrap_row_extra_line_spacing UNINIT
;
20424 ptrdiff_t wrap_row_min_pos UNINIT
, wrap_row_min_bpos UNINIT
;
20425 ptrdiff_t wrap_row_max_pos UNINIT
, wrap_row_max_bpos UNINIT
;
20427 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20428 ptrdiff_t min_bpos UNINIT
, max_bpos UNINIT
;
20429 bool pending_handle_line_prefix
= false;
20431 /* We always start displaying at hpos zero even if hscrolled. */
20432 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20434 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20435 >= it
->w
->desired_matrix
->nrows
)
20437 it
->w
->nrows_scale_factor
++;
20438 it
->f
->fonts_changed
= true;
20442 /* Clear the result glyph row and enable it. */
20443 prepare_desired_row (it
->w
, row
, false);
20445 row
->y
= it
->current_y
;
20446 row
->start
= it
->start
;
20447 row
->continuation_lines_width
= it
->continuation_lines_width
;
20448 row
->displays_text_p
= true;
20449 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20450 it
->starts_in_middle_of_char_p
= false;
20452 /* Arrange the overlays nicely for our purposes. Usually, we call
20453 display_line on only one line at a time, in which case this
20454 can't really hurt too much, or we call it on lines which appear
20455 one after another in the buffer, in which case all calls to
20456 recenter_overlay_lists but the first will be pretty cheap. */
20457 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20459 /* Move over display elements that are not visible because we are
20460 hscrolled. This may stop at an x-position < IT->first_visible_x
20461 if the first glyph is partially visible or if we hit a line end. */
20462 if (it
->current_x
< it
->first_visible_x
)
20464 enum move_it_result move_result
;
20466 this_line_min_pos
= row
->start
.pos
;
20467 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20468 MOVE_TO_POS
| MOVE_TO_X
);
20469 /* If we are under a large hscroll, move_it_in_display_line_to
20470 could hit the end of the line without reaching
20471 it->first_visible_x. Pretend that we did reach it. This is
20472 especially important on a TTY, where we will call
20473 extend_face_to_end_of_line, which needs to know how many
20474 blank glyphs to produce. */
20475 if (it
->current_x
< it
->first_visible_x
20476 && (move_result
== MOVE_NEWLINE_OR_CR
20477 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20478 it
->current_x
= it
->first_visible_x
;
20480 /* Record the smallest positions seen while we moved over
20481 display elements that are not visible. This is needed by
20482 redisplay_internal for optimizing the case where the cursor
20483 stays inside the same line. The rest of this function only
20484 considers positions that are actually displayed, so
20485 RECORD_MAX_MIN_POS will not otherwise record positions that
20486 are hscrolled to the left of the left edge of the window. */
20487 min_pos
= CHARPOS (this_line_min_pos
);
20488 min_bpos
= BYTEPOS (this_line_min_pos
);
20490 else if (it
->area
== TEXT_AREA
)
20492 /* We only do this when not calling move_it_in_display_line_to
20493 above, because that function calls itself handle_line_prefix. */
20494 handle_line_prefix (it
);
20498 /* Line-prefix and wrap-prefix are always displayed in the text
20499 area. But if this is the first call to display_line after
20500 init_iterator, the iterator might have been set up to write
20501 into a marginal area, e.g. if the line begins with some
20502 display property that writes to the margins. So we need to
20503 wait with the call to handle_line_prefix until whatever
20504 writes to the margin has done its job. */
20505 pending_handle_line_prefix
= true;
20508 /* Get the initial row height. This is either the height of the
20509 text hscrolled, if there is any, or zero. */
20510 row
->ascent
= it
->max_ascent
;
20511 row
->height
= it
->max_ascent
+ it
->max_descent
;
20512 row
->phys_ascent
= it
->max_phys_ascent
;
20513 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20514 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20516 /* Utility macro to record max and min buffer positions seen until now. */
20517 #define RECORD_MAX_MIN_POS(IT) \
20520 bool composition_p \
20521 = !STRINGP ((IT)->string) && ((IT)->what == IT_COMPOSITION); \
20522 ptrdiff_t current_pos = \
20523 composition_p ? (IT)->cmp_it.charpos \
20524 : IT_CHARPOS (*(IT)); \
20525 ptrdiff_t current_bpos = \
20526 composition_p ? CHAR_TO_BYTE (current_pos) \
20527 : IT_BYTEPOS (*(IT)); \
20528 if (current_pos < min_pos) \
20530 min_pos = current_pos; \
20531 min_bpos = current_bpos; \
20533 if (IT_CHARPOS (*it) > max_pos) \
20535 max_pos = IT_CHARPOS (*it); \
20536 max_bpos = IT_BYTEPOS (*it); \
20541 /* Loop generating characters. The loop is left with IT on the next
20542 character to display. */
20545 int n_glyphs_before
, hpos_before
, x_before
;
20547 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20549 /* Retrieve the next thing to display. Value is false if end of
20551 if (!get_next_display_element (it
))
20553 /* Maybe add a space at the end of this line that is used to
20554 display the cursor there under X. Set the charpos of the
20555 first glyph of blank lines not corresponding to any text
20557 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20558 row
->exact_window_width_line_p
= true;
20559 else if ((append_space_for_newline (it
, true)
20560 && row
->used
[TEXT_AREA
] == 1)
20561 || row
->used
[TEXT_AREA
] == 0)
20563 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20564 row
->displays_text_p
= false;
20566 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20567 && (!MINI_WINDOW_P (it
->w
)
20568 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20569 row
->indicate_empty_line_p
= true;
20572 it
->continuation_lines_width
= 0;
20573 row
->ends_at_zv_p
= true;
20574 /* A row that displays right-to-left text must always have
20575 its last face extended all the way to the end of line,
20576 even if this row ends in ZV, because we still write to
20577 the screen left to right. We also need to extend the
20578 last face if the default face is remapped to some
20579 different face, otherwise the functions that clear
20580 portions of the screen will clear with the default face's
20581 background color. */
20582 if (row
->reversed_p
20583 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20584 extend_face_to_end_of_line (it
);
20588 /* Now, get the metrics of what we want to display. This also
20589 generates glyphs in `row' (which is IT->glyph_row). */
20590 n_glyphs_before
= row
->used
[TEXT_AREA
];
20593 /* Remember the line height so far in case the next element doesn't
20594 fit on the line. */
20595 if (it
->line_wrap
!= TRUNCATE
)
20597 ascent
= it
->max_ascent
;
20598 descent
= it
->max_descent
;
20599 phys_ascent
= it
->max_phys_ascent
;
20600 phys_descent
= it
->max_phys_descent
;
20602 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20604 if (IT_DISPLAYING_WHITESPACE (it
))
20608 SAVE_IT (wrap_it
, *it
, wrap_data
);
20610 wrap_row_used
= row
->used
[TEXT_AREA
];
20611 wrap_row_ascent
= row
->ascent
;
20612 wrap_row_height
= row
->height
;
20613 wrap_row_phys_ascent
= row
->phys_ascent
;
20614 wrap_row_phys_height
= row
->phys_height
;
20615 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20616 wrap_row_min_pos
= min_pos
;
20617 wrap_row_min_bpos
= min_bpos
;
20618 wrap_row_max_pos
= max_pos
;
20619 wrap_row_max_bpos
= max_bpos
;
20625 PRODUCE_GLYPHS (it
);
20627 /* If this display element was in marginal areas, continue with
20629 if (it
->area
!= TEXT_AREA
)
20631 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20632 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20633 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20634 row
->phys_height
= max (row
->phys_height
,
20635 it
->max_phys_ascent
+ it
->max_phys_descent
);
20636 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20637 it
->max_extra_line_spacing
);
20638 set_iterator_to_next (it
, true);
20639 /* If we didn't handle the line/wrap prefix above, and the
20640 call to set_iterator_to_next just switched to TEXT_AREA,
20641 process the prefix now. */
20642 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20644 pending_handle_line_prefix
= false;
20645 handle_line_prefix (it
);
20650 /* Does the display element fit on the line? If we truncate
20651 lines, we should draw past the right edge of the window. If
20652 we don't truncate, we want to stop so that we can display the
20653 continuation glyph before the right margin. If lines are
20654 continued, there are two possible strategies for characters
20655 resulting in more than 1 glyph (e.g. tabs): Display as many
20656 glyphs as possible in this line and leave the rest for the
20657 continuation line, or display the whole element in the next
20658 line. Original redisplay did the former, so we do it also. */
20659 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20660 hpos_before
= it
->hpos
;
20663 if (/* Not a newline. */
20665 /* Glyphs produced fit entirely in the line. */
20666 && it
->current_x
< it
->last_visible_x
)
20668 it
->hpos
+= nglyphs
;
20669 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20670 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20671 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20672 row
->phys_height
= max (row
->phys_height
,
20673 it
->max_phys_ascent
+ it
->max_phys_descent
);
20674 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20675 it
->max_extra_line_spacing
);
20676 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20677 /* In R2L rows, we arrange in extend_face_to_end_of_line
20678 to add a right offset to the line, by a suitable
20679 change to the stretch glyph that is the leftmost
20680 glyph of the line. */
20681 && !row
->reversed_p
)
20682 row
->x
= x
- it
->first_visible_x
;
20683 /* Record the maximum and minimum buffer positions seen so
20684 far in glyphs that will be displayed by this row. */
20686 RECORD_MAX_MIN_POS (it
);
20691 struct glyph
*glyph
;
20693 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20695 /* Identify the glyphs added by the last call to
20696 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20697 the previous glyphs. */
20698 if (!row
->reversed_p
)
20699 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20701 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20702 new_x
= x
+ glyph
->pixel_width
;
20704 if (/* Lines are continued. */
20705 it
->line_wrap
!= TRUNCATE
20706 && (/* Glyph doesn't fit on the line. */
20707 new_x
> it
->last_visible_x
20708 /* Or it fits exactly on a window system frame. */
20709 || (new_x
== it
->last_visible_x
20710 && FRAME_WINDOW_P (it
->f
)
20711 && (row
->reversed_p
20712 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20713 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20715 /* End of a continued line. */
20718 || (new_x
== it
->last_visible_x
20719 && FRAME_WINDOW_P (it
->f
)
20720 && (row
->reversed_p
20721 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20722 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20724 /* Current glyph is the only one on the line or
20725 fits exactly on the line. We must continue
20726 the line because we can't draw the cursor
20727 after the glyph. */
20728 row
->continued_p
= true;
20729 it
->current_x
= new_x
;
20730 it
->continuation_lines_width
+= new_x
;
20732 if (i
== nglyphs
- 1)
20734 /* If line-wrap is on, check if a previous
20735 wrap point was found. */
20736 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)
20737 && wrap_row_used
> 0
20738 /* Even if there is a previous wrap
20739 point, continue the line here as
20740 usual, if (i) the previous character
20741 was a space or tab AND (ii) the
20742 current character is not. */
20744 || IT_DISPLAYING_WHITESPACE (it
)))
20747 /* Record the maximum and minimum buffer
20748 positions seen so far in glyphs that will be
20749 displayed by this row. */
20751 RECORD_MAX_MIN_POS (it
);
20752 set_iterator_to_next (it
, true);
20753 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20755 if (!get_next_display_element (it
))
20757 row
->exact_window_width_line_p
= true;
20758 it
->continuation_lines_width
= 0;
20759 row
->continued_p
= false;
20760 row
->ends_at_zv_p
= true;
20762 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20764 row
->continued_p
= false;
20765 row
->exact_window_width_line_p
= true;
20767 /* If line-wrap is on, check if a
20768 previous wrap point was found. */
20769 else if (wrap_row_used
> 0
20770 /* Even if there is a previous wrap
20771 point, continue the line here as
20772 usual, if (i) the previous character
20773 was a space or tab AND (ii) the
20774 current character is not. */
20776 || IT_DISPLAYING_WHITESPACE (it
)))
20781 else if (it
->bidi_p
)
20782 RECORD_MAX_MIN_POS (it
);
20783 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20784 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20785 extend_face_to_end_of_line (it
);
20787 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20788 && !FRAME_WINDOW_P (it
->f
))
20790 /* A padding glyph that doesn't fit on this line.
20791 This means the whole character doesn't fit
20793 if (row
->reversed_p
)
20794 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20795 - n_glyphs_before
);
20796 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20798 /* Fill the rest of the row with continuation
20799 glyphs like in 20.x. */
20800 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20801 < row
->glyphs
[1 + TEXT_AREA
])
20802 produce_special_glyphs (it
, IT_CONTINUATION
);
20804 row
->continued_p
= true;
20805 it
->current_x
= x_before
;
20806 it
->continuation_lines_width
+= x_before
;
20808 /* Restore the height to what it was before the
20809 element not fitting on the line. */
20810 it
->max_ascent
= ascent
;
20811 it
->max_descent
= descent
;
20812 it
->max_phys_ascent
= phys_ascent
;
20813 it
->max_phys_descent
= phys_descent
;
20814 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20815 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20816 extend_face_to_end_of_line (it
);
20818 else if (wrap_row_used
> 0)
20821 if (row
->reversed_p
)
20822 unproduce_glyphs (it
,
20823 row
->used
[TEXT_AREA
] - wrap_row_used
);
20824 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20825 it
->continuation_lines_width
+= wrap_x
;
20826 row
->used
[TEXT_AREA
] = wrap_row_used
;
20827 row
->ascent
= wrap_row_ascent
;
20828 row
->height
= wrap_row_height
;
20829 row
->phys_ascent
= wrap_row_phys_ascent
;
20830 row
->phys_height
= wrap_row_phys_height
;
20831 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20832 min_pos
= wrap_row_min_pos
;
20833 min_bpos
= wrap_row_min_bpos
;
20834 max_pos
= wrap_row_max_pos
;
20835 max_bpos
= wrap_row_max_bpos
;
20836 row
->continued_p
= true;
20837 row
->ends_at_zv_p
= false;
20838 row
->exact_window_width_line_p
= false;
20839 it
->continuation_lines_width
+= x
;
20841 /* Make sure that a non-default face is extended
20842 up to the right margin of the window. */
20843 extend_face_to_end_of_line (it
);
20845 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20847 /* A TAB that extends past the right edge of the
20848 window. This produces a single glyph on
20849 window system frames. We leave the glyph in
20850 this row and let it fill the row, but don't
20851 consume the TAB. */
20852 if ((row
->reversed_p
20853 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20854 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20855 produce_special_glyphs (it
, IT_CONTINUATION
);
20856 it
->continuation_lines_width
+= it
->last_visible_x
;
20857 row
->ends_in_middle_of_char_p
= true;
20858 row
->continued_p
= true;
20859 glyph
->pixel_width
= it
->last_visible_x
- x
;
20860 it
->starts_in_middle_of_char_p
= true;
20861 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20862 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20863 extend_face_to_end_of_line (it
);
20867 /* Something other than a TAB that draws past
20868 the right edge of the window. Restore
20869 positions to values before the element. */
20870 if (row
->reversed_p
)
20871 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20872 - (n_glyphs_before
+ i
));
20873 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20875 /* Display continuation glyphs. */
20876 it
->current_x
= x_before
;
20877 it
->continuation_lines_width
+= x
;
20878 if (!FRAME_WINDOW_P (it
->f
)
20879 || (row
->reversed_p
20880 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20881 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20882 produce_special_glyphs (it
, IT_CONTINUATION
);
20883 row
->continued_p
= true;
20885 extend_face_to_end_of_line (it
);
20887 if (nglyphs
> 1 && i
> 0)
20889 row
->ends_in_middle_of_char_p
= true;
20890 it
->starts_in_middle_of_char_p
= true;
20893 /* Restore the height to what it was before the
20894 element not fitting on the line. */
20895 it
->max_ascent
= ascent
;
20896 it
->max_descent
= descent
;
20897 it
->max_phys_ascent
= phys_ascent
;
20898 it
->max_phys_descent
= phys_descent
;
20903 else if (new_x
> it
->first_visible_x
)
20905 /* Increment number of glyphs actually displayed. */
20908 /* Record the maximum and minimum buffer positions
20909 seen so far in glyphs that will be displayed by
20912 RECORD_MAX_MIN_POS (it
);
20914 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20915 /* Glyph is partially visible, i.e. row starts at
20916 negative X position. Don't do that in R2L
20917 rows, where we arrange to add a right offset to
20918 the line in extend_face_to_end_of_line, by a
20919 suitable change to the stretch glyph that is
20920 the leftmost glyph of the line. */
20921 row
->x
= x
- it
->first_visible_x
;
20922 /* When the last glyph of an R2L row only fits
20923 partially on the line, we need to set row->x to a
20924 negative offset, so that the leftmost glyph is
20925 the one that is partially visible. But if we are
20926 going to produce the truncation glyph, this will
20927 be taken care of in produce_special_glyphs. */
20928 if (row
->reversed_p
20929 && new_x
> it
->last_visible_x
20930 && !(it
->line_wrap
== TRUNCATE
20931 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
20933 eassert (FRAME_WINDOW_P (it
->f
));
20934 row
->x
= it
->last_visible_x
- new_x
;
20939 /* Glyph is completely off the left margin of the
20940 window. This should not happen because of the
20941 move_it_in_display_line at the start of this
20942 function, unless the text display area of the
20943 window is empty. */
20944 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20947 /* Even if this display element produced no glyphs at all,
20948 we want to record its position. */
20949 if (it
->bidi_p
&& nglyphs
== 0)
20950 RECORD_MAX_MIN_POS (it
);
20952 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20953 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20954 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20955 row
->phys_height
= max (row
->phys_height
,
20956 it
->max_phys_ascent
+ it
->max_phys_descent
);
20957 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20958 it
->max_extra_line_spacing
);
20960 /* End of this display line if row is continued. */
20961 if (row
->continued_p
|| row
->ends_at_zv_p
)
20966 /* Is this a line end? If yes, we're also done, after making
20967 sure that a non-default face is extended up to the right
20968 margin of the window. */
20969 if (ITERATOR_AT_END_OF_LINE_P (it
))
20971 int used_before
= row
->used
[TEXT_AREA
];
20973 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20975 /* Add a space at the end of the line that is used to
20976 display the cursor there. */
20977 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20978 append_space_for_newline (it
, false);
20980 /* Extend the face to the end of the line. */
20981 extend_face_to_end_of_line (it
);
20983 /* Make sure we have the position. */
20984 if (used_before
== 0)
20985 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20987 /* Record the position of the newline, for use in
20989 it
->eol_pos
= it
->current
.pos
;
20991 /* Consume the line end. This skips over invisible lines. */
20992 set_iterator_to_next (it
, true);
20993 it
->continuation_lines_width
= 0;
20997 /* Proceed with next display element. Note that this skips
20998 over lines invisible because of selective display. */
20999 set_iterator_to_next (it
, true);
21001 /* If we truncate lines, we are done when the last displayed
21002 glyphs reach past the right margin of the window. */
21003 if (it
->line_wrap
== TRUNCATE
21004 && ((FRAME_WINDOW_P (it
->f
)
21005 /* Images are preprocessed in produce_image_glyph such
21006 that they are cropped at the right edge of the
21007 window, so an image glyph will always end exactly at
21008 last_visible_x, even if there's no right fringe. */
21009 && ((row
->reversed_p
21010 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
21011 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
21012 || it
->what
== IT_IMAGE
))
21013 ? (it
->current_x
>= it
->last_visible_x
)
21014 : (it
->current_x
> it
->last_visible_x
)))
21016 /* Maybe add truncation glyphs. */
21017 if (!FRAME_WINDOW_P (it
->f
)
21018 || (row
->reversed_p
21019 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
21020 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
21024 if (!row
->reversed_p
)
21026 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
21027 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
21032 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
21033 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
21035 /* Remove any padding glyphs at the front of ROW, to
21036 make room for the truncation glyphs we will be
21037 adding below. The loop below always inserts at
21038 least one truncation glyph, so also remove the
21039 last glyph added to ROW. */
21040 unproduce_glyphs (it
, i
+ 1);
21041 /* Adjust i for the loop below. */
21042 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
21045 /* produce_special_glyphs overwrites the last glyph, so
21046 we don't want that if we want to keep that last
21047 glyph, which means it's an image. */
21048 if (it
->current_x
> it
->last_visible_x
)
21050 it
->current_x
= x_before
;
21051 if (!FRAME_WINDOW_P (it
->f
))
21053 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
21055 row
->used
[TEXT_AREA
] = i
;
21056 produce_special_glyphs (it
, IT_TRUNCATION
);
21061 row
->used
[TEXT_AREA
] = i
;
21062 produce_special_glyphs (it
, IT_TRUNCATION
);
21064 it
->hpos
= hpos_before
;
21067 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
21069 /* Don't truncate if we can overflow newline into fringe. */
21070 if (!get_next_display_element (it
))
21072 it
->continuation_lines_width
= 0;
21073 row
->ends_at_zv_p
= true;
21074 row
->exact_window_width_line_p
= true;
21077 if (ITERATOR_AT_END_OF_LINE_P (it
))
21079 row
->exact_window_width_line_p
= true;
21080 goto at_end_of_line
;
21082 it
->current_x
= x_before
;
21083 it
->hpos
= hpos_before
;
21086 row
->truncated_on_right_p
= true;
21087 it
->continuation_lines_width
= 0;
21088 reseat_at_next_visible_line_start (it
, false);
21089 /* We insist below that IT's position be at ZV because in
21090 bidi-reordered lines the character at visible line start
21091 might not be the character that follows the newline in
21092 the logical order. */
21093 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
21094 row
->ends_at_zv_p
=
21095 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
21097 row
->ends_at_zv_p
= false;
21103 bidi_unshelve_cache (wrap_data
, true);
21105 /* If line is not empty and hscrolled, maybe insert truncation glyphs
21106 at the left window margin. */
21107 if (it
->first_visible_x
21108 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
21110 if (!FRAME_WINDOW_P (it
->f
)
21111 || (((row
->reversed_p
21112 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21113 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
21114 /* Don't let insert_left_trunc_glyphs overwrite the
21115 first glyph of the row if it is an image. */
21116 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
21117 insert_left_trunc_glyphs (it
);
21118 row
->truncated_on_left_p
= true;
21121 /* Remember the position at which this line ends.
21123 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
21124 cannot be before the call to find_row_edges below, since that is
21125 where these positions are determined. */
21126 row
->end
= it
->current
;
21129 row
->minpos
= row
->start
.pos
;
21130 row
->maxpos
= row
->end
.pos
;
21134 /* ROW->minpos and ROW->maxpos must be the smallest and
21135 `1 + the largest' buffer positions in ROW. But if ROW was
21136 bidi-reordered, these two positions can be anywhere in the
21137 row, so we must determine them now. */
21138 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
21141 /* If the start of this line is the overlay arrow-position, then
21142 mark this glyph row as the one containing the overlay arrow.
21143 This is clearly a mess with variable size fonts. It would be
21144 better to let it be displayed like cursors under X. */
21145 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
21146 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
21147 !NILP (overlay_arrow_string
)))
21149 /* Overlay arrow in window redisplay is a fringe bitmap. */
21150 if (STRINGP (overlay_arrow_string
))
21152 struct glyph_row
*arrow_row
21153 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
21154 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
21155 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
21156 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
21157 struct glyph
*p2
, *end
;
21159 /* Copy the arrow glyphs. */
21160 while (glyph
< arrow_end
)
21163 /* Throw away padding glyphs. */
21165 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
21166 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
21172 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
21177 eassert (INTEGERP (overlay_arrow_string
));
21178 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
21180 overlay_arrow_seen
= true;
21183 /* Highlight trailing whitespace. */
21184 if (!NILP (Vshow_trailing_whitespace
))
21185 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
21187 /* Compute pixel dimensions of this line. */
21188 compute_line_metrics (it
);
21190 /* Implementation note: No changes in the glyphs of ROW or in their
21191 faces can be done past this point, because compute_line_metrics
21192 computes ROW's hash value and stores it within the glyph_row
21195 /* Record whether this row ends inside an ellipsis. */
21196 row
->ends_in_ellipsis_p
21197 = (it
->method
== GET_FROM_DISPLAY_VECTOR
21198 && it
->ellipsis_p
);
21200 /* Save fringe bitmaps in this row. */
21201 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
21202 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
21203 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
21204 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
21206 it
->left_user_fringe_bitmap
= 0;
21207 it
->left_user_fringe_face_id
= 0;
21208 it
->right_user_fringe_bitmap
= 0;
21209 it
->right_user_fringe_face_id
= 0;
21211 /* Maybe set the cursor. */
21212 cvpos
= it
->w
->cursor
.vpos
;
21214 /* In bidi-reordered rows, keep checking for proper cursor
21215 position even if one has been found already, because buffer
21216 positions in such rows change non-linearly with ROW->VPOS,
21217 when a line is continued. One exception: when we are at ZV,
21218 display cursor on the first suitable glyph row, since all
21219 the empty rows after that also have their position set to ZV. */
21220 /* FIXME: Revisit this when glyph ``spilling'' in continuation
21221 lines' rows is implemented for bidi-reordered rows. */
21223 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
21224 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
21225 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
21226 && cursor_row_p (row
))
21227 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
21229 /* Prepare for the next line. This line starts horizontally at (X
21230 HPOS) = (0 0). Vertical positions are incremented. As a
21231 convenience for the caller, IT->glyph_row is set to the next
21233 it
->current_x
= it
->hpos
= 0;
21234 it
->current_y
+= row
->height
;
21235 SET_TEXT_POS (it
->eol_pos
, 0, 0);
21238 /* The next row should by default use the same value of the
21239 reversed_p flag as this one. set_iterator_to_next decides when
21240 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
21241 the flag accordingly. */
21242 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
21243 it
->glyph_row
->reversed_p
= row
->reversed_p
;
21244 it
->start
= row
->end
;
21245 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
21247 #undef RECORD_MAX_MIN_POS
21250 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
21251 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
21252 doc
: /* Return paragraph direction at point in BUFFER.
21253 Value is either `left-to-right' or `right-to-left'.
21254 If BUFFER is omitted or nil, it defaults to the current buffer.
21256 Paragraph direction determines how the text in the paragraph is displayed.
21257 In left-to-right paragraphs, text begins at the left margin of the window
21258 and the reading direction is generally left to right. In right-to-left
21259 paragraphs, text begins at the right margin and is read from right to left.
21261 See also `bidi-paragraph-direction'. */)
21262 (Lisp_Object buffer
)
21264 struct buffer
*buf
= current_buffer
;
21265 struct buffer
*old
= buf
;
21267 if (! NILP (buffer
))
21269 CHECK_BUFFER (buffer
);
21270 buf
= XBUFFER (buffer
);
21273 if (NILP (BVAR (buf
, bidi_display_reordering
))
21274 || NILP (BVAR (buf
, enable_multibyte_characters
))
21275 /* When we are loading loadup.el, the character property tables
21276 needed for bidi iteration are not yet available. */
21277 || redisplay__inhibit_bidi
)
21278 return Qleft_to_right
;
21279 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
21280 return BVAR (buf
, bidi_paragraph_direction
);
21283 /* Determine the direction from buffer text. We could try to
21284 use current_matrix if it is up to date, but this seems fast
21285 enough as it is. */
21286 struct bidi_it itb
;
21287 ptrdiff_t pos
= BUF_PT (buf
);
21288 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
21290 void *itb_data
= bidi_shelve_cache ();
21292 set_buffer_temp (buf
);
21293 /* bidi_paragraph_init finds the base direction of the paragraph
21294 by searching forward from paragraph start. We need the base
21295 direction of the current or _previous_ paragraph, so we need
21296 to make sure we are within that paragraph. To that end, find
21297 the previous non-empty line. */
21298 if (pos
>= ZV
&& pos
> BEGV
)
21299 DEC_BOTH (pos
, bytepos
);
21300 AUTO_STRING (trailing_white_space
, "[\f\t ]*\n");
21301 if (fast_looking_at (trailing_white_space
,
21302 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
21304 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
21305 || c
== ' ' || c
== '\t' || c
== '\f')
21307 if (bytepos
<= BEGV_BYTE
)
21312 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
21315 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
21316 itb
.paragraph_dir
= NEUTRAL_DIR
;
21317 itb
.string
.s
= NULL
;
21318 itb
.string
.lstring
= Qnil
;
21319 itb
.string
.bufpos
= 0;
21320 itb
.string
.from_disp_str
= false;
21321 itb
.string
.unibyte
= false;
21322 /* We have no window to use here for ignoring window-specific
21323 overlays. Using NULL for window pointer will cause
21324 compute_display_string_pos to use the current buffer. */
21326 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, true);
21327 bidi_unshelve_cache (itb_data
, false);
21328 set_buffer_temp (old
);
21329 switch (itb
.paragraph_dir
)
21332 return Qleft_to_right
;
21335 return Qright_to_left
;
21343 DEFUN ("bidi-find-overridden-directionality",
21344 Fbidi_find_overridden_directionality
,
21345 Sbidi_find_overridden_directionality
, 2, 3, 0,
21346 doc
: /* Return position between FROM and TO where directionality was overridden.
21348 This function returns the first character position in the specified
21349 region of OBJECT where there is a character whose `bidi-class' property
21350 is `L', but which was forced to display as `R' by a directional
21351 override, and likewise with characters whose `bidi-class' is `R'
21352 or `AL' that were forced to display as `L'.
21354 If no such character is found, the function returns nil.
21356 OBJECT is a Lisp string or buffer to search for overridden
21357 directionality, and defaults to the current buffer if nil or omitted.
21358 OBJECT can also be a window, in which case the function will search
21359 the buffer displayed in that window. Passing the window instead of
21360 a buffer is preferable when the buffer is displayed in some window,
21361 because this function will then be able to correctly account for
21362 window-specific overlays, which can affect the results.
21364 Strong directional characters `L', `R', and `AL' can have their
21365 intrinsic directionality overridden by directional override
21366 control characters RLO (u+202e) and LRO (u+202d). See the
21367 function `get-char-code-property' for a way to inquire about
21368 the `bidi-class' property of a character. */)
21369 (Lisp_Object from
, Lisp_Object to
, Lisp_Object object
)
21371 struct buffer
*buf
= current_buffer
;
21372 struct buffer
*old
= buf
;
21373 struct window
*w
= NULL
;
21374 bool frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ());
21375 struct bidi_it itb
;
21376 ptrdiff_t from_pos
, to_pos
, from_bpos
;
21379 if (!NILP (object
))
21381 if (BUFFERP (object
))
21382 buf
= XBUFFER (object
);
21383 else if (WINDOWP (object
))
21385 w
= decode_live_window (object
);
21386 buf
= XBUFFER (w
->contents
);
21387 frame_window_p
= FRAME_WINDOW_P (XFRAME (w
->frame
));
21390 CHECK_STRING (object
);
21393 if (STRINGP (object
))
21395 /* Characters in unibyte strings are always treated by bidi.c as
21397 if (!STRING_MULTIBYTE (object
)
21398 /* When we are loading loadup.el, the character property
21399 tables needed for bidi iteration are not yet
21401 || redisplay__inhibit_bidi
)
21404 validate_subarray (object
, from
, to
, SCHARS (object
), &from_pos
, &to_pos
);
21405 if (from_pos
>= SCHARS (object
))
21408 /* Set up the bidi iterator. */
21409 itb_data
= bidi_shelve_cache ();
21410 itb
.paragraph_dir
= NEUTRAL_DIR
;
21411 itb
.string
.lstring
= object
;
21412 itb
.string
.s
= NULL
;
21413 itb
.string
.schars
= SCHARS (object
);
21414 itb
.string
.bufpos
= 0;
21415 itb
.string
.from_disp_str
= false;
21416 itb
.string
.unibyte
= false;
21418 bidi_init_it (0, 0, frame_window_p
, &itb
);
21422 /* Nothing this fancy can happen in unibyte buffers, or in a
21423 buffer that disabled reordering, or if FROM is at EOB. */
21424 if (NILP (BVAR (buf
, bidi_display_reordering
))
21425 || NILP (BVAR (buf
, enable_multibyte_characters
))
21426 /* When we are loading loadup.el, the character property
21427 tables needed for bidi iteration are not yet
21429 || redisplay__inhibit_bidi
)
21432 set_buffer_temp (buf
);
21433 validate_region (&from
, &to
);
21434 from_pos
= XINT (from
);
21435 to_pos
= XINT (to
);
21436 if (from_pos
>= ZV
)
21439 /* Set up the bidi iterator. */
21440 itb_data
= bidi_shelve_cache ();
21441 from_bpos
= CHAR_TO_BYTE (from_pos
);
21442 if (from_pos
== BEGV
)
21444 itb
.charpos
= BEGV
;
21445 itb
.bytepos
= BEGV_BYTE
;
21447 else if (FETCH_CHAR (from_bpos
- 1) == '\n')
21449 itb
.charpos
= from_pos
;
21450 itb
.bytepos
= from_bpos
;
21453 itb
.charpos
= find_newline_no_quit (from_pos
, CHAR_TO_BYTE (from_pos
),
21455 itb
.paragraph_dir
= NEUTRAL_DIR
;
21456 itb
.string
.s
= NULL
;
21457 itb
.string
.lstring
= Qnil
;
21458 itb
.string
.bufpos
= 0;
21459 itb
.string
.from_disp_str
= false;
21460 itb
.string
.unibyte
= false;
21462 bidi_init_it (itb
.charpos
, itb
.bytepos
, frame_window_p
, &itb
);
21467 /* For the purposes of this function, the actual base direction of
21468 the paragraph doesn't matter, so just set it to L2R. */
21469 bidi_paragraph_init (L2R
, &itb
, false);
21470 while ((found
= bidi_find_first_overridden (&itb
)) < from_pos
)
21472 } while (found
== ZV
&& itb
.ch
== '\n' && itb
.charpos
< to_pos
);
21474 bidi_unshelve_cache (itb_data
, false);
21475 set_buffer_temp (old
);
21477 return (from_pos
<= found
&& found
< to_pos
) ? make_number (found
) : Qnil
;
21480 DEFUN ("move-point-visually", Fmove_point_visually
,
21481 Smove_point_visually
, 1, 1, 0,
21482 doc
: /* Move point in the visual order in the specified DIRECTION.
21483 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
21486 Value is the new character position of point. */)
21487 (Lisp_Object direction
)
21489 struct window
*w
= XWINDOW (selected_window
);
21490 struct buffer
*b
= XBUFFER (w
->contents
);
21491 struct glyph_row
*row
;
21493 Lisp_Object paragraph_dir
;
21495 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21496 (!(ROW)->continued_p \
21497 && NILP ((GLYPH)->object) \
21498 && (GLYPH)->type == CHAR_GLYPH \
21499 && (GLYPH)->u.ch == ' ' \
21500 && (GLYPH)->charpos >= 0 \
21501 && !(GLYPH)->avoid_cursor_p)
21503 CHECK_NUMBER (direction
);
21504 dir
= XINT (direction
);
21510 /* If current matrix is up-to-date, we can use the information
21511 recorded in the glyphs, at least as long as the goal is on the
21513 if (w
->window_end_valid
21514 && !windows_or_buffers_changed
21516 && !b
->clip_changed
21517 && !b
->prevent_redisplay_optimizations_p
21518 && !window_outdated (w
)
21519 /* We rely below on the cursor coordinates to be up to date, but
21520 we cannot trust them if some command moved point since the
21521 last complete redisplay. */
21522 && w
->last_point
== BUF_PT (b
)
21523 && w
->cursor
.vpos
>= 0
21524 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21525 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21527 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21528 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21529 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21531 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21533 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21535 SET_PT (g
->charpos
);
21536 w
->cursor
.vpos
= -1;
21537 return make_number (PT
);
21539 else if (!NILP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21543 if (BUFFERP (gpt
->object
))
21546 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21547 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21549 new_pos
-= (row
->reversed_p
? -dir
: dir
);
21551 else if (BUFFERP (g
->object
))
21552 new_pos
= g
->charpos
;
21556 w
->cursor
.vpos
= -1;
21557 return make_number (PT
);
21559 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21561 /* Glyphs inserted at the end of a non-empty line for
21562 positioning the cursor have zero charpos, so we must
21563 deduce the value of point by other means. */
21564 if (g
->charpos
> 0)
21565 SET_PT (g
->charpos
);
21566 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21568 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21569 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21572 w
->cursor
.vpos
= -1;
21573 return make_number (PT
);
21576 if (g
== e
|| NILP (g
->object
))
21578 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21579 goto simulate_display
;
21580 if (!row
->reversed_p
)
21584 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21585 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21586 goto simulate_display
;
21590 if (row
->reversed_p
&& !row
->continued_p
)
21592 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21593 w
->cursor
.vpos
= -1;
21594 return make_number (PT
);
21596 g
= row
->glyphs
[TEXT_AREA
];
21597 e
= g
+ row
->used
[TEXT_AREA
];
21598 for ( ; g
< e
; g
++)
21600 if (BUFFERP (g
->object
)
21601 /* Empty lines have only one glyph, which stands
21602 for the newline, and whose charpos is the
21603 buffer position of the newline. */
21604 || ROW_GLYPH_NEWLINE_P (row
, g
)
21605 /* When the buffer ends in a newline, the line at
21606 EOB also has one glyph, but its charpos is -1. */
21607 || (row
->ends_at_zv_p
21608 && !row
->reversed_p
21609 && NILP (g
->object
)
21610 && g
->type
== CHAR_GLYPH
21611 && g
->u
.ch
== ' '))
21613 if (g
->charpos
> 0)
21614 SET_PT (g
->charpos
);
21615 else if (!row
->reversed_p
21616 && row
->ends_at_zv_p
21621 w
->cursor
.vpos
= -1;
21622 return make_number (PT
);
21628 if (!row
->reversed_p
&& !row
->continued_p
)
21630 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21631 w
->cursor
.vpos
= -1;
21632 return make_number (PT
);
21634 e
= row
->glyphs
[TEXT_AREA
];
21635 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21636 for ( ; g
>= e
; g
--)
21638 if (BUFFERP (g
->object
)
21639 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21641 /* Empty R2L lines on GUI frames have the buffer
21642 position of the newline stored in the stretch
21644 || g
->type
== STRETCH_GLYPH
21645 || (row
->ends_at_zv_p
21647 && NILP (g
->object
)
21648 && g
->type
== CHAR_GLYPH
21649 && g
->u
.ch
== ' '))
21651 if (g
->charpos
> 0)
21652 SET_PT (g
->charpos
);
21653 else if (row
->reversed_p
21654 && row
->ends_at_zv_p
21659 w
->cursor
.vpos
= -1;
21660 return make_number (PT
);
21669 /* If we wind up here, we failed to move by using the glyphs, so we
21670 need to simulate display instead. */
21673 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21675 paragraph_dir
= Qleft_to_right
;
21676 if (EQ (paragraph_dir
, Qright_to_left
))
21678 if (PT
<= BEGV
&& dir
< 0)
21679 xsignal0 (Qbeginning_of_buffer
);
21680 else if (PT
>= ZV
&& dir
> 0)
21681 xsignal0 (Qend_of_buffer
);
21684 struct text_pos pt
;
21686 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21688 bool overshoot_expected
= false;
21689 #ifdef HAVE_WINDOW_SYSTEM
21690 bool target_is_eol_p
= false;
21693 /* Setup the arena. */
21694 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21695 start_display (&it
, w
, pt
);
21696 /* When lines are truncated, we could be called with point
21697 outside of the windows edges, in which case move_it_*
21698 functions either prematurely stop at window's edge or jump to
21699 the next screen line, whereas we rely below on our ability to
21700 reach point, in order to start from its X coordinate. So we
21701 need to disregard the window's horizontal extent in that case. */
21702 if (it
.line_wrap
== TRUNCATE
)
21703 it
.last_visible_x
= INFINITY
;
21705 if (it
.cmp_it
.id
< 0
21706 && it
.method
== GET_FROM_STRING
21707 && it
.area
== TEXT_AREA
21708 && it
.string_from_display_prop_p
21709 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21710 overshoot_expected
= true;
21712 /* Find the X coordinate of point. We start from the beginning
21713 of this or previous line to make sure we are before point in
21714 the logical order (since the move_it_* functions can only
21717 reseat_at_previous_visible_line_start (&it
);
21718 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21719 if (IT_CHARPOS (it
) != PT
)
21721 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21722 -1, -1, -1, MOVE_TO_POS
);
21723 /* If we missed point because the character there is
21724 displayed out of a display vector that has more than one
21725 glyph, retry expecting overshoot. */
21726 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21727 && it
.current
.dpvec_index
> 0
21728 && !overshoot_expected
)
21730 overshoot_expected
= true;
21733 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21734 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21736 pt_x
= it
.current_x
;
21738 if (dir
> 0 || overshoot_expected
)
21740 struct glyph_row
*row
= it
.glyph_row
;
21742 /* When point is at beginning of line, we don't have
21743 information about the glyph there loaded into struct
21744 it. Calling get_next_display_element fixes that. */
21746 get_next_display_element (&it
);
21747 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21748 it
.glyph_row
= NULL
;
21749 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21750 it
.glyph_row
= row
;
21751 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21752 it, lest it will become out of sync with it's buffer
21754 it
.current_x
= pt_x
;
21757 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21758 pixel_width
= it
.pixel_width
;
21759 if (overshoot_expected
&& at_eol_p
)
21761 else if (pixel_width
<= 0)
21764 /* If there's a display string (or something similar) at point,
21765 we are actually at the glyph to the left of point, so we need
21766 to correct the X coordinate. */
21767 if (overshoot_expected
)
21770 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21772 pt_x
+= pixel_width
;
21775 /* Compute target X coordinate, either to the left or to the
21776 right of point. On TTY frames, all characters have the same
21777 pixel width of 1, so we can use that. On GUI frames we don't
21778 have an easy way of getting at the pixel width of the
21779 character to the left of point, so we use a different method
21780 of getting to that place. */
21782 target_x
= pt_x
+ pixel_width
;
21784 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21786 /* Target X coordinate could be one line above or below the line
21787 of point, in which case we need to adjust the target X
21788 coordinate. Also, if moving to the left, we need to begin at
21789 the left edge of the point's screen line. */
21794 start_display (&it
, w
, pt
);
21795 if (it
.line_wrap
== TRUNCATE
)
21796 it
.last_visible_x
= INFINITY
;
21797 reseat_at_previous_visible_line_start (&it
);
21798 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21800 move_it_by_lines (&it
, pt_vpos
);
21804 move_it_by_lines (&it
, -1);
21805 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21806 #ifdef HAVE_WINDOW_SYSTEM
21807 target_is_eol_p
= true;
21809 /* Under word-wrap, we don't know the x coordinate of
21810 the last character displayed on the previous line,
21811 which immediately precedes the wrap point. To find
21812 out its x coordinate, we try moving to the right
21813 margin of the window, which will stop at the wrap
21814 point, and then reset target_x to point at the
21815 character that precedes the wrap point. This is not
21816 needed on GUI frames, because (see below) there we
21817 move from the left margin one grapheme cluster at a
21818 time, and stop when we hit the wrap point. */
21819 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21821 void *it_data
= NULL
;
21824 SAVE_IT (it2
, it
, it_data
);
21825 move_it_in_display_line_to (&it
, ZV
, target_x
,
21826 MOVE_TO_POS
| MOVE_TO_X
);
21827 /* If we arrived at target_x, that _is_ the last
21828 character on the previous line. */
21829 if (it
.current_x
!= target_x
)
21830 target_x
= it
.current_x
- 1;
21831 RESTORE_IT (&it
, &it2
, it_data
);
21838 || (target_x
>= it
.last_visible_x
21839 && it
.line_wrap
!= TRUNCATE
))
21842 move_it_by_lines (&it
, 0);
21843 move_it_by_lines (&it
, 1);
21848 /* Move to the target X coordinate. */
21849 #ifdef HAVE_WINDOW_SYSTEM
21850 /* On GUI frames, as we don't know the X coordinate of the
21851 character to the left of point, moving point to the left
21852 requires walking, one grapheme cluster at a time, until we
21853 find ourself at a place immediately to the left of the
21854 character at point. */
21855 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21857 struct text_pos new_pos
;
21858 enum move_it_result rc
= MOVE_X_REACHED
;
21860 if (it
.current_x
== 0)
21861 get_next_display_element (&it
);
21862 if (it
.what
== IT_COMPOSITION
)
21864 new_pos
.charpos
= it
.cmp_it
.charpos
;
21865 new_pos
.bytepos
= -1;
21868 new_pos
= it
.current
.pos
;
21870 while (it
.current_x
+ it
.pixel_width
<= target_x
21871 && (rc
== MOVE_X_REACHED
21872 /* Under word-wrap, move_it_in_display_line_to
21873 stops at correct coordinates, but sometimes
21874 returns MOVE_POS_MATCH_OR_ZV. */
21875 || (it
.line_wrap
== WORD_WRAP
21876 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21878 int new_x
= it
.current_x
+ it
.pixel_width
;
21880 /* For composed characters, we want the position of the
21881 first character in the grapheme cluster (usually, the
21882 composition's base character), whereas it.current
21883 might give us the position of the _last_ one, e.g. if
21884 the composition is rendered in reverse due to bidi
21886 if (it
.what
== IT_COMPOSITION
)
21888 new_pos
.charpos
= it
.cmp_it
.charpos
;
21889 new_pos
.bytepos
= -1;
21892 new_pos
= it
.current
.pos
;
21893 if (new_x
== it
.current_x
)
21895 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21896 MOVE_TO_POS
| MOVE_TO_X
);
21897 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21900 /* The previous position we saw in the loop is the one we
21902 if (new_pos
.bytepos
== -1)
21903 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21904 it
.current
.pos
= new_pos
;
21908 if (it
.current_x
!= target_x
)
21909 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21911 /* If we ended up in a display string that covers point, move to
21912 buffer position to the right in the visual order. */
21915 while (IT_CHARPOS (it
) == PT
)
21917 set_iterator_to_next (&it
, false);
21918 if (!get_next_display_element (&it
))
21923 /* Move point to that position. */
21924 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21927 return make_number (PT
);
21929 #undef ROW_GLYPH_NEWLINE_P
21932 DEFUN ("bidi-resolved-levels", Fbidi_resolved_levels
,
21933 Sbidi_resolved_levels
, 0, 1, 0,
21934 doc
: /* Return the resolved bidirectional levels of characters at VPOS.
21936 The resolved levels are produced by the Emacs bidi reordering engine
21937 that implements the UBA, the Unicode Bidirectional Algorithm. Please
21938 read the Unicode Standard Annex 9 (UAX#9) for background information
21939 about these levels.
21941 VPOS is the zero-based number of the current window's screen line
21942 for which to produce the resolved levels. If VPOS is nil or omitted,
21943 it defaults to the screen line of point. If the window displays a
21944 header line, VPOS of zero will report on the header line, and first
21945 line of text in the window will have VPOS of 1.
21947 Value is an array of resolved levels, indexed by glyph number.
21948 Glyphs are numbered from zero starting from the beginning of the
21949 screen line, i.e. the left edge of the window for left-to-right lines
21950 and from the right edge for right-to-left lines. The resolved levels
21951 are produced only for the window's text area; text in display margins
21954 If the selected window's display is not up-to-date, or if the specified
21955 screen line does not display text, this function returns nil. It is
21956 highly recommended to bind this function to some simple key, like F8,
21957 in order to avoid these problems.
21959 This function exists mainly for testing the correctness of the
21960 Emacs UBA implementation, in particular with the test suite. */)
21963 struct window
*w
= XWINDOW (selected_window
);
21964 struct buffer
*b
= XBUFFER (w
->contents
);
21966 struct glyph_row
*row
;
21970 int d1
, d2
, d3
, d4
, d5
;
21972 pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &nrow
);
21976 CHECK_NUMBER_COERCE_MARKER (vpos
);
21977 nrow
= XINT (vpos
);
21980 /* We require up-to-date glyph matrix for this window. */
21981 if (w
->window_end_valid
21982 && !windows_or_buffers_changed
21984 && !b
->clip_changed
21985 && !b
->prevent_redisplay_optimizations_p
21986 && !window_outdated (w
)
21988 && nrow
< w
->current_matrix
->nrows
21989 && (row
= MATRIX_ROW (w
->current_matrix
, nrow
))->enabled_p
21990 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
21992 struct glyph
*g
, *e
, *g1
;
21994 Lisp_Object levels
;
21996 if (!row
->reversed_p
) /* Left-to-right glyph row. */
21998 g
= g1
= row
->glyphs
[TEXT_AREA
];
21999 e
= g
+ row
->used
[TEXT_AREA
];
22001 /* Skip over glyphs at the start of the row that was
22002 generated by redisplay for its own needs. */
22004 && NILP (g
->object
)
22009 /* Count the "interesting" glyphs in this row. */
22010 for (nglyphs
= 0; g
< e
&& !NILP (g
->object
); g
++)
22013 /* Create and fill the array. */
22014 levels
= make_uninit_vector (nglyphs
);
22015 for (i
= 0; g1
< g
; i
++, g1
++)
22016 ASET (levels
, i
, make_number (g1
->resolved_level
));
22018 else /* Right-to-left glyph row. */
22020 g
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
22021 e
= row
->glyphs
[TEXT_AREA
] - 1;
22023 && NILP (g
->object
)
22027 for (nglyphs
= 0; g
> e
&& !NILP (g
->object
); g
--)
22029 levels
= make_uninit_vector (nglyphs
);
22030 for (i
= 0; g1
> g
; i
++, g1
--)
22031 ASET (levels
, i
, make_number (g1
->resolved_level
));
22041 /***********************************************************************
22043 ***********************************************************************/
22045 /* Redisplay the menu bar in the frame for window W.
22047 The menu bar of X frames that don't have X toolkit support is
22048 displayed in a special window W->frame->menu_bar_window.
22050 The menu bar of terminal frames is treated specially as far as
22051 glyph matrices are concerned. Menu bar lines are not part of
22052 windows, so the update is done directly on the frame matrix rows
22053 for the menu bar. */
22056 display_menu_bar (struct window
*w
)
22058 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22063 /* Don't do all this for graphical frames. */
22065 if (FRAME_W32_P (f
))
22068 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
22074 if (FRAME_NS_P (f
))
22076 #endif /* HAVE_NS */
22078 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
22079 eassert (!FRAME_WINDOW_P (f
));
22080 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
22081 it
.first_visible_x
= 0;
22082 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
22083 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
22084 if (FRAME_WINDOW_P (f
))
22086 /* Menu bar lines are displayed in the desired matrix of the
22087 dummy window menu_bar_window. */
22088 struct window
*menu_w
;
22089 menu_w
= XWINDOW (f
->menu_bar_window
);
22090 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
22092 it
.first_visible_x
= 0;
22093 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
22096 #endif /* not USE_X_TOOLKIT and not USE_GTK */
22098 /* This is a TTY frame, i.e. character hpos/vpos are used as
22100 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
22102 it
.first_visible_x
= 0;
22103 it
.last_visible_x
= FRAME_COLS (f
);
22106 /* FIXME: This should be controlled by a user option. See the
22107 comments in redisplay_tool_bar and display_mode_line about
22109 it
.paragraph_embedding
= L2R
;
22111 /* Clear all rows of the menu bar. */
22112 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
22114 struct glyph_row
*row
= it
.glyph_row
+ i
;
22115 clear_glyph_row (row
);
22116 row
->enabled_p
= true;
22117 row
->full_width_p
= true;
22118 row
->reversed_p
= false;
22121 /* Display all items of the menu bar. */
22122 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
22123 for (i
= 0; i
< ASIZE (items
); i
+= 4)
22125 Lisp_Object string
;
22127 /* Stop at nil string. */
22128 string
= AREF (items
, i
+ 1);
22132 /* Remember where item was displayed. */
22133 ASET (items
, i
+ 3, make_number (it
.hpos
));
22135 /* Display the item, pad with one space. */
22136 if (it
.current_x
< it
.last_visible_x
)
22137 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
22138 SCHARS (string
) + 1, 0, 0, -1);
22141 /* Fill out the line with spaces. */
22142 if (it
.current_x
< it
.last_visible_x
)
22143 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
22145 /* Compute the total height of the lines. */
22146 compute_line_metrics (&it
);
22149 /* Deep copy of a glyph row, including the glyphs. */
22151 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
22153 struct glyph
*pointers
[1 + LAST_AREA
];
22154 int to_used
= to
->used
[TEXT_AREA
];
22156 /* Save glyph pointers of TO. */
22157 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
22159 /* Do a structure assignment. */
22162 /* Restore original glyph pointers of TO. */
22163 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
22165 /* Copy the glyphs. */
22166 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
22167 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
22169 /* If we filled only part of the TO row, fill the rest with
22170 space_glyph (which will display as empty space). */
22171 if (to_used
> from
->used
[TEXT_AREA
])
22172 fill_up_frame_row_with_spaces (to
, to_used
);
22175 /* Display one menu item on a TTY, by overwriting the glyphs in the
22176 frame F's desired glyph matrix with glyphs produced from the menu
22177 item text. Called from term.c to display TTY drop-down menus one
22180 ITEM_TEXT is the menu item text as a C string.
22182 FACE_ID is the face ID to be used for this menu item. FACE_ID
22183 could specify one of 3 faces: a face for an enabled item, a face
22184 for a disabled item, or a face for a selected item.
22186 X and Y are coordinates of the first glyph in the frame's desired
22187 matrix to be overwritten by the menu item. Since this is a TTY, Y
22188 is the zero-based number of the glyph row and X is the zero-based
22189 glyph number in the row, starting from left, where to start
22190 displaying the item.
22192 SUBMENU means this menu item drops down a submenu, which
22193 should be indicated by displaying a proper visual cue after the
22197 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
22198 int x
, int y
, bool submenu
)
22201 struct frame
*f
= SELECTED_FRAME ();
22202 struct window
*w
= XWINDOW (f
->selected_window
);
22203 struct glyph_row
*row
;
22204 size_t item_len
= strlen (item_text
);
22206 eassert (FRAME_TERMCAP_P (f
));
22208 /* Don't write beyond the matrix's last row. This can happen for
22209 TTY screens that are not high enough to show the entire menu.
22210 (This is actually a bit of defensive programming, as
22211 tty_menu_display already limits the number of menu items to one
22212 less than the number of screen lines.) */
22213 if (y
>= f
->desired_matrix
->nrows
)
22216 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
22217 it
.first_visible_x
= 0;
22218 it
.last_visible_x
= FRAME_COLS (f
) - 1;
22219 row
= it
.glyph_row
;
22220 /* Start with the row contents from the current matrix. */
22221 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
22222 bool saved_width
= row
->full_width_p
;
22223 row
->full_width_p
= true;
22224 bool saved_reversed
= row
->reversed_p
;
22225 row
->reversed_p
= false;
22226 row
->enabled_p
= true;
22228 /* Arrange for the menu item glyphs to start at (X,Y) and have the
22230 eassert (x
< f
->desired_matrix
->matrix_w
);
22231 it
.current_x
= it
.hpos
= x
;
22232 it
.current_y
= it
.vpos
= y
;
22233 int saved_used
= row
->used
[TEXT_AREA
];
22234 bool saved_truncated
= row
->truncated_on_right_p
;
22235 row
->used
[TEXT_AREA
] = x
;
22236 it
.face_id
= face_id
;
22237 it
.line_wrap
= TRUNCATE
;
22239 /* FIXME: This should be controlled by a user option. See the
22240 comments in redisplay_tool_bar and display_mode_line about this.
22241 Also, if paragraph_embedding could ever be R2L, changes will be
22242 needed to avoid shifting to the right the row characters in
22243 term.c:append_glyph. */
22244 it
.paragraph_embedding
= L2R
;
22246 /* Pad with a space on the left. */
22247 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
22249 /* Display the menu item, pad with spaces to WIDTH. */
22252 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
22253 item_len
, 0, FRAME_COLS (f
) - 1, -1);
22255 /* Indicate with " >" that there's a submenu. */
22256 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
22257 FRAME_COLS (f
) - 1, -1);
22260 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
22261 width
, 0, FRAME_COLS (f
) - 1, -1);
22263 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
22264 row
->truncated_on_right_p
= saved_truncated
;
22265 row
->hash
= row_hash (row
);
22266 row
->full_width_p
= saved_width
;
22267 row
->reversed_p
= saved_reversed
;
22270 /***********************************************************************
22272 ***********************************************************************/
22274 /* Redisplay mode lines in the window tree whose root is WINDOW.
22275 If FORCE, redisplay mode lines unconditionally.
22276 Otherwise, redisplay only mode lines that are garbaged. Value is
22277 the number of windows whose mode lines were redisplayed. */
22280 redisplay_mode_lines (Lisp_Object window
, bool force
)
22284 while (!NILP (window
))
22286 struct window
*w
= XWINDOW (window
);
22288 if (WINDOWP (w
->contents
))
22289 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
22291 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
22292 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
22294 struct text_pos lpoint
;
22295 struct buffer
*old
= current_buffer
;
22297 /* Set the window's buffer for the mode line display. */
22298 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
22299 set_buffer_internal_1 (XBUFFER (w
->contents
));
22301 /* Point refers normally to the selected window. For any
22302 other window, set up appropriate value. */
22303 if (!EQ (window
, selected_window
))
22305 struct text_pos pt
;
22307 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
22308 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
22311 /* Display mode lines. */
22312 clear_glyph_matrix (w
->desired_matrix
);
22313 if (display_mode_lines (w
))
22316 /* Restore old settings. */
22317 set_buffer_internal_1 (old
);
22318 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
22328 /* Display the mode and/or header line of window W. Value is the
22329 sum number of mode lines and header lines displayed. */
22332 display_mode_lines (struct window
*w
)
22334 Lisp_Object old_selected_window
= selected_window
;
22335 Lisp_Object old_selected_frame
= selected_frame
;
22336 Lisp_Object new_frame
= w
->frame
;
22337 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
22340 selected_frame
= new_frame
;
22341 /* FIXME: If we were to allow the mode-line's computation changing the buffer
22342 or window's point, then we'd need select_window_1 here as well. */
22343 XSETWINDOW (selected_window
, w
);
22344 XFRAME (new_frame
)->selected_window
= selected_window
;
22346 /* These will be set while the mode line specs are processed. */
22347 line_number_displayed
= false;
22348 w
->column_number_displayed
= -1;
22350 if (WINDOW_WANTS_MODELINE_P (w
))
22352 struct window
*sel_w
= XWINDOW (old_selected_window
);
22354 /* Select mode line face based on the real selected window. */
22355 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
22356 BVAR (current_buffer
, mode_line_format
));
22360 if (WINDOW_WANTS_HEADER_LINE_P (w
))
22362 display_mode_line (w
, HEADER_LINE_FACE_ID
,
22363 BVAR (current_buffer
, header_line_format
));
22367 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
22368 selected_frame
= old_selected_frame
;
22369 selected_window
= old_selected_window
;
22371 w
->must_be_updated_p
= true;
22376 /* Display mode or header line of window W. FACE_ID specifies which
22377 line to display; it is either MODE_LINE_FACE_ID or
22378 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
22379 display. Value is the pixel height of the mode/header line
22383 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
22387 ptrdiff_t count
= SPECPDL_INDEX ();
22389 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22390 /* Don't extend on a previously drawn mode-line.
22391 This may happen if called from pos_visible_p. */
22392 it
.glyph_row
->enabled_p
= false;
22393 prepare_desired_row (w
, it
.glyph_row
, true);
22395 it
.glyph_row
->mode_line_p
= true;
22397 /* FIXME: This should be controlled by a user option. But
22398 supporting such an option is not trivial, since the mode line is
22399 made up of many separate strings. */
22400 it
.paragraph_embedding
= L2R
;
22402 record_unwind_protect (unwind_format_mode_line
,
22403 format_mode_line_unwind_data (NULL
, NULL
,
22406 mode_line_target
= MODE_LINE_DISPLAY
;
22408 /* Temporarily make frame's keyboard the current kboard so that
22409 kboard-local variables in the mode_line_format will get the right
22411 push_kboard (FRAME_KBOARD (it
.f
));
22412 record_unwind_save_match_data ();
22413 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22416 unbind_to (count
, Qnil
);
22418 /* Fill up with spaces. */
22419 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
22421 compute_line_metrics (&it
);
22422 it
.glyph_row
->full_width_p
= true;
22423 it
.glyph_row
->continued_p
= false;
22424 it
.glyph_row
->truncated_on_left_p
= false;
22425 it
.glyph_row
->truncated_on_right_p
= false;
22427 /* Make a 3D mode-line have a shadow at its right end. */
22428 face
= FACE_FROM_ID (it
.f
, face_id
);
22429 extend_face_to_end_of_line (&it
);
22430 if (face
->box
!= FACE_NO_BOX
)
22432 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
22433 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
22434 last
->right_box_line_p
= true;
22437 return it
.glyph_row
->height
;
22440 /* Move element ELT in LIST to the front of LIST.
22441 Return the updated list. */
22444 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
22446 register Lisp_Object tail
, prev
;
22447 register Lisp_Object tem
;
22451 while (CONSP (tail
))
22457 /* Splice out the link TAIL. */
22459 list
= XCDR (tail
);
22461 Fsetcdr (prev
, XCDR (tail
));
22463 /* Now make it the first. */
22464 Fsetcdr (tail
, list
);
22469 tail
= XCDR (tail
);
22473 /* Not found--return unchanged LIST. */
22477 /* Contribute ELT to the mode line for window IT->w. How it
22478 translates into text depends on its data type.
22480 IT describes the display environment in which we display, as usual.
22482 DEPTH is the depth in recursion. It is used to prevent
22483 infinite recursion here.
22485 FIELD_WIDTH is the number of characters the display of ELT should
22486 occupy in the mode line, and PRECISION is the maximum number of
22487 characters to display from ELT's representation. See
22488 display_string for details.
22490 Returns the hpos of the end of the text generated by ELT.
22492 PROPS is a property list to add to any string we encounter.
22494 If RISKY, remove (disregard) any properties in any string
22495 we encounter, and ignore :eval and :propertize.
22497 The global variable `mode_line_target' determines whether the
22498 output is passed to `store_mode_line_noprop',
22499 `store_mode_line_string', or `display_string'. */
22502 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
22503 Lisp_Object elt
, Lisp_Object props
, bool risky
)
22505 int n
= 0, field
, prec
;
22506 bool literal
= false;
22510 elt
= build_string ("*too-deep*");
22514 switch (XTYPE (elt
))
22518 /* A string: output it and check for %-constructs within it. */
22520 ptrdiff_t offset
= 0;
22522 if (SCHARS (elt
) > 0
22523 && (!NILP (props
) || risky
))
22525 Lisp_Object oprops
, aelt
;
22526 oprops
= Ftext_properties_at (make_number (0), elt
);
22528 /* If the starting string's properties are not what
22529 we want, translate the string. Also, if the string
22530 is risky, do that anyway. */
22532 if (NILP (Fequal (props
, oprops
)) || risky
)
22534 /* If the starting string has properties,
22535 merge the specified ones onto the existing ones. */
22536 if (! NILP (oprops
) && !risky
)
22540 oprops
= Fcopy_sequence (oprops
);
22542 while (CONSP (tem
))
22544 oprops
= Fplist_put (oprops
, XCAR (tem
),
22545 XCAR (XCDR (tem
)));
22546 tem
= XCDR (XCDR (tem
));
22551 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
22552 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
22554 /* AELT is what we want. Move it to the front
22555 without consing. */
22557 mode_line_proptrans_alist
22558 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
22564 /* If AELT has the wrong props, it is useless.
22565 so get rid of it. */
22567 mode_line_proptrans_alist
22568 = Fdelq (aelt
, mode_line_proptrans_alist
);
22570 elt
= Fcopy_sequence (elt
);
22571 Fset_text_properties (make_number (0), Flength (elt
),
22573 /* Add this item to mode_line_proptrans_alist. */
22574 mode_line_proptrans_alist
22575 = Fcons (Fcons (elt
, props
),
22576 mode_line_proptrans_alist
);
22577 /* Truncate mode_line_proptrans_alist
22578 to at most 50 elements. */
22579 tem
= Fnthcdr (make_number (50),
22580 mode_line_proptrans_alist
);
22582 XSETCDR (tem
, Qnil
);
22591 prec
= precision
- n
;
22592 switch (mode_line_target
)
22594 case MODE_LINE_NOPROP
:
22595 case MODE_LINE_TITLE
:
22596 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
22598 case MODE_LINE_STRING
:
22599 n
+= store_mode_line_string (NULL
, elt
, true, 0, prec
, Qnil
);
22601 case MODE_LINE_DISPLAY
:
22602 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
22603 0, prec
, 0, STRING_MULTIBYTE (elt
));
22610 /* Handle the non-literal case. */
22612 while ((precision
<= 0 || n
< precision
)
22613 && SREF (elt
, offset
) != 0
22614 && (mode_line_target
!= MODE_LINE_DISPLAY
22615 || it
->current_x
< it
->last_visible_x
))
22617 ptrdiff_t last_offset
= offset
;
22619 /* Advance to end of string or next format specifier. */
22620 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22623 if (offset
- 1 != last_offset
)
22625 ptrdiff_t nchars
, nbytes
;
22627 /* Output to end of string or up to '%'. Field width
22628 is length of string. Don't output more than
22629 PRECISION allows us. */
22632 prec
= c_string_width (SDATA (elt
) + last_offset
,
22633 offset
- last_offset
, precision
- n
,
22636 switch (mode_line_target
)
22638 case MODE_LINE_NOPROP
:
22639 case MODE_LINE_TITLE
:
22640 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22642 case MODE_LINE_STRING
:
22644 ptrdiff_t bytepos
= last_offset
;
22645 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22646 ptrdiff_t endpos
= (precision
<= 0
22647 ? string_byte_to_char (elt
, offset
)
22648 : charpos
+ nchars
);
22649 Lisp_Object mode_string
22650 = Fsubstring (elt
, make_number (charpos
),
22651 make_number (endpos
));
22652 n
+= store_mode_line_string (NULL
, mode_string
, false,
22656 case MODE_LINE_DISPLAY
:
22658 ptrdiff_t bytepos
= last_offset
;
22659 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22661 if (precision
<= 0)
22662 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22663 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22665 STRING_MULTIBYTE (elt
));
22670 else /* c == '%' */
22672 ptrdiff_t percent_position
= offset
;
22674 /* Get the specified minimum width. Zero means
22677 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22678 field
= field
* 10 + c
- '0';
22680 /* Don't pad beyond the total padding allowed. */
22681 if (field_width
- n
> 0 && field
> field_width
- n
)
22682 field
= field_width
- n
;
22684 /* Note that either PRECISION <= 0 or N < PRECISION. */
22685 prec
= precision
- n
;
22688 n
+= display_mode_element (it
, depth
, field
, prec
,
22689 Vglobal_mode_string
, props
,
22694 ptrdiff_t bytepos
, charpos
;
22696 Lisp_Object string
;
22698 bytepos
= percent_position
;
22699 charpos
= (STRING_MULTIBYTE (elt
)
22700 ? string_byte_to_char (elt
, bytepos
)
22702 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22703 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22705 switch (mode_line_target
)
22707 case MODE_LINE_NOPROP
:
22708 case MODE_LINE_TITLE
:
22709 n
+= store_mode_line_noprop (spec
, field
, prec
);
22711 case MODE_LINE_STRING
:
22713 Lisp_Object tem
= build_string (spec
);
22714 props
= Ftext_properties_at (make_number (charpos
), elt
);
22715 /* Should only keep face property in props */
22716 n
+= store_mode_line_string (NULL
, tem
, false,
22717 field
, prec
, props
);
22720 case MODE_LINE_DISPLAY
:
22722 int nglyphs_before
, nwritten
;
22724 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22725 nwritten
= display_string (spec
, string
, elt
,
22730 /* Assign to the glyphs written above the
22731 string where the `%x' came from, position
22735 struct glyph
*glyph
22736 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22740 for (i
= 0; i
< nwritten
; ++i
)
22742 glyph
[i
].object
= elt
;
22743 glyph
[i
].charpos
= charpos
;
22760 /* A symbol: process the value of the symbol recursively
22761 as if it appeared here directly. Avoid error if symbol void.
22762 Special case: if value of symbol is a string, output the string
22765 register Lisp_Object tem
;
22767 /* If the variable is not marked as risky to set
22768 then its contents are risky to use. */
22769 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22772 tem
= Fboundp (elt
);
22775 tem
= Fsymbol_value (elt
);
22776 /* If value is a string, output that string literally:
22777 don't check for % within it. */
22781 if (!EQ (tem
, elt
))
22783 /* Give up right away for nil or t. */
22793 register Lisp_Object car
, tem
;
22795 /* A cons cell: five distinct cases.
22796 If first element is :eval or :propertize, do something special.
22797 If first element is a string or a cons, process all the elements
22798 and effectively concatenate them.
22799 If first element is a negative number, truncate displaying cdr to
22800 at most that many characters. If positive, pad (with spaces)
22801 to at least that many characters.
22802 If first element is a symbol, process the cadr or caddr recursively
22803 according to whether the symbol's value is non-nil or nil. */
22805 if (EQ (car
, QCeval
))
22807 /* An element of the form (:eval FORM) means evaluate FORM
22808 and use the result as mode line elements. */
22813 if (CONSP (XCDR (elt
)))
22816 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22817 n
+= display_mode_element (it
, depth
, field_width
- n
,
22818 precision
- n
, spec
, props
,
22822 else if (EQ (car
, QCpropertize
))
22824 /* An element of the form (:propertize ELT PROPS...)
22825 means display ELT but applying properties PROPS. */
22830 if (CONSP (XCDR (elt
)))
22831 n
+= display_mode_element (it
, depth
, field_width
- n
,
22832 precision
- n
, XCAR (XCDR (elt
)),
22833 XCDR (XCDR (elt
)), risky
);
22835 else if (SYMBOLP (car
))
22837 tem
= Fboundp (car
);
22841 /* elt is now the cdr, and we know it is a cons cell.
22842 Use its car if CAR has a non-nil value. */
22845 tem
= Fsymbol_value (car
);
22852 /* Symbol's value is nil (or symbol is unbound)
22853 Get the cddr of the original list
22854 and if possible find the caddr and use that. */
22858 else if (!CONSP (elt
))
22863 else if (INTEGERP (car
))
22865 register int lim
= XINT (car
);
22869 /* Negative int means reduce maximum width. */
22870 if (precision
<= 0)
22873 precision
= min (precision
, -lim
);
22877 /* Padding specified. Don't let it be more than
22878 current maximum. */
22880 lim
= min (precision
, lim
);
22882 /* If that's more padding than already wanted, queue it.
22883 But don't reduce padding already specified even if
22884 that is beyond the current truncation point. */
22885 field_width
= max (lim
, field_width
);
22889 else if (STRINGP (car
) || CONSP (car
))
22891 Lisp_Object halftail
= elt
;
22895 && (precision
<= 0 || n
< precision
))
22897 n
+= display_mode_element (it
, depth
,
22898 /* Do padding only after the last
22899 element in the list. */
22900 (! CONSP (XCDR (elt
))
22903 precision
- n
, XCAR (elt
),
22907 if ((len
& 1) == 0)
22908 halftail
= XCDR (halftail
);
22909 /* Check for cycle. */
22910 if (EQ (halftail
, elt
))
22919 elt
= build_string ("*invalid*");
22923 /* Pad to FIELD_WIDTH. */
22924 if (field_width
> 0 && n
< field_width
)
22926 switch (mode_line_target
)
22928 case MODE_LINE_NOPROP
:
22929 case MODE_LINE_TITLE
:
22930 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22932 case MODE_LINE_STRING
:
22933 n
+= store_mode_line_string ("", Qnil
, false, field_width
- n
, 0,
22936 case MODE_LINE_DISPLAY
:
22937 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22946 /* Store a mode-line string element in mode_line_string_list.
22948 If STRING is non-null, display that C string. Otherwise, the Lisp
22949 string LISP_STRING is displayed.
22951 FIELD_WIDTH is the minimum number of output glyphs to produce.
22952 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22953 with spaces. FIELD_WIDTH <= 0 means don't pad.
22955 PRECISION is the maximum number of characters to output from
22956 STRING. PRECISION <= 0 means don't truncate the string.
22958 If COPY_STRING, make a copy of LISP_STRING before adding
22959 properties to the string.
22961 PROPS are the properties to add to the string.
22962 The mode_line_string_face face property is always added to the string.
22966 store_mode_line_string (const char *string
, Lisp_Object lisp_string
,
22968 int field_width
, int precision
, Lisp_Object props
)
22973 if (string
!= NULL
)
22975 len
= strlen (string
);
22976 if (precision
> 0 && len
> precision
)
22978 lisp_string
= make_string (string
, len
);
22980 props
= mode_line_string_face_prop
;
22981 else if (!NILP (mode_line_string_face
))
22983 Lisp_Object face
= Fplist_get (props
, Qface
);
22984 props
= Fcopy_sequence (props
);
22986 face
= mode_line_string_face
;
22988 face
= list2 (face
, mode_line_string_face
);
22989 props
= Fplist_put (props
, Qface
, face
);
22991 Fadd_text_properties (make_number (0), make_number (len
),
22992 props
, lisp_string
);
22996 len
= XFASTINT (Flength (lisp_string
));
22997 if (precision
> 0 && len
> precision
)
23000 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
23003 if (!NILP (mode_line_string_face
))
23007 props
= Ftext_properties_at (make_number (0), lisp_string
);
23008 face
= Fplist_get (props
, Qface
);
23010 face
= mode_line_string_face
;
23012 face
= list2 (face
, mode_line_string_face
);
23013 props
= list2 (Qface
, face
);
23015 lisp_string
= Fcopy_sequence (lisp_string
);
23018 Fadd_text_properties (make_number (0), make_number (len
),
23019 props
, lisp_string
);
23024 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
23028 if (field_width
> len
)
23030 field_width
-= len
;
23031 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
23033 Fadd_text_properties (make_number (0), make_number (field_width
),
23034 props
, lisp_string
);
23035 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
23043 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
23045 doc
: /* Format a string out of a mode line format specification.
23046 First arg FORMAT specifies the mode line format (see `mode-line-format'
23047 for details) to use.
23049 By default, the format is evaluated for the currently selected window.
23051 Optional second arg FACE specifies the face property to put on all
23052 characters for which no face is specified. The value nil means the
23053 default face. The value t means whatever face the window's mode line
23054 currently uses (either `mode-line' or `mode-line-inactive',
23055 depending on whether the window is the selected window or not).
23056 An integer value means the value string has no text
23059 Optional third and fourth args WINDOW and BUFFER specify the window
23060 and buffer to use as the context for the formatting (defaults
23061 are the selected window and the WINDOW's buffer). */)
23062 (Lisp_Object format
, Lisp_Object face
,
23063 Lisp_Object window
, Lisp_Object buffer
)
23068 struct buffer
*old_buffer
= NULL
;
23070 bool no_props
= INTEGERP (face
);
23071 ptrdiff_t count
= SPECPDL_INDEX ();
23073 int string_start
= 0;
23075 w
= decode_any_window (window
);
23076 XSETWINDOW (window
, w
);
23079 buffer
= w
->contents
;
23080 CHECK_BUFFER (buffer
);
23082 /* Make formatting the modeline a non-op when noninteractive, otherwise
23083 there will be problems later caused by a partially initialized frame. */
23084 if (NILP (format
) || noninteractive
)
23085 return empty_unibyte_string
;
23090 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
23091 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
23092 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
23093 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
23094 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
23095 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
23096 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
23099 old_buffer
= current_buffer
;
23101 /* Save things including mode_line_proptrans_alist,
23102 and set that to nil so that we don't alter the outer value. */
23103 record_unwind_protect (unwind_format_mode_line
,
23104 format_mode_line_unwind_data
23105 (XFRAME (WINDOW_FRAME (w
)),
23106 old_buffer
, selected_window
, true));
23107 mode_line_proptrans_alist
= Qnil
;
23109 Fselect_window (window
, Qt
);
23110 set_buffer_internal_1 (XBUFFER (buffer
));
23112 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
23116 mode_line_target
= MODE_LINE_NOPROP
;
23117 mode_line_string_face_prop
= Qnil
;
23118 mode_line_string_list
= Qnil
;
23119 string_start
= MODE_LINE_NOPROP_LEN (0);
23123 mode_line_target
= MODE_LINE_STRING
;
23124 mode_line_string_list
= Qnil
;
23125 mode_line_string_face
= face
;
23126 mode_line_string_face_prop
23127 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
23130 push_kboard (FRAME_KBOARD (it
.f
));
23131 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
23136 len
= MODE_LINE_NOPROP_LEN (string_start
);
23137 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
23141 mode_line_string_list
= Fnreverse (mode_line_string_list
);
23142 str
= Fmapconcat (Qidentity
, mode_line_string_list
,
23143 empty_unibyte_string
);
23146 unbind_to (count
, Qnil
);
23150 /* Write a null-terminated, right justified decimal representation of
23151 the positive integer D to BUF using a minimal field width WIDTH. */
23154 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
23156 register char *p
= buf
;
23164 *p
++ = d
% 10 + '0';
23169 for (width
-= (int) (p
- buf
); width
> 0; --width
)
23180 /* Write a null-terminated, right justified decimal and "human
23181 readable" representation of the nonnegative integer D to BUF using
23182 a minimal field width WIDTH. D should be smaller than 999.5e24. */
23184 static const char power_letter
[] =
23198 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
23200 /* We aim to represent the nonnegative integer D as
23201 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
23202 ptrdiff_t quotient
= d
;
23204 /* -1 means: do not use TENTHS. */
23208 /* Length of QUOTIENT.TENTHS as a string. */
23214 if (quotient
>= 1000)
23216 /* Scale to the appropriate EXPONENT. */
23219 remainder
= quotient
% 1000;
23223 while (quotient
>= 1000);
23225 /* Round to nearest and decide whether to use TENTHS or not. */
23228 tenths
= remainder
/ 100;
23229 if (remainder
% 100 >= 50)
23236 if (quotient
== 10)
23244 if (remainder
>= 500)
23246 if (quotient
< 999)
23257 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
23258 if (tenths
== -1 && quotient
<= 99)
23265 p
= psuffix
= buf
+ max (width
, length
);
23267 /* Print EXPONENT. */
23268 *psuffix
++ = power_letter
[exponent
];
23271 /* Print TENTHS. */
23274 *--p
= '0' + tenths
;
23278 /* Print QUOTIENT. */
23281 int digit
= quotient
% 10;
23282 *--p
= '0' + digit
;
23284 while ((quotient
/= 10) != 0);
23286 /* Print leading spaces. */
23291 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
23292 If EOL_FLAG, set also a mnemonic character for end-of-line
23293 type of CODING_SYSTEM. Return updated pointer into BUF. */
23295 static unsigned char invalid_eol_type
[] = "(*invalid*)";
23298 decode_mode_spec_coding (Lisp_Object coding_system
, char *buf
, bool eol_flag
)
23301 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
23302 const unsigned char *eol_str
;
23304 /* The EOL conversion we are using. */
23305 Lisp_Object eoltype
;
23307 val
= CODING_SYSTEM_SPEC (coding_system
);
23310 if (!VECTORP (val
)) /* Not yet decided. */
23312 *buf
++ = multibyte
? '-' : ' ';
23314 eoltype
= eol_mnemonic_undecided
;
23315 /* Don't mention EOL conversion if it isn't decided. */
23320 Lisp_Object eolvalue
;
23322 attrs
= AREF (val
, 0);
23323 eolvalue
= AREF (val
, 2);
23326 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
23331 /* The EOL conversion that is normal on this system. */
23333 if (NILP (eolvalue
)) /* Not yet decided. */
23334 eoltype
= eol_mnemonic_undecided
;
23335 else if (VECTORP (eolvalue
)) /* Not yet decided. */
23336 eoltype
= eol_mnemonic_undecided
;
23337 else /* eolvalue is Qunix, Qdos, or Qmac. */
23338 eoltype
= (EQ (eolvalue
, Qunix
)
23339 ? eol_mnemonic_unix
23340 : EQ (eolvalue
, Qdos
)
23341 ? eol_mnemonic_dos
: eol_mnemonic_mac
);
23347 /* Mention the EOL conversion if it is not the usual one. */
23348 if (STRINGP (eoltype
))
23350 eol_str
= SDATA (eoltype
);
23351 eol_str_len
= SBYTES (eoltype
);
23353 else if (CHARACTERP (eoltype
))
23355 int c
= XFASTINT (eoltype
);
23356 return buf
+ CHAR_STRING (c
, (unsigned char *) buf
);
23360 eol_str
= invalid_eol_type
;
23361 eol_str_len
= sizeof (invalid_eol_type
) - 1;
23363 memcpy (buf
, eol_str
, eol_str_len
);
23364 buf
+= eol_str_len
;
23370 /* Return a string for the output of a mode line %-spec for window W,
23371 generated by character C. FIELD_WIDTH > 0 means pad the string
23372 returned with spaces to that value. Return a Lisp string in
23373 *STRING if the resulting string is taken from that Lisp string.
23375 Note we operate on the current buffer for most purposes. */
23377 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
23379 static const char *
23380 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
23381 Lisp_Object
*string
)
23384 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23385 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
23386 /* We are going to use f->decode_mode_spec_buffer as the buffer to
23387 produce strings from numerical values, so limit preposterously
23388 large values of FIELD_WIDTH to avoid overrunning the buffer's
23389 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
23390 bytes plus the terminating null. */
23391 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
23392 struct buffer
*b
= current_buffer
;
23400 if (!NILP (BVAR (b
, read_only
)))
23402 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23407 /* This differs from %* only for a modified read-only buffer. */
23408 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23410 if (!NILP (BVAR (b
, read_only
)))
23415 /* This differs from %* in ignoring read-only-ness. */
23416 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23428 if (command_loop_level
> 5)
23430 p
= decode_mode_spec_buf
;
23431 for (i
= 0; i
< command_loop_level
; i
++)
23434 return decode_mode_spec_buf
;
23442 if (command_loop_level
> 5)
23444 p
= decode_mode_spec_buf
;
23445 for (i
= 0; i
< command_loop_level
; i
++)
23448 return decode_mode_spec_buf
;
23455 /* Let lots_of_dashes be a string of infinite length. */
23456 if (mode_line_target
== MODE_LINE_NOPROP
23457 || mode_line_target
== MODE_LINE_STRING
)
23459 if (field_width
<= 0
23460 || field_width
> sizeof (lots_of_dashes
))
23462 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
23463 decode_mode_spec_buf
[i
] = '-';
23464 decode_mode_spec_buf
[i
] = '\0';
23465 return decode_mode_spec_buf
;
23468 return lots_of_dashes
;
23472 obj
= BVAR (b
, name
);
23476 /* %c and %l are ignored in `frame-title-format'.
23477 (In redisplay_internal, the frame title is drawn _before_ the
23478 windows are updated, so the stuff which depends on actual
23479 window contents (such as %l) may fail to render properly, or
23480 even crash emacs.) */
23481 if (mode_line_target
== MODE_LINE_TITLE
)
23485 ptrdiff_t col
= current_column ();
23486 w
->column_number_displayed
= col
;
23487 pint2str (decode_mode_spec_buf
, width
, col
);
23488 return decode_mode_spec_buf
;
23492 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
23494 if (NILP (Vmemory_full
))
23497 return "!MEM FULL! ";
23504 /* %F displays the frame name. */
23505 if (!NILP (f
->title
))
23506 return SSDATA (f
->title
);
23507 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
23508 return SSDATA (f
->name
);
23512 obj
= BVAR (b
, filename
);
23517 ptrdiff_t size
= ZV
- BEGV
;
23518 pint2str (decode_mode_spec_buf
, width
, size
);
23519 return decode_mode_spec_buf
;
23524 ptrdiff_t size
= ZV
- BEGV
;
23525 pint2hrstr (decode_mode_spec_buf
, width
, size
);
23526 return decode_mode_spec_buf
;
23531 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
23532 ptrdiff_t topline
, nlines
, height
;
23535 /* %c and %l are ignored in `frame-title-format'. */
23536 if (mode_line_target
== MODE_LINE_TITLE
)
23539 startpos
= marker_position (w
->start
);
23540 startpos_byte
= marker_byte_position (w
->start
);
23541 height
= WINDOW_TOTAL_LINES (w
);
23543 /* If we decided that this buffer isn't suitable for line numbers,
23544 don't forget that too fast. */
23545 if (w
->base_line_pos
== -1)
23548 /* If the buffer is very big, don't waste time. */
23549 if (INTEGERP (Vline_number_display_limit
)
23550 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
23552 w
->base_line_pos
= 0;
23553 w
->base_line_number
= 0;
23557 if (w
->base_line_number
> 0
23558 && w
->base_line_pos
> 0
23559 && w
->base_line_pos
<= startpos
)
23561 line
= w
->base_line_number
;
23562 linepos
= w
->base_line_pos
;
23563 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
23568 linepos
= BUF_BEGV (b
);
23569 linepos_byte
= BUF_BEGV_BYTE (b
);
23572 /* Count lines from base line to window start position. */
23573 nlines
= display_count_lines (linepos_byte
,
23577 topline
= nlines
+ line
;
23579 /* Determine a new base line, if the old one is too close
23580 or too far away, or if we did not have one.
23581 "Too close" means it's plausible a scroll-down would
23582 go back past it. */
23583 if (startpos
== BUF_BEGV (b
))
23585 w
->base_line_number
= topline
;
23586 w
->base_line_pos
= BUF_BEGV (b
);
23588 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
23589 || linepos
== BUF_BEGV (b
))
23591 ptrdiff_t limit
= BUF_BEGV (b
);
23592 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
23593 ptrdiff_t position
;
23594 ptrdiff_t distance
=
23595 (height
* 2 + 30) * line_number_display_limit_width
;
23597 if (startpos
- distance
> limit
)
23599 limit
= startpos
- distance
;
23600 limit_byte
= CHAR_TO_BYTE (limit
);
23603 nlines
= display_count_lines (startpos_byte
,
23605 - (height
* 2 + 30),
23607 /* If we couldn't find the lines we wanted within
23608 line_number_display_limit_width chars per line,
23609 give up on line numbers for this window. */
23610 if (position
== limit_byte
&& limit
== startpos
- distance
)
23612 w
->base_line_pos
= -1;
23613 w
->base_line_number
= 0;
23617 w
->base_line_number
= topline
- nlines
;
23618 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23621 /* Now count lines from the start pos to point. */
23622 nlines
= display_count_lines (startpos_byte
,
23623 PT_BYTE
, PT
, &junk
);
23625 /* Record that we did display the line number. */
23626 line_number_displayed
= true;
23628 /* Make the string to show. */
23629 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23630 return decode_mode_spec_buf
;
23633 char *p
= decode_mode_spec_buf
;
23634 int pad
= width
- 2;
23640 return decode_mode_spec_buf
;
23646 obj
= BVAR (b
, mode_name
);
23650 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23656 ptrdiff_t pos
= marker_position (w
->start
);
23657 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23659 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23661 if (pos
<= BUF_BEGV (b
))
23666 else if (pos
<= BUF_BEGV (b
))
23670 if (total
> 1000000)
23671 /* Do it differently for a large value, to avoid overflow. */
23672 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23674 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23675 /* We can't normally display a 3-digit number,
23676 so get us a 2-digit number that is close. */
23679 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23680 return decode_mode_spec_buf
;
23684 /* Display percentage of size above the bottom of the screen. */
23687 ptrdiff_t toppos
= marker_position (w
->start
);
23688 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23689 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23691 if (botpos
>= BUF_ZV (b
))
23693 if (toppos
<= BUF_BEGV (b
))
23700 if (total
> 1000000)
23701 /* Do it differently for a large value, to avoid overflow. */
23702 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23704 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23705 /* We can't normally display a 3-digit number,
23706 so get us a 2-digit number that is close. */
23709 if (toppos
<= BUF_BEGV (b
))
23710 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23712 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23713 return decode_mode_spec_buf
;
23718 /* status of process */
23719 obj
= Fget_buffer_process (Fcurrent_buffer ());
23721 return "no process";
23723 obj
= Fsymbol_name (Fprocess_status (obj
));
23729 ptrdiff_t count
= inhibit_garbage_collection ();
23730 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23731 Lisp_Object val
= Qnil
;
23733 if (STRINGP (curdir
))
23734 val
= call1 (intern ("file-remote-p"), curdir
);
23736 unbind_to (count
, Qnil
);
23745 /* coding-system (not including end-of-line format) */
23747 /* coding-system (including end-of-line type) */
23749 bool eol_flag
= (c
== 'Z');
23750 char *p
= decode_mode_spec_buf
;
23752 if (! FRAME_WINDOW_P (f
))
23754 /* No need to mention EOL here--the terminal never needs
23755 to do EOL conversion. */
23756 p
= decode_mode_spec_coding (CODING_ID_NAME
23757 (FRAME_KEYBOARD_CODING (f
)->id
),
23759 p
= decode_mode_spec_coding (CODING_ID_NAME
23760 (FRAME_TERMINAL_CODING (f
)->id
),
23763 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23766 #if false /* This proves to be annoying; I think we can do without. -- rms. */
23767 #ifdef subprocesses
23768 obj
= Fget_buffer_process (Fcurrent_buffer ());
23769 if (PROCESSP (obj
))
23771 p
= decode_mode_spec_coding
23772 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23773 p
= decode_mode_spec_coding
23774 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23776 #endif /* subprocesses */
23779 return decode_mode_spec_buf
;
23786 return SSDATA (obj
);
23793 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23794 means count lines back from START_BYTE. But don't go beyond
23795 LIMIT_BYTE. Return the number of lines thus found (always
23798 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23799 either the position COUNT lines after/before START_BYTE, if we
23800 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23804 display_count_lines (ptrdiff_t start_byte
,
23805 ptrdiff_t limit_byte
, ptrdiff_t count
,
23806 ptrdiff_t *byte_pos_ptr
)
23808 register unsigned char *cursor
;
23809 unsigned char *base
;
23811 register ptrdiff_t ceiling
;
23812 register unsigned char *ceiling_addr
;
23813 ptrdiff_t orig_count
= count
;
23815 /* If we are not in selective display mode,
23816 check only for newlines. */
23817 bool selective_display
23818 = (!NILP (BVAR (current_buffer
, selective_display
))
23819 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23823 while (start_byte
< limit_byte
)
23825 ceiling
= BUFFER_CEILING_OF (start_byte
);
23826 ceiling
= min (limit_byte
- 1, ceiling
);
23827 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23828 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23832 if (selective_display
)
23834 while (*cursor
!= '\n' && *cursor
!= 015
23835 && ++cursor
!= ceiling_addr
)
23837 if (cursor
== ceiling_addr
)
23842 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23851 start_byte
+= cursor
- base
;
23852 *byte_pos_ptr
= start_byte
;
23856 while (cursor
< ceiling_addr
);
23858 start_byte
+= ceiling_addr
- base
;
23863 while (start_byte
> limit_byte
)
23865 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23866 ceiling
= max (limit_byte
, ceiling
);
23867 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23868 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23871 if (selective_display
)
23873 while (--cursor
>= ceiling_addr
23874 && *cursor
!= '\n' && *cursor
!= 015)
23876 if (cursor
< ceiling_addr
)
23881 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23888 start_byte
+= cursor
- base
+ 1;
23889 *byte_pos_ptr
= start_byte
;
23890 /* When scanning backwards, we should
23891 not count the newline posterior to which we stop. */
23892 return - orig_count
- 1;
23895 start_byte
+= ceiling_addr
- base
;
23899 *byte_pos_ptr
= limit_byte
;
23902 return - orig_count
+ count
;
23903 return orig_count
- count
;
23909 /***********************************************************************
23911 ***********************************************************************/
23913 /* Display a NUL-terminated string, starting with index START.
23915 If STRING is non-null, display that C string. Otherwise, the Lisp
23916 string LISP_STRING is displayed. There's a case that STRING is
23917 non-null and LISP_STRING is not nil. It means STRING is a string
23918 data of LISP_STRING. In that case, we display LISP_STRING while
23919 ignoring its text properties.
23921 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23922 FACE_STRING. Display STRING or LISP_STRING with the face at
23923 FACE_STRING_POS in FACE_STRING:
23925 Display the string in the environment given by IT, but use the
23926 standard display table, temporarily.
23928 FIELD_WIDTH is the minimum number of output glyphs to produce.
23929 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23930 with spaces. If STRING has more characters, more than FIELD_WIDTH
23931 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23933 PRECISION is the maximum number of characters to output from
23934 STRING. PRECISION < 0 means don't truncate the string.
23936 This is roughly equivalent to printf format specifiers:
23938 FIELD_WIDTH PRECISION PRINTF
23939 ----------------------------------------
23945 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23946 display them, and < 0 means obey the current buffer's value of
23947 enable_multibyte_characters.
23949 Value is the number of columns displayed. */
23952 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23953 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23954 int field_width
, int precision
, int max_x
, int multibyte
)
23956 int hpos_at_start
= it
->hpos
;
23957 int saved_face_id
= it
->face_id
;
23958 struct glyph_row
*row
= it
->glyph_row
;
23959 ptrdiff_t it_charpos
;
23961 /* Initialize the iterator IT for iteration over STRING beginning
23962 with index START. */
23963 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23964 precision
, field_width
, multibyte
);
23965 if (string
&& STRINGP (lisp_string
))
23966 /* LISP_STRING is the one returned by decode_mode_spec. We should
23967 ignore its text properties. */
23968 it
->stop_charpos
= it
->end_charpos
;
23970 /* If displaying STRING, set up the face of the iterator from
23971 FACE_STRING, if that's given. */
23972 if (STRINGP (face_string
))
23978 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23979 0, &endptr
, it
->base_face_id
, false);
23980 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23981 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23984 /* Set max_x to the maximum allowed X position. Don't let it go
23985 beyond the right edge of the window. */
23987 max_x
= it
->last_visible_x
;
23989 max_x
= min (max_x
, it
->last_visible_x
);
23991 /* Skip over display elements that are not visible. because IT->w is
23993 if (it
->current_x
< it
->first_visible_x
)
23994 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23995 MOVE_TO_POS
| MOVE_TO_X
);
23997 row
->ascent
= it
->max_ascent
;
23998 row
->height
= it
->max_ascent
+ it
->max_descent
;
23999 row
->phys_ascent
= it
->max_phys_ascent
;
24000 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
24001 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
24003 if (STRINGP (it
->string
))
24004 it_charpos
= IT_STRING_CHARPOS (*it
);
24006 it_charpos
= IT_CHARPOS (*it
);
24008 /* This condition is for the case that we are called with current_x
24009 past last_visible_x. */
24010 while (it
->current_x
< max_x
)
24012 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
24014 /* Get the next display element. */
24015 if (!get_next_display_element (it
))
24018 /* Produce glyphs. */
24019 x_before
= it
->current_x
;
24020 n_glyphs_before
= row
->used
[TEXT_AREA
];
24021 PRODUCE_GLYPHS (it
);
24023 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
24026 while (i
< nglyphs
)
24028 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
24030 if (it
->line_wrap
!= TRUNCATE
24031 && x
+ glyph
->pixel_width
> max_x
)
24033 /* End of continued line or max_x reached. */
24034 if (CHAR_GLYPH_PADDING_P (*glyph
))
24036 /* A wide character is unbreakable. */
24037 if (row
->reversed_p
)
24038 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
24039 - n_glyphs_before
);
24040 row
->used
[TEXT_AREA
] = n_glyphs_before
;
24041 it
->current_x
= x_before
;
24045 if (row
->reversed_p
)
24046 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
24047 - (n_glyphs_before
+ i
));
24048 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
24053 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
24055 /* Glyph is at least partially visible. */
24057 if (x
< it
->first_visible_x
)
24058 row
->x
= x
- it
->first_visible_x
;
24062 /* Glyph is off the left margin of the display area.
24063 Should not happen. */
24067 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
24068 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
24069 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
24070 row
->phys_height
= max (row
->phys_height
,
24071 it
->max_phys_ascent
+ it
->max_phys_descent
);
24072 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
24073 it
->max_extra_line_spacing
);
24074 x
+= glyph
->pixel_width
;
24078 /* Stop if max_x reached. */
24082 /* Stop at line ends. */
24083 if (ITERATOR_AT_END_OF_LINE_P (it
))
24085 it
->continuation_lines_width
= 0;
24089 set_iterator_to_next (it
, true);
24090 if (STRINGP (it
->string
))
24091 it_charpos
= IT_STRING_CHARPOS (*it
);
24093 it_charpos
= IT_CHARPOS (*it
);
24095 /* Stop if truncating at the right edge. */
24096 if (it
->line_wrap
== TRUNCATE
24097 && it
->current_x
>= it
->last_visible_x
)
24099 /* Add truncation mark, but don't do it if the line is
24100 truncated at a padding space. */
24101 if (it_charpos
< it
->string_nchars
)
24103 if (!FRAME_WINDOW_P (it
->f
))
24107 if (it
->current_x
> it
->last_visible_x
)
24109 if (!row
->reversed_p
)
24111 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
24112 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
24117 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
24118 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
24120 unproduce_glyphs (it
, ii
+ 1);
24121 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
24123 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
24125 row
->used
[TEXT_AREA
] = ii
;
24126 produce_special_glyphs (it
, IT_TRUNCATION
);
24129 produce_special_glyphs (it
, IT_TRUNCATION
);
24131 row
->truncated_on_right_p
= true;
24137 /* Maybe insert a truncation at the left. */
24138 if (it
->first_visible_x
24141 if (!FRAME_WINDOW_P (it
->f
)
24142 || (row
->reversed_p
24143 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24144 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
24145 insert_left_trunc_glyphs (it
);
24146 row
->truncated_on_left_p
= true;
24149 it
->face_id
= saved_face_id
;
24151 /* Value is number of columns displayed. */
24152 return it
->hpos
- hpos_at_start
;
24157 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
24158 appears as an element of LIST or as the car of an element of LIST.
24159 If PROPVAL is a list, compare each element against LIST in that
24160 way, and return 1/2 if any element of PROPVAL is found in LIST.
24161 Otherwise return 0. This function cannot quit.
24162 The return value is 2 if the text is invisible but with an ellipsis
24163 and 1 if it's invisible and without an ellipsis. */
24166 invisible_prop (Lisp_Object propval
, Lisp_Object list
)
24168 Lisp_Object tail
, proptail
;
24170 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
24172 register Lisp_Object tem
;
24174 if (EQ (propval
, tem
))
24176 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
24177 return NILP (XCDR (tem
)) ? 1 : 2;
24180 if (CONSP (propval
))
24182 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
24184 Lisp_Object propelt
;
24185 propelt
= XCAR (proptail
);
24186 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
24188 register Lisp_Object tem
;
24190 if (EQ (propelt
, tem
))
24192 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
24193 return NILP (XCDR (tem
)) ? 1 : 2;
24201 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
24202 doc
: /* Non-nil if the property makes the text invisible.
24203 POS-OR-PROP can be a marker or number, in which case it is taken to be
24204 a position in the current buffer and the value of the `invisible' property
24205 is checked; or it can be some other value, which is then presumed to be the
24206 value of the `invisible' property of the text of interest.
24207 The non-nil value returned can be t for truly invisible text or something
24208 else if the text is replaced by an ellipsis. */)
24209 (Lisp_Object pos_or_prop
)
24212 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
24213 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
24215 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
24216 return (invis
== 0 ? Qnil
24218 : make_number (invis
));
24221 /* Calculate a width or height in pixels from a specification using
24222 the following elements:
24225 NUM - a (fractional) multiple of the default font width/height
24226 (NUM) - specifies exactly NUM pixels
24227 UNIT - a fixed number of pixels, see below.
24228 ELEMENT - size of a display element in pixels, see below.
24229 (NUM . SPEC) - equals NUM * SPEC
24230 (+ SPEC SPEC ...) - add pixel values
24231 (- SPEC SPEC ...) - subtract pixel values
24232 (- SPEC) - negate pixel value
24235 INT or FLOAT - a number constant
24236 SYMBOL - use symbol's (buffer local) variable binding.
24239 in - pixels per inch *)
24240 mm - pixels per 1/1000 meter *)
24241 cm - pixels per 1/100 meter *)
24242 width - width of current font in pixels.
24243 height - height of current font in pixels.
24245 *) using the ratio(s) defined in display-pixels-per-inch.
24249 left-fringe - left fringe width in pixels
24250 right-fringe - right fringe width in pixels
24252 left-margin - left margin width in pixels
24253 right-margin - right margin width in pixels
24255 scroll-bar - scroll-bar area width in pixels
24259 Pixels corresponding to 5 inches:
24262 Total width of non-text areas on left side of window (if scroll-bar is on left):
24263 '(space :width (+ left-fringe left-margin scroll-bar))
24265 Align to first text column (in header line):
24266 '(space :align-to 0)
24268 Align to middle of text area minus half the width of variable `my-image'
24269 containing a loaded image:
24270 '(space :align-to (0.5 . (- text my-image)))
24272 Width of left margin minus width of 1 character in the default font:
24273 '(space :width (- left-margin 1))
24275 Width of left margin minus width of 2 characters in the current font:
24276 '(space :width (- left-margin (2 . width)))
24278 Center 1 character over left-margin (in header line):
24279 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
24281 Different ways to express width of left fringe plus left margin minus one pixel:
24282 '(space :width (- (+ left-fringe left-margin) (1)))
24283 '(space :width (+ left-fringe left-margin (- (1))))
24284 '(space :width (+ left-fringe left-margin (-1)))
24289 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
24290 struct font
*font
, bool width_p
, int *align_to
)
24294 # define OK_PIXELS(val) (*res = (val), true)
24295 # define OK_ALIGN_TO(val) (*align_to = (val), true)
24298 return OK_PIXELS (0);
24300 eassert (FRAME_LIVE_P (it
->f
));
24302 if (SYMBOLP (prop
))
24304 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
24306 char *unit
= SSDATA (SYMBOL_NAME (prop
));
24308 if (unit
[0] == 'i' && unit
[1] == 'n')
24310 else if (unit
[0] == 'm' && unit
[1] == 'm')
24312 else if (unit
[0] == 'c' && unit
[1] == 'm')
24318 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
24319 : FRAME_RES_Y (it
->f
));
24322 return OK_PIXELS (ppi
/ pixels
);
24327 #ifdef HAVE_WINDOW_SYSTEM
24328 if (EQ (prop
, Qheight
))
24329 return OK_PIXELS (font
24330 ? normal_char_height (font
, -1)
24331 : FRAME_LINE_HEIGHT (it
->f
));
24332 if (EQ (prop
, Qwidth
))
24333 return OK_PIXELS (font
24334 ? FONT_WIDTH (font
)
24335 : FRAME_COLUMN_WIDTH (it
->f
));
24337 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
24338 return OK_PIXELS (1);
24341 if (EQ (prop
, Qtext
))
24342 return OK_PIXELS (width_p
24343 ? window_box_width (it
->w
, TEXT_AREA
)
24344 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
24346 if (align_to
&& *align_to
< 0)
24349 if (EQ (prop
, Qleft
))
24350 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
24351 if (EQ (prop
, Qright
))
24352 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
24353 if (EQ (prop
, Qcenter
))
24354 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
24355 + window_box_width (it
->w
, TEXT_AREA
) / 2);
24356 if (EQ (prop
, Qleft_fringe
))
24357 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24358 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
24359 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
24360 if (EQ (prop
, Qright_fringe
))
24361 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24362 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24363 : window_box_right_offset (it
->w
, TEXT_AREA
));
24364 if (EQ (prop
, Qleft_margin
))
24365 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
24366 if (EQ (prop
, Qright_margin
))
24367 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
24368 if (EQ (prop
, Qscroll_bar
))
24369 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
24371 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24372 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24373 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24378 if (EQ (prop
, Qleft_fringe
))
24379 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
24380 if (EQ (prop
, Qright_fringe
))
24381 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
24382 if (EQ (prop
, Qleft_margin
))
24383 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
24384 if (EQ (prop
, Qright_margin
))
24385 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
24386 if (EQ (prop
, Qscroll_bar
))
24387 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
24390 prop
= buffer_local_value (prop
, it
->w
->contents
);
24391 if (EQ (prop
, Qunbound
))
24395 if (NUMBERP (prop
))
24397 int base_unit
= (width_p
24398 ? FRAME_COLUMN_WIDTH (it
->f
)
24399 : FRAME_LINE_HEIGHT (it
->f
));
24400 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
24405 Lisp_Object car
= XCAR (prop
);
24406 Lisp_Object cdr
= XCDR (prop
);
24410 #ifdef HAVE_WINDOW_SYSTEM
24411 if (FRAME_WINDOW_P (it
->f
)
24412 && valid_image_p (prop
))
24414 ptrdiff_t id
= lookup_image (it
->f
, prop
);
24415 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
24417 return OK_PIXELS (width_p
? img
->width
: img
->height
);
24419 if (FRAME_WINDOW_P (it
->f
) && valid_xwidget_spec_p (prop
))
24421 // TODO: Don't return dummy size.
24422 return OK_PIXELS (100);
24425 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
24431 while (CONSP (cdr
))
24433 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
24434 font
, width_p
, align_to
))
24437 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= false;
24442 if (EQ (car
, Qminus
))
24444 return OK_PIXELS (pixels
);
24447 car
= buffer_local_value (car
, it
->w
->contents
);
24448 if (EQ (car
, Qunbound
))
24455 pixels
= XFLOATINT (car
);
24457 return OK_PIXELS (pixels
);
24458 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
24459 font
, width_p
, align_to
))
24460 return OK_PIXELS (pixels
* fact
);
24471 get_font_ascent_descent (struct font
*font
, int *ascent
, int *descent
)
24473 #ifdef HAVE_WINDOW_SYSTEM
24474 normal_char_ascent_descent (font
, -1, ascent
, descent
);
24482 /***********************************************************************
24484 ***********************************************************************/
24486 #ifdef HAVE_WINDOW_SYSTEM
24491 dump_glyph_string (struct glyph_string
*s
)
24493 fprintf (stderr
, "glyph string\n");
24494 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
24495 s
->x
, s
->y
, s
->width
, s
->height
);
24496 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
24497 fprintf (stderr
, " hl = %d\n", s
->hl
);
24498 fprintf (stderr
, " left overhang = %d, right = %d\n",
24499 s
->left_overhang
, s
->right_overhang
);
24500 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
24501 fprintf (stderr
, " extends to end of line = %d\n",
24502 s
->extends_to_end_of_line_p
);
24503 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
24504 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
24507 #endif /* GLYPH_DEBUG */
24509 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
24510 of XChar2b structures for S; it can't be allocated in
24511 init_glyph_string because it must be allocated via `alloca'. W
24512 is the window on which S is drawn. ROW and AREA are the glyph row
24513 and area within the row from which S is constructed. START is the
24514 index of the first glyph structure covered by S. HL is a
24515 face-override for drawing S. */
24518 #define OPTIONAL_HDC(hdc) HDC hdc,
24519 #define DECLARE_HDC(hdc) HDC hdc;
24520 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
24521 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
24524 #ifndef OPTIONAL_HDC
24525 #define OPTIONAL_HDC(hdc)
24526 #define DECLARE_HDC(hdc)
24527 #define ALLOCATE_HDC(hdc, f)
24528 #define RELEASE_HDC(hdc, f)
24532 init_glyph_string (struct glyph_string
*s
,
24534 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
24535 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
24537 memset (s
, 0, sizeof *s
);
24539 s
->f
= XFRAME (w
->frame
);
24543 s
->display
= FRAME_X_DISPLAY (s
->f
);
24544 s
->window
= FRAME_X_WINDOW (s
->f
);
24545 s
->char2b
= char2b
;
24549 s
->first_glyph
= row
->glyphs
[area
] + start
;
24550 s
->height
= row
->height
;
24551 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
24552 s
->ybase
= s
->y
+ row
->ascent
;
24556 /* Append the list of glyph strings with head H and tail T to the list
24557 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
24560 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24561 struct glyph_string
*h
, struct glyph_string
*t
)
24575 /* Prepend the list of glyph strings with head H and tail T to the
24576 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
24580 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24581 struct glyph_string
*h
, struct glyph_string
*t
)
24595 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
24596 Set *HEAD and *TAIL to the resulting list. */
24599 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
24600 struct glyph_string
*s
)
24602 s
->next
= s
->prev
= NULL
;
24603 append_glyph_string_lists (head
, tail
, s
, s
);
24607 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24608 The encoding of C is returned in *CHAR2B. DISPLAY_P means
24609 make sure that X resources for the face returned are allocated.
24610 Value is a pointer to a realized face that is ready for display if
24613 static struct face
*
24614 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
24615 XChar2b
*char2b
, bool display_p
)
24617 struct face
*face
= FACE_FROM_ID (f
, face_id
);
24622 code
= face
->font
->driver
->encode_char (face
->font
, c
);
24624 if (code
== FONT_INVALID_CODE
)
24627 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24629 /* Make sure X resources of the face are allocated. */
24630 #ifdef HAVE_X_WINDOWS
24634 eassert (face
!= NULL
);
24635 prepare_face_for_display (f
, face
);
24642 /* Get face and two-byte form of character glyph GLYPH on frame F.
24643 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24644 a pointer to a realized face that is ready for display. */
24646 static struct face
*
24647 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24653 eassert (glyph
->type
== CHAR_GLYPH
);
24654 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24656 /* Make sure X resources of the face are allocated. */
24657 prepare_face_for_display (f
, face
);
24661 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24662 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24664 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24666 if (code
== FONT_INVALID_CODE
)
24670 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24675 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24676 Return true iff FONT has a glyph for C. */
24679 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24683 if (CHAR_BYTE8_P (c
))
24684 code
= CHAR_TO_BYTE8 (c
);
24686 code
= font
->driver
->encode_char (font
, c
);
24688 if (code
== FONT_INVALID_CODE
)
24690 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24695 /* Fill glyph string S with composition components specified by S->cmp.
24697 BASE_FACE is the base face of the composition.
24698 S->cmp_from is the index of the first component for S.
24700 OVERLAPS non-zero means S should draw the foreground only, and use
24701 its physical height for clipping. See also draw_glyphs.
24703 Value is the index of a component not in S. */
24706 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24710 /* For all glyphs of this composition, starting at the offset
24711 S->cmp_from, until we reach the end of the definition or encounter a
24712 glyph that requires the different face, add it to S. */
24717 s
->for_overlaps
= overlaps
;
24720 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24722 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24724 /* TAB in a composition means display glyphs with padding space
24725 on the left or right. */
24728 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24731 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24732 s
->char2b
+ i
, true);
24738 s
->font
= s
->face
->font
;
24740 else if (s
->face
!= face
)
24748 if (s
->face
== NULL
)
24750 s
->face
= base_face
->ascii_face
;
24751 s
->font
= s
->face
->font
;
24754 /* All glyph strings for the same composition has the same width,
24755 i.e. the width set for the first component of the composition. */
24756 s
->width
= s
->first_glyph
->pixel_width
;
24758 /* If the specified font could not be loaded, use the frame's
24759 default font, but record the fact that we couldn't load it in
24760 the glyph string so that we can draw rectangles for the
24761 characters of the glyph string. */
24762 if (s
->font
== NULL
)
24764 s
->font_not_found_p
= true;
24765 s
->font
= FRAME_FONT (s
->f
);
24768 /* Adjust base line for subscript/superscript text. */
24769 s
->ybase
+= s
->first_glyph
->voffset
;
24775 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24776 int start
, int end
, int overlaps
)
24778 struct glyph
*glyph
, *last
;
24779 Lisp_Object lgstring
;
24782 s
->for_overlaps
= overlaps
;
24783 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24784 last
= s
->row
->glyphs
[s
->area
] + end
;
24785 s
->cmp_id
= glyph
->u
.cmp
.id
;
24786 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24787 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24788 s
->face
= FACE_OPT_FROM_ID (s
->f
, face_id
);
24789 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24790 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24792 while (glyph
< last
24793 && glyph
->u
.cmp
.automatic
24794 && glyph
->u
.cmp
.id
== s
->cmp_id
24795 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24796 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24798 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24800 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24801 unsigned code
= LGLYPH_CODE (lglyph
);
24803 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24805 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24806 return glyph
- s
->row
->glyphs
[s
->area
];
24810 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24811 See the comment of fill_glyph_string for arguments.
24812 Value is the index of the first glyph not in S. */
24816 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24817 int start
, int end
, int overlaps
)
24819 struct glyph
*glyph
, *last
;
24822 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24823 s
->for_overlaps
= overlaps
;
24824 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24825 last
= s
->row
->glyphs
[s
->area
] + end
;
24826 voffset
= glyph
->voffset
;
24827 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24828 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24830 s
->width
= glyph
->pixel_width
;
24832 while (glyph
< last
24833 && glyph
->type
== GLYPHLESS_GLYPH
24834 && glyph
->voffset
== voffset
24835 && glyph
->face_id
== face_id
)
24838 s
->width
+= glyph
->pixel_width
;
24841 s
->ybase
+= voffset
;
24842 return glyph
- s
->row
->glyphs
[s
->area
];
24846 /* Fill glyph string S from a sequence of character glyphs.
24848 FACE_ID is the face id of the string. START is the index of the
24849 first glyph to consider, END is the index of the last + 1.
24850 OVERLAPS non-zero means S should draw the foreground only, and use
24851 its physical height for clipping. See also draw_glyphs.
24853 Value is the index of the first glyph not in S. */
24856 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24857 int start
, int end
, int overlaps
)
24859 struct glyph
*glyph
, *last
;
24861 bool glyph_not_available_p
;
24863 eassert (s
->f
== XFRAME (s
->w
->frame
));
24864 eassert (s
->nchars
== 0);
24865 eassert (start
>= 0 && end
> start
);
24867 s
->for_overlaps
= overlaps
;
24868 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24869 last
= s
->row
->glyphs
[s
->area
] + end
;
24870 voffset
= glyph
->voffset
;
24871 s
->padding_p
= glyph
->padding_p
;
24872 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24874 while (glyph
< last
24875 && glyph
->type
== CHAR_GLYPH
24876 && glyph
->voffset
== voffset
24877 /* Same face id implies same font, nowadays. */
24878 && glyph
->face_id
== face_id
24879 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24881 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24882 s
->char2b
+ s
->nchars
);
24884 eassert (s
->nchars
<= end
- start
);
24885 s
->width
+= glyph
->pixel_width
;
24886 if (glyph
++->padding_p
!= s
->padding_p
)
24890 s
->font
= s
->face
->font
;
24892 /* If the specified font could not be loaded, use the frame's font,
24893 but record the fact that we couldn't load it in
24894 S->font_not_found_p so that we can draw rectangles for the
24895 characters of the glyph string. */
24896 if (s
->font
== NULL
|| glyph_not_available_p
)
24898 s
->font_not_found_p
= true;
24899 s
->font
= FRAME_FONT (s
->f
);
24902 /* Adjust base line for subscript/superscript text. */
24903 s
->ybase
+= voffset
;
24905 eassert (s
->face
&& s
->face
->gc
);
24906 return glyph
- s
->row
->glyphs
[s
->area
];
24910 /* Fill glyph string S from image glyph S->first_glyph. */
24913 fill_image_glyph_string (struct glyph_string
*s
)
24915 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24916 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24918 s
->slice
= s
->first_glyph
->slice
.img
;
24919 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24920 s
->font
= s
->face
->font
;
24921 s
->width
= s
->first_glyph
->pixel_width
;
24923 /* Adjust base line for subscript/superscript text. */
24924 s
->ybase
+= s
->first_glyph
->voffset
;
24928 #ifdef HAVE_XWIDGETS
24930 fill_xwidget_glyph_string (struct glyph_string
*s
)
24932 eassert (s
->first_glyph
->type
== XWIDGET_GLYPH
);
24933 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24934 s
->font
= s
->face
->font
;
24935 s
->width
= s
->first_glyph
->pixel_width
;
24936 s
->ybase
+= s
->first_glyph
->voffset
;
24937 s
->xwidget
= s
->first_glyph
->u
.xwidget
;
24940 /* Fill glyph string S from a sequence of stretch glyphs.
24942 START is the index of the first glyph to consider,
24943 END is the index of the last + 1.
24945 Value is the index of the first glyph not in S. */
24948 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24950 struct glyph
*glyph
, *last
;
24951 int voffset
, face_id
;
24953 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24955 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24956 last
= s
->row
->glyphs
[s
->area
] + end
;
24957 face_id
= glyph
->face_id
;
24958 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24959 s
->font
= s
->face
->font
;
24960 s
->width
= glyph
->pixel_width
;
24962 voffset
= glyph
->voffset
;
24966 && glyph
->type
== STRETCH_GLYPH
24967 && glyph
->voffset
== voffset
24968 && glyph
->face_id
== face_id
);
24970 s
->width
+= glyph
->pixel_width
;
24972 /* Adjust base line for subscript/superscript text. */
24973 s
->ybase
+= voffset
;
24975 /* The case that face->gc == 0 is handled when drawing the glyph
24976 string by calling prepare_face_for_display. */
24978 return glyph
- s
->row
->glyphs
[s
->area
];
24981 static struct font_metrics
*
24982 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24984 static struct font_metrics metrics
;
24989 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24990 if (code
== FONT_INVALID_CODE
)
24992 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24996 /* A subroutine that computes "normal" values of ASCENT and DESCENT
24997 for FONT. Values are taken from font-global ones, except for fonts
24998 that claim preposterously large values, but whose glyphs actually
24999 have reasonable dimensions. C is the character to use for metrics
25000 if the font-global values are too large; if C is negative, the
25001 function selects a default character. */
25003 normal_char_ascent_descent (struct font
*font
, int c
, int *ascent
, int *descent
)
25005 *ascent
= FONT_BASE (font
);
25006 *descent
= FONT_DESCENT (font
);
25008 if (FONT_TOO_HIGH (font
))
25012 /* Get metrics of C, defaulting to a reasonably sized ASCII
25014 if (get_char_glyph_code (c
>= 0 ? c
: '{', font
, &char2b
))
25016 struct font_metrics
*pcm
= get_per_char_metric (font
, &char2b
);
25018 if (!(pcm
->width
== 0 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0))
25020 /* We add 1 pixel to character dimensions as heuristics
25021 that produces nicer display, e.g. when the face has
25022 the box attribute. */
25023 *ascent
= pcm
->ascent
+ 1;
25024 *descent
= pcm
->descent
+ 1;
25030 /* A subroutine that computes a reasonable "normal character height"
25031 for fonts that claim preposterously large vertical dimensions, but
25032 whose glyphs are actually reasonably sized. C is the character
25033 whose metrics to use for those fonts, or -1 for default
25036 normal_char_height (struct font
*font
, int c
)
25038 int ascent
, descent
;
25040 normal_char_ascent_descent (font
, c
, &ascent
, &descent
);
25042 return ascent
+ descent
;
25046 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
25047 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
25048 assumed to be zero. */
25051 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
25053 *left
= *right
= 0;
25055 if (glyph
->type
== CHAR_GLYPH
)
25058 struct face
*face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
);
25061 struct font_metrics
*pcm
= get_per_char_metric (face
->font
, &char2b
);
25064 if (pcm
->rbearing
> pcm
->width
)
25065 *right
= pcm
->rbearing
- pcm
->width
;
25066 if (pcm
->lbearing
< 0)
25067 *left
= -pcm
->lbearing
;
25071 else if (glyph
->type
== COMPOSITE_GLYPH
)
25073 if (! glyph
->u
.cmp
.automatic
)
25075 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
25077 if (cmp
->rbearing
> cmp
->pixel_width
)
25078 *right
= cmp
->rbearing
- cmp
->pixel_width
;
25079 if (cmp
->lbearing
< 0)
25080 *left
= - cmp
->lbearing
;
25084 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
25085 struct font_metrics metrics
;
25087 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
25088 glyph
->slice
.cmp
.to
+ 1, &metrics
);
25089 if (metrics
.rbearing
> metrics
.width
)
25090 *right
= metrics
.rbearing
- metrics
.width
;
25091 if (metrics
.lbearing
< 0)
25092 *left
= - metrics
.lbearing
;
25098 /* Return the index of the first glyph preceding glyph string S that
25099 is overwritten by S because of S's left overhang. Value is -1
25100 if no glyphs are overwritten. */
25103 left_overwritten (struct glyph_string
*s
)
25107 if (s
->left_overhang
)
25110 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25111 int first
= s
->first_glyph
- glyphs
;
25113 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
25114 x
-= glyphs
[i
].pixel_width
;
25125 /* Return the index of the first glyph preceding glyph string S that
25126 is overwriting S because of its right overhang. Value is -1 if no
25127 glyph in front of S overwrites S. */
25130 left_overwriting (struct glyph_string
*s
)
25133 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25134 int first
= s
->first_glyph
- glyphs
;
25138 for (i
= first
- 1; i
>= 0; --i
)
25141 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
25144 x
-= glyphs
[i
].pixel_width
;
25151 /* Return the index of the last glyph following glyph string S that is
25152 overwritten by S because of S's right overhang. Value is -1 if
25153 no such glyph is found. */
25156 right_overwritten (struct glyph_string
*s
)
25160 if (s
->right_overhang
)
25163 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25164 int first
= (s
->first_glyph
- glyphs
25165 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
25166 int end
= s
->row
->used
[s
->area
];
25168 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
25169 x
+= glyphs
[i
].pixel_width
;
25178 /* Return the index of the last glyph following glyph string S that
25179 overwrites S because of its left overhang. Value is negative
25180 if no such glyph is found. */
25183 right_overwriting (struct glyph_string
*s
)
25186 int end
= s
->row
->used
[s
->area
];
25187 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25188 int first
= (s
->first_glyph
- glyphs
25189 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
25193 for (i
= first
; i
< end
; ++i
)
25196 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
25199 x
+= glyphs
[i
].pixel_width
;
25206 /* Set background width of glyph string S. START is the index of the
25207 first glyph following S. LAST_X is the right-most x-position + 1
25208 in the drawing area. */
25211 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
25213 /* If the face of this glyph string has to be drawn to the end of
25214 the drawing area, set S->extends_to_end_of_line_p. */
25216 if (start
== s
->row
->used
[s
->area
]
25217 && ((s
->row
->fill_line_p
25218 && (s
->hl
== DRAW_NORMAL_TEXT
25219 || s
->hl
== DRAW_IMAGE_RAISED
25220 || s
->hl
== DRAW_IMAGE_SUNKEN
))
25221 || s
->hl
== DRAW_MOUSE_FACE
))
25222 s
->extends_to_end_of_line_p
= true;
25224 /* If S extends its face to the end of the line, set its
25225 background_width to the distance to the right edge of the drawing
25227 if (s
->extends_to_end_of_line_p
)
25228 s
->background_width
= last_x
- s
->x
+ 1;
25230 s
->background_width
= s
->width
;
25234 /* Compute overhangs and x-positions for glyph string S and its
25235 predecessors, or successors. X is the starting x-position for S.
25236 BACKWARD_P means process predecessors. */
25239 compute_overhangs_and_x (struct glyph_string
*s
, int x
, bool backward_p
)
25245 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
25246 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
25256 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
25257 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
25267 /* The following macros are only called from draw_glyphs below.
25268 They reference the following parameters of that function directly:
25269 `w', `row', `area', and `overlap_p'
25270 as well as the following local variables:
25271 `s', `f', and `hdc' (in W32) */
25274 /* On W32, silently add local `hdc' variable to argument list of
25275 init_glyph_string. */
25276 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
25277 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
25279 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
25280 init_glyph_string (s, char2b, w, row, area, start, hl)
25283 /* Add a glyph string for a stretch glyph to the list of strings
25284 between HEAD and TAIL. START is the index of the stretch glyph in
25285 row area AREA of glyph row ROW. END is the index of the last glyph
25286 in that glyph row area. X is the current output position assigned
25287 to the new glyph string constructed. HL overrides that face of the
25288 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25289 is the right-most x-position of the drawing area. */
25291 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
25292 and below -- keep them on one line. */
25293 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25296 s = alloca (sizeof *s); \
25297 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25298 START = fill_stretch_glyph_string (s, START, END); \
25299 append_glyph_string (&HEAD, &TAIL, s); \
25305 /* Add a glyph string for an image glyph to the list of strings
25306 between HEAD and TAIL. START is the index of the image glyph in
25307 row area AREA of glyph row ROW. END is the index of the last glyph
25308 in that glyph row area. X is the current output position assigned
25309 to the new glyph string constructed. HL overrides that face of the
25310 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25311 is the right-most x-position of the drawing area. */
25313 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25316 s = alloca (sizeof *s); \
25317 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25318 fill_image_glyph_string (s); \
25319 append_glyph_string (&HEAD, &TAIL, s); \
25325 #ifndef HAVE_XWIDGETS
25326 # define BUILD_XWIDGET_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25329 # define BUILD_XWIDGET_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25332 s = alloca (sizeof *s); \
25333 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25334 fill_xwidget_glyph_string (s); \
25335 append_glyph_string (&(HEAD), &(TAIL), s); \
25342 /* Add a glyph string for a sequence of character glyphs to the list
25343 of strings between HEAD and TAIL. START is the index of the first
25344 glyph in row area AREA of glyph row ROW that is part of the new
25345 glyph string. END is the index of the last glyph in that glyph row
25346 area. X is the current output position assigned to the new glyph
25347 string constructed. HL overrides that face of the glyph; e.g. it
25348 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
25349 right-most x-position of the drawing area. */
25351 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25357 face_id = (row)->glyphs[area][START].face_id; \
25359 s = alloca (sizeof *s); \
25360 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
25361 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25362 append_glyph_string (&HEAD, &TAIL, s); \
25364 START = fill_glyph_string (s, face_id, START, END, overlaps); \
25369 /* Add a glyph string for a composite sequence to the list of strings
25370 between HEAD and TAIL. START is the index of the first glyph in
25371 row area AREA of glyph row ROW that is part of the new glyph
25372 string. END is the index of the last glyph in that glyph row area.
25373 X is the current output position assigned to the new glyph string
25374 constructed. HL overrides that face of the glyph; e.g. it is
25375 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
25376 x-position of the drawing area. */
25378 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25380 int face_id = (row)->glyphs[area][START].face_id; \
25381 struct face *base_face = FACE_OPT_FROM_ID (f, face_id); \
25382 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
25383 struct composition *cmp = composition_table[cmp_id]; \
25385 struct glyph_string *first_s = NULL; \
25388 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
25390 /* Make glyph_strings for each glyph sequence that is drawable by \
25391 the same face, and append them to HEAD/TAIL. */ \
25392 for (n = 0; n < cmp->glyph_len;) \
25394 s = alloca (sizeof *s); \
25395 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25396 append_glyph_string (&(HEAD), &(TAIL), s); \
25402 n = fill_composite_glyph_string (s, base_face, overlaps); \
25410 /* Add a glyph string for a glyph-string sequence to the list of strings
25411 between HEAD and TAIL. */
25413 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25417 Lisp_Object gstring; \
25419 face_id = (row)->glyphs[area][START].face_id; \
25420 gstring = (composition_gstring_from_id \
25421 ((row)->glyphs[area][START].u.cmp.id)); \
25422 s = alloca (sizeof *s); \
25423 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
25424 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25425 append_glyph_string (&(HEAD), &(TAIL), s); \
25427 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
25431 /* Add a glyph string for a sequence of glyphless character's glyphs
25432 to the list of strings between HEAD and TAIL. The meanings of
25433 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
25435 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25440 face_id = (row)->glyphs[area][START].face_id; \
25442 s = alloca (sizeof *s); \
25443 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25444 append_glyph_string (&HEAD, &TAIL, s); \
25446 START = fill_glyphless_glyph_string (s, face_id, START, END, \
25452 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
25453 of AREA of glyph row ROW on window W between indices START and END.
25454 HL overrides the face for drawing glyph strings, e.g. it is
25455 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
25456 x-positions of the drawing area.
25458 This is an ugly monster macro construct because we must use alloca
25459 to allocate glyph strings (because draw_glyphs can be called
25460 asynchronously). */
25462 #define BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25465 HEAD = TAIL = NULL; \
25466 while (START < END) \
25468 struct glyph *first_glyph = (row)->glyphs[area] + START; \
25469 switch (first_glyph->type) \
25472 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
25476 case COMPOSITE_GLYPH: \
25477 if (first_glyph->u.cmp.automatic) \
25478 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
25481 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
25485 case STRETCH_GLYPH: \
25486 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
25490 case IMAGE_GLYPH: \
25491 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
25495 #define BUILD_GLYPH_STRINGS_XW(START, END, HEAD, TAIL, HL, X, LAST_X) \
25496 case XWIDGET_GLYPH: \
25497 BUILD_XWIDGET_GLYPH_STRING (START, END, HEAD, TAIL, \
25501 #define BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X) \
25502 case GLYPHLESS_GLYPH: \
25503 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
25513 set_glyph_string_background_width (s, START, LAST_X); \
25520 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25521 BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25522 BUILD_GLYPH_STRINGS_XW(START, END, HEAD, TAIL, HL, X, LAST_X) \
25523 BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X)
25526 /* Draw glyphs between START and END in AREA of ROW on window W,
25527 starting at x-position X. X is relative to AREA in W. HL is a
25528 face-override with the following meaning:
25530 DRAW_NORMAL_TEXT draw normally
25531 DRAW_CURSOR draw in cursor face
25532 DRAW_MOUSE_FACE draw in mouse face.
25533 DRAW_INVERSE_VIDEO draw in mode line face
25534 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
25535 DRAW_IMAGE_RAISED draw an image with a raised relief around it
25537 If OVERLAPS is non-zero, draw only the foreground of characters and
25538 clip to the physical height of ROW. Non-zero value also defines
25539 the overlapping part to be drawn:
25541 OVERLAPS_PRED overlap with preceding rows
25542 OVERLAPS_SUCC overlap with succeeding rows
25543 OVERLAPS_BOTH overlap with both preceding/succeeding rows
25544 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
25546 Value is the x-position reached, relative to AREA of W. */
25549 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
25550 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
25551 enum draw_glyphs_face hl
, int overlaps
)
25553 struct glyph_string
*head
, *tail
;
25554 struct glyph_string
*s
;
25555 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
25556 int i
, j
, x_reached
, last_x
, area_left
= 0;
25557 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25560 ALLOCATE_HDC (hdc
, f
);
25562 /* Let's rather be paranoid than getting a SEGV. */
25563 end
= min (end
, row
->used
[area
]);
25564 start
= clip_to_bounds (0, start
, end
);
25566 /* Translate X to frame coordinates. Set last_x to the right
25567 end of the drawing area. */
25568 if (row
->full_width_p
)
25570 /* X is relative to the left edge of W, without scroll bars
25572 area_left
= WINDOW_LEFT_EDGE_X (w
);
25573 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
25574 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
25578 area_left
= window_box_left (w
, area
);
25579 last_x
= area_left
+ window_box_width (w
, area
);
25583 /* Build a doubly-linked list of glyph_string structures between
25584 head and tail from what we have to draw. Note that the macro
25585 BUILD_GLYPH_STRINGS will modify its start parameter. That's
25586 the reason we use a separate variable `i'. */
25589 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
25591 x_reached
= tail
->x
+ tail
->background_width
;
25595 /* If there are any glyphs with lbearing < 0 or rbearing > width in
25596 the row, redraw some glyphs in front or following the glyph
25597 strings built above. */
25598 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
25600 struct glyph_string
*h
, *t
;
25601 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25602 int mouse_beg_col UNINIT
, mouse_end_col UNINIT
;
25603 bool check_mouse_face
= false;
25606 /* If mouse highlighting is on, we may need to draw adjacent
25607 glyphs using mouse-face highlighting. */
25608 if (area
== TEXT_AREA
&& row
->mouse_face_p
25609 && hlinfo
->mouse_face_beg_row
>= 0
25610 && hlinfo
->mouse_face_end_row
>= 0)
25612 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
25614 if (row_vpos
>= hlinfo
->mouse_face_beg_row
25615 && row_vpos
<= hlinfo
->mouse_face_end_row
)
25617 check_mouse_face
= true;
25618 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
25619 ? hlinfo
->mouse_face_beg_col
: 0;
25620 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
25621 ? hlinfo
->mouse_face_end_col
25622 : row
->used
[TEXT_AREA
];
25626 /* Compute overhangs for all glyph strings. */
25627 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
25628 for (s
= head
; s
; s
= s
->next
)
25629 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
25631 /* Prepend glyph strings for glyphs in front of the first glyph
25632 string that are overwritten because of the first glyph
25633 string's left overhang. The background of all strings
25634 prepended must be drawn because the first glyph string
25636 i
= left_overwritten (head
);
25639 enum draw_glyphs_face overlap_hl
;
25641 /* If this row contains mouse highlighting, attempt to draw
25642 the overlapped glyphs with the correct highlight. This
25643 code fails if the overlap encompasses more than one glyph
25644 and mouse-highlight spans only some of these glyphs.
25645 However, making it work perfectly involves a lot more
25646 code, and I don't know if the pathological case occurs in
25647 practice, so we'll stick to this for now. --- cyd */
25648 if (check_mouse_face
25649 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25650 overlap_hl
= DRAW_MOUSE_FACE
;
25652 overlap_hl
= DRAW_NORMAL_TEXT
;
25654 if (hl
!= overlap_hl
)
25657 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
25658 overlap_hl
, dummy_x
, last_x
);
25660 compute_overhangs_and_x (t
, head
->x
, true);
25661 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25662 if (clip_head
== NULL
)
25666 /* Prepend glyph strings for glyphs in front of the first glyph
25667 string that overwrite that glyph string because of their
25668 right overhang. For these strings, only the foreground must
25669 be drawn, because it draws over the glyph string at `head'.
25670 The background must not be drawn because this would overwrite
25671 right overhangs of preceding glyphs for which no glyph
25673 i
= left_overwriting (head
);
25676 enum draw_glyphs_face overlap_hl
;
25678 if (check_mouse_face
25679 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25680 overlap_hl
= DRAW_MOUSE_FACE
;
25682 overlap_hl
= DRAW_NORMAL_TEXT
;
25684 if (hl
== overlap_hl
|| clip_head
== NULL
)
25686 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
25687 overlap_hl
, dummy_x
, last_x
);
25688 for (s
= h
; s
; s
= s
->next
)
25689 s
->background_filled_p
= true;
25690 compute_overhangs_and_x (t
, head
->x
, true);
25691 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25694 /* Append glyphs strings for glyphs following the last glyph
25695 string tail that are overwritten by tail. The background of
25696 these strings has to be drawn because tail's foreground draws
25698 i
= right_overwritten (tail
);
25701 enum draw_glyphs_face overlap_hl
;
25703 if (check_mouse_face
25704 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25705 overlap_hl
= DRAW_MOUSE_FACE
;
25707 overlap_hl
= DRAW_NORMAL_TEXT
;
25709 if (hl
!= overlap_hl
)
25711 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25712 overlap_hl
, x
, last_x
);
25713 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25714 we don't have `end = i;' here. */
25715 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25716 append_glyph_string_lists (&head
, &tail
, h
, t
);
25717 if (clip_tail
== NULL
)
25721 /* Append glyph strings for glyphs following the last glyph
25722 string tail that overwrite tail. The foreground of such
25723 glyphs has to be drawn because it writes into the background
25724 of tail. The background must not be drawn because it could
25725 paint over the foreground of following glyphs. */
25726 i
= right_overwriting (tail
);
25729 enum draw_glyphs_face overlap_hl
;
25730 if (check_mouse_face
25731 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25732 overlap_hl
= DRAW_MOUSE_FACE
;
25734 overlap_hl
= DRAW_NORMAL_TEXT
;
25736 if (hl
== overlap_hl
|| clip_tail
== NULL
)
25738 i
++; /* We must include the Ith glyph. */
25739 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25740 overlap_hl
, x
, last_x
);
25741 for (s
= h
; s
; s
= s
->next
)
25742 s
->background_filled_p
= true;
25743 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25744 append_glyph_string_lists (&head
, &tail
, h
, t
);
25746 if (clip_head
|| clip_tail
)
25747 for (s
= head
; s
; s
= s
->next
)
25749 s
->clip_head
= clip_head
;
25750 s
->clip_tail
= clip_tail
;
25754 /* Draw all strings. */
25755 for (s
= head
; s
; s
= s
->next
)
25756 FRAME_RIF (f
)->draw_glyph_string (s
);
25759 /* When focus a sole frame and move horizontally, this clears on_p
25760 causing a failure to erase prev cursor position. */
25761 if (area
== TEXT_AREA
25762 && !row
->full_width_p
25763 /* When drawing overlapping rows, only the glyph strings'
25764 foreground is drawn, which doesn't erase a cursor
25768 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25769 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25770 : (tail
? tail
->x
+ tail
->background_width
: x
));
25774 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25775 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25779 /* Value is the x-position up to which drawn, relative to AREA of W.
25780 This doesn't include parts drawn because of overhangs. */
25781 if (row
->full_width_p
)
25782 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25784 x_reached
-= area_left
;
25786 RELEASE_HDC (hdc
, f
);
25792 /* Expand row matrix if too narrow. Don't expand if area
25795 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25797 if (!it->f->fonts_changed \
25798 && (it->glyph_row->glyphs[area] \
25799 < it->glyph_row->glyphs[area + 1])) \
25801 it->w->ncols_scale_factor++; \
25802 it->f->fonts_changed = true; \
25806 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25807 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25810 append_glyph (struct it
*it
)
25812 struct glyph
*glyph
;
25813 enum glyph_row_area area
= it
->area
;
25815 eassert (it
->glyph_row
);
25816 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25818 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25819 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25821 /* If the glyph row is reversed, we need to prepend the glyph
25822 rather than append it. */
25823 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25827 /* Make room for the additional glyph. */
25828 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25830 glyph
= it
->glyph_row
->glyphs
[area
];
25832 glyph
->charpos
= CHARPOS (it
->position
);
25833 glyph
->object
= it
->object
;
25834 if (it
->pixel_width
> 0)
25836 eassert (it
->pixel_width
<= SHRT_MAX
);
25837 glyph
->pixel_width
= it
->pixel_width
;
25838 glyph
->padding_p
= false;
25842 /* Assure at least 1-pixel width. Otherwise, cursor can't
25843 be displayed correctly. */
25844 glyph
->pixel_width
= 1;
25845 glyph
->padding_p
= true;
25847 glyph
->ascent
= it
->ascent
;
25848 glyph
->descent
= it
->descent
;
25849 glyph
->voffset
= it
->voffset
;
25850 glyph
->type
= CHAR_GLYPH
;
25851 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25852 glyph
->multibyte_p
= it
->multibyte_p
;
25853 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25855 /* In R2L rows, the left and the right box edges need to be
25856 drawn in reverse direction. */
25857 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25858 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25862 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25863 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25865 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25866 || it
->phys_descent
> it
->descent
);
25867 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25868 glyph
->face_id
= it
->face_id
;
25869 glyph
->u
.ch
= it
->char_to_display
;
25870 glyph
->slice
.img
= null_glyph_slice
;
25871 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25874 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25875 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25876 glyph
->bidi_type
= it
->bidi_it
.type
;
25880 glyph
->resolved_level
= 0;
25881 glyph
->bidi_type
= UNKNOWN_BT
;
25883 ++it
->glyph_row
->used
[area
];
25886 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25889 /* Store one glyph for the composition IT->cmp_it.id in
25890 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25894 append_composite_glyph (struct it
*it
)
25896 struct glyph
*glyph
;
25897 enum glyph_row_area area
= it
->area
;
25899 eassert (it
->glyph_row
);
25901 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25902 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25904 /* If the glyph row is reversed, we need to prepend the glyph
25905 rather than append it. */
25906 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25910 /* Make room for the new glyph. */
25911 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25913 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25915 glyph
->charpos
= it
->cmp_it
.charpos
;
25916 glyph
->object
= it
->object
;
25917 eassert (it
->pixel_width
<= SHRT_MAX
);
25918 glyph
->pixel_width
= it
->pixel_width
;
25919 glyph
->ascent
= it
->ascent
;
25920 glyph
->descent
= it
->descent
;
25921 glyph
->voffset
= it
->voffset
;
25922 glyph
->type
= COMPOSITE_GLYPH
;
25923 if (it
->cmp_it
.ch
< 0)
25925 glyph
->u
.cmp
.automatic
= false;
25926 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25927 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25931 glyph
->u
.cmp
.automatic
= true;
25932 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25933 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25934 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25936 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25937 glyph
->multibyte_p
= it
->multibyte_p
;
25938 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25940 /* In R2L rows, the left and the right box edges need to be
25941 drawn in reverse direction. */
25942 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25943 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25947 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25948 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25950 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25951 || it
->phys_descent
> it
->descent
);
25952 glyph
->padding_p
= false;
25953 glyph
->glyph_not_available_p
= false;
25954 glyph
->face_id
= it
->face_id
;
25955 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25958 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25959 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25960 glyph
->bidi_type
= it
->bidi_it
.type
;
25962 ++it
->glyph_row
->used
[area
];
25965 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25969 /* Change IT->ascent and IT->height according to the setting of
25973 take_vertical_position_into_account (struct it
*it
)
25977 if (it
->voffset
< 0)
25978 /* Increase the ascent so that we can display the text higher
25980 it
->ascent
-= it
->voffset
;
25982 /* Increase the descent so that we can display the text lower
25984 it
->descent
+= it
->voffset
;
25989 /* Produce glyphs/get display metrics for the image IT is loaded with.
25990 See the description of struct display_iterator in dispextern.h for
25991 an overview of struct display_iterator. */
25994 produce_image_glyph (struct it
*it
)
25998 int glyph_ascent
, crop
;
25999 struct glyph_slice slice
;
26001 eassert (it
->what
== IT_IMAGE
);
26003 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26004 /* Make sure X resources of the face is loaded. */
26005 prepare_face_for_display (it
->f
, face
);
26007 if (it
->image_id
< 0)
26009 /* Fringe bitmap. */
26010 it
->ascent
= it
->phys_ascent
= 0;
26011 it
->descent
= it
->phys_descent
= 0;
26012 it
->pixel_width
= 0;
26017 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
26018 /* Make sure X resources of the image is loaded. */
26019 prepare_image_for_display (it
->f
, img
);
26021 slice
.x
= slice
.y
= 0;
26022 slice
.width
= img
->width
;
26023 slice
.height
= img
->height
;
26025 if (INTEGERP (it
->slice
.x
))
26026 slice
.x
= XINT (it
->slice
.x
);
26027 else if (FLOATP (it
->slice
.x
))
26028 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
26030 if (INTEGERP (it
->slice
.y
))
26031 slice
.y
= XINT (it
->slice
.y
);
26032 else if (FLOATP (it
->slice
.y
))
26033 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
26035 if (INTEGERP (it
->slice
.width
))
26036 slice
.width
= XINT (it
->slice
.width
);
26037 else if (FLOATP (it
->slice
.width
))
26038 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
26040 if (INTEGERP (it
->slice
.height
))
26041 slice
.height
= XINT (it
->slice
.height
);
26042 else if (FLOATP (it
->slice
.height
))
26043 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
26045 if (slice
.x
>= img
->width
)
26046 slice
.x
= img
->width
;
26047 if (slice
.y
>= img
->height
)
26048 slice
.y
= img
->height
;
26049 if (slice
.x
+ slice
.width
>= img
->width
)
26050 slice
.width
= img
->width
- slice
.x
;
26051 if (slice
.y
+ slice
.height
> img
->height
)
26052 slice
.height
= img
->height
- slice
.y
;
26054 if (slice
.width
== 0 || slice
.height
== 0)
26057 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
26059 it
->descent
= slice
.height
- glyph_ascent
;
26061 it
->descent
+= img
->vmargin
;
26062 if (slice
.y
+ slice
.height
== img
->height
)
26063 it
->descent
+= img
->vmargin
;
26064 it
->phys_descent
= it
->descent
;
26066 it
->pixel_width
= slice
.width
;
26068 it
->pixel_width
+= img
->hmargin
;
26069 if (slice
.x
+ slice
.width
== img
->width
)
26070 it
->pixel_width
+= img
->hmargin
;
26072 /* It's quite possible for images to have an ascent greater than
26073 their height, so don't get confused in that case. */
26074 if (it
->descent
< 0)
26079 if (face
->box
!= FACE_NO_BOX
)
26081 if (face
->box_line_width
> 0)
26084 it
->ascent
+= face
->box_line_width
;
26085 if (slice
.y
+ slice
.height
== img
->height
)
26086 it
->descent
+= face
->box_line_width
;
26089 if (it
->start_of_box_run_p
&& slice
.x
== 0)
26090 it
->pixel_width
+= eabs (face
->box_line_width
);
26091 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
26092 it
->pixel_width
+= eabs (face
->box_line_width
);
26095 take_vertical_position_into_account (it
);
26097 /* Automatically crop wide image glyphs at right edge so we can
26098 draw the cursor on same display row. */
26099 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
26100 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
26102 it
->pixel_width
-= crop
;
26103 slice
.width
-= crop
;
26108 struct glyph
*glyph
;
26109 enum glyph_row_area area
= it
->area
;
26111 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26112 if (it
->glyph_row
->reversed_p
)
26116 /* Make room for the new glyph. */
26117 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
26119 glyph
= it
->glyph_row
->glyphs
[it
->area
];
26121 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26123 glyph
->charpos
= CHARPOS (it
->position
);
26124 glyph
->object
= it
->object
;
26125 glyph
->pixel_width
= clip_to_bounds (-1, it
->pixel_width
, SHRT_MAX
);
26126 glyph
->ascent
= glyph_ascent
;
26127 glyph
->descent
= it
->descent
;
26128 glyph
->voffset
= it
->voffset
;
26129 glyph
->type
= IMAGE_GLYPH
;
26130 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26131 glyph
->multibyte_p
= it
->multibyte_p
;
26132 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26134 /* In R2L rows, the left and the right box edges need to be
26135 drawn in reverse direction. */
26136 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26137 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26141 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26142 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26144 glyph
->overlaps_vertically_p
= false;
26145 glyph
->padding_p
= false;
26146 glyph
->glyph_not_available_p
= false;
26147 glyph
->face_id
= it
->face_id
;
26148 glyph
->u
.img_id
= img
->id
;
26149 glyph
->slice
.img
= slice
;
26150 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26153 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26154 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26155 glyph
->bidi_type
= it
->bidi_it
.type
;
26157 ++it
->glyph_row
->used
[area
];
26160 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26165 produce_xwidget_glyph (struct it
*it
)
26167 #ifdef HAVE_XWIDGETS
26168 struct xwidget
*xw
;
26169 int glyph_ascent
, crop
;
26170 eassert (it
->what
== IT_XWIDGET
);
26172 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26173 /* Make sure X resources of the face is loaded. */
26174 prepare_face_for_display (it
->f
, face
);
26177 it
->ascent
= it
->phys_ascent
= glyph_ascent
= xw
->height
/2;
26178 it
->descent
= xw
->height
/2;
26179 it
->phys_descent
= it
->descent
;
26180 it
->pixel_width
= xw
->width
;
26181 /* It's quite possible for images to have an ascent greater than
26182 their height, so don't get confused in that case. */
26183 if (it
->descent
< 0)
26188 if (face
->box
!= FACE_NO_BOX
)
26190 if (face
->box_line_width
> 0)
26192 it
->ascent
+= face
->box_line_width
;
26193 it
->descent
+= face
->box_line_width
;
26196 if (it
->start_of_box_run_p
)
26197 it
->pixel_width
+= eabs (face
->box_line_width
);
26198 it
->pixel_width
+= eabs (face
->box_line_width
);
26201 take_vertical_position_into_account (it
);
26203 /* Automatically crop wide image glyphs at right edge so we can
26204 draw the cursor on same display row. */
26205 crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
);
26206 if (crop
> 0 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
26207 it
->pixel_width
-= crop
;
26211 enum glyph_row_area area
= it
->area
;
26212 struct glyph
*glyph
26213 = it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26215 if (it
->glyph_row
->reversed_p
)
26219 /* Make room for the new glyph. */
26220 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
26222 glyph
= it
->glyph_row
->glyphs
[it
->area
];
26224 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26226 glyph
->charpos
= CHARPOS (it
->position
);
26227 glyph
->object
= it
->object
;
26228 glyph
->pixel_width
= clip_to_bounds (-1, it
->pixel_width
, SHRT_MAX
);
26229 glyph
->ascent
= glyph_ascent
;
26230 glyph
->descent
= it
->descent
;
26231 glyph
->voffset
= it
->voffset
;
26232 glyph
->type
= XWIDGET_GLYPH
;
26233 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26234 glyph
->multibyte_p
= it
->multibyte_p
;
26235 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26237 /* In R2L rows, the left and the right box edges need to be
26238 drawn in reverse direction. */
26239 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26240 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26244 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26245 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26247 glyph
->overlaps_vertically_p
= 0;
26248 glyph
->padding_p
= 0;
26249 glyph
->glyph_not_available_p
= 0;
26250 glyph
->face_id
= it
->face_id
;
26251 glyph
->u
.xwidget
= it
->xwidget
;
26252 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26255 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26256 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26257 glyph
->bidi_type
= it
->bidi_it
.type
;
26259 ++it
->glyph_row
->used
[area
];
26262 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26267 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
26268 of the glyph, WIDTH and HEIGHT are the width and height of the
26269 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
26272 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
26273 int width
, int height
, int ascent
)
26275 struct glyph
*glyph
;
26276 enum glyph_row_area area
= it
->area
;
26278 eassert (ascent
>= 0 && ascent
<= height
);
26280 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26281 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26283 /* If the glyph row is reversed, we need to prepend the glyph
26284 rather than append it. */
26285 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26289 /* Make room for the additional glyph. */
26290 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26292 glyph
= it
->glyph_row
->glyphs
[area
];
26294 /* Decrease the width of the first glyph of the row that
26295 begins before first_visible_x (e.g., due to hscroll).
26296 This is so the overall width of the row becomes smaller
26297 by the scroll amount, and the stretch glyph appended by
26298 extend_face_to_end_of_line will be wider, to shift the
26299 row glyphs to the right. (In L2R rows, the corresponding
26300 left-shift effect is accomplished by setting row->x to a
26301 negative value, which won't work with R2L rows.)
26303 This must leave us with a positive value of WIDTH, since
26304 otherwise the call to move_it_in_display_line_to at the
26305 beginning of display_line would have got past the entire
26306 first glyph, and then it->current_x would have been
26307 greater or equal to it->first_visible_x. */
26308 if (it
->current_x
< it
->first_visible_x
)
26309 width
-= it
->first_visible_x
- it
->current_x
;
26310 eassert (width
> 0);
26312 glyph
->charpos
= CHARPOS (it
->position
);
26313 glyph
->object
= object
;
26314 /* FIXME: It would be better to use TYPE_MAX here, but
26315 __typeof__ is not portable enough... */
26316 glyph
->pixel_width
= clip_to_bounds (-1, width
, SHRT_MAX
);
26317 glyph
->ascent
= ascent
;
26318 glyph
->descent
= height
- ascent
;
26319 glyph
->voffset
= it
->voffset
;
26320 glyph
->type
= STRETCH_GLYPH
;
26321 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26322 glyph
->multibyte_p
= it
->multibyte_p
;
26323 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26325 /* In R2L rows, the left and the right box edges need to be
26326 drawn in reverse direction. */
26327 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26328 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26332 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26333 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26335 glyph
->overlaps_vertically_p
= false;
26336 glyph
->padding_p
= false;
26337 glyph
->glyph_not_available_p
= false;
26338 glyph
->face_id
= it
->face_id
;
26339 glyph
->u
.stretch
.ascent
= ascent
;
26340 glyph
->u
.stretch
.height
= height
;
26341 glyph
->slice
.img
= null_glyph_slice
;
26342 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26345 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26346 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26347 glyph
->bidi_type
= it
->bidi_it
.type
;
26351 glyph
->resolved_level
= 0;
26352 glyph
->bidi_type
= UNKNOWN_BT
;
26354 ++it
->glyph_row
->used
[area
];
26357 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26360 #endif /* HAVE_WINDOW_SYSTEM */
26362 /* Produce a stretch glyph for iterator IT. IT->object is the value
26363 of the glyph property displayed. The value must be a list
26364 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
26367 1. `:width WIDTH' specifies that the space should be WIDTH *
26368 canonical char width wide. WIDTH may be an integer or floating
26371 2. `:relative-width FACTOR' specifies that the width of the stretch
26372 should be computed from the width of the first character having the
26373 `glyph' property, and should be FACTOR times that width.
26375 3. `:align-to HPOS' specifies that the space should be wide enough
26376 to reach HPOS, a value in canonical character units.
26378 Exactly one of the above pairs must be present.
26380 4. `:height HEIGHT' specifies that the height of the stretch produced
26381 should be HEIGHT, measured in canonical character units.
26383 5. `:relative-height FACTOR' specifies that the height of the
26384 stretch should be FACTOR times the height of the characters having
26385 the glyph property.
26387 Either none or exactly one of 4 or 5 must be present.
26389 6. `:ascent ASCENT' specifies that ASCENT percent of the height
26390 of the stretch should be used for the ascent of the stretch.
26391 ASCENT must be in the range 0 <= ASCENT <= 100. */
26394 produce_stretch_glyph (struct it
*it
)
26396 /* (space :width WIDTH :height HEIGHT ...) */
26397 Lisp_Object prop
, plist
;
26398 int width
= 0, height
= 0, align_to
= -1;
26399 bool zero_width_ok_p
= false;
26401 struct font
*font
= NULL
;
26403 #ifdef HAVE_WINDOW_SYSTEM
26405 bool zero_height_ok_p
= false;
26407 if (FRAME_WINDOW_P (it
->f
))
26409 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26410 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26411 prepare_face_for_display (it
->f
, face
);
26415 /* List should start with `space'. */
26416 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
26417 plist
= XCDR (it
->object
);
26419 /* Compute the width of the stretch. */
26420 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
26421 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true, 0))
26423 /* Absolute width `:width WIDTH' specified and valid. */
26424 zero_width_ok_p
= true;
26427 else if (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0)
26429 /* Relative width `:relative-width FACTOR' specified and valid.
26430 Compute the width of the characters having the `glyph'
26433 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
26436 if (it
->multibyte_p
)
26437 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
26440 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
26441 if (! ASCII_CHAR_P (it2
.c
))
26442 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
26445 it2
.glyph_row
= NULL
;
26446 it2
.what
= IT_CHARACTER
;
26447 PRODUCE_GLYPHS (&it2
);
26448 width
= NUMVAL (prop
) * it2
.pixel_width
;
26450 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
26451 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true,
26454 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
26455 align_to
= (align_to
< 0
26457 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
26458 else if (align_to
< 0)
26459 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
26460 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
26461 zero_width_ok_p
= true;
26464 /* Nothing specified -> width defaults to canonical char width. */
26465 width
= FRAME_COLUMN_WIDTH (it
->f
);
26467 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
26470 #ifdef HAVE_WINDOW_SYSTEM
26471 /* Compute height. */
26472 if (FRAME_WINDOW_P (it
->f
))
26474 int default_height
= normal_char_height (font
, ' ');
26476 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
26477 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26480 zero_height_ok_p
= true;
26482 else if (prop
= Fplist_get (plist
, QCrelative_height
),
26484 height
= default_height
* NUMVAL (prop
);
26486 height
= default_height
;
26488 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
26491 /* Compute percentage of height used for ascent. If
26492 `:ascent ASCENT' is present and valid, use that. Otherwise,
26493 derive the ascent from the font in use. */
26494 if (prop
= Fplist_get (plist
, QCascent
),
26495 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
26496 ascent
= height
* NUMVAL (prop
) / 100.0;
26497 else if (!NILP (prop
)
26498 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26499 ascent
= min (max (0, (int)tem
), height
);
26501 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
26504 #endif /* HAVE_WINDOW_SYSTEM */
26507 if (width
> 0 && it
->line_wrap
!= TRUNCATE
26508 && it
->current_x
+ width
> it
->last_visible_x
)
26510 width
= it
->last_visible_x
- it
->current_x
;
26511 #ifdef HAVE_WINDOW_SYSTEM
26512 /* Subtract one more pixel from the stretch width, but only on
26513 GUI frames, since on a TTY each glyph is one "pixel" wide. */
26514 width
-= FRAME_WINDOW_P (it
->f
);
26518 if (width
> 0 && height
> 0 && it
->glyph_row
)
26520 Lisp_Object o_object
= it
->object
;
26521 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
26524 if (!STRINGP (object
))
26525 object
= it
->w
->contents
;
26526 #ifdef HAVE_WINDOW_SYSTEM
26527 if (FRAME_WINDOW_P (it
->f
))
26528 append_stretch_glyph (it
, object
, width
, height
, ascent
);
26532 it
->object
= object
;
26533 it
->char_to_display
= ' ';
26534 it
->pixel_width
= it
->len
= 1;
26536 tty_append_glyph (it
);
26537 it
->object
= o_object
;
26541 it
->pixel_width
= width
;
26542 #ifdef HAVE_WINDOW_SYSTEM
26543 if (FRAME_WINDOW_P (it
->f
))
26545 it
->ascent
= it
->phys_ascent
= ascent
;
26546 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
26547 it
->nglyphs
= width
> 0 && height
> 0;
26548 take_vertical_position_into_account (it
);
26552 it
->nglyphs
= width
;
26555 /* Get information about special display element WHAT in an
26556 environment described by IT. WHAT is one of IT_TRUNCATION or
26557 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
26558 non-null glyph_row member. This function ensures that fields like
26559 face_id, c, len of IT are left untouched. */
26562 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
26569 temp_it
.object
= Qnil
;
26570 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
26572 if (what
== IT_CONTINUATION
)
26574 /* Continuation glyph. For R2L lines, we mirror it by hand. */
26575 if (it
->bidi_it
.paragraph_dir
== R2L
)
26576 SET_GLYPH_FROM_CHAR (glyph
, '/');
26578 SET_GLYPH_FROM_CHAR (glyph
, '\\');
26580 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26582 /* FIXME: Should we mirror GC for R2L lines? */
26583 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26584 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26587 else if (what
== IT_TRUNCATION
)
26589 /* Truncation glyph. */
26590 SET_GLYPH_FROM_CHAR (glyph
, '$');
26592 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26594 /* FIXME: Should we mirror GC for R2L lines? */
26595 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26596 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26602 #ifdef HAVE_WINDOW_SYSTEM
26603 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
26604 is turned off, we precede the truncation/continuation glyphs by a
26605 stretch glyph whose width is computed such that these special
26606 glyphs are aligned at the window margin, even when very different
26607 fonts are used in different glyph rows. */
26608 if (FRAME_WINDOW_P (temp_it
.f
)
26609 /* init_iterator calls this with it->glyph_row == NULL, and it
26610 wants only the pixel width of the truncation/continuation
26612 && temp_it
.glyph_row
26613 /* insert_left_trunc_glyphs calls us at the beginning of the
26614 row, and it has its own calculation of the stretch glyph
26616 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
26617 && (temp_it
.glyph_row
->reversed_p
26618 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
26619 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
26621 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
26623 if (stretch_width
> 0)
26625 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
26626 struct font
*font
=
26627 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
26628 int stretch_ascent
=
26629 (((temp_it
.ascent
+ temp_it
.descent
)
26630 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
26632 append_stretch_glyph (&temp_it
, Qnil
, stretch_width
,
26633 temp_it
.ascent
+ temp_it
.descent
,
26640 temp_it
.what
= IT_CHARACTER
;
26641 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
26642 temp_it
.face_id
= GLYPH_FACE (glyph
);
26643 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
26645 PRODUCE_GLYPHS (&temp_it
);
26646 it
->pixel_width
= temp_it
.pixel_width
;
26647 it
->nglyphs
= temp_it
.nglyphs
;
26650 #ifdef HAVE_WINDOW_SYSTEM
26652 /* Calculate line-height and line-spacing properties.
26653 An integer value specifies explicit pixel value.
26654 A float value specifies relative value to current face height.
26655 A cons (float . face-name) specifies relative value to
26656 height of specified face font.
26658 Returns height in pixels, or nil. */
26661 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
26662 int boff
, bool override
)
26664 Lisp_Object face_name
= Qnil
;
26665 int ascent
, descent
, height
;
26667 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
26672 face_name
= XCAR (val
);
26674 if (!NUMBERP (val
))
26675 val
= make_number (1);
26676 if (NILP (face_name
))
26678 height
= it
->ascent
+ it
->descent
;
26683 if (NILP (face_name
))
26685 font
= FRAME_FONT (it
->f
);
26686 boff
= FRAME_BASELINE_OFFSET (it
->f
);
26688 else if (EQ (face_name
, Qt
))
26697 face_id
= lookup_named_face (it
->f
, face_name
, false);
26699 return make_number (-1);
26701 face
= FACE_FROM_ID (it
->f
, face_id
);
26704 return make_number (-1);
26705 boff
= font
->baseline_offset
;
26706 if (font
->vertical_centering
)
26707 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26710 normal_char_ascent_descent (font
, -1, &ascent
, &descent
);
26714 it
->override_ascent
= ascent
;
26715 it
->override_descent
= descent
;
26716 it
->override_boff
= boff
;
26719 height
= ascent
+ descent
;
26723 height
= (int)(XFLOAT_DATA (val
) * height
);
26724 else if (INTEGERP (val
))
26725 height
*= XINT (val
);
26727 return make_number (height
);
26731 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
26732 is a face ID to be used for the glyph. FOR_NO_FONT is true if
26733 and only if this is for a character for which no font was found.
26735 If the display method (it->glyphless_method) is
26736 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
26737 length of the acronym or the hexadecimal string, UPPER_XOFF and
26738 UPPER_YOFF are pixel offsets for the upper part of the string,
26739 LOWER_XOFF and LOWER_YOFF are for the lower part.
26741 For the other display methods, LEN through LOWER_YOFF are zero. */
26744 append_glyphless_glyph (struct it
*it
, int face_id
, bool for_no_font
, int len
,
26745 short upper_xoff
, short upper_yoff
,
26746 short lower_xoff
, short lower_yoff
)
26748 struct glyph
*glyph
;
26749 enum glyph_row_area area
= it
->area
;
26751 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26752 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26754 /* If the glyph row is reversed, we need to prepend the glyph
26755 rather than append it. */
26756 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26760 /* Make room for the additional glyph. */
26761 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26763 glyph
= it
->glyph_row
->glyphs
[area
];
26765 glyph
->charpos
= CHARPOS (it
->position
);
26766 glyph
->object
= it
->object
;
26767 eassert (it
->pixel_width
<= SHRT_MAX
);
26768 glyph
->pixel_width
= it
->pixel_width
;
26769 glyph
->ascent
= it
->ascent
;
26770 glyph
->descent
= it
->descent
;
26771 glyph
->voffset
= it
->voffset
;
26772 glyph
->type
= GLYPHLESS_GLYPH
;
26773 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
26774 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
26775 glyph
->u
.glyphless
.len
= len
;
26776 glyph
->u
.glyphless
.ch
= it
->c
;
26777 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
26778 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
26779 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
26780 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
26781 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26782 glyph
->multibyte_p
= it
->multibyte_p
;
26783 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26785 /* In R2L rows, the left and the right box edges need to be
26786 drawn in reverse direction. */
26787 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26788 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26792 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26793 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26795 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
26796 || it
->phys_descent
> it
->descent
);
26797 glyph
->padding_p
= false;
26798 glyph
->glyph_not_available_p
= false;
26799 glyph
->face_id
= face_id
;
26800 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26803 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26804 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26805 glyph
->bidi_type
= it
->bidi_it
.type
;
26807 ++it
->glyph_row
->used
[area
];
26810 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26814 /* Produce a glyph for a glyphless character for iterator IT.
26815 IT->glyphless_method specifies which method to use for displaying
26816 the character. See the description of enum
26817 glyphless_display_method in dispextern.h for the detail.
26819 FOR_NO_FONT is true if and only if this is for a character for
26820 which no font was found. ACRONYM, if non-nil, is an acronym string
26821 for the character. */
26824 produce_glyphless_glyph (struct it
*it
, bool for_no_font
, Lisp_Object acronym
)
26829 int base_width
, base_height
, width
, height
;
26830 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26833 /* Get the metrics of the base font. We always refer to the current
26835 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26836 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26837 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
26838 it
->ascent
+= font
->baseline_offset
;
26839 it
->descent
-= font
->baseline_offset
;
26840 base_height
= it
->ascent
+ it
->descent
;
26841 base_width
= font
->average_width
;
26843 face_id
= merge_glyphless_glyph_face (it
);
26845 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26847 it
->pixel_width
= THIN_SPACE_WIDTH
;
26849 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26851 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26853 width
= CHAR_WIDTH (it
->c
);
26856 else if (width
> 4)
26858 it
->pixel_width
= base_width
* width
;
26860 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26866 unsigned int code
[6];
26868 int ascent
, descent
;
26869 struct font_metrics metrics_upper
, metrics_lower
;
26871 face
= FACE_FROM_ID (it
->f
, face_id
);
26872 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26873 prepare_face_for_display (it
->f
, face
);
26875 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26877 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26878 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26879 if (CONSP (acronym
))
26880 acronym
= XCAR (acronym
);
26881 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26885 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26886 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
+ 0u);
26889 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
26890 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26891 upper_len
= (len
+ 1) / 2;
26892 font
->driver
->text_extents (font
, code
, upper_len
,
26894 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26899 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26900 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26901 upper_xoff
= upper_yoff
= 2; /* the typical case */
26902 if (base_width
>= width
)
26904 /* Align the upper to the left, the lower to the right. */
26905 it
->pixel_width
= base_width
;
26906 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26910 /* Center the shorter one. */
26911 it
->pixel_width
= width
;
26912 if (metrics_upper
.width
>= metrics_lower
.width
)
26913 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26916 /* FIXME: This code doesn't look right. It formerly was
26917 missing the "lower_xoff = 0;", which couldn't have
26918 been right since it left lower_xoff uninitialized. */
26920 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26924 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26925 top, bottom, and between upper and lower strings. */
26926 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26927 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26928 /* Center vertically.
26929 H:base_height, D:base_descent
26930 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26932 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26933 descent = D - H/2 + h/2;
26934 lower_yoff = descent - 2 - ld;
26935 upper_yoff = lower_yoff - la - 1 - ud; */
26936 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26937 descent
= it
->descent
- (base_height
- height
) / 2;
26938 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26939 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26940 - metrics_upper
.descent
);
26941 /* Don't make the height shorter than the base height. */
26942 if (height
> base_height
)
26944 it
->ascent
= ascent
;
26945 it
->descent
= descent
;
26949 it
->phys_ascent
= it
->ascent
;
26950 it
->phys_descent
= it
->descent
;
26952 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26953 upper_xoff
, upper_yoff
,
26954 lower_xoff
, lower_yoff
);
26956 take_vertical_position_into_account (it
);
26961 Produce glyphs/get display metrics for the display element IT is
26962 loaded with. See the description of struct it in dispextern.h
26963 for an overview of struct it. */
26966 x_produce_glyphs (struct it
*it
)
26968 int extra_line_spacing
= it
->extra_line_spacing
;
26970 it
->glyph_not_available_p
= false;
26972 if (it
->what
== IT_CHARACTER
)
26975 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26976 struct font
*font
= face
->font
;
26977 struct font_metrics
*pcm
= NULL
;
26978 int boff
; /* Baseline offset. */
26982 /* When no suitable font is found, display this character by
26983 the method specified in the first extra slot of
26984 Vglyphless_char_display. */
26985 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26987 eassert (it
->what
== IT_GLYPHLESS
);
26988 produce_glyphless_glyph (it
, true,
26989 STRINGP (acronym
) ? acronym
: Qnil
);
26993 boff
= font
->baseline_offset
;
26994 if (font
->vertical_centering
)
26995 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26997 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
27001 if (it
->override_ascent
>= 0)
27003 it
->ascent
= it
->override_ascent
;
27004 it
->descent
= it
->override_descent
;
27005 boff
= it
->override_boff
;
27009 it
->ascent
= FONT_BASE (font
) + boff
;
27010 it
->descent
= FONT_DESCENT (font
) - boff
;
27013 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
27015 pcm
= get_per_char_metric (font
, &char2b
);
27016 if (pcm
->width
== 0
27017 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
27023 it
->phys_ascent
= pcm
->ascent
+ boff
;
27024 it
->phys_descent
= pcm
->descent
- boff
;
27025 it
->pixel_width
= pcm
->width
;
27026 /* Don't use font-global values for ascent and descent
27027 if they result in an exceedingly large line height. */
27028 if (it
->override_ascent
< 0)
27030 if (FONT_TOO_HIGH (font
))
27032 it
->ascent
= it
->phys_ascent
;
27033 it
->descent
= it
->phys_descent
;
27034 /* These limitations are enforced by an
27035 assertion near the end of this function. */
27036 if (it
->ascent
< 0)
27038 if (it
->descent
< 0)
27045 it
->glyph_not_available_p
= true;
27046 it
->phys_ascent
= it
->ascent
;
27047 it
->phys_descent
= it
->descent
;
27048 it
->pixel_width
= font
->space_width
;
27051 if (it
->constrain_row_ascent_descent_p
)
27053 if (it
->descent
> it
->max_descent
)
27055 it
->ascent
+= it
->descent
- it
->max_descent
;
27056 it
->descent
= it
->max_descent
;
27058 if (it
->ascent
> it
->max_ascent
)
27060 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
27061 it
->ascent
= it
->max_ascent
;
27063 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
27064 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
27065 extra_line_spacing
= 0;
27068 /* If this is a space inside a region of text with
27069 `space-width' property, change its width. */
27071 = it
->char_to_display
== ' ' && !NILP (it
->space_width
);
27073 it
->pixel_width
*= XFLOATINT (it
->space_width
);
27075 /* If face has a box, add the box thickness to the character
27076 height. If character has a box line to the left and/or
27077 right, add the box line width to the character's width. */
27078 if (face
->box
!= FACE_NO_BOX
)
27080 int thick
= face
->box_line_width
;
27084 it
->ascent
+= thick
;
27085 it
->descent
+= thick
;
27090 if (it
->start_of_box_run_p
)
27091 it
->pixel_width
+= thick
;
27092 if (it
->end_of_box_run_p
)
27093 it
->pixel_width
+= thick
;
27096 /* If face has an overline, add the height of the overline
27097 (1 pixel) and a 1 pixel margin to the character height. */
27098 if (face
->overline_p
)
27099 it
->ascent
+= overline_margin
;
27101 if (it
->constrain_row_ascent_descent_p
)
27103 if (it
->ascent
> it
->max_ascent
)
27104 it
->ascent
= it
->max_ascent
;
27105 if (it
->descent
> it
->max_descent
)
27106 it
->descent
= it
->max_descent
;
27109 take_vertical_position_into_account (it
);
27111 /* If we have to actually produce glyphs, do it. */
27116 /* Translate a space with a `space-width' property
27117 into a stretch glyph. */
27118 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
27119 / FONT_HEIGHT (font
));
27120 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
27121 it
->ascent
+ it
->descent
, ascent
);
27126 /* If characters with lbearing or rbearing are displayed
27127 in this line, record that fact in a flag of the
27128 glyph row. This is used to optimize X output code. */
27129 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
27130 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27132 if (! stretched_p
&& it
->pixel_width
== 0)
27133 /* We assure that all visible glyphs have at least 1-pixel
27135 it
->pixel_width
= 1;
27137 else if (it
->char_to_display
== '\n')
27139 /* A newline has no width, but we need the height of the
27140 line. But if previous part of the line sets a height,
27141 don't increase that height. */
27143 Lisp_Object height
;
27144 Lisp_Object total_height
= Qnil
;
27146 it
->override_ascent
= -1;
27147 it
->pixel_width
= 0;
27150 height
= get_it_property (it
, Qline_height
);
27151 /* Split (line-height total-height) list. */
27153 && CONSP (XCDR (height
))
27154 && NILP (XCDR (XCDR (height
))))
27156 total_height
= XCAR (XCDR (height
));
27157 height
= XCAR (height
);
27159 height
= calc_line_height_property (it
, height
, font
, boff
, true);
27161 if (it
->override_ascent
>= 0)
27163 it
->ascent
= it
->override_ascent
;
27164 it
->descent
= it
->override_descent
;
27165 boff
= it
->override_boff
;
27169 if (FONT_TOO_HIGH (font
))
27171 it
->ascent
= font
->pixel_size
+ boff
- 1;
27172 it
->descent
= -boff
+ 1;
27173 if (it
->descent
< 0)
27178 it
->ascent
= FONT_BASE (font
) + boff
;
27179 it
->descent
= FONT_DESCENT (font
) - boff
;
27183 if (EQ (height
, Qt
))
27185 if (it
->descent
> it
->max_descent
)
27187 it
->ascent
+= it
->descent
- it
->max_descent
;
27188 it
->descent
= it
->max_descent
;
27190 if (it
->ascent
> it
->max_ascent
)
27192 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
27193 it
->ascent
= it
->max_ascent
;
27195 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
27196 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
27197 it
->constrain_row_ascent_descent_p
= true;
27198 extra_line_spacing
= 0;
27202 Lisp_Object spacing
;
27204 it
->phys_ascent
= it
->ascent
;
27205 it
->phys_descent
= it
->descent
;
27207 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
27208 && face
->box
!= FACE_NO_BOX
27209 && face
->box_line_width
> 0)
27211 it
->ascent
+= face
->box_line_width
;
27212 it
->descent
+= face
->box_line_width
;
27215 && XINT (height
) > it
->ascent
+ it
->descent
)
27216 it
->ascent
= XINT (height
) - it
->descent
;
27218 if (!NILP (total_height
))
27219 spacing
= calc_line_height_property (it
, total_height
, font
,
27223 spacing
= get_it_property (it
, Qline_spacing
);
27224 spacing
= calc_line_height_property (it
, spacing
, font
,
27227 if (INTEGERP (spacing
))
27229 extra_line_spacing
= XINT (spacing
);
27230 if (!NILP (total_height
))
27231 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
27235 else /* i.e. (it->char_to_display == '\t') */
27237 if (font
->space_width
> 0)
27239 int tab_width
= it
->tab_width
* font
->space_width
;
27240 int x
= it
->current_x
+ it
->continuation_lines_width
;
27241 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
27243 /* If the distance from the current position to the next tab
27244 stop is less than a space character width, use the
27245 tab stop after that. */
27246 if (next_tab_x
- x
< font
->space_width
)
27247 next_tab_x
+= tab_width
;
27249 it
->pixel_width
= next_tab_x
- x
;
27251 if (FONT_TOO_HIGH (font
))
27253 if (get_char_glyph_code (' ', font
, &char2b
))
27255 pcm
= get_per_char_metric (font
, &char2b
);
27256 if (pcm
->width
== 0
27257 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
27263 it
->ascent
= pcm
->ascent
+ boff
;
27264 it
->descent
= pcm
->descent
- boff
;
27268 it
->ascent
= font
->pixel_size
+ boff
- 1;
27269 it
->descent
= -boff
+ 1;
27271 if (it
->ascent
< 0)
27273 if (it
->descent
< 0)
27278 it
->ascent
= FONT_BASE (font
) + boff
;
27279 it
->descent
= FONT_DESCENT (font
) - boff
;
27281 it
->phys_ascent
= it
->ascent
;
27282 it
->phys_descent
= it
->descent
;
27286 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
27287 it
->ascent
+ it
->descent
, it
->ascent
);
27292 it
->pixel_width
= 0;
27297 if (FONT_TOO_HIGH (font
))
27299 int font_ascent
, font_descent
;
27301 /* For very large fonts, where we ignore the declared font
27302 dimensions, and go by per-character metrics instead,
27303 don't let the row ascent and descent values (and the row
27304 height computed from them) be smaller than the "normal"
27305 character metrics. This avoids unpleasant effects
27306 whereby lines on display would change their height
27307 depending on which characters are shown. */
27308 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
27309 it
->max_ascent
= max (it
->max_ascent
, font_ascent
);
27310 it
->max_descent
= max (it
->max_descent
, font_descent
);
27313 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
27315 /* A static composition.
27317 Note: A composition is represented as one glyph in the
27318 glyph matrix. There are no padding glyphs.
27320 Important note: pixel_width, ascent, and descent are the
27321 values of what is drawn by draw_glyphs (i.e. the values of
27322 the overall glyphs composed). */
27323 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27324 int boff
; /* baseline offset */
27325 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
27326 int glyph_len
= cmp
->glyph_len
;
27327 struct font
*font
= face
->font
;
27331 /* If we have not yet calculated pixel size data of glyphs of
27332 the composition for the current face font, calculate them
27333 now. Theoretically, we have to check all fonts for the
27334 glyphs, but that requires much time and memory space. So,
27335 here we check only the font of the first glyph. This may
27336 lead to incorrect display, but it's very rare, and C-l
27337 (recenter-top-bottom) can correct the display anyway. */
27338 if (! cmp
->font
|| cmp
->font
!= font
)
27340 /* Ascent and descent of the font of the first character
27341 of this composition (adjusted by baseline offset).
27342 Ascent and descent of overall glyphs should not be less
27343 than these, respectively. */
27344 int font_ascent
, font_descent
, font_height
;
27345 /* Bounding box of the overall glyphs. */
27346 int leftmost
, rightmost
, lowest
, highest
;
27347 int lbearing
, rbearing
;
27348 int i
, width
, ascent
, descent
;
27351 struct font_metrics
*pcm
;
27354 eassume (0 < glyph_len
); /* See Bug#8512. */
27356 c
= COMPOSITION_GLYPH (cmp
, --glyph_len
);
27357 while (c
== '\t' && 0 < glyph_len
);
27359 bool right_padded
= glyph_len
< cmp
->glyph_len
;
27360 for (i
= 0; i
< glyph_len
; i
++)
27362 c
= COMPOSITION_GLYPH (cmp
, i
);
27365 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
27367 bool left_padded
= i
> 0;
27369 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
27370 : IT_CHARPOS (*it
));
27371 /* If no suitable font is found, use the default font. */
27372 bool font_not_found_p
= font
== NULL
;
27373 if (font_not_found_p
)
27375 face
= face
->ascii_face
;
27378 boff
= font
->baseline_offset
;
27379 if (font
->vertical_centering
)
27380 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
27381 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
27382 font_ascent
+= boff
;
27383 font_descent
-= boff
;
27384 font_height
= font_ascent
+ font_descent
;
27389 if (! font_not_found_p
)
27391 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
27393 pcm
= get_per_char_metric (font
, &char2b
);
27396 /* Initialize the bounding box. */
27399 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
27400 ascent
= pcm
->ascent
;
27401 descent
= pcm
->descent
;
27402 lbearing
= pcm
->lbearing
;
27403 rbearing
= pcm
->rbearing
;
27407 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
27408 ascent
= FONT_BASE (font
);
27409 descent
= FONT_DESCENT (font
);
27416 lowest
= - descent
+ boff
;
27417 highest
= ascent
+ boff
;
27419 if (! font_not_found_p
27420 && font
->default_ascent
27421 && CHAR_TABLE_P (Vuse_default_ascent
)
27422 && !NILP (Faref (Vuse_default_ascent
,
27423 make_number (it
->char_to_display
))))
27424 highest
= font
->default_ascent
+ boff
;
27426 /* Draw the first glyph at the normal position. It may be
27427 shifted to right later if some other glyphs are drawn
27429 cmp
->offsets
[i
* 2] = 0;
27430 cmp
->offsets
[i
* 2 + 1] = boff
;
27431 cmp
->lbearing
= lbearing
;
27432 cmp
->rbearing
= rbearing
;
27434 /* Set cmp->offsets for the remaining glyphs. */
27435 for (i
++; i
< glyph_len
; i
++)
27437 int left
, right
, btm
, top
;
27438 int ch
= COMPOSITION_GLYPH (cmp
, i
);
27440 struct face
*this_face
;
27444 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
27445 this_face
= FACE_FROM_ID (it
->f
, face_id
);
27446 font
= this_face
->font
;
27452 get_char_face_and_encoding (it
->f
, ch
, face_id
,
27454 pcm
= get_per_char_metric (font
, &char2b
);
27457 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
27460 width
= pcm
->width
;
27461 ascent
= pcm
->ascent
;
27462 descent
= pcm
->descent
;
27463 lbearing
= pcm
->lbearing
;
27464 rbearing
= pcm
->rbearing
;
27465 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
27467 /* Relative composition with or without
27468 alternate chars. */
27469 left
= (leftmost
+ rightmost
- width
) / 2;
27470 btm
= - descent
+ boff
;
27471 if (font
->relative_compose
27472 && (! CHAR_TABLE_P (Vignore_relative_composition
)
27473 || NILP (Faref (Vignore_relative_composition
,
27474 make_number (ch
)))))
27477 if (- descent
>= font
->relative_compose
)
27478 /* One extra pixel between two glyphs. */
27480 else if (ascent
<= 0)
27481 /* One extra pixel between two glyphs. */
27482 btm
= lowest
- 1 - ascent
- descent
;
27487 /* A composition rule is specified by an integer
27488 value that encodes global and new reference
27489 points (GREF and NREF). GREF and NREF are
27490 specified by numbers as below:
27492 0---1---2 -- ascent
27496 9--10--11 -- center
27498 ---3---4---5--- baseline
27500 6---7---8 -- descent
27502 int rule
= COMPOSITION_RULE (cmp
, i
);
27503 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
27505 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
27506 grefx
= gref
% 3, nrefx
= nref
% 3;
27507 grefy
= gref
/ 3, nrefy
= nref
/ 3;
27509 xoff
= font_height
* (xoff
- 128) / 256;
27511 yoff
= font_height
* (yoff
- 128) / 256;
27514 + grefx
* (rightmost
- leftmost
) / 2
27515 - nrefx
* width
/ 2
27518 btm
= ((grefy
== 0 ? highest
27520 : grefy
== 2 ? lowest
27521 : (highest
+ lowest
) / 2)
27522 - (nrefy
== 0 ? ascent
+ descent
27523 : nrefy
== 1 ? descent
- boff
27525 : (ascent
+ descent
) / 2)
27529 cmp
->offsets
[i
* 2] = left
;
27530 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
27532 /* Update the bounding box of the overall glyphs. */
27535 right
= left
+ width
;
27536 if (left
< leftmost
)
27538 if (right
> rightmost
)
27541 top
= btm
+ descent
+ ascent
;
27547 if (cmp
->lbearing
> left
+ lbearing
)
27548 cmp
->lbearing
= left
+ lbearing
;
27549 if (cmp
->rbearing
< left
+ rbearing
)
27550 cmp
->rbearing
= left
+ rbearing
;
27554 /* If there are glyphs whose x-offsets are negative,
27555 shift all glyphs to the right and make all x-offsets
27559 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27560 cmp
->offsets
[i
* 2] -= leftmost
;
27561 rightmost
-= leftmost
;
27562 cmp
->lbearing
-= leftmost
;
27563 cmp
->rbearing
-= leftmost
;
27566 if (left_padded
&& cmp
->lbearing
< 0)
27568 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27569 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
27570 rightmost
-= cmp
->lbearing
;
27571 cmp
->rbearing
-= cmp
->lbearing
;
27574 if (right_padded
&& rightmost
< cmp
->rbearing
)
27576 rightmost
= cmp
->rbearing
;
27579 cmp
->pixel_width
= rightmost
;
27580 cmp
->ascent
= highest
;
27581 cmp
->descent
= - lowest
;
27582 if (cmp
->ascent
< font_ascent
)
27583 cmp
->ascent
= font_ascent
;
27584 if (cmp
->descent
< font_descent
)
27585 cmp
->descent
= font_descent
;
27589 && (cmp
->lbearing
< 0
27590 || cmp
->rbearing
> cmp
->pixel_width
))
27591 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27593 it
->pixel_width
= cmp
->pixel_width
;
27594 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
27595 it
->descent
= it
->phys_descent
= cmp
->descent
;
27596 if (face
->box
!= FACE_NO_BOX
)
27598 int thick
= face
->box_line_width
;
27602 it
->ascent
+= thick
;
27603 it
->descent
+= thick
;
27608 if (it
->start_of_box_run_p
)
27609 it
->pixel_width
+= thick
;
27610 if (it
->end_of_box_run_p
)
27611 it
->pixel_width
+= thick
;
27614 /* If face has an overline, add the height of the overline
27615 (1 pixel) and a 1 pixel margin to the character height. */
27616 if (face
->overline_p
)
27617 it
->ascent
+= overline_margin
;
27619 take_vertical_position_into_account (it
);
27620 if (it
->ascent
< 0)
27622 if (it
->descent
< 0)
27625 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
27626 append_composite_glyph (it
);
27628 else if (it
->what
== IT_COMPOSITION
)
27630 /* A dynamic (automatic) composition. */
27631 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27632 Lisp_Object gstring
;
27633 struct font_metrics metrics
;
27637 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
27639 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
27642 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
27643 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27644 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
27645 it
->descent
= it
->phys_descent
= metrics
.descent
;
27646 if (face
->box
!= FACE_NO_BOX
)
27648 int thick
= face
->box_line_width
;
27652 it
->ascent
+= thick
;
27653 it
->descent
+= thick
;
27658 if (it
->start_of_box_run_p
)
27659 it
->pixel_width
+= thick
;
27660 if (it
->end_of_box_run_p
)
27661 it
->pixel_width
+= thick
;
27663 /* If face has an overline, add the height of the overline
27664 (1 pixel) and a 1 pixel margin to the character height. */
27665 if (face
->overline_p
)
27666 it
->ascent
+= overline_margin
;
27667 take_vertical_position_into_account (it
);
27668 if (it
->ascent
< 0)
27670 if (it
->descent
< 0)
27674 append_composite_glyph (it
);
27676 else if (it
->what
== IT_GLYPHLESS
)
27677 produce_glyphless_glyph (it
, false, Qnil
);
27678 else if (it
->what
== IT_IMAGE
)
27679 produce_image_glyph (it
);
27680 else if (it
->what
== IT_STRETCH
)
27681 produce_stretch_glyph (it
);
27682 else if (it
->what
== IT_XWIDGET
)
27683 produce_xwidget_glyph (it
);
27686 /* Accumulate dimensions. Note: can't assume that it->descent > 0
27687 because this isn't true for images with `:ascent 100'. */
27688 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
27689 if (it
->area
== TEXT_AREA
)
27690 it
->current_x
+= it
->pixel_width
;
27692 if (extra_line_spacing
> 0)
27694 it
->descent
+= extra_line_spacing
;
27695 if (extra_line_spacing
> it
->max_extra_line_spacing
)
27696 it
->max_extra_line_spacing
= extra_line_spacing
;
27699 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
27700 it
->max_descent
= max (it
->max_descent
, it
->descent
);
27701 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
27702 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
27706 Output LEN glyphs starting at START at the nominal cursor position.
27707 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
27708 being updated, and UPDATED_AREA is the area of that row being updated. */
27711 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27712 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27714 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
27716 eassert (updated_row
);
27717 /* When the window is hscrolled, cursor hpos can legitimately be out
27718 of bounds, but we draw the cursor at the corresponding window
27719 margin in that case. */
27720 if (!updated_row
->reversed_p
&& chpos
< 0)
27722 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
27723 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
27727 /* Write glyphs. */
27729 hpos
= start
- updated_row
->glyphs
[updated_area
];
27730 x
= draw_glyphs (w
, w
->output_cursor
.x
,
27731 updated_row
, updated_area
,
27733 DRAW_NORMAL_TEXT
, 0);
27735 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
27736 if (updated_area
== TEXT_AREA
27737 && w
->phys_cursor_on_p
27738 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
27740 && chpos
< hpos
+ len
)
27741 w
->phys_cursor_on_p
= false;
27745 /* Advance the output cursor. */
27746 w
->output_cursor
.hpos
+= len
;
27747 w
->output_cursor
.x
= x
;
27752 Insert LEN glyphs from START at the nominal cursor position. */
27755 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27756 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27759 int line_height
, shift_by_width
, shifted_region_width
;
27760 struct glyph_row
*row
;
27761 struct glyph
*glyph
;
27762 int frame_x
, frame_y
;
27765 eassert (updated_row
);
27767 f
= XFRAME (WINDOW_FRAME (w
));
27769 /* Get the height of the line we are in. */
27771 line_height
= row
->height
;
27773 /* Get the width of the glyphs to insert. */
27774 shift_by_width
= 0;
27775 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
27776 shift_by_width
+= glyph
->pixel_width
;
27778 /* Get the width of the region to shift right. */
27779 shifted_region_width
= (window_box_width (w
, updated_area
)
27780 - w
->output_cursor
.x
27784 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
27785 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
27787 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
27788 line_height
, shift_by_width
);
27790 /* Write the glyphs. */
27791 hpos
= start
- row
->glyphs
[updated_area
];
27792 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
27794 DRAW_NORMAL_TEXT
, 0);
27796 /* Advance the output cursor. */
27797 w
->output_cursor
.hpos
+= len
;
27798 w
->output_cursor
.x
+= shift_by_width
;
27804 Erase the current text line from the nominal cursor position
27805 (inclusive) to pixel column TO_X (exclusive). The idea is that
27806 everything from TO_X onward is already erased.
27808 TO_X is a pixel position relative to UPDATED_AREA of currently
27809 updated window W. TO_X == -1 means clear to the end of this area. */
27812 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
27813 enum glyph_row_area updated_area
, int to_x
)
27816 int max_x
, min_y
, max_y
;
27817 int from_x
, from_y
, to_y
;
27819 eassert (updated_row
);
27820 f
= XFRAME (w
->frame
);
27822 if (updated_row
->full_width_p
)
27823 max_x
= (WINDOW_PIXEL_WIDTH (w
)
27824 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
27826 max_x
= window_box_width (w
, updated_area
);
27827 max_y
= window_text_bottom_y (w
);
27829 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
27830 of window. For TO_X > 0, truncate to end of drawing area. */
27836 to_x
= min (to_x
, max_x
);
27838 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
27840 /* Notice if the cursor will be cleared by this operation. */
27841 if (!updated_row
->full_width_p
)
27842 notice_overwritten_cursor (w
, updated_area
,
27843 w
->output_cursor
.x
, -1,
27845 MATRIX_ROW_BOTTOM_Y (updated_row
));
27847 from_x
= w
->output_cursor
.x
;
27849 /* Translate to frame coordinates. */
27850 if (updated_row
->full_width_p
)
27852 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
27853 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
27857 int area_left
= window_box_left (w
, updated_area
);
27858 from_x
+= area_left
;
27862 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
27863 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
27864 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
27866 /* Prevent inadvertently clearing to end of the X window. */
27867 if (to_x
> from_x
&& to_y
> from_y
)
27870 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
27871 to_x
- from_x
, to_y
- from_y
);
27876 #endif /* HAVE_WINDOW_SYSTEM */
27880 /***********************************************************************
27882 ***********************************************************************/
27884 /* Value is the internal representation of the specified cursor type
27885 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27886 of the bar cursor. */
27888 static enum text_cursor_kinds
27889 get_specified_cursor_type (Lisp_Object arg
, int *width
)
27891 enum text_cursor_kinds type
;
27896 if (EQ (arg
, Qbox
))
27897 return FILLED_BOX_CURSOR
;
27899 if (EQ (arg
, Qhollow
))
27900 return HOLLOW_BOX_CURSOR
;
27902 if (EQ (arg
, Qbar
))
27909 && EQ (XCAR (arg
), Qbar
)
27910 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27912 *width
= XINT (XCDR (arg
));
27916 if (EQ (arg
, Qhbar
))
27919 return HBAR_CURSOR
;
27923 && EQ (XCAR (arg
), Qhbar
)
27924 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27926 *width
= XINT (XCDR (arg
));
27927 return HBAR_CURSOR
;
27930 /* Treat anything unknown as "hollow box cursor".
27931 It was bad to signal an error; people have trouble fixing
27932 .Xdefaults with Emacs, when it has something bad in it. */
27933 type
= HOLLOW_BOX_CURSOR
;
27938 /* Set the default cursor types for specified frame. */
27940 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27945 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27946 FRAME_CURSOR_WIDTH (f
) = width
;
27948 /* By default, set up the blink-off state depending on the on-state. */
27950 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27953 FRAME_BLINK_OFF_CURSOR (f
)
27954 = get_specified_cursor_type (XCDR (tem
), &width
);
27955 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27958 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27960 /* Make sure the cursor gets redrawn. */
27961 f
->cursor_type_changed
= true;
27965 #ifdef HAVE_WINDOW_SYSTEM
27967 /* Return the cursor we want to be displayed in window W. Return
27968 width of bar/hbar cursor through WIDTH arg. Return with
27969 ACTIVE_CURSOR arg set to true if cursor in window W is `active'
27970 (i.e. if the `system caret' should track this cursor).
27972 In a mini-buffer window, we want the cursor only to appear if we
27973 are reading input from this window. For the selected window, we
27974 want the cursor type given by the frame parameter or buffer local
27975 setting of cursor-type. If explicitly marked off, draw no cursor.
27976 In all other cases, we want a hollow box cursor. */
27978 static enum text_cursor_kinds
27979 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27980 bool *active_cursor
)
27982 struct frame
*f
= XFRAME (w
->frame
);
27983 struct buffer
*b
= XBUFFER (w
->contents
);
27984 int cursor_type
= DEFAULT_CURSOR
;
27985 Lisp_Object alt_cursor
;
27986 bool non_selected
= false;
27988 *active_cursor
= true;
27991 if (cursor_in_echo_area
27992 && FRAME_HAS_MINIBUF_P (f
)
27993 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27995 if (w
== XWINDOW (echo_area_window
))
27997 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27999 *width
= FRAME_CURSOR_WIDTH (f
);
28000 return FRAME_DESIRED_CURSOR (f
);
28003 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
28006 *active_cursor
= false;
28007 non_selected
= true;
28010 /* Detect a nonselected window or nonselected frame. */
28011 else if (w
!= XWINDOW (f
->selected_window
)
28012 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
28014 *active_cursor
= false;
28016 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
28019 non_selected
= true;
28022 /* Never display a cursor in a window in which cursor-type is nil. */
28023 if (NILP (BVAR (b
, cursor_type
)))
28026 /* Get the normal cursor type for this window. */
28027 if (EQ (BVAR (b
, cursor_type
), Qt
))
28029 cursor_type
= FRAME_DESIRED_CURSOR (f
);
28030 *width
= FRAME_CURSOR_WIDTH (f
);
28033 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
28035 /* Use cursor-in-non-selected-windows instead
28036 for non-selected window or frame. */
28039 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
28040 if (!EQ (Qt
, alt_cursor
))
28041 return get_specified_cursor_type (alt_cursor
, width
);
28042 /* t means modify the normal cursor type. */
28043 if (cursor_type
== FILLED_BOX_CURSOR
)
28044 cursor_type
= HOLLOW_BOX_CURSOR
;
28045 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
28047 return cursor_type
;
28050 /* Use normal cursor if not blinked off. */
28051 if (!w
->cursor_off_p
)
28053 if (glyph
!= NULL
&& glyph
->type
== XWIDGET_GLYPH
)
28055 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
28057 if (cursor_type
== FILLED_BOX_CURSOR
)
28059 /* Using a block cursor on large images can be very annoying.
28060 So use a hollow cursor for "large" images.
28061 If image is not transparent (no mask), also use hollow cursor. */
28062 struct image
*img
= IMAGE_OPT_FROM_ID (f
, glyph
->u
.img_id
);
28063 if (img
!= NULL
&& IMAGEP (img
->spec
))
28065 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
28066 where N = size of default frame font size.
28067 This should cover most of the "tiny" icons people may use. */
28069 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
28070 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
28071 cursor_type
= HOLLOW_BOX_CURSOR
;
28074 else if (cursor_type
!= NO_CURSOR
)
28076 /* Display current only supports BOX and HOLLOW cursors for images.
28077 So for now, unconditionally use a HOLLOW cursor when cursor is
28078 not a solid box cursor. */
28079 cursor_type
= HOLLOW_BOX_CURSOR
;
28082 return cursor_type
;
28085 /* Cursor is blinked off, so determine how to "toggle" it. */
28087 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
28088 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
28089 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
28091 /* Then see if frame has specified a specific blink off cursor type. */
28092 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
28094 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
28095 return FRAME_BLINK_OFF_CURSOR (f
);
28099 /* Some people liked having a permanently visible blinking cursor,
28100 while others had very strong opinions against it. So it was
28101 decided to remove it. KFS 2003-09-03 */
28103 /* Finally perform built-in cursor blinking:
28104 filled box <-> hollow box
28105 wide [h]bar <-> narrow [h]bar
28106 narrow [h]bar <-> no cursor
28107 other type <-> no cursor */
28109 if (cursor_type
== FILLED_BOX_CURSOR
)
28110 return HOLLOW_BOX_CURSOR
;
28112 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
28115 return cursor_type
;
28123 /* Notice when the text cursor of window W has been completely
28124 overwritten by a drawing operation that outputs glyphs in AREA
28125 starting at X0 and ending at X1 in the line starting at Y0 and
28126 ending at Y1. X coordinates are area-relative. X1 < 0 means all
28127 the rest of the line after X0 has been written. Y coordinates
28128 are window-relative. */
28131 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
28132 int x0
, int x1
, int y0
, int y1
)
28134 int cx0
, cx1
, cy0
, cy1
;
28135 struct glyph_row
*row
;
28137 if (!w
->phys_cursor_on_p
)
28139 if (area
!= TEXT_AREA
)
28142 if (w
->phys_cursor
.vpos
< 0
28143 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
28144 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
28145 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
28148 if (row
->cursor_in_fringe_p
)
28150 row
->cursor_in_fringe_p
= false;
28151 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
28152 w
->phys_cursor_on_p
= false;
28156 cx0
= w
->phys_cursor
.x
;
28157 cx1
= cx0
+ w
->phys_cursor_width
;
28158 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
28161 /* The cursor image will be completely removed from the
28162 screen if the output area intersects the cursor area in
28163 y-direction. When we draw in [y0 y1[, and some part of
28164 the cursor is at y < y0, that part must have been drawn
28165 before. When scrolling, the cursor is erased before
28166 actually scrolling, so we don't come here. When not
28167 scrolling, the rows above the old cursor row must have
28168 changed, and in this case these rows must have written
28169 over the cursor image.
28171 Likewise if part of the cursor is below y1, with the
28172 exception of the cursor being in the first blank row at
28173 the buffer and window end because update_text_area
28174 doesn't draw that row. (Except when it does, but
28175 that's handled in update_text_area.) */
28177 cy0
= w
->phys_cursor
.y
;
28178 cy1
= cy0
+ w
->phys_cursor_height
;
28179 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
28182 w
->phys_cursor_on_p
= false;
28185 #endif /* HAVE_WINDOW_SYSTEM */
28188 /************************************************************************
28190 ************************************************************************/
28192 #ifdef HAVE_WINDOW_SYSTEM
28195 Fix the display of area AREA of overlapping row ROW in window W
28196 with respect to the overlapping part OVERLAPS. */
28199 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
28200 enum glyph_row_area area
, int overlaps
)
28207 for (i
= 0; i
< row
->used
[area
];)
28209 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
28211 int start
= i
, start_x
= x
;
28215 x
+= row
->glyphs
[area
][i
].pixel_width
;
28218 while (i
< row
->used
[area
]
28219 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
28221 draw_glyphs (w
, start_x
, row
, area
,
28223 DRAW_NORMAL_TEXT
, overlaps
);
28227 x
+= row
->glyphs
[area
][i
].pixel_width
;
28237 Draw the cursor glyph of window W in glyph row ROW. See the
28238 comment of draw_glyphs for the meaning of HL. */
28241 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
28242 enum draw_glyphs_face hl
)
28244 /* If cursor hpos is out of bounds, don't draw garbage. This can
28245 happen in mini-buffer windows when switching between echo area
28246 glyphs and mini-buffer. */
28247 if ((row
->reversed_p
28248 ? (w
->phys_cursor
.hpos
>= 0)
28249 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
28251 bool on_p
= w
->phys_cursor_on_p
;
28253 int hpos
= w
->phys_cursor
.hpos
;
28255 /* When the window is hscrolled, cursor hpos can legitimately be
28256 out of bounds, but we draw the cursor at the corresponding
28257 window margin in that case. */
28258 if (!row
->reversed_p
&& hpos
< 0)
28260 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28261 hpos
= row
->used
[TEXT_AREA
] - 1;
28263 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
28265 w
->phys_cursor_on_p
= on_p
;
28267 if (hl
== DRAW_CURSOR
)
28268 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
28269 /* When we erase the cursor, and ROW is overlapped by other
28270 rows, make sure that these overlapping parts of other rows
28272 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
28274 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
28276 if (row
> w
->current_matrix
->rows
28277 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
28278 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
28279 OVERLAPS_ERASED_CURSOR
);
28281 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
28282 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
28283 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
28284 OVERLAPS_ERASED_CURSOR
);
28290 /* Erase the image of a cursor of window W from the screen. */
28293 erase_phys_cursor (struct window
*w
)
28295 struct frame
*f
= XFRAME (w
->frame
);
28296 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28297 int hpos
= w
->phys_cursor
.hpos
;
28298 int vpos
= w
->phys_cursor
.vpos
;
28299 bool mouse_face_here_p
= false;
28300 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
28301 struct glyph_row
*cursor_row
;
28302 struct glyph
*cursor_glyph
;
28303 enum draw_glyphs_face hl
;
28305 /* No cursor displayed or row invalidated => nothing to do on the
28307 if (w
->phys_cursor_type
== NO_CURSOR
)
28308 goto mark_cursor_off
;
28310 /* VPOS >= active_glyphs->nrows means that window has been resized.
28311 Don't bother to erase the cursor. */
28312 if (vpos
>= active_glyphs
->nrows
)
28313 goto mark_cursor_off
;
28315 /* If row containing cursor is marked invalid, there is nothing we
28317 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
28318 if (!cursor_row
->enabled_p
)
28319 goto mark_cursor_off
;
28321 /* If line spacing is > 0, old cursor may only be partially visible in
28322 window after split-window. So adjust visible height. */
28323 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
28324 window_text_bottom_y (w
) - cursor_row
->y
);
28326 /* If row is completely invisible, don't attempt to delete a cursor which
28327 isn't there. This can happen if cursor is at top of a window, and
28328 we switch to a buffer with a header line in that window. */
28329 if (cursor_row
->visible_height
<= 0)
28330 goto mark_cursor_off
;
28332 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
28333 if (cursor_row
->cursor_in_fringe_p
)
28335 cursor_row
->cursor_in_fringe_p
= false;
28336 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
28337 goto mark_cursor_off
;
28340 /* This can happen when the new row is shorter than the old one.
28341 In this case, either draw_glyphs or clear_end_of_line
28342 should have cleared the cursor. Note that we wouldn't be
28343 able to erase the cursor in this case because we don't have a
28344 cursor glyph at hand. */
28345 if ((cursor_row
->reversed_p
28346 ? (w
->phys_cursor
.hpos
< 0)
28347 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
28348 goto mark_cursor_off
;
28350 /* When the window is hscrolled, cursor hpos can legitimately be out
28351 of bounds, but we draw the cursor at the corresponding window
28352 margin in that case. */
28353 if (!cursor_row
->reversed_p
&& hpos
< 0)
28355 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
28356 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
28358 /* If the cursor is in the mouse face area, redisplay that when
28359 we clear the cursor. */
28360 if (! NILP (hlinfo
->mouse_face_window
)
28361 && coords_in_mouse_face_p (w
, hpos
, vpos
)
28362 /* Don't redraw the cursor's spot in mouse face if it is at the
28363 end of a line (on a newline). The cursor appears there, but
28364 mouse highlighting does not. */
28365 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
28366 mouse_face_here_p
= true;
28368 /* Maybe clear the display under the cursor. */
28369 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
28372 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
28375 cursor_glyph
= get_phys_cursor_glyph (w
);
28376 if (cursor_glyph
== NULL
)
28377 goto mark_cursor_off
;
28379 width
= cursor_glyph
->pixel_width
;
28380 x
= w
->phys_cursor
.x
;
28386 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
28387 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
28388 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
28391 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
28394 /* Erase the cursor by redrawing the character underneath it. */
28395 if (mouse_face_here_p
)
28396 hl
= DRAW_MOUSE_FACE
;
28398 hl
= DRAW_NORMAL_TEXT
;
28399 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
28402 w
->phys_cursor_on_p
= false;
28403 w
->phys_cursor_type
= NO_CURSOR
;
28407 /* Display or clear cursor of window W. If !ON, clear the cursor.
28408 If ON, display the cursor; where to put the cursor is specified by
28409 HPOS, VPOS, X and Y. */
28412 display_and_set_cursor (struct window
*w
, bool on
,
28413 int hpos
, int vpos
, int x
, int y
)
28415 struct frame
*f
= XFRAME (w
->frame
);
28416 int new_cursor_type
;
28417 int new_cursor_width
;
28418 bool active_cursor
;
28419 struct glyph_row
*glyph_row
;
28420 struct glyph
*glyph
;
28422 /* This is pointless on invisible frames, and dangerous on garbaged
28423 windows and frames; in the latter case, the frame or window may
28424 be in the midst of changing its size, and x and y may be off the
28426 if (! FRAME_VISIBLE_P (f
)
28427 || FRAME_GARBAGED_P (f
)
28428 || vpos
>= w
->current_matrix
->nrows
28429 || hpos
>= w
->current_matrix
->matrix_w
)
28432 /* If cursor is off and we want it off, return quickly. */
28433 if (!on
&& !w
->phys_cursor_on_p
)
28436 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28437 /* If cursor row is not enabled, we don't really know where to
28438 display the cursor. */
28439 if (!glyph_row
->enabled_p
)
28441 w
->phys_cursor_on_p
= false;
28446 if (!glyph_row
->exact_window_width_line_p
28447 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
28448 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
28450 eassert (input_blocked_p ());
28452 /* Set new_cursor_type to the cursor we want to be displayed. */
28453 new_cursor_type
= get_window_cursor_type (w
, glyph
,
28454 &new_cursor_width
, &active_cursor
);
28456 /* If cursor is currently being shown and we don't want it to be or
28457 it is in the wrong place, or the cursor type is not what we want,
28459 if (w
->phys_cursor_on_p
28461 || w
->phys_cursor
.x
!= x
28462 || w
->phys_cursor
.y
!= y
28463 /* HPOS can be negative in R2L rows whose
28464 exact_window_width_line_p flag is set (i.e. their newline
28465 would "overflow into the fringe"). */
28467 || new_cursor_type
!= w
->phys_cursor_type
28468 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
28469 && new_cursor_width
!= w
->phys_cursor_width
)))
28470 erase_phys_cursor (w
);
28472 /* Don't check phys_cursor_on_p here because that flag is only set
28473 to false in some cases where we know that the cursor has been
28474 completely erased, to avoid the extra work of erasing the cursor
28475 twice. In other words, phys_cursor_on_p can be true and the cursor
28476 still not be visible, or it has only been partly erased. */
28479 w
->phys_cursor_ascent
= glyph_row
->ascent
;
28480 w
->phys_cursor_height
= glyph_row
->height
;
28482 /* Set phys_cursor_.* before x_draw_.* is called because some
28483 of them may need the information. */
28484 w
->phys_cursor
.x
= x
;
28485 w
->phys_cursor
.y
= glyph_row
->y
;
28486 w
->phys_cursor
.hpos
= hpos
;
28487 w
->phys_cursor
.vpos
= vpos
;
28490 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
28491 new_cursor_type
, new_cursor_width
,
28492 on
, active_cursor
);
28496 /* Switch the display of W's cursor on or off, according to the value
28500 update_window_cursor (struct window
*w
, bool on
)
28502 /* Don't update cursor in windows whose frame is in the process
28503 of being deleted. */
28504 if (w
->current_matrix
)
28506 int hpos
= w
->phys_cursor
.hpos
;
28507 int vpos
= w
->phys_cursor
.vpos
;
28508 struct glyph_row
*row
;
28510 if (vpos
>= w
->current_matrix
->nrows
28511 || hpos
>= w
->current_matrix
->matrix_w
)
28514 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28516 /* When the window is hscrolled, cursor hpos can legitimately be
28517 out of bounds, but we draw the cursor at the corresponding
28518 window margin in that case. */
28519 if (!row
->reversed_p
&& hpos
< 0)
28521 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28522 hpos
= row
->used
[TEXT_AREA
] - 1;
28525 display_and_set_cursor (w
, on
, hpos
, vpos
,
28526 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28532 /* Call update_window_cursor with parameter ON_P on all leaf windows
28533 in the window tree rooted at W. */
28536 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
28540 if (WINDOWP (w
->contents
))
28541 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
28543 update_window_cursor (w
, on_p
);
28545 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
28551 Display the cursor on window W, or clear it, according to ON_P.
28552 Don't change the cursor's position. */
28555 x_update_cursor (struct frame
*f
, bool on_p
)
28557 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
28562 Clear the cursor of window W to background color, and mark the
28563 cursor as not shown. This is used when the text where the cursor
28564 is about to be rewritten. */
28567 x_clear_cursor (struct window
*w
)
28569 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
28570 update_window_cursor (w
, false);
28573 #endif /* HAVE_WINDOW_SYSTEM */
28575 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
28578 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
28579 int start_hpos
, int end_hpos
,
28580 enum draw_glyphs_face draw
)
28582 #ifdef HAVE_WINDOW_SYSTEM
28583 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
28585 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
28589 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
28590 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
28594 /* Display the active region described by mouse_face_* according to DRAW. */
28597 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
28599 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
28600 #ifdef HAVE_WINDOW_SYSTEM
28601 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28603 (void) XFRAME (WINDOW_FRAME (w
));
28606 if (/* If window is in the process of being destroyed, don't bother
28608 w
->current_matrix
!= NULL
28609 /* Don't update mouse highlight if hidden. */
28610 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
28611 /* Recognize when we are called to operate on rows that don't exist
28612 anymore. This can happen when a window is split. */
28613 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
28615 #ifdef HAVE_WINDOW_SYSTEM
28616 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
28618 struct glyph_row
*row
, *first
, *last
;
28620 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
28621 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
28623 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
28625 int start_hpos
, end_hpos
, start_x
;
28627 /* For all but the first row, the highlight starts at column 0. */
28630 /* R2L rows have BEG and END in reversed order, but the
28631 screen drawing geometry is always left to right. So
28632 we need to mirror the beginning and end of the
28633 highlighted area in R2L rows. */
28634 if (!row
->reversed_p
)
28636 start_hpos
= hlinfo
->mouse_face_beg_col
;
28637 start_x
= hlinfo
->mouse_face_beg_x
;
28639 else if (row
== last
)
28641 start_hpos
= hlinfo
->mouse_face_end_col
;
28642 start_x
= hlinfo
->mouse_face_end_x
;
28650 else if (row
->reversed_p
&& row
== last
)
28652 start_hpos
= hlinfo
->mouse_face_end_col
;
28653 start_x
= hlinfo
->mouse_face_end_x
;
28663 if (!row
->reversed_p
)
28664 end_hpos
= hlinfo
->mouse_face_end_col
;
28665 else if (row
== first
)
28666 end_hpos
= hlinfo
->mouse_face_beg_col
;
28669 end_hpos
= row
->used
[TEXT_AREA
];
28670 if (draw
== DRAW_NORMAL_TEXT
)
28671 row
->fill_line_p
= true; /* Clear to end of line. */
28674 else if (row
->reversed_p
&& row
== first
)
28675 end_hpos
= hlinfo
->mouse_face_beg_col
;
28678 end_hpos
= row
->used
[TEXT_AREA
];
28679 if (draw
== DRAW_NORMAL_TEXT
)
28680 row
->fill_line_p
= true; /* Clear to end of line. */
28683 if (end_hpos
> start_hpos
)
28685 draw_row_with_mouse_face (w
, start_x
, row
,
28686 start_hpos
, end_hpos
, draw
);
28689 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
28693 #ifdef HAVE_WINDOW_SYSTEM
28694 /* When we've written over the cursor, arrange for it to
28695 be displayed again. */
28696 if (FRAME_WINDOW_P (f
)
28697 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
28699 int hpos
= w
->phys_cursor
.hpos
;
28701 /* When the window is hscrolled, cursor hpos can legitimately be
28702 out of bounds, but we draw the cursor at the corresponding
28703 window margin in that case. */
28704 if (!row
->reversed_p
&& hpos
< 0)
28706 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28707 hpos
= row
->used
[TEXT_AREA
] - 1;
28710 display_and_set_cursor (w
, true, hpos
, w
->phys_cursor
.vpos
,
28711 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28714 #endif /* HAVE_WINDOW_SYSTEM */
28717 #ifdef HAVE_WINDOW_SYSTEM
28718 /* Change the mouse cursor. */
28719 if (FRAME_WINDOW_P (f
) && NILP (do_mouse_tracking
))
28721 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
28722 if (draw
== DRAW_NORMAL_TEXT
28723 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
28724 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
28727 if (draw
== DRAW_MOUSE_FACE
)
28728 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
28730 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
28732 #endif /* HAVE_WINDOW_SYSTEM */
28736 Clear out the mouse-highlighted active region.
28737 Redraw it un-highlighted first. Value is true if mouse
28738 face was actually drawn unhighlighted. */
28741 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
28744 = !hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
);
28746 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
28747 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28748 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28749 hlinfo
->mouse_face_window
= Qnil
;
28750 hlinfo
->mouse_face_overlay
= Qnil
;
28754 /* Return true if the coordinates HPOS and VPOS on windows W are
28755 within the mouse face on that window. */
28757 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
28759 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28761 /* Quickly resolve the easy cases. */
28762 if (!(WINDOWP (hlinfo
->mouse_face_window
)
28763 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
28765 if (vpos
< hlinfo
->mouse_face_beg_row
28766 || vpos
> hlinfo
->mouse_face_end_row
)
28768 if (vpos
> hlinfo
->mouse_face_beg_row
28769 && vpos
< hlinfo
->mouse_face_end_row
)
28772 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
28774 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28776 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
28779 else if ((vpos
== hlinfo
->mouse_face_beg_row
28780 && hpos
>= hlinfo
->mouse_face_beg_col
)
28781 || (vpos
== hlinfo
->mouse_face_end_row
28782 && hpos
< hlinfo
->mouse_face_end_col
))
28787 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28789 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
28792 else if ((vpos
== hlinfo
->mouse_face_beg_row
28793 && hpos
<= hlinfo
->mouse_face_beg_col
)
28794 || (vpos
== hlinfo
->mouse_face_end_row
28795 && hpos
> hlinfo
->mouse_face_end_col
))
28803 True if physical cursor of window W is within mouse face. */
28806 cursor_in_mouse_face_p (struct window
*w
)
28808 int hpos
= w
->phys_cursor
.hpos
;
28809 int vpos
= w
->phys_cursor
.vpos
;
28810 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28812 /* When the window is hscrolled, cursor hpos can legitimately be out
28813 of bounds, but we draw the cursor at the corresponding window
28814 margin in that case. */
28815 if (!row
->reversed_p
&& hpos
< 0)
28817 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28818 hpos
= row
->used
[TEXT_AREA
] - 1;
28820 return coords_in_mouse_face_p (w
, hpos
, vpos
);
28825 /* Find the glyph rows START_ROW and END_ROW of window W that display
28826 characters between buffer positions START_CHARPOS and END_CHARPOS
28827 (excluding END_CHARPOS). DISP_STRING is a display string that
28828 covers these buffer positions. This is similar to
28829 row_containing_pos, but is more accurate when bidi reordering makes
28830 buffer positions change non-linearly with glyph rows. */
28832 rows_from_pos_range (struct window
*w
,
28833 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
28834 Lisp_Object disp_string
,
28835 struct glyph_row
**start
, struct glyph_row
**end
)
28837 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28838 int last_y
= window_text_bottom_y (w
);
28839 struct glyph_row
*row
;
28844 while (!first
->enabled_p
28845 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
28848 /* Find the START row. */
28850 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
28853 /* A row can potentially be the START row if the range of the
28854 characters it displays intersects the range
28855 [START_CHARPOS..END_CHARPOS). */
28856 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
28857 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
28858 /* See the commentary in row_containing_pos, for the
28859 explanation of the complicated way to check whether
28860 some position is beyond the end of the characters
28861 displayed by a row. */
28862 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28863 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28864 && !row
->ends_at_zv_p
28865 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
28866 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28867 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28868 && !row
->ends_at_zv_p
28869 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
28871 /* Found a candidate row. Now make sure at least one of the
28872 glyphs it displays has a charpos from the range
28873 [START_CHARPOS..END_CHARPOS).
28875 This is not obvious because bidi reordering could make
28876 buffer positions of a row be 1,2,3,102,101,100, and if we
28877 want to highlight characters in [50..60), we don't want
28878 this row, even though [50..60) does intersect [1..103),
28879 the range of character positions given by the row's start
28880 and end positions. */
28881 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
28882 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
28886 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28887 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28888 /* A glyph that comes from DISP_STRING is by
28889 definition to be highlighted. */
28890 || EQ (g
->object
, disp_string
))
28899 /* Find the END row. */
28901 /* If the last row is partially visible, start looking for END
28902 from that row, instead of starting from FIRST. */
28903 && !(row
->enabled_p
28904 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
28906 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
28908 struct glyph_row
*next
= row
+ 1;
28909 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
28911 if (!next
->enabled_p
28912 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
28913 /* The first row >= START whose range of displayed characters
28914 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28915 is the row END + 1. */
28916 || (start_charpos
< next_start
28917 && end_charpos
< next_start
)
28918 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28919 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28920 && !next
->ends_at_zv_p
28921 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28922 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28923 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28924 && !next
->ends_at_zv_p
28925 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28932 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28933 but none of the characters it displays are in the range, it is
28935 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28936 struct glyph
*s
= g
;
28937 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28941 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28942 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28943 /* If the buffer position of the first glyph in
28944 the row is equal to END_CHARPOS, it means
28945 the last character to be highlighted is the
28946 newline of ROW, and we must consider NEXT as
28948 || (((!next
->reversed_p
&& g
== s
)
28949 || (next
->reversed_p
&& g
== e
- 1))
28950 && (g
->charpos
== end_charpos
28951 /* Special case for when NEXT is an
28952 empty line at ZV. */
28953 || (g
->charpos
== -1
28954 && !row
->ends_at_zv_p
28955 && next_start
== end_charpos
)))))
28956 /* A glyph that comes from DISP_STRING is by
28957 definition to be highlighted. */
28958 || EQ (g
->object
, disp_string
))
28967 /* The first row that ends at ZV must be the last to be
28969 else if (next
->ends_at_zv_p
)
28978 /* This function sets the mouse_face_* elements of HLINFO, assuming
28979 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28980 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28981 for the overlay or run of text properties specifying the mouse
28982 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28983 before-string and after-string that must also be highlighted.
28984 DISP_STRING, if non-nil, is a display string that may cover some
28985 or all of the highlighted text. */
28988 mouse_face_from_buffer_pos (Lisp_Object window
,
28989 Mouse_HLInfo
*hlinfo
,
28990 ptrdiff_t mouse_charpos
,
28991 ptrdiff_t start_charpos
,
28992 ptrdiff_t end_charpos
,
28993 Lisp_Object before_string
,
28994 Lisp_Object after_string
,
28995 Lisp_Object disp_string
)
28997 struct window
*w
= XWINDOW (window
);
28998 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28999 struct glyph_row
*r1
, *r2
;
29000 struct glyph
*glyph
, *end
;
29001 ptrdiff_t ignore
, pos
;
29004 eassert (NILP (disp_string
) || STRINGP (disp_string
));
29005 eassert (NILP (before_string
) || STRINGP (before_string
));
29006 eassert (NILP (after_string
) || STRINGP (after_string
));
29008 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
29009 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
29011 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
29012 /* If the before-string or display-string contains newlines,
29013 rows_from_pos_range skips to its last row. Move back. */
29014 if (!NILP (before_string
) || !NILP (disp_string
))
29016 struct glyph_row
*prev
;
29017 while ((prev
= r1
- 1, prev
>= first
)
29018 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
29019 && prev
->used
[TEXT_AREA
] > 0)
29021 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
29022 glyph
= beg
+ prev
->used
[TEXT_AREA
];
29023 while (--glyph
>= beg
&& NILP (glyph
->object
));
29025 || !(EQ (glyph
->object
, before_string
)
29026 || EQ (glyph
->object
, disp_string
)))
29033 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
29034 hlinfo
->mouse_face_past_end
= true;
29036 else if (!NILP (after_string
))
29038 /* If the after-string has newlines, advance to its last row. */
29039 struct glyph_row
*next
;
29040 struct glyph_row
*last
29041 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
29043 for (next
= r2
+ 1;
29045 && next
->used
[TEXT_AREA
] > 0
29046 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
29050 /* The rest of the display engine assumes that mouse_face_beg_row is
29051 either above mouse_face_end_row or identical to it. But with
29052 bidi-reordered continued lines, the row for START_CHARPOS could
29053 be below the row for END_CHARPOS. If so, swap the rows and store
29054 them in correct order. */
29057 struct glyph_row
*tem
= r2
;
29063 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
29064 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
29066 /* For a bidi-reordered row, the positions of BEFORE_STRING,
29067 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
29068 could be anywhere in the row and in any order. The strategy
29069 below is to find the leftmost and the rightmost glyph that
29070 belongs to either of these 3 strings, or whose position is
29071 between START_CHARPOS and END_CHARPOS, and highlight all the
29072 glyphs between those two. This may cover more than just the text
29073 between START_CHARPOS and END_CHARPOS if the range of characters
29074 strides the bidi level boundary, e.g. if the beginning is in R2L
29075 text while the end is in L2R text or vice versa. */
29076 if (!r1
->reversed_p
)
29078 /* This row is in a left to right paragraph. Scan it left to
29080 glyph
= r1
->glyphs
[TEXT_AREA
];
29081 end
= glyph
+ r1
->used
[TEXT_AREA
];
29084 /* Skip truncation glyphs at the start of the glyph row. */
29085 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
29087 && NILP (glyph
->object
)
29088 && glyph
->charpos
< 0;
29090 x
+= glyph
->pixel_width
;
29092 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
29093 or DISP_STRING, and the first glyph from buffer whose
29094 position is between START_CHARPOS and END_CHARPOS. */
29096 && !NILP (glyph
->object
)
29097 && !EQ (glyph
->object
, disp_string
)
29098 && !(BUFFERP (glyph
->object
)
29099 && (glyph
->charpos
>= start_charpos
29100 && glyph
->charpos
< end_charpos
));
29103 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29104 are present at buffer positions between START_CHARPOS and
29105 END_CHARPOS, or if they come from an overlay. */
29106 if (EQ (glyph
->object
, before_string
))
29108 pos
= string_buffer_position (before_string
,
29110 /* If pos == 0, it means before_string came from an
29111 overlay, not from a buffer position. */
29112 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29115 else if (EQ (glyph
->object
, after_string
))
29117 pos
= string_buffer_position (after_string
, end_charpos
);
29118 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29121 x
+= glyph
->pixel_width
;
29123 hlinfo
->mouse_face_beg_x
= x
;
29124 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
29128 /* This row is in a right to left paragraph. Scan it right to
29132 end
= r1
->glyphs
[TEXT_AREA
] - 1;
29133 glyph
= end
+ r1
->used
[TEXT_AREA
];
29135 /* Skip truncation glyphs at the start of the glyph row. */
29136 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
29138 && NILP (glyph
->object
)
29139 && glyph
->charpos
< 0;
29143 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
29144 or DISP_STRING, and the first glyph from buffer whose
29145 position is between START_CHARPOS and END_CHARPOS. */
29147 && !NILP (glyph
->object
)
29148 && !EQ (glyph
->object
, disp_string
)
29149 && !(BUFFERP (glyph
->object
)
29150 && (glyph
->charpos
>= start_charpos
29151 && glyph
->charpos
< end_charpos
));
29154 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29155 are present at buffer positions between START_CHARPOS and
29156 END_CHARPOS, or if they come from an overlay. */
29157 if (EQ (glyph
->object
, before_string
))
29159 pos
= string_buffer_position (before_string
, start_charpos
);
29160 /* If pos == 0, it means before_string came from an
29161 overlay, not from a buffer position. */
29162 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29165 else if (EQ (glyph
->object
, after_string
))
29167 pos
= string_buffer_position (after_string
, end_charpos
);
29168 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29173 glyph
++; /* first glyph to the right of the highlighted area */
29174 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
29175 x
+= g
->pixel_width
;
29176 hlinfo
->mouse_face_beg_x
= x
;
29177 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
29180 /* If the highlight ends in a different row, compute GLYPH and END
29181 for the end row. Otherwise, reuse the values computed above for
29182 the row where the highlight begins. */
29185 if (!r2
->reversed_p
)
29187 glyph
= r2
->glyphs
[TEXT_AREA
];
29188 end
= glyph
+ r2
->used
[TEXT_AREA
];
29193 end
= r2
->glyphs
[TEXT_AREA
] - 1;
29194 glyph
= end
+ r2
->used
[TEXT_AREA
];
29198 if (!r2
->reversed_p
)
29200 /* Skip truncation and continuation glyphs near the end of the
29201 row, and also blanks and stretch glyphs inserted by
29202 extend_face_to_end_of_line. */
29204 && NILP ((end
- 1)->object
))
29206 /* Scan the rest of the glyph row from the end, looking for the
29207 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
29208 DISP_STRING, or whose position is between START_CHARPOS
29212 && !NILP (end
->object
)
29213 && !EQ (end
->object
, disp_string
)
29214 && !(BUFFERP (end
->object
)
29215 && (end
->charpos
>= start_charpos
29216 && end
->charpos
< end_charpos
));
29219 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29220 are present at buffer positions between START_CHARPOS and
29221 END_CHARPOS, or if they come from an overlay. */
29222 if (EQ (end
->object
, before_string
))
29224 pos
= string_buffer_position (before_string
, start_charpos
);
29225 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29228 else if (EQ (end
->object
, after_string
))
29230 pos
= string_buffer_position (after_string
, end_charpos
);
29231 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29235 /* Find the X coordinate of the last glyph to be highlighted. */
29236 for (; glyph
<= end
; ++glyph
)
29237 x
+= glyph
->pixel_width
;
29239 hlinfo
->mouse_face_end_x
= x
;
29240 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
29244 /* Skip truncation and continuation glyphs near the end of the
29245 row, and also blanks and stretch glyphs inserted by
29246 extend_face_to_end_of_line. */
29250 && NILP (end
->object
))
29252 x
+= end
->pixel_width
;
29255 /* Scan the rest of the glyph row from the end, looking for the
29256 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
29257 DISP_STRING, or whose position is between START_CHARPOS
29261 && !NILP (end
->object
)
29262 && !EQ (end
->object
, disp_string
)
29263 && !(BUFFERP (end
->object
)
29264 && (end
->charpos
>= start_charpos
29265 && end
->charpos
< end_charpos
));
29268 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29269 are present at buffer positions between START_CHARPOS and
29270 END_CHARPOS, or if they come from an overlay. */
29271 if (EQ (end
->object
, before_string
))
29273 pos
= string_buffer_position (before_string
, start_charpos
);
29274 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29277 else if (EQ (end
->object
, after_string
))
29279 pos
= string_buffer_position (after_string
, end_charpos
);
29280 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29283 x
+= end
->pixel_width
;
29285 /* If we exited the above loop because we arrived at the last
29286 glyph of the row, and its buffer position is still not in
29287 range, it means the last character in range is the preceding
29288 newline. Bump the end column and x values to get past the
29291 && BUFFERP (end
->object
)
29292 && (end
->charpos
< start_charpos
29293 || end
->charpos
>= end_charpos
))
29295 x
+= end
->pixel_width
;
29298 hlinfo
->mouse_face_end_x
= x
;
29299 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
29302 hlinfo
->mouse_face_window
= window
;
29303 hlinfo
->mouse_face_face_id
29304 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
29306 !hlinfo
->mouse_face_hidden
, -1);
29307 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29310 /* The following function is not used anymore (replaced with
29311 mouse_face_from_string_pos), but I leave it here for the time
29312 being, in case someone would. */
29314 #if false /* not used */
29316 /* Find the position of the glyph for position POS in OBJECT in
29317 window W's current matrix, and return in *X, *Y the pixel
29318 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
29320 RIGHT_P means return the position of the right edge of the glyph.
29321 !RIGHT_P means return the left edge position.
29323 If no glyph for POS exists in the matrix, return the position of
29324 the glyph with the next smaller position that is in the matrix, if
29325 RIGHT_P is false. If RIGHT_P, and no glyph for POS
29326 exists in the matrix, return the position of the glyph with the
29327 next larger position in OBJECT.
29329 Value is true if a glyph was found. */
29332 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
29333 int *hpos
, int *vpos
, int *x
, int *y
, bool right_p
)
29335 int yb
= window_text_bottom_y (w
);
29336 struct glyph_row
*r
;
29337 struct glyph
*best_glyph
= NULL
;
29338 struct glyph_row
*best_row
= NULL
;
29341 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
29342 r
->enabled_p
&& r
->y
< yb
;
29345 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
29346 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
29349 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
29350 if (EQ (g
->object
, object
))
29352 if (g
->charpos
== pos
)
29359 else if (best_glyph
== NULL
29360 || ((eabs (g
->charpos
- pos
)
29361 < eabs (best_glyph
->charpos
- pos
))
29364 : g
->charpos
> pos
)))
29378 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
29382 *x
+= best_glyph
->pixel_width
;
29387 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
29390 return best_glyph
!= NULL
;
29392 #endif /* not used */
29394 /* Find the positions of the first and the last glyphs in window W's
29395 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
29396 (assumed to be a string), and return in HLINFO's mouse_face_*
29397 members the pixel and column/row coordinates of those glyphs. */
29400 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
29401 Lisp_Object object
,
29402 ptrdiff_t startpos
, ptrdiff_t endpos
)
29404 int yb
= window_text_bottom_y (w
);
29405 struct glyph_row
*r
;
29406 struct glyph
*g
, *e
;
29408 bool found
= false;
29410 /* Find the glyph row with at least one position in the range
29411 [STARTPOS..ENDPOS), and the first glyph in that row whose
29412 position belongs to that range. */
29413 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
29414 r
->enabled_p
&& r
->y
< yb
;
29417 if (!r
->reversed_p
)
29419 g
= r
->glyphs
[TEXT_AREA
];
29420 e
= g
+ r
->used
[TEXT_AREA
];
29421 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
29422 if (EQ (g
->object
, object
)
29423 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29425 hlinfo
->mouse_face_beg_row
29426 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29427 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29428 hlinfo
->mouse_face_beg_x
= gx
;
29437 e
= r
->glyphs
[TEXT_AREA
];
29438 g
= e
+ r
->used
[TEXT_AREA
];
29439 for ( ; g
> e
; --g
)
29440 if (EQ ((g
-1)->object
, object
)
29441 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
29443 hlinfo
->mouse_face_beg_row
29444 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29445 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29446 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
29447 gx
+= g1
->pixel_width
;
29448 hlinfo
->mouse_face_beg_x
= gx
;
29460 /* Starting with the next row, look for the first row which does NOT
29461 include any glyphs whose positions are in the range. */
29462 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
29464 g
= r
->glyphs
[TEXT_AREA
];
29465 e
= g
+ r
->used
[TEXT_AREA
];
29467 for ( ; g
< e
; ++g
)
29468 if (EQ (g
->object
, object
)
29469 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29478 /* The highlighted region ends on the previous row. */
29481 /* Set the end row. */
29482 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29484 /* Compute and set the end column and the end column's horizontal
29485 pixel coordinate. */
29486 if (!r
->reversed_p
)
29488 g
= r
->glyphs
[TEXT_AREA
];
29489 e
= g
+ r
->used
[TEXT_AREA
];
29490 for ( ; e
> g
; --e
)
29491 if (EQ ((e
-1)->object
, object
)
29492 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
29494 hlinfo
->mouse_face_end_col
= e
- g
;
29496 for (gx
= r
->x
; g
< e
; ++g
)
29497 gx
+= g
->pixel_width
;
29498 hlinfo
->mouse_face_end_x
= gx
;
29502 e
= r
->glyphs
[TEXT_AREA
];
29503 g
= e
+ r
->used
[TEXT_AREA
];
29504 for (gx
= r
->x
; e
< g
; ++e
)
29506 if (EQ (e
->object
, object
)
29507 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
29509 gx
+= e
->pixel_width
;
29511 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
29512 hlinfo
->mouse_face_end_x
= gx
;
29516 #ifdef HAVE_WINDOW_SYSTEM
29518 /* See if position X, Y is within a hot-spot of an image. */
29521 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
29523 if (!CONSP (hot_spot
))
29526 if (EQ (XCAR (hot_spot
), Qrect
))
29528 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
29529 Lisp_Object rect
= XCDR (hot_spot
);
29533 if (!CONSP (XCAR (rect
)))
29535 if (!CONSP (XCDR (rect
)))
29537 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
29539 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
29541 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
29543 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
29547 else if (EQ (XCAR (hot_spot
), Qcircle
))
29549 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
29550 Lisp_Object circ
= XCDR (hot_spot
);
29551 Lisp_Object lr
, lx0
, ly0
;
29553 && CONSP (XCAR (circ
))
29554 && (lr
= XCDR (circ
), NUMBERP (lr
))
29555 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
29556 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
29558 double r
= XFLOATINT (lr
);
29559 double dx
= XINT (lx0
) - x
;
29560 double dy
= XINT (ly0
) - y
;
29561 return (dx
* dx
+ dy
* dy
<= r
* r
);
29564 else if (EQ (XCAR (hot_spot
), Qpoly
))
29566 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
29567 if (VECTORP (XCDR (hot_spot
)))
29569 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
29570 Lisp_Object
*poly
= v
->contents
;
29571 ptrdiff_t n
= v
->header
.size
;
29573 bool inside
= false;
29574 Lisp_Object lx
, ly
;
29577 /* Need an even number of coordinates, and at least 3 edges. */
29578 if (n
< 6 || n
& 1)
29581 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
29582 If count is odd, we are inside polygon. Pixels on edges
29583 may or may not be included depending on actual geometry of the
29585 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
29586 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
29588 x0
= XINT (lx
), y0
= XINT (ly
);
29589 for (i
= 0; i
< n
; i
+= 2)
29591 int x1
= x0
, y1
= y0
;
29592 if ((lx
= poly
[i
], !INTEGERP (lx
))
29593 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
29595 x0
= XINT (lx
), y0
= XINT (ly
);
29597 /* Does this segment cross the X line? */
29605 if (y
> y0
&& y
> y1
)
29607 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
29617 find_hot_spot (Lisp_Object map
, int x
, int y
)
29619 while (CONSP (map
))
29621 if (CONSP (XCAR (map
))
29622 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
29630 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
29632 doc
: /* Lookup in image map MAP coordinates X and Y.
29633 An image map is an alist where each element has the format (AREA ID PLIST).
29634 An AREA is specified as either a rectangle, a circle, or a polygon:
29635 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
29636 pixel coordinates of the upper left and bottom right corners.
29637 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
29638 and the radius of the circle; r may be a float or integer.
29639 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
29640 vector describes one corner in the polygon.
29641 Returns the alist element for the first matching AREA in MAP. */)
29642 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
29650 return find_hot_spot (map
,
29651 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
29652 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
29656 /* Display frame CURSOR, optionally using shape defined by POINTER. */
29658 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
29660 /* Do not change cursor shape while dragging mouse. */
29661 if (EQ (do_mouse_tracking
, Qdragging
))
29664 if (!NILP (pointer
))
29666 if (EQ (pointer
, Qarrow
))
29667 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29668 else if (EQ (pointer
, Qhand
))
29669 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
29670 else if (EQ (pointer
, Qtext
))
29671 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29672 else if (EQ (pointer
, intern ("hdrag")))
29673 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29674 else if (EQ (pointer
, intern ("nhdrag")))
29675 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29676 #ifdef HAVE_X_WINDOWS
29677 else if (EQ (pointer
, intern ("vdrag")))
29678 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29680 else if (EQ (pointer
, intern ("hourglass")))
29681 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
29682 else if (EQ (pointer
, Qmodeline
))
29683 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
29685 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29688 if (cursor
!= No_Cursor
)
29689 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
29692 #endif /* HAVE_WINDOW_SYSTEM */
29694 /* Take proper action when mouse has moved to the mode or header line
29695 or marginal area AREA of window W, x-position X and y-position Y.
29696 X is relative to the start of the text display area of W, so the
29697 width of bitmap areas and scroll bars must be subtracted to get a
29698 position relative to the start of the mode line. */
29701 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
29702 enum window_part area
)
29704 struct window
*w
= XWINDOW (window
);
29705 struct frame
*f
= XFRAME (w
->frame
);
29706 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29707 #ifdef HAVE_WINDOW_SYSTEM
29708 Display_Info
*dpyinfo
;
29709 Cursor cursor
= No_Cursor
;
29710 Lisp_Object pointer
= Qnil
;
29712 int dx
, dy
, width
, height
;
29714 Lisp_Object string
, object
= Qnil
;
29715 Lisp_Object pos UNINIT
;
29716 Lisp_Object mouse_face
;
29717 int original_x_pixel
= x
;
29718 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
29719 struct glyph_row
*row UNINIT
;
29721 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
29726 /* Kludge alert: mode_line_string takes X/Y in pixels, but
29727 returns them in row/column units! */
29728 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
29729 &object
, &dx
, &dy
, &width
, &height
);
29731 row
= (area
== ON_MODE_LINE
29732 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
29733 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
29735 /* Find the glyph under the mouse pointer. */
29736 if (row
->mode_line_p
&& row
->enabled_p
)
29738 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
29739 end
= glyph
+ row
->used
[TEXT_AREA
];
29741 for (x0
= original_x_pixel
;
29742 glyph
< end
&& x0
>= glyph
->pixel_width
;
29744 x0
-= glyph
->pixel_width
;
29752 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
29753 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
29754 returns them in row/column units! */
29755 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
29756 &object
, &dx
, &dy
, &width
, &height
);
29759 Lisp_Object help
= Qnil
;
29761 #ifdef HAVE_WINDOW_SYSTEM
29762 if (IMAGEP (object
))
29764 Lisp_Object image_map
, hotspot
;
29765 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
29767 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
29769 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29773 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
29774 If so, we could look for mouse-enter, mouse-leave
29775 properties in PLIST (and do something...). */
29776 hotspot
= XCDR (hotspot
);
29777 if (CONSP (hotspot
)
29778 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29780 pointer
= Fplist_get (plist
, Qpointer
);
29781 if (NILP (pointer
))
29783 help
= Fplist_get (plist
, Qhelp_echo
);
29786 help_echo_string
= help
;
29787 XSETWINDOW (help_echo_window
, w
);
29788 help_echo_object
= w
->contents
;
29789 help_echo_pos
= charpos
;
29793 if (NILP (pointer
))
29794 pointer
= Fplist_get (XCDR (object
), QCpointer
);
29796 #endif /* HAVE_WINDOW_SYSTEM */
29798 if (STRINGP (string
))
29799 pos
= make_number (charpos
);
29801 /* Set the help text and mouse pointer. If the mouse is on a part
29802 of the mode line without any text (e.g. past the right edge of
29803 the mode line text), use the default help text and pointer. */
29804 if (STRINGP (string
) || area
== ON_MODE_LINE
)
29806 /* Arrange to display the help by setting the global variables
29807 help_echo_string, help_echo_object, and help_echo_pos. */
29810 if (STRINGP (string
))
29811 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
29815 help_echo_string
= help
;
29816 XSETWINDOW (help_echo_window
, w
);
29817 help_echo_object
= string
;
29818 help_echo_pos
= charpos
;
29820 else if (area
== ON_MODE_LINE
)
29822 Lisp_Object default_help
29823 = buffer_local_value (Qmode_line_default_help_echo
,
29826 if (STRINGP (default_help
))
29828 help_echo_string
= default_help
;
29829 XSETWINDOW (help_echo_window
, w
);
29830 help_echo_object
= Qnil
;
29831 help_echo_pos
= -1;
29836 #ifdef HAVE_WINDOW_SYSTEM
29837 /* Change the mouse pointer according to what is under it. */
29838 if (FRAME_WINDOW_P (f
))
29840 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
29842 || NILP (Vresize_mini_windows
));
29844 dpyinfo
= FRAME_DISPLAY_INFO (f
);
29845 if (STRINGP (string
))
29847 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29849 if (NILP (pointer
))
29850 pointer
= Fget_text_property (pos
, Qpointer
, string
);
29852 /* Change the mouse pointer according to what is under X/Y. */
29854 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
29857 map
= Fget_text_property (pos
, Qlocal_map
, string
);
29858 if (!KEYMAPP (map
))
29859 map
= Fget_text_property (pos
, Qkeymap
, string
);
29860 if (!KEYMAPP (map
) && draggable
)
29861 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
29864 else if (draggable
)
29865 /* Default mode-line pointer. */
29866 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29871 /* Change the mouse face according to what is under X/Y. */
29872 bool mouse_face_shown
= false;
29873 if (STRINGP (string
))
29875 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
29876 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
29877 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29882 struct glyph
* tmp_glyph
;
29886 int total_pixel_width
;
29887 ptrdiff_t begpos
, endpos
, ignore
;
29891 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
29892 Qmouse_face
, string
, Qnil
);
29898 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
29900 endpos
= SCHARS (string
);
29904 /* Calculate the glyph position GPOS of GLYPH in the
29905 displayed string, relative to the beginning of the
29906 highlighted part of the string.
29908 Note: GPOS is different from CHARPOS. CHARPOS is the
29909 position of GLYPH in the internal string object. A mode
29910 line string format has structures which are converted to
29911 a flattened string by the Emacs Lisp interpreter. The
29912 internal string is an element of those structures. The
29913 displayed string is the flattened string. */
29914 tmp_glyph
= row_start_glyph
;
29915 while (tmp_glyph
< glyph
29916 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29917 && begpos
<= tmp_glyph
->charpos
29918 && tmp_glyph
->charpos
< endpos
)))
29920 gpos
= glyph
- tmp_glyph
;
29922 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29923 the highlighted part of the displayed string to which
29924 GLYPH belongs. Note: GSEQ_LENGTH is different from
29925 SCHARS (STRING), because the latter returns the length of
29926 the internal string. */
29927 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29929 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29930 && begpos
<= tmp_glyph
->charpos
29931 && tmp_glyph
->charpos
< endpos
));
29934 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29936 /* Calculate the total pixel width of all the glyphs between
29937 the beginning of the highlighted area and GLYPH. */
29938 total_pixel_width
= 0;
29939 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29940 total_pixel_width
+= tmp_glyph
->pixel_width
;
29942 /* Pre calculation of re-rendering position. Note: X is in
29943 column units here, after the call to mode_line_string or
29944 marginal_area_string. */
29946 vpos
= (area
== ON_MODE_LINE
29947 ? (w
->current_matrix
)->nrows
- 1
29950 /* If GLYPH's position is included in the region that is
29951 already drawn in mouse face, we have nothing to do. */
29952 if ( EQ (window
, hlinfo
->mouse_face_window
)
29953 && (!row
->reversed_p
29954 ? (hlinfo
->mouse_face_beg_col
<= hpos
29955 && hpos
< hlinfo
->mouse_face_end_col
)
29956 /* In R2L rows we swap BEG and END, see below. */
29957 : (hlinfo
->mouse_face_end_col
<= hpos
29958 && hpos
< hlinfo
->mouse_face_beg_col
))
29959 && hlinfo
->mouse_face_beg_row
== vpos
)
29962 #ifdef HAVE_WINDOW_SYSTEM
29963 if (clear_mouse_face (hlinfo
))
29964 cursor
= No_Cursor
;
29966 (void) clear_mouse_face (hlinfo
);
29969 if (!row
->reversed_p
)
29971 hlinfo
->mouse_face_beg_col
= hpos
;
29972 hlinfo
->mouse_face_beg_x
= original_x_pixel
29973 - (total_pixel_width
+ dx
);
29974 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29975 hlinfo
->mouse_face_end_x
= 0;
29979 /* In R2L rows, show_mouse_face expects BEG and END
29980 coordinates to be swapped. */
29981 hlinfo
->mouse_face_end_col
= hpos
;
29982 hlinfo
->mouse_face_end_x
= original_x_pixel
29983 - (total_pixel_width
+ dx
);
29984 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29985 hlinfo
->mouse_face_beg_x
= 0;
29988 hlinfo
->mouse_face_beg_row
= vpos
;
29989 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29990 hlinfo
->mouse_face_past_end
= false;
29991 hlinfo
->mouse_face_window
= window
;
29993 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29998 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29999 mouse_face_shown
= true;
30001 #ifdef HAVE_WINDOW_SYSTEM
30002 if (NILP (pointer
))
30008 /* If mouse-face doesn't need to be shown, clear any existing
30010 if ((area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
) && !mouse_face_shown
)
30011 clear_mouse_face (hlinfo
);
30013 #ifdef HAVE_WINDOW_SYSTEM
30014 if (FRAME_WINDOW_P (f
))
30015 define_frame_cursor1 (f
, cursor
, pointer
);
30021 Take proper action when the mouse has moved to position X, Y on
30022 frame F with regards to highlighting portions of display that have
30023 mouse-face properties. Also de-highlight portions of display where
30024 the mouse was before, set the mouse pointer shape as appropriate
30025 for the mouse coordinates, and activate help echo (tooltips).
30026 X and Y can be negative or out of range. */
30029 note_mouse_highlight (struct frame
*f
, int x
, int y
)
30031 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30032 enum window_part part
= ON_NOTHING
;
30033 Lisp_Object window
;
30035 #ifdef HAVE_WINDOW_SYSTEM
30036 Cursor cursor
= No_Cursor
;
30037 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
30041 /* When a menu is active, don't highlight because this looks odd. */
30042 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
30043 if (popup_activated ())
30047 if (!f
->glyphs_initialized_p
30048 || f
->pointer_invisible
)
30051 hlinfo
->mouse_face_mouse_x
= x
;
30052 hlinfo
->mouse_face_mouse_y
= y
;
30053 hlinfo
->mouse_face_mouse_frame
= f
;
30055 if (hlinfo
->mouse_face_defer
)
30058 /* Which window is that in? */
30059 window
= window_from_coordinates (f
, x
, y
, &part
, true);
30061 /* If displaying active text in another window, clear that. */
30062 if (! EQ (window
, hlinfo
->mouse_face_window
)
30063 /* Also clear if we move out of text area in same window. */
30064 || (!NILP (hlinfo
->mouse_face_window
)
30067 && part
!= ON_MODE_LINE
30068 && part
!= ON_HEADER_LINE
))
30069 clear_mouse_face (hlinfo
);
30071 /* Not on a window -> return. */
30072 if (!WINDOWP (window
))
30075 /* Reset help_echo_string. It will get recomputed below. */
30076 help_echo_string
= Qnil
;
30078 /* Convert to window-relative pixel coordinates. */
30079 w
= XWINDOW (window
);
30080 frame_to_window_pixel_xy (w
, &x
, &y
);
30082 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
30083 /* Handle tool-bar window differently since it doesn't display a
30085 if (EQ (window
, f
->tool_bar_window
))
30087 note_tool_bar_highlight (f
, x
, y
);
30092 /* Mouse is on the mode, header line or margin? */
30093 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
30094 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
30096 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
30098 #ifdef HAVE_WINDOW_SYSTEM
30099 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
30101 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30102 /* Show non-text cursor (Bug#16647). */
30110 #ifdef HAVE_WINDOW_SYSTEM
30111 if (part
== ON_VERTICAL_BORDER
)
30113 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
30114 help_echo_string
= build_string ("drag-mouse-1: resize");
30116 else if (part
== ON_RIGHT_DIVIDER
)
30118 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
30119 help_echo_string
= build_string ("drag-mouse-1: resize");
30121 else if (part
== ON_BOTTOM_DIVIDER
)
30122 if (! WINDOW_BOTTOMMOST_P (w
)
30124 || NILP (Vresize_mini_windows
))
30126 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
30127 help_echo_string
= build_string ("drag-mouse-1: resize");
30130 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30131 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
30132 || part
== ON_VERTICAL_SCROLL_BAR
30133 || part
== ON_HORIZONTAL_SCROLL_BAR
)
30134 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30136 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
30139 /* Are we in a window whose display is up to date?
30140 And verify the buffer's text has not changed. */
30141 b
= XBUFFER (w
->contents
);
30142 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
30144 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
30146 struct glyph
*glyph
;
30147 Lisp_Object object
;
30148 Lisp_Object mouse_face
= Qnil
, position
;
30149 Lisp_Object
*overlay_vec
= NULL
;
30150 ptrdiff_t i
, noverlays
;
30151 struct buffer
*obuf
;
30152 ptrdiff_t obegv
, ozv
;
30155 /* Find the glyph under X/Y. */
30156 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
30158 #ifdef HAVE_WINDOW_SYSTEM
30159 /* Look for :pointer property on image. */
30160 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
30162 struct image
*img
= IMAGE_OPT_FROM_ID (f
, glyph
->u
.img_id
);
30163 if (img
!= NULL
&& IMAGEP (img
->spec
))
30165 Lisp_Object image_map
, hotspot
;
30166 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
30168 && (hotspot
= find_hot_spot (image_map
,
30169 glyph
->slice
.img
.x
+ dx
,
30170 glyph
->slice
.img
.y
+ dy
),
30172 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
30176 /* Could check XCAR (hotspot) to see if we enter/leave
30178 If so, we could look for mouse-enter, mouse-leave
30179 properties in PLIST (and do something...). */
30180 hotspot
= XCDR (hotspot
);
30181 if (CONSP (hotspot
)
30182 && (plist
= XCAR (hotspot
), CONSP (plist
)))
30184 pointer
= Fplist_get (plist
, Qpointer
);
30185 if (NILP (pointer
))
30187 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
30188 if (!NILP (help_echo_string
))
30190 help_echo_window
= window
;
30191 help_echo_object
= glyph
->object
;
30192 help_echo_pos
= glyph
->charpos
;
30196 if (NILP (pointer
))
30197 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
30200 #endif /* HAVE_WINDOW_SYSTEM */
30202 /* Clear mouse face if X/Y not over text. */
30204 || area
!= TEXT_AREA
30205 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
30206 /* Glyph's OBJECT is nil for glyphs inserted by the
30207 display engine for its internal purposes, like truncation
30208 and continuation glyphs and blanks beyond the end of
30209 line's text on text terminals. If we are over such a
30210 glyph, we are not over any text. */
30211 || NILP (glyph
->object
)
30212 /* R2L rows have a stretch glyph at their front, which
30213 stands for no text, whereas L2R rows have no glyphs at
30214 all beyond the end of text. Treat such stretch glyphs
30215 like we do with NULL glyphs in L2R rows. */
30216 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
30217 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
30218 && glyph
->type
== STRETCH_GLYPH
30219 && glyph
->avoid_cursor_p
))
30221 #ifndef HAVE_WINDOW_SYSTEM
30222 (void) clear_mouse_face (hlinfo
);
30223 #else /* HAVE_WINDOW_SYSTEM */
30224 if (clear_mouse_face (hlinfo
))
30225 cursor
= No_Cursor
;
30226 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30228 if (area
!= TEXT_AREA
)
30229 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30231 pointer
= Vvoid_text_area_pointer
;
30233 #endif /* HAVE_WINDOW_SYSTEM */
30237 pos
= glyph
->charpos
;
30238 object
= glyph
->object
;
30239 if (!STRINGP (object
) && !BUFFERP (object
))
30242 /* If we get an out-of-range value, return now; avoid an error. */
30243 if (BUFFERP (object
) && pos
> BUF_Z (b
))
30246 /* Make the window's buffer temporarily current for
30247 overlays_at and compute_char_face. */
30248 obuf
= current_buffer
;
30249 current_buffer
= b
;
30255 /* Is this char mouse-active or does it have help-echo? */
30256 position
= make_number (pos
);
30260 if (BUFFERP (object
))
30262 /* Put all the overlays we want in a vector in overlay_vec. */
30263 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, false);
30264 /* Sort overlays into increasing priority order. */
30265 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
30270 if (NILP (Vmouse_highlight
))
30272 clear_mouse_face (hlinfo
);
30273 goto check_help_echo
;
30276 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
30278 #ifdef HAVE_WINDOW_SYSTEM
30280 cursor
= No_Cursor
;
30283 /* Check mouse-face highlighting. */
30285 /* If there exists an overlay with mouse-face overlapping
30286 the one we are currently highlighting, we have to
30287 check if we enter the overlapping overlay, and then
30288 highlight only that. */
30289 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
30290 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
30292 /* Find the highest priority overlay with a mouse-face. */
30293 Lisp_Object overlay
= Qnil
;
30294 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
30296 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
30297 if (!NILP (mouse_face
))
30298 overlay
= overlay_vec
[i
];
30301 /* If we're highlighting the same overlay as before, there's
30302 no need to do that again. */
30303 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
30304 goto check_help_echo
;
30305 hlinfo
->mouse_face_overlay
= overlay
;
30307 /* Clear the display of the old active region, if any. */
30308 #ifdef HAVE_WINDOW_SYSTEM
30309 if (clear_mouse_face (hlinfo
))
30310 cursor
= No_Cursor
;
30312 (void) clear_mouse_face (hlinfo
);
30315 /* If no overlay applies, get a text property. */
30316 if (NILP (overlay
))
30317 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
30319 /* Next, compute the bounds of the mouse highlighting and
30321 if (!NILP (mouse_face
) && STRINGP (object
))
30323 /* The mouse-highlighting comes from a display string
30324 with a mouse-face. */
30328 s
= Fprevious_single_property_change
30329 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
30330 e
= Fnext_single_property_change
30331 (position
, Qmouse_face
, object
, Qnil
);
30333 s
= make_number (0);
30335 e
= make_number (SCHARS (object
));
30336 mouse_face_from_string_pos (w
, hlinfo
, object
,
30337 XINT (s
), XINT (e
));
30338 hlinfo
->mouse_face_past_end
= false;
30339 hlinfo
->mouse_face_window
= window
;
30340 hlinfo
->mouse_face_face_id
30341 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
30342 glyph
->face_id
, true);
30343 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
30344 #ifdef HAVE_WINDOW_SYSTEM
30345 cursor
= No_Cursor
;
30350 /* The mouse-highlighting, if any, comes from an overlay
30351 or text property in the buffer. */
30352 Lisp_Object buffer UNINIT
;
30353 Lisp_Object disp_string UNINIT
;
30355 if (STRINGP (object
))
30357 /* If we are on a display string with no mouse-face,
30358 check if the text under it has one. */
30359 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
30360 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30361 pos
= string_buffer_position (object
, start
);
30364 mouse_face
= get_char_property_and_overlay
30365 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
30366 buffer
= w
->contents
;
30367 disp_string
= object
;
30373 disp_string
= Qnil
;
30376 if (!NILP (mouse_face
))
30378 Lisp_Object before
, after
;
30379 Lisp_Object before_string
, after_string
;
30380 /* To correctly find the limits of mouse highlight
30381 in a bidi-reordered buffer, we must not use the
30382 optimization of limiting the search in
30383 previous-single-property-change and
30384 next-single-property-change, because
30385 rows_from_pos_range needs the real start and end
30386 positions to DTRT in this case. That's because
30387 the first row visible in a window does not
30388 necessarily display the character whose position
30389 is the smallest. */
30391 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
30392 ? Fmarker_position (w
->start
)
30395 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
30396 ? make_number (BUF_Z (XBUFFER (buffer
))
30397 - w
->window_end_pos
)
30400 if (NILP (overlay
))
30402 /* Handle the text property case. */
30403 before
= Fprevious_single_property_change
30404 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
30405 after
= Fnext_single_property_change
30406 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
30407 before_string
= after_string
= Qnil
;
30411 /* Handle the overlay case. */
30412 before
= Foverlay_start (overlay
);
30413 after
= Foverlay_end (overlay
);
30414 before_string
= Foverlay_get (overlay
, Qbefore_string
);
30415 after_string
= Foverlay_get (overlay
, Qafter_string
);
30417 if (!STRINGP (before_string
)) before_string
= Qnil
;
30418 if (!STRINGP (after_string
)) after_string
= Qnil
;
30421 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
30424 : XFASTINT (before
),
30426 ? BUF_Z (XBUFFER (buffer
))
30427 : XFASTINT (after
),
30428 before_string
, after_string
,
30430 #ifdef HAVE_WINDOW_SYSTEM
30431 cursor
= No_Cursor
;
30439 /* Look for a `help-echo' property. */
30440 if (NILP (help_echo_string
)) {
30441 Lisp_Object help
, overlay
;
30443 /* Check overlays first. */
30444 help
= overlay
= Qnil
;
30445 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
30447 overlay
= overlay_vec
[i
];
30448 help
= Foverlay_get (overlay
, Qhelp_echo
);
30453 help_echo_string
= help
;
30454 help_echo_window
= window
;
30455 help_echo_object
= overlay
;
30456 help_echo_pos
= pos
;
30460 Lisp_Object obj
= glyph
->object
;
30461 ptrdiff_t charpos
= glyph
->charpos
;
30463 /* Try text properties. */
30466 && charpos
< SCHARS (obj
))
30468 help
= Fget_text_property (make_number (charpos
),
30472 /* If the string itself doesn't specify a help-echo,
30473 see if the buffer text ``under'' it does. */
30474 struct glyph_row
*r
30475 = MATRIX_ROW (w
->current_matrix
, vpos
);
30476 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30477 ptrdiff_t p
= string_buffer_position (obj
, start
);
30480 help
= Fget_char_property (make_number (p
),
30481 Qhelp_echo
, w
->contents
);
30490 else if (BUFFERP (obj
)
30493 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
30498 help_echo_string
= help
;
30499 help_echo_window
= window
;
30500 help_echo_object
= obj
;
30501 help_echo_pos
= charpos
;
30506 #ifdef HAVE_WINDOW_SYSTEM
30507 /* Look for a `pointer' property. */
30508 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30510 /* Check overlays first. */
30511 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
30512 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
30514 if (NILP (pointer
))
30516 Lisp_Object obj
= glyph
->object
;
30517 ptrdiff_t charpos
= glyph
->charpos
;
30519 /* Try text properties. */
30522 && charpos
< SCHARS (obj
))
30524 pointer
= Fget_text_property (make_number (charpos
),
30526 if (NILP (pointer
))
30528 /* If the string itself doesn't specify a pointer,
30529 see if the buffer text ``under'' it does. */
30530 struct glyph_row
*r
30531 = MATRIX_ROW (w
->current_matrix
, vpos
);
30532 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30533 ptrdiff_t p
= string_buffer_position (obj
, start
);
30535 pointer
= Fget_char_property (make_number (p
),
30536 Qpointer
, w
->contents
);
30539 else if (BUFFERP (obj
)
30542 pointer
= Fget_text_property (make_number (charpos
),
30546 #endif /* HAVE_WINDOW_SYSTEM */
30550 current_buffer
= obuf
;
30556 #ifdef HAVE_WINDOW_SYSTEM
30557 if (FRAME_WINDOW_P (f
))
30558 define_frame_cursor1 (f
, cursor
, pointer
);
30560 /* This is here to prevent a compiler error, about "label at end of
30561 compound statement". */
30568 Clear any mouse-face on window W. This function is part of the
30569 redisplay interface, and is called from try_window_id and similar
30570 functions to ensure the mouse-highlight is off. */
30573 x_clear_window_mouse_face (struct window
*w
)
30575 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
30576 Lisp_Object window
;
30579 XSETWINDOW (window
, w
);
30580 if (EQ (window
, hlinfo
->mouse_face_window
))
30581 clear_mouse_face (hlinfo
);
30587 Just discard the mouse face information for frame F, if any.
30588 This is used when the size of F is changed. */
30591 cancel_mouse_face (struct frame
*f
)
30593 Lisp_Object window
;
30594 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30596 window
= hlinfo
->mouse_face_window
;
30597 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
30598 reset_mouse_highlight (hlinfo
);
30603 /***********************************************************************
30605 ***********************************************************************/
30607 #ifdef HAVE_WINDOW_SYSTEM
30609 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
30610 which intersects rectangle R. R is in window-relative coordinates. */
30613 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
30614 enum glyph_row_area area
)
30616 struct glyph
*first
= row
->glyphs
[area
];
30617 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
30618 struct glyph
*last
;
30619 int first_x
, start_x
, x
;
30621 if (area
== TEXT_AREA
&& row
->fill_line_p
)
30622 /* If row extends face to end of line write the whole line. */
30623 draw_glyphs (w
, 0, row
, area
,
30624 0, row
->used
[area
],
30625 DRAW_NORMAL_TEXT
, 0);
30628 /* Set START_X to the window-relative start position for drawing glyphs of
30629 AREA. The first glyph of the text area can be partially visible.
30630 The first glyphs of other areas cannot. */
30631 start_x
= window_box_left_offset (w
, area
);
30633 if (area
== TEXT_AREA
)
30636 /* Find the first glyph that must be redrawn. */
30638 && x
+ first
->pixel_width
< r
->x
)
30640 x
+= first
->pixel_width
;
30644 /* Find the last one. */
30647 /* Use a signed int intermediate value to avoid catastrophic
30648 failures due to comparison between signed and unsigned, when
30649 x is negative (can happen for wide images that are hscrolled). */
30650 int r_end
= r
->x
+ r
->width
;
30651 while (last
< end
&& x
< r_end
)
30653 x
+= last
->pixel_width
;
30659 draw_glyphs (w
, first_x
- start_x
, row
, area
,
30660 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
30661 DRAW_NORMAL_TEXT
, 0);
30666 /* Redraw the parts of the glyph row ROW on window W intersecting
30667 rectangle R. R is in window-relative coordinates. Value is
30668 true if mouse-face was overwritten. */
30671 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
30673 eassert (row
->enabled_p
);
30675 if (row
->mode_line_p
|| w
->pseudo_window_p
)
30676 draw_glyphs (w
, 0, row
, TEXT_AREA
,
30677 0, row
->used
[TEXT_AREA
],
30678 DRAW_NORMAL_TEXT
, 0);
30681 if (row
->used
[LEFT_MARGIN_AREA
])
30682 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
30683 if (row
->used
[TEXT_AREA
])
30684 expose_area (w
, row
, r
, TEXT_AREA
);
30685 if (row
->used
[RIGHT_MARGIN_AREA
])
30686 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
30687 draw_row_fringe_bitmaps (w
, row
);
30690 return row
->mouse_face_p
;
30694 /* Redraw those parts of glyphs rows during expose event handling that
30695 overlap other rows. Redrawing of an exposed line writes over parts
30696 of lines overlapping that exposed line; this function fixes that.
30698 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
30699 row in W's current matrix that is exposed and overlaps other rows.
30700 LAST_OVERLAPPING_ROW is the last such row. */
30703 expose_overlaps (struct window
*w
,
30704 struct glyph_row
*first_overlapping_row
,
30705 struct glyph_row
*last_overlapping_row
,
30708 struct glyph_row
*row
;
30710 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
30711 if (row
->overlapping_p
)
30713 eassert (row
->enabled_p
&& !row
->mode_line_p
);
30716 if (row
->used
[LEFT_MARGIN_AREA
])
30717 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
30719 if (row
->used
[TEXT_AREA
])
30720 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
30722 if (row
->used
[RIGHT_MARGIN_AREA
])
30723 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
30729 /* Return true if W's cursor intersects rectangle R. */
30732 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
30734 XRectangle cr
, result
;
30735 struct glyph
*cursor_glyph
;
30736 struct glyph_row
*row
;
30738 if (w
->phys_cursor
.vpos
>= 0
30739 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
30740 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
30742 && row
->cursor_in_fringe_p
)
30744 /* Cursor is in the fringe. */
30745 cr
.x
= window_box_right_offset (w
,
30746 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
30747 ? RIGHT_MARGIN_AREA
30750 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
30751 cr
.height
= row
->height
;
30752 return x_intersect_rectangles (&cr
, r
, &result
);
30755 cursor_glyph
= get_phys_cursor_glyph (w
);
30758 /* r is relative to W's box, but w->phys_cursor.x is relative
30759 to left edge of W's TEXT area. Adjust it. */
30760 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
30761 cr
.y
= w
->phys_cursor
.y
;
30762 cr
.width
= cursor_glyph
->pixel_width
;
30763 cr
.height
= w
->phys_cursor_height
;
30764 /* ++KFS: W32 version used W32-specific IntersectRect here, but
30765 I assume the effect is the same -- and this is portable. */
30766 return x_intersect_rectangles (&cr
, r
, &result
);
30768 /* If we don't understand the format, pretend we're not in the hot-spot. */
30774 Draw a vertical window border to the right of window W if W doesn't
30775 have vertical scroll bars. */
30778 x_draw_vertical_border (struct window
*w
)
30780 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30782 /* We could do better, if we knew what type of scroll-bar the adjacent
30783 windows (on either side) have... But we don't :-(
30784 However, I think this works ok. ++KFS 2003-04-25 */
30786 /* Redraw borders between horizontally adjacent windows. Don't
30787 do it for frames with vertical scroll bars because either the
30788 right scroll bar of a window, or the left scroll bar of its
30789 neighbor will suffice as a border. */
30790 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
30793 /* Note: It is necessary to redraw both the left and the right
30794 borders, for when only this single window W is being
30796 if (!WINDOW_RIGHTMOST_P (w
)
30797 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
30799 int x0
, x1
, y0
, y1
;
30801 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30804 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30807 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
30810 if (!WINDOW_LEFTMOST_P (w
)
30811 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
30813 int x0
, x1
, y0
, y1
;
30815 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30818 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30821 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
30826 /* Draw window dividers for window W. */
30829 x_draw_right_divider (struct window
*w
)
30831 struct frame
*f
= WINDOW_XFRAME (w
);
30833 if (w
->mini
|| w
->pseudo_window_p
)
30835 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30837 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
30838 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30839 int y0
= WINDOW_TOP_EDGE_Y (w
);
30840 /* The bottom divider prevails. */
30841 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30843 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30848 x_draw_bottom_divider (struct window
*w
)
30850 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30852 if (w
->mini
|| w
->pseudo_window_p
)
30854 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30856 int x0
= WINDOW_LEFT_EDGE_X (w
);
30857 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30858 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30859 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
30861 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30865 /* Redraw the part of window W intersection rectangle FR. Pixel
30866 coordinates in FR are frame-relative. Call this function with
30867 input blocked. Value is true if the exposure overwrites
30871 expose_window (struct window
*w
, XRectangle
*fr
)
30873 struct frame
*f
= XFRAME (w
->frame
);
30875 bool mouse_face_overwritten_p
= false;
30877 /* If window is not yet fully initialized, do nothing. This can
30878 happen when toolkit scroll bars are used and a window is split.
30879 Reconfiguring the scroll bar will generate an expose for a newly
30881 if (w
->current_matrix
== NULL
)
30884 /* When we're currently updating the window, display and current
30885 matrix usually don't agree. Arrange for a thorough display
30887 if (w
->must_be_updated_p
)
30889 SET_FRAME_GARBAGED (f
);
30893 /* Frame-relative pixel rectangle of W. */
30894 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
30895 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
30896 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
30897 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
30899 if (x_intersect_rectangles (fr
, &wr
, &r
))
30901 int yb
= window_text_bottom_y (w
);
30902 struct glyph_row
*row
;
30903 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
30905 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
30906 r
.x
, r
.y
, r
.width
, r
.height
));
30908 /* Convert to window coordinates. */
30909 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
30910 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
30912 /* Turn off the cursor. */
30913 bool cursor_cleared_p
= (!w
->pseudo_window_p
30914 && phys_cursor_in_rect_p (w
, &r
));
30915 if (cursor_cleared_p
)
30916 x_clear_cursor (w
);
30918 /* If the row containing the cursor extends face to end of line,
30919 then expose_area might overwrite the cursor outside the
30920 rectangle and thus notice_overwritten_cursor might clear
30921 w->phys_cursor_on_p. We remember the original value and
30922 check later if it is changed. */
30923 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
30925 /* Use a signed int intermediate value to avoid catastrophic
30926 failures due to comparison between signed and unsigned, when
30927 y0 or y1 is negative (can happen for tall images). */
30928 int r_bottom
= r
.y
+ r
.height
;
30930 /* Update lines intersecting rectangle R. */
30931 first_overlapping_row
= last_overlapping_row
= NULL
;
30932 for (row
= w
->current_matrix
->rows
;
30937 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
30939 if ((y0
>= r
.y
&& y0
< r_bottom
)
30940 || (y1
> r
.y
&& y1
< r_bottom
)
30941 || (r
.y
>= y0
&& r
.y
< y1
)
30942 || (r_bottom
> y0
&& r_bottom
< y1
))
30944 /* A header line may be overlapping, but there is no need
30945 to fix overlapping areas for them. KFS 2005-02-12 */
30946 if (row
->overlapping_p
&& !row
->mode_line_p
)
30948 if (first_overlapping_row
== NULL
)
30949 first_overlapping_row
= row
;
30950 last_overlapping_row
= row
;
30954 if (expose_line (w
, row
, &r
))
30955 mouse_face_overwritten_p
= true;
30958 else if (row
->overlapping_p
)
30960 /* We must redraw a row overlapping the exposed area. */
30962 ? y0
+ row
->phys_height
> r
.y
30963 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30965 if (first_overlapping_row
== NULL
)
30966 first_overlapping_row
= row
;
30967 last_overlapping_row
= row
;
30975 /* Display the mode line if there is one. */
30976 if (WINDOW_WANTS_MODELINE_P (w
)
30977 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30979 && row
->y
< r_bottom
)
30981 if (expose_line (w
, row
, &r
))
30982 mouse_face_overwritten_p
= true;
30985 if (!w
->pseudo_window_p
)
30987 /* Fix the display of overlapping rows. */
30988 if (first_overlapping_row
)
30989 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30992 /* Draw border between windows. */
30993 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30994 x_draw_right_divider (w
);
30996 x_draw_vertical_border (w
);
30998 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30999 x_draw_bottom_divider (w
);
31001 /* Turn the cursor on again. */
31002 if (cursor_cleared_p
31003 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
31004 update_window_cursor (w
, true);
31008 return mouse_face_overwritten_p
;
31013 /* Redraw (parts) of all windows in the window tree rooted at W that
31014 intersect R. R contains frame pixel coordinates. Value is
31015 true if the exposure overwrites mouse-face. */
31018 expose_window_tree (struct window
*w
, XRectangle
*r
)
31020 struct frame
*f
= XFRAME (w
->frame
);
31021 bool mouse_face_overwritten_p
= false;
31023 while (w
&& !FRAME_GARBAGED_P (f
))
31025 mouse_face_overwritten_p
31026 |= (WINDOWP (w
->contents
)
31027 ? expose_window_tree (XWINDOW (w
->contents
), r
)
31028 : expose_window (w
, r
));
31030 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
31033 return mouse_face_overwritten_p
;
31038 Redisplay an exposed area of frame F. X and Y are the upper-left
31039 corner of the exposed rectangle. W and H are width and height of
31040 the exposed area. All are pixel values. W or H zero means redraw
31041 the entire frame. */
31044 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
31047 bool mouse_face_overwritten_p
= false;
31049 TRACE ((stderr
, "expose_frame "));
31051 /* No need to redraw if frame will be redrawn soon. */
31052 if (FRAME_GARBAGED_P (f
))
31054 TRACE ((stderr
, " garbaged\n"));
31058 /* If basic faces haven't been realized yet, there is no point in
31059 trying to redraw anything. This can happen when we get an expose
31060 event while Emacs is starting, e.g. by moving another window. */
31061 if (FRAME_FACE_CACHE (f
) == NULL
31062 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
31064 TRACE ((stderr
, " no faces\n"));
31068 if (w
== 0 || h
== 0)
31071 r
.width
= FRAME_TEXT_WIDTH (f
);
31072 r
.height
= FRAME_TEXT_HEIGHT (f
);
31082 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
31083 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
31085 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
31086 if (WINDOWP (f
->tool_bar_window
))
31087 mouse_face_overwritten_p
31088 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
31091 #ifdef HAVE_X_WINDOWS
31093 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
31094 if (WINDOWP (f
->menu_bar_window
))
31095 mouse_face_overwritten_p
31096 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
31097 #endif /* not USE_X_TOOLKIT and not USE_GTK */
31101 /* Some window managers support a focus-follows-mouse style with
31102 delayed raising of frames. Imagine a partially obscured frame,
31103 and moving the mouse into partially obscured mouse-face on that
31104 frame. The visible part of the mouse-face will be highlighted,
31105 then the WM raises the obscured frame. With at least one WM, KDE
31106 2.1, Emacs is not getting any event for the raising of the frame
31107 (even tried with SubstructureRedirectMask), only Expose events.
31108 These expose events will draw text normally, i.e. not
31109 highlighted. Which means we must redo the highlight here.
31110 Subsume it under ``we love X''. --gerd 2001-08-15 */
31111 /* Included in Windows version because Windows most likely does not
31112 do the right thing if any third party tool offers
31113 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
31114 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
31116 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
31117 if (f
== hlinfo
->mouse_face_mouse_frame
)
31119 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
31120 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
31121 clear_mouse_face (hlinfo
);
31122 note_mouse_highlight (f
, mouse_x
, mouse_y
);
31129 Determine the intersection of two rectangles R1 and R2. Return
31130 the intersection in *RESULT. Value is true if RESULT is not
31134 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
31136 XRectangle
*left
, *right
;
31137 XRectangle
*upper
, *lower
;
31138 bool intersection_p
= false;
31140 /* Rearrange so that R1 is the left-most rectangle. */
31142 left
= r1
, right
= r2
;
31144 left
= r2
, right
= r1
;
31146 /* X0 of the intersection is right.x0, if this is inside R1,
31147 otherwise there is no intersection. */
31148 if (right
->x
<= left
->x
+ left
->width
)
31150 result
->x
= right
->x
;
31152 /* The right end of the intersection is the minimum of
31153 the right ends of left and right. */
31154 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
31157 /* Same game for Y. */
31159 upper
= r1
, lower
= r2
;
31161 upper
= r2
, lower
= r1
;
31163 /* The upper end of the intersection is lower.y0, if this is inside
31164 of upper. Otherwise, there is no intersection. */
31165 if (lower
->y
<= upper
->y
+ upper
->height
)
31167 result
->y
= lower
->y
;
31169 /* The lower end of the intersection is the minimum of the lower
31170 ends of upper and lower. */
31171 result
->height
= (min (lower
->y
+ lower
->height
,
31172 upper
->y
+ upper
->height
)
31174 intersection_p
= true;
31178 return intersection_p
;
31181 #endif /* HAVE_WINDOW_SYSTEM */
31184 /***********************************************************************
31186 ***********************************************************************/
31189 syms_of_xdisp (void)
31191 Vwith_echo_area_save_vector
= Qnil
;
31192 staticpro (&Vwith_echo_area_save_vector
);
31194 Vmessage_stack
= Qnil
;
31195 staticpro (&Vmessage_stack
);
31197 /* Non-nil means don't actually do any redisplay. */
31198 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
31200 DEFSYM (Qredisplay_internal_xC_functionx
, "redisplay_internal (C function)");
31202 DEFVAR_BOOL("inhibit-message", inhibit_message
,
31203 doc
: /* Non-nil means calls to `message' are not displayed.
31204 They are still logged to the *Messages* buffer. */);
31205 inhibit_message
= 0;
31207 message_dolog_marker1
= Fmake_marker ();
31208 staticpro (&message_dolog_marker1
);
31209 message_dolog_marker2
= Fmake_marker ();
31210 staticpro (&message_dolog_marker2
);
31211 message_dolog_marker3
= Fmake_marker ();
31212 staticpro (&message_dolog_marker3
);
31215 defsubr (&Sdump_frame_glyph_matrix
);
31216 defsubr (&Sdump_glyph_matrix
);
31217 defsubr (&Sdump_glyph_row
);
31218 defsubr (&Sdump_tool_bar_row
);
31219 defsubr (&Strace_redisplay
);
31220 defsubr (&Strace_to_stderr
);
31222 #ifdef HAVE_WINDOW_SYSTEM
31223 defsubr (&Stool_bar_height
);
31224 defsubr (&Slookup_image_map
);
31226 defsubr (&Sline_pixel_height
);
31227 defsubr (&Sformat_mode_line
);
31228 defsubr (&Sinvisible_p
);
31229 defsubr (&Scurrent_bidi_paragraph_direction
);
31230 defsubr (&Swindow_text_pixel_size
);
31231 defsubr (&Smove_point_visually
);
31232 defsubr (&Sbidi_find_overridden_directionality
);
31234 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
31235 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
31236 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
31237 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
31238 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
31239 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
31240 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
31241 DEFSYM (Qeval
, "eval");
31242 DEFSYM (QCdata
, ":data");
31244 /* Names of text properties relevant for redisplay. */
31245 DEFSYM (Qdisplay
, "display");
31246 DEFSYM (Qspace_width
, "space-width");
31247 DEFSYM (Qraise
, "raise");
31248 DEFSYM (Qslice
, "slice");
31249 DEFSYM (Qspace
, "space");
31250 DEFSYM (Qmargin
, "margin");
31251 DEFSYM (Qpointer
, "pointer");
31252 DEFSYM (Qleft_margin
, "left-margin");
31253 DEFSYM (Qright_margin
, "right-margin");
31254 DEFSYM (Qcenter
, "center");
31255 DEFSYM (Qline_height
, "line-height");
31256 DEFSYM (QCalign_to
, ":align-to");
31257 DEFSYM (QCrelative_width
, ":relative-width");
31258 DEFSYM (QCrelative_height
, ":relative-height");
31259 DEFSYM (QCeval
, ":eval");
31260 DEFSYM (QCpropertize
, ":propertize");
31261 DEFSYM (QCfile
, ":file");
31262 DEFSYM (Qfontified
, "fontified");
31263 DEFSYM (Qfontification_functions
, "fontification-functions");
31265 /* Name of the face used to highlight trailing whitespace. */
31266 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
31268 /* Name and number of the face used to highlight escape glyphs. */
31269 DEFSYM (Qescape_glyph
, "escape-glyph");
31271 /* Name and number of the face used to highlight non-breaking
31273 DEFSYM (Qnobreak_space
, "nobreak-space");
31274 DEFSYM (Qnobreak_hyphen
, "nobreak-hyphen");
31276 /* The symbol 'image' which is the car of the lists used to represent
31277 images in Lisp. Also a tool bar style. */
31278 DEFSYM (Qimage
, "image");
31280 /* Tool bar styles. */
31281 DEFSYM (Qtext
, "text");
31282 DEFSYM (Qboth
, "both");
31283 DEFSYM (Qboth_horiz
, "both-horiz");
31284 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
31286 /* The image map types. */
31287 DEFSYM (QCmap
, ":map");
31288 DEFSYM (QCpointer
, ":pointer");
31289 DEFSYM (Qrect
, "rect");
31290 DEFSYM (Qcircle
, "circle");
31291 DEFSYM (Qpoly
, "poly");
31293 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
31295 DEFSYM (Qgrow_only
, "grow-only");
31296 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
31297 DEFSYM (Qposition
, "position");
31298 DEFSYM (Qbuffer_position
, "buffer-position");
31299 DEFSYM (Qobject
, "object");
31301 /* Cursor shapes. */
31302 DEFSYM (Qbar
, "bar");
31303 DEFSYM (Qhbar
, "hbar");
31304 DEFSYM (Qbox
, "box");
31305 DEFSYM (Qhollow
, "hollow");
31307 /* Pointer shapes. */
31308 DEFSYM (Qhand
, "hand");
31309 DEFSYM (Qarrow
, "arrow");
31312 DEFSYM (Qdragging
, "dragging");
31314 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
31316 list_of_error
= list1 (list2 (Qerror
, Qvoid_variable
));
31317 staticpro (&list_of_error
);
31319 /* Values of those variables at last redisplay are stored as
31320 properties on 'overlay-arrow-position' symbol. However, if
31321 Voverlay_arrow_position is a marker, last-arrow-position is its
31322 numerical position. */
31323 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
31324 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
31326 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
31327 properties on a symbol in overlay-arrow-variable-list. */
31328 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
31329 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
31331 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
31332 staticpro (&echo_buffer
[0]);
31333 staticpro (&echo_buffer
[1]);
31335 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
31336 staticpro (&echo_area_buffer
[0]);
31337 staticpro (&echo_area_buffer
[1]);
31339 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
31340 staticpro (&Vmessages_buffer_name
);
31342 mode_line_proptrans_alist
= Qnil
;
31343 staticpro (&mode_line_proptrans_alist
);
31344 mode_line_string_list
= Qnil
;
31345 staticpro (&mode_line_string_list
);
31346 mode_line_string_face
= Qnil
;
31347 staticpro (&mode_line_string_face
);
31348 mode_line_string_face_prop
= Qnil
;
31349 staticpro (&mode_line_string_face_prop
);
31350 Vmode_line_unwind_vector
= Qnil
;
31351 staticpro (&Vmode_line_unwind_vector
);
31353 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
31355 help_echo_string
= Qnil
;
31356 staticpro (&help_echo_string
);
31357 help_echo_object
= Qnil
;
31358 staticpro (&help_echo_object
);
31359 help_echo_window
= Qnil
;
31360 staticpro (&help_echo_window
);
31361 previous_help_echo_string
= Qnil
;
31362 staticpro (&previous_help_echo_string
);
31363 help_echo_pos
= -1;
31365 DEFSYM (Qright_to_left
, "right-to-left");
31366 DEFSYM (Qleft_to_right
, "left-to-right");
31367 defsubr (&Sbidi_resolved_levels
);
31369 #ifdef HAVE_WINDOW_SYSTEM
31370 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
31371 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
31372 For example, if a block cursor is over a tab, it will be drawn as
31373 wide as that tab on the display. */);
31374 x_stretch_cursor_p
= 0;
31377 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
31378 doc
: /* Non-nil means highlight trailing whitespace.
31379 The face used for trailing whitespace is `trailing-whitespace'. */);
31380 Vshow_trailing_whitespace
= Qnil
;
31382 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
31383 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
31384 If the value is t, Emacs highlights non-ASCII chars which have the
31385 same appearance as an ASCII space or hyphen, using the `nobreak-space'
31386 or `nobreak-hyphen' face respectively.
31388 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
31389 U+2011 (non-breaking hyphen) are affected.
31391 Any other non-nil value means to display these characters as a escape
31392 glyph followed by an ordinary space or hyphen.
31394 A value of nil means no special handling of these characters. */);
31395 Vnobreak_char_display
= Qt
;
31397 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
31398 doc
: /* The pointer shape to show in void text areas.
31399 A value of nil means to show the text pointer. Other options are
31400 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
31402 Vvoid_text_area_pointer
= Qarrow
;
31404 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
31405 doc
: /* Non-nil means don't actually do any redisplay.
31406 This is used for internal purposes. */);
31407 Vinhibit_redisplay
= Qnil
;
31409 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
31410 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
31411 Vglobal_mode_string
= Qnil
;
31413 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
31414 doc
: /* Marker for where to display an arrow on top of the buffer text.
31415 This must be the beginning of a line in order to work.
31416 See also `overlay-arrow-string'. */);
31417 Voverlay_arrow_position
= Qnil
;
31419 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
31420 doc
: /* String to display as an arrow in non-window frames.
31421 See also `overlay-arrow-position'. */);
31422 Voverlay_arrow_string
= build_pure_c_string ("=>");
31424 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
31425 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
31426 The symbols on this list are examined during redisplay to determine
31427 where to display overlay arrows. */);
31428 Voverlay_arrow_variable_list
31429 = list1 (intern_c_string ("overlay-arrow-position"));
31431 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
31432 doc
: /* The number of lines to try scrolling a window by when point moves out.
31433 If that fails to bring point back on frame, point is centered instead.
31434 If this is zero, point is always centered after it moves off frame.
31435 If you want scrolling to always be a line at a time, you should set
31436 `scroll-conservatively' to a large value rather than set this to 1. */);
31438 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
31439 doc
: /* Scroll up to this many lines, to bring point back on screen.
31440 If point moves off-screen, redisplay will scroll by up to
31441 `scroll-conservatively' lines in order to bring point just barely
31442 onto the screen again. If that cannot be done, then redisplay
31443 recenters point as usual.
31445 If the value is greater than 100, redisplay will never recenter point,
31446 but will always scroll just enough text to bring point into view, even
31447 if you move far away.
31449 A value of zero means always recenter point if it moves off screen. */);
31450 scroll_conservatively
= 0;
31452 DEFVAR_INT ("scroll-margin", scroll_margin
,
31453 doc
: /* Number of lines of margin at the top and bottom of a window.
31454 Recenter the window whenever point gets within this many lines
31455 of the top or bottom of the window. */);
31458 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
31459 doc
: /* Pixels per inch value for non-window system displays.
31460 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
31461 Vdisplay_pixels_per_inch
= make_float (72.0);
31464 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
31467 DEFVAR_LISP ("truncate-partial-width-windows",
31468 Vtruncate_partial_width_windows
,
31469 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
31470 For an integer value, truncate lines in each window narrower than the
31471 full frame width, provided the total window width in column units is less
31472 than that integer; otherwise, respect the value of `truncate-lines'.
31473 The total width of the window is as returned by `window-total-width', it
31474 includes the fringes, the continuation and truncation glyphs, the
31475 display margins (if any), and the scroll bar
31477 For any other non-nil value, truncate lines in all windows that do
31478 not span the full frame width.
31480 A value of nil means to respect the value of `truncate-lines'.
31482 If `word-wrap' is enabled, you might want to reduce this. */);
31483 Vtruncate_partial_width_windows
= make_number (50);
31485 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
31486 doc
: /* Maximum buffer size for which line number should be displayed.
31487 If the buffer is bigger than this, the line number does not appear
31488 in the mode line. A value of nil means no limit. */);
31489 Vline_number_display_limit
= Qnil
;
31491 DEFVAR_INT ("line-number-display-limit-width",
31492 line_number_display_limit_width
,
31493 doc
: /* Maximum line width (in characters) for line number display.
31494 If the average length of the lines near point is bigger than this, then the
31495 line number may be omitted from the mode line. */);
31496 line_number_display_limit_width
= 200;
31498 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
31499 doc
: /* Non-nil means highlight region even in nonselected windows. */);
31500 highlight_nonselected_windows
= false;
31502 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
31503 doc
: /* Non-nil if more than one frame is visible on this display.
31504 Minibuffer-only frames don't count, but iconified frames do.
31505 This variable is not guaranteed to be accurate except while processing
31506 `frame-title-format' and `icon-title-format'. */);
31508 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
31509 doc
: /* Template for displaying the title bar of visible frames.
31510 \(Assuming the window manager supports this feature.)
31512 This variable has the same structure as `mode-line-format', except that
31513 the %c and %l constructs are ignored. It is used only on frames for
31514 which no explicit name has been set (see `modify-frame-parameters'). */);
31516 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
31517 doc
: /* Template for displaying the title bar of an iconified frame.
31518 \(Assuming the window manager supports this feature.)
31519 This variable has the same structure as `mode-line-format' (which see),
31520 and is used only on frames for which no explicit name has been set
31521 \(see `modify-frame-parameters'). */);
31523 = Vframe_title_format
31524 = listn (CONSTYPE_PURE
, 3,
31525 intern_c_string ("multiple-frames"),
31526 build_pure_c_string ("%b"),
31527 listn (CONSTYPE_PURE
, 4,
31528 empty_unibyte_string
,
31529 intern_c_string ("invocation-name"),
31530 build_pure_c_string ("@"),
31531 intern_c_string ("system-name")));
31533 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
31534 doc
: /* Maximum number of lines to keep in the message log buffer.
31535 If nil, disable message logging. If t, log messages but don't truncate
31536 the buffer when it becomes large. */);
31537 Vmessage_log_max
= make_number (1000);
31539 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
31540 doc
: /* List of functions to call before redisplaying a window with scrolling.
31541 Each function is called with two arguments, the window and its new
31542 display-start position.
31543 These functions are called whenever the `window-start' marker is modified,
31544 either to point into another buffer (e.g. via `set-window-buffer') or another
31545 place in the same buffer.
31546 Note that the value of `window-end' is not valid when these functions are
31549 Warning: Do not use this feature to alter the way the window
31550 is scrolled. It is not designed for that, and such use probably won't
31552 Vwindow_scroll_functions
= Qnil
;
31554 DEFVAR_LISP ("window-text-change-functions",
31555 Vwindow_text_change_functions
,
31556 doc
: /* Functions to call in redisplay when text in the window might change. */);
31557 Vwindow_text_change_functions
= Qnil
;
31559 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
31560 doc
: /* Functions called when redisplay of a window reaches the end trigger.
31561 Each function is called with two arguments, the window and the end trigger value.
31562 See `set-window-redisplay-end-trigger'. */);
31563 Vredisplay_end_trigger_functions
= Qnil
;
31565 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
31566 doc
: /* Non-nil means autoselect window with mouse pointer.
31567 If nil, do not autoselect windows.
31568 A positive number means delay autoselection by that many seconds: a
31569 window is autoselected only after the mouse has remained in that
31570 window for the duration of the delay.
31571 A negative number has a similar effect, but causes windows to be
31572 autoselected only after the mouse has stopped moving. (Because of
31573 the way Emacs compares mouse events, you will occasionally wait twice
31574 that time before the window gets selected.)
31575 Any other value means to autoselect window instantaneously when the
31576 mouse pointer enters it.
31578 Autoselection selects the minibuffer only if it is active, and never
31579 unselects the minibuffer if it is active.
31581 When customizing this variable make sure that the actual value of
31582 `focus-follows-mouse' matches the behavior of your window manager. */);
31583 Vmouse_autoselect_window
= Qnil
;
31585 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
31586 doc
: /* Non-nil means automatically resize tool-bars.
31587 This dynamically changes the tool-bar's height to the minimum height
31588 that is needed to make all tool-bar items visible.
31589 If value is `grow-only', the tool-bar's height is only increased
31590 automatically; to decrease the tool-bar height, use \\[recenter]. */);
31591 Vauto_resize_tool_bars
= Qt
;
31593 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
31594 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
31595 auto_raise_tool_bar_buttons_p
= true;
31597 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
31598 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
31599 make_cursor_line_fully_visible_p
= true;
31601 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
31602 doc
: /* Border below tool-bar in pixels.
31603 If an integer, use it as the height of the border.
31604 If it is one of `internal-border-width' or `border-width', use the
31605 value of the corresponding frame parameter.
31606 Otherwise, no border is added below the tool-bar. */);
31607 Vtool_bar_border
= Qinternal_border_width
;
31609 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
31610 doc
: /* Margin around tool-bar buttons in pixels.
31611 If an integer, use that for both horizontal and vertical margins.
31612 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
31613 HORZ specifying the horizontal margin, and VERT specifying the
31614 vertical margin. */);
31615 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
31617 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
31618 doc
: /* Relief thickness of tool-bar buttons. */);
31619 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
31621 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
31622 doc
: /* Tool bar style to use.
31624 image - show images only
31625 text - show text only
31626 both - show both, text below image
31627 both-horiz - show text to the right of the image
31628 text-image-horiz - show text to the left of the image
31629 any other - use system default or image if no system default.
31631 This variable only affects the GTK+ toolkit version of Emacs. */);
31632 Vtool_bar_style
= Qnil
;
31634 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
31635 doc
: /* Maximum number of characters a label can have to be shown.
31636 The tool bar style must also show labels for this to have any effect, see
31637 `tool-bar-style'. */);
31638 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
31640 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
31641 doc
: /* List of functions to call to fontify regions of text.
31642 Each function is called with one argument POS. Functions must
31643 fontify a region starting at POS in the current buffer, and give
31644 fontified regions the property `fontified'. */);
31645 Vfontification_functions
= Qnil
;
31646 Fmake_variable_buffer_local (Qfontification_functions
);
31648 DEFVAR_BOOL ("unibyte-display-via-language-environment",
31649 unibyte_display_via_language_environment
,
31650 doc
: /* Non-nil means display unibyte text according to language environment.
31651 Specifically, this means that raw bytes in the range 160-255 decimal
31652 are displayed by converting them to the equivalent multibyte characters
31653 according to the current language environment. As a result, they are
31654 displayed according to the current fontset.
31656 Note that this variable affects only how these bytes are displayed,
31657 but does not change the fact they are interpreted as raw bytes. */);
31658 unibyte_display_via_language_environment
= false;
31660 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
31661 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
31662 If a float, it specifies a fraction of the mini-window frame's height.
31663 If an integer, it specifies a number of lines. */);
31664 Vmax_mini_window_height
= make_float (0.25);
31666 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
31667 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
31668 A value of nil means don't automatically resize mini-windows.
31669 A value of t means resize them to fit the text displayed in them.
31670 A value of `grow-only', the default, means let mini-windows grow only;
31671 they return to their normal size when the minibuffer is closed, or the
31672 echo area becomes empty. */);
31673 /* Contrary to the doc string, we initialize this to nil, so that
31674 loading loadup.el won't try to resize windows before loading
31675 window.el, where some functions we need to call for this live.
31676 We assign the 'grow-only' value right after loading window.el
31678 Vresize_mini_windows
= Qnil
;
31680 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
31681 doc
: /* Alist specifying how to blink the cursor off.
31682 Each element has the form (ON-STATE . OFF-STATE). Whenever the
31683 `cursor-type' frame-parameter or variable equals ON-STATE,
31684 comparing using `equal', Emacs uses OFF-STATE to specify
31685 how to blink it off. ON-STATE and OFF-STATE are values for
31686 the `cursor-type' frame parameter.
31688 If a frame's ON-STATE has no entry in this list,
31689 the frame's other specifications determine how to blink the cursor off. */);
31690 Vblink_cursor_alist
= Qnil
;
31692 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
31693 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
31694 If non-nil, windows are automatically scrolled horizontally to make
31695 point visible. */);
31696 automatic_hscrolling_p
= true;
31697 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
31699 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
31700 doc
: /* How many columns away from the window edge point is allowed to get
31701 before automatic hscrolling will horizontally scroll the window. */);
31702 hscroll_margin
= 5;
31704 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
31705 doc
: /* How many columns to scroll the window when point gets too close to the edge.
31706 When point is less than `hscroll-margin' columns from the window
31707 edge, automatic hscrolling will scroll the window by the amount of columns
31708 determined by this variable. If its value is a positive integer, scroll that
31709 many columns. If it's a positive floating-point number, it specifies the
31710 fraction of the window's width to scroll. If it's nil or zero, point will be
31711 centered horizontally after the scroll. Any other value, including negative
31712 numbers, are treated as if the value were zero.
31714 Automatic hscrolling always moves point outside the scroll margin, so if
31715 point was more than scroll step columns inside the margin, the window will
31716 scroll more than the value given by the scroll step.
31718 Note that the lower bound for automatic hscrolling specified by `scroll-left'
31719 and `scroll-right' overrides this variable's effect. */);
31720 Vhscroll_step
= make_number (0);
31722 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
31723 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
31724 Bind this around calls to `message' to let it take effect. */);
31725 message_truncate_lines
= false;
31727 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
31728 doc
: /* Normal hook run to update the menu bar definitions.
31729 Redisplay runs this hook before it redisplays the menu bar.
31730 This is used to update menus such as Buffers, whose contents depend on
31732 Vmenu_bar_update_hook
= Qnil
;
31734 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
31735 doc
: /* Frame for which we are updating a menu.
31736 The enable predicate for a menu binding should check this variable. */);
31737 Vmenu_updating_frame
= Qnil
;
31739 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
31740 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
31741 inhibit_menubar_update
= false;
31743 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
31744 doc
: /* Prefix prepended to all continuation lines at display time.
31745 The value may be a string, an image, or a stretch-glyph; it is
31746 interpreted in the same way as the value of a `display' text property.
31748 This variable is overridden by any `wrap-prefix' text or overlay
31751 To add a prefix to non-continuation lines, use `line-prefix'. */);
31752 Vwrap_prefix
= Qnil
;
31753 DEFSYM (Qwrap_prefix
, "wrap-prefix");
31754 Fmake_variable_buffer_local (Qwrap_prefix
);
31756 DEFVAR_LISP ("line-prefix", Vline_prefix
,
31757 doc
: /* Prefix prepended to all non-continuation lines at display time.
31758 The value may be a string, an image, or a stretch-glyph; it is
31759 interpreted in the same way as the value of a `display' text property.
31761 This variable is overridden by any `line-prefix' text or overlay
31764 To add a prefix to continuation lines, use `wrap-prefix'. */);
31765 Vline_prefix
= Qnil
;
31766 DEFSYM (Qline_prefix
, "line-prefix");
31767 Fmake_variable_buffer_local (Qline_prefix
);
31769 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
31770 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
31771 inhibit_eval_during_redisplay
= false;
31773 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
31774 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
31775 inhibit_free_realized_faces
= false;
31777 DEFVAR_BOOL ("inhibit-bidi-mirroring", inhibit_bidi_mirroring
,
31778 doc
: /* Non-nil means don't mirror characters even when bidi context requires that.
31779 Intended for use during debugging and for testing bidi display;
31780 see biditest.el in the test suite. */);
31781 inhibit_bidi_mirroring
= false;
31784 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
31785 doc
: /* Inhibit try_window_id display optimization. */);
31786 inhibit_try_window_id
= false;
31788 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
31789 doc
: /* Inhibit try_window_reusing display optimization. */);
31790 inhibit_try_window_reusing
= false;
31792 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
31793 doc
: /* Inhibit try_cursor_movement display optimization. */);
31794 inhibit_try_cursor_movement
= false;
31795 #endif /* GLYPH_DEBUG */
31797 DEFVAR_INT ("overline-margin", overline_margin
,
31798 doc
: /* Space between overline and text, in pixels.
31799 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
31800 margin to the character height. */);
31801 overline_margin
= 2;
31803 DEFVAR_INT ("underline-minimum-offset",
31804 underline_minimum_offset
,
31805 doc
: /* Minimum distance between baseline and underline.
31806 This can improve legibility of underlined text at small font sizes,
31807 particularly when using variable `x-use-underline-position-properties'
31808 with fonts that specify an UNDERLINE_POSITION relatively close to the
31809 baseline. The default value is 1. */);
31810 underline_minimum_offset
= 1;
31812 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
31813 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
31814 This feature only works when on a window system that can change
31815 cursor shapes. */);
31816 display_hourglass_p
= true;
31818 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
31819 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
31820 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
31822 #ifdef HAVE_WINDOW_SYSTEM
31823 hourglass_atimer
= NULL
;
31824 hourglass_shown_p
= false;
31825 #endif /* HAVE_WINDOW_SYSTEM */
31827 /* Name of the face used to display glyphless characters. */
31828 DEFSYM (Qglyphless_char
, "glyphless-char");
31830 /* Method symbols for Vglyphless_char_display. */
31831 DEFSYM (Qhex_code
, "hex-code");
31832 DEFSYM (Qempty_box
, "empty-box");
31833 DEFSYM (Qthin_space
, "thin-space");
31834 DEFSYM (Qzero_width
, "zero-width");
31836 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
31837 doc
: /* Function run just before redisplay.
31838 It is called with one argument, which is the set of windows that are to
31839 be redisplayed. This set can be nil (meaning, only the selected window),
31840 or t (meaning all windows). */);
31841 Vpre_redisplay_function
= intern ("ignore");
31843 /* Symbol for the purpose of Vglyphless_char_display. */
31844 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
31845 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
31847 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
31848 doc
: /* Char-table defining glyphless characters.
31849 Each element, if non-nil, should be one of the following:
31850 an ASCII acronym string: display this string in a box
31851 `hex-code': display the hexadecimal code of a character in a box
31852 `empty-box': display as an empty box
31853 `thin-space': display as 1-pixel width space
31854 `zero-width': don't display
31855 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
31856 display method for graphical terminals and text terminals respectively.
31857 GRAPHICAL and TEXT should each have one of the values listed above.
31859 The char-table has one extra slot to control the display of a character for
31860 which no font is found. This slot only takes effect on graphical terminals.
31861 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
31862 `thin-space'. The default is `empty-box'.
31864 If a character has a non-nil entry in an active display table, the
31865 display table takes effect; in this case, Emacs does not consult
31866 `glyphless-char-display' at all. */);
31867 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
31868 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
31871 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
31872 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
31873 Vdebug_on_message
= Qnil
;
31875 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
31877 Vredisplay__all_windows_cause
= Fmake_hash_table (0, NULL
);
31879 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
31881 Vredisplay__mode_lines_cause
= Fmake_hash_table (0, NULL
);
31883 DEFVAR_LISP ("redisplay--variables", Vredisplay__variables
,
31884 doc
: /* A hash-table of variables changing which triggers a thorough redisplay. */);
31885 Vredisplay__variables
= Qnil
;
31887 DEFVAR_BOOL ("redisplay--inhibit-bidi", redisplay__inhibit_bidi
,
31888 doc
: /* Non-nil means it is not safe to attempt bidi reordering for display. */);
31889 /* Initialize to t, since we need to disable reordering until
31890 loadup.el successfully loads charprop.el. */
31891 redisplay__inhibit_bidi
= true;
31895 /* Initialize this module when Emacs starts. */
31900 CHARPOS (this_line_start_pos
) = 0;
31902 if (!noninteractive
)
31904 struct window
*m
= XWINDOW (minibuf_window
);
31905 Lisp_Object frame
= m
->frame
;
31906 struct frame
*f
= XFRAME (frame
);
31907 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
31908 struct window
*r
= XWINDOW (root
);
31911 echo_area_window
= minibuf_window
;
31913 r
->top_line
= FRAME_TOP_MARGIN (f
);
31914 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
31915 r
->total_cols
= FRAME_COLS (f
);
31916 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31917 r
->total_lines
= FRAME_TOTAL_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
31918 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
31920 m
->top_line
= FRAME_TOTAL_LINES (f
) - 1;
31921 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
31922 m
->total_cols
= FRAME_COLS (f
);
31923 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31924 m
->total_lines
= 1;
31925 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
31927 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
31928 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
31929 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
31931 /* The default ellipsis glyphs `...'. */
31932 for (i
= 0; i
< 3; ++i
)
31933 default_invis_vector
[i
] = make_number ('.');
31937 /* Allocate the buffer for frame titles.
31938 Also used for `format-mode-line'. */
31940 mode_line_noprop_buf
= xmalloc (size
);
31941 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
31942 mode_line_noprop_ptr
= mode_line_noprop_buf
;
31943 mode_line_target
= MODE_LINE_DISPLAY
;
31946 help_echo_showing_p
= false;
31949 #ifdef HAVE_WINDOW_SYSTEM
31951 /* Platform-independent portion of hourglass implementation. */
31953 /* Timer function of hourglass_atimer. */
31956 show_hourglass (struct atimer
*timer
)
31958 /* The timer implementation will cancel this timer automatically
31959 after this function has run. Set hourglass_atimer to null
31960 so that we know the timer doesn't have to be canceled. */
31961 hourglass_atimer
= NULL
;
31963 if (!hourglass_shown_p
)
31965 Lisp_Object tail
, frame
;
31969 FOR_EACH_FRAME (tail
, frame
)
31971 struct frame
*f
= XFRAME (frame
);
31973 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31974 && FRAME_RIF (f
)->show_hourglass
)
31975 FRAME_RIF (f
)->show_hourglass (f
);
31978 hourglass_shown_p
= true;
31983 /* Cancel a currently active hourglass timer, and start a new one. */
31986 start_hourglass (void)
31988 struct timespec delay
;
31990 cancel_hourglass ();
31992 if (INTEGERP (Vhourglass_delay
)
31993 && XINT (Vhourglass_delay
) > 0)
31994 delay
= make_timespec (min (XINT (Vhourglass_delay
),
31995 TYPE_MAXIMUM (time_t)),
31997 else if (FLOATP (Vhourglass_delay
)
31998 && XFLOAT_DATA (Vhourglass_delay
) > 0)
31999 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
32001 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
32003 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
32004 show_hourglass
, NULL
);
32007 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
32011 cancel_hourglass (void)
32013 if (hourglass_atimer
)
32015 cancel_atimer (hourglass_atimer
);
32016 hourglass_atimer
= NULL
;
32019 if (hourglass_shown_p
)
32021 Lisp_Object tail
, frame
;
32025 FOR_EACH_FRAME (tail
, frame
)
32027 struct frame
*f
= XFRAME (frame
);
32029 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
32030 && FRAME_RIF (f
)->hide_hourglass
)
32031 FRAME_RIF (f
)->hide_hourglass (f
);
32033 /* No cursors on non GUI frames - restore to stock arrow cursor. */
32034 else if (!FRAME_W32_P (f
))
32035 w32_arrow_cursor ();
32039 hourglass_shown_p
= false;
32044 #endif /* HAVE_WINDOW_SYSTEM */