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
)))
5024 if (!FRAME_WINDOW_P (it
->f
))
5025 /* If we return here, POSITION has been advanced
5026 across the text with this property. */
5028 /* Synchronize the bidi iterator with POSITION. This is
5029 needed because we are not going to push the iterator
5030 on behalf of this display property, so there will be
5031 no pop_it call to do this synchronization for us. */
5034 it
->position
= *position
;
5035 iterate_out_of_display_property (it
);
5036 *position
= it
->position
;
5041 else if (!frame_window_p
)
5044 #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
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8562 bool saw_smaller_pos
= prev_pos
< to_charpos
;
8564 /* Don't produce glyphs in produce_glyphs. */
8565 saved_glyph_row
= it
->glyph_row
;
8566 it
->glyph_row
= NULL
;
8568 /* Use wrap_it to save a copy of IT wherever a word wrap could
8569 occur. Use atpos_it to save a copy of IT at the desired buffer
8570 position, if found, so that we can scan ahead and check if the
8571 word later overshoots the window edge. Use atx_it similarly, for
8577 /* Use ppos_it under bidi reordering to save a copy of IT for the
8578 initial position. We restore that position in IT when we have
8579 scanned the entire display line without finding a match for
8580 TO_CHARPOS and all the character positions are greater than
8581 TO_CHARPOS. We then restart the scan from the initial position,
8582 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8583 the closest to TO_CHARPOS. */
8586 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8588 SAVE_IT (ppos_it
, *it
, ppos_data
);
8589 closest_pos
= IT_CHARPOS (*it
);
8595 #define BUFFER_POS_REACHED_P() \
8596 ((op & MOVE_TO_POS) != 0 \
8597 && BUFFERP (it->object) \
8598 && (IT_CHARPOS (*it) == to_charpos \
8600 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8601 && IT_CHARPOS (*it) > to_charpos) \
8602 || (it->what == IT_COMPOSITION \
8603 && ((IT_CHARPOS (*it) > to_charpos \
8604 && to_charpos >= it->cmp_it.charpos) \
8605 || (IT_CHARPOS (*it) < to_charpos \
8606 && to_charpos <= it->cmp_it.charpos)))) \
8607 && (it->method == GET_FROM_BUFFER \
8608 || (it->method == GET_FROM_DISPLAY_VECTOR \
8609 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8611 /* If there's a line-/wrap-prefix, handle it. */
8612 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8613 && it
->current_y
< it
->last_visible_y
)
8614 handle_line_prefix (it
);
8616 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8617 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8621 int x
, i
, ascent
= 0, descent
= 0;
8623 /* Utility macro to reset an iterator with x, ascent, and descent. */
8624 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8625 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8626 (IT)->max_descent = descent)
8628 /* Stop if we move beyond TO_CHARPOS (after an image or a
8629 display string or stretch glyph). */
8630 if ((op
& MOVE_TO_POS
) != 0
8631 && BUFFERP (it
->object
)
8632 && it
->method
== GET_FROM_BUFFER
8634 /* When the iterator is at base embedding level, we
8635 are guaranteed that characters are delivered for
8636 display in strictly increasing order of their
8637 buffer positions. */
8638 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8639 && IT_CHARPOS (*it
) > to_charpos
)
8641 && (prev_method
== GET_FROM_IMAGE
8642 || prev_method
== GET_FROM_STRETCH
8643 || prev_method
== GET_FROM_STRING
)
8644 /* Passed TO_CHARPOS from left to right. */
8645 && ((prev_pos
< to_charpos
8646 && IT_CHARPOS (*it
) > to_charpos
)
8647 /* Passed TO_CHARPOS from right to left. */
8648 || (prev_pos
> to_charpos
8649 && IT_CHARPOS (*it
) < to_charpos
)))))
8651 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8653 result
= MOVE_POS_MATCH_OR_ZV
;
8656 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8657 /* If wrap_it is valid, the current position might be in a
8658 word that is wrapped. So, save the iterator in
8659 atpos_it and continue to see if wrapping happens. */
8660 SAVE_IT (atpos_it
, *it
, atpos_data
);
8663 /* Stop when ZV reached.
8664 We used to stop here when TO_CHARPOS reached as well, but that is
8665 too soon if this glyph does not fit on this line. So we handle it
8666 explicitly below. */
8667 if (!get_next_display_element (it
))
8669 result
= MOVE_POS_MATCH_OR_ZV
;
8673 if (it
->line_wrap
== TRUNCATE
)
8675 if (BUFFER_POS_REACHED_P ())
8677 result
= MOVE_POS_MATCH_OR_ZV
;
8683 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8685 if (IT_DISPLAYING_WHITESPACE (it
))
8689 /* We have reached a glyph that follows one or more
8690 whitespace characters. If the position is
8691 already found, we are done. */
8692 if (atpos_it
.sp
>= 0)
8694 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8695 result
= MOVE_POS_MATCH_OR_ZV
;
8700 RESTORE_IT (it
, &atx_it
, atx_data
);
8701 result
= MOVE_X_REACHED
;
8704 /* Otherwise, we can wrap here. */
8705 SAVE_IT (wrap_it
, *it
, wrap_data
);
8711 /* Remember the line height for the current line, in case
8712 the next element doesn't fit on the line. */
8713 ascent
= it
->max_ascent
;
8714 descent
= it
->max_descent
;
8716 /* The call to produce_glyphs will get the metrics of the
8717 display element IT is loaded with. Record the x-position
8718 before this display element, in case it doesn't fit on the
8722 PRODUCE_GLYPHS (it
);
8724 if (it
->area
!= TEXT_AREA
)
8726 prev_method
= it
->method
;
8727 if (it
->method
== GET_FROM_BUFFER
)
8728 prev_pos
= IT_CHARPOS (*it
);
8729 set_iterator_to_next (it
, true);
8730 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8731 SET_TEXT_POS (this_line_min_pos
,
8732 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8734 && (op
& MOVE_TO_POS
)
8735 && IT_CHARPOS (*it
) > to_charpos
8736 && IT_CHARPOS (*it
) < closest_pos
)
8737 closest_pos
= IT_CHARPOS (*it
);
8741 /* The number of glyphs we get back in IT->nglyphs will normally
8742 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8743 character on a terminal frame, or (iii) a line end. For the
8744 second case, IT->nglyphs - 1 padding glyphs will be present.
8745 (On X frames, there is only one glyph produced for a
8746 composite character.)
8748 The behavior implemented below means, for continuation lines,
8749 that as many spaces of a TAB as fit on the current line are
8750 displayed there. For terminal frames, as many glyphs of a
8751 multi-glyph character are displayed in the current line, too.
8752 This is what the old redisplay code did, and we keep it that
8753 way. Under X, the whole shape of a complex character must
8754 fit on the line or it will be completely displayed in the
8757 Note that both for tabs and padding glyphs, all glyphs have
8761 /* More than one glyph or glyph doesn't fit on line. All
8762 glyphs have the same width. */
8763 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8765 int x_before_this_char
= x
;
8766 int hpos_before_this_char
= it
->hpos
;
8768 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8770 new_x
= x
+ single_glyph_width
;
8772 /* We want to leave anything reaching TO_X to the caller. */
8773 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8775 if (BUFFER_POS_REACHED_P ())
8777 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8778 goto buffer_pos_reached
;
8779 if (atpos_it
.sp
< 0)
8781 SAVE_IT (atpos_it
, *it
, atpos_data
);
8782 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8787 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8790 result
= MOVE_X_REACHED
;
8795 SAVE_IT (atx_it
, *it
, atx_data
);
8796 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8801 if (/* Lines are continued. */
8802 it
->line_wrap
!= TRUNCATE
8803 && (/* And glyph doesn't fit on the line. */
8804 new_x
> it
->last_visible_x
8805 /* Or it fits exactly and we're on a window
8807 || (new_x
== it
->last_visible_x
8808 && FRAME_WINDOW_P (it
->f
)
8809 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8810 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8811 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8813 bool moved_forward
= false;
8815 if (/* IT->hpos == 0 means the very first glyph
8816 doesn't fit on the line, e.g. a wide image. */
8818 || (new_x
== it
->last_visible_x
8819 && FRAME_WINDOW_P (it
->f
)))
8822 it
->current_x
= new_x
;
8824 /* The character's last glyph just barely fits
8826 if (i
== it
->nglyphs
- 1)
8828 /* If this is the destination position,
8829 return a position *before* it in this row,
8830 now that we know it fits in this row. */
8831 if (BUFFER_POS_REACHED_P ())
8833 bool can_wrap
= true;
8835 /* If we are at a whitespace character
8836 that barely fits on this screen line,
8837 but the next character is also
8838 whitespace, we cannot wrap here. */
8839 if (it
->line_wrap
== WORD_WRAP
8842 && IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8845 void *tem_data
= NULL
;
8847 SAVE_IT (tem_it
, *it
, tem_data
);
8848 set_iterator_to_next (it
, true);
8849 if (get_next_display_element (it
)
8850 && IT_DISPLAYING_WHITESPACE (it
))
8852 RESTORE_IT (it
, &tem_it
, tem_data
);
8854 if (it
->line_wrap
!= WORD_WRAP
8856 /* If we've just found whitespace
8857 where we can wrap, effectively
8858 ignore the previous wrap point --
8859 it is no longer relevant, but we
8860 won't have an opportunity to
8861 update it, since we've reached
8862 the edge of this screen line. */
8863 || (may_wrap
&& can_wrap
8864 && IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8866 it
->hpos
= hpos_before_this_char
;
8867 it
->current_x
= x_before_this_char
;
8868 result
= MOVE_POS_MATCH_OR_ZV
;
8871 if (it
->line_wrap
== WORD_WRAP
8874 SAVE_IT (atpos_it
, *it
, atpos_data
);
8875 atpos_it
.current_x
= x_before_this_char
;
8876 atpos_it
.hpos
= hpos_before_this_char
;
8880 prev_method
= it
->method
;
8881 if (it
->method
== GET_FROM_BUFFER
)
8882 prev_pos
= IT_CHARPOS (*it
);
8883 set_iterator_to_next (it
, true);
8884 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8885 SET_TEXT_POS (this_line_min_pos
,
8886 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8887 /* On graphical terminals, newlines may
8888 "overflow" into the fringe if
8889 overflow-newline-into-fringe is non-nil.
8890 On text terminals, and on graphical
8891 terminals with no right margin, newlines
8892 may overflow into the last glyph on the
8894 if (!FRAME_WINDOW_P (it
->f
)
8896 && it
->bidi_it
.paragraph_dir
== R2L
)
8897 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8898 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8899 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8901 if (!get_next_display_element (it
))
8903 result
= MOVE_POS_MATCH_OR_ZV
;
8906 moved_forward
= true;
8907 if (BUFFER_POS_REACHED_P ())
8909 if (ITERATOR_AT_END_OF_LINE_P (it
))
8910 result
= MOVE_POS_MATCH_OR_ZV
;
8912 result
= MOVE_LINE_CONTINUED
;
8915 if (ITERATOR_AT_END_OF_LINE_P (it
)
8916 && (it
->line_wrap
!= WORD_WRAP
8918 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8920 result
= MOVE_NEWLINE_OR_CR
;
8927 IT_RESET_X_ASCENT_DESCENT (it
);
8929 /* If the screen line ends with whitespace, and we
8930 are under word-wrap, don't use wrap_it: it is no
8931 longer relevant, but we won't have an opportunity
8932 to update it, since we are done with this screen
8934 if (may_wrap
&& IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)
8935 /* If the character after the one which set the
8936 may_wrap flag is also whitespace, we can't
8937 wrap here, since the screen line cannot be
8938 wrapped in the middle of whitespace.
8939 Therefore, wrap_it _is_ relevant in that
8941 && !(moved_forward
&& IT_DISPLAYING_WHITESPACE (it
)))
8943 /* If we've found TO_X, go back there, as we now
8944 know the last word fits on this screen line. */
8945 if ((op
& MOVE_TO_X
) && new_x
== it
->last_visible_x
8948 RESTORE_IT (it
, &atx_it
, atx_data
);
8951 result
= MOVE_X_REACHED
;
8955 else if (wrap_it
.sp
>= 0)
8957 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8962 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8964 result
= MOVE_LINE_CONTINUED
;
8968 if (BUFFER_POS_REACHED_P ())
8970 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8971 goto buffer_pos_reached
;
8972 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8974 SAVE_IT (atpos_it
, *it
, atpos_data
);
8975 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8979 if (new_x
> it
->first_visible_x
)
8981 /* Glyph is visible. Increment number of glyphs that
8982 would be displayed. */
8987 if (result
!= MOVE_UNDEFINED
)
8990 else if (BUFFER_POS_REACHED_P ())
8993 IT_RESET_X_ASCENT_DESCENT (it
);
8994 result
= MOVE_POS_MATCH_OR_ZV
;
8997 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8999 /* Stop when TO_X specified and reached. This check is
9000 necessary here because of lines consisting of a line end,
9001 only. The line end will not produce any glyphs and we
9002 would never get MOVE_X_REACHED. */
9003 eassert (it
->nglyphs
== 0);
9004 result
= MOVE_X_REACHED
;
9008 /* Is this a line end? If yes, we're done. */
9009 if (ITERATOR_AT_END_OF_LINE_P (it
))
9011 /* If we are past TO_CHARPOS, but never saw any character
9012 positions smaller than TO_CHARPOS, return
9013 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
9015 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
9017 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
9019 if (closest_pos
< ZV
)
9021 RESTORE_IT (it
, &ppos_it
, ppos_data
);
9022 /* Don't recurse if closest_pos is equal to
9023 to_charpos, since we have just tried that. */
9024 if (closest_pos
!= to_charpos
)
9025 move_it_in_display_line_to (it
, closest_pos
, -1,
9027 result
= MOVE_POS_MATCH_OR_ZV
;
9030 goto buffer_pos_reached
;
9032 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
9033 && IT_CHARPOS (*it
) > to_charpos
)
9034 goto buffer_pos_reached
;
9036 result
= MOVE_NEWLINE_OR_CR
;
9039 result
= MOVE_NEWLINE_OR_CR
;
9043 prev_method
= it
->method
;
9044 if (it
->method
== GET_FROM_BUFFER
)
9045 prev_pos
= IT_CHARPOS (*it
);
9046 /* The current display element has been consumed. Advance
9048 set_iterator_to_next (it
, true);
9049 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
9050 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
9051 if (IT_CHARPOS (*it
) < to_charpos
)
9052 saw_smaller_pos
= true;
9054 && (op
& MOVE_TO_POS
)
9055 && IT_CHARPOS (*it
) >= to_charpos
9056 && IT_CHARPOS (*it
) < closest_pos
)
9057 closest_pos
= IT_CHARPOS (*it
);
9059 /* Stop if lines are truncated and IT's current x-position is
9060 past the right edge of the window now. */
9061 if (it
->line_wrap
== TRUNCATE
9062 && it
->current_x
>= it
->last_visible_x
)
9064 if (!FRAME_WINDOW_P (it
->f
)
9065 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
9066 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
9067 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
9068 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
9070 bool at_eob_p
= false;
9072 if ((at_eob_p
= !get_next_display_element (it
))
9073 || BUFFER_POS_REACHED_P ()
9074 /* If we are past TO_CHARPOS, but never saw any
9075 character positions smaller than TO_CHARPOS,
9076 return MOVE_POS_MATCH_OR_ZV, like the
9077 unidirectional display did. */
9078 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
9080 && IT_CHARPOS (*it
) > to_charpos
))
9083 && !BUFFER_POS_REACHED_P ()
9084 && !at_eob_p
&& closest_pos
< ZV
)
9086 RESTORE_IT (it
, &ppos_it
, ppos_data
);
9087 if (closest_pos
!= to_charpos
)
9088 move_it_in_display_line_to (it
, closest_pos
, -1,
9091 result
= MOVE_POS_MATCH_OR_ZV
;
9094 if (ITERATOR_AT_END_OF_LINE_P (it
))
9096 result
= MOVE_NEWLINE_OR_CR
;
9100 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
9102 && IT_CHARPOS (*it
) > to_charpos
)
9104 if (closest_pos
< ZV
)
9106 RESTORE_IT (it
, &ppos_it
, ppos_data
);
9107 if (closest_pos
!= to_charpos
)
9108 move_it_in_display_line_to (it
, closest_pos
, -1,
9111 result
= MOVE_POS_MATCH_OR_ZV
;
9114 result
= MOVE_LINE_TRUNCATED
;
9117 #undef IT_RESET_X_ASCENT_DESCENT
9120 #undef BUFFER_POS_REACHED_P
9122 /* If we scanned beyond TO_POS, restore the saved iterator either to
9123 the wrap point (if found), or to atpos/atx location. We decide which
9124 data to use to restore the saved iterator state by their X coordinates,
9125 since buffer positions might increase non-monotonically with screen
9126 coordinates due to bidi reordering. */
9127 if (result
== MOVE_LINE_CONTINUED
9128 && it
->line_wrap
== WORD_WRAP
9130 && ((atpos_it
.sp
>= 0 && wrap_it
.current_x
< atpos_it
.current_x
)
9131 || (atx_it
.sp
>= 0 && wrap_it
.current_x
< atx_it
.current_x
)))
9132 RESTORE_IT (it
, &wrap_it
, wrap_data
);
9133 else if (atpos_it
.sp
>= 0)
9134 RESTORE_IT (it
, &atpos_it
, atpos_data
);
9135 else if (atx_it
.sp
>= 0)
9136 RESTORE_IT (it
, &atx_it
, atx_data
);
9141 bidi_unshelve_cache (atpos_data
, true);
9143 bidi_unshelve_cache (atx_data
, true);
9145 bidi_unshelve_cache (wrap_data
, true);
9147 bidi_unshelve_cache (ppos_data
, true);
9149 /* Restore the iterator settings altered at the beginning of this
9151 it
->glyph_row
= saved_glyph_row
;
9155 /* For external use. */
9157 move_it_in_display_line (struct it
*it
,
9158 ptrdiff_t to_charpos
, int to_x
,
9159 enum move_operation_enum op
)
9161 if (it
->line_wrap
== WORD_WRAP
9162 && (op
& MOVE_TO_X
))
9165 void *save_data
= NULL
;
9168 SAVE_IT (save_it
, *it
, save_data
);
9169 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9170 /* When word-wrap is on, TO_X may lie past the end
9171 of a wrapped line. Then it->current is the
9172 character on the next line, so backtrack to the
9173 space before the wrap point. */
9174 if (skip
== MOVE_LINE_CONTINUED
)
9176 int prev_x
= max (it
->current_x
- 1, 0);
9177 RESTORE_IT (it
, &save_it
, save_data
);
9178 move_it_in_display_line_to
9179 (it
, -1, prev_x
, MOVE_TO_X
);
9182 bidi_unshelve_cache (save_data
, true);
9185 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9189 /* Move IT forward until it satisfies one or more of the criteria in
9190 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9192 OP is a bit-mask that specifies where to stop, and in particular,
9193 which of those four position arguments makes a difference. See the
9194 description of enum move_operation_enum.
9196 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9197 screen line, this function will set IT to the next position that is
9198 displayed to the right of TO_CHARPOS on the screen.
9200 Return the maximum pixel length of any line scanned but never more
9201 than it.last_visible_x. */
9204 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9206 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9207 int line_height
, line_start_x
= 0, reached
= 0;
9208 int max_current_x
= 0;
9209 void *backup_data
= NULL
;
9213 if (op
& MOVE_TO_VPOS
)
9215 /* If no TO_CHARPOS and no TO_X specified, stop at the
9216 start of the line TO_VPOS. */
9217 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9219 if (it
->vpos
== to_vpos
)
9225 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9229 /* TO_VPOS >= 0 means stop at TO_X in the line at
9230 TO_VPOS, or at TO_POS, whichever comes first. */
9231 if (it
->vpos
== to_vpos
)
9237 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9239 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9244 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9246 /* We have reached TO_X but not in the line we want. */
9247 skip
= move_it_in_display_line_to (it
, to_charpos
,
9249 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9257 else if (op
& MOVE_TO_Y
)
9259 struct it it_backup
;
9261 if (it
->line_wrap
== WORD_WRAP
)
9262 SAVE_IT (it_backup
, *it
, backup_data
);
9264 /* TO_Y specified means stop at TO_X in the line containing
9265 TO_Y---or at TO_CHARPOS if this is reached first. The
9266 problem is that we can't really tell whether the line
9267 contains TO_Y before we have completely scanned it, and
9268 this may skip past TO_X. What we do is to first scan to
9271 If TO_X is not specified, use a TO_X of zero. The reason
9272 is to make the outcome of this function more predictable.
9273 If we didn't use TO_X == 0, we would stop at the end of
9274 the line which is probably not what a caller would expect
9276 skip
= move_it_in_display_line_to
9277 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9278 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9280 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9281 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9283 else if (skip
== MOVE_X_REACHED
)
9285 /* If TO_X was reached, we want to know whether TO_Y is
9286 in the line. We know this is the case if the already
9287 scanned glyphs make the line tall enough. Otherwise,
9288 we must check by scanning the rest of the line. */
9289 line_height
= it
->max_ascent
+ it
->max_descent
;
9290 if (to_y
>= it
->current_y
9291 && to_y
< it
->current_y
+ line_height
)
9296 SAVE_IT (it_backup
, *it
, backup_data
);
9297 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9298 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9300 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9301 line_height
= it
->max_ascent
+ it
->max_descent
;
9302 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9304 if (to_y
>= it
->current_y
9305 && to_y
< it
->current_y
+ line_height
)
9307 /* If TO_Y is in this line and TO_X was reached
9308 above, we scanned too far. We have to restore
9309 IT's settings to the ones before skipping. But
9310 keep the more accurate values of max_ascent and
9311 max_descent we've found while skipping the rest
9312 of the line, for the sake of callers, such as
9313 pos_visible_p, that need to know the line
9315 int max_ascent
= it
->max_ascent
;
9316 int max_descent
= it
->max_descent
;
9318 RESTORE_IT (it
, &it_backup
, backup_data
);
9319 it
->max_ascent
= max_ascent
;
9320 it
->max_descent
= max_descent
;
9326 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9332 /* Check whether TO_Y is in this line. */
9333 line_height
= it
->max_ascent
+ it
->max_descent
;
9334 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9336 if (to_y
>= it
->current_y
9337 && to_y
< it
->current_y
+ line_height
)
9339 if (to_y
> it
->current_y
)
9340 max_current_x
= max (it
->current_x
, max_current_x
);
9342 /* When word-wrap is on, TO_X may lie past the end
9343 of a wrapped line. Then it->current is the
9344 character on the next line, so backtrack to the
9345 space before the wrap point. */
9346 if (skip
== MOVE_LINE_CONTINUED
9347 && it
->line_wrap
== WORD_WRAP
)
9349 int prev_x
= max (it
->current_x
- 1, 0);
9350 RESTORE_IT (it
, &it_backup
, backup_data
);
9351 skip
= move_it_in_display_line_to
9352 (it
, -1, prev_x
, MOVE_TO_X
);
9361 max_current_x
= max (it
->current_x
, max_current_x
);
9365 else if (BUFFERP (it
->object
)
9366 && (it
->method
== GET_FROM_BUFFER
9367 || it
->method
== GET_FROM_STRETCH
)
9368 && IT_CHARPOS (*it
) >= to_charpos
9369 /* Under bidi iteration, a call to set_iterator_to_next
9370 can scan far beyond to_charpos if the initial
9371 portion of the next line needs to be reordered. In
9372 that case, give move_it_in_display_line_to another
9375 && it
->bidi_it
.scan_dir
== -1))
9376 skip
= MOVE_POS_MATCH_OR_ZV
;
9378 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9382 case MOVE_POS_MATCH_OR_ZV
:
9383 max_current_x
= max (it
->current_x
, max_current_x
);
9387 case MOVE_NEWLINE_OR_CR
:
9388 max_current_x
= max (it
->current_x
, max_current_x
);
9389 set_iterator_to_next (it
, true);
9390 it
->continuation_lines_width
= 0;
9393 case MOVE_LINE_TRUNCATED
:
9394 max_current_x
= it
->last_visible_x
;
9395 it
->continuation_lines_width
= 0;
9396 reseat_at_next_visible_line_start (it
, false);
9397 if ((op
& MOVE_TO_POS
) != 0
9398 && IT_CHARPOS (*it
) > to_charpos
)
9405 case MOVE_LINE_CONTINUED
:
9406 max_current_x
= it
->last_visible_x
;
9407 /* For continued lines ending in a tab, some of the glyphs
9408 associated with the tab are displayed on the current
9409 line. Since it->current_x does not include these glyphs,
9410 we use it->last_visible_x instead. */
9413 it
->continuation_lines_width
+= it
->last_visible_x
;
9414 /* When moving by vpos, ensure that the iterator really
9415 advances to the next line (bug#847, bug#969). Fixme:
9416 do we need to do this in other circumstances? */
9417 if (it
->current_x
!= it
->last_visible_x
9418 && (op
& MOVE_TO_VPOS
)
9419 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9421 line_start_x
= it
->current_x
+ it
->pixel_width
9422 - it
->last_visible_x
;
9423 if (FRAME_WINDOW_P (it
->f
))
9425 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9426 struct font
*face_font
= face
->font
;
9428 /* When display_line produces a continued line
9429 that ends in a TAB, it skips a tab stop that
9430 is closer than the font's space character
9431 width (see x_produce_glyphs where it produces
9432 the stretch glyph which represents a TAB).
9433 We need to reproduce the same logic here. */
9434 eassert (face_font
);
9437 if (line_start_x
< face_font
->space_width
)
9439 += it
->tab_width
* face_font
->space_width
;
9442 set_iterator_to_next (it
, false);
9446 it
->continuation_lines_width
+= it
->current_x
;
9453 /* Reset/increment for the next run. */
9454 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9455 it
->current_x
= line_start_x
;
9458 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9460 last_height
= it
->max_ascent
+ it
->max_descent
;
9461 it
->max_ascent
= it
->max_descent
= 0;
9466 /* On text terminals, we may stop at the end of a line in the middle
9467 of a multi-character glyph. If the glyph itself is continued,
9468 i.e. it is actually displayed on the next line, don't treat this
9469 stopping point as valid; move to the next line instead (unless
9470 that brings us offscreen). */
9471 if (!FRAME_WINDOW_P (it
->f
)
9473 && IT_CHARPOS (*it
) == to_charpos
9474 && it
->what
== IT_CHARACTER
9476 && it
->line_wrap
== WINDOW_WRAP
9477 && it
->current_x
== it
->last_visible_x
- 1
9480 && it
->w
->window_end_valid
9481 && it
->vpos
< it
->w
->window_end_vpos
)
9483 it
->continuation_lines_width
+= it
->current_x
;
9484 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9485 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9487 last_height
= it
->max_ascent
+ it
->max_descent
;
9491 bidi_unshelve_cache (backup_data
, true);
9493 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9495 return max_current_x
;
9499 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9501 If DY > 0, move IT backward at least that many pixels. DY = 0
9502 means move IT backward to the preceding line start or BEGV. This
9503 function may move over more than DY pixels if IT->current_y - DY
9504 ends up in the middle of a line; in this case IT->current_y will be
9505 set to the top of the line moved to. */
9508 move_it_vertically_backward (struct it
*it
, int dy
)
9512 void *it2data
= NULL
, *it3data
= NULL
;
9513 ptrdiff_t start_pos
;
9515 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9516 ptrdiff_t pos_limit
;
9521 start_pos
= IT_CHARPOS (*it
);
9523 /* Estimate how many newlines we must move back. */
9524 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9525 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9528 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9530 /* Set the iterator's position that many lines back. But don't go
9531 back more than NLINES full screen lines -- this wins a day with
9532 buffers which have very long lines. */
9533 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9534 back_to_previous_visible_line_start (it
);
9536 /* Reseat the iterator here. When moving backward, we don't want
9537 reseat to skip forward over invisible text, set up the iterator
9538 to deliver from overlay strings at the new position etc. So,
9539 use reseat_1 here. */
9540 reseat_1 (it
, it
->current
.pos
, true);
9542 /* We are now surely at a line start. */
9543 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9544 reordering is in effect. */
9545 it
->continuation_lines_width
= 0;
9547 /* Move forward and see what y-distance we moved. First move to the
9548 start of the next line so that we get its height. We need this
9549 height to be able to tell whether we reached the specified
9551 SAVE_IT (it2
, *it
, it2data
);
9552 it2
.max_ascent
= it2
.max_descent
= 0;
9555 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9556 MOVE_TO_POS
| MOVE_TO_VPOS
);
9558 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9559 /* If we are in a display string which starts at START_POS,
9560 and that display string includes a newline, and we are
9561 right after that newline (i.e. at the beginning of a
9562 display line), exit the loop, because otherwise we will
9563 infloop, since move_it_to will see that it is already at
9564 START_POS and will not move. */
9565 || (it2
.method
== GET_FROM_STRING
9566 && IT_CHARPOS (it2
) == start_pos
9567 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9568 eassert (IT_CHARPOS (*it
) >= BEGV
);
9569 SAVE_IT (it3
, it2
, it3data
);
9571 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9572 eassert (IT_CHARPOS (*it
) >= BEGV
);
9573 /* H is the actual vertical distance from the position in *IT
9574 and the starting position. */
9575 h
= it2
.current_y
- it
->current_y
;
9576 /* NLINES is the distance in number of lines. */
9577 nlines
= it2
.vpos
- it
->vpos
;
9579 /* Correct IT's y and vpos position
9580 so that they are relative to the starting point. */
9586 /* DY == 0 means move to the start of the screen line. The
9587 value of nlines is > 0 if continuation lines were involved,
9588 or if the original IT position was at start of a line. */
9589 RESTORE_IT (it
, it
, it2data
);
9591 move_it_by_lines (it
, nlines
);
9592 /* The above code moves us to some position NLINES down,
9593 usually to its first glyph (leftmost in an L2R line), but
9594 that's not necessarily the start of the line, under bidi
9595 reordering. We want to get to the character position
9596 that is immediately after the newline of the previous
9599 && !it
->continuation_lines_width
9600 && !STRINGP (it
->string
)
9601 && IT_CHARPOS (*it
) > BEGV
9602 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9604 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9607 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9608 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9610 bidi_unshelve_cache (it3data
, true);
9614 /* The y-position we try to reach, relative to *IT.
9615 Note that H has been subtracted in front of the if-statement. */
9616 int target_y
= it
->current_y
+ h
- dy
;
9617 int y0
= it3
.current_y
;
9621 RESTORE_IT (&it3
, &it3
, it3data
);
9622 y1
= line_bottom_y (&it3
);
9623 line_height
= y1
- y0
;
9624 RESTORE_IT (it
, it
, it2data
);
9625 /* If we did not reach target_y, try to move further backward if
9626 we can. If we moved too far backward, try to move forward. */
9627 if (target_y
< it
->current_y
9628 /* This is heuristic. In a window that's 3 lines high, with
9629 a line height of 13 pixels each, recentering with point
9630 on the bottom line will try to move -39/2 = 19 pixels
9631 backward. Try to avoid moving into the first line. */
9632 && (it
->current_y
- target_y
9633 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9634 && IT_CHARPOS (*it
) > BEGV
)
9636 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9637 target_y
- it
->current_y
));
9638 dy
= it
->current_y
- target_y
;
9639 goto move_further_back
;
9641 else if (target_y
>= it
->current_y
+ line_height
9642 && IT_CHARPOS (*it
) < ZV
)
9644 /* Should move forward by at least one line, maybe more.
9646 Note: Calling move_it_by_lines can be expensive on
9647 terminal frames, where compute_motion is used (via
9648 vmotion) to do the job, when there are very long lines
9649 and truncate-lines is nil. That's the reason for
9650 treating terminal frames specially here. */
9652 if (!FRAME_WINDOW_P (it
->f
))
9653 move_it_vertically (it
, target_y
- it
->current_y
);
9658 move_it_by_lines (it
, 1);
9660 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9667 /* Move IT by a specified amount of pixel lines DY. DY negative means
9668 move backwards. DY = 0 means move to start of screen line. At the
9669 end, IT will be on the start of a screen line. */
9672 move_it_vertically (struct it
*it
, int dy
)
9675 move_it_vertically_backward (it
, -dy
);
9678 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9679 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9680 MOVE_TO_POS
| MOVE_TO_Y
);
9681 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9683 /* If buffer ends in ZV without a newline, move to the start of
9684 the line to satisfy the post-condition. */
9685 if (IT_CHARPOS (*it
) == ZV
9687 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9688 move_it_by_lines (it
, 0);
9693 /* Move iterator IT past the end of the text line it is in. */
9696 move_it_past_eol (struct it
*it
)
9698 enum move_it_result rc
;
9700 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9701 if (rc
== MOVE_NEWLINE_OR_CR
)
9702 set_iterator_to_next (it
, false);
9706 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9707 negative means move up. DVPOS == 0 means move to the start of the
9710 Optimization idea: If we would know that IT->f doesn't use
9711 a face with proportional font, we could be faster for
9712 truncate-lines nil. */
9715 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9718 /* The commented-out optimization uses vmotion on terminals. This
9719 gives bad results, because elements like it->what, on which
9720 callers such as pos_visible_p rely, aren't updated. */
9721 /* struct position pos;
9722 if (!FRAME_WINDOW_P (it->f))
9724 struct text_pos textpos;
9726 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9727 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9728 reseat (it, textpos, true);
9729 it->vpos += pos.vpos;
9730 it->current_y += pos.vpos;
9736 /* DVPOS == 0 means move to the start of the screen line. */
9737 move_it_vertically_backward (it
, 0);
9738 /* Let next call to line_bottom_y calculate real line height. */
9743 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9744 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9746 /* Only move to the next buffer position if we ended up in a
9747 string from display property, not in an overlay string
9748 (before-string or after-string). That is because the
9749 latter don't conceal the underlying buffer position, so
9750 we can ask to move the iterator to the exact position we
9751 are interested in. Note that, even if we are already at
9752 IT_CHARPOS (*it), the call below is not a no-op, as it
9753 will detect that we are at the end of the string, pop the
9754 iterator, and compute it->current_x and it->hpos
9756 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9757 -1, -1, -1, MOVE_TO_POS
);
9763 void *it2data
= NULL
;
9764 ptrdiff_t start_charpos
, i
;
9766 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9767 bool hit_pos_limit
= false;
9768 ptrdiff_t pos_limit
;
9770 /* Start at the beginning of the screen line containing IT's
9771 position. This may actually move vertically backwards,
9772 in case of overlays, so adjust dvpos accordingly. */
9774 move_it_vertically_backward (it
, 0);
9777 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9778 screen lines, and reseat the iterator there. */
9779 start_charpos
= IT_CHARPOS (*it
);
9780 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9783 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9785 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9786 back_to_previous_visible_line_start (it
);
9787 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9788 hit_pos_limit
= true;
9789 reseat (it
, it
->current
.pos
, true);
9791 /* Move further back if we end up in a string or an image. */
9792 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9794 /* First try to move to start of display line. */
9796 move_it_vertically_backward (it
, 0);
9798 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9800 /* If start of line is still in string or image,
9801 move further back. */
9802 back_to_previous_visible_line_start (it
);
9803 reseat (it
, it
->current
.pos
, true);
9807 it
->current_x
= it
->hpos
= 0;
9809 /* Above call may have moved too far if continuation lines
9810 are involved. Scan forward and see if it did. */
9811 SAVE_IT (it2
, *it
, it2data
);
9812 it2
.vpos
= it2
.current_y
= 0;
9813 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9814 it
->vpos
-= it2
.vpos
;
9815 it
->current_y
-= it2
.current_y
;
9816 it
->current_x
= it
->hpos
= 0;
9818 /* If we moved too far back, move IT some lines forward. */
9819 if (it2
.vpos
> -dvpos
)
9821 int delta
= it2
.vpos
+ dvpos
;
9823 RESTORE_IT (&it2
, &it2
, it2data
);
9824 SAVE_IT (it2
, *it
, it2data
);
9825 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9826 /* Move back again if we got too far ahead. */
9827 if (IT_CHARPOS (*it
) >= start_charpos
)
9828 RESTORE_IT (it
, &it2
, it2data
);
9830 bidi_unshelve_cache (it2data
, true);
9832 else if (hit_pos_limit
&& pos_limit
> BEGV
9833 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9835 /* If we hit the limit, but still didn't make it far enough
9836 back, that means there's a display string with a newline
9837 covering a large chunk of text, and that caused
9838 back_to_previous_visible_line_start try to go too far.
9839 Punish those who commit such atrocities by going back
9840 until we've reached DVPOS, after lifting the limit, which
9841 could make it slow for very long lines. "If it hurts,
9844 RESTORE_IT (it
, it
, it2data
);
9845 for (i
= -dvpos
; i
> 0; --i
)
9847 back_to_previous_visible_line_start (it
);
9850 reseat_1 (it
, it
->current
.pos
, true);
9853 RESTORE_IT (it
, it
, it2data
);
9857 /* Return true if IT points into the middle of a display vector. */
9860 in_display_vector_p (struct it
*it
)
9862 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9863 && it
->current
.dpvec_index
> 0
9864 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9867 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9868 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9869 WINDOW must be a live window and defaults to the selected one. The
9870 return value is a cons of the maximum pixel-width of any text line and
9871 the maximum pixel-height of all text lines.
9873 The optional argument FROM, if non-nil, specifies the first text
9874 position and defaults to the minimum accessible position of the buffer.
9875 If FROM is t, use the minimum accessible position that starts a
9876 non-empty line. TO, if non-nil, specifies the last text position and
9877 defaults to the maximum accessible position of the buffer. If TO is t,
9878 use the maximum accessible position that ends a non-empty line.
9880 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9881 width that can be returned. X-LIMIT nil or omitted, means to use the
9882 pixel-width of WINDOW's body; use this if you want to know how high
9883 WINDOW should be become in order to fit all of its buffer's text with
9884 the width of WINDOW unaltered. Use the maximum width WINDOW may assume
9885 if you intend to change WINDOW's width. In any case, text whose
9886 x-coordinate is beyond X-LIMIT is ignored. Since calculating the width
9887 of long lines can take some time, it's always a good idea to make this
9888 argument as small as possible; in particular, if the buffer contains
9889 long lines that shall be truncated anyway.
9891 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9892 height (excluding the height of the mode- or header-line, if any) that
9893 can be returned. Text lines whose y-coordinate is beyond Y-LIMIT are
9894 ignored. Since calculating the text height of a large buffer can take
9895 some time, it makes sense to specify this argument if the size of the
9896 buffer is large or unknown.
9898 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9899 include the height of the mode- or header-line of WINDOW in the return
9900 value. If it is either the symbol `mode-line' or `header-line', include
9901 only the height of that line, if present, in the return value. If t,
9902 include the height of both, if present, in the return value. */)
9903 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
,
9904 Lisp_Object y_limit
, Lisp_Object mode_and_header_line
)
9906 struct window
*w
= decode_live_window (window
);
9907 Lisp_Object buffer
= w
->contents
;
9910 struct buffer
*old_b
= NULL
;
9911 ptrdiff_t start
, end
, pos
;
9912 struct text_pos startp
;
9913 void *itdata
= NULL
;
9914 int c
, max_x
= 0, max_y
= 0, x
= 0, y
= 0;
9916 CHECK_BUFFER (buffer
);
9917 b
= XBUFFER (buffer
);
9919 if (b
!= current_buffer
)
9921 old_b
= current_buffer
;
9922 set_buffer_internal (b
);
9927 else if (EQ (from
, Qt
))
9930 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9931 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9933 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9938 CHECK_NUMBER_COERCE_MARKER (from
);
9939 start
= min (max (XINT (from
), BEGV
), ZV
);
9944 else if (EQ (to
, Qt
))
9947 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9948 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9950 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9955 CHECK_NUMBER_COERCE_MARKER (to
);
9956 end
= max (start
, min (XINT (to
), ZV
));
9959 if (!NILP (x_limit
) && RANGED_INTEGERP (0, x_limit
, INT_MAX
))
9960 max_x
= XINT (x_limit
);
9964 else if (RANGED_INTEGERP (0, y_limit
, INT_MAX
))
9965 max_y
= XINT (y_limit
);
9967 itdata
= bidi_shelve_cache ();
9968 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9969 start_display (&it
, w
, startp
);
9972 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9975 it
.last_visible_x
= max_x
;
9976 /* Actually, we never want move_it_to stop at to_x. But to make
9977 sure that move_it_in_display_line_to always moves far enough,
9978 we set it to INT_MAX and specify MOVE_TO_X. Also bound width
9979 value by X-LIMIT. */
9980 x
= min (move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9981 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
),
9985 /* Subtract height of header-line which was counted automatically by
9987 y
= min (it
.current_y
+ it
.max_ascent
+ it
.max_descent
9988 - WINDOW_HEADER_LINE_HEIGHT (w
),
9991 if (EQ (mode_and_header_line
, Qheader_line
)
9992 || EQ (mode_and_header_line
, Qt
))
9993 /* Re-add height of header-line as requested. */
9994 y
= y
+ WINDOW_HEADER_LINE_HEIGHT (w
);
9996 if (EQ (mode_and_header_line
, Qmode_line
)
9997 || EQ (mode_and_header_line
, Qt
))
9998 /* Add height of mode-line as requested. */
9999 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
10001 bidi_unshelve_cache (itdata
, false);
10004 set_buffer_internal (old_b
);
10006 return Fcons (make_number (x
), make_number (y
));
10009 /***********************************************************************
10011 ***********************************************************************/
10013 /* Return the number of arguments the format string FORMAT needs. */
10016 format_nargs (char const *format
)
10018 ptrdiff_t nargs
= 0;
10019 for (char const *p
= format
; (p
= strchr (p
, '%')); p
++)
10027 /* Add a message with format string FORMAT and formatted arguments
10031 add_to_log (const char *format
, ...)
10034 va_start (ap
, format
);
10035 vadd_to_log (format
, ap
);
10040 vadd_to_log (char const *format
, va_list ap
)
10042 ptrdiff_t form_nargs
= format_nargs (format
);
10043 ptrdiff_t nargs
= 1 + form_nargs
;
10044 Lisp_Object args
[10];
10045 eassert (nargs
<= ARRAYELTS (args
));
10046 AUTO_STRING (args0
, format
);
10048 for (ptrdiff_t i
= 1; i
<= nargs
; i
++)
10049 args
[i
] = va_arg (ap
, Lisp_Object
);
10050 Lisp_Object msg
= Qnil
;
10051 msg
= Fformat_message (nargs
, args
);
10053 ptrdiff_t len
= SBYTES (msg
) + 1;
10055 char *buffer
= SAFE_ALLOCA (len
);
10056 memcpy (buffer
, SDATA (msg
), len
);
10058 message_dolog (buffer
, len
- 1, true, STRING_MULTIBYTE (msg
));
10063 /* Output a newline in the *Messages* buffer if "needs" one. */
10066 message_log_maybe_newline (void)
10068 if (message_log_need_newline
)
10069 message_dolog ("", 0, true, false);
10073 /* Add a string M of length NBYTES to the message log, optionally
10074 terminated with a newline when NLFLAG is true. MULTIBYTE, if
10075 true, means interpret the contents of M as multibyte. This
10076 function calls low-level routines in order to bypass text property
10077 hooks, etc. which might not be safe to run.
10079 This may GC (insert may run before/after change hooks),
10080 so the buffer M must NOT point to a Lisp string. */
10083 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
10085 const unsigned char *msg
= (const unsigned char *) m
;
10087 if (!NILP (Vmemory_full
))
10090 if (!NILP (Vmessage_log_max
))
10092 struct buffer
*oldbuf
;
10093 Lisp_Object oldpoint
, oldbegv
, oldzv
;
10094 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
10095 ptrdiff_t point_at_end
= 0;
10096 ptrdiff_t zv_at_end
= 0;
10097 Lisp_Object old_deactivate_mark
;
10099 old_deactivate_mark
= Vdeactivate_mark
;
10100 oldbuf
= current_buffer
;
10102 /* Ensure the Messages buffer exists, and switch to it.
10103 If we created it, set the major-mode. */
10104 bool newbuffer
= NILP (Fget_buffer (Vmessages_buffer_name
));
10105 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
10107 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
10108 call0 (intern ("messages-buffer-mode"));
10110 bset_undo_list (current_buffer
, Qt
);
10111 bset_cache_long_scans (current_buffer
, Qnil
);
10113 oldpoint
= message_dolog_marker1
;
10114 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
10115 oldbegv
= message_dolog_marker2
;
10116 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
10117 oldzv
= message_dolog_marker3
;
10118 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
10126 BEGV_BYTE
= BEG_BYTE
;
10129 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10131 /* Insert the string--maybe converting multibyte to single byte
10132 or vice versa, so that all the text fits the buffer. */
10134 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10140 /* Convert a multibyte string to single-byte
10141 for the *Message* buffer. */
10142 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
10144 c
= string_char_and_length (msg
+ i
, &char_bytes
);
10145 work
[0] = CHAR_TO_BYTE8 (c
);
10146 insert_1_both (work
, 1, 1, true, false, false);
10149 else if (! multibyte
10150 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10154 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10155 /* Convert a single-byte string to multibyte
10156 for the *Message* buffer. */
10157 for (i
= 0; i
< nbytes
; i
++)
10160 MAKE_CHAR_MULTIBYTE (c
);
10161 char_bytes
= CHAR_STRING (c
, str
);
10162 insert_1_both ((char *) str
, 1, char_bytes
, true, false, false);
10166 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
,
10167 true, false, false);
10171 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
10174 insert_1_both ("\n", 1, 1, true, false, false);
10176 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, false);
10178 this_bol_byte
= PT_BYTE
;
10180 /* See if this line duplicates the previous one.
10181 If so, combine duplicates. */
10182 if (this_bol
> BEG
)
10184 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, false);
10186 prev_bol_byte
= PT_BYTE
;
10188 dups
= message_log_check_duplicate (prev_bol_byte
,
10192 del_range_both (prev_bol
, prev_bol_byte
,
10193 this_bol
, this_bol_byte
, false);
10196 char dupstr
[sizeof " [ times]"
10197 + INT_STRLEN_BOUND (printmax_t
)];
10199 /* If you change this format, don't forget to also
10200 change message_log_check_duplicate. */
10201 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
10202 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
10203 insert_1_both (dupstr
, duplen
, duplen
,
10204 true, false, true);
10209 /* If we have more than the desired maximum number of lines
10210 in the *Messages* buffer now, delete the oldest ones.
10211 This is safe because we don't have undo in this buffer. */
10213 if (NATNUMP (Vmessage_log_max
))
10215 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10216 -XFASTINT (Vmessage_log_max
) - 1, false);
10217 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, false);
10220 BEGV
= marker_position (oldbegv
);
10221 BEGV_BYTE
= marker_byte_position (oldbegv
);
10230 ZV
= marker_position (oldzv
);
10231 ZV_BYTE
= marker_byte_position (oldzv
);
10235 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10237 /* We can't do Fgoto_char (oldpoint) because it will run some
10239 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10240 marker_byte_position (oldpoint
));
10242 unchain_marker (XMARKER (oldpoint
));
10243 unchain_marker (XMARKER (oldbegv
));
10244 unchain_marker (XMARKER (oldzv
));
10246 /* We called insert_1_both above with its 5th argument (PREPARE)
10247 false, which prevents insert_1_both from calling
10248 prepare_to_modify_buffer, which in turns prevents us from
10249 incrementing windows_or_buffers_changed even if *Messages* is
10250 shown in some window. So we must manually set
10251 windows_or_buffers_changed here to make up for that. */
10252 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10253 bset_redisplay (current_buffer
);
10255 set_buffer_internal (oldbuf
);
10257 message_log_need_newline
= !nlflag
;
10258 Vdeactivate_mark
= old_deactivate_mark
;
10263 /* We are at the end of the buffer after just having inserted a newline.
10264 (Note: We depend on the fact we won't be crossing the gap.)
10265 Check to see if the most recent message looks a lot like the previous one.
10266 Return 0 if different, 1 if the new one should just replace it, or a
10267 value N > 1 if we should also append " [N times]". */
10270 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10273 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10274 bool seen_dots
= false;
10275 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10276 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10278 for (i
= 0; i
< len
; i
++)
10280 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10282 if (p1
[i
] != p2
[i
])
10288 if (*p1
++ == ' ' && *p1
++ == '[')
10291 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10292 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10299 /* Display an echo area message M with a specified length of NBYTES
10300 bytes. The string may include null characters. If M is not a
10301 string, clear out any existing message, and let the mini-buffer
10304 This function cancels echoing. */
10307 message3 (Lisp_Object m
)
10309 clear_message (true, true);
10312 /* First flush out any partial line written with print. */
10313 message_log_maybe_newline ();
10316 ptrdiff_t nbytes
= SBYTES (m
);
10317 bool multibyte
= STRING_MULTIBYTE (m
);
10320 SAFE_ALLOCA_STRING (buffer
, m
);
10321 message_dolog (buffer
, nbytes
, true, multibyte
);
10324 if (! inhibit_message
)
10325 message3_nolog (m
);
10328 /* Log the message M to stderr. Log an empty line if M is not a string. */
10331 message_to_stderr (Lisp_Object m
)
10333 if (noninteractive_need_newline
)
10335 noninteractive_need_newline
= false;
10336 fputc ('\n', stderr
);
10340 Lisp_Object coding_system
= Vlocale_coding_system
;
10343 if (!NILP (Vcoding_system_for_write
))
10344 coding_system
= Vcoding_system_for_write
;
10345 if (!NILP (coding_system
))
10346 s
= code_convert_string_norecord (m
, coding_system
, true);
10350 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10352 if (!cursor_in_echo_area
)
10353 fputc ('\n', stderr
);
10357 /* The non-logging version of message3.
10358 This does not cancel echoing, because it is used for echoing.
10359 Perhaps we need to make a separate function for echoing
10360 and make this cancel echoing. */
10363 message3_nolog (Lisp_Object m
)
10365 struct frame
*sf
= SELECTED_FRAME ();
10367 if (FRAME_INITIAL_P (sf
))
10368 message_to_stderr (m
);
10369 /* Error messages get reported properly by cmd_error, so this must be just an
10370 informative message; if the frame hasn't really been initialized yet, just
10372 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10374 /* Get the frame containing the mini-buffer
10375 that the selected frame is using. */
10376 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10377 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10378 struct frame
*f
= XFRAME (frame
);
10380 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10381 Fmake_frame_visible (frame
);
10383 if (STRINGP (m
) && SCHARS (m
) > 0)
10386 if (minibuffer_auto_raise
)
10387 Fraise_frame (frame
);
10388 /* Assume we are not echoing.
10389 (If we are, echo_now will override this.) */
10390 echo_message_buffer
= Qnil
;
10393 clear_message (true, true);
10395 do_pending_window_change (false);
10396 echo_area_display (true);
10397 do_pending_window_change (false);
10398 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10399 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10404 /* Display a null-terminated echo area message M. If M is 0, clear
10405 out any existing message, and let the mini-buffer text show through.
10407 The buffer M must continue to exist until after the echo area gets
10408 cleared or some other message gets displayed there. Do not pass
10409 text that is stored in a Lisp string. Do not pass text in a buffer
10410 that was alloca'd. */
10413 message1 (const char *m
)
10415 message3 (m
? build_unibyte_string (m
) : Qnil
);
10419 /* The non-logging counterpart of message1. */
10422 message1_nolog (const char *m
)
10424 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10427 /* Display a message M which contains a single %s
10428 which gets replaced with STRING. */
10431 message_with_string (const char *m
, Lisp_Object string
, bool log
)
10433 CHECK_STRING (string
);
10436 if (noninteractive
)
10437 need_message
= !!m
;
10438 else if (!INTERACTIVE
)
10439 need_message
= false;
10442 /* The frame whose minibuffer we're going to display the message on.
10443 It may be larger than the selected frame, so we need
10444 to use its buffer, not the selected frame's buffer. */
10445 Lisp_Object mini_window
;
10446 struct frame
*f
, *sf
= SELECTED_FRAME ();
10448 /* Get the frame containing the minibuffer
10449 that the selected frame is using. */
10450 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10451 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10453 /* Error messages get reported properly by cmd_error, so this must be
10454 just an informative message; if the frame hasn't really been
10455 initialized yet, just toss it. */
10456 need_message
= f
->glyphs_initialized_p
;
10461 AUTO_STRING (fmt
, m
);
10462 Lisp_Object msg
= CALLN (Fformat_message
, fmt
, string
);
10464 if (noninteractive
)
10465 message_to_stderr (msg
);
10471 message3_nolog (msg
);
10473 /* Print should start at the beginning of the message
10474 buffer next time. */
10475 message_buf_print
= false;
10481 /* Dump an informative message to the minibuf. If M is 0, clear out
10482 any existing message, and let the mini-buffer text show through.
10484 The message must be safe ASCII and the format must not contain ` or
10485 '. If your message and format do not fit into this category,
10486 convert your arguments to Lisp objects and use Fmessage instead. */
10488 static void ATTRIBUTE_FORMAT_PRINTF (1, 0)
10489 vmessage (const char *m
, va_list ap
)
10491 if (noninteractive
)
10495 if (noninteractive_need_newline
)
10496 putc ('\n', stderr
);
10497 noninteractive_need_newline
= false;
10498 vfprintf (stderr
, m
, ap
);
10499 if (!cursor_in_echo_area
)
10500 fprintf (stderr
, "\n");
10504 else if (INTERACTIVE
)
10506 /* The frame whose mini-buffer we're going to display the message
10507 on. It may be larger than the selected frame, so we need to
10508 use its buffer, not the selected frame's buffer. */
10509 Lisp_Object mini_window
;
10510 struct frame
*f
, *sf
= SELECTED_FRAME ();
10512 /* Get the frame containing the mini-buffer
10513 that the selected frame is using. */
10514 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10515 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10517 /* Error messages get reported properly by cmd_error, so this must be
10518 just an informative message; if the frame hasn't really been
10519 initialized yet, just toss it. */
10520 if (f
->glyphs_initialized_p
)
10525 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10527 char *message_buf
= SAFE_ALLOCA (maxsize
+ 1);
10529 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10531 message3 (make_string (message_buf
, len
));
10537 /* Print should start at the beginning of the message
10538 buffer next time. */
10539 message_buf_print
= false;
10545 message (const char *m
, ...)
10554 /* Display the current message in the current mini-buffer. This is
10555 only called from error handlers in process.c, and is not time
10559 update_echo_area (void)
10561 if (!NILP (echo_area_buffer
[0]))
10563 Lisp_Object string
;
10564 string
= Fcurrent_message ();
10570 /* Make sure echo area buffers in `echo_buffers' are live.
10571 If they aren't, make new ones. */
10574 ensure_echo_area_buffers (void)
10576 for (int i
= 0; i
< 2; i
++)
10577 if (!BUFFERP (echo_buffer
[i
])
10578 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10580 Lisp_Object old_buffer
= echo_buffer
[i
];
10581 static char const name_fmt
[] = " *Echo Area %d*";
10582 char name
[sizeof name_fmt
+ INT_STRLEN_BOUND (int)];
10583 AUTO_STRING_WITH_LEN (lname
, name
, sprintf (name
, name_fmt
, i
));
10584 echo_buffer
[i
] = Fget_buffer_create (lname
);
10585 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10586 /* to force word wrap in echo area -
10587 it was decided to postpone this*/
10588 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10590 for (int j
= 0; j
< 2; j
++)
10591 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10592 echo_area_buffer
[j
] = echo_buffer
[i
];
10597 /* Call FN with args A1..A2 with either the current or last displayed
10598 echo_area_buffer as current buffer.
10600 WHICH zero means use the current message buffer
10601 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10602 from echo_buffer[] and clear it.
10604 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10605 suitable buffer from echo_buffer[] and clear it.
10607 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10608 that the current message becomes the last displayed one, choose a
10609 suitable buffer for echo_area_buffer[0], and clear it.
10611 Value is what FN returns. */
10614 with_echo_area_buffer (struct window
*w
, int which
,
10615 bool (*fn
) (ptrdiff_t, Lisp_Object
),
10616 ptrdiff_t a1
, Lisp_Object a2
)
10618 Lisp_Object buffer
;
10619 bool this_one
, the_other
, clear_buffer_p
, rc
;
10620 ptrdiff_t count
= SPECPDL_INDEX ();
10622 /* If buffers aren't live, make new ones. */
10623 ensure_echo_area_buffers ();
10625 clear_buffer_p
= false;
10628 this_one
= false, the_other
= true;
10629 else if (which
> 0)
10630 this_one
= true, the_other
= false;
10633 this_one
= false, the_other
= true;
10634 clear_buffer_p
= true;
10636 /* We need a fresh one in case the current echo buffer equals
10637 the one containing the last displayed echo area message. */
10638 if (!NILP (echo_area_buffer
[this_one
])
10639 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10640 echo_area_buffer
[this_one
] = Qnil
;
10643 /* Choose a suitable buffer from echo_buffer[] if we don't
10645 if (NILP (echo_area_buffer
[this_one
]))
10647 echo_area_buffer
[this_one
]
10648 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10649 ? echo_buffer
[the_other
]
10650 : echo_buffer
[this_one
]);
10651 clear_buffer_p
= true;
10654 buffer
= echo_area_buffer
[this_one
];
10656 /* Don't get confused by reusing the buffer used for echoing
10657 for a different purpose. */
10658 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10661 record_unwind_protect (unwind_with_echo_area_buffer
,
10662 with_echo_area_buffer_unwind_data (w
));
10664 /* Make the echo area buffer current. Note that for display
10665 purposes, it is not necessary that the displayed window's buffer
10666 == current_buffer, except for text property lookup. So, let's
10667 only set that buffer temporarily here without doing a full
10668 Fset_window_buffer. We must also change w->pointm, though,
10669 because otherwise an assertions in unshow_buffer fails, and Emacs
10671 set_buffer_internal_1 (XBUFFER (buffer
));
10674 wset_buffer (w
, buffer
);
10675 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10676 set_marker_both (w
->old_pointm
, buffer
, BEG
, BEG_BYTE
);
10679 bset_undo_list (current_buffer
, Qt
);
10680 bset_read_only (current_buffer
, Qnil
);
10681 specbind (Qinhibit_read_only
, Qt
);
10682 specbind (Qinhibit_modification_hooks
, Qt
);
10684 if (clear_buffer_p
&& Z
> BEG
)
10685 del_range (BEG
, Z
);
10687 eassert (BEGV
>= BEG
);
10688 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10692 eassert (BEGV
>= BEG
);
10693 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10695 unbind_to (count
, Qnil
);
10700 /* Save state that should be preserved around the call to the function
10701 FN called in with_echo_area_buffer. */
10704 with_echo_area_buffer_unwind_data (struct window
*w
)
10707 Lisp_Object vector
, tmp
;
10709 /* Reduce consing by keeping one vector in
10710 Vwith_echo_area_save_vector. */
10711 vector
= Vwith_echo_area_save_vector
;
10712 Vwith_echo_area_save_vector
= Qnil
;
10715 vector
= Fmake_vector (make_number (11), Qnil
);
10717 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10718 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10719 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10723 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10724 ASET (vector
, i
, w
->contents
); ++i
;
10725 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10726 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10727 ASET (vector
, i
, make_number (marker_position (w
->old_pointm
))); ++i
;
10728 ASET (vector
, i
, make_number (marker_byte_position (w
->old_pointm
))); ++i
;
10729 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10730 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10735 for (; i
< end
; ++i
)
10736 ASET (vector
, i
, Qnil
);
10739 eassert (i
== ASIZE (vector
));
10744 /* Restore global state from VECTOR which was created by
10745 with_echo_area_buffer_unwind_data. */
10748 unwind_with_echo_area_buffer (Lisp_Object vector
)
10750 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10751 Vdeactivate_mark
= AREF (vector
, 1);
10752 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10754 if (WINDOWP (AREF (vector
, 3)))
10757 Lisp_Object buffer
;
10759 w
= XWINDOW (AREF (vector
, 3));
10760 buffer
= AREF (vector
, 4);
10762 wset_buffer (w
, buffer
);
10763 set_marker_both (w
->pointm
, buffer
,
10764 XFASTINT (AREF (vector
, 5)),
10765 XFASTINT (AREF (vector
, 6)));
10766 set_marker_both (w
->old_pointm
, buffer
,
10767 XFASTINT (AREF (vector
, 7)),
10768 XFASTINT (AREF (vector
, 8)));
10769 set_marker_both (w
->start
, buffer
,
10770 XFASTINT (AREF (vector
, 9)),
10771 XFASTINT (AREF (vector
, 10)));
10774 Vwith_echo_area_save_vector
= vector
;
10778 /* Set up the echo area for use by print functions. MULTIBYTE_P
10779 means we will print multibyte. */
10782 setup_echo_area_for_printing (bool multibyte_p
)
10784 /* If we can't find an echo area any more, exit. */
10785 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10786 Fkill_emacs (Qnil
);
10788 ensure_echo_area_buffers ();
10790 if (!message_buf_print
)
10792 /* A message has been output since the last time we printed.
10793 Choose a fresh echo area buffer. */
10794 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10795 echo_area_buffer
[0] = echo_buffer
[1];
10797 echo_area_buffer
[0] = echo_buffer
[0];
10799 /* Switch to that buffer and clear it. */
10800 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10801 bset_truncate_lines (current_buffer
, Qnil
);
10805 ptrdiff_t count
= SPECPDL_INDEX ();
10806 specbind (Qinhibit_read_only
, Qt
);
10807 /* Note that undo recording is always disabled. */
10808 del_range (BEG
, Z
);
10809 unbind_to (count
, Qnil
);
10811 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10813 /* Set up the buffer for the multibyteness we need. */
10815 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10816 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10818 /* Raise the frame containing the echo area. */
10819 if (minibuffer_auto_raise
)
10821 struct frame
*sf
= SELECTED_FRAME ();
10822 Lisp_Object mini_window
;
10823 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10824 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10827 message_log_maybe_newline ();
10828 message_buf_print
= true;
10832 if (NILP (echo_area_buffer
[0]))
10834 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10835 echo_area_buffer
[0] = echo_buffer
[1];
10837 echo_area_buffer
[0] = echo_buffer
[0];
10840 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10842 /* Someone switched buffers between print requests. */
10843 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10844 bset_truncate_lines (current_buffer
, Qnil
);
10850 /* Display an echo area message in window W. Value is true if W's
10851 height is changed. If display_last_displayed_message_p,
10852 display the message that was last displayed, otherwise
10853 display the current message. */
10856 display_echo_area (struct window
*w
)
10858 bool no_message_p
, window_height_changed_p
;
10860 /* Temporarily disable garbage collections while displaying the echo
10861 area. This is done because a GC can print a message itself.
10862 That message would modify the echo area buffer's contents while a
10863 redisplay of the buffer is going on, and seriously confuse
10865 ptrdiff_t count
= inhibit_garbage_collection ();
10867 /* If there is no message, we must call display_echo_area_1
10868 nevertheless because it resizes the window. But we will have to
10869 reset the echo_area_buffer in question to nil at the end because
10870 with_echo_area_buffer will sets it to an empty buffer. */
10871 bool i
= display_last_displayed_message_p
;
10872 /* According to the C99, C11 and C++11 standards, the integral value
10873 of a "bool" is always 0 or 1, so this array access is safe here,
10875 no_message_p
= NILP (echo_area_buffer
[i
]);
10877 window_height_changed_p
10878 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10879 display_echo_area_1
,
10880 (intptr_t) w
, Qnil
);
10883 echo_area_buffer
[i
] = Qnil
;
10885 unbind_to (count
, Qnil
);
10886 return window_height_changed_p
;
10890 /* Helper for display_echo_area. Display the current buffer which
10891 contains the current echo area message in window W, a mini-window,
10892 a pointer to which is passed in A1. A2..A4 are currently not used.
10893 Change the height of W so that all of the message is displayed.
10894 Value is true if height of W was changed. */
10897 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10900 struct window
*w
= (struct window
*) i1
;
10901 Lisp_Object window
;
10902 struct text_pos start
;
10904 /* We are about to enter redisplay without going through
10905 redisplay_internal, so we need to forget these faces by hand
10907 forget_escape_and_glyphless_faces ();
10909 /* Do this before displaying, so that we have a large enough glyph
10910 matrix for the display. If we can't get enough space for the
10911 whole text, display the last N lines. That works by setting w->start. */
10912 bool window_height_changed_p
= resize_mini_window (w
, false);
10914 /* Use the starting position chosen by resize_mini_window. */
10915 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10918 clear_glyph_matrix (w
->desired_matrix
);
10919 XSETWINDOW (window
, w
);
10920 try_window (window
, start
, 0);
10922 return window_height_changed_p
;
10926 /* Resize the echo area window to exactly the size needed for the
10927 currently displayed message, if there is one. If a mini-buffer
10928 is active, don't shrink it. */
10931 resize_echo_area_exactly (void)
10933 if (BUFFERP (echo_area_buffer
[0])
10934 && WINDOWP (echo_area_window
))
10936 struct window
*w
= XWINDOW (echo_area_window
);
10937 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10938 bool resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10939 (intptr_t) w
, resize_exactly
);
10942 windows_or_buffers_changed
= 42;
10943 update_mode_lines
= 30;
10944 redisplay_internal ();
10950 /* Callback function for with_echo_area_buffer, when used from
10951 resize_echo_area_exactly. A1 contains a pointer to the window to
10952 resize, EXACTLY non-nil means resize the mini-window exactly to the
10953 size of the text displayed. A3 and A4 are not used. Value is what
10954 resize_mini_window returns. */
10957 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10960 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10964 /* Resize mini-window W to fit the size of its contents. EXACT_P
10965 means size the window exactly to the size needed. Otherwise, it's
10966 only enlarged until W's buffer is empty.
10968 Set W->start to the right place to begin display. If the whole
10969 contents fit, start at the beginning. Otherwise, start so as
10970 to make the end of the contents appear. This is particularly
10971 important for y-or-n-p, but seems desirable generally.
10973 Value is true if the window height has been changed. */
10976 resize_mini_window (struct window
*w
, bool exact_p
)
10978 struct frame
*f
= XFRAME (w
->frame
);
10979 bool window_height_changed_p
= false;
10981 eassert (MINI_WINDOW_P (w
));
10983 /* By default, start display at the beginning. */
10984 set_marker_both (w
->start
, w
->contents
,
10985 BUF_BEGV (XBUFFER (w
->contents
)),
10986 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10988 /* Don't resize windows while redisplaying a window; it would
10989 confuse redisplay functions when the size of the window they are
10990 displaying changes from under them. Such a resizing can happen,
10991 for instance, when which-func prints a long message while
10992 we are running fontification-functions. We're running these
10993 functions with safe_call which binds inhibit-redisplay to t. */
10994 if (!NILP (Vinhibit_redisplay
))
10997 /* Nil means don't try to resize. */
10998 if (NILP (Vresize_mini_windows
)
10999 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
11002 if (!FRAME_MINIBUF_ONLY_P (f
))
11005 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
11006 + WINDOW_PIXEL_HEIGHT (w
));
11007 int unit
= FRAME_LINE_HEIGHT (f
);
11008 int height
, max_height
;
11009 struct text_pos start
;
11010 struct buffer
*old_current_buffer
= NULL
;
11012 if (current_buffer
!= XBUFFER (w
->contents
))
11014 old_current_buffer
= current_buffer
;
11015 set_buffer_internal (XBUFFER (w
->contents
));
11018 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
11020 /* Compute the max. number of lines specified by the user. */
11021 if (FLOATP (Vmax_mini_window_height
))
11022 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
11023 else if (INTEGERP (Vmax_mini_window_height
))
11024 max_height
= XINT (Vmax_mini_window_height
) * unit
;
11026 max_height
= total_height
/ 4;
11028 /* Correct that max. height if it's bogus. */
11029 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
11031 /* Find out the height of the text in the window. */
11032 if (it
.line_wrap
== TRUNCATE
)
11037 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
11038 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
11039 height
= it
.current_y
+ last_height
;
11041 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
11042 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
11045 /* Compute a suitable window start. */
11046 if (height
> max_height
)
11048 height
= (max_height
/ unit
) * unit
;
11049 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
11050 move_it_vertically_backward (&it
, height
- unit
);
11051 start
= it
.current
.pos
;
11054 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
11055 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
11057 if (EQ (Vresize_mini_windows
, Qgrow_only
))
11059 /* Let it grow only, until we display an empty message, in which
11060 case the window shrinks again. */
11061 if (height
> WINDOW_PIXEL_HEIGHT (w
))
11063 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11065 FRAME_WINDOWS_FROZEN (f
) = true;
11066 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
11067 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11069 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
11070 && (exact_p
|| BEGV
== ZV
))
11072 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11074 FRAME_WINDOWS_FROZEN (f
) = false;
11075 shrink_mini_window (w
, true);
11076 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11081 /* Always resize to exact size needed. */
11082 if (height
> WINDOW_PIXEL_HEIGHT (w
))
11084 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11086 FRAME_WINDOWS_FROZEN (f
) = true;
11087 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
11088 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11090 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
11092 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11094 FRAME_WINDOWS_FROZEN (f
) = false;
11095 shrink_mini_window (w
, true);
11099 FRAME_WINDOWS_FROZEN (f
) = true;
11100 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
11103 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11107 if (old_current_buffer
)
11108 set_buffer_internal (old_current_buffer
);
11111 return window_height_changed_p
;
11115 /* Value is the current message, a string, or nil if there is no
11116 current message. */
11119 current_message (void)
11123 if (!BUFFERP (echo_area_buffer
[0]))
11127 with_echo_area_buffer (0, 0, current_message_1
,
11128 (intptr_t) &msg
, Qnil
);
11130 echo_area_buffer
[0] = Qnil
;
11138 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
11141 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
11144 *msg
= make_buffer_string (BEG
, Z
, true);
11151 /* Push the current message on Vmessage_stack for later restoration
11152 by restore_message. Value is true if the current message isn't
11153 empty. This is a relatively infrequent operation, so it's not
11154 worth optimizing. */
11157 push_message (void)
11159 Lisp_Object msg
= current_message ();
11160 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
11161 return STRINGP (msg
);
11165 /* Restore message display from the top of Vmessage_stack. */
11168 restore_message (void)
11170 eassert (CONSP (Vmessage_stack
));
11171 message3_nolog (XCAR (Vmessage_stack
));
11175 /* Handler for unwind-protect calling pop_message. */
11178 pop_message_unwind (void)
11180 /* Pop the top-most entry off Vmessage_stack. */
11181 eassert (CONSP (Vmessage_stack
));
11182 Vmessage_stack
= XCDR (Vmessage_stack
);
11186 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11187 exits. If the stack is not empty, we have a missing pop_message
11191 check_message_stack (void)
11193 if (!NILP (Vmessage_stack
))
11198 /* Truncate to NCHARS what will be displayed in the echo area the next
11199 time we display it---but don't redisplay it now. */
11202 truncate_echo_area (ptrdiff_t nchars
)
11205 echo_area_buffer
[0] = Qnil
;
11206 else if (!noninteractive
11208 && !NILP (echo_area_buffer
[0]))
11210 struct frame
*sf
= SELECTED_FRAME ();
11211 /* Error messages get reported properly by cmd_error, so this must be
11212 just an informative message; if the frame hasn't really been
11213 initialized yet, just toss it. */
11214 if (sf
->glyphs_initialized_p
)
11215 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11220 /* Helper function for truncate_echo_area. Truncate the current
11221 message to at most NCHARS characters. */
11224 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11226 if (BEG
+ nchars
< Z
)
11227 del_range (BEG
+ nchars
, Z
);
11229 echo_area_buffer
[0] = Qnil
;
11233 /* Set the current message to STRING. */
11236 set_message (Lisp_Object string
)
11238 eassert (STRINGP (string
));
11240 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11242 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11243 message_buf_print
= false;
11244 help_echo_showing_p
= false;
11246 if (STRINGP (Vdebug_on_message
)
11247 && STRINGP (string
)
11248 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11249 call_debugger (list2 (Qerror
, string
));
11253 /* Helper function for set_message. First argument is ignored and second
11254 argument has the same meaning as for set_message.
11255 This function is called with the echo area buffer being current. */
11258 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11260 eassert (STRINGP (string
));
11262 /* Change multibyteness of the echo buffer appropriately. */
11263 if (message_enable_multibyte
11264 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11265 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11267 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11268 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11269 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11271 /* Insert new message at BEG. */
11272 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11274 /* This function takes care of single/multibyte conversion.
11275 We just have to ensure that the echo area buffer has the right
11276 setting of enable_multibyte_characters. */
11277 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), true);
11283 /* Clear messages. CURRENT_P means clear the current message.
11284 LAST_DISPLAYED_P means clear the message last displayed. */
11287 clear_message (bool current_p
, bool last_displayed_p
)
11291 echo_area_buffer
[0] = Qnil
;
11292 message_cleared_p
= true;
11295 if (last_displayed_p
)
11296 echo_area_buffer
[1] = Qnil
;
11298 message_buf_print
= false;
11301 /* Clear garbaged frames.
11303 This function is used where the old redisplay called
11304 redraw_garbaged_frames which in turn called redraw_frame which in
11305 turn called clear_frame. The call to clear_frame was a source of
11306 flickering. I believe a clear_frame is not necessary. It should
11307 suffice in the new redisplay to invalidate all current matrices,
11308 and ensure a complete redisplay of all windows. */
11311 clear_garbaged_frames (void)
11313 if (frame_garbaged
)
11315 Lisp_Object tail
, frame
;
11316 struct frame
*sf
= SELECTED_FRAME ();
11318 FOR_EACH_FRAME (tail
, frame
)
11320 struct frame
*f
= XFRAME (frame
);
11322 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11325 /* It makes no sense to redraw a non-selected TTY
11326 frame, since that will actually clear the
11327 selected frame, and might leave the selected
11328 frame with corrupted display, if it happens not
11329 to be marked garbaged. */
11330 && !(f
!= sf
&& (FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))))
11333 clear_current_matrices (f
);
11334 fset_redisplay (f
);
11335 f
->garbaged
= false;
11336 f
->resized_p
= false;
11340 frame_garbaged
= false;
11345 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P, update
11349 echo_area_display (bool update_frame_p
)
11351 Lisp_Object mini_window
;
11354 bool window_height_changed_p
= false;
11355 struct frame
*sf
= SELECTED_FRAME ();
11357 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11358 w
= XWINDOW (mini_window
);
11359 f
= XFRAME (WINDOW_FRAME (w
));
11361 /* Don't display if frame is invisible or not yet initialized. */
11362 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11365 #ifdef HAVE_WINDOW_SYSTEM
11366 /* When Emacs starts, selected_frame may be the initial terminal
11367 frame. If we let this through, a message would be displayed on
11369 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11371 #endif /* HAVE_WINDOW_SYSTEM */
11373 /* Redraw garbaged frames. */
11374 clear_garbaged_frames ();
11376 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11378 echo_area_window
= mini_window
;
11379 window_height_changed_p
= display_echo_area (w
);
11380 w
->must_be_updated_p
= true;
11382 /* Update the display, unless called from redisplay_internal.
11383 Also don't update the screen during redisplay itself. The
11384 update will happen at the end of redisplay, and an update
11385 here could cause confusion. */
11386 if (update_frame_p
&& !redisplaying_p
)
11390 /* If the display update has been interrupted by pending
11391 input, update mode lines in the frame. Due to the
11392 pending input, it might have been that redisplay hasn't
11393 been called, so that mode lines above the echo area are
11394 garbaged. This looks odd, so we prevent it here. */
11395 if (!display_completed
)
11396 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11398 if (window_height_changed_p
11399 /* Don't do this if Emacs is shutting down. Redisplay
11400 needs to run hooks. */
11401 && !NILP (Vrun_hooks
))
11403 /* Must update other windows. Likewise as in other
11404 cases, don't let this update be interrupted by
11406 ptrdiff_t count
= SPECPDL_INDEX ();
11407 specbind (Qredisplay_dont_pause
, Qt
);
11408 fset_redisplay (f
);
11409 redisplay_internal ();
11410 unbind_to (count
, Qnil
);
11412 else if (FRAME_WINDOW_P (f
) && n
== 0)
11414 /* Window configuration is the same as before.
11415 Can do with a display update of the echo area,
11416 unless we displayed some mode lines. */
11417 update_single_window (w
);
11421 update_frame (f
, true, true);
11423 /* If cursor is in the echo area, make sure that the next
11424 redisplay displays the minibuffer, so that the cursor will
11425 be replaced with what the minibuffer wants. */
11426 if (cursor_in_echo_area
)
11427 wset_redisplay (XWINDOW (mini_window
));
11430 else if (!EQ (mini_window
, selected_window
))
11431 wset_redisplay (XWINDOW (mini_window
));
11433 /* Last displayed message is now the current message. */
11434 echo_area_buffer
[1] = echo_area_buffer
[0];
11435 /* Inform read_char that we're not echoing. */
11436 echo_message_buffer
= Qnil
;
11438 /* Prevent redisplay optimization in redisplay_internal by resetting
11439 this_line_start_pos. This is done because the mini-buffer now
11440 displays the message instead of its buffer text. */
11441 if (EQ (mini_window
, selected_window
))
11442 CHARPOS (this_line_start_pos
) = 0;
11444 if (window_height_changed_p
)
11446 fset_redisplay (f
);
11448 /* If window configuration was changed, frames may have been
11449 marked garbaged. Clear them or we will experience
11450 surprises wrt scrolling.
11451 FIXME: How/why/when? */
11452 clear_garbaged_frames ();
11456 /* True if W's buffer was changed but not saved. */
11459 window_buffer_changed (struct window
*w
)
11461 struct buffer
*b
= XBUFFER (w
->contents
);
11463 eassert (BUFFER_LIVE_P (b
));
11465 return (BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
;
11468 /* True if W has %c in its mode line and mode line should be updated. */
11471 mode_line_update_needed (struct window
*w
)
11473 return (w
->column_number_displayed
!= -1
11474 && !(PT
== w
->last_point
&& !window_outdated (w
))
11475 && (w
->column_number_displayed
!= current_column ()));
11478 /* True if window start of W is frozen and may not be changed during
11482 window_frozen_p (struct window
*w
)
11484 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11486 Lisp_Object window
;
11488 XSETWINDOW (window
, w
);
11489 if (MINI_WINDOW_P (w
))
11491 else if (EQ (window
, selected_window
))
11493 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11494 && EQ (window
, Vminibuf_scroll_window
))
11495 /* This special window can't be frozen too. */
11503 /***********************************************************************
11504 Mode Lines and Frame Titles
11505 ***********************************************************************/
11507 /* A buffer for constructing non-propertized mode-line strings and
11508 frame titles in it; allocated from the heap in init_xdisp and
11509 resized as needed in store_mode_line_noprop_char. */
11511 static char *mode_line_noprop_buf
;
11513 /* The buffer's end, and a current output position in it. */
11515 static char *mode_line_noprop_buf_end
;
11516 static char *mode_line_noprop_ptr
;
11518 #define MODE_LINE_NOPROP_LEN(start) \
11519 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11522 MODE_LINE_DISPLAY
= 0,
11526 } mode_line_target
;
11528 /* Alist that caches the results of :propertize.
11529 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11530 static Lisp_Object mode_line_proptrans_alist
;
11532 /* List of strings making up the mode-line. */
11533 static Lisp_Object mode_line_string_list
;
11535 /* Base face property when building propertized mode line string. */
11536 static Lisp_Object mode_line_string_face
;
11537 static Lisp_Object mode_line_string_face_prop
;
11540 /* Unwind data for mode line strings */
11542 static Lisp_Object Vmode_line_unwind_vector
;
11545 format_mode_line_unwind_data (struct frame
*target_frame
,
11546 struct buffer
*obuf
,
11548 bool save_proptrans
)
11550 Lisp_Object vector
, tmp
;
11552 /* Reduce consing by keeping one vector in
11553 Vwith_echo_area_save_vector. */
11554 vector
= Vmode_line_unwind_vector
;
11555 Vmode_line_unwind_vector
= Qnil
;
11558 vector
= Fmake_vector (make_number (10), Qnil
);
11560 ASET (vector
, 0, make_number (mode_line_target
));
11561 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11562 ASET (vector
, 2, mode_line_string_list
);
11563 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11564 ASET (vector
, 4, mode_line_string_face
);
11565 ASET (vector
, 5, mode_line_string_face_prop
);
11568 XSETBUFFER (tmp
, obuf
);
11571 ASET (vector
, 6, tmp
);
11572 ASET (vector
, 7, owin
);
11575 /* Similarly to `with-selected-window', if the operation selects
11576 a window on another frame, we must restore that frame's
11577 selected window, and (for a tty) the top-frame. */
11578 ASET (vector
, 8, target_frame
->selected_window
);
11579 if (FRAME_TERMCAP_P (target_frame
))
11580 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11587 unwind_format_mode_line (Lisp_Object vector
)
11589 Lisp_Object old_window
= AREF (vector
, 7);
11590 Lisp_Object target_frame_window
= AREF (vector
, 8);
11591 Lisp_Object old_top_frame
= AREF (vector
, 9);
11593 mode_line_target
= XINT (AREF (vector
, 0));
11594 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11595 mode_line_string_list
= AREF (vector
, 2);
11596 if (! EQ (AREF (vector
, 3), Qt
))
11597 mode_line_proptrans_alist
= AREF (vector
, 3);
11598 mode_line_string_face
= AREF (vector
, 4);
11599 mode_line_string_face_prop
= AREF (vector
, 5);
11601 /* Select window before buffer, since it may change the buffer. */
11602 if (!NILP (old_window
))
11604 /* If the operation that we are unwinding had selected a window
11605 on a different frame, reset its frame-selected-window. For a
11606 text terminal, reset its top-frame if necessary. */
11607 if (!NILP (target_frame_window
))
11610 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11612 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11613 Fselect_window (target_frame_window
, Qt
);
11615 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11616 Fselect_frame (old_top_frame
, Qt
);
11619 Fselect_window (old_window
, Qt
);
11622 if (!NILP (AREF (vector
, 6)))
11624 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11625 ASET (vector
, 6, Qnil
);
11628 Vmode_line_unwind_vector
= vector
;
11632 /* Store a single character C for the frame title in mode_line_noprop_buf.
11633 Re-allocate mode_line_noprop_buf if necessary. */
11636 store_mode_line_noprop_char (char c
)
11638 /* If output position has reached the end of the allocated buffer,
11639 increase the buffer's size. */
11640 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11642 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11643 ptrdiff_t size
= len
;
11644 mode_line_noprop_buf
=
11645 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11646 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11647 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11650 *mode_line_noprop_ptr
++ = c
;
11654 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11655 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11656 characters that yield more columns than PRECISION; PRECISION <= 0
11657 means copy the whole string. Pad with spaces until FIELD_WIDTH
11658 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11659 pad. Called from display_mode_element when it is used to build a
11663 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11665 const unsigned char *str
= (const unsigned char *) string
;
11667 ptrdiff_t dummy
, nbytes
;
11669 /* Copy at most PRECISION chars from STR. */
11670 nbytes
= strlen (string
);
11671 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11673 store_mode_line_noprop_char (*str
++);
11675 /* Fill up with spaces until FIELD_WIDTH reached. */
11676 while (field_width
> 0
11677 && n
< field_width
)
11679 store_mode_line_noprop_char (' ');
11686 /***********************************************************************
11688 ***********************************************************************/
11690 #ifdef HAVE_WINDOW_SYSTEM
11692 /* Set the title of FRAME, if it has changed. The title format is
11693 Vicon_title_format if FRAME is iconified, otherwise it is
11694 frame_title_format. */
11697 x_consider_frame_title (Lisp_Object frame
)
11699 struct frame
*f
= XFRAME (frame
);
11701 if ((FRAME_WINDOW_P (f
)
11702 || FRAME_MINIBUF_ONLY_P (f
)
11703 || f
->explicit_name
)
11704 && NILP (Fframe_parameter (frame
, Qtooltip
)))
11706 /* Do we have more than one visible frame on this X display? */
11707 Lisp_Object tail
, other_frame
, fmt
;
11708 ptrdiff_t title_start
;
11712 ptrdiff_t count
= SPECPDL_INDEX ();
11714 FOR_EACH_FRAME (tail
, other_frame
)
11716 struct frame
*tf
= XFRAME (other_frame
);
11719 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11720 && !FRAME_MINIBUF_ONLY_P (tf
)
11721 && !EQ (other_frame
, tip_frame
)
11722 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11726 /* Set global variable indicating that multiple frames exist. */
11727 multiple_frames
= CONSP (tail
);
11729 /* Switch to the buffer of selected window of the frame. Set up
11730 mode_line_target so that display_mode_element will output into
11731 mode_line_noprop_buf; then display the title. */
11732 record_unwind_protect (unwind_format_mode_line
,
11733 format_mode_line_unwind_data
11734 (f
, current_buffer
, selected_window
, false));
11736 Fselect_window (f
->selected_window
, Qt
);
11737 set_buffer_internal_1
11738 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11739 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11741 mode_line_target
= MODE_LINE_TITLE
;
11742 title_start
= MODE_LINE_NOPROP_LEN (0);
11743 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11744 NULL
, DEFAULT_FACE_ID
);
11745 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, false);
11746 len
= MODE_LINE_NOPROP_LEN (title_start
);
11747 title
= mode_line_noprop_buf
+ title_start
;
11748 unbind_to (count
, Qnil
);
11750 /* Set the title only if it's changed. This avoids consing in
11751 the common case where it hasn't. (If it turns out that we've
11752 already wasted too much time by walking through the list with
11753 display_mode_element, then we might need to optimize at a
11754 higher level than this.) */
11755 if (! STRINGP (f
->name
)
11756 || SBYTES (f
->name
) != len
11757 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11758 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11762 #endif /* not HAVE_WINDOW_SYSTEM */
11765 /***********************************************************************
11767 ***********************************************************************/
11769 /* True if we will not redisplay all visible windows. */
11770 #define REDISPLAY_SOME_P() \
11771 ((windows_or_buffers_changed == 0 \
11772 || windows_or_buffers_changed == REDISPLAY_SOME) \
11773 && (update_mode_lines == 0 \
11774 || update_mode_lines == REDISPLAY_SOME))
11776 /* Prepare for redisplay by updating menu-bar item lists when
11777 appropriate. This can call eval. */
11780 prepare_menu_bars (void)
11782 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11783 bool some_windows
= REDISPLAY_SOME_P ();
11784 Lisp_Object tooltip_frame
;
11786 #ifdef HAVE_WINDOW_SYSTEM
11787 tooltip_frame
= tip_frame
;
11789 tooltip_frame
= Qnil
;
11792 if (FUNCTIONP (Vpre_redisplay_function
))
11794 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11795 if (all_windows
&& some_windows
)
11797 Lisp_Object ws
= window_list ();
11798 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11800 Lisp_Object
this = XCAR (ws
);
11801 struct window
*w
= XWINDOW (this);
11803 || XFRAME (w
->frame
)->redisplay
11804 || XBUFFER (w
->contents
)->text
->redisplay
)
11806 windows
= Fcons (this, windows
);
11810 safe__call1 (true, Vpre_redisplay_function
, windows
);
11813 /* Update all frame titles based on their buffer names, etc. We do
11814 this before the menu bars so that the buffer-menu will show the
11815 up-to-date frame titles. */
11816 #ifdef HAVE_WINDOW_SYSTEM
11819 Lisp_Object tail
, frame
;
11821 FOR_EACH_FRAME (tail
, frame
)
11823 struct frame
*f
= XFRAME (frame
);
11824 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11828 && !XBUFFER (w
->contents
)->text
->redisplay
)
11831 if (!EQ (frame
, tooltip_frame
)
11832 && (FRAME_ICONIFIED_P (f
)
11833 || FRAME_VISIBLE_P (f
) == 1
11834 /* Exclude TTY frames that are obscured because they
11835 are not the top frame on their console. This is
11836 because x_consider_frame_title actually switches
11837 to the frame, which for TTY frames means it is
11838 marked as garbaged, and will be completely
11839 redrawn on the next redisplay cycle. This causes
11840 TTY frames to be completely redrawn, when there
11841 are more than one of them, even though nothing
11842 should be changed on display. */
11843 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11844 x_consider_frame_title (frame
);
11847 #endif /* HAVE_WINDOW_SYSTEM */
11849 /* Update the menu bar item lists, if appropriate. This has to be
11850 done before any actual redisplay or generation of display lines. */
11854 Lisp_Object tail
, frame
;
11855 ptrdiff_t count
= SPECPDL_INDEX ();
11856 /* True means that update_menu_bar has run its hooks
11857 so any further calls to update_menu_bar shouldn't do so again. */
11858 bool menu_bar_hooks_run
= false;
11860 record_unwind_save_match_data ();
11862 FOR_EACH_FRAME (tail
, frame
)
11864 struct frame
*f
= XFRAME (frame
);
11865 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11867 /* Ignore tooltip frame. */
11868 if (EQ (frame
, tooltip_frame
))
11874 && !XBUFFER (w
->contents
)->text
->redisplay
)
11877 run_window_size_change_functions (frame
);
11878 menu_bar_hooks_run
= update_menu_bar (f
, false, menu_bar_hooks_run
);
11879 #ifdef HAVE_WINDOW_SYSTEM
11880 update_tool_bar (f
, false);
11884 unbind_to (count
, Qnil
);
11888 struct frame
*sf
= SELECTED_FRAME ();
11889 update_menu_bar (sf
, true, false);
11890 #ifdef HAVE_WINDOW_SYSTEM
11891 update_tool_bar (sf
, true);
11897 /* Update the menu bar item list for frame F. This has to be done
11898 before we start to fill in any display lines, because it can call
11901 If SAVE_MATCH_DATA, we must save and restore it here.
11903 If HOOKS_RUN, a previous call to update_menu_bar
11904 already ran the menu bar hooks for this redisplay, so there
11905 is no need to run them again. The return value is the
11906 updated value of this flag, to pass to the next call. */
11909 update_menu_bar (struct frame
*f
, bool save_match_data
, bool hooks_run
)
11911 Lisp_Object window
;
11914 /* If called recursively during a menu update, do nothing. This can
11915 happen when, for instance, an activate-menubar-hook causes a
11917 if (inhibit_menubar_update
)
11920 window
= FRAME_SELECTED_WINDOW (f
);
11921 w
= XWINDOW (window
);
11923 if (FRAME_WINDOW_P (f
)
11925 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11926 || defined (HAVE_NS) || defined (USE_GTK)
11927 FRAME_EXTERNAL_MENU_BAR (f
)
11929 FRAME_MENU_BAR_LINES (f
) > 0
11931 : FRAME_MENU_BAR_LINES (f
) > 0)
11933 /* If the user has switched buffers or windows, we need to
11934 recompute to reflect the new bindings. But we'll
11935 recompute when update_mode_lines is set too; that means
11936 that people can use force-mode-line-update to request
11937 that the menu bar be recomputed. The adverse effect on
11938 the rest of the redisplay algorithm is about the same as
11939 windows_or_buffers_changed anyway. */
11940 if (windows_or_buffers_changed
11941 /* This used to test w->update_mode_line, but we believe
11942 there is no need to recompute the menu in that case. */
11943 || update_mode_lines
11944 || window_buffer_changed (w
))
11946 struct buffer
*prev
= current_buffer
;
11947 ptrdiff_t count
= SPECPDL_INDEX ();
11949 specbind (Qinhibit_menubar_update
, Qt
);
11951 set_buffer_internal_1 (XBUFFER (w
->contents
));
11952 if (save_match_data
)
11953 record_unwind_save_match_data ();
11954 if (NILP (Voverriding_local_map_menu_flag
))
11956 specbind (Qoverriding_terminal_local_map
, Qnil
);
11957 specbind (Qoverriding_local_map
, Qnil
);
11962 /* Run the Lucid hook. */
11963 safe_run_hooks (Qactivate_menubar_hook
);
11965 /* If it has changed current-menubar from previous value,
11966 really recompute the menu-bar from the value. */
11967 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11968 call0 (Qrecompute_lucid_menubar
);
11970 safe_run_hooks (Qmenu_bar_update_hook
);
11975 XSETFRAME (Vmenu_updating_frame
, f
);
11976 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11978 /* Redisplay the menu bar in case we changed it. */
11979 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11980 || defined (HAVE_NS) || defined (USE_GTK)
11981 if (FRAME_WINDOW_P (f
))
11983 #if defined (HAVE_NS)
11984 /* All frames on Mac OS share the same menubar. So only
11985 the selected frame should be allowed to set it. */
11986 if (f
== SELECTED_FRAME ())
11988 set_frame_menubar (f
, false, false);
11991 /* On a terminal screen, the menu bar is an ordinary screen
11992 line, and this makes it get updated. */
11993 w
->update_mode_line
= true;
11994 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11995 /* In the non-toolkit version, the menu bar is an ordinary screen
11996 line, and this makes it get updated. */
11997 w
->update_mode_line
= true;
11998 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
12000 unbind_to (count
, Qnil
);
12001 set_buffer_internal_1 (prev
);
12008 /***********************************************************************
12010 ***********************************************************************/
12012 #ifdef HAVE_WINDOW_SYSTEM
12014 /* Select `frame' temporarily without running all the code in
12016 FIXME: Maybe do_switch_frame should be trimmed down similarly
12017 when `norecord' is set. */
12019 fast_set_selected_frame (Lisp_Object frame
)
12021 if (!EQ (selected_frame
, frame
))
12023 selected_frame
= frame
;
12024 selected_window
= XFRAME (frame
)->selected_window
;
12028 /* Update the tool-bar item list for frame F. This has to be done
12029 before we start to fill in any display lines. Called from
12030 prepare_menu_bars. If SAVE_MATCH_DATA, we must save
12031 and restore it here. */
12034 update_tool_bar (struct frame
*f
, bool save_match_data
)
12036 #if defined (USE_GTK) || defined (HAVE_NS)
12037 bool do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
12039 bool do_update
= (WINDOWP (f
->tool_bar_window
)
12040 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0);
12045 Lisp_Object window
;
12048 window
= FRAME_SELECTED_WINDOW (f
);
12049 w
= XWINDOW (window
);
12051 /* If the user has switched buffers or windows, we need to
12052 recompute to reflect the new bindings. But we'll
12053 recompute when update_mode_lines is set too; that means
12054 that people can use force-mode-line-update to request
12055 that the menu bar be recomputed. The adverse effect on
12056 the rest of the redisplay algorithm is about the same as
12057 windows_or_buffers_changed anyway. */
12058 if (windows_or_buffers_changed
12059 || w
->update_mode_line
12060 || update_mode_lines
12061 || window_buffer_changed (w
))
12063 struct buffer
*prev
= current_buffer
;
12064 ptrdiff_t count
= SPECPDL_INDEX ();
12065 Lisp_Object frame
, new_tool_bar
;
12066 int new_n_tool_bar
;
12068 /* Set current_buffer to the buffer of the selected
12069 window of the frame, so that we get the right local
12071 set_buffer_internal_1 (XBUFFER (w
->contents
));
12073 /* Save match data, if we must. */
12074 if (save_match_data
)
12075 record_unwind_save_match_data ();
12077 /* Make sure that we don't accidentally use bogus keymaps. */
12078 if (NILP (Voverriding_local_map_menu_flag
))
12080 specbind (Qoverriding_terminal_local_map
, Qnil
);
12081 specbind (Qoverriding_local_map
, Qnil
);
12084 /* We must temporarily set the selected frame to this frame
12085 before calling tool_bar_items, because the calculation of
12086 the tool-bar keymap uses the selected frame (see
12087 `tool-bar-make-keymap' in tool-bar.el). */
12088 eassert (EQ (selected_window
,
12089 /* Since we only explicitly preserve selected_frame,
12090 check that selected_window would be redundant. */
12091 XFRAME (selected_frame
)->selected_window
));
12092 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
12093 XSETFRAME (frame
, f
);
12094 fast_set_selected_frame (frame
);
12096 /* Build desired tool-bar items from keymaps. */
12098 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
12101 /* Redisplay the tool-bar if we changed it. */
12102 if (new_n_tool_bar
!= f
->n_tool_bar_items
12103 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
12105 /* Redisplay that happens asynchronously due to an expose event
12106 may access f->tool_bar_items. Make sure we update both
12107 variables within BLOCK_INPUT so no such event interrupts. */
12109 fset_tool_bar_items (f
, new_tool_bar
);
12110 f
->n_tool_bar_items
= new_n_tool_bar
;
12111 w
->update_mode_line
= true;
12115 unbind_to (count
, Qnil
);
12116 set_buffer_internal_1 (prev
);
12121 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12123 /* Set F->desired_tool_bar_string to a Lisp string representing frame
12124 F's desired tool-bar contents. F->tool_bar_items must have
12125 been set up previously by calling prepare_menu_bars. */
12128 build_desired_tool_bar_string (struct frame
*f
)
12130 int i
, size
, size_needed
;
12131 Lisp_Object image
, plist
;
12133 image
= plist
= Qnil
;
12135 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
12136 Otherwise, make a new string. */
12138 /* The size of the string we might be able to reuse. */
12139 size
= (STRINGP (f
->desired_tool_bar_string
)
12140 ? SCHARS (f
->desired_tool_bar_string
)
12143 /* We need one space in the string for each image. */
12144 size_needed
= f
->n_tool_bar_items
;
12146 /* Reuse f->desired_tool_bar_string, if possible. */
12147 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
12148 fset_desired_tool_bar_string
12149 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
12152 AUTO_LIST4 (props
, Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
12153 Fremove_text_properties (make_number (0), make_number (size
),
12154 props
, f
->desired_tool_bar_string
);
12157 /* Put a `display' property on the string for the images to display,
12158 put a `menu_item' property on tool-bar items with a value that
12159 is the index of the item in F's tool-bar item vector. */
12160 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
12162 #define PROP(IDX) \
12163 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
12165 bool enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
12166 bool selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
12167 int hmargin
, vmargin
, relief
, idx
, end
;
12169 /* If image is a vector, choose the image according to the
12171 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
12172 if (VECTORP (image
))
12176 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12177 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
12180 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12181 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
12183 eassert (ASIZE (image
) >= idx
);
12184 image
= AREF (image
, idx
);
12189 /* Ignore invalid image specifications. */
12190 if (!valid_image_p (image
))
12193 /* Display the tool-bar button pressed, or depressed. */
12194 plist
= Fcopy_sequence (XCDR (image
));
12196 /* Compute margin and relief to draw. */
12197 relief
= (tool_bar_button_relief
>= 0
12198 ? tool_bar_button_relief
12199 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12200 hmargin
= vmargin
= relief
;
12202 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12203 INT_MAX
- max (hmargin
, vmargin
)))
12205 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12206 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12208 else if (CONSP (Vtool_bar_button_margin
))
12210 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12211 INT_MAX
- hmargin
))
12212 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12214 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12215 INT_MAX
- vmargin
))
12216 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12219 if (auto_raise_tool_bar_buttons_p
)
12221 /* Add a `:relief' property to the image spec if the item is
12225 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12232 /* If image is selected, display it pressed, i.e. with a
12233 negative relief. If it's not selected, display it with a
12235 plist
= Fplist_put (plist
, QCrelief
,
12237 ? make_number (-relief
)
12238 : make_number (relief
)));
12243 /* Put a margin around the image. */
12244 if (hmargin
|| vmargin
)
12246 if (hmargin
== vmargin
)
12247 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12249 plist
= Fplist_put (plist
, QCmargin
,
12250 Fcons (make_number (hmargin
),
12251 make_number (vmargin
)));
12254 /* If button is not enabled, and we don't have special images
12255 for the disabled state, make the image appear disabled by
12256 applying an appropriate algorithm to it. */
12257 if (!enabled_p
&& idx
< 0)
12258 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12260 /* Put a `display' text property on the string for the image to
12261 display. Put a `menu-item' property on the string that gives
12262 the start of this item's properties in the tool-bar items
12264 image
= Fcons (Qimage
, plist
);
12265 AUTO_LIST4 (props
, Qdisplay
, image
, Qmenu_item
,
12266 make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12268 /* Let the last image hide all remaining spaces in the tool bar
12269 string. The string can be longer than needed when we reuse a
12270 previous string. */
12271 if (i
+ 1 == f
->n_tool_bar_items
)
12272 end
= SCHARS (f
->desired_tool_bar_string
);
12275 Fadd_text_properties (make_number (i
), make_number (end
),
12276 props
, f
->desired_tool_bar_string
);
12282 /* Display one line of the tool-bar of frame IT->f.
12284 HEIGHT specifies the desired height of the tool-bar line.
12285 If the actual height of the glyph row is less than HEIGHT, the
12286 row's height is increased to HEIGHT, and the icons are centered
12287 vertically in the new height.
12289 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12290 count a final empty row in case the tool-bar width exactly matches
12295 display_tool_bar_line (struct it
*it
, int height
)
12297 struct glyph_row
*row
= it
->glyph_row
;
12298 int max_x
= it
->last_visible_x
;
12299 struct glyph
*last
;
12301 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12302 clear_glyph_row (row
);
12303 row
->enabled_p
= true;
12304 row
->y
= it
->current_y
;
12306 /* Note that this isn't made use of if the face hasn't a box,
12307 so there's no need to check the face here. */
12308 it
->start_of_box_run_p
= true;
12310 while (it
->current_x
< max_x
)
12312 int x
, n_glyphs_before
, i
, nglyphs
;
12313 struct it it_before
;
12315 /* Get the next display element. */
12316 if (!get_next_display_element (it
))
12318 /* Don't count empty row if we are counting needed tool-bar lines. */
12319 if (height
< 0 && !it
->hpos
)
12324 /* Produce glyphs. */
12325 n_glyphs_before
= row
->used
[TEXT_AREA
];
12328 PRODUCE_GLYPHS (it
);
12330 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12332 x
= it_before
.current_x
;
12333 while (i
< nglyphs
)
12335 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12337 if (x
+ glyph
->pixel_width
> max_x
)
12339 /* Glyph doesn't fit on line. Backtrack. */
12340 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12342 /* If this is the only glyph on this line, it will never fit on the
12343 tool-bar, so skip it. But ensure there is at least one glyph,
12344 so we don't accidentally disable the tool-bar. */
12345 if (n_glyphs_before
== 0
12346 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12352 x
+= glyph
->pixel_width
;
12356 /* Stop at line end. */
12357 if (ITERATOR_AT_END_OF_LINE_P (it
))
12360 set_iterator_to_next (it
, true);
12365 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12367 /* Use default face for the border below the tool bar.
12369 FIXME: When auto-resize-tool-bars is grow-only, there is
12370 no additional border below the possibly empty tool-bar lines.
12371 So to make the extra empty lines look "normal", we have to
12372 use the tool-bar face for the border too. */
12373 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12374 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12375 it
->face_id
= DEFAULT_FACE_ID
;
12377 extend_face_to_end_of_line (it
);
12378 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12379 last
->right_box_line_p
= true;
12380 if (last
== row
->glyphs
[TEXT_AREA
])
12381 last
->left_box_line_p
= true;
12383 /* Make line the desired height and center it vertically. */
12384 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12386 /* Don't add more than one line height. */
12387 height
%= FRAME_LINE_HEIGHT (it
->f
);
12388 it
->max_ascent
+= height
/ 2;
12389 it
->max_descent
+= (height
+ 1) / 2;
12392 compute_line_metrics (it
);
12394 /* If line is empty, make it occupy the rest of the tool-bar. */
12395 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12397 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12398 row
->visible_height
= row
->height
;
12399 row
->ascent
= row
->phys_ascent
= 0;
12400 row
->extra_line_spacing
= 0;
12403 row
->full_width_p
= true;
12404 row
->continued_p
= false;
12405 row
->truncated_on_left_p
= false;
12406 row
->truncated_on_right_p
= false;
12408 it
->current_x
= it
->hpos
= 0;
12409 it
->current_y
+= row
->height
;
12415 /* Value is the number of pixels needed to make all tool-bar items of
12416 frame F visible. The actual number of glyph rows needed is
12417 returned in *N_ROWS if non-NULL. */
12419 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12421 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12423 /* tool_bar_height is called from redisplay_tool_bar after building
12424 the desired matrix, so use (unused) mode-line row as temporary row to
12425 avoid destroying the first tool-bar row. */
12426 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12428 /* Initialize an iterator for iteration over
12429 F->desired_tool_bar_string in the tool-bar window of frame F. */
12430 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12431 temp_row
->reversed_p
= false;
12432 it
.first_visible_x
= 0;
12433 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12434 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12435 it
.paragraph_embedding
= L2R
;
12437 while (!ITERATOR_AT_END_P (&it
))
12439 clear_glyph_row (temp_row
);
12440 it
.glyph_row
= temp_row
;
12441 display_tool_bar_line (&it
, -1);
12443 clear_glyph_row (temp_row
);
12445 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12447 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12450 return it
.current_y
;
12452 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12455 #endif /* !USE_GTK && !HAVE_NS */
12457 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12459 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12460 If FRAME is nil or omitted, use the selected frame. Optional argument
12461 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12462 (Lisp_Object frame
, Lisp_Object pixelwise
)
12466 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12467 struct frame
*f
= decode_any_frame (frame
);
12469 if (WINDOWP (f
->tool_bar_window
)
12470 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12472 update_tool_bar (f
, true);
12473 if (f
->n_tool_bar_items
)
12475 build_desired_tool_bar_string (f
);
12476 height
= tool_bar_height (f
, NULL
, !NILP (pixelwise
));
12481 return make_number (height
);
12485 /* Display the tool-bar of frame F. Value is true if tool-bar's
12486 height should be changed. */
12488 redisplay_tool_bar (struct frame
*f
)
12490 f
->tool_bar_redisplayed
= true;
12491 #if defined (USE_GTK) || defined (HAVE_NS)
12493 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12494 update_frame_tool_bar (f
);
12497 #else /* !USE_GTK && !HAVE_NS */
12501 struct glyph_row
*row
;
12503 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12504 do anything. This means you must start with tool-bar-lines
12505 non-zero to get the auto-sizing effect. Or in other words, you
12506 can turn off tool-bars by specifying tool-bar-lines zero. */
12507 if (!WINDOWP (f
->tool_bar_window
)
12508 || (w
= XWINDOW (f
->tool_bar_window
),
12509 WINDOW_TOTAL_LINES (w
) == 0))
12512 /* Set up an iterator for the tool-bar window. */
12513 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12514 it
.first_visible_x
= 0;
12515 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12516 row
= it
.glyph_row
;
12517 row
->reversed_p
= false;
12519 /* Build a string that represents the contents of the tool-bar. */
12520 build_desired_tool_bar_string (f
);
12521 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12522 /* FIXME: This should be controlled by a user option. But it
12523 doesn't make sense to have an R2L tool bar if the menu bar cannot
12524 be drawn also R2L, and making the menu bar R2L is tricky due
12525 toolkit-specific code that implements it. If an R2L tool bar is
12526 ever supported, display_tool_bar_line should also be augmented to
12527 call unproduce_glyphs like display_line and display_string
12529 it
.paragraph_embedding
= L2R
;
12531 if (f
->n_tool_bar_rows
== 0)
12533 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, true);
12535 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12537 x_change_tool_bar_height (f
, new_height
);
12538 frame_default_tool_bar_height
= new_height
;
12539 /* Always do that now. */
12540 clear_glyph_matrix (w
->desired_matrix
);
12541 f
->fonts_changed
= true;
12546 /* Display as many lines as needed to display all tool-bar items. */
12548 if (f
->n_tool_bar_rows
> 0)
12550 int border
, rows
, height
, extra
;
12552 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12553 border
= XINT (Vtool_bar_border
);
12554 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12555 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12556 else if (EQ (Vtool_bar_border
, Qborder_width
))
12557 border
= f
->border_width
;
12563 rows
= f
->n_tool_bar_rows
;
12564 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12565 extra
= it
.last_visible_y
- border
- height
* rows
;
12567 while (it
.current_y
< it
.last_visible_y
)
12570 if (extra
> 0 && rows
-- > 0)
12572 h
= (extra
+ rows
- 1) / rows
;
12575 display_tool_bar_line (&it
, height
+ h
);
12580 while (it
.current_y
< it
.last_visible_y
)
12581 display_tool_bar_line (&it
, 0);
12584 /* It doesn't make much sense to try scrolling in the tool-bar
12585 window, so don't do it. */
12586 w
->desired_matrix
->no_scrolling_p
= true;
12587 w
->must_be_updated_p
= true;
12589 if (!NILP (Vauto_resize_tool_bars
))
12591 bool change_height_p
= true;
12593 /* If we couldn't display everything, change the tool-bar's
12594 height if there is room for more. */
12595 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
12596 change_height_p
= true;
12598 /* We subtract 1 because display_tool_bar_line advances the
12599 glyph_row pointer before returning to its caller. We want to
12600 examine the last glyph row produced by
12601 display_tool_bar_line. */
12602 row
= it
.glyph_row
- 1;
12604 /* If there are blank lines at the end, except for a partially
12605 visible blank line at the end that is smaller than
12606 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12607 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12608 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12609 change_height_p
= true;
12611 /* If row displays tool-bar items, but is partially visible,
12612 change the tool-bar's height. */
12613 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12614 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
12615 change_height_p
= true;
12617 /* Resize windows as needed by changing the `tool-bar-lines'
12618 frame parameter. */
12619 if (change_height_p
)
12622 int new_height
= tool_bar_height (f
, &nrows
, true);
12624 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12625 && !f
->minimize_tool_bar_window_p
)
12626 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12627 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12628 f
->minimize_tool_bar_window_p
= false;
12630 if (change_height_p
)
12632 x_change_tool_bar_height (f
, new_height
);
12633 frame_default_tool_bar_height
= new_height
;
12634 clear_glyph_matrix (w
->desired_matrix
);
12635 f
->n_tool_bar_rows
= nrows
;
12636 f
->fonts_changed
= true;
12643 f
->minimize_tool_bar_window_p
= false;
12646 #endif /* USE_GTK || HAVE_NS */
12649 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12651 /* Get information about the tool-bar item which is displayed in GLYPH
12652 on frame F. Return in *PROP_IDX the index where tool-bar item
12653 properties start in F->tool_bar_items. Value is false if
12654 GLYPH doesn't display a tool-bar item. */
12657 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12662 /* This function can be called asynchronously, which means we must
12663 exclude any possibility that Fget_text_property signals an
12665 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12666 charpos
= max (0, charpos
);
12668 /* Get the text property `menu-item' at pos. The value of that
12669 property is the start index of this item's properties in
12670 F->tool_bar_items. */
12671 prop
= Fget_text_property (make_number (charpos
),
12672 Qmenu_item
, f
->current_tool_bar_string
);
12673 if (! INTEGERP (prop
))
12675 *prop_idx
= XINT (prop
);
12680 /* Get information about the tool-bar item at position X/Y on frame F.
12681 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12682 the current matrix of the tool-bar window of F, or NULL if not
12683 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12684 item in F->tool_bar_items. Value is
12686 -1 if X/Y is not on a tool-bar item
12687 0 if X/Y is on the same item that was highlighted before.
12691 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12692 int *hpos
, int *vpos
, int *prop_idx
)
12694 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12695 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12698 /* Find the glyph under X/Y. */
12699 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12700 if (*glyph
== NULL
)
12703 /* Get the start of this tool-bar item's properties in
12704 f->tool_bar_items. */
12705 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12708 /* Is mouse on the highlighted item? */
12709 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12710 && *vpos
>= hlinfo
->mouse_face_beg_row
12711 && *vpos
<= hlinfo
->mouse_face_end_row
12712 && (*vpos
> hlinfo
->mouse_face_beg_row
12713 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12714 && (*vpos
< hlinfo
->mouse_face_end_row
12715 || *hpos
< hlinfo
->mouse_face_end_col
12716 || hlinfo
->mouse_face_past_end
))
12724 Handle mouse button event on the tool-bar of frame F, at
12725 frame-relative coordinates X/Y. DOWN_P is true for a button press,
12726 false for button release. MODIFIERS is event modifiers for button
12730 handle_tool_bar_click (struct frame
*f
, int x
, int y
, bool down_p
,
12733 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12734 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12735 int hpos
, vpos
, prop_idx
;
12736 struct glyph
*glyph
;
12737 Lisp_Object enabled_p
;
12740 /* If not on the highlighted tool-bar item, and mouse-highlight is
12741 non-nil, return. This is so we generate the tool-bar button
12742 click only when the mouse button is released on the same item as
12743 where it was pressed. However, when mouse-highlight is disabled,
12744 generate the click when the button is released regardless of the
12745 highlight, since tool-bar items are not highlighted in that
12747 frame_to_window_pixel_xy (w
, &x
, &y
);
12748 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12750 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12753 /* When mouse-highlight is off, generate the click for the item
12754 where the button was pressed, disregarding where it was
12756 if (NILP (Vmouse_highlight
) && !down_p
)
12757 prop_idx
= f
->last_tool_bar_item
;
12759 /* If item is disabled, do nothing. */
12760 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12761 if (NILP (enabled_p
))
12766 /* Show item in pressed state. */
12767 if (!NILP (Vmouse_highlight
))
12768 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12769 f
->last_tool_bar_item
= prop_idx
;
12773 Lisp_Object key
, frame
;
12774 struct input_event event
;
12775 EVENT_INIT (event
);
12777 /* Show item in released state. */
12778 if (!NILP (Vmouse_highlight
))
12779 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12781 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12783 XSETFRAME (frame
, f
);
12784 event
.kind
= TOOL_BAR_EVENT
;
12785 event
.frame_or_window
= frame
;
12787 kbd_buffer_store_event (&event
);
12789 event
.kind
= TOOL_BAR_EVENT
;
12790 event
.frame_or_window
= frame
;
12792 event
.modifiers
= modifiers
;
12793 kbd_buffer_store_event (&event
);
12794 f
->last_tool_bar_item
= -1;
12799 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12800 tool-bar window-relative coordinates X/Y. Called from
12801 note_mouse_highlight. */
12804 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12806 Lisp_Object window
= f
->tool_bar_window
;
12807 struct window
*w
= XWINDOW (window
);
12808 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12809 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12811 struct glyph
*glyph
;
12812 struct glyph_row
*row
;
12814 Lisp_Object enabled_p
;
12816 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12820 /* Function note_mouse_highlight is called with negative X/Y
12821 values when mouse moves outside of the frame. */
12822 if (x
<= 0 || y
<= 0)
12824 clear_mouse_face (hlinfo
);
12828 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12831 /* Not on tool-bar item. */
12832 clear_mouse_face (hlinfo
);
12836 /* On same tool-bar item as before. */
12837 goto set_help_echo
;
12839 clear_mouse_face (hlinfo
);
12841 /* Mouse is down, but on different tool-bar item? */
12842 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12843 && f
== dpyinfo
->last_mouse_frame
);
12845 if (mouse_down_p
&& f
->last_tool_bar_item
!= prop_idx
)
12848 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12850 /* If tool-bar item is not enabled, don't highlight it. */
12851 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12852 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12854 /* Compute the x-position of the glyph. In front and past the
12855 image is a space. We include this in the highlighted area. */
12856 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12857 for (i
= x
= 0; i
< hpos
; ++i
)
12858 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12860 /* Record this as the current active region. */
12861 hlinfo
->mouse_face_beg_col
= hpos
;
12862 hlinfo
->mouse_face_beg_row
= vpos
;
12863 hlinfo
->mouse_face_beg_x
= x
;
12864 hlinfo
->mouse_face_past_end
= false;
12866 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12867 hlinfo
->mouse_face_end_row
= vpos
;
12868 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12869 hlinfo
->mouse_face_window
= window
;
12870 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12872 /* Display it as active. */
12873 show_mouse_face (hlinfo
, draw
);
12878 /* Set help_echo_string to a help string to display for this tool-bar item.
12879 XTread_socket does the rest. */
12880 help_echo_object
= help_echo_window
= Qnil
;
12881 help_echo_pos
= -1;
12882 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12883 if (NILP (help_echo_string
))
12884 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12887 #endif /* !USE_GTK && !HAVE_NS */
12889 #endif /* HAVE_WINDOW_SYSTEM */
12893 /************************************************************************
12894 Horizontal scrolling
12895 ************************************************************************/
12897 /* For all leaf windows in the window tree rooted at WINDOW, set their
12898 hscroll value so that PT is (i) visible in the window, and (ii) so
12899 that it is not within a certain margin at the window's left and
12900 right border. Value is true if any window's hscroll has been
12904 hscroll_window_tree (Lisp_Object window
)
12906 bool hscrolled_p
= false;
12907 bool hscroll_relative_p
= FLOATP (Vhscroll_step
);
12908 int hscroll_step_abs
= 0;
12909 double hscroll_step_rel
= 0;
12911 if (hscroll_relative_p
)
12913 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12914 if (hscroll_step_rel
< 0)
12916 hscroll_relative_p
= false;
12917 hscroll_step_abs
= 0;
12920 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12922 hscroll_step_abs
= XINT (Vhscroll_step
);
12923 if (hscroll_step_abs
< 0)
12924 hscroll_step_abs
= 0;
12927 hscroll_step_abs
= 0;
12929 while (WINDOWP (window
))
12931 struct window
*w
= XWINDOW (window
);
12933 if (WINDOWP (w
->contents
))
12934 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12935 else if (w
->cursor
.vpos
>= 0)
12938 int text_area_width
;
12939 struct glyph_row
*cursor_row
;
12940 struct glyph_row
*bottom_row
;
12942 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12943 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12944 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12946 cursor_row
= bottom_row
- 1;
12948 if (!cursor_row
->enabled_p
)
12950 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12951 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12952 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12954 cursor_row
= bottom_row
- 1;
12956 bool row_r2l_p
= cursor_row
->reversed_p
;
12958 text_area_width
= window_box_width (w
, TEXT_AREA
);
12960 /* Scroll when cursor is inside this scroll margin. */
12961 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12963 /* If the position of this window's point has explicitly
12964 changed, no more suspend auto hscrolling. */
12965 if (NILP (Fequal (Fwindow_point (window
), Fwindow_old_point (window
))))
12966 w
->suspend_auto_hscroll
= false;
12968 /* Remember window point. */
12969 Fset_marker (w
->old_pointm
,
12970 ((w
== XWINDOW (selected_window
))
12971 ? make_number (BUF_PT (XBUFFER (w
->contents
)))
12972 : Fmarker_position (w
->pointm
)),
12975 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12976 && !w
->suspend_auto_hscroll
12977 /* In some pathological cases, like restoring a window
12978 configuration into a frame that is much smaller than
12979 the one from which the configuration was saved, we
12980 get glyph rows whose start and end have zero buffer
12981 positions, which we cannot handle below. Just skip
12983 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12984 /* For left-to-right rows, hscroll when cursor is either
12985 (i) inside the right hscroll margin, or (ii) if it is
12986 inside the left margin and the window is already
12989 && ((w
->hscroll
&& w
->cursor
.x
<= h_margin
)
12990 || (cursor_row
->enabled_p
12991 && cursor_row
->truncated_on_right_p
12992 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12993 /* For right-to-left rows, the logic is similar,
12994 except that rules for scrolling to left and right
12995 are reversed. E.g., if cursor.x <= h_margin, we
12996 need to hscroll "to the right" unconditionally,
12997 and that will scroll the screen to the left so as
12998 to reveal the next portion of the row. */
13000 && ((cursor_row
->enabled_p
13001 /* FIXME: It is confusing to set the
13002 truncated_on_right_p flag when R2L rows
13003 are actually truncated on the left. */
13004 && cursor_row
->truncated_on_right_p
13005 && w
->cursor
.x
<= h_margin
)
13007 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
13011 struct buffer
*saved_current_buffer
;
13015 /* Find point in a display of infinite width. */
13016 saved_current_buffer
= current_buffer
;
13017 current_buffer
= XBUFFER (w
->contents
);
13019 if (w
== XWINDOW (selected_window
))
13022 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
13024 /* Move iterator to pt starting at cursor_row->start in
13025 a line with infinite width. */
13026 init_to_row_start (&it
, w
, cursor_row
);
13027 it
.last_visible_x
= INFINITY
;
13028 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
13029 current_buffer
= saved_current_buffer
;
13031 /* Position cursor in window. */
13032 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
13033 hscroll
= max (0, (it
.current_x
13034 - (ITERATOR_AT_END_OF_LINE_P (&it
)
13035 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
13036 : (text_area_width
/ 2))))
13037 / FRAME_COLUMN_WIDTH (it
.f
);
13038 else if ((!row_r2l_p
13039 && w
->cursor
.x
>= text_area_width
- h_margin
)
13040 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
13042 if (hscroll_relative_p
)
13043 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
13046 wanted_x
= text_area_width
13047 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
13050 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
13054 if (hscroll_relative_p
)
13055 wanted_x
= text_area_width
* hscroll_step_rel
13058 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
13061 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
13063 hscroll
= max (hscroll
, w
->min_hscroll
);
13065 /* Don't prevent redisplay optimizations if hscroll
13066 hasn't changed, as it will unnecessarily slow down
13068 if (w
->hscroll
!= hscroll
)
13070 struct buffer
*b
= XBUFFER (w
->contents
);
13071 b
->prevent_redisplay_optimizations_p
= true;
13072 w
->hscroll
= hscroll
;
13073 hscrolled_p
= true;
13081 /* Value is true if hscroll of any leaf window has been changed. */
13082 return hscrolled_p
;
13086 /* Set hscroll so that cursor is visible and not inside horizontal
13087 scroll margins for all windows in the tree rooted at WINDOW. See
13088 also hscroll_window_tree above. Value is true if any window's
13089 hscroll has been changed. If it has, desired matrices on the frame
13090 of WINDOW are cleared. */
13093 hscroll_windows (Lisp_Object window
)
13095 bool hscrolled_p
= hscroll_window_tree (window
);
13097 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
13098 return hscrolled_p
;
13103 /************************************************************************
13105 ************************************************************************/
13107 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined.
13108 This is sometimes handy to have in a debugger session. */
13112 /* First and last unchanged row for try_window_id. */
13114 static int debug_first_unchanged_at_end_vpos
;
13115 static int debug_last_unchanged_at_beg_vpos
;
13117 /* Delta vpos and y. */
13119 static int debug_dvpos
, debug_dy
;
13121 /* Delta in characters and bytes for try_window_id. */
13123 static ptrdiff_t debug_delta
, debug_delta_bytes
;
13125 /* Values of window_end_pos and window_end_vpos at the end of
13128 static ptrdiff_t debug_end_vpos
;
13130 /* Append a string to W->desired_matrix->method. FMT is a printf
13131 format string. If trace_redisplay_p is true also printf the
13132 resulting string to stderr. */
13134 static void debug_method_add (struct window
*, char const *, ...)
13135 ATTRIBUTE_FORMAT_PRINTF (2, 3);
13138 debug_method_add (struct window
*w
, char const *fmt
, ...)
13141 char *method
= w
->desired_matrix
->method
;
13142 int len
= strlen (method
);
13143 int size
= sizeof w
->desired_matrix
->method
;
13144 int remaining
= size
- len
- 1;
13147 if (len
&& remaining
)
13150 --remaining
, ++len
;
13153 va_start (ap
, fmt
);
13154 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
13157 if (trace_redisplay_p
)
13158 fprintf (stderr
, "%p (%s): %s\n",
13160 ((BUFFERP (w
->contents
)
13161 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
13162 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13167 #endif /* GLYPH_DEBUG */
13170 /* Value is true if all changes in window W, which displays
13171 current_buffer, are in the text between START and END. START is a
13172 buffer position, END is given as a distance from Z. Used in
13173 redisplay_internal for display optimization. */
13176 text_outside_line_unchanged_p (struct window
*w
,
13177 ptrdiff_t start
, ptrdiff_t end
)
13179 bool unchanged_p
= true;
13181 /* If text or overlays have changed, see where. */
13182 if (window_outdated (w
))
13184 /* Gap in the line? */
13185 if (GPT
< start
|| Z
- GPT
< end
)
13186 unchanged_p
= false;
13188 /* Changes start in front of the line, or end after it? */
13190 && (BEG_UNCHANGED
< start
- 1
13191 || END_UNCHANGED
< end
))
13192 unchanged_p
= false;
13194 /* If selective display, can't optimize if changes start at the
13195 beginning of the line. */
13197 && INTEGERP (BVAR (current_buffer
, selective_display
))
13198 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13199 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13200 unchanged_p
= false;
13202 /* If there are overlays at the start or end of the line, these
13203 may have overlay strings with newlines in them. A change at
13204 START, for instance, may actually concern the display of such
13205 overlay strings as well, and they are displayed on different
13206 lines. So, quickly rule out this case. (For the future, it
13207 might be desirable to implement something more telling than
13208 just BEG/END_UNCHANGED.) */
13211 if (BEG
+ BEG_UNCHANGED
== start
13212 && overlay_touches_p (start
))
13213 unchanged_p
= false;
13214 if (END_UNCHANGED
== end
13215 && overlay_touches_p (Z
- end
))
13216 unchanged_p
= false;
13219 /* Under bidi reordering, adding or deleting a character in the
13220 beginning of a paragraph, before the first strong directional
13221 character, can change the base direction of the paragraph (unless
13222 the buffer specifies a fixed paragraph direction), which will
13223 require redisplaying the whole paragraph. It might be worthwhile
13224 to find the paragraph limits and widen the range of redisplayed
13225 lines to that, but for now just give up this optimization. */
13226 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13227 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13228 unchanged_p
= false;
13231 return unchanged_p
;
13235 /* Do a frame update, taking possible shortcuts into account. This is
13236 the main external entry point for redisplay.
13238 If the last redisplay displayed an echo area message and that message
13239 is no longer requested, we clear the echo area or bring back the
13240 mini-buffer if that is in use. */
13245 redisplay_internal ();
13250 overlay_arrow_string_or_property (Lisp_Object var
)
13254 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13257 return Voverlay_arrow_string
;
13260 /* Return true if there are any overlay-arrows in current_buffer. */
13262 overlay_arrow_in_current_buffer_p (void)
13266 for (vlist
= Voverlay_arrow_variable_list
;
13268 vlist
= XCDR (vlist
))
13270 Lisp_Object var
= XCAR (vlist
);
13273 if (!SYMBOLP (var
))
13275 val
= find_symbol_value (var
);
13277 && current_buffer
== XMARKER (val
)->buffer
)
13284 /* Return true if any overlay_arrows have moved or overlay-arrow-string
13288 overlay_arrows_changed_p (void)
13292 for (vlist
= Voverlay_arrow_variable_list
;
13294 vlist
= XCDR (vlist
))
13296 Lisp_Object var
= XCAR (vlist
);
13297 Lisp_Object val
, pstr
;
13299 if (!SYMBOLP (var
))
13301 val
= find_symbol_value (var
);
13302 if (!MARKERP (val
))
13304 if (! EQ (COERCE_MARKER (val
),
13305 Fget (var
, Qlast_arrow_position
))
13306 || ! (pstr
= overlay_arrow_string_or_property (var
),
13307 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13313 /* Mark overlay arrows to be updated on next redisplay. */
13316 update_overlay_arrows (int up_to_date
)
13320 for (vlist
= Voverlay_arrow_variable_list
;
13322 vlist
= XCDR (vlist
))
13324 Lisp_Object var
= XCAR (vlist
);
13326 if (!SYMBOLP (var
))
13329 if (up_to_date
> 0)
13331 Lisp_Object val
= find_symbol_value (var
);
13332 Fput (var
, Qlast_arrow_position
,
13333 COERCE_MARKER (val
));
13334 Fput (var
, Qlast_arrow_string
,
13335 overlay_arrow_string_or_property (var
));
13337 else if (up_to_date
< 0
13338 || !NILP (Fget (var
, Qlast_arrow_position
)))
13340 Fput (var
, Qlast_arrow_position
, Qt
);
13341 Fput (var
, Qlast_arrow_string
, Qt
);
13347 /* Return overlay arrow string to display at row.
13348 Return integer (bitmap number) for arrow bitmap in left fringe.
13349 Return nil if no overlay arrow. */
13352 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13356 for (vlist
= Voverlay_arrow_variable_list
;
13358 vlist
= XCDR (vlist
))
13360 Lisp_Object var
= XCAR (vlist
);
13363 if (!SYMBOLP (var
))
13366 val
= find_symbol_value (var
);
13369 && current_buffer
== XMARKER (val
)->buffer
13370 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13372 if (FRAME_WINDOW_P (it
->f
)
13373 /* FIXME: if ROW->reversed_p is set, this should test
13374 the right fringe, not the left one. */
13375 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13377 #ifdef HAVE_WINDOW_SYSTEM
13378 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13380 int fringe_bitmap
= lookup_fringe_bitmap (val
);
13381 if (fringe_bitmap
!= 0)
13382 return make_number (fringe_bitmap
);
13385 return make_number (-1); /* Use default arrow bitmap. */
13387 return overlay_arrow_string_or_property (var
);
13394 /* Return true if point moved out of or into a composition. Otherwise
13395 return false. PREV_BUF and PREV_PT are the last point buffer and
13396 position. BUF and PT are the current point buffer and position. */
13399 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13400 struct buffer
*buf
, ptrdiff_t pt
)
13402 ptrdiff_t start
, end
;
13404 Lisp_Object buffer
;
13406 XSETBUFFER (buffer
, buf
);
13407 /* Check a composition at the last point if point moved within the
13409 if (prev_buf
== buf
)
13412 /* Point didn't move. */
13415 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13416 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13417 && composition_valid_p (start
, end
, prop
)
13418 && start
< prev_pt
&& end
> prev_pt
)
13419 /* The last point was within the composition. Return true iff
13420 point moved out of the composition. */
13421 return (pt
<= start
|| pt
>= end
);
13424 /* Check a composition at the current point. */
13425 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13426 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13427 && composition_valid_p (start
, end
, prop
)
13428 && start
< pt
&& end
> pt
);
13431 /* Reconsider the clip changes of buffer which is displayed in W. */
13434 reconsider_clip_changes (struct window
*w
)
13436 struct buffer
*b
= XBUFFER (w
->contents
);
13438 if (b
->clip_changed
13439 && w
->window_end_valid
13440 && w
->current_matrix
->buffer
== b
13441 && w
->current_matrix
->zv
== BUF_ZV (b
)
13442 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13443 b
->clip_changed
= false;
13445 /* If display wasn't paused, and W is not a tool bar window, see if
13446 point has been moved into or out of a composition. In that case,
13447 set b->clip_changed to force updating the screen. If
13448 b->clip_changed has already been set, skip this check. */
13449 if (!b
->clip_changed
&& w
->window_end_valid
)
13451 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13452 ? PT
: marker_position (w
->pointm
));
13454 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13455 && check_point_in_composition (w
->current_matrix
->buffer
,
13456 w
->last_point
, b
, pt
))
13457 b
->clip_changed
= true;
13462 propagate_buffer_redisplay (void)
13463 { /* Resetting b->text->redisplay is problematic!
13464 We can't just reset it in the case that some window that displays
13465 it has not been redisplayed; and such a window can stay
13466 unredisplayed for a long time if it's currently invisible.
13467 But we do want to reset it at the end of redisplay otherwise
13468 its displayed windows will keep being redisplayed over and over
13470 So we copy all b->text->redisplay flags up to their windows here,
13471 such that mark_window_display_accurate can safely reset
13472 b->text->redisplay. */
13473 Lisp_Object ws
= window_list ();
13474 for (; CONSP (ws
); ws
= XCDR (ws
))
13476 struct window
*thisw
= XWINDOW (XCAR (ws
));
13477 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13478 if (thisb
->text
->redisplay
)
13479 thisw
->redisplay
= true;
13483 #define STOP_POLLING \
13484 do { if (! polling_stopped_here) stop_polling (); \
13485 polling_stopped_here = true; } while (false)
13487 #define RESUME_POLLING \
13488 do { if (polling_stopped_here) start_polling (); \
13489 polling_stopped_here = false; } while (false)
13492 /* Perhaps in the future avoid recentering windows if it
13493 is not necessary; currently that causes some problems. */
13496 redisplay_internal (void)
13498 struct window
*w
= XWINDOW (selected_window
);
13502 bool must_finish
= false, match_p
;
13503 struct text_pos tlbufpos
, tlendpos
;
13504 int number_of_visible_frames
;
13507 bool polling_stopped_here
= false;
13508 Lisp_Object tail
, frame
;
13510 /* True means redisplay has to consider all windows on all
13511 frames. False, only selected_window is considered. */
13512 bool consider_all_windows_p
;
13514 /* True means redisplay has to redisplay the miniwindow. */
13515 bool update_miniwindow_p
= false;
13517 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13519 /* No redisplay if running in batch mode or frame is not yet fully
13520 initialized, or redisplay is explicitly turned off by setting
13521 Vinhibit_redisplay. */
13522 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13523 || !NILP (Vinhibit_redisplay
))
13526 /* Don't examine these until after testing Vinhibit_redisplay.
13527 When Emacs is shutting down, perhaps because its connection to
13528 X has dropped, we should not look at them at all. */
13529 fr
= XFRAME (w
->frame
);
13530 sf
= SELECTED_FRAME ();
13532 if (!fr
->glyphs_initialized_p
)
13535 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13536 if (popup_activated ())
13540 /* I don't think this happens but let's be paranoid. */
13541 if (redisplaying_p
)
13544 /* Record a function that clears redisplaying_p
13545 when we leave this function. */
13546 count
= SPECPDL_INDEX ();
13547 record_unwind_protect_void (unwind_redisplay
);
13548 redisplaying_p
= true;
13549 specbind (Qinhibit_free_realized_faces
, Qnil
);
13551 /* Record this function, so it appears on the profiler's backtraces. */
13552 record_in_backtrace (Qredisplay_internal_xC_functionx
, 0, 0);
13554 FOR_EACH_FRAME (tail
, frame
)
13555 XFRAME (frame
)->already_hscrolled_p
= false;
13558 /* Remember the currently selected window. */
13562 forget_escape_and_glyphless_faces ();
13564 inhibit_free_realized_faces
= false;
13566 /* If face_change, init_iterator will free all realized faces, which
13567 includes the faces referenced from current matrices. So, we
13568 can't reuse current matrices in this case. */
13570 windows_or_buffers_changed
= 47;
13572 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13573 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13575 /* Since frames on a single ASCII terminal share the same
13576 display area, displaying a different frame means redisplay
13577 the whole thing. */
13578 SET_FRAME_GARBAGED (sf
);
13580 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13582 FRAME_TTY (sf
)->previous_frame
= sf
;
13585 /* Set the visible flags for all frames. Do this before checking for
13586 resized or garbaged frames; they want to know if their frames are
13587 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13588 number_of_visible_frames
= 0;
13590 FOR_EACH_FRAME (tail
, frame
)
13592 struct frame
*f
= XFRAME (frame
);
13594 if (FRAME_VISIBLE_P (f
))
13596 ++number_of_visible_frames
;
13597 /* Adjust matrices for visible frames only. */
13598 if (f
->fonts_changed
)
13600 adjust_frame_glyphs (f
);
13601 /* Disable all redisplay optimizations for this frame.
13602 This is because adjust_frame_glyphs resets the
13603 enabled_p flag for all glyph rows of all windows, so
13604 many optimizations will fail anyway, and some might
13605 fail to test that flag and do bogus things as
13607 SET_FRAME_GARBAGED (f
);
13608 f
->fonts_changed
= false;
13610 /* If cursor type has been changed on the frame
13611 other than selected, consider all frames. */
13612 if (f
!= sf
&& f
->cursor_type_changed
)
13613 fset_redisplay (f
);
13615 clear_desired_matrices (f
);
13618 /* Notice any pending interrupt request to change frame size. */
13619 do_pending_window_change (true);
13621 /* do_pending_window_change could change the selected_window due to
13622 frame resizing which makes the selected window too small. */
13623 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13626 /* Clear frames marked as garbaged. */
13627 clear_garbaged_frames ();
13629 /* Build menubar and tool-bar items. */
13630 if (NILP (Vmemory_full
))
13631 prepare_menu_bars ();
13633 reconsider_clip_changes (w
);
13635 /* In most cases selected window displays current buffer. */
13636 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13639 /* Detect case that we need to write or remove a star in the mode line. */
13640 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13641 w
->update_mode_line
= true;
13643 if (mode_line_update_needed (w
))
13644 w
->update_mode_line
= true;
13646 /* If reconsider_clip_changes above decided that the narrowing
13647 in the current buffer changed, make sure all other windows
13648 showing that buffer will be redisplayed. */
13649 if (current_buffer
->clip_changed
)
13650 bset_update_mode_line (current_buffer
);
13653 /* Normally the message* functions will have already displayed and
13654 updated the echo area, but the frame may have been trashed, or
13655 the update may have been preempted, so display the echo area
13656 again here. Checking message_cleared_p captures the case that
13657 the echo area should be cleared. */
13658 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13659 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13660 || (message_cleared_p
13661 && minibuf_level
== 0
13662 /* If the mini-window is currently selected, this means the
13663 echo-area doesn't show through. */
13664 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13666 echo_area_display (false);
13668 /* If echo_area_display resizes the mini-window, the redisplay and
13669 window_sizes_changed flags of the selected frame are set, but
13670 it's too late for the hooks in window-size-change-functions,
13671 which have been examined already in prepare_menu_bars. So in
13672 that case we call the hooks here only for the selected frame. */
13675 ptrdiff_t count1
= SPECPDL_INDEX ();
13677 record_unwind_save_match_data ();
13678 run_window_size_change_functions (selected_frame
);
13679 unbind_to (count1
, Qnil
);
13682 if (message_cleared_p
)
13683 update_miniwindow_p
= true;
13685 must_finish
= true;
13687 /* If we don't display the current message, don't clear the
13688 message_cleared_p flag, because, if we did, we wouldn't clear
13689 the echo area in the next redisplay which doesn't preserve
13691 if (!display_last_displayed_message_p
)
13692 message_cleared_p
= false;
13694 else if (EQ (selected_window
, minibuf_window
)
13695 && (current_buffer
->clip_changed
|| window_outdated (w
))
13696 && resize_mini_window (w
, false))
13700 ptrdiff_t count1
= SPECPDL_INDEX ();
13702 record_unwind_save_match_data ();
13703 run_window_size_change_functions (selected_frame
);
13704 unbind_to (count1
, Qnil
);
13707 /* Resized active mini-window to fit the size of what it is
13708 showing if its contents might have changed. */
13709 must_finish
= true;
13711 /* If window configuration was changed, frames may have been
13712 marked garbaged. Clear them or we will experience
13713 surprises wrt scrolling. */
13714 clear_garbaged_frames ();
13717 if (windows_or_buffers_changed
&& !update_mode_lines
)
13718 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13719 only the windows's contents needs to be refreshed, or whether the
13720 mode-lines also need a refresh. */
13721 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13722 ? REDISPLAY_SOME
: 32);
13724 /* If specs for an arrow have changed, do thorough redisplay
13725 to ensure we remove any arrow that should no longer exist. */
13726 if (overlay_arrows_changed_p ())
13727 /* Apparently, this is the only case where we update other windows,
13728 without updating other mode-lines. */
13729 windows_or_buffers_changed
= 49;
13731 consider_all_windows_p
= (update_mode_lines
13732 || windows_or_buffers_changed
);
13734 #define AINC(a,i) \
13736 Lisp_Object entry = Fgethash (make_number (i), a, make_number (0)); \
13737 if (INTEGERP (entry)) \
13738 Fputhash (make_number (i), make_number (1 + XINT (entry)), a); \
13741 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13742 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13744 /* Optimize the case that only the line containing the cursor in the
13745 selected window has changed. Variables starting with this_ are
13746 set in display_line and record information about the line
13747 containing the cursor. */
13748 tlbufpos
= this_line_start_pos
;
13749 tlendpos
= this_line_end_pos
;
13750 if (!consider_all_windows_p
13751 && CHARPOS (tlbufpos
) > 0
13752 && !w
->update_mode_line
13753 && !current_buffer
->clip_changed
13754 && !current_buffer
->prevent_redisplay_optimizations_p
13755 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13756 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13757 && !XFRAME (w
->frame
)->cursor_type_changed
13758 && !XFRAME (w
->frame
)->face_change
13759 /* Make sure recorded data applies to current buffer, etc. */
13760 && this_line_buffer
== current_buffer
13763 && !w
->optional_new_start
13764 /* Point must be on the line that we have info recorded about. */
13765 && PT
>= CHARPOS (tlbufpos
)
13766 && PT
<= Z
- CHARPOS (tlendpos
)
13767 /* All text outside that line, including its final newline,
13768 must be unchanged. */
13769 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13770 CHARPOS (tlendpos
)))
13772 if (CHARPOS (tlbufpos
) > BEGV
13773 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13774 && (CHARPOS (tlbufpos
) == ZV
13775 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13776 /* Former continuation line has disappeared by becoming empty. */
13778 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13780 /* We have to handle the case of continuation around a
13781 wide-column character (see the comment in indent.c around
13784 For instance, in the following case:
13786 -------- Insert --------
13787 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13788 J_I_ ==> J_I_ `^^' are cursors.
13792 As we have to redraw the line above, we cannot use this
13796 int line_height_before
= this_line_pixel_height
;
13798 /* Note that start_display will handle the case that the
13799 line starting at tlbufpos is a continuation line. */
13800 start_display (&it
, w
, tlbufpos
);
13802 /* Implementation note: It this still necessary? */
13803 if (it
.current_x
!= this_line_start_x
)
13806 TRACE ((stderr
, "trying display optimization 1\n"));
13807 w
->cursor
.vpos
= -1;
13808 overlay_arrow_seen
= false;
13809 it
.vpos
= this_line_vpos
;
13810 it
.current_y
= this_line_y
;
13811 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13812 display_line (&it
);
13814 /* If line contains point, is not continued,
13815 and ends at same distance from eob as before, we win. */
13816 if (w
->cursor
.vpos
>= 0
13817 /* Line is not continued, otherwise this_line_start_pos
13818 would have been set to 0 in display_line. */
13819 && CHARPOS (this_line_start_pos
)
13820 /* Line ends as before. */
13821 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13822 /* Line has same height as before. Otherwise other lines
13823 would have to be shifted up or down. */
13824 && this_line_pixel_height
== line_height_before
)
13826 /* If this is not the window's last line, we must adjust
13827 the charstarts of the lines below. */
13828 if (it
.current_y
< it
.last_visible_y
)
13830 struct glyph_row
*row
13831 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13832 ptrdiff_t delta
, delta_bytes
;
13834 /* We used to distinguish between two cases here,
13835 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13836 when the line ends in a newline or the end of the
13837 buffer's accessible portion. But both cases did
13838 the same, so they were collapsed. */
13840 - CHARPOS (tlendpos
)
13841 - MATRIX_ROW_START_CHARPOS (row
));
13842 delta_bytes
= (Z_BYTE
13843 - BYTEPOS (tlendpos
)
13844 - MATRIX_ROW_START_BYTEPOS (row
));
13846 increment_matrix_positions (w
->current_matrix
,
13847 this_line_vpos
+ 1,
13848 w
->current_matrix
->nrows
,
13849 delta
, delta_bytes
);
13852 /* If this row displays text now but previously didn't,
13853 or vice versa, w->window_end_vpos may have to be
13855 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13857 if (w
->window_end_vpos
< this_line_vpos
)
13858 w
->window_end_vpos
= this_line_vpos
;
13860 else if (w
->window_end_vpos
== this_line_vpos
13861 && this_line_vpos
> 0)
13862 w
->window_end_vpos
= this_line_vpos
- 1;
13863 w
->window_end_valid
= false;
13865 /* Update hint: No need to try to scroll in update_window. */
13866 w
->desired_matrix
->no_scrolling_p
= true;
13869 *w
->desired_matrix
->method
= 0;
13870 debug_method_add (w
, "optimization 1");
13872 #ifdef HAVE_WINDOW_SYSTEM
13873 update_window_fringes (w
, false);
13880 else if (/* Cursor position hasn't changed. */
13881 PT
== w
->last_point
13882 /* Make sure the cursor was last displayed
13883 in this window. Otherwise we have to reposition it. */
13885 /* PXW: Must be converted to pixels, probably. */
13886 && 0 <= w
->cursor
.vpos
13887 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13891 do_pending_window_change (true);
13892 /* If selected_window changed, redisplay again. */
13893 if (WINDOWP (selected_window
)
13894 && (w
= XWINDOW (selected_window
)) != sw
)
13897 /* We used to always goto end_of_redisplay here, but this
13898 isn't enough if we have a blinking cursor. */
13899 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13900 goto end_of_redisplay
;
13904 /* If highlighting the region, or if the cursor is in the echo area,
13905 then we can't just move the cursor. */
13906 else if (NILP (Vshow_trailing_whitespace
)
13907 && !cursor_in_echo_area
)
13910 struct glyph_row
*row
;
13912 /* Skip from tlbufpos to PT and see where it is. Note that
13913 PT may be in invisible text. If so, we will end at the
13914 next visible position. */
13915 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13916 NULL
, DEFAULT_FACE_ID
);
13917 it
.current_x
= this_line_start_x
;
13918 it
.current_y
= this_line_y
;
13919 it
.vpos
= this_line_vpos
;
13921 /* The call to move_it_to stops in front of PT, but
13922 moves over before-strings. */
13923 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13925 if (it
.vpos
== this_line_vpos
13926 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13929 eassert (this_line_vpos
== it
.vpos
);
13930 eassert (this_line_y
== it
.current_y
);
13931 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13932 if (cursor_row_fully_visible_p (w
, false, true))
13935 *w
->desired_matrix
->method
= 0;
13936 debug_method_add (w
, "optimization 3");
13948 /* Text changed drastically or point moved off of line. */
13949 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13952 CHARPOS (this_line_start_pos
) = 0;
13953 ++clear_face_cache_count
;
13954 #ifdef HAVE_WINDOW_SYSTEM
13955 ++clear_image_cache_count
;
13958 /* Build desired matrices, and update the display. If
13959 consider_all_windows_p, do it for all windows on all frames that
13960 require redisplay, as specified by their 'redisplay' flag.
13961 Otherwise do it for selected_window, only. */
13963 if (consider_all_windows_p
)
13965 FOR_EACH_FRAME (tail
, frame
)
13966 XFRAME (frame
)->updated_p
= false;
13968 propagate_buffer_redisplay ();
13970 FOR_EACH_FRAME (tail
, frame
)
13972 struct frame
*f
= XFRAME (frame
);
13974 /* We don't have to do anything for unselected terminal
13976 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13977 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13981 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13984 /* Only GC scrollbars when we redisplay the whole frame. */
13985 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13986 bool f_redisplay_flag
= f
->redisplay
;
13987 /* Mark all the scroll bars to be removed; we'll redeem
13988 the ones we want when we redisplay their windows. */
13989 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13990 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13992 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13993 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13994 /* Remember that the invisible frames need to be redisplayed next
13995 time they're visible. */
13996 else if (!REDISPLAY_SOME_P ())
13997 f
->redisplay
= true;
13999 /* The X error handler may have deleted that frame. */
14000 if (!FRAME_LIVE_P (f
))
14003 /* Any scroll bars which redisplay_windows should have
14004 nuked should now go away. */
14005 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
14006 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
14008 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
14010 /* If fonts changed on visible frame, display again. */
14011 if (f
->fonts_changed
)
14013 adjust_frame_glyphs (f
);
14014 /* Disable all redisplay optimizations for this
14015 frame. For the reasons, see the comment near
14016 the previous call to adjust_frame_glyphs above. */
14017 SET_FRAME_GARBAGED (f
);
14018 f
->fonts_changed
= false;
14022 /* See if we have to hscroll. */
14023 if (!f
->already_hscrolled_p
)
14025 f
->already_hscrolled_p
= true;
14026 if (hscroll_windows (f
->root_window
))
14030 /* If the frame's redisplay flag was not set before
14031 we went about redisplaying its windows, but it is
14032 set now, that means we employed some redisplay
14033 optimizations inside redisplay_windows, and
14034 bypassed producing some screen lines. But if
14035 f->redisplay is now set, it might mean the old
14036 faces are no longer valid (e.g., if redisplaying
14037 some window called some Lisp which defined a new
14038 face or redefined an existing face), so trying to
14039 use them in update_frame will segfault.
14040 Therefore, we must redisplay this frame. */
14041 if (!f_redisplay_flag
&& f
->redisplay
)
14044 /* Prevent various kinds of signals during display
14045 update. stdio is not robust about handling
14046 signals, which can cause an apparent I/O error. */
14047 if (interrupt_input
)
14048 unrequest_sigio ();
14051 pending
|= update_frame (f
, false, false);
14052 f
->cursor_type_changed
= false;
14053 f
->updated_p
= true;
14058 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
14062 /* Do the mark_window_display_accurate after all windows have
14063 been redisplayed because this call resets flags in buffers
14064 which are needed for proper redisplay. */
14065 FOR_EACH_FRAME (tail
, frame
)
14067 struct frame
*f
= XFRAME (frame
);
14070 f
->redisplay
= false;
14071 mark_window_display_accurate (f
->root_window
, true);
14072 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
14073 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
14078 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
14080 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
14081 /* Use list_of_error, not Qerror, so that
14082 we catch only errors and don't run the debugger. */
14083 internal_condition_case_1 (redisplay_window_1
, selected_window
,
14085 redisplay_window_error
);
14086 if (update_miniwindow_p
)
14087 internal_condition_case_1 (redisplay_window_1
,
14088 FRAME_MINIBUF_WINDOW (sf
), list_of_error
,
14089 redisplay_window_error
);
14091 /* Compare desired and current matrices, perform output. */
14094 /* If fonts changed, display again. Likewise if redisplay_window_1
14095 above caused some change (e.g., a change in faces) that requires
14096 considering the entire frame again. */
14097 if (sf
->fonts_changed
|| sf
->redisplay
)
14101 /* Set this to force a more thorough redisplay.
14102 Otherwise, we might immediately loop back to the
14103 above "else-if" clause (since all the conditions that
14104 led here might still be true), and we will then
14105 infloop, because the selected-frame's redisplay flag
14106 is not (and cannot be) reset. */
14107 windows_or_buffers_changed
= 50;
14112 /* Prevent freeing of realized faces, since desired matrices are
14113 pending that reference the faces we computed and cached. */
14114 inhibit_free_realized_faces
= true;
14116 /* Prevent various kinds of signals during display update.
14117 stdio is not robust about handling signals,
14118 which can cause an apparent I/O error. */
14119 if (interrupt_input
)
14120 unrequest_sigio ();
14123 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
14125 if (hscroll_windows (selected_window
))
14128 XWINDOW (selected_window
)->must_be_updated_p
= true;
14129 pending
= update_frame (sf
, false, false);
14130 sf
->cursor_type_changed
= false;
14133 /* We may have called echo_area_display at the top of this
14134 function. If the echo area is on another frame, that may
14135 have put text on a frame other than the selected one, so the
14136 above call to update_frame would not have caught it. Catch
14138 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
14139 struct frame
*mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
14141 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
14143 XWINDOW (mini_window
)->must_be_updated_p
= true;
14144 pending
|= update_frame (mini_frame
, false, false);
14145 mini_frame
->cursor_type_changed
= false;
14146 if (!pending
&& hscroll_windows (mini_window
))
14151 /* If display was paused because of pending input, make sure we do a
14152 thorough update the next time. */
14155 /* Prevent the optimization at the beginning of
14156 redisplay_internal that tries a single-line update of the
14157 line containing the cursor in the selected window. */
14158 CHARPOS (this_line_start_pos
) = 0;
14160 /* Let the overlay arrow be updated the next time. */
14161 update_overlay_arrows (0);
14163 /* If we pause after scrolling, some rows in the current
14164 matrices of some windows are not valid. */
14165 if (!WINDOW_FULL_WIDTH_P (w
)
14166 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
14167 update_mode_lines
= 36;
14171 if (!consider_all_windows_p
)
14173 /* This has already been done above if
14174 consider_all_windows_p is set. */
14175 if (XBUFFER (w
->contents
)->text
->redisplay
14176 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
14177 /* This can happen if b->text->redisplay was set during
14179 propagate_buffer_redisplay ();
14180 mark_window_display_accurate_1 (w
, true);
14182 /* Say overlay arrows are up to date. */
14183 update_overlay_arrows (1);
14185 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
14186 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
14189 update_mode_lines
= 0;
14190 windows_or_buffers_changed
= 0;
14193 /* Start SIGIO interrupts coming again. Having them off during the
14194 code above makes it less likely one will discard output, but not
14195 impossible, since there might be stuff in the system buffer here.
14196 But it is much hairier to try to do anything about that. */
14197 if (interrupt_input
)
14201 /* If a frame has become visible which was not before, redisplay
14202 again, so that we display it. Expose events for such a frame
14203 (which it gets when becoming visible) don't call the parts of
14204 redisplay constructing glyphs, so simply exposing a frame won't
14205 display anything in this case. So, we have to display these
14206 frames here explicitly. */
14211 FOR_EACH_FRAME (tail
, frame
)
14213 if (XFRAME (frame
)->visible
)
14217 if (new_count
!= number_of_visible_frames
)
14218 windows_or_buffers_changed
= 52;
14221 /* Change frame size now if a change is pending. */
14222 do_pending_window_change (true);
14224 /* If we just did a pending size change, or have additional
14225 visible frames, or selected_window changed, redisplay again. */
14226 if ((windows_or_buffers_changed
&& !pending
)
14227 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14230 /* Clear the face and image caches.
14232 We used to do this only if consider_all_windows_p. But the cache
14233 needs to be cleared if a timer creates images in the current
14234 buffer (e.g. the test case in Bug#6230). */
14236 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14238 clear_face_cache (false);
14239 clear_face_cache_count
= 0;
14242 #ifdef HAVE_WINDOW_SYSTEM
14243 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14245 clear_image_caches (Qnil
);
14246 clear_image_cache_count
= 0;
14248 #endif /* HAVE_WINDOW_SYSTEM */
14252 ns_set_doc_edited ();
14254 if (interrupt_input
&& interrupts_deferred
)
14257 unbind_to (count
, Qnil
);
14262 /* Redisplay, but leave alone any recent echo area message unless
14263 another message has been requested in its place.
14265 This is useful in situations where you need to redisplay but no
14266 user action has occurred, making it inappropriate for the message
14267 area to be cleared. See tracking_off and
14268 wait_reading_process_output for examples of these situations.
14270 FROM_WHERE is an integer saying from where this function was
14271 called. This is useful for debugging. */
14274 redisplay_preserve_echo_area (int from_where
)
14276 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14278 if (!NILP (echo_area_buffer
[1]))
14280 /* We have a previously displayed message, but no current
14281 message. Redisplay the previous message. */
14282 display_last_displayed_message_p
= true;
14283 redisplay_internal ();
14284 display_last_displayed_message_p
= false;
14287 redisplay_internal ();
14289 flush_frame (SELECTED_FRAME ());
14293 /* Function registered with record_unwind_protect in redisplay_internal. */
14296 unwind_redisplay (void)
14298 redisplaying_p
= false;
14302 /* Mark the display of leaf window W as accurate or inaccurate.
14303 If ACCURATE_P, mark display of W as accurate.
14304 If !ACCURATE_P, arrange for W to be redisplayed the next
14305 time redisplay_internal is called. */
14308 mark_window_display_accurate_1 (struct window
*w
, bool accurate_p
)
14310 struct buffer
*b
= XBUFFER (w
->contents
);
14312 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14313 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14314 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14318 b
->clip_changed
= false;
14319 b
->prevent_redisplay_optimizations_p
= false;
14320 eassert (buffer_window_count (b
) > 0);
14321 /* Resetting b->text->redisplay is problematic!
14322 In order to make it safer to do it here, redisplay_internal must
14323 have copied all b->text->redisplay to their respective windows. */
14324 b
->text
->redisplay
= false;
14326 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14327 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14328 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14329 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14331 w
->current_matrix
->buffer
= b
;
14332 w
->current_matrix
->begv
= BUF_BEGV (b
);
14333 w
->current_matrix
->zv
= BUF_ZV (b
);
14335 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14336 w
->last_cursor_off_p
= w
->cursor_off_p
;
14338 if (w
== XWINDOW (selected_window
))
14339 w
->last_point
= BUF_PT (b
);
14341 w
->last_point
= marker_position (w
->pointm
);
14343 w
->window_end_valid
= true;
14344 w
->update_mode_line
= false;
14347 w
->redisplay
= !accurate_p
;
14351 /* Mark the display of windows in the window tree rooted at WINDOW as
14352 accurate or inaccurate. If ACCURATE_P, mark display of
14353 windows as accurate. If !ACCURATE_P, arrange for windows to
14354 be redisplayed the next time redisplay_internal is called. */
14357 mark_window_display_accurate (Lisp_Object window
, bool accurate_p
)
14361 for (; !NILP (window
); window
= w
->next
)
14363 w
= XWINDOW (window
);
14364 if (WINDOWP (w
->contents
))
14365 mark_window_display_accurate (w
->contents
, accurate_p
);
14367 mark_window_display_accurate_1 (w
, accurate_p
);
14371 update_overlay_arrows (1);
14373 /* Force a thorough redisplay the next time by setting
14374 last_arrow_position and last_arrow_string to t, which is
14375 unequal to any useful value of Voverlay_arrow_... */
14376 update_overlay_arrows (-1);
14380 /* Return value in display table DP (Lisp_Char_Table *) for character
14381 C. Since a display table doesn't have any parent, we don't have to
14382 follow parent. Do not call this function directly but use the
14383 macro DISP_CHAR_VECTOR. */
14386 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14390 if (ASCII_CHAR_P (c
))
14393 if (SUB_CHAR_TABLE_P (val
))
14394 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14400 XSETCHAR_TABLE (table
, dp
);
14401 val
= char_table_ref (table
, c
);
14410 /***********************************************************************
14412 ***********************************************************************/
14414 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14417 redisplay_windows (Lisp_Object window
)
14419 while (!NILP (window
))
14421 struct window
*w
= XWINDOW (window
);
14423 if (WINDOWP (w
->contents
))
14424 redisplay_windows (w
->contents
);
14425 else if (BUFFERP (w
->contents
))
14427 displayed_buffer
= XBUFFER (w
->contents
);
14428 /* Use list_of_error, not Qerror, so that
14429 we catch only errors and don't run the debugger. */
14430 internal_condition_case_1 (redisplay_window_0
, window
,
14432 redisplay_window_error
);
14440 redisplay_window_error (Lisp_Object ignore
)
14442 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14447 redisplay_window_0 (Lisp_Object window
)
14449 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14450 redisplay_window (window
, false);
14455 redisplay_window_1 (Lisp_Object window
)
14457 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14458 redisplay_window (window
, true);
14463 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14464 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14465 which positions recorded in ROW differ from current buffer
14468 Return true iff cursor is on this row. */
14471 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14472 struct glyph_matrix
*matrix
,
14473 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14476 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14477 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14478 struct glyph
*cursor
= NULL
;
14479 /* The last known character position in row. */
14480 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14482 ptrdiff_t pt_old
= PT
- delta
;
14483 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14484 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14485 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14486 /* A glyph beyond the edge of TEXT_AREA which we should never
14488 struct glyph
*glyphs_end
= end
;
14489 /* True means we've found a match for cursor position, but that
14490 glyph has the avoid_cursor_p flag set. */
14491 bool match_with_avoid_cursor
= false;
14492 /* True means we've seen at least one glyph that came from a
14494 bool string_seen
= false;
14495 /* Largest and smallest buffer positions seen so far during scan of
14497 ptrdiff_t bpos_max
= pos_before
;
14498 ptrdiff_t bpos_min
= pos_after
;
14499 /* Last buffer position covered by an overlay string with an integer
14500 `cursor' property. */
14501 ptrdiff_t bpos_covered
= 0;
14502 /* True means the display string on which to display the cursor
14503 comes from a text property, not from an overlay. */
14504 bool string_from_text_prop
= false;
14506 /* Don't even try doing anything if called for a mode-line or
14507 header-line row, since the rest of the code isn't prepared to
14508 deal with such calamities. */
14509 eassert (!row
->mode_line_p
);
14510 if (row
->mode_line_p
)
14513 /* Skip over glyphs not having an object at the start and the end of
14514 the row. These are special glyphs like truncation marks on
14515 terminal frames. */
14516 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14518 if (!row
->reversed_p
)
14521 && NILP (glyph
->object
)
14522 && glyph
->charpos
< 0)
14524 x
+= glyph
->pixel_width
;
14528 && NILP ((end
- 1)->object
)
14529 /* CHARPOS is zero for blanks and stretch glyphs
14530 inserted by extend_face_to_end_of_line. */
14531 && (end
- 1)->charpos
<= 0)
14533 glyph_before
= glyph
- 1;
14540 /* If the glyph row is reversed, we need to process it from back
14541 to front, so swap the edge pointers. */
14542 glyphs_end
= end
= glyph
- 1;
14543 glyph
+= row
->used
[TEXT_AREA
] - 1;
14545 while (glyph
> end
+ 1
14546 && NILP (glyph
->object
)
14547 && glyph
->charpos
< 0)
14550 x
-= glyph
->pixel_width
;
14552 if (NILP (glyph
->object
) && glyph
->charpos
< 0)
14554 /* By default, in reversed rows we put the cursor on the
14555 rightmost (first in the reading order) glyph. */
14556 for (g
= end
+ 1; g
< glyph
; g
++)
14557 x
+= g
->pixel_width
;
14559 && NILP ((end
+ 1)->object
)
14560 && (end
+ 1)->charpos
<= 0)
14562 glyph_before
= glyph
+ 1;
14566 else if (row
->reversed_p
)
14568 /* In R2L rows that don't display text, put the cursor on the
14569 rightmost glyph. Case in point: an empty last line that is
14570 part of an R2L paragraph. */
14572 /* Avoid placing the cursor on the last glyph of the row, where
14573 on terminal frames we hold the vertical border between
14574 adjacent windows. */
14575 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14576 && !WINDOW_RIGHTMOST_P (w
)
14577 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14579 x
= -1; /* will be computed below, at label compute_x */
14582 /* Step 1: Try to find the glyph whose character position
14583 corresponds to point. If that's not possible, find 2 glyphs
14584 whose character positions are the closest to point, one before
14585 point, the other after it. */
14586 if (!row
->reversed_p
)
14587 while (/* not marched to end of glyph row */
14589 /* glyph was not inserted by redisplay for internal purposes */
14590 && !NILP (glyph
->object
))
14592 if (BUFFERP (glyph
->object
))
14594 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14596 if (glyph
->charpos
> bpos_max
)
14597 bpos_max
= glyph
->charpos
;
14598 if (glyph
->charpos
< bpos_min
)
14599 bpos_min
= glyph
->charpos
;
14600 if (!glyph
->avoid_cursor_p
)
14602 /* If we hit point, we've found the glyph on which to
14603 display the cursor. */
14606 match_with_avoid_cursor
= false;
14609 /* See if we've found a better approximation to
14610 POS_BEFORE or to POS_AFTER. */
14611 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14613 pos_before
= glyph
->charpos
;
14614 glyph_before
= glyph
;
14616 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14618 pos_after
= glyph
->charpos
;
14619 glyph_after
= glyph
;
14622 else if (dpos
== 0)
14623 match_with_avoid_cursor
= true;
14625 else if (STRINGP (glyph
->object
))
14627 Lisp_Object chprop
;
14628 ptrdiff_t glyph_pos
= glyph
->charpos
;
14630 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14632 if (!NILP (chprop
))
14634 /* If the string came from a `display' text property,
14635 look up the buffer position of that property and
14636 use that position to update bpos_max, as if we
14637 actually saw such a position in one of the row's
14638 glyphs. This helps with supporting integer values
14639 of `cursor' property on the display string in
14640 situations where most or all of the row's buffer
14641 text is completely covered by display properties,
14642 so that no glyph with valid buffer positions is
14643 ever seen in the row. */
14644 ptrdiff_t prop_pos
=
14645 string_buffer_position_lim (glyph
->object
, pos_before
,
14648 if (prop_pos
>= pos_before
)
14649 bpos_max
= prop_pos
;
14651 if (INTEGERP (chprop
))
14653 bpos_covered
= bpos_max
+ XINT (chprop
);
14654 /* If the `cursor' property covers buffer positions up
14655 to and including point, we should display cursor on
14656 this glyph. Note that, if a `cursor' property on one
14657 of the string's characters has an integer value, we
14658 will break out of the loop below _before_ we get to
14659 the position match above. IOW, integer values of
14660 the `cursor' property override the "exact match for
14661 point" strategy of positioning the cursor. */
14662 /* Implementation note: bpos_max == pt_old when, e.g.,
14663 we are in an empty line, where bpos_max is set to
14664 MATRIX_ROW_START_CHARPOS, see above. */
14665 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14672 string_seen
= true;
14674 x
+= glyph
->pixel_width
;
14677 else if (glyph
> end
) /* row is reversed */
14678 while (!NILP (glyph
->object
))
14680 if (BUFFERP (glyph
->object
))
14682 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14684 if (glyph
->charpos
> bpos_max
)
14685 bpos_max
= glyph
->charpos
;
14686 if (glyph
->charpos
< bpos_min
)
14687 bpos_min
= glyph
->charpos
;
14688 if (!glyph
->avoid_cursor_p
)
14692 match_with_avoid_cursor
= false;
14695 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14697 pos_before
= glyph
->charpos
;
14698 glyph_before
= glyph
;
14700 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14702 pos_after
= glyph
->charpos
;
14703 glyph_after
= glyph
;
14706 else if (dpos
== 0)
14707 match_with_avoid_cursor
= true;
14709 else if (STRINGP (glyph
->object
))
14711 Lisp_Object chprop
;
14712 ptrdiff_t glyph_pos
= glyph
->charpos
;
14714 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14716 if (!NILP (chprop
))
14718 ptrdiff_t prop_pos
=
14719 string_buffer_position_lim (glyph
->object
, pos_before
,
14722 if (prop_pos
>= pos_before
)
14723 bpos_max
= prop_pos
;
14725 if (INTEGERP (chprop
))
14727 bpos_covered
= bpos_max
+ XINT (chprop
);
14728 /* If the `cursor' property covers buffer positions up
14729 to and including point, we should display cursor on
14731 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14737 string_seen
= true;
14740 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14742 x
--; /* can't use any pixel_width */
14745 x
-= glyph
->pixel_width
;
14748 /* Step 2: If we didn't find an exact match for point, we need to
14749 look for a proper place to put the cursor among glyphs between
14750 GLYPH_BEFORE and GLYPH_AFTER. */
14751 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14752 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14753 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14755 /* An empty line has a single glyph whose OBJECT is nil and
14756 whose CHARPOS is the position of a newline on that line.
14757 Note that on a TTY, there are more glyphs after that, which
14758 were produced by extend_face_to_end_of_line, but their
14759 CHARPOS is zero or negative. */
14760 bool empty_line_p
=
14761 ((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14762 && NILP (glyph
->object
) && glyph
->charpos
> 0
14763 /* On a TTY, continued and truncated rows also have a glyph at
14764 their end whose OBJECT is nil and whose CHARPOS is
14765 positive (the continuation and truncation glyphs), but such
14766 rows are obviously not "empty". */
14767 && !(row
->continued_p
|| row
->truncated_on_right_p
));
14769 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14771 ptrdiff_t ellipsis_pos
;
14773 /* Scan back over the ellipsis glyphs. */
14774 if (!row
->reversed_p
)
14776 ellipsis_pos
= (glyph
- 1)->charpos
;
14777 while (glyph
> row
->glyphs
[TEXT_AREA
]
14778 && (glyph
- 1)->charpos
== ellipsis_pos
)
14779 glyph
--, x
-= glyph
->pixel_width
;
14780 /* That loop always goes one position too far, including
14781 the glyph before the ellipsis. So scan forward over
14783 x
+= glyph
->pixel_width
;
14786 else /* row is reversed */
14788 ellipsis_pos
= (glyph
+ 1)->charpos
;
14789 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14790 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14791 glyph
++, x
+= glyph
->pixel_width
;
14792 x
-= glyph
->pixel_width
;
14796 else if (match_with_avoid_cursor
)
14798 cursor
= glyph_after
;
14801 else if (string_seen
)
14803 int incr
= row
->reversed_p
? -1 : +1;
14805 /* Need to find the glyph that came out of a string which is
14806 present at point. That glyph is somewhere between
14807 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14808 positioned between POS_BEFORE and POS_AFTER in the
14810 struct glyph
*start
, *stop
;
14811 ptrdiff_t pos
= pos_before
;
14815 /* If the row ends in a newline from a display string,
14816 reordering could have moved the glyphs belonging to the
14817 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14818 in this case we extend the search to the last glyph in
14819 the row that was not inserted by redisplay. */
14820 if (row
->ends_in_newline_from_string_p
)
14823 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14826 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14827 correspond to POS_BEFORE and POS_AFTER, respectively. We
14828 need START and STOP in the order that corresponds to the
14829 row's direction as given by its reversed_p flag. If the
14830 directionality of characters between POS_BEFORE and
14831 POS_AFTER is the opposite of the row's base direction,
14832 these characters will have been reordered for display,
14833 and we need to reverse START and STOP. */
14834 if (!row
->reversed_p
)
14836 start
= min (glyph_before
, glyph_after
);
14837 stop
= max (glyph_before
, glyph_after
);
14841 start
= max (glyph_before
, glyph_after
);
14842 stop
= min (glyph_before
, glyph_after
);
14844 for (glyph
= start
+ incr
;
14845 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14848 /* Any glyphs that come from the buffer are here because
14849 of bidi reordering. Skip them, and only pay
14850 attention to glyphs that came from some string. */
14851 if (STRINGP (glyph
->object
))
14855 /* If the display property covers the newline, we
14856 need to search for it one position farther. */
14857 ptrdiff_t lim
= pos_after
14858 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14860 string_from_text_prop
= false;
14861 str
= glyph
->object
;
14862 tem
= string_buffer_position_lim (str
, pos
, lim
, false);
14863 if (tem
== 0 /* from overlay */
14866 /* If the string from which this glyph came is
14867 found in the buffer at point, or at position
14868 that is closer to point than pos_after, then
14869 we've found the glyph we've been looking for.
14870 If it comes from an overlay (tem == 0), and
14871 it has the `cursor' property on one of its
14872 glyphs, record that glyph as a candidate for
14873 displaying the cursor. (As in the
14874 unidirectional version, we will display the
14875 cursor on the last candidate we find.) */
14878 || (tem
- pt_old
> 0 && tem
< pos_after
))
14880 /* The glyphs from this string could have
14881 been reordered. Find the one with the
14882 smallest string position. Or there could
14883 be a character in the string with the
14884 `cursor' property, which means display
14885 cursor on that character's glyph. */
14886 ptrdiff_t strpos
= glyph
->charpos
;
14891 string_from_text_prop
= true;
14894 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14895 && EQ (glyph
->object
, str
);
14899 ptrdiff_t gpos
= glyph
->charpos
;
14901 cprop
= Fget_char_property (make_number (gpos
),
14909 if (tem
&& glyph
->charpos
< strpos
)
14911 strpos
= glyph
->charpos
;
14917 || (tem
- pt_old
> 0 && tem
< pos_after
))
14921 pos
= tem
+ 1; /* don't find previous instances */
14923 /* This string is not what we want; skip all of the
14924 glyphs that came from it. */
14925 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14926 && EQ (glyph
->object
, str
))
14933 /* If we reached the end of the line, and END was from a string,
14934 the cursor is not on this line. */
14936 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14937 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14938 && STRINGP (end
->object
)
14939 && row
->continued_p
)
14942 /* A truncated row may not include PT among its character positions.
14943 Setting the cursor inside the scroll margin will trigger
14944 recalculation of hscroll in hscroll_window_tree. But if a
14945 display string covers point, defer to the string-handling
14946 code below to figure this out. */
14947 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14949 cursor
= glyph_before
;
14952 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14953 /* Zero-width characters produce no glyphs. */
14955 && (row
->reversed_p
14956 ? glyph_after
> glyphs_end
14957 : glyph_after
< glyphs_end
)))
14959 cursor
= glyph_after
;
14965 if (cursor
!= NULL
)
14967 else if (glyph
== glyphs_end
14968 && pos_before
== pos_after
14969 && STRINGP ((row
->reversed_p
14970 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14971 : row
->glyphs
[TEXT_AREA
])->object
))
14973 /* If all the glyphs of this row came from strings, put the
14974 cursor on the first glyph of the row. This avoids having the
14975 cursor outside of the text area in this very rare and hard
14979 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14980 : row
->glyphs
[TEXT_AREA
];
14986 /* Need to compute x that corresponds to GLYPH. */
14987 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14989 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14991 x
+= g
->pixel_width
;
14995 /* ROW could be part of a continued line, which, under bidi
14996 reordering, might have other rows whose start and end charpos
14997 occlude point. Only set w->cursor if we found a better
14998 approximation to the cursor position than we have from previously
14999 examined candidate rows belonging to the same continued line. */
15000 if (/* We already have a candidate row. */
15001 w
->cursor
.vpos
>= 0
15002 /* That candidate is not the row we are processing. */
15003 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
15004 /* Make sure cursor.vpos specifies a row whose start and end
15005 charpos occlude point, and it is valid candidate for being a
15006 cursor-row. This is because some callers of this function
15007 leave cursor.vpos at the row where the cursor was displayed
15008 during the last redisplay cycle. */
15009 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
15010 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
15011 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
15014 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
15016 /* Don't consider glyphs that are outside TEXT_AREA. */
15017 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
15019 /* Keep the candidate whose buffer position is the closest to
15020 point or has the `cursor' property. */
15021 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
15022 w
->cursor
.hpos
>= 0
15023 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
15024 && ((BUFFERP (g1
->object
)
15025 && (g1
->charpos
== pt_old
/* An exact match always wins. */
15026 || (BUFFERP (glyph
->object
)
15027 && eabs (g1
->charpos
- pt_old
)
15028 < eabs (glyph
->charpos
- pt_old
))))
15029 /* Previous candidate is a glyph from a string that has
15030 a non-nil `cursor' property. */
15031 || (STRINGP (g1
->object
)
15032 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
15033 Qcursor
, g1
->object
))
15034 /* Previous candidate is from the same display
15035 string as this one, and the display string
15036 came from a text property. */
15037 || (EQ (g1
->object
, glyph
->object
)
15038 && string_from_text_prop
)
15039 /* this candidate is from newline and its
15040 position is not an exact match */
15041 || (NILP (glyph
->object
)
15042 && glyph
->charpos
!= pt_old
)))))
15044 /* If this candidate gives an exact match, use that. */
15045 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
15046 /* If this candidate is a glyph created for the
15047 terminating newline of a line, and point is on that
15048 newline, it wins because it's an exact match. */
15049 || (!row
->continued_p
15050 && NILP (glyph
->object
)
15051 && glyph
->charpos
== 0
15052 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
15053 /* Otherwise, keep the candidate that comes from a row
15054 spanning less buffer positions. This may win when one or
15055 both candidate positions are on glyphs that came from
15056 display strings, for which we cannot compare buffer
15058 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
15059 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
15060 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
15063 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
15065 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
15066 w
->cursor
.y
= row
->y
+ dy
;
15068 if (w
== XWINDOW (selected_window
))
15070 if (!row
->continued_p
15071 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15074 this_line_buffer
= XBUFFER (w
->contents
);
15076 CHARPOS (this_line_start_pos
)
15077 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
15078 BYTEPOS (this_line_start_pos
)
15079 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
15081 CHARPOS (this_line_end_pos
)
15082 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
15083 BYTEPOS (this_line_end_pos
)
15084 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
15086 this_line_y
= w
->cursor
.y
;
15087 this_line_pixel_height
= row
->height
;
15088 this_line_vpos
= w
->cursor
.vpos
;
15089 this_line_start_x
= row
->x
;
15092 CHARPOS (this_line_start_pos
) = 0;
15099 /* Run window scroll functions, if any, for WINDOW with new window
15100 start STARTP. Sets the window start of WINDOW to that position.
15102 We assume that the window's buffer is really current. */
15104 static struct text_pos
15105 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
15107 struct window
*w
= XWINDOW (window
);
15108 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
15110 eassert (current_buffer
== XBUFFER (w
->contents
));
15112 if (!NILP (Vwindow_scroll_functions
))
15114 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
15115 make_number (CHARPOS (startp
)));
15116 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15117 /* In case the hook functions switch buffers. */
15118 set_buffer_internal (XBUFFER (w
->contents
));
15125 /* Make sure the line containing the cursor is fully visible.
15126 A value of true means there is nothing to be done.
15127 (Either the line is fully visible, or it cannot be made so,
15128 or we cannot tell.)
15130 If FORCE_P, return false even if partial visible cursor row
15131 is higher than window.
15133 If CURRENT_MATRIX_P, use the information from the
15134 window's current glyph matrix; otherwise use the desired glyph
15137 A value of false means the caller should do scrolling
15138 as if point had gone off the screen. */
15141 cursor_row_fully_visible_p (struct window
*w
, bool force_p
,
15142 bool current_matrix_p
)
15144 struct glyph_matrix
*matrix
;
15145 struct glyph_row
*row
;
15148 if (!make_cursor_line_fully_visible_p
)
15151 /* It's not always possible to find the cursor, e.g, when a window
15152 is full of overlay strings. Don't do anything in that case. */
15153 if (w
->cursor
.vpos
< 0)
15156 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
15157 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
15159 /* If the cursor row is not partially visible, there's nothing to do. */
15160 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
15163 /* If the row the cursor is in is taller than the window's height,
15164 it's not clear what to do, so do nothing. */
15165 window_height
= window_box_height (w
);
15166 if (row
->height
>= window_height
)
15168 if (!force_p
|| MINI_WINDOW_P (w
)
15169 || w
->vscroll
|| w
->cursor
.vpos
== 0)
15176 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
15177 means only WINDOW is redisplayed in redisplay_internal.
15178 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
15179 in redisplay_window to bring a partially visible line into view in
15180 the case that only the cursor has moved.
15182 LAST_LINE_MISFIT should be true if we're scrolling because the
15183 last screen line's vertical height extends past the end of the screen.
15187 1 if scrolling succeeded
15189 0 if scrolling didn't find point.
15191 -1 if new fonts have been loaded so that we must interrupt
15192 redisplay, adjust glyph matrices, and try again. */
15198 SCROLLING_NEED_LARGER_MATRICES
15201 /* If scroll-conservatively is more than this, never recenter.
15203 If you change this, don't forget to update the doc string of
15204 `scroll-conservatively' and the Emacs manual. */
15205 #define SCROLL_LIMIT 100
15208 try_scrolling (Lisp_Object window
, bool just_this_one_p
,
15209 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
15210 bool temp_scroll_step
, bool last_line_misfit
)
15212 struct window
*w
= XWINDOW (window
);
15213 struct frame
*f
= XFRAME (w
->frame
);
15214 struct text_pos pos
, startp
;
15216 int this_scroll_margin
, scroll_max
, rc
, height
;
15217 int dy
= 0, amount_to_scroll
= 0;
15218 bool scroll_down_p
= false;
15219 int extra_scroll_margin_lines
= last_line_misfit
;
15220 Lisp_Object aggressive
;
15221 /* We will never try scrolling more than this number of lines. */
15222 int scroll_limit
= SCROLL_LIMIT
;
15223 int frame_line_height
= default_line_pixel_height (w
);
15224 int window_total_lines
15225 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15228 debug_method_add (w
, "try_scrolling");
15231 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15233 /* Compute scroll margin height in pixels. We scroll when point is
15234 within this distance from the top or bottom of the window. */
15235 if (scroll_margin
> 0)
15236 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15237 * frame_line_height
;
15239 this_scroll_margin
= 0;
15241 /* Force arg_scroll_conservatively to have a reasonable value, to
15242 avoid scrolling too far away with slow move_it_* functions. Note
15243 that the user can supply scroll-conservatively equal to
15244 `most-positive-fixnum', which can be larger than INT_MAX. */
15245 if (arg_scroll_conservatively
> scroll_limit
)
15247 arg_scroll_conservatively
= scroll_limit
+ 1;
15248 scroll_max
= scroll_limit
* frame_line_height
;
15250 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15251 /* Compute how much we should try to scroll maximally to bring
15252 point into view. */
15253 scroll_max
= (max (scroll_step
,
15254 max (arg_scroll_conservatively
, temp_scroll_step
))
15255 * frame_line_height
);
15256 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15257 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15258 /* We're trying to scroll because of aggressive scrolling but no
15259 scroll_step is set. Choose an arbitrary one. */
15260 scroll_max
= 10 * frame_line_height
;
15266 /* Decide whether to scroll down. */
15267 if (PT
> CHARPOS (startp
))
15269 int scroll_margin_y
;
15271 /* Compute the pixel ypos of the scroll margin, then move IT to
15272 either that ypos or PT, whichever comes first. */
15273 start_display (&it
, w
, startp
);
15274 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15275 - frame_line_height
* extra_scroll_margin_lines
;
15276 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15277 (MOVE_TO_POS
| MOVE_TO_Y
));
15279 if (PT
> CHARPOS (it
.current
.pos
))
15281 int y0
= line_bottom_y (&it
);
15282 /* Compute how many pixels below window bottom to stop searching
15283 for PT. This avoids costly search for PT that is far away if
15284 the user limited scrolling by a small number of lines, but
15285 always finds PT if scroll_conservatively is set to a large
15286 number, such as most-positive-fixnum. */
15287 int slack
= max (scroll_max
, 10 * frame_line_height
);
15288 int y_to_move
= it
.last_visible_y
+ slack
;
15290 /* Compute the distance from the scroll margin to PT or to
15291 the scroll limit, whichever comes first. This should
15292 include the height of the cursor line, to make that line
15294 move_it_to (&it
, PT
, -1, y_to_move
,
15295 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15296 dy
= line_bottom_y (&it
) - y0
;
15298 if (dy
> scroll_max
)
15299 return SCROLLING_FAILED
;
15302 scroll_down_p
= true;
15308 /* Point is in or below the bottom scroll margin, so move the
15309 window start down. If scrolling conservatively, move it just
15310 enough down to make point visible. If scroll_step is set,
15311 move it down by scroll_step. */
15312 if (arg_scroll_conservatively
)
15314 = min (max (dy
, frame_line_height
),
15315 frame_line_height
* arg_scroll_conservatively
);
15316 else if (scroll_step
|| temp_scroll_step
)
15317 amount_to_scroll
= scroll_max
;
15320 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15321 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15322 if (NUMBERP (aggressive
))
15324 double float_amount
= XFLOATINT (aggressive
) * height
;
15325 int aggressive_scroll
= float_amount
;
15326 if (aggressive_scroll
== 0 && float_amount
> 0)
15327 aggressive_scroll
= 1;
15328 /* Don't let point enter the scroll margin near top of
15329 the window. This could happen if the value of
15330 scroll_up_aggressively is too large and there are
15331 non-zero margins, because scroll_up_aggressively
15332 means put point that fraction of window height
15333 _from_the_bottom_margin_. */
15334 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15335 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15336 amount_to_scroll
= dy
+ aggressive_scroll
;
15340 if (amount_to_scroll
<= 0)
15341 return SCROLLING_FAILED
;
15343 start_display (&it
, w
, startp
);
15344 if (arg_scroll_conservatively
<= scroll_limit
)
15345 move_it_vertically (&it
, amount_to_scroll
);
15348 /* Extra precision for users who set scroll-conservatively
15349 to a large number: make sure the amount we scroll
15350 the window start is never less than amount_to_scroll,
15351 which was computed as distance from window bottom to
15352 point. This matters when lines at window top and lines
15353 below window bottom have different height. */
15355 void *it1data
= NULL
;
15356 /* We use a temporary it1 because line_bottom_y can modify
15357 its argument, if it moves one line down; see there. */
15360 SAVE_IT (it1
, it
, it1data
);
15361 start_y
= line_bottom_y (&it1
);
15363 RESTORE_IT (&it
, &it
, it1data
);
15364 move_it_by_lines (&it
, 1);
15365 SAVE_IT (it1
, it
, it1data
);
15366 } while (IT_CHARPOS (it
) < ZV
15367 && line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15368 bidi_unshelve_cache (it1data
, true);
15371 /* If STARTP is unchanged, move it down another screen line. */
15372 if (IT_CHARPOS (it
) == CHARPOS (startp
))
15373 move_it_by_lines (&it
, 1);
15374 startp
= it
.current
.pos
;
15378 struct text_pos scroll_margin_pos
= startp
;
15381 /* See if point is inside the scroll margin at the top of the
15383 if (this_scroll_margin
)
15387 start_display (&it
, w
, startp
);
15388 y_start
= it
.current_y
;
15389 move_it_vertically (&it
, this_scroll_margin
);
15390 scroll_margin_pos
= it
.current
.pos
;
15391 /* If we didn't move enough before hitting ZV, request
15392 additional amount of scroll, to move point out of the
15394 if (IT_CHARPOS (it
) == ZV
15395 && it
.current_y
- y_start
< this_scroll_margin
)
15396 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15399 if (PT
< CHARPOS (scroll_margin_pos
))
15401 /* Point is in the scroll margin at the top of the window or
15402 above what is displayed in the window. */
15405 /* Compute the vertical distance from PT to the scroll
15406 margin position. Move as far as scroll_max allows, or
15407 one screenful, or 10 screen lines, whichever is largest.
15408 Give up if distance is greater than scroll_max or if we
15409 didn't reach the scroll margin position. */
15410 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15411 start_display (&it
, w
, pos
);
15413 y_to_move
= max (it
.last_visible_y
,
15414 max (scroll_max
, 10 * frame_line_height
));
15415 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15417 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15418 dy
= it
.current_y
- y0
;
15419 if (dy
> scroll_max
15420 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15421 return SCROLLING_FAILED
;
15423 /* Additional scroll for when ZV was too close to point. */
15426 /* Compute new window start. */
15427 start_display (&it
, w
, startp
);
15429 if (arg_scroll_conservatively
)
15430 amount_to_scroll
= max (dy
, frame_line_height
15431 * max (scroll_step
, temp_scroll_step
));
15432 else if (scroll_step
|| temp_scroll_step
)
15433 amount_to_scroll
= scroll_max
;
15436 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15437 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15438 if (NUMBERP (aggressive
))
15440 double float_amount
= XFLOATINT (aggressive
) * height
;
15441 int aggressive_scroll
= float_amount
;
15442 if (aggressive_scroll
== 0 && float_amount
> 0)
15443 aggressive_scroll
= 1;
15444 /* Don't let point enter the scroll margin near
15445 bottom of the window, if the value of
15446 scroll_down_aggressively happens to be too
15448 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15449 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15450 amount_to_scroll
= dy
+ aggressive_scroll
;
15454 if (amount_to_scroll
<= 0)
15455 return SCROLLING_FAILED
;
15457 move_it_vertically_backward (&it
, amount_to_scroll
);
15458 startp
= it
.current
.pos
;
15462 /* Run window scroll functions. */
15463 startp
= run_window_scroll_functions (window
, startp
);
15465 /* Display the window. Give up if new fonts are loaded, or if point
15467 if (!try_window (window
, startp
, 0))
15468 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15469 else if (w
->cursor
.vpos
< 0)
15471 clear_glyph_matrix (w
->desired_matrix
);
15472 rc
= SCROLLING_FAILED
;
15476 /* Maybe forget recorded base line for line number display. */
15477 if (!just_this_one_p
15478 || current_buffer
->clip_changed
15479 || BEG_UNCHANGED
< CHARPOS (startp
))
15480 w
->base_line_number
= 0;
15482 /* If cursor ends up on a partially visible line,
15483 treat that as being off the bottom of the screen. */
15484 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1,
15486 /* It's possible that the cursor is on the first line of the
15487 buffer, which is partially obscured due to a vscroll
15488 (Bug#7537). In that case, avoid looping forever. */
15489 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15491 clear_glyph_matrix (w
->desired_matrix
);
15492 ++extra_scroll_margin_lines
;
15495 rc
= SCROLLING_SUCCESS
;
15502 /* Compute a suitable window start for window W if display of W starts
15503 on a continuation line. Value is true if a new window start
15506 The new window start will be computed, based on W's width, starting
15507 from the start of the continued line. It is the start of the
15508 screen line with the minimum distance from the old start W->start. */
15511 compute_window_start_on_continuation_line (struct window
*w
)
15513 struct text_pos pos
, start_pos
;
15514 bool window_start_changed_p
= false;
15516 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15518 /* If window start is on a continuation line... Window start may be
15519 < BEGV in case there's invisible text at the start of the
15520 buffer (M-x rmail, for example). */
15521 if (CHARPOS (start_pos
) > BEGV
15522 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15525 struct glyph_row
*row
;
15527 /* Handle the case that the window start is out of range. */
15528 if (CHARPOS (start_pos
) < BEGV
)
15529 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15530 else if (CHARPOS (start_pos
) > ZV
)
15531 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15533 /* Find the start of the continued line. This should be fast
15534 because find_newline is fast (newline cache). */
15535 row
= w
->desired_matrix
->rows
+ WINDOW_WANTS_HEADER_LINE_P (w
);
15536 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15537 row
, DEFAULT_FACE_ID
);
15538 reseat_at_previous_visible_line_start (&it
);
15540 /* If the line start is "too far" away from the window start,
15541 say it takes too much time to compute a new window start. */
15542 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15543 /* PXW: Do we need upper bounds here? */
15544 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15546 int min_distance
, distance
;
15548 /* Move forward by display lines to find the new window
15549 start. If window width was enlarged, the new start can
15550 be expected to be > the old start. If window width was
15551 decreased, the new window start will be < the old start.
15552 So, we're looking for the display line start with the
15553 minimum distance from the old window start. */
15554 pos
= it
.current
.pos
;
15555 min_distance
= INFINITY
;
15556 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15557 distance
< min_distance
)
15559 min_distance
= distance
;
15560 pos
= it
.current
.pos
;
15561 if (it
.line_wrap
== WORD_WRAP
)
15563 /* Under WORD_WRAP, move_it_by_lines is likely to
15564 overshoot and stop not at the first, but the
15565 second character from the left margin. So in
15566 that case, we need a more tight control on the X
15567 coordinate of the iterator than move_it_by_lines
15568 promises in its contract. The method is to first
15569 go to the last (rightmost) visible character of a
15570 line, then move to the leftmost character on the
15571 next line in a separate call. */
15572 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15573 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15574 move_it_to (&it
, ZV
, 0,
15575 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15576 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15579 move_it_by_lines (&it
, 1);
15582 /* Set the window start there. */
15583 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15584 window_start_changed_p
= true;
15588 return window_start_changed_p
;
15592 /* Try cursor movement in case text has not changed in window WINDOW,
15593 with window start STARTP. Value is
15595 CURSOR_MOVEMENT_SUCCESS if successful
15597 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15599 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15600 display. *SCROLL_STEP is set to true, under certain circumstances, if
15601 we want to scroll as if scroll-step were set to 1. See the code.
15603 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15604 which case we have to abort this redisplay, and adjust matrices
15609 CURSOR_MOVEMENT_SUCCESS
,
15610 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15611 CURSOR_MOVEMENT_MUST_SCROLL
,
15612 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15616 try_cursor_movement (Lisp_Object window
, struct text_pos startp
,
15619 struct window
*w
= XWINDOW (window
);
15620 struct frame
*f
= XFRAME (w
->frame
);
15621 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15624 if (inhibit_try_cursor_movement
)
15628 /* Previously, there was a check for Lisp integer in the
15629 if-statement below. Now, this field is converted to
15630 ptrdiff_t, thus zero means invalid position in a buffer. */
15631 eassert (w
->last_point
> 0);
15632 /* Likewise there was a check whether window_end_vpos is nil or larger
15633 than the window. Now window_end_vpos is int and so never nil, but
15634 let's leave eassert to check whether it fits in the window. */
15635 eassert (!w
->window_end_valid
15636 || w
->window_end_vpos
< w
->current_matrix
->nrows
);
15638 /* Handle case where text has not changed, only point, and it has
15639 not moved off the frame. */
15640 if (/* Point may be in this window. */
15641 PT
>= CHARPOS (startp
)
15642 /* Selective display hasn't changed. */
15643 && !current_buffer
->clip_changed
15644 /* Function force-mode-line-update is used to force a thorough
15645 redisplay. It sets either windows_or_buffers_changed or
15646 update_mode_lines. So don't take a shortcut here for these
15648 && !update_mode_lines
15649 && !windows_or_buffers_changed
15650 && !f
->cursor_type_changed
15651 && NILP (Vshow_trailing_whitespace
)
15652 /* This code is not used for mini-buffer for the sake of the case
15653 of redisplaying to replace an echo area message; since in
15654 that case the mini-buffer contents per se are usually
15655 unchanged. This code is of no real use in the mini-buffer
15656 since the handling of this_line_start_pos, etc., in redisplay
15657 handles the same cases. */
15658 && !EQ (window
, minibuf_window
)
15659 && (FRAME_WINDOW_P (f
)
15660 || !overlay_arrow_in_current_buffer_p ()))
15662 int this_scroll_margin
, top_scroll_margin
;
15663 struct glyph_row
*row
= NULL
;
15664 int frame_line_height
= default_line_pixel_height (w
);
15665 int window_total_lines
15666 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15669 debug_method_add (w
, "cursor movement");
15672 /* Scroll if point within this distance from the top or bottom
15673 of the window. This is a pixel value. */
15674 if (scroll_margin
> 0)
15676 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15677 this_scroll_margin
*= frame_line_height
;
15680 this_scroll_margin
= 0;
15682 top_scroll_margin
= this_scroll_margin
;
15683 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15684 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15686 /* Start with the row the cursor was displayed during the last
15687 not paused redisplay. Give up if that row is not valid. */
15688 if (w
->last_cursor_vpos
< 0
15689 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15690 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15693 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15694 if (row
->mode_line_p
)
15696 if (!row
->enabled_p
)
15697 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15700 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15702 bool scroll_p
= false, must_scroll
= false;
15703 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15705 if (PT
> w
->last_point
)
15707 /* Point has moved forward. */
15708 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15709 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15711 eassert (row
->enabled_p
);
15715 /* If the end position of a row equals the start
15716 position of the next row, and PT is at that position,
15717 we would rather display cursor in the next line. */
15718 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15719 && MATRIX_ROW_END_CHARPOS (row
) == PT
15720 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15721 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15722 && !cursor_row_p (row
))
15725 /* If within the scroll margin, scroll. Note that
15726 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15727 the next line would be drawn, and that
15728 this_scroll_margin can be zero. */
15729 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15730 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15731 /* Line is completely visible last line in window
15732 and PT is to be set in the next line. */
15733 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15734 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15735 && !row
->ends_at_zv_p
15736 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15739 else if (PT
< w
->last_point
)
15741 /* Cursor has to be moved backward. Note that PT >=
15742 CHARPOS (startp) because of the outer if-statement. */
15743 while (!row
->mode_line_p
15744 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15745 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15746 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15747 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15748 row
> w
->current_matrix
->rows
15749 && (row
-1)->ends_in_newline_from_string_p
))))
15750 && (row
->y
> top_scroll_margin
15751 || CHARPOS (startp
) == BEGV
))
15753 eassert (row
->enabled_p
);
15757 /* Consider the following case: Window starts at BEGV,
15758 there is invisible, intangible text at BEGV, so that
15759 display starts at some point START > BEGV. It can
15760 happen that we are called with PT somewhere between
15761 BEGV and START. Try to handle that case. */
15762 if (row
< w
->current_matrix
->rows
15763 || row
->mode_line_p
)
15765 row
= w
->current_matrix
->rows
;
15766 if (row
->mode_line_p
)
15770 /* Due to newlines in overlay strings, we may have to
15771 skip forward over overlay strings. */
15772 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15773 && MATRIX_ROW_END_CHARPOS (row
) == PT
15774 && !cursor_row_p (row
))
15777 /* If within the scroll margin, scroll. */
15778 if (row
->y
< top_scroll_margin
15779 && CHARPOS (startp
) != BEGV
)
15784 /* Cursor did not move. So don't scroll even if cursor line
15785 is partially visible, as it was so before. */
15786 rc
= CURSOR_MOVEMENT_SUCCESS
;
15789 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15790 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15792 /* if PT is not in the glyph row, give up. */
15793 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15794 must_scroll
= true;
15796 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15797 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15799 struct glyph_row
*row1
;
15801 /* If rows are bidi-reordered and point moved, back up
15802 until we find a row that does not belong to a
15803 continuation line. This is because we must consider
15804 all rows of a continued line as candidates for the
15805 new cursor positioning, since row start and end
15806 positions change non-linearly with vertical position
15808 /* FIXME: Revisit this when glyph ``spilling'' in
15809 continuation lines' rows is implemented for
15810 bidi-reordered rows. */
15811 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15812 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15815 /* If we hit the beginning of the displayed portion
15816 without finding the first row of a continued
15820 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15823 eassert (row
->enabled_p
);
15828 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15829 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15830 /* Make sure this isn't a header line by any chance, since
15831 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield true. */
15832 && !row
->mode_line_p
15833 && make_cursor_line_fully_visible_p
)
15835 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15836 && !row
->ends_at_zv_p
15837 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15838 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15839 else if (row
->height
> window_box_height (w
))
15841 /* If we end up in a partially visible line, let's
15842 make it fully visible, except when it's taller
15843 than the window, in which case we can't do much
15845 *scroll_step
= true;
15846 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15850 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15851 if (!cursor_row_fully_visible_p (w
, false, true))
15852 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15854 rc
= CURSOR_MOVEMENT_SUCCESS
;
15858 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15859 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15860 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15862 /* With bidi-reordered rows, there could be more than
15863 one candidate row whose start and end positions
15864 occlude point. We need to let set_cursor_from_row
15865 find the best candidate. */
15866 /* FIXME: Revisit this when glyph ``spilling'' in
15867 continuation lines' rows is implemented for
15868 bidi-reordered rows. */
15873 bool at_zv_p
= false, exact_match_p
= false;
15875 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15876 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15877 && cursor_row_p (row
))
15878 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15880 /* As soon as we've found the exact match for point,
15881 or the first suitable row whose ends_at_zv_p flag
15882 is set, we are done. */
15885 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15886 w
->cursor
.vpos
)->ends_at_zv_p
;
15888 && w
->cursor
.hpos
>= 0
15889 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15892 struct glyph_row
*candidate
=
15893 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15895 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15896 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15899 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15900 || (NILP (g
->object
)
15901 && (g
->charpos
== PT
15902 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15904 if (at_zv_p
|| exact_match_p
)
15906 rc
= CURSOR_MOVEMENT_SUCCESS
;
15910 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15914 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15915 || row
->continued_p
)
15916 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15917 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15918 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15919 /* If we didn't find any candidate rows, or exited the
15920 loop before all the candidates were examined, signal
15921 to the caller that this method failed. */
15922 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15924 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15925 && !row
->continued_p
))
15926 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15928 rc
= CURSOR_MOVEMENT_SUCCESS
;
15934 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15936 rc
= CURSOR_MOVEMENT_SUCCESS
;
15941 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15942 && MATRIX_ROW_START_CHARPOS (row
) == PT
15943 && cursor_row_p (row
));
15953 set_vertical_scroll_bar (struct window
*w
)
15955 ptrdiff_t start
, end
, whole
;
15957 /* Calculate the start and end positions for the current window.
15958 At some point, it would be nice to choose between scrollbars
15959 which reflect the whole buffer size, with special markers
15960 indicating narrowing, and scrollbars which reflect only the
15963 Note that mini-buffers sometimes aren't displaying any text. */
15964 if (!MINI_WINDOW_P (w
)
15965 || (w
== XWINDOW (minibuf_window
)
15966 && NILP (echo_area_buffer
[0])))
15968 struct buffer
*buf
= XBUFFER (w
->contents
);
15969 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15970 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15971 /* I don't think this is guaranteed to be right. For the
15972 moment, we'll pretend it is. */
15973 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15977 if (whole
< (end
- start
))
15978 whole
= end
- start
;
15981 start
= end
= whole
= 0;
15983 /* Indicate what this scroll bar ought to be displaying now. */
15984 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15985 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15986 (w
, end
- start
, whole
, start
);
15991 set_horizontal_scroll_bar (struct window
*w
)
15993 int start
, end
, whole
, portion
;
15995 if (!MINI_WINDOW_P (w
)
15996 || (w
== XWINDOW (minibuf_window
)
15997 && NILP (echo_area_buffer
[0])))
15999 struct buffer
*b
= XBUFFER (w
->contents
);
16000 struct buffer
*old_buffer
= NULL
;
16002 struct text_pos startp
;
16004 if (b
!= current_buffer
)
16006 old_buffer
= current_buffer
;
16007 set_buffer_internal (b
);
16010 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16011 start_display (&it
, w
, startp
);
16012 it
.last_visible_x
= INT_MAX
;
16013 whole
= move_it_to (&it
, -1, INT_MAX
, window_box_height (w
), -1,
16014 MOVE_TO_X
| MOVE_TO_Y
);
16015 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
16016 window_box_height (w), -1,
16017 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
16019 start
= w
->hscroll
* FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
));
16020 end
= start
+ window_box_width (w
, TEXT_AREA
);
16021 portion
= end
- start
;
16022 /* After enlarging a horizontally scrolled window such that it
16023 gets at least as wide as the text it contains, make sure that
16024 the thumb doesn't fill the entire scroll bar so we can still
16025 drag it back to see the entire text. */
16026 whole
= max (whole
, end
);
16032 pdir
= Fcurrent_bidi_paragraph_direction (Qnil
);
16033 if (EQ (pdir
, Qright_to_left
))
16035 start
= whole
- end
;
16036 end
= start
+ portion
;
16041 set_buffer_internal (old_buffer
);
16044 start
= end
= whole
= portion
= 0;
16046 w
->hscroll_whole
= whole
;
16048 /* Indicate what this scroll bar ought to be displaying now. */
16049 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
16050 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
16051 (w
, portion
, whole
, start
);
16055 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P means only
16056 selected_window is redisplayed.
16058 We can return without actually redisplaying the window if fonts has been
16059 changed on window's frame. In that case, redisplay_internal will retry.
16061 As one of the important parts of redisplaying a window, we need to
16062 decide whether the previous window-start position (stored in the
16063 window's w->start marker position) is still valid, and if it isn't,
16064 recompute it. Some details about that:
16066 . The previous window-start could be in a continuation line, in
16067 which case we need to recompute it when the window width
16068 changes. See compute_window_start_on_continuation_line and its
16071 . The text that changed since last redisplay could include the
16072 previous window-start position. In that case, we try to salvage
16073 what we can from the current glyph matrix by calling
16074 try_scrolling, which see.
16076 . Some Emacs command could force us to use a specific window-start
16077 position by setting the window's force_start flag, or gently
16078 propose doing that by setting the window's optional_new_start
16079 flag. In these cases, we try using the specified start point if
16080 that succeeds (i.e. the window desired matrix is successfully
16081 recomputed, and point location is within the window). In case
16082 of optional_new_start, we first check if the specified start
16083 position is feasible, i.e. if it will allow point to be
16084 displayed in the window. If using the specified start point
16085 fails, e.g., if new fonts are needed to be loaded, we abort the
16086 redisplay cycle and leave it up to the next cycle to figure out
16089 . Note that the window's force_start flag is sometimes set by
16090 redisplay itself, when it decides that the previous window start
16091 point is fine and should be kept. Search for "goto force_start"
16092 below to see the details. Like the values of window-start
16093 specified outside of redisplay, these internally-deduced values
16094 are tested for feasibility, and ignored if found to be
16097 . Note that the function try_window, used to completely redisplay
16098 a window, accepts the window's start point as its argument.
16099 This is used several times in the redisplay code to control
16100 where the window start will be, according to user options such
16101 as scroll-conservatively, and also to ensure the screen line
16102 showing point will be fully (as opposed to partially) visible on
16106 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
16108 struct window
*w
= XWINDOW (window
);
16109 struct frame
*f
= XFRAME (w
->frame
);
16110 struct buffer
*buffer
= XBUFFER (w
->contents
);
16111 struct buffer
*old
= current_buffer
;
16112 struct text_pos lpoint
, opoint
, startp
;
16113 bool update_mode_line
;
16116 /* Record it now because it's overwritten. */
16117 bool current_matrix_up_to_date_p
= false;
16118 bool used_current_matrix_p
= false;
16119 /* This is less strict than current_matrix_up_to_date_p.
16120 It indicates that the buffer contents and narrowing are unchanged. */
16121 bool buffer_unchanged_p
= false;
16122 bool temp_scroll_step
= false;
16123 ptrdiff_t count
= SPECPDL_INDEX ();
16125 int centering_position
= -1;
16126 bool last_line_misfit
= false;
16127 ptrdiff_t beg_unchanged
, end_unchanged
;
16128 int frame_line_height
;
16129 bool use_desired_matrix
;
16131 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16135 *w
->desired_matrix
->method
= 0;
16138 if (!just_this_one_p
16139 && REDISPLAY_SOME_P ()
16141 && !w
->update_mode_line
16144 && !buffer
->text
->redisplay
16145 && BUF_PT (buffer
) == w
->last_point
)
16148 /* Make sure that both W's markers are valid. */
16149 eassert (XMARKER (w
->start
)->buffer
== buffer
);
16150 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
16152 /* We come here again if we need to run window-text-change-functions
16155 reconsider_clip_changes (w
);
16156 frame_line_height
= default_line_pixel_height (w
);
16158 /* Has the mode line to be updated? */
16159 update_mode_line
= (w
->update_mode_line
16160 || update_mode_lines
16161 || buffer
->clip_changed
16162 || buffer
->prevent_redisplay_optimizations_p
);
16164 if (!just_this_one_p
)
16165 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
16166 cleverly elsewhere. */
16167 w
->must_be_updated_p
= true;
16169 if (MINI_WINDOW_P (w
))
16171 if (w
== XWINDOW (echo_area_window
)
16172 && !NILP (echo_area_buffer
[0]))
16174 if (update_mode_line
)
16175 /* We may have to update a tty frame's menu bar or a
16176 tool-bar. Example `M-x C-h C-h C-g'. */
16177 goto finish_menu_bars
;
16179 /* We've already displayed the echo area glyphs in this window. */
16180 goto finish_scroll_bars
;
16182 else if ((w
!= XWINDOW (minibuf_window
)
16183 || minibuf_level
== 0)
16184 /* When buffer is nonempty, redisplay window normally. */
16185 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
16186 /* Quail displays non-mini buffers in minibuffer window.
16187 In that case, redisplay the window normally. */
16188 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
16190 /* W is a mini-buffer window, but it's not active, so clear
16192 int yb
= window_text_bottom_y (w
);
16193 struct glyph_row
*row
;
16196 for (y
= 0, row
= w
->desired_matrix
->rows
;
16198 y
+= row
->height
, ++row
)
16199 blank_row (w
, row
, y
);
16200 goto finish_scroll_bars
;
16203 clear_glyph_matrix (w
->desired_matrix
);
16206 /* Otherwise set up data on this window; select its buffer and point
16208 /* Really select the buffer, for the sake of buffer-local
16210 set_buffer_internal_1 (XBUFFER (w
->contents
));
16212 current_matrix_up_to_date_p
16213 = (w
->window_end_valid
16214 && !current_buffer
->clip_changed
16215 && !current_buffer
->prevent_redisplay_optimizations_p
16216 && !window_outdated (w
));
16218 /* Run the window-text-change-functions
16219 if it is possible that the text on the screen has changed
16220 (either due to modification of the text, or any other reason). */
16221 if (!current_matrix_up_to_date_p
16222 && !NILP (Vwindow_text_change_functions
))
16224 safe_run_hooks (Qwindow_text_change_functions
);
16228 beg_unchanged
= BEG_UNCHANGED
;
16229 end_unchanged
= END_UNCHANGED
;
16231 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
16233 specbind (Qinhibit_point_motion_hooks
, Qt
);
16236 = (w
->window_end_valid
16237 && !current_buffer
->clip_changed
16238 && !window_outdated (w
));
16240 /* When windows_or_buffers_changed is non-zero, we can't rely
16241 on the window end being valid, so set it to zero there. */
16242 if (windows_or_buffers_changed
)
16244 /* If window starts on a continuation line, maybe adjust the
16245 window start in case the window's width changed. */
16246 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16247 compute_window_start_on_continuation_line (w
);
16249 w
->window_end_valid
= false;
16250 /* If so, we also can't rely on current matrix
16251 and should not fool try_cursor_movement below. */
16252 current_matrix_up_to_date_p
= false;
16255 /* Some sanity checks. */
16256 CHECK_WINDOW_END (w
);
16257 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16259 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16262 if (mode_line_update_needed (w
))
16263 update_mode_line
= true;
16265 /* Point refers normally to the selected window. For any other
16266 window, set up appropriate value. */
16267 if (!EQ (window
, selected_window
))
16269 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16270 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16275 new_pt_byte
= BEGV_BYTE
;
16276 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16278 else if (new_pt
> (ZV
- 1))
16281 new_pt_byte
= ZV_BYTE
;
16282 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16285 /* We don't use SET_PT so that the point-motion hooks don't run. */
16286 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16289 /* If any of the character widths specified in the display table
16290 have changed, invalidate the width run cache. It's true that
16291 this may be a bit late to catch such changes, but the rest of
16292 redisplay goes (non-fatally) haywire when the display table is
16293 changed, so why should we worry about doing any better? */
16294 if (current_buffer
->width_run_cache
16295 || (current_buffer
->base_buffer
16296 && current_buffer
->base_buffer
->width_run_cache
))
16298 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16300 if (! disptab_matches_widthtab
16301 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16303 struct buffer
*buf
= current_buffer
;
16305 if (buf
->base_buffer
)
16306 buf
= buf
->base_buffer
;
16307 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16308 recompute_width_table (current_buffer
, disptab
);
16312 /* If window-start is screwed up, choose a new one. */
16313 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16316 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16318 /* If someone specified a new starting point but did not insist,
16319 check whether it can be used. */
16320 if ((w
->optional_new_start
|| window_frozen_p (w
))
16321 && CHARPOS (startp
) >= BEGV
16322 && CHARPOS (startp
) <= ZV
)
16324 ptrdiff_t it_charpos
;
16326 w
->optional_new_start
= false;
16327 start_display (&it
, w
, startp
);
16328 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16329 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16330 /* Record IT's position now, since line_bottom_y might change
16332 it_charpos
= IT_CHARPOS (it
);
16333 /* Make sure we set the force_start flag only if the cursor row
16334 will be fully visible. Otherwise, the code under force_start
16335 label below will try to move point back into view, which is
16336 not what the code which sets optional_new_start wants. */
16337 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
16338 && !w
->force_start
)
16340 if (it_charpos
== PT
)
16341 w
->force_start
= true;
16342 /* IT may overshoot PT if text at PT is invisible. */
16343 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16344 w
->force_start
= true;
16346 if (w
->force_start
)
16348 if (window_frozen_p (w
))
16349 debug_method_add (w
, "set force_start from frozen window start");
16351 debug_method_add (w
, "set force_start from optional_new_start");
16359 /* Handle case where place to start displaying has been specified,
16360 unless the specified location is outside the accessible range. */
16361 if (w
->force_start
)
16363 /* We set this later on if we have to adjust point. */
16366 w
->force_start
= false;
16368 w
->window_end_valid
= false;
16370 /* Forget any recorded base line for line number display. */
16371 if (!buffer_unchanged_p
)
16372 w
->base_line_number
= 0;
16374 /* Redisplay the mode line. Select the buffer properly for that.
16375 Also, run the hook window-scroll-functions
16376 because we have scrolled. */
16377 /* Note, we do this after clearing force_start because
16378 if there's an error, it is better to forget about force_start
16379 than to get into an infinite loop calling the hook functions
16380 and having them get more errors. */
16381 if (!update_mode_line
16382 || ! NILP (Vwindow_scroll_functions
))
16384 update_mode_line
= true;
16385 w
->update_mode_line
= true;
16386 startp
= run_window_scroll_functions (window
, startp
);
16389 if (CHARPOS (startp
) < BEGV
)
16390 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16391 else if (CHARPOS (startp
) > ZV
)
16392 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16394 /* Redisplay, then check if cursor has been set during the
16395 redisplay. Give up if new fonts were loaded. */
16396 /* We used to issue a CHECK_MARGINS argument to try_window here,
16397 but this causes scrolling to fail when point begins inside
16398 the scroll margin (bug#148) -- cyd */
16399 if (!try_window (window
, startp
, 0))
16401 w
->force_start
= true;
16402 clear_glyph_matrix (w
->desired_matrix
);
16403 goto need_larger_matrices
;
16406 if (w
->cursor
.vpos
< 0)
16408 /* If point does not appear, try to move point so it does
16409 appear. The desired matrix has been built above, so we
16410 can use it here. First see if point is in invisible
16411 text, and if so, move it to the first visible buffer
16412 position past that. */
16413 struct glyph_row
*r
= NULL
;
16414 Lisp_Object invprop
=
16415 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16418 if (TEXT_PROP_MEANS_INVISIBLE (invprop
) != 0)
16421 Lisp_Object invprop_end
=
16422 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16425 if (NATNUMP (invprop_end
))
16426 alt_pt
= XFASTINT (invprop_end
);
16429 r
= row_containing_pos (w
, alt_pt
, w
->desired_matrix
->rows
,
16433 new_vpos
= MATRIX_ROW_BOTTOM_Y (r
);
16434 else /* Give up and just move to the middle of the window. */
16435 new_vpos
= window_box_height (w
) / 2;
16438 if (!cursor_row_fully_visible_p (w
, false, false))
16440 /* Point does appear, but on a line partly visible at end of window.
16441 Move it back to a fully-visible line. */
16442 new_vpos
= window_box_height (w
);
16443 /* But if window_box_height suggests a Y coordinate that is
16444 not less than we already have, that line will clearly not
16445 be fully visible, so give up and scroll the display.
16446 This can happen when the default face uses a font whose
16447 dimensions are different from the frame's default
16449 if (new_vpos
>= w
->cursor
.y
)
16451 w
->cursor
.vpos
= -1;
16452 clear_glyph_matrix (w
->desired_matrix
);
16453 goto try_to_scroll
;
16456 else if (w
->cursor
.vpos
>= 0)
16458 /* Some people insist on not letting point enter the scroll
16459 margin, even though this part handles windows that didn't
16461 int window_total_lines
16462 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16463 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16464 int pixel_margin
= margin
* frame_line_height
;
16465 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16467 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16468 below, which finds the row to move point to, advances by
16469 the Y coordinate of the _next_ row, see the definition of
16470 MATRIX_ROW_BOTTOM_Y. */
16471 if (w
->cursor
.vpos
< margin
+ header_line
)
16473 w
->cursor
.vpos
= -1;
16474 clear_glyph_matrix (w
->desired_matrix
);
16475 goto try_to_scroll
;
16479 int window_height
= window_box_height (w
);
16482 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16483 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16485 w
->cursor
.vpos
= -1;
16486 clear_glyph_matrix (w
->desired_matrix
);
16487 goto try_to_scroll
;
16492 /* If we need to move point for either of the above reasons,
16493 now actually do it. */
16496 struct glyph_row
*row
;
16498 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16499 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16502 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16503 MATRIX_ROW_START_BYTEPOS (row
));
16505 if (w
!= XWINDOW (selected_window
))
16506 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16507 else if (current_buffer
== old
)
16508 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16510 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16512 /* Re-run pre-redisplay-function so it can update the region
16513 according to the new position of point. */
16514 /* Other than the cursor, w's redisplay is done so we can set its
16515 redisplay to false. Also the buffer's redisplay can be set to
16516 false, since propagate_buffer_redisplay should have already
16517 propagated its info to `w' anyway. */
16518 w
->redisplay
= false;
16519 XBUFFER (w
->contents
)->text
->redisplay
= false;
16520 safe__call1 (true, Vpre_redisplay_function
, Fcons (window
, Qnil
));
16522 if (w
->redisplay
|| XBUFFER (w
->contents
)->text
->redisplay
)
16524 /* pre-redisplay-function made changes (e.g. move the region)
16525 that require another round of redisplay. */
16526 clear_glyph_matrix (w
->desired_matrix
);
16527 if (!try_window (window
, startp
, 0))
16528 goto need_larger_matrices
;
16531 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, false, false))
16533 clear_glyph_matrix (w
->desired_matrix
);
16534 goto try_to_scroll
;
16538 debug_method_add (w
, "forced window start");
16543 /* Handle case where text has not changed, only point, and it has
16544 not moved off the frame, and we are not retrying after hscroll.
16545 (current_matrix_up_to_date_p is true when retrying.) */
16546 if (current_matrix_up_to_date_p
16547 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16548 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16552 case CURSOR_MOVEMENT_SUCCESS
:
16553 used_current_matrix_p
= true;
16556 case CURSOR_MOVEMENT_MUST_SCROLL
:
16557 goto try_to_scroll
;
16563 /* If current starting point was originally the beginning of a line
16564 but no longer is, find a new starting point. */
16565 else if (w
->start_at_line_beg
16566 && !(CHARPOS (startp
) <= BEGV
16567 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16570 debug_method_add (w
, "recenter 1");
16575 /* Try scrolling with try_window_id. Value is > 0 if update has
16576 been done, it is -1 if we know that the same window start will
16577 not work. It is 0 if unsuccessful for some other reason. */
16578 else if ((tem
= try_window_id (w
)) != 0)
16581 debug_method_add (w
, "try_window_id %d", tem
);
16584 if (f
->fonts_changed
)
16585 goto need_larger_matrices
;
16589 /* Otherwise try_window_id has returned -1 which means that we
16590 don't want the alternative below this comment to execute. */
16592 else if (CHARPOS (startp
) >= BEGV
16593 && CHARPOS (startp
) <= ZV
16594 && PT
>= CHARPOS (startp
)
16595 && (CHARPOS (startp
) < ZV
16596 /* Avoid starting at end of buffer. */
16597 || CHARPOS (startp
) == BEGV
16598 || !window_outdated (w
)))
16600 int d1
, d2
, d5
, d6
;
16603 /* If first window line is a continuation line, and window start
16604 is inside the modified region, but the first change is before
16605 current window start, we must select a new window start.
16607 However, if this is the result of a down-mouse event (e.g. by
16608 extending the mouse-drag-overlay), we don't want to select a
16609 new window start, since that would change the position under
16610 the mouse, resulting in an unwanted mouse-movement rather
16611 than a simple mouse-click. */
16612 if (!w
->start_at_line_beg
16613 && NILP (do_mouse_tracking
)
16614 && CHARPOS (startp
) > BEGV
16615 && CHARPOS (startp
) > BEG
+ beg_unchanged
16616 && CHARPOS (startp
) <= Z
- end_unchanged
16617 /* Even if w->start_at_line_beg is nil, a new window may
16618 start at a line_beg, since that's how set_buffer_window
16619 sets it. So, we need to check the return value of
16620 compute_window_start_on_continuation_line. (See also
16622 && XMARKER (w
->start
)->buffer
== current_buffer
16623 && compute_window_start_on_continuation_line (w
)
16624 /* It doesn't make sense to force the window start like we
16625 do at label force_start if it is already known that point
16626 will not be fully visible in the resulting window, because
16627 doing so will move point from its correct position
16628 instead of scrolling the window to bring point into view.
16630 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16631 /* A very tall row could need more than the window height,
16632 in which case we accept that it is partially visible. */
16633 && (rtop
!= 0) == (rbot
!= 0))
16635 w
->force_start
= true;
16636 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16638 debug_method_add (w
, "recomputed window start in continuation line");
16644 debug_method_add (w
, "same window start");
16647 /* Try to redisplay starting at same place as before.
16648 If point has not moved off frame, accept the results. */
16649 if (!current_matrix_up_to_date_p
16650 /* Don't use try_window_reusing_current_matrix in this case
16651 because a window scroll function can have changed the
16653 || !NILP (Vwindow_scroll_functions
)
16654 || MINI_WINDOW_P (w
)
16655 || !(used_current_matrix_p
16656 = try_window_reusing_current_matrix (w
)))
16658 IF_DEBUG (debug_method_add (w
, "1"));
16659 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16660 /* -1 means we need to scroll.
16661 0 means we need new matrices, but fonts_changed
16662 is set in that case, so we will detect it below. */
16663 goto try_to_scroll
;
16666 if (f
->fonts_changed
)
16667 goto need_larger_matrices
;
16669 if (w
->cursor
.vpos
>= 0)
16671 if (!just_this_one_p
16672 || current_buffer
->clip_changed
16673 || BEG_UNCHANGED
< CHARPOS (startp
))
16674 /* Forget any recorded base line for line number display. */
16675 w
->base_line_number
= 0;
16677 if (!cursor_row_fully_visible_p (w
, true, false))
16679 clear_glyph_matrix (w
->desired_matrix
);
16680 last_line_misfit
= true;
16682 /* Drop through and scroll. */
16687 clear_glyph_matrix (w
->desired_matrix
);
16692 /* Redisplay the mode line. Select the buffer properly for that. */
16693 if (!update_mode_line
)
16695 update_mode_line
= true;
16696 w
->update_mode_line
= true;
16699 /* Try to scroll by specified few lines. */
16700 if ((scroll_conservatively
16701 || emacs_scroll_step
16702 || temp_scroll_step
16703 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16704 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16705 && CHARPOS (startp
) >= BEGV
16706 && CHARPOS (startp
) <= ZV
)
16708 /* The function returns -1 if new fonts were loaded, 1 if
16709 successful, 0 if not successful. */
16710 int ss
= try_scrolling (window
, just_this_one_p
,
16711 scroll_conservatively
,
16713 temp_scroll_step
, last_line_misfit
);
16716 case SCROLLING_SUCCESS
:
16719 case SCROLLING_NEED_LARGER_MATRICES
:
16720 goto need_larger_matrices
;
16722 case SCROLLING_FAILED
:
16730 /* Finally, just choose a place to start which positions point
16731 according to user preferences. */
16736 debug_method_add (w
, "recenter");
16739 /* Forget any previously recorded base line for line number display. */
16740 if (!buffer_unchanged_p
)
16741 w
->base_line_number
= 0;
16743 /* Determine the window start relative to point. */
16744 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16745 it
.current_y
= it
.last_visible_y
;
16746 if (centering_position
< 0)
16748 int window_total_lines
16749 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16751 = scroll_margin
> 0
16752 ? min (scroll_margin
, window_total_lines
/ 4)
16754 ptrdiff_t margin_pos
= CHARPOS (startp
);
16755 Lisp_Object aggressive
;
16758 /* If there is a scroll margin at the top of the window, find
16759 its character position. */
16761 /* Cannot call start_display if startp is not in the
16762 accessible region of the buffer. This can happen when we
16763 have just switched to a different buffer and/or changed
16764 its restriction. In that case, startp is initialized to
16765 the character position 1 (BEGV) because we did not yet
16766 have chance to display the buffer even once. */
16767 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16770 void *it1data
= NULL
;
16772 SAVE_IT (it1
, it
, it1data
);
16773 start_display (&it1
, w
, startp
);
16774 move_it_vertically (&it1
, margin
* frame_line_height
);
16775 margin_pos
= IT_CHARPOS (it1
);
16776 RESTORE_IT (&it
, &it
, it1data
);
16778 scrolling_up
= PT
> margin_pos
;
16781 ? BVAR (current_buffer
, scroll_up_aggressively
)
16782 : BVAR (current_buffer
, scroll_down_aggressively
);
16784 if (!MINI_WINDOW_P (w
)
16785 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16789 /* Setting scroll-conservatively overrides
16790 scroll-*-aggressively. */
16791 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16793 double float_amount
= XFLOATINT (aggressive
);
16795 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16796 if (pt_offset
== 0 && float_amount
> 0)
16798 if (pt_offset
&& margin
> 0)
16801 /* Compute how much to move the window start backward from
16802 point so that point will be displayed where the user
16806 centering_position
= it
.last_visible_y
;
16808 centering_position
-= pt_offset
;
16809 centering_position
-=
16810 (frame_line_height
* (1 + margin
+ last_line_misfit
)
16811 + WINDOW_HEADER_LINE_HEIGHT (w
));
16812 /* Don't let point enter the scroll margin near top of
16814 if (centering_position
< margin
* frame_line_height
)
16815 centering_position
= margin
* frame_line_height
;
16818 centering_position
= margin
* frame_line_height
+ pt_offset
;
16821 /* Set the window start half the height of the window backward
16823 centering_position
= window_box_height (w
) / 2;
16825 move_it_vertically_backward (&it
, centering_position
);
16827 eassert (IT_CHARPOS (it
) >= BEGV
);
16829 /* The function move_it_vertically_backward may move over more
16830 than the specified y-distance. If it->w is small, e.g. a
16831 mini-buffer window, we may end up in front of the window's
16832 display area. Start displaying at the start of the line
16833 containing PT in this case. */
16834 if (it
.current_y
<= 0)
16836 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16837 move_it_vertically_backward (&it
, 0);
16841 it
.current_x
= it
.hpos
= 0;
16843 /* Set the window start position here explicitly, to avoid an
16844 infinite loop in case the functions in window-scroll-functions
16846 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16848 /* Run scroll hooks. */
16849 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16851 /* Redisplay the window. */
16852 use_desired_matrix
= false;
16853 if (!current_matrix_up_to_date_p
16854 || windows_or_buffers_changed
16855 || f
->cursor_type_changed
16856 /* Don't use try_window_reusing_current_matrix in this case
16857 because it can have changed the buffer. */
16858 || !NILP (Vwindow_scroll_functions
)
16859 || !just_this_one_p
16860 || MINI_WINDOW_P (w
)
16861 || !(used_current_matrix_p
16862 = try_window_reusing_current_matrix (w
)))
16863 use_desired_matrix
= (try_window (window
, startp
, 0) == 1);
16865 /* If new fonts have been loaded (due to fontsets), give up. We
16866 have to start a new redisplay since we need to re-adjust glyph
16868 if (f
->fonts_changed
)
16869 goto need_larger_matrices
;
16871 /* If cursor did not appear assume that the middle of the window is
16872 in the first line of the window. Do it again with the next line.
16873 (Imagine a window of height 100, displaying two lines of height
16874 60. Moving back 50 from it->last_visible_y will end in the first
16876 if (w
->cursor
.vpos
< 0)
16878 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16880 clear_glyph_matrix (w
->desired_matrix
);
16881 move_it_by_lines (&it
, 1);
16882 try_window (window
, it
.current
.pos
, 0);
16884 else if (PT
< IT_CHARPOS (it
))
16886 clear_glyph_matrix (w
->desired_matrix
);
16887 move_it_by_lines (&it
, -1);
16888 try_window (window
, it
.current
.pos
, 0);
16892 /* Not much we can do about it. */
16896 /* Consider the following case: Window starts at BEGV, there is
16897 invisible, intangible text at BEGV, so that display starts at
16898 some point START > BEGV. It can happen that we are called with
16899 PT somewhere between BEGV and START. Try to handle that case,
16900 and similar ones. */
16901 if (w
->cursor
.vpos
< 0)
16903 /* Prefer the desired matrix to the current matrix, if possible,
16904 in the fallback calculations below. This is because using
16905 the current matrix might completely goof, e.g. if its first
16906 row is after point. */
16907 struct glyph_matrix
*matrix
=
16908 use_desired_matrix
? w
->desired_matrix
: w
->current_matrix
;
16909 /* First, try locating the proper glyph row for PT. */
16910 struct glyph_row
*row
=
16911 row_containing_pos (w
, PT
, matrix
->rows
, NULL
, 0);
16913 /* Sometimes point is at the beginning of invisible text that is
16914 before the 1st character displayed in the row. In that case,
16915 row_containing_pos fails to find the row, because no glyphs
16916 with appropriate buffer positions are present in the row.
16917 Therefore, we next try to find the row which shows the 1st
16918 position after the invisible text. */
16922 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16925 if (TEXT_PROP_MEANS_INVISIBLE (val
) != 0)
16928 Lisp_Object invis_end
=
16929 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16932 if (NATNUMP (invis_end
))
16933 alt_pos
= XFASTINT (invis_end
);
16936 row
= row_containing_pos (w
, alt_pos
, matrix
->rows
, NULL
, 0);
16939 /* Finally, fall back on the first row of the window after the
16940 header line (if any). This is slightly better than not
16941 displaying the cursor at all. */
16944 row
= matrix
->rows
;
16945 if (row
->mode_line_p
)
16948 set_cursor_from_row (w
, row
, matrix
, 0, 0, 0, 0);
16951 if (!cursor_row_fully_visible_p (w
, false, false))
16953 /* If vscroll is enabled, disable it and try again. */
16957 clear_glyph_matrix (w
->desired_matrix
);
16961 /* Users who set scroll-conservatively to a large number want
16962 point just above/below the scroll margin. If we ended up
16963 with point's row partially visible, move the window start to
16964 make that row fully visible and out of the margin. */
16965 if (scroll_conservatively
> SCROLL_LIMIT
)
16967 int window_total_lines
16968 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16971 ? min (scroll_margin
, window_total_lines
/ 4)
16973 bool move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16975 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16976 clear_glyph_matrix (w
->desired_matrix
);
16977 if (1 == try_window (window
, it
.current
.pos
,
16978 TRY_WINDOW_CHECK_MARGINS
))
16982 /* If centering point failed to make the whole line visible,
16983 put point at the top instead. That has to make the whole line
16984 visible, if it can be done. */
16985 if (centering_position
== 0)
16988 clear_glyph_matrix (w
->desired_matrix
);
16989 centering_position
= 0;
16995 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16996 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16997 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16999 /* Display the mode line, if we must. */
17000 if ((update_mode_line
17001 /* If window not full width, must redo its mode line
17002 if (a) the window to its side is being redone and
17003 (b) we do a frame-based redisplay. This is a consequence
17004 of how inverted lines are drawn in frame-based redisplay. */
17005 || (!just_this_one_p
17006 && !FRAME_WINDOW_P (f
)
17007 && !WINDOW_FULL_WIDTH_P (w
))
17008 /* Line number to display. */
17009 || w
->base_line_pos
> 0
17010 /* Column number is displayed and different from the one displayed. */
17011 || (w
->column_number_displayed
!= -1
17012 && (w
->column_number_displayed
!= current_column ())))
17013 /* This means that the window has a mode line. */
17014 && (WINDOW_WANTS_MODELINE_P (w
)
17015 || WINDOW_WANTS_HEADER_LINE_P (w
)))
17018 display_mode_lines (w
);
17020 /* If mode line height has changed, arrange for a thorough
17021 immediate redisplay using the correct mode line height. */
17022 if (WINDOW_WANTS_MODELINE_P (w
)
17023 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
17025 f
->fonts_changed
= true;
17026 w
->mode_line_height
= -1;
17027 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
17028 = DESIRED_MODE_LINE_HEIGHT (w
);
17031 /* If header line height has changed, arrange for a thorough
17032 immediate redisplay using the correct header line height. */
17033 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17034 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
17036 f
->fonts_changed
= true;
17037 w
->header_line_height
= -1;
17038 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
17039 = DESIRED_HEADER_LINE_HEIGHT (w
);
17042 if (f
->fonts_changed
)
17043 goto need_larger_matrices
;
17046 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
17048 w
->base_line_pos
= 0;
17049 w
->base_line_number
= 0;
17054 /* When we reach a frame's selected window, redo the frame's menu
17055 bar and the frame's title. */
17056 if (update_mode_line
17057 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
17059 bool redisplay_menu_p
;
17061 if (FRAME_WINDOW_P (f
))
17063 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
17064 || defined (HAVE_NS) || defined (USE_GTK)
17065 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
17067 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
17071 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
17073 if (redisplay_menu_p
)
17074 display_menu_bar (w
);
17076 #ifdef HAVE_WINDOW_SYSTEM
17077 if (FRAME_WINDOW_P (f
))
17079 #if defined (USE_GTK) || defined (HAVE_NS)
17080 if (FRAME_EXTERNAL_TOOL_BAR (f
))
17081 redisplay_tool_bar (f
);
17083 if (WINDOWP (f
->tool_bar_window
)
17084 && (FRAME_TOOL_BAR_LINES (f
) > 0
17085 || !NILP (Vauto_resize_tool_bars
))
17086 && redisplay_tool_bar (f
))
17087 ignore_mouse_drag_p
= true;
17090 ptrdiff_t count1
= SPECPDL_INDEX ();
17091 /* x_consider_frame_title calls select-frame, which calls
17092 resize_mini_window, which could resize the mini-window and by
17093 that undo the effect of this redisplay cycle wrt minibuffer
17094 and echo-area display. Binding inhibit-redisplay to t makes
17095 the call to resize_mini_window a no-op, thus avoiding the
17096 adverse side effects. */
17097 specbind (Qinhibit_redisplay
, Qt
);
17098 x_consider_frame_title (w
->frame
);
17099 unbind_to (count1
, Qnil
);
17103 #ifdef HAVE_WINDOW_SYSTEM
17104 if (FRAME_WINDOW_P (f
)
17105 && update_window_fringes (w
, (just_this_one_p
17106 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
17107 || w
->pseudo_window_p
)))
17111 if (draw_window_fringes (w
, true))
17113 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
17114 x_draw_right_divider (w
);
17116 x_draw_vertical_border (w
);
17122 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
17123 x_draw_bottom_divider (w
);
17124 #endif /* HAVE_WINDOW_SYSTEM */
17126 /* We go to this label, with fonts_changed set, if it is
17127 necessary to try again using larger glyph matrices.
17128 We have to redeem the scroll bar even in this case,
17129 because the loop in redisplay_internal expects that. */
17130 need_larger_matrices
:
17132 finish_scroll_bars
:
17134 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
17136 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
17137 /* Set the thumb's position and size. */
17138 set_vertical_scroll_bar (w
);
17140 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
17141 /* Set the thumb's position and size. */
17142 set_horizontal_scroll_bar (w
);
17144 /* Note that we actually used the scroll bar attached to this
17145 window, so it shouldn't be deleted at the end of redisplay. */
17146 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
17147 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
17150 /* Restore current_buffer and value of point in it. The window
17151 update may have changed the buffer, so first make sure `opoint'
17152 is still valid (Bug#6177). */
17153 if (CHARPOS (opoint
) < BEGV
)
17154 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
17155 else if (CHARPOS (opoint
) > ZV
)
17156 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
17158 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
17160 set_buffer_internal_1 (old
);
17161 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
17162 shorter. This can be caused by log truncation in *Messages*. */
17163 if (CHARPOS (lpoint
) <= ZV
)
17164 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
17166 unbind_to (count
, Qnil
);
17170 /* Build the complete desired matrix of WINDOW with a window start
17171 buffer position POS.
17173 Value is 1 if successful. It is zero if fonts were loaded during
17174 redisplay which makes re-adjusting glyph matrices necessary, and -1
17175 if point would appear in the scroll margins.
17176 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
17177 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
17181 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
17183 struct window
*w
= XWINDOW (window
);
17185 struct glyph_row
*last_text_row
= NULL
;
17186 struct frame
*f
= XFRAME (w
->frame
);
17187 int frame_line_height
= default_line_pixel_height (w
);
17189 /* Make POS the new window start. */
17190 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
17192 /* Mark cursor position as unknown. No overlay arrow seen. */
17193 w
->cursor
.vpos
= -1;
17194 overlay_arrow_seen
= false;
17196 /* Initialize iterator and info to start at POS. */
17197 start_display (&it
, w
, pos
);
17198 it
.glyph_row
->reversed_p
= false;
17200 /* Display all lines of W. */
17201 while (it
.current_y
< it
.last_visible_y
)
17203 if (display_line (&it
))
17204 last_text_row
= it
.glyph_row
- 1;
17205 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
17209 /* Don't let the cursor end in the scroll margins. */
17210 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
17211 && !MINI_WINDOW_P (w
))
17213 int this_scroll_margin
;
17214 int window_total_lines
17215 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
17217 if (scroll_margin
> 0)
17219 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
17220 this_scroll_margin
*= frame_line_height
;
17223 this_scroll_margin
= 0;
17225 if ((w
->cursor
.y
>= 0 /* not vscrolled */
17226 && w
->cursor
.y
< this_scroll_margin
17227 && CHARPOS (pos
) > BEGV
17228 && IT_CHARPOS (it
) < ZV
)
17229 /* rms: considering make_cursor_line_fully_visible_p here
17230 seems to give wrong results. We don't want to recenter
17231 when the last line is partly visible, we want to allow
17232 that case to be handled in the usual way. */
17233 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
17235 w
->cursor
.vpos
= -1;
17236 clear_glyph_matrix (w
->desired_matrix
);
17241 /* If bottom moved off end of frame, change mode line percentage. */
17242 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
17243 w
->update_mode_line
= true;
17245 /* Set window_end_pos to the offset of the last character displayed
17246 on the window from the end of current_buffer. Set
17247 window_end_vpos to its row number. */
17250 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
17251 adjust_window_ends (w
, last_text_row
, false);
17253 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
17254 w
->window_end_vpos
)));
17258 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17259 w
->window_end_pos
= Z
- ZV
;
17260 w
->window_end_vpos
= 0;
17263 /* But that is not valid info until redisplay finishes. */
17264 w
->window_end_valid
= false;
17270 /************************************************************************
17271 Window redisplay reusing current matrix when buffer has not changed
17272 ************************************************************************/
17274 /* Try redisplay of window W showing an unchanged buffer with a
17275 different window start than the last time it was displayed by
17276 reusing its current matrix. Value is true if successful.
17277 W->start is the new window start. */
17280 try_window_reusing_current_matrix (struct window
*w
)
17282 struct frame
*f
= XFRAME (w
->frame
);
17283 struct glyph_row
*bottom_row
;
17286 struct text_pos start
, new_start
;
17287 int nrows_scrolled
, i
;
17288 struct glyph_row
*last_text_row
;
17289 struct glyph_row
*last_reused_text_row
;
17290 struct glyph_row
*start_row
;
17291 int start_vpos
, min_y
, max_y
;
17294 if (inhibit_try_window_reusing
)
17298 if (/* This function doesn't handle terminal frames. */
17299 !FRAME_WINDOW_P (f
)
17300 /* Don't try to reuse the display if windows have been split
17302 || windows_or_buffers_changed
17303 || f
->cursor_type_changed
)
17306 /* Can't do this if showing trailing whitespace. */
17307 if (!NILP (Vshow_trailing_whitespace
))
17310 /* If top-line visibility has changed, give up. */
17311 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17312 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17315 /* Give up if old or new display is scrolled vertically. We could
17316 make this function handle this, but right now it doesn't. */
17317 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17318 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17321 /* The variable new_start now holds the new window start. The old
17322 start `start' can be determined from the current matrix. */
17323 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17324 start
= start_row
->minpos
;
17325 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17327 /* Clear the desired matrix for the display below. */
17328 clear_glyph_matrix (w
->desired_matrix
);
17330 if (CHARPOS (new_start
) <= CHARPOS (start
))
17332 /* Don't use this method if the display starts with an ellipsis
17333 displayed for invisible text. It's not easy to handle that case
17334 below, and it's certainly not worth the effort since this is
17335 not a frequent case. */
17336 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17339 IF_DEBUG (debug_method_add (w
, "twu1"));
17341 /* Display up to a row that can be reused. The variable
17342 last_text_row is set to the last row displayed that displays
17343 text. Note that it.vpos == 0 if or if not there is a
17344 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17345 start_display (&it
, w
, new_start
);
17346 w
->cursor
.vpos
= -1;
17347 last_text_row
= last_reused_text_row
= NULL
;
17349 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17351 /* If we have reached into the characters in the START row,
17352 that means the line boundaries have changed. So we
17353 can't start copying with the row START. Maybe it will
17354 work to start copying with the following row. */
17355 while (IT_CHARPOS (it
) > CHARPOS (start
))
17357 /* Advance to the next row as the "start". */
17359 start
= start_row
->minpos
;
17360 /* If there are no more rows to try, or just one, give up. */
17361 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17362 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17363 || CHARPOS (start
) == ZV
)
17365 clear_glyph_matrix (w
->desired_matrix
);
17369 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17371 /* If we have reached alignment, we can copy the rest of the
17373 if (IT_CHARPOS (it
) == CHARPOS (start
)
17374 /* Don't accept "alignment" inside a display vector,
17375 since start_row could have started in the middle of
17376 that same display vector (thus their character
17377 positions match), and we have no way of telling if
17378 that is the case. */
17379 && it
.current
.dpvec_index
< 0)
17382 it
.glyph_row
->reversed_p
= false;
17383 if (display_line (&it
))
17384 last_text_row
= it
.glyph_row
- 1;
17388 /* A value of current_y < last_visible_y means that we stopped
17389 at the previous window start, which in turn means that we
17390 have at least one reusable row. */
17391 if (it
.current_y
< it
.last_visible_y
)
17393 struct glyph_row
*row
;
17395 /* IT.vpos always starts from 0; it counts text lines. */
17396 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17398 /* Find PT if not already found in the lines displayed. */
17399 if (w
->cursor
.vpos
< 0)
17401 int dy
= it
.current_y
- start_row
->y
;
17403 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17404 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17406 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17407 dy
, nrows_scrolled
);
17410 clear_glyph_matrix (w
->desired_matrix
);
17415 /* Scroll the display. Do it before the current matrix is
17416 changed. The problem here is that update has not yet
17417 run, i.e. part of the current matrix is not up to date.
17418 scroll_run_hook will clear the cursor, and use the
17419 current matrix to get the height of the row the cursor is
17421 run
.current_y
= start_row
->y
;
17422 run
.desired_y
= it
.current_y
;
17423 run
.height
= it
.last_visible_y
- it
.current_y
;
17425 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17428 FRAME_RIF (f
)->update_window_begin_hook (w
);
17429 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17430 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17431 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17435 /* Shift current matrix down by nrows_scrolled lines. */
17436 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17437 rotate_matrix (w
->current_matrix
,
17439 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17442 /* Disable lines that must be updated. */
17443 for (i
= 0; i
< nrows_scrolled
; ++i
)
17444 (start_row
+ i
)->enabled_p
= false;
17446 /* Re-compute Y positions. */
17447 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17448 max_y
= it
.last_visible_y
;
17449 for (row
= start_row
+ nrows_scrolled
;
17453 row
->y
= it
.current_y
;
17454 row
->visible_height
= row
->height
;
17456 if (row
->y
< min_y
)
17457 row
->visible_height
-= min_y
- row
->y
;
17458 if (row
->y
+ row
->height
> max_y
)
17459 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17460 if (row
->fringe_bitmap_periodic_p
)
17461 row
->redraw_fringe_bitmaps_p
= true;
17463 it
.current_y
+= row
->height
;
17465 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17466 last_reused_text_row
= row
;
17467 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17471 /* Disable lines in the current matrix which are now
17472 below the window. */
17473 for (++row
; row
< bottom_row
; ++row
)
17474 row
->enabled_p
= row
->mode_line_p
= false;
17477 /* Update window_end_pos etc.; last_reused_text_row is the last
17478 reused row from the current matrix containing text, if any.
17479 The value of last_text_row is the last displayed line
17480 containing text. */
17481 if (last_reused_text_row
)
17482 adjust_window_ends (w
, last_reused_text_row
, true);
17483 else if (last_text_row
)
17484 adjust_window_ends (w
, last_text_row
, false);
17487 /* This window must be completely empty. */
17488 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17489 w
->window_end_pos
= Z
- ZV
;
17490 w
->window_end_vpos
= 0;
17492 w
->window_end_valid
= false;
17494 /* Update hint: don't try scrolling again in update_window. */
17495 w
->desired_matrix
->no_scrolling_p
= true;
17498 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17502 else if (CHARPOS (new_start
) > CHARPOS (start
))
17504 struct glyph_row
*pt_row
, *row
;
17505 struct glyph_row
*first_reusable_row
;
17506 struct glyph_row
*first_row_to_display
;
17508 int yb
= window_text_bottom_y (w
);
17510 /* Find the row starting at new_start, if there is one. Don't
17511 reuse a partially visible line at the end. */
17512 first_reusable_row
= start_row
;
17513 while (first_reusable_row
->enabled_p
17514 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17515 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17516 < CHARPOS (new_start
)))
17517 ++first_reusable_row
;
17519 /* Give up if there is no row to reuse. */
17520 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17521 || !first_reusable_row
->enabled_p
17522 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17523 != CHARPOS (new_start
)))
17526 /* We can reuse fully visible rows beginning with
17527 first_reusable_row to the end of the window. Set
17528 first_row_to_display to the first row that cannot be reused.
17529 Set pt_row to the row containing point, if there is any. */
17531 for (first_row_to_display
= first_reusable_row
;
17532 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17533 ++first_row_to_display
)
17535 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17536 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17537 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17538 && first_row_to_display
->ends_at_zv_p
17539 && pt_row
== NULL
)))
17540 pt_row
= first_row_to_display
;
17543 /* Start displaying at the start of first_row_to_display. */
17544 eassert (first_row_to_display
->y
< yb
);
17545 init_to_row_start (&it
, w
, first_row_to_display
);
17547 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17549 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17551 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17552 + WINDOW_HEADER_LINE_HEIGHT (w
));
17554 /* Display lines beginning with first_row_to_display in the
17555 desired matrix. Set last_text_row to the last row displayed
17556 that displays text. */
17557 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17558 if (pt_row
== NULL
)
17559 w
->cursor
.vpos
= -1;
17560 last_text_row
= NULL
;
17561 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17562 if (display_line (&it
))
17563 last_text_row
= it
.glyph_row
- 1;
17565 /* If point is in a reused row, adjust y and vpos of the cursor
17569 w
->cursor
.vpos
-= nrows_scrolled
;
17570 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17573 /* Give up if point isn't in a row displayed or reused. (This
17574 also handles the case where w->cursor.vpos < nrows_scrolled
17575 after the calls to display_line, which can happen with scroll
17576 margins. See bug#1295.) */
17577 if (w
->cursor
.vpos
< 0)
17579 clear_glyph_matrix (w
->desired_matrix
);
17583 /* Scroll the display. */
17584 run
.current_y
= first_reusable_row
->y
;
17585 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17586 run
.height
= it
.last_visible_y
- run
.current_y
;
17587 dy
= run
.current_y
- run
.desired_y
;
17592 FRAME_RIF (f
)->update_window_begin_hook (w
);
17593 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17594 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17595 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17599 /* Adjust Y positions of reused rows. */
17600 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17601 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17602 max_y
= it
.last_visible_y
;
17603 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17606 row
->visible_height
= row
->height
;
17607 if (row
->y
< min_y
)
17608 row
->visible_height
-= min_y
- row
->y
;
17609 if (row
->y
+ row
->height
> max_y
)
17610 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17611 if (row
->fringe_bitmap_periodic_p
)
17612 row
->redraw_fringe_bitmaps_p
= true;
17615 /* Scroll the current matrix. */
17616 eassert (nrows_scrolled
> 0);
17617 rotate_matrix (w
->current_matrix
,
17619 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17622 /* Disable rows not reused. */
17623 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17624 row
->enabled_p
= false;
17626 /* Point may have moved to a different line, so we cannot assume that
17627 the previous cursor position is valid; locate the correct row. */
17630 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17632 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17633 && !row
->ends_at_zv_p
;
17637 w
->cursor
.y
= row
->y
;
17639 if (row
< bottom_row
)
17641 /* Can't simply scan the row for point with
17642 bidi-reordered glyph rows. Let set_cursor_from_row
17643 figure out where to put the cursor, and if it fails,
17645 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17647 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17650 clear_glyph_matrix (w
->desired_matrix
);
17656 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17657 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17660 && (!BUFFERP (glyph
->object
)
17661 || glyph
->charpos
< PT
);
17665 w
->cursor
.x
+= glyph
->pixel_width
;
17671 /* Adjust window end. A null value of last_text_row means that
17672 the window end is in reused rows which in turn means that
17673 only its vpos can have changed. */
17675 adjust_window_ends (w
, last_text_row
, false);
17677 w
->window_end_vpos
-= nrows_scrolled
;
17679 w
->window_end_valid
= false;
17680 w
->desired_matrix
->no_scrolling_p
= true;
17683 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17693 /************************************************************************
17694 Window redisplay reusing current matrix when buffer has changed
17695 ************************************************************************/
17697 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17698 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17699 ptrdiff_t *, ptrdiff_t *);
17700 static struct glyph_row
*
17701 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17702 struct glyph_row
*);
17705 /* Return the last row in MATRIX displaying text. If row START is
17706 non-null, start searching with that row. IT gives the dimensions
17707 of the display. Value is null if matrix is empty; otherwise it is
17708 a pointer to the row found. */
17710 static struct glyph_row
*
17711 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17712 struct glyph_row
*start
)
17714 struct glyph_row
*row
, *row_found
;
17716 /* Set row_found to the last row in IT->w's current matrix
17717 displaying text. The loop looks funny but think of partially
17720 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17721 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17723 eassert (row
->enabled_p
);
17725 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17734 /* Return the last row in the current matrix of W that is not affected
17735 by changes at the start of current_buffer that occurred since W's
17736 current matrix was built. Value is null if no such row exists.
17738 BEG_UNCHANGED us the number of characters unchanged at the start of
17739 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17740 first changed character in current_buffer. Characters at positions <
17741 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17742 when the current matrix was built. */
17744 static struct glyph_row
*
17745 find_last_unchanged_at_beg_row (struct window
*w
)
17747 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17748 struct glyph_row
*row
;
17749 struct glyph_row
*row_found
= NULL
;
17750 int yb
= window_text_bottom_y (w
);
17752 /* Find the last row displaying unchanged text. */
17753 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17754 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17755 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17758 if (/* If row ends before first_changed_pos, it is unchanged,
17759 except in some case. */
17760 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17761 /* When row ends in ZV and we write at ZV it is not
17763 && !row
->ends_at_zv_p
17764 /* When first_changed_pos is the end of a continued line,
17765 row is not unchanged because it may be no longer
17767 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17768 && (row
->continued_p
17769 || row
->exact_window_width_line_p
))
17770 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17771 needs to be recomputed, so don't consider this row as
17772 unchanged. This happens when the last line was
17773 bidi-reordered and was killed immediately before this
17774 redisplay cycle. In that case, ROW->end stores the
17775 buffer position of the first visual-order character of
17776 the killed text, which is now beyond ZV. */
17777 && CHARPOS (row
->end
.pos
) <= ZV
)
17780 /* Stop if last visible row. */
17781 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17789 /* Find the first glyph row in the current matrix of W that is not
17790 affected by changes at the end of current_buffer since the
17791 time W's current matrix was built.
17793 Return in *DELTA the number of chars by which buffer positions in
17794 unchanged text at the end of current_buffer must be adjusted.
17796 Return in *DELTA_BYTES the corresponding number of bytes.
17798 Value is null if no such row exists, i.e. all rows are affected by
17801 static struct glyph_row
*
17802 find_first_unchanged_at_end_row (struct window
*w
,
17803 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17805 struct glyph_row
*row
;
17806 struct glyph_row
*row_found
= NULL
;
17808 *delta
= *delta_bytes
= 0;
17810 /* Display must not have been paused, otherwise the current matrix
17811 is not up to date. */
17812 eassert (w
->window_end_valid
);
17814 /* A value of window_end_pos >= END_UNCHANGED means that the window
17815 end is in the range of changed text. If so, there is no
17816 unchanged row at the end of W's current matrix. */
17817 if (w
->window_end_pos
>= END_UNCHANGED
)
17820 /* Set row to the last row in W's current matrix displaying text. */
17821 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17823 /* If matrix is entirely empty, no unchanged row exists. */
17824 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17826 /* The value of row is the last glyph row in the matrix having a
17827 meaningful buffer position in it. The end position of row
17828 corresponds to window_end_pos. This allows us to translate
17829 buffer positions in the current matrix to current buffer
17830 positions for characters not in changed text. */
17832 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17833 ptrdiff_t Z_BYTE_old
=
17834 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17835 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17836 struct glyph_row
*first_text_row
17837 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17839 *delta
= Z
- Z_old
;
17840 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17842 /* Set last_unchanged_pos to the buffer position of the last
17843 character in the buffer that has not been changed. Z is the
17844 index + 1 of the last character in current_buffer, i.e. by
17845 subtracting END_UNCHANGED we get the index of the last
17846 unchanged character, and we have to add BEG to get its buffer
17848 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17849 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17851 /* Search backward from ROW for a row displaying a line that
17852 starts at a minimum position >= last_unchanged_pos_old. */
17853 for (; row
> first_text_row
; --row
)
17855 /* This used to abort, but it can happen.
17856 It is ok to just stop the search instead here. KFS. */
17857 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17860 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17865 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17871 /* Make sure that glyph rows in the current matrix of window W
17872 reference the same glyph memory as corresponding rows in the
17873 frame's frame matrix. This function is called after scrolling W's
17874 current matrix on a terminal frame in try_window_id and
17875 try_window_reusing_current_matrix. */
17878 sync_frame_with_window_matrix_rows (struct window
*w
)
17880 struct frame
*f
= XFRAME (w
->frame
);
17881 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17883 /* Preconditions: W must be a leaf window and full-width. Its frame
17884 must have a frame matrix. */
17885 eassert (BUFFERP (w
->contents
));
17886 eassert (WINDOW_FULL_WIDTH_P (w
));
17887 eassert (!FRAME_WINDOW_P (f
));
17889 /* If W is a full-width window, glyph pointers in W's current matrix
17890 have, by definition, to be the same as glyph pointers in the
17891 corresponding frame matrix. Note that frame matrices have no
17892 marginal areas (see build_frame_matrix). */
17893 window_row
= w
->current_matrix
->rows
;
17894 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17895 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17896 while (window_row
< window_row_end
)
17898 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17899 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17901 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17902 frame_row
->glyphs
[TEXT_AREA
] = start
;
17903 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17904 frame_row
->glyphs
[LAST_AREA
] = end
;
17906 /* Disable frame rows whose corresponding window rows have
17907 been disabled in try_window_id. */
17908 if (!window_row
->enabled_p
)
17909 frame_row
->enabled_p
= false;
17911 ++window_row
, ++frame_row
;
17916 /* Find the glyph row in window W containing CHARPOS. Consider all
17917 rows between START and END (not inclusive). END null means search
17918 all rows to the end of the display area of W. Value is the row
17919 containing CHARPOS or null. */
17922 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17923 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17925 struct glyph_row
*row
= start
;
17926 struct glyph_row
*best_row
= NULL
;
17927 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17930 /* If we happen to start on a header-line, skip that. */
17931 if (row
->mode_line_p
)
17934 if ((end
&& row
>= end
) || !row
->enabled_p
)
17937 last_y
= window_text_bottom_y (w
) - dy
;
17941 /* Give up if we have gone too far. */
17942 if ((end
&& row
>= end
) || !row
->enabled_p
)
17944 /* This formerly returned if they were equal.
17945 I think that both quantities are of a "last plus one" type;
17946 if so, when they are equal, the row is within the screen. -- rms. */
17947 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17950 /* If it is in this row, return this row. */
17951 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17952 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17953 /* The end position of a row equals the start
17954 position of the next row. If CHARPOS is there, we
17955 would rather consider it displayed in the next
17956 line, except when this line ends in ZV. */
17957 && !row_for_charpos_p (row
, charpos
)))
17958 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17962 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17963 || (!best_row
&& !row
->continued_p
))
17965 /* In bidi-reordered rows, there could be several rows whose
17966 edges surround CHARPOS, all of these rows belonging to
17967 the same continued line. We need to find the row which
17968 fits CHARPOS the best. */
17969 for (g
= row
->glyphs
[TEXT_AREA
];
17970 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17973 if (!STRINGP (g
->object
))
17975 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17977 mindif
= eabs (g
->charpos
- charpos
);
17979 /* Exact match always wins. */
17986 else if (best_row
&& !row
->continued_p
)
17993 /* Try to redisplay window W by reusing its existing display. W's
17994 current matrix must be up to date when this function is called,
17995 i.e., window_end_valid must be true.
17999 >= 1 if successful, i.e. display has been updated
18001 1 means the changes were in front of a newline that precedes
18002 the window start, and the whole current matrix was reused
18003 2 means the changes were after the last position displayed
18004 in the window, and the whole current matrix was reused
18005 3 means portions of the current matrix were reused, while
18006 some of the screen lines were redrawn
18007 -1 if redisplay with same window start is known not to succeed
18008 0 if otherwise unsuccessful
18010 The following steps are performed:
18012 1. Find the last row in the current matrix of W that is not
18013 affected by changes at the start of current_buffer. If no such row
18016 2. Find the first row in W's current matrix that is not affected by
18017 changes at the end of current_buffer. Maybe there is no such row.
18019 3. Display lines beginning with the row + 1 found in step 1 to the
18020 row found in step 2 or, if step 2 didn't find a row, to the end of
18023 4. If cursor is not known to appear on the window, give up.
18025 5. If display stopped at the row found in step 2, scroll the
18026 display and current matrix as needed.
18028 6. Maybe display some lines at the end of W, if we must. This can
18029 happen under various circumstances, like a partially visible line
18030 becoming fully visible, or because newly displayed lines are displayed
18031 in smaller font sizes.
18033 7. Update W's window end information. */
18036 try_window_id (struct window
*w
)
18038 struct frame
*f
= XFRAME (w
->frame
);
18039 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
18040 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
18041 struct glyph_row
*last_unchanged_at_beg_row
;
18042 struct glyph_row
*first_unchanged_at_end_row
;
18043 struct glyph_row
*row
;
18044 struct glyph_row
*bottom_row
;
18047 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
18049 struct text_pos start_pos
;
18051 int first_unchanged_at_end_vpos
= 0;
18052 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
18053 struct text_pos start
;
18054 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
18057 if (inhibit_try_window_id
)
18061 /* This is handy for debugging. */
18063 #define GIVE_UP(X) \
18065 TRACE ((stderr, "try_window_id give up %d\n", (X))); \
18069 #define GIVE_UP(X) return 0
18072 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
18074 /* Don't use this for mini-windows because these can show
18075 messages and mini-buffers, and we don't handle that here. */
18076 if (MINI_WINDOW_P (w
))
18079 /* This flag is used to prevent redisplay optimizations. */
18080 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
18083 /* This function's optimizations cannot be used if overlays have
18084 changed in the buffer displayed by the window, so give up if they
18086 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
18089 /* Verify that narrowing has not changed.
18090 Also verify that we were not told to prevent redisplay optimizations.
18091 It would be nice to further
18092 reduce the number of cases where this prevents try_window_id. */
18093 if (current_buffer
->clip_changed
18094 || current_buffer
->prevent_redisplay_optimizations_p
)
18097 /* Window must either use window-based redisplay or be full width. */
18098 if (!FRAME_WINDOW_P (f
)
18099 && (!FRAME_LINE_INS_DEL_OK (f
)
18100 || !WINDOW_FULL_WIDTH_P (w
)))
18103 /* Give up if point is known NOT to appear in W. */
18104 if (PT
< CHARPOS (start
))
18107 /* Another way to prevent redisplay optimizations. */
18108 if (w
->last_modified
== 0)
18111 /* Verify that window is not hscrolled. */
18112 if (w
->hscroll
!= 0)
18115 /* Verify that display wasn't paused. */
18116 if (!w
->window_end_valid
)
18119 /* Likewise if highlighting trailing whitespace. */
18120 if (!NILP (Vshow_trailing_whitespace
))
18123 /* Can't use this if overlay arrow position and/or string have
18125 if (overlay_arrows_changed_p ())
18128 /* When word-wrap is on, adding a space to the first word of a
18129 wrapped line can change the wrap position, altering the line
18130 above it. It might be worthwhile to handle this more
18131 intelligently, but for now just redisplay from scratch. */
18132 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
18135 /* Under bidi reordering, adding or deleting a character in the
18136 beginning of a paragraph, before the first strong directional
18137 character, can change the base direction of the paragraph (unless
18138 the buffer specifies a fixed paragraph direction), which will
18139 require redisplaying the whole paragraph. It might be worthwhile
18140 to find the paragraph limits and widen the range of redisplayed
18141 lines to that, but for now just give up this optimization and
18142 redisplay from scratch. */
18143 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
18144 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
18147 /* Give up if the buffer has line-spacing set, as Lisp-level changes
18148 to that variable require thorough redisplay. */
18149 if (!NILP (BVAR (XBUFFER (w
->contents
), extra_line_spacing
)))
18152 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
18153 only if buffer has really changed. The reason is that the gap is
18154 initially at Z for freshly visited files. The code below would
18155 set end_unchanged to 0 in that case. */
18156 if (MODIFF
> SAVE_MODIFF
18157 /* This seems to happen sometimes after saving a buffer. */
18158 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
18160 if (GPT
- BEG
< BEG_UNCHANGED
)
18161 BEG_UNCHANGED
= GPT
- BEG
;
18162 if (Z
- GPT
< END_UNCHANGED
)
18163 END_UNCHANGED
= Z
- GPT
;
18166 /* The position of the first and last character that has been changed. */
18167 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
18168 last_changed_charpos
= Z
- END_UNCHANGED
;
18170 /* If window starts after a line end, and the last change is in
18171 front of that newline, then changes don't affect the display.
18172 This case happens with stealth-fontification. Note that although
18173 the display is unchanged, glyph positions in the matrix have to
18174 be adjusted, of course. */
18175 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
18176 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
18177 && ((last_changed_charpos
< CHARPOS (start
)
18178 && CHARPOS (start
) == BEGV
)
18179 || (last_changed_charpos
< CHARPOS (start
) - 1
18180 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
18182 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
18183 struct glyph_row
*r0
;
18185 /* Compute how many chars/bytes have been added to or removed
18186 from the buffer. */
18187 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
18188 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
18189 Z_delta
= Z
- Z_old
;
18190 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
18192 /* Give up if PT is not in the window. Note that it already has
18193 been checked at the start of try_window_id that PT is not in
18194 front of the window start. */
18195 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
18198 /* If window start is unchanged, we can reuse the whole matrix
18199 as is, after adjusting glyph positions. No need to compute
18200 the window end again, since its offset from Z hasn't changed. */
18201 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18202 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
18203 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
18204 /* PT must not be in a partially visible line. */
18205 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
18206 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18208 /* Adjust positions in the glyph matrix. */
18209 if (Z_delta
|| Z_delta_bytes
)
18211 struct glyph_row
*r1
18212 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18213 increment_matrix_positions (w
->current_matrix
,
18214 MATRIX_ROW_VPOS (r0
, current_matrix
),
18215 MATRIX_ROW_VPOS (r1
, current_matrix
),
18216 Z_delta
, Z_delta_bytes
);
18219 /* Set the cursor. */
18220 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18222 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18227 /* Handle the case that changes are all below what is displayed in
18228 the window, and that PT is in the window. This shortcut cannot
18229 be taken if ZV is visible in the window, and text has been added
18230 there that is visible in the window. */
18231 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
18232 /* ZV is not visible in the window, or there are no
18233 changes at ZV, actually. */
18234 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
18235 || first_changed_charpos
== last_changed_charpos
))
18237 struct glyph_row
*r0
;
18239 /* Give up if PT is not in the window. Note that it already has
18240 been checked at the start of try_window_id that PT is not in
18241 front of the window start. */
18242 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
18245 /* If window start is unchanged, we can reuse the whole matrix
18246 as is, without changing glyph positions since no text has
18247 been added/removed in front of the window end. */
18248 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18249 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
18250 /* PT must not be in a partially visible line. */
18251 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
18252 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18254 /* We have to compute the window end anew since text
18255 could have been added/removed after it. */
18256 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18257 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18259 /* Set the cursor. */
18260 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18262 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18267 /* Give up if window start is in the changed area.
18269 The condition used to read
18271 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18273 but why that was tested escapes me at the moment. */
18274 if (CHARPOS (start
) >= first_changed_charpos
18275 && CHARPOS (start
) <= last_changed_charpos
)
18278 /* Check that window start agrees with the start of the first glyph
18279 row in its current matrix. Check this after we know the window
18280 start is not in changed text, otherwise positions would not be
18282 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18283 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
18286 /* Give up if the window ends in strings. Overlay strings
18287 at the end are difficult to handle, so don't try. */
18288 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
18289 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
18292 /* Compute the position at which we have to start displaying new
18293 lines. Some of the lines at the top of the window might be
18294 reusable because they are not displaying changed text. Find the
18295 last row in W's current matrix not affected by changes at the
18296 start of current_buffer. Value is null if changes start in the
18297 first line of window. */
18298 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18299 if (last_unchanged_at_beg_row
)
18301 /* Avoid starting to display in the middle of a character, a TAB
18302 for instance. This is easier than to set up the iterator
18303 exactly, and it's not a frequent case, so the additional
18304 effort wouldn't really pay off. */
18305 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18306 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18307 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18308 --last_unchanged_at_beg_row
;
18310 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18313 if (! init_to_row_end (&it
, w
, last_unchanged_at_beg_row
))
18315 start_pos
= it
.current
.pos
;
18317 /* Start displaying new lines in the desired matrix at the same
18318 vpos we would use in the current matrix, i.e. below
18319 last_unchanged_at_beg_row. */
18320 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18322 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18323 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18325 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18329 /* There are no reusable lines at the start of the window.
18330 Start displaying in the first text line. */
18331 start_display (&it
, w
, start
);
18332 it
.vpos
= it
.first_vpos
;
18333 start_pos
= it
.current
.pos
;
18336 /* Find the first row that is not affected by changes at the end of
18337 the buffer. Value will be null if there is no unchanged row, in
18338 which case we must redisplay to the end of the window. delta
18339 will be set to the value by which buffer positions beginning with
18340 first_unchanged_at_end_row have to be adjusted due to text
18342 first_unchanged_at_end_row
18343 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18344 IF_DEBUG (debug_delta
= delta
);
18345 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18347 /* Set stop_pos to the buffer position up to which we will have to
18348 display new lines. If first_unchanged_at_end_row != NULL, this
18349 is the buffer position of the start of the line displayed in that
18350 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18351 that we don't stop at a buffer position. */
18353 if (first_unchanged_at_end_row
)
18355 eassert (last_unchanged_at_beg_row
== NULL
18356 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18358 /* If this is a continuation line, move forward to the next one
18359 that isn't. Changes in lines above affect this line.
18360 Caution: this may move first_unchanged_at_end_row to a row
18361 not displaying text. */
18362 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18363 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18364 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18365 < it
.last_visible_y
))
18366 ++first_unchanged_at_end_row
;
18368 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18369 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18370 >= it
.last_visible_y
))
18371 first_unchanged_at_end_row
= NULL
;
18374 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18376 first_unchanged_at_end_vpos
18377 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18378 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18381 else if (last_unchanged_at_beg_row
== NULL
)
18387 /* Either there is no unchanged row at the end, or the one we have
18388 now displays text. This is a necessary condition for the window
18389 end pos calculation at the end of this function. */
18390 eassert (first_unchanged_at_end_row
== NULL
18391 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18393 debug_last_unchanged_at_beg_vpos
18394 = (last_unchanged_at_beg_row
18395 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18397 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18399 #endif /* GLYPH_DEBUG */
18402 /* Display new lines. Set last_text_row to the last new line
18403 displayed which has text on it, i.e. might end up as being the
18404 line where the window_end_vpos is. */
18405 w
->cursor
.vpos
= -1;
18406 last_text_row
= NULL
;
18407 overlay_arrow_seen
= false;
18408 if (it
.current_y
< it
.last_visible_y
18409 && !f
->fonts_changed
18410 && (first_unchanged_at_end_row
== NULL
18411 || IT_CHARPOS (it
) < stop_pos
))
18412 it
.glyph_row
->reversed_p
= false;
18413 while (it
.current_y
< it
.last_visible_y
18414 && !f
->fonts_changed
18415 && (first_unchanged_at_end_row
== NULL
18416 || IT_CHARPOS (it
) < stop_pos
))
18418 if (display_line (&it
))
18419 last_text_row
= it
.glyph_row
- 1;
18422 if (f
->fonts_changed
)
18425 /* The redisplay iterations in display_line above could have
18426 triggered font-lock, which could have done something that
18427 invalidates IT->w window's end-point information, on which we
18428 rely below. E.g., one package, which will remain unnamed, used
18429 to install a font-lock-fontify-region-function that called
18430 bury-buffer, whose side effect is to switch the buffer displayed
18431 by IT->w, and that predictably resets IT->w's window_end_valid
18432 flag, which we already tested at the entry to this function.
18433 Amply punish such packages/modes by giving up on this
18434 optimization in those cases. */
18435 if (!w
->window_end_valid
)
18437 clear_glyph_matrix (w
->desired_matrix
);
18441 /* Compute differences in buffer positions, y-positions etc. for
18442 lines reused at the bottom of the window. Compute what we can
18444 if (first_unchanged_at_end_row
18445 /* No lines reused because we displayed everything up to the
18446 bottom of the window. */
18447 && it
.current_y
< it
.last_visible_y
)
18450 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18452 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18453 run
.current_y
= first_unchanged_at_end_row
->y
;
18454 run
.desired_y
= run
.current_y
+ dy
;
18455 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18459 delta
= delta_bytes
= dvpos
= dy
18460 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18461 first_unchanged_at_end_row
= NULL
;
18463 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18466 /* Find the cursor if not already found. We have to decide whether
18467 PT will appear on this window (it sometimes doesn't, but this is
18468 not a very frequent case.) This decision has to be made before
18469 the current matrix is altered. A value of cursor.vpos < 0 means
18470 that PT is either in one of the lines beginning at
18471 first_unchanged_at_end_row or below the window. Don't care for
18472 lines that might be displayed later at the window end; as
18473 mentioned, this is not a frequent case. */
18474 if (w
->cursor
.vpos
< 0)
18476 /* Cursor in unchanged rows at the top? */
18477 if (PT
< CHARPOS (start_pos
)
18478 && last_unchanged_at_beg_row
)
18480 row
= row_containing_pos (w
, PT
,
18481 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18482 last_unchanged_at_beg_row
+ 1, 0);
18484 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18487 /* Start from first_unchanged_at_end_row looking for PT. */
18488 else if (first_unchanged_at_end_row
)
18490 row
= row_containing_pos (w
, PT
- delta
,
18491 first_unchanged_at_end_row
, NULL
, 0);
18493 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18494 delta_bytes
, dy
, dvpos
);
18497 /* Give up if cursor was not found. */
18498 if (w
->cursor
.vpos
< 0)
18500 clear_glyph_matrix (w
->desired_matrix
);
18505 /* Don't let the cursor end in the scroll margins. */
18507 int this_scroll_margin
, cursor_height
;
18508 int frame_line_height
= default_line_pixel_height (w
);
18509 int window_total_lines
18510 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18512 this_scroll_margin
=
18513 max (0, min (scroll_margin
, window_total_lines
/ 4));
18514 this_scroll_margin
*= frame_line_height
;
18515 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18517 if ((w
->cursor
.y
< this_scroll_margin
18518 && CHARPOS (start
) > BEGV
)
18519 /* Old redisplay didn't take scroll margin into account at the bottom,
18520 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18521 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18522 ? cursor_height
+ this_scroll_margin
18523 : 1)) > it
.last_visible_y
)
18525 w
->cursor
.vpos
= -1;
18526 clear_glyph_matrix (w
->desired_matrix
);
18531 /* Scroll the display. Do it before changing the current matrix so
18532 that xterm.c doesn't get confused about where the cursor glyph is
18534 if (dy
&& run
.height
)
18538 if (FRAME_WINDOW_P (f
))
18540 FRAME_RIF (f
)->update_window_begin_hook (w
);
18541 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18542 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18543 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
18547 /* Terminal frame. In this case, dvpos gives the number of
18548 lines to scroll by; dvpos < 0 means scroll up. */
18550 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18551 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18552 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18553 + WINDOW_WANTS_HEADER_LINE_P (w
)
18554 + window_internal_height (w
));
18556 #if defined (HAVE_GPM) || defined (MSDOS)
18557 x_clear_window_mouse_face (w
);
18559 /* Perform the operation on the screen. */
18562 /* Scroll last_unchanged_at_beg_row to the end of the
18563 window down dvpos lines. */
18564 set_terminal_window (f
, end
);
18566 /* On dumb terminals delete dvpos lines at the end
18567 before inserting dvpos empty lines. */
18568 if (!FRAME_SCROLL_REGION_OK (f
))
18569 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18571 /* Insert dvpos empty lines in front of
18572 last_unchanged_at_beg_row. */
18573 ins_del_lines (f
, from
, dvpos
);
18575 else if (dvpos
< 0)
18577 /* Scroll up last_unchanged_at_beg_vpos to the end of
18578 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18579 set_terminal_window (f
, end
);
18581 /* Delete dvpos lines in front of
18582 last_unchanged_at_beg_vpos. ins_del_lines will set
18583 the cursor to the given vpos and emit |dvpos| delete
18585 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18587 /* On a dumb terminal insert dvpos empty lines at the
18589 if (!FRAME_SCROLL_REGION_OK (f
))
18590 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18593 set_terminal_window (f
, 0);
18599 /* Shift reused rows of the current matrix to the right position.
18600 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18602 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18603 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18606 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18607 bottom_vpos
, dvpos
);
18608 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18611 else if (dvpos
> 0)
18613 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18614 bottom_vpos
, dvpos
);
18615 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18616 first_unchanged_at_end_vpos
+ dvpos
);
18619 /* For frame-based redisplay, make sure that current frame and window
18620 matrix are in sync with respect to glyph memory. */
18621 if (!FRAME_WINDOW_P (f
))
18622 sync_frame_with_window_matrix_rows (w
);
18624 /* Adjust buffer positions in reused rows. */
18625 if (delta
|| delta_bytes
)
18626 increment_matrix_positions (current_matrix
,
18627 first_unchanged_at_end_vpos
+ dvpos
,
18628 bottom_vpos
, delta
, delta_bytes
);
18630 /* Adjust Y positions. */
18632 shift_glyph_matrix (w
, current_matrix
,
18633 first_unchanged_at_end_vpos
+ dvpos
,
18636 if (first_unchanged_at_end_row
)
18638 first_unchanged_at_end_row
+= dvpos
;
18639 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18640 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18641 first_unchanged_at_end_row
= NULL
;
18644 /* If scrolling up, there may be some lines to display at the end of
18646 last_text_row_at_end
= NULL
;
18649 /* Scrolling up can leave for example a partially visible line
18650 at the end of the window to be redisplayed. */
18651 /* Set last_row to the glyph row in the current matrix where the
18652 window end line is found. It has been moved up or down in
18653 the matrix by dvpos. */
18654 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18655 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18657 /* If last_row is the window end line, it should display text. */
18658 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18660 /* If window end line was partially visible before, begin
18661 displaying at that line. Otherwise begin displaying with the
18662 line following it. */
18663 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18665 init_to_row_start (&it
, w
, last_row
);
18666 it
.vpos
= last_vpos
;
18667 it
.current_y
= last_row
->y
;
18671 init_to_row_end (&it
, w
, last_row
);
18672 it
.vpos
= 1 + last_vpos
;
18673 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18677 /* We may start in a continuation line. If so, we have to
18678 get the right continuation_lines_width and current_x. */
18679 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18680 it
.hpos
= it
.current_x
= 0;
18682 /* Display the rest of the lines at the window end. */
18683 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18684 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18686 /* Is it always sure that the display agrees with lines in
18687 the current matrix? I don't think so, so we mark rows
18688 displayed invalid in the current matrix by setting their
18689 enabled_p flag to false. */
18690 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18691 if (display_line (&it
))
18692 last_text_row_at_end
= it
.glyph_row
- 1;
18696 /* Update window_end_pos and window_end_vpos. */
18697 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18699 /* Window end line if one of the preserved rows from the current
18700 matrix. Set row to the last row displaying text in current
18701 matrix starting at first_unchanged_at_end_row, after
18703 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18704 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18705 first_unchanged_at_end_row
);
18706 eassume (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18707 adjust_window_ends (w
, row
, true);
18708 eassert (w
->window_end_bytepos
>= 0);
18709 IF_DEBUG (debug_method_add (w
, "A"));
18711 else if (last_text_row_at_end
)
18713 adjust_window_ends (w
, last_text_row_at_end
, false);
18714 eassert (w
->window_end_bytepos
>= 0);
18715 IF_DEBUG (debug_method_add (w
, "B"));
18717 else if (last_text_row
)
18719 /* We have displayed either to the end of the window or at the
18720 end of the window, i.e. the last row with text is to be found
18721 in the desired matrix. */
18722 adjust_window_ends (w
, last_text_row
, false);
18723 eassert (w
->window_end_bytepos
>= 0);
18725 else if (first_unchanged_at_end_row
== NULL
18726 && last_text_row
== NULL
18727 && last_text_row_at_end
== NULL
)
18729 /* Displayed to end of window, but no line containing text was
18730 displayed. Lines were deleted at the end of the window. */
18731 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
18732 int vpos
= w
->window_end_vpos
;
18733 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18734 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18736 for (row
= NULL
; !row
; --vpos
, --current_row
, --desired_row
)
18738 eassert (first_vpos
<= vpos
);
18739 if (desired_row
->enabled_p
)
18741 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18744 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18748 w
->window_end_vpos
= vpos
+ 1;
18749 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18750 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18751 eassert (w
->window_end_bytepos
>= 0);
18752 IF_DEBUG (debug_method_add (w
, "C"));
18757 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18758 debug_end_vpos
= w
->window_end_vpos
));
18760 /* Record that display has not been completed. */
18761 w
->window_end_valid
= false;
18762 w
->desired_matrix
->no_scrolling_p
= true;
18770 /***********************************************************************
18771 More debugging support
18772 ***********************************************************************/
18776 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18777 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18778 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18781 /* Dump the contents of glyph matrix MATRIX on stderr.
18783 GLYPHS 0 means don't show glyph contents.
18784 GLYPHS 1 means show glyphs in short form
18785 GLYPHS > 1 means show glyphs in long form. */
18788 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18791 for (i
= 0; i
< matrix
->nrows
; ++i
)
18792 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18796 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18797 the glyph row and area where the glyph comes from. */
18800 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18802 if (glyph
->type
== CHAR_GLYPH
18803 || glyph
->type
== GLYPHLESS_GLYPH
)
18806 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18807 glyph
- row
->glyphs
[TEXT_AREA
],
18808 (glyph
->type
== CHAR_GLYPH
18812 (BUFFERP (glyph
->object
)
18814 : (STRINGP (glyph
->object
)
18816 : (NILP (glyph
->object
)
18819 glyph
->pixel_width
,
18821 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18825 glyph
->left_box_line_p
,
18826 glyph
->right_box_line_p
);
18828 else if (glyph
->type
== STRETCH_GLYPH
)
18831 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18832 glyph
- row
->glyphs
[TEXT_AREA
],
18835 (BUFFERP (glyph
->object
)
18837 : (STRINGP (glyph
->object
)
18839 : (NILP (glyph
->object
)
18842 glyph
->pixel_width
,
18846 glyph
->left_box_line_p
,
18847 glyph
->right_box_line_p
);
18849 else if (glyph
->type
== IMAGE_GLYPH
)
18852 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18853 glyph
- row
->glyphs
[TEXT_AREA
],
18856 (BUFFERP (glyph
->object
)
18858 : (STRINGP (glyph
->object
)
18860 : (NILP (glyph
->object
)
18863 glyph
->pixel_width
,
18867 glyph
->left_box_line_p
,
18868 glyph
->right_box_line_p
);
18870 else if (glyph
->type
== COMPOSITE_GLYPH
)
18873 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18874 glyph
- row
->glyphs
[TEXT_AREA
],
18877 (BUFFERP (glyph
->object
)
18879 : (STRINGP (glyph
->object
)
18881 : (NILP (glyph
->object
)
18884 glyph
->pixel_width
,
18886 if (glyph
->u
.cmp
.automatic
)
18889 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18890 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18892 glyph
->left_box_line_p
,
18893 glyph
->right_box_line_p
);
18895 else if (glyph
->type
== XWIDGET_GLYPH
)
18897 #ifndef HAVE_XWIDGETS
18901 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
18902 glyph
- row
->glyphs
[TEXT_AREA
],
18905 (BUFFERP (glyph
->object
)
18907 : (STRINGP (glyph
->object
)
18910 glyph
->pixel_width
,
18914 glyph
->left_box_line_p
,
18915 glyph
->right_box_line_p
);
18921 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18922 GLYPHS 0 means don't show glyph contents.
18923 GLYPHS 1 means show glyphs in short form
18924 GLYPHS > 1 means show glyphs in long form. */
18927 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18931 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18932 fprintf (stderr
, "==============================================================================\n");
18934 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18935 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18937 MATRIX_ROW_START_CHARPOS (row
),
18938 MATRIX_ROW_END_CHARPOS (row
),
18939 row
->used
[TEXT_AREA
],
18940 row
->contains_overlapping_glyphs_p
,
18942 row
->truncated_on_left_p
,
18943 row
->truncated_on_right_p
,
18945 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18946 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18949 row
->ends_in_middle_of_char_p
,
18950 row
->starts_in_middle_of_char_p
,
18956 row
->visible_height
,
18959 /* The next 3 lines should align to "Start" in the header. */
18960 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18961 row
->end
.overlay_string_index
,
18962 row
->continuation_lines_width
);
18963 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18964 CHARPOS (row
->start
.string_pos
),
18965 CHARPOS (row
->end
.string_pos
));
18966 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18967 row
->end
.dpvec_index
);
18974 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18976 struct glyph
*glyph
= row
->glyphs
[area
];
18977 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18979 /* Glyph for a line end in text. */
18980 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18983 if (glyph
< glyph_end
)
18984 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18986 for (; glyph
< glyph_end
; ++glyph
)
18987 dump_glyph (row
, glyph
, area
);
18990 else if (glyphs
== 1)
18993 char s
[SHRT_MAX
+ 4];
18995 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18999 for (i
= 0; i
< row
->used
[area
]; ++i
)
19001 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
19002 if (i
== row
->used
[area
] - 1
19003 && area
== TEXT_AREA
19004 && NILP (glyph
->object
)
19005 && glyph
->type
== CHAR_GLYPH
19006 && glyph
->u
.ch
== ' ')
19008 strcpy (&s
[i
], "[\\n]");
19011 else if (glyph
->type
== CHAR_GLYPH
19012 && glyph
->u
.ch
< 0x80
19013 && glyph
->u
.ch
>= ' ')
19014 s
[i
] = glyph
->u
.ch
;
19020 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
19026 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
19027 Sdump_glyph_matrix
, 0, 1, "p",
19028 doc
: /* Dump the current matrix of the selected window to stderr.
19029 Shows contents of glyph row structures. With non-nil
19030 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
19031 glyphs in short form, otherwise show glyphs in long form.
19033 Interactively, no argument means show glyphs in short form;
19034 with numeric argument, its value is passed as the GLYPHS flag. */)
19035 (Lisp_Object glyphs
)
19037 struct window
*w
= XWINDOW (selected_window
);
19038 struct buffer
*buffer
= XBUFFER (w
->contents
);
19040 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
19041 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
19042 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
19043 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
19044 fprintf (stderr
, "=============================================\n");
19045 dump_glyph_matrix (w
->current_matrix
,
19046 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
19051 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
19052 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* Dump the current glyph matrix of the selected frame to stderr.
19053 Only text-mode frames have frame glyph matrices. */)
19056 struct frame
*f
= XFRAME (selected_frame
);
19058 if (f
->current_matrix
)
19059 dump_glyph_matrix (f
->current_matrix
, 1);
19061 fprintf (stderr
, "*** This frame doesn't have a frame glyph matrix ***\n");
19066 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
19067 doc
: /* Dump glyph row ROW to stderr.
19068 GLYPH 0 means don't dump glyphs.
19069 GLYPH 1 means dump glyphs in short form.
19070 GLYPH > 1 or omitted means dump glyphs in long form. */)
19071 (Lisp_Object row
, Lisp_Object glyphs
)
19073 struct glyph_matrix
*matrix
;
19076 CHECK_NUMBER (row
);
19077 matrix
= XWINDOW (selected_window
)->current_matrix
;
19079 if (vpos
>= 0 && vpos
< matrix
->nrows
)
19080 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
19082 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
19087 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
19088 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
19089 GLYPH 0 means don't dump glyphs.
19090 GLYPH 1 means dump glyphs in short form.
19091 GLYPH > 1 or omitted means dump glyphs in long form.
19093 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
19095 (Lisp_Object row
, Lisp_Object glyphs
)
19097 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19098 struct frame
*sf
= SELECTED_FRAME ();
19099 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
19102 CHECK_NUMBER (row
);
19104 if (vpos
>= 0 && vpos
< m
->nrows
)
19105 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
19106 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
19112 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
19113 doc
: /* Toggle tracing of redisplay.
19114 With ARG, turn tracing on if and only if ARG is positive. */)
19118 trace_redisplay_p
= !trace_redisplay_p
;
19121 arg
= Fprefix_numeric_value (arg
);
19122 trace_redisplay_p
= XINT (arg
) > 0;
19129 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
19130 doc
: /* Like `format', but print result to stderr.
19131 usage: (trace-to-stderr STRING &rest OBJECTS) */)
19132 (ptrdiff_t nargs
, Lisp_Object
*args
)
19134 Lisp_Object s
= Fformat (nargs
, args
);
19135 fwrite (SDATA (s
), 1, SBYTES (s
), stderr
);
19139 #endif /* GLYPH_DEBUG */
19143 /***********************************************************************
19144 Building Desired Matrix Rows
19145 ***********************************************************************/
19147 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
19148 Used for non-window-redisplay windows, and for windows w/o left fringe. */
19150 static struct glyph_row
*
19151 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
19153 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19154 struct buffer
*buffer
= XBUFFER (w
->contents
);
19155 struct buffer
*old
= current_buffer
;
19156 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
19157 ptrdiff_t arrow_len
= SCHARS (overlay_arrow_string
);
19158 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
19159 const unsigned char *p
;
19162 int n_glyphs_before
;
19164 set_buffer_temp (buffer
);
19165 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
19166 scratch_glyph_row
.reversed_p
= false;
19167 it
.glyph_row
->used
[TEXT_AREA
] = 0;
19168 SET_TEXT_POS (it
.position
, 0, 0);
19170 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
19172 while (p
< arrow_end
)
19174 Lisp_Object face
, ilisp
;
19176 /* Get the next character. */
19178 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
19181 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
19182 if (! ASCII_CHAR_P (it
.c
))
19183 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
19187 /* Get its face. */
19188 ilisp
= make_number (p
- arrow_string
);
19189 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
19190 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
19192 /* Compute its width, get its glyphs. */
19193 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
19194 SET_TEXT_POS (it
.position
, -1, -1);
19195 PRODUCE_GLYPHS (&it
);
19197 /* If this character doesn't fit any more in the line, we have
19198 to remove some glyphs. */
19199 if (it
.current_x
> it
.last_visible_x
)
19201 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19206 set_buffer_temp (old
);
19207 return it
.glyph_row
;
19211 /* Insert truncation glyphs at the start of IT->glyph_row. Which
19212 glyphs to insert is determined by produce_special_glyphs. */
19215 insert_left_trunc_glyphs (struct it
*it
)
19217 struct it truncate_it
;
19218 struct glyph
*from
, *end
, *to
, *toend
;
19220 eassert (!FRAME_WINDOW_P (it
->f
)
19221 || (!it
->glyph_row
->reversed_p
19222 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19223 || (it
->glyph_row
->reversed_p
19224 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
19226 /* Get the truncation glyphs. */
19228 truncate_it
.current_x
= 0;
19229 truncate_it
.face_id
= DEFAULT_FACE_ID
;
19230 truncate_it
.glyph_row
= &scratch_glyph_row
;
19231 truncate_it
.area
= TEXT_AREA
;
19232 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
19233 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
19234 truncate_it
.object
= Qnil
;
19235 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
19237 /* Overwrite glyphs from IT with truncation glyphs. */
19238 if (!it
->glyph_row
->reversed_p
)
19240 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19242 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19243 end
= from
+ tused
;
19244 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19245 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
19246 if (FRAME_WINDOW_P (it
->f
))
19248 /* On GUI frames, when variable-size fonts are displayed,
19249 the truncation glyphs may need more pixels than the row's
19250 glyphs they overwrite. We overwrite more glyphs to free
19251 enough screen real estate, and enlarge the stretch glyph
19252 on the right (see display_line), if there is one, to
19253 preserve the screen position of the truncation glyphs on
19256 struct glyph
*g
= to
;
19259 /* The first glyph could be partially visible, in which case
19260 it->glyph_row->x will be negative. But we want the left
19261 truncation glyphs to be aligned at the left margin of the
19262 window, so we override the x coordinate at which the row
19264 it
->glyph_row
->x
= 0;
19265 while (g
< toend
&& w
< it
->truncation_pixel_width
)
19267 w
+= g
->pixel_width
;
19270 if (g
- to
- tused
> 0)
19272 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
19273 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
19275 used
= it
->glyph_row
->used
[TEXT_AREA
];
19276 if (it
->glyph_row
->truncated_on_right_p
19277 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
19278 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
19281 int extra
= w
- it
->truncation_pixel_width
;
19283 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
19290 /* There may be padding glyphs left over. Overwrite them too. */
19291 if (!FRAME_WINDOW_P (it
->f
))
19293 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
19295 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19302 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
19306 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19308 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19309 that back to front. */
19310 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19311 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19312 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19313 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19314 if (FRAME_WINDOW_P (it
->f
))
19317 struct glyph
*g
= to
;
19319 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19321 w
+= g
->pixel_width
;
19324 if (to
- g
- tused
> 0)
19326 if (it
->glyph_row
->truncated_on_right_p
19327 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19328 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19330 int extra
= w
- it
->truncation_pixel_width
;
19332 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19336 while (from
>= end
&& to
>= toend
)
19338 if (!FRAME_WINDOW_P (it
->f
))
19340 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19343 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19344 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19345 while (from
>= end
&& to
>= toend
)
19351 /* Need to free some room before prepending additional
19353 int move_by
= from
- end
+ 1;
19354 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19355 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19357 for ( ; g
>= g0
; g
--)
19359 while (from
>= end
)
19361 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19366 /* Compute the hash code for ROW. */
19368 row_hash (struct glyph_row
*row
)
19371 unsigned hashval
= 0;
19373 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19374 for (k
= 0; k
< row
->used
[area
]; ++k
)
19375 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19376 + row
->glyphs
[area
][k
].u
.val
19377 + row
->glyphs
[area
][k
].face_id
19378 + row
->glyphs
[area
][k
].padding_p
19379 + (row
->glyphs
[area
][k
].type
<< 2));
19384 /* Compute the pixel height and width of IT->glyph_row.
19386 Most of the time, ascent and height of a display line will be equal
19387 to the max_ascent and max_height values of the display iterator
19388 structure. This is not the case if
19390 1. We hit ZV without displaying anything. In this case, max_ascent
19391 and max_height will be zero.
19393 2. We have some glyphs that don't contribute to the line height.
19394 (The glyph row flag contributes_to_line_height_p is for future
19395 pixmap extensions).
19397 The first case is easily covered by using default values because in
19398 these cases, the line height does not really matter, except that it
19399 must not be zero. */
19402 compute_line_metrics (struct it
*it
)
19404 struct glyph_row
*row
= it
->glyph_row
;
19406 if (FRAME_WINDOW_P (it
->f
))
19408 int i
, min_y
, max_y
;
19410 /* The line may consist of one space only, that was added to
19411 place the cursor on it. If so, the row's height hasn't been
19413 if (row
->height
== 0)
19415 if (it
->max_ascent
+ it
->max_descent
== 0)
19416 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19417 row
->ascent
= it
->max_ascent
;
19418 row
->height
= it
->max_ascent
+ it
->max_descent
;
19419 row
->phys_ascent
= it
->max_phys_ascent
;
19420 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19421 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19424 /* Compute the width of this line. */
19425 row
->pixel_width
= row
->x
;
19426 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19427 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19429 eassert (row
->pixel_width
>= 0);
19430 eassert (row
->ascent
>= 0 && row
->height
> 0);
19432 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19433 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19435 /* If first line's physical ascent is larger than its logical
19436 ascent, use the physical ascent, and make the row taller.
19437 This makes accented characters fully visible. */
19438 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19439 && row
->phys_ascent
> row
->ascent
)
19441 row
->height
+= row
->phys_ascent
- row
->ascent
;
19442 row
->ascent
= row
->phys_ascent
;
19445 /* Compute how much of the line is visible. */
19446 row
->visible_height
= row
->height
;
19448 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19449 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19451 if (row
->y
< min_y
)
19452 row
->visible_height
-= min_y
- row
->y
;
19453 if (row
->y
+ row
->height
> max_y
)
19454 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19458 row
->pixel_width
= row
->used
[TEXT_AREA
];
19459 if (row
->continued_p
)
19460 row
->pixel_width
-= it
->continuation_pixel_width
;
19461 else if (row
->truncated_on_right_p
)
19462 row
->pixel_width
-= it
->truncation_pixel_width
;
19463 row
->ascent
= row
->phys_ascent
= 0;
19464 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19465 row
->extra_line_spacing
= 0;
19468 /* Compute a hash code for this row. */
19469 row
->hash
= row_hash (row
);
19471 it
->max_ascent
= it
->max_descent
= 0;
19472 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19476 /* Append one space to the glyph row of iterator IT if doing a
19477 window-based redisplay. The space has the same face as
19478 IT->face_id. Value is true if a space was added.
19480 This function is called to make sure that there is always one glyph
19481 at the end of a glyph row that the cursor can be set on under
19482 window-systems. (If there weren't such a glyph we would not know
19483 how wide and tall a box cursor should be displayed).
19485 At the same time this space let's a nicely handle clearing to the
19486 end of the line if the row ends in italic text. */
19489 append_space_for_newline (struct it
*it
, bool default_face_p
)
19491 if (FRAME_WINDOW_P (it
->f
))
19493 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19495 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19496 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19498 /* Save some values that must not be changed.
19499 Must save IT->c and IT->len because otherwise
19500 ITERATOR_AT_END_P wouldn't work anymore after
19501 append_space_for_newline has been called. */
19502 enum display_element_type saved_what
= it
->what
;
19503 int saved_c
= it
->c
, saved_len
= it
->len
;
19504 int saved_char_to_display
= it
->char_to_display
;
19505 int saved_x
= it
->current_x
;
19506 int saved_face_id
= it
->face_id
;
19507 bool saved_box_end
= it
->end_of_box_run_p
;
19508 struct text_pos saved_pos
;
19509 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 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;
20419 int wrap_x
IF_LINT (= 0);
20420 int wrap_row_used
= -1;
20421 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
20422 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
20423 int wrap_row_extra_line_spacing
IF_LINT (= 0);
20424 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
20425 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
20427 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20428 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
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 bool target_is_eol_p
= false;
21691 /* Setup the arena. */
21692 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21693 start_display (&it
, w
, pt
);
21694 /* When lines are truncated, we could be called with point
21695 outside of the windows edges, in which case move_it_*
21696 functions either prematurely stop at window's edge or jump to
21697 the next screen line, whereas we rely below on our ability to
21698 reach point, in order to start from its X coordinate. So we
21699 need to disregard the window's horizontal extent in that case. */
21700 if (it
.line_wrap
== TRUNCATE
)
21701 it
.last_visible_x
= INFINITY
;
21703 if (it
.cmp_it
.id
< 0
21704 && it
.method
== GET_FROM_STRING
21705 && it
.area
== TEXT_AREA
21706 && it
.string_from_display_prop_p
21707 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21708 overshoot_expected
= true;
21710 /* Find the X coordinate of point. We start from the beginning
21711 of this or previous line to make sure we are before point in
21712 the logical order (since the move_it_* functions can only
21715 reseat_at_previous_visible_line_start (&it
);
21716 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21717 if (IT_CHARPOS (it
) != PT
)
21719 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21720 -1, -1, -1, MOVE_TO_POS
);
21721 /* If we missed point because the character there is
21722 displayed out of a display vector that has more than one
21723 glyph, retry expecting overshoot. */
21724 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21725 && it
.current
.dpvec_index
> 0
21726 && !overshoot_expected
)
21728 overshoot_expected
= true;
21731 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21732 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21734 pt_x
= it
.current_x
;
21736 if (dir
> 0 || overshoot_expected
)
21738 struct glyph_row
*row
= it
.glyph_row
;
21740 /* When point is at beginning of line, we don't have
21741 information about the glyph there loaded into struct
21742 it. Calling get_next_display_element fixes that. */
21744 get_next_display_element (&it
);
21745 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21746 it
.glyph_row
= NULL
;
21747 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21748 it
.glyph_row
= row
;
21749 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21750 it, lest it will become out of sync with it's buffer
21752 it
.current_x
= pt_x
;
21755 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21756 pixel_width
= it
.pixel_width
;
21757 if (overshoot_expected
&& at_eol_p
)
21759 else if (pixel_width
<= 0)
21762 /* If there's a display string (or something similar) at point,
21763 we are actually at the glyph to the left of point, so we need
21764 to correct the X coordinate. */
21765 if (overshoot_expected
)
21768 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21770 pt_x
+= pixel_width
;
21773 /* Compute target X coordinate, either to the left or to the
21774 right of point. On TTY frames, all characters have the same
21775 pixel width of 1, so we can use that. On GUI frames we don't
21776 have an easy way of getting at the pixel width of the
21777 character to the left of point, so we use a different method
21778 of getting to that place. */
21780 target_x
= pt_x
+ pixel_width
;
21782 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21784 /* Target X coordinate could be one line above or below the line
21785 of point, in which case we need to adjust the target X
21786 coordinate. Also, if moving to the left, we need to begin at
21787 the left edge of the point's screen line. */
21792 start_display (&it
, w
, pt
);
21793 if (it
.line_wrap
== TRUNCATE
)
21794 it
.last_visible_x
= INFINITY
;
21795 reseat_at_previous_visible_line_start (&it
);
21796 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21798 move_it_by_lines (&it
, pt_vpos
);
21802 move_it_by_lines (&it
, -1);
21803 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21804 target_is_eol_p
= true;
21805 /* Under word-wrap, we don't know the x coordinate of
21806 the last character displayed on the previous line,
21807 which immediately precedes the wrap point. To find
21808 out its x coordinate, we try moving to the right
21809 margin of the window, which will stop at the wrap
21810 point, and then reset target_x to point at the
21811 character that precedes the wrap point. This is not
21812 needed on GUI frames, because (see below) there we
21813 move from the left margin one grapheme cluster at a
21814 time, and stop when we hit the wrap point. */
21815 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21817 void *it_data
= NULL
;
21820 SAVE_IT (it2
, it
, it_data
);
21821 move_it_in_display_line_to (&it
, ZV
, target_x
,
21822 MOVE_TO_POS
| MOVE_TO_X
);
21823 /* If we arrived at target_x, that _is_ the last
21824 character on the previous line. */
21825 if (it
.current_x
!= target_x
)
21826 target_x
= it
.current_x
- 1;
21827 RESTORE_IT (&it
, &it2
, it_data
);
21834 || (target_x
>= it
.last_visible_x
21835 && it
.line_wrap
!= TRUNCATE
))
21838 move_it_by_lines (&it
, 0);
21839 move_it_by_lines (&it
, 1);
21844 /* Move to the target X coordinate. */
21845 #ifdef HAVE_WINDOW_SYSTEM
21846 /* On GUI frames, as we don't know the X coordinate of the
21847 character to the left of point, moving point to the left
21848 requires walking, one grapheme cluster at a time, until we
21849 find ourself at a place immediately to the left of the
21850 character at point. */
21851 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21853 struct text_pos new_pos
;
21854 enum move_it_result rc
= MOVE_X_REACHED
;
21856 if (it
.current_x
== 0)
21857 get_next_display_element (&it
);
21858 if (it
.what
== IT_COMPOSITION
)
21860 new_pos
.charpos
= it
.cmp_it
.charpos
;
21861 new_pos
.bytepos
= -1;
21864 new_pos
= it
.current
.pos
;
21866 while (it
.current_x
+ it
.pixel_width
<= target_x
21867 && (rc
== MOVE_X_REACHED
21868 /* Under word-wrap, move_it_in_display_line_to
21869 stops at correct coordinates, but sometimes
21870 returns MOVE_POS_MATCH_OR_ZV. */
21871 || (it
.line_wrap
== WORD_WRAP
21872 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21874 int new_x
= it
.current_x
+ it
.pixel_width
;
21876 /* For composed characters, we want the position of the
21877 first character in the grapheme cluster (usually, the
21878 composition's base character), whereas it.current
21879 might give us the position of the _last_ one, e.g. if
21880 the composition is rendered in reverse due to bidi
21882 if (it
.what
== IT_COMPOSITION
)
21884 new_pos
.charpos
= it
.cmp_it
.charpos
;
21885 new_pos
.bytepos
= -1;
21888 new_pos
= it
.current
.pos
;
21889 if (new_x
== it
.current_x
)
21891 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21892 MOVE_TO_POS
| MOVE_TO_X
);
21893 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21896 /* The previous position we saw in the loop is the one we
21898 if (new_pos
.bytepos
== -1)
21899 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21900 it
.current
.pos
= new_pos
;
21904 if (it
.current_x
!= target_x
)
21905 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21907 /* If we ended up in a display string that covers point, move to
21908 buffer position to the right in the visual order. */
21911 while (IT_CHARPOS (it
) == PT
)
21913 set_iterator_to_next (&it
, false);
21914 if (!get_next_display_element (&it
))
21919 /* Move point to that position. */
21920 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21923 return make_number (PT
);
21925 #undef ROW_GLYPH_NEWLINE_P
21928 DEFUN ("bidi-resolved-levels", Fbidi_resolved_levels
,
21929 Sbidi_resolved_levels
, 0, 1, 0,
21930 doc
: /* Return the resolved bidirectional levels of characters at VPOS.
21932 The resolved levels are produced by the Emacs bidi reordering engine
21933 that implements the UBA, the Unicode Bidirectional Algorithm. Please
21934 read the Unicode Standard Annex 9 (UAX#9) for background information
21935 about these levels.
21937 VPOS is the zero-based number of the current window's screen line
21938 for which to produce the resolved levels. If VPOS is nil or omitted,
21939 it defaults to the screen line of point. If the window displays a
21940 header line, VPOS of zero will report on the header line, and first
21941 line of text in the window will have VPOS of 1.
21943 Value is an array of resolved levels, indexed by glyph number.
21944 Glyphs are numbered from zero starting from the beginning of the
21945 screen line, i.e. the left edge of the window for left-to-right lines
21946 and from the right edge for right-to-left lines. The resolved levels
21947 are produced only for the window's text area; text in display margins
21950 If the selected window's display is not up-to-date, or if the specified
21951 screen line does not display text, this function returns nil. It is
21952 highly recommended to bind this function to some simple key, like F8,
21953 in order to avoid these problems.
21955 This function exists mainly for testing the correctness of the
21956 Emacs UBA implementation, in particular with the test suite. */)
21959 struct window
*w
= XWINDOW (selected_window
);
21960 struct buffer
*b
= XBUFFER (w
->contents
);
21962 struct glyph_row
*row
;
21966 int d1
, d2
, d3
, d4
, d5
;
21968 pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &nrow
);
21972 CHECK_NUMBER_COERCE_MARKER (vpos
);
21973 nrow
= XINT (vpos
);
21976 /* We require up-to-date glyph matrix for this window. */
21977 if (w
->window_end_valid
21978 && !windows_or_buffers_changed
21980 && !b
->clip_changed
21981 && !b
->prevent_redisplay_optimizations_p
21982 && !window_outdated (w
)
21984 && nrow
< w
->current_matrix
->nrows
21985 && (row
= MATRIX_ROW (w
->current_matrix
, nrow
))->enabled_p
21986 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
21988 struct glyph
*g
, *e
, *g1
;
21990 Lisp_Object levels
;
21992 if (!row
->reversed_p
) /* Left-to-right glyph row. */
21994 g
= g1
= row
->glyphs
[TEXT_AREA
];
21995 e
= g
+ row
->used
[TEXT_AREA
];
21997 /* Skip over glyphs at the start of the row that was
21998 generated by redisplay for its own needs. */
22000 && NILP (g
->object
)
22005 /* Count the "interesting" glyphs in this row. */
22006 for (nglyphs
= 0; g
< e
&& !NILP (g
->object
); g
++)
22009 /* Create and fill the array. */
22010 levels
= make_uninit_vector (nglyphs
);
22011 for (i
= 0; g1
< g
; i
++, g1
++)
22012 ASET (levels
, i
, make_number (g1
->resolved_level
));
22014 else /* Right-to-left glyph row. */
22016 g
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
22017 e
= row
->glyphs
[TEXT_AREA
] - 1;
22019 && NILP (g
->object
)
22023 for (nglyphs
= 0; g
> e
&& !NILP (g
->object
); g
--)
22025 levels
= make_uninit_vector (nglyphs
);
22026 for (i
= 0; g1
> g
; i
++, g1
--)
22027 ASET (levels
, i
, make_number (g1
->resolved_level
));
22037 /***********************************************************************
22039 ***********************************************************************/
22041 /* Redisplay the menu bar in the frame for window W.
22043 The menu bar of X frames that don't have X toolkit support is
22044 displayed in a special window W->frame->menu_bar_window.
22046 The menu bar of terminal frames is treated specially as far as
22047 glyph matrices are concerned. Menu bar lines are not part of
22048 windows, so the update is done directly on the frame matrix rows
22049 for the menu bar. */
22052 display_menu_bar (struct window
*w
)
22054 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22059 /* Don't do all this for graphical frames. */
22061 if (FRAME_W32_P (f
))
22064 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
22070 if (FRAME_NS_P (f
))
22072 #endif /* HAVE_NS */
22074 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
22075 eassert (!FRAME_WINDOW_P (f
));
22076 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
22077 it
.first_visible_x
= 0;
22078 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
22079 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
22080 if (FRAME_WINDOW_P (f
))
22082 /* Menu bar lines are displayed in the desired matrix of the
22083 dummy window menu_bar_window. */
22084 struct window
*menu_w
;
22085 menu_w
= XWINDOW (f
->menu_bar_window
);
22086 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
22088 it
.first_visible_x
= 0;
22089 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
22092 #endif /* not USE_X_TOOLKIT and not USE_GTK */
22094 /* This is a TTY frame, i.e. character hpos/vpos are used as
22096 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
22098 it
.first_visible_x
= 0;
22099 it
.last_visible_x
= FRAME_COLS (f
);
22102 /* FIXME: This should be controlled by a user option. See the
22103 comments in redisplay_tool_bar and display_mode_line about
22105 it
.paragraph_embedding
= L2R
;
22107 /* Clear all rows of the menu bar. */
22108 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
22110 struct glyph_row
*row
= it
.glyph_row
+ i
;
22111 clear_glyph_row (row
);
22112 row
->enabled_p
= true;
22113 row
->full_width_p
= true;
22114 row
->reversed_p
= false;
22117 /* Display all items of the menu bar. */
22118 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
22119 for (i
= 0; i
< ASIZE (items
); i
+= 4)
22121 Lisp_Object string
;
22123 /* Stop at nil string. */
22124 string
= AREF (items
, i
+ 1);
22128 /* Remember where item was displayed. */
22129 ASET (items
, i
+ 3, make_number (it
.hpos
));
22131 /* Display the item, pad with one space. */
22132 if (it
.current_x
< it
.last_visible_x
)
22133 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
22134 SCHARS (string
) + 1, 0, 0, -1);
22137 /* Fill out the line with spaces. */
22138 if (it
.current_x
< it
.last_visible_x
)
22139 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
22141 /* Compute the total height of the lines. */
22142 compute_line_metrics (&it
);
22145 /* Deep copy of a glyph row, including the glyphs. */
22147 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
22149 struct glyph
*pointers
[1 + LAST_AREA
];
22150 int to_used
= to
->used
[TEXT_AREA
];
22152 /* Save glyph pointers of TO. */
22153 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
22155 /* Do a structure assignment. */
22158 /* Restore original glyph pointers of TO. */
22159 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
22161 /* Copy the glyphs. */
22162 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
22163 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
22165 /* If we filled only part of the TO row, fill the rest with
22166 space_glyph (which will display as empty space). */
22167 if (to_used
> from
->used
[TEXT_AREA
])
22168 fill_up_frame_row_with_spaces (to
, to_used
);
22171 /* Display one menu item on a TTY, by overwriting the glyphs in the
22172 frame F's desired glyph matrix with glyphs produced from the menu
22173 item text. Called from term.c to display TTY drop-down menus one
22176 ITEM_TEXT is the menu item text as a C string.
22178 FACE_ID is the face ID to be used for this menu item. FACE_ID
22179 could specify one of 3 faces: a face for an enabled item, a face
22180 for a disabled item, or a face for a selected item.
22182 X and Y are coordinates of the first glyph in the frame's desired
22183 matrix to be overwritten by the menu item. Since this is a TTY, Y
22184 is the zero-based number of the glyph row and X is the zero-based
22185 glyph number in the row, starting from left, where to start
22186 displaying the item.
22188 SUBMENU means this menu item drops down a submenu, which
22189 should be indicated by displaying a proper visual cue after the
22193 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
22194 int x
, int y
, bool submenu
)
22197 struct frame
*f
= SELECTED_FRAME ();
22198 struct window
*w
= XWINDOW (f
->selected_window
);
22199 struct glyph_row
*row
;
22200 size_t item_len
= strlen (item_text
);
22202 eassert (FRAME_TERMCAP_P (f
));
22204 /* Don't write beyond the matrix's last row. This can happen for
22205 TTY screens that are not high enough to show the entire menu.
22206 (This is actually a bit of defensive programming, as
22207 tty_menu_display already limits the number of menu items to one
22208 less than the number of screen lines.) */
22209 if (y
>= f
->desired_matrix
->nrows
)
22212 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
22213 it
.first_visible_x
= 0;
22214 it
.last_visible_x
= FRAME_COLS (f
) - 1;
22215 row
= it
.glyph_row
;
22216 /* Start with the row contents from the current matrix. */
22217 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
22218 bool saved_width
= row
->full_width_p
;
22219 row
->full_width_p
= true;
22220 bool saved_reversed
= row
->reversed_p
;
22221 row
->reversed_p
= false;
22222 row
->enabled_p
= true;
22224 /* Arrange for the menu item glyphs to start at (X,Y) and have the
22226 eassert (x
< f
->desired_matrix
->matrix_w
);
22227 it
.current_x
= it
.hpos
= x
;
22228 it
.current_y
= it
.vpos
= y
;
22229 int saved_used
= row
->used
[TEXT_AREA
];
22230 bool saved_truncated
= row
->truncated_on_right_p
;
22231 row
->used
[TEXT_AREA
] = x
;
22232 it
.face_id
= face_id
;
22233 it
.line_wrap
= TRUNCATE
;
22235 /* FIXME: This should be controlled by a user option. See the
22236 comments in redisplay_tool_bar and display_mode_line about this.
22237 Also, if paragraph_embedding could ever be R2L, changes will be
22238 needed to avoid shifting to the right the row characters in
22239 term.c:append_glyph. */
22240 it
.paragraph_embedding
= L2R
;
22242 /* Pad with a space on the left. */
22243 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
22245 /* Display the menu item, pad with spaces to WIDTH. */
22248 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
22249 item_len
, 0, FRAME_COLS (f
) - 1, -1);
22251 /* Indicate with " >" that there's a submenu. */
22252 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
22253 FRAME_COLS (f
) - 1, -1);
22256 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
22257 width
, 0, FRAME_COLS (f
) - 1, -1);
22259 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
22260 row
->truncated_on_right_p
= saved_truncated
;
22261 row
->hash
= row_hash (row
);
22262 row
->full_width_p
= saved_width
;
22263 row
->reversed_p
= saved_reversed
;
22266 /***********************************************************************
22268 ***********************************************************************/
22270 /* Redisplay mode lines in the window tree whose root is WINDOW.
22271 If FORCE, redisplay mode lines unconditionally.
22272 Otherwise, redisplay only mode lines that are garbaged. Value is
22273 the number of windows whose mode lines were redisplayed. */
22276 redisplay_mode_lines (Lisp_Object window
, bool force
)
22280 while (!NILP (window
))
22282 struct window
*w
= XWINDOW (window
);
22284 if (WINDOWP (w
->contents
))
22285 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
22287 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
22288 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
22290 struct text_pos lpoint
;
22291 struct buffer
*old
= current_buffer
;
22293 /* Set the window's buffer for the mode line display. */
22294 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
22295 set_buffer_internal_1 (XBUFFER (w
->contents
));
22297 /* Point refers normally to the selected window. For any
22298 other window, set up appropriate value. */
22299 if (!EQ (window
, selected_window
))
22301 struct text_pos pt
;
22303 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
22304 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
22307 /* Display mode lines. */
22308 clear_glyph_matrix (w
->desired_matrix
);
22309 if (display_mode_lines (w
))
22312 /* Restore old settings. */
22313 set_buffer_internal_1 (old
);
22314 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
22324 /* Display the mode and/or header line of window W. Value is the
22325 sum number of mode lines and header lines displayed. */
22328 display_mode_lines (struct window
*w
)
22330 Lisp_Object old_selected_window
= selected_window
;
22331 Lisp_Object old_selected_frame
= selected_frame
;
22332 Lisp_Object new_frame
= w
->frame
;
22333 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
22336 selected_frame
= new_frame
;
22337 /* FIXME: If we were to allow the mode-line's computation changing the buffer
22338 or window's point, then we'd need select_window_1 here as well. */
22339 XSETWINDOW (selected_window
, w
);
22340 XFRAME (new_frame
)->selected_window
= selected_window
;
22342 /* These will be set while the mode line specs are processed. */
22343 line_number_displayed
= false;
22344 w
->column_number_displayed
= -1;
22346 if (WINDOW_WANTS_MODELINE_P (w
))
22348 struct window
*sel_w
= XWINDOW (old_selected_window
);
22350 /* Select mode line face based on the real selected window. */
22351 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
22352 BVAR (current_buffer
, mode_line_format
));
22356 if (WINDOW_WANTS_HEADER_LINE_P (w
))
22358 display_mode_line (w
, HEADER_LINE_FACE_ID
,
22359 BVAR (current_buffer
, header_line_format
));
22363 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
22364 selected_frame
= old_selected_frame
;
22365 selected_window
= old_selected_window
;
22367 w
->must_be_updated_p
= true;
22372 /* Display mode or header line of window W. FACE_ID specifies which
22373 line to display; it is either MODE_LINE_FACE_ID or
22374 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
22375 display. Value is the pixel height of the mode/header line
22379 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
22383 ptrdiff_t count
= SPECPDL_INDEX ();
22385 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22386 /* Don't extend on a previously drawn mode-line.
22387 This may happen if called from pos_visible_p. */
22388 it
.glyph_row
->enabled_p
= false;
22389 prepare_desired_row (w
, it
.glyph_row
, true);
22391 it
.glyph_row
->mode_line_p
= true;
22393 /* FIXME: This should be controlled by a user option. But
22394 supporting such an option is not trivial, since the mode line is
22395 made up of many separate strings. */
22396 it
.paragraph_embedding
= L2R
;
22398 record_unwind_protect (unwind_format_mode_line
,
22399 format_mode_line_unwind_data (NULL
, NULL
,
22402 mode_line_target
= MODE_LINE_DISPLAY
;
22404 /* Temporarily make frame's keyboard the current kboard so that
22405 kboard-local variables in the mode_line_format will get the right
22407 push_kboard (FRAME_KBOARD (it
.f
));
22408 record_unwind_save_match_data ();
22409 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22412 unbind_to (count
, Qnil
);
22414 /* Fill up with spaces. */
22415 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
22417 compute_line_metrics (&it
);
22418 it
.glyph_row
->full_width_p
= true;
22419 it
.glyph_row
->continued_p
= false;
22420 it
.glyph_row
->truncated_on_left_p
= false;
22421 it
.glyph_row
->truncated_on_right_p
= false;
22423 /* Make a 3D mode-line have a shadow at its right end. */
22424 face
= FACE_FROM_ID (it
.f
, face_id
);
22425 extend_face_to_end_of_line (&it
);
22426 if (face
->box
!= FACE_NO_BOX
)
22428 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
22429 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
22430 last
->right_box_line_p
= true;
22433 return it
.glyph_row
->height
;
22436 /* Move element ELT in LIST to the front of LIST.
22437 Return the updated list. */
22440 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
22442 register Lisp_Object tail
, prev
;
22443 register Lisp_Object tem
;
22447 while (CONSP (tail
))
22453 /* Splice out the link TAIL. */
22455 list
= XCDR (tail
);
22457 Fsetcdr (prev
, XCDR (tail
));
22459 /* Now make it the first. */
22460 Fsetcdr (tail
, list
);
22465 tail
= XCDR (tail
);
22469 /* Not found--return unchanged LIST. */
22473 /* Contribute ELT to the mode line for window IT->w. How it
22474 translates into text depends on its data type.
22476 IT describes the display environment in which we display, as usual.
22478 DEPTH is the depth in recursion. It is used to prevent
22479 infinite recursion here.
22481 FIELD_WIDTH is the number of characters the display of ELT should
22482 occupy in the mode line, and PRECISION is the maximum number of
22483 characters to display from ELT's representation. See
22484 display_string for details.
22486 Returns the hpos of the end of the text generated by ELT.
22488 PROPS is a property list to add to any string we encounter.
22490 If RISKY, remove (disregard) any properties in any string
22491 we encounter, and ignore :eval and :propertize.
22493 The global variable `mode_line_target' determines whether the
22494 output is passed to `store_mode_line_noprop',
22495 `store_mode_line_string', or `display_string'. */
22498 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
22499 Lisp_Object elt
, Lisp_Object props
, bool risky
)
22501 int n
= 0, field
, prec
;
22502 bool literal
= false;
22506 elt
= build_string ("*too-deep*");
22510 switch (XTYPE (elt
))
22514 /* A string: output it and check for %-constructs within it. */
22516 ptrdiff_t offset
= 0;
22518 if (SCHARS (elt
) > 0
22519 && (!NILP (props
) || risky
))
22521 Lisp_Object oprops
, aelt
;
22522 oprops
= Ftext_properties_at (make_number (0), elt
);
22524 /* If the starting string's properties are not what
22525 we want, translate the string. Also, if the string
22526 is risky, do that anyway. */
22528 if (NILP (Fequal (props
, oprops
)) || risky
)
22530 /* If the starting string has properties,
22531 merge the specified ones onto the existing ones. */
22532 if (! NILP (oprops
) && !risky
)
22536 oprops
= Fcopy_sequence (oprops
);
22538 while (CONSP (tem
))
22540 oprops
= Fplist_put (oprops
, XCAR (tem
),
22541 XCAR (XCDR (tem
)));
22542 tem
= XCDR (XCDR (tem
));
22547 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
22548 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
22550 /* AELT is what we want. Move it to the front
22551 without consing. */
22553 mode_line_proptrans_alist
22554 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
22560 /* If AELT has the wrong props, it is useless.
22561 so get rid of it. */
22563 mode_line_proptrans_alist
22564 = Fdelq (aelt
, mode_line_proptrans_alist
);
22566 elt
= Fcopy_sequence (elt
);
22567 Fset_text_properties (make_number (0), Flength (elt
),
22569 /* Add this item to mode_line_proptrans_alist. */
22570 mode_line_proptrans_alist
22571 = Fcons (Fcons (elt
, props
),
22572 mode_line_proptrans_alist
);
22573 /* Truncate mode_line_proptrans_alist
22574 to at most 50 elements. */
22575 tem
= Fnthcdr (make_number (50),
22576 mode_line_proptrans_alist
);
22578 XSETCDR (tem
, Qnil
);
22587 prec
= precision
- n
;
22588 switch (mode_line_target
)
22590 case MODE_LINE_NOPROP
:
22591 case MODE_LINE_TITLE
:
22592 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
22594 case MODE_LINE_STRING
:
22595 n
+= store_mode_line_string (NULL
, elt
, true, 0, prec
, Qnil
);
22597 case MODE_LINE_DISPLAY
:
22598 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
22599 0, prec
, 0, STRING_MULTIBYTE (elt
));
22606 /* Handle the non-literal case. */
22608 while ((precision
<= 0 || n
< precision
)
22609 && SREF (elt
, offset
) != 0
22610 && (mode_line_target
!= MODE_LINE_DISPLAY
22611 || it
->current_x
< it
->last_visible_x
))
22613 ptrdiff_t last_offset
= offset
;
22615 /* Advance to end of string or next format specifier. */
22616 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22619 if (offset
- 1 != last_offset
)
22621 ptrdiff_t nchars
, nbytes
;
22623 /* Output to end of string or up to '%'. Field width
22624 is length of string. Don't output more than
22625 PRECISION allows us. */
22628 prec
= c_string_width (SDATA (elt
) + last_offset
,
22629 offset
- last_offset
, precision
- n
,
22632 switch (mode_line_target
)
22634 case MODE_LINE_NOPROP
:
22635 case MODE_LINE_TITLE
:
22636 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22638 case MODE_LINE_STRING
:
22640 ptrdiff_t bytepos
= last_offset
;
22641 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22642 ptrdiff_t endpos
= (precision
<= 0
22643 ? string_byte_to_char (elt
, offset
)
22644 : charpos
+ nchars
);
22645 Lisp_Object mode_string
22646 = Fsubstring (elt
, make_number (charpos
),
22647 make_number (endpos
));
22648 n
+= store_mode_line_string (NULL
, mode_string
, false,
22652 case MODE_LINE_DISPLAY
:
22654 ptrdiff_t bytepos
= last_offset
;
22655 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22657 if (precision
<= 0)
22658 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22659 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22661 STRING_MULTIBYTE (elt
));
22666 else /* c == '%' */
22668 ptrdiff_t percent_position
= offset
;
22670 /* Get the specified minimum width. Zero means
22673 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22674 field
= field
* 10 + c
- '0';
22676 /* Don't pad beyond the total padding allowed. */
22677 if (field_width
- n
> 0 && field
> field_width
- n
)
22678 field
= field_width
- n
;
22680 /* Note that either PRECISION <= 0 or N < PRECISION. */
22681 prec
= precision
- n
;
22684 n
+= display_mode_element (it
, depth
, field
, prec
,
22685 Vglobal_mode_string
, props
,
22690 ptrdiff_t bytepos
, charpos
;
22692 Lisp_Object string
;
22694 bytepos
= percent_position
;
22695 charpos
= (STRING_MULTIBYTE (elt
)
22696 ? string_byte_to_char (elt
, bytepos
)
22698 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22699 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22701 switch (mode_line_target
)
22703 case MODE_LINE_NOPROP
:
22704 case MODE_LINE_TITLE
:
22705 n
+= store_mode_line_noprop (spec
, field
, prec
);
22707 case MODE_LINE_STRING
:
22709 Lisp_Object tem
= build_string (spec
);
22710 props
= Ftext_properties_at (make_number (charpos
), elt
);
22711 /* Should only keep face property in props */
22712 n
+= store_mode_line_string (NULL
, tem
, false,
22713 field
, prec
, props
);
22716 case MODE_LINE_DISPLAY
:
22718 int nglyphs_before
, nwritten
;
22720 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22721 nwritten
= display_string (spec
, string
, elt
,
22726 /* Assign to the glyphs written above the
22727 string where the `%x' came from, position
22731 struct glyph
*glyph
22732 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22736 for (i
= 0; i
< nwritten
; ++i
)
22738 glyph
[i
].object
= elt
;
22739 glyph
[i
].charpos
= charpos
;
22756 /* A symbol: process the value of the symbol recursively
22757 as if it appeared here directly. Avoid error if symbol void.
22758 Special case: if value of symbol is a string, output the string
22761 register Lisp_Object tem
;
22763 /* If the variable is not marked as risky to set
22764 then its contents are risky to use. */
22765 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22768 tem
= Fboundp (elt
);
22771 tem
= Fsymbol_value (elt
);
22772 /* If value is a string, output that string literally:
22773 don't check for % within it. */
22777 if (!EQ (tem
, elt
))
22779 /* Give up right away for nil or t. */
22789 register Lisp_Object car
, tem
;
22791 /* A cons cell: five distinct cases.
22792 If first element is :eval or :propertize, do something special.
22793 If first element is a string or a cons, process all the elements
22794 and effectively concatenate them.
22795 If first element is a negative number, truncate displaying cdr to
22796 at most that many characters. If positive, pad (with spaces)
22797 to at least that many characters.
22798 If first element is a symbol, process the cadr or caddr recursively
22799 according to whether the symbol's value is non-nil or nil. */
22801 if (EQ (car
, QCeval
))
22803 /* An element of the form (:eval FORM) means evaluate FORM
22804 and use the result as mode line elements. */
22809 if (CONSP (XCDR (elt
)))
22812 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22813 n
+= display_mode_element (it
, depth
, field_width
- n
,
22814 precision
- n
, spec
, props
,
22818 else if (EQ (car
, QCpropertize
))
22820 /* An element of the form (:propertize ELT PROPS...)
22821 means display ELT but applying properties PROPS. */
22826 if (CONSP (XCDR (elt
)))
22827 n
+= display_mode_element (it
, depth
, field_width
- n
,
22828 precision
- n
, XCAR (XCDR (elt
)),
22829 XCDR (XCDR (elt
)), risky
);
22831 else if (SYMBOLP (car
))
22833 tem
= Fboundp (car
);
22837 /* elt is now the cdr, and we know it is a cons cell.
22838 Use its car if CAR has a non-nil value. */
22841 tem
= Fsymbol_value (car
);
22848 /* Symbol's value is nil (or symbol is unbound)
22849 Get the cddr of the original list
22850 and if possible find the caddr and use that. */
22854 else if (!CONSP (elt
))
22859 else if (INTEGERP (car
))
22861 register int lim
= XINT (car
);
22865 /* Negative int means reduce maximum width. */
22866 if (precision
<= 0)
22869 precision
= min (precision
, -lim
);
22873 /* Padding specified. Don't let it be more than
22874 current maximum. */
22876 lim
= min (precision
, lim
);
22878 /* If that's more padding than already wanted, queue it.
22879 But don't reduce padding already specified even if
22880 that is beyond the current truncation point. */
22881 field_width
= max (lim
, field_width
);
22885 else if (STRINGP (car
) || CONSP (car
))
22887 Lisp_Object halftail
= elt
;
22891 && (precision
<= 0 || n
< precision
))
22893 n
+= display_mode_element (it
, depth
,
22894 /* Do padding only after the last
22895 element in the list. */
22896 (! CONSP (XCDR (elt
))
22899 precision
- n
, XCAR (elt
),
22903 if ((len
& 1) == 0)
22904 halftail
= XCDR (halftail
);
22905 /* Check for cycle. */
22906 if (EQ (halftail
, elt
))
22915 elt
= build_string ("*invalid*");
22919 /* Pad to FIELD_WIDTH. */
22920 if (field_width
> 0 && n
< field_width
)
22922 switch (mode_line_target
)
22924 case MODE_LINE_NOPROP
:
22925 case MODE_LINE_TITLE
:
22926 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22928 case MODE_LINE_STRING
:
22929 n
+= store_mode_line_string ("", Qnil
, false, field_width
- n
, 0,
22932 case MODE_LINE_DISPLAY
:
22933 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22942 /* Store a mode-line string element in mode_line_string_list.
22944 If STRING is non-null, display that C string. Otherwise, the Lisp
22945 string LISP_STRING is displayed.
22947 FIELD_WIDTH is the minimum number of output glyphs to produce.
22948 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22949 with spaces. FIELD_WIDTH <= 0 means don't pad.
22951 PRECISION is the maximum number of characters to output from
22952 STRING. PRECISION <= 0 means don't truncate the string.
22954 If COPY_STRING, make a copy of LISP_STRING before adding
22955 properties to the string.
22957 PROPS are the properties to add to the string.
22958 The mode_line_string_face face property is always added to the string.
22962 store_mode_line_string (const char *string
, Lisp_Object lisp_string
,
22964 int field_width
, int precision
, Lisp_Object props
)
22969 if (string
!= NULL
)
22971 len
= strlen (string
);
22972 if (precision
> 0 && len
> precision
)
22974 lisp_string
= make_string (string
, len
);
22976 props
= mode_line_string_face_prop
;
22977 else if (!NILP (mode_line_string_face
))
22979 Lisp_Object face
= Fplist_get (props
, Qface
);
22980 props
= Fcopy_sequence (props
);
22982 face
= mode_line_string_face
;
22984 face
= list2 (face
, mode_line_string_face
);
22985 props
= Fplist_put (props
, Qface
, face
);
22987 Fadd_text_properties (make_number (0), make_number (len
),
22988 props
, lisp_string
);
22992 len
= XFASTINT (Flength (lisp_string
));
22993 if (precision
> 0 && len
> precision
)
22996 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22999 if (!NILP (mode_line_string_face
))
23003 props
= Ftext_properties_at (make_number (0), lisp_string
);
23004 face
= Fplist_get (props
, Qface
);
23006 face
= mode_line_string_face
;
23008 face
= list2 (face
, mode_line_string_face
);
23009 props
= list2 (Qface
, face
);
23011 lisp_string
= Fcopy_sequence (lisp_string
);
23014 Fadd_text_properties (make_number (0), make_number (len
),
23015 props
, lisp_string
);
23020 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
23024 if (field_width
> len
)
23026 field_width
-= len
;
23027 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
23029 Fadd_text_properties (make_number (0), make_number (field_width
),
23030 props
, lisp_string
);
23031 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
23039 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
23041 doc
: /* Format a string out of a mode line format specification.
23042 First arg FORMAT specifies the mode line format (see `mode-line-format'
23043 for details) to use.
23045 By default, the format is evaluated for the currently selected window.
23047 Optional second arg FACE specifies the face property to put on all
23048 characters for which no face is specified. The value nil means the
23049 default face. The value t means whatever face the window's mode line
23050 currently uses (either `mode-line' or `mode-line-inactive',
23051 depending on whether the window is the selected window or not).
23052 An integer value means the value string has no text
23055 Optional third and fourth args WINDOW and BUFFER specify the window
23056 and buffer to use as the context for the formatting (defaults
23057 are the selected window and the WINDOW's buffer). */)
23058 (Lisp_Object format
, Lisp_Object face
,
23059 Lisp_Object window
, Lisp_Object buffer
)
23064 struct buffer
*old_buffer
= NULL
;
23066 bool no_props
= INTEGERP (face
);
23067 ptrdiff_t count
= SPECPDL_INDEX ();
23069 int string_start
= 0;
23071 w
= decode_any_window (window
);
23072 XSETWINDOW (window
, w
);
23075 buffer
= w
->contents
;
23076 CHECK_BUFFER (buffer
);
23078 /* Make formatting the modeline a non-op when noninteractive, otherwise
23079 there will be problems later caused by a partially initialized frame. */
23080 if (NILP (format
) || noninteractive
)
23081 return empty_unibyte_string
;
23086 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
23087 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
23088 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
23089 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
23090 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
23091 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
23092 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
23095 old_buffer
= current_buffer
;
23097 /* Save things including mode_line_proptrans_alist,
23098 and set that to nil so that we don't alter the outer value. */
23099 record_unwind_protect (unwind_format_mode_line
,
23100 format_mode_line_unwind_data
23101 (XFRAME (WINDOW_FRAME (w
)),
23102 old_buffer
, selected_window
, true));
23103 mode_line_proptrans_alist
= Qnil
;
23105 Fselect_window (window
, Qt
);
23106 set_buffer_internal_1 (XBUFFER (buffer
));
23108 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
23112 mode_line_target
= MODE_LINE_NOPROP
;
23113 mode_line_string_face_prop
= Qnil
;
23114 mode_line_string_list
= Qnil
;
23115 string_start
= MODE_LINE_NOPROP_LEN (0);
23119 mode_line_target
= MODE_LINE_STRING
;
23120 mode_line_string_list
= Qnil
;
23121 mode_line_string_face
= face
;
23122 mode_line_string_face_prop
23123 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
23126 push_kboard (FRAME_KBOARD (it
.f
));
23127 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
23132 len
= MODE_LINE_NOPROP_LEN (string_start
);
23133 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
23137 mode_line_string_list
= Fnreverse (mode_line_string_list
);
23138 str
= Fmapconcat (Qidentity
, mode_line_string_list
,
23139 empty_unibyte_string
);
23142 unbind_to (count
, Qnil
);
23146 /* Write a null-terminated, right justified decimal representation of
23147 the positive integer D to BUF using a minimal field width WIDTH. */
23150 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
23152 register char *p
= buf
;
23160 *p
++ = d
% 10 + '0';
23165 for (width
-= (int) (p
- buf
); width
> 0; --width
)
23176 /* Write a null-terminated, right justified decimal and "human
23177 readable" representation of the nonnegative integer D to BUF using
23178 a minimal field width WIDTH. D should be smaller than 999.5e24. */
23180 static const char power_letter
[] =
23194 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
23196 /* We aim to represent the nonnegative integer D as
23197 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
23198 ptrdiff_t quotient
= d
;
23200 /* -1 means: do not use TENTHS. */
23204 /* Length of QUOTIENT.TENTHS as a string. */
23210 if (quotient
>= 1000)
23212 /* Scale to the appropriate EXPONENT. */
23215 remainder
= quotient
% 1000;
23219 while (quotient
>= 1000);
23221 /* Round to nearest and decide whether to use TENTHS or not. */
23224 tenths
= remainder
/ 100;
23225 if (remainder
% 100 >= 50)
23232 if (quotient
== 10)
23240 if (remainder
>= 500)
23242 if (quotient
< 999)
23253 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
23254 if (tenths
== -1 && quotient
<= 99)
23261 p
= psuffix
= buf
+ max (width
, length
);
23263 /* Print EXPONENT. */
23264 *psuffix
++ = power_letter
[exponent
];
23267 /* Print TENTHS. */
23270 *--p
= '0' + tenths
;
23274 /* Print QUOTIENT. */
23277 int digit
= quotient
% 10;
23278 *--p
= '0' + digit
;
23280 while ((quotient
/= 10) != 0);
23282 /* Print leading spaces. */
23287 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
23288 If EOL_FLAG, set also a mnemonic character for end-of-line
23289 type of CODING_SYSTEM. Return updated pointer into BUF. */
23291 static unsigned char invalid_eol_type
[] = "(*invalid*)";
23294 decode_mode_spec_coding (Lisp_Object coding_system
, char *buf
, bool eol_flag
)
23297 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
23298 const unsigned char *eol_str
;
23300 /* The EOL conversion we are using. */
23301 Lisp_Object eoltype
;
23303 val
= CODING_SYSTEM_SPEC (coding_system
);
23306 if (!VECTORP (val
)) /* Not yet decided. */
23308 *buf
++ = multibyte
? '-' : ' ';
23310 eoltype
= eol_mnemonic_undecided
;
23311 /* Don't mention EOL conversion if it isn't decided. */
23316 Lisp_Object eolvalue
;
23318 attrs
= AREF (val
, 0);
23319 eolvalue
= AREF (val
, 2);
23322 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
23327 /* The EOL conversion that is normal on this system. */
23329 if (NILP (eolvalue
)) /* Not yet decided. */
23330 eoltype
= eol_mnemonic_undecided
;
23331 else if (VECTORP (eolvalue
)) /* Not yet decided. */
23332 eoltype
= eol_mnemonic_undecided
;
23333 else /* eolvalue is Qunix, Qdos, or Qmac. */
23334 eoltype
= (EQ (eolvalue
, Qunix
)
23335 ? eol_mnemonic_unix
23336 : EQ (eolvalue
, Qdos
)
23337 ? eol_mnemonic_dos
: eol_mnemonic_mac
);
23343 /* Mention the EOL conversion if it is not the usual one. */
23344 if (STRINGP (eoltype
))
23346 eol_str
= SDATA (eoltype
);
23347 eol_str_len
= SBYTES (eoltype
);
23349 else if (CHARACTERP (eoltype
))
23351 int c
= XFASTINT (eoltype
);
23352 return buf
+ CHAR_STRING (c
, (unsigned char *) buf
);
23356 eol_str
= invalid_eol_type
;
23357 eol_str_len
= sizeof (invalid_eol_type
) - 1;
23359 memcpy (buf
, eol_str
, eol_str_len
);
23360 buf
+= eol_str_len
;
23366 /* Return a string for the output of a mode line %-spec for window W,
23367 generated by character C. FIELD_WIDTH > 0 means pad the string
23368 returned with spaces to that value. Return a Lisp string in
23369 *STRING if the resulting string is taken from that Lisp string.
23371 Note we operate on the current buffer for most purposes. */
23373 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
23375 static const char *
23376 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
23377 Lisp_Object
*string
)
23380 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23381 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
23382 /* We are going to use f->decode_mode_spec_buffer as the buffer to
23383 produce strings from numerical values, so limit preposterously
23384 large values of FIELD_WIDTH to avoid overrunning the buffer's
23385 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
23386 bytes plus the terminating null. */
23387 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
23388 struct buffer
*b
= current_buffer
;
23396 if (!NILP (BVAR (b
, read_only
)))
23398 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23403 /* This differs from %* only for a modified read-only buffer. */
23404 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23406 if (!NILP (BVAR (b
, read_only
)))
23411 /* This differs from %* in ignoring read-only-ness. */
23412 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23424 if (command_loop_level
> 5)
23426 p
= decode_mode_spec_buf
;
23427 for (i
= 0; i
< command_loop_level
; i
++)
23430 return decode_mode_spec_buf
;
23438 if (command_loop_level
> 5)
23440 p
= decode_mode_spec_buf
;
23441 for (i
= 0; i
< command_loop_level
; i
++)
23444 return decode_mode_spec_buf
;
23451 /* Let lots_of_dashes be a string of infinite length. */
23452 if (mode_line_target
== MODE_LINE_NOPROP
23453 || mode_line_target
== MODE_LINE_STRING
)
23455 if (field_width
<= 0
23456 || field_width
> sizeof (lots_of_dashes
))
23458 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
23459 decode_mode_spec_buf
[i
] = '-';
23460 decode_mode_spec_buf
[i
] = '\0';
23461 return decode_mode_spec_buf
;
23464 return lots_of_dashes
;
23468 obj
= BVAR (b
, name
);
23472 /* %c and %l are ignored in `frame-title-format'.
23473 (In redisplay_internal, the frame title is drawn _before_ the
23474 windows are updated, so the stuff which depends on actual
23475 window contents (such as %l) may fail to render properly, or
23476 even crash emacs.) */
23477 if (mode_line_target
== MODE_LINE_TITLE
)
23481 ptrdiff_t col
= current_column ();
23482 w
->column_number_displayed
= col
;
23483 pint2str (decode_mode_spec_buf
, width
, col
);
23484 return decode_mode_spec_buf
;
23488 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
23490 if (NILP (Vmemory_full
))
23493 return "!MEM FULL! ";
23500 /* %F displays the frame name. */
23501 if (!NILP (f
->title
))
23502 return SSDATA (f
->title
);
23503 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
23504 return SSDATA (f
->name
);
23508 obj
= BVAR (b
, filename
);
23513 ptrdiff_t size
= ZV
- BEGV
;
23514 pint2str (decode_mode_spec_buf
, width
, size
);
23515 return decode_mode_spec_buf
;
23520 ptrdiff_t size
= ZV
- BEGV
;
23521 pint2hrstr (decode_mode_spec_buf
, width
, size
);
23522 return decode_mode_spec_buf
;
23527 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
23528 ptrdiff_t topline
, nlines
, height
;
23531 /* %c and %l are ignored in `frame-title-format'. */
23532 if (mode_line_target
== MODE_LINE_TITLE
)
23535 startpos
= marker_position (w
->start
);
23536 startpos_byte
= marker_byte_position (w
->start
);
23537 height
= WINDOW_TOTAL_LINES (w
);
23539 /* If we decided that this buffer isn't suitable for line numbers,
23540 don't forget that too fast. */
23541 if (w
->base_line_pos
== -1)
23544 /* If the buffer is very big, don't waste time. */
23545 if (INTEGERP (Vline_number_display_limit
)
23546 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
23548 w
->base_line_pos
= 0;
23549 w
->base_line_number
= 0;
23553 if (w
->base_line_number
> 0
23554 && w
->base_line_pos
> 0
23555 && w
->base_line_pos
<= startpos
)
23557 line
= w
->base_line_number
;
23558 linepos
= w
->base_line_pos
;
23559 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
23564 linepos
= BUF_BEGV (b
);
23565 linepos_byte
= BUF_BEGV_BYTE (b
);
23568 /* Count lines from base line to window start position. */
23569 nlines
= display_count_lines (linepos_byte
,
23573 topline
= nlines
+ line
;
23575 /* Determine a new base line, if the old one is too close
23576 or too far away, or if we did not have one.
23577 "Too close" means it's plausible a scroll-down would
23578 go back past it. */
23579 if (startpos
== BUF_BEGV (b
))
23581 w
->base_line_number
= topline
;
23582 w
->base_line_pos
= BUF_BEGV (b
);
23584 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
23585 || linepos
== BUF_BEGV (b
))
23587 ptrdiff_t limit
= BUF_BEGV (b
);
23588 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
23589 ptrdiff_t position
;
23590 ptrdiff_t distance
=
23591 (height
* 2 + 30) * line_number_display_limit_width
;
23593 if (startpos
- distance
> limit
)
23595 limit
= startpos
- distance
;
23596 limit_byte
= CHAR_TO_BYTE (limit
);
23599 nlines
= display_count_lines (startpos_byte
,
23601 - (height
* 2 + 30),
23603 /* If we couldn't find the lines we wanted within
23604 line_number_display_limit_width chars per line,
23605 give up on line numbers for this window. */
23606 if (position
== limit_byte
&& limit
== startpos
- distance
)
23608 w
->base_line_pos
= -1;
23609 w
->base_line_number
= 0;
23613 w
->base_line_number
= topline
- nlines
;
23614 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23617 /* Now count lines from the start pos to point. */
23618 nlines
= display_count_lines (startpos_byte
,
23619 PT_BYTE
, PT
, &junk
);
23621 /* Record that we did display the line number. */
23622 line_number_displayed
= true;
23624 /* Make the string to show. */
23625 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23626 return decode_mode_spec_buf
;
23629 char *p
= decode_mode_spec_buf
;
23630 int pad
= width
- 2;
23636 return decode_mode_spec_buf
;
23642 obj
= BVAR (b
, mode_name
);
23646 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23652 ptrdiff_t pos
= marker_position (w
->start
);
23653 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23655 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23657 if (pos
<= BUF_BEGV (b
))
23662 else if (pos
<= BUF_BEGV (b
))
23666 if (total
> 1000000)
23667 /* Do it differently for a large value, to avoid overflow. */
23668 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23670 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23671 /* We can't normally display a 3-digit number,
23672 so get us a 2-digit number that is close. */
23675 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23676 return decode_mode_spec_buf
;
23680 /* Display percentage of size above the bottom of the screen. */
23683 ptrdiff_t toppos
= marker_position (w
->start
);
23684 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23685 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23687 if (botpos
>= BUF_ZV (b
))
23689 if (toppos
<= BUF_BEGV (b
))
23696 if (total
> 1000000)
23697 /* Do it differently for a large value, to avoid overflow. */
23698 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23700 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23701 /* We can't normally display a 3-digit number,
23702 so get us a 2-digit number that is close. */
23705 if (toppos
<= BUF_BEGV (b
))
23706 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23708 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23709 return decode_mode_spec_buf
;
23714 /* status of process */
23715 obj
= Fget_buffer_process (Fcurrent_buffer ());
23717 return "no process";
23719 obj
= Fsymbol_name (Fprocess_status (obj
));
23725 ptrdiff_t count
= inhibit_garbage_collection ();
23726 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23727 Lisp_Object val
= Qnil
;
23729 if (STRINGP (curdir
))
23730 val
= call1 (intern ("file-remote-p"), curdir
);
23732 unbind_to (count
, Qnil
);
23741 /* coding-system (not including end-of-line format) */
23743 /* coding-system (including end-of-line type) */
23745 bool eol_flag
= (c
== 'Z');
23746 char *p
= decode_mode_spec_buf
;
23748 if (! FRAME_WINDOW_P (f
))
23750 /* No need to mention EOL here--the terminal never needs
23751 to do EOL conversion. */
23752 p
= decode_mode_spec_coding (CODING_ID_NAME
23753 (FRAME_KEYBOARD_CODING (f
)->id
),
23755 p
= decode_mode_spec_coding (CODING_ID_NAME
23756 (FRAME_TERMINAL_CODING (f
)->id
),
23759 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23762 #if false /* This proves to be annoying; I think we can do without. -- rms. */
23763 #ifdef subprocesses
23764 obj
= Fget_buffer_process (Fcurrent_buffer ());
23765 if (PROCESSP (obj
))
23767 p
= decode_mode_spec_coding
23768 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23769 p
= decode_mode_spec_coding
23770 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23772 #endif /* subprocesses */
23775 return decode_mode_spec_buf
;
23782 return SSDATA (obj
);
23789 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23790 means count lines back from START_BYTE. But don't go beyond
23791 LIMIT_BYTE. Return the number of lines thus found (always
23794 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23795 either the position COUNT lines after/before START_BYTE, if we
23796 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23800 display_count_lines (ptrdiff_t start_byte
,
23801 ptrdiff_t limit_byte
, ptrdiff_t count
,
23802 ptrdiff_t *byte_pos_ptr
)
23804 register unsigned char *cursor
;
23805 unsigned char *base
;
23807 register ptrdiff_t ceiling
;
23808 register unsigned char *ceiling_addr
;
23809 ptrdiff_t orig_count
= count
;
23811 /* If we are not in selective display mode,
23812 check only for newlines. */
23813 bool selective_display
23814 = (!NILP (BVAR (current_buffer
, selective_display
))
23815 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23819 while (start_byte
< limit_byte
)
23821 ceiling
= BUFFER_CEILING_OF (start_byte
);
23822 ceiling
= min (limit_byte
- 1, ceiling
);
23823 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23824 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23828 if (selective_display
)
23830 while (*cursor
!= '\n' && *cursor
!= 015
23831 && ++cursor
!= ceiling_addr
)
23833 if (cursor
== ceiling_addr
)
23838 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23847 start_byte
+= cursor
- base
;
23848 *byte_pos_ptr
= start_byte
;
23852 while (cursor
< ceiling_addr
);
23854 start_byte
+= ceiling_addr
- base
;
23859 while (start_byte
> limit_byte
)
23861 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23862 ceiling
= max (limit_byte
, ceiling
);
23863 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23864 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23867 if (selective_display
)
23869 while (--cursor
>= ceiling_addr
23870 && *cursor
!= '\n' && *cursor
!= 015)
23872 if (cursor
< ceiling_addr
)
23877 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23884 start_byte
+= cursor
- base
+ 1;
23885 *byte_pos_ptr
= start_byte
;
23886 /* When scanning backwards, we should
23887 not count the newline posterior to which we stop. */
23888 return - orig_count
- 1;
23891 start_byte
+= ceiling_addr
- base
;
23895 *byte_pos_ptr
= limit_byte
;
23898 return - orig_count
+ count
;
23899 return orig_count
- count
;
23905 /***********************************************************************
23907 ***********************************************************************/
23909 /* Display a NUL-terminated string, starting with index START.
23911 If STRING is non-null, display that C string. Otherwise, the Lisp
23912 string LISP_STRING is displayed. There's a case that STRING is
23913 non-null and LISP_STRING is not nil. It means STRING is a string
23914 data of LISP_STRING. In that case, we display LISP_STRING while
23915 ignoring its text properties.
23917 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23918 FACE_STRING. Display STRING or LISP_STRING with the face at
23919 FACE_STRING_POS in FACE_STRING:
23921 Display the string in the environment given by IT, but use the
23922 standard display table, temporarily.
23924 FIELD_WIDTH is the minimum number of output glyphs to produce.
23925 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23926 with spaces. If STRING has more characters, more than FIELD_WIDTH
23927 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23929 PRECISION is the maximum number of characters to output from
23930 STRING. PRECISION < 0 means don't truncate the string.
23932 This is roughly equivalent to printf format specifiers:
23934 FIELD_WIDTH PRECISION PRINTF
23935 ----------------------------------------
23941 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23942 display them, and < 0 means obey the current buffer's value of
23943 enable_multibyte_characters.
23945 Value is the number of columns displayed. */
23948 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23949 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23950 int field_width
, int precision
, int max_x
, int multibyte
)
23952 int hpos_at_start
= it
->hpos
;
23953 int saved_face_id
= it
->face_id
;
23954 struct glyph_row
*row
= it
->glyph_row
;
23955 ptrdiff_t it_charpos
;
23957 /* Initialize the iterator IT for iteration over STRING beginning
23958 with index START. */
23959 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23960 precision
, field_width
, multibyte
);
23961 if (string
&& STRINGP (lisp_string
))
23962 /* LISP_STRING is the one returned by decode_mode_spec. We should
23963 ignore its text properties. */
23964 it
->stop_charpos
= it
->end_charpos
;
23966 /* If displaying STRING, set up the face of the iterator from
23967 FACE_STRING, if that's given. */
23968 if (STRINGP (face_string
))
23974 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23975 0, &endptr
, it
->base_face_id
, false);
23976 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23977 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23980 /* Set max_x to the maximum allowed X position. Don't let it go
23981 beyond the right edge of the window. */
23983 max_x
= it
->last_visible_x
;
23985 max_x
= min (max_x
, it
->last_visible_x
);
23987 /* Skip over display elements that are not visible. because IT->w is
23989 if (it
->current_x
< it
->first_visible_x
)
23990 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23991 MOVE_TO_POS
| MOVE_TO_X
);
23993 row
->ascent
= it
->max_ascent
;
23994 row
->height
= it
->max_ascent
+ it
->max_descent
;
23995 row
->phys_ascent
= it
->max_phys_ascent
;
23996 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23997 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23999 if (STRINGP (it
->string
))
24000 it_charpos
= IT_STRING_CHARPOS (*it
);
24002 it_charpos
= IT_CHARPOS (*it
);
24004 /* This condition is for the case that we are called with current_x
24005 past last_visible_x. */
24006 while (it
->current_x
< max_x
)
24008 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
24010 /* Get the next display element. */
24011 if (!get_next_display_element (it
))
24014 /* Produce glyphs. */
24015 x_before
= it
->current_x
;
24016 n_glyphs_before
= row
->used
[TEXT_AREA
];
24017 PRODUCE_GLYPHS (it
);
24019 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
24022 while (i
< nglyphs
)
24024 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
24026 if (it
->line_wrap
!= TRUNCATE
24027 && x
+ glyph
->pixel_width
> max_x
)
24029 /* End of continued line or max_x reached. */
24030 if (CHAR_GLYPH_PADDING_P (*glyph
))
24032 /* A wide character is unbreakable. */
24033 if (row
->reversed_p
)
24034 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
24035 - n_glyphs_before
);
24036 row
->used
[TEXT_AREA
] = n_glyphs_before
;
24037 it
->current_x
= x_before
;
24041 if (row
->reversed_p
)
24042 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
24043 - (n_glyphs_before
+ i
));
24044 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
24049 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
24051 /* Glyph is at least partially visible. */
24053 if (x
< it
->first_visible_x
)
24054 row
->x
= x
- it
->first_visible_x
;
24058 /* Glyph is off the left margin of the display area.
24059 Should not happen. */
24063 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
24064 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
24065 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
24066 row
->phys_height
= max (row
->phys_height
,
24067 it
->max_phys_ascent
+ it
->max_phys_descent
);
24068 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
24069 it
->max_extra_line_spacing
);
24070 x
+= glyph
->pixel_width
;
24074 /* Stop if max_x reached. */
24078 /* Stop at line ends. */
24079 if (ITERATOR_AT_END_OF_LINE_P (it
))
24081 it
->continuation_lines_width
= 0;
24085 set_iterator_to_next (it
, true);
24086 if (STRINGP (it
->string
))
24087 it_charpos
= IT_STRING_CHARPOS (*it
);
24089 it_charpos
= IT_CHARPOS (*it
);
24091 /* Stop if truncating at the right edge. */
24092 if (it
->line_wrap
== TRUNCATE
24093 && it
->current_x
>= it
->last_visible_x
)
24095 /* Add truncation mark, but don't do it if the line is
24096 truncated at a padding space. */
24097 if (it_charpos
< it
->string_nchars
)
24099 if (!FRAME_WINDOW_P (it
->f
))
24103 if (it
->current_x
> it
->last_visible_x
)
24105 if (!row
->reversed_p
)
24107 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
24108 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
24113 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
24114 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
24116 unproduce_glyphs (it
, ii
+ 1);
24117 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
24119 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
24121 row
->used
[TEXT_AREA
] = ii
;
24122 produce_special_glyphs (it
, IT_TRUNCATION
);
24125 produce_special_glyphs (it
, IT_TRUNCATION
);
24127 row
->truncated_on_right_p
= true;
24133 /* Maybe insert a truncation at the left. */
24134 if (it
->first_visible_x
24137 if (!FRAME_WINDOW_P (it
->f
)
24138 || (row
->reversed_p
24139 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24140 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
24141 insert_left_trunc_glyphs (it
);
24142 row
->truncated_on_left_p
= true;
24145 it
->face_id
= saved_face_id
;
24147 /* Value is number of columns displayed. */
24148 return it
->hpos
- hpos_at_start
;
24153 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
24154 appears as an element of LIST or as the car of an element of LIST.
24155 If PROPVAL is a list, compare each element against LIST in that
24156 way, and return 1/2 if any element of PROPVAL is found in LIST.
24157 Otherwise return 0. This function cannot quit.
24158 The return value is 2 if the text is invisible but with an ellipsis
24159 and 1 if it's invisible and without an ellipsis. */
24162 invisible_prop (Lisp_Object propval
, Lisp_Object list
)
24164 Lisp_Object tail
, proptail
;
24166 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
24168 register Lisp_Object tem
;
24170 if (EQ (propval
, tem
))
24172 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
24173 return NILP (XCDR (tem
)) ? 1 : 2;
24176 if (CONSP (propval
))
24178 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
24180 Lisp_Object propelt
;
24181 propelt
= XCAR (proptail
);
24182 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
24184 register Lisp_Object tem
;
24186 if (EQ (propelt
, tem
))
24188 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
24189 return NILP (XCDR (tem
)) ? 1 : 2;
24197 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
24198 doc
: /* Non-nil if the property makes the text invisible.
24199 POS-OR-PROP can be a marker or number, in which case it is taken to be
24200 a position in the current buffer and the value of the `invisible' property
24201 is checked; or it can be some other value, which is then presumed to be the
24202 value of the `invisible' property of the text of interest.
24203 The non-nil value returned can be t for truly invisible text or something
24204 else if the text is replaced by an ellipsis. */)
24205 (Lisp_Object pos_or_prop
)
24208 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
24209 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
24211 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
24212 return (invis
== 0 ? Qnil
24214 : make_number (invis
));
24217 /* Calculate a width or height in pixels from a specification using
24218 the following elements:
24221 NUM - a (fractional) multiple of the default font width/height
24222 (NUM) - specifies exactly NUM pixels
24223 UNIT - a fixed number of pixels, see below.
24224 ELEMENT - size of a display element in pixels, see below.
24225 (NUM . SPEC) - equals NUM * SPEC
24226 (+ SPEC SPEC ...) - add pixel values
24227 (- SPEC SPEC ...) - subtract pixel values
24228 (- SPEC) - negate pixel value
24231 INT or FLOAT - a number constant
24232 SYMBOL - use symbol's (buffer local) variable binding.
24235 in - pixels per inch *)
24236 mm - pixels per 1/1000 meter *)
24237 cm - pixels per 1/100 meter *)
24238 width - width of current font in pixels.
24239 height - height of current font in pixels.
24241 *) using the ratio(s) defined in display-pixels-per-inch.
24245 left-fringe - left fringe width in pixels
24246 right-fringe - right fringe width in pixels
24248 left-margin - left margin width in pixels
24249 right-margin - right margin width in pixels
24251 scroll-bar - scroll-bar area width in pixels
24255 Pixels corresponding to 5 inches:
24258 Total width of non-text areas on left side of window (if scroll-bar is on left):
24259 '(space :width (+ left-fringe left-margin scroll-bar))
24261 Align to first text column (in header line):
24262 '(space :align-to 0)
24264 Align to middle of text area minus half the width of variable `my-image'
24265 containing a loaded image:
24266 '(space :align-to (0.5 . (- text my-image)))
24268 Width of left margin minus width of 1 character in the default font:
24269 '(space :width (- left-margin 1))
24271 Width of left margin minus width of 2 characters in the current font:
24272 '(space :width (- left-margin (2 . width)))
24274 Center 1 character over left-margin (in header line):
24275 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
24277 Different ways to express width of left fringe plus left margin minus one pixel:
24278 '(space :width (- (+ left-fringe left-margin) (1)))
24279 '(space :width (+ left-fringe left-margin (- (1))))
24280 '(space :width (+ left-fringe left-margin (-1)))
24285 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
24286 struct font
*font
, bool width_p
, int *align_to
)
24290 # define OK_PIXELS(val) (*res = (val), true)
24291 # define OK_ALIGN_TO(val) (*align_to = (val), true)
24294 return OK_PIXELS (0);
24296 eassert (FRAME_LIVE_P (it
->f
));
24298 if (SYMBOLP (prop
))
24300 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
24302 char *unit
= SSDATA (SYMBOL_NAME (prop
));
24304 if (unit
[0] == 'i' && unit
[1] == 'n')
24306 else if (unit
[0] == 'm' && unit
[1] == 'm')
24308 else if (unit
[0] == 'c' && unit
[1] == 'm')
24314 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
24315 : FRAME_RES_Y (it
->f
));
24318 return OK_PIXELS (ppi
/ pixels
);
24323 #ifdef HAVE_WINDOW_SYSTEM
24324 if (EQ (prop
, Qheight
))
24325 return OK_PIXELS (font
24326 ? normal_char_height (font
, -1)
24327 : FRAME_LINE_HEIGHT (it
->f
));
24328 if (EQ (prop
, Qwidth
))
24329 return OK_PIXELS (font
24330 ? FONT_WIDTH (font
)
24331 : FRAME_COLUMN_WIDTH (it
->f
));
24333 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
24334 return OK_PIXELS (1);
24337 if (EQ (prop
, Qtext
))
24338 return OK_PIXELS (width_p
24339 ? window_box_width (it
->w
, TEXT_AREA
)
24340 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
24342 if (align_to
&& *align_to
< 0)
24345 if (EQ (prop
, Qleft
))
24346 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
24347 if (EQ (prop
, Qright
))
24348 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
24349 if (EQ (prop
, Qcenter
))
24350 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
24351 + window_box_width (it
->w
, TEXT_AREA
) / 2);
24352 if (EQ (prop
, Qleft_fringe
))
24353 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24354 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
24355 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
24356 if (EQ (prop
, Qright_fringe
))
24357 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24358 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24359 : window_box_right_offset (it
->w
, TEXT_AREA
));
24360 if (EQ (prop
, Qleft_margin
))
24361 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
24362 if (EQ (prop
, Qright_margin
))
24363 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
24364 if (EQ (prop
, Qscroll_bar
))
24365 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
24367 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24368 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24369 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24374 if (EQ (prop
, Qleft_fringe
))
24375 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
24376 if (EQ (prop
, Qright_fringe
))
24377 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
24378 if (EQ (prop
, Qleft_margin
))
24379 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
24380 if (EQ (prop
, Qright_margin
))
24381 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
24382 if (EQ (prop
, Qscroll_bar
))
24383 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
24386 prop
= buffer_local_value (prop
, it
->w
->contents
);
24387 if (EQ (prop
, Qunbound
))
24391 if (NUMBERP (prop
))
24393 int base_unit
= (width_p
24394 ? FRAME_COLUMN_WIDTH (it
->f
)
24395 : FRAME_LINE_HEIGHT (it
->f
));
24396 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
24401 Lisp_Object car
= XCAR (prop
);
24402 Lisp_Object cdr
= XCDR (prop
);
24406 #ifdef HAVE_WINDOW_SYSTEM
24407 if (FRAME_WINDOW_P (it
->f
)
24408 && valid_image_p (prop
))
24410 ptrdiff_t id
= lookup_image (it
->f
, prop
);
24411 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
24413 return OK_PIXELS (width_p
? img
->width
: img
->height
);
24415 if (FRAME_WINDOW_P (it
->f
) && valid_xwidget_spec_p (prop
))
24417 // TODO: Don't return dummy size.
24418 return OK_PIXELS (100);
24421 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
24427 while (CONSP (cdr
))
24429 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
24430 font
, width_p
, align_to
))
24433 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= false;
24438 if (EQ (car
, Qminus
))
24440 return OK_PIXELS (pixels
);
24443 car
= buffer_local_value (car
, it
->w
->contents
);
24444 if (EQ (car
, Qunbound
))
24451 pixels
= XFLOATINT (car
);
24453 return OK_PIXELS (pixels
);
24454 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
24455 font
, width_p
, align_to
))
24456 return OK_PIXELS (pixels
* fact
);
24467 get_font_ascent_descent (struct font
*font
, int *ascent
, int *descent
)
24469 #ifdef HAVE_WINDOW_SYSTEM
24470 normal_char_ascent_descent (font
, -1, ascent
, descent
);
24478 /***********************************************************************
24480 ***********************************************************************/
24482 #ifdef HAVE_WINDOW_SYSTEM
24487 dump_glyph_string (struct glyph_string
*s
)
24489 fprintf (stderr
, "glyph string\n");
24490 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
24491 s
->x
, s
->y
, s
->width
, s
->height
);
24492 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
24493 fprintf (stderr
, " hl = %d\n", s
->hl
);
24494 fprintf (stderr
, " left overhang = %d, right = %d\n",
24495 s
->left_overhang
, s
->right_overhang
);
24496 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
24497 fprintf (stderr
, " extends to end of line = %d\n",
24498 s
->extends_to_end_of_line_p
);
24499 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
24500 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
24503 #endif /* GLYPH_DEBUG */
24505 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
24506 of XChar2b structures for S; it can't be allocated in
24507 init_glyph_string because it must be allocated via `alloca'. W
24508 is the window on which S is drawn. ROW and AREA are the glyph row
24509 and area within the row from which S is constructed. START is the
24510 index of the first glyph structure covered by S. HL is a
24511 face-override for drawing S. */
24514 #define OPTIONAL_HDC(hdc) HDC hdc,
24515 #define DECLARE_HDC(hdc) HDC hdc;
24516 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
24517 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
24520 #ifndef OPTIONAL_HDC
24521 #define OPTIONAL_HDC(hdc)
24522 #define DECLARE_HDC(hdc)
24523 #define ALLOCATE_HDC(hdc, f)
24524 #define RELEASE_HDC(hdc, f)
24528 init_glyph_string (struct glyph_string
*s
,
24530 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
24531 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
24533 memset (s
, 0, sizeof *s
);
24535 s
->f
= XFRAME (w
->frame
);
24539 s
->display
= FRAME_X_DISPLAY (s
->f
);
24540 s
->window
= FRAME_X_WINDOW (s
->f
);
24541 s
->char2b
= char2b
;
24545 s
->first_glyph
= row
->glyphs
[area
] + start
;
24546 s
->height
= row
->height
;
24547 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
24548 s
->ybase
= s
->y
+ row
->ascent
;
24552 /* Append the list of glyph strings with head H and tail T to the list
24553 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
24556 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24557 struct glyph_string
*h
, struct glyph_string
*t
)
24571 /* Prepend the list of glyph strings with head H and tail T to the
24572 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
24576 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24577 struct glyph_string
*h
, struct glyph_string
*t
)
24591 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
24592 Set *HEAD and *TAIL to the resulting list. */
24595 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
24596 struct glyph_string
*s
)
24598 s
->next
= s
->prev
= NULL
;
24599 append_glyph_string_lists (head
, tail
, s
, s
);
24603 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24604 The encoding of C is returned in *CHAR2B. DISPLAY_P means
24605 make sure that X resources for the face returned are allocated.
24606 Value is a pointer to a realized face that is ready for display if
24609 static struct face
*
24610 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
24611 XChar2b
*char2b
, bool display_p
)
24613 struct face
*face
= FACE_FROM_ID (f
, face_id
);
24618 code
= face
->font
->driver
->encode_char (face
->font
, c
);
24620 if (code
== FONT_INVALID_CODE
)
24623 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24625 /* Make sure X resources of the face are allocated. */
24626 #ifdef HAVE_X_WINDOWS
24630 eassert (face
!= NULL
);
24631 prepare_face_for_display (f
, face
);
24638 /* Get face and two-byte form of character glyph GLYPH on frame F.
24639 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24640 a pointer to a realized face that is ready for display. */
24642 static struct face
*
24643 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24649 eassert (glyph
->type
== CHAR_GLYPH
);
24650 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24652 /* Make sure X resources of the face are allocated. */
24653 prepare_face_for_display (f
, face
);
24657 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24658 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24660 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24662 if (code
== FONT_INVALID_CODE
)
24666 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24671 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24672 Return true iff FONT has a glyph for C. */
24675 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24679 if (CHAR_BYTE8_P (c
))
24680 code
= CHAR_TO_BYTE8 (c
);
24682 code
= font
->driver
->encode_char (font
, c
);
24684 if (code
== FONT_INVALID_CODE
)
24686 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24691 /* Fill glyph string S with composition components specified by S->cmp.
24693 BASE_FACE is the base face of the composition.
24694 S->cmp_from is the index of the first component for S.
24696 OVERLAPS non-zero means S should draw the foreground only, and use
24697 its physical height for clipping. See also draw_glyphs.
24699 Value is the index of a component not in S. */
24702 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24706 /* For all glyphs of this composition, starting at the offset
24707 S->cmp_from, until we reach the end of the definition or encounter a
24708 glyph that requires the different face, add it to S. */
24713 s
->for_overlaps
= overlaps
;
24716 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24718 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24720 /* TAB in a composition means display glyphs with padding space
24721 on the left or right. */
24724 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24727 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24728 s
->char2b
+ i
, true);
24734 s
->font
= s
->face
->font
;
24736 else if (s
->face
!= face
)
24744 if (s
->face
== NULL
)
24746 s
->face
= base_face
->ascii_face
;
24747 s
->font
= s
->face
->font
;
24750 /* All glyph strings for the same composition has the same width,
24751 i.e. the width set for the first component of the composition. */
24752 s
->width
= s
->first_glyph
->pixel_width
;
24754 /* If the specified font could not be loaded, use the frame's
24755 default font, but record the fact that we couldn't load it in
24756 the glyph string so that we can draw rectangles for the
24757 characters of the glyph string. */
24758 if (s
->font
== NULL
)
24760 s
->font_not_found_p
= true;
24761 s
->font
= FRAME_FONT (s
->f
);
24764 /* Adjust base line for subscript/superscript text. */
24765 s
->ybase
+= s
->first_glyph
->voffset
;
24771 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24772 int start
, int end
, int overlaps
)
24774 struct glyph
*glyph
, *last
;
24775 Lisp_Object lgstring
;
24778 s
->for_overlaps
= overlaps
;
24779 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24780 last
= s
->row
->glyphs
[s
->area
] + end
;
24781 s
->cmp_id
= glyph
->u
.cmp
.id
;
24782 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24783 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24784 s
->face
= FACE_OPT_FROM_ID (s
->f
, face_id
);
24785 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24786 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24788 while (glyph
< last
24789 && glyph
->u
.cmp
.automatic
24790 && glyph
->u
.cmp
.id
== s
->cmp_id
24791 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24792 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24794 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24796 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24797 unsigned code
= LGLYPH_CODE (lglyph
);
24799 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24801 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24802 return glyph
- s
->row
->glyphs
[s
->area
];
24806 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24807 See the comment of fill_glyph_string for arguments.
24808 Value is the index of the first glyph not in S. */
24812 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24813 int start
, int end
, int overlaps
)
24815 struct glyph
*glyph
, *last
;
24818 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24819 s
->for_overlaps
= overlaps
;
24820 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24821 last
= s
->row
->glyphs
[s
->area
] + end
;
24822 voffset
= glyph
->voffset
;
24823 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24824 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24826 s
->width
= glyph
->pixel_width
;
24828 while (glyph
< last
24829 && glyph
->type
== GLYPHLESS_GLYPH
24830 && glyph
->voffset
== voffset
24831 && glyph
->face_id
== face_id
)
24834 s
->width
+= glyph
->pixel_width
;
24837 s
->ybase
+= voffset
;
24838 return glyph
- s
->row
->glyphs
[s
->area
];
24842 /* Fill glyph string S from a sequence of character glyphs.
24844 FACE_ID is the face id of the string. START is the index of the
24845 first glyph to consider, END is the index of the last + 1.
24846 OVERLAPS non-zero means S should draw the foreground only, and use
24847 its physical height for clipping. See also draw_glyphs.
24849 Value is the index of the first glyph not in S. */
24852 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24853 int start
, int end
, int overlaps
)
24855 struct glyph
*glyph
, *last
;
24857 bool glyph_not_available_p
;
24859 eassert (s
->f
== XFRAME (s
->w
->frame
));
24860 eassert (s
->nchars
== 0);
24861 eassert (start
>= 0 && end
> start
);
24863 s
->for_overlaps
= overlaps
;
24864 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24865 last
= s
->row
->glyphs
[s
->area
] + end
;
24866 voffset
= glyph
->voffset
;
24867 s
->padding_p
= glyph
->padding_p
;
24868 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24870 while (glyph
< last
24871 && glyph
->type
== CHAR_GLYPH
24872 && glyph
->voffset
== voffset
24873 /* Same face id implies same font, nowadays. */
24874 && glyph
->face_id
== face_id
24875 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24877 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24878 s
->char2b
+ s
->nchars
);
24880 eassert (s
->nchars
<= end
- start
);
24881 s
->width
+= glyph
->pixel_width
;
24882 if (glyph
++->padding_p
!= s
->padding_p
)
24886 s
->font
= s
->face
->font
;
24888 /* If the specified font could not be loaded, use the frame's font,
24889 but record the fact that we couldn't load it in
24890 S->font_not_found_p so that we can draw rectangles for the
24891 characters of the glyph string. */
24892 if (s
->font
== NULL
|| glyph_not_available_p
)
24894 s
->font_not_found_p
= true;
24895 s
->font
= FRAME_FONT (s
->f
);
24898 /* Adjust base line for subscript/superscript text. */
24899 s
->ybase
+= voffset
;
24901 eassert (s
->face
&& s
->face
->gc
);
24902 return glyph
- s
->row
->glyphs
[s
->area
];
24906 /* Fill glyph string S from image glyph S->first_glyph. */
24909 fill_image_glyph_string (struct glyph_string
*s
)
24911 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24912 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24914 s
->slice
= s
->first_glyph
->slice
.img
;
24915 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24916 s
->font
= s
->face
->font
;
24917 s
->width
= s
->first_glyph
->pixel_width
;
24919 /* Adjust base line for subscript/superscript text. */
24920 s
->ybase
+= s
->first_glyph
->voffset
;
24924 #ifdef HAVE_XWIDGETS
24926 fill_xwidget_glyph_string (struct glyph_string
*s
)
24928 eassert (s
->first_glyph
->type
== XWIDGET_GLYPH
);
24929 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24930 s
->font
= s
->face
->font
;
24931 s
->width
= s
->first_glyph
->pixel_width
;
24932 s
->ybase
+= s
->first_glyph
->voffset
;
24933 s
->xwidget
= s
->first_glyph
->u
.xwidget
;
24936 /* Fill glyph string S from a sequence of stretch glyphs.
24938 START is the index of the first glyph to consider,
24939 END is the index of the last + 1.
24941 Value is the index of the first glyph not in S. */
24944 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24946 struct glyph
*glyph
, *last
;
24947 int voffset
, face_id
;
24949 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24951 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24952 last
= s
->row
->glyphs
[s
->area
] + end
;
24953 face_id
= glyph
->face_id
;
24954 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24955 s
->font
= s
->face
->font
;
24956 s
->width
= glyph
->pixel_width
;
24958 voffset
= glyph
->voffset
;
24962 && glyph
->type
== STRETCH_GLYPH
24963 && glyph
->voffset
== voffset
24964 && glyph
->face_id
== face_id
);
24966 s
->width
+= glyph
->pixel_width
;
24968 /* Adjust base line for subscript/superscript text. */
24969 s
->ybase
+= voffset
;
24971 /* The case that face->gc == 0 is handled when drawing the glyph
24972 string by calling prepare_face_for_display. */
24974 return glyph
- s
->row
->glyphs
[s
->area
];
24977 static struct font_metrics
*
24978 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24980 static struct font_metrics metrics
;
24985 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24986 if (code
== FONT_INVALID_CODE
)
24988 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24992 /* A subroutine that computes "normal" values of ASCENT and DESCENT
24993 for FONT. Values are taken from font-global ones, except for fonts
24994 that claim preposterously large values, but whose glyphs actually
24995 have reasonable dimensions. C is the character to use for metrics
24996 if the font-global values are too large; if C is negative, the
24997 function selects a default character. */
24999 normal_char_ascent_descent (struct font
*font
, int c
, int *ascent
, int *descent
)
25001 *ascent
= FONT_BASE (font
);
25002 *descent
= FONT_DESCENT (font
);
25004 if (FONT_TOO_HIGH (font
))
25008 /* Get metrics of C, defaulting to a reasonably sized ASCII
25010 if (get_char_glyph_code (c
>= 0 ? c
: '{', font
, &char2b
))
25012 struct font_metrics
*pcm
= get_per_char_metric (font
, &char2b
);
25014 if (!(pcm
->width
== 0 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0))
25016 /* We add 1 pixel to character dimensions as heuristics
25017 that produces nicer display, e.g. when the face has
25018 the box attribute. */
25019 *ascent
= pcm
->ascent
+ 1;
25020 *descent
= pcm
->descent
+ 1;
25026 /* A subroutine that computes a reasonable "normal character height"
25027 for fonts that claim preposterously large vertical dimensions, but
25028 whose glyphs are actually reasonably sized. C is the character
25029 whose metrics to use for those fonts, or -1 for default
25032 normal_char_height (struct font
*font
, int c
)
25034 int ascent
, descent
;
25036 normal_char_ascent_descent (font
, c
, &ascent
, &descent
);
25038 return ascent
+ descent
;
25042 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
25043 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
25044 assumed to be zero. */
25047 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
25049 *left
= *right
= 0;
25051 if (glyph
->type
== CHAR_GLYPH
)
25054 struct face
*face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
);
25057 struct font_metrics
*pcm
= get_per_char_metric (face
->font
, &char2b
);
25060 if (pcm
->rbearing
> pcm
->width
)
25061 *right
= pcm
->rbearing
- pcm
->width
;
25062 if (pcm
->lbearing
< 0)
25063 *left
= -pcm
->lbearing
;
25067 else if (glyph
->type
== COMPOSITE_GLYPH
)
25069 if (! glyph
->u
.cmp
.automatic
)
25071 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
25073 if (cmp
->rbearing
> cmp
->pixel_width
)
25074 *right
= cmp
->rbearing
- cmp
->pixel_width
;
25075 if (cmp
->lbearing
< 0)
25076 *left
= - cmp
->lbearing
;
25080 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
25081 struct font_metrics metrics
;
25083 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
25084 glyph
->slice
.cmp
.to
+ 1, &metrics
);
25085 if (metrics
.rbearing
> metrics
.width
)
25086 *right
= metrics
.rbearing
- metrics
.width
;
25087 if (metrics
.lbearing
< 0)
25088 *left
= - metrics
.lbearing
;
25094 /* Return the index of the first glyph preceding glyph string S that
25095 is overwritten by S because of S's left overhang. Value is -1
25096 if no glyphs are overwritten. */
25099 left_overwritten (struct glyph_string
*s
)
25103 if (s
->left_overhang
)
25106 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25107 int first
= s
->first_glyph
- glyphs
;
25109 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
25110 x
-= glyphs
[i
].pixel_width
;
25121 /* Return the index of the first glyph preceding glyph string S that
25122 is overwriting S because of its right overhang. Value is -1 if no
25123 glyph in front of S overwrites S. */
25126 left_overwriting (struct glyph_string
*s
)
25129 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25130 int first
= s
->first_glyph
- glyphs
;
25134 for (i
= first
- 1; i
>= 0; --i
)
25137 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
25140 x
-= glyphs
[i
].pixel_width
;
25147 /* Return the index of the last glyph following glyph string S that is
25148 overwritten by S because of S's right overhang. Value is -1 if
25149 no such glyph is found. */
25152 right_overwritten (struct glyph_string
*s
)
25156 if (s
->right_overhang
)
25159 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25160 int first
= (s
->first_glyph
- glyphs
25161 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
25162 int end
= s
->row
->used
[s
->area
];
25164 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
25165 x
+= glyphs
[i
].pixel_width
;
25174 /* Return the index of the last glyph following glyph string S that
25175 overwrites S because of its left overhang. Value is negative
25176 if no such glyph is found. */
25179 right_overwriting (struct glyph_string
*s
)
25182 int end
= s
->row
->used
[s
->area
];
25183 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25184 int first
= (s
->first_glyph
- glyphs
25185 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
25189 for (i
= first
; i
< end
; ++i
)
25192 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
25195 x
+= glyphs
[i
].pixel_width
;
25202 /* Set background width of glyph string S. START is the index of the
25203 first glyph following S. LAST_X is the right-most x-position + 1
25204 in the drawing area. */
25207 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
25209 /* If the face of this glyph string has to be drawn to the end of
25210 the drawing area, set S->extends_to_end_of_line_p. */
25212 if (start
== s
->row
->used
[s
->area
]
25213 && ((s
->row
->fill_line_p
25214 && (s
->hl
== DRAW_NORMAL_TEXT
25215 || s
->hl
== DRAW_IMAGE_RAISED
25216 || s
->hl
== DRAW_IMAGE_SUNKEN
))
25217 || s
->hl
== DRAW_MOUSE_FACE
))
25218 s
->extends_to_end_of_line_p
= true;
25220 /* If S extends its face to the end of the line, set its
25221 background_width to the distance to the right edge of the drawing
25223 if (s
->extends_to_end_of_line_p
)
25224 s
->background_width
= last_x
- s
->x
+ 1;
25226 s
->background_width
= s
->width
;
25230 /* Compute overhangs and x-positions for glyph string S and its
25231 predecessors, or successors. X is the starting x-position for S.
25232 BACKWARD_P means process predecessors. */
25235 compute_overhangs_and_x (struct glyph_string
*s
, int x
, bool backward_p
)
25241 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
25242 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
25252 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
25253 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
25263 /* The following macros are only called from draw_glyphs below.
25264 They reference the following parameters of that function directly:
25265 `w', `row', `area', and `overlap_p'
25266 as well as the following local variables:
25267 `s', `f', and `hdc' (in W32) */
25270 /* On W32, silently add local `hdc' variable to argument list of
25271 init_glyph_string. */
25272 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
25273 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
25275 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
25276 init_glyph_string (s, char2b, w, row, area, start, hl)
25279 /* Add a glyph string for a stretch glyph to the list of strings
25280 between HEAD and TAIL. START is the index of the stretch glyph in
25281 row area AREA of glyph row ROW. END is the index of the last glyph
25282 in that glyph row area. X is the current output position assigned
25283 to the new glyph string constructed. HL overrides that face of the
25284 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25285 is the right-most x-position of the drawing area. */
25287 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
25288 and below -- keep them on one line. */
25289 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25292 s = alloca (sizeof *s); \
25293 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25294 START = fill_stretch_glyph_string (s, START, END); \
25295 append_glyph_string (&HEAD, &TAIL, s); \
25301 /* Add a glyph string for an image glyph to the list of strings
25302 between HEAD and TAIL. START is the index of the image glyph in
25303 row area AREA of glyph row ROW. END is the index of the last glyph
25304 in that glyph row area. X is the current output position assigned
25305 to the new glyph string constructed. HL overrides that face of the
25306 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25307 is the right-most x-position of the drawing area. */
25309 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25312 s = alloca (sizeof *s); \
25313 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25314 fill_image_glyph_string (s); \
25315 append_glyph_string (&HEAD, &TAIL, s); \
25321 #ifndef HAVE_XWIDGETS
25322 # define BUILD_XWIDGET_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25325 # define BUILD_XWIDGET_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25328 s = alloca (sizeof *s); \
25329 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25330 fill_xwidget_glyph_string (s); \
25331 append_glyph_string (&(HEAD), &(TAIL), s); \
25338 /* Add a glyph string for a sequence of character glyphs to the list
25339 of strings between HEAD and TAIL. START is the index of the first
25340 glyph in row area AREA of glyph row ROW that is part of the new
25341 glyph string. END is the index of the last glyph in that glyph row
25342 area. X is the current output position assigned to the new glyph
25343 string constructed. HL overrides that face of the glyph; e.g. it
25344 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
25345 right-most x-position of the drawing area. */
25347 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25353 face_id = (row)->glyphs[area][START].face_id; \
25355 s = alloca (sizeof *s); \
25356 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
25357 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25358 append_glyph_string (&HEAD, &TAIL, s); \
25360 START = fill_glyph_string (s, face_id, START, END, overlaps); \
25365 /* Add a glyph string for a composite sequence to the list of strings
25366 between HEAD and TAIL. START is the index of the first glyph in
25367 row area AREA of glyph row ROW that is part of the new glyph
25368 string. END is the index of the last glyph in that glyph row area.
25369 X is the current output position assigned to the new glyph string
25370 constructed. HL overrides that face of the glyph; e.g. it is
25371 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
25372 x-position of the drawing area. */
25374 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25376 int face_id = (row)->glyphs[area][START].face_id; \
25377 struct face *base_face = FACE_OPT_FROM_ID (f, face_id); \
25378 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
25379 struct composition *cmp = composition_table[cmp_id]; \
25381 struct glyph_string *first_s = NULL; \
25384 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
25386 /* Make glyph_strings for each glyph sequence that is drawable by \
25387 the same face, and append them to HEAD/TAIL. */ \
25388 for (n = 0; n < cmp->glyph_len;) \
25390 s = alloca (sizeof *s); \
25391 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25392 append_glyph_string (&(HEAD), &(TAIL), s); \
25398 n = fill_composite_glyph_string (s, base_face, overlaps); \
25406 /* Add a glyph string for a glyph-string sequence to the list of strings
25407 between HEAD and TAIL. */
25409 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25413 Lisp_Object gstring; \
25415 face_id = (row)->glyphs[area][START].face_id; \
25416 gstring = (composition_gstring_from_id \
25417 ((row)->glyphs[area][START].u.cmp.id)); \
25418 s = alloca (sizeof *s); \
25419 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
25420 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25421 append_glyph_string (&(HEAD), &(TAIL), s); \
25423 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
25427 /* Add a glyph string for a sequence of glyphless character's glyphs
25428 to the list of strings between HEAD and TAIL. The meanings of
25429 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
25431 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25436 face_id = (row)->glyphs[area][START].face_id; \
25438 s = alloca (sizeof *s); \
25439 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25440 append_glyph_string (&HEAD, &TAIL, s); \
25442 START = fill_glyphless_glyph_string (s, face_id, START, END, \
25448 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
25449 of AREA of glyph row ROW on window W between indices START and END.
25450 HL overrides the face for drawing glyph strings, e.g. it is
25451 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
25452 x-positions of the drawing area.
25454 This is an ugly monster macro construct because we must use alloca
25455 to allocate glyph strings (because draw_glyphs can be called
25456 asynchronously). */
25458 #define BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25461 HEAD = TAIL = NULL; \
25462 while (START < END) \
25464 struct glyph *first_glyph = (row)->glyphs[area] + START; \
25465 switch (first_glyph->type) \
25468 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
25472 case COMPOSITE_GLYPH: \
25473 if (first_glyph->u.cmp.automatic) \
25474 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
25477 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
25481 case STRETCH_GLYPH: \
25482 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
25486 case IMAGE_GLYPH: \
25487 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
25491 #define BUILD_GLYPH_STRINGS_XW(START, END, HEAD, TAIL, HL, X, LAST_X) \
25492 case XWIDGET_GLYPH: \
25493 BUILD_XWIDGET_GLYPH_STRING (START, END, HEAD, TAIL, \
25497 #define BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X) \
25498 case GLYPHLESS_GLYPH: \
25499 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
25509 set_glyph_string_background_width (s, START, LAST_X); \
25516 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25517 BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25518 BUILD_GLYPH_STRINGS_XW(START, END, HEAD, TAIL, HL, X, LAST_X) \
25519 BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X)
25522 /* Draw glyphs between START and END in AREA of ROW on window W,
25523 starting at x-position X. X is relative to AREA in W. HL is a
25524 face-override with the following meaning:
25526 DRAW_NORMAL_TEXT draw normally
25527 DRAW_CURSOR draw in cursor face
25528 DRAW_MOUSE_FACE draw in mouse face.
25529 DRAW_INVERSE_VIDEO draw in mode line face
25530 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
25531 DRAW_IMAGE_RAISED draw an image with a raised relief around it
25533 If OVERLAPS is non-zero, draw only the foreground of characters and
25534 clip to the physical height of ROW. Non-zero value also defines
25535 the overlapping part to be drawn:
25537 OVERLAPS_PRED overlap with preceding rows
25538 OVERLAPS_SUCC overlap with succeeding rows
25539 OVERLAPS_BOTH overlap with both preceding/succeeding rows
25540 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
25542 Value is the x-position reached, relative to AREA of W. */
25545 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
25546 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
25547 enum draw_glyphs_face hl
, int overlaps
)
25549 struct glyph_string
*head
, *tail
;
25550 struct glyph_string
*s
;
25551 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
25552 int i
, j
, x_reached
, last_x
, area_left
= 0;
25553 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25556 ALLOCATE_HDC (hdc
, f
);
25558 /* Let's rather be paranoid than getting a SEGV. */
25559 end
= min (end
, row
->used
[area
]);
25560 start
= clip_to_bounds (0, start
, end
);
25562 /* Translate X to frame coordinates. Set last_x to the right
25563 end of the drawing area. */
25564 if (row
->full_width_p
)
25566 /* X is relative to the left edge of W, without scroll bars
25568 area_left
= WINDOW_LEFT_EDGE_X (w
);
25569 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
25570 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
25574 area_left
= window_box_left (w
, area
);
25575 last_x
= area_left
+ window_box_width (w
, area
);
25579 /* Build a doubly-linked list of glyph_string structures between
25580 head and tail from what we have to draw. Note that the macro
25581 BUILD_GLYPH_STRINGS will modify its start parameter. That's
25582 the reason we use a separate variable `i'. */
25585 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
25587 x_reached
= tail
->x
+ tail
->background_width
;
25591 /* If there are any glyphs with lbearing < 0 or rbearing > width in
25592 the row, redraw some glyphs in front or following the glyph
25593 strings built above. */
25594 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
25596 struct glyph_string
*h
, *t
;
25597 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25598 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
25599 bool check_mouse_face
= false;
25602 /* If mouse highlighting is on, we may need to draw adjacent
25603 glyphs using mouse-face highlighting. */
25604 if (area
== TEXT_AREA
&& row
->mouse_face_p
25605 && hlinfo
->mouse_face_beg_row
>= 0
25606 && hlinfo
->mouse_face_end_row
>= 0)
25608 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
25610 if (row_vpos
>= hlinfo
->mouse_face_beg_row
25611 && row_vpos
<= hlinfo
->mouse_face_end_row
)
25613 check_mouse_face
= true;
25614 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
25615 ? hlinfo
->mouse_face_beg_col
: 0;
25616 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
25617 ? hlinfo
->mouse_face_end_col
25618 : row
->used
[TEXT_AREA
];
25622 /* Compute overhangs for all glyph strings. */
25623 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
25624 for (s
= head
; s
; s
= s
->next
)
25625 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
25627 /* Prepend glyph strings for glyphs in front of the first glyph
25628 string that are overwritten because of the first glyph
25629 string's left overhang. The background of all strings
25630 prepended must be drawn because the first glyph string
25632 i
= left_overwritten (head
);
25635 enum draw_glyphs_face overlap_hl
;
25637 /* If this row contains mouse highlighting, attempt to draw
25638 the overlapped glyphs with the correct highlight. This
25639 code fails if the overlap encompasses more than one glyph
25640 and mouse-highlight spans only some of these glyphs.
25641 However, making it work perfectly involves a lot more
25642 code, and I don't know if the pathological case occurs in
25643 practice, so we'll stick to this for now. --- cyd */
25644 if (check_mouse_face
25645 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25646 overlap_hl
= DRAW_MOUSE_FACE
;
25648 overlap_hl
= DRAW_NORMAL_TEXT
;
25650 if (hl
!= overlap_hl
)
25653 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
25654 overlap_hl
, dummy_x
, last_x
);
25656 compute_overhangs_and_x (t
, head
->x
, true);
25657 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25658 if (clip_head
== NULL
)
25662 /* Prepend glyph strings for glyphs in front of the first glyph
25663 string that overwrite that glyph string because of their
25664 right overhang. For these strings, only the foreground must
25665 be drawn, because it draws over the glyph string at `head'.
25666 The background must not be drawn because this would overwrite
25667 right overhangs of preceding glyphs for which no glyph
25669 i
= left_overwriting (head
);
25672 enum draw_glyphs_face overlap_hl
;
25674 if (check_mouse_face
25675 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25676 overlap_hl
= DRAW_MOUSE_FACE
;
25678 overlap_hl
= DRAW_NORMAL_TEXT
;
25680 if (hl
== overlap_hl
|| clip_head
== NULL
)
25682 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
25683 overlap_hl
, dummy_x
, last_x
);
25684 for (s
= h
; s
; s
= s
->next
)
25685 s
->background_filled_p
= true;
25686 compute_overhangs_and_x (t
, head
->x
, true);
25687 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25690 /* Append glyphs strings for glyphs following the last glyph
25691 string tail that are overwritten by tail. The background of
25692 these strings has to be drawn because tail's foreground draws
25694 i
= right_overwritten (tail
);
25697 enum draw_glyphs_face overlap_hl
;
25699 if (check_mouse_face
25700 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25701 overlap_hl
= DRAW_MOUSE_FACE
;
25703 overlap_hl
= DRAW_NORMAL_TEXT
;
25705 if (hl
!= overlap_hl
)
25707 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25708 overlap_hl
, x
, last_x
);
25709 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25710 we don't have `end = i;' here. */
25711 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25712 append_glyph_string_lists (&head
, &tail
, h
, t
);
25713 if (clip_tail
== NULL
)
25717 /* Append glyph strings for glyphs following the last glyph
25718 string tail that overwrite tail. The foreground of such
25719 glyphs has to be drawn because it writes into the background
25720 of tail. The background must not be drawn because it could
25721 paint over the foreground of following glyphs. */
25722 i
= right_overwriting (tail
);
25725 enum draw_glyphs_face overlap_hl
;
25726 if (check_mouse_face
25727 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25728 overlap_hl
= DRAW_MOUSE_FACE
;
25730 overlap_hl
= DRAW_NORMAL_TEXT
;
25732 if (hl
== overlap_hl
|| clip_tail
== NULL
)
25734 i
++; /* We must include the Ith glyph. */
25735 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25736 overlap_hl
, x
, last_x
);
25737 for (s
= h
; s
; s
= s
->next
)
25738 s
->background_filled_p
= true;
25739 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25740 append_glyph_string_lists (&head
, &tail
, h
, t
);
25742 if (clip_head
|| clip_tail
)
25743 for (s
= head
; s
; s
= s
->next
)
25745 s
->clip_head
= clip_head
;
25746 s
->clip_tail
= clip_tail
;
25750 /* Draw all strings. */
25751 for (s
= head
; s
; s
= s
->next
)
25752 FRAME_RIF (f
)->draw_glyph_string (s
);
25755 /* When focus a sole frame and move horizontally, this clears on_p
25756 causing a failure to erase prev cursor position. */
25757 if (area
== TEXT_AREA
25758 && !row
->full_width_p
25759 /* When drawing overlapping rows, only the glyph strings'
25760 foreground is drawn, which doesn't erase a cursor
25764 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25765 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25766 : (tail
? tail
->x
+ tail
->background_width
: x
));
25770 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25771 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25775 /* Value is the x-position up to which drawn, relative to AREA of W.
25776 This doesn't include parts drawn because of overhangs. */
25777 if (row
->full_width_p
)
25778 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25780 x_reached
-= area_left
;
25782 RELEASE_HDC (hdc
, f
);
25788 /* Expand row matrix if too narrow. Don't expand if area
25791 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25793 if (!it->f->fonts_changed \
25794 && (it->glyph_row->glyphs[area] \
25795 < it->glyph_row->glyphs[area + 1])) \
25797 it->w->ncols_scale_factor++; \
25798 it->f->fonts_changed = true; \
25802 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25803 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25806 append_glyph (struct it
*it
)
25808 struct glyph
*glyph
;
25809 enum glyph_row_area area
= it
->area
;
25811 eassert (it
->glyph_row
);
25812 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25814 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25815 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25817 /* If the glyph row is reversed, we need to prepend the glyph
25818 rather than append it. */
25819 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25823 /* Make room for the additional glyph. */
25824 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25826 glyph
= it
->glyph_row
->glyphs
[area
];
25828 glyph
->charpos
= CHARPOS (it
->position
);
25829 glyph
->object
= it
->object
;
25830 if (it
->pixel_width
> 0)
25832 eassert (it
->pixel_width
<= SHRT_MAX
);
25833 glyph
->pixel_width
= it
->pixel_width
;
25834 glyph
->padding_p
= false;
25838 /* Assure at least 1-pixel width. Otherwise, cursor can't
25839 be displayed correctly. */
25840 glyph
->pixel_width
= 1;
25841 glyph
->padding_p
= true;
25843 glyph
->ascent
= it
->ascent
;
25844 glyph
->descent
= it
->descent
;
25845 glyph
->voffset
= it
->voffset
;
25846 glyph
->type
= CHAR_GLYPH
;
25847 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25848 glyph
->multibyte_p
= it
->multibyte_p
;
25849 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25851 /* In R2L rows, the left and the right box edges need to be
25852 drawn in reverse direction. */
25853 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25854 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25858 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25859 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25861 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25862 || it
->phys_descent
> it
->descent
);
25863 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25864 glyph
->face_id
= it
->face_id
;
25865 glyph
->u
.ch
= it
->char_to_display
;
25866 glyph
->slice
.img
= null_glyph_slice
;
25867 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25870 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25871 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25872 glyph
->bidi_type
= it
->bidi_it
.type
;
25876 glyph
->resolved_level
= 0;
25877 glyph
->bidi_type
= UNKNOWN_BT
;
25879 ++it
->glyph_row
->used
[area
];
25882 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25885 /* Store one glyph for the composition IT->cmp_it.id in
25886 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25890 append_composite_glyph (struct it
*it
)
25892 struct glyph
*glyph
;
25893 enum glyph_row_area area
= it
->area
;
25895 eassert (it
->glyph_row
);
25897 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25898 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25900 /* If the glyph row is reversed, we need to prepend the glyph
25901 rather than append it. */
25902 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25906 /* Make room for the new glyph. */
25907 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25909 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25911 glyph
->charpos
= it
->cmp_it
.charpos
;
25912 glyph
->object
= it
->object
;
25913 eassert (it
->pixel_width
<= SHRT_MAX
);
25914 glyph
->pixel_width
= it
->pixel_width
;
25915 glyph
->ascent
= it
->ascent
;
25916 glyph
->descent
= it
->descent
;
25917 glyph
->voffset
= it
->voffset
;
25918 glyph
->type
= COMPOSITE_GLYPH
;
25919 if (it
->cmp_it
.ch
< 0)
25921 glyph
->u
.cmp
.automatic
= false;
25922 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25923 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25927 glyph
->u
.cmp
.automatic
= true;
25928 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25929 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25930 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25932 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25933 glyph
->multibyte_p
= it
->multibyte_p
;
25934 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25936 /* In R2L rows, the left and the right box edges need to be
25937 drawn in reverse direction. */
25938 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25939 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25943 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25944 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25946 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25947 || it
->phys_descent
> it
->descent
);
25948 glyph
->padding_p
= false;
25949 glyph
->glyph_not_available_p
= false;
25950 glyph
->face_id
= it
->face_id
;
25951 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25954 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25955 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25956 glyph
->bidi_type
= it
->bidi_it
.type
;
25958 ++it
->glyph_row
->used
[area
];
25961 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25965 /* Change IT->ascent and IT->height according to the setting of
25969 take_vertical_position_into_account (struct it
*it
)
25973 if (it
->voffset
< 0)
25974 /* Increase the ascent so that we can display the text higher
25976 it
->ascent
-= it
->voffset
;
25978 /* Increase the descent so that we can display the text lower
25980 it
->descent
+= it
->voffset
;
25985 /* Produce glyphs/get display metrics for the image IT is loaded with.
25986 See the description of struct display_iterator in dispextern.h for
25987 an overview of struct display_iterator. */
25990 produce_image_glyph (struct it
*it
)
25994 int glyph_ascent
, crop
;
25995 struct glyph_slice slice
;
25997 eassert (it
->what
== IT_IMAGE
);
25999 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26000 /* Make sure X resources of the face is loaded. */
26001 prepare_face_for_display (it
->f
, face
);
26003 if (it
->image_id
< 0)
26005 /* Fringe bitmap. */
26006 it
->ascent
= it
->phys_ascent
= 0;
26007 it
->descent
= it
->phys_descent
= 0;
26008 it
->pixel_width
= 0;
26013 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
26014 /* Make sure X resources of the image is loaded. */
26015 prepare_image_for_display (it
->f
, img
);
26017 slice
.x
= slice
.y
= 0;
26018 slice
.width
= img
->width
;
26019 slice
.height
= img
->height
;
26021 if (INTEGERP (it
->slice
.x
))
26022 slice
.x
= XINT (it
->slice
.x
);
26023 else if (FLOATP (it
->slice
.x
))
26024 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
26026 if (INTEGERP (it
->slice
.y
))
26027 slice
.y
= XINT (it
->slice
.y
);
26028 else if (FLOATP (it
->slice
.y
))
26029 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
26031 if (INTEGERP (it
->slice
.width
))
26032 slice
.width
= XINT (it
->slice
.width
);
26033 else if (FLOATP (it
->slice
.width
))
26034 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
26036 if (INTEGERP (it
->slice
.height
))
26037 slice
.height
= XINT (it
->slice
.height
);
26038 else if (FLOATP (it
->slice
.height
))
26039 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
26041 if (slice
.x
>= img
->width
)
26042 slice
.x
= img
->width
;
26043 if (slice
.y
>= img
->height
)
26044 slice
.y
= img
->height
;
26045 if (slice
.x
+ slice
.width
>= img
->width
)
26046 slice
.width
= img
->width
- slice
.x
;
26047 if (slice
.y
+ slice
.height
> img
->height
)
26048 slice
.height
= img
->height
- slice
.y
;
26050 if (slice
.width
== 0 || slice
.height
== 0)
26053 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
26055 it
->descent
= slice
.height
- glyph_ascent
;
26057 it
->descent
+= img
->vmargin
;
26058 if (slice
.y
+ slice
.height
== img
->height
)
26059 it
->descent
+= img
->vmargin
;
26060 it
->phys_descent
= it
->descent
;
26062 it
->pixel_width
= slice
.width
;
26064 it
->pixel_width
+= img
->hmargin
;
26065 if (slice
.x
+ slice
.width
== img
->width
)
26066 it
->pixel_width
+= img
->hmargin
;
26068 /* It's quite possible for images to have an ascent greater than
26069 their height, so don't get confused in that case. */
26070 if (it
->descent
< 0)
26075 if (face
->box
!= FACE_NO_BOX
)
26077 if (face
->box_line_width
> 0)
26080 it
->ascent
+= face
->box_line_width
;
26081 if (slice
.y
+ slice
.height
== img
->height
)
26082 it
->descent
+= face
->box_line_width
;
26085 if (it
->start_of_box_run_p
&& slice
.x
== 0)
26086 it
->pixel_width
+= eabs (face
->box_line_width
);
26087 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
26088 it
->pixel_width
+= eabs (face
->box_line_width
);
26091 take_vertical_position_into_account (it
);
26093 /* Automatically crop wide image glyphs at right edge so we can
26094 draw the cursor on same display row. */
26095 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
26096 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
26098 it
->pixel_width
-= crop
;
26099 slice
.width
-= crop
;
26104 struct glyph
*glyph
;
26105 enum glyph_row_area area
= it
->area
;
26107 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26108 if (it
->glyph_row
->reversed_p
)
26112 /* Make room for the new glyph. */
26113 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
26115 glyph
= it
->glyph_row
->glyphs
[it
->area
];
26117 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26119 glyph
->charpos
= CHARPOS (it
->position
);
26120 glyph
->object
= it
->object
;
26121 glyph
->pixel_width
= clip_to_bounds (-1, it
->pixel_width
, SHRT_MAX
);
26122 glyph
->ascent
= glyph_ascent
;
26123 glyph
->descent
= it
->descent
;
26124 glyph
->voffset
= it
->voffset
;
26125 glyph
->type
= IMAGE_GLYPH
;
26126 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26127 glyph
->multibyte_p
= it
->multibyte_p
;
26128 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26130 /* In R2L rows, the left and the right box edges need to be
26131 drawn in reverse direction. */
26132 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26133 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26137 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26138 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26140 glyph
->overlaps_vertically_p
= false;
26141 glyph
->padding_p
= false;
26142 glyph
->glyph_not_available_p
= false;
26143 glyph
->face_id
= it
->face_id
;
26144 glyph
->u
.img_id
= img
->id
;
26145 glyph
->slice
.img
= slice
;
26146 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26149 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26150 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26151 glyph
->bidi_type
= it
->bidi_it
.type
;
26153 ++it
->glyph_row
->used
[area
];
26156 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26161 produce_xwidget_glyph (struct it
*it
)
26163 #ifdef HAVE_XWIDGETS
26164 struct xwidget
*xw
;
26165 int glyph_ascent
, crop
;
26166 eassert (it
->what
== IT_XWIDGET
);
26168 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26169 /* Make sure X resources of the face is loaded. */
26170 prepare_face_for_display (it
->f
, face
);
26173 it
->ascent
= it
->phys_ascent
= glyph_ascent
= xw
->height
/2;
26174 it
->descent
= xw
->height
/2;
26175 it
->phys_descent
= it
->descent
;
26176 it
->pixel_width
= xw
->width
;
26177 /* It's quite possible for images to have an ascent greater than
26178 their height, so don't get confused in that case. */
26179 if (it
->descent
< 0)
26184 if (face
->box
!= FACE_NO_BOX
)
26186 if (face
->box_line_width
> 0)
26188 it
->ascent
+= face
->box_line_width
;
26189 it
->descent
+= face
->box_line_width
;
26192 if (it
->start_of_box_run_p
)
26193 it
->pixel_width
+= eabs (face
->box_line_width
);
26194 it
->pixel_width
+= eabs (face
->box_line_width
);
26197 take_vertical_position_into_account (it
);
26199 /* Automatically crop wide image glyphs at right edge so we can
26200 draw the cursor on same display row. */
26201 crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
);
26202 if (crop
> 0 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
26203 it
->pixel_width
-= crop
;
26207 enum glyph_row_area area
= it
->area
;
26208 struct glyph
*glyph
26209 = it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26211 if (it
->glyph_row
->reversed_p
)
26215 /* Make room for the new glyph. */
26216 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
26218 glyph
= it
->glyph_row
->glyphs
[it
->area
];
26220 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26222 glyph
->charpos
= CHARPOS (it
->position
);
26223 glyph
->object
= it
->object
;
26224 glyph
->pixel_width
= clip_to_bounds (-1, it
->pixel_width
, SHRT_MAX
);
26225 glyph
->ascent
= glyph_ascent
;
26226 glyph
->descent
= it
->descent
;
26227 glyph
->voffset
= it
->voffset
;
26228 glyph
->type
= XWIDGET_GLYPH
;
26229 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26230 glyph
->multibyte_p
= it
->multibyte_p
;
26231 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26233 /* In R2L rows, the left and the right box edges need to be
26234 drawn in reverse direction. */
26235 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26236 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26240 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26241 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26243 glyph
->overlaps_vertically_p
= 0;
26244 glyph
->padding_p
= 0;
26245 glyph
->glyph_not_available_p
= 0;
26246 glyph
->face_id
= it
->face_id
;
26247 glyph
->u
.xwidget
= it
->xwidget
;
26248 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26251 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26252 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26253 glyph
->bidi_type
= it
->bidi_it
.type
;
26255 ++it
->glyph_row
->used
[area
];
26258 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26263 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
26264 of the glyph, WIDTH and HEIGHT are the width and height of the
26265 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
26268 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
26269 int width
, int height
, int ascent
)
26271 struct glyph
*glyph
;
26272 enum glyph_row_area area
= it
->area
;
26274 eassert (ascent
>= 0 && ascent
<= height
);
26276 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26277 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26279 /* If the glyph row is reversed, we need to prepend the glyph
26280 rather than append it. */
26281 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26285 /* Make room for the additional glyph. */
26286 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26288 glyph
= it
->glyph_row
->glyphs
[area
];
26290 /* Decrease the width of the first glyph of the row that
26291 begins before first_visible_x (e.g., due to hscroll).
26292 This is so the overall width of the row becomes smaller
26293 by the scroll amount, and the stretch glyph appended by
26294 extend_face_to_end_of_line will be wider, to shift the
26295 row glyphs to the right. (In L2R rows, the corresponding
26296 left-shift effect is accomplished by setting row->x to a
26297 negative value, which won't work with R2L rows.)
26299 This must leave us with a positive value of WIDTH, since
26300 otherwise the call to move_it_in_display_line_to at the
26301 beginning of display_line would have got past the entire
26302 first glyph, and then it->current_x would have been
26303 greater or equal to it->first_visible_x. */
26304 if (it
->current_x
< it
->first_visible_x
)
26305 width
-= it
->first_visible_x
- it
->current_x
;
26306 eassert (width
> 0);
26308 glyph
->charpos
= CHARPOS (it
->position
);
26309 glyph
->object
= object
;
26310 /* FIXME: It would be better to use TYPE_MAX here, but
26311 __typeof__ is not portable enough... */
26312 glyph
->pixel_width
= clip_to_bounds (-1, width
, SHRT_MAX
);
26313 glyph
->ascent
= ascent
;
26314 glyph
->descent
= height
- ascent
;
26315 glyph
->voffset
= it
->voffset
;
26316 glyph
->type
= STRETCH_GLYPH
;
26317 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26318 glyph
->multibyte_p
= it
->multibyte_p
;
26319 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26321 /* In R2L rows, the left and the right box edges need to be
26322 drawn in reverse direction. */
26323 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26324 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26328 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26329 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26331 glyph
->overlaps_vertically_p
= false;
26332 glyph
->padding_p
= false;
26333 glyph
->glyph_not_available_p
= false;
26334 glyph
->face_id
= it
->face_id
;
26335 glyph
->u
.stretch
.ascent
= ascent
;
26336 glyph
->u
.stretch
.height
= height
;
26337 glyph
->slice
.img
= null_glyph_slice
;
26338 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26341 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26342 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26343 glyph
->bidi_type
= it
->bidi_it
.type
;
26347 glyph
->resolved_level
= 0;
26348 glyph
->bidi_type
= UNKNOWN_BT
;
26350 ++it
->glyph_row
->used
[area
];
26353 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26356 #endif /* HAVE_WINDOW_SYSTEM */
26358 /* Produce a stretch glyph for iterator IT. IT->object is the value
26359 of the glyph property displayed. The value must be a list
26360 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
26363 1. `:width WIDTH' specifies that the space should be WIDTH *
26364 canonical char width wide. WIDTH may be an integer or floating
26367 2. `:relative-width FACTOR' specifies that the width of the stretch
26368 should be computed from the width of the first character having the
26369 `glyph' property, and should be FACTOR times that width.
26371 3. `:align-to HPOS' specifies that the space should be wide enough
26372 to reach HPOS, a value in canonical character units.
26374 Exactly one of the above pairs must be present.
26376 4. `:height HEIGHT' specifies that the height of the stretch produced
26377 should be HEIGHT, measured in canonical character units.
26379 5. `:relative-height FACTOR' specifies that the height of the
26380 stretch should be FACTOR times the height of the characters having
26381 the glyph property.
26383 Either none or exactly one of 4 or 5 must be present.
26385 6. `:ascent ASCENT' specifies that ASCENT percent of the height
26386 of the stretch should be used for the ascent of the stretch.
26387 ASCENT must be in the range 0 <= ASCENT <= 100. */
26390 produce_stretch_glyph (struct it
*it
)
26392 /* (space :width WIDTH :height HEIGHT ...) */
26393 Lisp_Object prop
, plist
;
26394 int width
= 0, height
= 0, align_to
= -1;
26395 bool zero_width_ok_p
= false;
26397 struct font
*font
= NULL
;
26399 #ifdef HAVE_WINDOW_SYSTEM
26401 bool zero_height_ok_p
= false;
26403 if (FRAME_WINDOW_P (it
->f
))
26405 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26406 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26407 prepare_face_for_display (it
->f
, face
);
26411 /* List should start with `space'. */
26412 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
26413 plist
= XCDR (it
->object
);
26415 /* Compute the width of the stretch. */
26416 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
26417 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true, 0))
26419 /* Absolute width `:width WIDTH' specified and valid. */
26420 zero_width_ok_p
= true;
26423 else if (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0)
26425 /* Relative width `:relative-width FACTOR' specified and valid.
26426 Compute the width of the characters having the `glyph'
26429 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
26432 if (it
->multibyte_p
)
26433 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
26436 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
26437 if (! ASCII_CHAR_P (it2
.c
))
26438 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
26441 it2
.glyph_row
= NULL
;
26442 it2
.what
= IT_CHARACTER
;
26443 PRODUCE_GLYPHS (&it2
);
26444 width
= NUMVAL (prop
) * it2
.pixel_width
;
26446 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
26447 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true,
26450 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
26451 align_to
= (align_to
< 0
26453 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
26454 else if (align_to
< 0)
26455 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
26456 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
26457 zero_width_ok_p
= true;
26460 /* Nothing specified -> width defaults to canonical char width. */
26461 width
= FRAME_COLUMN_WIDTH (it
->f
);
26463 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
26466 #ifdef HAVE_WINDOW_SYSTEM
26467 /* Compute height. */
26468 if (FRAME_WINDOW_P (it
->f
))
26470 int default_height
= normal_char_height (font
, ' ');
26472 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
26473 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26476 zero_height_ok_p
= true;
26478 else if (prop
= Fplist_get (plist
, QCrelative_height
),
26480 height
= default_height
* NUMVAL (prop
);
26482 height
= default_height
;
26484 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
26487 /* Compute percentage of height used for ascent. If
26488 `:ascent ASCENT' is present and valid, use that. Otherwise,
26489 derive the ascent from the font in use. */
26490 if (prop
= Fplist_get (plist
, QCascent
),
26491 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
26492 ascent
= height
* NUMVAL (prop
) / 100.0;
26493 else if (!NILP (prop
)
26494 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26495 ascent
= min (max (0, (int)tem
), height
);
26497 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
26500 #endif /* HAVE_WINDOW_SYSTEM */
26503 if (width
> 0 && it
->line_wrap
!= TRUNCATE
26504 && it
->current_x
+ width
> it
->last_visible_x
)
26506 width
= it
->last_visible_x
- it
->current_x
;
26507 #ifdef HAVE_WINDOW_SYSTEM
26508 /* Subtract one more pixel from the stretch width, but only on
26509 GUI frames, since on a TTY each glyph is one "pixel" wide. */
26510 width
-= FRAME_WINDOW_P (it
->f
);
26514 if (width
> 0 && height
> 0 && it
->glyph_row
)
26516 Lisp_Object o_object
= it
->object
;
26517 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
26520 if (!STRINGP (object
))
26521 object
= it
->w
->contents
;
26522 #ifdef HAVE_WINDOW_SYSTEM
26523 if (FRAME_WINDOW_P (it
->f
))
26524 append_stretch_glyph (it
, object
, width
, height
, ascent
);
26528 it
->object
= object
;
26529 it
->char_to_display
= ' ';
26530 it
->pixel_width
= it
->len
= 1;
26532 tty_append_glyph (it
);
26533 it
->object
= o_object
;
26537 it
->pixel_width
= width
;
26538 #ifdef HAVE_WINDOW_SYSTEM
26539 if (FRAME_WINDOW_P (it
->f
))
26541 it
->ascent
= it
->phys_ascent
= ascent
;
26542 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
26543 it
->nglyphs
= width
> 0 && height
> 0;
26544 take_vertical_position_into_account (it
);
26548 it
->nglyphs
= width
;
26551 /* Get information about special display element WHAT in an
26552 environment described by IT. WHAT is one of IT_TRUNCATION or
26553 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
26554 non-null glyph_row member. This function ensures that fields like
26555 face_id, c, len of IT are left untouched. */
26558 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
26565 temp_it
.object
= Qnil
;
26566 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
26568 if (what
== IT_CONTINUATION
)
26570 /* Continuation glyph. For R2L lines, we mirror it by hand. */
26571 if (it
->bidi_it
.paragraph_dir
== R2L
)
26572 SET_GLYPH_FROM_CHAR (glyph
, '/');
26574 SET_GLYPH_FROM_CHAR (glyph
, '\\');
26576 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26578 /* FIXME: Should we mirror GC for R2L lines? */
26579 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26580 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26583 else if (what
== IT_TRUNCATION
)
26585 /* Truncation glyph. */
26586 SET_GLYPH_FROM_CHAR (glyph
, '$');
26588 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26590 /* FIXME: Should we mirror GC for R2L lines? */
26591 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26592 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26598 #ifdef HAVE_WINDOW_SYSTEM
26599 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
26600 is turned off, we precede the truncation/continuation glyphs by a
26601 stretch glyph whose width is computed such that these special
26602 glyphs are aligned at the window margin, even when very different
26603 fonts are used in different glyph rows. */
26604 if (FRAME_WINDOW_P (temp_it
.f
)
26605 /* init_iterator calls this with it->glyph_row == NULL, and it
26606 wants only the pixel width of the truncation/continuation
26608 && temp_it
.glyph_row
26609 /* insert_left_trunc_glyphs calls us at the beginning of the
26610 row, and it has its own calculation of the stretch glyph
26612 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
26613 && (temp_it
.glyph_row
->reversed_p
26614 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
26615 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
26617 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
26619 if (stretch_width
> 0)
26621 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
26622 struct font
*font
=
26623 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
26624 int stretch_ascent
=
26625 (((temp_it
.ascent
+ temp_it
.descent
)
26626 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
26628 append_stretch_glyph (&temp_it
, Qnil
, stretch_width
,
26629 temp_it
.ascent
+ temp_it
.descent
,
26636 temp_it
.what
= IT_CHARACTER
;
26637 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
26638 temp_it
.face_id
= GLYPH_FACE (glyph
);
26639 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
26641 PRODUCE_GLYPHS (&temp_it
);
26642 it
->pixel_width
= temp_it
.pixel_width
;
26643 it
->nglyphs
= temp_it
.nglyphs
;
26646 #ifdef HAVE_WINDOW_SYSTEM
26648 /* Calculate line-height and line-spacing properties.
26649 An integer value specifies explicit pixel value.
26650 A float value specifies relative value to current face height.
26651 A cons (float . face-name) specifies relative value to
26652 height of specified face font.
26654 Returns height in pixels, or nil. */
26657 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
26658 int boff
, bool override
)
26660 Lisp_Object face_name
= Qnil
;
26661 int ascent
, descent
, height
;
26663 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
26668 face_name
= XCAR (val
);
26670 if (!NUMBERP (val
))
26671 val
= make_number (1);
26672 if (NILP (face_name
))
26674 height
= it
->ascent
+ it
->descent
;
26679 if (NILP (face_name
))
26681 font
= FRAME_FONT (it
->f
);
26682 boff
= FRAME_BASELINE_OFFSET (it
->f
);
26684 else if (EQ (face_name
, Qt
))
26693 face_id
= lookup_named_face (it
->f
, face_name
, false);
26695 return make_number (-1);
26697 face
= FACE_FROM_ID (it
->f
, face_id
);
26700 return make_number (-1);
26701 boff
= font
->baseline_offset
;
26702 if (font
->vertical_centering
)
26703 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26706 normal_char_ascent_descent (font
, -1, &ascent
, &descent
);
26710 it
->override_ascent
= ascent
;
26711 it
->override_descent
= descent
;
26712 it
->override_boff
= boff
;
26715 height
= ascent
+ descent
;
26719 height
= (int)(XFLOAT_DATA (val
) * height
);
26720 else if (INTEGERP (val
))
26721 height
*= XINT (val
);
26723 return make_number (height
);
26727 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
26728 is a face ID to be used for the glyph. FOR_NO_FONT is true if
26729 and only if this is for a character for which no font was found.
26731 If the display method (it->glyphless_method) is
26732 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
26733 length of the acronym or the hexadecimal string, UPPER_XOFF and
26734 UPPER_YOFF are pixel offsets for the upper part of the string,
26735 LOWER_XOFF and LOWER_YOFF are for the lower part.
26737 For the other display methods, LEN through LOWER_YOFF are zero. */
26740 append_glyphless_glyph (struct it
*it
, int face_id
, bool for_no_font
, int len
,
26741 short upper_xoff
, short upper_yoff
,
26742 short lower_xoff
, short lower_yoff
)
26744 struct glyph
*glyph
;
26745 enum glyph_row_area area
= it
->area
;
26747 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26748 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26750 /* If the glyph row is reversed, we need to prepend the glyph
26751 rather than append it. */
26752 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26756 /* Make room for the additional glyph. */
26757 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26759 glyph
= it
->glyph_row
->glyphs
[area
];
26761 glyph
->charpos
= CHARPOS (it
->position
);
26762 glyph
->object
= it
->object
;
26763 eassert (it
->pixel_width
<= SHRT_MAX
);
26764 glyph
->pixel_width
= it
->pixel_width
;
26765 glyph
->ascent
= it
->ascent
;
26766 glyph
->descent
= it
->descent
;
26767 glyph
->voffset
= it
->voffset
;
26768 glyph
->type
= GLYPHLESS_GLYPH
;
26769 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
26770 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
26771 glyph
->u
.glyphless
.len
= len
;
26772 glyph
->u
.glyphless
.ch
= it
->c
;
26773 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
26774 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
26775 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
26776 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
26777 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26778 glyph
->multibyte_p
= it
->multibyte_p
;
26779 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26781 /* In R2L rows, the left and the right box edges need to be
26782 drawn in reverse direction. */
26783 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26784 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26788 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26789 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26791 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
26792 || it
->phys_descent
> it
->descent
);
26793 glyph
->padding_p
= false;
26794 glyph
->glyph_not_available_p
= false;
26795 glyph
->face_id
= face_id
;
26796 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26799 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26800 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26801 glyph
->bidi_type
= it
->bidi_it
.type
;
26803 ++it
->glyph_row
->used
[area
];
26806 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26810 /* Produce a glyph for a glyphless character for iterator IT.
26811 IT->glyphless_method specifies which method to use for displaying
26812 the character. See the description of enum
26813 glyphless_display_method in dispextern.h for the detail.
26815 FOR_NO_FONT is true if and only if this is for a character for
26816 which no font was found. ACRONYM, if non-nil, is an acronym string
26817 for the character. */
26820 produce_glyphless_glyph (struct it
*it
, bool for_no_font
, Lisp_Object acronym
)
26825 int base_width
, base_height
, width
, height
;
26826 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26829 /* Get the metrics of the base font. We always refer to the current
26831 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26832 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26833 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
26834 it
->ascent
+= font
->baseline_offset
;
26835 it
->descent
-= font
->baseline_offset
;
26836 base_height
= it
->ascent
+ it
->descent
;
26837 base_width
= font
->average_width
;
26839 face_id
= merge_glyphless_glyph_face (it
);
26841 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26843 it
->pixel_width
= THIN_SPACE_WIDTH
;
26845 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26847 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26849 width
= CHAR_WIDTH (it
->c
);
26852 else if (width
> 4)
26854 it
->pixel_width
= base_width
* width
;
26856 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26862 unsigned int code
[6];
26864 int ascent
, descent
;
26865 struct font_metrics metrics_upper
, metrics_lower
;
26867 face
= FACE_FROM_ID (it
->f
, face_id
);
26868 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26869 prepare_face_for_display (it
->f
, face
);
26871 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26873 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26874 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26875 if (CONSP (acronym
))
26876 acronym
= XCAR (acronym
);
26877 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26881 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26882 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
+ 0u);
26885 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
26886 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26887 upper_len
= (len
+ 1) / 2;
26888 font
->driver
->text_extents (font
, code
, upper_len
,
26890 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26895 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26896 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26897 upper_xoff
= upper_yoff
= 2; /* the typical case */
26898 if (base_width
>= width
)
26900 /* Align the upper to the left, the lower to the right. */
26901 it
->pixel_width
= base_width
;
26902 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26906 /* Center the shorter one. */
26907 it
->pixel_width
= width
;
26908 if (metrics_upper
.width
>= metrics_lower
.width
)
26909 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26912 /* FIXME: This code doesn't look right. It formerly was
26913 missing the "lower_xoff = 0;", which couldn't have
26914 been right since it left lower_xoff uninitialized. */
26916 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26920 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26921 top, bottom, and between upper and lower strings. */
26922 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26923 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26924 /* Center vertically.
26925 H:base_height, D:base_descent
26926 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26928 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26929 descent = D - H/2 + h/2;
26930 lower_yoff = descent - 2 - ld;
26931 upper_yoff = lower_yoff - la - 1 - ud; */
26932 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26933 descent
= it
->descent
- (base_height
- height
) / 2;
26934 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26935 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26936 - metrics_upper
.descent
);
26937 /* Don't make the height shorter than the base height. */
26938 if (height
> base_height
)
26940 it
->ascent
= ascent
;
26941 it
->descent
= descent
;
26945 it
->phys_ascent
= it
->ascent
;
26946 it
->phys_descent
= it
->descent
;
26948 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26949 upper_xoff
, upper_yoff
,
26950 lower_xoff
, lower_yoff
);
26952 take_vertical_position_into_account (it
);
26957 Produce glyphs/get display metrics for the display element IT is
26958 loaded with. See the description of struct it in dispextern.h
26959 for an overview of struct it. */
26962 x_produce_glyphs (struct it
*it
)
26964 int extra_line_spacing
= it
->extra_line_spacing
;
26966 it
->glyph_not_available_p
= false;
26968 if (it
->what
== IT_CHARACTER
)
26971 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26972 struct font
*font
= face
->font
;
26973 struct font_metrics
*pcm
= NULL
;
26974 int boff
; /* Baseline offset. */
26978 /* When no suitable font is found, display this character by
26979 the method specified in the first extra slot of
26980 Vglyphless_char_display. */
26981 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26983 eassert (it
->what
== IT_GLYPHLESS
);
26984 produce_glyphless_glyph (it
, true,
26985 STRINGP (acronym
) ? acronym
: Qnil
);
26989 boff
= font
->baseline_offset
;
26990 if (font
->vertical_centering
)
26991 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26993 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26997 if (it
->override_ascent
>= 0)
26999 it
->ascent
= it
->override_ascent
;
27000 it
->descent
= it
->override_descent
;
27001 boff
= it
->override_boff
;
27005 it
->ascent
= FONT_BASE (font
) + boff
;
27006 it
->descent
= FONT_DESCENT (font
) - boff
;
27009 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
27011 pcm
= get_per_char_metric (font
, &char2b
);
27012 if (pcm
->width
== 0
27013 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
27019 it
->phys_ascent
= pcm
->ascent
+ boff
;
27020 it
->phys_descent
= pcm
->descent
- boff
;
27021 it
->pixel_width
= pcm
->width
;
27022 /* Don't use font-global values for ascent and descent
27023 if they result in an exceedingly large line height. */
27024 if (it
->override_ascent
< 0)
27026 if (FONT_TOO_HIGH (font
))
27028 it
->ascent
= it
->phys_ascent
;
27029 it
->descent
= it
->phys_descent
;
27030 /* These limitations are enforced by an
27031 assertion near the end of this function. */
27032 if (it
->ascent
< 0)
27034 if (it
->descent
< 0)
27041 it
->glyph_not_available_p
= true;
27042 it
->phys_ascent
= it
->ascent
;
27043 it
->phys_descent
= it
->descent
;
27044 it
->pixel_width
= font
->space_width
;
27047 if (it
->constrain_row_ascent_descent_p
)
27049 if (it
->descent
> it
->max_descent
)
27051 it
->ascent
+= it
->descent
- it
->max_descent
;
27052 it
->descent
= it
->max_descent
;
27054 if (it
->ascent
> it
->max_ascent
)
27056 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
27057 it
->ascent
= it
->max_ascent
;
27059 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
27060 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
27061 extra_line_spacing
= 0;
27064 /* If this is a space inside a region of text with
27065 `space-width' property, change its width. */
27067 = it
->char_to_display
== ' ' && !NILP (it
->space_width
);
27069 it
->pixel_width
*= XFLOATINT (it
->space_width
);
27071 /* If face has a box, add the box thickness to the character
27072 height. If character has a box line to the left and/or
27073 right, add the box line width to the character's width. */
27074 if (face
->box
!= FACE_NO_BOX
)
27076 int thick
= face
->box_line_width
;
27080 it
->ascent
+= thick
;
27081 it
->descent
+= thick
;
27086 if (it
->start_of_box_run_p
)
27087 it
->pixel_width
+= thick
;
27088 if (it
->end_of_box_run_p
)
27089 it
->pixel_width
+= thick
;
27092 /* If face has an overline, add the height of the overline
27093 (1 pixel) and a 1 pixel margin to the character height. */
27094 if (face
->overline_p
)
27095 it
->ascent
+= overline_margin
;
27097 if (it
->constrain_row_ascent_descent_p
)
27099 if (it
->ascent
> it
->max_ascent
)
27100 it
->ascent
= it
->max_ascent
;
27101 if (it
->descent
> it
->max_descent
)
27102 it
->descent
= it
->max_descent
;
27105 take_vertical_position_into_account (it
);
27107 /* If we have to actually produce glyphs, do it. */
27112 /* Translate a space with a `space-width' property
27113 into a stretch glyph. */
27114 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
27115 / FONT_HEIGHT (font
));
27116 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
27117 it
->ascent
+ it
->descent
, ascent
);
27122 /* If characters with lbearing or rbearing are displayed
27123 in this line, record that fact in a flag of the
27124 glyph row. This is used to optimize X output code. */
27125 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
27126 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27128 if (! stretched_p
&& it
->pixel_width
== 0)
27129 /* We assure that all visible glyphs have at least 1-pixel
27131 it
->pixel_width
= 1;
27133 else if (it
->char_to_display
== '\n')
27135 /* A newline has no width, but we need the height of the
27136 line. But if previous part of the line sets a height,
27137 don't increase that height. */
27139 Lisp_Object height
;
27140 Lisp_Object total_height
= Qnil
;
27142 it
->override_ascent
= -1;
27143 it
->pixel_width
= 0;
27146 height
= get_it_property (it
, Qline_height
);
27147 /* Split (line-height total-height) list. */
27149 && CONSP (XCDR (height
))
27150 && NILP (XCDR (XCDR (height
))))
27152 total_height
= XCAR (XCDR (height
));
27153 height
= XCAR (height
);
27155 height
= calc_line_height_property (it
, height
, font
, boff
, true);
27157 if (it
->override_ascent
>= 0)
27159 it
->ascent
= it
->override_ascent
;
27160 it
->descent
= it
->override_descent
;
27161 boff
= it
->override_boff
;
27165 if (FONT_TOO_HIGH (font
))
27167 it
->ascent
= font
->pixel_size
+ boff
- 1;
27168 it
->descent
= -boff
+ 1;
27169 if (it
->descent
< 0)
27174 it
->ascent
= FONT_BASE (font
) + boff
;
27175 it
->descent
= FONT_DESCENT (font
) - boff
;
27179 if (EQ (height
, Qt
))
27181 if (it
->descent
> it
->max_descent
)
27183 it
->ascent
+= it
->descent
- it
->max_descent
;
27184 it
->descent
= it
->max_descent
;
27186 if (it
->ascent
> it
->max_ascent
)
27188 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
27189 it
->ascent
= it
->max_ascent
;
27191 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
27192 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
27193 it
->constrain_row_ascent_descent_p
= true;
27194 extra_line_spacing
= 0;
27198 Lisp_Object spacing
;
27200 it
->phys_ascent
= it
->ascent
;
27201 it
->phys_descent
= it
->descent
;
27203 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
27204 && face
->box
!= FACE_NO_BOX
27205 && face
->box_line_width
> 0)
27207 it
->ascent
+= face
->box_line_width
;
27208 it
->descent
+= face
->box_line_width
;
27211 && XINT (height
) > it
->ascent
+ it
->descent
)
27212 it
->ascent
= XINT (height
) - it
->descent
;
27214 if (!NILP (total_height
))
27215 spacing
= calc_line_height_property (it
, total_height
, font
,
27219 spacing
= get_it_property (it
, Qline_spacing
);
27220 spacing
= calc_line_height_property (it
, spacing
, font
,
27223 if (INTEGERP (spacing
))
27225 extra_line_spacing
= XINT (spacing
);
27226 if (!NILP (total_height
))
27227 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
27231 else /* i.e. (it->char_to_display == '\t') */
27233 if (font
->space_width
> 0)
27235 int tab_width
= it
->tab_width
* font
->space_width
;
27236 int x
= it
->current_x
+ it
->continuation_lines_width
;
27237 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
27239 /* If the distance from the current position to the next tab
27240 stop is less than a space character width, use the
27241 tab stop after that. */
27242 if (next_tab_x
- x
< font
->space_width
)
27243 next_tab_x
+= tab_width
;
27245 it
->pixel_width
= next_tab_x
- x
;
27247 if (FONT_TOO_HIGH (font
))
27249 if (get_char_glyph_code (' ', font
, &char2b
))
27251 pcm
= get_per_char_metric (font
, &char2b
);
27252 if (pcm
->width
== 0
27253 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
27259 it
->ascent
= pcm
->ascent
+ boff
;
27260 it
->descent
= pcm
->descent
- boff
;
27264 it
->ascent
= font
->pixel_size
+ boff
- 1;
27265 it
->descent
= -boff
+ 1;
27267 if (it
->ascent
< 0)
27269 if (it
->descent
< 0)
27274 it
->ascent
= FONT_BASE (font
) + boff
;
27275 it
->descent
= FONT_DESCENT (font
) - boff
;
27277 it
->phys_ascent
= it
->ascent
;
27278 it
->phys_descent
= it
->descent
;
27282 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
27283 it
->ascent
+ it
->descent
, it
->ascent
);
27288 it
->pixel_width
= 0;
27293 if (FONT_TOO_HIGH (font
))
27295 int font_ascent
, font_descent
;
27297 /* For very large fonts, where we ignore the declared font
27298 dimensions, and go by per-character metrics instead,
27299 don't let the row ascent and descent values (and the row
27300 height computed from them) be smaller than the "normal"
27301 character metrics. This avoids unpleasant effects
27302 whereby lines on display would change their height
27303 depending on which characters are shown. */
27304 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
27305 it
->max_ascent
= max (it
->max_ascent
, font_ascent
);
27306 it
->max_descent
= max (it
->max_descent
, font_descent
);
27309 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
27311 /* A static composition.
27313 Note: A composition is represented as one glyph in the
27314 glyph matrix. There are no padding glyphs.
27316 Important note: pixel_width, ascent, and descent are the
27317 values of what is drawn by draw_glyphs (i.e. the values of
27318 the overall glyphs composed). */
27319 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27320 int boff
; /* baseline offset */
27321 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
27322 int glyph_len
= cmp
->glyph_len
;
27323 struct font
*font
= face
->font
;
27327 /* If we have not yet calculated pixel size data of glyphs of
27328 the composition for the current face font, calculate them
27329 now. Theoretically, we have to check all fonts for the
27330 glyphs, but that requires much time and memory space. So,
27331 here we check only the font of the first glyph. This may
27332 lead to incorrect display, but it's very rare, and C-l
27333 (recenter-top-bottom) can correct the display anyway. */
27334 if (! cmp
->font
|| cmp
->font
!= font
)
27336 /* Ascent and descent of the font of the first character
27337 of this composition (adjusted by baseline offset).
27338 Ascent and descent of overall glyphs should not be less
27339 than these, respectively. */
27340 int font_ascent
, font_descent
, font_height
;
27341 /* Bounding box of the overall glyphs. */
27342 int leftmost
, rightmost
, lowest
, highest
;
27343 int lbearing
, rbearing
;
27344 int i
, width
, ascent
, descent
;
27347 struct font_metrics
*pcm
;
27350 eassume (0 < glyph_len
); /* See Bug#8512. */
27352 c
= COMPOSITION_GLYPH (cmp
, --glyph_len
);
27353 while (c
== '\t' && 0 < glyph_len
);
27355 bool right_padded
= glyph_len
< cmp
->glyph_len
;
27356 for (i
= 0; i
< glyph_len
; i
++)
27358 c
= COMPOSITION_GLYPH (cmp
, i
);
27361 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
27363 bool left_padded
= i
> 0;
27365 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
27366 : IT_CHARPOS (*it
));
27367 /* If no suitable font is found, use the default font. */
27368 bool font_not_found_p
= font
== NULL
;
27369 if (font_not_found_p
)
27371 face
= face
->ascii_face
;
27374 boff
= font
->baseline_offset
;
27375 if (font
->vertical_centering
)
27376 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
27377 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
27378 font_ascent
+= boff
;
27379 font_descent
-= boff
;
27380 font_height
= font_ascent
+ font_descent
;
27385 if (! font_not_found_p
)
27387 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
27389 pcm
= get_per_char_metric (font
, &char2b
);
27392 /* Initialize the bounding box. */
27395 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
27396 ascent
= pcm
->ascent
;
27397 descent
= pcm
->descent
;
27398 lbearing
= pcm
->lbearing
;
27399 rbearing
= pcm
->rbearing
;
27403 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
27404 ascent
= FONT_BASE (font
);
27405 descent
= FONT_DESCENT (font
);
27412 lowest
= - descent
+ boff
;
27413 highest
= ascent
+ boff
;
27415 if (! font_not_found_p
27416 && font
->default_ascent
27417 && CHAR_TABLE_P (Vuse_default_ascent
)
27418 && !NILP (Faref (Vuse_default_ascent
,
27419 make_number (it
->char_to_display
))))
27420 highest
= font
->default_ascent
+ boff
;
27422 /* Draw the first glyph at the normal position. It may be
27423 shifted to right later if some other glyphs are drawn
27425 cmp
->offsets
[i
* 2] = 0;
27426 cmp
->offsets
[i
* 2 + 1] = boff
;
27427 cmp
->lbearing
= lbearing
;
27428 cmp
->rbearing
= rbearing
;
27430 /* Set cmp->offsets for the remaining glyphs. */
27431 for (i
++; i
< glyph_len
; i
++)
27433 int left
, right
, btm
, top
;
27434 int ch
= COMPOSITION_GLYPH (cmp
, i
);
27436 struct face
*this_face
;
27440 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
27441 this_face
= FACE_FROM_ID (it
->f
, face_id
);
27442 font
= this_face
->font
;
27448 get_char_face_and_encoding (it
->f
, ch
, face_id
,
27450 pcm
= get_per_char_metric (font
, &char2b
);
27453 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
27456 width
= pcm
->width
;
27457 ascent
= pcm
->ascent
;
27458 descent
= pcm
->descent
;
27459 lbearing
= pcm
->lbearing
;
27460 rbearing
= pcm
->rbearing
;
27461 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
27463 /* Relative composition with or without
27464 alternate chars. */
27465 left
= (leftmost
+ rightmost
- width
) / 2;
27466 btm
= - descent
+ boff
;
27467 if (font
->relative_compose
27468 && (! CHAR_TABLE_P (Vignore_relative_composition
)
27469 || NILP (Faref (Vignore_relative_composition
,
27470 make_number (ch
)))))
27473 if (- descent
>= font
->relative_compose
)
27474 /* One extra pixel between two glyphs. */
27476 else if (ascent
<= 0)
27477 /* One extra pixel between two glyphs. */
27478 btm
= lowest
- 1 - ascent
- descent
;
27483 /* A composition rule is specified by an integer
27484 value that encodes global and new reference
27485 points (GREF and NREF). GREF and NREF are
27486 specified by numbers as below:
27488 0---1---2 -- ascent
27492 9--10--11 -- center
27494 ---3---4---5--- baseline
27496 6---7---8 -- descent
27498 int rule
= COMPOSITION_RULE (cmp
, i
);
27499 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
27501 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
27502 grefx
= gref
% 3, nrefx
= nref
% 3;
27503 grefy
= gref
/ 3, nrefy
= nref
/ 3;
27505 xoff
= font_height
* (xoff
- 128) / 256;
27507 yoff
= font_height
* (yoff
- 128) / 256;
27510 + grefx
* (rightmost
- leftmost
) / 2
27511 - nrefx
* width
/ 2
27514 btm
= ((grefy
== 0 ? highest
27516 : grefy
== 2 ? lowest
27517 : (highest
+ lowest
) / 2)
27518 - (nrefy
== 0 ? ascent
+ descent
27519 : nrefy
== 1 ? descent
- boff
27521 : (ascent
+ descent
) / 2)
27525 cmp
->offsets
[i
* 2] = left
;
27526 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
27528 /* Update the bounding box of the overall glyphs. */
27531 right
= left
+ width
;
27532 if (left
< leftmost
)
27534 if (right
> rightmost
)
27537 top
= btm
+ descent
+ ascent
;
27543 if (cmp
->lbearing
> left
+ lbearing
)
27544 cmp
->lbearing
= left
+ lbearing
;
27545 if (cmp
->rbearing
< left
+ rbearing
)
27546 cmp
->rbearing
= left
+ rbearing
;
27550 /* If there are glyphs whose x-offsets are negative,
27551 shift all glyphs to the right and make all x-offsets
27555 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27556 cmp
->offsets
[i
* 2] -= leftmost
;
27557 rightmost
-= leftmost
;
27558 cmp
->lbearing
-= leftmost
;
27559 cmp
->rbearing
-= leftmost
;
27562 if (left_padded
&& cmp
->lbearing
< 0)
27564 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27565 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
27566 rightmost
-= cmp
->lbearing
;
27567 cmp
->rbearing
-= cmp
->lbearing
;
27570 if (right_padded
&& rightmost
< cmp
->rbearing
)
27572 rightmost
= cmp
->rbearing
;
27575 cmp
->pixel_width
= rightmost
;
27576 cmp
->ascent
= highest
;
27577 cmp
->descent
= - lowest
;
27578 if (cmp
->ascent
< font_ascent
)
27579 cmp
->ascent
= font_ascent
;
27580 if (cmp
->descent
< font_descent
)
27581 cmp
->descent
= font_descent
;
27585 && (cmp
->lbearing
< 0
27586 || cmp
->rbearing
> cmp
->pixel_width
))
27587 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27589 it
->pixel_width
= cmp
->pixel_width
;
27590 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
27591 it
->descent
= it
->phys_descent
= cmp
->descent
;
27592 if (face
->box
!= FACE_NO_BOX
)
27594 int thick
= face
->box_line_width
;
27598 it
->ascent
+= thick
;
27599 it
->descent
+= thick
;
27604 if (it
->start_of_box_run_p
)
27605 it
->pixel_width
+= thick
;
27606 if (it
->end_of_box_run_p
)
27607 it
->pixel_width
+= thick
;
27610 /* If face has an overline, add the height of the overline
27611 (1 pixel) and a 1 pixel margin to the character height. */
27612 if (face
->overline_p
)
27613 it
->ascent
+= overline_margin
;
27615 take_vertical_position_into_account (it
);
27616 if (it
->ascent
< 0)
27618 if (it
->descent
< 0)
27621 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
27622 append_composite_glyph (it
);
27624 else if (it
->what
== IT_COMPOSITION
)
27626 /* A dynamic (automatic) composition. */
27627 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27628 Lisp_Object gstring
;
27629 struct font_metrics metrics
;
27633 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
27635 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
27638 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
27639 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27640 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
27641 it
->descent
= it
->phys_descent
= metrics
.descent
;
27642 if (face
->box
!= FACE_NO_BOX
)
27644 int thick
= face
->box_line_width
;
27648 it
->ascent
+= thick
;
27649 it
->descent
+= thick
;
27654 if (it
->start_of_box_run_p
)
27655 it
->pixel_width
+= thick
;
27656 if (it
->end_of_box_run_p
)
27657 it
->pixel_width
+= thick
;
27659 /* If face has an overline, add the height of the overline
27660 (1 pixel) and a 1 pixel margin to the character height. */
27661 if (face
->overline_p
)
27662 it
->ascent
+= overline_margin
;
27663 take_vertical_position_into_account (it
);
27664 if (it
->ascent
< 0)
27666 if (it
->descent
< 0)
27670 append_composite_glyph (it
);
27672 else if (it
->what
== IT_GLYPHLESS
)
27673 produce_glyphless_glyph (it
, false, Qnil
);
27674 else if (it
->what
== IT_IMAGE
)
27675 produce_image_glyph (it
);
27676 else if (it
->what
== IT_STRETCH
)
27677 produce_stretch_glyph (it
);
27678 else if (it
->what
== IT_XWIDGET
)
27679 produce_xwidget_glyph (it
);
27682 /* Accumulate dimensions. Note: can't assume that it->descent > 0
27683 because this isn't true for images with `:ascent 100'. */
27684 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
27685 if (it
->area
== TEXT_AREA
)
27686 it
->current_x
+= it
->pixel_width
;
27688 if (extra_line_spacing
> 0)
27690 it
->descent
+= extra_line_spacing
;
27691 if (extra_line_spacing
> it
->max_extra_line_spacing
)
27692 it
->max_extra_line_spacing
= extra_line_spacing
;
27695 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
27696 it
->max_descent
= max (it
->max_descent
, it
->descent
);
27697 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
27698 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
27702 Output LEN glyphs starting at START at the nominal cursor position.
27703 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
27704 being updated, and UPDATED_AREA is the area of that row being updated. */
27707 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27708 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27710 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
27712 eassert (updated_row
);
27713 /* When the window is hscrolled, cursor hpos can legitimately be out
27714 of bounds, but we draw the cursor at the corresponding window
27715 margin in that case. */
27716 if (!updated_row
->reversed_p
&& chpos
< 0)
27718 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
27719 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
27723 /* Write glyphs. */
27725 hpos
= start
- updated_row
->glyphs
[updated_area
];
27726 x
= draw_glyphs (w
, w
->output_cursor
.x
,
27727 updated_row
, updated_area
,
27729 DRAW_NORMAL_TEXT
, 0);
27731 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
27732 if (updated_area
== TEXT_AREA
27733 && w
->phys_cursor_on_p
27734 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
27736 && chpos
< hpos
+ len
)
27737 w
->phys_cursor_on_p
= false;
27741 /* Advance the output cursor. */
27742 w
->output_cursor
.hpos
+= len
;
27743 w
->output_cursor
.x
= x
;
27748 Insert LEN glyphs from START at the nominal cursor position. */
27751 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27752 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27755 int line_height
, shift_by_width
, shifted_region_width
;
27756 struct glyph_row
*row
;
27757 struct glyph
*glyph
;
27758 int frame_x
, frame_y
;
27761 eassert (updated_row
);
27763 f
= XFRAME (WINDOW_FRAME (w
));
27765 /* Get the height of the line we are in. */
27767 line_height
= row
->height
;
27769 /* Get the width of the glyphs to insert. */
27770 shift_by_width
= 0;
27771 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
27772 shift_by_width
+= glyph
->pixel_width
;
27774 /* Get the width of the region to shift right. */
27775 shifted_region_width
= (window_box_width (w
, updated_area
)
27776 - w
->output_cursor
.x
27780 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
27781 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
27783 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
27784 line_height
, shift_by_width
);
27786 /* Write the glyphs. */
27787 hpos
= start
- row
->glyphs
[updated_area
];
27788 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
27790 DRAW_NORMAL_TEXT
, 0);
27792 /* Advance the output cursor. */
27793 w
->output_cursor
.hpos
+= len
;
27794 w
->output_cursor
.x
+= shift_by_width
;
27800 Erase the current text line from the nominal cursor position
27801 (inclusive) to pixel column TO_X (exclusive). The idea is that
27802 everything from TO_X onward is already erased.
27804 TO_X is a pixel position relative to UPDATED_AREA of currently
27805 updated window W. TO_X == -1 means clear to the end of this area. */
27808 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
27809 enum glyph_row_area updated_area
, int to_x
)
27812 int max_x
, min_y
, max_y
;
27813 int from_x
, from_y
, to_y
;
27815 eassert (updated_row
);
27816 f
= XFRAME (w
->frame
);
27818 if (updated_row
->full_width_p
)
27819 max_x
= (WINDOW_PIXEL_WIDTH (w
)
27820 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
27822 max_x
= window_box_width (w
, updated_area
);
27823 max_y
= window_text_bottom_y (w
);
27825 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
27826 of window. For TO_X > 0, truncate to end of drawing area. */
27832 to_x
= min (to_x
, max_x
);
27834 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
27836 /* Notice if the cursor will be cleared by this operation. */
27837 if (!updated_row
->full_width_p
)
27838 notice_overwritten_cursor (w
, updated_area
,
27839 w
->output_cursor
.x
, -1,
27841 MATRIX_ROW_BOTTOM_Y (updated_row
));
27843 from_x
= w
->output_cursor
.x
;
27845 /* Translate to frame coordinates. */
27846 if (updated_row
->full_width_p
)
27848 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
27849 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
27853 int area_left
= window_box_left (w
, updated_area
);
27854 from_x
+= area_left
;
27858 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
27859 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
27860 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
27862 /* Prevent inadvertently clearing to end of the X window. */
27863 if (to_x
> from_x
&& to_y
> from_y
)
27866 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
27867 to_x
- from_x
, to_y
- from_y
);
27872 #endif /* HAVE_WINDOW_SYSTEM */
27876 /***********************************************************************
27878 ***********************************************************************/
27880 /* Value is the internal representation of the specified cursor type
27881 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27882 of the bar cursor. */
27884 static enum text_cursor_kinds
27885 get_specified_cursor_type (Lisp_Object arg
, int *width
)
27887 enum text_cursor_kinds type
;
27892 if (EQ (arg
, Qbox
))
27893 return FILLED_BOX_CURSOR
;
27895 if (EQ (arg
, Qhollow
))
27896 return HOLLOW_BOX_CURSOR
;
27898 if (EQ (arg
, Qbar
))
27905 && EQ (XCAR (arg
), Qbar
)
27906 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27908 *width
= XINT (XCDR (arg
));
27912 if (EQ (arg
, Qhbar
))
27915 return HBAR_CURSOR
;
27919 && EQ (XCAR (arg
), Qhbar
)
27920 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27922 *width
= XINT (XCDR (arg
));
27923 return HBAR_CURSOR
;
27926 /* Treat anything unknown as "hollow box cursor".
27927 It was bad to signal an error; people have trouble fixing
27928 .Xdefaults with Emacs, when it has something bad in it. */
27929 type
= HOLLOW_BOX_CURSOR
;
27934 /* Set the default cursor types for specified frame. */
27936 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27941 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27942 FRAME_CURSOR_WIDTH (f
) = width
;
27944 /* By default, set up the blink-off state depending on the on-state. */
27946 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27949 FRAME_BLINK_OFF_CURSOR (f
)
27950 = get_specified_cursor_type (XCDR (tem
), &width
);
27951 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27954 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27956 /* Make sure the cursor gets redrawn. */
27957 f
->cursor_type_changed
= true;
27961 #ifdef HAVE_WINDOW_SYSTEM
27963 /* Return the cursor we want to be displayed in window W. Return
27964 width of bar/hbar cursor through WIDTH arg. Return with
27965 ACTIVE_CURSOR arg set to true if cursor in window W is `active'
27966 (i.e. if the `system caret' should track this cursor).
27968 In a mini-buffer window, we want the cursor only to appear if we
27969 are reading input from this window. For the selected window, we
27970 want the cursor type given by the frame parameter or buffer local
27971 setting of cursor-type. If explicitly marked off, draw no cursor.
27972 In all other cases, we want a hollow box cursor. */
27974 static enum text_cursor_kinds
27975 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27976 bool *active_cursor
)
27978 struct frame
*f
= XFRAME (w
->frame
);
27979 struct buffer
*b
= XBUFFER (w
->contents
);
27980 int cursor_type
= DEFAULT_CURSOR
;
27981 Lisp_Object alt_cursor
;
27982 bool non_selected
= false;
27984 *active_cursor
= true;
27987 if (cursor_in_echo_area
27988 && FRAME_HAS_MINIBUF_P (f
)
27989 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27991 if (w
== XWINDOW (echo_area_window
))
27993 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27995 *width
= FRAME_CURSOR_WIDTH (f
);
27996 return FRAME_DESIRED_CURSOR (f
);
27999 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
28002 *active_cursor
= false;
28003 non_selected
= true;
28006 /* Detect a nonselected window or nonselected frame. */
28007 else if (w
!= XWINDOW (f
->selected_window
)
28008 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
28010 *active_cursor
= false;
28012 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
28015 non_selected
= true;
28018 /* Never display a cursor in a window in which cursor-type is nil. */
28019 if (NILP (BVAR (b
, cursor_type
)))
28022 /* Get the normal cursor type for this window. */
28023 if (EQ (BVAR (b
, cursor_type
), Qt
))
28025 cursor_type
= FRAME_DESIRED_CURSOR (f
);
28026 *width
= FRAME_CURSOR_WIDTH (f
);
28029 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
28031 /* Use cursor-in-non-selected-windows instead
28032 for non-selected window or frame. */
28035 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
28036 if (!EQ (Qt
, alt_cursor
))
28037 return get_specified_cursor_type (alt_cursor
, width
);
28038 /* t means modify the normal cursor type. */
28039 if (cursor_type
== FILLED_BOX_CURSOR
)
28040 cursor_type
= HOLLOW_BOX_CURSOR
;
28041 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
28043 return cursor_type
;
28046 /* Use normal cursor if not blinked off. */
28047 if (!w
->cursor_off_p
)
28049 if (glyph
!= NULL
&& glyph
->type
== XWIDGET_GLYPH
)
28051 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
28053 if (cursor_type
== FILLED_BOX_CURSOR
)
28055 /* Using a block cursor on large images can be very annoying.
28056 So use a hollow cursor for "large" images.
28057 If image is not transparent (no mask), also use hollow cursor. */
28058 struct image
*img
= IMAGE_OPT_FROM_ID (f
, glyph
->u
.img_id
);
28059 if (img
!= NULL
&& IMAGEP (img
->spec
))
28061 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
28062 where N = size of default frame font size.
28063 This should cover most of the "tiny" icons people may use. */
28065 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
28066 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
28067 cursor_type
= HOLLOW_BOX_CURSOR
;
28070 else if (cursor_type
!= NO_CURSOR
)
28072 /* Display current only supports BOX and HOLLOW cursors for images.
28073 So for now, unconditionally use a HOLLOW cursor when cursor is
28074 not a solid box cursor. */
28075 cursor_type
= HOLLOW_BOX_CURSOR
;
28078 return cursor_type
;
28081 /* Cursor is blinked off, so determine how to "toggle" it. */
28083 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
28084 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
28085 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
28087 /* Then see if frame has specified a specific blink off cursor type. */
28088 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
28090 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
28091 return FRAME_BLINK_OFF_CURSOR (f
);
28095 /* Some people liked having a permanently visible blinking cursor,
28096 while others had very strong opinions against it. So it was
28097 decided to remove it. KFS 2003-09-03 */
28099 /* Finally perform built-in cursor blinking:
28100 filled box <-> hollow box
28101 wide [h]bar <-> narrow [h]bar
28102 narrow [h]bar <-> no cursor
28103 other type <-> no cursor */
28105 if (cursor_type
== FILLED_BOX_CURSOR
)
28106 return HOLLOW_BOX_CURSOR
;
28108 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
28111 return cursor_type
;
28119 /* Notice when the text cursor of window W has been completely
28120 overwritten by a drawing operation that outputs glyphs in AREA
28121 starting at X0 and ending at X1 in the line starting at Y0 and
28122 ending at Y1. X coordinates are area-relative. X1 < 0 means all
28123 the rest of the line after X0 has been written. Y coordinates
28124 are window-relative. */
28127 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
28128 int x0
, int x1
, int y0
, int y1
)
28130 int cx0
, cx1
, cy0
, cy1
;
28131 struct glyph_row
*row
;
28133 if (!w
->phys_cursor_on_p
)
28135 if (area
!= TEXT_AREA
)
28138 if (w
->phys_cursor
.vpos
< 0
28139 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
28140 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
28141 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
28144 if (row
->cursor_in_fringe_p
)
28146 row
->cursor_in_fringe_p
= false;
28147 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
28148 w
->phys_cursor_on_p
= false;
28152 cx0
= w
->phys_cursor
.x
;
28153 cx1
= cx0
+ w
->phys_cursor_width
;
28154 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
28157 /* The cursor image will be completely removed from the
28158 screen if the output area intersects the cursor area in
28159 y-direction. When we draw in [y0 y1[, and some part of
28160 the cursor is at y < y0, that part must have been drawn
28161 before. When scrolling, the cursor is erased before
28162 actually scrolling, so we don't come here. When not
28163 scrolling, the rows above the old cursor row must have
28164 changed, and in this case these rows must have written
28165 over the cursor image.
28167 Likewise if part of the cursor is below y1, with the
28168 exception of the cursor being in the first blank row at
28169 the buffer and window end because update_text_area
28170 doesn't draw that row. (Except when it does, but
28171 that's handled in update_text_area.) */
28173 cy0
= w
->phys_cursor
.y
;
28174 cy1
= cy0
+ w
->phys_cursor_height
;
28175 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
28178 w
->phys_cursor_on_p
= false;
28181 #endif /* HAVE_WINDOW_SYSTEM */
28184 /************************************************************************
28186 ************************************************************************/
28188 #ifdef HAVE_WINDOW_SYSTEM
28191 Fix the display of area AREA of overlapping row ROW in window W
28192 with respect to the overlapping part OVERLAPS. */
28195 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
28196 enum glyph_row_area area
, int overlaps
)
28203 for (i
= 0; i
< row
->used
[area
];)
28205 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
28207 int start
= i
, start_x
= x
;
28211 x
+= row
->glyphs
[area
][i
].pixel_width
;
28214 while (i
< row
->used
[area
]
28215 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
28217 draw_glyphs (w
, start_x
, row
, area
,
28219 DRAW_NORMAL_TEXT
, overlaps
);
28223 x
+= row
->glyphs
[area
][i
].pixel_width
;
28233 Draw the cursor glyph of window W in glyph row ROW. See the
28234 comment of draw_glyphs for the meaning of HL. */
28237 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
28238 enum draw_glyphs_face hl
)
28240 /* If cursor hpos is out of bounds, don't draw garbage. This can
28241 happen in mini-buffer windows when switching between echo area
28242 glyphs and mini-buffer. */
28243 if ((row
->reversed_p
28244 ? (w
->phys_cursor
.hpos
>= 0)
28245 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
28247 bool on_p
= w
->phys_cursor_on_p
;
28249 int hpos
= w
->phys_cursor
.hpos
;
28251 /* When the window is hscrolled, cursor hpos can legitimately be
28252 out of bounds, but we draw the cursor at the corresponding
28253 window margin in that case. */
28254 if (!row
->reversed_p
&& hpos
< 0)
28256 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28257 hpos
= row
->used
[TEXT_AREA
] - 1;
28259 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
28261 w
->phys_cursor_on_p
= on_p
;
28263 if (hl
== DRAW_CURSOR
)
28264 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
28265 /* When we erase the cursor, and ROW is overlapped by other
28266 rows, make sure that these overlapping parts of other rows
28268 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
28270 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
28272 if (row
> w
->current_matrix
->rows
28273 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
28274 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
28275 OVERLAPS_ERASED_CURSOR
);
28277 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
28278 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
28279 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
28280 OVERLAPS_ERASED_CURSOR
);
28286 /* Erase the image of a cursor of window W from the screen. */
28289 erase_phys_cursor (struct window
*w
)
28291 struct frame
*f
= XFRAME (w
->frame
);
28292 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28293 int hpos
= w
->phys_cursor
.hpos
;
28294 int vpos
= w
->phys_cursor
.vpos
;
28295 bool mouse_face_here_p
= false;
28296 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
28297 struct glyph_row
*cursor_row
;
28298 struct glyph
*cursor_glyph
;
28299 enum draw_glyphs_face hl
;
28301 /* No cursor displayed or row invalidated => nothing to do on the
28303 if (w
->phys_cursor_type
== NO_CURSOR
)
28304 goto mark_cursor_off
;
28306 /* VPOS >= active_glyphs->nrows means that window has been resized.
28307 Don't bother to erase the cursor. */
28308 if (vpos
>= active_glyphs
->nrows
)
28309 goto mark_cursor_off
;
28311 /* If row containing cursor is marked invalid, there is nothing we
28313 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
28314 if (!cursor_row
->enabled_p
)
28315 goto mark_cursor_off
;
28317 /* If line spacing is > 0, old cursor may only be partially visible in
28318 window after split-window. So adjust visible height. */
28319 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
28320 window_text_bottom_y (w
) - cursor_row
->y
);
28322 /* If row is completely invisible, don't attempt to delete a cursor which
28323 isn't there. This can happen if cursor is at top of a window, and
28324 we switch to a buffer with a header line in that window. */
28325 if (cursor_row
->visible_height
<= 0)
28326 goto mark_cursor_off
;
28328 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
28329 if (cursor_row
->cursor_in_fringe_p
)
28331 cursor_row
->cursor_in_fringe_p
= false;
28332 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
28333 goto mark_cursor_off
;
28336 /* This can happen when the new row is shorter than the old one.
28337 In this case, either draw_glyphs or clear_end_of_line
28338 should have cleared the cursor. Note that we wouldn't be
28339 able to erase the cursor in this case because we don't have a
28340 cursor glyph at hand. */
28341 if ((cursor_row
->reversed_p
28342 ? (w
->phys_cursor
.hpos
< 0)
28343 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
28344 goto mark_cursor_off
;
28346 /* When the window is hscrolled, cursor hpos can legitimately be out
28347 of bounds, but we draw the cursor at the corresponding window
28348 margin in that case. */
28349 if (!cursor_row
->reversed_p
&& hpos
< 0)
28351 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
28352 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
28354 /* If the cursor is in the mouse face area, redisplay that when
28355 we clear the cursor. */
28356 if (! NILP (hlinfo
->mouse_face_window
)
28357 && coords_in_mouse_face_p (w
, hpos
, vpos
)
28358 /* Don't redraw the cursor's spot in mouse face if it is at the
28359 end of a line (on a newline). The cursor appears there, but
28360 mouse highlighting does not. */
28361 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
28362 mouse_face_here_p
= true;
28364 /* Maybe clear the display under the cursor. */
28365 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
28368 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
28371 cursor_glyph
= get_phys_cursor_glyph (w
);
28372 if (cursor_glyph
== NULL
)
28373 goto mark_cursor_off
;
28375 width
= cursor_glyph
->pixel_width
;
28376 x
= w
->phys_cursor
.x
;
28382 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
28383 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
28384 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
28387 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
28390 /* Erase the cursor by redrawing the character underneath it. */
28391 if (mouse_face_here_p
)
28392 hl
= DRAW_MOUSE_FACE
;
28394 hl
= DRAW_NORMAL_TEXT
;
28395 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
28398 w
->phys_cursor_on_p
= false;
28399 w
->phys_cursor_type
= NO_CURSOR
;
28403 /* Display or clear cursor of window W. If !ON, clear the cursor.
28404 If ON, display the cursor; where to put the cursor is specified by
28405 HPOS, VPOS, X and Y. */
28408 display_and_set_cursor (struct window
*w
, bool on
,
28409 int hpos
, int vpos
, int x
, int y
)
28411 struct frame
*f
= XFRAME (w
->frame
);
28412 int new_cursor_type
;
28413 int new_cursor_width
;
28414 bool active_cursor
;
28415 struct glyph_row
*glyph_row
;
28416 struct glyph
*glyph
;
28418 /* This is pointless on invisible frames, and dangerous on garbaged
28419 windows and frames; in the latter case, the frame or window may
28420 be in the midst of changing its size, and x and y may be off the
28422 if (! FRAME_VISIBLE_P (f
)
28423 || FRAME_GARBAGED_P (f
)
28424 || vpos
>= w
->current_matrix
->nrows
28425 || hpos
>= w
->current_matrix
->matrix_w
)
28428 /* If cursor is off and we want it off, return quickly. */
28429 if (!on
&& !w
->phys_cursor_on_p
)
28432 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28433 /* If cursor row is not enabled, we don't really know where to
28434 display the cursor. */
28435 if (!glyph_row
->enabled_p
)
28437 w
->phys_cursor_on_p
= false;
28442 if (!glyph_row
->exact_window_width_line_p
28443 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
28444 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
28446 eassert (input_blocked_p ());
28448 /* Set new_cursor_type to the cursor we want to be displayed. */
28449 new_cursor_type
= get_window_cursor_type (w
, glyph
,
28450 &new_cursor_width
, &active_cursor
);
28452 /* If cursor is currently being shown and we don't want it to be or
28453 it is in the wrong place, or the cursor type is not what we want,
28455 if (w
->phys_cursor_on_p
28457 || w
->phys_cursor
.x
!= x
28458 || w
->phys_cursor
.y
!= y
28459 /* HPOS can be negative in R2L rows whose
28460 exact_window_width_line_p flag is set (i.e. their newline
28461 would "overflow into the fringe"). */
28463 || new_cursor_type
!= w
->phys_cursor_type
28464 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
28465 && new_cursor_width
!= w
->phys_cursor_width
)))
28466 erase_phys_cursor (w
);
28468 /* Don't check phys_cursor_on_p here because that flag is only set
28469 to false in some cases where we know that the cursor has been
28470 completely erased, to avoid the extra work of erasing the cursor
28471 twice. In other words, phys_cursor_on_p can be true and the cursor
28472 still not be visible, or it has only been partly erased. */
28475 w
->phys_cursor_ascent
= glyph_row
->ascent
;
28476 w
->phys_cursor_height
= glyph_row
->height
;
28478 /* Set phys_cursor_.* before x_draw_.* is called because some
28479 of them may need the information. */
28480 w
->phys_cursor
.x
= x
;
28481 w
->phys_cursor
.y
= glyph_row
->y
;
28482 w
->phys_cursor
.hpos
= hpos
;
28483 w
->phys_cursor
.vpos
= vpos
;
28486 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
28487 new_cursor_type
, new_cursor_width
,
28488 on
, active_cursor
);
28492 /* Switch the display of W's cursor on or off, according to the value
28496 update_window_cursor (struct window
*w
, bool on
)
28498 /* Don't update cursor in windows whose frame is in the process
28499 of being deleted. */
28500 if (w
->current_matrix
)
28502 int hpos
= w
->phys_cursor
.hpos
;
28503 int vpos
= w
->phys_cursor
.vpos
;
28504 struct glyph_row
*row
;
28506 if (vpos
>= w
->current_matrix
->nrows
28507 || hpos
>= w
->current_matrix
->matrix_w
)
28510 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28512 /* When the window is hscrolled, cursor hpos can legitimately be
28513 out of bounds, but we draw the cursor at the corresponding
28514 window margin in that case. */
28515 if (!row
->reversed_p
&& hpos
< 0)
28517 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28518 hpos
= row
->used
[TEXT_AREA
] - 1;
28521 display_and_set_cursor (w
, on
, hpos
, vpos
,
28522 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28528 /* Call update_window_cursor with parameter ON_P on all leaf windows
28529 in the window tree rooted at W. */
28532 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
28536 if (WINDOWP (w
->contents
))
28537 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
28539 update_window_cursor (w
, on_p
);
28541 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
28547 Display the cursor on window W, or clear it, according to ON_P.
28548 Don't change the cursor's position. */
28551 x_update_cursor (struct frame
*f
, bool on_p
)
28553 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
28558 Clear the cursor of window W to background color, and mark the
28559 cursor as not shown. This is used when the text where the cursor
28560 is about to be rewritten. */
28563 x_clear_cursor (struct window
*w
)
28565 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
28566 update_window_cursor (w
, false);
28569 #endif /* HAVE_WINDOW_SYSTEM */
28571 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
28574 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
28575 int start_hpos
, int end_hpos
,
28576 enum draw_glyphs_face draw
)
28578 #ifdef HAVE_WINDOW_SYSTEM
28579 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
28581 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
28585 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
28586 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
28590 /* Display the active region described by mouse_face_* according to DRAW. */
28593 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
28595 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
28596 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28598 if (/* If window is in the process of being destroyed, don't bother
28600 w
->current_matrix
!= NULL
28601 /* Don't update mouse highlight if hidden. */
28602 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
28603 /* Recognize when we are called to operate on rows that don't exist
28604 anymore. This can happen when a window is split. */
28605 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
28607 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
28608 struct glyph_row
*row
, *first
, *last
;
28610 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
28611 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
28613 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
28615 int start_hpos
, end_hpos
, start_x
;
28617 /* For all but the first row, the highlight starts at column 0. */
28620 /* R2L rows have BEG and END in reversed order, but the
28621 screen drawing geometry is always left to right. So
28622 we need to mirror the beginning and end of the
28623 highlighted area in R2L rows. */
28624 if (!row
->reversed_p
)
28626 start_hpos
= hlinfo
->mouse_face_beg_col
;
28627 start_x
= hlinfo
->mouse_face_beg_x
;
28629 else if (row
== last
)
28631 start_hpos
= hlinfo
->mouse_face_end_col
;
28632 start_x
= hlinfo
->mouse_face_end_x
;
28640 else if (row
->reversed_p
&& row
== last
)
28642 start_hpos
= hlinfo
->mouse_face_end_col
;
28643 start_x
= hlinfo
->mouse_face_end_x
;
28653 if (!row
->reversed_p
)
28654 end_hpos
= hlinfo
->mouse_face_end_col
;
28655 else if (row
== first
)
28656 end_hpos
= hlinfo
->mouse_face_beg_col
;
28659 end_hpos
= row
->used
[TEXT_AREA
];
28660 if (draw
== DRAW_NORMAL_TEXT
)
28661 row
->fill_line_p
= true; /* Clear to end of line. */
28664 else if (row
->reversed_p
&& row
== first
)
28665 end_hpos
= hlinfo
->mouse_face_beg_col
;
28668 end_hpos
= row
->used
[TEXT_AREA
];
28669 if (draw
== DRAW_NORMAL_TEXT
)
28670 row
->fill_line_p
= true; /* Clear to end of line. */
28673 if (end_hpos
> start_hpos
)
28675 draw_row_with_mouse_face (w
, start_x
, row
,
28676 start_hpos
, end_hpos
, draw
);
28679 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
28683 #ifdef HAVE_WINDOW_SYSTEM
28684 /* When we've written over the cursor, arrange for it to
28685 be displayed again. */
28686 if (FRAME_WINDOW_P (f
)
28687 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
28689 int hpos
= w
->phys_cursor
.hpos
;
28691 /* When the window is hscrolled, cursor hpos can legitimately be
28692 out of bounds, but we draw the cursor at the corresponding
28693 window margin in that case. */
28694 if (!row
->reversed_p
&& hpos
< 0)
28696 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28697 hpos
= row
->used
[TEXT_AREA
] - 1;
28700 display_and_set_cursor (w
, true, hpos
, w
->phys_cursor
.vpos
,
28701 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28704 #endif /* HAVE_WINDOW_SYSTEM */
28707 #ifdef HAVE_WINDOW_SYSTEM
28708 /* Change the mouse cursor. */
28709 if (FRAME_WINDOW_P (f
) && NILP (do_mouse_tracking
))
28711 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
28712 if (draw
== DRAW_NORMAL_TEXT
28713 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
28714 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
28717 if (draw
== DRAW_MOUSE_FACE
)
28718 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
28720 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
28722 #endif /* HAVE_WINDOW_SYSTEM */
28726 Clear out the mouse-highlighted active region.
28727 Redraw it un-highlighted first. Value is true if mouse
28728 face was actually drawn unhighlighted. */
28731 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
28734 = !hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
);
28736 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
28737 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28738 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28739 hlinfo
->mouse_face_window
= Qnil
;
28740 hlinfo
->mouse_face_overlay
= Qnil
;
28744 /* Return true if the coordinates HPOS and VPOS on windows W are
28745 within the mouse face on that window. */
28747 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
28749 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28751 /* Quickly resolve the easy cases. */
28752 if (!(WINDOWP (hlinfo
->mouse_face_window
)
28753 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
28755 if (vpos
< hlinfo
->mouse_face_beg_row
28756 || vpos
> hlinfo
->mouse_face_end_row
)
28758 if (vpos
> hlinfo
->mouse_face_beg_row
28759 && vpos
< hlinfo
->mouse_face_end_row
)
28762 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
28764 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28766 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
28769 else if ((vpos
== hlinfo
->mouse_face_beg_row
28770 && hpos
>= hlinfo
->mouse_face_beg_col
)
28771 || (vpos
== hlinfo
->mouse_face_end_row
28772 && hpos
< hlinfo
->mouse_face_end_col
))
28777 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28779 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
28782 else if ((vpos
== hlinfo
->mouse_face_beg_row
28783 && hpos
<= hlinfo
->mouse_face_beg_col
)
28784 || (vpos
== hlinfo
->mouse_face_end_row
28785 && hpos
> hlinfo
->mouse_face_end_col
))
28793 True if physical cursor of window W is within mouse face. */
28796 cursor_in_mouse_face_p (struct window
*w
)
28798 int hpos
= w
->phys_cursor
.hpos
;
28799 int vpos
= w
->phys_cursor
.vpos
;
28800 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28802 /* When the window is hscrolled, cursor hpos can legitimately be out
28803 of bounds, but we draw the cursor at the corresponding window
28804 margin in that case. */
28805 if (!row
->reversed_p
&& hpos
< 0)
28807 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28808 hpos
= row
->used
[TEXT_AREA
] - 1;
28810 return coords_in_mouse_face_p (w
, hpos
, vpos
);
28815 /* Find the glyph rows START_ROW and END_ROW of window W that display
28816 characters between buffer positions START_CHARPOS and END_CHARPOS
28817 (excluding END_CHARPOS). DISP_STRING is a display string that
28818 covers these buffer positions. This is similar to
28819 row_containing_pos, but is more accurate when bidi reordering makes
28820 buffer positions change non-linearly with glyph rows. */
28822 rows_from_pos_range (struct window
*w
,
28823 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
28824 Lisp_Object disp_string
,
28825 struct glyph_row
**start
, struct glyph_row
**end
)
28827 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28828 int last_y
= window_text_bottom_y (w
);
28829 struct glyph_row
*row
;
28834 while (!first
->enabled_p
28835 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
28838 /* Find the START row. */
28840 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
28843 /* A row can potentially be the START row if the range of the
28844 characters it displays intersects the range
28845 [START_CHARPOS..END_CHARPOS). */
28846 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
28847 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
28848 /* See the commentary in row_containing_pos, for the
28849 explanation of the complicated way to check whether
28850 some position is beyond the end of the characters
28851 displayed by a row. */
28852 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28853 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28854 && !row
->ends_at_zv_p
28855 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
28856 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28857 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28858 && !row
->ends_at_zv_p
28859 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
28861 /* Found a candidate row. Now make sure at least one of the
28862 glyphs it displays has a charpos from the range
28863 [START_CHARPOS..END_CHARPOS).
28865 This is not obvious because bidi reordering could make
28866 buffer positions of a row be 1,2,3,102,101,100, and if we
28867 want to highlight characters in [50..60), we don't want
28868 this row, even though [50..60) does intersect [1..103),
28869 the range of character positions given by the row's start
28870 and end positions. */
28871 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
28872 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
28876 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28877 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28878 /* A glyph that comes from DISP_STRING is by
28879 definition to be highlighted. */
28880 || EQ (g
->object
, disp_string
))
28889 /* Find the END row. */
28891 /* If the last row is partially visible, start looking for END
28892 from that row, instead of starting from FIRST. */
28893 && !(row
->enabled_p
28894 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
28896 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
28898 struct glyph_row
*next
= row
+ 1;
28899 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
28901 if (!next
->enabled_p
28902 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
28903 /* The first row >= START whose range of displayed characters
28904 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28905 is the row END + 1. */
28906 || (start_charpos
< next_start
28907 && end_charpos
< next_start
)
28908 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28909 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28910 && !next
->ends_at_zv_p
28911 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28912 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28913 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28914 && !next
->ends_at_zv_p
28915 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28922 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28923 but none of the characters it displays are in the range, it is
28925 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28926 struct glyph
*s
= g
;
28927 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28931 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28932 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28933 /* If the buffer position of the first glyph in
28934 the row is equal to END_CHARPOS, it means
28935 the last character to be highlighted is the
28936 newline of ROW, and we must consider NEXT as
28938 || (((!next
->reversed_p
&& g
== s
)
28939 || (next
->reversed_p
&& g
== e
- 1))
28940 && (g
->charpos
== end_charpos
28941 /* Special case for when NEXT is an
28942 empty line at ZV. */
28943 || (g
->charpos
== -1
28944 && !row
->ends_at_zv_p
28945 && next_start
== end_charpos
)))))
28946 /* A glyph that comes from DISP_STRING is by
28947 definition to be highlighted. */
28948 || EQ (g
->object
, disp_string
))
28957 /* The first row that ends at ZV must be the last to be
28959 else if (next
->ends_at_zv_p
)
28968 /* This function sets the mouse_face_* elements of HLINFO, assuming
28969 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28970 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28971 for the overlay or run of text properties specifying the mouse
28972 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28973 before-string and after-string that must also be highlighted.
28974 DISP_STRING, if non-nil, is a display string that may cover some
28975 or all of the highlighted text. */
28978 mouse_face_from_buffer_pos (Lisp_Object window
,
28979 Mouse_HLInfo
*hlinfo
,
28980 ptrdiff_t mouse_charpos
,
28981 ptrdiff_t start_charpos
,
28982 ptrdiff_t end_charpos
,
28983 Lisp_Object before_string
,
28984 Lisp_Object after_string
,
28985 Lisp_Object disp_string
)
28987 struct window
*w
= XWINDOW (window
);
28988 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28989 struct glyph_row
*r1
, *r2
;
28990 struct glyph
*glyph
, *end
;
28991 ptrdiff_t ignore
, pos
;
28994 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28995 eassert (NILP (before_string
) || STRINGP (before_string
));
28996 eassert (NILP (after_string
) || STRINGP (after_string
));
28998 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28999 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
29001 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
29002 /* If the before-string or display-string contains newlines,
29003 rows_from_pos_range skips to its last row. Move back. */
29004 if (!NILP (before_string
) || !NILP (disp_string
))
29006 struct glyph_row
*prev
;
29007 while ((prev
= r1
- 1, prev
>= first
)
29008 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
29009 && prev
->used
[TEXT_AREA
] > 0)
29011 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
29012 glyph
= beg
+ prev
->used
[TEXT_AREA
];
29013 while (--glyph
>= beg
&& NILP (glyph
->object
));
29015 || !(EQ (glyph
->object
, before_string
)
29016 || EQ (glyph
->object
, disp_string
)))
29023 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
29024 hlinfo
->mouse_face_past_end
= true;
29026 else if (!NILP (after_string
))
29028 /* If the after-string has newlines, advance to its last row. */
29029 struct glyph_row
*next
;
29030 struct glyph_row
*last
29031 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
29033 for (next
= r2
+ 1;
29035 && next
->used
[TEXT_AREA
] > 0
29036 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
29040 /* The rest of the display engine assumes that mouse_face_beg_row is
29041 either above mouse_face_end_row or identical to it. But with
29042 bidi-reordered continued lines, the row for START_CHARPOS could
29043 be below the row for END_CHARPOS. If so, swap the rows and store
29044 them in correct order. */
29047 struct glyph_row
*tem
= r2
;
29053 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
29054 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
29056 /* For a bidi-reordered row, the positions of BEFORE_STRING,
29057 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
29058 could be anywhere in the row and in any order. The strategy
29059 below is to find the leftmost and the rightmost glyph that
29060 belongs to either of these 3 strings, or whose position is
29061 between START_CHARPOS and END_CHARPOS, and highlight all the
29062 glyphs between those two. This may cover more than just the text
29063 between START_CHARPOS and END_CHARPOS if the range of characters
29064 strides the bidi level boundary, e.g. if the beginning is in R2L
29065 text while the end is in L2R text or vice versa. */
29066 if (!r1
->reversed_p
)
29068 /* This row is in a left to right paragraph. Scan it left to
29070 glyph
= r1
->glyphs
[TEXT_AREA
];
29071 end
= glyph
+ r1
->used
[TEXT_AREA
];
29074 /* Skip truncation glyphs at the start of the glyph row. */
29075 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
29077 && NILP (glyph
->object
)
29078 && glyph
->charpos
< 0;
29080 x
+= glyph
->pixel_width
;
29082 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
29083 or DISP_STRING, and the first glyph from buffer whose
29084 position is between START_CHARPOS and END_CHARPOS. */
29086 && !NILP (glyph
->object
)
29087 && !EQ (glyph
->object
, disp_string
)
29088 && !(BUFFERP (glyph
->object
)
29089 && (glyph
->charpos
>= start_charpos
29090 && glyph
->charpos
< end_charpos
));
29093 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29094 are present at buffer positions between START_CHARPOS and
29095 END_CHARPOS, or if they come from an overlay. */
29096 if (EQ (glyph
->object
, before_string
))
29098 pos
= string_buffer_position (before_string
,
29100 /* If pos == 0, it means before_string came from an
29101 overlay, not from a buffer position. */
29102 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29105 else if (EQ (glyph
->object
, after_string
))
29107 pos
= string_buffer_position (after_string
, end_charpos
);
29108 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29111 x
+= glyph
->pixel_width
;
29113 hlinfo
->mouse_face_beg_x
= x
;
29114 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
29118 /* This row is in a right to left paragraph. Scan it right to
29122 end
= r1
->glyphs
[TEXT_AREA
] - 1;
29123 glyph
= end
+ r1
->used
[TEXT_AREA
];
29125 /* Skip truncation glyphs at the start of the glyph row. */
29126 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
29128 && NILP (glyph
->object
)
29129 && glyph
->charpos
< 0;
29133 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
29134 or DISP_STRING, and the first glyph from buffer whose
29135 position is between START_CHARPOS and END_CHARPOS. */
29137 && !NILP (glyph
->object
)
29138 && !EQ (glyph
->object
, disp_string
)
29139 && !(BUFFERP (glyph
->object
)
29140 && (glyph
->charpos
>= start_charpos
29141 && glyph
->charpos
< end_charpos
));
29144 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29145 are present at buffer positions between START_CHARPOS and
29146 END_CHARPOS, or if they come from an overlay. */
29147 if (EQ (glyph
->object
, before_string
))
29149 pos
= string_buffer_position (before_string
, start_charpos
);
29150 /* If pos == 0, it means before_string came from an
29151 overlay, not from a buffer position. */
29152 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29155 else if (EQ (glyph
->object
, after_string
))
29157 pos
= string_buffer_position (after_string
, end_charpos
);
29158 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29163 glyph
++; /* first glyph to the right of the highlighted area */
29164 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
29165 x
+= g
->pixel_width
;
29166 hlinfo
->mouse_face_beg_x
= x
;
29167 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
29170 /* If the highlight ends in a different row, compute GLYPH and END
29171 for the end row. Otherwise, reuse the values computed above for
29172 the row where the highlight begins. */
29175 if (!r2
->reversed_p
)
29177 glyph
= r2
->glyphs
[TEXT_AREA
];
29178 end
= glyph
+ r2
->used
[TEXT_AREA
];
29183 end
= r2
->glyphs
[TEXT_AREA
] - 1;
29184 glyph
= end
+ r2
->used
[TEXT_AREA
];
29188 if (!r2
->reversed_p
)
29190 /* Skip truncation and continuation glyphs near the end of the
29191 row, and also blanks and stretch glyphs inserted by
29192 extend_face_to_end_of_line. */
29194 && NILP ((end
- 1)->object
))
29196 /* Scan the rest of the glyph row from the end, looking for the
29197 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
29198 DISP_STRING, or whose position is between START_CHARPOS
29202 && !NILP (end
->object
)
29203 && !EQ (end
->object
, disp_string
)
29204 && !(BUFFERP (end
->object
)
29205 && (end
->charpos
>= start_charpos
29206 && end
->charpos
< end_charpos
));
29209 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29210 are present at buffer positions between START_CHARPOS and
29211 END_CHARPOS, or if they come from an overlay. */
29212 if (EQ (end
->object
, before_string
))
29214 pos
= string_buffer_position (before_string
, start_charpos
);
29215 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29218 else if (EQ (end
->object
, after_string
))
29220 pos
= string_buffer_position (after_string
, end_charpos
);
29221 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29225 /* Find the X coordinate of the last glyph to be highlighted. */
29226 for (; glyph
<= end
; ++glyph
)
29227 x
+= glyph
->pixel_width
;
29229 hlinfo
->mouse_face_end_x
= x
;
29230 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
29234 /* Skip truncation and continuation glyphs near the end of the
29235 row, and also blanks and stretch glyphs inserted by
29236 extend_face_to_end_of_line. */
29240 && NILP (end
->object
))
29242 x
+= end
->pixel_width
;
29245 /* Scan the rest of the glyph row from the end, looking for the
29246 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
29247 DISP_STRING, or whose position is between START_CHARPOS
29251 && !NILP (end
->object
)
29252 && !EQ (end
->object
, disp_string
)
29253 && !(BUFFERP (end
->object
)
29254 && (end
->charpos
>= start_charpos
29255 && end
->charpos
< end_charpos
));
29258 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29259 are present at buffer positions between START_CHARPOS and
29260 END_CHARPOS, or if they come from an overlay. */
29261 if (EQ (end
->object
, before_string
))
29263 pos
= string_buffer_position (before_string
, start_charpos
);
29264 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29267 else if (EQ (end
->object
, after_string
))
29269 pos
= string_buffer_position (after_string
, end_charpos
);
29270 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29273 x
+= end
->pixel_width
;
29275 /* If we exited the above loop because we arrived at the last
29276 glyph of the row, and its buffer position is still not in
29277 range, it means the last character in range is the preceding
29278 newline. Bump the end column and x values to get past the
29281 && BUFFERP (end
->object
)
29282 && (end
->charpos
< start_charpos
29283 || end
->charpos
>= end_charpos
))
29285 x
+= end
->pixel_width
;
29288 hlinfo
->mouse_face_end_x
= x
;
29289 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
29292 hlinfo
->mouse_face_window
= window
;
29293 hlinfo
->mouse_face_face_id
29294 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
29296 !hlinfo
->mouse_face_hidden
, -1);
29297 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29300 /* The following function is not used anymore (replaced with
29301 mouse_face_from_string_pos), but I leave it here for the time
29302 being, in case someone would. */
29304 #if false /* not used */
29306 /* Find the position of the glyph for position POS in OBJECT in
29307 window W's current matrix, and return in *X, *Y the pixel
29308 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
29310 RIGHT_P means return the position of the right edge of the glyph.
29311 !RIGHT_P means return the left edge position.
29313 If no glyph for POS exists in the matrix, return the position of
29314 the glyph with the next smaller position that is in the matrix, if
29315 RIGHT_P is false. If RIGHT_P, and no glyph for POS
29316 exists in the matrix, return the position of the glyph with the
29317 next larger position in OBJECT.
29319 Value is true if a glyph was found. */
29322 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
29323 int *hpos
, int *vpos
, int *x
, int *y
, bool right_p
)
29325 int yb
= window_text_bottom_y (w
);
29326 struct glyph_row
*r
;
29327 struct glyph
*best_glyph
= NULL
;
29328 struct glyph_row
*best_row
= NULL
;
29331 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
29332 r
->enabled_p
&& r
->y
< yb
;
29335 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
29336 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
29339 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
29340 if (EQ (g
->object
, object
))
29342 if (g
->charpos
== pos
)
29349 else if (best_glyph
== NULL
29350 || ((eabs (g
->charpos
- pos
)
29351 < eabs (best_glyph
->charpos
- pos
))
29354 : g
->charpos
> pos
)))
29368 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
29372 *x
+= best_glyph
->pixel_width
;
29377 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
29380 return best_glyph
!= NULL
;
29382 #endif /* not used */
29384 /* Find the positions of the first and the last glyphs in window W's
29385 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
29386 (assumed to be a string), and return in HLINFO's mouse_face_*
29387 members the pixel and column/row coordinates of those glyphs. */
29390 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
29391 Lisp_Object object
,
29392 ptrdiff_t startpos
, ptrdiff_t endpos
)
29394 int yb
= window_text_bottom_y (w
);
29395 struct glyph_row
*r
;
29396 struct glyph
*g
, *e
;
29398 bool found
= false;
29400 /* Find the glyph row with at least one position in the range
29401 [STARTPOS..ENDPOS), and the first glyph in that row whose
29402 position belongs to that range. */
29403 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
29404 r
->enabled_p
&& r
->y
< yb
;
29407 if (!r
->reversed_p
)
29409 g
= r
->glyphs
[TEXT_AREA
];
29410 e
= g
+ r
->used
[TEXT_AREA
];
29411 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
29412 if (EQ (g
->object
, object
)
29413 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29415 hlinfo
->mouse_face_beg_row
29416 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29417 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29418 hlinfo
->mouse_face_beg_x
= gx
;
29427 e
= r
->glyphs
[TEXT_AREA
];
29428 g
= e
+ r
->used
[TEXT_AREA
];
29429 for ( ; g
> e
; --g
)
29430 if (EQ ((g
-1)->object
, object
)
29431 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
29433 hlinfo
->mouse_face_beg_row
29434 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29435 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29436 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
29437 gx
+= g1
->pixel_width
;
29438 hlinfo
->mouse_face_beg_x
= gx
;
29450 /* Starting with the next row, look for the first row which does NOT
29451 include any glyphs whose positions are in the range. */
29452 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
29454 g
= r
->glyphs
[TEXT_AREA
];
29455 e
= g
+ r
->used
[TEXT_AREA
];
29457 for ( ; g
< e
; ++g
)
29458 if (EQ (g
->object
, object
)
29459 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29468 /* The highlighted region ends on the previous row. */
29471 /* Set the end row. */
29472 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29474 /* Compute and set the end column and the end column's horizontal
29475 pixel coordinate. */
29476 if (!r
->reversed_p
)
29478 g
= r
->glyphs
[TEXT_AREA
];
29479 e
= g
+ r
->used
[TEXT_AREA
];
29480 for ( ; e
> g
; --e
)
29481 if (EQ ((e
-1)->object
, object
)
29482 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
29484 hlinfo
->mouse_face_end_col
= e
- g
;
29486 for (gx
= r
->x
; g
< e
; ++g
)
29487 gx
+= g
->pixel_width
;
29488 hlinfo
->mouse_face_end_x
= gx
;
29492 e
= r
->glyphs
[TEXT_AREA
];
29493 g
= e
+ r
->used
[TEXT_AREA
];
29494 for (gx
= r
->x
; e
< g
; ++e
)
29496 if (EQ (e
->object
, object
)
29497 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
29499 gx
+= e
->pixel_width
;
29501 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
29502 hlinfo
->mouse_face_end_x
= gx
;
29506 #ifdef HAVE_WINDOW_SYSTEM
29508 /* See if position X, Y is within a hot-spot of an image. */
29511 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
29513 if (!CONSP (hot_spot
))
29516 if (EQ (XCAR (hot_spot
), Qrect
))
29518 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
29519 Lisp_Object rect
= XCDR (hot_spot
);
29523 if (!CONSP (XCAR (rect
)))
29525 if (!CONSP (XCDR (rect
)))
29527 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
29529 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
29531 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
29533 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
29537 else if (EQ (XCAR (hot_spot
), Qcircle
))
29539 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
29540 Lisp_Object circ
= XCDR (hot_spot
);
29541 Lisp_Object lr
, lx0
, ly0
;
29543 && CONSP (XCAR (circ
))
29544 && (lr
= XCDR (circ
), NUMBERP (lr
))
29545 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
29546 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
29548 double r
= XFLOATINT (lr
);
29549 double dx
= XINT (lx0
) - x
;
29550 double dy
= XINT (ly0
) - y
;
29551 return (dx
* dx
+ dy
* dy
<= r
* r
);
29554 else if (EQ (XCAR (hot_spot
), Qpoly
))
29556 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
29557 if (VECTORP (XCDR (hot_spot
)))
29559 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
29560 Lisp_Object
*poly
= v
->contents
;
29561 ptrdiff_t n
= v
->header
.size
;
29563 bool inside
= false;
29564 Lisp_Object lx
, ly
;
29567 /* Need an even number of coordinates, and at least 3 edges. */
29568 if (n
< 6 || n
& 1)
29571 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
29572 If count is odd, we are inside polygon. Pixels on edges
29573 may or may not be included depending on actual geometry of the
29575 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
29576 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
29578 x0
= XINT (lx
), y0
= XINT (ly
);
29579 for (i
= 0; i
< n
; i
+= 2)
29581 int x1
= x0
, y1
= y0
;
29582 if ((lx
= poly
[i
], !INTEGERP (lx
))
29583 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
29585 x0
= XINT (lx
), y0
= XINT (ly
);
29587 /* Does this segment cross the X line? */
29595 if (y
> y0
&& y
> y1
)
29597 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
29607 find_hot_spot (Lisp_Object map
, int x
, int y
)
29609 while (CONSP (map
))
29611 if (CONSP (XCAR (map
))
29612 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
29620 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
29622 doc
: /* Lookup in image map MAP coordinates X and Y.
29623 An image map is an alist where each element has the format (AREA ID PLIST).
29624 An AREA is specified as either a rectangle, a circle, or a polygon:
29625 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
29626 pixel coordinates of the upper left and bottom right corners.
29627 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
29628 and the radius of the circle; r may be a float or integer.
29629 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
29630 vector describes one corner in the polygon.
29631 Returns the alist element for the first matching AREA in MAP. */)
29632 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
29640 return find_hot_spot (map
,
29641 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
29642 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
29646 /* Display frame CURSOR, optionally using shape defined by POINTER. */
29648 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
29650 /* Do not change cursor shape while dragging mouse. */
29651 if (EQ (do_mouse_tracking
, Qdragging
))
29654 if (!NILP (pointer
))
29656 if (EQ (pointer
, Qarrow
))
29657 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29658 else if (EQ (pointer
, Qhand
))
29659 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
29660 else if (EQ (pointer
, Qtext
))
29661 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29662 else if (EQ (pointer
, intern ("hdrag")))
29663 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29664 else if (EQ (pointer
, intern ("nhdrag")))
29665 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29666 #ifdef HAVE_X_WINDOWS
29667 else if (EQ (pointer
, intern ("vdrag")))
29668 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29670 else if (EQ (pointer
, intern ("hourglass")))
29671 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
29672 else if (EQ (pointer
, Qmodeline
))
29673 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
29675 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29678 if (cursor
!= No_Cursor
)
29679 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
29682 #endif /* HAVE_WINDOW_SYSTEM */
29684 /* Take proper action when mouse has moved to the mode or header line
29685 or marginal area AREA of window W, x-position X and y-position Y.
29686 X is relative to the start of the text display area of W, so the
29687 width of bitmap areas and scroll bars must be subtracted to get a
29688 position relative to the start of the mode line. */
29691 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
29692 enum window_part area
)
29694 struct window
*w
= XWINDOW (window
);
29695 struct frame
*f
= XFRAME (w
->frame
);
29696 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29697 #ifdef HAVE_WINDOW_SYSTEM
29698 Display_Info
*dpyinfo
;
29700 Cursor cursor
= No_Cursor
;
29701 Lisp_Object pointer
= Qnil
;
29702 int dx
, dy
, width
, height
;
29704 Lisp_Object string
, object
= Qnil
;
29705 Lisp_Object pos
IF_LINT (= Qnil
), help
;
29707 Lisp_Object mouse_face
;
29708 int original_x_pixel
= x
;
29709 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
29710 struct glyph_row
*row
IF_LINT (= 0);
29712 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
29717 /* Kludge alert: mode_line_string takes X/Y in pixels, but
29718 returns them in row/column units! */
29719 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
29720 &object
, &dx
, &dy
, &width
, &height
);
29722 row
= (area
== ON_MODE_LINE
29723 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
29724 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
29726 /* Find the glyph under the mouse pointer. */
29727 if (row
->mode_line_p
&& row
->enabled_p
)
29729 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
29730 end
= glyph
+ row
->used
[TEXT_AREA
];
29732 for (x0
= original_x_pixel
;
29733 glyph
< end
&& x0
>= glyph
->pixel_width
;
29735 x0
-= glyph
->pixel_width
;
29743 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
29744 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
29745 returns them in row/column units! */
29746 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
29747 &object
, &dx
, &dy
, &width
, &height
);
29752 #ifdef HAVE_WINDOW_SYSTEM
29753 if (IMAGEP (object
))
29755 Lisp_Object image_map
, hotspot
;
29756 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
29758 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
29760 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29764 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
29765 If so, we could look for mouse-enter, mouse-leave
29766 properties in PLIST (and do something...). */
29767 hotspot
= XCDR (hotspot
);
29768 if (CONSP (hotspot
)
29769 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29771 pointer
= Fplist_get (plist
, Qpointer
);
29772 if (NILP (pointer
))
29774 help
= Fplist_get (plist
, Qhelp_echo
);
29777 help_echo_string
= help
;
29778 XSETWINDOW (help_echo_window
, w
);
29779 help_echo_object
= w
->contents
;
29780 help_echo_pos
= charpos
;
29784 if (NILP (pointer
))
29785 pointer
= Fplist_get (XCDR (object
), QCpointer
);
29787 #endif /* HAVE_WINDOW_SYSTEM */
29789 if (STRINGP (string
))
29790 pos
= make_number (charpos
);
29792 /* Set the help text and mouse pointer. If the mouse is on a part
29793 of the mode line without any text (e.g. past the right edge of
29794 the mode line text), use the default help text and pointer. */
29795 if (STRINGP (string
) || area
== ON_MODE_LINE
)
29797 /* Arrange to display the help by setting the global variables
29798 help_echo_string, help_echo_object, and help_echo_pos. */
29801 if (STRINGP (string
))
29802 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
29806 help_echo_string
= help
;
29807 XSETWINDOW (help_echo_window
, w
);
29808 help_echo_object
= string
;
29809 help_echo_pos
= charpos
;
29811 else if (area
== ON_MODE_LINE
)
29813 Lisp_Object default_help
29814 = buffer_local_value (Qmode_line_default_help_echo
,
29817 if (STRINGP (default_help
))
29819 help_echo_string
= default_help
;
29820 XSETWINDOW (help_echo_window
, w
);
29821 help_echo_object
= Qnil
;
29822 help_echo_pos
= -1;
29827 #ifdef HAVE_WINDOW_SYSTEM
29828 /* Change the mouse pointer according to what is under it. */
29829 if (FRAME_WINDOW_P (f
))
29831 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
29833 || NILP (Vresize_mini_windows
));
29835 dpyinfo
= FRAME_DISPLAY_INFO (f
);
29836 if (STRINGP (string
))
29838 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29840 if (NILP (pointer
))
29841 pointer
= Fget_text_property (pos
, Qpointer
, string
);
29843 /* Change the mouse pointer according to what is under X/Y. */
29845 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
29848 map
= Fget_text_property (pos
, Qlocal_map
, string
);
29849 if (!KEYMAPP (map
))
29850 map
= Fget_text_property (pos
, Qkeymap
, string
);
29851 if (!KEYMAPP (map
) && draggable
)
29852 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
29855 else if (draggable
)
29856 /* Default mode-line pointer. */
29857 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29862 /* Change the mouse face according to what is under X/Y. */
29863 bool mouse_face_shown
= false;
29864 if (STRINGP (string
))
29866 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
29867 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
29868 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29873 struct glyph
* tmp_glyph
;
29877 int total_pixel_width
;
29878 ptrdiff_t begpos
, endpos
, ignore
;
29882 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
29883 Qmouse_face
, string
, Qnil
);
29889 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
29891 endpos
= SCHARS (string
);
29895 /* Calculate the glyph position GPOS of GLYPH in the
29896 displayed string, relative to the beginning of the
29897 highlighted part of the string.
29899 Note: GPOS is different from CHARPOS. CHARPOS is the
29900 position of GLYPH in the internal string object. A mode
29901 line string format has structures which are converted to
29902 a flattened string by the Emacs Lisp interpreter. The
29903 internal string is an element of those structures. The
29904 displayed string is the flattened string. */
29905 tmp_glyph
= row_start_glyph
;
29906 while (tmp_glyph
< glyph
29907 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29908 && begpos
<= tmp_glyph
->charpos
29909 && tmp_glyph
->charpos
< endpos
)))
29911 gpos
= glyph
- tmp_glyph
;
29913 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29914 the highlighted part of the displayed string to which
29915 GLYPH belongs. Note: GSEQ_LENGTH is different from
29916 SCHARS (STRING), because the latter returns the length of
29917 the internal string. */
29918 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29920 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29921 && begpos
<= tmp_glyph
->charpos
29922 && tmp_glyph
->charpos
< endpos
));
29925 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29927 /* Calculate the total pixel width of all the glyphs between
29928 the beginning of the highlighted area and GLYPH. */
29929 total_pixel_width
= 0;
29930 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29931 total_pixel_width
+= tmp_glyph
->pixel_width
;
29933 /* Pre calculation of re-rendering position. Note: X is in
29934 column units here, after the call to mode_line_string or
29935 marginal_area_string. */
29937 vpos
= (area
== ON_MODE_LINE
29938 ? (w
->current_matrix
)->nrows
- 1
29941 /* If GLYPH's position is included in the region that is
29942 already drawn in mouse face, we have nothing to do. */
29943 if ( EQ (window
, hlinfo
->mouse_face_window
)
29944 && (!row
->reversed_p
29945 ? (hlinfo
->mouse_face_beg_col
<= hpos
29946 && hpos
< hlinfo
->mouse_face_end_col
)
29947 /* In R2L rows we swap BEG and END, see below. */
29948 : (hlinfo
->mouse_face_end_col
<= hpos
29949 && hpos
< hlinfo
->mouse_face_beg_col
))
29950 && hlinfo
->mouse_face_beg_row
== vpos
)
29953 if (clear_mouse_face (hlinfo
))
29954 cursor
= No_Cursor
;
29956 if (!row
->reversed_p
)
29958 hlinfo
->mouse_face_beg_col
= hpos
;
29959 hlinfo
->mouse_face_beg_x
= original_x_pixel
29960 - (total_pixel_width
+ dx
);
29961 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29962 hlinfo
->mouse_face_end_x
= 0;
29966 /* In R2L rows, show_mouse_face expects BEG and END
29967 coordinates to be swapped. */
29968 hlinfo
->mouse_face_end_col
= hpos
;
29969 hlinfo
->mouse_face_end_x
= original_x_pixel
29970 - (total_pixel_width
+ dx
);
29971 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29972 hlinfo
->mouse_face_beg_x
= 0;
29975 hlinfo
->mouse_face_beg_row
= vpos
;
29976 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29977 hlinfo
->mouse_face_past_end
= false;
29978 hlinfo
->mouse_face_window
= window
;
29980 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29985 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29986 mouse_face_shown
= true;
29988 if (NILP (pointer
))
29993 /* If mouse-face doesn't need to be shown, clear any existing
29995 if ((area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
) && !mouse_face_shown
)
29996 clear_mouse_face (hlinfo
);
29998 #ifdef HAVE_WINDOW_SYSTEM
29999 if (FRAME_WINDOW_P (f
))
30000 define_frame_cursor1 (f
, cursor
, pointer
);
30006 Take proper action when the mouse has moved to position X, Y on
30007 frame F with regards to highlighting portions of display that have
30008 mouse-face properties. Also de-highlight portions of display where
30009 the mouse was before, set the mouse pointer shape as appropriate
30010 for the mouse coordinates, and activate help echo (tooltips).
30011 X and Y can be negative or out of range. */
30014 note_mouse_highlight (struct frame
*f
, int x
, int y
)
30016 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30017 enum window_part part
= ON_NOTHING
;
30018 Lisp_Object window
;
30020 Cursor cursor
= No_Cursor
;
30021 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
30024 /* When a menu is active, don't highlight because this looks odd. */
30025 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
30026 if (popup_activated ())
30030 if (!f
->glyphs_initialized_p
30031 || f
->pointer_invisible
)
30034 hlinfo
->mouse_face_mouse_x
= x
;
30035 hlinfo
->mouse_face_mouse_y
= y
;
30036 hlinfo
->mouse_face_mouse_frame
= f
;
30038 if (hlinfo
->mouse_face_defer
)
30041 /* Which window is that in? */
30042 window
= window_from_coordinates (f
, x
, y
, &part
, true);
30044 /* If displaying active text in another window, clear that. */
30045 if (! EQ (window
, hlinfo
->mouse_face_window
)
30046 /* Also clear if we move out of text area in same window. */
30047 || (!NILP (hlinfo
->mouse_face_window
)
30050 && part
!= ON_MODE_LINE
30051 && part
!= ON_HEADER_LINE
))
30052 clear_mouse_face (hlinfo
);
30054 /* Not on a window -> return. */
30055 if (!WINDOWP (window
))
30058 /* Reset help_echo_string. It will get recomputed below. */
30059 help_echo_string
= Qnil
;
30061 /* Convert to window-relative pixel coordinates. */
30062 w
= XWINDOW (window
);
30063 frame_to_window_pixel_xy (w
, &x
, &y
);
30065 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
30066 /* Handle tool-bar window differently since it doesn't display a
30068 if (EQ (window
, f
->tool_bar_window
))
30070 note_tool_bar_highlight (f
, x
, y
);
30075 /* Mouse is on the mode, header line or margin? */
30076 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
30077 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
30079 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
30081 #ifdef HAVE_WINDOW_SYSTEM
30082 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
30084 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30085 /* Show non-text cursor (Bug#16647). */
30093 #ifdef HAVE_WINDOW_SYSTEM
30094 if (part
== ON_VERTICAL_BORDER
)
30096 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
30097 help_echo_string
= build_string ("drag-mouse-1: resize");
30099 else if (part
== ON_RIGHT_DIVIDER
)
30101 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
30102 help_echo_string
= build_string ("drag-mouse-1: resize");
30104 else if (part
== ON_BOTTOM_DIVIDER
)
30105 if (! WINDOW_BOTTOMMOST_P (w
)
30107 || NILP (Vresize_mini_windows
))
30109 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
30110 help_echo_string
= build_string ("drag-mouse-1: resize");
30113 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30114 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
30115 || part
== ON_VERTICAL_SCROLL_BAR
30116 || part
== ON_HORIZONTAL_SCROLL_BAR
)
30117 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30119 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
30122 /* Are we in a window whose display is up to date?
30123 And verify the buffer's text has not changed. */
30124 b
= XBUFFER (w
->contents
);
30125 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
30127 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
30129 struct glyph
*glyph
;
30130 Lisp_Object object
;
30131 Lisp_Object mouse_face
= Qnil
, position
;
30132 Lisp_Object
*overlay_vec
= NULL
;
30133 ptrdiff_t i
, noverlays
;
30134 struct buffer
*obuf
;
30135 ptrdiff_t obegv
, ozv
;
30138 /* Find the glyph under X/Y. */
30139 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
30141 #ifdef HAVE_WINDOW_SYSTEM
30142 /* Look for :pointer property on image. */
30143 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
30145 struct image
*img
= IMAGE_OPT_FROM_ID (f
, glyph
->u
.img_id
);
30146 if (img
!= NULL
&& IMAGEP (img
->spec
))
30148 Lisp_Object image_map
, hotspot
;
30149 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
30151 && (hotspot
= find_hot_spot (image_map
,
30152 glyph
->slice
.img
.x
+ dx
,
30153 glyph
->slice
.img
.y
+ dy
),
30155 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
30159 /* Could check XCAR (hotspot) to see if we enter/leave
30161 If so, we could look for mouse-enter, mouse-leave
30162 properties in PLIST (and do something...). */
30163 hotspot
= XCDR (hotspot
);
30164 if (CONSP (hotspot
)
30165 && (plist
= XCAR (hotspot
), CONSP (plist
)))
30167 pointer
= Fplist_get (plist
, Qpointer
);
30168 if (NILP (pointer
))
30170 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
30171 if (!NILP (help_echo_string
))
30173 help_echo_window
= window
;
30174 help_echo_object
= glyph
->object
;
30175 help_echo_pos
= glyph
->charpos
;
30179 if (NILP (pointer
))
30180 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
30183 #endif /* HAVE_WINDOW_SYSTEM */
30185 /* Clear mouse face if X/Y not over text. */
30187 || area
!= TEXT_AREA
30188 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
30189 /* Glyph's OBJECT is nil for glyphs inserted by the
30190 display engine for its internal purposes, like truncation
30191 and continuation glyphs and blanks beyond the end of
30192 line's text on text terminals. If we are over such a
30193 glyph, we are not over any text. */
30194 || NILP (glyph
->object
)
30195 /* R2L rows have a stretch glyph at their front, which
30196 stands for no text, whereas L2R rows have no glyphs at
30197 all beyond the end of text. Treat such stretch glyphs
30198 like we do with NULL glyphs in L2R rows. */
30199 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
30200 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
30201 && glyph
->type
== STRETCH_GLYPH
30202 && glyph
->avoid_cursor_p
))
30204 if (clear_mouse_face (hlinfo
))
30205 cursor
= No_Cursor
;
30206 #ifdef HAVE_WINDOW_SYSTEM
30207 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30209 if (area
!= TEXT_AREA
)
30210 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30212 pointer
= Vvoid_text_area_pointer
;
30218 pos
= glyph
->charpos
;
30219 object
= glyph
->object
;
30220 if (!STRINGP (object
) && !BUFFERP (object
))
30223 /* If we get an out-of-range value, return now; avoid an error. */
30224 if (BUFFERP (object
) && pos
> BUF_Z (b
))
30227 /* Make the window's buffer temporarily current for
30228 overlays_at and compute_char_face. */
30229 obuf
= current_buffer
;
30230 current_buffer
= b
;
30236 /* Is this char mouse-active or does it have help-echo? */
30237 position
= make_number (pos
);
30241 if (BUFFERP (object
))
30243 /* Put all the overlays we want in a vector in overlay_vec. */
30244 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, false);
30245 /* Sort overlays into increasing priority order. */
30246 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
30251 if (NILP (Vmouse_highlight
))
30253 clear_mouse_face (hlinfo
);
30254 goto check_help_echo
;
30257 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
30260 cursor
= No_Cursor
;
30262 /* Check mouse-face highlighting. */
30264 /* If there exists an overlay with mouse-face overlapping
30265 the one we are currently highlighting, we have to
30266 check if we enter the overlapping overlay, and then
30267 highlight only that. */
30268 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
30269 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
30271 /* Find the highest priority overlay with a mouse-face. */
30272 Lisp_Object overlay
= Qnil
;
30273 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
30275 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
30276 if (!NILP (mouse_face
))
30277 overlay
= overlay_vec
[i
];
30280 /* If we're highlighting the same overlay as before, there's
30281 no need to do that again. */
30282 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
30283 goto check_help_echo
;
30284 hlinfo
->mouse_face_overlay
= overlay
;
30286 /* Clear the display of the old active region, if any. */
30287 if (clear_mouse_face (hlinfo
))
30288 cursor
= No_Cursor
;
30290 /* If no overlay applies, get a text property. */
30291 if (NILP (overlay
))
30292 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
30294 /* Next, compute the bounds of the mouse highlighting and
30296 if (!NILP (mouse_face
) && STRINGP (object
))
30298 /* The mouse-highlighting comes from a display string
30299 with a mouse-face. */
30303 s
= Fprevious_single_property_change
30304 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
30305 e
= Fnext_single_property_change
30306 (position
, Qmouse_face
, object
, Qnil
);
30308 s
= make_number (0);
30310 e
= make_number (SCHARS (object
));
30311 mouse_face_from_string_pos (w
, hlinfo
, object
,
30312 XINT (s
), XINT (e
));
30313 hlinfo
->mouse_face_past_end
= false;
30314 hlinfo
->mouse_face_window
= window
;
30315 hlinfo
->mouse_face_face_id
30316 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
30317 glyph
->face_id
, true);
30318 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
30319 cursor
= No_Cursor
;
30323 /* The mouse-highlighting, if any, comes from an overlay
30324 or text property in the buffer. */
30325 Lisp_Object buffer
IF_LINT (= Qnil
);
30326 Lisp_Object disp_string
IF_LINT (= Qnil
);
30328 if (STRINGP (object
))
30330 /* If we are on a display string with no mouse-face,
30331 check if the text under it has one. */
30332 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
30333 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30334 pos
= string_buffer_position (object
, start
);
30337 mouse_face
= get_char_property_and_overlay
30338 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
30339 buffer
= w
->contents
;
30340 disp_string
= object
;
30346 disp_string
= Qnil
;
30349 if (!NILP (mouse_face
))
30351 Lisp_Object before
, after
;
30352 Lisp_Object before_string
, after_string
;
30353 /* To correctly find the limits of mouse highlight
30354 in a bidi-reordered buffer, we must not use the
30355 optimization of limiting the search in
30356 previous-single-property-change and
30357 next-single-property-change, because
30358 rows_from_pos_range needs the real start and end
30359 positions to DTRT in this case. That's because
30360 the first row visible in a window does not
30361 necessarily display the character whose position
30362 is the smallest. */
30364 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
30365 ? Fmarker_position (w
->start
)
30368 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
30369 ? make_number (BUF_Z (XBUFFER (buffer
))
30370 - w
->window_end_pos
)
30373 if (NILP (overlay
))
30375 /* Handle the text property case. */
30376 before
= Fprevious_single_property_change
30377 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
30378 after
= Fnext_single_property_change
30379 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
30380 before_string
= after_string
= Qnil
;
30384 /* Handle the overlay case. */
30385 before
= Foverlay_start (overlay
);
30386 after
= Foverlay_end (overlay
);
30387 before_string
= Foverlay_get (overlay
, Qbefore_string
);
30388 after_string
= Foverlay_get (overlay
, Qafter_string
);
30390 if (!STRINGP (before_string
)) before_string
= Qnil
;
30391 if (!STRINGP (after_string
)) after_string
= Qnil
;
30394 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
30397 : XFASTINT (before
),
30399 ? BUF_Z (XBUFFER (buffer
))
30400 : XFASTINT (after
),
30401 before_string
, after_string
,
30403 cursor
= No_Cursor
;
30410 /* Look for a `help-echo' property. */
30411 if (NILP (help_echo_string
)) {
30412 Lisp_Object help
, overlay
;
30414 /* Check overlays first. */
30415 help
= overlay
= Qnil
;
30416 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
30418 overlay
= overlay_vec
[i
];
30419 help
= Foverlay_get (overlay
, Qhelp_echo
);
30424 help_echo_string
= help
;
30425 help_echo_window
= window
;
30426 help_echo_object
= overlay
;
30427 help_echo_pos
= pos
;
30431 Lisp_Object obj
= glyph
->object
;
30432 ptrdiff_t charpos
= glyph
->charpos
;
30434 /* Try text properties. */
30437 && charpos
< SCHARS (obj
))
30439 help
= Fget_text_property (make_number (charpos
),
30443 /* If the string itself doesn't specify a help-echo,
30444 see if the buffer text ``under'' it does. */
30445 struct glyph_row
*r
30446 = MATRIX_ROW (w
->current_matrix
, vpos
);
30447 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30448 ptrdiff_t p
= string_buffer_position (obj
, start
);
30451 help
= Fget_char_property (make_number (p
),
30452 Qhelp_echo
, w
->contents
);
30461 else if (BUFFERP (obj
)
30464 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
30469 help_echo_string
= help
;
30470 help_echo_window
= window
;
30471 help_echo_object
= obj
;
30472 help_echo_pos
= charpos
;
30477 #ifdef HAVE_WINDOW_SYSTEM
30478 /* Look for a `pointer' property. */
30479 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30481 /* Check overlays first. */
30482 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
30483 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
30485 if (NILP (pointer
))
30487 Lisp_Object obj
= glyph
->object
;
30488 ptrdiff_t charpos
= glyph
->charpos
;
30490 /* Try text properties. */
30493 && charpos
< SCHARS (obj
))
30495 pointer
= Fget_text_property (make_number (charpos
),
30497 if (NILP (pointer
))
30499 /* If the string itself doesn't specify a pointer,
30500 see if the buffer text ``under'' it does. */
30501 struct glyph_row
*r
30502 = MATRIX_ROW (w
->current_matrix
, vpos
);
30503 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30504 ptrdiff_t p
= string_buffer_position (obj
, start
);
30506 pointer
= Fget_char_property (make_number (p
),
30507 Qpointer
, w
->contents
);
30510 else if (BUFFERP (obj
)
30513 pointer
= Fget_text_property (make_number (charpos
),
30517 #endif /* HAVE_WINDOW_SYSTEM */
30521 current_buffer
= obuf
;
30527 #ifdef HAVE_WINDOW_SYSTEM
30528 if (FRAME_WINDOW_P (f
))
30529 define_frame_cursor1 (f
, cursor
, pointer
);
30531 /* This is here to prevent a compiler error, about "label at end of
30532 compound statement". */
30539 Clear any mouse-face on window W. This function is part of the
30540 redisplay interface, and is called from try_window_id and similar
30541 functions to ensure the mouse-highlight is off. */
30544 x_clear_window_mouse_face (struct window
*w
)
30546 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
30547 Lisp_Object window
;
30550 XSETWINDOW (window
, w
);
30551 if (EQ (window
, hlinfo
->mouse_face_window
))
30552 clear_mouse_face (hlinfo
);
30558 Just discard the mouse face information for frame F, if any.
30559 This is used when the size of F is changed. */
30562 cancel_mouse_face (struct frame
*f
)
30564 Lisp_Object window
;
30565 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30567 window
= hlinfo
->mouse_face_window
;
30568 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
30569 reset_mouse_highlight (hlinfo
);
30574 /***********************************************************************
30576 ***********************************************************************/
30578 #ifdef HAVE_WINDOW_SYSTEM
30580 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
30581 which intersects rectangle R. R is in window-relative coordinates. */
30584 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
30585 enum glyph_row_area area
)
30587 struct glyph
*first
= row
->glyphs
[area
];
30588 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
30589 struct glyph
*last
;
30590 int first_x
, start_x
, x
;
30592 if (area
== TEXT_AREA
&& row
->fill_line_p
)
30593 /* If row extends face to end of line write the whole line. */
30594 draw_glyphs (w
, 0, row
, area
,
30595 0, row
->used
[area
],
30596 DRAW_NORMAL_TEXT
, 0);
30599 /* Set START_X to the window-relative start position for drawing glyphs of
30600 AREA. The first glyph of the text area can be partially visible.
30601 The first glyphs of other areas cannot. */
30602 start_x
= window_box_left_offset (w
, area
);
30604 if (area
== TEXT_AREA
)
30607 /* Find the first glyph that must be redrawn. */
30609 && x
+ first
->pixel_width
< r
->x
)
30611 x
+= first
->pixel_width
;
30615 /* Find the last one. */
30618 /* Use a signed int intermediate value to avoid catastrophic
30619 failures due to comparison between signed and unsigned, when
30620 x is negative (can happen for wide images that are hscrolled). */
30621 int r_end
= r
->x
+ r
->width
;
30622 while (last
< end
&& x
< r_end
)
30624 x
+= last
->pixel_width
;
30630 draw_glyphs (w
, first_x
- start_x
, row
, area
,
30631 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
30632 DRAW_NORMAL_TEXT
, 0);
30637 /* Redraw the parts of the glyph row ROW on window W intersecting
30638 rectangle R. R is in window-relative coordinates. Value is
30639 true if mouse-face was overwritten. */
30642 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
30644 eassert (row
->enabled_p
);
30646 if (row
->mode_line_p
|| w
->pseudo_window_p
)
30647 draw_glyphs (w
, 0, row
, TEXT_AREA
,
30648 0, row
->used
[TEXT_AREA
],
30649 DRAW_NORMAL_TEXT
, 0);
30652 if (row
->used
[LEFT_MARGIN_AREA
])
30653 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
30654 if (row
->used
[TEXT_AREA
])
30655 expose_area (w
, row
, r
, TEXT_AREA
);
30656 if (row
->used
[RIGHT_MARGIN_AREA
])
30657 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
30658 draw_row_fringe_bitmaps (w
, row
);
30661 return row
->mouse_face_p
;
30665 /* Redraw those parts of glyphs rows during expose event handling that
30666 overlap other rows. Redrawing of an exposed line writes over parts
30667 of lines overlapping that exposed line; this function fixes that.
30669 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
30670 row in W's current matrix that is exposed and overlaps other rows.
30671 LAST_OVERLAPPING_ROW is the last such row. */
30674 expose_overlaps (struct window
*w
,
30675 struct glyph_row
*first_overlapping_row
,
30676 struct glyph_row
*last_overlapping_row
,
30679 struct glyph_row
*row
;
30681 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
30682 if (row
->overlapping_p
)
30684 eassert (row
->enabled_p
&& !row
->mode_line_p
);
30687 if (row
->used
[LEFT_MARGIN_AREA
])
30688 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
30690 if (row
->used
[TEXT_AREA
])
30691 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
30693 if (row
->used
[RIGHT_MARGIN_AREA
])
30694 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
30700 /* Return true if W's cursor intersects rectangle R. */
30703 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
30705 XRectangle cr
, result
;
30706 struct glyph
*cursor_glyph
;
30707 struct glyph_row
*row
;
30709 if (w
->phys_cursor
.vpos
>= 0
30710 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
30711 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
30713 && row
->cursor_in_fringe_p
)
30715 /* Cursor is in the fringe. */
30716 cr
.x
= window_box_right_offset (w
,
30717 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
30718 ? RIGHT_MARGIN_AREA
30721 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
30722 cr
.height
= row
->height
;
30723 return x_intersect_rectangles (&cr
, r
, &result
);
30726 cursor_glyph
= get_phys_cursor_glyph (w
);
30729 /* r is relative to W's box, but w->phys_cursor.x is relative
30730 to left edge of W's TEXT area. Adjust it. */
30731 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
30732 cr
.y
= w
->phys_cursor
.y
;
30733 cr
.width
= cursor_glyph
->pixel_width
;
30734 cr
.height
= w
->phys_cursor_height
;
30735 /* ++KFS: W32 version used W32-specific IntersectRect here, but
30736 I assume the effect is the same -- and this is portable. */
30737 return x_intersect_rectangles (&cr
, r
, &result
);
30739 /* If we don't understand the format, pretend we're not in the hot-spot. */
30745 Draw a vertical window border to the right of window W if W doesn't
30746 have vertical scroll bars. */
30749 x_draw_vertical_border (struct window
*w
)
30751 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30753 /* We could do better, if we knew what type of scroll-bar the adjacent
30754 windows (on either side) have... But we don't :-(
30755 However, I think this works ok. ++KFS 2003-04-25 */
30757 /* Redraw borders between horizontally adjacent windows. Don't
30758 do it for frames with vertical scroll bars because either the
30759 right scroll bar of a window, or the left scroll bar of its
30760 neighbor will suffice as a border. */
30761 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
30764 /* Note: It is necessary to redraw both the left and the right
30765 borders, for when only this single window W is being
30767 if (!WINDOW_RIGHTMOST_P (w
)
30768 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
30770 int x0
, x1
, y0
, y1
;
30772 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30775 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30778 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
30781 if (!WINDOW_LEFTMOST_P (w
)
30782 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
30784 int x0
, x1
, y0
, y1
;
30786 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30789 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30792 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
30797 /* Draw window dividers for window W. */
30800 x_draw_right_divider (struct window
*w
)
30802 struct frame
*f
= WINDOW_XFRAME (w
);
30804 if (w
->mini
|| w
->pseudo_window_p
)
30806 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30808 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
30809 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30810 int y0
= WINDOW_TOP_EDGE_Y (w
);
30811 /* The bottom divider prevails. */
30812 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30814 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30819 x_draw_bottom_divider (struct window
*w
)
30821 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30823 if (w
->mini
|| w
->pseudo_window_p
)
30825 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30827 int x0
= WINDOW_LEFT_EDGE_X (w
);
30828 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30829 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30830 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
30832 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30836 /* Redraw the part of window W intersection rectangle FR. Pixel
30837 coordinates in FR are frame-relative. Call this function with
30838 input blocked. Value is true if the exposure overwrites
30842 expose_window (struct window
*w
, XRectangle
*fr
)
30844 struct frame
*f
= XFRAME (w
->frame
);
30846 bool mouse_face_overwritten_p
= false;
30848 /* If window is not yet fully initialized, do nothing. This can
30849 happen when toolkit scroll bars are used and a window is split.
30850 Reconfiguring the scroll bar will generate an expose for a newly
30852 if (w
->current_matrix
== NULL
)
30855 /* When we're currently updating the window, display and current
30856 matrix usually don't agree. Arrange for a thorough display
30858 if (w
->must_be_updated_p
)
30860 SET_FRAME_GARBAGED (f
);
30864 /* Frame-relative pixel rectangle of W. */
30865 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
30866 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
30867 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
30868 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
30870 if (x_intersect_rectangles (fr
, &wr
, &r
))
30872 int yb
= window_text_bottom_y (w
);
30873 struct glyph_row
*row
;
30874 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
30876 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
30877 r
.x
, r
.y
, r
.width
, r
.height
));
30879 /* Convert to window coordinates. */
30880 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
30881 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
30883 /* Turn off the cursor. */
30884 bool cursor_cleared_p
= (!w
->pseudo_window_p
30885 && phys_cursor_in_rect_p (w
, &r
));
30886 if (cursor_cleared_p
)
30887 x_clear_cursor (w
);
30889 /* If the row containing the cursor extends face to end of line,
30890 then expose_area might overwrite the cursor outside the
30891 rectangle and thus notice_overwritten_cursor might clear
30892 w->phys_cursor_on_p. We remember the original value and
30893 check later if it is changed. */
30894 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
30896 /* Use a signed int intermediate value to avoid catastrophic
30897 failures due to comparison between signed and unsigned, when
30898 y0 or y1 is negative (can happen for tall images). */
30899 int r_bottom
= r
.y
+ r
.height
;
30901 /* Update lines intersecting rectangle R. */
30902 first_overlapping_row
= last_overlapping_row
= NULL
;
30903 for (row
= w
->current_matrix
->rows
;
30908 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
30910 if ((y0
>= r
.y
&& y0
< r_bottom
)
30911 || (y1
> r
.y
&& y1
< r_bottom
)
30912 || (r
.y
>= y0
&& r
.y
< y1
)
30913 || (r_bottom
> y0
&& r_bottom
< y1
))
30915 /* A header line may be overlapping, but there is no need
30916 to fix overlapping areas for them. KFS 2005-02-12 */
30917 if (row
->overlapping_p
&& !row
->mode_line_p
)
30919 if (first_overlapping_row
== NULL
)
30920 first_overlapping_row
= row
;
30921 last_overlapping_row
= row
;
30925 if (expose_line (w
, row
, &r
))
30926 mouse_face_overwritten_p
= true;
30929 else if (row
->overlapping_p
)
30931 /* We must redraw a row overlapping the exposed area. */
30933 ? y0
+ row
->phys_height
> r
.y
30934 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30936 if (first_overlapping_row
== NULL
)
30937 first_overlapping_row
= row
;
30938 last_overlapping_row
= row
;
30946 /* Display the mode line if there is one. */
30947 if (WINDOW_WANTS_MODELINE_P (w
)
30948 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30950 && row
->y
< r_bottom
)
30952 if (expose_line (w
, row
, &r
))
30953 mouse_face_overwritten_p
= true;
30956 if (!w
->pseudo_window_p
)
30958 /* Fix the display of overlapping rows. */
30959 if (first_overlapping_row
)
30960 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30963 /* Draw border between windows. */
30964 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30965 x_draw_right_divider (w
);
30967 x_draw_vertical_border (w
);
30969 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30970 x_draw_bottom_divider (w
);
30972 /* Turn the cursor on again. */
30973 if (cursor_cleared_p
30974 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30975 update_window_cursor (w
, true);
30979 return mouse_face_overwritten_p
;
30984 /* Redraw (parts) of all windows in the window tree rooted at W that
30985 intersect R. R contains frame pixel coordinates. Value is
30986 true if the exposure overwrites mouse-face. */
30989 expose_window_tree (struct window
*w
, XRectangle
*r
)
30991 struct frame
*f
= XFRAME (w
->frame
);
30992 bool mouse_face_overwritten_p
= false;
30994 while (w
&& !FRAME_GARBAGED_P (f
))
30996 mouse_face_overwritten_p
30997 |= (WINDOWP (w
->contents
)
30998 ? expose_window_tree (XWINDOW (w
->contents
), r
)
30999 : expose_window (w
, r
));
31001 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
31004 return mouse_face_overwritten_p
;
31009 Redisplay an exposed area of frame F. X and Y are the upper-left
31010 corner of the exposed rectangle. W and H are width and height of
31011 the exposed area. All are pixel values. W or H zero means redraw
31012 the entire frame. */
31015 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
31018 bool mouse_face_overwritten_p
= false;
31020 TRACE ((stderr
, "expose_frame "));
31022 /* No need to redraw if frame will be redrawn soon. */
31023 if (FRAME_GARBAGED_P (f
))
31025 TRACE ((stderr
, " garbaged\n"));
31029 /* If basic faces haven't been realized yet, there is no point in
31030 trying to redraw anything. This can happen when we get an expose
31031 event while Emacs is starting, e.g. by moving another window. */
31032 if (FRAME_FACE_CACHE (f
) == NULL
31033 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
31035 TRACE ((stderr
, " no faces\n"));
31039 if (w
== 0 || h
== 0)
31042 r
.width
= FRAME_TEXT_WIDTH (f
);
31043 r
.height
= FRAME_TEXT_HEIGHT (f
);
31053 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
31054 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
31056 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
31057 if (WINDOWP (f
->tool_bar_window
))
31058 mouse_face_overwritten_p
31059 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
31062 #ifdef HAVE_X_WINDOWS
31064 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
31065 if (WINDOWP (f
->menu_bar_window
))
31066 mouse_face_overwritten_p
31067 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
31068 #endif /* not USE_X_TOOLKIT and not USE_GTK */
31072 /* Some window managers support a focus-follows-mouse style with
31073 delayed raising of frames. Imagine a partially obscured frame,
31074 and moving the mouse into partially obscured mouse-face on that
31075 frame. The visible part of the mouse-face will be highlighted,
31076 then the WM raises the obscured frame. With at least one WM, KDE
31077 2.1, Emacs is not getting any event for the raising of the frame
31078 (even tried with SubstructureRedirectMask), only Expose events.
31079 These expose events will draw text normally, i.e. not
31080 highlighted. Which means we must redo the highlight here.
31081 Subsume it under ``we love X''. --gerd 2001-08-15 */
31082 /* Included in Windows version because Windows most likely does not
31083 do the right thing if any third party tool offers
31084 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
31085 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
31087 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
31088 if (f
== hlinfo
->mouse_face_mouse_frame
)
31090 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
31091 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
31092 clear_mouse_face (hlinfo
);
31093 note_mouse_highlight (f
, mouse_x
, mouse_y
);
31100 Determine the intersection of two rectangles R1 and R2. Return
31101 the intersection in *RESULT. Value is true if RESULT is not
31105 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
31107 XRectangle
*left
, *right
;
31108 XRectangle
*upper
, *lower
;
31109 bool intersection_p
= false;
31111 /* Rearrange so that R1 is the left-most rectangle. */
31113 left
= r1
, right
= r2
;
31115 left
= r2
, right
= r1
;
31117 /* X0 of the intersection is right.x0, if this is inside R1,
31118 otherwise there is no intersection. */
31119 if (right
->x
<= left
->x
+ left
->width
)
31121 result
->x
= right
->x
;
31123 /* The right end of the intersection is the minimum of
31124 the right ends of left and right. */
31125 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
31128 /* Same game for Y. */
31130 upper
= r1
, lower
= r2
;
31132 upper
= r2
, lower
= r1
;
31134 /* The upper end of the intersection is lower.y0, if this is inside
31135 of upper. Otherwise, there is no intersection. */
31136 if (lower
->y
<= upper
->y
+ upper
->height
)
31138 result
->y
= lower
->y
;
31140 /* The lower end of the intersection is the minimum of the lower
31141 ends of upper and lower. */
31142 result
->height
= (min (lower
->y
+ lower
->height
,
31143 upper
->y
+ upper
->height
)
31145 intersection_p
= true;
31149 return intersection_p
;
31152 #endif /* HAVE_WINDOW_SYSTEM */
31155 /***********************************************************************
31157 ***********************************************************************/
31160 syms_of_xdisp (void)
31162 Vwith_echo_area_save_vector
= Qnil
;
31163 staticpro (&Vwith_echo_area_save_vector
);
31165 Vmessage_stack
= Qnil
;
31166 staticpro (&Vmessage_stack
);
31168 /* Non-nil means don't actually do any redisplay. */
31169 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
31171 DEFSYM (Qredisplay_internal_xC_functionx
, "redisplay_internal (C function)");
31173 DEFVAR_BOOL("inhibit-message", inhibit_message
,
31174 doc
: /* Non-nil means calls to `message' are not displayed.
31175 They are still logged to the *Messages* buffer. */);
31176 inhibit_message
= 0;
31178 message_dolog_marker1
= Fmake_marker ();
31179 staticpro (&message_dolog_marker1
);
31180 message_dolog_marker2
= Fmake_marker ();
31181 staticpro (&message_dolog_marker2
);
31182 message_dolog_marker3
= Fmake_marker ();
31183 staticpro (&message_dolog_marker3
);
31186 defsubr (&Sdump_frame_glyph_matrix
);
31187 defsubr (&Sdump_glyph_matrix
);
31188 defsubr (&Sdump_glyph_row
);
31189 defsubr (&Sdump_tool_bar_row
);
31190 defsubr (&Strace_redisplay
);
31191 defsubr (&Strace_to_stderr
);
31193 #ifdef HAVE_WINDOW_SYSTEM
31194 defsubr (&Stool_bar_height
);
31195 defsubr (&Slookup_image_map
);
31197 defsubr (&Sline_pixel_height
);
31198 defsubr (&Sformat_mode_line
);
31199 defsubr (&Sinvisible_p
);
31200 defsubr (&Scurrent_bidi_paragraph_direction
);
31201 defsubr (&Swindow_text_pixel_size
);
31202 defsubr (&Smove_point_visually
);
31203 defsubr (&Sbidi_find_overridden_directionality
);
31205 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
31206 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
31207 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
31208 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
31209 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
31210 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
31211 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
31212 DEFSYM (Qeval
, "eval");
31213 DEFSYM (QCdata
, ":data");
31215 /* Names of text properties relevant for redisplay. */
31216 DEFSYM (Qdisplay
, "display");
31217 DEFSYM (Qspace_width
, "space-width");
31218 DEFSYM (Qraise
, "raise");
31219 DEFSYM (Qslice
, "slice");
31220 DEFSYM (Qspace
, "space");
31221 DEFSYM (Qmargin
, "margin");
31222 DEFSYM (Qpointer
, "pointer");
31223 DEFSYM (Qleft_margin
, "left-margin");
31224 DEFSYM (Qright_margin
, "right-margin");
31225 DEFSYM (Qcenter
, "center");
31226 DEFSYM (Qline_height
, "line-height");
31227 DEFSYM (QCalign_to
, ":align-to");
31228 DEFSYM (QCrelative_width
, ":relative-width");
31229 DEFSYM (QCrelative_height
, ":relative-height");
31230 DEFSYM (QCeval
, ":eval");
31231 DEFSYM (QCpropertize
, ":propertize");
31232 DEFSYM (QCfile
, ":file");
31233 DEFSYM (Qfontified
, "fontified");
31234 DEFSYM (Qfontification_functions
, "fontification-functions");
31236 /* Name of the face used to highlight trailing whitespace. */
31237 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
31239 /* Name and number of the face used to highlight escape glyphs. */
31240 DEFSYM (Qescape_glyph
, "escape-glyph");
31242 /* Name and number of the face used to highlight non-breaking
31244 DEFSYM (Qnobreak_space
, "nobreak-space");
31245 DEFSYM (Qnobreak_hyphen
, "nobreak-hyphen");
31247 /* The symbol 'image' which is the car of the lists used to represent
31248 images in Lisp. Also a tool bar style. */
31249 DEFSYM (Qimage
, "image");
31251 /* Tool bar styles. */
31252 DEFSYM (Qtext
, "text");
31253 DEFSYM (Qboth
, "both");
31254 DEFSYM (Qboth_horiz
, "both-horiz");
31255 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
31257 /* The image map types. */
31258 DEFSYM (QCmap
, ":map");
31259 DEFSYM (QCpointer
, ":pointer");
31260 DEFSYM (Qrect
, "rect");
31261 DEFSYM (Qcircle
, "circle");
31262 DEFSYM (Qpoly
, "poly");
31264 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
31266 DEFSYM (Qgrow_only
, "grow-only");
31267 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
31268 DEFSYM (Qposition
, "position");
31269 DEFSYM (Qbuffer_position
, "buffer-position");
31270 DEFSYM (Qobject
, "object");
31272 /* Cursor shapes. */
31273 DEFSYM (Qbar
, "bar");
31274 DEFSYM (Qhbar
, "hbar");
31275 DEFSYM (Qbox
, "box");
31276 DEFSYM (Qhollow
, "hollow");
31278 /* Pointer shapes. */
31279 DEFSYM (Qhand
, "hand");
31280 DEFSYM (Qarrow
, "arrow");
31283 DEFSYM (Qdragging
, "dragging");
31285 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
31287 list_of_error
= list1 (list2 (Qerror
, Qvoid_variable
));
31288 staticpro (&list_of_error
);
31290 /* Values of those variables at last redisplay are stored as
31291 properties on 'overlay-arrow-position' symbol. However, if
31292 Voverlay_arrow_position is a marker, last-arrow-position is its
31293 numerical position. */
31294 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
31295 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
31297 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
31298 properties on a symbol in overlay-arrow-variable-list. */
31299 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
31300 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
31302 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
31303 staticpro (&echo_buffer
[0]);
31304 staticpro (&echo_buffer
[1]);
31306 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
31307 staticpro (&echo_area_buffer
[0]);
31308 staticpro (&echo_area_buffer
[1]);
31310 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
31311 staticpro (&Vmessages_buffer_name
);
31313 mode_line_proptrans_alist
= Qnil
;
31314 staticpro (&mode_line_proptrans_alist
);
31315 mode_line_string_list
= Qnil
;
31316 staticpro (&mode_line_string_list
);
31317 mode_line_string_face
= Qnil
;
31318 staticpro (&mode_line_string_face
);
31319 mode_line_string_face_prop
= Qnil
;
31320 staticpro (&mode_line_string_face_prop
);
31321 Vmode_line_unwind_vector
= Qnil
;
31322 staticpro (&Vmode_line_unwind_vector
);
31324 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
31326 help_echo_string
= Qnil
;
31327 staticpro (&help_echo_string
);
31328 help_echo_object
= Qnil
;
31329 staticpro (&help_echo_object
);
31330 help_echo_window
= Qnil
;
31331 staticpro (&help_echo_window
);
31332 previous_help_echo_string
= Qnil
;
31333 staticpro (&previous_help_echo_string
);
31334 help_echo_pos
= -1;
31336 DEFSYM (Qright_to_left
, "right-to-left");
31337 DEFSYM (Qleft_to_right
, "left-to-right");
31338 defsubr (&Sbidi_resolved_levels
);
31340 #ifdef HAVE_WINDOW_SYSTEM
31341 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
31342 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
31343 For example, if a block cursor is over a tab, it will be drawn as
31344 wide as that tab on the display. */);
31345 x_stretch_cursor_p
= 0;
31348 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
31349 doc
: /* Non-nil means highlight trailing whitespace.
31350 The face used for trailing whitespace is `trailing-whitespace'. */);
31351 Vshow_trailing_whitespace
= Qnil
;
31353 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
31354 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
31355 If the value is t, Emacs highlights non-ASCII chars which have the
31356 same appearance as an ASCII space or hyphen, using the `nobreak-space'
31357 or `nobreak-hyphen' face respectively.
31359 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
31360 U+2011 (non-breaking hyphen) are affected.
31362 Any other non-nil value means to display these characters as a escape
31363 glyph followed by an ordinary space or hyphen.
31365 A value of nil means no special handling of these characters. */);
31366 Vnobreak_char_display
= Qt
;
31368 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
31369 doc
: /* The pointer shape to show in void text areas.
31370 A value of nil means to show the text pointer. Other options are
31371 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
31373 Vvoid_text_area_pointer
= Qarrow
;
31375 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
31376 doc
: /* Non-nil means don't actually do any redisplay.
31377 This is used for internal purposes. */);
31378 Vinhibit_redisplay
= Qnil
;
31380 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
31381 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
31382 Vglobal_mode_string
= Qnil
;
31384 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
31385 doc
: /* Marker for where to display an arrow on top of the buffer text.
31386 This must be the beginning of a line in order to work.
31387 See also `overlay-arrow-string'. */);
31388 Voverlay_arrow_position
= Qnil
;
31390 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
31391 doc
: /* String to display as an arrow in non-window frames.
31392 See also `overlay-arrow-position'. */);
31393 Voverlay_arrow_string
= build_pure_c_string ("=>");
31395 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
31396 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
31397 The symbols on this list are examined during redisplay to determine
31398 where to display overlay arrows. */);
31399 Voverlay_arrow_variable_list
31400 = list1 (intern_c_string ("overlay-arrow-position"));
31402 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
31403 doc
: /* The number of lines to try scrolling a window by when point moves out.
31404 If that fails to bring point back on frame, point is centered instead.
31405 If this is zero, point is always centered after it moves off frame.
31406 If you want scrolling to always be a line at a time, you should set
31407 `scroll-conservatively' to a large value rather than set this to 1. */);
31409 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
31410 doc
: /* Scroll up to this many lines, to bring point back on screen.
31411 If point moves off-screen, redisplay will scroll by up to
31412 `scroll-conservatively' lines in order to bring point just barely
31413 onto the screen again. If that cannot be done, then redisplay
31414 recenters point as usual.
31416 If the value is greater than 100, redisplay will never recenter point,
31417 but will always scroll just enough text to bring point into view, even
31418 if you move far away.
31420 A value of zero means always recenter point if it moves off screen. */);
31421 scroll_conservatively
= 0;
31423 DEFVAR_INT ("scroll-margin", scroll_margin
,
31424 doc
: /* Number of lines of margin at the top and bottom of a window.
31425 Recenter the window whenever point gets within this many lines
31426 of the top or bottom of the window. */);
31429 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
31430 doc
: /* Pixels per inch value for non-window system displays.
31431 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
31432 Vdisplay_pixels_per_inch
= make_float (72.0);
31435 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
31438 DEFVAR_LISP ("truncate-partial-width-windows",
31439 Vtruncate_partial_width_windows
,
31440 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
31441 For an integer value, truncate lines in each window narrower than the
31442 full frame width, provided the total window width in column units is less
31443 than that integer; otherwise, respect the value of `truncate-lines'.
31444 The total width of the window is as returned by `window-total-width', it
31445 includes the fringes, the continuation and truncation glyphs, the
31446 display margins (if any), and the scroll bar
31448 For any other non-nil value, truncate lines in all windows that do
31449 not span the full frame width.
31451 A value of nil means to respect the value of `truncate-lines'.
31453 If `word-wrap' is enabled, you might want to reduce this. */);
31454 Vtruncate_partial_width_windows
= make_number (50);
31456 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
31457 doc
: /* Maximum buffer size for which line number should be displayed.
31458 If the buffer is bigger than this, the line number does not appear
31459 in the mode line. A value of nil means no limit. */);
31460 Vline_number_display_limit
= Qnil
;
31462 DEFVAR_INT ("line-number-display-limit-width",
31463 line_number_display_limit_width
,
31464 doc
: /* Maximum line width (in characters) for line number display.
31465 If the average length of the lines near point is bigger than this, then the
31466 line number may be omitted from the mode line. */);
31467 line_number_display_limit_width
= 200;
31469 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
31470 doc
: /* Non-nil means highlight region even in nonselected windows. */);
31471 highlight_nonselected_windows
= false;
31473 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
31474 doc
: /* Non-nil if more than one frame is visible on this display.
31475 Minibuffer-only frames don't count, but iconified frames do.
31476 This variable is not guaranteed to be accurate except while processing
31477 `frame-title-format' and `icon-title-format'. */);
31479 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
31480 doc
: /* Template for displaying the title bar of visible frames.
31481 \(Assuming the window manager supports this feature.)
31483 This variable has the same structure as `mode-line-format', except that
31484 the %c and %l constructs are ignored. It is used only on frames for
31485 which no explicit name has been set (see `modify-frame-parameters'). */);
31487 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
31488 doc
: /* Template for displaying the title bar of an iconified frame.
31489 \(Assuming the window manager supports this feature.)
31490 This variable has the same structure as `mode-line-format' (which see),
31491 and is used only on frames for which no explicit name has been set
31492 \(see `modify-frame-parameters'). */);
31494 = Vframe_title_format
31495 = listn (CONSTYPE_PURE
, 3,
31496 intern_c_string ("multiple-frames"),
31497 build_pure_c_string ("%b"),
31498 listn (CONSTYPE_PURE
, 4,
31499 empty_unibyte_string
,
31500 intern_c_string ("invocation-name"),
31501 build_pure_c_string ("@"),
31502 intern_c_string ("system-name")));
31504 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
31505 doc
: /* Maximum number of lines to keep in the message log buffer.
31506 If nil, disable message logging. If t, log messages but don't truncate
31507 the buffer when it becomes large. */);
31508 Vmessage_log_max
= make_number (1000);
31510 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
31511 doc
: /* List of functions to call before redisplaying a window with scrolling.
31512 Each function is called with two arguments, the window and its new
31513 display-start position.
31514 These functions are called whenever the `window-start' marker is modified,
31515 either to point into another buffer (e.g. via `set-window-buffer') or another
31516 place in the same buffer.
31517 Note that the value of `window-end' is not valid when these functions are
31520 Warning: Do not use this feature to alter the way the window
31521 is scrolled. It is not designed for that, and such use probably won't
31523 Vwindow_scroll_functions
= Qnil
;
31525 DEFVAR_LISP ("window-text-change-functions",
31526 Vwindow_text_change_functions
,
31527 doc
: /* Functions to call in redisplay when text in the window might change. */);
31528 Vwindow_text_change_functions
= Qnil
;
31530 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
31531 doc
: /* Functions called when redisplay of a window reaches the end trigger.
31532 Each function is called with two arguments, the window and the end trigger value.
31533 See `set-window-redisplay-end-trigger'. */);
31534 Vredisplay_end_trigger_functions
= Qnil
;
31536 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
31537 doc
: /* Non-nil means autoselect window with mouse pointer.
31538 If nil, do not autoselect windows.
31539 A positive number means delay autoselection by that many seconds: a
31540 window is autoselected only after the mouse has remained in that
31541 window for the duration of the delay.
31542 A negative number has a similar effect, but causes windows to be
31543 autoselected only after the mouse has stopped moving. (Because of
31544 the way Emacs compares mouse events, you will occasionally wait twice
31545 that time before the window gets selected.)
31546 Any other value means to autoselect window instantaneously when the
31547 mouse pointer enters it.
31549 Autoselection selects the minibuffer only if it is active, and never
31550 unselects the minibuffer if it is active.
31552 When customizing this variable make sure that the actual value of
31553 `focus-follows-mouse' matches the behavior of your window manager. */);
31554 Vmouse_autoselect_window
= Qnil
;
31556 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
31557 doc
: /* Non-nil means automatically resize tool-bars.
31558 This dynamically changes the tool-bar's height to the minimum height
31559 that is needed to make all tool-bar items visible.
31560 If value is `grow-only', the tool-bar's height is only increased
31561 automatically; to decrease the tool-bar height, use \\[recenter]. */);
31562 Vauto_resize_tool_bars
= Qt
;
31564 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
31565 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
31566 auto_raise_tool_bar_buttons_p
= true;
31568 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
31569 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
31570 make_cursor_line_fully_visible_p
= true;
31572 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
31573 doc
: /* Border below tool-bar in pixels.
31574 If an integer, use it as the height of the border.
31575 If it is one of `internal-border-width' or `border-width', use the
31576 value of the corresponding frame parameter.
31577 Otherwise, no border is added below the tool-bar. */);
31578 Vtool_bar_border
= Qinternal_border_width
;
31580 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
31581 doc
: /* Margin around tool-bar buttons in pixels.
31582 If an integer, use that for both horizontal and vertical margins.
31583 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
31584 HORZ specifying the horizontal margin, and VERT specifying the
31585 vertical margin. */);
31586 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
31588 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
31589 doc
: /* Relief thickness of tool-bar buttons. */);
31590 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
31592 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
31593 doc
: /* Tool bar style to use.
31595 image - show images only
31596 text - show text only
31597 both - show both, text below image
31598 both-horiz - show text to the right of the image
31599 text-image-horiz - show text to the left of the image
31600 any other - use system default or image if no system default.
31602 This variable only affects the GTK+ toolkit version of Emacs. */);
31603 Vtool_bar_style
= Qnil
;
31605 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
31606 doc
: /* Maximum number of characters a label can have to be shown.
31607 The tool bar style must also show labels for this to have any effect, see
31608 `tool-bar-style'. */);
31609 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
31611 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
31612 doc
: /* List of functions to call to fontify regions of text.
31613 Each function is called with one argument POS. Functions must
31614 fontify a region starting at POS in the current buffer, and give
31615 fontified regions the property `fontified'. */);
31616 Vfontification_functions
= Qnil
;
31617 Fmake_variable_buffer_local (Qfontification_functions
);
31619 DEFVAR_BOOL ("unibyte-display-via-language-environment",
31620 unibyte_display_via_language_environment
,
31621 doc
: /* Non-nil means display unibyte text according to language environment.
31622 Specifically, this means that raw bytes in the range 160-255 decimal
31623 are displayed by converting them to the equivalent multibyte characters
31624 according to the current language environment. As a result, they are
31625 displayed according to the current fontset.
31627 Note that this variable affects only how these bytes are displayed,
31628 but does not change the fact they are interpreted as raw bytes. */);
31629 unibyte_display_via_language_environment
= false;
31631 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
31632 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
31633 If a float, it specifies a fraction of the mini-window frame's height.
31634 If an integer, it specifies a number of lines. */);
31635 Vmax_mini_window_height
= make_float (0.25);
31637 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
31638 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
31639 A value of nil means don't automatically resize mini-windows.
31640 A value of t means resize them to fit the text displayed in them.
31641 A value of `grow-only', the default, means let mini-windows grow only;
31642 they return to their normal size when the minibuffer is closed, or the
31643 echo area becomes empty. */);
31644 /* Contrary to the doc string, we initialize this to nil, so that
31645 loading loadup.el won't try to resize windows before loading
31646 window.el, where some functions we need to call for this live.
31647 We assign the 'grow-only' value right after loading window.el
31649 Vresize_mini_windows
= Qnil
;
31651 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
31652 doc
: /* Alist specifying how to blink the cursor off.
31653 Each element has the form (ON-STATE . OFF-STATE). Whenever the
31654 `cursor-type' frame-parameter or variable equals ON-STATE,
31655 comparing using `equal', Emacs uses OFF-STATE to specify
31656 how to blink it off. ON-STATE and OFF-STATE are values for
31657 the `cursor-type' frame parameter.
31659 If a frame's ON-STATE has no entry in this list,
31660 the frame's other specifications determine how to blink the cursor off. */);
31661 Vblink_cursor_alist
= Qnil
;
31663 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
31664 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
31665 If non-nil, windows are automatically scrolled horizontally to make
31666 point visible. */);
31667 automatic_hscrolling_p
= true;
31668 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
31670 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
31671 doc
: /* How many columns away from the window edge point is allowed to get
31672 before automatic hscrolling will horizontally scroll the window. */);
31673 hscroll_margin
= 5;
31675 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
31676 doc
: /* How many columns to scroll the window when point gets too close to the edge.
31677 When point is less than `hscroll-margin' columns from the window
31678 edge, automatic hscrolling will scroll the window by the amount of columns
31679 determined by this variable. If its value is a positive integer, scroll that
31680 many columns. If it's a positive floating-point number, it specifies the
31681 fraction of the window's width to scroll. If it's nil or zero, point will be
31682 centered horizontally after the scroll. Any other value, including negative
31683 numbers, are treated as if the value were zero.
31685 Automatic hscrolling always moves point outside the scroll margin, so if
31686 point was more than scroll step columns inside the margin, the window will
31687 scroll more than the value given by the scroll step.
31689 Note that the lower bound for automatic hscrolling specified by `scroll-left'
31690 and `scroll-right' overrides this variable's effect. */);
31691 Vhscroll_step
= make_number (0);
31693 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
31694 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
31695 Bind this around calls to `message' to let it take effect. */);
31696 message_truncate_lines
= false;
31698 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
31699 doc
: /* Normal hook run to update the menu bar definitions.
31700 Redisplay runs this hook before it redisplays the menu bar.
31701 This is used to update menus such as Buffers, whose contents depend on
31703 Vmenu_bar_update_hook
= Qnil
;
31705 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
31706 doc
: /* Frame for which we are updating a menu.
31707 The enable predicate for a menu binding should check this variable. */);
31708 Vmenu_updating_frame
= Qnil
;
31710 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
31711 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
31712 inhibit_menubar_update
= false;
31714 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
31715 doc
: /* Prefix prepended to all continuation lines at display time.
31716 The value may be a string, an image, or a stretch-glyph; it is
31717 interpreted in the same way as the value of a `display' text property.
31719 This variable is overridden by any `wrap-prefix' text or overlay
31722 To add a prefix to non-continuation lines, use `line-prefix'. */);
31723 Vwrap_prefix
= Qnil
;
31724 DEFSYM (Qwrap_prefix
, "wrap-prefix");
31725 Fmake_variable_buffer_local (Qwrap_prefix
);
31727 DEFVAR_LISP ("line-prefix", Vline_prefix
,
31728 doc
: /* Prefix prepended to all non-continuation lines at display time.
31729 The value may be a string, an image, or a stretch-glyph; it is
31730 interpreted in the same way as the value of a `display' text property.
31732 This variable is overridden by any `line-prefix' text or overlay
31735 To add a prefix to continuation lines, use `wrap-prefix'. */);
31736 Vline_prefix
= Qnil
;
31737 DEFSYM (Qline_prefix
, "line-prefix");
31738 Fmake_variable_buffer_local (Qline_prefix
);
31740 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
31741 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
31742 inhibit_eval_during_redisplay
= false;
31744 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
31745 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
31746 inhibit_free_realized_faces
= false;
31748 DEFVAR_BOOL ("inhibit-bidi-mirroring", inhibit_bidi_mirroring
,
31749 doc
: /* Non-nil means don't mirror characters even when bidi context requires that.
31750 Intended for use during debugging and for testing bidi display;
31751 see biditest.el in the test suite. */);
31752 inhibit_bidi_mirroring
= false;
31755 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
31756 doc
: /* Inhibit try_window_id display optimization. */);
31757 inhibit_try_window_id
= false;
31759 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
31760 doc
: /* Inhibit try_window_reusing display optimization. */);
31761 inhibit_try_window_reusing
= false;
31763 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
31764 doc
: /* Inhibit try_cursor_movement display optimization. */);
31765 inhibit_try_cursor_movement
= false;
31766 #endif /* GLYPH_DEBUG */
31768 DEFVAR_INT ("overline-margin", overline_margin
,
31769 doc
: /* Space between overline and text, in pixels.
31770 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
31771 margin to the character height. */);
31772 overline_margin
= 2;
31774 DEFVAR_INT ("underline-minimum-offset",
31775 underline_minimum_offset
,
31776 doc
: /* Minimum distance between baseline and underline.
31777 This can improve legibility of underlined text at small font sizes,
31778 particularly when using variable `x-use-underline-position-properties'
31779 with fonts that specify an UNDERLINE_POSITION relatively close to the
31780 baseline. The default value is 1. */);
31781 underline_minimum_offset
= 1;
31783 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
31784 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
31785 This feature only works when on a window system that can change
31786 cursor shapes. */);
31787 display_hourglass_p
= true;
31789 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
31790 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
31791 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
31793 #ifdef HAVE_WINDOW_SYSTEM
31794 hourglass_atimer
= NULL
;
31795 hourglass_shown_p
= false;
31796 #endif /* HAVE_WINDOW_SYSTEM */
31798 /* Name of the face used to display glyphless characters. */
31799 DEFSYM (Qglyphless_char
, "glyphless-char");
31801 /* Method symbols for Vglyphless_char_display. */
31802 DEFSYM (Qhex_code
, "hex-code");
31803 DEFSYM (Qempty_box
, "empty-box");
31804 DEFSYM (Qthin_space
, "thin-space");
31805 DEFSYM (Qzero_width
, "zero-width");
31807 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
31808 doc
: /* Function run just before redisplay.
31809 It is called with one argument, which is the set of windows that are to
31810 be redisplayed. This set can be nil (meaning, only the selected window),
31811 or t (meaning all windows). */);
31812 Vpre_redisplay_function
= intern ("ignore");
31814 /* Symbol for the purpose of Vglyphless_char_display. */
31815 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
31816 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
31818 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
31819 doc
: /* Char-table defining glyphless characters.
31820 Each element, if non-nil, should be one of the following:
31821 an ASCII acronym string: display this string in a box
31822 `hex-code': display the hexadecimal code of a character in a box
31823 `empty-box': display as an empty box
31824 `thin-space': display as 1-pixel width space
31825 `zero-width': don't display
31826 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
31827 display method for graphical terminals and text terminals respectively.
31828 GRAPHICAL and TEXT should each have one of the values listed above.
31830 The char-table has one extra slot to control the display of a character for
31831 which no font is found. This slot only takes effect on graphical terminals.
31832 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
31833 `thin-space'. The default is `empty-box'.
31835 If a character has a non-nil entry in an active display table, the
31836 display table takes effect; in this case, Emacs does not consult
31837 `glyphless-char-display' at all. */);
31838 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
31839 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
31842 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
31843 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
31844 Vdebug_on_message
= Qnil
;
31846 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
31848 Vredisplay__all_windows_cause
= Fmake_hash_table (0, NULL
);
31850 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
31852 Vredisplay__mode_lines_cause
= Fmake_hash_table (0, NULL
);
31854 DEFVAR_LISP ("redisplay--variables", Vredisplay__variables
,
31855 doc
: /* A hash-table of variables changing which triggers a thorough redisplay. */);
31856 Vredisplay__variables
= Qnil
;
31858 DEFVAR_BOOL ("redisplay--inhibit-bidi", redisplay__inhibit_bidi
,
31859 doc
: /* Non-nil means it is not safe to attempt bidi reordering for display. */);
31860 /* Initialize to t, since we need to disable reordering until
31861 loadup.el successfully loads charprop.el. */
31862 redisplay__inhibit_bidi
= true;
31866 /* Initialize this module when Emacs starts. */
31871 CHARPOS (this_line_start_pos
) = 0;
31873 if (!noninteractive
)
31875 struct window
*m
= XWINDOW (minibuf_window
);
31876 Lisp_Object frame
= m
->frame
;
31877 struct frame
*f
= XFRAME (frame
);
31878 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
31879 struct window
*r
= XWINDOW (root
);
31882 echo_area_window
= minibuf_window
;
31884 r
->top_line
= FRAME_TOP_MARGIN (f
);
31885 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
31886 r
->total_cols
= FRAME_COLS (f
);
31887 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31888 r
->total_lines
= FRAME_TOTAL_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
31889 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
31891 m
->top_line
= FRAME_TOTAL_LINES (f
) - 1;
31892 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
31893 m
->total_cols
= FRAME_COLS (f
);
31894 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31895 m
->total_lines
= 1;
31896 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
31898 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
31899 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
31900 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
31902 /* The default ellipsis glyphs `...'. */
31903 for (i
= 0; i
< 3; ++i
)
31904 default_invis_vector
[i
] = make_number ('.');
31908 /* Allocate the buffer for frame titles.
31909 Also used for `format-mode-line'. */
31911 mode_line_noprop_buf
= xmalloc (size
);
31912 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
31913 mode_line_noprop_ptr
= mode_line_noprop_buf
;
31914 mode_line_target
= MODE_LINE_DISPLAY
;
31917 help_echo_showing_p
= false;
31920 #ifdef HAVE_WINDOW_SYSTEM
31922 /* Platform-independent portion of hourglass implementation. */
31924 /* Timer function of hourglass_atimer. */
31927 show_hourglass (struct atimer
*timer
)
31929 /* The timer implementation will cancel this timer automatically
31930 after this function has run. Set hourglass_atimer to null
31931 so that we know the timer doesn't have to be canceled. */
31932 hourglass_atimer
= NULL
;
31934 if (!hourglass_shown_p
)
31936 Lisp_Object tail
, frame
;
31940 FOR_EACH_FRAME (tail
, frame
)
31942 struct frame
*f
= XFRAME (frame
);
31944 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31945 && FRAME_RIF (f
)->show_hourglass
)
31946 FRAME_RIF (f
)->show_hourglass (f
);
31949 hourglass_shown_p
= true;
31954 /* Cancel a currently active hourglass timer, and start a new one. */
31957 start_hourglass (void)
31959 struct timespec delay
;
31961 cancel_hourglass ();
31963 if (INTEGERP (Vhourglass_delay
)
31964 && XINT (Vhourglass_delay
) > 0)
31965 delay
= make_timespec (min (XINT (Vhourglass_delay
),
31966 TYPE_MAXIMUM (time_t)),
31968 else if (FLOATP (Vhourglass_delay
)
31969 && XFLOAT_DATA (Vhourglass_delay
) > 0)
31970 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
31972 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
31974 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
31975 show_hourglass
, NULL
);
31978 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31982 cancel_hourglass (void)
31984 if (hourglass_atimer
)
31986 cancel_atimer (hourglass_atimer
);
31987 hourglass_atimer
= NULL
;
31990 if (hourglass_shown_p
)
31992 Lisp_Object tail
, frame
;
31996 FOR_EACH_FRAME (tail
, frame
)
31998 struct frame
*f
= XFRAME (frame
);
32000 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
32001 && FRAME_RIF (f
)->hide_hourglass
)
32002 FRAME_RIF (f
)->hide_hourglass (f
);
32004 /* No cursors on non GUI frames - restore to stock arrow cursor. */
32005 else if (!FRAME_W32_P (f
))
32006 w32_arrow_cursor ();
32010 hourglass_shown_p
= false;
32015 #endif /* HAVE_WINDOW_SYSTEM */