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_FROM_ID_OR_NULL (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_FROM_ID_OR_NULL (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_FROM_ID_OR_NULL. This will happen
3881 if this is the initial call that gets the face. */
3882 struct face
*old_face
= FACE_FROM_ID_OR_NULL (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_FROM_ID_OR_NULL (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_FROM_ID_OR_NULL (it
->f
, it
->face_id
);
3993 /* If new face has a box but old face hasn't, this is the
3994 start of a run of characters with box, i.e. it has a
3995 shadow on the left side. */
3996 it
->start_of_box_run_p
3997 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3998 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
4002 it
->face_id
= new_face_id
;
4003 return HANDLED_NORMALLY
;
4007 /* Return the ID of the face ``underlying'' IT's current position,
4008 which is in a string. If the iterator is associated with a
4009 buffer, return the face at IT's current buffer position.
4010 Otherwise, use the iterator's base_face_id. */
4013 underlying_face_id (struct it
*it
)
4015 int face_id
= it
->base_face_id
, i
;
4017 eassert (STRINGP (it
->string
));
4019 for (i
= it
->sp
- 1; i
>= 0; --i
)
4020 if (NILP (it
->stack
[i
].string
))
4021 face_id
= it
->stack
[i
].face_id
;
4027 /* Compute the face one character before or after the current position
4028 of IT, in the visual order. BEFORE_P means get the face
4029 in front (to the left in L2R paragraphs, to the right in R2L
4030 paragraphs) of IT's screen position. Value is the ID of the face. */
4033 face_before_or_after_it_pos (struct it
*it
, bool before_p
)
4036 ptrdiff_t next_check_charpos
;
4038 void *it_copy_data
= NULL
;
4040 eassert (it
->s
== NULL
);
4042 if (STRINGP (it
->string
))
4044 ptrdiff_t bufpos
, charpos
;
4047 /* No face change past the end of the string (for the case
4048 we are padding with spaces). No face change before the
4050 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
4051 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
4056 /* Set charpos to the position before or after IT's current
4057 position, in the logical order, which in the non-bidi
4058 case is the same as the visual order. */
4060 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4061 else if (it
->what
== IT_COMPOSITION
)
4062 /* For composition, we must check the character after the
4064 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4066 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4072 /* With bidi iteration, the character before the current
4073 in the visual order cannot be found by simple
4074 iteration, because "reverse" reordering is not
4075 supported. Instead, we need to start from the string
4076 beginning and go all the way to the current string
4077 position, remembering the previous position. */
4078 /* Ignore face changes before the first visible
4079 character on this display line. */
4080 if (it
->current_x
<= it
->first_visible_x
)
4082 SAVE_IT (it_copy
, *it
, it_copy_data
);
4083 IT_STRING_CHARPOS (it_copy
) = 0;
4084 bidi_init_it (0, 0, FRAME_WINDOW_P (it_copy
.f
), &it_copy
.bidi_it
);
4088 charpos
= IT_STRING_CHARPOS (it_copy
);
4089 if (charpos
>= SCHARS (it
->string
))
4091 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4093 while (IT_STRING_CHARPOS (it_copy
) != IT_STRING_CHARPOS (*it
));
4095 RESTORE_IT (it
, it
, it_copy_data
);
4099 /* Set charpos to the string position of the character
4100 that comes after IT's current position in the visual
4102 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4106 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4108 charpos
= it_copy
.bidi_it
.charpos
;
4111 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4113 if (it
->current
.overlay_string_index
>= 0)
4114 bufpos
= IT_CHARPOS (*it
);
4118 base_face_id
= underlying_face_id (it
);
4120 /* Get the face for ASCII, or unibyte. */
4121 face_id
= face_at_string_position (it
->w
,
4125 &next_check_charpos
,
4126 base_face_id
, false);
4128 /* Correct the face for charsets different from ASCII. Do it
4129 for the multibyte case only. The face returned above is
4130 suitable for unibyte text if IT->string is unibyte. */
4131 if (STRING_MULTIBYTE (it
->string
))
4133 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4134 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4136 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4138 c
= string_char_and_length (p
, &len
);
4139 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4144 struct text_pos pos
;
4146 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4147 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4150 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4151 pos
= it
->current
.pos
;
4156 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4159 if (it
->what
== IT_COMPOSITION
)
4161 /* For composition, we must check the position after
4163 pos
.charpos
+= it
->cmp_it
.nchars
;
4164 pos
.bytepos
+= it
->len
;
4167 INC_TEXT_POS (pos
, it
->multibyte_p
);
4176 /* With bidi iteration, the character before the current
4177 in the visual order cannot be found by simple
4178 iteration, because "reverse" reordering is not
4179 supported. Instead, we need to use the move_it_*
4180 family of functions, and move to the previous
4181 character starting from the beginning of the visual
4183 /* Ignore face changes before the first visible
4184 character on this display line. */
4185 if (it
->current_x
<= it
->first_visible_x
)
4187 SAVE_IT (it_copy
, *it
, it_copy_data
);
4188 /* Implementation note: Since move_it_in_display_line
4189 works in the iterator geometry, and thinks the first
4190 character is always the leftmost, even in R2L lines,
4191 we don't need to distinguish between the R2L and L2R
4193 current_x
= it_copy
.current_x
;
4194 move_it_vertically_backward (&it_copy
, 0);
4195 move_it_in_display_line (&it_copy
, ZV
, current_x
- 1, MOVE_TO_X
);
4196 pos
= it_copy
.current
.pos
;
4197 RESTORE_IT (it
, it
, it_copy_data
);
4201 /* Set charpos to the buffer position of the character
4202 that comes after IT's current position in the visual
4204 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4208 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4211 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4214 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4216 /* Determine face for CHARSET_ASCII, or unibyte. */
4217 face_id
= face_at_buffer_position (it
->w
,
4219 &next_check_charpos
,
4222 /* Correct the face for charsets different from ASCII. Do it
4223 for the multibyte case only. The face returned above is
4224 suitable for unibyte text if current_buffer is unibyte. */
4225 if (it
->multibyte_p
)
4227 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4228 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4229 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4238 /***********************************************************************
4240 ***********************************************************************/
4242 /* Set up iterator IT from invisible properties at its current
4243 position. Called from handle_stop. */
4245 static enum prop_handled
4246 handle_invisible_prop (struct it
*it
)
4248 enum prop_handled handled
= HANDLED_NORMALLY
;
4252 if (STRINGP (it
->string
))
4254 Lisp_Object end_charpos
, limit
;
4256 /* Get the value of the invisible text property at the
4257 current position. Value will be nil if there is no such
4259 end_charpos
= make_number (IT_STRING_CHARPOS (*it
));
4260 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4261 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4263 if (invis
!= 0 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4265 /* Record whether we have to display an ellipsis for the
4267 bool display_ellipsis_p
= (invis
== 2);
4268 ptrdiff_t len
, endpos
;
4270 handled
= HANDLED_RECOMPUTE_PROPS
;
4272 /* Get the position at which the next visible text can be
4273 found in IT->string, if any. */
4274 endpos
= len
= SCHARS (it
->string
);
4275 XSETINT (limit
, len
);
4279 = Fnext_single_property_change (end_charpos
, Qinvisible
,
4281 /* Since LIMIT is always an integer, so should be the
4282 value returned by Fnext_single_property_change. */
4283 eassert (INTEGERP (end_charpos
));
4284 if (INTEGERP (end_charpos
))
4286 endpos
= XFASTINT (end_charpos
);
4287 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4288 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4290 display_ellipsis_p
= true;
4292 else /* Should never happen; but if it does, exit the loop. */
4295 while (invis
!= 0 && endpos
< len
);
4297 if (display_ellipsis_p
)
4298 it
->ellipsis_p
= true;
4302 /* Text at END_CHARPOS is visible. Move IT there. */
4303 struct text_pos old
;
4306 old
= it
->current
.string_pos
;
4307 oldpos
= CHARPOS (old
);
4310 if (it
->bidi_it
.first_elt
4311 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4312 bidi_paragraph_init (it
->paragraph_embedding
,
4313 &it
->bidi_it
, true);
4314 /* Bidi-iterate out of the invisible text. */
4317 bidi_move_to_visually_next (&it
->bidi_it
);
4319 while (oldpos
<= it
->bidi_it
.charpos
4320 && it
->bidi_it
.charpos
< endpos
);
4322 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4323 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4324 if (IT_CHARPOS (*it
) >= endpos
)
4325 it
->prev_stop
= endpos
;
4329 IT_STRING_CHARPOS (*it
) = endpos
;
4330 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4335 /* The rest of the string is invisible. If this is an
4336 overlay string, proceed with the next overlay string
4337 or whatever comes and return a character from there. */
4338 if (it
->current
.overlay_string_index
>= 0
4339 && !display_ellipsis_p
)
4341 next_overlay_string (it
);
4342 /* Don't check for overlay strings when we just
4343 finished processing them. */
4344 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4348 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4349 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4356 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4357 Lisp_Object pos
, overlay
;
4359 /* First of all, is there invisible text at this position? */
4360 tem
= start_charpos
= IT_CHARPOS (*it
);
4361 pos
= make_number (tem
);
4362 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4364 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4366 /* If we are on invisible text, skip over it. */
4367 if (invis
!= 0 && start_charpos
< it
->end_charpos
)
4369 /* Record whether we have to display an ellipsis for the
4371 bool display_ellipsis_p
= invis
== 2;
4373 handled
= HANDLED_RECOMPUTE_PROPS
;
4375 /* Loop skipping over invisible text. The loop is left at
4376 ZV or with IT on the first char being visible again. */
4379 /* Try to skip some invisible text. Return value is the
4380 position reached which can be equal to where we start
4381 if there is nothing invisible there. This skips both
4382 over invisible text properties and overlays with
4383 invisible property. */
4384 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4386 /* If we skipped nothing at all we weren't at invisible
4387 text in the first place. If everything to the end of
4388 the buffer was skipped, end the loop. */
4389 if (newpos
== tem
|| newpos
>= ZV
)
4393 /* We skipped some characters but not necessarily
4394 all there are. Check if we ended up on visible
4395 text. Fget_char_property returns the property of
4396 the char before the given position, i.e. if we
4397 get invis = 0, this means that the char at
4398 newpos is visible. */
4399 pos
= make_number (newpos
);
4400 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4401 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4404 /* If we ended up on invisible text, proceed to
4405 skip starting with next_stop. */
4409 /* If there are adjacent invisible texts, don't lose the
4410 second one's ellipsis. */
4412 display_ellipsis_p
= true;
4416 /* The position newpos is now either ZV or on visible text. */
4419 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4421 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4423 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4425 /* If the invisible text ends on a newline or on a
4426 character after a newline, we can avoid the costly,
4427 character by character, bidi iteration to NEWPOS, and
4428 instead simply reseat the iterator there. That's
4429 because all bidi reordering information is tossed at
4430 the newline. This is a big win for modes that hide
4431 complete lines, like Outline, Org, etc. */
4432 if (on_newline
|| after_newline
)
4434 struct text_pos tpos
;
4435 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4437 SET_TEXT_POS (tpos
, newpos
, bpos
);
4438 reseat_1 (it
, tpos
, false);
4439 /* If we reseat on a newline/ZV, we need to prep the
4440 bidi iterator for advancing to the next character
4441 after the newline/EOB, keeping the current paragraph
4442 direction (so that PRODUCE_GLYPHS does TRT wrt
4443 prepending/appending glyphs to a glyph row). */
4446 it
->bidi_it
.first_elt
= false;
4447 it
->bidi_it
.paragraph_dir
= pdir
;
4448 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4449 it
->bidi_it
.nchars
= 1;
4450 it
->bidi_it
.ch_len
= 1;
4453 else /* Must use the slow method. */
4455 /* With bidi iteration, the region of invisible text
4456 could start and/or end in the middle of a
4457 non-base embedding level. Therefore, we need to
4458 skip invisible text using the bidi iterator,
4459 starting at IT's current position, until we find
4460 ourselves outside of the invisible text.
4461 Skipping invisible text _after_ bidi iteration
4462 avoids affecting the visual order of the
4463 displayed text when invisible properties are
4464 added or removed. */
4465 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4467 /* If we were `reseat'ed to a new paragraph,
4468 determine the paragraph base direction. We
4469 need to do it now because
4470 next_element_from_buffer may not have a
4471 chance to do it, if we are going to skip any
4472 text at the beginning, which resets the
4474 bidi_paragraph_init (it
->paragraph_embedding
,
4475 &it
->bidi_it
, true);
4479 bidi_move_to_visually_next (&it
->bidi_it
);
4481 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4482 && it
->bidi_it
.charpos
< newpos
);
4483 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4484 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4485 /* If we overstepped NEWPOS, record its position in
4486 the iterator, so that we skip invisible text if
4487 later the bidi iteration lands us in the
4488 invisible region again. */
4489 if (IT_CHARPOS (*it
) >= newpos
)
4490 it
->prev_stop
= newpos
;
4495 IT_CHARPOS (*it
) = newpos
;
4496 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4499 if (display_ellipsis_p
)
4501 /* Make sure that the glyphs of the ellipsis will get
4502 correct `charpos' values. If we would not update
4503 it->position here, the glyphs would belong to the
4504 last visible character _before_ the invisible
4505 text, which confuses `set_cursor_from_row'.
4507 We use the last invisible position instead of the
4508 first because this way the cursor is always drawn on
4509 the first "." of the ellipsis, whenever PT is inside
4510 the invisible text. Otherwise the cursor would be
4511 placed _after_ the ellipsis when the point is after the
4512 first invisible character. */
4513 if (!STRINGP (it
->object
))
4515 it
->position
.charpos
= newpos
- 1;
4516 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4520 /* If there are before-strings at the start of invisible
4521 text, and the text is invisible because of a text
4522 property, arrange to show before-strings because 20.x did
4523 it that way. (If the text is invisible because of an
4524 overlay property instead of a text property, this is
4525 already handled in the overlay code.) */
4527 && get_overlay_strings (it
, it
->stop_charpos
))
4529 handled
= HANDLED_RECOMPUTE_PROPS
;
4532 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4533 /* The call to get_overlay_strings above recomputes
4534 it->stop_charpos, but it only considers changes
4535 in properties and overlays beyond iterator's
4536 current position. This causes us to miss changes
4537 that happen exactly where the invisible property
4538 ended. So we play it safe here and force the
4539 iterator to check for potential stop positions
4540 immediately after the invisible text. Note that
4541 if get_overlay_strings returns true, it
4542 normally also pushed the iterator stack, so we
4543 need to update the stop position in the slot
4544 below the current one. */
4545 it
->stack
[it
->sp
- 1].stop_charpos
4546 = CHARPOS (it
->stack
[it
->sp
- 1].current
.pos
);
4549 else if (display_ellipsis_p
)
4551 it
->ellipsis_p
= true;
4552 /* Let the ellipsis display before
4553 considering any properties of the following char.
4554 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4555 handled
= HANDLED_RETURN
;
4564 /* Make iterator IT return `...' next.
4565 Replaces LEN characters from buffer. */
4568 setup_for_ellipsis (struct it
*it
, int len
)
4570 /* Use the display table definition for `...'. Invalid glyphs
4571 will be handled by the method returning elements from dpvec. */
4572 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4574 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4575 it
->dpvec
= v
->contents
;
4576 it
->dpend
= v
->contents
+ v
->header
.size
;
4580 /* Default `...'. */
4581 it
->dpvec
= default_invis_vector
;
4582 it
->dpend
= default_invis_vector
+ 3;
4585 it
->dpvec_char_len
= len
;
4586 it
->current
.dpvec_index
= 0;
4587 it
->dpvec_face_id
= -1;
4589 /* Use IT->saved_face_id for the ellipsis, so that it has the same
4590 face as the preceding text. IT->saved_face_id was set in
4591 handle_stop to the face of the preceding character, and will be
4592 different from IT->face_id only if the invisible text skipped in
4593 handle_invisible_prop has some non-default face on its first
4594 character. We thus ignore the face of the invisible text when we
4595 display the ellipsis. IT's face is restored in set_iterator_to_next. */
4596 if (it
->saved_face_id
>= 0)
4597 it
->face_id
= it
->saved_face_id
;
4599 /* If the ellipsis represents buffer text, it means we advanced in
4600 the buffer, so we should no longer ignore overlay strings. */
4601 if (it
->method
== GET_FROM_BUFFER
)
4602 it
->ignore_overlay_strings_at_pos_p
= false;
4604 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4605 it
->ellipsis_p
= true;
4610 /***********************************************************************
4612 ***********************************************************************/
4614 /* Set up iterator IT from `display' property at its current position.
4615 Called from handle_stop.
4616 We return HANDLED_RETURN if some part of the display property
4617 overrides the display of the buffer text itself.
4618 Otherwise we return HANDLED_NORMALLY. */
4620 static enum prop_handled
4621 handle_display_prop (struct it
*it
)
4623 Lisp_Object propval
, object
, overlay
;
4624 struct text_pos
*position
;
4626 /* Nonzero if some property replaces the display of the text itself. */
4627 int display_replaced
= 0;
4629 if (STRINGP (it
->string
))
4631 object
= it
->string
;
4632 position
= &it
->current
.string_pos
;
4633 bufpos
= CHARPOS (it
->current
.pos
);
4637 XSETWINDOW (object
, it
->w
);
4638 position
= &it
->current
.pos
;
4639 bufpos
= CHARPOS (*position
);
4642 /* Reset those iterator values set from display property values. */
4643 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4644 it
->space_width
= Qnil
;
4645 it
->font_height
= Qnil
;
4648 /* We don't support recursive `display' properties, i.e. string
4649 values that have a string `display' property, that have a string
4650 `display' property etc. */
4651 if (!it
->string_from_display_prop_p
)
4652 it
->area
= TEXT_AREA
;
4654 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4655 Qdisplay
, object
, &overlay
);
4657 return HANDLED_NORMALLY
;
4658 /* Now OVERLAY is the overlay that gave us this property, or nil
4659 if it was a text property. */
4661 if (!STRINGP (it
->string
))
4662 object
= it
->w
->contents
;
4664 display_replaced
= handle_display_spec (it
, propval
, object
, overlay
,
4666 FRAME_WINDOW_P (it
->f
));
4667 return display_replaced
!= 0 ? HANDLED_RETURN
: HANDLED_NORMALLY
;
4670 /* Subroutine of handle_display_prop. Returns non-zero if the display
4671 specification in SPEC is a replacing specification, i.e. it would
4672 replace the text covered by `display' property with something else,
4673 such as an image or a display string. If SPEC includes any kind or
4674 `(space ...) specification, the value is 2; this is used by
4675 compute_display_string_pos, which see.
4677 See handle_single_display_spec for documentation of arguments.
4678 FRAME_WINDOW_P is true if the window being redisplayed is on a
4679 GUI frame; this argument is used only if IT is NULL, see below.
4681 IT can be NULL, if this is called by the bidi reordering code
4682 through compute_display_string_pos, which see. In that case, this
4683 function only examines SPEC, but does not otherwise "handle" it, in
4684 the sense that it doesn't set up members of IT from the display
4687 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4688 Lisp_Object overlay
, struct text_pos
*position
,
4689 ptrdiff_t bufpos
, bool frame_window_p
)
4694 /* Simple specifications. */
4695 && !EQ (XCAR (spec
), Qimage
)
4696 #ifdef HAVE_XWIDGETS
4697 && !EQ (XCAR (spec
), Qxwidget
)
4699 && !EQ (XCAR (spec
), Qspace
)
4700 && !EQ (XCAR (spec
), Qwhen
)
4701 && !EQ (XCAR (spec
), Qslice
)
4702 && !EQ (XCAR (spec
), Qspace_width
)
4703 && !EQ (XCAR (spec
), Qheight
)
4704 && !EQ (XCAR (spec
), Qraise
)
4705 /* Marginal area specifications. */
4706 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4707 && !EQ (XCAR (spec
), Qleft_fringe
)
4708 && !EQ (XCAR (spec
), Qright_fringe
)
4709 && !NILP (XCAR (spec
)))
4711 for (; CONSP (spec
); spec
= XCDR (spec
))
4713 int rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4714 overlay
, position
, bufpos
,
4715 replacing
, frame_window_p
);
4719 /* If some text in a string is replaced, `position' no
4720 longer points to the position of `object'. */
4721 if (!it
|| STRINGP (object
))
4726 else if (VECTORP (spec
))
4729 for (i
= 0; i
< ASIZE (spec
); ++i
)
4731 int rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4732 overlay
, position
, bufpos
,
4733 replacing
, frame_window_p
);
4737 /* If some text in a string is replaced, `position' no
4738 longer points to the position of `object'. */
4739 if (!it
|| STRINGP (object
))
4745 replacing
= handle_single_display_spec (it
, spec
, object
, overlay
, position
,
4746 bufpos
, 0, frame_window_p
);
4750 /* Value is the position of the end of the `display' property starting
4751 at START_POS in OBJECT. */
4753 static struct text_pos
4754 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4757 struct text_pos end_pos
;
4759 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4760 Qdisplay
, object
, Qnil
);
4761 CHARPOS (end_pos
) = XFASTINT (end
);
4762 if (STRINGP (object
))
4763 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4765 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4771 /* Set up IT from a single `display' property specification SPEC. OBJECT
4772 is the object in which the `display' property was found. *POSITION
4773 is the position in OBJECT at which the `display' property was found.
4774 BUFPOS is the buffer position of OBJECT (different from POSITION if
4775 OBJECT is not a buffer). DISPLAY_REPLACED non-zero means that we
4776 previously saw a display specification which already replaced text
4777 display with something else, for example an image; we ignore such
4778 properties after the first one has been processed.
4780 OVERLAY is the overlay this `display' property came from,
4781 or nil if it was a text property.
4783 If SPEC is a `space' or `image' specification, and in some other
4784 cases too, set *POSITION to the position where the `display'
4787 If IT is NULL, only examine the property specification in SPEC, but
4788 don't set up IT. In that case, FRAME_WINDOW_P means SPEC
4789 is intended to be displayed in a window on a GUI frame.
4791 Value is non-zero if something was found which replaces the display
4792 of buffer or string text. */
4795 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4796 Lisp_Object overlay
, struct text_pos
*position
,
4797 ptrdiff_t bufpos
, int display_replaced
,
4798 bool frame_window_p
)
4801 Lisp_Object location
, value
;
4802 struct text_pos start_pos
= *position
;
4804 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4805 If the result is non-nil, use VALUE instead of SPEC. */
4807 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4816 if (!NILP (form
) && !EQ (form
, Qt
))
4818 ptrdiff_t count
= SPECPDL_INDEX ();
4820 /* Bind `object' to the object having the `display' property, a
4821 buffer or string. Bind `position' to the position in the
4822 object where the property was found, and `buffer-position'
4823 to the current position in the buffer. */
4826 XSETBUFFER (object
, current_buffer
);
4827 specbind (Qobject
, object
);
4828 specbind (Qposition
, make_number (CHARPOS (*position
)));
4829 specbind (Qbuffer_position
, make_number (bufpos
));
4830 form
= safe_eval (form
);
4831 unbind_to (count
, Qnil
);
4837 /* Handle `(height HEIGHT)' specifications. */
4839 && EQ (XCAR (spec
), Qheight
)
4840 && CONSP (XCDR (spec
)))
4844 if (!FRAME_WINDOW_P (it
->f
))
4847 it
->font_height
= XCAR (XCDR (spec
));
4848 if (!NILP (it
->font_height
))
4850 int new_height
= -1;
4852 if (CONSP (it
->font_height
)
4853 && (EQ (XCAR (it
->font_height
), Qplus
)
4854 || EQ (XCAR (it
->font_height
), Qminus
))
4855 && CONSP (XCDR (it
->font_height
))
4856 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4858 /* `(+ N)' or `(- N)' where N is an integer. */
4859 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4860 if (EQ (XCAR (it
->font_height
), Qplus
))
4862 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4864 else if (FUNCTIONP (it
->font_height
))
4866 /* Call function with current height as argument.
4867 Value is the new height. */
4868 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4870 height
= safe_call1 (it
->font_height
,
4871 face
->lface
[LFACE_HEIGHT_INDEX
]);
4872 if (NUMBERP (height
))
4873 new_height
= XFLOATINT (height
);
4875 else if (NUMBERP (it
->font_height
))
4877 /* Value is a multiple of the canonical char height. */
4880 f
= FACE_FROM_ID (it
->f
,
4881 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4882 new_height
= (XFLOATINT (it
->font_height
)
4883 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4887 /* Evaluate IT->font_height with `height' bound to the
4888 current specified height to get the new height. */
4889 ptrdiff_t count
= SPECPDL_INDEX ();
4890 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4892 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4893 value
= safe_eval (it
->font_height
);
4894 unbind_to (count
, Qnil
);
4896 if (NUMBERP (value
))
4897 new_height
= XFLOATINT (value
);
4901 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4908 /* Handle `(space-width WIDTH)'. */
4910 && EQ (XCAR (spec
), Qspace_width
)
4911 && CONSP (XCDR (spec
)))
4915 if (!FRAME_WINDOW_P (it
->f
))
4918 value
= XCAR (XCDR (spec
));
4919 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4920 it
->space_width
= value
;
4926 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4928 && EQ (XCAR (spec
), Qslice
))
4934 if (!FRAME_WINDOW_P (it
->f
))
4937 if (tem
= XCDR (spec
), CONSP (tem
))
4939 it
->slice
.x
= XCAR (tem
);
4940 if (tem
= XCDR (tem
), CONSP (tem
))
4942 it
->slice
.y
= XCAR (tem
);
4943 if (tem
= XCDR (tem
), CONSP (tem
))
4945 it
->slice
.width
= XCAR (tem
);
4946 if (tem
= XCDR (tem
), CONSP (tem
))
4947 it
->slice
.height
= XCAR (tem
);
4956 /* Handle `(raise FACTOR)'. */
4958 && EQ (XCAR (spec
), Qraise
)
4959 && CONSP (XCDR (spec
)))
4963 if (!FRAME_WINDOW_P (it
->f
))
4966 #ifdef HAVE_WINDOW_SYSTEM
4967 value
= XCAR (XCDR (spec
));
4968 if (NUMBERP (value
))
4970 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4971 it
->voffset
= - (XFLOATINT (value
)
4972 * (normal_char_height (face
->font
, -1)));
4974 #endif /* HAVE_WINDOW_SYSTEM */
4980 /* Don't handle the other kinds of display specifications
4981 inside a string that we got from a `display' property. */
4982 if (it
&& it
->string_from_display_prop_p
)
4985 /* Characters having this form of property are not displayed, so
4986 we have to find the end of the property. */
4989 start_pos
= *position
;
4990 *position
= display_prop_end (it
, object
, start_pos
);
4991 /* If the display property comes from an overlay, don't consider
4992 any potential stop_charpos values before the end of that
4993 overlay. Since display_prop_end will happily find another
4994 'display' property coming from some other overlay or text
4995 property on buffer positions before this overlay's end, we
4996 need to ignore them, or else we risk displaying this
4997 overlay's display string/image twice. */
4998 if (!NILP (overlay
))
5000 ptrdiff_t ovendpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5002 if (ovendpos
> CHARPOS (*position
))
5003 SET_TEXT_POS (*position
, ovendpos
, CHAR_TO_BYTE (ovendpos
));
5008 /* Stop the scan at that end position--we assume that all
5009 text properties change there. */
5011 it
->stop_charpos
= position
->charpos
;
5013 /* Handle `(left-fringe BITMAP [FACE])'
5014 and `(right-fringe BITMAP [FACE])'. */
5016 && (EQ (XCAR (spec
), Qleft_fringe
)
5017 || EQ (XCAR (spec
), Qright_fringe
))
5018 && CONSP (XCDR (spec
)))
5022 if (!FRAME_WINDOW_P (it
->f
))
5023 /* If we return here, POSITION has been advanced
5024 across the text with this property. */
5026 /* Synchronize the bidi iterator with POSITION. This is
5027 needed because we are not going to push the iterator
5028 on behalf of this display property, so there will be
5029 no pop_it call to do this synchronization for us. */
5032 it
->position
= *position
;
5033 iterate_out_of_display_property (it
);
5034 *position
= it
->position
;
5039 else if (!frame_window_p
)
5042 #ifdef HAVE_WINDOW_SYSTEM
5043 value
= XCAR (XCDR (spec
));
5044 int fringe_bitmap
= SYMBOLP (value
) ? lookup_fringe_bitmap (value
) : 0;
5045 if (! fringe_bitmap
)
5046 /* If we return here, POSITION has been advanced
5047 across the text with this property. */
5049 if (it
&& it
->bidi_p
)
5051 it
->position
= *position
;
5052 iterate_out_of_display_property (it
);
5053 *position
= it
->position
;
5060 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
5062 if (CONSP (XCDR (XCDR (spec
))))
5064 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
5065 int face_id2
= lookup_derived_face (it
->f
, face_name
,
5066 FRINGE_FACE_ID
, false);
5071 /* Save current settings of IT so that we can restore them
5072 when we are finished with the glyph property value. */
5073 push_it (it
, position
);
5075 it
->area
= TEXT_AREA
;
5076 it
->what
= IT_IMAGE
;
5077 it
->image_id
= -1; /* no image */
5078 it
->position
= start_pos
;
5079 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5080 it
->method
= GET_FROM_IMAGE
;
5081 it
->from_overlay
= Qnil
;
5082 it
->face_id
= face_id
;
5083 it
->from_disp_prop_p
= true;
5085 /* Say that we haven't consumed the characters with
5086 `display' property yet. The call to pop_it in
5087 set_iterator_to_next will clean this up. */
5088 *position
= start_pos
;
5090 if (EQ (XCAR (spec
), Qleft_fringe
))
5092 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5093 it
->left_user_fringe_face_id
= face_id
;
5097 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5098 it
->right_user_fringe_face_id
= face_id
;
5101 #endif /* HAVE_WINDOW_SYSTEM */
5105 /* Prepare to handle `((margin left-margin) ...)',
5106 `((margin right-margin) ...)' and `((margin nil) ...)'
5107 prefixes for display specifications. */
5108 location
= Qunbound
;
5109 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5113 value
= XCDR (spec
);
5115 value
= XCAR (value
);
5118 if (EQ (XCAR (tem
), Qmargin
)
5119 && (tem
= XCDR (tem
),
5120 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5122 || EQ (tem
, Qleft_margin
)
5123 || EQ (tem
, Qright_margin
))))
5127 if (EQ (location
, Qunbound
))
5133 /* After this point, VALUE is the property after any
5134 margin prefix has been stripped. It must be a string,
5135 an image specification, or `(space ...)'.
5137 LOCATION specifies where to display: `left-margin',
5138 `right-margin' or nil. */
5140 bool valid_p
= (STRINGP (value
)
5141 #ifdef HAVE_WINDOW_SYSTEM
5142 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5143 && valid_image_p (value
))
5144 #endif /* not HAVE_WINDOW_SYSTEM */
5145 || (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5146 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5147 && valid_xwidget_spec_p (value
)));
5149 if (valid_p
&& display_replaced
== 0)
5155 /* Callers need to know whether the display spec is any kind
5156 of `(space ...)' spec that is about to affect text-area
5158 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5163 /* Save current settings of IT so that we can restore them
5164 when we are finished with the glyph property value. */
5165 push_it (it
, position
);
5166 it
->from_overlay
= overlay
;
5167 it
->from_disp_prop_p
= true;
5169 if (NILP (location
))
5170 it
->area
= TEXT_AREA
;
5171 else if (EQ (location
, Qleft_margin
))
5172 it
->area
= LEFT_MARGIN_AREA
;
5174 it
->area
= RIGHT_MARGIN_AREA
;
5176 if (STRINGP (value
))
5179 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5180 it
->current
.overlay_string_index
= -1;
5181 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5182 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5183 it
->method
= GET_FROM_STRING
;
5184 it
->stop_charpos
= 0;
5186 it
->base_level_stop
= 0;
5187 it
->string_from_display_prop_p
= true;
5188 /* Say that we haven't consumed the characters with
5189 `display' property yet. The call to pop_it in
5190 set_iterator_to_next will clean this up. */
5191 if (BUFFERP (object
))
5192 *position
= start_pos
;
5194 /* Force paragraph direction to be that of the parent
5195 object. If the parent object's paragraph direction is
5196 not yet determined, default to L2R. */
5197 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5198 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5200 it
->paragraph_embedding
= L2R
;
5202 /* Set up the bidi iterator for this display string. */
5205 it
->bidi_it
.string
.lstring
= it
->string
;
5206 it
->bidi_it
.string
.s
= NULL
;
5207 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5208 it
->bidi_it
.string
.bufpos
= bufpos
;
5209 it
->bidi_it
.string
.from_disp_str
= true;
5210 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5211 it
->bidi_it
.w
= it
->w
;
5212 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5215 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5217 it
->method
= GET_FROM_STRETCH
;
5219 *position
= it
->position
= start_pos
;
5220 retval
= 1 + (it
->area
== TEXT_AREA
);
5222 else if (valid_xwidget_spec_p (value
))
5224 it
->what
= IT_XWIDGET
;
5225 it
->method
= GET_FROM_XWIDGET
;
5226 it
->position
= start_pos
;
5227 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5228 *position
= start_pos
;
5229 it
->xwidget
= lookup_xwidget (value
);
5231 #ifdef HAVE_WINDOW_SYSTEM
5234 it
->what
= IT_IMAGE
;
5235 it
->image_id
= lookup_image (it
->f
, value
);
5236 it
->position
= start_pos
;
5237 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5238 it
->method
= GET_FROM_IMAGE
;
5240 /* Say that we haven't consumed the characters with
5241 `display' property yet. The call to pop_it in
5242 set_iterator_to_next will clean this up. */
5243 *position
= start_pos
;
5245 #endif /* HAVE_WINDOW_SYSTEM */
5250 /* Invalid property or property not supported. Restore
5251 POSITION to what it was before. */
5252 *position
= start_pos
;
5256 /* Check if PROP is a display property value whose text should be
5257 treated as intangible. OVERLAY is the overlay from which PROP
5258 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5259 specify the buffer position covered by PROP. */
5262 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5263 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5265 bool frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5266 struct text_pos position
;
5268 SET_TEXT_POS (position
, charpos
, bytepos
);
5269 return (handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5270 &position
, charpos
, frame_window_p
)
5275 /* Return true if PROP is a display sub-property value containing STRING.
5277 Implementation note: this and the following function are really
5278 special cases of handle_display_spec and
5279 handle_single_display_spec, and should ideally use the same code.
5280 Until they do, these two pairs must be consistent and must be
5281 modified in sync. */
5284 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5286 if (EQ (string
, prop
))
5289 /* Skip over `when FORM'. */
5290 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5295 /* Actually, the condition following `when' should be eval'ed,
5296 like handle_single_display_spec does, and we should return
5297 false if it evaluates to nil. However, this function is
5298 called only when the buffer was already displayed and some
5299 glyph in the glyph matrix was found to come from a display
5300 string. Therefore, the condition was already evaluated, and
5301 the result was non-nil, otherwise the display string wouldn't
5302 have been displayed and we would have never been called for
5303 this property. Thus, we can skip the evaluation and assume
5304 its result is non-nil. */
5309 /* Skip over `margin LOCATION'. */
5310 if (EQ (XCAR (prop
), Qmargin
))
5321 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5325 /* Return true if STRING appears in the `display' property PROP. */
5328 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5331 && !EQ (XCAR (prop
), Qwhen
)
5332 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5334 /* A list of sub-properties. */
5335 while (CONSP (prop
))
5337 if (single_display_spec_string_p (XCAR (prop
), string
))
5342 else if (VECTORP (prop
))
5344 /* A vector of sub-properties. */
5346 for (i
= 0; i
< ASIZE (prop
); ++i
)
5347 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5351 return single_display_spec_string_p (prop
, string
);
5356 /* Look for STRING in overlays and text properties in the current
5357 buffer, between character positions FROM and TO (excluding TO).
5358 BACK_P means look back (in this case, TO is supposed to be
5360 Value is the first character position where STRING was found, or
5361 zero if it wasn't found before hitting TO.
5363 This function may only use code that doesn't eval because it is
5364 called asynchronously from note_mouse_highlight. */
5367 string_buffer_position_lim (Lisp_Object string
,
5368 ptrdiff_t from
, ptrdiff_t to
, bool back_p
)
5370 Lisp_Object limit
, prop
, pos
;
5373 pos
= make_number (max (from
, BEGV
));
5375 if (!back_p
) /* looking forward */
5377 limit
= make_number (min (to
, ZV
));
5378 while (!found
&& !EQ (pos
, limit
))
5380 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5381 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5384 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5388 else /* looking back */
5390 limit
= make_number (max (to
, BEGV
));
5391 while (!found
&& !EQ (pos
, limit
))
5393 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5394 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5397 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5402 return found
? XINT (pos
) : 0;
5405 /* Determine which buffer position in current buffer STRING comes from.
5406 AROUND_CHARPOS is an approximate position where it could come from.
5407 Value is the buffer position or 0 if it couldn't be determined.
5409 This function is necessary because we don't record buffer positions
5410 in glyphs generated from strings (to keep struct glyph small).
5411 This function may only use code that doesn't eval because it is
5412 called asynchronously from note_mouse_highlight. */
5415 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5417 const int MAX_DISTANCE
= 1000;
5418 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5419 around_charpos
+ MAX_DISTANCE
,
5423 found
= string_buffer_position_lim (string
, around_charpos
,
5424 around_charpos
- MAX_DISTANCE
, true);
5430 /***********************************************************************
5431 `composition' property
5432 ***********************************************************************/
5434 /* Set up iterator IT from `composition' property at its current
5435 position. Called from handle_stop. */
5437 static enum prop_handled
5438 handle_composition_prop (struct it
*it
)
5440 Lisp_Object prop
, string
;
5441 ptrdiff_t pos
, pos_byte
, start
, end
;
5443 if (STRINGP (it
->string
))
5447 pos
= IT_STRING_CHARPOS (*it
);
5448 pos_byte
= IT_STRING_BYTEPOS (*it
);
5449 string
= it
->string
;
5450 s
= SDATA (string
) + pos_byte
;
5451 it
->c
= STRING_CHAR (s
);
5455 pos
= IT_CHARPOS (*it
);
5456 pos_byte
= IT_BYTEPOS (*it
);
5458 it
->c
= FETCH_CHAR (pos_byte
);
5461 /* If there's a valid composition and point is not inside of the
5462 composition (in the case that the composition is from the current
5463 buffer), draw a glyph composed from the composition components. */
5464 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5465 && composition_valid_p (start
, end
, prop
)
5466 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5469 /* As we can't handle this situation (perhaps font-lock added
5470 a new composition), we just return here hoping that next
5471 redisplay will detect this composition much earlier. */
5472 return HANDLED_NORMALLY
;
5475 if (STRINGP (it
->string
))
5476 pos_byte
= string_char_to_byte (it
->string
, start
);
5478 pos_byte
= CHAR_TO_BYTE (start
);
5480 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5483 if (it
->cmp_it
.id
>= 0)
5486 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5487 it
->cmp_it
.nglyphs
= -1;
5491 return HANDLED_NORMALLY
;
5496 /***********************************************************************
5498 ***********************************************************************/
5500 /* The following structure is used to record overlay strings for
5501 later sorting in load_overlay_strings. */
5503 struct overlay_entry
5505 Lisp_Object overlay
;
5508 bool after_string_p
;
5512 /* Set up iterator IT from overlay strings at its current position.
5513 Called from handle_stop. */
5515 static enum prop_handled
5516 handle_overlay_change (struct it
*it
)
5518 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5519 return HANDLED_RECOMPUTE_PROPS
;
5521 return HANDLED_NORMALLY
;
5525 /* Set up the next overlay string for delivery by IT, if there is an
5526 overlay string to deliver. Called by set_iterator_to_next when the
5527 end of the current overlay string is reached. If there are more
5528 overlay strings to display, IT->string and
5529 IT->current.overlay_string_index are set appropriately here.
5530 Otherwise IT->string is set to nil. */
5533 next_overlay_string (struct it
*it
)
5535 ++it
->current
.overlay_string_index
;
5536 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5538 /* No more overlay strings. Restore IT's settings to what
5539 they were before overlay strings were processed, and
5540 continue to deliver from current_buffer. */
5542 it
->ellipsis_p
= it
->stack
[it
->sp
- 1].display_ellipsis_p
;
5545 || (NILP (it
->string
)
5546 && it
->method
== GET_FROM_BUFFER
5547 && it
->stop_charpos
>= BEGV
5548 && it
->stop_charpos
<= it
->end_charpos
));
5549 it
->current
.overlay_string_index
= -1;
5550 it
->n_overlay_strings
= 0;
5551 /* If there's an empty display string on the stack, pop the
5552 stack, to resync the bidi iterator with IT's position. Such
5553 empty strings are pushed onto the stack in
5554 get_overlay_strings_1. */
5555 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5558 /* Since we've exhausted overlay strings at this buffer
5559 position, set the flag to ignore overlays until we move to
5560 another position. The flag is reset in
5561 next_element_from_buffer. */
5562 it
->ignore_overlay_strings_at_pos_p
= true;
5564 /* If we're at the end of the buffer, record that we have
5565 processed the overlay strings there already, so that
5566 next_element_from_buffer doesn't try it again. */
5567 if (NILP (it
->string
)
5568 && IT_CHARPOS (*it
) >= it
->end_charpos
5569 && it
->overlay_strings_charpos
>= it
->end_charpos
)
5570 it
->overlay_strings_at_end_processed_p
= true;
5571 /* Note: we reset overlay_strings_charpos only here, to make
5572 sure the just-processed overlays were indeed at EOB.
5573 Otherwise, overlays on text with invisible text property,
5574 which are processed with IT's position past the invisible
5575 text, might fool us into thinking the overlays at EOB were
5576 already processed (linum-mode can cause this, for
5578 it
->overlay_strings_charpos
= -1;
5582 /* There are more overlay strings to process. If
5583 IT->current.overlay_string_index has advanced to a position
5584 where we must load IT->overlay_strings with more strings, do
5585 it. We must load at the IT->overlay_strings_charpos where
5586 IT->n_overlay_strings was originally computed; when invisible
5587 text is present, this might not be IT_CHARPOS (Bug#7016). */
5588 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5590 if (it
->current
.overlay_string_index
&& i
== 0)
5591 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5593 /* Initialize IT to deliver display elements from the overlay
5595 it
->string
= it
->overlay_strings
[i
];
5596 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5597 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5598 it
->method
= GET_FROM_STRING
;
5599 it
->stop_charpos
= 0;
5600 it
->end_charpos
= SCHARS (it
->string
);
5601 if (it
->cmp_it
.stop_pos
>= 0)
5602 it
->cmp_it
.stop_pos
= 0;
5604 it
->base_level_stop
= 0;
5606 /* Set up the bidi iterator for this overlay string. */
5609 it
->bidi_it
.string
.lstring
= it
->string
;
5610 it
->bidi_it
.string
.s
= NULL
;
5611 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5612 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5613 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5614 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5615 it
->bidi_it
.w
= it
->w
;
5616 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5624 /* Compare two overlay_entry structures E1 and E2. Used as a
5625 comparison function for qsort in load_overlay_strings. Overlay
5626 strings for the same position are sorted so that
5628 1. All after-strings come in front of before-strings, except
5629 when they come from the same overlay.
5631 2. Within after-strings, strings are sorted so that overlay strings
5632 from overlays with higher priorities come first.
5634 2. Within before-strings, strings are sorted so that overlay
5635 strings from overlays with higher priorities come last.
5637 Value is analogous to strcmp. */
5641 compare_overlay_entries (const void *e1
, const void *e2
)
5643 struct overlay_entry
const *entry1
= e1
;
5644 struct overlay_entry
const *entry2
= e2
;
5647 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5649 /* Let after-strings appear in front of before-strings if
5650 they come from different overlays. */
5651 if (EQ (entry1
->overlay
, entry2
->overlay
))
5652 result
= entry1
->after_string_p
? 1 : -1;
5654 result
= entry1
->after_string_p
? -1 : 1;
5656 else if (entry1
->priority
!= entry2
->priority
)
5658 if (entry1
->after_string_p
)
5659 /* After-strings sorted in order of decreasing priority. */
5660 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5662 /* Before-strings sorted in order of increasing priority. */
5663 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5672 /* Load the vector IT->overlay_strings with overlay strings from IT's
5673 current buffer position, or from CHARPOS if that is > 0. Set
5674 IT->n_overlays to the total number of overlay strings found.
5676 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5677 a time. On entry into load_overlay_strings,
5678 IT->current.overlay_string_index gives the number of overlay
5679 strings that have already been loaded by previous calls to this
5682 IT->add_overlay_start contains an additional overlay start
5683 position to consider for taking overlay strings from, if non-zero.
5684 This position comes into play when the overlay has an `invisible'
5685 property, and both before and after-strings. When we've skipped to
5686 the end of the overlay, because of its `invisible' property, we
5687 nevertheless want its before-string to appear.
5688 IT->add_overlay_start will contain the overlay start position
5691 Overlay strings are sorted so that after-string strings come in
5692 front of before-string strings. Within before and after-strings,
5693 strings are sorted by overlay priority. See also function
5694 compare_overlay_entries. */
5697 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5699 Lisp_Object overlay
, window
, str
, invisible
;
5700 struct Lisp_Overlay
*ov
;
5701 ptrdiff_t start
, end
;
5702 ptrdiff_t n
= 0, i
, j
;
5704 struct overlay_entry entriesbuf
[20];
5705 ptrdiff_t size
= ARRAYELTS (entriesbuf
);
5706 struct overlay_entry
*entries
= entriesbuf
;
5710 charpos
= IT_CHARPOS (*it
);
5712 /* Append the overlay string STRING of overlay OVERLAY to vector
5713 `entries' which has size `size' and currently contains `n'
5714 elements. AFTER_P means STRING is an after-string of
5716 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5719 Lisp_Object priority; \
5723 struct overlay_entry *old = entries; \
5724 SAFE_NALLOCA (entries, 2, size); \
5725 memcpy (entries, old, size * sizeof *entries); \
5729 entries[n].string = (STRING); \
5730 entries[n].overlay = (OVERLAY); \
5731 priority = Foverlay_get ((OVERLAY), Qpriority); \
5732 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5733 entries[n].after_string_p = (AFTER_P); \
5738 /* Process overlay before the overlay center. */
5739 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5741 XSETMISC (overlay
, ov
);
5742 eassert (OVERLAYP (overlay
));
5743 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5744 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5749 /* Skip this overlay if it doesn't start or end at IT's current
5751 if (end
!= charpos
&& start
!= charpos
)
5754 /* Skip this overlay if it doesn't apply to IT->w. */
5755 window
= Foverlay_get (overlay
, Qwindow
);
5756 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5759 /* If the text ``under'' the overlay is invisible, both before-
5760 and after-strings from this overlay are visible; start and
5761 end position are indistinguishable. */
5762 invisible
= Foverlay_get (overlay
, Qinvisible
);
5763 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5765 /* If overlay has a non-empty before-string, record it. */
5766 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5767 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5769 RECORD_OVERLAY_STRING (overlay
, str
, false);
5771 /* If overlay has a non-empty after-string, record it. */
5772 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5773 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5775 RECORD_OVERLAY_STRING (overlay
, str
, true);
5778 /* Process overlays after the overlay center. */
5779 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5781 XSETMISC (overlay
, ov
);
5782 eassert (OVERLAYP (overlay
));
5783 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5784 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5786 if (start
> charpos
)
5789 /* Skip this overlay if it doesn't start or end at IT's current
5791 if (end
!= charpos
&& start
!= charpos
)
5794 /* Skip this overlay if it doesn't apply to IT->w. */
5795 window
= Foverlay_get (overlay
, Qwindow
);
5796 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5799 /* If the text ``under'' the overlay is invisible, it has a zero
5800 dimension, and both before- and after-strings apply. */
5801 invisible
= Foverlay_get (overlay
, Qinvisible
);
5802 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5804 /* If overlay has a non-empty before-string, record it. */
5805 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5806 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5808 RECORD_OVERLAY_STRING (overlay
, str
, false);
5810 /* If overlay has a non-empty after-string, record it. */
5811 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5812 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5814 RECORD_OVERLAY_STRING (overlay
, str
, true);
5817 #undef RECORD_OVERLAY_STRING
5821 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5823 /* Record number of overlay strings, and where we computed it. */
5824 it
->n_overlay_strings
= n
;
5825 it
->overlay_strings_charpos
= charpos
;
5827 /* IT->current.overlay_string_index is the number of overlay strings
5828 that have already been consumed by IT. Copy some of the
5829 remaining overlay strings to IT->overlay_strings. */
5831 j
= it
->current
.overlay_string_index
;
5832 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5834 it
->overlay_strings
[i
] = entries
[j
].string
;
5835 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5843 /* Get the first chunk of overlay strings at IT's current buffer
5844 position, or at CHARPOS if that is > 0. Value is true if at
5845 least one overlay string was found. */
5848 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, bool compute_stop_p
)
5850 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5851 process. This fills IT->overlay_strings with strings, and sets
5852 IT->n_overlay_strings to the total number of strings to process.
5853 IT->pos.overlay_string_index has to be set temporarily to zero
5854 because load_overlay_strings needs this; it must be set to -1
5855 when no overlay strings are found because a zero value would
5856 indicate a position in the first overlay string. */
5857 it
->current
.overlay_string_index
= 0;
5858 load_overlay_strings (it
, charpos
);
5860 /* If we found overlay strings, set up IT to deliver display
5861 elements from the first one. Otherwise set up IT to deliver
5862 from current_buffer. */
5863 if (it
->n_overlay_strings
)
5865 /* Make sure we know settings in current_buffer, so that we can
5866 restore meaningful values when we're done with the overlay
5869 compute_stop_pos (it
);
5870 eassert (it
->face_id
>= 0);
5872 /* Save IT's settings. They are restored after all overlay
5873 strings have been processed. */
5874 eassert (!compute_stop_p
|| it
->sp
== 0);
5876 /* When called from handle_stop, there might be an empty display
5877 string loaded. In that case, don't bother saving it. But
5878 don't use this optimization with the bidi iterator, since we
5879 need the corresponding pop_it call to resync the bidi
5880 iterator's position with IT's position, after we are done
5881 with the overlay strings. (The corresponding call to pop_it
5882 in case of an empty display string is in
5883 next_overlay_string.) */
5885 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5888 /* Set up IT to deliver display elements from the first overlay
5890 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5891 it
->string
= it
->overlay_strings
[0];
5892 it
->from_overlay
= Qnil
;
5893 it
->stop_charpos
= 0;
5894 eassert (STRINGP (it
->string
));
5895 it
->end_charpos
= SCHARS (it
->string
);
5897 it
->base_level_stop
= 0;
5898 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5899 it
->method
= GET_FROM_STRING
;
5900 it
->from_disp_prop_p
= 0;
5902 /* Force paragraph direction to be that of the parent
5904 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5905 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5907 it
->paragraph_embedding
= L2R
;
5909 /* Set up the bidi iterator for this overlay string. */
5912 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5914 it
->bidi_it
.string
.lstring
= it
->string
;
5915 it
->bidi_it
.string
.s
= NULL
;
5916 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5917 it
->bidi_it
.string
.bufpos
= pos
;
5918 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5919 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5920 it
->bidi_it
.w
= it
->w
;
5921 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5926 it
->current
.overlay_string_index
= -1;
5931 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5934 it
->method
= GET_FROM_BUFFER
;
5936 get_overlay_strings_1 (it
, charpos
, true);
5940 /* Value is true if we found at least one overlay string. */
5941 return STRINGP (it
->string
);
5946 /***********************************************************************
5947 Saving and restoring state
5948 ***********************************************************************/
5950 /* Save current settings of IT on IT->stack. Called, for example,
5951 before setting up IT for an overlay string, to be able to restore
5952 IT's settings to what they were after the overlay string has been
5953 processed. If POSITION is non-NULL, it is the position to save on
5954 the stack instead of IT->position. */
5957 push_it (struct it
*it
, struct text_pos
*position
)
5959 struct iterator_stack_entry
*p
;
5961 eassert (it
->sp
< IT_STACK_SIZE
);
5962 p
= it
->stack
+ it
->sp
;
5964 p
->stop_charpos
= it
->stop_charpos
;
5965 p
->prev_stop
= it
->prev_stop
;
5966 p
->base_level_stop
= it
->base_level_stop
;
5967 p
->cmp_it
= it
->cmp_it
;
5968 eassert (it
->face_id
>= 0);
5969 p
->face_id
= it
->face_id
;
5970 p
->string
= it
->string
;
5971 p
->method
= it
->method
;
5972 p
->from_overlay
= it
->from_overlay
;
5975 case GET_FROM_IMAGE
:
5976 p
->u
.image
.object
= it
->object
;
5977 p
->u
.image
.image_id
= it
->image_id
;
5978 p
->u
.image
.slice
= it
->slice
;
5980 case GET_FROM_STRETCH
:
5981 p
->u
.stretch
.object
= it
->object
;
5983 case GET_FROM_XWIDGET
:
5984 p
->u
.xwidget
.object
= it
->object
;
5986 case GET_FROM_BUFFER
:
5987 case GET_FROM_DISPLAY_VECTOR
:
5988 case GET_FROM_STRING
:
5989 case GET_FROM_C_STRING
:
5994 p
->position
= position
? *position
: it
->position
;
5995 p
->current
= it
->current
;
5996 p
->end_charpos
= it
->end_charpos
;
5997 p
->string_nchars
= it
->string_nchars
;
5999 p
->multibyte_p
= it
->multibyte_p
;
6000 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
6001 p
->space_width
= it
->space_width
;
6002 p
->font_height
= it
->font_height
;
6003 p
->voffset
= it
->voffset
;
6004 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
6005 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
6006 p
->display_ellipsis_p
= false;
6007 p
->line_wrap
= it
->line_wrap
;
6008 p
->bidi_p
= it
->bidi_p
;
6009 p
->paragraph_embedding
= it
->paragraph_embedding
;
6010 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
6013 /* Save the state of the bidi iterator as well. */
6015 bidi_push_it (&it
->bidi_it
);
6019 iterate_out_of_display_property (struct it
*it
)
6021 bool buffer_p
= !STRINGP (it
->string
);
6022 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
6023 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
6025 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
6027 /* Maybe initialize paragraph direction. If we are at the beginning
6028 of a new paragraph, next_element_from_buffer may not have a
6029 chance to do that. */
6030 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
6031 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
6032 /* prev_stop can be zero, so check against BEGV as well. */
6033 while (it
->bidi_it
.charpos
>= bob
6034 && it
->prev_stop
<= it
->bidi_it
.charpos
6035 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
6036 && it
->bidi_it
.charpos
< eob
)
6037 bidi_move_to_visually_next (&it
->bidi_it
);
6038 /* Record the stop_pos we just crossed, for when we cross it
6040 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
6041 it
->prev_stop
= CHARPOS (it
->position
);
6042 /* If we ended up not where pop_it put us, resync IT's
6043 positional members with the bidi iterator. */
6044 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
6045 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
6047 it
->current
.pos
= it
->position
;
6049 it
->current
.string_pos
= it
->position
;
6052 /* Restore IT's settings from IT->stack. Called, for example, when no
6053 more overlay strings must be processed, and we return to delivering
6054 display elements from a buffer, or when the end of a string from a
6055 `display' property is reached and we return to delivering display
6056 elements from an overlay string, or from a buffer. */
6059 pop_it (struct it
*it
)
6061 struct iterator_stack_entry
*p
;
6062 bool from_display_prop
= it
->from_disp_prop_p
;
6063 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
6065 eassert (it
->sp
> 0);
6067 p
= it
->stack
+ it
->sp
;
6068 it
->stop_charpos
= p
->stop_charpos
;
6069 it
->prev_stop
= p
->prev_stop
;
6070 it
->base_level_stop
= p
->base_level_stop
;
6071 it
->cmp_it
= p
->cmp_it
;
6072 it
->face_id
= p
->face_id
;
6073 it
->current
= p
->current
;
6074 it
->position
= p
->position
;
6075 it
->string
= p
->string
;
6076 it
->from_overlay
= p
->from_overlay
;
6077 if (NILP (it
->string
))
6078 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
6079 it
->method
= p
->method
;
6082 case GET_FROM_IMAGE
:
6083 it
->image_id
= p
->u
.image
.image_id
;
6084 it
->object
= p
->u
.image
.object
;
6085 it
->slice
= p
->u
.image
.slice
;
6087 case GET_FROM_XWIDGET
:
6088 it
->object
= p
->u
.xwidget
.object
;
6090 case GET_FROM_STRETCH
:
6091 it
->object
= p
->u
.stretch
.object
;
6093 case GET_FROM_BUFFER
:
6094 it
->object
= it
->w
->contents
;
6096 case GET_FROM_STRING
:
6098 struct face
*face
= FACE_FROM_ID_OR_NULL (it
->f
, it
->face_id
);
6100 /* Restore the face_box_p flag, since it could have been
6101 overwritten by the face of the object that we just finished
6104 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6105 it
->object
= it
->string
;
6108 case GET_FROM_DISPLAY_VECTOR
:
6110 it
->method
= GET_FROM_C_STRING
;
6111 else if (STRINGP (it
->string
))
6112 it
->method
= GET_FROM_STRING
;
6115 it
->method
= GET_FROM_BUFFER
;
6116 it
->object
= it
->w
->contents
;
6119 case GET_FROM_C_STRING
:
6124 it
->end_charpos
= p
->end_charpos
;
6125 it
->string_nchars
= p
->string_nchars
;
6127 it
->multibyte_p
= p
->multibyte_p
;
6128 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6129 it
->space_width
= p
->space_width
;
6130 it
->font_height
= p
->font_height
;
6131 it
->voffset
= p
->voffset
;
6132 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6133 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6134 it
->line_wrap
= p
->line_wrap
;
6135 it
->bidi_p
= p
->bidi_p
;
6136 it
->paragraph_embedding
= p
->paragraph_embedding
;
6137 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6140 bidi_pop_it (&it
->bidi_it
);
6141 /* Bidi-iterate until we get out of the portion of text, if any,
6142 covered by a `display' text property or by an overlay with
6143 `display' property. (We cannot just jump there, because the
6144 internal coherency of the bidi iterator state can not be
6145 preserved across such jumps.) We also must determine the
6146 paragraph base direction if the overlay we just processed is
6147 at the beginning of a new paragraph. */
6148 if (from_display_prop
6149 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6150 iterate_out_of_display_property (it
);
6152 eassert ((BUFFERP (it
->object
)
6153 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6154 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6155 || (STRINGP (it
->object
)
6156 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6157 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6158 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6160 /* If we move the iterator over text covered by a display property
6161 to a new buffer position, any info about previously seen overlays
6162 is no longer valid. */
6163 if (from_display_prop
&& it
->sp
== 0 && CHARPOS (it
->position
) != prev_pos
)
6164 it
->ignore_overlay_strings_at_pos_p
= false;
6169 /***********************************************************************
6171 ***********************************************************************/
6173 /* Set IT's current position to the previous line start. */
6176 back_to_previous_line_start (struct it
*it
)
6178 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6181 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6185 /* Move IT to the next line start.
6187 Value is true if a newline was found. Set *SKIPPED_P to true if
6188 we skipped over part of the text (as opposed to moving the iterator
6189 continuously over the text). Otherwise, don't change the value
6192 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6193 iterator on the newline, if it was found.
6195 Newlines may come from buffer text, overlay strings, or strings
6196 displayed via the `display' property. That's the reason we can't
6197 simply use find_newline_no_quit.
6199 Note that this function may not skip over invisible text that is so
6200 because of text properties and immediately follows a newline. If
6201 it would, function reseat_at_next_visible_line_start, when called
6202 from set_iterator_to_next, would effectively make invisible
6203 characters following a newline part of the wrong glyph row, which
6204 leads to wrong cursor motion. */
6207 forward_to_next_line_start (struct it
*it
, bool *skipped_p
,
6208 struct bidi_it
*bidi_it_prev
)
6210 ptrdiff_t old_selective
;
6211 bool newline_found_p
= false;
6213 const int MAX_NEWLINE_DISTANCE
= 500;
6215 /* If already on a newline, just consume it to avoid unintended
6216 skipping over invisible text below. */
6217 if (it
->what
== IT_CHARACTER
6219 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6221 if (it
->bidi_p
&& bidi_it_prev
)
6222 *bidi_it_prev
= it
->bidi_it
;
6223 set_iterator_to_next (it
, false);
6228 /* Don't handle selective display in the following. It's (a)
6229 unnecessary because it's done by the caller, and (b) leads to an
6230 infinite recursion because next_element_from_ellipsis indirectly
6231 calls this function. */
6232 old_selective
= it
->selective
;
6235 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6236 from buffer text. */
6238 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6239 n
+= !STRINGP (it
->string
))
6241 if (!get_next_display_element (it
))
6243 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6244 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6245 *bidi_it_prev
= it
->bidi_it
;
6246 set_iterator_to_next (it
, false);
6249 /* If we didn't find a newline near enough, see if we can use a
6251 if (!newline_found_p
)
6253 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6254 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6258 eassert (!STRINGP (it
->string
));
6260 /* If there isn't any `display' property in sight, and no
6261 overlays, we can just use the position of the newline in
6263 if (it
->stop_charpos
>= limit
6264 || ((pos
= Fnext_single_property_change (make_number (start
),
6266 make_number (limit
)),
6268 && next_overlay_change (start
) == ZV
))
6272 IT_CHARPOS (*it
) = limit
;
6273 IT_BYTEPOS (*it
) = bytepos
;
6277 struct bidi_it bprev
;
6279 /* Help bidi.c avoid expensive searches for display
6280 properties and overlays, by telling it that there are
6281 none up to `limit'. */
6282 if (it
->bidi_it
.disp_pos
< limit
)
6284 it
->bidi_it
.disp_pos
= limit
;
6285 it
->bidi_it
.disp_prop
= 0;
6288 bprev
= it
->bidi_it
;
6289 bidi_move_to_visually_next (&it
->bidi_it
);
6290 } while (it
->bidi_it
.charpos
!= limit
);
6291 IT_CHARPOS (*it
) = limit
;
6292 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6294 *bidi_it_prev
= bprev
;
6296 *skipped_p
= newline_found_p
= true;
6300 while (get_next_display_element (it
)
6301 && !newline_found_p
)
6303 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6304 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6305 *bidi_it_prev
= it
->bidi_it
;
6306 set_iterator_to_next (it
, false);
6311 it
->selective
= old_selective
;
6312 return newline_found_p
;
6316 /* Set IT's current position to the previous visible line start. Skip
6317 invisible text that is so either due to text properties or due to
6318 selective display. Caution: this does not change IT->current_x and
6322 back_to_previous_visible_line_start (struct it
*it
)
6324 while (IT_CHARPOS (*it
) > BEGV
)
6326 back_to_previous_line_start (it
);
6328 if (IT_CHARPOS (*it
) <= BEGV
)
6331 /* If selective > 0, then lines indented more than its value are
6333 if (it
->selective
> 0
6334 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6338 /* Check the newline before point for invisibility. */
6341 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6342 Qinvisible
, it
->window
);
6343 if (TEXT_PROP_MEANS_INVISIBLE (prop
) != 0)
6347 if (IT_CHARPOS (*it
) <= BEGV
)
6352 void *it2data
= NULL
;
6355 Lisp_Object val
, overlay
;
6357 SAVE_IT (it2
, *it
, it2data
);
6359 /* If newline is part of a composition, continue from start of composition */
6360 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6361 && beg
< IT_CHARPOS (*it
))
6364 /* If newline is replaced by a display property, find start of overlay
6365 or interval and continue search from that point. */
6366 pos
= --IT_CHARPOS (it2
);
6369 bidi_unshelve_cache (NULL
, false);
6370 it2
.string_from_display_prop_p
= false;
6371 it2
.from_disp_prop_p
= false;
6372 if (handle_display_prop (&it2
) == HANDLED_RETURN
6373 && !NILP (val
= get_char_property_and_overlay
6374 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6375 && (OVERLAYP (overlay
)
6376 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6377 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6379 RESTORE_IT (it
, it
, it2data
);
6383 /* Newline is not replaced by anything -- so we are done. */
6384 RESTORE_IT (it
, it
, it2data
);
6390 IT_CHARPOS (*it
) = beg
;
6391 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6395 it
->continuation_lines_width
= 0;
6397 eassert (IT_CHARPOS (*it
) >= BEGV
);
6398 eassert (IT_CHARPOS (*it
) == BEGV
6399 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6404 /* Reseat iterator IT at the previous visible line start. Skip
6405 invisible text that is so either due to text properties or due to
6406 selective display. At the end, update IT's overlay information,
6407 face information etc. */
6410 reseat_at_previous_visible_line_start (struct it
*it
)
6412 back_to_previous_visible_line_start (it
);
6413 reseat (it
, it
->current
.pos
, true);
6418 /* Reseat iterator IT on the next visible line start in the current
6419 buffer. ON_NEWLINE_P means position IT on the newline
6420 preceding the line start. Skip over invisible text that is so
6421 because of selective display. Compute faces, overlays etc at the
6422 new position. Note that this function does not skip over text that
6423 is invisible because of text properties. */
6426 reseat_at_next_visible_line_start (struct it
*it
, bool on_newline_p
)
6428 bool skipped_p
= false;
6429 struct bidi_it bidi_it_prev
;
6430 bool newline_found_p
6431 = forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6433 /* Skip over lines that are invisible because they are indented
6434 more than the value of IT->selective. */
6435 if (it
->selective
> 0)
6436 while (IT_CHARPOS (*it
) < ZV
6437 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6440 eassert (IT_BYTEPOS (*it
) == BEGV
6441 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6443 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6446 /* Position on the newline if that's what's requested. */
6447 if (on_newline_p
&& newline_found_p
)
6449 if (STRINGP (it
->string
))
6451 if (IT_STRING_CHARPOS (*it
) > 0)
6455 --IT_STRING_CHARPOS (*it
);
6456 --IT_STRING_BYTEPOS (*it
);
6460 /* We need to restore the bidi iterator to the state
6461 it had on the newline, and resync the IT's
6462 position with that. */
6463 it
->bidi_it
= bidi_it_prev
;
6464 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6465 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6469 else if (IT_CHARPOS (*it
) > BEGV
)
6478 /* We need to restore the bidi iterator to the state it
6479 had on the newline and resync IT with that. */
6480 it
->bidi_it
= bidi_it_prev
;
6481 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6482 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6484 reseat (it
, it
->current
.pos
, false);
6488 reseat (it
, it
->current
.pos
, false);
6495 /***********************************************************************
6496 Changing an iterator's position
6497 ***********************************************************************/
6499 /* Change IT's current position to POS in current_buffer.
6500 If FORCE_P, always check for text properties at the new position.
6501 Otherwise, text properties are only looked up if POS >=
6502 IT->check_charpos of a property. */
6505 reseat (struct it
*it
, struct text_pos pos
, bool force_p
)
6507 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6509 reseat_1 (it
, pos
, false);
6511 /* Determine where to check text properties. Avoid doing it
6512 where possible because text property lookup is very expensive. */
6514 || CHARPOS (pos
) > it
->stop_charpos
6515 || CHARPOS (pos
) < original_pos
)
6519 /* For bidi iteration, we need to prime prev_stop and
6520 base_level_stop with our best estimations. */
6521 /* Implementation note: Of course, POS is not necessarily a
6522 stop position, so assigning prev_pos to it is a lie; we
6523 should have called compute_stop_backwards. However, if
6524 the current buffer does not include any R2L characters,
6525 that call would be a waste of cycles, because the
6526 iterator will never move back, and thus never cross this
6527 "fake" stop position. So we delay that backward search
6528 until the time we really need it, in next_element_from_buffer. */
6529 if (CHARPOS (pos
) != it
->prev_stop
)
6530 it
->prev_stop
= CHARPOS (pos
);
6531 if (CHARPOS (pos
) < it
->base_level_stop
)
6532 it
->base_level_stop
= 0; /* meaning it's unknown */
6538 it
->prev_stop
= it
->base_level_stop
= 0;
6547 /* Change IT's buffer position to POS. SET_STOP_P means set
6548 IT->stop_pos to POS, also. */
6551 reseat_1 (struct it
*it
, struct text_pos pos
, bool set_stop_p
)
6553 /* Don't call this function when scanning a C string. */
6554 eassert (it
->s
== NULL
);
6556 /* POS must be a reasonable value. */
6557 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6559 it
->current
.pos
= it
->position
= pos
;
6560 it
->end_charpos
= ZV
;
6562 it
->current
.dpvec_index
= -1;
6563 it
->current
.overlay_string_index
= -1;
6564 IT_STRING_CHARPOS (*it
) = -1;
6565 IT_STRING_BYTEPOS (*it
) = -1;
6567 it
->method
= GET_FROM_BUFFER
;
6568 it
->object
= it
->w
->contents
;
6569 it
->area
= TEXT_AREA
;
6570 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6572 it
->string_from_display_prop_p
= false;
6573 it
->string_from_prefix_prop_p
= false;
6575 it
->from_disp_prop_p
= false;
6576 it
->face_before_selective_p
= false;
6579 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6581 bidi_unshelve_cache (NULL
, false);
6582 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6583 it
->bidi_it
.string
.s
= NULL
;
6584 it
->bidi_it
.string
.lstring
= Qnil
;
6585 it
->bidi_it
.string
.bufpos
= 0;
6586 it
->bidi_it
.string
.from_disp_str
= false;
6587 it
->bidi_it
.string
.unibyte
= false;
6588 it
->bidi_it
.w
= it
->w
;
6593 it
->stop_charpos
= CHARPOS (pos
);
6594 it
->base_level_stop
= CHARPOS (pos
);
6596 /* This make the information stored in it->cmp_it invalidate. */
6601 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6602 If S is non-null, it is a C string to iterate over. Otherwise,
6603 STRING gives a Lisp string to iterate over.
6605 If PRECISION > 0, don't return more then PRECISION number of
6606 characters from the string.
6608 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6609 characters have been returned. FIELD_WIDTH < 0 means an infinite
6612 MULTIBYTE = 0 means disable processing of multibyte characters,
6613 MULTIBYTE > 0 means enable it,
6614 MULTIBYTE < 0 means use IT->multibyte_p.
6616 IT must be initialized via a prior call to init_iterator before
6617 calling this function. */
6620 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6621 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6624 /* No text property checks performed by default, but see below. */
6625 it
->stop_charpos
= -1;
6627 /* Set iterator position and end position. */
6628 memset (&it
->current
, 0, sizeof it
->current
);
6629 it
->current
.overlay_string_index
= -1;
6630 it
->current
.dpvec_index
= -1;
6631 eassert (charpos
>= 0);
6633 /* If STRING is specified, use its multibyteness, otherwise use the
6634 setting of MULTIBYTE, if specified. */
6636 it
->multibyte_p
= multibyte
> 0;
6638 /* Bidirectional reordering of strings is controlled by the default
6639 value of bidi-display-reordering. Don't try to reorder while
6640 loading loadup.el, as the necessary character property tables are
6641 not yet available. */
6643 !redisplay__inhibit_bidi
6644 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6648 eassert (STRINGP (string
));
6649 it
->string
= string
;
6651 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6652 it
->method
= GET_FROM_STRING
;
6653 it
->current
.string_pos
= string_pos (charpos
, string
);
6657 it
->bidi_it
.string
.lstring
= string
;
6658 it
->bidi_it
.string
.s
= NULL
;
6659 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6660 it
->bidi_it
.string
.bufpos
= 0;
6661 it
->bidi_it
.string
.from_disp_str
= false;
6662 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6663 it
->bidi_it
.w
= it
->w
;
6664 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6665 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6670 it
->s
= (const unsigned char *) s
;
6673 /* Note that we use IT->current.pos, not it->current.string_pos,
6674 for displaying C strings. */
6675 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6676 if (it
->multibyte_p
)
6678 it
->current
.pos
= c_string_pos (charpos
, s
, true);
6679 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, true);
6683 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6684 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6689 it
->bidi_it
.string
.lstring
= Qnil
;
6690 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6691 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6692 it
->bidi_it
.string
.bufpos
= 0;
6693 it
->bidi_it
.string
.from_disp_str
= false;
6694 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6695 it
->bidi_it
.w
= it
->w
;
6696 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6699 it
->method
= GET_FROM_C_STRING
;
6702 /* PRECISION > 0 means don't return more than PRECISION characters
6704 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6706 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6708 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6711 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6712 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6713 FIELD_WIDTH < 0 means infinite field width. This is useful for
6714 padding with `-' at the end of a mode line. */
6715 if (field_width
< 0)
6716 field_width
= INFINITY
;
6717 /* Implementation note: We deliberately don't enlarge
6718 it->bidi_it.string.schars here to fit it->end_charpos, because
6719 the bidi iterator cannot produce characters out of thin air. */
6720 if (field_width
> it
->end_charpos
- charpos
)
6721 it
->end_charpos
= charpos
+ field_width
;
6723 /* Use the standard display table for displaying strings. */
6724 if (DISP_TABLE_P (Vstandard_display_table
))
6725 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6727 it
->stop_charpos
= charpos
;
6728 it
->prev_stop
= charpos
;
6729 it
->base_level_stop
= 0;
6732 it
->bidi_it
.first_elt
= true;
6733 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6734 it
->bidi_it
.disp_pos
= -1;
6736 if (s
== NULL
&& it
->multibyte_p
)
6738 ptrdiff_t endpos
= SCHARS (it
->string
);
6739 if (endpos
> it
->end_charpos
)
6740 endpos
= it
->end_charpos
;
6741 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6749 /***********************************************************************
6751 ***********************************************************************/
6753 /* Map enum it_method value to corresponding next_element_from_* function. */
6755 typedef bool (*next_element_function
) (struct it
*);
6757 static next_element_function
const get_next_element
[NUM_IT_METHODS
] =
6759 next_element_from_buffer
,
6760 next_element_from_display_vector
,
6761 next_element_from_string
,
6762 next_element_from_c_string
,
6763 next_element_from_image
,
6764 next_element_from_stretch
,
6765 next_element_from_xwidget
,
6768 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6771 /* Return true iff a character at CHARPOS (and BYTEPOS) is composed
6772 (possibly with the following characters). */
6774 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6775 ((IT)->cmp_it.id >= 0 \
6776 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6777 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6778 END_CHARPOS, (IT)->w, \
6779 FACE_FROM_ID_OR_NULL ((IT)->f, \
6784 /* Lookup the char-table Vglyphless_char_display for character C (-1
6785 if we want information for no-font case), and return the display
6786 method symbol. By side-effect, update it->what and
6787 it->glyphless_method. This function is called from
6788 get_next_display_element for each character element, and from
6789 x_produce_glyphs when no suitable font was found. */
6792 lookup_glyphless_char_display (int c
, struct it
*it
)
6794 Lisp_Object glyphless_method
= Qnil
;
6796 if (CHAR_TABLE_P (Vglyphless_char_display
)
6797 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6801 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6802 if (CONSP (glyphless_method
))
6803 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6804 ? XCAR (glyphless_method
)
6805 : XCDR (glyphless_method
);
6808 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6812 if (NILP (glyphless_method
))
6815 /* The default is to display the character by a proper font. */
6817 /* The default for the no-font case is to display an empty box. */
6818 glyphless_method
= Qempty_box
;
6820 if (EQ (glyphless_method
, Qzero_width
))
6823 return glyphless_method
;
6824 /* This method can't be used for the no-font case. */
6825 glyphless_method
= Qempty_box
;
6827 if (EQ (glyphless_method
, Qthin_space
))
6828 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6829 else if (EQ (glyphless_method
, Qempty_box
))
6830 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6831 else if (EQ (glyphless_method
, Qhex_code
))
6832 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6833 else if (STRINGP (glyphless_method
))
6834 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6837 /* Invalid value. We use the default method. */
6838 glyphless_method
= Qnil
;
6841 it
->what
= IT_GLYPHLESS
;
6842 return glyphless_method
;
6845 /* Merge escape glyph face and cache the result. */
6847 static struct frame
*last_escape_glyph_frame
= NULL
;
6848 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6849 static int last_escape_glyph_merged_face_id
= 0;
6852 merge_escape_glyph_face (struct it
*it
)
6856 if (it
->f
== last_escape_glyph_frame
6857 && it
->face_id
== last_escape_glyph_face_id
)
6858 face_id
= last_escape_glyph_merged_face_id
;
6861 /* Merge the `escape-glyph' face into the current face. */
6862 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6863 last_escape_glyph_frame
= it
->f
;
6864 last_escape_glyph_face_id
= it
->face_id
;
6865 last_escape_glyph_merged_face_id
= face_id
;
6870 /* Likewise for glyphless glyph face. */
6872 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6873 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6874 static int last_glyphless_glyph_merged_face_id
= 0;
6877 merge_glyphless_glyph_face (struct it
*it
)
6881 if (it
->f
== last_glyphless_glyph_frame
6882 && it
->face_id
== last_glyphless_glyph_face_id
)
6883 face_id
= last_glyphless_glyph_merged_face_id
;
6886 /* Merge the `glyphless-char' face into the current face. */
6887 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6888 last_glyphless_glyph_frame
= it
->f
;
6889 last_glyphless_glyph_face_id
= it
->face_id
;
6890 last_glyphless_glyph_merged_face_id
= face_id
;
6895 /* Forget the `escape-glyph' and `glyphless-char' faces. This should
6896 be called before redisplaying windows, and when the frame's face
6899 forget_escape_and_glyphless_faces (void)
6901 last_escape_glyph_frame
= NULL
;
6902 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6903 last_glyphless_glyph_frame
= NULL
;
6904 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6907 /* Load IT's display element fields with information about the next
6908 display element from the current position of IT. Value is false if
6909 end of buffer (or C string) is reached. */
6912 get_next_display_element (struct it
*it
)
6914 /* True means that we found a display element. False means that
6915 we hit the end of what we iterate over. Performance note: the
6916 function pointer `method' used here turns out to be faster than
6917 using a sequence of if-statements. */
6921 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6923 if (it
->what
== IT_CHARACTER
)
6925 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6926 and only if (a) the resolved directionality of that character
6928 /* FIXME: Do we need an exception for characters from display
6930 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
6931 && !inhibit_bidi_mirroring
)
6932 it
->c
= bidi_mirror_char (it
->c
);
6933 /* Map via display table or translate control characters.
6934 IT->c, IT->len etc. have been set to the next character by
6935 the function call above. If we have a display table, and it
6936 contains an entry for IT->c, translate it. Don't do this if
6937 IT->c itself comes from a display table, otherwise we could
6938 end up in an infinite recursion. (An alternative could be to
6939 count the recursion depth of this function and signal an
6940 error when a certain maximum depth is reached.) Is it worth
6942 if (success_p
&& it
->dpvec
== NULL
)
6945 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6946 bool nonascii_space_p
= false;
6947 bool nonascii_hyphen_p
= false;
6948 int c
= it
->c
; /* This is the character to display. */
6950 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6952 eassert (SINGLE_BYTE_CHAR_P (c
));
6953 if (unibyte_display_via_language_environment
)
6955 c
= DECODE_CHAR (unibyte
, c
);
6957 c
= BYTE8_TO_CHAR (it
->c
);
6960 c
= BYTE8_TO_CHAR (it
->c
);
6964 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6967 struct Lisp_Vector
*v
= XVECTOR (dv
);
6969 /* Return the first character from the display table
6970 entry, if not empty. If empty, don't display the
6971 current character. */
6974 it
->dpvec_char_len
= it
->len
;
6975 it
->dpvec
= v
->contents
;
6976 it
->dpend
= v
->contents
+ v
->header
.size
;
6977 it
->current
.dpvec_index
= 0;
6978 it
->dpvec_face_id
= -1;
6979 it
->saved_face_id
= it
->face_id
;
6980 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6981 it
->ellipsis_p
= false;
6985 set_iterator_to_next (it
, false);
6990 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6992 if (it
->what
== IT_GLYPHLESS
)
6994 /* Don't display this character. */
6995 set_iterator_to_next (it
, false);
6999 /* If `nobreak-char-display' is non-nil, we display
7000 non-ASCII spaces and hyphens specially. */
7001 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
7003 if (c
== NO_BREAK_SPACE
)
7004 nonascii_space_p
= true;
7005 else if (c
== SOFT_HYPHEN
|| c
== HYPHEN
7006 || c
== NON_BREAKING_HYPHEN
)
7007 nonascii_hyphen_p
= true;
7010 /* Translate control characters into `\003' or `^C' form.
7011 Control characters coming from a display table entry are
7012 currently not translated because we use IT->dpvec to hold
7013 the translation. This could easily be changed but I
7014 don't believe that it is worth doing.
7016 The characters handled by `nobreak-char-display' must be
7019 Non-printable characters and raw-byte characters are also
7020 translated to octal form. */
7021 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
7022 ? (it
->area
!= TEXT_AREA
7023 /* In mode line, treat \n, \t like other crl chars. */
7026 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
7027 || (c
!= '\n' && c
!= '\t'))
7029 || nonascii_hyphen_p
7031 || ! CHAR_PRINTABLE_P (c
))))
7033 /* C is a control character, non-ASCII space/hyphen,
7034 raw-byte, or a non-printable character which must be
7035 displayed either as '\003' or as `^C' where the '\\'
7036 and '^' can be defined in the display table. Fill
7037 IT->ctl_chars with glyphs for what we have to
7038 display. Then, set IT->dpvec to these glyphs. */
7045 /* Handle control characters with ^. */
7047 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
7051 g
= '^'; /* default glyph for Control */
7052 /* Set IT->ctl_chars[0] to the glyph for `^'. */
7054 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7056 g
= GLYPH_CODE_CHAR (gc
);
7057 lface_id
= GLYPH_CODE_FACE (gc
);
7061 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7062 : merge_escape_glyph_face (it
));
7064 XSETINT (it
->ctl_chars
[0], g
);
7065 XSETINT (it
->ctl_chars
[1], c
^ 0100);
7067 goto display_control
;
7070 /* Handle non-ascii space in the mode where it only gets
7073 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
7075 /* Merge `nobreak-space' into the current face. */
7076 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
7078 XSETINT (it
->ctl_chars
[0], ' ');
7080 goto display_control
;
7083 /* Handle non-ascii hyphens in the mode where it only
7084 gets highlighting. */
7086 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
7088 /* Merge `nobreak-space' into the current face. */
7089 face_id
= merge_faces (it
->f
, Qnobreak_hyphen
, 0,
7091 XSETINT (it
->ctl_chars
[0], '-');
7093 goto display_control
;
7096 /* Handle sequences that start with the "escape glyph". */
7098 /* the default escape glyph is \. */
7099 escape_glyph
= '\\';
7102 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7104 escape_glyph
= GLYPH_CODE_CHAR (gc
);
7105 lface_id
= GLYPH_CODE_FACE (gc
);
7109 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7110 : merge_escape_glyph_face (it
));
7112 /* Draw non-ASCII space/hyphen with escape glyph: */
7114 if (nonascii_space_p
|| nonascii_hyphen_p
)
7116 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7117 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7119 goto display_control
;
7126 if (CHAR_BYTE8_P (c
))
7127 /* Display \200 instead of \17777600. */
7128 c
= CHAR_TO_BYTE8 (c
);
7129 len
= sprintf (str
, "%03o", c
+ 0u);
7131 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7132 for (i
= 0; i
< len
; i
++)
7133 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7138 /* Set up IT->dpvec and return first character from it. */
7139 it
->dpvec_char_len
= it
->len
;
7140 it
->dpvec
= it
->ctl_chars
;
7141 it
->dpend
= it
->dpvec
+ ctl_len
;
7142 it
->current
.dpvec_index
= 0;
7143 it
->dpvec_face_id
= face_id
;
7144 it
->saved_face_id
= it
->face_id
;
7145 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7146 it
->ellipsis_p
= false;
7149 it
->char_to_display
= c
;
7153 it
->char_to_display
= it
->c
;
7157 #ifdef HAVE_WINDOW_SYSTEM
7158 /* Adjust face id for a multibyte character. There are no multibyte
7159 character in unibyte text. */
7160 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7163 && FRAME_WINDOW_P (it
->f
))
7165 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7167 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7169 /* Automatic composition with glyph-string. */
7170 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7172 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7176 ptrdiff_t pos
= (it
->s
? -1
7177 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7178 : IT_CHARPOS (*it
));
7181 if (it
->what
== IT_CHARACTER
)
7182 c
= it
->char_to_display
;
7185 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7189 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7190 /* TAB in a composition means display glyphs with
7191 padding space on the left or right. */
7192 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7195 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7198 #endif /* HAVE_WINDOW_SYSTEM */
7201 /* Is this character the last one of a run of characters with
7202 box? If yes, set IT->end_of_box_run_p to true. */
7206 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7208 int face_id
= underlying_face_id (it
);
7209 struct face
*face
= FACE_FROM_ID_OR_NULL (it
->f
, face_id
);
7213 if (face
->box
== FACE_NO_BOX
)
7215 /* If the box comes from face properties in a
7216 display string, check faces in that string. */
7217 int string_face_id
= face_after_it_pos (it
);
7218 it
->end_of_box_run_p
7219 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7222 /* Otherwise, the box comes from the underlying face.
7223 If this is the last string character displayed, check
7224 the next buffer location. */
7225 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7226 /* n_overlay_strings is unreliable unless
7227 overlay_string_index is non-negative. */
7228 && ((it
->current
.overlay_string_index
>= 0
7229 && (it
->current
.overlay_string_index
7230 == it
->n_overlay_strings
- 1))
7231 /* A string from display property. */
7232 || it
->from_disp_prop_p
))
7236 bool text_from_string
= false;
7237 /* Normally, the next buffer location is stored in
7238 IT->current.pos... */
7239 struct text_pos pos
= it
->current
.pos
;
7241 /* ...but for a string from a display property, the
7242 next buffer position is stored in the 'position'
7243 member of the iteration stack slot below the
7244 current one, see handle_single_display_spec. By
7245 contrast, it->current.pos was not yet updated to
7246 point to that buffer position; that will happen
7247 in pop_it, after we finish displaying the current
7248 string. Note that we already checked above that
7249 it->sp is positive, so subtracting one from it is
7251 if (it
->from_disp_prop_p
)
7253 int stackp
= it
->sp
- 1;
7255 /* Find the stack level with data from buffer. */
7257 && STRINGP ((it
->stack
+ stackp
)->string
))
7261 /* If no stack slot was found for iterating
7262 a buffer, we are displaying text from a
7263 string, most probably the mode line or
7264 the header line, and that string has a
7265 display string on some of its
7267 text_from_string
= true;
7268 pos
= it
->stack
[it
->sp
- 1].position
;
7271 pos
= (it
->stack
+ stackp
)->position
;
7274 INC_TEXT_POS (pos
, it
->multibyte_p
);
7276 if (text_from_string
)
7278 Lisp_Object base_string
= it
->stack
[it
->sp
- 1].string
;
7280 if (CHARPOS (pos
) >= SCHARS (base_string
) - 1)
7281 it
->end_of_box_run_p
= true;
7285 = face_at_string_position (it
->w
, base_string
,
7287 &ignore
, face_id
, false);
7288 it
->end_of_box_run_p
7289 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7293 else if (CHARPOS (pos
) >= ZV
)
7294 it
->end_of_box_run_p
= true;
7298 face_at_buffer_position (it
->w
, CHARPOS (pos
), &ignore
,
7300 + TEXT_PROP_DISTANCE_LIMIT
,
7302 it
->end_of_box_run_p
7303 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7309 /* next_element_from_display_vector sets this flag according to
7310 faces of the display vector glyphs, see there. */
7311 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7313 int face_id
= face_after_it_pos (it
);
7314 it
->end_of_box_run_p
7315 = (face_id
!= it
->face_id
7316 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7319 /* If we reached the end of the object we've been iterating (e.g., a
7320 display string or an overlay string), and there's something on
7321 IT->stack, proceed with what's on the stack. It doesn't make
7322 sense to return false if there's unprocessed stuff on the stack,
7323 because otherwise that stuff will never be displayed. */
7324 if (!success_p
&& it
->sp
> 0)
7326 set_iterator_to_next (it
, false);
7327 success_p
= get_next_display_element (it
);
7330 /* Value is false if end of buffer or string reached. */
7335 /* Move IT to the next display element.
7337 RESEAT_P means if called on a newline in buffer text,
7338 skip to the next visible line start.
7340 Functions get_next_display_element and set_iterator_to_next are
7341 separate because I find this arrangement easier to handle than a
7342 get_next_display_element function that also increments IT's
7343 position. The way it is we can first look at an iterator's current
7344 display element, decide whether it fits on a line, and if it does,
7345 increment the iterator position. The other way around we probably
7346 would either need a flag indicating whether the iterator has to be
7347 incremented the next time, or we would have to implement a
7348 decrement position function which would not be easy to write. */
7351 set_iterator_to_next (struct it
*it
, bool reseat_p
)
7353 /* Reset flags indicating start and end of a sequence of characters
7354 with box. Reset them at the start of this function because
7355 moving the iterator to a new position might set them. */
7356 it
->start_of_box_run_p
= it
->end_of_box_run_p
= false;
7360 case GET_FROM_BUFFER
:
7361 /* The current display element of IT is a character from
7362 current_buffer. Advance in the buffer, and maybe skip over
7363 invisible lines that are so because of selective display. */
7364 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7365 reseat_at_next_visible_line_start (it
, false);
7366 else if (it
->cmp_it
.id
>= 0)
7368 /* We are currently getting glyphs from a composition. */
7371 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7372 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7378 /* Update IT's char/byte positions to point to the first
7379 character of the next grapheme cluster, or to the
7380 character visually after the current composition. */
7381 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7382 bidi_move_to_visually_next (&it
->bidi_it
);
7383 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7384 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7387 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7388 && it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7390 /* Composition created while scanning forward. Proceed
7391 to the next grapheme cluster. */
7392 it
->cmp_it
.from
= it
->cmp_it
.to
;
7394 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7395 && it
->cmp_it
.from
> 0)
7397 /* Composition created while scanning backward. Proceed
7398 to the previous grapheme cluster. */
7399 it
->cmp_it
.to
= it
->cmp_it
.from
;
7403 /* No more grapheme clusters in this composition.
7404 Find the next stop position. */
7405 ptrdiff_t stop
= it
->end_charpos
;
7407 if (it
->bidi_it
.scan_dir
< 0)
7408 /* Now we are scanning backward and don't know
7411 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7412 IT_BYTEPOS (*it
), stop
, Qnil
);
7417 eassert (it
->len
!= 0);
7421 IT_BYTEPOS (*it
) += it
->len
;
7422 IT_CHARPOS (*it
) += 1;
7426 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7427 /* If this is a new paragraph, determine its base
7428 direction (a.k.a. its base embedding level). */
7429 if (it
->bidi_it
.new_paragraph
)
7430 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
7432 bidi_move_to_visually_next (&it
->bidi_it
);
7433 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7434 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7435 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7437 /* As the scan direction was changed, we must
7438 re-compute the stop position for composition. */
7439 ptrdiff_t stop
= it
->end_charpos
;
7440 if (it
->bidi_it
.scan_dir
< 0)
7442 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7443 IT_BYTEPOS (*it
), stop
, Qnil
);
7446 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7450 case GET_FROM_C_STRING
:
7451 /* Current display element of IT is from a C string. */
7453 /* If the string position is beyond string's end, it means
7454 next_element_from_c_string is padding the string with
7455 blanks, in which case we bypass the bidi iterator,
7456 because it cannot deal with such virtual characters. */
7457 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7459 IT_BYTEPOS (*it
) += it
->len
;
7460 IT_CHARPOS (*it
) += 1;
7464 bidi_move_to_visually_next (&it
->bidi_it
);
7465 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7466 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7470 case GET_FROM_DISPLAY_VECTOR
:
7471 /* Current display element of IT is from a display table entry.
7472 Advance in the display table definition. Reset it to null if
7473 end reached, and continue with characters from buffers/
7475 ++it
->current
.dpvec_index
;
7477 /* Restore face of the iterator to what they were before the
7478 display vector entry (these entries may contain faces). */
7479 it
->face_id
= it
->saved_face_id
;
7481 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7483 bool recheck_faces
= it
->ellipsis_p
;
7486 it
->method
= GET_FROM_C_STRING
;
7487 else if (STRINGP (it
->string
))
7488 it
->method
= GET_FROM_STRING
;
7491 it
->method
= GET_FROM_BUFFER
;
7492 it
->object
= it
->w
->contents
;
7496 it
->current
.dpvec_index
= -1;
7498 /* Skip over characters which were displayed via IT->dpvec. */
7499 if (it
->dpvec_char_len
< 0)
7500 reseat_at_next_visible_line_start (it
, true);
7501 else if (it
->dpvec_char_len
> 0)
7503 it
->len
= it
->dpvec_char_len
;
7504 set_iterator_to_next (it
, reseat_p
);
7507 /* Maybe recheck faces after display vector. */
7510 if (it
->method
== GET_FROM_STRING
)
7511 it
->stop_charpos
= IT_STRING_CHARPOS (*it
);
7513 it
->stop_charpos
= IT_CHARPOS (*it
);
7518 case GET_FROM_STRING
:
7519 /* Current display element is a character from a Lisp string. */
7520 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7521 /* Don't advance past string end. These conditions are true
7522 when set_iterator_to_next is called at the end of
7523 get_next_display_element, in which case the Lisp string is
7524 already exhausted, and all we want is pop the iterator
7526 if (it
->current
.overlay_string_index
>= 0)
7528 /* This is an overlay string, so there's no padding with
7529 spaces, and the number of characters in the string is
7530 where the string ends. */
7531 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7532 goto consider_string_end
;
7536 /* Not an overlay string. There could be padding, so test
7537 against it->end_charpos. */
7538 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7539 goto consider_string_end
;
7541 if (it
->cmp_it
.id
>= 0)
7543 /* We are delivering display elements from a composition.
7544 Update the string position past the grapheme cluster
7545 we've just processed. */
7548 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7549 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7555 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7556 bidi_move_to_visually_next (&it
->bidi_it
);
7557 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7558 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7561 /* Did we exhaust all the grapheme clusters of this
7563 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7564 && (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
))
7566 /* Not all the grapheme clusters were processed yet;
7567 advance to the next cluster. */
7568 it
->cmp_it
.from
= it
->cmp_it
.to
;
7570 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7571 && it
->cmp_it
.from
> 0)
7573 /* Likewise: advance to the next cluster, but going in
7574 the reverse direction. */
7575 it
->cmp_it
.to
= it
->cmp_it
.from
;
7579 /* This composition was fully processed; find the next
7580 candidate place for checking for composed
7582 /* Always limit string searches to the string length;
7583 any padding spaces are not part of the string, and
7584 there cannot be any compositions in that padding. */
7585 ptrdiff_t stop
= SCHARS (it
->string
);
7587 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
7589 else if (it
->end_charpos
< stop
)
7591 /* Cf. PRECISION in reseat_to_string: we might be
7592 limited in how many of the string characters we
7594 stop
= it
->end_charpos
;
7596 composition_compute_stop_pos (&it
->cmp_it
,
7597 IT_STRING_CHARPOS (*it
),
7598 IT_STRING_BYTEPOS (*it
), stop
,
7605 /* If the string position is beyond string's end, it
7606 means next_element_from_string is padding the string
7607 with blanks, in which case we bypass the bidi
7608 iterator, because it cannot deal with such virtual
7610 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7612 IT_STRING_BYTEPOS (*it
) += it
->len
;
7613 IT_STRING_CHARPOS (*it
) += 1;
7617 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7619 bidi_move_to_visually_next (&it
->bidi_it
);
7620 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7621 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7622 /* If the scan direction changes, we may need to update
7623 the place where to check for composed characters. */
7624 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7626 ptrdiff_t stop
= SCHARS (it
->string
);
7628 if (it
->bidi_it
.scan_dir
< 0)
7630 else if (it
->end_charpos
< stop
)
7631 stop
= it
->end_charpos
;
7633 composition_compute_stop_pos (&it
->cmp_it
,
7634 IT_STRING_CHARPOS (*it
),
7635 IT_STRING_BYTEPOS (*it
), stop
,
7641 consider_string_end
:
7643 if (it
->current
.overlay_string_index
>= 0)
7645 /* IT->string is an overlay string. Advance to the
7646 next, if there is one. */
7647 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7649 it
->ellipsis_p
= false;
7650 next_overlay_string (it
);
7652 setup_for_ellipsis (it
, 0);
7657 /* IT->string is not an overlay string. If we reached
7658 its end, and there is something on IT->stack, proceed
7659 with what is on the stack. This can be either another
7660 string, this time an overlay string, or a buffer. */
7661 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7665 if (it
->method
== GET_FROM_STRING
)
7666 goto consider_string_end
;
7671 case GET_FROM_IMAGE
:
7672 case GET_FROM_STRETCH
:
7673 case GET_FROM_XWIDGET
:
7675 /* The position etc with which we have to proceed are on
7676 the stack. The position may be at the end of a string,
7677 if the `display' property takes up the whole string. */
7678 eassert (it
->sp
> 0);
7680 if (it
->method
== GET_FROM_STRING
)
7681 goto consider_string_end
;
7685 /* There are no other methods defined, so this should be a bug. */
7689 eassert (it
->method
!= GET_FROM_STRING
7690 || (STRINGP (it
->string
)
7691 && IT_STRING_CHARPOS (*it
) >= 0));
7694 /* Load IT's display element fields with information about the next
7695 display element which comes from a display table entry or from the
7696 result of translating a control character to one of the forms `^C'
7699 IT->dpvec holds the glyphs to return as characters.
7700 IT->saved_face_id holds the face id before the display vector--it
7701 is restored into IT->face_id in set_iterator_to_next. */
7704 next_element_from_display_vector (struct it
*it
)
7707 int prev_face_id
= it
->face_id
;
7711 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7713 it
->face_id
= it
->saved_face_id
;
7715 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7716 That seemed totally bogus - so I changed it... */
7717 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7719 if (GLYPH_CODE_P (gc
))
7721 struct face
*this_face
, *prev_face
, *next_face
;
7723 it
->c
= GLYPH_CODE_CHAR (gc
);
7724 it
->len
= CHAR_BYTES (it
->c
);
7726 /* The entry may contain a face id to use. Such a face id is
7727 the id of a Lisp face, not a realized face. A face id of
7728 zero means no face is specified. */
7729 if (it
->dpvec_face_id
>= 0)
7730 it
->face_id
= it
->dpvec_face_id
;
7733 int lface_id
= GLYPH_CODE_FACE (gc
);
7735 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7739 /* Glyphs in the display vector could have the box face, so we
7740 need to set the related flags in the iterator, as
7742 this_face
= FACE_FROM_ID_OR_NULL (it
->f
, it
->face_id
);
7743 prev_face
= FACE_FROM_ID_OR_NULL (it
->f
, prev_face_id
);
7745 /* Is this character the first character of a box-face run? */
7746 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7748 || prev_face
->box
== FACE_NO_BOX
));
7750 /* For the last character of the box-face run, we need to look
7751 either at the next glyph from the display vector, or at the
7752 face we saw before the display vector. */
7753 next_face_id
= it
->saved_face_id
;
7754 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7756 if (it
->dpvec_face_id
>= 0)
7757 next_face_id
= it
->dpvec_face_id
;
7761 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7764 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7768 next_face
= FACE_FROM_ID_OR_NULL (it
->f
, next_face_id
);
7769 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7771 || next_face
->box
== FACE_NO_BOX
));
7772 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7775 /* Display table entry is invalid. Return a space. */
7776 it
->c
= ' ', it
->len
= 1;
7778 /* Don't change position and object of the iterator here. They are
7779 still the values of the character that had this display table
7780 entry or was translated, and that's what we want. */
7781 it
->what
= IT_CHARACTER
;
7785 /* Get the first element of string/buffer in the visual order, after
7786 being reseated to a new position in a string or a buffer. */
7788 get_visually_first_element (struct it
*it
)
7790 bool string_p
= STRINGP (it
->string
) || it
->s
;
7791 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7792 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7794 if (STRINGP (it
->string
))
7796 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7797 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7801 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7802 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7805 if (it
->bidi_it
.charpos
== eob
)
7807 /* Nothing to do, but reset the FIRST_ELT flag, like
7808 bidi_paragraph_init does, because we are not going to
7810 it
->bidi_it
.first_elt
= false;
7812 else if (it
->bidi_it
.charpos
== bob
7814 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7815 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7817 /* If we are at the beginning of a line/string, we can produce
7818 the next element right away. */
7819 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7820 bidi_move_to_visually_next (&it
->bidi_it
);
7824 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7826 /* We need to prime the bidi iterator starting at the line's or
7827 string's beginning, before we will be able to produce the
7830 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7832 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7833 IT_BYTEPOS (*it
), -1,
7834 &it
->bidi_it
.bytepos
);
7835 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7838 /* Now return to buffer/string position where we were asked
7839 to get the next display element, and produce that. */
7840 bidi_move_to_visually_next (&it
->bidi_it
);
7842 while (it
->bidi_it
.bytepos
!= orig_bytepos
7843 && it
->bidi_it
.charpos
< eob
);
7846 /* Adjust IT's position information to where we ended up. */
7847 if (STRINGP (it
->string
))
7849 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7850 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7854 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7855 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7858 if (STRINGP (it
->string
) || !it
->s
)
7860 ptrdiff_t stop
, charpos
, bytepos
;
7862 if (STRINGP (it
->string
))
7865 stop
= SCHARS (it
->string
);
7866 if (stop
> it
->end_charpos
)
7867 stop
= it
->end_charpos
;
7868 charpos
= IT_STRING_CHARPOS (*it
);
7869 bytepos
= IT_STRING_BYTEPOS (*it
);
7873 stop
= it
->end_charpos
;
7874 charpos
= IT_CHARPOS (*it
);
7875 bytepos
= IT_BYTEPOS (*it
);
7877 if (it
->bidi_it
.scan_dir
< 0)
7879 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7884 /* Load IT with the next display element from Lisp string IT->string.
7885 IT->current.string_pos is the current position within the string.
7886 If IT->current.overlay_string_index >= 0, the Lisp string is an
7890 next_element_from_string (struct it
*it
)
7892 struct text_pos position
;
7894 eassert (STRINGP (it
->string
));
7895 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7896 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7897 position
= it
->current
.string_pos
;
7899 /* With bidi reordering, the character to display might not be the
7900 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT means
7901 that we were reseat()ed to a new string, whose paragraph
7902 direction is not known. */
7903 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7905 get_visually_first_element (it
);
7906 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7909 /* Time to check for invisible text? */
7910 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7912 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7915 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7916 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7918 /* With bidi non-linear iteration, we could find
7919 ourselves far beyond the last computed stop_charpos,
7920 with several other stop positions in between that we
7921 missed. Scan them all now, in buffer's logical
7922 order, until we find and handle the last stop_charpos
7923 that precedes our current position. */
7924 handle_stop_backwards (it
, it
->stop_charpos
);
7925 return GET_NEXT_DISPLAY_ELEMENT (it
);
7931 /* Take note of the stop position we just moved
7932 across, for when we will move back across it. */
7933 it
->prev_stop
= it
->stop_charpos
;
7934 /* If we are at base paragraph embedding level, take
7935 note of the last stop position seen at this
7937 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7938 it
->base_level_stop
= it
->stop_charpos
;
7942 /* Since a handler may have changed IT->method, we must
7944 return GET_NEXT_DISPLAY_ELEMENT (it
);
7948 /* If we are before prev_stop, we may have overstepped
7949 on our way backwards a stop_pos, and if so, we need
7950 to handle that stop_pos. */
7951 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7952 /* We can sometimes back up for reasons that have nothing
7953 to do with bidi reordering. E.g., compositions. The
7954 code below is only needed when we are above the base
7955 embedding level, so test for that explicitly. */
7956 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7958 /* If we lost track of base_level_stop, we have no better
7959 place for handle_stop_backwards to start from than string
7960 beginning. This happens, e.g., when we were reseated to
7961 the previous screenful of text by vertical-motion. */
7962 if (it
->base_level_stop
<= 0
7963 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7964 it
->base_level_stop
= 0;
7965 handle_stop_backwards (it
, it
->base_level_stop
);
7966 return GET_NEXT_DISPLAY_ELEMENT (it
);
7970 if (it
->current
.overlay_string_index
>= 0)
7972 /* Get the next character from an overlay string. In overlay
7973 strings, there is no field width or padding with spaces to
7975 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7980 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7981 IT_STRING_BYTEPOS (*it
),
7982 it
->bidi_it
.scan_dir
< 0
7984 : SCHARS (it
->string
))
7985 && next_element_from_composition (it
))
7989 else if (STRING_MULTIBYTE (it
->string
))
7991 const unsigned char *s
= (SDATA (it
->string
)
7992 + IT_STRING_BYTEPOS (*it
));
7993 it
->c
= string_char_and_length (s
, &it
->len
);
7997 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
8003 /* Get the next character from a Lisp string that is not an
8004 overlay string. Such strings come from the mode line, for
8005 example. We may have to pad with spaces, or truncate the
8006 string. See also next_element_from_c_string. */
8007 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
8012 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
8014 /* Pad with spaces. */
8015 it
->c
= ' ', it
->len
= 1;
8016 CHARPOS (position
) = BYTEPOS (position
) = -1;
8018 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
8019 IT_STRING_BYTEPOS (*it
),
8020 it
->bidi_it
.scan_dir
< 0
8022 : it
->string_nchars
)
8023 && next_element_from_composition (it
))
8027 else if (STRING_MULTIBYTE (it
->string
))
8029 const unsigned char *s
= (SDATA (it
->string
)
8030 + IT_STRING_BYTEPOS (*it
));
8031 it
->c
= string_char_and_length (s
, &it
->len
);
8035 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
8040 /* Record what we have and where it came from. */
8041 it
->what
= IT_CHARACTER
;
8042 it
->object
= it
->string
;
8043 it
->position
= position
;
8048 /* Load IT with next display element from C string IT->s.
8049 IT->string_nchars is the maximum number of characters to return
8050 from the string. IT->end_charpos may be greater than
8051 IT->string_nchars when this function is called, in which case we
8052 may have to return padding spaces. Value is false if end of string
8053 reached, including padding spaces. */
8056 next_element_from_c_string (struct it
*it
)
8058 bool success_p
= true;
8061 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
8062 it
->what
= IT_CHARACTER
;
8063 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
8064 it
->object
= make_number (0);
8066 /* With bidi reordering, the character to display might not be the
8067 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
8068 we were reseated to a new string, whose paragraph direction is
8070 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8071 get_visually_first_element (it
);
8073 /* IT's position can be greater than IT->string_nchars in case a
8074 field width or precision has been specified when the iterator was
8076 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8078 /* End of the game. */
8082 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
8084 /* Pad with spaces. */
8085 it
->c
= ' ', it
->len
= 1;
8086 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
8088 else if (it
->multibyte_p
)
8089 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
8091 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
8097 /* Set up IT to return characters from an ellipsis, if appropriate.
8098 The definition of the ellipsis glyphs may come from a display table
8099 entry. This function fills IT with the first glyph from the
8100 ellipsis if an ellipsis is to be displayed. */
8103 next_element_from_ellipsis (struct it
*it
)
8105 if (it
->selective_display_ellipsis_p
)
8106 setup_for_ellipsis (it
, it
->len
);
8109 /* The face at the current position may be different from the
8110 face we find after the invisible text. Remember what it
8111 was in IT->saved_face_id, and signal that it's there by
8112 setting face_before_selective_p. */
8113 it
->saved_face_id
= it
->face_id
;
8114 it
->method
= GET_FROM_BUFFER
;
8115 it
->object
= it
->w
->contents
;
8116 reseat_at_next_visible_line_start (it
, true);
8117 it
->face_before_selective_p
= true;
8120 return GET_NEXT_DISPLAY_ELEMENT (it
);
8124 /* Deliver an image display element. The iterator IT is already
8125 filled with image information (done in handle_display_prop). Value
8130 next_element_from_image (struct it
*it
)
8132 it
->what
= IT_IMAGE
;
8137 next_element_from_xwidget (struct it
*it
)
8139 it
->what
= IT_XWIDGET
;
8144 /* Fill iterator IT with next display element from a stretch glyph
8145 property. IT->object is the value of the text property. Value is
8149 next_element_from_stretch (struct it
*it
)
8151 it
->what
= IT_STRETCH
;
8155 /* Scan backwards from IT's current position until we find a stop
8156 position, or until BEGV. This is called when we find ourself
8157 before both the last known prev_stop and base_level_stop while
8158 reordering bidirectional text. */
8161 compute_stop_pos_backwards (struct it
*it
)
8163 const int SCAN_BACK_LIMIT
= 1000;
8164 struct text_pos pos
;
8165 struct display_pos save_current
= it
->current
;
8166 struct text_pos save_position
= it
->position
;
8167 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8168 ptrdiff_t where_we_are
= charpos
;
8169 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8170 ptrdiff_t save_end_pos
= it
->end_charpos
;
8172 eassert (NILP (it
->string
) && !it
->s
);
8173 eassert (it
->bidi_p
);
8177 it
->end_charpos
= min (charpos
+ 1, ZV
);
8178 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8179 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8180 reseat_1 (it
, pos
, false);
8181 compute_stop_pos (it
);
8182 /* We must advance forward, right? */
8183 if (it
->stop_charpos
<= charpos
)
8186 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8188 if (it
->stop_charpos
<= where_we_are
)
8189 it
->prev_stop
= it
->stop_charpos
;
8191 it
->prev_stop
= BEGV
;
8193 it
->current
= save_current
;
8194 it
->position
= save_position
;
8195 it
->stop_charpos
= save_stop_pos
;
8196 it
->end_charpos
= save_end_pos
;
8199 /* Scan forward from CHARPOS in the current buffer/string, until we
8200 find a stop position > current IT's position. Then handle the stop
8201 position before that. This is called when we bump into a stop
8202 position while reordering bidirectional text. CHARPOS should be
8203 the last previously processed stop_pos (or BEGV/0, if none were
8204 processed yet) whose position is less that IT's current
8208 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8210 bool bufp
= !STRINGP (it
->string
);
8211 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8212 struct display_pos save_current
= it
->current
;
8213 struct text_pos save_position
= it
->position
;
8214 struct text_pos pos1
;
8215 ptrdiff_t next_stop
;
8217 /* Scan in strict logical order. */
8218 eassert (it
->bidi_p
);
8222 it
->prev_stop
= charpos
;
8225 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8226 reseat_1 (it
, pos1
, false);
8229 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8230 compute_stop_pos (it
);
8231 /* We must advance forward, right? */
8232 if (it
->stop_charpos
<= it
->prev_stop
)
8234 charpos
= it
->stop_charpos
;
8236 while (charpos
<= where_we_are
);
8239 it
->current
= save_current
;
8240 it
->position
= save_position
;
8241 next_stop
= it
->stop_charpos
;
8242 it
->stop_charpos
= it
->prev_stop
;
8244 it
->stop_charpos
= next_stop
;
8247 /* Load IT with the next display element from current_buffer. Value
8248 is false if end of buffer reached. IT->stop_charpos is the next
8249 position at which to stop and check for text properties or buffer
8253 next_element_from_buffer (struct it
*it
)
8255 bool success_p
= true;
8257 eassert (IT_CHARPOS (*it
) >= BEGV
);
8258 eassert (NILP (it
->string
) && !it
->s
);
8259 eassert (!it
->bidi_p
8260 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8261 && it
->bidi_it
.string
.s
== NULL
));
8263 /* With bidi reordering, the character to display might not be the
8264 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
8265 we were reseat()ed to a new buffer position, which is potentially
8266 a different paragraph. */
8267 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8269 get_visually_first_element (it
);
8270 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8273 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8275 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8277 bool overlay_strings_follow_p
;
8279 /* End of the game, except when overlay strings follow that
8280 haven't been returned yet. */
8281 if (it
->overlay_strings_at_end_processed_p
)
8282 overlay_strings_follow_p
= false;
8285 it
->overlay_strings_at_end_processed_p
= true;
8286 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8289 if (overlay_strings_follow_p
)
8290 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8294 it
->position
= it
->current
.pos
;
8298 else if (!(!it
->bidi_p
8299 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8300 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8302 /* With bidi non-linear iteration, we could find ourselves
8303 far beyond the last computed stop_charpos, with several
8304 other stop positions in between that we missed. Scan
8305 them all now, in buffer's logical order, until we find
8306 and handle the last stop_charpos that precedes our
8307 current position. */
8308 handle_stop_backwards (it
, it
->stop_charpos
);
8309 it
->ignore_overlay_strings_at_pos_p
= false;
8310 return GET_NEXT_DISPLAY_ELEMENT (it
);
8316 /* Take note of the stop position we just moved across,
8317 for when we will move back across it. */
8318 it
->prev_stop
= it
->stop_charpos
;
8319 /* If we are at base paragraph embedding level, take
8320 note of the last stop position seen at this
8322 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8323 it
->base_level_stop
= it
->stop_charpos
;
8326 it
->ignore_overlay_strings_at_pos_p
= false;
8327 return GET_NEXT_DISPLAY_ELEMENT (it
);
8331 /* If we are before prev_stop, we may have overstepped on
8332 our way backwards a stop_pos, and if so, we need to
8333 handle that stop_pos. */
8334 && IT_CHARPOS (*it
) < it
->prev_stop
8335 /* We can sometimes back up for reasons that have nothing
8336 to do with bidi reordering. E.g., compositions. The
8337 code below is only needed when we are above the base
8338 embedding level, so test for that explicitly. */
8339 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8341 if (it
->base_level_stop
<= 0
8342 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8344 /* If we lost track of base_level_stop, we need to find
8345 prev_stop by looking backwards. This happens, e.g., when
8346 we were reseated to the previous screenful of text by
8348 it
->base_level_stop
= BEGV
;
8349 compute_stop_pos_backwards (it
);
8350 handle_stop_backwards (it
, it
->prev_stop
);
8353 handle_stop_backwards (it
, it
->base_level_stop
);
8354 it
->ignore_overlay_strings_at_pos_p
= false;
8355 return GET_NEXT_DISPLAY_ELEMENT (it
);
8359 /* No face changes, overlays etc. in sight, so just return a
8360 character from current_buffer. */
8364 /* We moved to the next buffer position, so any info about
8365 previously seen overlays is no longer valid. */
8366 it
->ignore_overlay_strings_at_pos_p
= false;
8368 /* Maybe run the redisplay end trigger hook. Performance note:
8369 This doesn't seem to cost measurable time. */
8370 if (it
->redisplay_end_trigger_charpos
8372 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8373 run_redisplay_end_trigger_hook (it
);
8375 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8376 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8378 && next_element_from_composition (it
))
8383 /* Get the next character, maybe multibyte. */
8384 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8385 if (it
->multibyte_p
&& !ASCII_CHAR_P (*p
))
8386 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8388 it
->c
= *p
, it
->len
= 1;
8390 /* Record what we have and where it came from. */
8391 it
->what
= IT_CHARACTER
;
8392 it
->object
= it
->w
->contents
;
8393 it
->position
= it
->current
.pos
;
8395 /* Normally we return the character found above, except when we
8396 really want to return an ellipsis for selective display. */
8401 /* A value of selective > 0 means hide lines indented more
8402 than that number of columns. */
8403 if (it
->selective
> 0
8404 && IT_CHARPOS (*it
) + 1 < ZV
8405 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8406 IT_BYTEPOS (*it
) + 1,
8409 success_p
= next_element_from_ellipsis (it
);
8410 it
->dpvec_char_len
= -1;
8413 else if (it
->c
== '\r' && it
->selective
== -1)
8415 /* A value of selective == -1 means that everything from the
8416 CR to the end of the line is invisible, with maybe an
8417 ellipsis displayed for it. */
8418 success_p
= next_element_from_ellipsis (it
);
8419 it
->dpvec_char_len
= -1;
8424 /* Value is false if end of buffer reached. */
8425 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8430 /* Run the redisplay end trigger hook for IT. */
8433 run_redisplay_end_trigger_hook (struct it
*it
)
8435 /* IT->glyph_row should be non-null, i.e. we should be actually
8436 displaying something, or otherwise we should not run the hook. */
8437 eassert (it
->glyph_row
);
8439 ptrdiff_t charpos
= it
->redisplay_end_trigger_charpos
;
8440 it
->redisplay_end_trigger_charpos
= 0;
8442 /* Since we are *trying* to run these functions, don't try to run
8443 them again, even if they get an error. */
8444 wset_redisplay_end_trigger (it
->w
, Qnil
);
8445 CALLN (Frun_hook_with_args
, Qredisplay_end_trigger_functions
, it
->window
,
8446 make_number (charpos
));
8448 /* Notice if it changed the face of the character we are on. */
8449 handle_face_prop (it
);
8453 /* Deliver a composition display element. Unlike the other
8454 next_element_from_XXX, this function is not registered in the array
8455 get_next_element[]. It is called from next_element_from_buffer and
8456 next_element_from_string when necessary. */
8459 next_element_from_composition (struct it
*it
)
8461 it
->what
= IT_COMPOSITION
;
8462 it
->len
= it
->cmp_it
.nbytes
;
8463 if (STRINGP (it
->string
))
8467 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8468 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8471 it
->position
= it
->current
.string_pos
;
8472 it
->object
= it
->string
;
8473 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8474 IT_STRING_BYTEPOS (*it
), it
->string
);
8480 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8481 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8484 if (it
->bidi_it
.new_paragraph
)
8485 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
8487 /* Resync the bidi iterator with IT's new position.
8488 FIXME: this doesn't support bidirectional text. */
8489 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8490 bidi_move_to_visually_next (&it
->bidi_it
);
8494 it
->position
= it
->current
.pos
;
8495 it
->object
= it
->w
->contents
;
8496 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8497 IT_BYTEPOS (*it
), Qnil
);
8504 /***********************************************************************
8505 Moving an iterator without producing glyphs
8506 ***********************************************************************/
8508 /* Check if iterator is at a position corresponding to a valid buffer
8509 position after some move_it_ call. */
8511 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8512 ((it)->method != GET_FROM_STRING || IT_STRING_CHARPOS (*it) == 0)
8515 /* Move iterator IT to a specified buffer or X position within one
8516 line on the display without producing glyphs.
8518 OP should be a bit mask including some or all of these bits:
8519 MOVE_TO_X: Stop upon reaching x-position TO_X.
8520 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8521 Regardless of OP's value, stop upon reaching the end of the display line.
8523 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8524 This means, in particular, that TO_X includes window's horizontal
8527 The return value has several possible values that
8528 say what condition caused the scan to stop:
8530 MOVE_POS_MATCH_OR_ZV
8531 - when TO_POS or ZV was reached.
8534 -when TO_X was reached before TO_POS or ZV were reached.
8537 - when we reached the end of the display area and the line must
8541 - when we reached the end of the display area and the line is
8545 - when we stopped at a line end, i.e. a newline or a CR and selective
8548 static enum move_it_result
8549 move_it_in_display_line_to (struct it
*it
,
8550 ptrdiff_t to_charpos
, int to_x
,
8551 enum move_operation_enum op
)
8553 enum move_it_result result
= MOVE_UNDEFINED
;
8554 struct glyph_row
*saved_glyph_row
;
8555 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8556 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8557 void *ppos_data
= NULL
;
8558 bool may_wrap
= false;
8559 enum it_method prev_method
= it
->method
;
8560 ptrdiff_t closest_pos UNINIT
;
8561 ptrdiff_t 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
;
9040 /* If we've processed the newline, make sure this flag is
9041 reset, as it must only be set when the newline itself is
9043 if (result
== MOVE_NEWLINE_OR_CR
)
9044 it
->constrain_row_ascent_descent_p
= false;
9048 prev_method
= it
->method
;
9049 if (it
->method
== GET_FROM_BUFFER
)
9050 prev_pos
= IT_CHARPOS (*it
);
9051 /* The current display element has been consumed. Advance
9053 set_iterator_to_next (it
, true);
9054 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
9055 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
9056 if (IT_CHARPOS (*it
) < to_charpos
)
9057 saw_smaller_pos
= true;
9059 && (op
& MOVE_TO_POS
)
9060 && IT_CHARPOS (*it
) >= to_charpos
9061 && IT_CHARPOS (*it
) < closest_pos
)
9062 closest_pos
= IT_CHARPOS (*it
);
9064 /* Stop if lines are truncated and IT's current x-position is
9065 past the right edge of the window now. */
9066 if (it
->line_wrap
== TRUNCATE
9067 && it
->current_x
>= it
->last_visible_x
)
9069 if (!FRAME_WINDOW_P (it
->f
)
9070 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
9071 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
9072 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
9073 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
9075 bool at_eob_p
= false;
9077 if ((at_eob_p
= !get_next_display_element (it
))
9078 || BUFFER_POS_REACHED_P ()
9079 /* If we are past TO_CHARPOS, but never saw any
9080 character positions smaller than TO_CHARPOS,
9081 return MOVE_POS_MATCH_OR_ZV, like the
9082 unidirectional display did. */
9083 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
9085 && IT_CHARPOS (*it
) > to_charpos
))
9088 && !BUFFER_POS_REACHED_P ()
9089 && !at_eob_p
&& closest_pos
< ZV
)
9091 RESTORE_IT (it
, &ppos_it
, ppos_data
);
9092 if (closest_pos
!= to_charpos
)
9093 move_it_in_display_line_to (it
, closest_pos
, -1,
9096 result
= MOVE_POS_MATCH_OR_ZV
;
9099 if (ITERATOR_AT_END_OF_LINE_P (it
))
9101 result
= MOVE_NEWLINE_OR_CR
;
9105 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
9107 && IT_CHARPOS (*it
) > to_charpos
)
9109 if (closest_pos
< ZV
)
9111 RESTORE_IT (it
, &ppos_it
, ppos_data
);
9112 if (closest_pos
!= to_charpos
)
9113 move_it_in_display_line_to (it
, closest_pos
, -1,
9116 result
= MOVE_POS_MATCH_OR_ZV
;
9119 result
= MOVE_LINE_TRUNCATED
;
9122 #undef IT_RESET_X_ASCENT_DESCENT
9125 #undef BUFFER_POS_REACHED_P
9127 /* If we scanned beyond TO_POS, restore the saved iterator either to
9128 the wrap point (if found), or to atpos/atx location. We decide which
9129 data to use to restore the saved iterator state by their X coordinates,
9130 since buffer positions might increase non-monotonically with screen
9131 coordinates due to bidi reordering. */
9132 if (result
== MOVE_LINE_CONTINUED
9133 && it
->line_wrap
== WORD_WRAP
9135 && ((atpos_it
.sp
>= 0 && wrap_it
.current_x
< atpos_it
.current_x
)
9136 || (atx_it
.sp
>= 0 && wrap_it
.current_x
< atx_it
.current_x
)))
9137 RESTORE_IT (it
, &wrap_it
, wrap_data
);
9138 else if (atpos_it
.sp
>= 0)
9139 RESTORE_IT (it
, &atpos_it
, atpos_data
);
9140 else if (atx_it
.sp
>= 0)
9141 RESTORE_IT (it
, &atx_it
, atx_data
);
9146 bidi_unshelve_cache (atpos_data
, true);
9148 bidi_unshelve_cache (atx_data
, true);
9150 bidi_unshelve_cache (wrap_data
, true);
9152 bidi_unshelve_cache (ppos_data
, true);
9154 /* Restore the iterator settings altered at the beginning of this
9156 it
->glyph_row
= saved_glyph_row
;
9160 /* For external use. */
9162 move_it_in_display_line (struct it
*it
,
9163 ptrdiff_t to_charpos
, int to_x
,
9164 enum move_operation_enum op
)
9166 if (it
->line_wrap
== WORD_WRAP
9167 && (op
& MOVE_TO_X
))
9170 void *save_data
= NULL
;
9173 SAVE_IT (save_it
, *it
, save_data
);
9174 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9175 /* When word-wrap is on, TO_X may lie past the end
9176 of a wrapped line. Then it->current is the
9177 character on the next line, so backtrack to the
9178 space before the wrap point. */
9179 if (skip
== MOVE_LINE_CONTINUED
)
9181 int prev_x
= max (it
->current_x
- 1, 0);
9182 RESTORE_IT (it
, &save_it
, save_data
);
9183 move_it_in_display_line_to
9184 (it
, -1, prev_x
, MOVE_TO_X
);
9187 bidi_unshelve_cache (save_data
, true);
9190 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9194 /* Move IT forward until it satisfies one or more of the criteria in
9195 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9197 OP is a bit-mask that specifies where to stop, and in particular,
9198 which of those four position arguments makes a difference. See the
9199 description of enum move_operation_enum.
9201 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9202 screen line, this function will set IT to the next position that is
9203 displayed to the right of TO_CHARPOS on the screen.
9205 Return the maximum pixel length of any line scanned but never more
9206 than it.last_visible_x. */
9209 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9211 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9212 int line_height
, line_start_x
= 0, reached
= 0;
9213 int max_current_x
= 0;
9214 void *backup_data
= NULL
;
9218 if (op
& MOVE_TO_VPOS
)
9220 /* If no TO_CHARPOS and no TO_X specified, stop at the
9221 start of the line TO_VPOS. */
9222 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9224 if (it
->vpos
== to_vpos
)
9230 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9234 /* TO_VPOS >= 0 means stop at TO_X in the line at
9235 TO_VPOS, or at TO_POS, whichever comes first. */
9236 if (it
->vpos
== to_vpos
)
9242 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9244 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9249 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9251 /* We have reached TO_X but not in the line we want. */
9252 skip
= move_it_in_display_line_to (it
, to_charpos
,
9254 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9262 else if (op
& MOVE_TO_Y
)
9264 struct it it_backup
;
9266 if (it
->line_wrap
== WORD_WRAP
)
9267 SAVE_IT (it_backup
, *it
, backup_data
);
9269 /* TO_Y specified means stop at TO_X in the line containing
9270 TO_Y---or at TO_CHARPOS if this is reached first. The
9271 problem is that we can't really tell whether the line
9272 contains TO_Y before we have completely scanned it, and
9273 this may skip past TO_X. What we do is to first scan to
9276 If TO_X is not specified, use a TO_X of zero. The reason
9277 is to make the outcome of this function more predictable.
9278 If we didn't use TO_X == 0, we would stop at the end of
9279 the line which is probably not what a caller would expect
9281 skip
= move_it_in_display_line_to
9282 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9283 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9285 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9286 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9288 else if (skip
== MOVE_X_REACHED
)
9290 /* If TO_X was reached, we want to know whether TO_Y is
9291 in the line. We know this is the case if the already
9292 scanned glyphs make the line tall enough. Otherwise,
9293 we must check by scanning the rest of the line. */
9294 line_height
= it
->max_ascent
+ it
->max_descent
;
9295 if (to_y
>= it
->current_y
9296 && to_y
< it
->current_y
+ line_height
)
9301 SAVE_IT (it_backup
, *it
, backup_data
);
9302 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9303 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9305 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9306 line_height
= it
->max_ascent
+ it
->max_descent
;
9307 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9309 if (to_y
>= it
->current_y
9310 && to_y
< it
->current_y
+ line_height
)
9312 /* If TO_Y is in this line and TO_X was reached
9313 above, we scanned too far. We have to restore
9314 IT's settings to the ones before skipping. But
9315 keep the more accurate values of max_ascent and
9316 max_descent we've found while skipping the rest
9317 of the line, for the sake of callers, such as
9318 pos_visible_p, that need to know the line
9320 int max_ascent
= it
->max_ascent
;
9321 int max_descent
= it
->max_descent
;
9323 RESTORE_IT (it
, &it_backup
, backup_data
);
9324 it
->max_ascent
= max_ascent
;
9325 it
->max_descent
= max_descent
;
9331 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9337 /* Check whether TO_Y is in this line. */
9338 line_height
= it
->max_ascent
+ it
->max_descent
;
9339 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9341 if (to_y
>= it
->current_y
9342 && to_y
< it
->current_y
+ line_height
)
9344 if (to_y
> it
->current_y
)
9345 max_current_x
= max (it
->current_x
, max_current_x
);
9347 /* When word-wrap is on, TO_X may lie past the end
9348 of a wrapped line. Then it->current is the
9349 character on the next line, so backtrack to the
9350 space before the wrap point. */
9351 if (skip
== MOVE_LINE_CONTINUED
9352 && it
->line_wrap
== WORD_WRAP
)
9354 int prev_x
= max (it
->current_x
- 1, 0);
9355 RESTORE_IT (it
, &it_backup
, backup_data
);
9356 skip
= move_it_in_display_line_to
9357 (it
, -1, prev_x
, MOVE_TO_X
);
9366 max_current_x
= max (it
->current_x
, max_current_x
);
9370 else if (BUFFERP (it
->object
)
9371 && (it
->method
== GET_FROM_BUFFER
9372 || it
->method
== GET_FROM_STRETCH
)
9373 && IT_CHARPOS (*it
) >= to_charpos
9374 /* Under bidi iteration, a call to set_iterator_to_next
9375 can scan far beyond to_charpos if the initial
9376 portion of the next line needs to be reordered. In
9377 that case, give move_it_in_display_line_to another
9380 && it
->bidi_it
.scan_dir
== -1))
9381 skip
= MOVE_POS_MATCH_OR_ZV
;
9383 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9387 case MOVE_POS_MATCH_OR_ZV
:
9388 max_current_x
= max (it
->current_x
, max_current_x
);
9392 case MOVE_NEWLINE_OR_CR
:
9393 max_current_x
= max (it
->current_x
, max_current_x
);
9394 set_iterator_to_next (it
, true);
9395 it
->continuation_lines_width
= 0;
9398 case MOVE_LINE_TRUNCATED
:
9399 max_current_x
= it
->last_visible_x
;
9400 it
->continuation_lines_width
= 0;
9401 reseat_at_next_visible_line_start (it
, false);
9402 if ((op
& MOVE_TO_POS
) != 0
9403 && IT_CHARPOS (*it
) > to_charpos
)
9410 case MOVE_LINE_CONTINUED
:
9411 max_current_x
= it
->last_visible_x
;
9412 /* For continued lines ending in a tab, some of the glyphs
9413 associated with the tab are displayed on the current
9414 line. Since it->current_x does not include these glyphs,
9415 we use it->last_visible_x instead. */
9418 it
->continuation_lines_width
+= it
->last_visible_x
;
9419 /* When moving by vpos, ensure that the iterator really
9420 advances to the next line (bug#847, bug#969). Fixme:
9421 do we need to do this in other circumstances? */
9422 if (it
->current_x
!= it
->last_visible_x
9423 && (op
& MOVE_TO_VPOS
)
9424 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9426 line_start_x
= it
->current_x
+ it
->pixel_width
9427 - it
->last_visible_x
;
9428 if (FRAME_WINDOW_P (it
->f
))
9430 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9431 struct font
*face_font
= face
->font
;
9433 /* When display_line produces a continued line
9434 that ends in a TAB, it skips a tab stop that
9435 is closer than the font's space character
9436 width (see x_produce_glyphs where it produces
9437 the stretch glyph which represents a TAB).
9438 We need to reproduce the same logic here. */
9439 eassert (face_font
);
9442 if (line_start_x
< face_font
->space_width
)
9444 += it
->tab_width
* face_font
->space_width
;
9447 set_iterator_to_next (it
, false);
9451 it
->continuation_lines_width
+= it
->current_x
;
9458 /* Reset/increment for the next run. */
9459 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9460 it
->current_x
= line_start_x
;
9463 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9465 last_height
= it
->max_ascent
+ it
->max_descent
;
9466 it
->max_ascent
= it
->max_descent
= 0;
9471 /* On text terminals, we may stop at the end of a line in the middle
9472 of a multi-character glyph. If the glyph itself is continued,
9473 i.e. it is actually displayed on the next line, don't treat this
9474 stopping point as valid; move to the next line instead (unless
9475 that brings us offscreen). */
9476 if (!FRAME_WINDOW_P (it
->f
)
9478 && IT_CHARPOS (*it
) == to_charpos
9479 && it
->what
== IT_CHARACTER
9481 && it
->line_wrap
== WINDOW_WRAP
9482 && it
->current_x
== it
->last_visible_x
- 1
9485 && it
->w
->window_end_valid
9486 && it
->vpos
< it
->w
->window_end_vpos
)
9488 it
->continuation_lines_width
+= it
->current_x
;
9489 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9490 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9492 last_height
= it
->max_ascent
+ it
->max_descent
;
9496 bidi_unshelve_cache (backup_data
, true);
9498 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9500 return max_current_x
;
9504 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9506 If DY > 0, move IT backward at least that many pixels. DY = 0
9507 means move IT backward to the preceding line start or BEGV. This
9508 function may move over more than DY pixels if IT->current_y - DY
9509 ends up in the middle of a line; in this case IT->current_y will be
9510 set to the top of the line moved to. */
9513 move_it_vertically_backward (struct it
*it
, int dy
)
9517 void *it2data
= NULL
, *it3data
= NULL
;
9518 ptrdiff_t start_pos
;
9520 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9521 ptrdiff_t pos_limit
;
9526 start_pos
= IT_CHARPOS (*it
);
9528 /* Estimate how many newlines we must move back. */
9529 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9530 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9533 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9535 /* Set the iterator's position that many lines back. But don't go
9536 back more than NLINES full screen lines -- this wins a day with
9537 buffers which have very long lines. */
9538 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9539 back_to_previous_visible_line_start (it
);
9541 /* Reseat the iterator here. When moving backward, we don't want
9542 reseat to skip forward over invisible text, set up the iterator
9543 to deliver from overlay strings at the new position etc. So,
9544 use reseat_1 here. */
9545 reseat_1 (it
, it
->current
.pos
, true);
9547 /* We are now surely at a line start. */
9548 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9549 reordering is in effect. */
9550 it
->continuation_lines_width
= 0;
9552 /* Move forward and see what y-distance we moved. First move to the
9553 start of the next line so that we get its height. We need this
9554 height to be able to tell whether we reached the specified
9556 SAVE_IT (it2
, *it
, it2data
);
9557 it2
.max_ascent
= it2
.max_descent
= 0;
9560 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9561 MOVE_TO_POS
| MOVE_TO_VPOS
);
9563 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9564 /* If we are in a display string which starts at START_POS,
9565 and that display string includes a newline, and we are
9566 right after that newline (i.e. at the beginning of a
9567 display line), exit the loop, because otherwise we will
9568 infloop, since move_it_to will see that it is already at
9569 START_POS and will not move. */
9570 || (it2
.method
== GET_FROM_STRING
9571 && IT_CHARPOS (it2
) == start_pos
9572 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9573 eassert (IT_CHARPOS (*it
) >= BEGV
);
9574 SAVE_IT (it3
, it2
, it3data
);
9576 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9577 eassert (IT_CHARPOS (*it
) >= BEGV
);
9578 /* H is the actual vertical distance from the position in *IT
9579 and the starting position. */
9580 h
= it2
.current_y
- it
->current_y
;
9581 /* NLINES is the distance in number of lines. */
9582 nlines
= it2
.vpos
- it
->vpos
;
9584 /* Correct IT's y and vpos position
9585 so that they are relative to the starting point. */
9591 /* DY == 0 means move to the start of the screen line. The
9592 value of nlines is > 0 if continuation lines were involved,
9593 or if the original IT position was at start of a line. */
9594 RESTORE_IT (it
, it
, it2data
);
9596 move_it_by_lines (it
, nlines
);
9597 /* The above code moves us to some position NLINES down,
9598 usually to its first glyph (leftmost in an L2R line), but
9599 that's not necessarily the start of the line, under bidi
9600 reordering. We want to get to the character position
9601 that is immediately after the newline of the previous
9604 && !it
->continuation_lines_width
9605 && !STRINGP (it
->string
)
9606 && IT_CHARPOS (*it
) > BEGV
9607 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9609 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9612 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9613 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9615 bidi_unshelve_cache (it3data
, true);
9619 /* The y-position we try to reach, relative to *IT.
9620 Note that H has been subtracted in front of the if-statement. */
9621 int target_y
= it
->current_y
+ h
- dy
;
9622 int y0
= it3
.current_y
;
9626 RESTORE_IT (&it3
, &it3
, it3data
);
9627 y1
= line_bottom_y (&it3
);
9628 line_height
= y1
- y0
;
9629 RESTORE_IT (it
, it
, it2data
);
9630 /* If we did not reach target_y, try to move further backward if
9631 we can. If we moved too far backward, try to move forward. */
9632 if (target_y
< it
->current_y
9633 /* This is heuristic. In a window that's 3 lines high, with
9634 a line height of 13 pixels each, recentering with point
9635 on the bottom line will try to move -39/2 = 19 pixels
9636 backward. Try to avoid moving into the first line. */
9637 && (it
->current_y
- target_y
9638 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9639 && IT_CHARPOS (*it
) > BEGV
)
9641 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9642 target_y
- it
->current_y
));
9643 dy
= it
->current_y
- target_y
;
9644 goto move_further_back
;
9646 else if (target_y
>= it
->current_y
+ line_height
9647 && IT_CHARPOS (*it
) < ZV
)
9649 /* Should move forward by at least one line, maybe more.
9651 Note: Calling move_it_by_lines can be expensive on
9652 terminal frames, where compute_motion is used (via
9653 vmotion) to do the job, when there are very long lines
9654 and truncate-lines is nil. That's the reason for
9655 treating terminal frames specially here. */
9657 if (!FRAME_WINDOW_P (it
->f
))
9658 move_it_vertically (it
, target_y
- it
->current_y
);
9663 move_it_by_lines (it
, 1);
9665 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9672 /* Move IT by a specified amount of pixel lines DY. DY negative means
9673 move backwards. DY = 0 means move to start of screen line. At the
9674 end, IT will be on the start of a screen line. */
9677 move_it_vertically (struct it
*it
, int dy
)
9680 move_it_vertically_backward (it
, -dy
);
9683 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9684 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9685 MOVE_TO_POS
| MOVE_TO_Y
);
9686 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9688 /* If buffer ends in ZV without a newline, move to the start of
9689 the line to satisfy the post-condition. */
9690 if (IT_CHARPOS (*it
) == ZV
9692 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9693 move_it_by_lines (it
, 0);
9698 /* Move iterator IT past the end of the text line it is in. */
9701 move_it_past_eol (struct it
*it
)
9703 enum move_it_result rc
;
9705 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9706 if (rc
== MOVE_NEWLINE_OR_CR
)
9707 set_iterator_to_next (it
, false);
9711 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9712 negative means move up. DVPOS == 0 means move to the start of the
9715 Optimization idea: If we would know that IT->f doesn't use
9716 a face with proportional font, we could be faster for
9717 truncate-lines nil. */
9720 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9723 /* The commented-out optimization uses vmotion on terminals. This
9724 gives bad results, because elements like it->what, on which
9725 callers such as pos_visible_p rely, aren't updated. */
9726 /* struct position pos;
9727 if (!FRAME_WINDOW_P (it->f))
9729 struct text_pos textpos;
9731 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9732 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9733 reseat (it, textpos, true);
9734 it->vpos += pos.vpos;
9735 it->current_y += pos.vpos;
9741 /* DVPOS == 0 means move to the start of the screen line. */
9742 move_it_vertically_backward (it
, 0);
9743 /* Let next call to line_bottom_y calculate real line height. */
9748 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9749 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9751 /* Only move to the next buffer position if we ended up in a
9752 string from display property, not in an overlay string
9753 (before-string or after-string). That is because the
9754 latter don't conceal the underlying buffer position, so
9755 we can ask to move the iterator to the exact position we
9756 are interested in. Note that, even if we are already at
9757 IT_CHARPOS (*it), the call below is not a no-op, as it
9758 will detect that we are at the end of the string, pop the
9759 iterator, and compute it->current_x and it->hpos
9761 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9762 -1, -1, -1, MOVE_TO_POS
);
9768 void *it2data
= NULL
;
9769 ptrdiff_t start_charpos
, i
;
9771 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9772 bool hit_pos_limit
= false;
9773 ptrdiff_t pos_limit
;
9775 /* Start at the beginning of the screen line containing IT's
9776 position. This may actually move vertically backwards,
9777 in case of overlays, so adjust dvpos accordingly. */
9779 move_it_vertically_backward (it
, 0);
9782 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9783 screen lines, and reseat the iterator there. */
9784 start_charpos
= IT_CHARPOS (*it
);
9785 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9788 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9790 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9791 back_to_previous_visible_line_start (it
);
9792 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9793 hit_pos_limit
= true;
9794 reseat (it
, it
->current
.pos
, true);
9796 /* Move further back if we end up in a string or an image. */
9797 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9799 /* First try to move to start of display line. */
9801 move_it_vertically_backward (it
, 0);
9803 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9805 /* If start of line is still in string or image,
9806 move further back. */
9807 back_to_previous_visible_line_start (it
);
9808 reseat (it
, it
->current
.pos
, true);
9812 it
->current_x
= it
->hpos
= 0;
9814 /* Above call may have moved too far if continuation lines
9815 are involved. Scan forward and see if it did. */
9816 SAVE_IT (it2
, *it
, it2data
);
9817 it2
.vpos
= it2
.current_y
= 0;
9818 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9819 it
->vpos
-= it2
.vpos
;
9820 it
->current_y
-= it2
.current_y
;
9821 it
->current_x
= it
->hpos
= 0;
9823 /* If we moved too far back, move IT some lines forward. */
9824 if (it2
.vpos
> -dvpos
)
9826 int delta
= it2
.vpos
+ dvpos
;
9828 RESTORE_IT (&it2
, &it2
, it2data
);
9829 SAVE_IT (it2
, *it
, it2data
);
9830 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9831 /* Move back again if we got too far ahead. */
9832 if (IT_CHARPOS (*it
) >= start_charpos
)
9833 RESTORE_IT (it
, &it2
, it2data
);
9835 bidi_unshelve_cache (it2data
, true);
9837 else if (hit_pos_limit
&& pos_limit
> BEGV
9838 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9840 /* If we hit the limit, but still didn't make it far enough
9841 back, that means there's a display string with a newline
9842 covering a large chunk of text, and that caused
9843 back_to_previous_visible_line_start try to go too far.
9844 Punish those who commit such atrocities by going back
9845 until we've reached DVPOS, after lifting the limit, which
9846 could make it slow for very long lines. "If it hurts,
9849 RESTORE_IT (it
, it
, it2data
);
9850 for (i
= -dvpos
; i
> 0; --i
)
9852 back_to_previous_visible_line_start (it
);
9855 reseat_1 (it
, it
->current
.pos
, true);
9858 RESTORE_IT (it
, it
, it2data
);
9862 /* Return true if IT points into the middle of a display vector. */
9865 in_display_vector_p (struct it
*it
)
9867 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9868 && it
->current
.dpvec_index
> 0
9869 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9872 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9873 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9874 WINDOW must be a live window and defaults to the selected one. The
9875 return value is a cons of the maximum pixel-width of any text line and
9876 the maximum pixel-height of all text lines.
9878 The optional argument FROM, if non-nil, specifies the first text
9879 position and defaults to the minimum accessible position of the buffer.
9880 If FROM is t, use the minimum accessible position that starts a
9881 non-empty line. TO, if non-nil, specifies the last text position and
9882 defaults to the maximum accessible position of the buffer. If TO is t,
9883 use the maximum accessible position that ends a non-empty line.
9885 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9886 width that can be returned. X-LIMIT nil or omitted, means to use the
9887 pixel-width of WINDOW's body; use this if you want to know how high
9888 WINDOW should be become in order to fit all of its buffer's text with
9889 the width of WINDOW unaltered. Use the maximum width WINDOW may assume
9890 if you intend to change WINDOW's width. In any case, text whose
9891 x-coordinate is beyond X-LIMIT is ignored. Since calculating the width
9892 of long lines can take some time, it's always a good idea to make this
9893 argument as small as possible; in particular, if the buffer contains
9894 long lines that shall be truncated anyway.
9896 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9897 height (excluding the height of the mode- or header-line, if any) that
9898 can be returned. Text lines whose y-coordinate is beyond Y-LIMIT are
9899 ignored. Since calculating the text height of a large buffer can take
9900 some time, it makes sense to specify this argument if the size of the
9901 buffer is large or unknown.
9903 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9904 include the height of the mode- or header-line of WINDOW in the return
9905 value. If it is either the symbol `mode-line' or `header-line', include
9906 only the height of that line, if present, in the return value. If t,
9907 include the height of both, if present, in the return value. */)
9908 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
,
9909 Lisp_Object y_limit
, Lisp_Object mode_and_header_line
)
9911 struct window
*w
= decode_live_window (window
);
9912 Lisp_Object buffer
= w
->contents
;
9915 struct buffer
*old_b
= NULL
;
9916 ptrdiff_t start
, end
, pos
;
9917 struct text_pos startp
;
9918 void *itdata
= NULL
;
9919 int c
, max_x
= 0, max_y
= 0, x
= 0, y
= 0;
9921 CHECK_BUFFER (buffer
);
9922 b
= XBUFFER (buffer
);
9924 if (b
!= current_buffer
)
9926 old_b
= current_buffer
;
9927 set_buffer_internal (b
);
9932 else if (EQ (from
, Qt
))
9935 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9936 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9938 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9943 CHECK_NUMBER_COERCE_MARKER (from
);
9944 start
= min (max (XINT (from
), BEGV
), ZV
);
9949 else if (EQ (to
, Qt
))
9952 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9953 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9955 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9960 CHECK_NUMBER_COERCE_MARKER (to
);
9961 end
= max (start
, min (XINT (to
), ZV
));
9964 if (!NILP (x_limit
) && RANGED_INTEGERP (0, x_limit
, INT_MAX
))
9965 max_x
= XINT (x_limit
);
9969 else if (RANGED_INTEGERP (0, y_limit
, INT_MAX
))
9970 max_y
= XINT (y_limit
);
9972 itdata
= bidi_shelve_cache ();
9973 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9974 start_display (&it
, w
, startp
);
9977 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9980 it
.last_visible_x
= max_x
;
9981 /* Actually, we never want move_it_to stop at to_x. But to make
9982 sure that move_it_in_display_line_to always moves far enough,
9983 we set it to INT_MAX and specify MOVE_TO_X. */
9984 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9985 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9986 /* Don't return more than X-LIMIT. */
9991 /* Subtract height of header-line which was counted automatically by
9993 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
9994 - WINDOW_HEADER_LINE_HEIGHT (w
);
9995 /* Don't return more than Y-LIMIT. */
9999 if (EQ (mode_and_header_line
, Qheader_line
)
10000 || EQ (mode_and_header_line
, Qt
))
10001 /* Re-add height of header-line as requested. */
10002 y
= y
+ WINDOW_HEADER_LINE_HEIGHT (w
);
10004 if (EQ (mode_and_header_line
, Qmode_line
)
10005 || EQ (mode_and_header_line
, Qt
))
10006 /* Add height of mode-line as requested. */
10007 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
10009 bidi_unshelve_cache (itdata
, false);
10012 set_buffer_internal (old_b
);
10014 return Fcons (make_number (x
), make_number (y
));
10017 /***********************************************************************
10019 ***********************************************************************/
10021 /* Return the number of arguments the format string FORMAT needs. */
10024 format_nargs (char const *format
)
10026 ptrdiff_t nargs
= 0;
10027 for (char const *p
= format
; (p
= strchr (p
, '%')); p
++)
10035 /* Add a message with format string FORMAT and formatted arguments
10039 add_to_log (const char *format
, ...)
10042 va_start (ap
, format
);
10043 vadd_to_log (format
, ap
);
10048 vadd_to_log (char const *format
, va_list ap
)
10050 ptrdiff_t form_nargs
= format_nargs (format
);
10051 ptrdiff_t nargs
= 1 + form_nargs
;
10052 Lisp_Object args
[10];
10053 eassert (nargs
<= ARRAYELTS (args
));
10054 AUTO_STRING (args0
, format
);
10056 for (ptrdiff_t i
= 1; i
<= nargs
; i
++)
10057 args
[i
] = va_arg (ap
, Lisp_Object
);
10058 Lisp_Object msg
= Qnil
;
10059 msg
= Fformat_message (nargs
, args
);
10061 ptrdiff_t len
= SBYTES (msg
) + 1;
10063 char *buffer
= SAFE_ALLOCA (len
);
10064 memcpy (buffer
, SDATA (msg
), len
);
10066 message_dolog (buffer
, len
- 1, true, STRING_MULTIBYTE (msg
));
10071 /* Output a newline in the *Messages* buffer if "needs" one. */
10074 message_log_maybe_newline (void)
10076 if (message_log_need_newline
)
10077 message_dolog ("", 0, true, false);
10081 /* Add a string M of length NBYTES to the message log, optionally
10082 terminated with a newline when NLFLAG is true. MULTIBYTE, if
10083 true, means interpret the contents of M as multibyte. This
10084 function calls low-level routines in order to bypass text property
10085 hooks, etc. which might not be safe to run.
10087 This may GC (insert may run before/after change hooks),
10088 so the buffer M must NOT point to a Lisp string. */
10091 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
10093 const unsigned char *msg
= (const unsigned char *) m
;
10095 if (!NILP (Vmemory_full
))
10098 if (!NILP (Vmessage_log_max
))
10100 struct buffer
*oldbuf
;
10101 Lisp_Object oldpoint
, oldbegv
, oldzv
;
10102 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
10103 ptrdiff_t point_at_end
= 0;
10104 ptrdiff_t zv_at_end
= 0;
10105 Lisp_Object old_deactivate_mark
;
10107 old_deactivate_mark
= Vdeactivate_mark
;
10108 oldbuf
= current_buffer
;
10110 /* Ensure the Messages buffer exists, and switch to it.
10111 If we created it, set the major-mode. */
10112 bool newbuffer
= NILP (Fget_buffer (Vmessages_buffer_name
));
10113 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
10115 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
10116 call0 (intern ("messages-buffer-mode"));
10118 bset_undo_list (current_buffer
, Qt
);
10119 bset_cache_long_scans (current_buffer
, Qnil
);
10121 oldpoint
= message_dolog_marker1
;
10122 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
10123 oldbegv
= message_dolog_marker2
;
10124 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
10125 oldzv
= message_dolog_marker3
;
10126 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
10134 BEGV_BYTE
= BEG_BYTE
;
10137 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10139 /* Insert the string--maybe converting multibyte to single byte
10140 or vice versa, so that all the text fits the buffer. */
10142 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10148 /* Convert a multibyte string to single-byte
10149 for the *Message* buffer. */
10150 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
10152 c
= string_char_and_length (msg
+ i
, &char_bytes
);
10153 work
[0] = CHAR_TO_BYTE8 (c
);
10154 insert_1_both (work
, 1, 1, true, false, false);
10157 else if (! multibyte
10158 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10162 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10163 /* Convert a single-byte string to multibyte
10164 for the *Message* buffer. */
10165 for (i
= 0; i
< nbytes
; i
++)
10168 MAKE_CHAR_MULTIBYTE (c
);
10169 char_bytes
= CHAR_STRING (c
, str
);
10170 insert_1_both ((char *) str
, 1, char_bytes
, true, false, false);
10174 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
,
10175 true, false, false);
10179 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
10182 insert_1_both ("\n", 1, 1, true, false, false);
10184 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, false);
10186 this_bol_byte
= PT_BYTE
;
10188 /* See if this line duplicates the previous one.
10189 If so, combine duplicates. */
10190 if (this_bol
> BEG
)
10192 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, false);
10194 prev_bol_byte
= PT_BYTE
;
10196 dups
= message_log_check_duplicate (prev_bol_byte
,
10200 del_range_both (prev_bol
, prev_bol_byte
,
10201 this_bol
, this_bol_byte
, false);
10204 char dupstr
[sizeof " [ times]"
10205 + INT_STRLEN_BOUND (printmax_t
)];
10207 /* If you change this format, don't forget to also
10208 change message_log_check_duplicate. */
10209 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
10210 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
10211 insert_1_both (dupstr
, duplen
, duplen
,
10212 true, false, true);
10217 /* If we have more than the desired maximum number of lines
10218 in the *Messages* buffer now, delete the oldest ones.
10219 This is safe because we don't have undo in this buffer. */
10221 if (NATNUMP (Vmessage_log_max
))
10223 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10224 -XFASTINT (Vmessage_log_max
) - 1, false);
10225 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, false);
10228 BEGV
= marker_position (oldbegv
);
10229 BEGV_BYTE
= marker_byte_position (oldbegv
);
10238 ZV
= marker_position (oldzv
);
10239 ZV_BYTE
= marker_byte_position (oldzv
);
10243 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10245 /* We can't do Fgoto_char (oldpoint) because it will run some
10247 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10248 marker_byte_position (oldpoint
));
10250 unchain_marker (XMARKER (oldpoint
));
10251 unchain_marker (XMARKER (oldbegv
));
10252 unchain_marker (XMARKER (oldzv
));
10254 /* We called insert_1_both above with its 5th argument (PREPARE)
10255 false, which prevents insert_1_both from calling
10256 prepare_to_modify_buffer, which in turns prevents us from
10257 incrementing windows_or_buffers_changed even if *Messages* is
10258 shown in some window. So we must manually set
10259 windows_or_buffers_changed here to make up for that. */
10260 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10261 bset_redisplay (current_buffer
);
10263 set_buffer_internal (oldbuf
);
10265 message_log_need_newline
= !nlflag
;
10266 Vdeactivate_mark
= old_deactivate_mark
;
10271 /* We are at the end of the buffer after just having inserted a newline.
10272 (Note: We depend on the fact we won't be crossing the gap.)
10273 Check to see if the most recent message looks a lot like the previous one.
10274 Return 0 if different, 1 if the new one should just replace it, or a
10275 value N > 1 if we should also append " [N times]". */
10278 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10281 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10282 bool seen_dots
= false;
10283 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10284 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10286 for (i
= 0; i
< len
; i
++)
10288 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10290 if (p1
[i
] != p2
[i
])
10296 if (*p1
++ == ' ' && *p1
++ == '[')
10299 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10300 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10307 /* Display an echo area message M with a specified length of NBYTES
10308 bytes. The string may include null characters. If M is not a
10309 string, clear out any existing message, and let the mini-buffer
10312 This function cancels echoing. */
10315 message3 (Lisp_Object m
)
10317 clear_message (true, true);
10320 /* First flush out any partial line written with print. */
10321 message_log_maybe_newline ();
10324 ptrdiff_t nbytes
= SBYTES (m
);
10325 bool multibyte
= STRING_MULTIBYTE (m
);
10328 SAFE_ALLOCA_STRING (buffer
, m
);
10329 message_dolog (buffer
, nbytes
, true, multibyte
);
10332 if (! inhibit_message
)
10333 message3_nolog (m
);
10336 /* Log the message M to stderr. Log an empty line if M is not a string. */
10339 message_to_stderr (Lisp_Object m
)
10341 if (noninteractive_need_newline
)
10343 noninteractive_need_newline
= false;
10344 fputc ('\n', stderr
);
10348 Lisp_Object coding_system
= Vlocale_coding_system
;
10351 if (!NILP (Vcoding_system_for_write
))
10352 coding_system
= Vcoding_system_for_write
;
10353 if (!NILP (coding_system
))
10354 s
= code_convert_string_norecord (m
, coding_system
, true);
10358 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10360 if (!cursor_in_echo_area
)
10361 fputc ('\n', stderr
);
10365 /* The non-logging version of message3.
10366 This does not cancel echoing, because it is used for echoing.
10367 Perhaps we need to make a separate function for echoing
10368 and make this cancel echoing. */
10371 message3_nolog (Lisp_Object m
)
10373 struct frame
*sf
= SELECTED_FRAME ();
10375 if (FRAME_INITIAL_P (sf
))
10376 message_to_stderr (m
);
10377 /* Error messages get reported properly by cmd_error, so this must be just an
10378 informative message; if the frame hasn't really been initialized yet, just
10380 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10382 /* Get the frame containing the mini-buffer
10383 that the selected frame is using. */
10384 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10385 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10386 struct frame
*f
= XFRAME (frame
);
10388 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10389 Fmake_frame_visible (frame
);
10391 if (STRINGP (m
) && SCHARS (m
) > 0)
10394 if (minibuffer_auto_raise
)
10395 Fraise_frame (frame
);
10396 /* Assume we are not echoing.
10397 (If we are, echo_now will override this.) */
10398 echo_message_buffer
= Qnil
;
10401 clear_message (true, true);
10403 do_pending_window_change (false);
10404 echo_area_display (true);
10405 do_pending_window_change (false);
10406 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10407 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10412 /* Display a null-terminated echo area message M. If M is 0, clear
10413 out any existing message, and let the mini-buffer text show through.
10415 The buffer M must continue to exist until after the echo area gets
10416 cleared or some other message gets displayed there. Do not pass
10417 text that is stored in a Lisp string. Do not pass text in a buffer
10418 that was alloca'd. */
10421 message1 (const char *m
)
10423 message3 (m
? build_unibyte_string (m
) : Qnil
);
10427 /* The non-logging counterpart of message1. */
10430 message1_nolog (const char *m
)
10432 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10435 /* Display a message M which contains a single %s
10436 which gets replaced with STRING. */
10439 message_with_string (const char *m
, Lisp_Object string
, bool log
)
10441 CHECK_STRING (string
);
10444 if (noninteractive
)
10445 need_message
= !!m
;
10446 else if (!INTERACTIVE
)
10447 need_message
= false;
10450 /* The frame whose minibuffer we're going to display the message on.
10451 It may be larger than the selected frame, so we need
10452 to use its buffer, not the selected frame's buffer. */
10453 Lisp_Object mini_window
;
10454 struct frame
*f
, *sf
= SELECTED_FRAME ();
10456 /* Get the frame containing the minibuffer
10457 that the selected frame is using. */
10458 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10459 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10461 /* Error messages get reported properly by cmd_error, so this must be
10462 just an informative message; if the frame hasn't really been
10463 initialized yet, just toss it. */
10464 need_message
= f
->glyphs_initialized_p
;
10469 AUTO_STRING (fmt
, m
);
10470 Lisp_Object msg
= CALLN (Fformat_message
, fmt
, string
);
10472 if (noninteractive
)
10473 message_to_stderr (msg
);
10479 message3_nolog (msg
);
10481 /* Print should start at the beginning of the message
10482 buffer next time. */
10483 message_buf_print
= false;
10489 /* Dump an informative message to the minibuf. If M is 0, clear out
10490 any existing message, and let the mini-buffer text show through.
10492 The message must be safe ASCII and the format must not contain ` or
10493 '. If your message and format do not fit into this category,
10494 convert your arguments to Lisp objects and use Fmessage instead. */
10496 static void ATTRIBUTE_FORMAT_PRINTF (1, 0)
10497 vmessage (const char *m
, va_list ap
)
10499 if (noninteractive
)
10503 if (noninteractive_need_newline
)
10504 putc ('\n', stderr
);
10505 noninteractive_need_newline
= false;
10506 vfprintf (stderr
, m
, ap
);
10507 if (!cursor_in_echo_area
)
10508 fprintf (stderr
, "\n");
10512 else if (INTERACTIVE
)
10514 /* The frame whose mini-buffer we're going to display the message
10515 on. It may be larger than the selected frame, so we need to
10516 use its buffer, not the selected frame's buffer. */
10517 Lisp_Object mini_window
;
10518 struct frame
*f
, *sf
= SELECTED_FRAME ();
10520 /* Get the frame containing the mini-buffer
10521 that the selected frame is using. */
10522 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10523 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10525 /* Error messages get reported properly by cmd_error, so this must be
10526 just an informative message; if the frame hasn't really been
10527 initialized yet, just toss it. */
10528 if (f
->glyphs_initialized_p
)
10533 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10535 char *message_buf
= SAFE_ALLOCA (maxsize
+ 1);
10537 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10539 message3 (make_string (message_buf
, len
));
10545 /* Print should start at the beginning of the message
10546 buffer next time. */
10547 message_buf_print
= false;
10553 message (const char *m
, ...)
10562 /* Display the current message in the current mini-buffer. This is
10563 only called from error handlers in process.c, and is not time
10567 update_echo_area (void)
10569 if (!NILP (echo_area_buffer
[0]))
10571 Lisp_Object string
;
10572 string
= Fcurrent_message ();
10578 /* Make sure echo area buffers in `echo_buffers' are live.
10579 If they aren't, make new ones. */
10582 ensure_echo_area_buffers (void)
10584 for (int i
= 0; i
< 2; i
++)
10585 if (!BUFFERP (echo_buffer
[i
])
10586 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10588 Lisp_Object old_buffer
= echo_buffer
[i
];
10589 static char const name_fmt
[] = " *Echo Area %d*";
10590 char name
[sizeof name_fmt
+ INT_STRLEN_BOUND (int)];
10591 AUTO_STRING_WITH_LEN (lname
, name
, sprintf (name
, name_fmt
, i
));
10592 echo_buffer
[i
] = Fget_buffer_create (lname
);
10593 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10594 /* to force word wrap in echo area -
10595 it was decided to postpone this*/
10596 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10598 for (int j
= 0; j
< 2; j
++)
10599 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10600 echo_area_buffer
[j
] = echo_buffer
[i
];
10605 /* Call FN with args A1..A2 with either the current or last displayed
10606 echo_area_buffer as current buffer.
10608 WHICH zero means use the current message buffer
10609 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10610 from echo_buffer[] and clear it.
10612 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10613 suitable buffer from echo_buffer[] and clear it.
10615 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10616 that the current message becomes the last displayed one, choose a
10617 suitable buffer for echo_area_buffer[0], and clear it.
10619 Value is what FN returns. */
10622 with_echo_area_buffer (struct window
*w
, int which
,
10623 bool (*fn
) (ptrdiff_t, Lisp_Object
),
10624 ptrdiff_t a1
, Lisp_Object a2
)
10626 Lisp_Object buffer
;
10627 bool this_one
, the_other
, clear_buffer_p
, rc
;
10628 ptrdiff_t count
= SPECPDL_INDEX ();
10630 /* If buffers aren't live, make new ones. */
10631 ensure_echo_area_buffers ();
10633 clear_buffer_p
= false;
10636 this_one
= false, the_other
= true;
10637 else if (which
> 0)
10638 this_one
= true, the_other
= false;
10641 this_one
= false, the_other
= true;
10642 clear_buffer_p
= true;
10644 /* We need a fresh one in case the current echo buffer equals
10645 the one containing the last displayed echo area message. */
10646 if (!NILP (echo_area_buffer
[this_one
])
10647 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10648 echo_area_buffer
[this_one
] = Qnil
;
10651 /* Choose a suitable buffer from echo_buffer[] if we don't
10653 if (NILP (echo_area_buffer
[this_one
]))
10655 echo_area_buffer
[this_one
]
10656 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10657 ? echo_buffer
[the_other
]
10658 : echo_buffer
[this_one
]);
10659 clear_buffer_p
= true;
10662 buffer
= echo_area_buffer
[this_one
];
10664 /* Don't get confused by reusing the buffer used for echoing
10665 for a different purpose. */
10666 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10669 record_unwind_protect (unwind_with_echo_area_buffer
,
10670 with_echo_area_buffer_unwind_data (w
));
10672 /* Make the echo area buffer current. Note that for display
10673 purposes, it is not necessary that the displayed window's buffer
10674 == current_buffer, except for text property lookup. So, let's
10675 only set that buffer temporarily here without doing a full
10676 Fset_window_buffer. We must also change w->pointm, though,
10677 because otherwise an assertions in unshow_buffer fails, and Emacs
10679 set_buffer_internal_1 (XBUFFER (buffer
));
10682 wset_buffer (w
, buffer
);
10683 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10684 set_marker_both (w
->old_pointm
, buffer
, BEG
, BEG_BYTE
);
10687 bset_undo_list (current_buffer
, Qt
);
10688 bset_read_only (current_buffer
, Qnil
);
10689 specbind (Qinhibit_read_only
, Qt
);
10690 specbind (Qinhibit_modification_hooks
, Qt
);
10692 if (clear_buffer_p
&& Z
> BEG
)
10693 del_range (BEG
, Z
);
10695 eassert (BEGV
>= BEG
);
10696 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10700 eassert (BEGV
>= BEG
);
10701 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10703 unbind_to (count
, Qnil
);
10708 /* Save state that should be preserved around the call to the function
10709 FN called in with_echo_area_buffer. */
10712 with_echo_area_buffer_unwind_data (struct window
*w
)
10715 Lisp_Object vector
, tmp
;
10717 /* Reduce consing by keeping one vector in
10718 Vwith_echo_area_save_vector. */
10719 vector
= Vwith_echo_area_save_vector
;
10720 Vwith_echo_area_save_vector
= Qnil
;
10723 vector
= Fmake_vector (make_number (11), Qnil
);
10725 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10726 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10727 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10731 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10732 ASET (vector
, i
, w
->contents
); ++i
;
10733 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10734 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10735 ASET (vector
, i
, make_number (marker_position (w
->old_pointm
))); ++i
;
10736 ASET (vector
, i
, make_number (marker_byte_position (w
->old_pointm
))); ++i
;
10737 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10738 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10743 for (; i
< end
; ++i
)
10744 ASET (vector
, i
, Qnil
);
10747 eassert (i
== ASIZE (vector
));
10752 /* Restore global state from VECTOR which was created by
10753 with_echo_area_buffer_unwind_data. */
10756 unwind_with_echo_area_buffer (Lisp_Object vector
)
10758 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10759 Vdeactivate_mark
= AREF (vector
, 1);
10760 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10762 if (WINDOWP (AREF (vector
, 3)))
10765 Lisp_Object buffer
;
10767 w
= XWINDOW (AREF (vector
, 3));
10768 buffer
= AREF (vector
, 4);
10770 wset_buffer (w
, buffer
);
10771 set_marker_both (w
->pointm
, buffer
,
10772 XFASTINT (AREF (vector
, 5)),
10773 XFASTINT (AREF (vector
, 6)));
10774 set_marker_both (w
->old_pointm
, buffer
,
10775 XFASTINT (AREF (vector
, 7)),
10776 XFASTINT (AREF (vector
, 8)));
10777 set_marker_both (w
->start
, buffer
,
10778 XFASTINT (AREF (vector
, 9)),
10779 XFASTINT (AREF (vector
, 10)));
10782 Vwith_echo_area_save_vector
= vector
;
10786 /* Set up the echo area for use by print functions. MULTIBYTE_P
10787 means we will print multibyte. */
10790 setup_echo_area_for_printing (bool multibyte_p
)
10792 /* If we can't find an echo area any more, exit. */
10793 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10794 Fkill_emacs (Qnil
);
10796 ensure_echo_area_buffers ();
10798 if (!message_buf_print
)
10800 /* A message has been output since the last time we printed.
10801 Choose a fresh echo area buffer. */
10802 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10803 echo_area_buffer
[0] = echo_buffer
[1];
10805 echo_area_buffer
[0] = echo_buffer
[0];
10807 /* Switch to that buffer and clear it. */
10808 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10809 bset_truncate_lines (current_buffer
, Qnil
);
10813 ptrdiff_t count
= SPECPDL_INDEX ();
10814 specbind (Qinhibit_read_only
, Qt
);
10815 /* Note that undo recording is always disabled. */
10816 del_range (BEG
, Z
);
10817 unbind_to (count
, Qnil
);
10819 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10821 /* Set up the buffer for the multibyteness we need. */
10823 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10824 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10826 /* Raise the frame containing the echo area. */
10827 if (minibuffer_auto_raise
)
10829 struct frame
*sf
= SELECTED_FRAME ();
10830 Lisp_Object mini_window
;
10831 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10832 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10835 message_log_maybe_newline ();
10836 message_buf_print
= true;
10840 if (NILP (echo_area_buffer
[0]))
10842 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10843 echo_area_buffer
[0] = echo_buffer
[1];
10845 echo_area_buffer
[0] = echo_buffer
[0];
10848 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10850 /* Someone switched buffers between print requests. */
10851 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10852 bset_truncate_lines (current_buffer
, Qnil
);
10858 /* Display an echo area message in window W. Value is true if W's
10859 height is changed. If display_last_displayed_message_p,
10860 display the message that was last displayed, otherwise
10861 display the current message. */
10864 display_echo_area (struct window
*w
)
10866 bool no_message_p
, window_height_changed_p
;
10868 /* Temporarily disable garbage collections while displaying the echo
10869 area. This is done because a GC can print a message itself.
10870 That message would modify the echo area buffer's contents while a
10871 redisplay of the buffer is going on, and seriously confuse
10873 ptrdiff_t count
= inhibit_garbage_collection ();
10875 /* If there is no message, we must call display_echo_area_1
10876 nevertheless because it resizes the window. But we will have to
10877 reset the echo_area_buffer in question to nil at the end because
10878 with_echo_area_buffer will sets it to an empty buffer. */
10879 bool i
= display_last_displayed_message_p
;
10880 /* According to the C99, C11 and C++11 standards, the integral value
10881 of a "bool" is always 0 or 1, so this array access is safe here,
10883 no_message_p
= NILP (echo_area_buffer
[i
]);
10885 window_height_changed_p
10886 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10887 display_echo_area_1
,
10888 (intptr_t) w
, Qnil
);
10891 echo_area_buffer
[i
] = Qnil
;
10893 unbind_to (count
, Qnil
);
10894 return window_height_changed_p
;
10898 /* Helper for display_echo_area. Display the current buffer which
10899 contains the current echo area message in window W, a mini-window,
10900 a pointer to which is passed in A1. A2..A4 are currently not used.
10901 Change the height of W so that all of the message is displayed.
10902 Value is true if height of W was changed. */
10905 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10908 struct window
*w
= (struct window
*) i1
;
10909 Lisp_Object window
;
10910 struct text_pos start
;
10912 /* We are about to enter redisplay without going through
10913 redisplay_internal, so we need to forget these faces by hand
10915 forget_escape_and_glyphless_faces ();
10917 /* Do this before displaying, so that we have a large enough glyph
10918 matrix for the display. If we can't get enough space for the
10919 whole text, display the last N lines. That works by setting w->start. */
10920 bool window_height_changed_p
= resize_mini_window (w
, false);
10922 /* Use the starting position chosen by resize_mini_window. */
10923 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10926 clear_glyph_matrix (w
->desired_matrix
);
10927 XSETWINDOW (window
, w
);
10928 try_window (window
, start
, 0);
10930 return window_height_changed_p
;
10934 /* Resize the echo area window to exactly the size needed for the
10935 currently displayed message, if there is one. If a mini-buffer
10936 is active, don't shrink it. */
10939 resize_echo_area_exactly (void)
10941 if (BUFFERP (echo_area_buffer
[0])
10942 && WINDOWP (echo_area_window
))
10944 struct window
*w
= XWINDOW (echo_area_window
);
10945 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10946 bool resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10947 (intptr_t) w
, resize_exactly
);
10950 windows_or_buffers_changed
= 42;
10951 update_mode_lines
= 30;
10952 redisplay_internal ();
10958 /* Callback function for with_echo_area_buffer, when used from
10959 resize_echo_area_exactly. A1 contains a pointer to the window to
10960 resize, EXACTLY non-nil means resize the mini-window exactly to the
10961 size of the text displayed. A3 and A4 are not used. Value is what
10962 resize_mini_window returns. */
10965 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10968 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10972 /* Resize mini-window W to fit the size of its contents. EXACT_P
10973 means size the window exactly to the size needed. Otherwise, it's
10974 only enlarged until W's buffer is empty.
10976 Set W->start to the right place to begin display. If the whole
10977 contents fit, start at the beginning. Otherwise, start so as
10978 to make the end of the contents appear. This is particularly
10979 important for y-or-n-p, but seems desirable generally.
10981 Value is true if the window height has been changed. */
10984 resize_mini_window (struct window
*w
, bool exact_p
)
10986 struct frame
*f
= XFRAME (w
->frame
);
10987 bool window_height_changed_p
= false;
10989 eassert (MINI_WINDOW_P (w
));
10991 /* By default, start display at the beginning. */
10992 set_marker_both (w
->start
, w
->contents
,
10993 BUF_BEGV (XBUFFER (w
->contents
)),
10994 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10996 /* Don't resize windows while redisplaying a window; it would
10997 confuse redisplay functions when the size of the window they are
10998 displaying changes from under them. Such a resizing can happen,
10999 for instance, when which-func prints a long message while
11000 we are running fontification-functions. We're running these
11001 functions with safe_call which binds inhibit-redisplay to t. */
11002 if (!NILP (Vinhibit_redisplay
))
11005 /* Nil means don't try to resize. */
11006 if (NILP (Vresize_mini_windows
)
11007 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
11010 if (!FRAME_MINIBUF_ONLY_P (f
))
11013 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
11014 + WINDOW_PIXEL_HEIGHT (w
));
11015 int unit
= FRAME_LINE_HEIGHT (f
);
11016 int height
, max_height
;
11017 struct text_pos start
;
11018 struct buffer
*old_current_buffer
= NULL
;
11020 if (current_buffer
!= XBUFFER (w
->contents
))
11022 old_current_buffer
= current_buffer
;
11023 set_buffer_internal (XBUFFER (w
->contents
));
11026 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
11028 /* Compute the max. number of lines specified by the user. */
11029 if (FLOATP (Vmax_mini_window_height
))
11030 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
11031 else if (INTEGERP (Vmax_mini_window_height
))
11032 max_height
= XINT (Vmax_mini_window_height
) * unit
;
11034 max_height
= total_height
/ 4;
11036 /* Correct that max. height if it's bogus. */
11037 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
11039 /* Find out the height of the text in the window. */
11040 if (it
.line_wrap
== TRUNCATE
)
11045 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
11046 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
11047 height
= it
.current_y
+ last_height
;
11049 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
11050 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
11053 /* Compute a suitable window start. */
11054 if (height
> max_height
)
11056 height
= (max_height
/ unit
) * unit
;
11057 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
11058 move_it_vertically_backward (&it
, height
- unit
);
11059 start
= it
.current
.pos
;
11062 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
11063 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
11065 if (EQ (Vresize_mini_windows
, Qgrow_only
))
11067 /* Let it grow only, until we display an empty message, in which
11068 case the window shrinks again. */
11069 if (height
> WINDOW_PIXEL_HEIGHT (w
))
11071 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11073 FRAME_WINDOWS_FROZEN (f
) = true;
11074 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
11075 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11077 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
11078 && (exact_p
|| BEGV
== ZV
))
11080 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11082 FRAME_WINDOWS_FROZEN (f
) = false;
11083 shrink_mini_window (w
, true);
11084 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11089 /* Always resize to exact size needed. */
11090 if (height
> WINDOW_PIXEL_HEIGHT (w
))
11092 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11094 FRAME_WINDOWS_FROZEN (f
) = true;
11095 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
11096 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11098 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
11100 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11102 FRAME_WINDOWS_FROZEN (f
) = false;
11103 shrink_mini_window (w
, true);
11107 FRAME_WINDOWS_FROZEN (f
) = true;
11108 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
11111 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11115 if (old_current_buffer
)
11116 set_buffer_internal (old_current_buffer
);
11119 return window_height_changed_p
;
11123 /* Value is the current message, a string, or nil if there is no
11124 current message. */
11127 current_message (void)
11131 if (!BUFFERP (echo_area_buffer
[0]))
11135 with_echo_area_buffer (0, 0, current_message_1
,
11136 (intptr_t) &msg
, Qnil
);
11138 echo_area_buffer
[0] = Qnil
;
11146 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
11149 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
11152 *msg
= make_buffer_string (BEG
, Z
, true);
11159 /* Push the current message on Vmessage_stack for later restoration
11160 by restore_message. Value is true if the current message isn't
11161 empty. This is a relatively infrequent operation, so it's not
11162 worth optimizing. */
11165 push_message (void)
11167 Lisp_Object msg
= current_message ();
11168 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
11169 return STRINGP (msg
);
11173 /* Restore message display from the top of Vmessage_stack. */
11176 restore_message (void)
11178 eassert (CONSP (Vmessage_stack
));
11179 message3_nolog (XCAR (Vmessage_stack
));
11183 /* Handler for unwind-protect calling pop_message. */
11186 pop_message_unwind (void)
11188 /* Pop the top-most entry off Vmessage_stack. */
11189 eassert (CONSP (Vmessage_stack
));
11190 Vmessage_stack
= XCDR (Vmessage_stack
);
11194 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11195 exits. If the stack is not empty, we have a missing pop_message
11199 check_message_stack (void)
11201 if (!NILP (Vmessage_stack
))
11206 /* Truncate to NCHARS what will be displayed in the echo area the next
11207 time we display it---but don't redisplay it now. */
11210 truncate_echo_area (ptrdiff_t nchars
)
11213 echo_area_buffer
[0] = Qnil
;
11214 else if (!noninteractive
11216 && !NILP (echo_area_buffer
[0]))
11218 struct frame
*sf
= SELECTED_FRAME ();
11219 /* Error messages get reported properly by cmd_error, so this must be
11220 just an informative message; if the frame hasn't really been
11221 initialized yet, just toss it. */
11222 if (sf
->glyphs_initialized_p
)
11223 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11228 /* Helper function for truncate_echo_area. Truncate the current
11229 message to at most NCHARS characters. */
11232 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11234 if (BEG
+ nchars
< Z
)
11235 del_range (BEG
+ nchars
, Z
);
11237 echo_area_buffer
[0] = Qnil
;
11241 /* Set the current message to STRING. */
11244 set_message (Lisp_Object string
)
11246 eassert (STRINGP (string
));
11248 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11250 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11251 message_buf_print
= false;
11252 help_echo_showing_p
= false;
11254 if (STRINGP (Vdebug_on_message
)
11255 && STRINGP (string
)
11256 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11257 call_debugger (list2 (Qerror
, string
));
11261 /* Helper function for set_message. First argument is ignored and second
11262 argument has the same meaning as for set_message.
11263 This function is called with the echo area buffer being current. */
11266 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11268 eassert (STRINGP (string
));
11270 /* Change multibyteness of the echo buffer appropriately. */
11271 if (message_enable_multibyte
11272 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11273 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11275 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11276 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11277 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11279 /* Insert new message at BEG. */
11280 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11282 /* This function takes care of single/multibyte conversion.
11283 We just have to ensure that the echo area buffer has the right
11284 setting of enable_multibyte_characters. */
11285 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), true);
11291 /* Clear messages. CURRENT_P means clear the current message.
11292 LAST_DISPLAYED_P means clear the message last displayed. */
11295 clear_message (bool current_p
, bool last_displayed_p
)
11299 echo_area_buffer
[0] = Qnil
;
11300 message_cleared_p
= true;
11303 if (last_displayed_p
)
11304 echo_area_buffer
[1] = Qnil
;
11306 message_buf_print
= false;
11309 /* Clear garbaged frames.
11311 This function is used where the old redisplay called
11312 redraw_garbaged_frames which in turn called redraw_frame which in
11313 turn called clear_frame. The call to clear_frame was a source of
11314 flickering. I believe a clear_frame is not necessary. It should
11315 suffice in the new redisplay to invalidate all current matrices,
11316 and ensure a complete redisplay of all windows. */
11319 clear_garbaged_frames (void)
11321 if (frame_garbaged
)
11323 Lisp_Object tail
, frame
;
11324 struct frame
*sf
= SELECTED_FRAME ();
11326 FOR_EACH_FRAME (tail
, frame
)
11328 struct frame
*f
= XFRAME (frame
);
11330 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11333 /* It makes no sense to redraw a non-selected TTY
11334 frame, since that will actually clear the
11335 selected frame, and might leave the selected
11336 frame with corrupted display, if it happens not
11337 to be marked garbaged. */
11338 && !(f
!= sf
&& (FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))))
11341 clear_current_matrices (f
);
11342 fset_redisplay (f
);
11343 f
->garbaged
= false;
11344 f
->resized_p
= false;
11348 frame_garbaged
= false;
11353 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P, update
11357 echo_area_display (bool update_frame_p
)
11359 Lisp_Object mini_window
;
11362 bool window_height_changed_p
= false;
11363 struct frame
*sf
= SELECTED_FRAME ();
11365 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11366 w
= XWINDOW (mini_window
);
11367 f
= XFRAME (WINDOW_FRAME (w
));
11369 /* Don't display if frame is invisible or not yet initialized. */
11370 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11373 #ifdef HAVE_WINDOW_SYSTEM
11374 /* When Emacs starts, selected_frame may be the initial terminal
11375 frame. If we let this through, a message would be displayed on
11377 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11379 #endif /* HAVE_WINDOW_SYSTEM */
11381 /* Redraw garbaged frames. */
11382 clear_garbaged_frames ();
11384 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11386 echo_area_window
= mini_window
;
11387 window_height_changed_p
= display_echo_area (w
);
11388 w
->must_be_updated_p
= true;
11390 /* Update the display, unless called from redisplay_internal.
11391 Also don't update the screen during redisplay itself. The
11392 update will happen at the end of redisplay, and an update
11393 here could cause confusion. */
11394 if (update_frame_p
&& !redisplaying_p
)
11398 /* If the display update has been interrupted by pending
11399 input, update mode lines in the frame. Due to the
11400 pending input, it might have been that redisplay hasn't
11401 been called, so that mode lines above the echo area are
11402 garbaged. This looks odd, so we prevent it here. */
11403 if (!display_completed
)
11404 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11406 if (window_height_changed_p
11407 /* Don't do this if Emacs is shutting down. Redisplay
11408 needs to run hooks. */
11409 && !NILP (Vrun_hooks
))
11411 /* Must update other windows. Likewise as in other
11412 cases, don't let this update be interrupted by
11414 ptrdiff_t count
= SPECPDL_INDEX ();
11415 specbind (Qredisplay_dont_pause
, Qt
);
11416 fset_redisplay (f
);
11417 redisplay_internal ();
11418 unbind_to (count
, Qnil
);
11420 else if (FRAME_WINDOW_P (f
) && n
== 0)
11422 /* Window configuration is the same as before.
11423 Can do with a display update of the echo area,
11424 unless we displayed some mode lines. */
11425 update_single_window (w
);
11429 update_frame (f
, true, true);
11431 /* If cursor is in the echo area, make sure that the next
11432 redisplay displays the minibuffer, so that the cursor will
11433 be replaced with what the minibuffer wants. */
11434 if (cursor_in_echo_area
)
11435 wset_redisplay (XWINDOW (mini_window
));
11438 else if (!EQ (mini_window
, selected_window
))
11439 wset_redisplay (XWINDOW (mini_window
));
11441 /* Last displayed message is now the current message. */
11442 echo_area_buffer
[1] = echo_area_buffer
[0];
11443 /* Inform read_char that we're not echoing. */
11444 echo_message_buffer
= Qnil
;
11446 /* Prevent redisplay optimization in redisplay_internal by resetting
11447 this_line_start_pos. This is done because the mini-buffer now
11448 displays the message instead of its buffer text. */
11449 if (EQ (mini_window
, selected_window
))
11450 CHARPOS (this_line_start_pos
) = 0;
11452 if (window_height_changed_p
)
11454 fset_redisplay (f
);
11456 /* If window configuration was changed, frames may have been
11457 marked garbaged. Clear them or we will experience
11458 surprises wrt scrolling.
11459 FIXME: How/why/when? */
11460 clear_garbaged_frames ();
11464 /* True if W's buffer was changed but not saved. */
11467 window_buffer_changed (struct window
*w
)
11469 struct buffer
*b
= XBUFFER (w
->contents
);
11471 eassert (BUFFER_LIVE_P (b
));
11473 return (BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
;
11476 /* True if W has %c in its mode line and mode line should be updated. */
11479 mode_line_update_needed (struct window
*w
)
11481 return (w
->column_number_displayed
!= -1
11482 && !(PT
== w
->last_point
&& !window_outdated (w
))
11483 && (w
->column_number_displayed
!= current_column ()));
11486 /* True if window start of W is frozen and may not be changed during
11490 window_frozen_p (struct window
*w
)
11492 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11494 Lisp_Object window
;
11496 XSETWINDOW (window
, w
);
11497 if (MINI_WINDOW_P (w
))
11499 else if (EQ (window
, selected_window
))
11501 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11502 && EQ (window
, Vminibuf_scroll_window
))
11503 /* This special window can't be frozen too. */
11511 /***********************************************************************
11512 Mode Lines and Frame Titles
11513 ***********************************************************************/
11515 /* A buffer for constructing non-propertized mode-line strings and
11516 frame titles in it; allocated from the heap in init_xdisp and
11517 resized as needed in store_mode_line_noprop_char. */
11519 static char *mode_line_noprop_buf
;
11521 /* The buffer's end, and a current output position in it. */
11523 static char *mode_line_noprop_buf_end
;
11524 static char *mode_line_noprop_ptr
;
11526 #define MODE_LINE_NOPROP_LEN(start) \
11527 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11530 MODE_LINE_DISPLAY
= 0,
11534 } mode_line_target
;
11536 /* Alist that caches the results of :propertize.
11537 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11538 static Lisp_Object mode_line_proptrans_alist
;
11540 /* List of strings making up the mode-line. */
11541 static Lisp_Object mode_line_string_list
;
11543 /* Base face property when building propertized mode line string. */
11544 static Lisp_Object mode_line_string_face
;
11545 static Lisp_Object mode_line_string_face_prop
;
11548 /* Unwind data for mode line strings */
11550 static Lisp_Object Vmode_line_unwind_vector
;
11553 format_mode_line_unwind_data (struct frame
*target_frame
,
11554 struct buffer
*obuf
,
11556 bool save_proptrans
)
11558 Lisp_Object vector
, tmp
;
11560 /* Reduce consing by keeping one vector in
11561 Vwith_echo_area_save_vector. */
11562 vector
= Vmode_line_unwind_vector
;
11563 Vmode_line_unwind_vector
= Qnil
;
11566 vector
= Fmake_vector (make_number (10), Qnil
);
11568 ASET (vector
, 0, make_number (mode_line_target
));
11569 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11570 ASET (vector
, 2, mode_line_string_list
);
11571 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11572 ASET (vector
, 4, mode_line_string_face
);
11573 ASET (vector
, 5, mode_line_string_face_prop
);
11576 XSETBUFFER (tmp
, obuf
);
11579 ASET (vector
, 6, tmp
);
11580 ASET (vector
, 7, owin
);
11583 /* Similarly to `with-selected-window', if the operation selects
11584 a window on another frame, we must restore that frame's
11585 selected window, and (for a tty) the top-frame. */
11586 ASET (vector
, 8, target_frame
->selected_window
);
11587 if (FRAME_TERMCAP_P (target_frame
))
11588 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11595 unwind_format_mode_line (Lisp_Object vector
)
11597 Lisp_Object old_window
= AREF (vector
, 7);
11598 Lisp_Object target_frame_window
= AREF (vector
, 8);
11599 Lisp_Object old_top_frame
= AREF (vector
, 9);
11601 mode_line_target
= XINT (AREF (vector
, 0));
11602 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11603 mode_line_string_list
= AREF (vector
, 2);
11604 if (! EQ (AREF (vector
, 3), Qt
))
11605 mode_line_proptrans_alist
= AREF (vector
, 3);
11606 mode_line_string_face
= AREF (vector
, 4);
11607 mode_line_string_face_prop
= AREF (vector
, 5);
11609 /* Select window before buffer, since it may change the buffer. */
11610 if (!NILP (old_window
))
11612 /* If the operation that we are unwinding had selected a window
11613 on a different frame, reset its frame-selected-window. For a
11614 text terminal, reset its top-frame if necessary. */
11615 if (!NILP (target_frame_window
))
11618 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11620 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11621 Fselect_window (target_frame_window
, Qt
);
11623 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11624 Fselect_frame (old_top_frame
, Qt
);
11627 Fselect_window (old_window
, Qt
);
11630 if (!NILP (AREF (vector
, 6)))
11632 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11633 ASET (vector
, 6, Qnil
);
11636 Vmode_line_unwind_vector
= vector
;
11640 /* Store a single character C for the frame title in mode_line_noprop_buf.
11641 Re-allocate mode_line_noprop_buf if necessary. */
11644 store_mode_line_noprop_char (char c
)
11646 /* If output position has reached the end of the allocated buffer,
11647 increase the buffer's size. */
11648 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11650 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11651 ptrdiff_t size
= len
;
11652 mode_line_noprop_buf
=
11653 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11654 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11655 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11658 *mode_line_noprop_ptr
++ = c
;
11662 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11663 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11664 characters that yield more columns than PRECISION; PRECISION <= 0
11665 means copy the whole string. Pad with spaces until FIELD_WIDTH
11666 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11667 pad. Called from display_mode_element when it is used to build a
11671 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11673 const unsigned char *str
= (const unsigned char *) string
;
11675 ptrdiff_t dummy
, nbytes
;
11677 /* Copy at most PRECISION chars from STR. */
11678 nbytes
= strlen (string
);
11679 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11681 store_mode_line_noprop_char (*str
++);
11683 /* Fill up with spaces until FIELD_WIDTH reached. */
11684 while (field_width
> 0
11685 && n
< field_width
)
11687 store_mode_line_noprop_char (' ');
11694 /***********************************************************************
11696 ***********************************************************************/
11698 #ifdef HAVE_WINDOW_SYSTEM
11700 /* Set the title of FRAME, if it has changed. The title format is
11701 Vicon_title_format if FRAME is iconified, otherwise it is
11702 frame_title_format. */
11705 x_consider_frame_title (Lisp_Object frame
)
11707 struct frame
*f
= XFRAME (frame
);
11709 if ((FRAME_WINDOW_P (f
)
11710 || FRAME_MINIBUF_ONLY_P (f
)
11711 || f
->explicit_name
)
11712 && NILP (Fframe_parameter (frame
, Qtooltip
)))
11714 /* Do we have more than one visible frame on this X display? */
11715 Lisp_Object tail
, other_frame
, fmt
;
11716 ptrdiff_t title_start
;
11720 ptrdiff_t count
= SPECPDL_INDEX ();
11722 FOR_EACH_FRAME (tail
, other_frame
)
11724 struct frame
*tf
= XFRAME (other_frame
);
11727 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11728 && !FRAME_MINIBUF_ONLY_P (tf
)
11729 && !EQ (other_frame
, tip_frame
)
11730 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11734 /* Set global variable indicating that multiple frames exist. */
11735 multiple_frames
= CONSP (tail
);
11737 /* Switch to the buffer of selected window of the frame. Set up
11738 mode_line_target so that display_mode_element will output into
11739 mode_line_noprop_buf; then display the title. */
11740 record_unwind_protect (unwind_format_mode_line
,
11741 format_mode_line_unwind_data
11742 (f
, current_buffer
, selected_window
, false));
11744 Fselect_window (f
->selected_window
, Qt
);
11745 set_buffer_internal_1
11746 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11747 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11749 mode_line_target
= MODE_LINE_TITLE
;
11750 title_start
= MODE_LINE_NOPROP_LEN (0);
11751 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11752 NULL
, DEFAULT_FACE_ID
);
11753 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, false);
11754 len
= MODE_LINE_NOPROP_LEN (title_start
);
11755 title
= mode_line_noprop_buf
+ title_start
;
11756 unbind_to (count
, Qnil
);
11758 /* Set the title only if it's changed. This avoids consing in
11759 the common case where it hasn't. (If it turns out that we've
11760 already wasted too much time by walking through the list with
11761 display_mode_element, then we might need to optimize at a
11762 higher level than this.) */
11763 if (! STRINGP (f
->name
)
11764 || SBYTES (f
->name
) != len
11765 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11766 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11770 #endif /* not HAVE_WINDOW_SYSTEM */
11773 /***********************************************************************
11775 ***********************************************************************/
11777 /* True if we will not redisplay all visible windows. */
11778 #define REDISPLAY_SOME_P() \
11779 ((windows_or_buffers_changed == 0 \
11780 || windows_or_buffers_changed == REDISPLAY_SOME) \
11781 && (update_mode_lines == 0 \
11782 || update_mode_lines == REDISPLAY_SOME))
11784 /* Prepare for redisplay by updating menu-bar item lists when
11785 appropriate. This can call eval. */
11788 prepare_menu_bars (void)
11790 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11791 bool some_windows
= REDISPLAY_SOME_P ();
11792 Lisp_Object tooltip_frame
;
11794 #ifdef HAVE_WINDOW_SYSTEM
11795 tooltip_frame
= tip_frame
;
11797 tooltip_frame
= Qnil
;
11800 if (FUNCTIONP (Vpre_redisplay_function
))
11802 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11803 if (all_windows
&& some_windows
)
11805 Lisp_Object ws
= window_list ();
11806 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11808 Lisp_Object
this = XCAR (ws
);
11809 struct window
*w
= XWINDOW (this);
11811 || XFRAME (w
->frame
)->redisplay
11812 || XBUFFER (w
->contents
)->text
->redisplay
)
11814 windows
= Fcons (this, windows
);
11818 safe__call1 (true, Vpre_redisplay_function
, windows
);
11821 /* Update all frame titles based on their buffer names, etc. We do
11822 this before the menu bars so that the buffer-menu will show the
11823 up-to-date frame titles. */
11824 #ifdef HAVE_WINDOW_SYSTEM
11827 Lisp_Object tail
, frame
;
11829 FOR_EACH_FRAME (tail
, frame
)
11831 struct frame
*f
= XFRAME (frame
);
11832 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11836 && !XBUFFER (w
->contents
)->text
->redisplay
)
11839 if (!EQ (frame
, tooltip_frame
)
11840 && (FRAME_ICONIFIED_P (f
)
11841 || FRAME_VISIBLE_P (f
) == 1
11842 /* Exclude TTY frames that are obscured because they
11843 are not the top frame on their console. This is
11844 because x_consider_frame_title actually switches
11845 to the frame, which for TTY frames means it is
11846 marked as garbaged, and will be completely
11847 redrawn on the next redisplay cycle. This causes
11848 TTY frames to be completely redrawn, when there
11849 are more than one of them, even though nothing
11850 should be changed on display. */
11851 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11852 x_consider_frame_title (frame
);
11855 #endif /* HAVE_WINDOW_SYSTEM */
11857 /* Update the menu bar item lists, if appropriate. This has to be
11858 done before any actual redisplay or generation of display lines. */
11862 Lisp_Object tail
, frame
;
11863 ptrdiff_t count
= SPECPDL_INDEX ();
11864 /* True means that update_menu_bar has run its hooks
11865 so any further calls to update_menu_bar shouldn't do so again. */
11866 bool menu_bar_hooks_run
= false;
11868 record_unwind_save_match_data ();
11870 FOR_EACH_FRAME (tail
, frame
)
11872 struct frame
*f
= XFRAME (frame
);
11873 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11875 /* Ignore tooltip frame. */
11876 if (EQ (frame
, tooltip_frame
))
11882 && !XBUFFER (w
->contents
)->text
->redisplay
)
11885 run_window_size_change_functions (frame
);
11886 menu_bar_hooks_run
= update_menu_bar (f
, false, menu_bar_hooks_run
);
11887 #ifdef HAVE_WINDOW_SYSTEM
11888 update_tool_bar (f
, false);
11892 unbind_to (count
, Qnil
);
11896 struct frame
*sf
= SELECTED_FRAME ();
11897 update_menu_bar (sf
, true, false);
11898 #ifdef HAVE_WINDOW_SYSTEM
11899 update_tool_bar (sf
, true);
11905 /* Update the menu bar item list for frame F. This has to be done
11906 before we start to fill in any display lines, because it can call
11909 If SAVE_MATCH_DATA, we must save and restore it here.
11911 If HOOKS_RUN, a previous call to update_menu_bar
11912 already ran the menu bar hooks for this redisplay, so there
11913 is no need to run them again. The return value is the
11914 updated value of this flag, to pass to the next call. */
11917 update_menu_bar (struct frame
*f
, bool save_match_data
, bool hooks_run
)
11919 Lisp_Object window
;
11922 /* If called recursively during a menu update, do nothing. This can
11923 happen when, for instance, an activate-menubar-hook causes a
11925 if (inhibit_menubar_update
)
11928 window
= FRAME_SELECTED_WINDOW (f
);
11929 w
= XWINDOW (window
);
11931 if (FRAME_WINDOW_P (f
)
11933 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11934 || defined (HAVE_NS) || defined (USE_GTK)
11935 FRAME_EXTERNAL_MENU_BAR (f
)
11937 FRAME_MENU_BAR_LINES (f
) > 0
11939 : FRAME_MENU_BAR_LINES (f
) > 0)
11941 /* If the user has switched buffers or windows, we need to
11942 recompute to reflect the new bindings. But we'll
11943 recompute when update_mode_lines is set too; that means
11944 that people can use force-mode-line-update to request
11945 that the menu bar be recomputed. The adverse effect on
11946 the rest of the redisplay algorithm is about the same as
11947 windows_or_buffers_changed anyway. */
11948 if (windows_or_buffers_changed
11949 /* This used to test w->update_mode_line, but we believe
11950 there is no need to recompute the menu in that case. */
11951 || update_mode_lines
11952 || window_buffer_changed (w
))
11954 struct buffer
*prev
= current_buffer
;
11955 ptrdiff_t count
= SPECPDL_INDEX ();
11957 specbind (Qinhibit_menubar_update
, Qt
);
11959 set_buffer_internal_1 (XBUFFER (w
->contents
));
11960 if (save_match_data
)
11961 record_unwind_save_match_data ();
11962 if (NILP (Voverriding_local_map_menu_flag
))
11964 specbind (Qoverriding_terminal_local_map
, Qnil
);
11965 specbind (Qoverriding_local_map
, Qnil
);
11970 /* Run the Lucid hook. */
11971 safe_run_hooks (Qactivate_menubar_hook
);
11973 /* If it has changed current-menubar from previous value,
11974 really recompute the menu-bar from the value. */
11975 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11976 call0 (Qrecompute_lucid_menubar
);
11978 safe_run_hooks (Qmenu_bar_update_hook
);
11983 XSETFRAME (Vmenu_updating_frame
, f
);
11984 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11986 /* Redisplay the menu bar in case we changed it. */
11987 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11988 || defined (HAVE_NS) || defined (USE_GTK)
11989 if (FRAME_WINDOW_P (f
))
11991 #if defined (HAVE_NS)
11992 /* All frames on Mac OS share the same menubar. So only
11993 the selected frame should be allowed to set it. */
11994 if (f
== SELECTED_FRAME ())
11996 set_frame_menubar (f
, false, false);
11999 /* On a terminal screen, the menu bar is an ordinary screen
12000 line, and this makes it get updated. */
12001 w
->update_mode_line
= true;
12002 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
12003 /* In the non-toolkit version, the menu bar is an ordinary screen
12004 line, and this makes it get updated. */
12005 w
->update_mode_line
= true;
12006 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
12008 unbind_to (count
, Qnil
);
12009 set_buffer_internal_1 (prev
);
12016 /***********************************************************************
12018 ***********************************************************************/
12020 #ifdef HAVE_WINDOW_SYSTEM
12022 /* Select `frame' temporarily without running all the code in
12024 FIXME: Maybe do_switch_frame should be trimmed down similarly
12025 when `norecord' is set. */
12027 fast_set_selected_frame (Lisp_Object frame
)
12029 if (!EQ (selected_frame
, frame
))
12031 selected_frame
= frame
;
12032 selected_window
= XFRAME (frame
)->selected_window
;
12036 /* Update the tool-bar item list for frame F. This has to be done
12037 before we start to fill in any display lines. Called from
12038 prepare_menu_bars. If SAVE_MATCH_DATA, we must save
12039 and restore it here. */
12042 update_tool_bar (struct frame
*f
, bool save_match_data
)
12044 #if defined (USE_GTK) || defined (HAVE_NS)
12045 bool do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
12047 bool do_update
= (WINDOWP (f
->tool_bar_window
)
12048 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0);
12053 Lisp_Object window
;
12056 window
= FRAME_SELECTED_WINDOW (f
);
12057 w
= XWINDOW (window
);
12059 /* If the user has switched buffers or windows, we need to
12060 recompute to reflect the new bindings. But we'll
12061 recompute when update_mode_lines is set too; that means
12062 that people can use force-mode-line-update to request
12063 that the menu bar be recomputed. The adverse effect on
12064 the rest of the redisplay algorithm is about the same as
12065 windows_or_buffers_changed anyway. */
12066 if (windows_or_buffers_changed
12067 || w
->update_mode_line
12068 || update_mode_lines
12069 || window_buffer_changed (w
))
12071 struct buffer
*prev
= current_buffer
;
12072 ptrdiff_t count
= SPECPDL_INDEX ();
12073 Lisp_Object frame
, new_tool_bar
;
12074 int new_n_tool_bar
;
12076 /* Set current_buffer to the buffer of the selected
12077 window of the frame, so that we get the right local
12079 set_buffer_internal_1 (XBUFFER (w
->contents
));
12081 /* Save match data, if we must. */
12082 if (save_match_data
)
12083 record_unwind_save_match_data ();
12085 /* Make sure that we don't accidentally use bogus keymaps. */
12086 if (NILP (Voverriding_local_map_menu_flag
))
12088 specbind (Qoverriding_terminal_local_map
, Qnil
);
12089 specbind (Qoverriding_local_map
, Qnil
);
12092 /* We must temporarily set the selected frame to this frame
12093 before calling tool_bar_items, because the calculation of
12094 the tool-bar keymap uses the selected frame (see
12095 `tool-bar-make-keymap' in tool-bar.el). */
12096 eassert (EQ (selected_window
,
12097 /* Since we only explicitly preserve selected_frame,
12098 check that selected_window would be redundant. */
12099 XFRAME (selected_frame
)->selected_window
));
12100 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
12101 XSETFRAME (frame
, f
);
12102 fast_set_selected_frame (frame
);
12104 /* Build desired tool-bar items from keymaps. */
12106 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
12109 /* Redisplay the tool-bar if we changed it. */
12110 if (new_n_tool_bar
!= f
->n_tool_bar_items
12111 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
12113 /* Redisplay that happens asynchronously due to an expose event
12114 may access f->tool_bar_items. Make sure we update both
12115 variables within BLOCK_INPUT so no such event interrupts. */
12117 fset_tool_bar_items (f
, new_tool_bar
);
12118 f
->n_tool_bar_items
= new_n_tool_bar
;
12119 w
->update_mode_line
= true;
12123 unbind_to (count
, Qnil
);
12124 set_buffer_internal_1 (prev
);
12129 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12131 /* Set F->desired_tool_bar_string to a Lisp string representing frame
12132 F's desired tool-bar contents. F->tool_bar_items must have
12133 been set up previously by calling prepare_menu_bars. */
12136 build_desired_tool_bar_string (struct frame
*f
)
12138 int i
, size
, size_needed
;
12139 Lisp_Object image
, plist
;
12141 image
= plist
= Qnil
;
12143 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
12144 Otherwise, make a new string. */
12146 /* The size of the string we might be able to reuse. */
12147 size
= (STRINGP (f
->desired_tool_bar_string
)
12148 ? SCHARS (f
->desired_tool_bar_string
)
12151 /* We need one space in the string for each image. */
12152 size_needed
= f
->n_tool_bar_items
;
12154 /* Reuse f->desired_tool_bar_string, if possible. */
12155 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
12156 fset_desired_tool_bar_string
12157 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
12160 AUTO_LIST4 (props
, Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
12161 Fremove_text_properties (make_number (0), make_number (size
),
12162 props
, f
->desired_tool_bar_string
);
12165 /* Put a `display' property on the string for the images to display,
12166 put a `menu_item' property on tool-bar items with a value that
12167 is the index of the item in F's tool-bar item vector. */
12168 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
12170 #define PROP(IDX) \
12171 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
12173 bool enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
12174 bool selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
12175 int hmargin
, vmargin
, relief
, idx
, end
;
12177 /* If image is a vector, choose the image according to the
12179 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
12180 if (VECTORP (image
))
12184 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12185 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
12188 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12189 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
12191 eassert (ASIZE (image
) >= idx
);
12192 image
= AREF (image
, idx
);
12197 /* Ignore invalid image specifications. */
12198 if (!valid_image_p (image
))
12201 /* Display the tool-bar button pressed, or depressed. */
12202 plist
= Fcopy_sequence (XCDR (image
));
12204 /* Compute margin and relief to draw. */
12205 relief
= (tool_bar_button_relief
>= 0
12206 ? tool_bar_button_relief
12207 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12208 hmargin
= vmargin
= relief
;
12210 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12211 INT_MAX
- max (hmargin
, vmargin
)))
12213 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12214 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12216 else if (CONSP (Vtool_bar_button_margin
))
12218 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12219 INT_MAX
- hmargin
))
12220 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12222 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12223 INT_MAX
- vmargin
))
12224 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12227 if (auto_raise_tool_bar_buttons_p
)
12229 /* Add a `:relief' property to the image spec if the item is
12233 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12240 /* If image is selected, display it pressed, i.e. with a
12241 negative relief. If it's not selected, display it with a
12243 plist
= Fplist_put (plist
, QCrelief
,
12245 ? make_number (-relief
)
12246 : make_number (relief
)));
12251 /* Put a margin around the image. */
12252 if (hmargin
|| vmargin
)
12254 if (hmargin
== vmargin
)
12255 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12257 plist
= Fplist_put (plist
, QCmargin
,
12258 Fcons (make_number (hmargin
),
12259 make_number (vmargin
)));
12262 /* If button is not enabled, and we don't have special images
12263 for the disabled state, make the image appear disabled by
12264 applying an appropriate algorithm to it. */
12265 if (!enabled_p
&& idx
< 0)
12266 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12268 /* Put a `display' text property on the string for the image to
12269 display. Put a `menu-item' property on the string that gives
12270 the start of this item's properties in the tool-bar items
12272 image
= Fcons (Qimage
, plist
);
12273 AUTO_LIST4 (props
, Qdisplay
, image
, Qmenu_item
,
12274 make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12276 /* Let the last image hide all remaining spaces in the tool bar
12277 string. The string can be longer than needed when we reuse a
12278 previous string. */
12279 if (i
+ 1 == f
->n_tool_bar_items
)
12280 end
= SCHARS (f
->desired_tool_bar_string
);
12283 Fadd_text_properties (make_number (i
), make_number (end
),
12284 props
, f
->desired_tool_bar_string
);
12290 /* Display one line of the tool-bar of frame IT->f.
12292 HEIGHT specifies the desired height of the tool-bar line.
12293 If the actual height of the glyph row is less than HEIGHT, the
12294 row's height is increased to HEIGHT, and the icons are centered
12295 vertically in the new height.
12297 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12298 count a final empty row in case the tool-bar width exactly matches
12303 display_tool_bar_line (struct it
*it
, int height
)
12305 struct glyph_row
*row
= it
->glyph_row
;
12306 int max_x
= it
->last_visible_x
;
12307 struct glyph
*last
;
12309 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12310 clear_glyph_row (row
);
12311 row
->enabled_p
= true;
12312 row
->y
= it
->current_y
;
12314 /* Note that this isn't made use of if the face hasn't a box,
12315 so there's no need to check the face here. */
12316 it
->start_of_box_run_p
= true;
12318 while (it
->current_x
< max_x
)
12320 int x
, n_glyphs_before
, i
, nglyphs
;
12321 struct it it_before
;
12323 /* Get the next display element. */
12324 if (!get_next_display_element (it
))
12326 /* Don't count empty row if we are counting needed tool-bar lines. */
12327 if (height
< 0 && !it
->hpos
)
12332 /* Produce glyphs. */
12333 n_glyphs_before
= row
->used
[TEXT_AREA
];
12336 PRODUCE_GLYPHS (it
);
12338 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12340 x
= it_before
.current_x
;
12341 while (i
< nglyphs
)
12343 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12345 if (x
+ glyph
->pixel_width
> max_x
)
12347 /* Glyph doesn't fit on line. Backtrack. */
12348 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12350 /* If this is the only glyph on this line, it will never fit on the
12351 tool-bar, so skip it. But ensure there is at least one glyph,
12352 so we don't accidentally disable the tool-bar. */
12353 if (n_glyphs_before
== 0
12354 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12360 x
+= glyph
->pixel_width
;
12364 /* Stop at line end. */
12365 if (ITERATOR_AT_END_OF_LINE_P (it
))
12368 set_iterator_to_next (it
, true);
12373 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12375 /* Use default face for the border below the tool bar.
12377 FIXME: When auto-resize-tool-bars is grow-only, there is
12378 no additional border below the possibly empty tool-bar lines.
12379 So to make the extra empty lines look "normal", we have to
12380 use the tool-bar face for the border too. */
12381 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12382 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12383 it
->face_id
= DEFAULT_FACE_ID
;
12385 extend_face_to_end_of_line (it
);
12386 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12387 last
->right_box_line_p
= true;
12388 if (last
== row
->glyphs
[TEXT_AREA
])
12389 last
->left_box_line_p
= true;
12391 /* Make line the desired height and center it vertically. */
12392 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12394 /* Don't add more than one line height. */
12395 height
%= FRAME_LINE_HEIGHT (it
->f
);
12396 it
->max_ascent
+= height
/ 2;
12397 it
->max_descent
+= (height
+ 1) / 2;
12400 compute_line_metrics (it
);
12402 /* If line is empty, make it occupy the rest of the tool-bar. */
12403 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12405 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12406 row
->visible_height
= row
->height
;
12407 row
->ascent
= row
->phys_ascent
= 0;
12408 row
->extra_line_spacing
= 0;
12411 row
->full_width_p
= true;
12412 row
->continued_p
= false;
12413 row
->truncated_on_left_p
= false;
12414 row
->truncated_on_right_p
= false;
12416 it
->current_x
= it
->hpos
= 0;
12417 it
->current_y
+= row
->height
;
12423 /* Value is the number of pixels needed to make all tool-bar items of
12424 frame F visible. The actual number of glyph rows needed is
12425 returned in *N_ROWS if non-NULL. */
12427 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12429 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12431 /* tool_bar_height is called from redisplay_tool_bar after building
12432 the desired matrix, so use (unused) mode-line row as temporary row to
12433 avoid destroying the first tool-bar row. */
12434 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12436 /* Initialize an iterator for iteration over
12437 F->desired_tool_bar_string in the tool-bar window of frame F. */
12438 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12439 temp_row
->reversed_p
= false;
12440 it
.first_visible_x
= 0;
12441 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12442 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12443 it
.paragraph_embedding
= L2R
;
12445 while (!ITERATOR_AT_END_P (&it
))
12447 clear_glyph_row (temp_row
);
12448 it
.glyph_row
= temp_row
;
12449 display_tool_bar_line (&it
, -1);
12451 clear_glyph_row (temp_row
);
12453 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12455 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12458 return it
.current_y
;
12460 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12463 #endif /* !USE_GTK && !HAVE_NS */
12465 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12467 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12468 If FRAME is nil or omitted, use the selected frame. Optional argument
12469 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12470 (Lisp_Object frame
, Lisp_Object pixelwise
)
12474 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12475 struct frame
*f
= decode_any_frame (frame
);
12477 if (WINDOWP (f
->tool_bar_window
)
12478 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12480 update_tool_bar (f
, true);
12481 if (f
->n_tool_bar_items
)
12483 build_desired_tool_bar_string (f
);
12484 height
= tool_bar_height (f
, NULL
, !NILP (pixelwise
));
12489 return make_number (height
);
12493 /* Display the tool-bar of frame F. Value is true if tool-bar's
12494 height should be changed. */
12496 redisplay_tool_bar (struct frame
*f
)
12498 f
->tool_bar_redisplayed
= true;
12499 #if defined (USE_GTK) || defined (HAVE_NS)
12501 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12502 update_frame_tool_bar (f
);
12505 #else /* !USE_GTK && !HAVE_NS */
12509 struct glyph_row
*row
;
12511 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12512 do anything. This means you must start with tool-bar-lines
12513 non-zero to get the auto-sizing effect. Or in other words, you
12514 can turn off tool-bars by specifying tool-bar-lines zero. */
12515 if (!WINDOWP (f
->tool_bar_window
)
12516 || (w
= XWINDOW (f
->tool_bar_window
),
12517 WINDOW_TOTAL_LINES (w
) == 0))
12520 /* Set up an iterator for the tool-bar window. */
12521 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12522 it
.first_visible_x
= 0;
12523 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12524 row
= it
.glyph_row
;
12525 row
->reversed_p
= false;
12527 /* Build a string that represents the contents of the tool-bar. */
12528 build_desired_tool_bar_string (f
);
12529 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12530 /* FIXME: This should be controlled by a user option. But it
12531 doesn't make sense to have an R2L tool bar if the menu bar cannot
12532 be drawn also R2L, and making the menu bar R2L is tricky due
12533 toolkit-specific code that implements it. If an R2L tool bar is
12534 ever supported, display_tool_bar_line should also be augmented to
12535 call unproduce_glyphs like display_line and display_string
12537 it
.paragraph_embedding
= L2R
;
12539 if (f
->n_tool_bar_rows
== 0)
12541 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, true);
12543 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12545 x_change_tool_bar_height (f
, new_height
);
12546 frame_default_tool_bar_height
= new_height
;
12547 /* Always do that now. */
12548 clear_glyph_matrix (w
->desired_matrix
);
12549 f
->fonts_changed
= true;
12554 /* Display as many lines as needed to display all tool-bar items. */
12556 if (f
->n_tool_bar_rows
> 0)
12558 int border
, rows
, height
, extra
;
12560 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12561 border
= XINT (Vtool_bar_border
);
12562 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12563 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12564 else if (EQ (Vtool_bar_border
, Qborder_width
))
12565 border
= f
->border_width
;
12571 rows
= f
->n_tool_bar_rows
;
12572 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12573 extra
= it
.last_visible_y
- border
- height
* rows
;
12575 while (it
.current_y
< it
.last_visible_y
)
12578 if (extra
> 0 && rows
-- > 0)
12580 h
= (extra
+ rows
- 1) / rows
;
12583 display_tool_bar_line (&it
, height
+ h
);
12588 while (it
.current_y
< it
.last_visible_y
)
12589 display_tool_bar_line (&it
, 0);
12592 /* It doesn't make much sense to try scrolling in the tool-bar
12593 window, so don't do it. */
12594 w
->desired_matrix
->no_scrolling_p
= true;
12595 w
->must_be_updated_p
= true;
12597 if (!NILP (Vauto_resize_tool_bars
))
12599 bool change_height_p
= true;
12601 /* If we couldn't display everything, change the tool-bar's
12602 height if there is room for more. */
12603 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
12604 change_height_p
= true;
12606 /* We subtract 1 because display_tool_bar_line advances the
12607 glyph_row pointer before returning to its caller. We want to
12608 examine the last glyph row produced by
12609 display_tool_bar_line. */
12610 row
= it
.glyph_row
- 1;
12612 /* If there are blank lines at the end, except for a partially
12613 visible blank line at the end that is smaller than
12614 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12615 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12616 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12617 change_height_p
= true;
12619 /* If row displays tool-bar items, but is partially visible,
12620 change the tool-bar's height. */
12621 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12622 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
12623 change_height_p
= true;
12625 /* Resize windows as needed by changing the `tool-bar-lines'
12626 frame parameter. */
12627 if (change_height_p
)
12630 int new_height
= tool_bar_height (f
, &nrows
, true);
12632 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12633 && !f
->minimize_tool_bar_window_p
)
12634 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12635 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12636 f
->minimize_tool_bar_window_p
= false;
12638 if (change_height_p
)
12640 x_change_tool_bar_height (f
, new_height
);
12641 frame_default_tool_bar_height
= new_height
;
12642 clear_glyph_matrix (w
->desired_matrix
);
12643 f
->n_tool_bar_rows
= nrows
;
12644 f
->fonts_changed
= true;
12651 f
->minimize_tool_bar_window_p
= false;
12654 #endif /* USE_GTK || HAVE_NS */
12657 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12659 /* Get information about the tool-bar item which is displayed in GLYPH
12660 on frame F. Return in *PROP_IDX the index where tool-bar item
12661 properties start in F->tool_bar_items. Value is false if
12662 GLYPH doesn't display a tool-bar item. */
12665 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12670 /* This function can be called asynchronously, which means we must
12671 exclude any possibility that Fget_text_property signals an
12673 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12674 charpos
= max (0, charpos
);
12676 /* Get the text property `menu-item' at pos. The value of that
12677 property is the start index of this item's properties in
12678 F->tool_bar_items. */
12679 prop
= Fget_text_property (make_number (charpos
),
12680 Qmenu_item
, f
->current_tool_bar_string
);
12681 if (! INTEGERP (prop
))
12683 *prop_idx
= XINT (prop
);
12688 /* Get information about the tool-bar item at position X/Y on frame F.
12689 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12690 the current matrix of the tool-bar window of F, or NULL if not
12691 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12692 item in F->tool_bar_items. Value is
12694 -1 if X/Y is not on a tool-bar item
12695 0 if X/Y is on the same item that was highlighted before.
12699 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12700 int *hpos
, int *vpos
, int *prop_idx
)
12702 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12703 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12706 /* Find the glyph under X/Y. */
12707 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12708 if (*glyph
== NULL
)
12711 /* Get the start of this tool-bar item's properties in
12712 f->tool_bar_items. */
12713 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12716 /* Is mouse on the highlighted item? */
12717 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12718 && *vpos
>= hlinfo
->mouse_face_beg_row
12719 && *vpos
<= hlinfo
->mouse_face_end_row
12720 && (*vpos
> hlinfo
->mouse_face_beg_row
12721 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12722 && (*vpos
< hlinfo
->mouse_face_end_row
12723 || *hpos
< hlinfo
->mouse_face_end_col
12724 || hlinfo
->mouse_face_past_end
))
12732 Handle mouse button event on the tool-bar of frame F, at
12733 frame-relative coordinates X/Y. DOWN_P is true for a button press,
12734 false for button release. MODIFIERS is event modifiers for button
12738 handle_tool_bar_click (struct frame
*f
, int x
, int y
, bool down_p
,
12741 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12742 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12743 int hpos
, vpos
, prop_idx
;
12744 struct glyph
*glyph
;
12745 Lisp_Object enabled_p
;
12748 /* If not on the highlighted tool-bar item, and mouse-highlight is
12749 non-nil, return. This is so we generate the tool-bar button
12750 click only when the mouse button is released on the same item as
12751 where it was pressed. However, when mouse-highlight is disabled,
12752 generate the click when the button is released regardless of the
12753 highlight, since tool-bar items are not highlighted in that
12755 frame_to_window_pixel_xy (w
, &x
, &y
);
12756 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12758 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12761 /* When mouse-highlight is off, generate the click for the item
12762 where the button was pressed, disregarding where it was
12764 if (NILP (Vmouse_highlight
) && !down_p
)
12765 prop_idx
= f
->last_tool_bar_item
;
12767 /* If item is disabled, do nothing. */
12768 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12769 if (NILP (enabled_p
))
12774 /* Show item in pressed state. */
12775 if (!NILP (Vmouse_highlight
))
12776 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12777 f
->last_tool_bar_item
= prop_idx
;
12781 Lisp_Object key
, frame
;
12782 struct input_event event
;
12783 EVENT_INIT (event
);
12785 /* Show item in released state. */
12786 if (!NILP (Vmouse_highlight
))
12787 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12789 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12791 XSETFRAME (frame
, f
);
12792 event
.kind
= TOOL_BAR_EVENT
;
12793 event
.frame_or_window
= frame
;
12795 kbd_buffer_store_event (&event
);
12797 event
.kind
= TOOL_BAR_EVENT
;
12798 event
.frame_or_window
= frame
;
12800 event
.modifiers
= modifiers
;
12801 kbd_buffer_store_event (&event
);
12802 f
->last_tool_bar_item
= -1;
12807 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12808 tool-bar window-relative coordinates X/Y. Called from
12809 note_mouse_highlight. */
12812 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12814 Lisp_Object window
= f
->tool_bar_window
;
12815 struct window
*w
= XWINDOW (window
);
12816 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12817 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12819 struct glyph
*glyph
;
12820 struct glyph_row
*row
;
12822 Lisp_Object enabled_p
;
12824 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12828 /* Function note_mouse_highlight is called with negative X/Y
12829 values when mouse moves outside of the frame. */
12830 if (x
<= 0 || y
<= 0)
12832 clear_mouse_face (hlinfo
);
12836 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12839 /* Not on tool-bar item. */
12840 clear_mouse_face (hlinfo
);
12844 /* On same tool-bar item as before. */
12845 goto set_help_echo
;
12847 clear_mouse_face (hlinfo
);
12849 /* Mouse is down, but on different tool-bar item? */
12850 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12851 && f
== dpyinfo
->last_mouse_frame
);
12853 if (mouse_down_p
&& f
->last_tool_bar_item
!= prop_idx
)
12856 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12858 /* If tool-bar item is not enabled, don't highlight it. */
12859 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12860 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12862 /* Compute the x-position of the glyph. In front and past the
12863 image is a space. We include this in the highlighted area. */
12864 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12865 for (i
= x
= 0; i
< hpos
; ++i
)
12866 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12868 /* Record this as the current active region. */
12869 hlinfo
->mouse_face_beg_col
= hpos
;
12870 hlinfo
->mouse_face_beg_row
= vpos
;
12871 hlinfo
->mouse_face_beg_x
= x
;
12872 hlinfo
->mouse_face_past_end
= false;
12874 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12875 hlinfo
->mouse_face_end_row
= vpos
;
12876 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12877 hlinfo
->mouse_face_window
= window
;
12878 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12880 /* Display it as active. */
12881 show_mouse_face (hlinfo
, draw
);
12886 /* Set help_echo_string to a help string to display for this tool-bar item.
12887 XTread_socket does the rest. */
12888 help_echo_object
= help_echo_window
= Qnil
;
12889 help_echo_pos
= -1;
12890 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12891 if (NILP (help_echo_string
))
12892 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12895 #endif /* !USE_GTK && !HAVE_NS */
12897 #endif /* HAVE_WINDOW_SYSTEM */
12901 /************************************************************************
12902 Horizontal scrolling
12903 ************************************************************************/
12905 /* For all leaf windows in the window tree rooted at WINDOW, set their
12906 hscroll value so that PT is (i) visible in the window, and (ii) so
12907 that it is not within a certain margin at the window's left and
12908 right border. Value is true if any window's hscroll has been
12912 hscroll_window_tree (Lisp_Object window
)
12914 bool hscrolled_p
= false;
12915 bool hscroll_relative_p
= FLOATP (Vhscroll_step
);
12916 int hscroll_step_abs
= 0;
12917 double hscroll_step_rel
= 0;
12919 if (hscroll_relative_p
)
12921 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12922 if (hscroll_step_rel
< 0)
12924 hscroll_relative_p
= false;
12925 hscroll_step_abs
= 0;
12928 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12930 hscroll_step_abs
= XINT (Vhscroll_step
);
12931 if (hscroll_step_abs
< 0)
12932 hscroll_step_abs
= 0;
12935 hscroll_step_abs
= 0;
12937 while (WINDOWP (window
))
12939 struct window
*w
= XWINDOW (window
);
12941 if (WINDOWP (w
->contents
))
12942 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12943 else if (w
->cursor
.vpos
>= 0)
12946 int text_area_width
;
12947 struct glyph_row
*cursor_row
;
12948 struct glyph_row
*bottom_row
;
12950 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12951 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12952 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12954 cursor_row
= bottom_row
- 1;
12956 if (!cursor_row
->enabled_p
)
12958 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12959 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12960 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12962 cursor_row
= bottom_row
- 1;
12964 bool row_r2l_p
= cursor_row
->reversed_p
;
12966 text_area_width
= window_box_width (w
, TEXT_AREA
);
12968 /* Scroll when cursor is inside this scroll margin. */
12969 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12971 /* If the position of this window's point has explicitly
12972 changed, no more suspend auto hscrolling. */
12973 if (NILP (Fequal (Fwindow_point (window
), Fwindow_old_point (window
))))
12974 w
->suspend_auto_hscroll
= false;
12976 /* Remember window point. */
12977 Fset_marker (w
->old_pointm
,
12978 ((w
== XWINDOW (selected_window
))
12979 ? make_number (BUF_PT (XBUFFER (w
->contents
)))
12980 : Fmarker_position (w
->pointm
)),
12983 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12984 && !w
->suspend_auto_hscroll
12985 /* In some pathological cases, like restoring a window
12986 configuration into a frame that is much smaller than
12987 the one from which the configuration was saved, we
12988 get glyph rows whose start and end have zero buffer
12989 positions, which we cannot handle below. Just skip
12991 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12992 /* For left-to-right rows, hscroll when cursor is either
12993 (i) inside the right hscroll margin, or (ii) if it is
12994 inside the left margin and the window is already
12997 && ((w
->hscroll
&& w
->cursor
.x
<= h_margin
)
12998 || (cursor_row
->enabled_p
12999 && cursor_row
->truncated_on_right_p
13000 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
13001 /* For right-to-left rows, the logic is similar,
13002 except that rules for scrolling to left and right
13003 are reversed. E.g., if cursor.x <= h_margin, we
13004 need to hscroll "to the right" unconditionally,
13005 and that will scroll the screen to the left so as
13006 to reveal the next portion of the row. */
13008 && ((cursor_row
->enabled_p
13009 /* FIXME: It is confusing to set the
13010 truncated_on_right_p flag when R2L rows
13011 are actually truncated on the left. */
13012 && cursor_row
->truncated_on_right_p
13013 && w
->cursor
.x
<= h_margin
)
13015 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
13019 struct buffer
*saved_current_buffer
;
13023 /* Find point in a display of infinite width. */
13024 saved_current_buffer
= current_buffer
;
13025 current_buffer
= XBUFFER (w
->contents
);
13027 if (w
== XWINDOW (selected_window
))
13030 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
13032 /* Move iterator to pt starting at cursor_row->start in
13033 a line with infinite width. */
13034 init_to_row_start (&it
, w
, cursor_row
);
13035 it
.last_visible_x
= INFINITY
;
13036 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
13037 current_buffer
= saved_current_buffer
;
13039 /* Position cursor in window. */
13040 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
13041 hscroll
= max (0, (it
.current_x
13042 - (ITERATOR_AT_END_OF_LINE_P (&it
)
13043 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
13044 : (text_area_width
/ 2))))
13045 / FRAME_COLUMN_WIDTH (it
.f
);
13046 else if ((!row_r2l_p
13047 && w
->cursor
.x
>= text_area_width
- h_margin
)
13048 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
13050 if (hscroll_relative_p
)
13051 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
13054 wanted_x
= text_area_width
13055 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
13058 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
13062 if (hscroll_relative_p
)
13063 wanted_x
= text_area_width
* hscroll_step_rel
13066 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
13069 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
13071 hscroll
= max (hscroll
, w
->min_hscroll
);
13073 /* Don't prevent redisplay optimizations if hscroll
13074 hasn't changed, as it will unnecessarily slow down
13076 if (w
->hscroll
!= hscroll
)
13078 struct buffer
*b
= XBUFFER (w
->contents
);
13079 b
->prevent_redisplay_optimizations_p
= true;
13080 w
->hscroll
= hscroll
;
13081 hscrolled_p
= true;
13089 /* Value is true if hscroll of any leaf window has been changed. */
13090 return hscrolled_p
;
13094 /* Set hscroll so that cursor is visible and not inside horizontal
13095 scroll margins for all windows in the tree rooted at WINDOW. See
13096 also hscroll_window_tree above. Value is true if any window's
13097 hscroll has been changed. If it has, desired matrices on the frame
13098 of WINDOW are cleared. */
13101 hscroll_windows (Lisp_Object window
)
13103 bool hscrolled_p
= hscroll_window_tree (window
);
13105 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
13106 return hscrolled_p
;
13111 /************************************************************************
13113 ************************************************************************/
13115 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined.
13116 This is sometimes handy to have in a debugger session. */
13120 /* First and last unchanged row for try_window_id. */
13122 static int debug_first_unchanged_at_end_vpos
;
13123 static int debug_last_unchanged_at_beg_vpos
;
13125 /* Delta vpos and y. */
13127 static int debug_dvpos
, debug_dy
;
13129 /* Delta in characters and bytes for try_window_id. */
13131 static ptrdiff_t debug_delta
, debug_delta_bytes
;
13133 /* Values of window_end_pos and window_end_vpos at the end of
13136 static ptrdiff_t debug_end_vpos
;
13138 /* Append a string to W->desired_matrix->method. FMT is a printf
13139 format string. If trace_redisplay_p is true also printf the
13140 resulting string to stderr. */
13142 static void debug_method_add (struct window
*, char const *, ...)
13143 ATTRIBUTE_FORMAT_PRINTF (2, 3);
13146 debug_method_add (struct window
*w
, char const *fmt
, ...)
13149 char *method
= w
->desired_matrix
->method
;
13150 int len
= strlen (method
);
13151 int size
= sizeof w
->desired_matrix
->method
;
13152 int remaining
= size
- len
- 1;
13155 if (len
&& remaining
)
13158 --remaining
, ++len
;
13161 va_start (ap
, fmt
);
13162 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
13165 if (trace_redisplay_p
)
13166 fprintf (stderr
, "%p (%s): %s\n",
13168 ((BUFFERP (w
->contents
)
13169 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
13170 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13175 #endif /* GLYPH_DEBUG */
13178 /* Value is true if all changes in window W, which displays
13179 current_buffer, are in the text between START and END. START is a
13180 buffer position, END is given as a distance from Z. Used in
13181 redisplay_internal for display optimization. */
13184 text_outside_line_unchanged_p (struct window
*w
,
13185 ptrdiff_t start
, ptrdiff_t end
)
13187 bool unchanged_p
= true;
13189 /* If text or overlays have changed, see where. */
13190 if (window_outdated (w
))
13192 /* Gap in the line? */
13193 if (GPT
< start
|| Z
- GPT
< end
)
13194 unchanged_p
= false;
13196 /* Changes start in front of the line, or end after it? */
13198 && (BEG_UNCHANGED
< start
- 1
13199 || END_UNCHANGED
< end
))
13200 unchanged_p
= false;
13202 /* If selective display, can't optimize if changes start at the
13203 beginning of the line. */
13205 && INTEGERP (BVAR (current_buffer
, selective_display
))
13206 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13207 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13208 unchanged_p
= false;
13210 /* If there are overlays at the start or end of the line, these
13211 may have overlay strings with newlines in them. A change at
13212 START, for instance, may actually concern the display of such
13213 overlay strings as well, and they are displayed on different
13214 lines. So, quickly rule out this case. (For the future, it
13215 might be desirable to implement something more telling than
13216 just BEG/END_UNCHANGED.) */
13219 if (BEG
+ BEG_UNCHANGED
== start
13220 && overlay_touches_p (start
))
13221 unchanged_p
= false;
13222 if (END_UNCHANGED
== end
13223 && overlay_touches_p (Z
- end
))
13224 unchanged_p
= false;
13227 /* Under bidi reordering, adding or deleting a character in the
13228 beginning of a paragraph, before the first strong directional
13229 character, can change the base direction of the paragraph (unless
13230 the buffer specifies a fixed paragraph direction), which will
13231 require redisplaying the whole paragraph. It might be worthwhile
13232 to find the paragraph limits and widen the range of redisplayed
13233 lines to that, but for now just give up this optimization. */
13234 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13235 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13236 unchanged_p
= false;
13239 return unchanged_p
;
13243 /* Do a frame update, taking possible shortcuts into account. This is
13244 the main external entry point for redisplay.
13246 If the last redisplay displayed an echo area message and that message
13247 is no longer requested, we clear the echo area or bring back the
13248 mini-buffer if that is in use. */
13253 redisplay_internal ();
13258 overlay_arrow_string_or_property (Lisp_Object var
)
13262 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13265 return Voverlay_arrow_string
;
13268 /* Return true if there are any overlay-arrows in current_buffer. */
13270 overlay_arrow_in_current_buffer_p (void)
13274 for (vlist
= Voverlay_arrow_variable_list
;
13276 vlist
= XCDR (vlist
))
13278 Lisp_Object var
= XCAR (vlist
);
13281 if (!SYMBOLP (var
))
13283 val
= find_symbol_value (var
);
13285 && current_buffer
== XMARKER (val
)->buffer
)
13292 /* Return true if any overlay_arrows have moved or overlay-arrow-string
13296 overlay_arrows_changed_p (void)
13300 for (vlist
= Voverlay_arrow_variable_list
;
13302 vlist
= XCDR (vlist
))
13304 Lisp_Object var
= XCAR (vlist
);
13305 Lisp_Object val
, pstr
;
13307 if (!SYMBOLP (var
))
13309 val
= find_symbol_value (var
);
13310 if (!MARKERP (val
))
13312 if (! EQ (COERCE_MARKER (val
),
13313 Fget (var
, Qlast_arrow_position
))
13314 || ! (pstr
= overlay_arrow_string_or_property (var
),
13315 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13321 /* Mark overlay arrows to be updated on next redisplay. */
13324 update_overlay_arrows (int up_to_date
)
13328 for (vlist
= Voverlay_arrow_variable_list
;
13330 vlist
= XCDR (vlist
))
13332 Lisp_Object var
= XCAR (vlist
);
13334 if (!SYMBOLP (var
))
13337 if (up_to_date
> 0)
13339 Lisp_Object val
= find_symbol_value (var
);
13340 Fput (var
, Qlast_arrow_position
,
13341 COERCE_MARKER (val
));
13342 Fput (var
, Qlast_arrow_string
,
13343 overlay_arrow_string_or_property (var
));
13345 else if (up_to_date
< 0
13346 || !NILP (Fget (var
, Qlast_arrow_position
)))
13348 Fput (var
, Qlast_arrow_position
, Qt
);
13349 Fput (var
, Qlast_arrow_string
, Qt
);
13355 /* Return overlay arrow string to display at row.
13356 Return integer (bitmap number) for arrow bitmap in left fringe.
13357 Return nil if no overlay arrow. */
13360 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13364 for (vlist
= Voverlay_arrow_variable_list
;
13366 vlist
= XCDR (vlist
))
13368 Lisp_Object var
= XCAR (vlist
);
13371 if (!SYMBOLP (var
))
13374 val
= find_symbol_value (var
);
13377 && current_buffer
== XMARKER (val
)->buffer
13378 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13380 if (FRAME_WINDOW_P (it
->f
)
13381 /* FIXME: if ROW->reversed_p is set, this should test
13382 the right fringe, not the left one. */
13383 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13385 #ifdef HAVE_WINDOW_SYSTEM
13386 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13388 int fringe_bitmap
= lookup_fringe_bitmap (val
);
13389 if (fringe_bitmap
!= 0)
13390 return make_number (fringe_bitmap
);
13393 return make_number (-1); /* Use default arrow bitmap. */
13395 return overlay_arrow_string_or_property (var
);
13402 /* Return true if point moved out of or into a composition. Otherwise
13403 return false. PREV_BUF and PREV_PT are the last point buffer and
13404 position. BUF and PT are the current point buffer and position. */
13407 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13408 struct buffer
*buf
, ptrdiff_t pt
)
13410 ptrdiff_t start
, end
;
13412 Lisp_Object buffer
;
13414 XSETBUFFER (buffer
, buf
);
13415 /* Check a composition at the last point if point moved within the
13417 if (prev_buf
== buf
)
13420 /* Point didn't move. */
13423 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13424 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13425 && composition_valid_p (start
, end
, prop
)
13426 && start
< prev_pt
&& end
> prev_pt
)
13427 /* The last point was within the composition. Return true iff
13428 point moved out of the composition. */
13429 return (pt
<= start
|| pt
>= end
);
13432 /* Check a composition at the current point. */
13433 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13434 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13435 && composition_valid_p (start
, end
, prop
)
13436 && start
< pt
&& end
> pt
);
13439 /* Reconsider the clip changes of buffer which is displayed in W. */
13442 reconsider_clip_changes (struct window
*w
)
13444 struct buffer
*b
= XBUFFER (w
->contents
);
13446 if (b
->clip_changed
13447 && w
->window_end_valid
13448 && w
->current_matrix
->buffer
== b
13449 && w
->current_matrix
->zv
== BUF_ZV (b
)
13450 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13451 b
->clip_changed
= false;
13453 /* If display wasn't paused, and W is not a tool bar window, see if
13454 point has been moved into or out of a composition. In that case,
13455 set b->clip_changed to force updating the screen. If
13456 b->clip_changed has already been set, skip this check. */
13457 if (!b
->clip_changed
&& w
->window_end_valid
)
13459 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13460 ? PT
: marker_position (w
->pointm
));
13462 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13463 && check_point_in_composition (w
->current_matrix
->buffer
,
13464 w
->last_point
, b
, pt
))
13465 b
->clip_changed
= true;
13470 propagate_buffer_redisplay (void)
13471 { /* Resetting b->text->redisplay is problematic!
13472 We can't just reset it in the case that some window that displays
13473 it has not been redisplayed; and such a window can stay
13474 unredisplayed for a long time if it's currently invisible.
13475 But we do want to reset it at the end of redisplay otherwise
13476 its displayed windows will keep being redisplayed over and over
13478 So we copy all b->text->redisplay flags up to their windows here,
13479 such that mark_window_display_accurate can safely reset
13480 b->text->redisplay. */
13481 Lisp_Object ws
= window_list ();
13482 for (; CONSP (ws
); ws
= XCDR (ws
))
13484 struct window
*thisw
= XWINDOW (XCAR (ws
));
13485 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13486 if (thisb
->text
->redisplay
)
13487 thisw
->redisplay
= true;
13491 #define STOP_POLLING \
13492 do { if (! polling_stopped_here) stop_polling (); \
13493 polling_stopped_here = true; } while (false)
13495 #define RESUME_POLLING \
13496 do { if (polling_stopped_here) start_polling (); \
13497 polling_stopped_here = false; } while (false)
13500 /* Perhaps in the future avoid recentering windows if it
13501 is not necessary; currently that causes some problems. */
13504 redisplay_internal (void)
13506 struct window
*w
= XWINDOW (selected_window
);
13510 bool must_finish
= false, match_p
;
13511 struct text_pos tlbufpos
, tlendpos
;
13512 int number_of_visible_frames
;
13515 bool polling_stopped_here
= false;
13516 Lisp_Object tail
, frame
;
13518 /* True means redisplay has to consider all windows on all
13519 frames. False, only selected_window is considered. */
13520 bool consider_all_windows_p
;
13522 /* True means redisplay has to redisplay the miniwindow. */
13523 bool update_miniwindow_p
= false;
13525 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13527 /* No redisplay if running in batch mode or frame is not yet fully
13528 initialized, or redisplay is explicitly turned off by setting
13529 Vinhibit_redisplay. */
13530 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13531 || !NILP (Vinhibit_redisplay
))
13534 /* Don't examine these until after testing Vinhibit_redisplay.
13535 When Emacs is shutting down, perhaps because its connection to
13536 X has dropped, we should not look at them at all. */
13537 fr
= XFRAME (w
->frame
);
13538 sf
= SELECTED_FRAME ();
13540 if (!fr
->glyphs_initialized_p
)
13543 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13544 if (popup_activated ())
13548 /* I don't think this happens but let's be paranoid. */
13549 if (redisplaying_p
)
13552 /* Record a function that clears redisplaying_p
13553 when we leave this function. */
13554 count
= SPECPDL_INDEX ();
13555 record_unwind_protect_void (unwind_redisplay
);
13556 redisplaying_p
= true;
13557 specbind (Qinhibit_free_realized_faces
, Qnil
);
13559 /* Record this function, so it appears on the profiler's backtraces. */
13560 record_in_backtrace (Qredisplay_internal_xC_functionx
, 0, 0);
13562 FOR_EACH_FRAME (tail
, frame
)
13563 XFRAME (frame
)->already_hscrolled_p
= false;
13566 /* Remember the currently selected window. */
13570 forget_escape_and_glyphless_faces ();
13572 inhibit_free_realized_faces
= false;
13574 /* If face_change, init_iterator will free all realized faces, which
13575 includes the faces referenced from current matrices. So, we
13576 can't reuse current matrices in this case. */
13578 windows_or_buffers_changed
= 47;
13580 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13581 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13583 /* Since frames on a single ASCII terminal share the same
13584 display area, displaying a different frame means redisplay
13585 the whole thing. */
13586 SET_FRAME_GARBAGED (sf
);
13588 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13590 FRAME_TTY (sf
)->previous_frame
= sf
;
13593 /* Set the visible flags for all frames. Do this before checking for
13594 resized or garbaged frames; they want to know if their frames are
13595 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13596 number_of_visible_frames
= 0;
13598 FOR_EACH_FRAME (tail
, frame
)
13600 struct frame
*f
= XFRAME (frame
);
13602 if (FRAME_VISIBLE_P (f
))
13604 ++number_of_visible_frames
;
13605 /* Adjust matrices for visible frames only. */
13606 if (f
->fonts_changed
)
13608 adjust_frame_glyphs (f
);
13609 /* Disable all redisplay optimizations for this frame.
13610 This is because adjust_frame_glyphs resets the
13611 enabled_p flag for all glyph rows of all windows, so
13612 many optimizations will fail anyway, and some might
13613 fail to test that flag and do bogus things as
13615 SET_FRAME_GARBAGED (f
);
13616 f
->fonts_changed
= false;
13618 /* If cursor type has been changed on the frame
13619 other than selected, consider all frames. */
13620 if (f
!= sf
&& f
->cursor_type_changed
)
13621 fset_redisplay (f
);
13623 clear_desired_matrices (f
);
13626 /* Notice any pending interrupt request to change frame size. */
13627 do_pending_window_change (true);
13629 /* do_pending_window_change could change the selected_window due to
13630 frame resizing which makes the selected window too small. */
13631 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13634 /* Clear frames marked as garbaged. */
13635 clear_garbaged_frames ();
13637 /* Build menubar and tool-bar items. */
13638 if (NILP (Vmemory_full
))
13639 prepare_menu_bars ();
13641 reconsider_clip_changes (w
);
13643 /* In most cases selected window displays current buffer. */
13644 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13647 /* Detect case that we need to write or remove a star in the mode line. */
13648 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13649 w
->update_mode_line
= true;
13651 if (mode_line_update_needed (w
))
13652 w
->update_mode_line
= true;
13654 /* If reconsider_clip_changes above decided that the narrowing
13655 in the current buffer changed, make sure all other windows
13656 showing that buffer will be redisplayed. */
13657 if (current_buffer
->clip_changed
)
13658 bset_update_mode_line (current_buffer
);
13661 /* Normally the message* functions will have already displayed and
13662 updated the echo area, but the frame may have been trashed, or
13663 the update may have been preempted, so display the echo area
13664 again here. Checking message_cleared_p captures the case that
13665 the echo area should be cleared. */
13666 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13667 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13668 || (message_cleared_p
13669 && minibuf_level
== 0
13670 /* If the mini-window is currently selected, this means the
13671 echo-area doesn't show through. */
13672 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13674 echo_area_display (false);
13676 /* If echo_area_display resizes the mini-window, the redisplay and
13677 window_sizes_changed flags of the selected frame are set, but
13678 it's too late for the hooks in window-size-change-functions,
13679 which have been examined already in prepare_menu_bars. So in
13680 that case we call the hooks here only for the selected frame. */
13683 ptrdiff_t count1
= SPECPDL_INDEX ();
13685 record_unwind_save_match_data ();
13686 run_window_size_change_functions (selected_frame
);
13687 unbind_to (count1
, Qnil
);
13690 if (message_cleared_p
)
13691 update_miniwindow_p
= true;
13693 must_finish
= true;
13695 /* If we don't display the current message, don't clear the
13696 message_cleared_p flag, because, if we did, we wouldn't clear
13697 the echo area in the next redisplay which doesn't preserve
13699 if (!display_last_displayed_message_p
)
13700 message_cleared_p
= false;
13702 else if (EQ (selected_window
, minibuf_window
)
13703 && (current_buffer
->clip_changed
|| window_outdated (w
))
13704 && resize_mini_window (w
, false))
13708 ptrdiff_t count1
= SPECPDL_INDEX ();
13710 record_unwind_save_match_data ();
13711 run_window_size_change_functions (selected_frame
);
13712 unbind_to (count1
, Qnil
);
13715 /* Resized active mini-window to fit the size of what it is
13716 showing if its contents might have changed. */
13717 must_finish
= true;
13719 /* If window configuration was changed, frames may have been
13720 marked garbaged. Clear them or we will experience
13721 surprises wrt scrolling. */
13722 clear_garbaged_frames ();
13725 if (windows_or_buffers_changed
&& !update_mode_lines
)
13726 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13727 only the windows's contents needs to be refreshed, or whether the
13728 mode-lines also need a refresh. */
13729 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13730 ? REDISPLAY_SOME
: 32);
13732 /* If specs for an arrow have changed, do thorough redisplay
13733 to ensure we remove any arrow that should no longer exist. */
13734 if (overlay_arrows_changed_p ())
13735 /* Apparently, this is the only case where we update other windows,
13736 without updating other mode-lines. */
13737 windows_or_buffers_changed
= 49;
13739 consider_all_windows_p
= (update_mode_lines
13740 || windows_or_buffers_changed
);
13742 #define AINC(a,i) \
13744 Lisp_Object entry = Fgethash (make_number (i), a, make_number (0)); \
13745 if (INTEGERP (entry)) \
13746 Fputhash (make_number (i), make_number (1 + XINT (entry)), a); \
13749 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13750 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13752 /* Optimize the case that only the line containing the cursor in the
13753 selected window has changed. Variables starting with this_ are
13754 set in display_line and record information about the line
13755 containing the cursor. */
13756 tlbufpos
= this_line_start_pos
;
13757 tlendpos
= this_line_end_pos
;
13758 if (!consider_all_windows_p
13759 && CHARPOS (tlbufpos
) > 0
13760 && !w
->update_mode_line
13761 && !current_buffer
->clip_changed
13762 && !current_buffer
->prevent_redisplay_optimizations_p
13763 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13764 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13765 && !XFRAME (w
->frame
)->cursor_type_changed
13766 && !XFRAME (w
->frame
)->face_change
13767 /* Make sure recorded data applies to current buffer, etc. */
13768 && this_line_buffer
== current_buffer
13771 && !w
->optional_new_start
13772 /* Point must be on the line that we have info recorded about. */
13773 && PT
>= CHARPOS (tlbufpos
)
13774 && PT
<= Z
- CHARPOS (tlendpos
)
13775 /* All text outside that line, including its final newline,
13776 must be unchanged. */
13777 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13778 CHARPOS (tlendpos
)))
13780 if (CHARPOS (tlbufpos
) > BEGV
13781 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13782 && (CHARPOS (tlbufpos
) == ZV
13783 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13784 /* Former continuation line has disappeared by becoming empty. */
13786 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13788 /* We have to handle the case of continuation around a
13789 wide-column character (see the comment in indent.c around
13792 For instance, in the following case:
13794 -------- Insert --------
13795 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13796 J_I_ ==> J_I_ `^^' are cursors.
13800 As we have to redraw the line above, we cannot use this
13804 int line_height_before
= this_line_pixel_height
;
13806 /* Note that start_display will handle the case that the
13807 line starting at tlbufpos is a continuation line. */
13808 start_display (&it
, w
, tlbufpos
);
13810 /* Implementation note: It this still necessary? */
13811 if (it
.current_x
!= this_line_start_x
)
13814 TRACE ((stderr
, "trying display optimization 1\n"));
13815 w
->cursor
.vpos
= -1;
13816 overlay_arrow_seen
= false;
13817 it
.vpos
= this_line_vpos
;
13818 it
.current_y
= this_line_y
;
13819 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13820 display_line (&it
);
13822 /* If line contains point, is not continued,
13823 and ends at same distance from eob as before, we win. */
13824 if (w
->cursor
.vpos
>= 0
13825 /* Line is not continued, otherwise this_line_start_pos
13826 would have been set to 0 in display_line. */
13827 && CHARPOS (this_line_start_pos
)
13828 /* Line ends as before. */
13829 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13830 /* Line has same height as before. Otherwise other lines
13831 would have to be shifted up or down. */
13832 && this_line_pixel_height
== line_height_before
)
13834 /* If this is not the window's last line, we must adjust
13835 the charstarts of the lines below. */
13836 if (it
.current_y
< it
.last_visible_y
)
13838 struct glyph_row
*row
13839 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13840 ptrdiff_t delta
, delta_bytes
;
13842 /* We used to distinguish between two cases here,
13843 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13844 when the line ends in a newline or the end of the
13845 buffer's accessible portion. But both cases did
13846 the same, so they were collapsed. */
13848 - CHARPOS (tlendpos
)
13849 - MATRIX_ROW_START_CHARPOS (row
));
13850 delta_bytes
= (Z_BYTE
13851 - BYTEPOS (tlendpos
)
13852 - MATRIX_ROW_START_BYTEPOS (row
));
13854 increment_matrix_positions (w
->current_matrix
,
13855 this_line_vpos
+ 1,
13856 w
->current_matrix
->nrows
,
13857 delta
, delta_bytes
);
13860 /* If this row displays text now but previously didn't,
13861 or vice versa, w->window_end_vpos may have to be
13863 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13865 if (w
->window_end_vpos
< this_line_vpos
)
13866 w
->window_end_vpos
= this_line_vpos
;
13868 else if (w
->window_end_vpos
== this_line_vpos
13869 && this_line_vpos
> 0)
13870 w
->window_end_vpos
= this_line_vpos
- 1;
13871 w
->window_end_valid
= false;
13873 /* Update hint: No need to try to scroll in update_window. */
13874 w
->desired_matrix
->no_scrolling_p
= true;
13877 *w
->desired_matrix
->method
= 0;
13878 debug_method_add (w
, "optimization 1");
13880 #ifdef HAVE_WINDOW_SYSTEM
13881 update_window_fringes (w
, false);
13888 else if (/* Cursor position hasn't changed. */
13889 PT
== w
->last_point
13890 /* Make sure the cursor was last displayed
13891 in this window. Otherwise we have to reposition it. */
13893 /* PXW: Must be converted to pixels, probably. */
13894 && 0 <= w
->cursor
.vpos
13895 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13899 do_pending_window_change (true);
13900 /* If selected_window changed, redisplay again. */
13901 if (WINDOWP (selected_window
)
13902 && (w
= XWINDOW (selected_window
)) != sw
)
13905 /* We used to always goto end_of_redisplay here, but this
13906 isn't enough if we have a blinking cursor. */
13907 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13908 goto end_of_redisplay
;
13912 /* If highlighting the region, or if the cursor is in the echo area,
13913 then we can't just move the cursor. */
13914 else if (NILP (Vshow_trailing_whitespace
)
13915 && !cursor_in_echo_area
)
13918 struct glyph_row
*row
;
13920 /* Skip from tlbufpos to PT and see where it is. Note that
13921 PT may be in invisible text. If so, we will end at the
13922 next visible position. */
13923 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13924 NULL
, DEFAULT_FACE_ID
);
13925 it
.current_x
= this_line_start_x
;
13926 it
.current_y
= this_line_y
;
13927 it
.vpos
= this_line_vpos
;
13929 /* The call to move_it_to stops in front of PT, but
13930 moves over before-strings. */
13931 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13933 if (it
.vpos
== this_line_vpos
13934 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13937 eassert (this_line_vpos
== it
.vpos
);
13938 eassert (this_line_y
== it
.current_y
);
13939 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13940 if (cursor_row_fully_visible_p (w
, false, true))
13943 *w
->desired_matrix
->method
= 0;
13944 debug_method_add (w
, "optimization 3");
13956 /* Text changed drastically or point moved off of line. */
13957 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13960 CHARPOS (this_line_start_pos
) = 0;
13961 ++clear_face_cache_count
;
13962 #ifdef HAVE_WINDOW_SYSTEM
13963 ++clear_image_cache_count
;
13966 /* Build desired matrices, and update the display. If
13967 consider_all_windows_p, do it for all windows on all frames that
13968 require redisplay, as specified by their 'redisplay' flag.
13969 Otherwise do it for selected_window, only. */
13971 if (consider_all_windows_p
)
13973 FOR_EACH_FRAME (tail
, frame
)
13974 XFRAME (frame
)->updated_p
= false;
13976 propagate_buffer_redisplay ();
13978 FOR_EACH_FRAME (tail
, frame
)
13980 struct frame
*f
= XFRAME (frame
);
13982 /* We don't have to do anything for unselected terminal
13984 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13985 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13989 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13992 /* Only GC scrollbars when we redisplay the whole frame. */
13993 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13994 bool f_redisplay_flag
= f
->redisplay
;
13995 /* Mark all the scroll bars to be removed; we'll redeem
13996 the ones we want when we redisplay their windows. */
13997 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13998 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
14000 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
14001 redisplay_windows (FRAME_ROOT_WINDOW (f
));
14002 /* Remember that the invisible frames need to be redisplayed next
14003 time they're visible. */
14004 else if (!REDISPLAY_SOME_P ())
14005 f
->redisplay
= true;
14007 /* The X error handler may have deleted that frame. */
14008 if (!FRAME_LIVE_P (f
))
14011 /* Any scroll bars which redisplay_windows should have
14012 nuked should now go away. */
14013 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
14014 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
14016 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
14018 /* If fonts changed on visible frame, display again. */
14019 if (f
->fonts_changed
)
14021 adjust_frame_glyphs (f
);
14022 /* Disable all redisplay optimizations for this
14023 frame. For the reasons, see the comment near
14024 the previous call to adjust_frame_glyphs above. */
14025 SET_FRAME_GARBAGED (f
);
14026 f
->fonts_changed
= false;
14030 /* See if we have to hscroll. */
14031 if (!f
->already_hscrolled_p
)
14033 f
->already_hscrolled_p
= true;
14034 if (hscroll_windows (f
->root_window
))
14038 /* If the frame's redisplay flag was not set before
14039 we went about redisplaying its windows, but it is
14040 set now, that means we employed some redisplay
14041 optimizations inside redisplay_windows, and
14042 bypassed producing some screen lines. But if
14043 f->redisplay is now set, it might mean the old
14044 faces are no longer valid (e.g., if redisplaying
14045 some window called some Lisp which defined a new
14046 face or redefined an existing face), so trying to
14047 use them in update_frame will segfault.
14048 Therefore, we must redisplay this frame. */
14049 if (!f_redisplay_flag
&& f
->redisplay
)
14052 /* Prevent various kinds of signals during display
14053 update. stdio is not robust about handling
14054 signals, which can cause an apparent I/O error. */
14055 if (interrupt_input
)
14056 unrequest_sigio ();
14059 pending
|= update_frame (f
, false, false);
14060 f
->cursor_type_changed
= false;
14061 f
->updated_p
= true;
14066 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
14070 /* Do the mark_window_display_accurate after all windows have
14071 been redisplayed because this call resets flags in buffers
14072 which are needed for proper redisplay. */
14073 FOR_EACH_FRAME (tail
, frame
)
14075 struct frame
*f
= XFRAME (frame
);
14078 f
->redisplay
= false;
14079 mark_window_display_accurate (f
->root_window
, true);
14080 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
14081 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
14086 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
14088 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
14089 /* Use list_of_error, not Qerror, so that
14090 we catch only errors and don't run the debugger. */
14091 internal_condition_case_1 (redisplay_window_1
, selected_window
,
14093 redisplay_window_error
);
14094 if (update_miniwindow_p
)
14095 internal_condition_case_1 (redisplay_window_1
,
14096 FRAME_MINIBUF_WINDOW (sf
), list_of_error
,
14097 redisplay_window_error
);
14099 /* Compare desired and current matrices, perform output. */
14102 /* If fonts changed, display again. Likewise if redisplay_window_1
14103 above caused some change (e.g., a change in faces) that requires
14104 considering the entire frame again. */
14105 if (sf
->fonts_changed
|| sf
->redisplay
)
14109 /* Set this to force a more thorough redisplay.
14110 Otherwise, we might immediately loop back to the
14111 above "else-if" clause (since all the conditions that
14112 led here might still be true), and we will then
14113 infloop, because the selected-frame's redisplay flag
14114 is not (and cannot be) reset. */
14115 windows_or_buffers_changed
= 50;
14120 /* Prevent freeing of realized faces, since desired matrices are
14121 pending that reference the faces we computed and cached. */
14122 inhibit_free_realized_faces
= true;
14124 /* Prevent various kinds of signals during display update.
14125 stdio is not robust about handling signals,
14126 which can cause an apparent I/O error. */
14127 if (interrupt_input
)
14128 unrequest_sigio ();
14131 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
14133 if (hscroll_windows (selected_window
))
14136 XWINDOW (selected_window
)->must_be_updated_p
= true;
14137 pending
= update_frame (sf
, false, false);
14138 sf
->cursor_type_changed
= false;
14141 /* We may have called echo_area_display at the top of this
14142 function. If the echo area is on another frame, that may
14143 have put text on a frame other than the selected one, so the
14144 above call to update_frame would not have caught it. Catch
14146 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
14147 struct frame
*mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
14149 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
14151 XWINDOW (mini_window
)->must_be_updated_p
= true;
14152 pending
|= update_frame (mini_frame
, false, false);
14153 mini_frame
->cursor_type_changed
= false;
14154 if (!pending
&& hscroll_windows (mini_window
))
14159 /* If display was paused because of pending input, make sure we do a
14160 thorough update the next time. */
14163 /* Prevent the optimization at the beginning of
14164 redisplay_internal that tries a single-line update of the
14165 line containing the cursor in the selected window. */
14166 CHARPOS (this_line_start_pos
) = 0;
14168 /* Let the overlay arrow be updated the next time. */
14169 update_overlay_arrows (0);
14171 /* If we pause after scrolling, some rows in the current
14172 matrices of some windows are not valid. */
14173 if (!WINDOW_FULL_WIDTH_P (w
)
14174 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
14175 update_mode_lines
= 36;
14179 if (!consider_all_windows_p
)
14181 /* This has already been done above if
14182 consider_all_windows_p is set. */
14183 if (XBUFFER (w
->contents
)->text
->redisplay
14184 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
14185 /* This can happen if b->text->redisplay was set during
14187 propagate_buffer_redisplay ();
14188 mark_window_display_accurate_1 (w
, true);
14190 /* Say overlay arrows are up to date. */
14191 update_overlay_arrows (1);
14193 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
14194 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
14197 update_mode_lines
= 0;
14198 windows_or_buffers_changed
= 0;
14201 /* Start SIGIO interrupts coming again. Having them off during the
14202 code above makes it less likely one will discard output, but not
14203 impossible, since there might be stuff in the system buffer here.
14204 But it is much hairier to try to do anything about that. */
14205 if (interrupt_input
)
14209 /* If a frame has become visible which was not before, redisplay
14210 again, so that we display it. Expose events for such a frame
14211 (which it gets when becoming visible) don't call the parts of
14212 redisplay constructing glyphs, so simply exposing a frame won't
14213 display anything in this case. So, we have to display these
14214 frames here explicitly. */
14219 FOR_EACH_FRAME (tail
, frame
)
14221 if (XFRAME (frame
)->visible
)
14225 if (new_count
!= number_of_visible_frames
)
14226 windows_or_buffers_changed
= 52;
14229 /* Change frame size now if a change is pending. */
14230 do_pending_window_change (true);
14232 /* If we just did a pending size change, or have additional
14233 visible frames, or selected_window changed, redisplay again. */
14234 if ((windows_or_buffers_changed
&& !pending
)
14235 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14238 /* Clear the face and image caches.
14240 We used to do this only if consider_all_windows_p. But the cache
14241 needs to be cleared if a timer creates images in the current
14242 buffer (e.g. the test case in Bug#6230). */
14244 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14246 clear_face_cache (false);
14247 clear_face_cache_count
= 0;
14250 #ifdef HAVE_WINDOW_SYSTEM
14251 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14253 clear_image_caches (Qnil
);
14254 clear_image_cache_count
= 0;
14256 #endif /* HAVE_WINDOW_SYSTEM */
14260 ns_set_doc_edited ();
14262 if (interrupt_input
&& interrupts_deferred
)
14265 unbind_to (count
, Qnil
);
14270 /* Redisplay, but leave alone any recent echo area message unless
14271 another message has been requested in its place.
14273 This is useful in situations where you need to redisplay but no
14274 user action has occurred, making it inappropriate for the message
14275 area to be cleared. See tracking_off and
14276 wait_reading_process_output for examples of these situations.
14278 FROM_WHERE is an integer saying from where this function was
14279 called. This is useful for debugging. */
14282 redisplay_preserve_echo_area (int from_where
)
14284 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14286 if (!NILP (echo_area_buffer
[1]))
14288 /* We have a previously displayed message, but no current
14289 message. Redisplay the previous message. */
14290 display_last_displayed_message_p
= true;
14291 redisplay_internal ();
14292 display_last_displayed_message_p
= false;
14295 redisplay_internal ();
14297 flush_frame (SELECTED_FRAME ());
14301 /* Function registered with record_unwind_protect in redisplay_internal. */
14304 unwind_redisplay (void)
14306 redisplaying_p
= false;
14310 /* Mark the display of leaf window W as accurate or inaccurate.
14311 If ACCURATE_P, mark display of W as accurate.
14312 If !ACCURATE_P, arrange for W to be redisplayed the next
14313 time redisplay_internal is called. */
14316 mark_window_display_accurate_1 (struct window
*w
, bool accurate_p
)
14318 struct buffer
*b
= XBUFFER (w
->contents
);
14320 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14321 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14322 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14326 b
->clip_changed
= false;
14327 b
->prevent_redisplay_optimizations_p
= false;
14328 eassert (buffer_window_count (b
) > 0);
14329 /* Resetting b->text->redisplay is problematic!
14330 In order to make it safer to do it here, redisplay_internal must
14331 have copied all b->text->redisplay to their respective windows. */
14332 b
->text
->redisplay
= false;
14334 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14335 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14336 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14337 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14339 w
->current_matrix
->buffer
= b
;
14340 w
->current_matrix
->begv
= BUF_BEGV (b
);
14341 w
->current_matrix
->zv
= BUF_ZV (b
);
14343 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14344 w
->last_cursor_off_p
= w
->cursor_off_p
;
14346 if (w
== XWINDOW (selected_window
))
14347 w
->last_point
= BUF_PT (b
);
14349 w
->last_point
= marker_position (w
->pointm
);
14351 w
->window_end_valid
= true;
14352 w
->update_mode_line
= false;
14355 w
->redisplay
= !accurate_p
;
14359 /* Mark the display of windows in the window tree rooted at WINDOW as
14360 accurate or inaccurate. If ACCURATE_P, mark display of
14361 windows as accurate. If !ACCURATE_P, arrange for windows to
14362 be redisplayed the next time redisplay_internal is called. */
14365 mark_window_display_accurate (Lisp_Object window
, bool accurate_p
)
14369 for (; !NILP (window
); window
= w
->next
)
14371 w
= XWINDOW (window
);
14372 if (WINDOWP (w
->contents
))
14373 mark_window_display_accurate (w
->contents
, accurate_p
);
14375 mark_window_display_accurate_1 (w
, accurate_p
);
14379 update_overlay_arrows (1);
14381 /* Force a thorough redisplay the next time by setting
14382 last_arrow_position and last_arrow_string to t, which is
14383 unequal to any useful value of Voverlay_arrow_... */
14384 update_overlay_arrows (-1);
14388 /* Return value in display table DP (Lisp_Char_Table *) for character
14389 C. Since a display table doesn't have any parent, we don't have to
14390 follow parent. Do not call this function directly but use the
14391 macro DISP_CHAR_VECTOR. */
14394 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14398 if (ASCII_CHAR_P (c
))
14401 if (SUB_CHAR_TABLE_P (val
))
14402 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14408 XSETCHAR_TABLE (table
, dp
);
14409 val
= char_table_ref (table
, c
);
14418 /***********************************************************************
14420 ***********************************************************************/
14422 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14425 redisplay_windows (Lisp_Object window
)
14427 while (!NILP (window
))
14429 struct window
*w
= XWINDOW (window
);
14431 if (WINDOWP (w
->contents
))
14432 redisplay_windows (w
->contents
);
14433 else if (BUFFERP (w
->contents
))
14435 displayed_buffer
= XBUFFER (w
->contents
);
14436 /* Use list_of_error, not Qerror, so that
14437 we catch only errors and don't run the debugger. */
14438 internal_condition_case_1 (redisplay_window_0
, window
,
14440 redisplay_window_error
);
14448 redisplay_window_error (Lisp_Object ignore
)
14450 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14455 redisplay_window_0 (Lisp_Object window
)
14457 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14458 redisplay_window (window
, false);
14463 redisplay_window_1 (Lisp_Object window
)
14465 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14466 redisplay_window (window
, true);
14471 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14472 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14473 which positions recorded in ROW differ from current buffer
14476 Return true iff cursor is on this row. */
14479 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14480 struct glyph_matrix
*matrix
,
14481 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14484 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14485 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14486 struct glyph
*cursor
= NULL
;
14487 /* The last known character position in row. */
14488 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14490 ptrdiff_t pt_old
= PT
- delta
;
14491 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14492 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14493 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14494 /* A glyph beyond the edge of TEXT_AREA which we should never
14496 struct glyph
*glyphs_end
= end
;
14497 /* True means we've found a match for cursor position, but that
14498 glyph has the avoid_cursor_p flag set. */
14499 bool match_with_avoid_cursor
= false;
14500 /* True means we've seen at least one glyph that came from a
14502 bool string_seen
= false;
14503 /* Largest and smallest buffer positions seen so far during scan of
14505 ptrdiff_t bpos_max
= pos_before
;
14506 ptrdiff_t bpos_min
= pos_after
;
14507 /* Last buffer position covered by an overlay string with an integer
14508 `cursor' property. */
14509 ptrdiff_t bpos_covered
= 0;
14510 /* True means the display string on which to display the cursor
14511 comes from a text property, not from an overlay. */
14512 bool string_from_text_prop
= false;
14514 /* Don't even try doing anything if called for a mode-line or
14515 header-line row, since the rest of the code isn't prepared to
14516 deal with such calamities. */
14517 eassert (!row
->mode_line_p
);
14518 if (row
->mode_line_p
)
14521 /* Skip over glyphs not having an object at the start and the end of
14522 the row. These are special glyphs like truncation marks on
14523 terminal frames. */
14524 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14526 if (!row
->reversed_p
)
14529 && NILP (glyph
->object
)
14530 && glyph
->charpos
< 0)
14532 x
+= glyph
->pixel_width
;
14536 && NILP ((end
- 1)->object
)
14537 /* CHARPOS is zero for blanks and stretch glyphs
14538 inserted by extend_face_to_end_of_line. */
14539 && (end
- 1)->charpos
<= 0)
14541 glyph_before
= glyph
- 1;
14548 /* If the glyph row is reversed, we need to process it from back
14549 to front, so swap the edge pointers. */
14550 glyphs_end
= end
= glyph
- 1;
14551 glyph
+= row
->used
[TEXT_AREA
] - 1;
14553 while (glyph
> end
+ 1
14554 && NILP (glyph
->object
)
14555 && glyph
->charpos
< 0)
14558 x
-= glyph
->pixel_width
;
14560 if (NILP (glyph
->object
) && glyph
->charpos
< 0)
14562 /* By default, in reversed rows we put the cursor on the
14563 rightmost (first in the reading order) glyph. */
14564 for (g
= end
+ 1; g
< glyph
; g
++)
14565 x
+= g
->pixel_width
;
14567 && NILP ((end
+ 1)->object
)
14568 && (end
+ 1)->charpos
<= 0)
14570 glyph_before
= glyph
+ 1;
14574 else if (row
->reversed_p
)
14576 /* In R2L rows that don't display text, put the cursor on the
14577 rightmost glyph. Case in point: an empty last line that is
14578 part of an R2L paragraph. */
14580 /* Avoid placing the cursor on the last glyph of the row, where
14581 on terminal frames we hold the vertical border between
14582 adjacent windows. */
14583 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14584 && !WINDOW_RIGHTMOST_P (w
)
14585 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14587 x
= -1; /* will be computed below, at label compute_x */
14590 /* Step 1: Try to find the glyph whose character position
14591 corresponds to point. If that's not possible, find 2 glyphs
14592 whose character positions are the closest to point, one before
14593 point, the other after it. */
14594 if (!row
->reversed_p
)
14595 while (/* not marched to end of glyph row */
14597 /* glyph was not inserted by redisplay for internal purposes */
14598 && !NILP (glyph
->object
))
14600 if (BUFFERP (glyph
->object
))
14602 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14604 if (glyph
->charpos
> bpos_max
)
14605 bpos_max
= glyph
->charpos
;
14606 if (glyph
->charpos
< bpos_min
)
14607 bpos_min
= glyph
->charpos
;
14608 if (!glyph
->avoid_cursor_p
)
14610 /* If we hit point, we've found the glyph on which to
14611 display the cursor. */
14614 match_with_avoid_cursor
= false;
14617 /* See if we've found a better approximation to
14618 POS_BEFORE or to POS_AFTER. */
14619 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14621 pos_before
= glyph
->charpos
;
14622 glyph_before
= glyph
;
14624 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14626 pos_after
= glyph
->charpos
;
14627 glyph_after
= glyph
;
14630 else if (dpos
== 0)
14631 match_with_avoid_cursor
= true;
14633 else if (STRINGP (glyph
->object
))
14635 Lisp_Object chprop
;
14636 ptrdiff_t glyph_pos
= glyph
->charpos
;
14638 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14640 if (!NILP (chprop
))
14642 /* If the string came from a `display' text property,
14643 look up the buffer position of that property and
14644 use that position to update bpos_max, as if we
14645 actually saw such a position in one of the row's
14646 glyphs. This helps with supporting integer values
14647 of `cursor' property on the display string in
14648 situations where most or all of the row's buffer
14649 text is completely covered by display properties,
14650 so that no glyph with valid buffer positions is
14651 ever seen in the row. */
14652 ptrdiff_t prop_pos
=
14653 string_buffer_position_lim (glyph
->object
, pos_before
,
14656 if (prop_pos
>= pos_before
)
14657 bpos_max
= prop_pos
;
14659 if (INTEGERP (chprop
))
14661 bpos_covered
= bpos_max
+ XINT (chprop
);
14662 /* If the `cursor' property covers buffer positions up
14663 to and including point, we should display cursor on
14664 this glyph. Note that, if a `cursor' property on one
14665 of the string's characters has an integer value, we
14666 will break out of the loop below _before_ we get to
14667 the position match above. IOW, integer values of
14668 the `cursor' property override the "exact match for
14669 point" strategy of positioning the cursor. */
14670 /* Implementation note: bpos_max == pt_old when, e.g.,
14671 we are in an empty line, where bpos_max is set to
14672 MATRIX_ROW_START_CHARPOS, see above. */
14673 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14680 string_seen
= true;
14682 x
+= glyph
->pixel_width
;
14685 else if (glyph
> end
) /* row is reversed */
14686 while (!NILP (glyph
->object
))
14688 if (BUFFERP (glyph
->object
))
14690 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14692 if (glyph
->charpos
> bpos_max
)
14693 bpos_max
= glyph
->charpos
;
14694 if (glyph
->charpos
< bpos_min
)
14695 bpos_min
= glyph
->charpos
;
14696 if (!glyph
->avoid_cursor_p
)
14700 match_with_avoid_cursor
= false;
14703 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14705 pos_before
= glyph
->charpos
;
14706 glyph_before
= glyph
;
14708 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14710 pos_after
= glyph
->charpos
;
14711 glyph_after
= glyph
;
14714 else if (dpos
== 0)
14715 match_with_avoid_cursor
= true;
14717 else if (STRINGP (glyph
->object
))
14719 Lisp_Object chprop
;
14720 ptrdiff_t glyph_pos
= glyph
->charpos
;
14722 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14724 if (!NILP (chprop
))
14726 ptrdiff_t prop_pos
=
14727 string_buffer_position_lim (glyph
->object
, pos_before
,
14730 if (prop_pos
>= pos_before
)
14731 bpos_max
= prop_pos
;
14733 if (INTEGERP (chprop
))
14735 bpos_covered
= bpos_max
+ XINT (chprop
);
14736 /* If the `cursor' property covers buffer positions up
14737 to and including point, we should display cursor on
14739 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14745 string_seen
= true;
14748 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14750 x
--; /* can't use any pixel_width */
14753 x
-= glyph
->pixel_width
;
14756 /* Step 2: If we didn't find an exact match for point, we need to
14757 look for a proper place to put the cursor among glyphs between
14758 GLYPH_BEFORE and GLYPH_AFTER. */
14759 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14760 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14761 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14763 /* An empty line has a single glyph whose OBJECT is nil and
14764 whose CHARPOS is the position of a newline on that line.
14765 Note that on a TTY, there are more glyphs after that, which
14766 were produced by extend_face_to_end_of_line, but their
14767 CHARPOS is zero or negative. */
14768 bool empty_line_p
=
14769 ((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14770 && NILP (glyph
->object
) && glyph
->charpos
> 0
14771 /* On a TTY, continued and truncated rows also have a glyph at
14772 their end whose OBJECT is nil and whose CHARPOS is
14773 positive (the continuation and truncation glyphs), but such
14774 rows are obviously not "empty". */
14775 && !(row
->continued_p
|| row
->truncated_on_right_p
));
14777 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14779 ptrdiff_t ellipsis_pos
;
14781 /* Scan back over the ellipsis glyphs. */
14782 if (!row
->reversed_p
)
14784 ellipsis_pos
= (glyph
- 1)->charpos
;
14785 while (glyph
> row
->glyphs
[TEXT_AREA
]
14786 && (glyph
- 1)->charpos
== ellipsis_pos
)
14787 glyph
--, x
-= glyph
->pixel_width
;
14788 /* That loop always goes one position too far, including
14789 the glyph before the ellipsis. So scan forward over
14791 x
+= glyph
->pixel_width
;
14794 else /* row is reversed */
14796 ellipsis_pos
= (glyph
+ 1)->charpos
;
14797 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14798 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14799 glyph
++, x
+= glyph
->pixel_width
;
14800 x
-= glyph
->pixel_width
;
14804 else if (match_with_avoid_cursor
)
14806 cursor
= glyph_after
;
14809 else if (string_seen
)
14811 int incr
= row
->reversed_p
? -1 : +1;
14813 /* Need to find the glyph that came out of a string which is
14814 present at point. That glyph is somewhere between
14815 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14816 positioned between POS_BEFORE and POS_AFTER in the
14818 struct glyph
*start
, *stop
;
14819 ptrdiff_t pos
= pos_before
;
14823 /* If the row ends in a newline from a display string,
14824 reordering could have moved the glyphs belonging to the
14825 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14826 in this case we extend the search to the last glyph in
14827 the row that was not inserted by redisplay. */
14828 if (row
->ends_in_newline_from_string_p
)
14831 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14834 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14835 correspond to POS_BEFORE and POS_AFTER, respectively. We
14836 need START and STOP in the order that corresponds to the
14837 row's direction as given by its reversed_p flag. If the
14838 directionality of characters between POS_BEFORE and
14839 POS_AFTER is the opposite of the row's base direction,
14840 these characters will have been reordered for display,
14841 and we need to reverse START and STOP. */
14842 if (!row
->reversed_p
)
14844 start
= min (glyph_before
, glyph_after
);
14845 stop
= max (glyph_before
, glyph_after
);
14849 start
= max (glyph_before
, glyph_after
);
14850 stop
= min (glyph_before
, glyph_after
);
14852 for (glyph
= start
+ incr
;
14853 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14856 /* Any glyphs that come from the buffer are here because
14857 of bidi reordering. Skip them, and only pay
14858 attention to glyphs that came from some string. */
14859 if (STRINGP (glyph
->object
))
14863 /* If the display property covers the newline, we
14864 need to search for it one position farther. */
14865 ptrdiff_t lim
= pos_after
14866 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14868 string_from_text_prop
= false;
14869 str
= glyph
->object
;
14870 tem
= string_buffer_position_lim (str
, pos
, lim
, false);
14871 if (tem
== 0 /* from overlay */
14874 /* If the string from which this glyph came is
14875 found in the buffer at point, or at position
14876 that is closer to point than pos_after, then
14877 we've found the glyph we've been looking for.
14878 If it comes from an overlay (tem == 0), and
14879 it has the `cursor' property on one of its
14880 glyphs, record that glyph as a candidate for
14881 displaying the cursor. (As in the
14882 unidirectional version, we will display the
14883 cursor on the last candidate we find.) */
14886 || (tem
- pt_old
> 0 && tem
< pos_after
))
14888 /* The glyphs from this string could have
14889 been reordered. Find the one with the
14890 smallest string position. Or there could
14891 be a character in the string with the
14892 `cursor' property, which means display
14893 cursor on that character's glyph. */
14894 ptrdiff_t strpos
= glyph
->charpos
;
14899 string_from_text_prop
= true;
14902 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14903 && EQ (glyph
->object
, str
);
14907 ptrdiff_t gpos
= glyph
->charpos
;
14909 cprop
= Fget_char_property (make_number (gpos
),
14917 if (tem
&& glyph
->charpos
< strpos
)
14919 strpos
= glyph
->charpos
;
14925 || (tem
- pt_old
> 0 && tem
< pos_after
))
14929 pos
= tem
+ 1; /* don't find previous instances */
14931 /* This string is not what we want; skip all of the
14932 glyphs that came from it. */
14933 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14934 && EQ (glyph
->object
, str
))
14941 /* If we reached the end of the line, and END was from a string,
14942 the cursor is not on this line. */
14944 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14945 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14946 && STRINGP (end
->object
)
14947 && row
->continued_p
)
14950 /* A truncated row may not include PT among its character positions.
14951 Setting the cursor inside the scroll margin will trigger
14952 recalculation of hscroll in hscroll_window_tree. But if a
14953 display string covers point, defer to the string-handling
14954 code below to figure this out. */
14955 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14957 cursor
= glyph_before
;
14960 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14961 /* Zero-width characters produce no glyphs. */
14963 && (row
->reversed_p
14964 ? glyph_after
> glyphs_end
14965 : glyph_after
< glyphs_end
)))
14967 cursor
= glyph_after
;
14973 if (cursor
!= NULL
)
14975 else if (glyph
== glyphs_end
14976 && pos_before
== pos_after
14977 && STRINGP ((row
->reversed_p
14978 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14979 : row
->glyphs
[TEXT_AREA
])->object
))
14981 /* If all the glyphs of this row came from strings, put the
14982 cursor on the first glyph of the row. This avoids having the
14983 cursor outside of the text area in this very rare and hard
14987 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14988 : row
->glyphs
[TEXT_AREA
];
14994 /* Need to compute x that corresponds to GLYPH. */
14995 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14997 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14999 x
+= g
->pixel_width
;
15003 /* ROW could be part of a continued line, which, under bidi
15004 reordering, might have other rows whose start and end charpos
15005 occlude point. Only set w->cursor if we found a better
15006 approximation to the cursor position than we have from previously
15007 examined candidate rows belonging to the same continued line. */
15008 if (/* We already have a candidate row. */
15009 w
->cursor
.vpos
>= 0
15010 /* That candidate is not the row we are processing. */
15011 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
15012 /* Make sure cursor.vpos specifies a row whose start and end
15013 charpos occlude point, and it is valid candidate for being a
15014 cursor-row. This is because some callers of this function
15015 leave cursor.vpos at the row where the cursor was displayed
15016 during the last redisplay cycle. */
15017 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
15018 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
15019 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
15022 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
15024 /* Don't consider glyphs that are outside TEXT_AREA. */
15025 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
15027 /* Keep the candidate whose buffer position is the closest to
15028 point or has the `cursor' property. */
15029 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
15030 w
->cursor
.hpos
>= 0
15031 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
15032 && ((BUFFERP (g1
->object
)
15033 && (g1
->charpos
== pt_old
/* An exact match always wins. */
15034 || (BUFFERP (glyph
->object
)
15035 && eabs (g1
->charpos
- pt_old
)
15036 < eabs (glyph
->charpos
- pt_old
))))
15037 /* Previous candidate is a glyph from a string that has
15038 a non-nil `cursor' property. */
15039 || (STRINGP (g1
->object
)
15040 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
15041 Qcursor
, g1
->object
))
15042 /* Previous candidate is from the same display
15043 string as this one, and the display string
15044 came from a text property. */
15045 || (EQ (g1
->object
, glyph
->object
)
15046 && string_from_text_prop
)
15047 /* this candidate is from newline and its
15048 position is not an exact match */
15049 || (NILP (glyph
->object
)
15050 && glyph
->charpos
!= pt_old
)))))
15052 /* If this candidate gives an exact match, use that. */
15053 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
15054 /* If this candidate is a glyph created for the
15055 terminating newline of a line, and point is on that
15056 newline, it wins because it's an exact match. */
15057 || (!row
->continued_p
15058 && NILP (glyph
->object
)
15059 && glyph
->charpos
== 0
15060 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
15061 /* Otherwise, keep the candidate that comes from a row
15062 spanning less buffer positions. This may win when one or
15063 both candidate positions are on glyphs that came from
15064 display strings, for which we cannot compare buffer
15066 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
15067 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
15068 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
15071 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
15073 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
15074 w
->cursor
.y
= row
->y
+ dy
;
15076 if (w
== XWINDOW (selected_window
))
15078 if (!row
->continued_p
15079 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15082 this_line_buffer
= XBUFFER (w
->contents
);
15084 CHARPOS (this_line_start_pos
)
15085 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
15086 BYTEPOS (this_line_start_pos
)
15087 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
15089 CHARPOS (this_line_end_pos
)
15090 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
15091 BYTEPOS (this_line_end_pos
)
15092 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
15094 this_line_y
= w
->cursor
.y
;
15095 this_line_pixel_height
= row
->height
;
15096 this_line_vpos
= w
->cursor
.vpos
;
15097 this_line_start_x
= row
->x
;
15100 CHARPOS (this_line_start_pos
) = 0;
15107 /* Run window scroll functions, if any, for WINDOW with new window
15108 start STARTP. Sets the window start of WINDOW to that position.
15110 We assume that the window's buffer is really current. */
15112 static struct text_pos
15113 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
15115 struct window
*w
= XWINDOW (window
);
15116 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
15118 eassert (current_buffer
== XBUFFER (w
->contents
));
15120 if (!NILP (Vwindow_scroll_functions
))
15122 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
15123 make_number (CHARPOS (startp
)));
15124 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15125 /* In case the hook functions switch buffers. */
15126 set_buffer_internal (XBUFFER (w
->contents
));
15133 /* Make sure the line containing the cursor is fully visible.
15134 A value of true means there is nothing to be done.
15135 (Either the line is fully visible, or it cannot be made so,
15136 or we cannot tell.)
15138 If FORCE_P, return false even if partial visible cursor row
15139 is higher than window.
15141 If CURRENT_MATRIX_P, use the information from the
15142 window's current glyph matrix; otherwise use the desired glyph
15145 A value of false means the caller should do scrolling
15146 as if point had gone off the screen. */
15149 cursor_row_fully_visible_p (struct window
*w
, bool force_p
,
15150 bool current_matrix_p
)
15152 struct glyph_matrix
*matrix
;
15153 struct glyph_row
*row
;
15156 if (!make_cursor_line_fully_visible_p
)
15159 /* It's not always possible to find the cursor, e.g, when a window
15160 is full of overlay strings. Don't do anything in that case. */
15161 if (w
->cursor
.vpos
< 0)
15164 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
15165 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
15167 /* If the cursor row is not partially visible, there's nothing to do. */
15168 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
15171 /* If the row the cursor is in is taller than the window's height,
15172 it's not clear what to do, so do nothing. */
15173 window_height
= window_box_height (w
);
15174 if (row
->height
>= window_height
)
15176 if (!force_p
|| MINI_WINDOW_P (w
)
15177 || w
->vscroll
|| w
->cursor
.vpos
== 0)
15184 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
15185 means only WINDOW is redisplayed in redisplay_internal.
15186 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
15187 in redisplay_window to bring a partially visible line into view in
15188 the case that only the cursor has moved.
15190 LAST_LINE_MISFIT should be true if we're scrolling because the
15191 last screen line's vertical height extends past the end of the screen.
15195 1 if scrolling succeeded
15197 0 if scrolling didn't find point.
15199 -1 if new fonts have been loaded so that we must interrupt
15200 redisplay, adjust glyph matrices, and try again. */
15206 SCROLLING_NEED_LARGER_MATRICES
15209 /* If scroll-conservatively is more than this, never recenter.
15211 If you change this, don't forget to update the doc string of
15212 `scroll-conservatively' and the Emacs manual. */
15213 #define SCROLL_LIMIT 100
15216 try_scrolling (Lisp_Object window
, bool just_this_one_p
,
15217 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
15218 bool temp_scroll_step
, bool last_line_misfit
)
15220 struct window
*w
= XWINDOW (window
);
15221 struct frame
*f
= XFRAME (w
->frame
);
15222 struct text_pos pos
, startp
;
15224 int this_scroll_margin
, scroll_max
, rc
, height
;
15225 int dy
= 0, amount_to_scroll
= 0;
15226 bool scroll_down_p
= false;
15227 int extra_scroll_margin_lines
= last_line_misfit
;
15228 Lisp_Object aggressive
;
15229 /* We will never try scrolling more than this number of lines. */
15230 int scroll_limit
= SCROLL_LIMIT
;
15231 int frame_line_height
= default_line_pixel_height (w
);
15232 int window_total_lines
15233 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15236 debug_method_add (w
, "try_scrolling");
15239 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15241 /* Compute scroll margin height in pixels. We scroll when point is
15242 within this distance from the top or bottom of the window. */
15243 if (scroll_margin
> 0)
15244 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15245 * frame_line_height
;
15247 this_scroll_margin
= 0;
15249 /* Force arg_scroll_conservatively to have a reasonable value, to
15250 avoid scrolling too far away with slow move_it_* functions. Note
15251 that the user can supply scroll-conservatively equal to
15252 `most-positive-fixnum', which can be larger than INT_MAX. */
15253 if (arg_scroll_conservatively
> scroll_limit
)
15255 arg_scroll_conservatively
= scroll_limit
+ 1;
15256 scroll_max
= scroll_limit
* frame_line_height
;
15258 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15259 /* Compute how much we should try to scroll maximally to bring
15260 point into view. */
15261 scroll_max
= (max (scroll_step
,
15262 max (arg_scroll_conservatively
, temp_scroll_step
))
15263 * frame_line_height
);
15264 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15265 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15266 /* We're trying to scroll because of aggressive scrolling but no
15267 scroll_step is set. Choose an arbitrary one. */
15268 scroll_max
= 10 * frame_line_height
;
15274 /* Decide whether to scroll down. */
15275 if (PT
> CHARPOS (startp
))
15277 int scroll_margin_y
;
15279 /* Compute the pixel ypos of the scroll margin, then move IT to
15280 either that ypos or PT, whichever comes first. */
15281 start_display (&it
, w
, startp
);
15282 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15283 - frame_line_height
* extra_scroll_margin_lines
;
15284 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15285 (MOVE_TO_POS
| MOVE_TO_Y
));
15287 if (PT
> CHARPOS (it
.current
.pos
))
15289 int y0
= line_bottom_y (&it
);
15290 /* Compute how many pixels below window bottom to stop searching
15291 for PT. This avoids costly search for PT that is far away if
15292 the user limited scrolling by a small number of lines, but
15293 always finds PT if scroll_conservatively is set to a large
15294 number, such as most-positive-fixnum. */
15295 int slack
= max (scroll_max
, 10 * frame_line_height
);
15296 int y_to_move
= it
.last_visible_y
+ slack
;
15298 /* Compute the distance from the scroll margin to PT or to
15299 the scroll limit, whichever comes first. This should
15300 include the height of the cursor line, to make that line
15302 move_it_to (&it
, PT
, -1, y_to_move
,
15303 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15304 dy
= line_bottom_y (&it
) - y0
;
15306 if (dy
> scroll_max
)
15307 return SCROLLING_FAILED
;
15310 scroll_down_p
= true;
15316 /* Point is in or below the bottom scroll margin, so move the
15317 window start down. If scrolling conservatively, move it just
15318 enough down to make point visible. If scroll_step is set,
15319 move it down by scroll_step. */
15320 if (arg_scroll_conservatively
)
15322 = min (max (dy
, frame_line_height
),
15323 frame_line_height
* arg_scroll_conservatively
);
15324 else if (scroll_step
|| temp_scroll_step
)
15325 amount_to_scroll
= scroll_max
;
15328 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15329 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15330 if (NUMBERP (aggressive
))
15332 double float_amount
= XFLOATINT (aggressive
) * height
;
15333 int aggressive_scroll
= float_amount
;
15334 if (aggressive_scroll
== 0 && float_amount
> 0)
15335 aggressive_scroll
= 1;
15336 /* Don't let point enter the scroll margin near top of
15337 the window. This could happen if the value of
15338 scroll_up_aggressively is too large and there are
15339 non-zero margins, because scroll_up_aggressively
15340 means put point that fraction of window height
15341 _from_the_bottom_margin_. */
15342 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15343 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15344 amount_to_scroll
= dy
+ aggressive_scroll
;
15348 if (amount_to_scroll
<= 0)
15349 return SCROLLING_FAILED
;
15351 start_display (&it
, w
, startp
);
15352 if (arg_scroll_conservatively
<= scroll_limit
)
15353 move_it_vertically (&it
, amount_to_scroll
);
15356 /* Extra precision for users who set scroll-conservatively
15357 to a large number: make sure the amount we scroll
15358 the window start is never less than amount_to_scroll,
15359 which was computed as distance from window bottom to
15360 point. This matters when lines at window top and lines
15361 below window bottom have different height. */
15363 void *it1data
= NULL
;
15364 /* We use a temporary it1 because line_bottom_y can modify
15365 its argument, if it moves one line down; see there. */
15368 SAVE_IT (it1
, it
, it1data
);
15369 start_y
= line_bottom_y (&it1
);
15371 RESTORE_IT (&it
, &it
, it1data
);
15372 move_it_by_lines (&it
, 1);
15373 SAVE_IT (it1
, it
, it1data
);
15374 } while (IT_CHARPOS (it
) < ZV
15375 && line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15376 bidi_unshelve_cache (it1data
, true);
15379 /* If STARTP is unchanged, move it down another screen line. */
15380 if (IT_CHARPOS (it
) == CHARPOS (startp
))
15381 move_it_by_lines (&it
, 1);
15382 startp
= it
.current
.pos
;
15386 struct text_pos scroll_margin_pos
= startp
;
15389 /* See if point is inside the scroll margin at the top of the
15391 if (this_scroll_margin
)
15395 start_display (&it
, w
, startp
);
15396 y_start
= it
.current_y
;
15397 move_it_vertically (&it
, this_scroll_margin
);
15398 scroll_margin_pos
= it
.current
.pos
;
15399 /* If we didn't move enough before hitting ZV, request
15400 additional amount of scroll, to move point out of the
15402 if (IT_CHARPOS (it
) == ZV
15403 && it
.current_y
- y_start
< this_scroll_margin
)
15404 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15407 if (PT
< CHARPOS (scroll_margin_pos
))
15409 /* Point is in the scroll margin at the top of the window or
15410 above what is displayed in the window. */
15413 /* Compute the vertical distance from PT to the scroll
15414 margin position. Move as far as scroll_max allows, or
15415 one screenful, or 10 screen lines, whichever is largest.
15416 Give up if distance is greater than scroll_max or if we
15417 didn't reach the scroll margin position. */
15418 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15419 start_display (&it
, w
, pos
);
15421 y_to_move
= max (it
.last_visible_y
,
15422 max (scroll_max
, 10 * frame_line_height
));
15423 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15425 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15426 dy
= it
.current_y
- y0
;
15427 if (dy
> scroll_max
15428 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15429 return SCROLLING_FAILED
;
15431 /* Additional scroll for when ZV was too close to point. */
15434 /* Compute new window start. */
15435 start_display (&it
, w
, startp
);
15437 if (arg_scroll_conservatively
)
15438 amount_to_scroll
= max (dy
, frame_line_height
15439 * max (scroll_step
, temp_scroll_step
));
15440 else if (scroll_step
|| temp_scroll_step
)
15441 amount_to_scroll
= scroll_max
;
15444 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15445 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15446 if (NUMBERP (aggressive
))
15448 double float_amount
= XFLOATINT (aggressive
) * height
;
15449 int aggressive_scroll
= float_amount
;
15450 if (aggressive_scroll
== 0 && float_amount
> 0)
15451 aggressive_scroll
= 1;
15452 /* Don't let point enter the scroll margin near
15453 bottom of the window, if the value of
15454 scroll_down_aggressively happens to be too
15456 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15457 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15458 amount_to_scroll
= dy
+ aggressive_scroll
;
15462 if (amount_to_scroll
<= 0)
15463 return SCROLLING_FAILED
;
15465 move_it_vertically_backward (&it
, amount_to_scroll
);
15466 startp
= it
.current
.pos
;
15470 /* Run window scroll functions. */
15471 startp
= run_window_scroll_functions (window
, startp
);
15473 /* Display the window. Give up if new fonts are loaded, or if point
15475 if (!try_window (window
, startp
, 0))
15476 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15477 else if (w
->cursor
.vpos
< 0)
15479 clear_glyph_matrix (w
->desired_matrix
);
15480 rc
= SCROLLING_FAILED
;
15484 /* Maybe forget recorded base line for line number display. */
15485 if (!just_this_one_p
15486 || current_buffer
->clip_changed
15487 || BEG_UNCHANGED
< CHARPOS (startp
))
15488 w
->base_line_number
= 0;
15490 /* If cursor ends up on a partially visible line,
15491 treat that as being off the bottom of the screen. */
15492 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1,
15494 /* It's possible that the cursor is on the first line of the
15495 buffer, which is partially obscured due to a vscroll
15496 (Bug#7537). In that case, avoid looping forever. */
15497 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15499 clear_glyph_matrix (w
->desired_matrix
);
15500 ++extra_scroll_margin_lines
;
15503 rc
= SCROLLING_SUCCESS
;
15510 /* Compute a suitable window start for window W if display of W starts
15511 on a continuation line. Value is true if a new window start
15514 The new window start will be computed, based on W's width, starting
15515 from the start of the continued line. It is the start of the
15516 screen line with the minimum distance from the old start W->start. */
15519 compute_window_start_on_continuation_line (struct window
*w
)
15521 struct text_pos pos
, start_pos
;
15522 bool window_start_changed_p
= false;
15524 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15526 /* If window start is on a continuation line... Window start may be
15527 < BEGV in case there's invisible text at the start of the
15528 buffer (M-x rmail, for example). */
15529 if (CHARPOS (start_pos
) > BEGV
15530 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15533 struct glyph_row
*row
;
15535 /* Handle the case that the window start is out of range. */
15536 if (CHARPOS (start_pos
) < BEGV
)
15537 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15538 else if (CHARPOS (start_pos
) > ZV
)
15539 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15541 /* Find the start of the continued line. This should be fast
15542 because find_newline is fast (newline cache). */
15543 row
= w
->desired_matrix
->rows
+ WINDOW_WANTS_HEADER_LINE_P (w
);
15544 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15545 row
, DEFAULT_FACE_ID
);
15546 reseat_at_previous_visible_line_start (&it
);
15548 /* If the line start is "too far" away from the window start,
15549 say it takes too much time to compute a new window start. */
15550 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15551 /* PXW: Do we need upper bounds here? */
15552 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15554 int min_distance
, distance
;
15556 /* Move forward by display lines to find the new window
15557 start. If window width was enlarged, the new start can
15558 be expected to be > the old start. If window width was
15559 decreased, the new window start will be < the old start.
15560 So, we're looking for the display line start with the
15561 minimum distance from the old window start. */
15562 pos
= it
.current
.pos
;
15563 min_distance
= INFINITY
;
15564 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15565 distance
< min_distance
)
15567 min_distance
= distance
;
15568 pos
= it
.current
.pos
;
15569 if (it
.line_wrap
== WORD_WRAP
)
15571 /* Under WORD_WRAP, move_it_by_lines is likely to
15572 overshoot and stop not at the first, but the
15573 second character from the left margin. So in
15574 that case, we need a more tight control on the X
15575 coordinate of the iterator than move_it_by_lines
15576 promises in its contract. The method is to first
15577 go to the last (rightmost) visible character of a
15578 line, then move to the leftmost character on the
15579 next line in a separate call. */
15580 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15581 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15582 move_it_to (&it
, ZV
, 0,
15583 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15584 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15587 move_it_by_lines (&it
, 1);
15590 /* Set the window start there. */
15591 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15592 window_start_changed_p
= true;
15596 return window_start_changed_p
;
15600 /* Try cursor movement in case text has not changed in window WINDOW,
15601 with window start STARTP. Value is
15603 CURSOR_MOVEMENT_SUCCESS if successful
15605 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15607 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15608 display. *SCROLL_STEP is set to true, under certain circumstances, if
15609 we want to scroll as if scroll-step were set to 1. See the code.
15611 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15612 which case we have to abort this redisplay, and adjust matrices
15617 CURSOR_MOVEMENT_SUCCESS
,
15618 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15619 CURSOR_MOVEMENT_MUST_SCROLL
,
15620 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15624 try_cursor_movement (Lisp_Object window
, struct text_pos startp
,
15627 struct window
*w
= XWINDOW (window
);
15628 struct frame
*f
= XFRAME (w
->frame
);
15629 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15632 if (inhibit_try_cursor_movement
)
15636 /* Previously, there was a check for Lisp integer in the
15637 if-statement below. Now, this field is converted to
15638 ptrdiff_t, thus zero means invalid position in a buffer. */
15639 eassert (w
->last_point
> 0);
15640 /* Likewise there was a check whether window_end_vpos is nil or larger
15641 than the window. Now window_end_vpos is int and so never nil, but
15642 let's leave eassert to check whether it fits in the window. */
15643 eassert (!w
->window_end_valid
15644 || w
->window_end_vpos
< w
->current_matrix
->nrows
);
15646 /* Handle case where text has not changed, only point, and it has
15647 not moved off the frame. */
15648 if (/* Point may be in this window. */
15649 PT
>= CHARPOS (startp
)
15650 /* Selective display hasn't changed. */
15651 && !current_buffer
->clip_changed
15652 /* Function force-mode-line-update is used to force a thorough
15653 redisplay. It sets either windows_or_buffers_changed or
15654 update_mode_lines. So don't take a shortcut here for these
15656 && !update_mode_lines
15657 && !windows_or_buffers_changed
15658 && !f
->cursor_type_changed
15659 && NILP (Vshow_trailing_whitespace
)
15660 /* This code is not used for mini-buffer for the sake of the case
15661 of redisplaying to replace an echo area message; since in
15662 that case the mini-buffer contents per se are usually
15663 unchanged. This code is of no real use in the mini-buffer
15664 since the handling of this_line_start_pos, etc., in redisplay
15665 handles the same cases. */
15666 && !EQ (window
, minibuf_window
)
15667 && (FRAME_WINDOW_P (f
)
15668 || !overlay_arrow_in_current_buffer_p ()))
15670 int this_scroll_margin
, top_scroll_margin
;
15671 struct glyph_row
*row
= NULL
;
15672 int frame_line_height
= default_line_pixel_height (w
);
15673 int window_total_lines
15674 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15677 debug_method_add (w
, "cursor movement");
15680 /* Scroll if point within this distance from the top or bottom
15681 of the window. This is a pixel value. */
15682 if (scroll_margin
> 0)
15684 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15685 this_scroll_margin
*= frame_line_height
;
15688 this_scroll_margin
= 0;
15690 top_scroll_margin
= this_scroll_margin
;
15691 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15692 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15694 /* Start with the row the cursor was displayed during the last
15695 not paused redisplay. Give up if that row is not valid. */
15696 if (w
->last_cursor_vpos
< 0
15697 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15698 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15701 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15702 if (row
->mode_line_p
)
15704 if (!row
->enabled_p
)
15705 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15708 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15710 bool scroll_p
= false, must_scroll
= false;
15711 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15713 if (PT
> w
->last_point
)
15715 /* Point has moved forward. */
15716 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15717 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15719 eassert (row
->enabled_p
);
15723 /* If the end position of a row equals the start
15724 position of the next row, and PT is at that position,
15725 we would rather display cursor in the next line. */
15726 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15727 && MATRIX_ROW_END_CHARPOS (row
) == PT
15728 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15729 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15730 && !cursor_row_p (row
))
15733 /* If within the scroll margin, scroll. Note that
15734 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15735 the next line would be drawn, and that
15736 this_scroll_margin can be zero. */
15737 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15738 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15739 /* Line is completely visible last line in window
15740 and PT is to be set in the next line. */
15741 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15742 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15743 && !row
->ends_at_zv_p
15744 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15747 else if (PT
< w
->last_point
)
15749 /* Cursor has to be moved backward. Note that PT >=
15750 CHARPOS (startp) because of the outer if-statement. */
15751 while (!row
->mode_line_p
15752 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15753 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15754 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15755 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15756 row
> w
->current_matrix
->rows
15757 && (row
-1)->ends_in_newline_from_string_p
))))
15758 && (row
->y
> top_scroll_margin
15759 || CHARPOS (startp
) == BEGV
))
15761 eassert (row
->enabled_p
);
15765 /* Consider the following case: Window starts at BEGV,
15766 there is invisible, intangible text at BEGV, so that
15767 display starts at some point START > BEGV. It can
15768 happen that we are called with PT somewhere between
15769 BEGV and START. Try to handle that case. */
15770 if (row
< w
->current_matrix
->rows
15771 || row
->mode_line_p
)
15773 row
= w
->current_matrix
->rows
;
15774 if (row
->mode_line_p
)
15778 /* Due to newlines in overlay strings, we may have to
15779 skip forward over overlay strings. */
15780 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15781 && MATRIX_ROW_END_CHARPOS (row
) == PT
15782 && !cursor_row_p (row
))
15785 /* If within the scroll margin, scroll. */
15786 if (row
->y
< top_scroll_margin
15787 && CHARPOS (startp
) != BEGV
)
15792 /* Cursor did not move. So don't scroll even if cursor line
15793 is partially visible, as it was so before. */
15794 rc
= CURSOR_MOVEMENT_SUCCESS
;
15797 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15798 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15800 /* if PT is not in the glyph row, give up. */
15801 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15802 must_scroll
= true;
15804 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15805 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15807 struct glyph_row
*row1
;
15809 /* If rows are bidi-reordered and point moved, back up
15810 until we find a row that does not belong to a
15811 continuation line. This is because we must consider
15812 all rows of a continued line as candidates for the
15813 new cursor positioning, since row start and end
15814 positions change non-linearly with vertical position
15816 /* FIXME: Revisit this when glyph ``spilling'' in
15817 continuation lines' rows is implemented for
15818 bidi-reordered rows. */
15819 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15820 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15823 /* If we hit the beginning of the displayed portion
15824 without finding the first row of a continued
15828 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15831 eassert (row
->enabled_p
);
15836 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15837 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15838 /* Make sure this isn't a header line by any chance, since
15839 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield true. */
15840 && !row
->mode_line_p
15841 && make_cursor_line_fully_visible_p
)
15843 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15844 && !row
->ends_at_zv_p
15845 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15846 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15847 else if (row
->height
> window_box_height (w
))
15849 /* If we end up in a partially visible line, let's
15850 make it fully visible, except when it's taller
15851 than the window, in which case we can't do much
15853 *scroll_step
= true;
15854 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15858 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15859 if (!cursor_row_fully_visible_p (w
, false, true))
15860 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15862 rc
= CURSOR_MOVEMENT_SUCCESS
;
15866 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15867 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15868 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15870 /* With bidi-reordered rows, there could be more than
15871 one candidate row whose start and end positions
15872 occlude point. We need to let set_cursor_from_row
15873 find the best candidate. */
15874 /* FIXME: Revisit this when glyph ``spilling'' in
15875 continuation lines' rows is implemented for
15876 bidi-reordered rows. */
15881 bool at_zv_p
= false, exact_match_p
= false;
15883 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15884 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15885 && cursor_row_p (row
))
15886 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15888 /* As soon as we've found the exact match for point,
15889 or the first suitable row whose ends_at_zv_p flag
15890 is set, we are done. */
15893 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15894 w
->cursor
.vpos
)->ends_at_zv_p
;
15896 && w
->cursor
.hpos
>= 0
15897 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15900 struct glyph_row
*candidate
=
15901 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15903 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15904 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15907 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15908 || (NILP (g
->object
)
15909 && (g
->charpos
== PT
15910 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15912 if (at_zv_p
|| exact_match_p
)
15914 rc
= CURSOR_MOVEMENT_SUCCESS
;
15918 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15922 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15923 || row
->continued_p
)
15924 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15925 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15926 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15927 /* If we didn't find any candidate rows, or exited the
15928 loop before all the candidates were examined, signal
15929 to the caller that this method failed. */
15930 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15932 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15933 && !row
->continued_p
))
15934 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15936 rc
= CURSOR_MOVEMENT_SUCCESS
;
15942 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15944 rc
= CURSOR_MOVEMENT_SUCCESS
;
15949 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15950 && MATRIX_ROW_START_CHARPOS (row
) == PT
15951 && cursor_row_p (row
));
15961 set_vertical_scroll_bar (struct window
*w
)
15963 ptrdiff_t start
, end
, whole
;
15965 /* Calculate the start and end positions for the current window.
15966 At some point, it would be nice to choose between scrollbars
15967 which reflect the whole buffer size, with special markers
15968 indicating narrowing, and scrollbars which reflect only the
15971 Note that mini-buffers sometimes aren't displaying any text. */
15972 if (!MINI_WINDOW_P (w
)
15973 || (w
== XWINDOW (minibuf_window
)
15974 && NILP (echo_area_buffer
[0])))
15976 struct buffer
*buf
= XBUFFER (w
->contents
);
15977 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15978 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15979 /* I don't think this is guaranteed to be right. For the
15980 moment, we'll pretend it is. */
15981 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15985 if (whole
< (end
- start
))
15986 whole
= end
- start
;
15989 start
= end
= whole
= 0;
15991 /* Indicate what this scroll bar ought to be displaying now. */
15992 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15993 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15994 (w
, end
- start
, whole
, start
);
15999 set_horizontal_scroll_bar (struct window
*w
)
16001 int start
, end
, whole
, portion
;
16003 if (!MINI_WINDOW_P (w
)
16004 || (w
== XWINDOW (minibuf_window
)
16005 && NILP (echo_area_buffer
[0])))
16007 struct buffer
*b
= XBUFFER (w
->contents
);
16008 struct buffer
*old_buffer
= NULL
;
16010 struct text_pos startp
;
16012 if (b
!= current_buffer
)
16014 old_buffer
= current_buffer
;
16015 set_buffer_internal (b
);
16018 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16019 start_display (&it
, w
, startp
);
16020 it
.last_visible_x
= INT_MAX
;
16021 whole
= move_it_to (&it
, -1, INT_MAX
, window_box_height (w
), -1,
16022 MOVE_TO_X
| MOVE_TO_Y
);
16023 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
16024 window_box_height (w), -1,
16025 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
16027 start
= w
->hscroll
* FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
));
16028 end
= start
+ window_box_width (w
, TEXT_AREA
);
16029 portion
= end
- start
;
16030 /* After enlarging a horizontally scrolled window such that it
16031 gets at least as wide as the text it contains, make sure that
16032 the thumb doesn't fill the entire scroll bar so we can still
16033 drag it back to see the entire text. */
16034 whole
= max (whole
, end
);
16040 pdir
= Fcurrent_bidi_paragraph_direction (Qnil
);
16041 if (EQ (pdir
, Qright_to_left
))
16043 start
= whole
- end
;
16044 end
= start
+ portion
;
16049 set_buffer_internal (old_buffer
);
16052 start
= end
= whole
= portion
= 0;
16054 w
->hscroll_whole
= whole
;
16056 /* Indicate what this scroll bar ought to be displaying now. */
16057 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
16058 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
16059 (w
, portion
, whole
, start
);
16063 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P means only
16064 selected_window is redisplayed.
16066 We can return without actually redisplaying the window if fonts has been
16067 changed on window's frame. In that case, redisplay_internal will retry.
16069 As one of the important parts of redisplaying a window, we need to
16070 decide whether the previous window-start position (stored in the
16071 window's w->start marker position) is still valid, and if it isn't,
16072 recompute it. Some details about that:
16074 . The previous window-start could be in a continuation line, in
16075 which case we need to recompute it when the window width
16076 changes. See compute_window_start_on_continuation_line and its
16079 . The text that changed since last redisplay could include the
16080 previous window-start position. In that case, we try to salvage
16081 what we can from the current glyph matrix by calling
16082 try_scrolling, which see.
16084 . Some Emacs command could force us to use a specific window-start
16085 position by setting the window's force_start flag, or gently
16086 propose doing that by setting the window's optional_new_start
16087 flag. In these cases, we try using the specified start point if
16088 that succeeds (i.e. the window desired matrix is successfully
16089 recomputed, and point location is within the window). In case
16090 of optional_new_start, we first check if the specified start
16091 position is feasible, i.e. if it will allow point to be
16092 displayed in the window. If using the specified start point
16093 fails, e.g., if new fonts are needed to be loaded, we abort the
16094 redisplay cycle and leave it up to the next cycle to figure out
16097 . Note that the window's force_start flag is sometimes set by
16098 redisplay itself, when it decides that the previous window start
16099 point is fine and should be kept. Search for "goto force_start"
16100 below to see the details. Like the values of window-start
16101 specified outside of redisplay, these internally-deduced values
16102 are tested for feasibility, and ignored if found to be
16105 . Note that the function try_window, used to completely redisplay
16106 a window, accepts the window's start point as its argument.
16107 This is used several times in the redisplay code to control
16108 where the window start will be, according to user options such
16109 as scroll-conservatively, and also to ensure the screen line
16110 showing point will be fully (as opposed to partially) visible on
16114 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
16116 struct window
*w
= XWINDOW (window
);
16117 struct frame
*f
= XFRAME (w
->frame
);
16118 struct buffer
*buffer
= XBUFFER (w
->contents
);
16119 struct buffer
*old
= current_buffer
;
16120 struct text_pos lpoint
, opoint
, startp
;
16121 bool update_mode_line
;
16124 /* Record it now because it's overwritten. */
16125 bool current_matrix_up_to_date_p
= false;
16126 bool used_current_matrix_p
= false;
16127 /* This is less strict than current_matrix_up_to_date_p.
16128 It indicates that the buffer contents and narrowing are unchanged. */
16129 bool buffer_unchanged_p
= false;
16130 bool temp_scroll_step
= false;
16131 ptrdiff_t count
= SPECPDL_INDEX ();
16133 int centering_position
= -1;
16134 bool last_line_misfit
= false;
16135 ptrdiff_t beg_unchanged
, end_unchanged
;
16136 int frame_line_height
;
16137 bool use_desired_matrix
;
16139 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16143 *w
->desired_matrix
->method
= 0;
16146 if (!just_this_one_p
16147 && REDISPLAY_SOME_P ()
16149 && !w
->update_mode_line
16152 && !buffer
->text
->redisplay
16153 && BUF_PT (buffer
) == w
->last_point
)
16156 /* Make sure that both W's markers are valid. */
16157 eassert (XMARKER (w
->start
)->buffer
== buffer
);
16158 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
16160 /* We come here again if we need to run window-text-change-functions
16163 reconsider_clip_changes (w
);
16164 frame_line_height
= default_line_pixel_height (w
);
16166 /* Has the mode line to be updated? */
16167 update_mode_line
= (w
->update_mode_line
16168 || update_mode_lines
16169 || buffer
->clip_changed
16170 || buffer
->prevent_redisplay_optimizations_p
);
16172 if (!just_this_one_p
)
16173 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
16174 cleverly elsewhere. */
16175 w
->must_be_updated_p
= true;
16177 if (MINI_WINDOW_P (w
))
16179 if (w
== XWINDOW (echo_area_window
)
16180 && !NILP (echo_area_buffer
[0]))
16182 if (update_mode_line
)
16183 /* We may have to update a tty frame's menu bar or a
16184 tool-bar. Example `M-x C-h C-h C-g'. */
16185 goto finish_menu_bars
;
16187 /* We've already displayed the echo area glyphs in this window. */
16188 goto finish_scroll_bars
;
16190 else if ((w
!= XWINDOW (minibuf_window
)
16191 || minibuf_level
== 0)
16192 /* When buffer is nonempty, redisplay window normally. */
16193 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
16194 /* Quail displays non-mini buffers in minibuffer window.
16195 In that case, redisplay the window normally. */
16196 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
16198 /* W is a mini-buffer window, but it's not active, so clear
16200 int yb
= window_text_bottom_y (w
);
16201 struct glyph_row
*row
;
16204 for (y
= 0, row
= w
->desired_matrix
->rows
;
16206 y
+= row
->height
, ++row
)
16207 blank_row (w
, row
, y
);
16208 goto finish_scroll_bars
;
16211 clear_glyph_matrix (w
->desired_matrix
);
16214 /* Otherwise set up data on this window; select its buffer and point
16216 /* Really select the buffer, for the sake of buffer-local
16218 set_buffer_internal_1 (XBUFFER (w
->contents
));
16220 current_matrix_up_to_date_p
16221 = (w
->window_end_valid
16222 && !current_buffer
->clip_changed
16223 && !current_buffer
->prevent_redisplay_optimizations_p
16224 && !window_outdated (w
));
16226 /* Run the window-text-change-functions
16227 if it is possible that the text on the screen has changed
16228 (either due to modification of the text, or any other reason). */
16229 if (!current_matrix_up_to_date_p
16230 && !NILP (Vwindow_text_change_functions
))
16232 safe_run_hooks (Qwindow_text_change_functions
);
16236 beg_unchanged
= BEG_UNCHANGED
;
16237 end_unchanged
= END_UNCHANGED
;
16239 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
16241 specbind (Qinhibit_point_motion_hooks
, Qt
);
16244 = (w
->window_end_valid
16245 && !current_buffer
->clip_changed
16246 && !window_outdated (w
));
16248 /* When windows_or_buffers_changed is non-zero, we can't rely
16249 on the window end being valid, so set it to zero there. */
16250 if (windows_or_buffers_changed
)
16252 /* If window starts on a continuation line, maybe adjust the
16253 window start in case the window's width changed. */
16254 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16255 compute_window_start_on_continuation_line (w
);
16257 w
->window_end_valid
= false;
16258 /* If so, we also can't rely on current matrix
16259 and should not fool try_cursor_movement below. */
16260 current_matrix_up_to_date_p
= false;
16263 /* Some sanity checks. */
16264 CHECK_WINDOW_END (w
);
16265 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16267 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16270 if (mode_line_update_needed (w
))
16271 update_mode_line
= true;
16273 /* Point refers normally to the selected window. For any other
16274 window, set up appropriate value. */
16275 if (!EQ (window
, selected_window
))
16277 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16278 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16283 new_pt_byte
= BEGV_BYTE
;
16284 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16286 else if (new_pt
> (ZV
- 1))
16289 new_pt_byte
= ZV_BYTE
;
16290 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16293 /* We don't use SET_PT so that the point-motion hooks don't run. */
16294 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16297 /* If any of the character widths specified in the display table
16298 have changed, invalidate the width run cache. It's true that
16299 this may be a bit late to catch such changes, but the rest of
16300 redisplay goes (non-fatally) haywire when the display table is
16301 changed, so why should we worry about doing any better? */
16302 if (current_buffer
->width_run_cache
16303 || (current_buffer
->base_buffer
16304 && current_buffer
->base_buffer
->width_run_cache
))
16306 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16308 if (! disptab_matches_widthtab
16309 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16311 struct buffer
*buf
= current_buffer
;
16313 if (buf
->base_buffer
)
16314 buf
= buf
->base_buffer
;
16315 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16316 recompute_width_table (current_buffer
, disptab
);
16320 /* If window-start is screwed up, choose a new one. */
16321 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16324 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16326 /* If someone specified a new starting point but did not insist,
16327 check whether it can be used. */
16328 if ((w
->optional_new_start
|| window_frozen_p (w
))
16329 && CHARPOS (startp
) >= BEGV
16330 && CHARPOS (startp
) <= ZV
)
16332 ptrdiff_t it_charpos
;
16334 w
->optional_new_start
= false;
16335 start_display (&it
, w
, startp
);
16336 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16337 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16338 /* Record IT's position now, since line_bottom_y might change
16340 it_charpos
= IT_CHARPOS (it
);
16341 /* Make sure we set the force_start flag only if the cursor row
16342 will be fully visible. Otherwise, the code under force_start
16343 label below will try to move point back into view, which is
16344 not what the code which sets optional_new_start wants. */
16345 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
16346 && !w
->force_start
)
16348 if (it_charpos
== PT
)
16349 w
->force_start
= true;
16350 /* IT may overshoot PT if text at PT is invisible. */
16351 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16352 w
->force_start
= true;
16354 if (w
->force_start
)
16356 if (window_frozen_p (w
))
16357 debug_method_add (w
, "set force_start from frozen window start");
16359 debug_method_add (w
, "set force_start from optional_new_start");
16367 /* Handle case where place to start displaying has been specified,
16368 unless the specified location is outside the accessible range. */
16369 if (w
->force_start
)
16371 /* We set this later on if we have to adjust point. */
16374 w
->force_start
= false;
16376 w
->window_end_valid
= false;
16378 /* Forget any recorded base line for line number display. */
16379 if (!buffer_unchanged_p
)
16380 w
->base_line_number
= 0;
16382 /* Redisplay the mode line. Select the buffer properly for that.
16383 Also, run the hook window-scroll-functions
16384 because we have scrolled. */
16385 /* Note, we do this after clearing force_start because
16386 if there's an error, it is better to forget about force_start
16387 than to get into an infinite loop calling the hook functions
16388 and having them get more errors. */
16389 if (!update_mode_line
16390 || ! NILP (Vwindow_scroll_functions
))
16392 update_mode_line
= true;
16393 w
->update_mode_line
= true;
16394 startp
= run_window_scroll_functions (window
, startp
);
16397 if (CHARPOS (startp
) < BEGV
)
16398 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16399 else if (CHARPOS (startp
) > ZV
)
16400 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16402 /* Redisplay, then check if cursor has been set during the
16403 redisplay. Give up if new fonts were loaded. */
16404 /* We used to issue a CHECK_MARGINS argument to try_window here,
16405 but this causes scrolling to fail when point begins inside
16406 the scroll margin (bug#148) -- cyd */
16407 if (!try_window (window
, startp
, 0))
16409 w
->force_start
= true;
16410 clear_glyph_matrix (w
->desired_matrix
);
16411 goto need_larger_matrices
;
16414 if (w
->cursor
.vpos
< 0)
16416 /* If point does not appear, try to move point so it does
16417 appear. The desired matrix has been built above, so we
16418 can use it here. First see if point is in invisible
16419 text, and if so, move it to the first visible buffer
16420 position past that. */
16421 struct glyph_row
*r
= NULL
;
16422 Lisp_Object invprop
=
16423 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16426 if (TEXT_PROP_MEANS_INVISIBLE (invprop
) != 0)
16429 Lisp_Object invprop_end
=
16430 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16433 if (NATNUMP (invprop_end
))
16434 alt_pt
= XFASTINT (invprop_end
);
16437 r
= row_containing_pos (w
, alt_pt
, w
->desired_matrix
->rows
,
16441 new_vpos
= MATRIX_ROW_BOTTOM_Y (r
);
16442 else /* Give up and just move to the middle of the window. */
16443 new_vpos
= window_box_height (w
) / 2;
16446 if (!cursor_row_fully_visible_p (w
, false, false))
16448 /* Point does appear, but on a line partly visible at end of window.
16449 Move it back to a fully-visible line. */
16450 new_vpos
= window_box_height (w
);
16451 /* But if window_box_height suggests a Y coordinate that is
16452 not less than we already have, that line will clearly not
16453 be fully visible, so give up and scroll the display.
16454 This can happen when the default face uses a font whose
16455 dimensions are different from the frame's default
16457 if (new_vpos
>= w
->cursor
.y
)
16459 w
->cursor
.vpos
= -1;
16460 clear_glyph_matrix (w
->desired_matrix
);
16461 goto try_to_scroll
;
16464 else if (w
->cursor
.vpos
>= 0)
16466 /* Some people insist on not letting point enter the scroll
16467 margin, even though this part handles windows that didn't
16469 int window_total_lines
16470 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16471 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16472 int pixel_margin
= margin
* frame_line_height
;
16473 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16475 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16476 below, which finds the row to move point to, advances by
16477 the Y coordinate of the _next_ row, see the definition of
16478 MATRIX_ROW_BOTTOM_Y. */
16479 if (w
->cursor
.vpos
< margin
+ header_line
)
16481 w
->cursor
.vpos
= -1;
16482 clear_glyph_matrix (w
->desired_matrix
);
16483 goto try_to_scroll
;
16487 int window_height
= window_box_height (w
);
16490 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16491 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16493 w
->cursor
.vpos
= -1;
16494 clear_glyph_matrix (w
->desired_matrix
);
16495 goto try_to_scroll
;
16500 /* If we need to move point for either of the above reasons,
16501 now actually do it. */
16504 struct glyph_row
*row
;
16506 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16507 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16510 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16511 MATRIX_ROW_START_BYTEPOS (row
));
16513 if (w
!= XWINDOW (selected_window
))
16514 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16515 else if (current_buffer
== old
)
16516 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16518 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16520 /* Re-run pre-redisplay-function so it can update the region
16521 according to the new position of point. */
16522 /* Other than the cursor, w's redisplay is done so we can set its
16523 redisplay to false. Also the buffer's redisplay can be set to
16524 false, since propagate_buffer_redisplay should have already
16525 propagated its info to `w' anyway. */
16526 w
->redisplay
= false;
16527 XBUFFER (w
->contents
)->text
->redisplay
= false;
16528 safe__call1 (true, Vpre_redisplay_function
, Fcons (window
, Qnil
));
16530 if (w
->redisplay
|| XBUFFER (w
->contents
)->text
->redisplay
)
16532 /* pre-redisplay-function made changes (e.g. move the region)
16533 that require another round of redisplay. */
16534 clear_glyph_matrix (w
->desired_matrix
);
16535 if (!try_window (window
, startp
, 0))
16536 goto need_larger_matrices
;
16539 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, false, false))
16541 clear_glyph_matrix (w
->desired_matrix
);
16542 goto try_to_scroll
;
16546 debug_method_add (w
, "forced window start");
16551 /* Handle case where text has not changed, only point, and it has
16552 not moved off the frame, and we are not retrying after hscroll.
16553 (current_matrix_up_to_date_p is true when retrying.) */
16554 if (current_matrix_up_to_date_p
16555 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16556 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16560 case CURSOR_MOVEMENT_SUCCESS
:
16561 used_current_matrix_p
= true;
16564 case CURSOR_MOVEMENT_MUST_SCROLL
:
16565 goto try_to_scroll
;
16571 /* If current starting point was originally the beginning of a line
16572 but no longer is, find a new starting point. */
16573 else if (w
->start_at_line_beg
16574 && !(CHARPOS (startp
) <= BEGV
16575 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16578 debug_method_add (w
, "recenter 1");
16583 /* Try scrolling with try_window_id. Value is > 0 if update has
16584 been done, it is -1 if we know that the same window start will
16585 not work. It is 0 if unsuccessful for some other reason. */
16586 else if ((tem
= try_window_id (w
)) != 0)
16589 debug_method_add (w
, "try_window_id %d", tem
);
16592 if (f
->fonts_changed
)
16593 goto need_larger_matrices
;
16597 /* Otherwise try_window_id has returned -1 which means that we
16598 don't want the alternative below this comment to execute. */
16600 else if (CHARPOS (startp
) >= BEGV
16601 && CHARPOS (startp
) <= ZV
16602 && PT
>= CHARPOS (startp
)
16603 && (CHARPOS (startp
) < ZV
16604 /* Avoid starting at end of buffer. */
16605 || CHARPOS (startp
) == BEGV
16606 || !window_outdated (w
)))
16608 int d1
, d2
, d5
, d6
;
16611 /* If first window line is a continuation line, and window start
16612 is inside the modified region, but the first change is before
16613 current window start, we must select a new window start.
16615 However, if this is the result of a down-mouse event (e.g. by
16616 extending the mouse-drag-overlay), we don't want to select a
16617 new window start, since that would change the position under
16618 the mouse, resulting in an unwanted mouse-movement rather
16619 than a simple mouse-click. */
16620 if (!w
->start_at_line_beg
16621 && NILP (do_mouse_tracking
)
16622 && CHARPOS (startp
) > BEGV
16623 && CHARPOS (startp
) > BEG
+ beg_unchanged
16624 && CHARPOS (startp
) <= Z
- end_unchanged
16625 /* Even if w->start_at_line_beg is nil, a new window may
16626 start at a line_beg, since that's how set_buffer_window
16627 sets it. So, we need to check the return value of
16628 compute_window_start_on_continuation_line. (See also
16630 && XMARKER (w
->start
)->buffer
== current_buffer
16631 && compute_window_start_on_continuation_line (w
)
16632 /* It doesn't make sense to force the window start like we
16633 do at label force_start if it is already known that point
16634 will not be fully visible in the resulting window, because
16635 doing so will move point from its correct position
16636 instead of scrolling the window to bring point into view.
16638 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16639 /* A very tall row could need more than the window height,
16640 in which case we accept that it is partially visible. */
16641 && (rtop
!= 0) == (rbot
!= 0))
16643 w
->force_start
= true;
16644 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16646 debug_method_add (w
, "recomputed window start in continuation line");
16652 debug_method_add (w
, "same window start");
16655 /* Try to redisplay starting at same place as before.
16656 If point has not moved off frame, accept the results. */
16657 if (!current_matrix_up_to_date_p
16658 /* Don't use try_window_reusing_current_matrix in this case
16659 because a window scroll function can have changed the
16661 || !NILP (Vwindow_scroll_functions
)
16662 || MINI_WINDOW_P (w
)
16663 || !(used_current_matrix_p
16664 = try_window_reusing_current_matrix (w
)))
16666 IF_DEBUG (debug_method_add (w
, "1"));
16667 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16668 /* -1 means we need to scroll.
16669 0 means we need new matrices, but fonts_changed
16670 is set in that case, so we will detect it below. */
16671 goto try_to_scroll
;
16674 if (f
->fonts_changed
)
16675 goto need_larger_matrices
;
16677 if (w
->cursor
.vpos
>= 0)
16679 if (!just_this_one_p
16680 || current_buffer
->clip_changed
16681 || BEG_UNCHANGED
< CHARPOS (startp
))
16682 /* Forget any recorded base line for line number display. */
16683 w
->base_line_number
= 0;
16685 if (!cursor_row_fully_visible_p (w
, true, false))
16687 clear_glyph_matrix (w
->desired_matrix
);
16688 last_line_misfit
= true;
16690 /* Drop through and scroll. */
16695 clear_glyph_matrix (w
->desired_matrix
);
16700 /* Redisplay the mode line. Select the buffer properly for that. */
16701 if (!update_mode_line
)
16703 update_mode_line
= true;
16704 w
->update_mode_line
= true;
16707 /* Try to scroll by specified few lines. */
16708 if ((scroll_conservatively
16709 || emacs_scroll_step
16710 || temp_scroll_step
16711 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16712 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16713 && CHARPOS (startp
) >= BEGV
16714 && CHARPOS (startp
) <= ZV
)
16716 /* The function returns -1 if new fonts were loaded, 1 if
16717 successful, 0 if not successful. */
16718 int ss
= try_scrolling (window
, just_this_one_p
,
16719 scroll_conservatively
,
16721 temp_scroll_step
, last_line_misfit
);
16724 case SCROLLING_SUCCESS
:
16727 case SCROLLING_NEED_LARGER_MATRICES
:
16728 goto need_larger_matrices
;
16730 case SCROLLING_FAILED
:
16738 /* Finally, just choose a place to start which positions point
16739 according to user preferences. */
16744 debug_method_add (w
, "recenter");
16747 /* Forget any previously recorded base line for line number display. */
16748 if (!buffer_unchanged_p
)
16749 w
->base_line_number
= 0;
16751 /* Determine the window start relative to point. */
16752 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16753 it
.current_y
= it
.last_visible_y
;
16754 if (centering_position
< 0)
16756 int window_total_lines
16757 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16759 = scroll_margin
> 0
16760 ? min (scroll_margin
, window_total_lines
/ 4)
16762 ptrdiff_t margin_pos
= CHARPOS (startp
);
16763 Lisp_Object aggressive
;
16766 /* If there is a scroll margin at the top of the window, find
16767 its character position. */
16769 /* Cannot call start_display if startp is not in the
16770 accessible region of the buffer. This can happen when we
16771 have just switched to a different buffer and/or changed
16772 its restriction. In that case, startp is initialized to
16773 the character position 1 (BEGV) because we did not yet
16774 have chance to display the buffer even once. */
16775 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16778 void *it1data
= NULL
;
16780 SAVE_IT (it1
, it
, it1data
);
16781 start_display (&it1
, w
, startp
);
16782 move_it_vertically (&it1
, margin
* frame_line_height
);
16783 margin_pos
= IT_CHARPOS (it1
);
16784 RESTORE_IT (&it
, &it
, it1data
);
16786 scrolling_up
= PT
> margin_pos
;
16789 ? BVAR (current_buffer
, scroll_up_aggressively
)
16790 : BVAR (current_buffer
, scroll_down_aggressively
);
16792 if (!MINI_WINDOW_P (w
)
16793 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16797 /* Setting scroll-conservatively overrides
16798 scroll-*-aggressively. */
16799 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16801 double float_amount
= XFLOATINT (aggressive
);
16803 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16804 if (pt_offset
== 0 && float_amount
> 0)
16806 if (pt_offset
&& margin
> 0)
16809 /* Compute how much to move the window start backward from
16810 point so that point will be displayed where the user
16814 centering_position
= it
.last_visible_y
;
16816 centering_position
-= pt_offset
;
16817 centering_position
-=
16818 (frame_line_height
* (1 + margin
+ last_line_misfit
)
16819 + WINDOW_HEADER_LINE_HEIGHT (w
));
16820 /* Don't let point enter the scroll margin near top of
16822 if (centering_position
< margin
* frame_line_height
)
16823 centering_position
= margin
* frame_line_height
;
16826 centering_position
= margin
* frame_line_height
+ pt_offset
;
16829 /* Set the window start half the height of the window backward
16831 centering_position
= window_box_height (w
) / 2;
16833 move_it_vertically_backward (&it
, centering_position
);
16835 eassert (IT_CHARPOS (it
) >= BEGV
);
16837 /* The function move_it_vertically_backward may move over more
16838 than the specified y-distance. If it->w is small, e.g. a
16839 mini-buffer window, we may end up in front of the window's
16840 display area. Start displaying at the start of the line
16841 containing PT in this case. */
16842 if (it
.current_y
<= 0)
16844 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16845 move_it_vertically_backward (&it
, 0);
16849 it
.current_x
= it
.hpos
= 0;
16851 /* Set the window start position here explicitly, to avoid an
16852 infinite loop in case the functions in window-scroll-functions
16854 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16856 /* Run scroll hooks. */
16857 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16859 /* Redisplay the window. */
16860 use_desired_matrix
= false;
16861 if (!current_matrix_up_to_date_p
16862 || windows_or_buffers_changed
16863 || f
->cursor_type_changed
16864 /* Don't use try_window_reusing_current_matrix in this case
16865 because it can have changed the buffer. */
16866 || !NILP (Vwindow_scroll_functions
)
16867 || !just_this_one_p
16868 || MINI_WINDOW_P (w
)
16869 || !(used_current_matrix_p
16870 = try_window_reusing_current_matrix (w
)))
16871 use_desired_matrix
= (try_window (window
, startp
, 0) == 1);
16873 /* If new fonts have been loaded (due to fontsets), give up. We
16874 have to start a new redisplay since we need to re-adjust glyph
16876 if (f
->fonts_changed
)
16877 goto need_larger_matrices
;
16879 /* If cursor did not appear assume that the middle of the window is
16880 in the first line of the window. Do it again with the next line.
16881 (Imagine a window of height 100, displaying two lines of height
16882 60. Moving back 50 from it->last_visible_y will end in the first
16884 if (w
->cursor
.vpos
< 0)
16886 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16888 clear_glyph_matrix (w
->desired_matrix
);
16889 move_it_by_lines (&it
, 1);
16890 try_window (window
, it
.current
.pos
, 0);
16892 else if (PT
< IT_CHARPOS (it
))
16894 clear_glyph_matrix (w
->desired_matrix
);
16895 move_it_by_lines (&it
, -1);
16896 try_window (window
, it
.current
.pos
, 0);
16900 /* Not much we can do about it. */
16904 /* Consider the following case: Window starts at BEGV, there is
16905 invisible, intangible text at BEGV, so that display starts at
16906 some point START > BEGV. It can happen that we are called with
16907 PT somewhere between BEGV and START. Try to handle that case,
16908 and similar ones. */
16909 if (w
->cursor
.vpos
< 0)
16911 /* Prefer the desired matrix to the current matrix, if possible,
16912 in the fallback calculations below. This is because using
16913 the current matrix might completely goof, e.g. if its first
16914 row is after point. */
16915 struct glyph_matrix
*matrix
=
16916 use_desired_matrix
? w
->desired_matrix
: w
->current_matrix
;
16917 /* First, try locating the proper glyph row for PT. */
16918 struct glyph_row
*row
=
16919 row_containing_pos (w
, PT
, matrix
->rows
, NULL
, 0);
16921 /* Sometimes point is at the beginning of invisible text that is
16922 before the 1st character displayed in the row. In that case,
16923 row_containing_pos fails to find the row, because no glyphs
16924 with appropriate buffer positions are present in the row.
16925 Therefore, we next try to find the row which shows the 1st
16926 position after the invisible text. */
16930 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16933 if (TEXT_PROP_MEANS_INVISIBLE (val
) != 0)
16936 Lisp_Object invis_end
=
16937 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16940 if (NATNUMP (invis_end
))
16941 alt_pos
= XFASTINT (invis_end
);
16944 row
= row_containing_pos (w
, alt_pos
, matrix
->rows
, NULL
, 0);
16947 /* Finally, fall back on the first row of the window after the
16948 header line (if any). This is slightly better than not
16949 displaying the cursor at all. */
16952 row
= matrix
->rows
;
16953 if (row
->mode_line_p
)
16956 set_cursor_from_row (w
, row
, matrix
, 0, 0, 0, 0);
16959 if (!cursor_row_fully_visible_p (w
, false, false))
16961 /* If vscroll is enabled, disable it and try again. */
16965 clear_glyph_matrix (w
->desired_matrix
);
16969 /* Users who set scroll-conservatively to a large number want
16970 point just above/below the scroll margin. If we ended up
16971 with point's row partially visible, move the window start to
16972 make that row fully visible and out of the margin. */
16973 if (scroll_conservatively
> SCROLL_LIMIT
)
16975 int window_total_lines
16976 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16979 ? min (scroll_margin
, window_total_lines
/ 4)
16981 bool move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16983 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16984 clear_glyph_matrix (w
->desired_matrix
);
16985 if (1 == try_window (window
, it
.current
.pos
,
16986 TRY_WINDOW_CHECK_MARGINS
))
16990 /* If centering point failed to make the whole line visible,
16991 put point at the top instead. That has to make the whole line
16992 visible, if it can be done. */
16993 if (centering_position
== 0)
16996 clear_glyph_matrix (w
->desired_matrix
);
16997 centering_position
= 0;
17003 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
17004 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
17005 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
17007 /* Display the mode line, if we must. */
17008 if ((update_mode_line
17009 /* If window not full width, must redo its mode line
17010 if (a) the window to its side is being redone and
17011 (b) we do a frame-based redisplay. This is a consequence
17012 of how inverted lines are drawn in frame-based redisplay. */
17013 || (!just_this_one_p
17014 && !FRAME_WINDOW_P (f
)
17015 && !WINDOW_FULL_WIDTH_P (w
))
17016 /* Line number to display. */
17017 || w
->base_line_pos
> 0
17018 /* Column number is displayed and different from the one displayed. */
17019 || (w
->column_number_displayed
!= -1
17020 && (w
->column_number_displayed
!= current_column ())))
17021 /* This means that the window has a mode line. */
17022 && (WINDOW_WANTS_MODELINE_P (w
)
17023 || WINDOW_WANTS_HEADER_LINE_P (w
)))
17026 display_mode_lines (w
);
17028 /* If mode line height has changed, arrange for a thorough
17029 immediate redisplay using the correct mode line height. */
17030 if (WINDOW_WANTS_MODELINE_P (w
)
17031 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
17033 f
->fonts_changed
= true;
17034 w
->mode_line_height
= -1;
17035 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
17036 = DESIRED_MODE_LINE_HEIGHT (w
);
17039 /* If header line height has changed, arrange for a thorough
17040 immediate redisplay using the correct header line height. */
17041 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17042 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
17044 f
->fonts_changed
= true;
17045 w
->header_line_height
= -1;
17046 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
17047 = DESIRED_HEADER_LINE_HEIGHT (w
);
17050 if (f
->fonts_changed
)
17051 goto need_larger_matrices
;
17054 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
17056 w
->base_line_pos
= 0;
17057 w
->base_line_number
= 0;
17062 /* When we reach a frame's selected window, redo the frame's menu
17063 bar and the frame's title. */
17064 if (update_mode_line
17065 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
17067 bool redisplay_menu_p
;
17069 if (FRAME_WINDOW_P (f
))
17071 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
17072 || defined (HAVE_NS) || defined (USE_GTK)
17073 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
17075 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
17079 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
17081 if (redisplay_menu_p
)
17082 display_menu_bar (w
);
17084 #ifdef HAVE_WINDOW_SYSTEM
17085 if (FRAME_WINDOW_P (f
))
17087 #if defined (USE_GTK) || defined (HAVE_NS)
17088 if (FRAME_EXTERNAL_TOOL_BAR (f
))
17089 redisplay_tool_bar (f
);
17091 if (WINDOWP (f
->tool_bar_window
)
17092 && (FRAME_TOOL_BAR_LINES (f
) > 0
17093 || !NILP (Vauto_resize_tool_bars
))
17094 && redisplay_tool_bar (f
))
17095 ignore_mouse_drag_p
= true;
17098 ptrdiff_t count1
= SPECPDL_INDEX ();
17099 /* x_consider_frame_title calls select-frame, which calls
17100 resize_mini_window, which could resize the mini-window and by
17101 that undo the effect of this redisplay cycle wrt minibuffer
17102 and echo-area display. Binding inhibit-redisplay to t makes
17103 the call to resize_mini_window a no-op, thus avoiding the
17104 adverse side effects. */
17105 specbind (Qinhibit_redisplay
, Qt
);
17106 x_consider_frame_title (w
->frame
);
17107 unbind_to (count1
, Qnil
);
17111 #ifdef HAVE_WINDOW_SYSTEM
17112 if (FRAME_WINDOW_P (f
)
17113 && update_window_fringes (w
, (just_this_one_p
17114 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
17115 || w
->pseudo_window_p
)))
17119 if (draw_window_fringes (w
, true))
17121 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
17122 x_draw_right_divider (w
);
17124 x_draw_vertical_border (w
);
17130 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
17131 x_draw_bottom_divider (w
);
17132 #endif /* HAVE_WINDOW_SYSTEM */
17134 /* We go to this label, with fonts_changed set, if it is
17135 necessary to try again using larger glyph matrices.
17136 We have to redeem the scroll bar even in this case,
17137 because the loop in redisplay_internal expects that. */
17138 need_larger_matrices
:
17140 finish_scroll_bars
:
17142 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
17144 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
17145 /* Set the thumb's position and size. */
17146 set_vertical_scroll_bar (w
);
17148 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
17149 /* Set the thumb's position and size. */
17150 set_horizontal_scroll_bar (w
);
17152 /* Note that we actually used the scroll bar attached to this
17153 window, so it shouldn't be deleted at the end of redisplay. */
17154 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
17155 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
17158 /* Restore current_buffer and value of point in it. The window
17159 update may have changed the buffer, so first make sure `opoint'
17160 is still valid (Bug#6177). */
17161 if (CHARPOS (opoint
) < BEGV
)
17162 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
17163 else if (CHARPOS (opoint
) > ZV
)
17164 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
17166 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
17168 set_buffer_internal_1 (old
);
17169 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
17170 shorter. This can be caused by log truncation in *Messages*. */
17171 if (CHARPOS (lpoint
) <= ZV
)
17172 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
17174 unbind_to (count
, Qnil
);
17178 /* Build the complete desired matrix of WINDOW with a window start
17179 buffer position POS.
17181 Value is 1 if successful. It is zero if fonts were loaded during
17182 redisplay which makes re-adjusting glyph matrices necessary, and -1
17183 if point would appear in the scroll margins.
17184 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
17185 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
17189 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
17191 struct window
*w
= XWINDOW (window
);
17193 struct glyph_row
*last_text_row
= NULL
;
17194 struct frame
*f
= XFRAME (w
->frame
);
17195 int frame_line_height
= default_line_pixel_height (w
);
17197 /* Make POS the new window start. */
17198 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
17200 /* Mark cursor position as unknown. No overlay arrow seen. */
17201 w
->cursor
.vpos
= -1;
17202 overlay_arrow_seen
= false;
17204 /* Initialize iterator and info to start at POS. */
17205 start_display (&it
, w
, pos
);
17206 it
.glyph_row
->reversed_p
= false;
17208 /* Display all lines of W. */
17209 while (it
.current_y
< it
.last_visible_y
)
17211 if (display_line (&it
))
17212 last_text_row
= it
.glyph_row
- 1;
17213 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
17217 /* Don't let the cursor end in the scroll margins. */
17218 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
17219 && !MINI_WINDOW_P (w
))
17221 int this_scroll_margin
;
17222 int window_total_lines
17223 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
17225 if (scroll_margin
> 0)
17227 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
17228 this_scroll_margin
*= frame_line_height
;
17231 this_scroll_margin
= 0;
17233 if ((w
->cursor
.y
>= 0 /* not vscrolled */
17234 && w
->cursor
.y
< this_scroll_margin
17235 && CHARPOS (pos
) > BEGV
17236 && IT_CHARPOS (it
) < ZV
)
17237 /* rms: considering make_cursor_line_fully_visible_p here
17238 seems to give wrong results. We don't want to recenter
17239 when the last line is partly visible, we want to allow
17240 that case to be handled in the usual way. */
17241 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
17243 w
->cursor
.vpos
= -1;
17244 clear_glyph_matrix (w
->desired_matrix
);
17249 /* If bottom moved off end of frame, change mode line percentage. */
17250 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
17251 w
->update_mode_line
= true;
17253 /* Set window_end_pos to the offset of the last character displayed
17254 on the window from the end of current_buffer. Set
17255 window_end_vpos to its row number. */
17258 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
17259 adjust_window_ends (w
, last_text_row
, false);
17261 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
17262 w
->window_end_vpos
)));
17266 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17267 w
->window_end_pos
= Z
- ZV
;
17268 w
->window_end_vpos
= 0;
17271 /* But that is not valid info until redisplay finishes. */
17272 w
->window_end_valid
= false;
17278 /************************************************************************
17279 Window redisplay reusing current matrix when buffer has not changed
17280 ************************************************************************/
17282 /* Try redisplay of window W showing an unchanged buffer with a
17283 different window start than the last time it was displayed by
17284 reusing its current matrix. Value is true if successful.
17285 W->start is the new window start. */
17288 try_window_reusing_current_matrix (struct window
*w
)
17290 struct frame
*f
= XFRAME (w
->frame
);
17291 struct glyph_row
*bottom_row
;
17294 struct text_pos start
, new_start
;
17295 int nrows_scrolled
, i
;
17296 struct glyph_row
*last_text_row
;
17297 struct glyph_row
*last_reused_text_row
;
17298 struct glyph_row
*start_row
;
17299 int start_vpos
, min_y
, max_y
;
17302 if (inhibit_try_window_reusing
)
17306 if (/* This function doesn't handle terminal frames. */
17307 !FRAME_WINDOW_P (f
)
17308 /* Don't try to reuse the display if windows have been split
17310 || windows_or_buffers_changed
17311 || f
->cursor_type_changed
)
17314 /* Can't do this if showing trailing whitespace. */
17315 if (!NILP (Vshow_trailing_whitespace
))
17318 /* If top-line visibility has changed, give up. */
17319 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17320 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17323 /* Give up if old or new display is scrolled vertically. We could
17324 make this function handle this, but right now it doesn't. */
17325 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17326 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17329 /* The variable new_start now holds the new window start. The old
17330 start `start' can be determined from the current matrix. */
17331 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17332 start
= start_row
->minpos
;
17333 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17335 /* Clear the desired matrix for the display below. */
17336 clear_glyph_matrix (w
->desired_matrix
);
17338 if (CHARPOS (new_start
) <= CHARPOS (start
))
17340 /* Don't use this method if the display starts with an ellipsis
17341 displayed for invisible text. It's not easy to handle that case
17342 below, and it's certainly not worth the effort since this is
17343 not a frequent case. */
17344 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17347 IF_DEBUG (debug_method_add (w
, "twu1"));
17349 /* Display up to a row that can be reused. The variable
17350 last_text_row is set to the last row displayed that displays
17351 text. Note that it.vpos == 0 if or if not there is a
17352 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17353 start_display (&it
, w
, new_start
);
17354 w
->cursor
.vpos
= -1;
17355 last_text_row
= last_reused_text_row
= NULL
;
17357 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17359 /* If we have reached into the characters in the START row,
17360 that means the line boundaries have changed. So we
17361 can't start copying with the row START. Maybe it will
17362 work to start copying with the following row. */
17363 while (IT_CHARPOS (it
) > CHARPOS (start
))
17365 /* Advance to the next row as the "start". */
17367 start
= start_row
->minpos
;
17368 /* If there are no more rows to try, or just one, give up. */
17369 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17370 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17371 || CHARPOS (start
) == ZV
)
17373 clear_glyph_matrix (w
->desired_matrix
);
17377 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17379 /* If we have reached alignment, we can copy the rest of the
17381 if (IT_CHARPOS (it
) == CHARPOS (start
)
17382 /* Don't accept "alignment" inside a display vector,
17383 since start_row could have started in the middle of
17384 that same display vector (thus their character
17385 positions match), and we have no way of telling if
17386 that is the case. */
17387 && it
.current
.dpvec_index
< 0)
17390 it
.glyph_row
->reversed_p
= false;
17391 if (display_line (&it
))
17392 last_text_row
= it
.glyph_row
- 1;
17396 /* A value of current_y < last_visible_y means that we stopped
17397 at the previous window start, which in turn means that we
17398 have at least one reusable row. */
17399 if (it
.current_y
< it
.last_visible_y
)
17401 struct glyph_row
*row
;
17403 /* IT.vpos always starts from 0; it counts text lines. */
17404 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17406 /* Find PT if not already found in the lines displayed. */
17407 if (w
->cursor
.vpos
< 0)
17409 int dy
= it
.current_y
- start_row
->y
;
17411 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17412 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17414 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17415 dy
, nrows_scrolled
);
17418 clear_glyph_matrix (w
->desired_matrix
);
17423 /* Scroll the display. Do it before the current matrix is
17424 changed. The problem here is that update has not yet
17425 run, i.e. part of the current matrix is not up to date.
17426 scroll_run_hook will clear the cursor, and use the
17427 current matrix to get the height of the row the cursor is
17429 run
.current_y
= start_row
->y
;
17430 run
.desired_y
= it
.current_y
;
17431 run
.height
= it
.last_visible_y
- it
.current_y
;
17433 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17436 FRAME_RIF (f
)->update_window_begin_hook (w
);
17437 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17438 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17439 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17443 /* Shift current matrix down by nrows_scrolled lines. */
17444 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17445 rotate_matrix (w
->current_matrix
,
17447 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17450 /* Disable lines that must be updated. */
17451 for (i
= 0; i
< nrows_scrolled
; ++i
)
17452 (start_row
+ i
)->enabled_p
= false;
17454 /* Re-compute Y positions. */
17455 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17456 max_y
= it
.last_visible_y
;
17457 for (row
= start_row
+ nrows_scrolled
;
17461 row
->y
= it
.current_y
;
17462 row
->visible_height
= row
->height
;
17464 if (row
->y
< min_y
)
17465 row
->visible_height
-= min_y
- row
->y
;
17466 if (row
->y
+ row
->height
> max_y
)
17467 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17468 if (row
->fringe_bitmap_periodic_p
)
17469 row
->redraw_fringe_bitmaps_p
= true;
17471 it
.current_y
+= row
->height
;
17473 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17474 last_reused_text_row
= row
;
17475 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17479 /* Disable lines in the current matrix which are now
17480 below the window. */
17481 for (++row
; row
< bottom_row
; ++row
)
17482 row
->enabled_p
= row
->mode_line_p
= false;
17485 /* Update window_end_pos etc.; last_reused_text_row is the last
17486 reused row from the current matrix containing text, if any.
17487 The value of last_text_row is the last displayed line
17488 containing text. */
17489 if (last_reused_text_row
)
17490 adjust_window_ends (w
, last_reused_text_row
, true);
17491 else if (last_text_row
)
17492 adjust_window_ends (w
, last_text_row
, false);
17495 /* This window must be completely empty. */
17496 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17497 w
->window_end_pos
= Z
- ZV
;
17498 w
->window_end_vpos
= 0;
17500 w
->window_end_valid
= false;
17502 /* Update hint: don't try scrolling again in update_window. */
17503 w
->desired_matrix
->no_scrolling_p
= true;
17506 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17510 else if (CHARPOS (new_start
) > CHARPOS (start
))
17512 struct glyph_row
*pt_row
, *row
;
17513 struct glyph_row
*first_reusable_row
;
17514 struct glyph_row
*first_row_to_display
;
17516 int yb
= window_text_bottom_y (w
);
17518 /* Find the row starting at new_start, if there is one. Don't
17519 reuse a partially visible line at the end. */
17520 first_reusable_row
= start_row
;
17521 while (first_reusable_row
->enabled_p
17522 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17523 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17524 < CHARPOS (new_start
)))
17525 ++first_reusable_row
;
17527 /* Give up if there is no row to reuse. */
17528 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17529 || !first_reusable_row
->enabled_p
17530 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17531 != CHARPOS (new_start
)))
17534 /* We can reuse fully visible rows beginning with
17535 first_reusable_row to the end of the window. Set
17536 first_row_to_display to the first row that cannot be reused.
17537 Set pt_row to the row containing point, if there is any. */
17539 for (first_row_to_display
= first_reusable_row
;
17540 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17541 ++first_row_to_display
)
17543 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17544 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17545 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17546 && first_row_to_display
->ends_at_zv_p
17547 && pt_row
== NULL
)))
17548 pt_row
= first_row_to_display
;
17551 /* Start displaying at the start of first_row_to_display. */
17552 eassert (first_row_to_display
->y
< yb
);
17553 init_to_row_start (&it
, w
, first_row_to_display
);
17555 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17557 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17559 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17560 + WINDOW_HEADER_LINE_HEIGHT (w
));
17562 /* Display lines beginning with first_row_to_display in the
17563 desired matrix. Set last_text_row to the last row displayed
17564 that displays text. */
17565 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17566 if (pt_row
== NULL
)
17567 w
->cursor
.vpos
= -1;
17568 last_text_row
= NULL
;
17569 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17570 if (display_line (&it
))
17571 last_text_row
= it
.glyph_row
- 1;
17573 /* If point is in a reused row, adjust y and vpos of the cursor
17577 w
->cursor
.vpos
-= nrows_scrolled
;
17578 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17581 /* Give up if point isn't in a row displayed or reused. (This
17582 also handles the case where w->cursor.vpos < nrows_scrolled
17583 after the calls to display_line, which can happen with scroll
17584 margins. See bug#1295.) */
17585 if (w
->cursor
.vpos
< 0)
17587 clear_glyph_matrix (w
->desired_matrix
);
17591 /* Scroll the display. */
17592 run
.current_y
= first_reusable_row
->y
;
17593 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17594 run
.height
= it
.last_visible_y
- run
.current_y
;
17595 dy
= run
.current_y
- run
.desired_y
;
17600 FRAME_RIF (f
)->update_window_begin_hook (w
);
17601 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17602 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17603 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17607 /* Adjust Y positions of reused rows. */
17608 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17609 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17610 max_y
= it
.last_visible_y
;
17611 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17614 row
->visible_height
= row
->height
;
17615 if (row
->y
< min_y
)
17616 row
->visible_height
-= min_y
- row
->y
;
17617 if (row
->y
+ row
->height
> max_y
)
17618 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17619 if (row
->fringe_bitmap_periodic_p
)
17620 row
->redraw_fringe_bitmaps_p
= true;
17623 /* Scroll the current matrix. */
17624 eassert (nrows_scrolled
> 0);
17625 rotate_matrix (w
->current_matrix
,
17627 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17630 /* Disable rows not reused. */
17631 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17632 row
->enabled_p
= false;
17634 /* Point may have moved to a different line, so we cannot assume that
17635 the previous cursor position is valid; locate the correct row. */
17638 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17640 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17641 && !row
->ends_at_zv_p
;
17645 w
->cursor
.y
= row
->y
;
17647 if (row
< bottom_row
)
17649 /* Can't simply scan the row for point with
17650 bidi-reordered glyph rows. Let set_cursor_from_row
17651 figure out where to put the cursor, and if it fails,
17653 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17655 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17658 clear_glyph_matrix (w
->desired_matrix
);
17664 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17665 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17668 && (!BUFFERP (glyph
->object
)
17669 || glyph
->charpos
< PT
);
17673 w
->cursor
.x
+= glyph
->pixel_width
;
17679 /* Adjust window end. A null value of last_text_row means that
17680 the window end is in reused rows which in turn means that
17681 only its vpos can have changed. */
17683 adjust_window_ends (w
, last_text_row
, false);
17685 w
->window_end_vpos
-= nrows_scrolled
;
17687 w
->window_end_valid
= false;
17688 w
->desired_matrix
->no_scrolling_p
= true;
17691 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17701 /************************************************************************
17702 Window redisplay reusing current matrix when buffer has changed
17703 ************************************************************************/
17705 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17706 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17707 ptrdiff_t *, ptrdiff_t *);
17708 static struct glyph_row
*
17709 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17710 struct glyph_row
*);
17713 /* Return the last row in MATRIX displaying text. If row START is
17714 non-null, start searching with that row. IT gives the dimensions
17715 of the display. Value is null if matrix is empty; otherwise it is
17716 a pointer to the row found. */
17718 static struct glyph_row
*
17719 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17720 struct glyph_row
*start
)
17722 struct glyph_row
*row
, *row_found
;
17724 /* Set row_found to the last row in IT->w's current matrix
17725 displaying text. The loop looks funny but think of partially
17728 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17729 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17731 eassert (row
->enabled_p
);
17733 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17742 /* Return the last row in the current matrix of W that is not affected
17743 by changes at the start of current_buffer that occurred since W's
17744 current matrix was built. Value is null if no such row exists.
17746 BEG_UNCHANGED us the number of characters unchanged at the start of
17747 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17748 first changed character in current_buffer. Characters at positions <
17749 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17750 when the current matrix was built. */
17752 static struct glyph_row
*
17753 find_last_unchanged_at_beg_row (struct window
*w
)
17755 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17756 struct glyph_row
*row
;
17757 struct glyph_row
*row_found
= NULL
;
17758 int yb
= window_text_bottom_y (w
);
17760 /* Find the last row displaying unchanged text. */
17761 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17762 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17763 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17766 if (/* If row ends before first_changed_pos, it is unchanged,
17767 except in some case. */
17768 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17769 /* When row ends in ZV and we write at ZV it is not
17771 && !row
->ends_at_zv_p
17772 /* When first_changed_pos is the end of a continued line,
17773 row is not unchanged because it may be no longer
17775 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17776 && (row
->continued_p
17777 || row
->exact_window_width_line_p
))
17778 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17779 needs to be recomputed, so don't consider this row as
17780 unchanged. This happens when the last line was
17781 bidi-reordered and was killed immediately before this
17782 redisplay cycle. In that case, ROW->end stores the
17783 buffer position of the first visual-order character of
17784 the killed text, which is now beyond ZV. */
17785 && CHARPOS (row
->end
.pos
) <= ZV
)
17788 /* Stop if last visible row. */
17789 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17797 /* Find the first glyph row in the current matrix of W that is not
17798 affected by changes at the end of current_buffer since the
17799 time W's current matrix was built.
17801 Return in *DELTA the number of chars by which buffer positions in
17802 unchanged text at the end of current_buffer must be adjusted.
17804 Return in *DELTA_BYTES the corresponding number of bytes.
17806 Value is null if no such row exists, i.e. all rows are affected by
17809 static struct glyph_row
*
17810 find_first_unchanged_at_end_row (struct window
*w
,
17811 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17813 struct glyph_row
*row
;
17814 struct glyph_row
*row_found
= NULL
;
17816 *delta
= *delta_bytes
= 0;
17818 /* Display must not have been paused, otherwise the current matrix
17819 is not up to date. */
17820 eassert (w
->window_end_valid
);
17822 /* A value of window_end_pos >= END_UNCHANGED means that the window
17823 end is in the range of changed text. If so, there is no
17824 unchanged row at the end of W's current matrix. */
17825 if (w
->window_end_pos
>= END_UNCHANGED
)
17828 /* Set row to the last row in W's current matrix displaying text. */
17829 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17831 /* If matrix is entirely empty, no unchanged row exists. */
17832 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17834 /* The value of row is the last glyph row in the matrix having a
17835 meaningful buffer position in it. The end position of row
17836 corresponds to window_end_pos. This allows us to translate
17837 buffer positions in the current matrix to current buffer
17838 positions for characters not in changed text. */
17840 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17841 ptrdiff_t Z_BYTE_old
=
17842 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17843 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17844 struct glyph_row
*first_text_row
17845 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17847 *delta
= Z
- Z_old
;
17848 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17850 /* Set last_unchanged_pos to the buffer position of the last
17851 character in the buffer that has not been changed. Z is the
17852 index + 1 of the last character in current_buffer, i.e. by
17853 subtracting END_UNCHANGED we get the index of the last
17854 unchanged character, and we have to add BEG to get its buffer
17856 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17857 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17859 /* Search backward from ROW for a row displaying a line that
17860 starts at a minimum position >= last_unchanged_pos_old. */
17861 for (; row
> first_text_row
; --row
)
17863 /* This used to abort, but it can happen.
17864 It is ok to just stop the search instead here. KFS. */
17865 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17868 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17873 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17879 /* Make sure that glyph rows in the current matrix of window W
17880 reference the same glyph memory as corresponding rows in the
17881 frame's frame matrix. This function is called after scrolling W's
17882 current matrix on a terminal frame in try_window_id and
17883 try_window_reusing_current_matrix. */
17886 sync_frame_with_window_matrix_rows (struct window
*w
)
17888 struct frame
*f
= XFRAME (w
->frame
);
17889 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17891 /* Preconditions: W must be a leaf window and full-width. Its frame
17892 must have a frame matrix. */
17893 eassert (BUFFERP (w
->contents
));
17894 eassert (WINDOW_FULL_WIDTH_P (w
));
17895 eassert (!FRAME_WINDOW_P (f
));
17897 /* If W is a full-width window, glyph pointers in W's current matrix
17898 have, by definition, to be the same as glyph pointers in the
17899 corresponding frame matrix. Note that frame matrices have no
17900 marginal areas (see build_frame_matrix). */
17901 window_row
= w
->current_matrix
->rows
;
17902 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17903 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17904 while (window_row
< window_row_end
)
17906 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17907 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17909 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17910 frame_row
->glyphs
[TEXT_AREA
] = start
;
17911 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17912 frame_row
->glyphs
[LAST_AREA
] = end
;
17914 /* Disable frame rows whose corresponding window rows have
17915 been disabled in try_window_id. */
17916 if (!window_row
->enabled_p
)
17917 frame_row
->enabled_p
= false;
17919 ++window_row
, ++frame_row
;
17924 /* Find the glyph row in window W containing CHARPOS. Consider all
17925 rows between START and END (not inclusive). END null means search
17926 all rows to the end of the display area of W. Value is the row
17927 containing CHARPOS or null. */
17930 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17931 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17933 struct glyph_row
*row
= start
;
17934 struct glyph_row
*best_row
= NULL
;
17935 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17938 /* If we happen to start on a header-line, skip that. */
17939 if (row
->mode_line_p
)
17942 if ((end
&& row
>= end
) || !row
->enabled_p
)
17945 last_y
= window_text_bottom_y (w
) - dy
;
17949 /* Give up if we have gone too far. */
17950 if ((end
&& row
>= end
) || !row
->enabled_p
)
17952 /* This formerly returned if they were equal.
17953 I think that both quantities are of a "last plus one" type;
17954 if so, when they are equal, the row is within the screen. -- rms. */
17955 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17958 /* If it is in this row, return this row. */
17959 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17960 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17961 /* The end position of a row equals the start
17962 position of the next row. If CHARPOS is there, we
17963 would rather consider it displayed in the next
17964 line, except when this line ends in ZV. */
17965 && !row_for_charpos_p (row
, charpos
)))
17966 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17970 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17971 || (!best_row
&& !row
->continued_p
))
17973 /* In bidi-reordered rows, there could be several rows whose
17974 edges surround CHARPOS, all of these rows belonging to
17975 the same continued line. We need to find the row which
17976 fits CHARPOS the best. */
17977 for (g
= row
->glyphs
[TEXT_AREA
];
17978 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17981 if (!STRINGP (g
->object
))
17983 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17985 mindif
= eabs (g
->charpos
- charpos
);
17987 /* Exact match always wins. */
17994 else if (best_row
&& !row
->continued_p
)
18001 /* Try to redisplay window W by reusing its existing display. W's
18002 current matrix must be up to date when this function is called,
18003 i.e., window_end_valid must be true.
18007 >= 1 if successful, i.e. display has been updated
18009 1 means the changes were in front of a newline that precedes
18010 the window start, and the whole current matrix was reused
18011 2 means the changes were after the last position displayed
18012 in the window, and the whole current matrix was reused
18013 3 means portions of the current matrix were reused, while
18014 some of the screen lines were redrawn
18015 -1 if redisplay with same window start is known not to succeed
18016 0 if otherwise unsuccessful
18018 The following steps are performed:
18020 1. Find the last row in the current matrix of W that is not
18021 affected by changes at the start of current_buffer. If no such row
18024 2. Find the first row in W's current matrix that is not affected by
18025 changes at the end of current_buffer. Maybe there is no such row.
18027 3. Display lines beginning with the row + 1 found in step 1 to the
18028 row found in step 2 or, if step 2 didn't find a row, to the end of
18031 4. If cursor is not known to appear on the window, give up.
18033 5. If display stopped at the row found in step 2, scroll the
18034 display and current matrix as needed.
18036 6. Maybe display some lines at the end of W, if we must. This can
18037 happen under various circumstances, like a partially visible line
18038 becoming fully visible, or because newly displayed lines are displayed
18039 in smaller font sizes.
18041 7. Update W's window end information. */
18044 try_window_id (struct window
*w
)
18046 struct frame
*f
= XFRAME (w
->frame
);
18047 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
18048 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
18049 struct glyph_row
*last_unchanged_at_beg_row
;
18050 struct glyph_row
*first_unchanged_at_end_row
;
18051 struct glyph_row
*row
;
18052 struct glyph_row
*bottom_row
;
18055 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
18057 struct text_pos start_pos
;
18059 int first_unchanged_at_end_vpos
= 0;
18060 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
18061 struct text_pos start
;
18062 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
18065 if (inhibit_try_window_id
)
18069 /* This is handy for debugging. */
18071 #define GIVE_UP(X) \
18073 TRACE ((stderr, "try_window_id give up %d\n", (X))); \
18077 #define GIVE_UP(X) return 0
18080 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
18082 /* Don't use this for mini-windows because these can show
18083 messages and mini-buffers, and we don't handle that here. */
18084 if (MINI_WINDOW_P (w
))
18087 /* This flag is used to prevent redisplay optimizations. */
18088 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
18091 /* This function's optimizations cannot be used if overlays have
18092 changed in the buffer displayed by the window, so give up if they
18094 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
18097 /* Verify that narrowing has not changed.
18098 Also verify that we were not told to prevent redisplay optimizations.
18099 It would be nice to further
18100 reduce the number of cases where this prevents try_window_id. */
18101 if (current_buffer
->clip_changed
18102 || current_buffer
->prevent_redisplay_optimizations_p
)
18105 /* Window must either use window-based redisplay or be full width. */
18106 if (!FRAME_WINDOW_P (f
)
18107 && (!FRAME_LINE_INS_DEL_OK (f
)
18108 || !WINDOW_FULL_WIDTH_P (w
)))
18111 /* Give up if point is known NOT to appear in W. */
18112 if (PT
< CHARPOS (start
))
18115 /* Another way to prevent redisplay optimizations. */
18116 if (w
->last_modified
== 0)
18119 /* Verify that window is not hscrolled. */
18120 if (w
->hscroll
!= 0)
18123 /* Verify that display wasn't paused. */
18124 if (!w
->window_end_valid
)
18127 /* Likewise if highlighting trailing whitespace. */
18128 if (!NILP (Vshow_trailing_whitespace
))
18131 /* Can't use this if overlay arrow position and/or string have
18133 if (overlay_arrows_changed_p ())
18136 /* When word-wrap is on, adding a space to the first word of a
18137 wrapped line can change the wrap position, altering the line
18138 above it. It might be worthwhile to handle this more
18139 intelligently, but for now just redisplay from scratch. */
18140 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
18143 /* Under bidi reordering, adding or deleting a character in the
18144 beginning of a paragraph, before the first strong directional
18145 character, can change the base direction of the paragraph (unless
18146 the buffer specifies a fixed paragraph direction), which will
18147 require redisplaying the whole paragraph. It might be worthwhile
18148 to find the paragraph limits and widen the range of redisplayed
18149 lines to that, but for now just give up this optimization and
18150 redisplay from scratch. */
18151 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
18152 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
18155 /* Give up if the buffer has line-spacing set, as Lisp-level changes
18156 to that variable require thorough redisplay. */
18157 if (!NILP (BVAR (XBUFFER (w
->contents
), extra_line_spacing
)))
18160 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
18161 only if buffer has really changed. The reason is that the gap is
18162 initially at Z for freshly visited files. The code below would
18163 set end_unchanged to 0 in that case. */
18164 if (MODIFF
> SAVE_MODIFF
18165 /* This seems to happen sometimes after saving a buffer. */
18166 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
18168 if (GPT
- BEG
< BEG_UNCHANGED
)
18169 BEG_UNCHANGED
= GPT
- BEG
;
18170 if (Z
- GPT
< END_UNCHANGED
)
18171 END_UNCHANGED
= Z
- GPT
;
18174 /* The position of the first and last character that has been changed. */
18175 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
18176 last_changed_charpos
= Z
- END_UNCHANGED
;
18178 /* If window starts after a line end, and the last change is in
18179 front of that newline, then changes don't affect the display.
18180 This case happens with stealth-fontification. Note that although
18181 the display is unchanged, glyph positions in the matrix have to
18182 be adjusted, of course. */
18183 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
18184 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
18185 && ((last_changed_charpos
< CHARPOS (start
)
18186 && CHARPOS (start
) == BEGV
)
18187 || (last_changed_charpos
< CHARPOS (start
) - 1
18188 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
18190 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
18191 struct glyph_row
*r0
;
18193 /* Compute how many chars/bytes have been added to or removed
18194 from the buffer. */
18195 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
18196 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
18197 Z_delta
= Z
- Z_old
;
18198 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
18200 /* Give up if PT is not in the window. Note that it already has
18201 been checked at the start of try_window_id that PT is not in
18202 front of the window start. */
18203 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
18206 /* If window start is unchanged, we can reuse the whole matrix
18207 as is, after adjusting glyph positions. No need to compute
18208 the window end again, since its offset from Z hasn't changed. */
18209 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18210 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
18211 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
18212 /* PT must not be in a partially visible line. */
18213 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
18214 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18216 /* Adjust positions in the glyph matrix. */
18217 if (Z_delta
|| Z_delta_bytes
)
18219 struct glyph_row
*r1
18220 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18221 increment_matrix_positions (w
->current_matrix
,
18222 MATRIX_ROW_VPOS (r0
, current_matrix
),
18223 MATRIX_ROW_VPOS (r1
, current_matrix
),
18224 Z_delta
, Z_delta_bytes
);
18227 /* Set the cursor. */
18228 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18230 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18235 /* Handle the case that changes are all below what is displayed in
18236 the window, and that PT is in the window. This shortcut cannot
18237 be taken if ZV is visible in the window, and text has been added
18238 there that is visible in the window. */
18239 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
18240 /* ZV is not visible in the window, or there are no
18241 changes at ZV, actually. */
18242 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
18243 || first_changed_charpos
== last_changed_charpos
))
18245 struct glyph_row
*r0
;
18247 /* Give up if PT is not in the window. Note that it already has
18248 been checked at the start of try_window_id that PT is not in
18249 front of the window start. */
18250 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
18253 /* If window start is unchanged, we can reuse the whole matrix
18254 as is, without changing glyph positions since no text has
18255 been added/removed in front of the window end. */
18256 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18257 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
18258 /* PT must not be in a partially visible line. */
18259 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
18260 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18262 /* We have to compute the window end anew since text
18263 could have been added/removed after it. */
18264 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18265 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18267 /* Set the cursor. */
18268 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18270 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18275 /* Give up if window start is in the changed area.
18277 The condition used to read
18279 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18281 but why that was tested escapes me at the moment. */
18282 if (CHARPOS (start
) >= first_changed_charpos
18283 && CHARPOS (start
) <= last_changed_charpos
)
18286 /* Check that window start agrees with the start of the first glyph
18287 row in its current matrix. Check this after we know the window
18288 start is not in changed text, otherwise positions would not be
18290 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18291 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
18294 /* Give up if the window ends in strings. Overlay strings
18295 at the end are difficult to handle, so don't try. */
18296 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
18297 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
18300 /* Compute the position at which we have to start displaying new
18301 lines. Some of the lines at the top of the window might be
18302 reusable because they are not displaying changed text. Find the
18303 last row in W's current matrix not affected by changes at the
18304 start of current_buffer. Value is null if changes start in the
18305 first line of window. */
18306 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18307 if (last_unchanged_at_beg_row
)
18309 /* Avoid starting to display in the middle of a character, a TAB
18310 for instance. This is easier than to set up the iterator
18311 exactly, and it's not a frequent case, so the additional
18312 effort wouldn't really pay off. */
18313 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18314 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18315 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18316 --last_unchanged_at_beg_row
;
18318 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18321 if (! init_to_row_end (&it
, w
, last_unchanged_at_beg_row
))
18323 start_pos
= it
.current
.pos
;
18325 /* Start displaying new lines in the desired matrix at the same
18326 vpos we would use in the current matrix, i.e. below
18327 last_unchanged_at_beg_row. */
18328 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18330 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18331 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18333 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18337 /* There are no reusable lines at the start of the window.
18338 Start displaying in the first text line. */
18339 start_display (&it
, w
, start
);
18340 it
.vpos
= it
.first_vpos
;
18341 start_pos
= it
.current
.pos
;
18344 /* Find the first row that is not affected by changes at the end of
18345 the buffer. Value will be null if there is no unchanged row, in
18346 which case we must redisplay to the end of the window. delta
18347 will be set to the value by which buffer positions beginning with
18348 first_unchanged_at_end_row have to be adjusted due to text
18350 first_unchanged_at_end_row
18351 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18352 IF_DEBUG (debug_delta
= delta
);
18353 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18355 /* Set stop_pos to the buffer position up to which we will have to
18356 display new lines. If first_unchanged_at_end_row != NULL, this
18357 is the buffer position of the start of the line displayed in that
18358 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18359 that we don't stop at a buffer position. */
18361 if (first_unchanged_at_end_row
)
18363 eassert (last_unchanged_at_beg_row
== NULL
18364 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18366 /* If this is a continuation line, move forward to the next one
18367 that isn't. Changes in lines above affect this line.
18368 Caution: this may move first_unchanged_at_end_row to a row
18369 not displaying text. */
18370 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18371 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18372 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18373 < it
.last_visible_y
))
18374 ++first_unchanged_at_end_row
;
18376 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18377 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18378 >= it
.last_visible_y
))
18379 first_unchanged_at_end_row
= NULL
;
18382 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18384 first_unchanged_at_end_vpos
18385 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18386 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18389 else if (last_unchanged_at_beg_row
== NULL
)
18395 /* Either there is no unchanged row at the end, or the one we have
18396 now displays text. This is a necessary condition for the window
18397 end pos calculation at the end of this function. */
18398 eassert (first_unchanged_at_end_row
== NULL
18399 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18401 debug_last_unchanged_at_beg_vpos
18402 = (last_unchanged_at_beg_row
18403 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18405 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18407 #endif /* GLYPH_DEBUG */
18410 /* Display new lines. Set last_text_row to the last new line
18411 displayed which has text on it, i.e. might end up as being the
18412 line where the window_end_vpos is. */
18413 w
->cursor
.vpos
= -1;
18414 last_text_row
= NULL
;
18415 overlay_arrow_seen
= false;
18416 if (it
.current_y
< it
.last_visible_y
18417 && !f
->fonts_changed
18418 && (first_unchanged_at_end_row
== NULL
18419 || IT_CHARPOS (it
) < stop_pos
))
18420 it
.glyph_row
->reversed_p
= false;
18421 while (it
.current_y
< it
.last_visible_y
18422 && !f
->fonts_changed
18423 && (first_unchanged_at_end_row
== NULL
18424 || IT_CHARPOS (it
) < stop_pos
))
18426 if (display_line (&it
))
18427 last_text_row
= it
.glyph_row
- 1;
18430 if (f
->fonts_changed
)
18433 /* The redisplay iterations in display_line above could have
18434 triggered font-lock, which could have done something that
18435 invalidates IT->w window's end-point information, on which we
18436 rely below. E.g., one package, which will remain unnamed, used
18437 to install a font-lock-fontify-region-function that called
18438 bury-buffer, whose side effect is to switch the buffer displayed
18439 by IT->w, and that predictably resets IT->w's window_end_valid
18440 flag, which we already tested at the entry to this function.
18441 Amply punish such packages/modes by giving up on this
18442 optimization in those cases. */
18443 if (!w
->window_end_valid
)
18445 clear_glyph_matrix (w
->desired_matrix
);
18449 /* Compute differences in buffer positions, y-positions etc. for
18450 lines reused at the bottom of the window. Compute what we can
18452 if (first_unchanged_at_end_row
18453 /* No lines reused because we displayed everything up to the
18454 bottom of the window. */
18455 && it
.current_y
< it
.last_visible_y
)
18458 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18460 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18461 run
.current_y
= first_unchanged_at_end_row
->y
;
18462 run
.desired_y
= run
.current_y
+ dy
;
18463 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18467 delta
= delta_bytes
= dvpos
= dy
18468 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18469 first_unchanged_at_end_row
= NULL
;
18471 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18474 /* Find the cursor if not already found. We have to decide whether
18475 PT will appear on this window (it sometimes doesn't, but this is
18476 not a very frequent case.) This decision has to be made before
18477 the current matrix is altered. A value of cursor.vpos < 0 means
18478 that PT is either in one of the lines beginning at
18479 first_unchanged_at_end_row or below the window. Don't care for
18480 lines that might be displayed later at the window end; as
18481 mentioned, this is not a frequent case. */
18482 if (w
->cursor
.vpos
< 0)
18484 /* Cursor in unchanged rows at the top? */
18485 if (PT
< CHARPOS (start_pos
)
18486 && last_unchanged_at_beg_row
)
18488 row
= row_containing_pos (w
, PT
,
18489 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18490 last_unchanged_at_beg_row
+ 1, 0);
18492 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18495 /* Start from first_unchanged_at_end_row looking for PT. */
18496 else if (first_unchanged_at_end_row
)
18498 row
= row_containing_pos (w
, PT
- delta
,
18499 first_unchanged_at_end_row
, NULL
, 0);
18501 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18502 delta_bytes
, dy
, dvpos
);
18505 /* Give up if cursor was not found. */
18506 if (w
->cursor
.vpos
< 0)
18508 clear_glyph_matrix (w
->desired_matrix
);
18513 /* Don't let the cursor end in the scroll margins. */
18515 int this_scroll_margin
, cursor_height
;
18516 int frame_line_height
= default_line_pixel_height (w
);
18517 int window_total_lines
18518 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18520 this_scroll_margin
=
18521 max (0, min (scroll_margin
, window_total_lines
/ 4));
18522 this_scroll_margin
*= frame_line_height
;
18523 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18525 if ((w
->cursor
.y
< this_scroll_margin
18526 && CHARPOS (start
) > BEGV
)
18527 /* Old redisplay didn't take scroll margin into account at the bottom,
18528 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18529 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18530 ? cursor_height
+ this_scroll_margin
18531 : 1)) > it
.last_visible_y
)
18533 w
->cursor
.vpos
= -1;
18534 clear_glyph_matrix (w
->desired_matrix
);
18539 /* Scroll the display. Do it before changing the current matrix so
18540 that xterm.c doesn't get confused about where the cursor glyph is
18542 if (dy
&& run
.height
)
18546 if (FRAME_WINDOW_P (f
))
18548 FRAME_RIF (f
)->update_window_begin_hook (w
);
18549 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18550 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18551 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
18555 /* Terminal frame. In this case, dvpos gives the number of
18556 lines to scroll by; dvpos < 0 means scroll up. */
18558 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18559 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18560 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18561 + WINDOW_WANTS_HEADER_LINE_P (w
)
18562 + window_internal_height (w
));
18564 #if defined (HAVE_GPM) || defined (MSDOS)
18565 x_clear_window_mouse_face (w
);
18567 /* Perform the operation on the screen. */
18570 /* Scroll last_unchanged_at_beg_row to the end of the
18571 window down dvpos lines. */
18572 set_terminal_window (f
, end
);
18574 /* On dumb terminals delete dvpos lines at the end
18575 before inserting dvpos empty lines. */
18576 if (!FRAME_SCROLL_REGION_OK (f
))
18577 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18579 /* Insert dvpos empty lines in front of
18580 last_unchanged_at_beg_row. */
18581 ins_del_lines (f
, from
, dvpos
);
18583 else if (dvpos
< 0)
18585 /* Scroll up last_unchanged_at_beg_vpos to the end of
18586 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18587 set_terminal_window (f
, end
);
18589 /* Delete dvpos lines in front of
18590 last_unchanged_at_beg_vpos. ins_del_lines will set
18591 the cursor to the given vpos and emit |dvpos| delete
18593 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18595 /* On a dumb terminal insert dvpos empty lines at the
18597 if (!FRAME_SCROLL_REGION_OK (f
))
18598 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18601 set_terminal_window (f
, 0);
18607 /* Shift reused rows of the current matrix to the right position.
18608 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18610 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18611 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18614 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18615 bottom_vpos
, dvpos
);
18616 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18619 else if (dvpos
> 0)
18621 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18622 bottom_vpos
, dvpos
);
18623 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18624 first_unchanged_at_end_vpos
+ dvpos
);
18627 /* For frame-based redisplay, make sure that current frame and window
18628 matrix are in sync with respect to glyph memory. */
18629 if (!FRAME_WINDOW_P (f
))
18630 sync_frame_with_window_matrix_rows (w
);
18632 /* Adjust buffer positions in reused rows. */
18633 if (delta
|| delta_bytes
)
18634 increment_matrix_positions (current_matrix
,
18635 first_unchanged_at_end_vpos
+ dvpos
,
18636 bottom_vpos
, delta
, delta_bytes
);
18638 /* Adjust Y positions. */
18640 shift_glyph_matrix (w
, current_matrix
,
18641 first_unchanged_at_end_vpos
+ dvpos
,
18644 if (first_unchanged_at_end_row
)
18646 first_unchanged_at_end_row
+= dvpos
;
18647 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18648 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18649 first_unchanged_at_end_row
= NULL
;
18652 /* If scrolling up, there may be some lines to display at the end of
18654 last_text_row_at_end
= NULL
;
18657 /* Scrolling up can leave for example a partially visible line
18658 at the end of the window to be redisplayed. */
18659 /* Set last_row to the glyph row in the current matrix where the
18660 window end line is found. It has been moved up or down in
18661 the matrix by dvpos. */
18662 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18663 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18665 /* If last_row is the window end line, it should display text. */
18666 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18668 /* If window end line was partially visible before, begin
18669 displaying at that line. Otherwise begin displaying with the
18670 line following it. */
18671 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18673 init_to_row_start (&it
, w
, last_row
);
18674 it
.vpos
= last_vpos
;
18675 it
.current_y
= last_row
->y
;
18679 init_to_row_end (&it
, w
, last_row
);
18680 it
.vpos
= 1 + last_vpos
;
18681 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18685 /* We may start in a continuation line. If so, we have to
18686 get the right continuation_lines_width and current_x. */
18687 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18688 it
.hpos
= it
.current_x
= 0;
18690 /* Display the rest of the lines at the window end. */
18691 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18692 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18694 /* Is it always sure that the display agrees with lines in
18695 the current matrix? I don't think so, so we mark rows
18696 displayed invalid in the current matrix by setting their
18697 enabled_p flag to false. */
18698 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18699 if (display_line (&it
))
18700 last_text_row_at_end
= it
.glyph_row
- 1;
18704 /* Update window_end_pos and window_end_vpos. */
18705 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18707 /* Window end line if one of the preserved rows from the current
18708 matrix. Set row to the last row displaying text in current
18709 matrix starting at first_unchanged_at_end_row, after
18711 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18712 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18713 first_unchanged_at_end_row
);
18714 eassume (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18715 adjust_window_ends (w
, row
, true);
18716 eassert (w
->window_end_bytepos
>= 0);
18717 IF_DEBUG (debug_method_add (w
, "A"));
18719 else if (last_text_row_at_end
)
18721 adjust_window_ends (w
, last_text_row_at_end
, false);
18722 eassert (w
->window_end_bytepos
>= 0);
18723 IF_DEBUG (debug_method_add (w
, "B"));
18725 else if (last_text_row
)
18727 /* We have displayed either to the end of the window or at the
18728 end of the window, i.e. the last row with text is to be found
18729 in the desired matrix. */
18730 adjust_window_ends (w
, last_text_row
, false);
18731 eassert (w
->window_end_bytepos
>= 0);
18733 else if (first_unchanged_at_end_row
== NULL
18734 && last_text_row
== NULL
18735 && last_text_row_at_end
== NULL
)
18737 /* Displayed to end of window, but no line containing text was
18738 displayed. Lines were deleted at the end of the window. */
18739 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
18740 int vpos
= w
->window_end_vpos
;
18741 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18742 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18744 for (row
= NULL
; !row
; --vpos
, --current_row
, --desired_row
)
18746 eassert (first_vpos
<= vpos
);
18747 if (desired_row
->enabled_p
)
18749 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18752 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18756 w
->window_end_vpos
= vpos
+ 1;
18757 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18758 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18759 eassert (w
->window_end_bytepos
>= 0);
18760 IF_DEBUG (debug_method_add (w
, "C"));
18765 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18766 debug_end_vpos
= w
->window_end_vpos
));
18768 /* Record that display has not been completed. */
18769 w
->window_end_valid
= false;
18770 w
->desired_matrix
->no_scrolling_p
= true;
18778 /***********************************************************************
18779 More debugging support
18780 ***********************************************************************/
18784 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18785 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18786 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18789 /* Dump the contents of glyph matrix MATRIX on stderr.
18791 GLYPHS 0 means don't show glyph contents.
18792 GLYPHS 1 means show glyphs in short form
18793 GLYPHS > 1 means show glyphs in long form. */
18796 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18799 for (i
= 0; i
< matrix
->nrows
; ++i
)
18800 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18804 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18805 the glyph row and area where the glyph comes from. */
18808 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18810 if (glyph
->type
== CHAR_GLYPH
18811 || glyph
->type
== GLYPHLESS_GLYPH
)
18814 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18815 glyph
- row
->glyphs
[TEXT_AREA
],
18816 (glyph
->type
== CHAR_GLYPH
18820 (BUFFERP (glyph
->object
)
18822 : (STRINGP (glyph
->object
)
18824 : (NILP (glyph
->object
)
18827 glyph
->pixel_width
,
18829 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18833 glyph
->left_box_line_p
,
18834 glyph
->right_box_line_p
);
18836 else if (glyph
->type
== STRETCH_GLYPH
)
18839 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18840 glyph
- row
->glyphs
[TEXT_AREA
],
18843 (BUFFERP (glyph
->object
)
18845 : (STRINGP (glyph
->object
)
18847 : (NILP (glyph
->object
)
18850 glyph
->pixel_width
,
18854 glyph
->left_box_line_p
,
18855 glyph
->right_box_line_p
);
18857 else if (glyph
->type
== IMAGE_GLYPH
)
18860 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18861 glyph
- row
->glyphs
[TEXT_AREA
],
18864 (BUFFERP (glyph
->object
)
18866 : (STRINGP (glyph
->object
)
18868 : (NILP (glyph
->object
)
18871 glyph
->pixel_width
,
18875 glyph
->left_box_line_p
,
18876 glyph
->right_box_line_p
);
18878 else if (glyph
->type
== COMPOSITE_GLYPH
)
18881 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18882 glyph
- row
->glyphs
[TEXT_AREA
],
18885 (BUFFERP (glyph
->object
)
18887 : (STRINGP (glyph
->object
)
18889 : (NILP (glyph
->object
)
18892 glyph
->pixel_width
,
18894 if (glyph
->u
.cmp
.automatic
)
18897 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18898 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18900 glyph
->left_box_line_p
,
18901 glyph
->right_box_line_p
);
18903 else if (glyph
->type
== XWIDGET_GLYPH
)
18905 #ifndef HAVE_XWIDGETS
18909 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
18910 glyph
- row
->glyphs
[TEXT_AREA
],
18913 (BUFFERP (glyph
->object
)
18915 : (STRINGP (glyph
->object
)
18918 glyph
->pixel_width
,
18922 glyph
->left_box_line_p
,
18923 glyph
->right_box_line_p
);
18929 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18930 GLYPHS 0 means don't show glyph contents.
18931 GLYPHS 1 means show glyphs in short form
18932 GLYPHS > 1 means show glyphs in long form. */
18935 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18939 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18940 fprintf (stderr
, "==============================================================================\n");
18942 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18943 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18945 MATRIX_ROW_START_CHARPOS (row
),
18946 MATRIX_ROW_END_CHARPOS (row
),
18947 row
->used
[TEXT_AREA
],
18948 row
->contains_overlapping_glyphs_p
,
18950 row
->truncated_on_left_p
,
18951 row
->truncated_on_right_p
,
18953 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18954 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18957 row
->ends_in_middle_of_char_p
,
18958 row
->starts_in_middle_of_char_p
,
18964 row
->visible_height
,
18967 /* The next 3 lines should align to "Start" in the header. */
18968 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18969 row
->end
.overlay_string_index
,
18970 row
->continuation_lines_width
);
18971 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18972 CHARPOS (row
->start
.string_pos
),
18973 CHARPOS (row
->end
.string_pos
));
18974 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18975 row
->end
.dpvec_index
);
18982 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18984 struct glyph
*glyph
= row
->glyphs
[area
];
18985 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18987 /* Glyph for a line end in text. */
18988 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18991 if (glyph
< glyph_end
)
18992 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18994 for (; glyph
< glyph_end
; ++glyph
)
18995 dump_glyph (row
, glyph
, area
);
18998 else if (glyphs
== 1)
19001 char s
[SHRT_MAX
+ 4];
19003 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19007 for (i
= 0; i
< row
->used
[area
]; ++i
)
19009 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
19010 if (i
== row
->used
[area
] - 1
19011 && area
== TEXT_AREA
19012 && NILP (glyph
->object
)
19013 && glyph
->type
== CHAR_GLYPH
19014 && glyph
->u
.ch
== ' ')
19016 strcpy (&s
[i
], "[\\n]");
19019 else if (glyph
->type
== CHAR_GLYPH
19020 && glyph
->u
.ch
< 0x80
19021 && glyph
->u
.ch
>= ' ')
19022 s
[i
] = glyph
->u
.ch
;
19028 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
19034 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
19035 Sdump_glyph_matrix
, 0, 1, "p",
19036 doc
: /* Dump the current matrix of the selected window to stderr.
19037 Shows contents of glyph row structures. With non-nil
19038 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
19039 glyphs in short form, otherwise show glyphs in long form.
19041 Interactively, no argument means show glyphs in short form;
19042 with numeric argument, its value is passed as the GLYPHS flag. */)
19043 (Lisp_Object glyphs
)
19045 struct window
*w
= XWINDOW (selected_window
);
19046 struct buffer
*buffer
= XBUFFER (w
->contents
);
19048 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
19049 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
19050 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
19051 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
19052 fprintf (stderr
, "=============================================\n");
19053 dump_glyph_matrix (w
->current_matrix
,
19054 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
19059 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
19060 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* Dump the current glyph matrix of the selected frame to stderr.
19061 Only text-mode frames have frame glyph matrices. */)
19064 struct frame
*f
= XFRAME (selected_frame
);
19066 if (f
->current_matrix
)
19067 dump_glyph_matrix (f
->current_matrix
, 1);
19069 fprintf (stderr
, "*** This frame doesn't have a frame glyph matrix ***\n");
19074 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
19075 doc
: /* Dump glyph row ROW to stderr.
19076 GLYPH 0 means don't dump glyphs.
19077 GLYPH 1 means dump glyphs in short form.
19078 GLYPH > 1 or omitted means dump glyphs in long form. */)
19079 (Lisp_Object row
, Lisp_Object glyphs
)
19081 struct glyph_matrix
*matrix
;
19084 CHECK_NUMBER (row
);
19085 matrix
= XWINDOW (selected_window
)->current_matrix
;
19087 if (vpos
>= 0 && vpos
< matrix
->nrows
)
19088 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
19090 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
19095 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
19096 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
19097 GLYPH 0 means don't dump glyphs.
19098 GLYPH 1 means dump glyphs in short form.
19099 GLYPH > 1 or omitted means dump glyphs in long form.
19101 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
19103 (Lisp_Object row
, Lisp_Object glyphs
)
19105 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19106 struct frame
*sf
= SELECTED_FRAME ();
19107 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
19110 CHECK_NUMBER (row
);
19112 if (vpos
>= 0 && vpos
< m
->nrows
)
19113 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
19114 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
19120 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
19121 doc
: /* Toggle tracing of redisplay.
19122 With ARG, turn tracing on if and only if ARG is positive. */)
19126 trace_redisplay_p
= !trace_redisplay_p
;
19129 arg
= Fprefix_numeric_value (arg
);
19130 trace_redisplay_p
= XINT (arg
) > 0;
19137 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
19138 doc
: /* Like `format', but print result to stderr.
19139 usage: (trace-to-stderr STRING &rest OBJECTS) */)
19140 (ptrdiff_t nargs
, Lisp_Object
*args
)
19142 Lisp_Object s
= Fformat (nargs
, args
);
19143 fwrite (SDATA (s
), 1, SBYTES (s
), stderr
);
19147 #endif /* GLYPH_DEBUG */
19151 /***********************************************************************
19152 Building Desired Matrix Rows
19153 ***********************************************************************/
19155 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
19156 Used for non-window-redisplay windows, and for windows w/o left fringe. */
19158 static struct glyph_row
*
19159 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
19161 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19162 struct buffer
*buffer
= XBUFFER (w
->contents
);
19163 struct buffer
*old
= current_buffer
;
19164 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
19165 ptrdiff_t arrow_len
= SCHARS (overlay_arrow_string
);
19166 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
19167 const unsigned char *p
;
19170 int n_glyphs_before
;
19172 set_buffer_temp (buffer
);
19173 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
19174 scratch_glyph_row
.reversed_p
= false;
19175 it
.glyph_row
->used
[TEXT_AREA
] = 0;
19176 SET_TEXT_POS (it
.position
, 0, 0);
19178 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
19180 while (p
< arrow_end
)
19182 Lisp_Object face
, ilisp
;
19184 /* Get the next character. */
19186 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
19189 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
19190 if (! ASCII_CHAR_P (it
.c
))
19191 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
19195 /* Get its face. */
19196 ilisp
= make_number (p
- arrow_string
);
19197 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
19198 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
19200 /* Compute its width, get its glyphs. */
19201 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
19202 SET_TEXT_POS (it
.position
, -1, -1);
19203 PRODUCE_GLYPHS (&it
);
19205 /* If this character doesn't fit any more in the line, we have
19206 to remove some glyphs. */
19207 if (it
.current_x
> it
.last_visible_x
)
19209 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19214 set_buffer_temp (old
);
19215 return it
.glyph_row
;
19219 /* Insert truncation glyphs at the start of IT->glyph_row. Which
19220 glyphs to insert is determined by produce_special_glyphs. */
19223 insert_left_trunc_glyphs (struct it
*it
)
19225 struct it truncate_it
;
19226 struct glyph
*from
, *end
, *to
, *toend
;
19228 eassert (!FRAME_WINDOW_P (it
->f
)
19229 || (!it
->glyph_row
->reversed_p
19230 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19231 || (it
->glyph_row
->reversed_p
19232 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
19234 /* Get the truncation glyphs. */
19236 truncate_it
.current_x
= 0;
19237 truncate_it
.face_id
= DEFAULT_FACE_ID
;
19238 truncate_it
.glyph_row
= &scratch_glyph_row
;
19239 truncate_it
.area
= TEXT_AREA
;
19240 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
19241 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
19242 truncate_it
.object
= Qnil
;
19243 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
19245 /* Overwrite glyphs from IT with truncation glyphs. */
19246 if (!it
->glyph_row
->reversed_p
)
19248 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19250 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19251 end
= from
+ tused
;
19252 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19253 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
19254 if (FRAME_WINDOW_P (it
->f
))
19256 /* On GUI frames, when variable-size fonts are displayed,
19257 the truncation glyphs may need more pixels than the row's
19258 glyphs they overwrite. We overwrite more glyphs to free
19259 enough screen real estate, and enlarge the stretch glyph
19260 on the right (see display_line), if there is one, to
19261 preserve the screen position of the truncation glyphs on
19264 struct glyph
*g
= to
;
19267 /* The first glyph could be partially visible, in which case
19268 it->glyph_row->x will be negative. But we want the left
19269 truncation glyphs to be aligned at the left margin of the
19270 window, so we override the x coordinate at which the row
19272 it
->glyph_row
->x
= 0;
19273 while (g
< toend
&& w
< it
->truncation_pixel_width
)
19275 w
+= g
->pixel_width
;
19278 if (g
- to
- tused
> 0)
19280 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
19281 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
19283 used
= it
->glyph_row
->used
[TEXT_AREA
];
19284 if (it
->glyph_row
->truncated_on_right_p
19285 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
19286 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
19289 int extra
= w
- it
->truncation_pixel_width
;
19291 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
19298 /* There may be padding glyphs left over. Overwrite them too. */
19299 if (!FRAME_WINDOW_P (it
->f
))
19301 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
19303 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19310 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
19314 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19316 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19317 that back to front. */
19318 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19319 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19320 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19321 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19322 if (FRAME_WINDOW_P (it
->f
))
19325 struct glyph
*g
= to
;
19327 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19329 w
+= g
->pixel_width
;
19332 if (to
- g
- tused
> 0)
19334 if (it
->glyph_row
->truncated_on_right_p
19335 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19336 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19338 int extra
= w
- it
->truncation_pixel_width
;
19340 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19344 while (from
>= end
&& to
>= toend
)
19346 if (!FRAME_WINDOW_P (it
->f
))
19348 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19351 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19352 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19353 while (from
>= end
&& to
>= toend
)
19359 /* Need to free some room before prepending additional
19361 int move_by
= from
- end
+ 1;
19362 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19363 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19365 for ( ; g
>= g0
; g
--)
19367 while (from
>= end
)
19369 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19374 /* Compute the hash code for ROW. */
19376 row_hash (struct glyph_row
*row
)
19379 unsigned hashval
= 0;
19381 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19382 for (k
= 0; k
< row
->used
[area
]; ++k
)
19383 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19384 + row
->glyphs
[area
][k
].u
.val
19385 + row
->glyphs
[area
][k
].face_id
19386 + row
->glyphs
[area
][k
].padding_p
19387 + (row
->glyphs
[area
][k
].type
<< 2));
19392 /* Compute the pixel height and width of IT->glyph_row.
19394 Most of the time, ascent and height of a display line will be equal
19395 to the max_ascent and max_height values of the display iterator
19396 structure. This is not the case if
19398 1. We hit ZV without displaying anything. In this case, max_ascent
19399 and max_height will be zero.
19401 2. We have some glyphs that don't contribute to the line height.
19402 (The glyph row flag contributes_to_line_height_p is for future
19403 pixmap extensions).
19405 The first case is easily covered by using default values because in
19406 these cases, the line height does not really matter, except that it
19407 must not be zero. */
19410 compute_line_metrics (struct it
*it
)
19412 struct glyph_row
*row
= it
->glyph_row
;
19414 if (FRAME_WINDOW_P (it
->f
))
19416 int i
, min_y
, max_y
;
19418 /* The line may consist of one space only, that was added to
19419 place the cursor on it. If so, the row's height hasn't been
19421 if (row
->height
== 0)
19423 if (it
->max_ascent
+ it
->max_descent
== 0)
19424 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19425 row
->ascent
= it
->max_ascent
;
19426 row
->height
= it
->max_ascent
+ it
->max_descent
;
19427 row
->phys_ascent
= it
->max_phys_ascent
;
19428 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19429 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19432 /* Compute the width of this line. */
19433 row
->pixel_width
= row
->x
;
19434 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19435 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19437 eassert (row
->pixel_width
>= 0);
19438 eassert (row
->ascent
>= 0 && row
->height
> 0);
19440 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19441 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19443 /* If first line's physical ascent is larger than its logical
19444 ascent, use the physical ascent, and make the row taller.
19445 This makes accented characters fully visible. */
19446 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19447 && row
->phys_ascent
> row
->ascent
)
19449 row
->height
+= row
->phys_ascent
- row
->ascent
;
19450 row
->ascent
= row
->phys_ascent
;
19453 /* Compute how much of the line is visible. */
19454 row
->visible_height
= row
->height
;
19456 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19457 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19459 if (row
->y
< min_y
)
19460 row
->visible_height
-= min_y
- row
->y
;
19461 if (row
->y
+ row
->height
> max_y
)
19462 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19466 row
->pixel_width
= row
->used
[TEXT_AREA
];
19467 if (row
->continued_p
)
19468 row
->pixel_width
-= it
->continuation_pixel_width
;
19469 else if (row
->truncated_on_right_p
)
19470 row
->pixel_width
-= it
->truncation_pixel_width
;
19471 row
->ascent
= row
->phys_ascent
= 0;
19472 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19473 row
->extra_line_spacing
= 0;
19476 /* Compute a hash code for this row. */
19477 row
->hash
= row_hash (row
);
19479 it
->max_ascent
= it
->max_descent
= 0;
19480 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19484 /* Append one space to the glyph row of iterator IT if doing a
19485 window-based redisplay. The space has the same face as
19486 IT->face_id. Value is true if a space was added.
19488 This function is called to make sure that there is always one glyph
19489 at the end of a glyph row that the cursor can be set on under
19490 window-systems. (If there weren't such a glyph we would not know
19491 how wide and tall a box cursor should be displayed).
19493 At the same time this space let's a nicely handle clearing to the
19494 end of the line if the row ends in italic text. */
19497 append_space_for_newline (struct it
*it
, bool default_face_p
)
19499 if (FRAME_WINDOW_P (it
->f
))
19501 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19503 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19504 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19506 /* Save some values that must not be changed.
19507 Must save IT->c and IT->len because otherwise
19508 ITERATOR_AT_END_P wouldn't work anymore after
19509 append_space_for_newline has been called. */
19510 enum display_element_type saved_what
= it
->what
;
19511 int saved_c
= it
->c
, saved_len
= it
->len
;
19512 int saved_char_to_display
= it
->char_to_display
;
19513 int saved_x
= it
->current_x
;
19514 int saved_face_id
= it
->face_id
;
19515 bool saved_box_end
= it
->end_of_box_run_p
;
19516 struct text_pos saved_pos
;
19517 Lisp_Object saved_object
;
19520 saved_object
= it
->object
;
19521 saved_pos
= it
->position
;
19523 it
->what
= IT_CHARACTER
;
19524 memset (&it
->position
, 0, sizeof it
->position
);
19526 it
->c
= it
->char_to_display
= ' ';
19529 /* If the default face was remapped, be sure to use the
19530 remapped face for the appended newline. */
19531 if (default_face_p
)
19532 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19533 else if (it
->face_before_selective_p
)
19534 it
->face_id
= it
->saved_face_id
;
19535 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19536 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19537 /* In R2L rows, we will prepend a stretch glyph that will
19538 have the end_of_box_run_p flag set for it, so there's no
19539 need for the appended newline glyph to have that flag
19541 if (it
->glyph_row
->reversed_p
19542 /* But if the appended newline glyph goes all the way to
19543 the end of the row, there will be no stretch glyph,
19544 so leave the box flag set. */
19545 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19546 it
->end_of_box_run_p
= false;
19548 PRODUCE_GLYPHS (it
);
19550 #ifdef HAVE_WINDOW_SYSTEM
19551 /* Make sure this space glyph has the right ascent and
19552 descent values, or else cursor at end of line will look
19553 funny, and height of empty lines will be incorrect. */
19554 struct glyph
*g
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19555 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
19558 Lisp_Object height
, total_height
;
19559 int extra_line_spacing
= it
->extra_line_spacing
;
19560 int boff
= font
->baseline_offset
;
19562 if (font
->vertical_centering
)
19563 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
19565 it
->object
= saved_object
; /* get_it_property needs this */
19566 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
19567 /* Must do a subset of line height processing from
19568 x_produce_glyph for newline characters. */
19569 height
= get_it_property (it
, Qline_height
);
19571 && CONSP (XCDR (height
))
19572 && NILP (XCDR (XCDR (height
))))
19574 total_height
= XCAR (XCDR (height
));
19575 height
= XCAR (height
);
19578 total_height
= Qnil
;
19579 height
= calc_line_height_property (it
, height
, font
, boff
, true);
19581 if (it
->override_ascent
>= 0)
19583 it
->ascent
= it
->override_ascent
;
19584 it
->descent
= it
->override_descent
;
19585 boff
= it
->override_boff
;
19587 if (EQ (height
, Qt
))
19588 extra_line_spacing
= 0;
19591 Lisp_Object spacing
;
19593 it
->phys_ascent
= it
->ascent
;
19594 it
->phys_descent
= it
->descent
;
19596 && XINT (height
) > it
->ascent
+ it
->descent
)
19597 it
->ascent
= XINT (height
) - it
->descent
;
19599 if (!NILP (total_height
))
19600 spacing
= calc_line_height_property (it
, total_height
, font
,
19604 spacing
= get_it_property (it
, Qline_spacing
);
19605 spacing
= calc_line_height_property (it
, spacing
, font
,
19608 if (INTEGERP (spacing
))
19610 extra_line_spacing
= XINT (spacing
);
19611 if (!NILP (total_height
))
19612 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
19615 if (extra_line_spacing
> 0)
19617 it
->descent
+= extra_line_spacing
;
19618 if (extra_line_spacing
> it
->max_extra_line_spacing
)
19619 it
->max_extra_line_spacing
= extra_line_spacing
;
19621 it
->max_ascent
= it
->ascent
;
19622 it
->max_descent
= it
->descent
;
19623 /* Make sure compute_line_metrics recomputes the row height. */
19624 it
->glyph_row
->height
= 0;
19627 g
->ascent
= it
->max_ascent
;
19628 g
->descent
= it
->max_descent
;
19631 it
->override_ascent
= -1;
19632 it
->constrain_row_ascent_descent_p
= false;
19633 it
->current_x
= saved_x
;
19634 it
->object
= saved_object
;
19635 it
->position
= saved_pos
;
19636 it
->what
= saved_what
;
19637 it
->face_id
= saved_face_id
;
19638 it
->len
= saved_len
;
19640 it
->char_to_display
= saved_char_to_display
;
19641 it
->end_of_box_run_p
= saved_box_end
;
19650 /* Extend the face of the last glyph in the text area of IT->glyph_row
19651 to the end of the display line. Called from display_line. If the
19652 glyph row is empty, add a space glyph to it so that we know the
19653 face to draw. Set the glyph row flag fill_line_p. If the glyph
19654 row is R2L, prepend a stretch glyph to cover the empty space to the
19655 left of the leftmost glyph. */
19658 extend_face_to_end_of_line (struct it
*it
)
19660 struct face
*face
, *default_face
;
19661 struct frame
*f
= it
->f
;
19663 /* If line is already filled, do nothing. Non window-system frames
19664 get a grace of one more ``pixel'' because their characters are
19665 1-``pixel'' wide, so they hit the equality too early. This grace
19666 is needed only for R2L rows that are not continued, to produce
19667 one extra blank where we could display the cursor. */
19668 if ((it
->current_x
>= it
->last_visible_x
19669 + (!FRAME_WINDOW_P (f
)
19670 && it
->glyph_row
->reversed_p
19671 && !it
->glyph_row
->continued_p
))
19672 /* If the window has display margins, we will need to extend
19673 their face even if the text area is filled. */
19674 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19675 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19678 /* The default face, possibly remapped. */
19679 default_face
= FACE_FROM_ID_OR_NULL (f
,
19680 lookup_basic_face (f
, DEFAULT_FACE_ID
));
19682 /* Face extension extends the background and box of IT->face_id
19683 to the end of the line. If the background equals the background
19684 of the frame, we don't have to do anything. */
19685 face
= FACE_FROM_ID (f
, (it
->face_before_selective_p
19686 ? it
->saved_face_id
19689 if (FRAME_WINDOW_P (f
)
19690 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19691 && face
->box
== FACE_NO_BOX
19692 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19693 #ifdef HAVE_WINDOW_SYSTEM
19696 && !it
->glyph_row
->reversed_p
)
19699 /* Set the glyph row flag indicating that the face of the last glyph
19700 in the text area has to be drawn to the end of the text area. */
19701 it
->glyph_row
->fill_line_p
= true;
19703 /* If current character of IT is not ASCII, make sure we have the
19704 ASCII face. This will be automatically undone the next time
19705 get_next_display_element returns a multibyte character. Note
19706 that the character will always be single byte in unibyte
19708 if (!ASCII_CHAR_P (it
->c
))
19710 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19713 if (FRAME_WINDOW_P (f
))
19715 /* If the row is empty, add a space with the current face of IT,
19716 so that we know which face to draw. */
19717 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19719 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19720 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19721 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19723 /* Mode line and the header line don't have margins, and
19724 likewise the frame's tool-bar window, if there is any. */
19725 if (!(it
->glyph_row
->mode_line_p
19726 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19727 || (WINDOWP (f
->tool_bar_window
)
19728 && it
->w
== XWINDOW (f
->tool_bar_window
))
19732 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19733 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19735 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19736 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19738 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19740 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19741 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19743 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19744 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19746 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19749 #ifdef HAVE_WINDOW_SYSTEM
19750 if (it
->glyph_row
->reversed_p
)
19752 /* Prepend a stretch glyph to the row, such that the
19753 rightmost glyph will be drawn flushed all the way to the
19754 right margin of the window. The stretch glyph that will
19755 occupy the empty space, if any, to the left of the
19757 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19758 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19759 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19761 int row_width
, stretch_ascent
, stretch_width
;
19762 struct text_pos saved_pos
;
19764 bool saved_avoid_cursor
, saved_box_start
;
19766 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19767 row_width
+= g
->pixel_width
;
19769 /* FIXME: There are various minor display glitches in R2L
19770 rows when only one of the fringes is missing. The
19771 strange condition below produces the least bad effect. */
19772 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19773 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19774 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19775 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19777 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19778 stretch_width
-= row_width
;
19780 if (stretch_width
> 0)
19783 (((it
->ascent
+ it
->descent
)
19784 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19785 saved_pos
= it
->position
;
19786 memset (&it
->position
, 0, sizeof it
->position
);
19787 saved_avoid_cursor
= it
->avoid_cursor_p
;
19788 it
->avoid_cursor_p
= true;
19789 saved_face_id
= it
->face_id
;
19790 saved_box_start
= it
->start_of_box_run_p
;
19791 /* The last row's stretch glyph should get the default
19792 face, to avoid painting the rest of the window with
19793 the region face, if the region ends at ZV. */
19794 if (it
->glyph_row
->ends_at_zv_p
)
19795 it
->face_id
= default_face
->id
;
19797 it
->face_id
= face
->id
;
19798 it
->start_of_box_run_p
= false;
19799 append_stretch_glyph (it
, Qnil
, stretch_width
,
19800 it
->ascent
+ it
->descent
, stretch_ascent
);
19801 it
->position
= saved_pos
;
19802 it
->avoid_cursor_p
= saved_avoid_cursor
;
19803 it
->face_id
= saved_face_id
;
19804 it
->start_of_box_run_p
= saved_box_start
;
19806 /* If stretch_width comes out negative, it means that the
19807 last glyph is only partially visible. In R2L rows, we
19808 want the leftmost glyph to be partially visible, so we
19809 need to give the row the corresponding left offset. */
19810 if (stretch_width
< 0)
19811 it
->glyph_row
->x
= stretch_width
;
19813 #endif /* HAVE_WINDOW_SYSTEM */
19817 /* Save some values that must not be changed. */
19818 int saved_x
= it
->current_x
;
19819 struct text_pos saved_pos
;
19820 Lisp_Object saved_object
;
19821 enum display_element_type saved_what
= it
->what
;
19822 int saved_face_id
= it
->face_id
;
19824 saved_object
= it
->object
;
19825 saved_pos
= it
->position
;
19827 it
->what
= IT_CHARACTER
;
19828 memset (&it
->position
, 0, sizeof it
->position
);
19830 it
->c
= it
->char_to_display
= ' ';
19833 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19834 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19835 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19836 && !it
->glyph_row
->mode_line_p
19837 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19839 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19840 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19842 for (it
->current_x
= 0; g
< e
; g
++)
19843 it
->current_x
+= g
->pixel_width
;
19845 it
->area
= LEFT_MARGIN_AREA
;
19846 it
->face_id
= default_face
->id
;
19847 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19848 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19850 PRODUCE_GLYPHS (it
);
19851 /* term.c:produce_glyphs advances it->current_x only for
19853 it
->current_x
+= it
->pixel_width
;
19856 it
->current_x
= saved_x
;
19857 it
->area
= TEXT_AREA
;
19860 /* The last row's blank glyphs should get the default face, to
19861 avoid painting the rest of the window with the region face,
19862 if the region ends at ZV. */
19863 if (it
->glyph_row
->ends_at_zv_p
)
19864 it
->face_id
= default_face
->id
;
19866 it
->face_id
= face
->id
;
19867 PRODUCE_GLYPHS (it
);
19869 while (it
->current_x
<= it
->last_visible_x
)
19870 PRODUCE_GLYPHS (it
);
19872 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19873 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19874 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19875 && !it
->glyph_row
->mode_line_p
19876 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19878 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19879 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19881 for ( ; g
< e
; g
++)
19882 it
->current_x
+= g
->pixel_width
;
19884 it
->area
= RIGHT_MARGIN_AREA
;
19885 it
->face_id
= default_face
->id
;
19886 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19887 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19889 PRODUCE_GLYPHS (it
);
19890 it
->current_x
+= it
->pixel_width
;
19893 it
->area
= TEXT_AREA
;
19896 /* Don't count these blanks really. It would let us insert a left
19897 truncation glyph below and make us set the cursor on them, maybe. */
19898 it
->current_x
= saved_x
;
19899 it
->object
= saved_object
;
19900 it
->position
= saved_pos
;
19901 it
->what
= saved_what
;
19902 it
->face_id
= saved_face_id
;
19907 /* Value is true if text starting at CHARPOS in current_buffer is
19908 trailing whitespace. */
19911 trailing_whitespace_p (ptrdiff_t charpos
)
19913 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19916 while (bytepos
< ZV_BYTE
19917 && (c
= FETCH_CHAR (bytepos
),
19918 c
== ' ' || c
== '\t'))
19921 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19923 if (bytepos
!= PT_BYTE
)
19930 /* Highlight trailing whitespace, if any, in ROW. */
19933 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19935 int used
= row
->used
[TEXT_AREA
];
19939 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19940 struct glyph
*glyph
= start
+ used
- 1;
19942 if (row
->reversed_p
)
19944 /* Right-to-left rows need to be processed in the opposite
19945 direction, so swap the edge pointers. */
19947 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19950 /* Skip over glyphs inserted to display the cursor at the
19951 end of a line, for extending the face of the last glyph
19952 to the end of the line on terminals, and for truncation
19953 and continuation glyphs. */
19954 if (!row
->reversed_p
)
19956 while (glyph
>= start
19957 && glyph
->type
== CHAR_GLYPH
19958 && NILP (glyph
->object
))
19963 while (glyph
<= start
19964 && glyph
->type
== CHAR_GLYPH
19965 && NILP (glyph
->object
))
19969 /* If last glyph is a space or stretch, and it's trailing
19970 whitespace, set the face of all trailing whitespace glyphs in
19971 IT->glyph_row to `trailing-whitespace'. */
19972 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19973 && BUFFERP (glyph
->object
)
19974 && (glyph
->type
== STRETCH_GLYPH
19975 || (glyph
->type
== CHAR_GLYPH
19976 && glyph
->u
.ch
== ' '))
19977 && trailing_whitespace_p (glyph
->charpos
))
19979 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, false);
19983 if (!row
->reversed_p
)
19985 while (glyph
>= start
19986 && BUFFERP (glyph
->object
)
19987 && (glyph
->type
== STRETCH_GLYPH
19988 || (glyph
->type
== CHAR_GLYPH
19989 && glyph
->u
.ch
== ' ')))
19990 (glyph
--)->face_id
= face_id
;
19994 while (glyph
<= start
19995 && BUFFERP (glyph
->object
)
19996 && (glyph
->type
== STRETCH_GLYPH
19997 || (glyph
->type
== CHAR_GLYPH
19998 && glyph
->u
.ch
== ' ')))
19999 (glyph
++)->face_id
= face_id
;
20006 /* Value is true if glyph row ROW should be
20007 considered to hold the buffer position CHARPOS. */
20010 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
20012 bool result
= true;
20014 if (charpos
== CHARPOS (row
->end
.pos
)
20015 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
20017 /* Suppose the row ends on a string.
20018 Unless the row is continued, that means it ends on a newline
20019 in the string. If it's anything other than a display string
20020 (e.g., a before-string from an overlay), we don't want the
20021 cursor there. (This heuristic seems to give the optimal
20022 behavior for the various types of multi-line strings.)
20023 One exception: if the string has `cursor' property on one of
20024 its characters, we _do_ want the cursor there. */
20025 if (CHARPOS (row
->end
.string_pos
) >= 0)
20027 if (row
->continued_p
)
20031 /* Check for `display' property. */
20032 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
20033 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
20034 struct glyph
*glyph
;
20037 for (glyph
= end
; glyph
>= beg
; --glyph
)
20038 if (STRINGP (glyph
->object
))
20041 = Fget_char_property (make_number (charpos
),
20045 && display_prop_string_p (prop
, glyph
->object
));
20046 /* If there's a `cursor' property on one of the
20047 string's characters, this row is a cursor row,
20048 even though this is not a display string. */
20051 Lisp_Object s
= glyph
->object
;
20053 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
20055 ptrdiff_t gpos
= glyph
->charpos
;
20057 if (!NILP (Fget_char_property (make_number (gpos
),
20069 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
20071 /* If the row ends in middle of a real character,
20072 and the line is continued, we want the cursor here.
20073 That's because CHARPOS (ROW->end.pos) would equal
20074 PT if PT is before the character. */
20075 if (!row
->ends_in_ellipsis_p
)
20076 result
= row
->continued_p
;
20078 /* If the row ends in an ellipsis, then
20079 CHARPOS (ROW->end.pos) will equal point after the
20080 invisible text. We want that position to be displayed
20081 after the ellipsis. */
20084 /* If the row ends at ZV, display the cursor at the end of that
20085 row instead of at the start of the row below. */
20087 result
= row
->ends_at_zv_p
;
20093 /* Value is true if glyph row ROW should be
20094 used to hold the cursor. */
20097 cursor_row_p (struct glyph_row
*row
)
20099 return row_for_charpos_p (row
, PT
);
20104 /* Push the property PROP so that it will be rendered at the current
20105 position in IT. Return true if PROP was successfully pushed, false
20106 otherwise. Called from handle_line_prefix to handle the
20107 `line-prefix' and `wrap-prefix' properties. */
20110 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
20112 struct text_pos pos
=
20113 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
20115 eassert (it
->method
== GET_FROM_BUFFER
20116 || it
->method
== GET_FROM_DISPLAY_VECTOR
20117 || it
->method
== GET_FROM_STRING
20118 || it
->method
== GET_FROM_IMAGE
);
20120 /* We need to save the current buffer/string position, so it will be
20121 restored by pop_it, because iterate_out_of_display_property
20122 depends on that being set correctly, but some situations leave
20123 it->position not yet set when this function is called. */
20124 push_it (it
, &pos
);
20126 if (STRINGP (prop
))
20128 if (SCHARS (prop
) == 0)
20135 it
->string_from_prefix_prop_p
= true;
20136 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
20137 it
->current
.overlay_string_index
= -1;
20138 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
20139 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
20140 it
->method
= GET_FROM_STRING
;
20141 it
->stop_charpos
= 0;
20143 it
->base_level_stop
= 0;
20145 /* Force paragraph direction to be that of the parent
20147 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
20148 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
20150 it
->paragraph_embedding
= L2R
;
20152 /* Set up the bidi iterator for this display string. */
20155 it
->bidi_it
.string
.lstring
= it
->string
;
20156 it
->bidi_it
.string
.s
= NULL
;
20157 it
->bidi_it
.string
.schars
= it
->end_charpos
;
20158 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
20159 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
20160 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
20161 it
->bidi_it
.w
= it
->w
;
20162 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
20165 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
20167 it
->method
= GET_FROM_STRETCH
;
20170 #ifdef HAVE_WINDOW_SYSTEM
20171 else if (IMAGEP (prop
))
20173 it
->what
= IT_IMAGE
;
20174 it
->image_id
= lookup_image (it
->f
, prop
);
20175 it
->method
= GET_FROM_IMAGE
;
20177 #endif /* HAVE_WINDOW_SYSTEM */
20180 pop_it (it
); /* bogus display property, give up */
20187 /* Return the character-property PROP at the current position in IT. */
20190 get_it_property (struct it
*it
, Lisp_Object prop
)
20192 Lisp_Object position
, object
= it
->object
;
20194 if (STRINGP (object
))
20195 position
= make_number (IT_STRING_CHARPOS (*it
));
20196 else if (BUFFERP (object
))
20198 position
= make_number (IT_CHARPOS (*it
));
20199 object
= it
->window
;
20204 return Fget_char_property (position
, prop
, object
);
20207 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
20210 handle_line_prefix (struct it
*it
)
20212 Lisp_Object prefix
;
20214 if (it
->continuation_lines_width
> 0)
20216 prefix
= get_it_property (it
, Qwrap_prefix
);
20218 prefix
= Vwrap_prefix
;
20222 prefix
= get_it_property (it
, Qline_prefix
);
20224 prefix
= Vline_prefix
;
20226 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
20228 /* If the prefix is wider than the window, and we try to wrap
20229 it, it would acquire its own wrap prefix, and so on till the
20230 iterator stack overflows. So, don't wrap the prefix. */
20231 it
->line_wrap
= TRUNCATE
;
20232 it
->avoid_cursor_p
= true;
20238 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
20239 only for R2L lines from display_line and display_string, when they
20240 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
20241 the line/string needs to be continued on the next glyph row. */
20243 unproduce_glyphs (struct it
*it
, int n
)
20245 struct glyph
*glyph
, *end
;
20247 eassert (it
->glyph_row
);
20248 eassert (it
->glyph_row
->reversed_p
);
20249 eassert (it
->area
== TEXT_AREA
);
20250 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
20252 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
20253 n
= it
->glyph_row
->used
[TEXT_AREA
];
20254 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
20255 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
20256 for ( ; glyph
< end
; glyph
++)
20257 glyph
[-n
] = *glyph
;
20260 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
20261 and ROW->maxpos. */
20263 find_row_edges (struct it
*it
, struct glyph_row
*row
,
20264 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
20265 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
20267 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20268 lines' rows is implemented for bidi-reordered rows. */
20270 /* ROW->minpos is the value of min_pos, the minimal buffer position
20271 we have in ROW, or ROW->start.pos if that is smaller. */
20272 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
20273 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
20275 /* We didn't find buffer positions smaller than ROW->start, or
20276 didn't find _any_ valid buffer positions in any of the glyphs,
20277 so we must trust the iterator's computed positions. */
20278 row
->minpos
= row
->start
.pos
;
20281 max_pos
= CHARPOS (it
->current
.pos
);
20282 max_bpos
= BYTEPOS (it
->current
.pos
);
20285 /* Here are the various use-cases for ending the row, and the
20286 corresponding values for ROW->maxpos:
20288 Line ends in a newline from buffer eol_pos + 1
20289 Line is continued from buffer max_pos + 1
20290 Line is truncated on right it->current.pos
20291 Line ends in a newline from string max_pos + 1(*)
20292 (*) + 1 only when line ends in a forward scan
20293 Line is continued from string max_pos
20294 Line is continued from display vector max_pos
20295 Line is entirely from a string min_pos == max_pos
20296 Line is entirely from a display vector min_pos == max_pos
20297 Line that ends at ZV ZV
20299 If you discover other use-cases, please add them here as
20301 if (row
->ends_at_zv_p
)
20302 row
->maxpos
= it
->current
.pos
;
20303 else if (row
->used
[TEXT_AREA
])
20305 bool seen_this_string
= false;
20306 struct glyph_row
*r1
= row
- 1;
20308 /* Did we see the same display string on the previous row? */
20309 if (STRINGP (it
->object
)
20310 /* this is not the first row */
20311 && row
> it
->w
->desired_matrix
->rows
20312 /* previous row is not the header line */
20313 && !r1
->mode_line_p
20314 /* previous row also ends in a newline from a string */
20315 && r1
->ends_in_newline_from_string_p
)
20317 struct glyph
*start
, *end
;
20319 /* Search for the last glyph of the previous row that came
20320 from buffer or string. Depending on whether the row is
20321 L2R or R2L, we need to process it front to back or the
20322 other way round. */
20323 if (!r1
->reversed_p
)
20325 start
= r1
->glyphs
[TEXT_AREA
];
20326 end
= start
+ r1
->used
[TEXT_AREA
];
20327 /* Glyphs inserted by redisplay have nil as their object. */
20329 && NILP ((end
- 1)->object
)
20330 && (end
- 1)->charpos
<= 0)
20334 if (EQ ((end
- 1)->object
, it
->object
))
20335 seen_this_string
= true;
20338 /* If all the glyphs of the previous row were inserted
20339 by redisplay, it means the previous row was
20340 produced from a single newline, which is only
20341 possible if that newline came from the same string
20342 as the one which produced this ROW. */
20343 seen_this_string
= true;
20347 end
= r1
->glyphs
[TEXT_AREA
] - 1;
20348 start
= end
+ r1
->used
[TEXT_AREA
];
20350 && NILP ((end
+ 1)->object
)
20351 && (end
+ 1)->charpos
<= 0)
20355 if (EQ ((end
+ 1)->object
, it
->object
))
20356 seen_this_string
= true;
20359 seen_this_string
= true;
20362 /* Take note of each display string that covers a newline only
20363 once, the first time we see it. This is for when a display
20364 string includes more than one newline in it. */
20365 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
20367 /* If we were scanning the buffer forward when we displayed
20368 the string, we want to account for at least one buffer
20369 position that belongs to this row (position covered by
20370 the display string), so that cursor positioning will
20371 consider this row as a candidate when point is at the end
20372 of the visual line represented by this row. This is not
20373 required when scanning back, because max_pos will already
20374 have a much larger value. */
20375 if (CHARPOS (row
->end
.pos
) > max_pos
)
20376 INC_BOTH (max_pos
, max_bpos
);
20377 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20379 else if (CHARPOS (it
->eol_pos
) > 0)
20380 SET_TEXT_POS (row
->maxpos
,
20381 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
20382 else if (row
->continued_p
)
20384 /* If max_pos is different from IT's current position, it
20385 means IT->method does not belong to the display element
20386 at max_pos. However, it also means that the display
20387 element at max_pos was displayed in its entirety on this
20388 line, which is equivalent to saying that the next line
20389 starts at the next buffer position. */
20390 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
20391 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20394 INC_BOTH (max_pos
, max_bpos
);
20395 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20398 else if (row
->truncated_on_right_p
)
20399 /* display_line already called reseat_at_next_visible_line_start,
20400 which puts the iterator at the beginning of the next line, in
20401 the logical order. */
20402 row
->maxpos
= it
->current
.pos
;
20403 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20404 /* A line that is entirely from a string/image/stretch... */
20405 row
->maxpos
= row
->minpos
;
20410 row
->maxpos
= it
->current
.pos
;
20413 /* Construct the glyph row IT->glyph_row in the desired matrix of
20414 IT->w from text at the current position of IT. See dispextern.h
20415 for an overview of struct it. Value is true if
20416 IT->glyph_row displays text, as opposed to a line displaying ZV
20420 display_line (struct it
*it
)
20422 struct glyph_row
*row
= it
->glyph_row
;
20423 Lisp_Object overlay_arrow_string
;
20425 void *wrap_data
= NULL
;
20426 bool may_wrap
= false;
20428 int wrap_row_used
= -1;
20429 int wrap_row_ascent UNINIT
, wrap_row_height UNINIT
;
20430 int wrap_row_phys_ascent UNINIT
, wrap_row_phys_height UNINIT
;
20431 int wrap_row_extra_line_spacing UNINIT
;
20432 ptrdiff_t wrap_row_min_pos UNINIT
, wrap_row_min_bpos UNINIT
;
20433 ptrdiff_t wrap_row_max_pos UNINIT
, wrap_row_max_bpos UNINIT
;
20435 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20436 ptrdiff_t min_bpos UNINIT
, max_bpos UNINIT
;
20437 bool pending_handle_line_prefix
= false;
20439 /* We always start displaying at hpos zero even if hscrolled. */
20440 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20442 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20443 >= it
->w
->desired_matrix
->nrows
)
20445 it
->w
->nrows_scale_factor
++;
20446 it
->f
->fonts_changed
= true;
20450 /* Clear the result glyph row and enable it. */
20451 prepare_desired_row (it
->w
, row
, false);
20453 row
->y
= it
->current_y
;
20454 row
->start
= it
->start
;
20455 row
->continuation_lines_width
= it
->continuation_lines_width
;
20456 row
->displays_text_p
= true;
20457 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20458 it
->starts_in_middle_of_char_p
= false;
20460 /* Arrange the overlays nicely for our purposes. Usually, we call
20461 display_line on only one line at a time, in which case this
20462 can't really hurt too much, or we call it on lines which appear
20463 one after another in the buffer, in which case all calls to
20464 recenter_overlay_lists but the first will be pretty cheap. */
20465 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20467 /* Move over display elements that are not visible because we are
20468 hscrolled. This may stop at an x-position < IT->first_visible_x
20469 if the first glyph is partially visible or if we hit a line end. */
20470 if (it
->current_x
< it
->first_visible_x
)
20472 enum move_it_result move_result
;
20474 this_line_min_pos
= row
->start
.pos
;
20475 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20476 MOVE_TO_POS
| MOVE_TO_X
);
20477 /* If we are under a large hscroll, move_it_in_display_line_to
20478 could hit the end of the line without reaching
20479 it->first_visible_x. Pretend that we did reach it. This is
20480 especially important on a TTY, where we will call
20481 extend_face_to_end_of_line, which needs to know how many
20482 blank glyphs to produce. */
20483 if (it
->current_x
< it
->first_visible_x
20484 && (move_result
== MOVE_NEWLINE_OR_CR
20485 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20486 it
->current_x
= it
->first_visible_x
;
20488 /* Record the smallest positions seen while we moved over
20489 display elements that are not visible. This is needed by
20490 redisplay_internal for optimizing the case where the cursor
20491 stays inside the same line. The rest of this function only
20492 considers positions that are actually displayed, so
20493 RECORD_MAX_MIN_POS will not otherwise record positions that
20494 are hscrolled to the left of the left edge of the window. */
20495 min_pos
= CHARPOS (this_line_min_pos
);
20496 min_bpos
= BYTEPOS (this_line_min_pos
);
20498 else if (it
->area
== TEXT_AREA
)
20500 /* We only do this when not calling move_it_in_display_line_to
20501 above, because that function calls itself handle_line_prefix. */
20502 handle_line_prefix (it
);
20506 /* Line-prefix and wrap-prefix are always displayed in the text
20507 area. But if this is the first call to display_line after
20508 init_iterator, the iterator might have been set up to write
20509 into a marginal area, e.g. if the line begins with some
20510 display property that writes to the margins. So we need to
20511 wait with the call to handle_line_prefix until whatever
20512 writes to the margin has done its job. */
20513 pending_handle_line_prefix
= true;
20516 /* Get the initial row height. This is either the height of the
20517 text hscrolled, if there is any, or zero. */
20518 row
->ascent
= it
->max_ascent
;
20519 row
->height
= it
->max_ascent
+ it
->max_descent
;
20520 row
->phys_ascent
= it
->max_phys_ascent
;
20521 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20522 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20524 /* Utility macro to record max and min buffer positions seen until now. */
20525 #define RECORD_MAX_MIN_POS(IT) \
20528 bool composition_p \
20529 = !STRINGP ((IT)->string) && ((IT)->what == IT_COMPOSITION); \
20530 ptrdiff_t current_pos = \
20531 composition_p ? (IT)->cmp_it.charpos \
20532 : IT_CHARPOS (*(IT)); \
20533 ptrdiff_t current_bpos = \
20534 composition_p ? CHAR_TO_BYTE (current_pos) \
20535 : IT_BYTEPOS (*(IT)); \
20536 if (current_pos < min_pos) \
20538 min_pos = current_pos; \
20539 min_bpos = current_bpos; \
20541 if (IT_CHARPOS (*it) > max_pos) \
20543 max_pos = IT_CHARPOS (*it); \
20544 max_bpos = IT_BYTEPOS (*it); \
20549 /* Loop generating characters. The loop is left with IT on the next
20550 character to display. */
20553 int n_glyphs_before
, hpos_before
, x_before
;
20555 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20557 /* Retrieve the next thing to display. Value is false if end of
20559 if (!get_next_display_element (it
))
20561 /* Maybe add a space at the end of this line that is used to
20562 display the cursor there under X. Set the charpos of the
20563 first glyph of blank lines not corresponding to any text
20565 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20566 row
->exact_window_width_line_p
= true;
20567 else if ((append_space_for_newline (it
, true)
20568 && row
->used
[TEXT_AREA
] == 1)
20569 || row
->used
[TEXT_AREA
] == 0)
20571 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20572 row
->displays_text_p
= false;
20574 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20575 && (!MINI_WINDOW_P (it
->w
)
20576 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20577 row
->indicate_empty_line_p
= true;
20580 it
->continuation_lines_width
= 0;
20581 row
->ends_at_zv_p
= true;
20582 /* A row that displays right-to-left text must always have
20583 its last face extended all the way to the end of line,
20584 even if this row ends in ZV, because we still write to
20585 the screen left to right. We also need to extend the
20586 last face if the default face is remapped to some
20587 different face, otherwise the functions that clear
20588 portions of the screen will clear with the default face's
20589 background color. */
20590 if (row
->reversed_p
20591 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20592 extend_face_to_end_of_line (it
);
20596 /* Now, get the metrics of what we want to display. This also
20597 generates glyphs in `row' (which is IT->glyph_row). */
20598 n_glyphs_before
= row
->used
[TEXT_AREA
];
20601 /* Remember the line height so far in case the next element doesn't
20602 fit on the line. */
20603 if (it
->line_wrap
!= TRUNCATE
)
20605 ascent
= it
->max_ascent
;
20606 descent
= it
->max_descent
;
20607 phys_ascent
= it
->max_phys_ascent
;
20608 phys_descent
= it
->max_phys_descent
;
20610 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20612 if (IT_DISPLAYING_WHITESPACE (it
))
20616 SAVE_IT (wrap_it
, *it
, wrap_data
);
20618 wrap_row_used
= row
->used
[TEXT_AREA
];
20619 wrap_row_ascent
= row
->ascent
;
20620 wrap_row_height
= row
->height
;
20621 wrap_row_phys_ascent
= row
->phys_ascent
;
20622 wrap_row_phys_height
= row
->phys_height
;
20623 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20624 wrap_row_min_pos
= min_pos
;
20625 wrap_row_min_bpos
= min_bpos
;
20626 wrap_row_max_pos
= max_pos
;
20627 wrap_row_max_bpos
= max_bpos
;
20633 PRODUCE_GLYPHS (it
);
20635 /* If this display element was in marginal areas, continue with
20637 if (it
->area
!= TEXT_AREA
)
20639 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20640 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20641 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20642 row
->phys_height
= max (row
->phys_height
,
20643 it
->max_phys_ascent
+ it
->max_phys_descent
);
20644 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20645 it
->max_extra_line_spacing
);
20646 set_iterator_to_next (it
, true);
20647 /* If we didn't handle the line/wrap prefix above, and the
20648 call to set_iterator_to_next just switched to TEXT_AREA,
20649 process the prefix now. */
20650 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20652 pending_handle_line_prefix
= false;
20653 handle_line_prefix (it
);
20658 /* Does the display element fit on the line? If we truncate
20659 lines, we should draw past the right edge of the window. If
20660 we don't truncate, we want to stop so that we can display the
20661 continuation glyph before the right margin. If lines are
20662 continued, there are two possible strategies for characters
20663 resulting in more than 1 glyph (e.g. tabs): Display as many
20664 glyphs as possible in this line and leave the rest for the
20665 continuation line, or display the whole element in the next
20666 line. Original redisplay did the former, so we do it also. */
20667 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20668 hpos_before
= it
->hpos
;
20671 if (/* Not a newline. */
20673 /* Glyphs produced fit entirely in the line. */
20674 && it
->current_x
< it
->last_visible_x
)
20676 it
->hpos
+= nglyphs
;
20677 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20678 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20679 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20680 row
->phys_height
= max (row
->phys_height
,
20681 it
->max_phys_ascent
+ it
->max_phys_descent
);
20682 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20683 it
->max_extra_line_spacing
);
20684 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20685 /* In R2L rows, we arrange in extend_face_to_end_of_line
20686 to add a right offset to the line, by a suitable
20687 change to the stretch glyph that is the leftmost
20688 glyph of the line. */
20689 && !row
->reversed_p
)
20690 row
->x
= x
- it
->first_visible_x
;
20691 /* Record the maximum and minimum buffer positions seen so
20692 far in glyphs that will be displayed by this row. */
20694 RECORD_MAX_MIN_POS (it
);
20699 struct glyph
*glyph
;
20701 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20703 /* Identify the glyphs added by the last call to
20704 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20705 the previous glyphs. */
20706 if (!row
->reversed_p
)
20707 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20709 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20710 new_x
= x
+ glyph
->pixel_width
;
20712 if (/* Lines are continued. */
20713 it
->line_wrap
!= TRUNCATE
20714 && (/* Glyph doesn't fit on the line. */
20715 new_x
> it
->last_visible_x
20716 /* Or it fits exactly on a window system frame. */
20717 || (new_x
== it
->last_visible_x
20718 && FRAME_WINDOW_P (it
->f
)
20719 && (row
->reversed_p
20720 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20721 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20723 /* End of a continued line. */
20726 || (new_x
== it
->last_visible_x
20727 && FRAME_WINDOW_P (it
->f
)
20728 && (row
->reversed_p
20729 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20730 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20732 /* Current glyph is the only one on the line or
20733 fits exactly on the line. We must continue
20734 the line because we can't draw the cursor
20735 after the glyph. */
20736 row
->continued_p
= true;
20737 it
->current_x
= new_x
;
20738 it
->continuation_lines_width
+= new_x
;
20740 if (i
== nglyphs
- 1)
20742 /* If line-wrap is on, check if a previous
20743 wrap point was found. */
20744 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)
20745 && wrap_row_used
> 0
20746 /* Even if there is a previous wrap
20747 point, continue the line here as
20748 usual, if (i) the previous character
20749 was a space or tab AND (ii) the
20750 current character is not. */
20752 || IT_DISPLAYING_WHITESPACE (it
)))
20755 /* Record the maximum and minimum buffer
20756 positions seen so far in glyphs that will be
20757 displayed by this row. */
20759 RECORD_MAX_MIN_POS (it
);
20760 set_iterator_to_next (it
, true);
20761 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20763 if (!get_next_display_element (it
))
20765 row
->exact_window_width_line_p
= true;
20766 it
->continuation_lines_width
= 0;
20767 row
->continued_p
= false;
20768 row
->ends_at_zv_p
= true;
20770 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20772 row
->continued_p
= false;
20773 row
->exact_window_width_line_p
= true;
20775 /* If line-wrap is on, check if a
20776 previous wrap point was found. */
20777 else if (wrap_row_used
> 0
20778 /* Even if there is a previous wrap
20779 point, continue the line here as
20780 usual, if (i) the previous character
20781 was a space or tab AND (ii) the
20782 current character is not. */
20784 || IT_DISPLAYING_WHITESPACE (it
)))
20789 else if (it
->bidi_p
)
20790 RECORD_MAX_MIN_POS (it
);
20791 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20792 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20793 extend_face_to_end_of_line (it
);
20795 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20796 && !FRAME_WINDOW_P (it
->f
))
20798 /* A padding glyph that doesn't fit on this line.
20799 This means the whole character doesn't fit
20801 if (row
->reversed_p
)
20802 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20803 - n_glyphs_before
);
20804 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20806 /* Fill the rest of the row with continuation
20807 glyphs like in 20.x. */
20808 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20809 < row
->glyphs
[1 + TEXT_AREA
])
20810 produce_special_glyphs (it
, IT_CONTINUATION
);
20812 row
->continued_p
= true;
20813 it
->current_x
= x_before
;
20814 it
->continuation_lines_width
+= x_before
;
20816 /* Restore the height to what it was before the
20817 element not fitting on the line. */
20818 it
->max_ascent
= ascent
;
20819 it
->max_descent
= descent
;
20820 it
->max_phys_ascent
= phys_ascent
;
20821 it
->max_phys_descent
= phys_descent
;
20822 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20823 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20824 extend_face_to_end_of_line (it
);
20826 else if (wrap_row_used
> 0)
20829 if (row
->reversed_p
)
20830 unproduce_glyphs (it
,
20831 row
->used
[TEXT_AREA
] - wrap_row_used
);
20832 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20833 it
->continuation_lines_width
+= wrap_x
;
20834 row
->used
[TEXT_AREA
] = wrap_row_used
;
20835 row
->ascent
= wrap_row_ascent
;
20836 row
->height
= wrap_row_height
;
20837 row
->phys_ascent
= wrap_row_phys_ascent
;
20838 row
->phys_height
= wrap_row_phys_height
;
20839 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20840 min_pos
= wrap_row_min_pos
;
20841 min_bpos
= wrap_row_min_bpos
;
20842 max_pos
= wrap_row_max_pos
;
20843 max_bpos
= wrap_row_max_bpos
;
20844 row
->continued_p
= true;
20845 row
->ends_at_zv_p
= false;
20846 row
->exact_window_width_line_p
= false;
20847 it
->continuation_lines_width
+= x
;
20849 /* Make sure that a non-default face is extended
20850 up to the right margin of the window. */
20851 extend_face_to_end_of_line (it
);
20853 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20855 /* A TAB that extends past the right edge of the
20856 window. This produces a single glyph on
20857 window system frames. We leave the glyph in
20858 this row and let it fill the row, but don't
20859 consume the TAB. */
20860 if ((row
->reversed_p
20861 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20862 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20863 produce_special_glyphs (it
, IT_CONTINUATION
);
20864 it
->continuation_lines_width
+= it
->last_visible_x
;
20865 row
->ends_in_middle_of_char_p
= true;
20866 row
->continued_p
= true;
20867 glyph
->pixel_width
= it
->last_visible_x
- x
;
20868 it
->starts_in_middle_of_char_p
= true;
20869 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20870 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20871 extend_face_to_end_of_line (it
);
20875 /* Something other than a TAB that draws past
20876 the right edge of the window. Restore
20877 positions to values before the element. */
20878 if (row
->reversed_p
)
20879 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20880 - (n_glyphs_before
+ i
));
20881 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20883 /* Display continuation glyphs. */
20884 it
->current_x
= x_before
;
20885 it
->continuation_lines_width
+= x
;
20886 if (!FRAME_WINDOW_P (it
->f
)
20887 || (row
->reversed_p
20888 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20889 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20890 produce_special_glyphs (it
, IT_CONTINUATION
);
20891 row
->continued_p
= true;
20893 extend_face_to_end_of_line (it
);
20895 if (nglyphs
> 1 && i
> 0)
20897 row
->ends_in_middle_of_char_p
= true;
20898 it
->starts_in_middle_of_char_p
= true;
20901 /* Restore the height to what it was before the
20902 element not fitting on the line. */
20903 it
->max_ascent
= ascent
;
20904 it
->max_descent
= descent
;
20905 it
->max_phys_ascent
= phys_ascent
;
20906 it
->max_phys_descent
= phys_descent
;
20911 else if (new_x
> it
->first_visible_x
)
20913 /* Increment number of glyphs actually displayed. */
20916 /* Record the maximum and minimum buffer positions
20917 seen so far in glyphs that will be displayed by
20920 RECORD_MAX_MIN_POS (it
);
20922 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20923 /* Glyph is partially visible, i.e. row starts at
20924 negative X position. Don't do that in R2L
20925 rows, where we arrange to add a right offset to
20926 the line in extend_face_to_end_of_line, by a
20927 suitable change to the stretch glyph that is
20928 the leftmost glyph of the line. */
20929 row
->x
= x
- it
->first_visible_x
;
20930 /* When the last glyph of an R2L row only fits
20931 partially on the line, we need to set row->x to a
20932 negative offset, so that the leftmost glyph is
20933 the one that is partially visible. But if we are
20934 going to produce the truncation glyph, this will
20935 be taken care of in produce_special_glyphs. */
20936 if (row
->reversed_p
20937 && new_x
> it
->last_visible_x
20938 && !(it
->line_wrap
== TRUNCATE
20939 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
20941 eassert (FRAME_WINDOW_P (it
->f
));
20942 row
->x
= it
->last_visible_x
- new_x
;
20947 /* Glyph is completely off the left margin of the
20948 window. This should not happen because of the
20949 move_it_in_display_line at the start of this
20950 function, unless the text display area of the
20951 window is empty. */
20952 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20955 /* Even if this display element produced no glyphs at all,
20956 we want to record its position. */
20957 if (it
->bidi_p
&& nglyphs
== 0)
20958 RECORD_MAX_MIN_POS (it
);
20960 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20961 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20962 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20963 row
->phys_height
= max (row
->phys_height
,
20964 it
->max_phys_ascent
+ it
->max_phys_descent
);
20965 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20966 it
->max_extra_line_spacing
);
20968 /* End of this display line if row is continued. */
20969 if (row
->continued_p
|| row
->ends_at_zv_p
)
20974 /* Is this a line end? If yes, we're also done, after making
20975 sure that a non-default face is extended up to the right
20976 margin of the window. */
20977 if (ITERATOR_AT_END_OF_LINE_P (it
))
20979 int used_before
= row
->used
[TEXT_AREA
];
20981 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20983 /* Add a space at the end of the line that is used to
20984 display the cursor there. */
20985 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20986 append_space_for_newline (it
, false);
20988 /* Extend the face to the end of the line. */
20989 extend_face_to_end_of_line (it
);
20991 /* Make sure we have the position. */
20992 if (used_before
== 0)
20993 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20995 /* Record the position of the newline, for use in
20997 it
->eol_pos
= it
->current
.pos
;
20999 /* Consume the line end. This skips over invisible lines. */
21000 set_iterator_to_next (it
, true);
21001 it
->continuation_lines_width
= 0;
21005 /* Proceed with next display element. Note that this skips
21006 over lines invisible because of selective display. */
21007 set_iterator_to_next (it
, true);
21009 /* If we truncate lines, we are done when the last displayed
21010 glyphs reach past the right margin of the window. */
21011 if (it
->line_wrap
== TRUNCATE
21012 && ((FRAME_WINDOW_P (it
->f
)
21013 /* Images are preprocessed in produce_image_glyph such
21014 that they are cropped at the right edge of the
21015 window, so an image glyph will always end exactly at
21016 last_visible_x, even if there's no right fringe. */
21017 && ((row
->reversed_p
21018 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
21019 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
21020 || it
->what
== IT_IMAGE
))
21021 ? (it
->current_x
>= it
->last_visible_x
)
21022 : (it
->current_x
> it
->last_visible_x
)))
21024 /* Maybe add truncation glyphs. */
21025 if (!FRAME_WINDOW_P (it
->f
)
21026 || (row
->reversed_p
21027 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
21028 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
21032 if (!row
->reversed_p
)
21034 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
21035 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
21040 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
21041 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
21043 /* Remove any padding glyphs at the front of ROW, to
21044 make room for the truncation glyphs we will be
21045 adding below. The loop below always inserts at
21046 least one truncation glyph, so also remove the
21047 last glyph added to ROW. */
21048 unproduce_glyphs (it
, i
+ 1);
21049 /* Adjust i for the loop below. */
21050 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
21053 /* produce_special_glyphs overwrites the last glyph, so
21054 we don't want that if we want to keep that last
21055 glyph, which means it's an image. */
21056 if (it
->current_x
> it
->last_visible_x
)
21058 it
->current_x
= x_before
;
21059 if (!FRAME_WINDOW_P (it
->f
))
21061 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
21063 row
->used
[TEXT_AREA
] = i
;
21064 produce_special_glyphs (it
, IT_TRUNCATION
);
21069 row
->used
[TEXT_AREA
] = i
;
21070 produce_special_glyphs (it
, IT_TRUNCATION
);
21072 it
->hpos
= hpos_before
;
21075 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
21077 /* Don't truncate if we can overflow newline into fringe. */
21078 if (!get_next_display_element (it
))
21080 it
->continuation_lines_width
= 0;
21081 row
->ends_at_zv_p
= true;
21082 row
->exact_window_width_line_p
= true;
21085 if (ITERATOR_AT_END_OF_LINE_P (it
))
21087 row
->exact_window_width_line_p
= true;
21088 goto at_end_of_line
;
21090 it
->current_x
= x_before
;
21091 it
->hpos
= hpos_before
;
21094 row
->truncated_on_right_p
= true;
21095 it
->continuation_lines_width
= 0;
21096 reseat_at_next_visible_line_start (it
, false);
21097 /* We insist below that IT's position be at ZV because in
21098 bidi-reordered lines the character at visible line start
21099 might not be the character that follows the newline in
21100 the logical order. */
21101 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
21102 row
->ends_at_zv_p
=
21103 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
21105 row
->ends_at_zv_p
= false;
21111 bidi_unshelve_cache (wrap_data
, true);
21113 /* If line is not empty and hscrolled, maybe insert truncation glyphs
21114 at the left window margin. */
21115 if (it
->first_visible_x
21116 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
21118 if (!FRAME_WINDOW_P (it
->f
)
21119 || (((row
->reversed_p
21120 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21121 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
21122 /* Don't let insert_left_trunc_glyphs overwrite the
21123 first glyph of the row if it is an image. */
21124 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
21125 insert_left_trunc_glyphs (it
);
21126 row
->truncated_on_left_p
= true;
21129 /* Remember the position at which this line ends.
21131 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
21132 cannot be before the call to find_row_edges below, since that is
21133 where these positions are determined. */
21134 row
->end
= it
->current
;
21137 row
->minpos
= row
->start
.pos
;
21138 row
->maxpos
= row
->end
.pos
;
21142 /* ROW->minpos and ROW->maxpos must be the smallest and
21143 `1 + the largest' buffer positions in ROW. But if ROW was
21144 bidi-reordered, these two positions can be anywhere in the
21145 row, so we must determine them now. */
21146 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
21149 /* If the start of this line is the overlay arrow-position, then
21150 mark this glyph row as the one containing the overlay arrow.
21151 This is clearly a mess with variable size fonts. It would be
21152 better to let it be displayed like cursors under X. */
21153 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
21154 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
21155 !NILP (overlay_arrow_string
)))
21157 /* Overlay arrow in window redisplay is a fringe bitmap. */
21158 if (STRINGP (overlay_arrow_string
))
21160 struct glyph_row
*arrow_row
21161 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
21162 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
21163 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
21164 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
21165 struct glyph
*p2
, *end
;
21167 /* Copy the arrow glyphs. */
21168 while (glyph
< arrow_end
)
21171 /* Throw away padding glyphs. */
21173 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
21174 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
21180 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
21185 eassert (INTEGERP (overlay_arrow_string
));
21186 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
21188 overlay_arrow_seen
= true;
21191 /* Highlight trailing whitespace. */
21192 if (!NILP (Vshow_trailing_whitespace
))
21193 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
21195 /* Compute pixel dimensions of this line. */
21196 compute_line_metrics (it
);
21198 /* Implementation note: No changes in the glyphs of ROW or in their
21199 faces can be done past this point, because compute_line_metrics
21200 computes ROW's hash value and stores it within the glyph_row
21203 /* Record whether this row ends inside an ellipsis. */
21204 row
->ends_in_ellipsis_p
21205 = (it
->method
== GET_FROM_DISPLAY_VECTOR
21206 && it
->ellipsis_p
);
21208 /* Save fringe bitmaps in this row. */
21209 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
21210 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
21211 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
21212 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
21214 it
->left_user_fringe_bitmap
= 0;
21215 it
->left_user_fringe_face_id
= 0;
21216 it
->right_user_fringe_bitmap
= 0;
21217 it
->right_user_fringe_face_id
= 0;
21219 /* Maybe set the cursor. */
21220 cvpos
= it
->w
->cursor
.vpos
;
21222 /* In bidi-reordered rows, keep checking for proper cursor
21223 position even if one has been found already, because buffer
21224 positions in such rows change non-linearly with ROW->VPOS,
21225 when a line is continued. One exception: when we are at ZV,
21226 display cursor on the first suitable glyph row, since all
21227 the empty rows after that also have their position set to ZV. */
21228 /* FIXME: Revisit this when glyph ``spilling'' in continuation
21229 lines' rows is implemented for bidi-reordered rows. */
21231 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
21232 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
21233 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
21234 && cursor_row_p (row
))
21235 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
21237 /* Prepare for the next line. This line starts horizontally at (X
21238 HPOS) = (0 0). Vertical positions are incremented. As a
21239 convenience for the caller, IT->glyph_row is set to the next
21241 it
->current_x
= it
->hpos
= 0;
21242 it
->current_y
+= row
->height
;
21243 SET_TEXT_POS (it
->eol_pos
, 0, 0);
21246 /* The next row should by default use the same value of the
21247 reversed_p flag as this one. set_iterator_to_next decides when
21248 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
21249 the flag accordingly. */
21250 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
21251 it
->glyph_row
->reversed_p
= row
->reversed_p
;
21252 it
->start
= row
->end
;
21253 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
21255 #undef RECORD_MAX_MIN_POS
21258 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
21259 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
21260 doc
: /* Return paragraph direction at point in BUFFER.
21261 Value is either `left-to-right' or `right-to-left'.
21262 If BUFFER is omitted or nil, it defaults to the current buffer.
21264 Paragraph direction determines how the text in the paragraph is displayed.
21265 In left-to-right paragraphs, text begins at the left margin of the window
21266 and the reading direction is generally left to right. In right-to-left
21267 paragraphs, text begins at the right margin and is read from right to left.
21269 See also `bidi-paragraph-direction'. */)
21270 (Lisp_Object buffer
)
21272 struct buffer
*buf
= current_buffer
;
21273 struct buffer
*old
= buf
;
21275 if (! NILP (buffer
))
21277 CHECK_BUFFER (buffer
);
21278 buf
= XBUFFER (buffer
);
21281 if (NILP (BVAR (buf
, bidi_display_reordering
))
21282 || NILP (BVAR (buf
, enable_multibyte_characters
))
21283 /* When we are loading loadup.el, the character property tables
21284 needed for bidi iteration are not yet available. */
21285 || redisplay__inhibit_bidi
)
21286 return Qleft_to_right
;
21287 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
21288 return BVAR (buf
, bidi_paragraph_direction
);
21291 /* Determine the direction from buffer text. We could try to
21292 use current_matrix if it is up to date, but this seems fast
21293 enough as it is. */
21294 struct bidi_it itb
;
21295 ptrdiff_t pos
= BUF_PT (buf
);
21296 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
21298 void *itb_data
= bidi_shelve_cache ();
21300 set_buffer_temp (buf
);
21301 /* bidi_paragraph_init finds the base direction of the paragraph
21302 by searching forward from paragraph start. We need the base
21303 direction of the current or _previous_ paragraph, so we need
21304 to make sure we are within that paragraph. To that end, find
21305 the previous non-empty line. */
21306 if (pos
>= ZV
&& pos
> BEGV
)
21307 DEC_BOTH (pos
, bytepos
);
21308 AUTO_STRING (trailing_white_space
, "[\f\t ]*\n");
21309 if (fast_looking_at (trailing_white_space
,
21310 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
21312 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
21313 || c
== ' ' || c
== '\t' || c
== '\f')
21315 if (bytepos
<= BEGV_BYTE
)
21320 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
21323 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
21324 itb
.paragraph_dir
= NEUTRAL_DIR
;
21325 itb
.string
.s
= NULL
;
21326 itb
.string
.lstring
= Qnil
;
21327 itb
.string
.bufpos
= 0;
21328 itb
.string
.from_disp_str
= false;
21329 itb
.string
.unibyte
= false;
21330 /* We have no window to use here for ignoring window-specific
21331 overlays. Using NULL for window pointer will cause
21332 compute_display_string_pos to use the current buffer. */
21334 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, true);
21335 bidi_unshelve_cache (itb_data
, false);
21336 set_buffer_temp (old
);
21337 switch (itb
.paragraph_dir
)
21340 return Qleft_to_right
;
21343 return Qright_to_left
;
21351 DEFUN ("bidi-find-overridden-directionality",
21352 Fbidi_find_overridden_directionality
,
21353 Sbidi_find_overridden_directionality
, 2, 3, 0,
21354 doc
: /* Return position between FROM and TO where directionality was overridden.
21356 This function returns the first character position in the specified
21357 region of OBJECT where there is a character whose `bidi-class' property
21358 is `L', but which was forced to display as `R' by a directional
21359 override, and likewise with characters whose `bidi-class' is `R'
21360 or `AL' that were forced to display as `L'.
21362 If no such character is found, the function returns nil.
21364 OBJECT is a Lisp string or buffer to search for overridden
21365 directionality, and defaults to the current buffer if nil or omitted.
21366 OBJECT can also be a window, in which case the function will search
21367 the buffer displayed in that window. Passing the window instead of
21368 a buffer is preferable when the buffer is displayed in some window,
21369 because this function will then be able to correctly account for
21370 window-specific overlays, which can affect the results.
21372 Strong directional characters `L', `R', and `AL' can have their
21373 intrinsic directionality overridden by directional override
21374 control characters RLO (u+202e) and LRO (u+202d). See the
21375 function `get-char-code-property' for a way to inquire about
21376 the `bidi-class' property of a character. */)
21377 (Lisp_Object from
, Lisp_Object to
, Lisp_Object object
)
21379 struct buffer
*buf
= current_buffer
;
21380 struct buffer
*old
= buf
;
21381 struct window
*w
= NULL
;
21382 bool frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ());
21383 struct bidi_it itb
;
21384 ptrdiff_t from_pos
, to_pos
, from_bpos
;
21387 if (!NILP (object
))
21389 if (BUFFERP (object
))
21390 buf
= XBUFFER (object
);
21391 else if (WINDOWP (object
))
21393 w
= decode_live_window (object
);
21394 buf
= XBUFFER (w
->contents
);
21395 frame_window_p
= FRAME_WINDOW_P (XFRAME (w
->frame
));
21398 CHECK_STRING (object
);
21401 if (STRINGP (object
))
21403 /* Characters in unibyte strings are always treated by bidi.c as
21405 if (!STRING_MULTIBYTE (object
)
21406 /* When we are loading loadup.el, the character property
21407 tables needed for bidi iteration are not yet
21409 || redisplay__inhibit_bidi
)
21412 validate_subarray (object
, from
, to
, SCHARS (object
), &from_pos
, &to_pos
);
21413 if (from_pos
>= SCHARS (object
))
21416 /* Set up the bidi iterator. */
21417 itb_data
= bidi_shelve_cache ();
21418 itb
.paragraph_dir
= NEUTRAL_DIR
;
21419 itb
.string
.lstring
= object
;
21420 itb
.string
.s
= NULL
;
21421 itb
.string
.schars
= SCHARS (object
);
21422 itb
.string
.bufpos
= 0;
21423 itb
.string
.from_disp_str
= false;
21424 itb
.string
.unibyte
= false;
21426 bidi_init_it (0, 0, frame_window_p
, &itb
);
21430 /* Nothing this fancy can happen in unibyte buffers, or in a
21431 buffer that disabled reordering, or if FROM is at EOB. */
21432 if (NILP (BVAR (buf
, bidi_display_reordering
))
21433 || NILP (BVAR (buf
, enable_multibyte_characters
))
21434 /* When we are loading loadup.el, the character property
21435 tables needed for bidi iteration are not yet
21437 || redisplay__inhibit_bidi
)
21440 set_buffer_temp (buf
);
21441 validate_region (&from
, &to
);
21442 from_pos
= XINT (from
);
21443 to_pos
= XINT (to
);
21444 if (from_pos
>= ZV
)
21447 /* Set up the bidi iterator. */
21448 itb_data
= bidi_shelve_cache ();
21449 from_bpos
= CHAR_TO_BYTE (from_pos
);
21450 if (from_pos
== BEGV
)
21452 itb
.charpos
= BEGV
;
21453 itb
.bytepos
= BEGV_BYTE
;
21455 else if (FETCH_CHAR (from_bpos
- 1) == '\n')
21457 itb
.charpos
= from_pos
;
21458 itb
.bytepos
= from_bpos
;
21461 itb
.charpos
= find_newline_no_quit (from_pos
, CHAR_TO_BYTE (from_pos
),
21463 itb
.paragraph_dir
= NEUTRAL_DIR
;
21464 itb
.string
.s
= NULL
;
21465 itb
.string
.lstring
= Qnil
;
21466 itb
.string
.bufpos
= 0;
21467 itb
.string
.from_disp_str
= false;
21468 itb
.string
.unibyte
= false;
21470 bidi_init_it (itb
.charpos
, itb
.bytepos
, frame_window_p
, &itb
);
21475 /* For the purposes of this function, the actual base direction of
21476 the paragraph doesn't matter, so just set it to L2R. */
21477 bidi_paragraph_init (L2R
, &itb
, false);
21478 while ((found
= bidi_find_first_overridden (&itb
)) < from_pos
)
21480 } while (found
== ZV
&& itb
.ch
== '\n' && itb
.charpos
< to_pos
);
21482 bidi_unshelve_cache (itb_data
, false);
21483 set_buffer_temp (old
);
21485 return (from_pos
<= found
&& found
< to_pos
) ? make_number (found
) : Qnil
;
21488 DEFUN ("move-point-visually", Fmove_point_visually
,
21489 Smove_point_visually
, 1, 1, 0,
21490 doc
: /* Move point in the visual order in the specified DIRECTION.
21491 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
21494 Value is the new character position of point. */)
21495 (Lisp_Object direction
)
21497 struct window
*w
= XWINDOW (selected_window
);
21498 struct buffer
*b
= XBUFFER (w
->contents
);
21499 struct glyph_row
*row
;
21501 Lisp_Object paragraph_dir
;
21503 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21504 (!(ROW)->continued_p \
21505 && NILP ((GLYPH)->object) \
21506 && (GLYPH)->type == CHAR_GLYPH \
21507 && (GLYPH)->u.ch == ' ' \
21508 && (GLYPH)->charpos >= 0 \
21509 && !(GLYPH)->avoid_cursor_p)
21511 CHECK_NUMBER (direction
);
21512 dir
= XINT (direction
);
21518 /* If current matrix is up-to-date, we can use the information
21519 recorded in the glyphs, at least as long as the goal is on the
21521 if (w
->window_end_valid
21522 && !windows_or_buffers_changed
21524 && !b
->clip_changed
21525 && !b
->prevent_redisplay_optimizations_p
21526 && !window_outdated (w
)
21527 /* We rely below on the cursor coordinates to be up to date, but
21528 we cannot trust them if some command moved point since the
21529 last complete redisplay. */
21530 && w
->last_point
== BUF_PT (b
)
21531 && w
->cursor
.vpos
>= 0
21532 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21533 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21535 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21536 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21537 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21539 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21541 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21543 SET_PT (g
->charpos
);
21544 w
->cursor
.vpos
= -1;
21545 return make_number (PT
);
21547 else if (!NILP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21551 if (BUFFERP (gpt
->object
))
21554 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21555 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21557 new_pos
-= (row
->reversed_p
? -dir
: dir
);
21559 else if (BUFFERP (g
->object
))
21560 new_pos
= g
->charpos
;
21564 w
->cursor
.vpos
= -1;
21565 return make_number (PT
);
21567 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21569 /* Glyphs inserted at the end of a non-empty line for
21570 positioning the cursor have zero charpos, so we must
21571 deduce the value of point by other means. */
21572 if (g
->charpos
> 0)
21573 SET_PT (g
->charpos
);
21574 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21576 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21577 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21580 w
->cursor
.vpos
= -1;
21581 return make_number (PT
);
21584 if (g
== e
|| NILP (g
->object
))
21586 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21587 goto simulate_display
;
21588 if (!row
->reversed_p
)
21592 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21593 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21594 goto simulate_display
;
21598 if (row
->reversed_p
&& !row
->continued_p
)
21600 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21601 w
->cursor
.vpos
= -1;
21602 return make_number (PT
);
21604 g
= row
->glyphs
[TEXT_AREA
];
21605 e
= g
+ row
->used
[TEXT_AREA
];
21606 for ( ; g
< e
; g
++)
21608 if (BUFFERP (g
->object
)
21609 /* Empty lines have only one glyph, which stands
21610 for the newline, and whose charpos is the
21611 buffer position of the newline. */
21612 || ROW_GLYPH_NEWLINE_P (row
, g
)
21613 /* When the buffer ends in a newline, the line at
21614 EOB also has one glyph, but its charpos is -1. */
21615 || (row
->ends_at_zv_p
21616 && !row
->reversed_p
21617 && NILP (g
->object
)
21618 && g
->type
== CHAR_GLYPH
21619 && g
->u
.ch
== ' '))
21621 if (g
->charpos
> 0)
21622 SET_PT (g
->charpos
);
21623 else if (!row
->reversed_p
21624 && row
->ends_at_zv_p
21629 w
->cursor
.vpos
= -1;
21630 return make_number (PT
);
21636 if (!row
->reversed_p
&& !row
->continued_p
)
21638 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21639 w
->cursor
.vpos
= -1;
21640 return make_number (PT
);
21642 e
= row
->glyphs
[TEXT_AREA
];
21643 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21644 for ( ; g
>= e
; g
--)
21646 if (BUFFERP (g
->object
)
21647 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21649 /* Empty R2L lines on GUI frames have the buffer
21650 position of the newline stored in the stretch
21652 || g
->type
== STRETCH_GLYPH
21653 || (row
->ends_at_zv_p
21655 && NILP (g
->object
)
21656 && g
->type
== CHAR_GLYPH
21657 && g
->u
.ch
== ' '))
21659 if (g
->charpos
> 0)
21660 SET_PT (g
->charpos
);
21661 else if (row
->reversed_p
21662 && row
->ends_at_zv_p
21667 w
->cursor
.vpos
= -1;
21668 return make_number (PT
);
21677 /* If we wind up here, we failed to move by using the glyphs, so we
21678 need to simulate display instead. */
21681 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21683 paragraph_dir
= Qleft_to_right
;
21684 if (EQ (paragraph_dir
, Qright_to_left
))
21686 if (PT
<= BEGV
&& dir
< 0)
21687 xsignal0 (Qbeginning_of_buffer
);
21688 else if (PT
>= ZV
&& dir
> 0)
21689 xsignal0 (Qend_of_buffer
);
21692 struct text_pos pt
;
21694 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21696 bool overshoot_expected
= false;
21697 bool target_is_eol_p
= false;
21699 /* Setup the arena. */
21700 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21701 start_display (&it
, w
, pt
);
21702 /* When lines are truncated, we could be called with point
21703 outside of the windows edges, in which case move_it_*
21704 functions either prematurely stop at window's edge or jump to
21705 the next screen line, whereas we rely below on our ability to
21706 reach point, in order to start from its X coordinate. So we
21707 need to disregard the window's horizontal extent in that case. */
21708 if (it
.line_wrap
== TRUNCATE
)
21709 it
.last_visible_x
= INFINITY
;
21711 if (it
.cmp_it
.id
< 0
21712 && it
.method
== GET_FROM_STRING
21713 && it
.area
== TEXT_AREA
21714 && it
.string_from_display_prop_p
21715 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21716 overshoot_expected
= true;
21718 /* Find the X coordinate of point. We start from the beginning
21719 of this or previous line to make sure we are before point in
21720 the logical order (since the move_it_* functions can only
21723 reseat_at_previous_visible_line_start (&it
);
21724 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21725 if (IT_CHARPOS (it
) != PT
)
21727 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21728 -1, -1, -1, MOVE_TO_POS
);
21729 /* If we missed point because the character there is
21730 displayed out of a display vector that has more than one
21731 glyph, retry expecting overshoot. */
21732 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21733 && it
.current
.dpvec_index
> 0
21734 && !overshoot_expected
)
21736 overshoot_expected
= true;
21739 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21740 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21742 pt_x
= it
.current_x
;
21744 if (dir
> 0 || overshoot_expected
)
21746 struct glyph_row
*row
= it
.glyph_row
;
21748 /* When point is at beginning of line, we don't have
21749 information about the glyph there loaded into struct
21750 it. Calling get_next_display_element fixes that. */
21752 get_next_display_element (&it
);
21753 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21754 it
.glyph_row
= NULL
;
21755 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21756 it
.glyph_row
= row
;
21757 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21758 it, lest it will become out of sync with it's buffer
21760 it
.current_x
= pt_x
;
21763 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21764 pixel_width
= it
.pixel_width
;
21765 if (overshoot_expected
&& at_eol_p
)
21767 else if (pixel_width
<= 0)
21770 /* If there's a display string (or something similar) at point,
21771 we are actually at the glyph to the left of point, so we need
21772 to correct the X coordinate. */
21773 if (overshoot_expected
)
21776 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21778 pt_x
+= pixel_width
;
21781 /* Compute target X coordinate, either to the left or to the
21782 right of point. On TTY frames, all characters have the same
21783 pixel width of 1, so we can use that. On GUI frames we don't
21784 have an easy way of getting at the pixel width of the
21785 character to the left of point, so we use a different method
21786 of getting to that place. */
21788 target_x
= pt_x
+ pixel_width
;
21790 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21792 /* Target X coordinate could be one line above or below the line
21793 of point, in which case we need to adjust the target X
21794 coordinate. Also, if moving to the left, we need to begin at
21795 the left edge of the point's screen line. */
21800 start_display (&it
, w
, pt
);
21801 if (it
.line_wrap
== TRUNCATE
)
21802 it
.last_visible_x
= INFINITY
;
21803 reseat_at_previous_visible_line_start (&it
);
21804 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21806 move_it_by_lines (&it
, pt_vpos
);
21810 move_it_by_lines (&it
, -1);
21811 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21812 target_is_eol_p
= true;
21813 /* Under word-wrap, we don't know the x coordinate of
21814 the last character displayed on the previous line,
21815 which immediately precedes the wrap point. To find
21816 out its x coordinate, we try moving to the right
21817 margin of the window, which will stop at the wrap
21818 point, and then reset target_x to point at the
21819 character that precedes the wrap point. This is not
21820 needed on GUI frames, because (see below) there we
21821 move from the left margin one grapheme cluster at a
21822 time, and stop when we hit the wrap point. */
21823 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21825 void *it_data
= NULL
;
21828 SAVE_IT (it2
, it
, it_data
);
21829 move_it_in_display_line_to (&it
, ZV
, target_x
,
21830 MOVE_TO_POS
| MOVE_TO_X
);
21831 /* If we arrived at target_x, that _is_ the last
21832 character on the previous line. */
21833 if (it
.current_x
!= target_x
)
21834 target_x
= it
.current_x
- 1;
21835 RESTORE_IT (&it
, &it2
, it_data
);
21842 || (target_x
>= it
.last_visible_x
21843 && it
.line_wrap
!= TRUNCATE
))
21846 move_it_by_lines (&it
, 0);
21847 move_it_by_lines (&it
, 1);
21852 /* Move to the target X coordinate. */
21853 /* On GUI frames, as we don't know the X coordinate of the
21854 character to the left of point, moving point to the left
21855 requires walking, one grapheme cluster at a time, until we
21856 find ourself at a place immediately to the left of the
21857 character at point. */
21858 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21860 struct text_pos new_pos
;
21861 enum move_it_result rc
= MOVE_X_REACHED
;
21863 if (it
.current_x
== 0)
21864 get_next_display_element (&it
);
21865 if (it
.what
== IT_COMPOSITION
)
21867 new_pos
.charpos
= it
.cmp_it
.charpos
;
21868 new_pos
.bytepos
= -1;
21871 new_pos
= it
.current
.pos
;
21873 while (it
.current_x
+ it
.pixel_width
<= target_x
21874 && (rc
== MOVE_X_REACHED
21875 /* Under word-wrap, move_it_in_display_line_to
21876 stops at correct coordinates, but sometimes
21877 returns MOVE_POS_MATCH_OR_ZV. */
21878 || (it
.line_wrap
== WORD_WRAP
21879 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21881 int new_x
= it
.current_x
+ it
.pixel_width
;
21883 /* For composed characters, we want the position of the
21884 first character in the grapheme cluster (usually, the
21885 composition's base character), whereas it.current
21886 might give us the position of the _last_ one, e.g. if
21887 the composition is rendered in reverse due to bidi
21889 if (it
.what
== IT_COMPOSITION
)
21891 new_pos
.charpos
= it
.cmp_it
.charpos
;
21892 new_pos
.bytepos
= -1;
21895 new_pos
= it
.current
.pos
;
21896 if (new_x
== it
.current_x
)
21898 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21899 MOVE_TO_POS
| MOVE_TO_X
);
21900 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21903 /* The previous position we saw in the loop is the one we
21905 if (new_pos
.bytepos
== -1)
21906 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21907 it
.current
.pos
= new_pos
;
21909 else if (it
.current_x
!= target_x
)
21910 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21912 /* If we ended up in a display string that covers point, move to
21913 buffer position to the right in the visual order. */
21916 while (IT_CHARPOS (it
) == PT
)
21918 set_iterator_to_next (&it
, false);
21919 if (!get_next_display_element (&it
))
21924 /* Move point to that position. */
21925 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21928 return make_number (PT
);
21930 #undef ROW_GLYPH_NEWLINE_P
21933 DEFUN ("bidi-resolved-levels", Fbidi_resolved_levels
,
21934 Sbidi_resolved_levels
, 0, 1, 0,
21935 doc
: /* Return the resolved bidirectional levels of characters at VPOS.
21937 The resolved levels are produced by the Emacs bidi reordering engine
21938 that implements the UBA, the Unicode Bidirectional Algorithm. Please
21939 read the Unicode Standard Annex 9 (UAX#9) for background information
21940 about these levels.
21942 VPOS is the zero-based number of the current window's screen line
21943 for which to produce the resolved levels. If VPOS is nil or omitted,
21944 it defaults to the screen line of point. If the window displays a
21945 header line, VPOS of zero will report on the header line, and first
21946 line of text in the window will have VPOS of 1.
21948 Value is an array of resolved levels, indexed by glyph number.
21949 Glyphs are numbered from zero starting from the beginning of the
21950 screen line, i.e. the left edge of the window for left-to-right lines
21951 and from the right edge for right-to-left lines. The resolved levels
21952 are produced only for the window's text area; text in display margins
21955 If the selected window's display is not up-to-date, or if the specified
21956 screen line does not display text, this function returns nil. It is
21957 highly recommended to bind this function to some simple key, like F8,
21958 in order to avoid these problems.
21960 This function exists mainly for testing the correctness of the
21961 Emacs UBA implementation, in particular with the test suite. */)
21964 struct window
*w
= XWINDOW (selected_window
);
21965 struct buffer
*b
= XBUFFER (w
->contents
);
21967 struct glyph_row
*row
;
21971 int d1
, d2
, d3
, d4
, d5
;
21973 pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &nrow
);
21977 CHECK_NUMBER_COERCE_MARKER (vpos
);
21978 nrow
= XINT (vpos
);
21981 /* We require up-to-date glyph matrix for this window. */
21982 if (w
->window_end_valid
21983 && !windows_or_buffers_changed
21985 && !b
->clip_changed
21986 && !b
->prevent_redisplay_optimizations_p
21987 && !window_outdated (w
)
21989 && nrow
< w
->current_matrix
->nrows
21990 && (row
= MATRIX_ROW (w
->current_matrix
, nrow
))->enabled_p
21991 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
21993 struct glyph
*g
, *e
, *g1
;
21995 Lisp_Object levels
;
21997 if (!row
->reversed_p
) /* Left-to-right glyph row. */
21999 g
= g1
= row
->glyphs
[TEXT_AREA
];
22000 e
= g
+ row
->used
[TEXT_AREA
];
22002 /* Skip over glyphs at the start of the row that was
22003 generated by redisplay for its own needs. */
22005 && NILP (g
->object
)
22010 /* Count the "interesting" glyphs in this row. */
22011 for (nglyphs
= 0; g
< e
&& !NILP (g
->object
); g
++)
22014 /* Create and fill the array. */
22015 levels
= make_uninit_vector (nglyphs
);
22016 for (i
= 0; g1
< g
; i
++, g1
++)
22017 ASET (levels
, i
, make_number (g1
->resolved_level
));
22019 else /* Right-to-left glyph row. */
22021 g
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
22022 e
= row
->glyphs
[TEXT_AREA
] - 1;
22024 && NILP (g
->object
)
22028 for (nglyphs
= 0; g
> e
&& !NILP (g
->object
); g
--)
22030 levels
= make_uninit_vector (nglyphs
);
22031 for (i
= 0; g1
> g
; i
++, g1
--)
22032 ASET (levels
, i
, make_number (g1
->resolved_level
));
22042 /***********************************************************************
22044 ***********************************************************************/
22046 /* Redisplay the menu bar in the frame for window W.
22048 The menu bar of X frames that don't have X toolkit support is
22049 displayed in a special window W->frame->menu_bar_window.
22051 The menu bar of terminal frames is treated specially as far as
22052 glyph matrices are concerned. Menu bar lines are not part of
22053 windows, so the update is done directly on the frame matrix rows
22054 for the menu bar. */
22057 display_menu_bar (struct window
*w
)
22059 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22064 /* Don't do all this for graphical frames. */
22066 if (FRAME_W32_P (f
))
22069 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
22075 if (FRAME_NS_P (f
))
22077 #endif /* HAVE_NS */
22079 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
22080 eassert (!FRAME_WINDOW_P (f
));
22081 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
22082 it
.first_visible_x
= 0;
22083 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
22084 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
22085 if (FRAME_WINDOW_P (f
))
22087 /* Menu bar lines are displayed in the desired matrix of the
22088 dummy window menu_bar_window. */
22089 struct window
*menu_w
;
22090 menu_w
= XWINDOW (f
->menu_bar_window
);
22091 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
22093 it
.first_visible_x
= 0;
22094 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
22097 #endif /* not USE_X_TOOLKIT and not USE_GTK */
22099 /* This is a TTY frame, i.e. character hpos/vpos are used as
22101 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
22103 it
.first_visible_x
= 0;
22104 it
.last_visible_x
= FRAME_COLS (f
);
22107 /* FIXME: This should be controlled by a user option. See the
22108 comments in redisplay_tool_bar and display_mode_line about
22110 it
.paragraph_embedding
= L2R
;
22112 /* Clear all rows of the menu bar. */
22113 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
22115 struct glyph_row
*row
= it
.glyph_row
+ i
;
22116 clear_glyph_row (row
);
22117 row
->enabled_p
= true;
22118 row
->full_width_p
= true;
22119 row
->reversed_p
= false;
22122 /* Display all items of the menu bar. */
22123 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
22124 for (i
= 0; i
< ASIZE (items
); i
+= 4)
22126 Lisp_Object string
;
22128 /* Stop at nil string. */
22129 string
= AREF (items
, i
+ 1);
22133 /* Remember where item was displayed. */
22134 ASET (items
, i
+ 3, make_number (it
.hpos
));
22136 /* Display the item, pad with one space. */
22137 if (it
.current_x
< it
.last_visible_x
)
22138 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
22139 SCHARS (string
) + 1, 0, 0, -1);
22142 /* Fill out the line with spaces. */
22143 if (it
.current_x
< it
.last_visible_x
)
22144 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
22146 /* Compute the total height of the lines. */
22147 compute_line_metrics (&it
);
22150 /* Deep copy of a glyph row, including the glyphs. */
22152 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
22154 struct glyph
*pointers
[1 + LAST_AREA
];
22155 int to_used
= to
->used
[TEXT_AREA
];
22157 /* Save glyph pointers of TO. */
22158 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
22160 /* Do a structure assignment. */
22163 /* Restore original glyph pointers of TO. */
22164 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
22166 /* Copy the glyphs. */
22167 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
22168 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
22170 /* If we filled only part of the TO row, fill the rest with
22171 space_glyph (which will display as empty space). */
22172 if (to_used
> from
->used
[TEXT_AREA
])
22173 fill_up_frame_row_with_spaces (to
, to_used
);
22176 /* Display one menu item on a TTY, by overwriting the glyphs in the
22177 frame F's desired glyph matrix with glyphs produced from the menu
22178 item text. Called from term.c to display TTY drop-down menus one
22181 ITEM_TEXT is the menu item text as a C string.
22183 FACE_ID is the face ID to be used for this menu item. FACE_ID
22184 could specify one of 3 faces: a face for an enabled item, a face
22185 for a disabled item, or a face for a selected item.
22187 X and Y are coordinates of the first glyph in the frame's desired
22188 matrix to be overwritten by the menu item. Since this is a TTY, Y
22189 is the zero-based number of the glyph row and X is the zero-based
22190 glyph number in the row, starting from left, where to start
22191 displaying the item.
22193 SUBMENU means this menu item drops down a submenu, which
22194 should be indicated by displaying a proper visual cue after the
22198 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
22199 int x
, int y
, bool submenu
)
22202 struct frame
*f
= SELECTED_FRAME ();
22203 struct window
*w
= XWINDOW (f
->selected_window
);
22204 struct glyph_row
*row
;
22205 size_t item_len
= strlen (item_text
);
22207 eassert (FRAME_TERMCAP_P (f
));
22209 /* Don't write beyond the matrix's last row. This can happen for
22210 TTY screens that are not high enough to show the entire menu.
22211 (This is actually a bit of defensive programming, as
22212 tty_menu_display already limits the number of menu items to one
22213 less than the number of screen lines.) */
22214 if (y
>= f
->desired_matrix
->nrows
)
22217 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
22218 it
.first_visible_x
= 0;
22219 it
.last_visible_x
= FRAME_COLS (f
) - 1;
22220 row
= it
.glyph_row
;
22221 /* Start with the row contents from the current matrix. */
22222 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
22223 bool saved_width
= row
->full_width_p
;
22224 row
->full_width_p
= true;
22225 bool saved_reversed
= row
->reversed_p
;
22226 row
->reversed_p
= false;
22227 row
->enabled_p
= true;
22229 /* Arrange for the menu item glyphs to start at (X,Y) and have the
22231 eassert (x
< f
->desired_matrix
->matrix_w
);
22232 it
.current_x
= it
.hpos
= x
;
22233 it
.current_y
= it
.vpos
= y
;
22234 int saved_used
= row
->used
[TEXT_AREA
];
22235 bool saved_truncated
= row
->truncated_on_right_p
;
22236 row
->used
[TEXT_AREA
] = x
;
22237 it
.face_id
= face_id
;
22238 it
.line_wrap
= TRUNCATE
;
22240 /* FIXME: This should be controlled by a user option. See the
22241 comments in redisplay_tool_bar and display_mode_line about this.
22242 Also, if paragraph_embedding could ever be R2L, changes will be
22243 needed to avoid shifting to the right the row characters in
22244 term.c:append_glyph. */
22245 it
.paragraph_embedding
= L2R
;
22247 /* Pad with a space on the left. */
22248 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
22250 /* Display the menu item, pad with spaces to WIDTH. */
22253 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
22254 item_len
, 0, FRAME_COLS (f
) - 1, -1);
22256 /* Indicate with " >" that there's a submenu. */
22257 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
22258 FRAME_COLS (f
) - 1, -1);
22261 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
22262 width
, 0, FRAME_COLS (f
) - 1, -1);
22264 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
22265 row
->truncated_on_right_p
= saved_truncated
;
22266 row
->hash
= row_hash (row
);
22267 row
->full_width_p
= saved_width
;
22268 row
->reversed_p
= saved_reversed
;
22271 /***********************************************************************
22273 ***********************************************************************/
22275 /* Redisplay mode lines in the window tree whose root is WINDOW.
22276 If FORCE, redisplay mode lines unconditionally.
22277 Otherwise, redisplay only mode lines that are garbaged. Value is
22278 the number of windows whose mode lines were redisplayed. */
22281 redisplay_mode_lines (Lisp_Object window
, bool force
)
22285 while (!NILP (window
))
22287 struct window
*w
= XWINDOW (window
);
22289 if (WINDOWP (w
->contents
))
22290 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
22292 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
22293 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
22295 struct text_pos lpoint
;
22296 struct buffer
*old
= current_buffer
;
22298 /* Set the window's buffer for the mode line display. */
22299 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
22300 set_buffer_internal_1 (XBUFFER (w
->contents
));
22302 /* Point refers normally to the selected window. For any
22303 other window, set up appropriate value. */
22304 if (!EQ (window
, selected_window
))
22306 struct text_pos pt
;
22308 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
22309 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
22312 /* Display mode lines. */
22313 clear_glyph_matrix (w
->desired_matrix
);
22314 if (display_mode_lines (w
))
22317 /* Restore old settings. */
22318 set_buffer_internal_1 (old
);
22319 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
22329 /* Display the mode and/or header line of window W. Value is the
22330 sum number of mode lines and header lines displayed. */
22333 display_mode_lines (struct window
*w
)
22335 Lisp_Object old_selected_window
= selected_window
;
22336 Lisp_Object old_selected_frame
= selected_frame
;
22337 Lisp_Object new_frame
= w
->frame
;
22338 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
22341 selected_frame
= new_frame
;
22342 /* FIXME: If we were to allow the mode-line's computation changing the buffer
22343 or window's point, then we'd need select_window_1 here as well. */
22344 XSETWINDOW (selected_window
, w
);
22345 XFRAME (new_frame
)->selected_window
= selected_window
;
22347 /* These will be set while the mode line specs are processed. */
22348 line_number_displayed
= false;
22349 w
->column_number_displayed
= -1;
22351 if (WINDOW_WANTS_MODELINE_P (w
))
22353 struct window
*sel_w
= XWINDOW (old_selected_window
);
22355 /* Select mode line face based on the real selected window. */
22356 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
22357 BVAR (current_buffer
, mode_line_format
));
22361 if (WINDOW_WANTS_HEADER_LINE_P (w
))
22363 display_mode_line (w
, HEADER_LINE_FACE_ID
,
22364 BVAR (current_buffer
, header_line_format
));
22368 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
22369 selected_frame
= old_selected_frame
;
22370 selected_window
= old_selected_window
;
22372 w
->must_be_updated_p
= true;
22377 /* Display mode or header line of window W. FACE_ID specifies which
22378 line to display; it is either MODE_LINE_FACE_ID or
22379 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
22380 display. Value is the pixel height of the mode/header line
22384 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
22388 ptrdiff_t count
= SPECPDL_INDEX ();
22390 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22391 /* Don't extend on a previously drawn mode-line.
22392 This may happen if called from pos_visible_p. */
22393 it
.glyph_row
->enabled_p
= false;
22394 prepare_desired_row (w
, it
.glyph_row
, true);
22396 it
.glyph_row
->mode_line_p
= true;
22398 /* FIXME: This should be controlled by a user option. But
22399 supporting such an option is not trivial, since the mode line is
22400 made up of many separate strings. */
22401 it
.paragraph_embedding
= L2R
;
22403 record_unwind_protect (unwind_format_mode_line
,
22404 format_mode_line_unwind_data (NULL
, NULL
,
22407 mode_line_target
= MODE_LINE_DISPLAY
;
22409 /* Temporarily make frame's keyboard the current kboard so that
22410 kboard-local variables in the mode_line_format will get the right
22412 push_kboard (FRAME_KBOARD (it
.f
));
22413 record_unwind_save_match_data ();
22414 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22417 unbind_to (count
, Qnil
);
22419 /* Fill up with spaces. */
22420 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
22422 compute_line_metrics (&it
);
22423 it
.glyph_row
->full_width_p
= true;
22424 it
.glyph_row
->continued_p
= false;
22425 it
.glyph_row
->truncated_on_left_p
= false;
22426 it
.glyph_row
->truncated_on_right_p
= false;
22428 /* Make a 3D mode-line have a shadow at its right end. */
22429 face
= FACE_FROM_ID (it
.f
, face_id
);
22430 extend_face_to_end_of_line (&it
);
22431 if (face
->box
!= FACE_NO_BOX
)
22433 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
22434 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
22435 last
->right_box_line_p
= true;
22438 return it
.glyph_row
->height
;
22441 /* Move element ELT in LIST to the front of LIST.
22442 Return the updated list. */
22445 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
22447 register Lisp_Object tail
, prev
;
22448 register Lisp_Object tem
;
22452 while (CONSP (tail
))
22458 /* Splice out the link TAIL. */
22460 list
= XCDR (tail
);
22462 Fsetcdr (prev
, XCDR (tail
));
22464 /* Now make it the first. */
22465 Fsetcdr (tail
, list
);
22470 tail
= XCDR (tail
);
22474 /* Not found--return unchanged LIST. */
22478 /* Contribute ELT to the mode line for window IT->w. How it
22479 translates into text depends on its data type.
22481 IT describes the display environment in which we display, as usual.
22483 DEPTH is the depth in recursion. It is used to prevent
22484 infinite recursion here.
22486 FIELD_WIDTH is the number of characters the display of ELT should
22487 occupy in the mode line, and PRECISION is the maximum number of
22488 characters to display from ELT's representation. See
22489 display_string for details.
22491 Returns the hpos of the end of the text generated by ELT.
22493 PROPS is a property list to add to any string we encounter.
22495 If RISKY, remove (disregard) any properties in any string
22496 we encounter, and ignore :eval and :propertize.
22498 The global variable `mode_line_target' determines whether the
22499 output is passed to `store_mode_line_noprop',
22500 `store_mode_line_string', or `display_string'. */
22503 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
22504 Lisp_Object elt
, Lisp_Object props
, bool risky
)
22506 int n
= 0, field
, prec
;
22507 bool literal
= false;
22511 elt
= build_string ("*too-deep*");
22515 switch (XTYPE (elt
))
22519 /* A string: output it and check for %-constructs within it. */
22521 ptrdiff_t offset
= 0;
22523 if (SCHARS (elt
) > 0
22524 && (!NILP (props
) || risky
))
22526 Lisp_Object oprops
, aelt
;
22527 oprops
= Ftext_properties_at (make_number (0), elt
);
22529 /* If the starting string's properties are not what
22530 we want, translate the string. Also, if the string
22531 is risky, do that anyway. */
22533 if (NILP (Fequal (props
, oprops
)) || risky
)
22535 /* If the starting string has properties,
22536 merge the specified ones onto the existing ones. */
22537 if (! NILP (oprops
) && !risky
)
22541 oprops
= Fcopy_sequence (oprops
);
22543 while (CONSP (tem
))
22545 oprops
= Fplist_put (oprops
, XCAR (tem
),
22546 XCAR (XCDR (tem
)));
22547 tem
= XCDR (XCDR (tem
));
22552 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
22553 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
22555 /* AELT is what we want. Move it to the front
22556 without consing. */
22558 mode_line_proptrans_alist
22559 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
22565 /* If AELT has the wrong props, it is useless.
22566 so get rid of it. */
22568 mode_line_proptrans_alist
22569 = Fdelq (aelt
, mode_line_proptrans_alist
);
22571 elt
= Fcopy_sequence (elt
);
22572 Fset_text_properties (make_number (0), Flength (elt
),
22574 /* Add this item to mode_line_proptrans_alist. */
22575 mode_line_proptrans_alist
22576 = Fcons (Fcons (elt
, props
),
22577 mode_line_proptrans_alist
);
22578 /* Truncate mode_line_proptrans_alist
22579 to at most 50 elements. */
22580 tem
= Fnthcdr (make_number (50),
22581 mode_line_proptrans_alist
);
22583 XSETCDR (tem
, Qnil
);
22592 prec
= precision
- n
;
22593 switch (mode_line_target
)
22595 case MODE_LINE_NOPROP
:
22596 case MODE_LINE_TITLE
:
22597 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
22599 case MODE_LINE_STRING
:
22600 n
+= store_mode_line_string (NULL
, elt
, true, 0, prec
, Qnil
);
22602 case MODE_LINE_DISPLAY
:
22603 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
22604 0, prec
, 0, STRING_MULTIBYTE (elt
));
22611 /* Handle the non-literal case. */
22613 while ((precision
<= 0 || n
< precision
)
22614 && SREF (elt
, offset
) != 0
22615 && (mode_line_target
!= MODE_LINE_DISPLAY
22616 || it
->current_x
< it
->last_visible_x
))
22618 ptrdiff_t last_offset
= offset
;
22620 /* Advance to end of string or next format specifier. */
22621 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22624 if (offset
- 1 != last_offset
)
22626 ptrdiff_t nchars
, nbytes
;
22628 /* Output to end of string or up to '%'. Field width
22629 is length of string. Don't output more than
22630 PRECISION allows us. */
22633 prec
= c_string_width (SDATA (elt
) + last_offset
,
22634 offset
- last_offset
, precision
- n
,
22637 switch (mode_line_target
)
22639 case MODE_LINE_NOPROP
:
22640 case MODE_LINE_TITLE
:
22641 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22643 case MODE_LINE_STRING
:
22645 ptrdiff_t bytepos
= last_offset
;
22646 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22647 ptrdiff_t endpos
= (precision
<= 0
22648 ? string_byte_to_char (elt
, offset
)
22649 : charpos
+ nchars
);
22650 Lisp_Object mode_string
22651 = Fsubstring (elt
, make_number (charpos
),
22652 make_number (endpos
));
22653 n
+= store_mode_line_string (NULL
, mode_string
, false,
22657 case MODE_LINE_DISPLAY
:
22659 ptrdiff_t bytepos
= last_offset
;
22660 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22662 if (precision
<= 0)
22663 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22664 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22666 STRING_MULTIBYTE (elt
));
22671 else /* c == '%' */
22673 ptrdiff_t percent_position
= offset
;
22675 /* Get the specified minimum width. Zero means
22678 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22679 field
= field
* 10 + c
- '0';
22681 /* Don't pad beyond the total padding allowed. */
22682 if (field_width
- n
> 0 && field
> field_width
- n
)
22683 field
= field_width
- n
;
22685 /* Note that either PRECISION <= 0 or N < PRECISION. */
22686 prec
= precision
- n
;
22689 n
+= display_mode_element (it
, depth
, field
, prec
,
22690 Vglobal_mode_string
, props
,
22695 ptrdiff_t bytepos
, charpos
;
22697 Lisp_Object string
;
22699 bytepos
= percent_position
;
22700 charpos
= (STRING_MULTIBYTE (elt
)
22701 ? string_byte_to_char (elt
, bytepos
)
22703 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22704 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22706 switch (mode_line_target
)
22708 case MODE_LINE_NOPROP
:
22709 case MODE_LINE_TITLE
:
22710 n
+= store_mode_line_noprop (spec
, field
, prec
);
22712 case MODE_LINE_STRING
:
22714 Lisp_Object tem
= build_string (spec
);
22715 props
= Ftext_properties_at (make_number (charpos
), elt
);
22716 /* Should only keep face property in props */
22717 n
+= store_mode_line_string (NULL
, tem
, false,
22718 field
, prec
, props
);
22721 case MODE_LINE_DISPLAY
:
22723 int nglyphs_before
, nwritten
;
22725 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22726 nwritten
= display_string (spec
, string
, elt
,
22731 /* Assign to the glyphs written above the
22732 string where the `%x' came from, position
22736 struct glyph
*glyph
22737 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22741 for (i
= 0; i
< nwritten
; ++i
)
22743 glyph
[i
].object
= elt
;
22744 glyph
[i
].charpos
= charpos
;
22761 /* A symbol: process the value of the symbol recursively
22762 as if it appeared here directly. Avoid error if symbol void.
22763 Special case: if value of symbol is a string, output the string
22766 register Lisp_Object tem
;
22768 /* If the variable is not marked as risky to set
22769 then its contents are risky to use. */
22770 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22773 tem
= Fboundp (elt
);
22776 tem
= Fsymbol_value (elt
);
22777 /* If value is a string, output that string literally:
22778 don't check for % within it. */
22782 if (!EQ (tem
, elt
))
22784 /* Give up right away for nil or t. */
22794 register Lisp_Object car
, tem
;
22796 /* A cons cell: five distinct cases.
22797 If first element is :eval or :propertize, do something special.
22798 If first element is a string or a cons, process all the elements
22799 and effectively concatenate them.
22800 If first element is a negative number, truncate displaying cdr to
22801 at most that many characters. If positive, pad (with spaces)
22802 to at least that many characters.
22803 If first element is a symbol, process the cadr or caddr recursively
22804 according to whether the symbol's value is non-nil or nil. */
22806 if (EQ (car
, QCeval
))
22808 /* An element of the form (:eval FORM) means evaluate FORM
22809 and use the result as mode line elements. */
22814 if (CONSP (XCDR (elt
)))
22817 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22818 n
+= display_mode_element (it
, depth
, field_width
- n
,
22819 precision
- n
, spec
, props
,
22823 else if (EQ (car
, QCpropertize
))
22825 /* An element of the form (:propertize ELT PROPS...)
22826 means display ELT but applying properties PROPS. */
22831 if (CONSP (XCDR (elt
)))
22832 n
+= display_mode_element (it
, depth
, field_width
- n
,
22833 precision
- n
, XCAR (XCDR (elt
)),
22834 XCDR (XCDR (elt
)), risky
);
22836 else if (SYMBOLP (car
))
22838 tem
= Fboundp (car
);
22842 /* elt is now the cdr, and we know it is a cons cell.
22843 Use its car if CAR has a non-nil value. */
22846 tem
= Fsymbol_value (car
);
22853 /* Symbol's value is nil (or symbol is unbound)
22854 Get the cddr of the original list
22855 and if possible find the caddr and use that. */
22859 else if (!CONSP (elt
))
22864 else if (INTEGERP (car
))
22866 register int lim
= XINT (car
);
22870 /* Negative int means reduce maximum width. */
22871 if (precision
<= 0)
22874 precision
= min (precision
, -lim
);
22878 /* Padding specified. Don't let it be more than
22879 current maximum. */
22881 lim
= min (precision
, lim
);
22883 /* If that's more padding than already wanted, queue it.
22884 But don't reduce padding already specified even if
22885 that is beyond the current truncation point. */
22886 field_width
= max (lim
, field_width
);
22890 else if (STRINGP (car
) || CONSP (car
))
22892 Lisp_Object halftail
= elt
;
22896 && (precision
<= 0 || n
< precision
))
22898 n
+= display_mode_element (it
, depth
,
22899 /* Do padding only after the last
22900 element in the list. */
22901 (! CONSP (XCDR (elt
))
22904 precision
- n
, XCAR (elt
),
22908 if ((len
& 1) == 0)
22909 halftail
= XCDR (halftail
);
22910 /* Check for cycle. */
22911 if (EQ (halftail
, elt
))
22920 elt
= build_string ("*invalid*");
22924 /* Pad to FIELD_WIDTH. */
22925 if (field_width
> 0 && n
< field_width
)
22927 switch (mode_line_target
)
22929 case MODE_LINE_NOPROP
:
22930 case MODE_LINE_TITLE
:
22931 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22933 case MODE_LINE_STRING
:
22934 n
+= store_mode_line_string ("", Qnil
, false, field_width
- n
, 0,
22937 case MODE_LINE_DISPLAY
:
22938 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22947 /* Store a mode-line string element in mode_line_string_list.
22949 If STRING is non-null, display that C string. Otherwise, the Lisp
22950 string LISP_STRING is displayed.
22952 FIELD_WIDTH is the minimum number of output glyphs to produce.
22953 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22954 with spaces. FIELD_WIDTH <= 0 means don't pad.
22956 PRECISION is the maximum number of characters to output from
22957 STRING. PRECISION <= 0 means don't truncate the string.
22959 If COPY_STRING, make a copy of LISP_STRING before adding
22960 properties to the string.
22962 PROPS are the properties to add to the string.
22963 The mode_line_string_face face property is always added to the string.
22967 store_mode_line_string (const char *string
, Lisp_Object lisp_string
,
22969 int field_width
, int precision
, Lisp_Object props
)
22974 if (string
!= NULL
)
22976 len
= strlen (string
);
22977 if (precision
> 0 && len
> precision
)
22979 lisp_string
= make_string (string
, len
);
22981 props
= mode_line_string_face_prop
;
22982 else if (!NILP (mode_line_string_face
))
22984 Lisp_Object face
= Fplist_get (props
, Qface
);
22985 props
= Fcopy_sequence (props
);
22987 face
= mode_line_string_face
;
22989 face
= list2 (face
, mode_line_string_face
);
22990 props
= Fplist_put (props
, Qface
, face
);
22992 Fadd_text_properties (make_number (0), make_number (len
),
22993 props
, lisp_string
);
22997 len
= XFASTINT (Flength (lisp_string
));
22998 if (precision
> 0 && len
> precision
)
23001 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
23004 if (!NILP (mode_line_string_face
))
23008 props
= Ftext_properties_at (make_number (0), lisp_string
);
23009 face
= Fplist_get (props
, Qface
);
23011 face
= mode_line_string_face
;
23013 face
= list2 (face
, mode_line_string_face
);
23014 props
= list2 (Qface
, face
);
23016 lisp_string
= Fcopy_sequence (lisp_string
);
23019 Fadd_text_properties (make_number (0), make_number (len
),
23020 props
, lisp_string
);
23025 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
23029 if (field_width
> len
)
23031 field_width
-= len
;
23032 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
23034 Fadd_text_properties (make_number (0), make_number (field_width
),
23035 props
, lisp_string
);
23036 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
23044 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
23046 doc
: /* Format a string out of a mode line format specification.
23047 First arg FORMAT specifies the mode line format (see `mode-line-format'
23048 for details) to use.
23050 By default, the format is evaluated for the currently selected window.
23052 Optional second arg FACE specifies the face property to put on all
23053 characters for which no face is specified. The value nil means the
23054 default face. The value t means whatever face the window's mode line
23055 currently uses (either `mode-line' or `mode-line-inactive',
23056 depending on whether the window is the selected window or not).
23057 An integer value means the value string has no text
23060 Optional third and fourth args WINDOW and BUFFER specify the window
23061 and buffer to use as the context for the formatting (defaults
23062 are the selected window and the WINDOW's buffer). */)
23063 (Lisp_Object format
, Lisp_Object face
,
23064 Lisp_Object window
, Lisp_Object buffer
)
23069 struct buffer
*old_buffer
= NULL
;
23071 bool no_props
= INTEGERP (face
);
23072 ptrdiff_t count
= SPECPDL_INDEX ();
23074 int string_start
= 0;
23076 w
= decode_any_window (window
);
23077 XSETWINDOW (window
, w
);
23080 buffer
= w
->contents
;
23081 CHECK_BUFFER (buffer
);
23083 /* Make formatting the modeline a non-op when noninteractive, otherwise
23084 there will be problems later caused by a partially initialized frame. */
23085 if (NILP (format
) || noninteractive
)
23086 return empty_unibyte_string
;
23091 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
23092 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
23093 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
23094 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
23095 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
23096 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
23097 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
23100 old_buffer
= current_buffer
;
23102 /* Save things including mode_line_proptrans_alist,
23103 and set that to nil so that we don't alter the outer value. */
23104 record_unwind_protect (unwind_format_mode_line
,
23105 format_mode_line_unwind_data
23106 (XFRAME (WINDOW_FRAME (w
)),
23107 old_buffer
, selected_window
, true));
23108 mode_line_proptrans_alist
= Qnil
;
23110 Fselect_window (window
, Qt
);
23111 set_buffer_internal_1 (XBUFFER (buffer
));
23113 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
23117 mode_line_target
= MODE_LINE_NOPROP
;
23118 mode_line_string_face_prop
= Qnil
;
23119 mode_line_string_list
= Qnil
;
23120 string_start
= MODE_LINE_NOPROP_LEN (0);
23124 mode_line_target
= MODE_LINE_STRING
;
23125 mode_line_string_list
= Qnil
;
23126 mode_line_string_face
= face
;
23127 mode_line_string_face_prop
23128 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
23131 push_kboard (FRAME_KBOARD (it
.f
));
23132 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
23137 len
= MODE_LINE_NOPROP_LEN (string_start
);
23138 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
23142 mode_line_string_list
= Fnreverse (mode_line_string_list
);
23143 str
= Fmapconcat (Qidentity
, mode_line_string_list
,
23144 empty_unibyte_string
);
23147 unbind_to (count
, Qnil
);
23151 /* Write a null-terminated, right justified decimal representation of
23152 the positive integer D to BUF using a minimal field width WIDTH. */
23155 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
23157 register char *p
= buf
;
23165 *p
++ = d
% 10 + '0';
23170 for (width
-= (int) (p
- buf
); width
> 0; --width
)
23181 /* Write a null-terminated, right justified decimal and "human
23182 readable" representation of the nonnegative integer D to BUF using
23183 a minimal field width WIDTH. D should be smaller than 999.5e24. */
23185 static const char power_letter
[] =
23199 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
23201 /* We aim to represent the nonnegative integer D as
23202 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
23203 ptrdiff_t quotient
= d
;
23205 /* -1 means: do not use TENTHS. */
23209 /* Length of QUOTIENT.TENTHS as a string. */
23215 if (quotient
>= 1000)
23217 /* Scale to the appropriate EXPONENT. */
23220 remainder
= quotient
% 1000;
23224 while (quotient
>= 1000);
23226 /* Round to nearest and decide whether to use TENTHS or not. */
23229 tenths
= remainder
/ 100;
23230 if (remainder
% 100 >= 50)
23237 if (quotient
== 10)
23245 if (remainder
>= 500)
23247 if (quotient
< 999)
23258 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
23259 if (tenths
== -1 && quotient
<= 99)
23266 p
= psuffix
= buf
+ max (width
, length
);
23268 /* Print EXPONENT. */
23269 *psuffix
++ = power_letter
[exponent
];
23272 /* Print TENTHS. */
23275 *--p
= '0' + tenths
;
23279 /* Print QUOTIENT. */
23282 int digit
= quotient
% 10;
23283 *--p
= '0' + digit
;
23285 while ((quotient
/= 10) != 0);
23287 /* Print leading spaces. */
23292 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
23293 If EOL_FLAG, set also a mnemonic character for end-of-line
23294 type of CODING_SYSTEM. Return updated pointer into BUF. */
23296 static unsigned char invalid_eol_type
[] = "(*invalid*)";
23299 decode_mode_spec_coding (Lisp_Object coding_system
, char *buf
, bool eol_flag
)
23302 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
23303 const unsigned char *eol_str
;
23305 /* The EOL conversion we are using. */
23306 Lisp_Object eoltype
;
23308 val
= CODING_SYSTEM_SPEC (coding_system
);
23311 if (!VECTORP (val
)) /* Not yet decided. */
23313 *buf
++ = multibyte
? '-' : ' ';
23315 eoltype
= eol_mnemonic_undecided
;
23316 /* Don't mention EOL conversion if it isn't decided. */
23321 Lisp_Object eolvalue
;
23323 attrs
= AREF (val
, 0);
23324 eolvalue
= AREF (val
, 2);
23327 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
23332 /* The EOL conversion that is normal on this system. */
23334 if (NILP (eolvalue
)) /* Not yet decided. */
23335 eoltype
= eol_mnemonic_undecided
;
23336 else if (VECTORP (eolvalue
)) /* Not yet decided. */
23337 eoltype
= eol_mnemonic_undecided
;
23338 else /* eolvalue is Qunix, Qdos, or Qmac. */
23339 eoltype
= (EQ (eolvalue
, Qunix
)
23340 ? eol_mnemonic_unix
23341 : EQ (eolvalue
, Qdos
)
23342 ? eol_mnemonic_dos
: eol_mnemonic_mac
);
23348 /* Mention the EOL conversion if it is not the usual one. */
23349 if (STRINGP (eoltype
))
23351 eol_str
= SDATA (eoltype
);
23352 eol_str_len
= SBYTES (eoltype
);
23354 else if (CHARACTERP (eoltype
))
23356 int c
= XFASTINT (eoltype
);
23357 return buf
+ CHAR_STRING (c
, (unsigned char *) buf
);
23361 eol_str
= invalid_eol_type
;
23362 eol_str_len
= sizeof (invalid_eol_type
) - 1;
23364 memcpy (buf
, eol_str
, eol_str_len
);
23365 buf
+= eol_str_len
;
23371 /* Return a string for the output of a mode line %-spec for window W,
23372 generated by character C. FIELD_WIDTH > 0 means pad the string
23373 returned with spaces to that value. Return a Lisp string in
23374 *STRING if the resulting string is taken from that Lisp string.
23376 Note we operate on the current buffer for most purposes. */
23378 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
23380 static const char *
23381 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
23382 Lisp_Object
*string
)
23385 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23386 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
23387 /* We are going to use f->decode_mode_spec_buffer as the buffer to
23388 produce strings from numerical values, so limit preposterously
23389 large values of FIELD_WIDTH to avoid overrunning the buffer's
23390 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
23391 bytes plus the terminating null. */
23392 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
23393 struct buffer
*b
= current_buffer
;
23401 if (!NILP (BVAR (b
, read_only
)))
23403 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23408 /* This differs from %* only for a modified read-only buffer. */
23409 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23411 if (!NILP (BVAR (b
, read_only
)))
23416 /* This differs from %* in ignoring read-only-ness. */
23417 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23429 if (command_loop_level
> 5)
23431 p
= decode_mode_spec_buf
;
23432 for (i
= 0; i
< command_loop_level
; i
++)
23435 return decode_mode_spec_buf
;
23443 if (command_loop_level
> 5)
23445 p
= decode_mode_spec_buf
;
23446 for (i
= 0; i
< command_loop_level
; i
++)
23449 return decode_mode_spec_buf
;
23456 /* Let lots_of_dashes be a string of infinite length. */
23457 if (mode_line_target
== MODE_LINE_NOPROP
23458 || mode_line_target
== MODE_LINE_STRING
)
23460 if (field_width
<= 0
23461 || field_width
> sizeof (lots_of_dashes
))
23463 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
23464 decode_mode_spec_buf
[i
] = '-';
23465 decode_mode_spec_buf
[i
] = '\0';
23466 return decode_mode_spec_buf
;
23469 return lots_of_dashes
;
23473 obj
= BVAR (b
, name
);
23477 /* %c and %l are ignored in `frame-title-format'.
23478 (In redisplay_internal, the frame title is drawn _before_ the
23479 windows are updated, so the stuff which depends on actual
23480 window contents (such as %l) may fail to render properly, or
23481 even crash emacs.) */
23482 if (mode_line_target
== MODE_LINE_TITLE
)
23486 ptrdiff_t col
= current_column ();
23487 w
->column_number_displayed
= col
;
23488 pint2str (decode_mode_spec_buf
, width
, col
);
23489 return decode_mode_spec_buf
;
23493 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
23495 if (NILP (Vmemory_full
))
23498 return "!MEM FULL! ";
23505 /* %F displays the frame name. */
23506 if (!NILP (f
->title
))
23507 return SSDATA (f
->title
);
23508 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
23509 return SSDATA (f
->name
);
23513 obj
= BVAR (b
, filename
);
23518 ptrdiff_t size
= ZV
- BEGV
;
23519 pint2str (decode_mode_spec_buf
, width
, size
);
23520 return decode_mode_spec_buf
;
23525 ptrdiff_t size
= ZV
- BEGV
;
23526 pint2hrstr (decode_mode_spec_buf
, width
, size
);
23527 return decode_mode_spec_buf
;
23532 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
23533 ptrdiff_t topline
, nlines
, height
;
23536 /* %c and %l are ignored in `frame-title-format'. */
23537 if (mode_line_target
== MODE_LINE_TITLE
)
23540 startpos
= marker_position (w
->start
);
23541 startpos_byte
= marker_byte_position (w
->start
);
23542 height
= WINDOW_TOTAL_LINES (w
);
23544 /* If we decided that this buffer isn't suitable for line numbers,
23545 don't forget that too fast. */
23546 if (w
->base_line_pos
== -1)
23549 /* If the buffer is very big, don't waste time. */
23550 if (INTEGERP (Vline_number_display_limit
)
23551 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
23553 w
->base_line_pos
= 0;
23554 w
->base_line_number
= 0;
23558 if (w
->base_line_number
> 0
23559 && w
->base_line_pos
> 0
23560 && w
->base_line_pos
<= startpos
)
23562 line
= w
->base_line_number
;
23563 linepos
= w
->base_line_pos
;
23564 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
23569 linepos
= BUF_BEGV (b
);
23570 linepos_byte
= BUF_BEGV_BYTE (b
);
23573 /* Count lines from base line to window start position. */
23574 nlines
= display_count_lines (linepos_byte
,
23578 topline
= nlines
+ line
;
23580 /* Determine a new base line, if the old one is too close
23581 or too far away, or if we did not have one.
23582 "Too close" means it's plausible a scroll-down would
23583 go back past it. */
23584 if (startpos
== BUF_BEGV (b
))
23586 w
->base_line_number
= topline
;
23587 w
->base_line_pos
= BUF_BEGV (b
);
23589 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
23590 || linepos
== BUF_BEGV (b
))
23592 ptrdiff_t limit
= BUF_BEGV (b
);
23593 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
23594 ptrdiff_t position
;
23595 ptrdiff_t distance
=
23596 (height
* 2 + 30) * line_number_display_limit_width
;
23598 if (startpos
- distance
> limit
)
23600 limit
= startpos
- distance
;
23601 limit_byte
= CHAR_TO_BYTE (limit
);
23604 nlines
= display_count_lines (startpos_byte
,
23606 - (height
* 2 + 30),
23608 /* If we couldn't find the lines we wanted within
23609 line_number_display_limit_width chars per line,
23610 give up on line numbers for this window. */
23611 if (position
== limit_byte
&& limit
== startpos
- distance
)
23613 w
->base_line_pos
= -1;
23614 w
->base_line_number
= 0;
23618 w
->base_line_number
= topline
- nlines
;
23619 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23622 /* Now count lines from the start pos to point. */
23623 nlines
= display_count_lines (startpos_byte
,
23624 PT_BYTE
, PT
, &junk
);
23626 /* Record that we did display the line number. */
23627 line_number_displayed
= true;
23629 /* Make the string to show. */
23630 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23631 return decode_mode_spec_buf
;
23634 char *p
= decode_mode_spec_buf
;
23635 int pad
= width
- 2;
23641 return decode_mode_spec_buf
;
23647 obj
= BVAR (b
, mode_name
);
23651 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23657 ptrdiff_t pos
= marker_position (w
->start
);
23658 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23660 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23662 if (pos
<= BUF_BEGV (b
))
23667 else if (pos
<= BUF_BEGV (b
))
23671 if (total
> 1000000)
23672 /* Do it differently for a large value, to avoid overflow. */
23673 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23675 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23676 /* We can't normally display a 3-digit number,
23677 so get us a 2-digit number that is close. */
23680 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23681 return decode_mode_spec_buf
;
23685 /* Display percentage of size above the bottom of the screen. */
23688 ptrdiff_t toppos
= marker_position (w
->start
);
23689 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23690 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23692 if (botpos
>= BUF_ZV (b
))
23694 if (toppos
<= BUF_BEGV (b
))
23701 if (total
> 1000000)
23702 /* Do it differently for a large value, to avoid overflow. */
23703 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23705 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23706 /* We can't normally display a 3-digit number,
23707 so get us a 2-digit number that is close. */
23710 if (toppos
<= BUF_BEGV (b
))
23711 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23713 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23714 return decode_mode_spec_buf
;
23719 /* status of process */
23720 obj
= Fget_buffer_process (Fcurrent_buffer ());
23722 return "no process";
23724 obj
= Fsymbol_name (Fprocess_status (obj
));
23730 ptrdiff_t count
= inhibit_garbage_collection ();
23731 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23732 Lisp_Object val
= Qnil
;
23734 if (STRINGP (curdir
))
23735 val
= call1 (intern ("file-remote-p"), curdir
);
23737 unbind_to (count
, Qnil
);
23746 /* coding-system (not including end-of-line format) */
23748 /* coding-system (including end-of-line type) */
23750 bool eol_flag
= (c
== 'Z');
23751 char *p
= decode_mode_spec_buf
;
23753 if (! FRAME_WINDOW_P (f
))
23755 /* No need to mention EOL here--the terminal never needs
23756 to do EOL conversion. */
23757 p
= decode_mode_spec_coding (CODING_ID_NAME
23758 (FRAME_KEYBOARD_CODING (f
)->id
),
23760 p
= decode_mode_spec_coding (CODING_ID_NAME
23761 (FRAME_TERMINAL_CODING (f
)->id
),
23764 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23767 #if false /* This proves to be annoying; I think we can do without. -- rms. */
23768 #ifdef subprocesses
23769 obj
= Fget_buffer_process (Fcurrent_buffer ());
23770 if (PROCESSP (obj
))
23772 p
= decode_mode_spec_coding
23773 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23774 p
= decode_mode_spec_coding
23775 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23777 #endif /* subprocesses */
23780 return decode_mode_spec_buf
;
23787 return SSDATA (obj
);
23794 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23795 means count lines back from START_BYTE. But don't go beyond
23796 LIMIT_BYTE. Return the number of lines thus found (always
23799 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23800 either the position COUNT lines after/before START_BYTE, if we
23801 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23805 display_count_lines (ptrdiff_t start_byte
,
23806 ptrdiff_t limit_byte
, ptrdiff_t count
,
23807 ptrdiff_t *byte_pos_ptr
)
23809 register unsigned char *cursor
;
23810 unsigned char *base
;
23812 register ptrdiff_t ceiling
;
23813 register unsigned char *ceiling_addr
;
23814 ptrdiff_t orig_count
= count
;
23816 /* If we are not in selective display mode,
23817 check only for newlines. */
23818 bool selective_display
23819 = (!NILP (BVAR (current_buffer
, selective_display
))
23820 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23824 while (start_byte
< limit_byte
)
23826 ceiling
= BUFFER_CEILING_OF (start_byte
);
23827 ceiling
= min (limit_byte
- 1, ceiling
);
23828 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23829 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23833 if (selective_display
)
23835 while (*cursor
!= '\n' && *cursor
!= 015
23836 && ++cursor
!= ceiling_addr
)
23838 if (cursor
== ceiling_addr
)
23843 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23852 start_byte
+= cursor
- base
;
23853 *byte_pos_ptr
= start_byte
;
23857 while (cursor
< ceiling_addr
);
23859 start_byte
+= ceiling_addr
- base
;
23864 while (start_byte
> limit_byte
)
23866 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23867 ceiling
= max (limit_byte
, ceiling
);
23868 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23869 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23872 if (selective_display
)
23874 while (--cursor
>= ceiling_addr
23875 && *cursor
!= '\n' && *cursor
!= 015)
23877 if (cursor
< ceiling_addr
)
23882 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23889 start_byte
+= cursor
- base
+ 1;
23890 *byte_pos_ptr
= start_byte
;
23891 /* When scanning backwards, we should
23892 not count the newline posterior to which we stop. */
23893 return - orig_count
- 1;
23896 start_byte
+= ceiling_addr
- base
;
23900 *byte_pos_ptr
= limit_byte
;
23903 return - orig_count
+ count
;
23904 return orig_count
- count
;
23910 /***********************************************************************
23912 ***********************************************************************/
23914 /* Display a NUL-terminated string, starting with index START.
23916 If STRING is non-null, display that C string. Otherwise, the Lisp
23917 string LISP_STRING is displayed. There's a case that STRING is
23918 non-null and LISP_STRING is not nil. It means STRING is a string
23919 data of LISP_STRING. In that case, we display LISP_STRING while
23920 ignoring its text properties.
23922 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23923 FACE_STRING. Display STRING or LISP_STRING with the face at
23924 FACE_STRING_POS in FACE_STRING:
23926 Display the string in the environment given by IT, but use the
23927 standard display table, temporarily.
23929 FIELD_WIDTH is the minimum number of output glyphs to produce.
23930 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23931 with spaces. If STRING has more characters, more than FIELD_WIDTH
23932 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23934 PRECISION is the maximum number of characters to output from
23935 STRING. PRECISION < 0 means don't truncate the string.
23937 This is roughly equivalent to printf format specifiers:
23939 FIELD_WIDTH PRECISION PRINTF
23940 ----------------------------------------
23946 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23947 display them, and < 0 means obey the current buffer's value of
23948 enable_multibyte_characters.
23950 Value is the number of columns displayed. */
23953 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23954 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23955 int field_width
, int precision
, int max_x
, int multibyte
)
23957 int hpos_at_start
= it
->hpos
;
23958 int saved_face_id
= it
->face_id
;
23959 struct glyph_row
*row
= it
->glyph_row
;
23960 ptrdiff_t it_charpos
;
23962 /* Initialize the iterator IT for iteration over STRING beginning
23963 with index START. */
23964 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23965 precision
, field_width
, multibyte
);
23966 if (string
&& STRINGP (lisp_string
))
23967 /* LISP_STRING is the one returned by decode_mode_spec. We should
23968 ignore its text properties. */
23969 it
->stop_charpos
= it
->end_charpos
;
23971 /* If displaying STRING, set up the face of the iterator from
23972 FACE_STRING, if that's given. */
23973 if (STRINGP (face_string
))
23979 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23980 0, &endptr
, it
->base_face_id
, false);
23981 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23982 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23985 /* Set max_x to the maximum allowed X position. Don't let it go
23986 beyond the right edge of the window. */
23988 max_x
= it
->last_visible_x
;
23990 max_x
= min (max_x
, it
->last_visible_x
);
23992 /* Skip over display elements that are not visible. because IT->w is
23994 if (it
->current_x
< it
->first_visible_x
)
23995 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23996 MOVE_TO_POS
| MOVE_TO_X
);
23998 row
->ascent
= it
->max_ascent
;
23999 row
->height
= it
->max_ascent
+ it
->max_descent
;
24000 row
->phys_ascent
= it
->max_phys_ascent
;
24001 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
24002 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
24004 if (STRINGP (it
->string
))
24005 it_charpos
= IT_STRING_CHARPOS (*it
);
24007 it_charpos
= IT_CHARPOS (*it
);
24009 /* This condition is for the case that we are called with current_x
24010 past last_visible_x. */
24011 while (it
->current_x
< max_x
)
24013 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
24015 /* Get the next display element. */
24016 if (!get_next_display_element (it
))
24019 /* Produce glyphs. */
24020 x_before
= it
->current_x
;
24021 n_glyphs_before
= row
->used
[TEXT_AREA
];
24022 PRODUCE_GLYPHS (it
);
24024 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
24027 while (i
< nglyphs
)
24029 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
24031 if (it
->line_wrap
!= TRUNCATE
24032 && x
+ glyph
->pixel_width
> max_x
)
24034 /* End of continued line or max_x reached. */
24035 if (CHAR_GLYPH_PADDING_P (*glyph
))
24037 /* A wide character is unbreakable. */
24038 if (row
->reversed_p
)
24039 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
24040 - n_glyphs_before
);
24041 row
->used
[TEXT_AREA
] = n_glyphs_before
;
24042 it
->current_x
= x_before
;
24046 if (row
->reversed_p
)
24047 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
24048 - (n_glyphs_before
+ i
));
24049 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
24054 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
24056 /* Glyph is at least partially visible. */
24058 if (x
< it
->first_visible_x
)
24059 row
->x
= x
- it
->first_visible_x
;
24063 /* Glyph is off the left margin of the display area.
24064 Should not happen. */
24068 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
24069 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
24070 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
24071 row
->phys_height
= max (row
->phys_height
,
24072 it
->max_phys_ascent
+ it
->max_phys_descent
);
24073 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
24074 it
->max_extra_line_spacing
);
24075 x
+= glyph
->pixel_width
;
24079 /* Stop if max_x reached. */
24083 /* Stop at line ends. */
24084 if (ITERATOR_AT_END_OF_LINE_P (it
))
24086 it
->continuation_lines_width
= 0;
24090 set_iterator_to_next (it
, true);
24091 if (STRINGP (it
->string
))
24092 it_charpos
= IT_STRING_CHARPOS (*it
);
24094 it_charpos
= IT_CHARPOS (*it
);
24096 /* Stop if truncating at the right edge. */
24097 if (it
->line_wrap
== TRUNCATE
24098 && it
->current_x
>= it
->last_visible_x
)
24100 /* Add truncation mark, but don't do it if the line is
24101 truncated at a padding space. */
24102 if (it_charpos
< it
->string_nchars
)
24104 if (!FRAME_WINDOW_P (it
->f
))
24108 if (it
->current_x
> it
->last_visible_x
)
24110 if (!row
->reversed_p
)
24112 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
24113 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
24118 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
24119 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
24121 unproduce_glyphs (it
, ii
+ 1);
24122 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
24124 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
24126 row
->used
[TEXT_AREA
] = ii
;
24127 produce_special_glyphs (it
, IT_TRUNCATION
);
24130 produce_special_glyphs (it
, IT_TRUNCATION
);
24132 row
->truncated_on_right_p
= true;
24138 /* Maybe insert a truncation at the left. */
24139 if (it
->first_visible_x
24142 if (!FRAME_WINDOW_P (it
->f
)
24143 || (row
->reversed_p
24144 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24145 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
24146 insert_left_trunc_glyphs (it
);
24147 row
->truncated_on_left_p
= true;
24150 it
->face_id
= saved_face_id
;
24152 /* Value is number of columns displayed. */
24153 return it
->hpos
- hpos_at_start
;
24158 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
24159 appears as an element of LIST or as the car of an element of LIST.
24160 If PROPVAL is a list, compare each element against LIST in that
24161 way, and return 1/2 if any element of PROPVAL is found in LIST.
24162 Otherwise return 0. This function cannot quit.
24163 The return value is 2 if the text is invisible but with an ellipsis
24164 and 1 if it's invisible and without an ellipsis. */
24167 invisible_prop (Lisp_Object propval
, Lisp_Object list
)
24169 Lisp_Object tail
, proptail
;
24171 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
24173 register Lisp_Object tem
;
24175 if (EQ (propval
, tem
))
24177 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
24178 return NILP (XCDR (tem
)) ? 1 : 2;
24181 if (CONSP (propval
))
24183 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
24185 Lisp_Object propelt
;
24186 propelt
= XCAR (proptail
);
24187 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
24189 register Lisp_Object tem
;
24191 if (EQ (propelt
, tem
))
24193 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
24194 return NILP (XCDR (tem
)) ? 1 : 2;
24202 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
24203 doc
: /* Non-nil if the property makes the text invisible.
24204 POS-OR-PROP can be a marker or number, in which case it is taken to be
24205 a position in the current buffer and the value of the `invisible' property
24206 is checked; or it can be some other value, which is then presumed to be the
24207 value of the `invisible' property of the text of interest.
24208 The non-nil value returned can be t for truly invisible text or something
24209 else if the text is replaced by an ellipsis. */)
24210 (Lisp_Object pos_or_prop
)
24213 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
24214 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
24216 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
24217 return (invis
== 0 ? Qnil
24219 : make_number (invis
));
24222 /* Calculate a width or height in pixels from a specification using
24223 the following elements:
24226 NUM - a (fractional) multiple of the default font width/height
24227 (NUM) - specifies exactly NUM pixels
24228 UNIT - a fixed number of pixels, see below.
24229 ELEMENT - size of a display element in pixels, see below.
24230 (NUM . SPEC) - equals NUM * SPEC
24231 (+ SPEC SPEC ...) - add pixel values
24232 (- SPEC SPEC ...) - subtract pixel values
24233 (- SPEC) - negate pixel value
24236 INT or FLOAT - a number constant
24237 SYMBOL - use symbol's (buffer local) variable binding.
24240 in - pixels per inch *)
24241 mm - pixels per 1/1000 meter *)
24242 cm - pixels per 1/100 meter *)
24243 width - width of current font in pixels.
24244 height - height of current font in pixels.
24246 *) using the ratio(s) defined in display-pixels-per-inch.
24250 left-fringe - left fringe width in pixels
24251 right-fringe - right fringe width in pixels
24253 left-margin - left margin width in pixels
24254 right-margin - right margin width in pixels
24256 scroll-bar - scroll-bar area width in pixels
24260 Pixels corresponding to 5 inches:
24263 Total width of non-text areas on left side of window (if scroll-bar is on left):
24264 '(space :width (+ left-fringe left-margin scroll-bar))
24266 Align to first text column (in header line):
24267 '(space :align-to 0)
24269 Align to middle of text area minus half the width of variable `my-image'
24270 containing a loaded image:
24271 '(space :align-to (0.5 . (- text my-image)))
24273 Width of left margin minus width of 1 character in the default font:
24274 '(space :width (- left-margin 1))
24276 Width of left margin minus width of 2 characters in the current font:
24277 '(space :width (- left-margin (2 . width)))
24279 Center 1 character over left-margin (in header line):
24280 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
24282 Different ways to express width of left fringe plus left margin minus one pixel:
24283 '(space :width (- (+ left-fringe left-margin) (1)))
24284 '(space :width (+ left-fringe left-margin (- (1))))
24285 '(space :width (+ left-fringe left-margin (-1)))
24290 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
24291 struct font
*font
, bool width_p
, int *align_to
)
24295 # define OK_PIXELS(val) (*res = (val), true)
24296 # define OK_ALIGN_TO(val) (*align_to = (val), true)
24299 return OK_PIXELS (0);
24301 eassert (FRAME_LIVE_P (it
->f
));
24303 if (SYMBOLP (prop
))
24305 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
24307 char *unit
= SSDATA (SYMBOL_NAME (prop
));
24309 if (unit
[0] == 'i' && unit
[1] == 'n')
24311 else if (unit
[0] == 'm' && unit
[1] == 'm')
24313 else if (unit
[0] == 'c' && unit
[1] == 'm')
24319 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
24320 : FRAME_RES_Y (it
->f
));
24323 return OK_PIXELS (ppi
/ pixels
);
24328 #ifdef HAVE_WINDOW_SYSTEM
24329 if (EQ (prop
, Qheight
))
24330 return OK_PIXELS (font
24331 ? normal_char_height (font
, -1)
24332 : FRAME_LINE_HEIGHT (it
->f
));
24333 if (EQ (prop
, Qwidth
))
24334 return OK_PIXELS (font
24335 ? FONT_WIDTH (font
)
24336 : FRAME_COLUMN_WIDTH (it
->f
));
24338 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
24339 return OK_PIXELS (1);
24342 if (EQ (prop
, Qtext
))
24343 return OK_PIXELS (width_p
24344 ? window_box_width (it
->w
, TEXT_AREA
)
24345 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
24347 if (align_to
&& *align_to
< 0)
24350 if (EQ (prop
, Qleft
))
24351 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
24352 if (EQ (prop
, Qright
))
24353 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
24354 if (EQ (prop
, Qcenter
))
24355 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
24356 + window_box_width (it
->w
, TEXT_AREA
) / 2);
24357 if (EQ (prop
, Qleft_fringe
))
24358 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24359 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
24360 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
24361 if (EQ (prop
, Qright_fringe
))
24362 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24363 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24364 : window_box_right_offset (it
->w
, TEXT_AREA
));
24365 if (EQ (prop
, Qleft_margin
))
24366 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
24367 if (EQ (prop
, Qright_margin
))
24368 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
24369 if (EQ (prop
, Qscroll_bar
))
24370 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
24372 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24373 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24374 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24379 if (EQ (prop
, Qleft_fringe
))
24380 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
24381 if (EQ (prop
, Qright_fringe
))
24382 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
24383 if (EQ (prop
, Qleft_margin
))
24384 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
24385 if (EQ (prop
, Qright_margin
))
24386 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
24387 if (EQ (prop
, Qscroll_bar
))
24388 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
24391 prop
= buffer_local_value (prop
, it
->w
->contents
);
24392 if (EQ (prop
, Qunbound
))
24396 if (NUMBERP (prop
))
24398 int base_unit
= (width_p
24399 ? FRAME_COLUMN_WIDTH (it
->f
)
24400 : FRAME_LINE_HEIGHT (it
->f
));
24401 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
24406 Lisp_Object car
= XCAR (prop
);
24407 Lisp_Object cdr
= XCDR (prop
);
24411 #ifdef HAVE_WINDOW_SYSTEM
24412 if (FRAME_WINDOW_P (it
->f
)
24413 && valid_image_p (prop
))
24415 ptrdiff_t id
= lookup_image (it
->f
, prop
);
24416 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
24418 return OK_PIXELS (width_p
? img
->width
: img
->height
);
24420 if (FRAME_WINDOW_P (it
->f
) && valid_xwidget_spec_p (prop
))
24422 // TODO: Don't return dummy size.
24423 return OK_PIXELS (100);
24426 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
24432 while (CONSP (cdr
))
24434 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
24435 font
, width_p
, align_to
))
24438 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= false;
24443 if (EQ (car
, Qminus
))
24445 return OK_PIXELS (pixels
);
24448 car
= buffer_local_value (car
, it
->w
->contents
);
24449 if (EQ (car
, Qunbound
))
24456 pixels
= XFLOATINT (car
);
24458 return OK_PIXELS (pixels
);
24459 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
24460 font
, width_p
, align_to
))
24461 return OK_PIXELS (pixels
* fact
);
24472 get_font_ascent_descent (struct font
*font
, int *ascent
, int *descent
)
24474 #ifdef HAVE_WINDOW_SYSTEM
24475 normal_char_ascent_descent (font
, -1, ascent
, descent
);
24483 /***********************************************************************
24485 ***********************************************************************/
24487 #ifdef HAVE_WINDOW_SYSTEM
24492 dump_glyph_string (struct glyph_string
*s
)
24494 fprintf (stderr
, "glyph string\n");
24495 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
24496 s
->x
, s
->y
, s
->width
, s
->height
);
24497 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
24498 fprintf (stderr
, " hl = %d\n", s
->hl
);
24499 fprintf (stderr
, " left overhang = %d, right = %d\n",
24500 s
->left_overhang
, s
->right_overhang
);
24501 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
24502 fprintf (stderr
, " extends to end of line = %d\n",
24503 s
->extends_to_end_of_line_p
);
24504 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
24505 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
24508 #endif /* GLYPH_DEBUG */
24510 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
24511 of XChar2b structures for S; it can't be allocated in
24512 init_glyph_string because it must be allocated via `alloca'. W
24513 is the window on which S is drawn. ROW and AREA are the glyph row
24514 and area within the row from which S is constructed. START is the
24515 index of the first glyph structure covered by S. HL is a
24516 face-override for drawing S. */
24519 #define OPTIONAL_HDC(hdc) HDC hdc,
24520 #define DECLARE_HDC(hdc) HDC hdc;
24521 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
24522 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
24525 #ifndef OPTIONAL_HDC
24526 #define OPTIONAL_HDC(hdc)
24527 #define DECLARE_HDC(hdc)
24528 #define ALLOCATE_HDC(hdc, f)
24529 #define RELEASE_HDC(hdc, f)
24533 init_glyph_string (struct glyph_string
*s
,
24535 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
24536 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
24538 memset (s
, 0, sizeof *s
);
24540 s
->f
= XFRAME (w
->frame
);
24544 s
->display
= FRAME_X_DISPLAY (s
->f
);
24545 s
->window
= FRAME_X_WINDOW (s
->f
);
24546 s
->char2b
= char2b
;
24550 s
->first_glyph
= row
->glyphs
[area
] + start
;
24551 s
->height
= row
->height
;
24552 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
24553 s
->ybase
= s
->y
+ row
->ascent
;
24557 /* Append the list of glyph strings with head H and tail T to the list
24558 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
24561 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24562 struct glyph_string
*h
, struct glyph_string
*t
)
24576 /* Prepend the list of glyph strings with head H and tail T to the
24577 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
24581 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24582 struct glyph_string
*h
, struct glyph_string
*t
)
24596 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
24597 Set *HEAD and *TAIL to the resulting list. */
24600 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
24601 struct glyph_string
*s
)
24603 s
->next
= s
->prev
= NULL
;
24604 append_glyph_string_lists (head
, tail
, s
, s
);
24608 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24609 The encoding of C is returned in *CHAR2B. DISPLAY_P means
24610 make sure that X resources for the face returned are allocated.
24611 Value is a pointer to a realized face that is ready for display if
24614 static struct face
*
24615 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
24616 XChar2b
*char2b
, bool display_p
)
24618 struct face
*face
= FACE_FROM_ID (f
, face_id
);
24623 code
= face
->font
->driver
->encode_char (face
->font
, c
);
24625 if (code
== FONT_INVALID_CODE
)
24628 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24630 /* Make sure X resources of the face are allocated. */
24631 #ifdef HAVE_X_WINDOWS
24635 eassert (face
!= NULL
);
24636 prepare_face_for_display (f
, face
);
24643 /* Get face and two-byte form of character glyph GLYPH on frame F.
24644 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24645 a pointer to a realized face that is ready for display. */
24647 static struct face
*
24648 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24654 eassert (glyph
->type
== CHAR_GLYPH
);
24655 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24657 /* Make sure X resources of the face are allocated. */
24658 prepare_face_for_display (f
, face
);
24662 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24663 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24665 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24667 if (code
== FONT_INVALID_CODE
)
24671 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24676 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24677 Return true iff FONT has a glyph for C. */
24680 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24684 if (CHAR_BYTE8_P (c
))
24685 code
= CHAR_TO_BYTE8 (c
);
24687 code
= font
->driver
->encode_char (font
, c
);
24689 if (code
== FONT_INVALID_CODE
)
24691 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24696 /* Fill glyph string S with composition components specified by S->cmp.
24698 BASE_FACE is the base face of the composition.
24699 S->cmp_from is the index of the first component for S.
24701 OVERLAPS non-zero means S should draw the foreground only, and use
24702 its physical height for clipping. See also draw_glyphs.
24704 Value is the index of a component not in S. */
24707 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24711 /* For all glyphs of this composition, starting at the offset
24712 S->cmp_from, until we reach the end of the definition or encounter a
24713 glyph that requires the different face, add it to S. */
24718 s
->for_overlaps
= overlaps
;
24721 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24723 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24725 /* TAB in a composition means display glyphs with padding space
24726 on the left or right. */
24729 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24732 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24733 s
->char2b
+ i
, true);
24739 s
->font
= s
->face
->font
;
24741 else if (s
->face
!= face
)
24749 if (s
->face
== NULL
)
24751 s
->face
= base_face
->ascii_face
;
24752 s
->font
= s
->face
->font
;
24755 /* All glyph strings for the same composition has the same width,
24756 i.e. the width set for the first component of the composition. */
24757 s
->width
= s
->first_glyph
->pixel_width
;
24759 /* If the specified font could not be loaded, use the frame's
24760 default font, but record the fact that we couldn't load it in
24761 the glyph string so that we can draw rectangles for the
24762 characters of the glyph string. */
24763 if (s
->font
== NULL
)
24765 s
->font_not_found_p
= true;
24766 s
->font
= FRAME_FONT (s
->f
);
24769 /* Adjust base line for subscript/superscript text. */
24770 s
->ybase
+= s
->first_glyph
->voffset
;
24776 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24777 int start
, int end
, int overlaps
)
24779 struct glyph
*glyph
, *last
;
24780 Lisp_Object lgstring
;
24783 s
->for_overlaps
= overlaps
;
24784 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24785 last
= s
->row
->glyphs
[s
->area
] + end
;
24786 s
->cmp_id
= glyph
->u
.cmp
.id
;
24787 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24788 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24789 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24790 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24791 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24793 while (glyph
< last
24794 && glyph
->u
.cmp
.automatic
24795 && glyph
->u
.cmp
.id
== s
->cmp_id
24796 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24797 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24799 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24801 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24802 unsigned code
= LGLYPH_CODE (lglyph
);
24804 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24806 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24807 return glyph
- s
->row
->glyphs
[s
->area
];
24811 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24812 See the comment of fill_glyph_string for arguments.
24813 Value is the index of the first glyph not in S. */
24817 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24818 int start
, int end
, int overlaps
)
24820 struct glyph
*glyph
, *last
;
24823 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24824 s
->for_overlaps
= overlaps
;
24825 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24826 last
= s
->row
->glyphs
[s
->area
] + end
;
24827 voffset
= glyph
->voffset
;
24828 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24829 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24831 s
->width
= glyph
->pixel_width
;
24833 while (glyph
< last
24834 && glyph
->type
== GLYPHLESS_GLYPH
24835 && glyph
->voffset
== voffset
24836 && glyph
->face_id
== face_id
)
24839 s
->width
+= glyph
->pixel_width
;
24842 s
->ybase
+= voffset
;
24843 return glyph
- s
->row
->glyphs
[s
->area
];
24847 /* Fill glyph string S from a sequence of character glyphs.
24849 FACE_ID is the face id of the string. START is the index of the
24850 first glyph to consider, END is the index of the last + 1.
24851 OVERLAPS non-zero means S should draw the foreground only, and use
24852 its physical height for clipping. See also draw_glyphs.
24854 Value is the index of the first glyph not in S. */
24857 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24858 int start
, int end
, int overlaps
)
24860 struct glyph
*glyph
, *last
;
24862 bool glyph_not_available_p
;
24864 eassert (s
->f
== XFRAME (s
->w
->frame
));
24865 eassert (s
->nchars
== 0);
24866 eassert (start
>= 0 && end
> start
);
24868 s
->for_overlaps
= overlaps
;
24869 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24870 last
= s
->row
->glyphs
[s
->area
] + end
;
24871 voffset
= glyph
->voffset
;
24872 s
->padding_p
= glyph
->padding_p
;
24873 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24875 while (glyph
< last
24876 && glyph
->type
== CHAR_GLYPH
24877 && glyph
->voffset
== voffset
24878 /* Same face id implies same font, nowadays. */
24879 && glyph
->face_id
== face_id
24880 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24882 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24883 s
->char2b
+ s
->nchars
);
24885 eassert (s
->nchars
<= end
- start
);
24886 s
->width
+= glyph
->pixel_width
;
24887 if (glyph
++->padding_p
!= s
->padding_p
)
24891 s
->font
= s
->face
->font
;
24893 /* If the specified font could not be loaded, use the frame's font,
24894 but record the fact that we couldn't load it in
24895 S->font_not_found_p so that we can draw rectangles for the
24896 characters of the glyph string. */
24897 if (s
->font
== NULL
|| glyph_not_available_p
)
24899 s
->font_not_found_p
= true;
24900 s
->font
= FRAME_FONT (s
->f
);
24903 /* Adjust base line for subscript/superscript text. */
24904 s
->ybase
+= voffset
;
24906 eassert (s
->face
&& s
->face
->gc
);
24907 return glyph
- s
->row
->glyphs
[s
->area
];
24911 /* Fill glyph string S from image glyph S->first_glyph. */
24914 fill_image_glyph_string (struct glyph_string
*s
)
24916 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24917 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24919 s
->slice
= s
->first_glyph
->slice
.img
;
24920 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24921 s
->font
= s
->face
->font
;
24922 s
->width
= s
->first_glyph
->pixel_width
;
24924 /* Adjust base line for subscript/superscript text. */
24925 s
->ybase
+= s
->first_glyph
->voffset
;
24929 #ifdef HAVE_XWIDGETS
24931 fill_xwidget_glyph_string (struct glyph_string
*s
)
24933 eassert (s
->first_glyph
->type
== XWIDGET_GLYPH
);
24934 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24935 s
->font
= s
->face
->font
;
24936 s
->width
= s
->first_glyph
->pixel_width
;
24937 s
->ybase
+= s
->first_glyph
->voffset
;
24938 s
->xwidget
= s
->first_glyph
->u
.xwidget
;
24941 /* Fill glyph string S from a sequence of stretch glyphs.
24943 START is the index of the first glyph to consider,
24944 END is the index of the last + 1.
24946 Value is the index of the first glyph not in S. */
24949 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24951 struct glyph
*glyph
, *last
;
24952 int voffset
, face_id
;
24954 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24956 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24957 last
= s
->row
->glyphs
[s
->area
] + end
;
24958 face_id
= glyph
->face_id
;
24959 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24960 s
->font
= s
->face
->font
;
24961 s
->width
= glyph
->pixel_width
;
24963 voffset
= glyph
->voffset
;
24967 && glyph
->type
== STRETCH_GLYPH
24968 && glyph
->voffset
== voffset
24969 && glyph
->face_id
== face_id
);
24971 s
->width
+= glyph
->pixel_width
;
24973 /* Adjust base line for subscript/superscript text. */
24974 s
->ybase
+= voffset
;
24976 /* The case that face->gc == 0 is handled when drawing the glyph
24977 string by calling prepare_face_for_display. */
24979 return glyph
- s
->row
->glyphs
[s
->area
];
24982 static struct font_metrics
*
24983 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24985 static struct font_metrics metrics
;
24990 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24991 if (code
== FONT_INVALID_CODE
)
24993 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24997 /* A subroutine that computes "normal" values of ASCENT and DESCENT
24998 for FONT. Values are taken from font-global ones, except for fonts
24999 that claim preposterously large values, but whose glyphs actually
25000 have reasonable dimensions. C is the character to use for metrics
25001 if the font-global values are too large; if C is negative, the
25002 function selects a default character. */
25004 normal_char_ascent_descent (struct font
*font
, int c
, int *ascent
, int *descent
)
25006 *ascent
= FONT_BASE (font
);
25007 *descent
= FONT_DESCENT (font
);
25009 if (FONT_TOO_HIGH (font
))
25013 /* Get metrics of C, defaulting to a reasonably sized ASCII
25015 if (get_char_glyph_code (c
>= 0 ? c
: '{', font
, &char2b
))
25017 struct font_metrics
*pcm
= get_per_char_metric (font
, &char2b
);
25019 if (!(pcm
->width
== 0 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0))
25021 /* We add 1 pixel to character dimensions as heuristics
25022 that produces nicer display, e.g. when the face has
25023 the box attribute. */
25024 *ascent
= pcm
->ascent
+ 1;
25025 *descent
= pcm
->descent
+ 1;
25031 /* A subroutine that computes a reasonable "normal character height"
25032 for fonts that claim preposterously large vertical dimensions, but
25033 whose glyphs are actually reasonably sized. C is the character
25034 whose metrics to use for those fonts, or -1 for default
25037 normal_char_height (struct font
*font
, int c
)
25039 int ascent
, descent
;
25041 normal_char_ascent_descent (font
, c
, &ascent
, &descent
);
25043 return ascent
+ descent
;
25047 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
25048 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
25049 assumed to be zero. */
25052 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
25054 *left
= *right
= 0;
25056 if (glyph
->type
== CHAR_GLYPH
)
25059 struct face
*face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
);
25062 struct font_metrics
*pcm
= get_per_char_metric (face
->font
, &char2b
);
25065 if (pcm
->rbearing
> pcm
->width
)
25066 *right
= pcm
->rbearing
- pcm
->width
;
25067 if (pcm
->lbearing
< 0)
25068 *left
= -pcm
->lbearing
;
25072 else if (glyph
->type
== COMPOSITE_GLYPH
)
25074 if (! glyph
->u
.cmp
.automatic
)
25076 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
25078 if (cmp
->rbearing
> cmp
->pixel_width
)
25079 *right
= cmp
->rbearing
- cmp
->pixel_width
;
25080 if (cmp
->lbearing
< 0)
25081 *left
= - cmp
->lbearing
;
25085 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
25086 struct font_metrics metrics
;
25088 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
25089 glyph
->slice
.cmp
.to
+ 1, &metrics
);
25090 if (metrics
.rbearing
> metrics
.width
)
25091 *right
= metrics
.rbearing
- metrics
.width
;
25092 if (metrics
.lbearing
< 0)
25093 *left
= - metrics
.lbearing
;
25099 /* Return the index of the first glyph preceding glyph string S that
25100 is overwritten by S because of S's left overhang. Value is -1
25101 if no glyphs are overwritten. */
25104 left_overwritten (struct glyph_string
*s
)
25108 if (s
->left_overhang
)
25111 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25112 int first
= s
->first_glyph
- glyphs
;
25114 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
25115 x
-= glyphs
[i
].pixel_width
;
25126 /* Return the index of the first glyph preceding glyph string S that
25127 is overwriting S because of its right overhang. Value is -1 if no
25128 glyph in front of S overwrites S. */
25131 left_overwriting (struct glyph_string
*s
)
25134 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25135 int first
= s
->first_glyph
- glyphs
;
25139 for (i
= first
- 1; i
>= 0; --i
)
25142 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
25145 x
-= glyphs
[i
].pixel_width
;
25152 /* Return the index of the last glyph following glyph string S that is
25153 overwritten by S because of S's right overhang. Value is -1 if
25154 no such glyph is found. */
25157 right_overwritten (struct glyph_string
*s
)
25161 if (s
->right_overhang
)
25164 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25165 int first
= (s
->first_glyph
- glyphs
25166 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
25167 int end
= s
->row
->used
[s
->area
];
25169 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
25170 x
+= glyphs
[i
].pixel_width
;
25179 /* Return the index of the last glyph following glyph string S that
25180 overwrites S because of its left overhang. Value is negative
25181 if no such glyph is found. */
25184 right_overwriting (struct glyph_string
*s
)
25187 int end
= s
->row
->used
[s
->area
];
25188 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25189 int first
= (s
->first_glyph
- glyphs
25190 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
25194 for (i
= first
; i
< end
; ++i
)
25197 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
25200 x
+= glyphs
[i
].pixel_width
;
25207 /* Set background width of glyph string S. START is the index of the
25208 first glyph following S. LAST_X is the right-most x-position + 1
25209 in the drawing area. */
25212 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
25214 /* If the face of this glyph string has to be drawn to the end of
25215 the drawing area, set S->extends_to_end_of_line_p. */
25217 if (start
== s
->row
->used
[s
->area
]
25218 && ((s
->row
->fill_line_p
25219 && (s
->hl
== DRAW_NORMAL_TEXT
25220 || s
->hl
== DRAW_IMAGE_RAISED
25221 || s
->hl
== DRAW_IMAGE_SUNKEN
))
25222 || s
->hl
== DRAW_MOUSE_FACE
))
25223 s
->extends_to_end_of_line_p
= true;
25225 /* If S extends its face to the end of the line, set its
25226 background_width to the distance to the right edge of the drawing
25228 if (s
->extends_to_end_of_line_p
)
25229 s
->background_width
= last_x
- s
->x
+ 1;
25231 s
->background_width
= s
->width
;
25235 /* Compute overhangs and x-positions for glyph string S and its
25236 predecessors, or successors. X is the starting x-position for S.
25237 BACKWARD_P means process predecessors. */
25240 compute_overhangs_and_x (struct glyph_string
*s
, int x
, bool backward_p
)
25246 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
25247 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
25257 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
25258 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
25268 /* The following macros are only called from draw_glyphs below.
25269 They reference the following parameters of that function directly:
25270 `w', `row', `area', and `overlap_p'
25271 as well as the following local variables:
25272 `s', `f', and `hdc' (in W32) */
25275 /* On W32, silently add local `hdc' variable to argument list of
25276 init_glyph_string. */
25277 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
25278 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
25280 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
25281 init_glyph_string (s, char2b, w, row, area, start, hl)
25284 /* Add a glyph string for a stretch glyph to the list of strings
25285 between HEAD and TAIL. START is the index of the stretch glyph in
25286 row area AREA of glyph row ROW. END is the index of the last glyph
25287 in that glyph row area. X is the current output position assigned
25288 to the new glyph string constructed. HL overrides that face of the
25289 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25290 is the right-most x-position of the drawing area. */
25292 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
25293 and below -- keep them on one line. */
25294 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25297 s = alloca (sizeof *s); \
25298 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25299 START = fill_stretch_glyph_string (s, START, END); \
25300 append_glyph_string (&HEAD, &TAIL, s); \
25306 /* Add a glyph string for an image glyph to the list of strings
25307 between HEAD and TAIL. START is the index of the image glyph in
25308 row area AREA of glyph row ROW. END is the index of the last glyph
25309 in that glyph row area. X is the current output position assigned
25310 to the new glyph string constructed. HL overrides that face of the
25311 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25312 is the right-most x-position of the drawing area. */
25314 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25317 s = alloca (sizeof *s); \
25318 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25319 fill_image_glyph_string (s); \
25320 append_glyph_string (&HEAD, &TAIL, s); \
25326 #ifndef HAVE_XWIDGETS
25327 # define BUILD_XWIDGET_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25330 # define BUILD_XWIDGET_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25333 s = alloca (sizeof *s); \
25334 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25335 fill_xwidget_glyph_string (s); \
25336 append_glyph_string (&(HEAD), &(TAIL), s); \
25343 /* Add a glyph string for a sequence of character glyphs to the list
25344 of strings between HEAD and TAIL. START is the index of the first
25345 glyph in row area AREA of glyph row ROW that is part of the new
25346 glyph string. END is the index of the last glyph in that glyph row
25347 area. X is the current output position assigned to the new glyph
25348 string constructed. HL overrides that face of the glyph; e.g. it
25349 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
25350 right-most x-position of the drawing area. */
25352 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25358 face_id = (row)->glyphs[area][START].face_id; \
25360 s = alloca (sizeof *s); \
25361 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
25362 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25363 append_glyph_string (&HEAD, &TAIL, s); \
25365 START = fill_glyph_string (s, face_id, START, END, overlaps); \
25370 /* Add a glyph string for a composite sequence to the list of strings
25371 between HEAD and TAIL. START is the index of the first glyph in
25372 row area AREA of glyph row ROW that is part of the new glyph
25373 string. END is the index of the last glyph in that glyph row area.
25374 X is the current output position assigned to the new glyph string
25375 constructed. HL overrides that face of the glyph; e.g. it is
25376 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
25377 x-position of the drawing area. */
25379 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25381 int face_id = (row)->glyphs[area][START].face_id; \
25382 struct face *base_face = FACE_FROM_ID (f, face_id); \
25383 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
25384 struct composition *cmp = composition_table[cmp_id]; \
25386 struct glyph_string *first_s = NULL; \
25389 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
25391 /* Make glyph_strings for each glyph sequence that is drawable by \
25392 the same face, and append them to HEAD/TAIL. */ \
25393 for (n = 0; n < cmp->glyph_len;) \
25395 s = alloca (sizeof *s); \
25396 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25397 append_glyph_string (&(HEAD), &(TAIL), s); \
25403 n = fill_composite_glyph_string (s, base_face, overlaps); \
25411 /* Add a glyph string for a glyph-string sequence to the list of strings
25412 between HEAD and TAIL. */
25414 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25418 Lisp_Object gstring; \
25420 face_id = (row)->glyphs[area][START].face_id; \
25421 gstring = (composition_gstring_from_id \
25422 ((row)->glyphs[area][START].u.cmp.id)); \
25423 s = alloca (sizeof *s); \
25424 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
25425 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25426 append_glyph_string (&(HEAD), &(TAIL), s); \
25428 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
25432 /* Add a glyph string for a sequence of glyphless character's glyphs
25433 to the list of strings between HEAD and TAIL. The meanings of
25434 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
25436 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25441 face_id = (row)->glyphs[area][START].face_id; \
25443 s = alloca (sizeof *s); \
25444 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25445 append_glyph_string (&HEAD, &TAIL, s); \
25447 START = fill_glyphless_glyph_string (s, face_id, START, END, \
25453 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
25454 of AREA of glyph row ROW on window W between indices START and END.
25455 HL overrides the face for drawing glyph strings, e.g. it is
25456 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
25457 x-positions of the drawing area.
25459 This is an ugly monster macro construct because we must use alloca
25460 to allocate glyph strings (because draw_glyphs can be called
25461 asynchronously). */
25463 #define BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25466 HEAD = TAIL = NULL; \
25467 while (START < END) \
25469 struct glyph *first_glyph = (row)->glyphs[area] + START; \
25470 switch (first_glyph->type) \
25473 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
25477 case COMPOSITE_GLYPH: \
25478 if (first_glyph->u.cmp.automatic) \
25479 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
25482 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
25486 case STRETCH_GLYPH: \
25487 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
25491 case IMAGE_GLYPH: \
25492 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
25496 #define BUILD_GLYPH_STRINGS_XW(START, END, HEAD, TAIL, HL, X, LAST_X) \
25497 case XWIDGET_GLYPH: \
25498 BUILD_XWIDGET_GLYPH_STRING (START, END, HEAD, TAIL, \
25502 #define BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X) \
25503 case GLYPHLESS_GLYPH: \
25504 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
25514 set_glyph_string_background_width (s, START, LAST_X); \
25521 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25522 BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25523 BUILD_GLYPH_STRINGS_XW(START, END, HEAD, TAIL, HL, X, LAST_X) \
25524 BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X)
25527 /* Draw glyphs between START and END in AREA of ROW on window W,
25528 starting at x-position X. X is relative to AREA in W. HL is a
25529 face-override with the following meaning:
25531 DRAW_NORMAL_TEXT draw normally
25532 DRAW_CURSOR draw in cursor face
25533 DRAW_MOUSE_FACE draw in mouse face.
25534 DRAW_INVERSE_VIDEO draw in mode line face
25535 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
25536 DRAW_IMAGE_RAISED draw an image with a raised relief around it
25538 If OVERLAPS is non-zero, draw only the foreground of characters and
25539 clip to the physical height of ROW. Non-zero value also defines
25540 the overlapping part to be drawn:
25542 OVERLAPS_PRED overlap with preceding rows
25543 OVERLAPS_SUCC overlap with succeeding rows
25544 OVERLAPS_BOTH overlap with both preceding/succeeding rows
25545 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
25547 Value is the x-position reached, relative to AREA of W. */
25550 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
25551 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
25552 enum draw_glyphs_face hl
, int overlaps
)
25554 struct glyph_string
*head
, *tail
;
25555 struct glyph_string
*s
;
25556 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
25557 int i
, j
, x_reached
, last_x
, area_left
= 0;
25558 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25561 ALLOCATE_HDC (hdc
, f
);
25563 /* Let's rather be paranoid than getting a SEGV. */
25564 end
= min (end
, row
->used
[area
]);
25565 start
= clip_to_bounds (0, start
, end
);
25567 /* Translate X to frame coordinates. Set last_x to the right
25568 end of the drawing area. */
25569 if (row
->full_width_p
)
25571 /* X is relative to the left edge of W, without scroll bars
25573 area_left
= WINDOW_LEFT_EDGE_X (w
);
25574 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
25575 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
25579 area_left
= window_box_left (w
, area
);
25580 last_x
= area_left
+ window_box_width (w
, area
);
25584 /* Build a doubly-linked list of glyph_string structures between
25585 head and tail from what we have to draw. Note that the macro
25586 BUILD_GLYPH_STRINGS will modify its start parameter. That's
25587 the reason we use a separate variable `i'. */
25590 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
25592 x_reached
= tail
->x
+ tail
->background_width
;
25596 /* If there are any glyphs with lbearing < 0 or rbearing > width in
25597 the row, redraw some glyphs in front or following the glyph
25598 strings built above. */
25599 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
25601 struct glyph_string
*h
, *t
;
25602 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25603 int mouse_beg_col UNINIT
, mouse_end_col UNINIT
;
25604 bool check_mouse_face
= false;
25607 /* If mouse highlighting is on, we may need to draw adjacent
25608 glyphs using mouse-face highlighting. */
25609 if (area
== TEXT_AREA
&& row
->mouse_face_p
25610 && hlinfo
->mouse_face_beg_row
>= 0
25611 && hlinfo
->mouse_face_end_row
>= 0)
25613 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
25615 if (row_vpos
>= hlinfo
->mouse_face_beg_row
25616 && row_vpos
<= hlinfo
->mouse_face_end_row
)
25618 check_mouse_face
= true;
25619 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
25620 ? hlinfo
->mouse_face_beg_col
: 0;
25621 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
25622 ? hlinfo
->mouse_face_end_col
25623 : row
->used
[TEXT_AREA
];
25627 /* Compute overhangs for all glyph strings. */
25628 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
25629 for (s
= head
; s
; s
= s
->next
)
25630 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
25632 /* Prepend glyph strings for glyphs in front of the first glyph
25633 string that are overwritten because of the first glyph
25634 string's left overhang. The background of all strings
25635 prepended must be drawn because the first glyph string
25637 i
= left_overwritten (head
);
25640 enum draw_glyphs_face overlap_hl
;
25642 /* If this row contains mouse highlighting, attempt to draw
25643 the overlapped glyphs with the correct highlight. This
25644 code fails if the overlap encompasses more than one glyph
25645 and mouse-highlight spans only some of these glyphs.
25646 However, making it work perfectly involves a lot more
25647 code, and I don't know if the pathological case occurs in
25648 practice, so we'll stick to this for now. --- cyd */
25649 if (check_mouse_face
25650 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25651 overlap_hl
= DRAW_MOUSE_FACE
;
25653 overlap_hl
= DRAW_NORMAL_TEXT
;
25655 if (hl
!= overlap_hl
)
25658 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
25659 overlap_hl
, dummy_x
, last_x
);
25661 compute_overhangs_and_x (t
, head
->x
, true);
25662 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25663 if (clip_head
== NULL
)
25667 /* Prepend glyph strings for glyphs in front of the first glyph
25668 string that overwrite that glyph string because of their
25669 right overhang. For these strings, only the foreground must
25670 be drawn, because it draws over the glyph string at `head'.
25671 The background must not be drawn because this would overwrite
25672 right overhangs of preceding glyphs for which no glyph
25674 i
= left_overwriting (head
);
25677 enum draw_glyphs_face overlap_hl
;
25679 if (check_mouse_face
25680 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25681 overlap_hl
= DRAW_MOUSE_FACE
;
25683 overlap_hl
= DRAW_NORMAL_TEXT
;
25685 if (hl
== overlap_hl
|| clip_head
== NULL
)
25687 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
25688 overlap_hl
, dummy_x
, last_x
);
25689 for (s
= h
; s
; s
= s
->next
)
25690 s
->background_filled_p
= true;
25691 compute_overhangs_and_x (t
, head
->x
, true);
25692 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25695 /* Append glyphs strings for glyphs following the last glyph
25696 string tail that are overwritten by tail. The background of
25697 these strings has to be drawn because tail's foreground draws
25699 i
= right_overwritten (tail
);
25702 enum draw_glyphs_face overlap_hl
;
25704 if (check_mouse_face
25705 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25706 overlap_hl
= DRAW_MOUSE_FACE
;
25708 overlap_hl
= DRAW_NORMAL_TEXT
;
25710 if (hl
!= overlap_hl
)
25712 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25713 overlap_hl
, x
, last_x
);
25714 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25715 we don't have `end = i;' here. */
25716 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25717 append_glyph_string_lists (&head
, &tail
, h
, t
);
25718 if (clip_tail
== NULL
)
25722 /* Append glyph strings for glyphs following the last glyph
25723 string tail that overwrite tail. The foreground of such
25724 glyphs has to be drawn because it writes into the background
25725 of tail. The background must not be drawn because it could
25726 paint over the foreground of following glyphs. */
25727 i
= right_overwriting (tail
);
25730 enum draw_glyphs_face overlap_hl
;
25731 if (check_mouse_face
25732 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25733 overlap_hl
= DRAW_MOUSE_FACE
;
25735 overlap_hl
= DRAW_NORMAL_TEXT
;
25737 if (hl
== overlap_hl
|| clip_tail
== NULL
)
25739 i
++; /* We must include the Ith glyph. */
25740 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25741 overlap_hl
, x
, last_x
);
25742 for (s
= h
; s
; s
= s
->next
)
25743 s
->background_filled_p
= true;
25744 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25745 append_glyph_string_lists (&head
, &tail
, h
, t
);
25747 if (clip_head
|| clip_tail
)
25748 for (s
= head
; s
; s
= s
->next
)
25750 s
->clip_head
= clip_head
;
25751 s
->clip_tail
= clip_tail
;
25755 /* Draw all strings. */
25756 for (s
= head
; s
; s
= s
->next
)
25757 FRAME_RIF (f
)->draw_glyph_string (s
);
25760 /* When focus a sole frame and move horizontally, this clears on_p
25761 causing a failure to erase prev cursor position. */
25762 if (area
== TEXT_AREA
25763 && !row
->full_width_p
25764 /* When drawing overlapping rows, only the glyph strings'
25765 foreground is drawn, which doesn't erase a cursor
25769 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25770 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25771 : (tail
? tail
->x
+ tail
->background_width
: x
));
25775 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25776 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25780 /* Value is the x-position up to which drawn, relative to AREA of W.
25781 This doesn't include parts drawn because of overhangs. */
25782 if (row
->full_width_p
)
25783 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25785 x_reached
-= area_left
;
25787 RELEASE_HDC (hdc
, f
);
25793 /* Expand row matrix if too narrow. Don't expand if area
25796 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25798 if (!it->f->fonts_changed \
25799 && (it->glyph_row->glyphs[area] \
25800 < it->glyph_row->glyphs[area + 1])) \
25802 it->w->ncols_scale_factor++; \
25803 it->f->fonts_changed = true; \
25807 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25808 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25811 append_glyph (struct it
*it
)
25813 struct glyph
*glyph
;
25814 enum glyph_row_area area
= it
->area
;
25816 eassert (it
->glyph_row
);
25817 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25819 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25820 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25822 /* If the glyph row is reversed, we need to prepend the glyph
25823 rather than append it. */
25824 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25828 /* Make room for the additional glyph. */
25829 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25831 glyph
= it
->glyph_row
->glyphs
[area
];
25833 glyph
->charpos
= CHARPOS (it
->position
);
25834 glyph
->object
= it
->object
;
25835 if (it
->pixel_width
> 0)
25837 eassert (it
->pixel_width
<= SHRT_MAX
);
25838 glyph
->pixel_width
= it
->pixel_width
;
25839 glyph
->padding_p
= false;
25843 /* Assure at least 1-pixel width. Otherwise, cursor can't
25844 be displayed correctly. */
25845 glyph
->pixel_width
= 1;
25846 glyph
->padding_p
= true;
25848 glyph
->ascent
= it
->ascent
;
25849 glyph
->descent
= it
->descent
;
25850 glyph
->voffset
= it
->voffset
;
25851 glyph
->type
= CHAR_GLYPH
;
25852 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25853 glyph
->multibyte_p
= it
->multibyte_p
;
25854 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25856 /* In R2L rows, the left and the right box edges need to be
25857 drawn in reverse direction. */
25858 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25859 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25863 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25864 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25866 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25867 || it
->phys_descent
> it
->descent
);
25868 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25869 glyph
->face_id
= it
->face_id
;
25870 glyph
->u
.ch
= it
->char_to_display
;
25871 glyph
->slice
.img
= null_glyph_slice
;
25872 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25875 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25876 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25877 glyph
->bidi_type
= it
->bidi_it
.type
;
25881 glyph
->resolved_level
= 0;
25882 glyph
->bidi_type
= UNKNOWN_BT
;
25884 ++it
->glyph_row
->used
[area
];
25887 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25890 /* Store one glyph for the composition IT->cmp_it.id in
25891 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25895 append_composite_glyph (struct it
*it
)
25897 struct glyph
*glyph
;
25898 enum glyph_row_area area
= it
->area
;
25900 eassert (it
->glyph_row
);
25902 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25903 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25905 /* If the glyph row is reversed, we need to prepend the glyph
25906 rather than append it. */
25907 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25911 /* Make room for the new glyph. */
25912 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25914 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25916 glyph
->charpos
= it
->cmp_it
.charpos
;
25917 glyph
->object
= it
->object
;
25918 eassert (it
->pixel_width
<= SHRT_MAX
);
25919 glyph
->pixel_width
= it
->pixel_width
;
25920 glyph
->ascent
= it
->ascent
;
25921 glyph
->descent
= it
->descent
;
25922 glyph
->voffset
= it
->voffset
;
25923 glyph
->type
= COMPOSITE_GLYPH
;
25924 if (it
->cmp_it
.ch
< 0)
25926 glyph
->u
.cmp
.automatic
= false;
25927 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25928 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25932 glyph
->u
.cmp
.automatic
= true;
25933 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25934 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25935 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25937 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25938 glyph
->multibyte_p
= it
->multibyte_p
;
25939 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25941 /* In R2L rows, the left and the right box edges need to be
25942 drawn in reverse direction. */
25943 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25944 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25948 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25949 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25951 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25952 || it
->phys_descent
> it
->descent
);
25953 glyph
->padding_p
= false;
25954 glyph
->glyph_not_available_p
= false;
25955 glyph
->face_id
= it
->face_id
;
25956 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25959 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25960 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25961 glyph
->bidi_type
= it
->bidi_it
.type
;
25963 ++it
->glyph_row
->used
[area
];
25966 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25970 /* Change IT->ascent and IT->height according to the setting of
25974 take_vertical_position_into_account (struct it
*it
)
25978 if (it
->voffset
< 0)
25979 /* Increase the ascent so that we can display the text higher
25981 it
->ascent
-= it
->voffset
;
25983 /* Increase the descent so that we can display the text lower
25985 it
->descent
+= it
->voffset
;
25990 /* Produce glyphs/get display metrics for the image IT is loaded with.
25991 See the description of struct display_iterator in dispextern.h for
25992 an overview of struct display_iterator. */
25995 produce_image_glyph (struct it
*it
)
25999 int glyph_ascent
, crop
;
26000 struct glyph_slice slice
;
26002 eassert (it
->what
== IT_IMAGE
);
26004 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26005 /* Make sure X resources of the face is loaded. */
26006 prepare_face_for_display (it
->f
, face
);
26008 if (it
->image_id
< 0)
26010 /* Fringe bitmap. */
26011 it
->ascent
= it
->phys_ascent
= 0;
26012 it
->descent
= it
->phys_descent
= 0;
26013 it
->pixel_width
= 0;
26018 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
26019 /* Make sure X resources of the image is loaded. */
26020 prepare_image_for_display (it
->f
, img
);
26022 slice
.x
= slice
.y
= 0;
26023 slice
.width
= img
->width
;
26024 slice
.height
= img
->height
;
26026 if (INTEGERP (it
->slice
.x
))
26027 slice
.x
= XINT (it
->slice
.x
);
26028 else if (FLOATP (it
->slice
.x
))
26029 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
26031 if (INTEGERP (it
->slice
.y
))
26032 slice
.y
= XINT (it
->slice
.y
);
26033 else if (FLOATP (it
->slice
.y
))
26034 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
26036 if (INTEGERP (it
->slice
.width
))
26037 slice
.width
= XINT (it
->slice
.width
);
26038 else if (FLOATP (it
->slice
.width
))
26039 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
26041 if (INTEGERP (it
->slice
.height
))
26042 slice
.height
= XINT (it
->slice
.height
);
26043 else if (FLOATP (it
->slice
.height
))
26044 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
26046 if (slice
.x
>= img
->width
)
26047 slice
.x
= img
->width
;
26048 if (slice
.y
>= img
->height
)
26049 slice
.y
= img
->height
;
26050 if (slice
.x
+ slice
.width
>= img
->width
)
26051 slice
.width
= img
->width
- slice
.x
;
26052 if (slice
.y
+ slice
.height
> img
->height
)
26053 slice
.height
= img
->height
- slice
.y
;
26055 if (slice
.width
== 0 || slice
.height
== 0)
26058 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
26060 it
->descent
= slice
.height
- glyph_ascent
;
26062 it
->descent
+= img
->vmargin
;
26063 if (slice
.y
+ slice
.height
== img
->height
)
26064 it
->descent
+= img
->vmargin
;
26065 it
->phys_descent
= it
->descent
;
26067 it
->pixel_width
= slice
.width
;
26069 it
->pixel_width
+= img
->hmargin
;
26070 if (slice
.x
+ slice
.width
== img
->width
)
26071 it
->pixel_width
+= img
->hmargin
;
26073 /* It's quite possible for images to have an ascent greater than
26074 their height, so don't get confused in that case. */
26075 if (it
->descent
< 0)
26080 if (face
->box
!= FACE_NO_BOX
)
26082 if (face
->box_line_width
> 0)
26085 it
->ascent
+= face
->box_line_width
;
26086 if (slice
.y
+ slice
.height
== img
->height
)
26087 it
->descent
+= face
->box_line_width
;
26090 if (it
->start_of_box_run_p
&& slice
.x
== 0)
26091 it
->pixel_width
+= eabs (face
->box_line_width
);
26092 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
26093 it
->pixel_width
+= eabs (face
->box_line_width
);
26096 take_vertical_position_into_account (it
);
26098 /* Automatically crop wide image glyphs at right edge so we can
26099 draw the cursor on same display row. */
26100 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
26101 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
26103 it
->pixel_width
-= crop
;
26104 slice
.width
-= crop
;
26109 struct glyph
*glyph
;
26110 enum glyph_row_area area
= it
->area
;
26112 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26113 if (it
->glyph_row
->reversed_p
)
26117 /* Make room for the new glyph. */
26118 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
26120 glyph
= it
->glyph_row
->glyphs
[it
->area
];
26122 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26124 glyph
->charpos
= CHARPOS (it
->position
);
26125 glyph
->object
= it
->object
;
26126 glyph
->pixel_width
= clip_to_bounds (-1, it
->pixel_width
, SHRT_MAX
);
26127 glyph
->ascent
= glyph_ascent
;
26128 glyph
->descent
= it
->descent
;
26129 glyph
->voffset
= it
->voffset
;
26130 glyph
->type
= IMAGE_GLYPH
;
26131 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26132 glyph
->multibyte_p
= it
->multibyte_p
;
26133 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26135 /* In R2L rows, the left and the right box edges need to be
26136 drawn in reverse direction. */
26137 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26138 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26142 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26143 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26145 glyph
->overlaps_vertically_p
= false;
26146 glyph
->padding_p
= false;
26147 glyph
->glyph_not_available_p
= false;
26148 glyph
->face_id
= it
->face_id
;
26149 glyph
->u
.img_id
= img
->id
;
26150 glyph
->slice
.img
= slice
;
26151 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26154 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26155 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26156 glyph
->bidi_type
= it
->bidi_it
.type
;
26158 ++it
->glyph_row
->used
[area
];
26161 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26166 produce_xwidget_glyph (struct it
*it
)
26168 #ifdef HAVE_XWIDGETS
26169 struct xwidget
*xw
;
26170 int glyph_ascent
, crop
;
26171 eassert (it
->what
== IT_XWIDGET
);
26173 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26174 /* Make sure X resources of the face is loaded. */
26175 prepare_face_for_display (it
->f
, face
);
26178 it
->ascent
= it
->phys_ascent
= glyph_ascent
= xw
->height
/2;
26179 it
->descent
= xw
->height
/2;
26180 it
->phys_descent
= it
->descent
;
26181 it
->pixel_width
= xw
->width
;
26182 /* It's quite possible for images to have an ascent greater than
26183 their height, so don't get confused in that case. */
26184 if (it
->descent
< 0)
26189 if (face
->box
!= FACE_NO_BOX
)
26191 if (face
->box_line_width
> 0)
26193 it
->ascent
+= face
->box_line_width
;
26194 it
->descent
+= face
->box_line_width
;
26197 if (it
->start_of_box_run_p
)
26198 it
->pixel_width
+= eabs (face
->box_line_width
);
26199 it
->pixel_width
+= eabs (face
->box_line_width
);
26202 take_vertical_position_into_account (it
);
26204 /* Automatically crop wide image glyphs at right edge so we can
26205 draw the cursor on same display row. */
26206 crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
);
26207 if (crop
> 0 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
26208 it
->pixel_width
-= crop
;
26212 enum glyph_row_area area
= it
->area
;
26213 struct glyph
*glyph
26214 = it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26216 if (it
->glyph_row
->reversed_p
)
26220 /* Make room for the new glyph. */
26221 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
26223 glyph
= it
->glyph_row
->glyphs
[it
->area
];
26225 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26227 glyph
->charpos
= CHARPOS (it
->position
);
26228 glyph
->object
= it
->object
;
26229 glyph
->pixel_width
= clip_to_bounds (-1, it
->pixel_width
, SHRT_MAX
);
26230 glyph
->ascent
= glyph_ascent
;
26231 glyph
->descent
= it
->descent
;
26232 glyph
->voffset
= it
->voffset
;
26233 glyph
->type
= XWIDGET_GLYPH
;
26234 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26235 glyph
->multibyte_p
= it
->multibyte_p
;
26236 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26238 /* In R2L rows, the left and the right box edges need to be
26239 drawn in reverse direction. */
26240 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26241 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26245 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26246 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26248 glyph
->overlaps_vertically_p
= 0;
26249 glyph
->padding_p
= 0;
26250 glyph
->glyph_not_available_p
= 0;
26251 glyph
->face_id
= it
->face_id
;
26252 glyph
->u
.xwidget
= it
->xwidget
;
26253 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26256 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26257 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26258 glyph
->bidi_type
= it
->bidi_it
.type
;
26260 ++it
->glyph_row
->used
[area
];
26263 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26268 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
26269 of the glyph, WIDTH and HEIGHT are the width and height of the
26270 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
26273 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
26274 int width
, int height
, int ascent
)
26276 struct glyph
*glyph
;
26277 enum glyph_row_area area
= it
->area
;
26279 eassert (ascent
>= 0 && ascent
<= height
);
26281 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26282 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26284 /* If the glyph row is reversed, we need to prepend the glyph
26285 rather than append it. */
26286 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26290 /* Make room for the additional glyph. */
26291 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26293 glyph
= it
->glyph_row
->glyphs
[area
];
26295 /* Decrease the width of the first glyph of the row that
26296 begins before first_visible_x (e.g., due to hscroll).
26297 This is so the overall width of the row becomes smaller
26298 by the scroll amount, and the stretch glyph appended by
26299 extend_face_to_end_of_line will be wider, to shift the
26300 row glyphs to the right. (In L2R rows, the corresponding
26301 left-shift effect is accomplished by setting row->x to a
26302 negative value, which won't work with R2L rows.)
26304 This must leave us with a positive value of WIDTH, since
26305 otherwise the call to move_it_in_display_line_to at the
26306 beginning of display_line would have got past the entire
26307 first glyph, and then it->current_x would have been
26308 greater or equal to it->first_visible_x. */
26309 if (it
->current_x
< it
->first_visible_x
)
26310 width
-= it
->first_visible_x
- it
->current_x
;
26311 eassert (width
> 0);
26313 glyph
->charpos
= CHARPOS (it
->position
);
26314 glyph
->object
= object
;
26315 /* FIXME: It would be better to use TYPE_MAX here, but
26316 __typeof__ is not portable enough... */
26317 glyph
->pixel_width
= clip_to_bounds (-1, width
, SHRT_MAX
);
26318 glyph
->ascent
= ascent
;
26319 glyph
->descent
= height
- ascent
;
26320 glyph
->voffset
= it
->voffset
;
26321 glyph
->type
= STRETCH_GLYPH
;
26322 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26323 glyph
->multibyte_p
= it
->multibyte_p
;
26324 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26326 /* In R2L rows, the left and the right box edges need to be
26327 drawn in reverse direction. */
26328 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26329 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26333 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26334 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26336 glyph
->overlaps_vertically_p
= false;
26337 glyph
->padding_p
= false;
26338 glyph
->glyph_not_available_p
= false;
26339 glyph
->face_id
= it
->face_id
;
26340 glyph
->u
.stretch
.ascent
= ascent
;
26341 glyph
->u
.stretch
.height
= height
;
26342 glyph
->slice
.img
= null_glyph_slice
;
26343 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26346 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26347 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26348 glyph
->bidi_type
= it
->bidi_it
.type
;
26352 glyph
->resolved_level
= 0;
26353 glyph
->bidi_type
= UNKNOWN_BT
;
26355 ++it
->glyph_row
->used
[area
];
26358 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26361 #endif /* HAVE_WINDOW_SYSTEM */
26363 /* Produce a stretch glyph for iterator IT. IT->object is the value
26364 of the glyph property displayed. The value must be a list
26365 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
26368 1. `:width WIDTH' specifies that the space should be WIDTH *
26369 canonical char width wide. WIDTH may be an integer or floating
26372 2. `:relative-width FACTOR' specifies that the width of the stretch
26373 should be computed from the width of the first character having the
26374 `glyph' property, and should be FACTOR times that width.
26376 3. `:align-to HPOS' specifies that the space should be wide enough
26377 to reach HPOS, a value in canonical character units.
26379 Exactly one of the above pairs must be present.
26381 4. `:height HEIGHT' specifies that the height of the stretch produced
26382 should be HEIGHT, measured in canonical character units.
26384 5. `:relative-height FACTOR' specifies that the height of the
26385 stretch should be FACTOR times the height of the characters having
26386 the glyph property.
26388 Either none or exactly one of 4 or 5 must be present.
26390 6. `:ascent ASCENT' specifies that ASCENT percent of the height
26391 of the stretch should be used for the ascent of the stretch.
26392 ASCENT must be in the range 0 <= ASCENT <= 100. */
26395 produce_stretch_glyph (struct it
*it
)
26397 /* (space :width WIDTH :height HEIGHT ...) */
26398 Lisp_Object prop
, plist
;
26399 int width
= 0, height
= 0, align_to
= -1;
26400 bool zero_width_ok_p
= false;
26402 struct font
*font
= NULL
;
26404 #ifdef HAVE_WINDOW_SYSTEM
26406 bool zero_height_ok_p
= false;
26408 if (FRAME_WINDOW_P (it
->f
))
26410 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26411 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26412 prepare_face_for_display (it
->f
, face
);
26416 /* List should start with `space'. */
26417 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
26418 plist
= XCDR (it
->object
);
26420 /* Compute the width of the stretch. */
26421 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
26422 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true, 0))
26424 /* Absolute width `:width WIDTH' specified and valid. */
26425 zero_width_ok_p
= true;
26428 else if (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0)
26430 /* Relative width `:relative-width FACTOR' specified and valid.
26431 Compute the width of the characters having the `glyph'
26434 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
26437 if (it
->multibyte_p
)
26438 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
26441 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
26442 if (! ASCII_CHAR_P (it2
.c
))
26443 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
26446 it2
.glyph_row
= NULL
;
26447 it2
.what
= IT_CHARACTER
;
26448 PRODUCE_GLYPHS (&it2
);
26449 width
= NUMVAL (prop
) * it2
.pixel_width
;
26451 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
26452 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true,
26455 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
26456 align_to
= (align_to
< 0
26458 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
26459 else if (align_to
< 0)
26460 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
26461 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
26462 zero_width_ok_p
= true;
26465 /* Nothing specified -> width defaults to canonical char width. */
26466 width
= FRAME_COLUMN_WIDTH (it
->f
);
26468 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
26471 #ifdef HAVE_WINDOW_SYSTEM
26472 /* Compute height. */
26473 if (FRAME_WINDOW_P (it
->f
))
26475 int default_height
= normal_char_height (font
, ' ');
26477 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
26478 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26481 zero_height_ok_p
= true;
26483 else if (prop
= Fplist_get (plist
, QCrelative_height
),
26485 height
= default_height
* NUMVAL (prop
);
26487 height
= default_height
;
26489 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
26492 /* Compute percentage of height used for ascent. If
26493 `:ascent ASCENT' is present and valid, use that. Otherwise,
26494 derive the ascent from the font in use. */
26495 if (prop
= Fplist_get (plist
, QCascent
),
26496 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
26497 ascent
= height
* NUMVAL (prop
) / 100.0;
26498 else if (!NILP (prop
)
26499 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26500 ascent
= min (max (0, (int)tem
), height
);
26502 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
26505 #endif /* HAVE_WINDOW_SYSTEM */
26508 if (width
> 0 && it
->line_wrap
!= TRUNCATE
26509 && it
->current_x
+ width
> it
->last_visible_x
)
26511 width
= it
->last_visible_x
- it
->current_x
;
26512 #ifdef HAVE_WINDOW_SYSTEM
26513 /* Subtract one more pixel from the stretch width, but only on
26514 GUI frames, since on a TTY each glyph is one "pixel" wide. */
26515 width
-= FRAME_WINDOW_P (it
->f
);
26519 if (width
> 0 && height
> 0 && it
->glyph_row
)
26521 Lisp_Object o_object
= it
->object
;
26522 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
26525 if (!STRINGP (object
))
26526 object
= it
->w
->contents
;
26527 #ifdef HAVE_WINDOW_SYSTEM
26528 if (FRAME_WINDOW_P (it
->f
))
26529 append_stretch_glyph (it
, object
, width
, height
, ascent
);
26533 it
->object
= object
;
26534 it
->char_to_display
= ' ';
26535 it
->pixel_width
= it
->len
= 1;
26537 tty_append_glyph (it
);
26538 it
->object
= o_object
;
26542 it
->pixel_width
= width
;
26543 #ifdef HAVE_WINDOW_SYSTEM
26544 if (FRAME_WINDOW_P (it
->f
))
26546 it
->ascent
= it
->phys_ascent
= ascent
;
26547 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
26548 it
->nglyphs
= width
> 0 && height
> 0;
26549 take_vertical_position_into_account (it
);
26553 it
->nglyphs
= width
;
26556 /* Get information about special display element WHAT in an
26557 environment described by IT. WHAT is one of IT_TRUNCATION or
26558 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
26559 non-null glyph_row member. This function ensures that fields like
26560 face_id, c, len of IT are left untouched. */
26563 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
26570 temp_it
.object
= Qnil
;
26571 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
26573 if (what
== IT_CONTINUATION
)
26575 /* Continuation glyph. For R2L lines, we mirror it by hand. */
26576 if (it
->bidi_it
.paragraph_dir
== R2L
)
26577 SET_GLYPH_FROM_CHAR (glyph
, '/');
26579 SET_GLYPH_FROM_CHAR (glyph
, '\\');
26581 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26583 /* FIXME: Should we mirror GC for R2L lines? */
26584 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26585 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26588 else if (what
== IT_TRUNCATION
)
26590 /* Truncation glyph. */
26591 SET_GLYPH_FROM_CHAR (glyph
, '$');
26593 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26595 /* FIXME: Should we mirror GC for R2L lines? */
26596 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26597 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26603 #ifdef HAVE_WINDOW_SYSTEM
26604 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
26605 is turned off, we precede the truncation/continuation glyphs by a
26606 stretch glyph whose width is computed such that these special
26607 glyphs are aligned at the window margin, even when very different
26608 fonts are used in different glyph rows. */
26609 if (FRAME_WINDOW_P (temp_it
.f
)
26610 /* init_iterator calls this with it->glyph_row == NULL, and it
26611 wants only the pixel width of the truncation/continuation
26613 && temp_it
.glyph_row
26614 /* insert_left_trunc_glyphs calls us at the beginning of the
26615 row, and it has its own calculation of the stretch glyph
26617 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
26618 && (temp_it
.glyph_row
->reversed_p
26619 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
26620 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
26622 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
26624 if (stretch_width
> 0)
26626 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
26627 struct font
*font
=
26628 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
26629 int stretch_ascent
=
26630 (((temp_it
.ascent
+ temp_it
.descent
)
26631 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
26633 append_stretch_glyph (&temp_it
, Qnil
, stretch_width
,
26634 temp_it
.ascent
+ temp_it
.descent
,
26641 temp_it
.what
= IT_CHARACTER
;
26642 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
26643 temp_it
.face_id
= GLYPH_FACE (glyph
);
26644 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
26646 PRODUCE_GLYPHS (&temp_it
);
26647 it
->pixel_width
= temp_it
.pixel_width
;
26648 it
->nglyphs
= temp_it
.nglyphs
;
26651 #ifdef HAVE_WINDOW_SYSTEM
26653 /* Calculate line-height and line-spacing properties.
26654 An integer value specifies explicit pixel value.
26655 A float value specifies relative value to current face height.
26656 A cons (float . face-name) specifies relative value to
26657 height of specified face font.
26659 Returns height in pixels, or nil. */
26662 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
26663 int boff
, bool override
)
26665 Lisp_Object face_name
= Qnil
;
26666 int ascent
, descent
, height
;
26668 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
26673 face_name
= XCAR (val
);
26675 if (!NUMBERP (val
))
26676 val
= make_number (1);
26677 if (NILP (face_name
))
26679 height
= it
->ascent
+ it
->descent
;
26684 if (NILP (face_name
))
26686 font
= FRAME_FONT (it
->f
);
26687 boff
= FRAME_BASELINE_OFFSET (it
->f
);
26689 else if (EQ (face_name
, Qt
))
26698 face_id
= lookup_named_face (it
->f
, face_name
, false);
26699 face
= FACE_FROM_ID_OR_NULL (it
->f
, face_id
);
26700 if (face
== NULL
|| ((font
= face
->font
) == NULL
))
26701 return make_number (-1);
26702 boff
= font
->baseline_offset
;
26703 if (font
->vertical_centering
)
26704 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26707 normal_char_ascent_descent (font
, -1, &ascent
, &descent
);
26711 it
->override_ascent
= ascent
;
26712 it
->override_descent
= descent
;
26713 it
->override_boff
= boff
;
26716 height
= ascent
+ descent
;
26720 height
= (int)(XFLOAT_DATA (val
) * height
);
26721 else if (INTEGERP (val
))
26722 height
*= XINT (val
);
26724 return make_number (height
);
26728 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
26729 is a face ID to be used for the glyph. FOR_NO_FONT is true if
26730 and only if this is for a character for which no font was found.
26732 If the display method (it->glyphless_method) is
26733 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
26734 length of the acronym or the hexadecimal string, UPPER_XOFF and
26735 UPPER_YOFF are pixel offsets for the upper part of the string,
26736 LOWER_XOFF and LOWER_YOFF are for the lower part.
26738 For the other display methods, LEN through LOWER_YOFF are zero. */
26741 append_glyphless_glyph (struct it
*it
, int face_id
, bool for_no_font
, int len
,
26742 short upper_xoff
, short upper_yoff
,
26743 short lower_xoff
, short lower_yoff
)
26745 struct glyph
*glyph
;
26746 enum glyph_row_area area
= it
->area
;
26748 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26749 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26751 /* If the glyph row is reversed, we need to prepend the glyph
26752 rather than append it. */
26753 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26757 /* Make room for the additional glyph. */
26758 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26760 glyph
= it
->glyph_row
->glyphs
[area
];
26762 glyph
->charpos
= CHARPOS (it
->position
);
26763 glyph
->object
= it
->object
;
26764 eassert (it
->pixel_width
<= SHRT_MAX
);
26765 glyph
->pixel_width
= it
->pixel_width
;
26766 glyph
->ascent
= it
->ascent
;
26767 glyph
->descent
= it
->descent
;
26768 glyph
->voffset
= it
->voffset
;
26769 glyph
->type
= GLYPHLESS_GLYPH
;
26770 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
26771 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
26772 glyph
->u
.glyphless
.len
= len
;
26773 glyph
->u
.glyphless
.ch
= it
->c
;
26774 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
26775 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
26776 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
26777 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
26778 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26779 glyph
->multibyte_p
= it
->multibyte_p
;
26780 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26782 /* In R2L rows, the left and the right box edges need to be
26783 drawn in reverse direction. */
26784 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26785 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26789 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26790 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26792 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
26793 || it
->phys_descent
> it
->descent
);
26794 glyph
->padding_p
= false;
26795 glyph
->glyph_not_available_p
= false;
26796 glyph
->face_id
= face_id
;
26797 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26800 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26801 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26802 glyph
->bidi_type
= it
->bidi_it
.type
;
26804 ++it
->glyph_row
->used
[area
];
26807 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26811 /* Produce a glyph for a glyphless character for iterator IT.
26812 IT->glyphless_method specifies which method to use for displaying
26813 the character. See the description of enum
26814 glyphless_display_method in dispextern.h for the detail.
26816 FOR_NO_FONT is true if and only if this is for a character for
26817 which no font was found. ACRONYM, if non-nil, is an acronym string
26818 for the character. */
26821 produce_glyphless_glyph (struct it
*it
, bool for_no_font
, Lisp_Object acronym
)
26826 int base_width
, base_height
, width
, height
;
26827 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26830 /* Get the metrics of the base font. We always refer to the current
26832 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26833 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26834 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
26835 it
->ascent
+= font
->baseline_offset
;
26836 it
->descent
-= font
->baseline_offset
;
26837 base_height
= it
->ascent
+ it
->descent
;
26838 base_width
= font
->average_width
;
26840 face_id
= merge_glyphless_glyph_face (it
);
26842 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26844 it
->pixel_width
= THIN_SPACE_WIDTH
;
26846 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26848 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26850 width
= CHAR_WIDTH (it
->c
);
26853 else if (width
> 4)
26855 it
->pixel_width
= base_width
* width
;
26857 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26863 unsigned int code
[6];
26865 int ascent
, descent
;
26866 struct font_metrics metrics_upper
, metrics_lower
;
26868 face
= FACE_FROM_ID (it
->f
, face_id
);
26869 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26870 prepare_face_for_display (it
->f
, face
);
26872 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26874 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26875 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26876 if (CONSP (acronym
))
26877 acronym
= XCAR (acronym
);
26878 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26882 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26883 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
+ 0u);
26886 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
26887 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26888 upper_len
= (len
+ 1) / 2;
26889 font
->driver
->text_extents (font
, code
, upper_len
,
26891 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26896 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26897 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26898 upper_xoff
= upper_yoff
= 2; /* the typical case */
26899 if (base_width
>= width
)
26901 /* Align the upper to the left, the lower to the right. */
26902 it
->pixel_width
= base_width
;
26903 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26907 /* Center the shorter one. */
26908 it
->pixel_width
= width
;
26909 if (metrics_upper
.width
>= metrics_lower
.width
)
26910 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26913 /* FIXME: This code doesn't look right. It formerly was
26914 missing the "lower_xoff = 0;", which couldn't have
26915 been right since it left lower_xoff uninitialized. */
26917 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26921 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26922 top, bottom, and between upper and lower strings. */
26923 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26924 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26925 /* Center vertically.
26926 H:base_height, D:base_descent
26927 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26929 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26930 descent = D - H/2 + h/2;
26931 lower_yoff = descent - 2 - ld;
26932 upper_yoff = lower_yoff - la - 1 - ud; */
26933 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26934 descent
= it
->descent
- (base_height
- height
) / 2;
26935 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26936 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26937 - metrics_upper
.descent
);
26938 /* Don't make the height shorter than the base height. */
26939 if (height
> base_height
)
26941 it
->ascent
= ascent
;
26942 it
->descent
= descent
;
26946 it
->phys_ascent
= it
->ascent
;
26947 it
->phys_descent
= it
->descent
;
26949 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26950 upper_xoff
, upper_yoff
,
26951 lower_xoff
, lower_yoff
);
26953 take_vertical_position_into_account (it
);
26958 Produce glyphs/get display metrics for the display element IT is
26959 loaded with. See the description of struct it in dispextern.h
26960 for an overview of struct it. */
26963 x_produce_glyphs (struct it
*it
)
26965 int extra_line_spacing
= it
->extra_line_spacing
;
26967 it
->glyph_not_available_p
= false;
26969 if (it
->what
== IT_CHARACTER
)
26972 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26973 struct font
*font
= face
->font
;
26974 struct font_metrics
*pcm
= NULL
;
26975 int boff
; /* Baseline offset. */
26979 /* When no suitable font is found, display this character by
26980 the method specified in the first extra slot of
26981 Vglyphless_char_display. */
26982 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26984 eassert (it
->what
== IT_GLYPHLESS
);
26985 produce_glyphless_glyph (it
, true,
26986 STRINGP (acronym
) ? acronym
: Qnil
);
26990 boff
= font
->baseline_offset
;
26991 if (font
->vertical_centering
)
26992 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26994 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26998 if (it
->override_ascent
>= 0)
27000 it
->ascent
= it
->override_ascent
;
27001 it
->descent
= it
->override_descent
;
27002 boff
= it
->override_boff
;
27006 it
->ascent
= FONT_BASE (font
) + boff
;
27007 it
->descent
= FONT_DESCENT (font
) - boff
;
27010 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
27012 pcm
= get_per_char_metric (font
, &char2b
);
27013 if (pcm
->width
== 0
27014 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
27020 it
->phys_ascent
= pcm
->ascent
+ boff
;
27021 it
->phys_descent
= pcm
->descent
- boff
;
27022 it
->pixel_width
= pcm
->width
;
27023 /* Don't use font-global values for ascent and descent
27024 if they result in an exceedingly large line height. */
27025 if (it
->override_ascent
< 0)
27027 if (FONT_TOO_HIGH (font
))
27029 it
->ascent
= it
->phys_ascent
;
27030 it
->descent
= it
->phys_descent
;
27031 /* These limitations are enforced by an
27032 assertion near the end of this function. */
27033 if (it
->ascent
< 0)
27035 if (it
->descent
< 0)
27042 it
->glyph_not_available_p
= true;
27043 it
->phys_ascent
= it
->ascent
;
27044 it
->phys_descent
= it
->descent
;
27045 it
->pixel_width
= font
->space_width
;
27048 if (it
->constrain_row_ascent_descent_p
)
27050 if (it
->descent
> it
->max_descent
)
27052 it
->ascent
+= it
->descent
- it
->max_descent
;
27053 it
->descent
= it
->max_descent
;
27055 if (it
->ascent
> it
->max_ascent
)
27057 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
27058 it
->ascent
= it
->max_ascent
;
27060 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
27061 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
27062 extra_line_spacing
= 0;
27065 /* If this is a space inside a region of text with
27066 `space-width' property, change its width. */
27068 = it
->char_to_display
== ' ' && !NILP (it
->space_width
);
27070 it
->pixel_width
*= XFLOATINT (it
->space_width
);
27072 /* If face has a box, add the box thickness to the character
27073 height. If character has a box line to the left and/or
27074 right, add the box line width to the character's width. */
27075 if (face
->box
!= FACE_NO_BOX
)
27077 int thick
= face
->box_line_width
;
27081 it
->ascent
+= thick
;
27082 it
->descent
+= thick
;
27087 if (it
->start_of_box_run_p
)
27088 it
->pixel_width
+= thick
;
27089 if (it
->end_of_box_run_p
)
27090 it
->pixel_width
+= thick
;
27093 /* If face has an overline, add the height of the overline
27094 (1 pixel) and a 1 pixel margin to the character height. */
27095 if (face
->overline_p
)
27096 it
->ascent
+= overline_margin
;
27098 if (it
->constrain_row_ascent_descent_p
)
27100 if (it
->ascent
> it
->max_ascent
)
27101 it
->ascent
= it
->max_ascent
;
27102 if (it
->descent
> it
->max_descent
)
27103 it
->descent
= it
->max_descent
;
27106 take_vertical_position_into_account (it
);
27108 /* If we have to actually produce glyphs, do it. */
27113 /* Translate a space with a `space-width' property
27114 into a stretch glyph. */
27115 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
27116 / FONT_HEIGHT (font
));
27117 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
27118 it
->ascent
+ it
->descent
, ascent
);
27123 /* If characters with lbearing or rbearing are displayed
27124 in this line, record that fact in a flag of the
27125 glyph row. This is used to optimize X output code. */
27126 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
27127 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27129 if (! stretched_p
&& it
->pixel_width
== 0)
27130 /* We assure that all visible glyphs have at least 1-pixel
27132 it
->pixel_width
= 1;
27134 else if (it
->char_to_display
== '\n')
27136 /* A newline has no width, but we need the height of the
27137 line. But if previous part of the line sets a height,
27138 don't increase that height. */
27140 Lisp_Object height
;
27141 Lisp_Object total_height
= Qnil
;
27143 it
->override_ascent
= -1;
27144 it
->pixel_width
= 0;
27147 height
= get_it_property (it
, Qline_height
);
27148 /* Split (line-height total-height) list. */
27150 && CONSP (XCDR (height
))
27151 && NILP (XCDR (XCDR (height
))))
27153 total_height
= XCAR (XCDR (height
));
27154 height
= XCAR (height
);
27156 height
= calc_line_height_property (it
, height
, font
, boff
, true);
27158 if (it
->override_ascent
>= 0)
27160 it
->ascent
= it
->override_ascent
;
27161 it
->descent
= it
->override_descent
;
27162 boff
= it
->override_boff
;
27166 if (FONT_TOO_HIGH (font
))
27168 it
->ascent
= font
->pixel_size
+ boff
- 1;
27169 it
->descent
= -boff
+ 1;
27170 if (it
->descent
< 0)
27175 it
->ascent
= FONT_BASE (font
) + boff
;
27176 it
->descent
= FONT_DESCENT (font
) - boff
;
27180 if (EQ (height
, Qt
))
27182 if (it
->descent
> it
->max_descent
)
27184 it
->ascent
+= it
->descent
- it
->max_descent
;
27185 it
->descent
= it
->max_descent
;
27187 if (it
->ascent
> it
->max_ascent
)
27189 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
27190 it
->ascent
= it
->max_ascent
;
27192 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
27193 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
27194 it
->constrain_row_ascent_descent_p
= true;
27195 extra_line_spacing
= 0;
27199 Lisp_Object spacing
;
27201 it
->phys_ascent
= it
->ascent
;
27202 it
->phys_descent
= it
->descent
;
27204 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
27205 && face
->box
!= FACE_NO_BOX
27206 && face
->box_line_width
> 0)
27208 it
->ascent
+= face
->box_line_width
;
27209 it
->descent
+= face
->box_line_width
;
27212 && XINT (height
) > it
->ascent
+ it
->descent
)
27213 it
->ascent
= XINT (height
) - it
->descent
;
27215 if (!NILP (total_height
))
27216 spacing
= calc_line_height_property (it
, total_height
, font
,
27220 spacing
= get_it_property (it
, Qline_spacing
);
27221 spacing
= calc_line_height_property (it
, spacing
, font
,
27224 if (INTEGERP (spacing
))
27226 extra_line_spacing
= XINT (spacing
);
27227 if (!NILP (total_height
))
27228 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
27232 else /* i.e. (it->char_to_display == '\t') */
27234 if (font
->space_width
> 0)
27236 int tab_width
= it
->tab_width
* font
->space_width
;
27237 int x
= it
->current_x
+ it
->continuation_lines_width
;
27238 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
27240 /* If the distance from the current position to the next tab
27241 stop is less than a space character width, use the
27242 tab stop after that. */
27243 if (next_tab_x
- x
< font
->space_width
)
27244 next_tab_x
+= tab_width
;
27246 it
->pixel_width
= next_tab_x
- x
;
27248 if (FONT_TOO_HIGH (font
))
27250 if (get_char_glyph_code (' ', font
, &char2b
))
27252 pcm
= get_per_char_metric (font
, &char2b
);
27253 if (pcm
->width
== 0
27254 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
27260 it
->ascent
= pcm
->ascent
+ boff
;
27261 it
->descent
= pcm
->descent
- boff
;
27265 it
->ascent
= font
->pixel_size
+ boff
- 1;
27266 it
->descent
= -boff
+ 1;
27268 if (it
->ascent
< 0)
27270 if (it
->descent
< 0)
27275 it
->ascent
= FONT_BASE (font
) + boff
;
27276 it
->descent
= FONT_DESCENT (font
) - boff
;
27278 it
->phys_ascent
= it
->ascent
;
27279 it
->phys_descent
= it
->descent
;
27283 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
27284 it
->ascent
+ it
->descent
, it
->ascent
);
27289 it
->pixel_width
= 0;
27294 if (FONT_TOO_HIGH (font
))
27296 int font_ascent
, font_descent
;
27298 /* For very large fonts, where we ignore the declared font
27299 dimensions, and go by per-character metrics instead,
27300 don't let the row ascent and descent values (and the row
27301 height computed from them) be smaller than the "normal"
27302 character metrics. This avoids unpleasant effects
27303 whereby lines on display would change their height
27304 depending on which characters are shown. */
27305 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
27306 it
->max_ascent
= max (it
->max_ascent
, font_ascent
);
27307 it
->max_descent
= max (it
->max_descent
, font_descent
);
27310 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
27312 /* A static composition.
27314 Note: A composition is represented as one glyph in the
27315 glyph matrix. There are no padding glyphs.
27317 Important note: pixel_width, ascent, and descent are the
27318 values of what is drawn by draw_glyphs (i.e. the values of
27319 the overall glyphs composed). */
27320 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27321 int boff
; /* baseline offset */
27322 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
27323 int glyph_len
= cmp
->glyph_len
;
27324 struct font
*font
= face
->font
;
27328 /* If we have not yet calculated pixel size data of glyphs of
27329 the composition for the current face font, calculate them
27330 now. Theoretically, we have to check all fonts for the
27331 glyphs, but that requires much time and memory space. So,
27332 here we check only the font of the first glyph. This may
27333 lead to incorrect display, but it's very rare, and C-l
27334 (recenter-top-bottom) can correct the display anyway. */
27335 if (! cmp
->font
|| cmp
->font
!= font
)
27337 /* Ascent and descent of the font of the first character
27338 of this composition (adjusted by baseline offset).
27339 Ascent and descent of overall glyphs should not be less
27340 than these, respectively. */
27341 int font_ascent
, font_descent
, font_height
;
27342 /* Bounding box of the overall glyphs. */
27343 int leftmost
, rightmost
, lowest
, highest
;
27344 int lbearing
, rbearing
;
27345 int i
, width
, ascent
, descent
;
27348 struct font_metrics
*pcm
;
27351 eassume (0 < glyph_len
); /* See Bug#8512. */
27353 c
= COMPOSITION_GLYPH (cmp
, --glyph_len
);
27354 while (c
== '\t' && 0 < glyph_len
);
27356 bool right_padded
= glyph_len
< cmp
->glyph_len
;
27357 for (i
= 0; i
< glyph_len
; i
++)
27359 c
= COMPOSITION_GLYPH (cmp
, i
);
27362 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
27364 bool left_padded
= i
> 0;
27366 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
27367 : IT_CHARPOS (*it
));
27368 /* If no suitable font is found, use the default font. */
27369 bool font_not_found_p
= font
== NULL
;
27370 if (font_not_found_p
)
27372 face
= face
->ascii_face
;
27375 boff
= font
->baseline_offset
;
27376 if (font
->vertical_centering
)
27377 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
27378 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
27379 font_ascent
+= boff
;
27380 font_descent
-= boff
;
27381 font_height
= font_ascent
+ font_descent
;
27386 if (! font_not_found_p
)
27388 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
27390 pcm
= get_per_char_metric (font
, &char2b
);
27393 /* Initialize the bounding box. */
27396 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
27397 ascent
= pcm
->ascent
;
27398 descent
= pcm
->descent
;
27399 lbearing
= pcm
->lbearing
;
27400 rbearing
= pcm
->rbearing
;
27404 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
27405 ascent
= FONT_BASE (font
);
27406 descent
= FONT_DESCENT (font
);
27413 lowest
= - descent
+ boff
;
27414 highest
= ascent
+ boff
;
27416 if (! font_not_found_p
27417 && font
->default_ascent
27418 && CHAR_TABLE_P (Vuse_default_ascent
)
27419 && !NILP (Faref (Vuse_default_ascent
,
27420 make_number (it
->char_to_display
))))
27421 highest
= font
->default_ascent
+ boff
;
27423 /* Draw the first glyph at the normal position. It may be
27424 shifted to right later if some other glyphs are drawn
27426 cmp
->offsets
[i
* 2] = 0;
27427 cmp
->offsets
[i
* 2 + 1] = boff
;
27428 cmp
->lbearing
= lbearing
;
27429 cmp
->rbearing
= rbearing
;
27431 /* Set cmp->offsets for the remaining glyphs. */
27432 for (i
++; i
< glyph_len
; i
++)
27434 int left
, right
, btm
, top
;
27435 int ch
= COMPOSITION_GLYPH (cmp
, i
);
27437 struct face
*this_face
;
27441 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
27442 this_face
= FACE_FROM_ID (it
->f
, face_id
);
27443 font
= this_face
->font
;
27449 get_char_face_and_encoding (it
->f
, ch
, face_id
,
27451 pcm
= get_per_char_metric (font
, &char2b
);
27454 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
27457 width
= pcm
->width
;
27458 ascent
= pcm
->ascent
;
27459 descent
= pcm
->descent
;
27460 lbearing
= pcm
->lbearing
;
27461 rbearing
= pcm
->rbearing
;
27462 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
27464 /* Relative composition with or without
27465 alternate chars. */
27466 left
= (leftmost
+ rightmost
- width
) / 2;
27467 btm
= - descent
+ boff
;
27468 if (font
->relative_compose
27469 && (! CHAR_TABLE_P (Vignore_relative_composition
)
27470 || NILP (Faref (Vignore_relative_composition
,
27471 make_number (ch
)))))
27474 if (- descent
>= font
->relative_compose
)
27475 /* One extra pixel between two glyphs. */
27477 else if (ascent
<= 0)
27478 /* One extra pixel between two glyphs. */
27479 btm
= lowest
- 1 - ascent
- descent
;
27484 /* A composition rule is specified by an integer
27485 value that encodes global and new reference
27486 points (GREF and NREF). GREF and NREF are
27487 specified by numbers as below:
27489 0---1---2 -- ascent
27493 9--10--11 -- center
27495 ---3---4---5--- baseline
27497 6---7---8 -- descent
27499 int rule
= COMPOSITION_RULE (cmp
, i
);
27500 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
27502 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
27503 grefx
= gref
% 3, nrefx
= nref
% 3;
27504 grefy
= gref
/ 3, nrefy
= nref
/ 3;
27506 xoff
= font_height
* (xoff
- 128) / 256;
27508 yoff
= font_height
* (yoff
- 128) / 256;
27511 + grefx
* (rightmost
- leftmost
) / 2
27512 - nrefx
* width
/ 2
27515 btm
= ((grefy
== 0 ? highest
27517 : grefy
== 2 ? lowest
27518 : (highest
+ lowest
) / 2)
27519 - (nrefy
== 0 ? ascent
+ descent
27520 : nrefy
== 1 ? descent
- boff
27522 : (ascent
+ descent
) / 2)
27526 cmp
->offsets
[i
* 2] = left
;
27527 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
27529 /* Update the bounding box of the overall glyphs. */
27532 right
= left
+ width
;
27533 if (left
< leftmost
)
27535 if (right
> rightmost
)
27538 top
= btm
+ descent
+ ascent
;
27544 if (cmp
->lbearing
> left
+ lbearing
)
27545 cmp
->lbearing
= left
+ lbearing
;
27546 if (cmp
->rbearing
< left
+ rbearing
)
27547 cmp
->rbearing
= left
+ rbearing
;
27551 /* If there are glyphs whose x-offsets are negative,
27552 shift all glyphs to the right and make all x-offsets
27556 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27557 cmp
->offsets
[i
* 2] -= leftmost
;
27558 rightmost
-= leftmost
;
27559 cmp
->lbearing
-= leftmost
;
27560 cmp
->rbearing
-= leftmost
;
27563 if (left_padded
&& cmp
->lbearing
< 0)
27565 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27566 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
27567 rightmost
-= cmp
->lbearing
;
27568 cmp
->rbearing
-= cmp
->lbearing
;
27571 if (right_padded
&& rightmost
< cmp
->rbearing
)
27573 rightmost
= cmp
->rbearing
;
27576 cmp
->pixel_width
= rightmost
;
27577 cmp
->ascent
= highest
;
27578 cmp
->descent
= - lowest
;
27579 if (cmp
->ascent
< font_ascent
)
27580 cmp
->ascent
= font_ascent
;
27581 if (cmp
->descent
< font_descent
)
27582 cmp
->descent
= font_descent
;
27586 && (cmp
->lbearing
< 0
27587 || cmp
->rbearing
> cmp
->pixel_width
))
27588 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27590 it
->pixel_width
= cmp
->pixel_width
;
27591 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
27592 it
->descent
= it
->phys_descent
= cmp
->descent
;
27593 if (face
->box
!= FACE_NO_BOX
)
27595 int thick
= face
->box_line_width
;
27599 it
->ascent
+= thick
;
27600 it
->descent
+= thick
;
27605 if (it
->start_of_box_run_p
)
27606 it
->pixel_width
+= thick
;
27607 if (it
->end_of_box_run_p
)
27608 it
->pixel_width
+= thick
;
27611 /* If face has an overline, add the height of the overline
27612 (1 pixel) and a 1 pixel margin to the character height. */
27613 if (face
->overline_p
)
27614 it
->ascent
+= overline_margin
;
27616 take_vertical_position_into_account (it
);
27617 if (it
->ascent
< 0)
27619 if (it
->descent
< 0)
27622 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
27623 append_composite_glyph (it
);
27625 else if (it
->what
== IT_COMPOSITION
)
27627 /* A dynamic (automatic) composition. */
27628 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27629 Lisp_Object gstring
;
27630 struct font_metrics metrics
;
27634 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
27636 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
27639 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
27640 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27641 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
27642 it
->descent
= it
->phys_descent
= metrics
.descent
;
27643 if (face
->box
!= FACE_NO_BOX
)
27645 int thick
= face
->box_line_width
;
27649 it
->ascent
+= thick
;
27650 it
->descent
+= thick
;
27655 if (it
->start_of_box_run_p
)
27656 it
->pixel_width
+= thick
;
27657 if (it
->end_of_box_run_p
)
27658 it
->pixel_width
+= thick
;
27660 /* If face has an overline, add the height of the overline
27661 (1 pixel) and a 1 pixel margin to the character height. */
27662 if (face
->overline_p
)
27663 it
->ascent
+= overline_margin
;
27664 take_vertical_position_into_account (it
);
27665 if (it
->ascent
< 0)
27667 if (it
->descent
< 0)
27671 append_composite_glyph (it
);
27673 else if (it
->what
== IT_GLYPHLESS
)
27674 produce_glyphless_glyph (it
, false, Qnil
);
27675 else if (it
->what
== IT_IMAGE
)
27676 produce_image_glyph (it
);
27677 else if (it
->what
== IT_STRETCH
)
27678 produce_stretch_glyph (it
);
27679 else if (it
->what
== IT_XWIDGET
)
27680 produce_xwidget_glyph (it
);
27683 /* Accumulate dimensions. Note: can't assume that it->descent > 0
27684 because this isn't true for images with `:ascent 100'. */
27685 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
27686 if (it
->area
== TEXT_AREA
)
27687 it
->current_x
+= it
->pixel_width
;
27689 if (extra_line_spacing
> 0)
27691 it
->descent
+= extra_line_spacing
;
27692 if (extra_line_spacing
> it
->max_extra_line_spacing
)
27693 it
->max_extra_line_spacing
= extra_line_spacing
;
27696 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
27697 it
->max_descent
= max (it
->max_descent
, it
->descent
);
27698 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
27699 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
27703 Output LEN glyphs starting at START at the nominal cursor position.
27704 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
27705 being updated, and UPDATED_AREA is the area of that row being updated. */
27708 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27709 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27711 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
27713 eassert (updated_row
);
27714 /* When the window is hscrolled, cursor hpos can legitimately be out
27715 of bounds, but we draw the cursor at the corresponding window
27716 margin in that case. */
27717 if (!updated_row
->reversed_p
&& chpos
< 0)
27719 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
27720 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
27724 /* Write glyphs. */
27726 hpos
= start
- updated_row
->glyphs
[updated_area
];
27727 x
= draw_glyphs (w
, w
->output_cursor
.x
,
27728 updated_row
, updated_area
,
27730 DRAW_NORMAL_TEXT
, 0);
27732 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
27733 if (updated_area
== TEXT_AREA
27734 && w
->phys_cursor_on_p
27735 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
27737 && chpos
< hpos
+ len
)
27738 w
->phys_cursor_on_p
= false;
27742 /* Advance the output cursor. */
27743 w
->output_cursor
.hpos
+= len
;
27744 w
->output_cursor
.x
= x
;
27749 Insert LEN glyphs from START at the nominal cursor position. */
27752 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27753 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27756 int line_height
, shift_by_width
, shifted_region_width
;
27757 struct glyph_row
*row
;
27758 struct glyph
*glyph
;
27759 int frame_x
, frame_y
;
27762 eassert (updated_row
);
27764 f
= XFRAME (WINDOW_FRAME (w
));
27766 /* Get the height of the line we are in. */
27768 line_height
= row
->height
;
27770 /* Get the width of the glyphs to insert. */
27771 shift_by_width
= 0;
27772 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
27773 shift_by_width
+= glyph
->pixel_width
;
27775 /* Get the width of the region to shift right. */
27776 shifted_region_width
= (window_box_width (w
, updated_area
)
27777 - w
->output_cursor
.x
27781 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
27782 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
27784 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
27785 line_height
, shift_by_width
);
27787 /* Write the glyphs. */
27788 hpos
= start
- row
->glyphs
[updated_area
];
27789 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
27791 DRAW_NORMAL_TEXT
, 0);
27793 /* Advance the output cursor. */
27794 w
->output_cursor
.hpos
+= len
;
27795 w
->output_cursor
.x
+= shift_by_width
;
27801 Erase the current text line from the nominal cursor position
27802 (inclusive) to pixel column TO_X (exclusive). The idea is that
27803 everything from TO_X onward is already erased.
27805 TO_X is a pixel position relative to UPDATED_AREA of currently
27806 updated window W. TO_X == -1 means clear to the end of this area. */
27809 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
27810 enum glyph_row_area updated_area
, int to_x
)
27813 int max_x
, min_y
, max_y
;
27814 int from_x
, from_y
, to_y
;
27816 eassert (updated_row
);
27817 f
= XFRAME (w
->frame
);
27819 if (updated_row
->full_width_p
)
27820 max_x
= (WINDOW_PIXEL_WIDTH (w
)
27821 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
27823 max_x
= window_box_width (w
, updated_area
);
27824 max_y
= window_text_bottom_y (w
);
27826 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
27827 of window. For TO_X > 0, truncate to end of drawing area. */
27833 to_x
= min (to_x
, max_x
);
27835 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
27837 /* Notice if the cursor will be cleared by this operation. */
27838 if (!updated_row
->full_width_p
)
27839 notice_overwritten_cursor (w
, updated_area
,
27840 w
->output_cursor
.x
, -1,
27842 MATRIX_ROW_BOTTOM_Y (updated_row
));
27844 from_x
= w
->output_cursor
.x
;
27846 /* Translate to frame coordinates. */
27847 if (updated_row
->full_width_p
)
27849 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
27850 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
27854 int area_left
= window_box_left (w
, updated_area
);
27855 from_x
+= area_left
;
27859 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
27860 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
27861 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
27863 /* Prevent inadvertently clearing to end of the X window. */
27864 if (to_x
> from_x
&& to_y
> from_y
)
27867 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
27868 to_x
- from_x
, to_y
- from_y
);
27873 #endif /* HAVE_WINDOW_SYSTEM */
27877 /***********************************************************************
27879 ***********************************************************************/
27881 /* Value is the internal representation of the specified cursor type
27882 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27883 of the bar cursor. */
27885 static enum text_cursor_kinds
27886 get_specified_cursor_type (Lisp_Object arg
, int *width
)
27888 enum text_cursor_kinds type
;
27893 if (EQ (arg
, Qbox
))
27894 return FILLED_BOX_CURSOR
;
27896 if (EQ (arg
, Qhollow
))
27897 return HOLLOW_BOX_CURSOR
;
27899 if (EQ (arg
, Qbar
))
27906 && EQ (XCAR (arg
), Qbar
)
27907 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27909 *width
= XINT (XCDR (arg
));
27913 if (EQ (arg
, Qhbar
))
27916 return HBAR_CURSOR
;
27920 && EQ (XCAR (arg
), Qhbar
)
27921 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27923 *width
= XINT (XCDR (arg
));
27924 return HBAR_CURSOR
;
27927 /* Treat anything unknown as "hollow box cursor".
27928 It was bad to signal an error; people have trouble fixing
27929 .Xdefaults with Emacs, when it has something bad in it. */
27930 type
= HOLLOW_BOX_CURSOR
;
27935 /* Set the default cursor types for specified frame. */
27937 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27942 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27943 FRAME_CURSOR_WIDTH (f
) = width
;
27945 /* By default, set up the blink-off state depending on the on-state. */
27947 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27950 FRAME_BLINK_OFF_CURSOR (f
)
27951 = get_specified_cursor_type (XCDR (tem
), &width
);
27952 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27955 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27957 /* Make sure the cursor gets redrawn. */
27958 f
->cursor_type_changed
= true;
27962 #ifdef HAVE_WINDOW_SYSTEM
27964 /* Return the cursor we want to be displayed in window W. Return
27965 width of bar/hbar cursor through WIDTH arg. Return with
27966 ACTIVE_CURSOR arg set to true if cursor in window W is `active'
27967 (i.e. if the `system caret' should track this cursor).
27969 In a mini-buffer window, we want the cursor only to appear if we
27970 are reading input from this window. For the selected window, we
27971 want the cursor type given by the frame parameter or buffer local
27972 setting of cursor-type. If explicitly marked off, draw no cursor.
27973 In all other cases, we want a hollow box cursor. */
27975 static enum text_cursor_kinds
27976 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27977 bool *active_cursor
)
27979 struct frame
*f
= XFRAME (w
->frame
);
27980 struct buffer
*b
= XBUFFER (w
->contents
);
27981 int cursor_type
= DEFAULT_CURSOR
;
27982 Lisp_Object alt_cursor
;
27983 bool non_selected
= false;
27985 *active_cursor
= true;
27988 if (cursor_in_echo_area
27989 && FRAME_HAS_MINIBUF_P (f
)
27990 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27992 if (w
== XWINDOW (echo_area_window
))
27994 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27996 *width
= FRAME_CURSOR_WIDTH (f
);
27997 return FRAME_DESIRED_CURSOR (f
);
28000 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
28003 *active_cursor
= false;
28004 non_selected
= true;
28007 /* Detect a nonselected window or nonselected frame. */
28008 else if (w
!= XWINDOW (f
->selected_window
)
28009 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
28011 *active_cursor
= false;
28013 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
28016 non_selected
= true;
28019 /* Never display a cursor in a window in which cursor-type is nil. */
28020 if (NILP (BVAR (b
, cursor_type
)))
28023 /* Get the normal cursor type for this window. */
28024 if (EQ (BVAR (b
, cursor_type
), Qt
))
28026 cursor_type
= FRAME_DESIRED_CURSOR (f
);
28027 *width
= FRAME_CURSOR_WIDTH (f
);
28030 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
28032 /* Use cursor-in-non-selected-windows instead
28033 for non-selected window or frame. */
28036 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
28037 if (!EQ (Qt
, alt_cursor
))
28038 return get_specified_cursor_type (alt_cursor
, width
);
28039 /* t means modify the normal cursor type. */
28040 if (cursor_type
== FILLED_BOX_CURSOR
)
28041 cursor_type
= HOLLOW_BOX_CURSOR
;
28042 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
28044 return cursor_type
;
28047 /* Use normal cursor if not blinked off. */
28048 if (!w
->cursor_off_p
)
28050 if (glyph
!= NULL
&& glyph
->type
== XWIDGET_GLYPH
)
28052 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
28054 if (cursor_type
== FILLED_BOX_CURSOR
)
28056 /* Using a block cursor on large images can be very annoying.
28057 So use a hollow cursor for "large" images.
28058 If image is not transparent (no mask), also use hollow cursor. */
28059 struct image
*img
= IMAGE_OPT_FROM_ID (f
, glyph
->u
.img_id
);
28060 if (img
!= NULL
&& IMAGEP (img
->spec
))
28062 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
28063 where N = size of default frame font size.
28064 This should cover most of the "tiny" icons people may use. */
28066 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
28067 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
28068 cursor_type
= HOLLOW_BOX_CURSOR
;
28071 else if (cursor_type
!= NO_CURSOR
)
28073 /* Display current only supports BOX and HOLLOW cursors for images.
28074 So for now, unconditionally use a HOLLOW cursor when cursor is
28075 not a solid box cursor. */
28076 cursor_type
= HOLLOW_BOX_CURSOR
;
28079 return cursor_type
;
28082 /* Cursor is blinked off, so determine how to "toggle" it. */
28084 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
28085 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
28086 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
28088 /* Then see if frame has specified a specific blink off cursor type. */
28089 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
28091 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
28092 return FRAME_BLINK_OFF_CURSOR (f
);
28096 /* Some people liked having a permanently visible blinking cursor,
28097 while others had very strong opinions against it. So it was
28098 decided to remove it. KFS 2003-09-03 */
28100 /* Finally perform built-in cursor blinking:
28101 filled box <-> hollow box
28102 wide [h]bar <-> narrow [h]bar
28103 narrow [h]bar <-> no cursor
28104 other type <-> no cursor */
28106 if (cursor_type
== FILLED_BOX_CURSOR
)
28107 return HOLLOW_BOX_CURSOR
;
28109 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
28112 return cursor_type
;
28120 /* Notice when the text cursor of window W has been completely
28121 overwritten by a drawing operation that outputs glyphs in AREA
28122 starting at X0 and ending at X1 in the line starting at Y0 and
28123 ending at Y1. X coordinates are area-relative. X1 < 0 means all
28124 the rest of the line after X0 has been written. Y coordinates
28125 are window-relative. */
28128 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
28129 int x0
, int x1
, int y0
, int y1
)
28131 int cx0
, cx1
, cy0
, cy1
;
28132 struct glyph_row
*row
;
28134 if (!w
->phys_cursor_on_p
)
28136 if (area
!= TEXT_AREA
)
28139 if (w
->phys_cursor
.vpos
< 0
28140 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
28141 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
28142 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
28145 if (row
->cursor_in_fringe_p
)
28147 row
->cursor_in_fringe_p
= false;
28148 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
28149 w
->phys_cursor_on_p
= false;
28153 cx0
= w
->phys_cursor
.x
;
28154 cx1
= cx0
+ w
->phys_cursor_width
;
28155 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
28158 /* The cursor image will be completely removed from the
28159 screen if the output area intersects the cursor area in
28160 y-direction. When we draw in [y0 y1[, and some part of
28161 the cursor is at y < y0, that part must have been drawn
28162 before. When scrolling, the cursor is erased before
28163 actually scrolling, so we don't come here. When not
28164 scrolling, the rows above the old cursor row must have
28165 changed, and in this case these rows must have written
28166 over the cursor image.
28168 Likewise if part of the cursor is below y1, with the
28169 exception of the cursor being in the first blank row at
28170 the buffer and window end because update_text_area
28171 doesn't draw that row. (Except when it does, but
28172 that's handled in update_text_area.) */
28174 cy0
= w
->phys_cursor
.y
;
28175 cy1
= cy0
+ w
->phys_cursor_height
;
28176 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
28179 w
->phys_cursor_on_p
= false;
28182 #endif /* HAVE_WINDOW_SYSTEM */
28185 /************************************************************************
28187 ************************************************************************/
28189 #ifdef HAVE_WINDOW_SYSTEM
28192 Fix the display of area AREA of overlapping row ROW in window W
28193 with respect to the overlapping part OVERLAPS. */
28196 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
28197 enum glyph_row_area area
, int overlaps
)
28204 for (i
= 0; i
< row
->used
[area
];)
28206 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
28208 int start
= i
, start_x
= x
;
28212 x
+= row
->glyphs
[area
][i
].pixel_width
;
28215 while (i
< row
->used
[area
]
28216 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
28218 draw_glyphs (w
, start_x
, row
, area
,
28220 DRAW_NORMAL_TEXT
, overlaps
);
28224 x
+= row
->glyphs
[area
][i
].pixel_width
;
28234 Draw the cursor glyph of window W in glyph row ROW. See the
28235 comment of draw_glyphs for the meaning of HL. */
28238 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
28239 enum draw_glyphs_face hl
)
28241 /* If cursor hpos is out of bounds, don't draw garbage. This can
28242 happen in mini-buffer windows when switching between echo area
28243 glyphs and mini-buffer. */
28244 if ((row
->reversed_p
28245 ? (w
->phys_cursor
.hpos
>= 0)
28246 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
28248 bool on_p
= w
->phys_cursor_on_p
;
28250 int hpos
= w
->phys_cursor
.hpos
;
28252 /* When the window is hscrolled, cursor hpos can legitimately be
28253 out of bounds, but we draw the cursor at the corresponding
28254 window margin in that case. */
28255 if (!row
->reversed_p
&& hpos
< 0)
28257 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28258 hpos
= row
->used
[TEXT_AREA
] - 1;
28260 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
28262 w
->phys_cursor_on_p
= on_p
;
28264 if (hl
== DRAW_CURSOR
)
28265 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
28266 /* When we erase the cursor, and ROW is overlapped by other
28267 rows, make sure that these overlapping parts of other rows
28269 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
28271 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
28273 if (row
> w
->current_matrix
->rows
28274 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
28275 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
28276 OVERLAPS_ERASED_CURSOR
);
28278 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
28279 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
28280 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
28281 OVERLAPS_ERASED_CURSOR
);
28287 /* Erase the image of a cursor of window W from the screen. */
28290 erase_phys_cursor (struct window
*w
)
28292 struct frame
*f
= XFRAME (w
->frame
);
28293 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28294 int hpos
= w
->phys_cursor
.hpos
;
28295 int vpos
= w
->phys_cursor
.vpos
;
28296 bool mouse_face_here_p
= false;
28297 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
28298 struct glyph_row
*cursor_row
;
28299 struct glyph
*cursor_glyph
;
28300 enum draw_glyphs_face hl
;
28302 /* No cursor displayed or row invalidated => nothing to do on the
28304 if (w
->phys_cursor_type
== NO_CURSOR
)
28305 goto mark_cursor_off
;
28307 /* VPOS >= active_glyphs->nrows means that window has been resized.
28308 Don't bother to erase the cursor. */
28309 if (vpos
>= active_glyphs
->nrows
)
28310 goto mark_cursor_off
;
28312 /* If row containing cursor is marked invalid, there is nothing we
28314 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
28315 if (!cursor_row
->enabled_p
)
28316 goto mark_cursor_off
;
28318 /* If line spacing is > 0, old cursor may only be partially visible in
28319 window after split-window. So adjust visible height. */
28320 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
28321 window_text_bottom_y (w
) - cursor_row
->y
);
28323 /* If row is completely invisible, don't attempt to delete a cursor which
28324 isn't there. This can happen if cursor is at top of a window, and
28325 we switch to a buffer with a header line in that window. */
28326 if (cursor_row
->visible_height
<= 0)
28327 goto mark_cursor_off
;
28329 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
28330 if (cursor_row
->cursor_in_fringe_p
)
28332 cursor_row
->cursor_in_fringe_p
= false;
28333 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
28334 goto mark_cursor_off
;
28337 /* This can happen when the new row is shorter than the old one.
28338 In this case, either draw_glyphs or clear_end_of_line
28339 should have cleared the cursor. Note that we wouldn't be
28340 able to erase the cursor in this case because we don't have a
28341 cursor glyph at hand. */
28342 if ((cursor_row
->reversed_p
28343 ? (w
->phys_cursor
.hpos
< 0)
28344 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
28345 goto mark_cursor_off
;
28347 /* When the window is hscrolled, cursor hpos can legitimately be out
28348 of bounds, but we draw the cursor at the corresponding window
28349 margin in that case. */
28350 if (!cursor_row
->reversed_p
&& hpos
< 0)
28352 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
28353 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
28355 /* If the cursor is in the mouse face area, redisplay that when
28356 we clear the cursor. */
28357 if (! NILP (hlinfo
->mouse_face_window
)
28358 && coords_in_mouse_face_p (w
, hpos
, vpos
)
28359 /* Don't redraw the cursor's spot in mouse face if it is at the
28360 end of a line (on a newline). The cursor appears there, but
28361 mouse highlighting does not. */
28362 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
28363 mouse_face_here_p
= true;
28365 /* Maybe clear the display under the cursor. */
28366 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
28369 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
28372 cursor_glyph
= get_phys_cursor_glyph (w
);
28373 if (cursor_glyph
== NULL
)
28374 goto mark_cursor_off
;
28376 width
= cursor_glyph
->pixel_width
;
28377 x
= w
->phys_cursor
.x
;
28383 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
28384 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
28385 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
28388 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
28391 /* Erase the cursor by redrawing the character underneath it. */
28392 if (mouse_face_here_p
)
28393 hl
= DRAW_MOUSE_FACE
;
28395 hl
= DRAW_NORMAL_TEXT
;
28396 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
28399 w
->phys_cursor_on_p
= false;
28400 w
->phys_cursor_type
= NO_CURSOR
;
28404 /* Display or clear cursor of window W. If !ON, clear the cursor.
28405 If ON, display the cursor; where to put the cursor is specified by
28406 HPOS, VPOS, X and Y. */
28409 display_and_set_cursor (struct window
*w
, bool on
,
28410 int hpos
, int vpos
, int x
, int y
)
28412 struct frame
*f
= XFRAME (w
->frame
);
28413 int new_cursor_type
;
28414 int new_cursor_width
;
28415 bool active_cursor
;
28416 struct glyph_row
*glyph_row
;
28417 struct glyph
*glyph
;
28419 /* This is pointless on invisible frames, and dangerous on garbaged
28420 windows and frames; in the latter case, the frame or window may
28421 be in the midst of changing its size, and x and y may be off the
28423 if (! FRAME_VISIBLE_P (f
)
28424 || FRAME_GARBAGED_P (f
)
28425 || vpos
>= w
->current_matrix
->nrows
28426 || hpos
>= w
->current_matrix
->matrix_w
)
28429 /* If cursor is off and we want it off, return quickly. */
28430 if (!on
&& !w
->phys_cursor_on_p
)
28433 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28434 /* If cursor row is not enabled, we don't really know where to
28435 display the cursor. */
28436 if (!glyph_row
->enabled_p
)
28438 w
->phys_cursor_on_p
= false;
28443 if (!glyph_row
->exact_window_width_line_p
28444 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
28445 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
28447 eassert (input_blocked_p ());
28449 /* Set new_cursor_type to the cursor we want to be displayed. */
28450 new_cursor_type
= get_window_cursor_type (w
, glyph
,
28451 &new_cursor_width
, &active_cursor
);
28453 /* If cursor is currently being shown and we don't want it to be or
28454 it is in the wrong place, or the cursor type is not what we want,
28456 if (w
->phys_cursor_on_p
28458 || w
->phys_cursor
.x
!= x
28459 || w
->phys_cursor
.y
!= y
28460 /* HPOS can be negative in R2L rows whose
28461 exact_window_width_line_p flag is set (i.e. their newline
28462 would "overflow into the fringe"). */
28464 || new_cursor_type
!= w
->phys_cursor_type
28465 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
28466 && new_cursor_width
!= w
->phys_cursor_width
)))
28467 erase_phys_cursor (w
);
28469 /* Don't check phys_cursor_on_p here because that flag is only set
28470 to false in some cases where we know that the cursor has been
28471 completely erased, to avoid the extra work of erasing the cursor
28472 twice. In other words, phys_cursor_on_p can be true and the cursor
28473 still not be visible, or it has only been partly erased. */
28476 w
->phys_cursor_ascent
= glyph_row
->ascent
;
28477 w
->phys_cursor_height
= glyph_row
->height
;
28479 /* Set phys_cursor_.* before x_draw_.* is called because some
28480 of them may need the information. */
28481 w
->phys_cursor
.x
= x
;
28482 w
->phys_cursor
.y
= glyph_row
->y
;
28483 w
->phys_cursor
.hpos
= hpos
;
28484 w
->phys_cursor
.vpos
= vpos
;
28487 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
28488 new_cursor_type
, new_cursor_width
,
28489 on
, active_cursor
);
28493 /* Switch the display of W's cursor on or off, according to the value
28497 update_window_cursor (struct window
*w
, bool on
)
28499 /* Don't update cursor in windows whose frame is in the process
28500 of being deleted. */
28501 if (w
->current_matrix
)
28503 int hpos
= w
->phys_cursor
.hpos
;
28504 int vpos
= w
->phys_cursor
.vpos
;
28505 struct glyph_row
*row
;
28507 if (vpos
>= w
->current_matrix
->nrows
28508 || hpos
>= w
->current_matrix
->matrix_w
)
28511 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28513 /* When the window is hscrolled, cursor hpos can legitimately be
28514 out of bounds, but we draw the cursor at the corresponding
28515 window margin in that case. */
28516 if (!row
->reversed_p
&& hpos
< 0)
28518 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28519 hpos
= row
->used
[TEXT_AREA
] - 1;
28522 display_and_set_cursor (w
, on
, hpos
, vpos
,
28523 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28529 /* Call update_window_cursor with parameter ON_P on all leaf windows
28530 in the window tree rooted at W. */
28533 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
28537 if (WINDOWP (w
->contents
))
28538 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
28540 update_window_cursor (w
, on_p
);
28542 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
28548 Display the cursor on window W, or clear it, according to ON_P.
28549 Don't change the cursor's position. */
28552 x_update_cursor (struct frame
*f
, bool on_p
)
28554 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
28559 Clear the cursor of window W to background color, and mark the
28560 cursor as not shown. This is used when the text where the cursor
28561 is about to be rewritten. */
28564 x_clear_cursor (struct window
*w
)
28566 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
28567 update_window_cursor (w
, false);
28570 #endif /* HAVE_WINDOW_SYSTEM */
28572 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
28575 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
28576 int start_hpos
, int end_hpos
,
28577 enum draw_glyphs_face draw
)
28579 #ifdef HAVE_WINDOW_SYSTEM
28580 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
28582 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
28586 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
28587 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
28591 /* Display the active region described by mouse_face_* according to DRAW. */
28594 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
28596 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
28597 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28599 if (/* If window is in the process of being destroyed, don't bother
28601 w
->current_matrix
!= NULL
28602 /* Don't update mouse highlight if hidden. */
28603 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
28604 /* Recognize when we are called to operate on rows that don't exist
28605 anymore. This can happen when a window is split. */
28606 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
28608 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
28609 struct glyph_row
*row
, *first
, *last
;
28611 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
28612 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
28614 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
28616 int start_hpos
, end_hpos
, start_x
;
28618 /* For all but the first row, the highlight starts at column 0. */
28621 /* R2L rows have BEG and END in reversed order, but the
28622 screen drawing geometry is always left to right. So
28623 we need to mirror the beginning and end of the
28624 highlighted area in R2L rows. */
28625 if (!row
->reversed_p
)
28627 start_hpos
= hlinfo
->mouse_face_beg_col
;
28628 start_x
= hlinfo
->mouse_face_beg_x
;
28630 else if (row
== last
)
28632 start_hpos
= hlinfo
->mouse_face_end_col
;
28633 start_x
= hlinfo
->mouse_face_end_x
;
28641 else if (row
->reversed_p
&& row
== last
)
28643 start_hpos
= hlinfo
->mouse_face_end_col
;
28644 start_x
= hlinfo
->mouse_face_end_x
;
28654 if (!row
->reversed_p
)
28655 end_hpos
= hlinfo
->mouse_face_end_col
;
28656 else if (row
== first
)
28657 end_hpos
= hlinfo
->mouse_face_beg_col
;
28660 end_hpos
= row
->used
[TEXT_AREA
];
28661 if (draw
== DRAW_NORMAL_TEXT
)
28662 row
->fill_line_p
= true; /* Clear to end of line. */
28665 else if (row
->reversed_p
&& row
== first
)
28666 end_hpos
= hlinfo
->mouse_face_beg_col
;
28669 end_hpos
= row
->used
[TEXT_AREA
];
28670 if (draw
== DRAW_NORMAL_TEXT
)
28671 row
->fill_line_p
= true; /* Clear to end of line. */
28674 if (end_hpos
> start_hpos
)
28676 draw_row_with_mouse_face (w
, start_x
, row
,
28677 start_hpos
, end_hpos
, draw
);
28680 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
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 #ifdef HAVE_WINDOW_SYSTEM
28690 int hpos
= w
->phys_cursor
.hpos
;
28692 /* When the window is hscrolled, cursor hpos can legitimately be
28693 out of bounds, but we draw the cursor at the corresponding
28694 window margin in that case. */
28695 if (!row
->reversed_p
&& hpos
< 0)
28697 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28698 hpos
= row
->used
[TEXT_AREA
] - 1;
28701 display_and_set_cursor (w
, true, hpos
, w
->phys_cursor
.vpos
,
28702 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28704 #endif /* HAVE_WINDOW_SYSTEM */
28708 #ifdef HAVE_WINDOW_SYSTEM
28709 /* Change the mouse cursor. */
28710 if (FRAME_WINDOW_P (f
) && NILP (do_mouse_tracking
))
28712 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
28713 if (draw
== DRAW_NORMAL_TEXT
28714 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
28715 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
28718 if (draw
== DRAW_MOUSE_FACE
)
28719 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
28721 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
28723 #endif /* HAVE_WINDOW_SYSTEM */
28727 Clear out the mouse-highlighted active region.
28728 Redraw it un-highlighted first. Value is true if mouse
28729 face was actually drawn unhighlighted. */
28732 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
28735 = !hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
);
28737 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
28738 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28739 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28740 hlinfo
->mouse_face_window
= Qnil
;
28741 hlinfo
->mouse_face_overlay
= Qnil
;
28745 /* Return true if the coordinates HPOS and VPOS on windows W are
28746 within the mouse face on that window. */
28748 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
28750 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28752 /* Quickly resolve the easy cases. */
28753 if (!(WINDOWP (hlinfo
->mouse_face_window
)
28754 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
28756 if (vpos
< hlinfo
->mouse_face_beg_row
28757 || vpos
> hlinfo
->mouse_face_end_row
)
28759 if (vpos
> hlinfo
->mouse_face_beg_row
28760 && vpos
< hlinfo
->mouse_face_end_row
)
28763 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
28765 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28767 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
28770 else if ((vpos
== hlinfo
->mouse_face_beg_row
28771 && hpos
>= hlinfo
->mouse_face_beg_col
)
28772 || (vpos
== hlinfo
->mouse_face_end_row
28773 && hpos
< hlinfo
->mouse_face_end_col
))
28778 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28780 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
28783 else if ((vpos
== hlinfo
->mouse_face_beg_row
28784 && hpos
<= hlinfo
->mouse_face_beg_col
)
28785 || (vpos
== hlinfo
->mouse_face_end_row
28786 && hpos
> hlinfo
->mouse_face_end_col
))
28794 True if physical cursor of window W is within mouse face. */
28797 cursor_in_mouse_face_p (struct window
*w
)
28799 int hpos
= w
->phys_cursor
.hpos
;
28800 int vpos
= w
->phys_cursor
.vpos
;
28801 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28803 /* When the window is hscrolled, cursor hpos can legitimately be out
28804 of bounds, but we draw the cursor at the corresponding window
28805 margin in that case. */
28806 if (!row
->reversed_p
&& hpos
< 0)
28808 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28809 hpos
= row
->used
[TEXT_AREA
] - 1;
28811 return coords_in_mouse_face_p (w
, hpos
, vpos
);
28816 /* Find the glyph rows START_ROW and END_ROW of window W that display
28817 characters between buffer positions START_CHARPOS and END_CHARPOS
28818 (excluding END_CHARPOS). DISP_STRING is a display string that
28819 covers these buffer positions. This is similar to
28820 row_containing_pos, but is more accurate when bidi reordering makes
28821 buffer positions change non-linearly with glyph rows. */
28823 rows_from_pos_range (struct window
*w
,
28824 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
28825 Lisp_Object disp_string
,
28826 struct glyph_row
**start
, struct glyph_row
**end
)
28828 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28829 int last_y
= window_text_bottom_y (w
);
28830 struct glyph_row
*row
;
28835 while (!first
->enabled_p
28836 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
28839 /* Find the START row. */
28841 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
28844 /* A row can potentially be the START row if the range of the
28845 characters it displays intersects the range
28846 [START_CHARPOS..END_CHARPOS). */
28847 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
28848 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
28849 /* See the commentary in row_containing_pos, for the
28850 explanation of the complicated way to check whether
28851 some position is beyond the end of the characters
28852 displayed by a row. */
28853 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28854 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28855 && !row
->ends_at_zv_p
28856 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
28857 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28858 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28859 && !row
->ends_at_zv_p
28860 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
28862 /* Found a candidate row. Now make sure at least one of the
28863 glyphs it displays has a charpos from the range
28864 [START_CHARPOS..END_CHARPOS).
28866 This is not obvious because bidi reordering could make
28867 buffer positions of a row be 1,2,3,102,101,100, and if we
28868 want to highlight characters in [50..60), we don't want
28869 this row, even though [50..60) does intersect [1..103),
28870 the range of character positions given by the row's start
28871 and end positions. */
28872 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
28873 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
28877 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28878 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28879 /* A glyph that comes from DISP_STRING is by
28880 definition to be highlighted. */
28881 || EQ (g
->object
, disp_string
))
28890 /* Find the END row. */
28892 /* If the last row is partially visible, start looking for END
28893 from that row, instead of starting from FIRST. */
28894 && !(row
->enabled_p
28895 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
28897 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
28899 struct glyph_row
*next
= row
+ 1;
28900 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
28902 if (!next
->enabled_p
28903 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
28904 /* The first row >= START whose range of displayed characters
28905 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28906 is the row END + 1. */
28907 || (start_charpos
< next_start
28908 && end_charpos
< next_start
)
28909 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28910 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28911 && !next
->ends_at_zv_p
28912 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28913 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28914 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28915 && !next
->ends_at_zv_p
28916 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28923 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28924 but none of the characters it displays are in the range, it is
28926 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28927 struct glyph
*s
= g
;
28928 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28932 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28933 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28934 /* If the buffer position of the first glyph in
28935 the row is equal to END_CHARPOS, it means
28936 the last character to be highlighted is the
28937 newline of ROW, and we must consider NEXT as
28939 || (((!next
->reversed_p
&& g
== s
)
28940 || (next
->reversed_p
&& g
== e
- 1))
28941 && (g
->charpos
== end_charpos
28942 /* Special case for when NEXT is an
28943 empty line at ZV. */
28944 || (g
->charpos
== -1
28945 && !row
->ends_at_zv_p
28946 && next_start
== end_charpos
)))))
28947 /* A glyph that comes from DISP_STRING is by
28948 definition to be highlighted. */
28949 || EQ (g
->object
, disp_string
))
28958 /* The first row that ends at ZV must be the last to be
28960 else if (next
->ends_at_zv_p
)
28969 /* This function sets the mouse_face_* elements of HLINFO, assuming
28970 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28971 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28972 for the overlay or run of text properties specifying the mouse
28973 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28974 before-string and after-string that must also be highlighted.
28975 DISP_STRING, if non-nil, is a display string that may cover some
28976 or all of the highlighted text. */
28979 mouse_face_from_buffer_pos (Lisp_Object window
,
28980 Mouse_HLInfo
*hlinfo
,
28981 ptrdiff_t mouse_charpos
,
28982 ptrdiff_t start_charpos
,
28983 ptrdiff_t end_charpos
,
28984 Lisp_Object before_string
,
28985 Lisp_Object after_string
,
28986 Lisp_Object disp_string
)
28988 struct window
*w
= XWINDOW (window
);
28989 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28990 struct glyph_row
*r1
, *r2
;
28991 struct glyph
*glyph
, *end
;
28992 ptrdiff_t ignore
, pos
;
28995 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28996 eassert (NILP (before_string
) || STRINGP (before_string
));
28997 eassert (NILP (after_string
) || STRINGP (after_string
));
28999 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
29000 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
29002 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
29003 /* If the before-string or display-string contains newlines,
29004 rows_from_pos_range skips to its last row. Move back. */
29005 if (!NILP (before_string
) || !NILP (disp_string
))
29007 struct glyph_row
*prev
;
29008 while ((prev
= r1
- 1, prev
>= first
)
29009 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
29010 && prev
->used
[TEXT_AREA
] > 0)
29012 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
29013 glyph
= beg
+ prev
->used
[TEXT_AREA
];
29014 while (--glyph
>= beg
&& NILP (glyph
->object
));
29016 || !(EQ (glyph
->object
, before_string
)
29017 || EQ (glyph
->object
, disp_string
)))
29024 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
29025 hlinfo
->mouse_face_past_end
= true;
29027 else if (!NILP (after_string
))
29029 /* If the after-string has newlines, advance to its last row. */
29030 struct glyph_row
*next
;
29031 struct glyph_row
*last
29032 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
29034 for (next
= r2
+ 1;
29036 && next
->used
[TEXT_AREA
] > 0
29037 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
29041 /* The rest of the display engine assumes that mouse_face_beg_row is
29042 either above mouse_face_end_row or identical to it. But with
29043 bidi-reordered continued lines, the row for START_CHARPOS could
29044 be below the row for END_CHARPOS. If so, swap the rows and store
29045 them in correct order. */
29048 struct glyph_row
*tem
= r2
;
29054 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
29055 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
29057 /* For a bidi-reordered row, the positions of BEFORE_STRING,
29058 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
29059 could be anywhere in the row and in any order. The strategy
29060 below is to find the leftmost and the rightmost glyph that
29061 belongs to either of these 3 strings, or whose position is
29062 between START_CHARPOS and END_CHARPOS, and highlight all the
29063 glyphs between those two. This may cover more than just the text
29064 between START_CHARPOS and END_CHARPOS if the range of characters
29065 strides the bidi level boundary, e.g. if the beginning is in R2L
29066 text while the end is in L2R text or vice versa. */
29067 if (!r1
->reversed_p
)
29069 /* This row is in a left to right paragraph. Scan it left to
29071 glyph
= r1
->glyphs
[TEXT_AREA
];
29072 end
= glyph
+ r1
->used
[TEXT_AREA
];
29075 /* Skip truncation glyphs at the start of the glyph row. */
29076 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
29078 && NILP (glyph
->object
)
29079 && glyph
->charpos
< 0;
29081 x
+= glyph
->pixel_width
;
29083 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
29084 or DISP_STRING, and the first glyph from buffer whose
29085 position is between START_CHARPOS and END_CHARPOS. */
29087 && !NILP (glyph
->object
)
29088 && !EQ (glyph
->object
, disp_string
)
29089 && !(BUFFERP (glyph
->object
)
29090 && (glyph
->charpos
>= start_charpos
29091 && glyph
->charpos
< end_charpos
));
29094 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29095 are present at buffer positions between START_CHARPOS and
29096 END_CHARPOS, or if they come from an overlay. */
29097 if (EQ (glyph
->object
, before_string
))
29099 pos
= string_buffer_position (before_string
,
29101 /* If pos == 0, it means before_string came from an
29102 overlay, not from a buffer position. */
29103 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29106 else if (EQ (glyph
->object
, after_string
))
29108 pos
= string_buffer_position (after_string
, end_charpos
);
29109 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29112 x
+= glyph
->pixel_width
;
29114 hlinfo
->mouse_face_beg_x
= x
;
29115 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
29119 /* This row is in a right to left paragraph. Scan it right to
29123 end
= r1
->glyphs
[TEXT_AREA
] - 1;
29124 glyph
= end
+ r1
->used
[TEXT_AREA
];
29126 /* Skip truncation glyphs at the start of the glyph row. */
29127 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
29129 && NILP (glyph
->object
)
29130 && glyph
->charpos
< 0;
29134 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
29135 or DISP_STRING, and the first glyph from buffer whose
29136 position is between START_CHARPOS and END_CHARPOS. */
29138 && !NILP (glyph
->object
)
29139 && !EQ (glyph
->object
, disp_string
)
29140 && !(BUFFERP (glyph
->object
)
29141 && (glyph
->charpos
>= start_charpos
29142 && glyph
->charpos
< end_charpos
));
29145 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29146 are present at buffer positions between START_CHARPOS and
29147 END_CHARPOS, or if they come from an overlay. */
29148 if (EQ (glyph
->object
, before_string
))
29150 pos
= string_buffer_position (before_string
, start_charpos
);
29151 /* If pos == 0, it means before_string came from an
29152 overlay, not from a buffer position. */
29153 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29156 else if (EQ (glyph
->object
, after_string
))
29158 pos
= string_buffer_position (after_string
, end_charpos
);
29159 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29164 glyph
++; /* first glyph to the right of the highlighted area */
29165 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
29166 x
+= g
->pixel_width
;
29167 hlinfo
->mouse_face_beg_x
= x
;
29168 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
29171 /* If the highlight ends in a different row, compute GLYPH and END
29172 for the end row. Otherwise, reuse the values computed above for
29173 the row where the highlight begins. */
29176 if (!r2
->reversed_p
)
29178 glyph
= r2
->glyphs
[TEXT_AREA
];
29179 end
= glyph
+ r2
->used
[TEXT_AREA
];
29184 end
= r2
->glyphs
[TEXT_AREA
] - 1;
29185 glyph
= end
+ r2
->used
[TEXT_AREA
];
29189 if (!r2
->reversed_p
)
29191 /* Skip truncation and continuation glyphs near the end of the
29192 row, and also blanks and stretch glyphs inserted by
29193 extend_face_to_end_of_line. */
29195 && NILP ((end
- 1)->object
))
29197 /* Scan the rest of the glyph row from the end, looking for the
29198 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
29199 DISP_STRING, or whose position is between START_CHARPOS
29203 && !NILP (end
->object
)
29204 && !EQ (end
->object
, disp_string
)
29205 && !(BUFFERP (end
->object
)
29206 && (end
->charpos
>= start_charpos
29207 && end
->charpos
< end_charpos
));
29210 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29211 are present at buffer positions between START_CHARPOS and
29212 END_CHARPOS, or if they come from an overlay. */
29213 if (EQ (end
->object
, before_string
))
29215 pos
= string_buffer_position (before_string
, start_charpos
);
29216 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29219 else if (EQ (end
->object
, after_string
))
29221 pos
= string_buffer_position (after_string
, end_charpos
);
29222 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29226 /* Find the X coordinate of the last glyph to be highlighted. */
29227 for (; glyph
<= end
; ++glyph
)
29228 x
+= glyph
->pixel_width
;
29230 hlinfo
->mouse_face_end_x
= x
;
29231 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
29235 /* Skip truncation and continuation glyphs near the end of the
29236 row, and also blanks and stretch glyphs inserted by
29237 extend_face_to_end_of_line. */
29241 && NILP (end
->object
))
29243 x
+= end
->pixel_width
;
29246 /* Scan the rest of the glyph row from the end, looking for the
29247 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
29248 DISP_STRING, or whose position is between START_CHARPOS
29252 && !NILP (end
->object
)
29253 && !EQ (end
->object
, disp_string
)
29254 && !(BUFFERP (end
->object
)
29255 && (end
->charpos
>= start_charpos
29256 && end
->charpos
< end_charpos
));
29259 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29260 are present at buffer positions between START_CHARPOS and
29261 END_CHARPOS, or if they come from an overlay. */
29262 if (EQ (end
->object
, before_string
))
29264 pos
= string_buffer_position (before_string
, start_charpos
);
29265 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29268 else if (EQ (end
->object
, after_string
))
29270 pos
= string_buffer_position (after_string
, end_charpos
);
29271 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29274 x
+= end
->pixel_width
;
29276 /* If we exited the above loop because we arrived at the last
29277 glyph of the row, and its buffer position is still not in
29278 range, it means the last character in range is the preceding
29279 newline. Bump the end column and x values to get past the
29282 && BUFFERP (end
->object
)
29283 && (end
->charpos
< start_charpos
29284 || end
->charpos
>= end_charpos
))
29286 x
+= end
->pixel_width
;
29289 hlinfo
->mouse_face_end_x
= x
;
29290 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
29293 hlinfo
->mouse_face_window
= window
;
29294 hlinfo
->mouse_face_face_id
29295 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
29297 !hlinfo
->mouse_face_hidden
, -1);
29298 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29301 /* The following function is not used anymore (replaced with
29302 mouse_face_from_string_pos), but I leave it here for the time
29303 being, in case someone would. */
29305 #if false /* not used */
29307 /* Find the position of the glyph for position POS in OBJECT in
29308 window W's current matrix, and return in *X, *Y the pixel
29309 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
29311 RIGHT_P means return the position of the right edge of the glyph.
29312 !RIGHT_P means return the left edge position.
29314 If no glyph for POS exists in the matrix, return the position of
29315 the glyph with the next smaller position that is in the matrix, if
29316 RIGHT_P is false. If RIGHT_P, and no glyph for POS
29317 exists in the matrix, return the position of the glyph with the
29318 next larger position in OBJECT.
29320 Value is true if a glyph was found. */
29323 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
29324 int *hpos
, int *vpos
, int *x
, int *y
, bool right_p
)
29326 int yb
= window_text_bottom_y (w
);
29327 struct glyph_row
*r
;
29328 struct glyph
*best_glyph
= NULL
;
29329 struct glyph_row
*best_row
= NULL
;
29332 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
29333 r
->enabled_p
&& r
->y
< yb
;
29336 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
29337 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
29340 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
29341 if (EQ (g
->object
, object
))
29343 if (g
->charpos
== pos
)
29350 else if (best_glyph
== NULL
29351 || ((eabs (g
->charpos
- pos
)
29352 < eabs (best_glyph
->charpos
- pos
))
29355 : g
->charpos
> pos
)))
29369 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
29373 *x
+= best_glyph
->pixel_width
;
29378 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
29381 return best_glyph
!= NULL
;
29383 #endif /* not used */
29385 /* Find the positions of the first and the last glyphs in window W's
29386 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
29387 (assumed to be a string), and return in HLINFO's mouse_face_*
29388 members the pixel and column/row coordinates of those glyphs. */
29391 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
29392 Lisp_Object object
,
29393 ptrdiff_t startpos
, ptrdiff_t endpos
)
29395 int yb
= window_text_bottom_y (w
);
29396 struct glyph_row
*r
;
29397 struct glyph
*g
, *e
;
29399 bool found
= false;
29401 /* Find the glyph row with at least one position in the range
29402 [STARTPOS..ENDPOS), and the first glyph in that row whose
29403 position belongs to that range. */
29404 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
29405 r
->enabled_p
&& r
->y
< yb
;
29408 if (!r
->reversed_p
)
29410 g
= r
->glyphs
[TEXT_AREA
];
29411 e
= g
+ r
->used
[TEXT_AREA
];
29412 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
29413 if (EQ (g
->object
, object
)
29414 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29416 hlinfo
->mouse_face_beg_row
29417 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29418 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29419 hlinfo
->mouse_face_beg_x
= gx
;
29428 e
= r
->glyphs
[TEXT_AREA
];
29429 g
= e
+ r
->used
[TEXT_AREA
];
29430 for ( ; g
> e
; --g
)
29431 if (EQ ((g
-1)->object
, object
)
29432 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
29434 hlinfo
->mouse_face_beg_row
29435 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29436 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29437 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
29438 gx
+= g1
->pixel_width
;
29439 hlinfo
->mouse_face_beg_x
= gx
;
29451 /* Starting with the next row, look for the first row which does NOT
29452 include any glyphs whose positions are in the range. */
29453 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
29455 g
= r
->glyphs
[TEXT_AREA
];
29456 e
= g
+ r
->used
[TEXT_AREA
];
29458 for ( ; g
< e
; ++g
)
29459 if (EQ (g
->object
, object
)
29460 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29469 /* The highlighted region ends on the previous row. */
29472 /* Set the end row. */
29473 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29475 /* Compute and set the end column and the end column's horizontal
29476 pixel coordinate. */
29477 if (!r
->reversed_p
)
29479 g
= r
->glyphs
[TEXT_AREA
];
29480 e
= g
+ r
->used
[TEXT_AREA
];
29481 for ( ; e
> g
; --e
)
29482 if (EQ ((e
-1)->object
, object
)
29483 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
29485 hlinfo
->mouse_face_end_col
= e
- g
;
29487 for (gx
= r
->x
; g
< e
; ++g
)
29488 gx
+= g
->pixel_width
;
29489 hlinfo
->mouse_face_end_x
= gx
;
29493 e
= r
->glyphs
[TEXT_AREA
];
29494 g
= e
+ r
->used
[TEXT_AREA
];
29495 for (gx
= r
->x
; e
< g
; ++e
)
29497 if (EQ (e
->object
, object
)
29498 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
29500 gx
+= e
->pixel_width
;
29502 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
29503 hlinfo
->mouse_face_end_x
= gx
;
29507 #ifdef HAVE_WINDOW_SYSTEM
29509 /* See if position X, Y is within a hot-spot of an image. */
29512 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
29514 if (!CONSP (hot_spot
))
29517 if (EQ (XCAR (hot_spot
), Qrect
))
29519 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
29520 Lisp_Object rect
= XCDR (hot_spot
);
29524 if (!CONSP (XCAR (rect
)))
29526 if (!CONSP (XCDR (rect
)))
29528 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
29530 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
29532 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
29534 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
29538 else if (EQ (XCAR (hot_spot
), Qcircle
))
29540 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
29541 Lisp_Object circ
= XCDR (hot_spot
);
29542 Lisp_Object lr
, lx0
, ly0
;
29544 && CONSP (XCAR (circ
))
29545 && (lr
= XCDR (circ
), NUMBERP (lr
))
29546 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
29547 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
29549 double r
= XFLOATINT (lr
);
29550 double dx
= XINT (lx0
) - x
;
29551 double dy
= XINT (ly0
) - y
;
29552 return (dx
* dx
+ dy
* dy
<= r
* r
);
29555 else if (EQ (XCAR (hot_spot
), Qpoly
))
29557 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
29558 if (VECTORP (XCDR (hot_spot
)))
29560 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
29561 Lisp_Object
*poly
= v
->contents
;
29562 ptrdiff_t n
= v
->header
.size
;
29564 bool inside
= false;
29565 Lisp_Object lx
, ly
;
29568 /* Need an even number of coordinates, and at least 3 edges. */
29569 if (n
< 6 || n
& 1)
29572 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
29573 If count is odd, we are inside polygon. Pixels on edges
29574 may or may not be included depending on actual geometry of the
29576 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
29577 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
29579 x0
= XINT (lx
), y0
= XINT (ly
);
29580 for (i
= 0; i
< n
; i
+= 2)
29582 int x1
= x0
, y1
= y0
;
29583 if ((lx
= poly
[i
], !INTEGERP (lx
))
29584 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
29586 x0
= XINT (lx
), y0
= XINT (ly
);
29588 /* Does this segment cross the X line? */
29596 if (y
> y0
&& y
> y1
)
29598 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
29608 find_hot_spot (Lisp_Object map
, int x
, int y
)
29610 while (CONSP (map
))
29612 if (CONSP (XCAR (map
))
29613 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
29621 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
29623 doc
: /* Lookup in image map MAP coordinates X and Y.
29624 An image map is an alist where each element has the format (AREA ID PLIST).
29625 An AREA is specified as either a rectangle, a circle, or a polygon:
29626 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
29627 pixel coordinates of the upper left and bottom right corners.
29628 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
29629 and the radius of the circle; r may be a float or integer.
29630 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
29631 vector describes one corner in the polygon.
29632 Returns the alist element for the first matching AREA in MAP. */)
29633 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
29641 return find_hot_spot (map
,
29642 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
29643 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
29645 #endif /* HAVE_WINDOW_SYSTEM */
29648 /* Display frame CURSOR, optionally using shape defined by POINTER. */
29650 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
29652 #ifdef HAVE_WINDOW_SYSTEM
29653 if (!FRAME_WINDOW_P (f
))
29656 /* Do not change cursor shape while dragging mouse. */
29657 if (EQ (do_mouse_tracking
, Qdragging
))
29660 if (!NILP (pointer
))
29662 if (EQ (pointer
, Qarrow
))
29663 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29664 else if (EQ (pointer
, Qhand
))
29665 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
29666 else if (EQ (pointer
, Qtext
))
29667 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29668 else if (EQ (pointer
, intern ("hdrag")))
29669 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29670 else if (EQ (pointer
, intern ("nhdrag")))
29671 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29672 # ifdef HAVE_X_WINDOWS
29673 else if (EQ (pointer
, intern ("vdrag")))
29674 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29676 else if (EQ (pointer
, intern ("hourglass")))
29677 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
29678 else if (EQ (pointer
, Qmodeline
))
29679 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
29681 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29684 if (cursor
!= No_Cursor
)
29685 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
29689 /* Take proper action when mouse has moved to the mode or header line
29690 or marginal area AREA of window W, x-position X and y-position Y.
29691 X is relative to the start of the text display area of W, so the
29692 width of bitmap areas and scroll bars must be subtracted to get a
29693 position relative to the start of the mode line. */
29696 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
29697 enum window_part area
)
29699 struct window
*w
= XWINDOW (window
);
29700 struct frame
*f
= XFRAME (w
->frame
);
29701 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29702 #ifdef HAVE_WINDOW_SYSTEM
29703 Display_Info
*dpyinfo
;
29705 Cursor cursor
= No_Cursor
;
29706 Lisp_Object pointer
= Qnil
;
29707 int dx
, dy
, width
, height
;
29709 Lisp_Object string
, object
= Qnil
;
29710 Lisp_Object pos UNINIT
;
29711 Lisp_Object mouse_face
;
29712 int original_x_pixel
= x
;
29713 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
29714 struct glyph_row
*row UNINIT
;
29716 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
29721 /* Kludge alert: mode_line_string takes X/Y in pixels, but
29722 returns them in row/column units! */
29723 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
29724 &object
, &dx
, &dy
, &width
, &height
);
29726 row
= (area
== ON_MODE_LINE
29727 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
29728 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
29730 /* Find the glyph under the mouse pointer. */
29731 if (row
->mode_line_p
&& row
->enabled_p
)
29733 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
29734 end
= glyph
+ row
->used
[TEXT_AREA
];
29736 for (x0
= original_x_pixel
;
29737 glyph
< end
&& x0
>= glyph
->pixel_width
;
29739 x0
-= glyph
->pixel_width
;
29747 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
29748 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
29749 returns them in row/column units! */
29750 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
29751 &object
, &dx
, &dy
, &width
, &height
);
29754 Lisp_Object help
= Qnil
;
29756 #ifdef HAVE_WINDOW_SYSTEM
29757 if (IMAGEP (object
))
29759 Lisp_Object image_map
, hotspot
;
29760 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
29762 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
29764 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29768 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
29769 If so, we could look for mouse-enter, mouse-leave
29770 properties in PLIST (and do something...). */
29771 hotspot
= XCDR (hotspot
);
29772 if (CONSP (hotspot
)
29773 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29775 pointer
= Fplist_get (plist
, Qpointer
);
29776 if (NILP (pointer
))
29778 help
= Fplist_get (plist
, Qhelp_echo
);
29781 help_echo_string
= help
;
29782 XSETWINDOW (help_echo_window
, w
);
29783 help_echo_object
= w
->contents
;
29784 help_echo_pos
= charpos
;
29788 if (NILP (pointer
))
29789 pointer
= Fplist_get (XCDR (object
), QCpointer
);
29791 #endif /* HAVE_WINDOW_SYSTEM */
29793 if (STRINGP (string
))
29794 pos
= make_number (charpos
);
29796 /* Set the help text and mouse pointer. If the mouse is on a part
29797 of the mode line without any text (e.g. past the right edge of
29798 the mode line text), use the default help text and pointer. */
29799 if (STRINGP (string
) || area
== ON_MODE_LINE
)
29801 /* Arrange to display the help by setting the global variables
29802 help_echo_string, help_echo_object, and help_echo_pos. */
29805 if (STRINGP (string
))
29806 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
29810 help_echo_string
= help
;
29811 XSETWINDOW (help_echo_window
, w
);
29812 help_echo_object
= string
;
29813 help_echo_pos
= charpos
;
29815 else if (area
== ON_MODE_LINE
)
29817 Lisp_Object default_help
29818 = buffer_local_value (Qmode_line_default_help_echo
,
29821 if (STRINGP (default_help
))
29823 help_echo_string
= default_help
;
29824 XSETWINDOW (help_echo_window
, w
);
29825 help_echo_object
= Qnil
;
29826 help_echo_pos
= -1;
29831 #ifdef HAVE_WINDOW_SYSTEM
29832 /* Change the mouse pointer according to what is under it. */
29833 if (FRAME_WINDOW_P (f
))
29835 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
29837 || NILP (Vresize_mini_windows
));
29839 dpyinfo
= FRAME_DISPLAY_INFO (f
);
29840 if (STRINGP (string
))
29842 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29844 if (NILP (pointer
))
29845 pointer
= Fget_text_property (pos
, Qpointer
, string
);
29847 /* Change the mouse pointer according to what is under X/Y. */
29849 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
29852 map
= Fget_text_property (pos
, Qlocal_map
, string
);
29853 if (!KEYMAPP (map
))
29854 map
= Fget_text_property (pos
, Qkeymap
, string
);
29855 if (!KEYMAPP (map
) && draggable
)
29856 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
29859 else if (draggable
)
29860 /* Default mode-line pointer. */
29861 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29866 /* Change the mouse face according to what is under X/Y. */
29867 bool mouse_face_shown
= false;
29868 if (STRINGP (string
))
29870 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
29871 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
29872 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29877 struct glyph
* tmp_glyph
;
29881 int total_pixel_width
;
29882 ptrdiff_t begpos
, endpos
, ignore
;
29886 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
29887 Qmouse_face
, string
, Qnil
);
29893 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
29895 endpos
= SCHARS (string
);
29899 /* Calculate the glyph position GPOS of GLYPH in the
29900 displayed string, relative to the beginning of the
29901 highlighted part of the string.
29903 Note: GPOS is different from CHARPOS. CHARPOS is the
29904 position of GLYPH in the internal string object. A mode
29905 line string format has structures which are converted to
29906 a flattened string by the Emacs Lisp interpreter. The
29907 internal string is an element of those structures. The
29908 displayed string is the flattened string. */
29909 tmp_glyph
= row_start_glyph
;
29910 while (tmp_glyph
< glyph
29911 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29912 && begpos
<= tmp_glyph
->charpos
29913 && tmp_glyph
->charpos
< endpos
)))
29915 gpos
= glyph
- tmp_glyph
;
29917 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29918 the highlighted part of the displayed string to which
29919 GLYPH belongs. Note: GSEQ_LENGTH is different from
29920 SCHARS (STRING), because the latter returns the length of
29921 the internal string. */
29922 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29924 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29925 && begpos
<= tmp_glyph
->charpos
29926 && tmp_glyph
->charpos
< endpos
));
29929 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29931 /* Calculate the total pixel width of all the glyphs between
29932 the beginning of the highlighted area and GLYPH. */
29933 total_pixel_width
= 0;
29934 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29935 total_pixel_width
+= tmp_glyph
->pixel_width
;
29937 /* Pre calculation of re-rendering position. Note: X is in
29938 column units here, after the call to mode_line_string or
29939 marginal_area_string. */
29941 vpos
= (area
== ON_MODE_LINE
29942 ? (w
->current_matrix
)->nrows
- 1
29945 /* If GLYPH's position is included in the region that is
29946 already drawn in mouse face, we have nothing to do. */
29947 if ( EQ (window
, hlinfo
->mouse_face_window
)
29948 && (!row
->reversed_p
29949 ? (hlinfo
->mouse_face_beg_col
<= hpos
29950 && hpos
< hlinfo
->mouse_face_end_col
)
29951 /* In R2L rows we swap BEG and END, see below. */
29952 : (hlinfo
->mouse_face_end_col
<= hpos
29953 && hpos
< hlinfo
->mouse_face_beg_col
))
29954 && hlinfo
->mouse_face_beg_row
== vpos
)
29957 if (clear_mouse_face (hlinfo
))
29958 cursor
= No_Cursor
;
29960 if (!row
->reversed_p
)
29962 hlinfo
->mouse_face_beg_col
= hpos
;
29963 hlinfo
->mouse_face_beg_x
= original_x_pixel
29964 - (total_pixel_width
+ dx
);
29965 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29966 hlinfo
->mouse_face_end_x
= 0;
29970 /* In R2L rows, show_mouse_face expects BEG and END
29971 coordinates to be swapped. */
29972 hlinfo
->mouse_face_end_col
= hpos
;
29973 hlinfo
->mouse_face_end_x
= original_x_pixel
29974 - (total_pixel_width
+ dx
);
29975 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29976 hlinfo
->mouse_face_beg_x
= 0;
29979 hlinfo
->mouse_face_beg_row
= vpos
;
29980 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29981 hlinfo
->mouse_face_past_end
= false;
29982 hlinfo
->mouse_face_window
= window
;
29984 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29989 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29990 mouse_face_shown
= true;
29992 if (NILP (pointer
))
29997 /* If mouse-face doesn't need to be shown, clear any existing
29999 if ((area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
) && !mouse_face_shown
)
30000 clear_mouse_face (hlinfo
);
30002 define_frame_cursor1 (f
, cursor
, pointer
);
30007 Take proper action when the mouse has moved to position X, Y on
30008 frame F with regards to highlighting portions of display that have
30009 mouse-face properties. Also de-highlight portions of display where
30010 the mouse was before, set the mouse pointer shape as appropriate
30011 for the mouse coordinates, and activate help echo (tooltips).
30012 X and Y can be negative or out of range. */
30015 note_mouse_highlight (struct frame
*f
, int x
, int y
)
30017 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30018 enum window_part part
= ON_NOTHING
;
30019 Lisp_Object window
;
30021 Cursor cursor
= No_Cursor
;
30022 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
30025 /* When a menu is active, don't highlight because this looks odd. */
30026 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
30027 if (popup_activated ())
30031 if (!f
->glyphs_initialized_p
30032 || f
->pointer_invisible
)
30035 hlinfo
->mouse_face_mouse_x
= x
;
30036 hlinfo
->mouse_face_mouse_y
= y
;
30037 hlinfo
->mouse_face_mouse_frame
= f
;
30039 if (hlinfo
->mouse_face_defer
)
30042 /* Which window is that in? */
30043 window
= window_from_coordinates (f
, x
, y
, &part
, true);
30045 /* If displaying active text in another window, clear that. */
30046 if (! EQ (window
, hlinfo
->mouse_face_window
)
30047 /* Also clear if we move out of text area in same window. */
30048 || (!NILP (hlinfo
->mouse_face_window
)
30051 && part
!= ON_MODE_LINE
30052 && part
!= ON_HEADER_LINE
))
30053 clear_mouse_face (hlinfo
);
30055 /* Not on a window -> return. */
30056 if (!WINDOWP (window
))
30059 /* Reset help_echo_string. It will get recomputed below. */
30060 help_echo_string
= Qnil
;
30062 /* Convert to window-relative pixel coordinates. */
30063 w
= XWINDOW (window
);
30064 frame_to_window_pixel_xy (w
, &x
, &y
);
30066 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
30067 /* Handle tool-bar window differently since it doesn't display a
30069 if (EQ (window
, f
->tool_bar_window
))
30071 note_tool_bar_highlight (f
, x
, y
);
30076 /* Mouse is on the mode, header line or margin? */
30077 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
30078 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
30080 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
30082 #ifdef HAVE_WINDOW_SYSTEM
30083 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
30085 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30086 /* Show non-text cursor (Bug#16647). */
30094 #ifdef HAVE_WINDOW_SYSTEM
30095 if (part
== ON_VERTICAL_BORDER
)
30097 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
30098 help_echo_string
= build_string ("drag-mouse-1: resize");
30100 else if (part
== ON_RIGHT_DIVIDER
)
30102 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
30103 help_echo_string
= build_string ("drag-mouse-1: resize");
30105 else if (part
== ON_BOTTOM_DIVIDER
)
30106 if (! WINDOW_BOTTOMMOST_P (w
)
30108 || NILP (Vresize_mini_windows
))
30110 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
30111 help_echo_string
= build_string ("drag-mouse-1: resize");
30114 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30115 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
30116 || part
== ON_VERTICAL_SCROLL_BAR
30117 || part
== ON_HORIZONTAL_SCROLL_BAR
)
30118 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30120 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
30123 /* Are we in a window whose display is up to date?
30124 And verify the buffer's text has not changed. */
30125 b
= XBUFFER (w
->contents
);
30126 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
30128 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
30130 struct glyph
*glyph
;
30131 Lisp_Object object
;
30132 Lisp_Object mouse_face
= Qnil
, position
;
30133 Lisp_Object
*overlay_vec
= NULL
;
30134 ptrdiff_t i
, noverlays
;
30135 struct buffer
*obuf
;
30136 ptrdiff_t obegv
, ozv
;
30139 /* Find the glyph under X/Y. */
30140 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
30142 #ifdef HAVE_WINDOW_SYSTEM
30143 /* Look for :pointer property on image. */
30144 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
30146 struct image
*img
= IMAGE_OPT_FROM_ID (f
, glyph
->u
.img_id
);
30147 if (img
!= NULL
&& IMAGEP (img
->spec
))
30149 Lisp_Object image_map
, hotspot
;
30150 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
30152 && (hotspot
= find_hot_spot (image_map
,
30153 glyph
->slice
.img
.x
+ dx
,
30154 glyph
->slice
.img
.y
+ dy
),
30156 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
30160 /* Could check XCAR (hotspot) to see if we enter/leave
30162 If so, we could look for mouse-enter, mouse-leave
30163 properties in PLIST (and do something...). */
30164 hotspot
= XCDR (hotspot
);
30165 if (CONSP (hotspot
)
30166 && (plist
= XCAR (hotspot
), CONSP (plist
)))
30168 pointer
= Fplist_get (plist
, Qpointer
);
30169 if (NILP (pointer
))
30171 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
30172 if (!NILP (help_echo_string
))
30174 help_echo_window
= window
;
30175 help_echo_object
= glyph
->object
;
30176 help_echo_pos
= glyph
->charpos
;
30180 if (NILP (pointer
))
30181 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
30184 #endif /* HAVE_WINDOW_SYSTEM */
30186 /* Clear mouse face if X/Y not over text. */
30188 || area
!= TEXT_AREA
30189 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
30190 /* Glyph's OBJECT is nil for glyphs inserted by the
30191 display engine for its internal purposes, like truncation
30192 and continuation glyphs and blanks beyond the end of
30193 line's text on text terminals. If we are over such a
30194 glyph, we are not over any text. */
30195 || NILP (glyph
->object
)
30196 /* R2L rows have a stretch glyph at their front, which
30197 stands for no text, whereas L2R rows have no glyphs at
30198 all beyond the end of text. Treat such stretch glyphs
30199 like we do with NULL glyphs in L2R rows. */
30200 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
30201 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
30202 && glyph
->type
== STRETCH_GLYPH
30203 && glyph
->avoid_cursor_p
))
30205 if (clear_mouse_face (hlinfo
))
30206 cursor
= No_Cursor
;
30207 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30209 #ifdef HAVE_WINDOW_SYSTEM
30210 if (area
!= TEXT_AREA
)
30211 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30213 pointer
= Vvoid_text_area_pointer
;
30219 pos
= glyph
->charpos
;
30220 object
= glyph
->object
;
30221 if (!STRINGP (object
) && !BUFFERP (object
))
30224 /* If we get an out-of-range value, return now; avoid an error. */
30225 if (BUFFERP (object
) && pos
> BUF_Z (b
))
30228 /* Make the window's buffer temporarily current for
30229 overlays_at and compute_char_face. */
30230 obuf
= current_buffer
;
30231 current_buffer
= b
;
30237 /* Is this char mouse-active or does it have help-echo? */
30238 position
= make_number (pos
);
30242 if (BUFFERP (object
))
30244 /* Put all the overlays we want in a vector in overlay_vec. */
30245 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, false);
30246 /* Sort overlays into increasing priority order. */
30247 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
30252 if (NILP (Vmouse_highlight
))
30254 clear_mouse_face (hlinfo
);
30255 goto check_help_echo
;
30258 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
30261 cursor
= No_Cursor
;
30263 /* Check mouse-face highlighting. */
30265 /* If there exists an overlay with mouse-face overlapping
30266 the one we are currently highlighting, we have to
30267 check if we enter the overlapping overlay, and then
30268 highlight only that. */
30269 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
30270 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
30272 /* Find the highest priority overlay with a mouse-face. */
30273 Lisp_Object overlay
= Qnil
;
30274 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
30276 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
30277 if (!NILP (mouse_face
))
30278 overlay
= overlay_vec
[i
];
30281 /* If we're highlighting the same overlay as before, there's
30282 no need to do that again. */
30283 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
30284 goto check_help_echo
;
30285 hlinfo
->mouse_face_overlay
= overlay
;
30287 /* Clear the display of the old active region, if any. */
30288 if (clear_mouse_face (hlinfo
))
30289 cursor
= No_Cursor
;
30291 /* If no overlay applies, get a text property. */
30292 if (NILP (overlay
))
30293 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
30295 /* Next, compute the bounds of the mouse highlighting and
30297 if (!NILP (mouse_face
) && STRINGP (object
))
30299 /* The mouse-highlighting comes from a display string
30300 with a mouse-face. */
30304 s
= Fprevious_single_property_change
30305 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
30306 e
= Fnext_single_property_change
30307 (position
, Qmouse_face
, object
, Qnil
);
30309 s
= make_number (0);
30311 e
= make_number (SCHARS (object
));
30312 mouse_face_from_string_pos (w
, hlinfo
, object
,
30313 XINT (s
), XINT (e
));
30314 hlinfo
->mouse_face_past_end
= false;
30315 hlinfo
->mouse_face_window
= window
;
30316 hlinfo
->mouse_face_face_id
30317 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
30318 glyph
->face_id
, true);
30319 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
30320 cursor
= No_Cursor
;
30324 /* The mouse-highlighting, if any, comes from an overlay
30325 or text property in the buffer. */
30326 Lisp_Object buffer UNINIT
;
30327 Lisp_Object disp_string UNINIT
;
30329 if (STRINGP (object
))
30331 /* If we are on a display string with no mouse-face,
30332 check if the text under it has one. */
30333 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
30334 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30335 pos
= string_buffer_position (object
, start
);
30338 mouse_face
= get_char_property_and_overlay
30339 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
30340 buffer
= w
->contents
;
30341 disp_string
= object
;
30347 disp_string
= Qnil
;
30350 if (!NILP (mouse_face
))
30352 Lisp_Object before
, after
;
30353 Lisp_Object before_string
, after_string
;
30354 /* To correctly find the limits of mouse highlight
30355 in a bidi-reordered buffer, we must not use the
30356 optimization of limiting the search in
30357 previous-single-property-change and
30358 next-single-property-change, because
30359 rows_from_pos_range needs the real start and end
30360 positions to DTRT in this case. That's because
30361 the first row visible in a window does not
30362 necessarily display the character whose position
30363 is the smallest. */
30365 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
30366 ? Fmarker_position (w
->start
)
30369 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
30370 ? make_number (BUF_Z (XBUFFER (buffer
))
30371 - w
->window_end_pos
)
30374 if (NILP (overlay
))
30376 /* Handle the text property case. */
30377 before
= Fprevious_single_property_change
30378 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
30379 after
= Fnext_single_property_change
30380 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
30381 before_string
= after_string
= Qnil
;
30385 /* Handle the overlay case. */
30386 before
= Foverlay_start (overlay
);
30387 after
= Foverlay_end (overlay
);
30388 before_string
= Foverlay_get (overlay
, Qbefore_string
);
30389 after_string
= Foverlay_get (overlay
, Qafter_string
);
30391 if (!STRINGP (before_string
)) before_string
= Qnil
;
30392 if (!STRINGP (after_string
)) after_string
= Qnil
;
30395 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
30398 : XFASTINT (before
),
30400 ? BUF_Z (XBUFFER (buffer
))
30401 : XFASTINT (after
),
30402 before_string
, after_string
,
30404 cursor
= No_Cursor
;
30411 /* Look for a `help-echo' property. */
30412 if (NILP (help_echo_string
)) {
30413 Lisp_Object help
, overlay
;
30415 /* Check overlays first. */
30416 help
= overlay
= Qnil
;
30417 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
30419 overlay
= overlay_vec
[i
];
30420 help
= Foverlay_get (overlay
, Qhelp_echo
);
30425 help_echo_string
= help
;
30426 help_echo_window
= window
;
30427 help_echo_object
= overlay
;
30428 help_echo_pos
= pos
;
30432 Lisp_Object obj
= glyph
->object
;
30433 ptrdiff_t charpos
= glyph
->charpos
;
30435 /* Try text properties. */
30438 && charpos
< SCHARS (obj
))
30440 help
= Fget_text_property (make_number (charpos
),
30444 /* If the string itself doesn't specify a help-echo,
30445 see if the buffer text ``under'' it does. */
30446 struct glyph_row
*r
30447 = MATRIX_ROW (w
->current_matrix
, vpos
);
30448 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30449 ptrdiff_t p
= string_buffer_position (obj
, start
);
30452 help
= Fget_char_property (make_number (p
),
30453 Qhelp_echo
, w
->contents
);
30462 else if (BUFFERP (obj
)
30465 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
30470 help_echo_string
= help
;
30471 help_echo_window
= window
;
30472 help_echo_object
= obj
;
30473 help_echo_pos
= charpos
;
30478 #ifdef HAVE_WINDOW_SYSTEM
30479 /* Look for a `pointer' property. */
30480 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30482 /* Check overlays first. */
30483 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
30484 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
30486 if (NILP (pointer
))
30488 Lisp_Object obj
= glyph
->object
;
30489 ptrdiff_t charpos
= glyph
->charpos
;
30491 /* Try text properties. */
30494 && charpos
< SCHARS (obj
))
30496 pointer
= Fget_text_property (make_number (charpos
),
30498 if (NILP (pointer
))
30500 /* If the string itself doesn't specify a pointer,
30501 see if the buffer text ``under'' it does. */
30502 struct glyph_row
*r
30503 = MATRIX_ROW (w
->current_matrix
, vpos
);
30504 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30505 ptrdiff_t p
= string_buffer_position (obj
, start
);
30507 pointer
= Fget_char_property (make_number (p
),
30508 Qpointer
, w
->contents
);
30511 else if (BUFFERP (obj
)
30514 pointer
= Fget_text_property (make_number (charpos
),
30518 #endif /* HAVE_WINDOW_SYSTEM */
30522 current_buffer
= obuf
;
30527 define_frame_cursor1 (f
, cursor
, pointer
);
30532 Clear any mouse-face on window W. This function is part of the
30533 redisplay interface, and is called from try_window_id and similar
30534 functions to ensure the mouse-highlight is off. */
30537 x_clear_window_mouse_face (struct window
*w
)
30539 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
30540 Lisp_Object window
;
30543 XSETWINDOW (window
, w
);
30544 if (EQ (window
, hlinfo
->mouse_face_window
))
30545 clear_mouse_face (hlinfo
);
30551 Just discard the mouse face information for frame F, if any.
30552 This is used when the size of F is changed. */
30555 cancel_mouse_face (struct frame
*f
)
30557 Lisp_Object window
;
30558 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30560 window
= hlinfo
->mouse_face_window
;
30561 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
30562 reset_mouse_highlight (hlinfo
);
30567 /***********************************************************************
30569 ***********************************************************************/
30571 #ifdef HAVE_WINDOW_SYSTEM
30573 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
30574 which intersects rectangle R. R is in window-relative coordinates. */
30577 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
30578 enum glyph_row_area area
)
30580 struct glyph
*first
= row
->glyphs
[area
];
30581 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
30582 struct glyph
*last
;
30583 int first_x
, start_x
, x
;
30585 if (area
== TEXT_AREA
&& row
->fill_line_p
)
30586 /* If row extends face to end of line write the whole line. */
30587 draw_glyphs (w
, 0, row
, area
,
30588 0, row
->used
[area
],
30589 DRAW_NORMAL_TEXT
, 0);
30592 /* Set START_X to the window-relative start position for drawing glyphs of
30593 AREA. The first glyph of the text area can be partially visible.
30594 The first glyphs of other areas cannot. */
30595 start_x
= window_box_left_offset (w
, area
);
30597 if (area
== TEXT_AREA
)
30600 /* Find the first glyph that must be redrawn. */
30602 && x
+ first
->pixel_width
< r
->x
)
30604 x
+= first
->pixel_width
;
30608 /* Find the last one. */
30611 /* Use a signed int intermediate value to avoid catastrophic
30612 failures due to comparison between signed and unsigned, when
30613 x is negative (can happen for wide images that are hscrolled). */
30614 int r_end
= r
->x
+ r
->width
;
30615 while (last
< end
&& x
< r_end
)
30617 x
+= last
->pixel_width
;
30623 draw_glyphs (w
, first_x
- start_x
, row
, area
,
30624 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
30625 DRAW_NORMAL_TEXT
, 0);
30630 /* Redraw the parts of the glyph row ROW on window W intersecting
30631 rectangle R. R is in window-relative coordinates. Value is
30632 true if mouse-face was overwritten. */
30635 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
30637 eassert (row
->enabled_p
);
30639 if (row
->mode_line_p
|| w
->pseudo_window_p
)
30640 draw_glyphs (w
, 0, row
, TEXT_AREA
,
30641 0, row
->used
[TEXT_AREA
],
30642 DRAW_NORMAL_TEXT
, 0);
30645 if (row
->used
[LEFT_MARGIN_AREA
])
30646 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
30647 if (row
->used
[TEXT_AREA
])
30648 expose_area (w
, row
, r
, TEXT_AREA
);
30649 if (row
->used
[RIGHT_MARGIN_AREA
])
30650 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
30651 draw_row_fringe_bitmaps (w
, row
);
30654 return row
->mouse_face_p
;
30658 /* Redraw those parts of glyphs rows during expose event handling that
30659 overlap other rows. Redrawing of an exposed line writes over parts
30660 of lines overlapping that exposed line; this function fixes that.
30662 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
30663 row in W's current matrix that is exposed and overlaps other rows.
30664 LAST_OVERLAPPING_ROW is the last such row. */
30667 expose_overlaps (struct window
*w
,
30668 struct glyph_row
*first_overlapping_row
,
30669 struct glyph_row
*last_overlapping_row
,
30672 struct glyph_row
*row
;
30674 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
30675 if (row
->overlapping_p
)
30677 eassert (row
->enabled_p
&& !row
->mode_line_p
);
30680 if (row
->used
[LEFT_MARGIN_AREA
])
30681 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
30683 if (row
->used
[TEXT_AREA
])
30684 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
30686 if (row
->used
[RIGHT_MARGIN_AREA
])
30687 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
30693 /* Return true if W's cursor intersects rectangle R. */
30696 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
30698 XRectangle cr
, result
;
30699 struct glyph
*cursor_glyph
;
30700 struct glyph_row
*row
;
30702 if (w
->phys_cursor
.vpos
>= 0
30703 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
30704 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
30706 && row
->cursor_in_fringe_p
)
30708 /* Cursor is in the fringe. */
30709 cr
.x
= window_box_right_offset (w
,
30710 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
30711 ? RIGHT_MARGIN_AREA
30714 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
30715 cr
.height
= row
->height
;
30716 return x_intersect_rectangles (&cr
, r
, &result
);
30719 cursor_glyph
= get_phys_cursor_glyph (w
);
30722 /* r is relative to W's box, but w->phys_cursor.x is relative
30723 to left edge of W's TEXT area. Adjust it. */
30724 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
30725 cr
.y
= w
->phys_cursor
.y
;
30726 cr
.width
= cursor_glyph
->pixel_width
;
30727 cr
.height
= w
->phys_cursor_height
;
30728 /* ++KFS: W32 version used W32-specific IntersectRect here, but
30729 I assume the effect is the same -- and this is portable. */
30730 return x_intersect_rectangles (&cr
, r
, &result
);
30732 /* If we don't understand the format, pretend we're not in the hot-spot. */
30738 Draw a vertical window border to the right of window W if W doesn't
30739 have vertical scroll bars. */
30742 x_draw_vertical_border (struct window
*w
)
30744 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30746 /* We could do better, if we knew what type of scroll-bar the adjacent
30747 windows (on either side) have... But we don't :-(
30748 However, I think this works ok. ++KFS 2003-04-25 */
30750 /* Redraw borders between horizontally adjacent windows. Don't
30751 do it for frames with vertical scroll bars because either the
30752 right scroll bar of a window, or the left scroll bar of its
30753 neighbor will suffice as a border. */
30754 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
30757 /* Note: It is necessary to redraw both the left and the right
30758 borders, for when only this single window W is being
30760 if (!WINDOW_RIGHTMOST_P (w
)
30761 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
30763 int x0
, x1
, y0
, y1
;
30765 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30768 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30771 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
30774 if (!WINDOW_LEFTMOST_P (w
)
30775 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
30777 int x0
, x1
, y0
, y1
;
30779 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30782 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30785 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
30790 /* Draw window dividers for window W. */
30793 x_draw_right_divider (struct window
*w
)
30795 struct frame
*f
= WINDOW_XFRAME (w
);
30797 if (w
->mini
|| w
->pseudo_window_p
)
30799 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30801 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
30802 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30803 int y0
= WINDOW_TOP_EDGE_Y (w
);
30804 /* The bottom divider prevails. */
30805 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30807 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30812 x_draw_bottom_divider (struct window
*w
)
30814 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30816 if (w
->mini
|| w
->pseudo_window_p
)
30818 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30820 int x0
= WINDOW_LEFT_EDGE_X (w
);
30821 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30822 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30823 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
30825 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30829 /* Redraw the part of window W intersection rectangle FR. Pixel
30830 coordinates in FR are frame-relative. Call this function with
30831 input blocked. Value is true if the exposure overwrites
30835 expose_window (struct window
*w
, XRectangle
*fr
)
30837 struct frame
*f
= XFRAME (w
->frame
);
30839 bool mouse_face_overwritten_p
= false;
30841 /* If window is not yet fully initialized, do nothing. This can
30842 happen when toolkit scroll bars are used and a window is split.
30843 Reconfiguring the scroll bar will generate an expose for a newly
30845 if (w
->current_matrix
== NULL
)
30848 /* When we're currently updating the window, display and current
30849 matrix usually don't agree. Arrange for a thorough display
30851 if (w
->must_be_updated_p
)
30853 SET_FRAME_GARBAGED (f
);
30857 /* Frame-relative pixel rectangle of W. */
30858 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
30859 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
30860 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
30861 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
30863 if (x_intersect_rectangles (fr
, &wr
, &r
))
30865 int yb
= window_text_bottom_y (w
);
30866 struct glyph_row
*row
;
30867 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
30869 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
30870 r
.x
, r
.y
, r
.width
, r
.height
));
30872 /* Convert to window coordinates. */
30873 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
30874 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
30876 /* Turn off the cursor. */
30877 bool cursor_cleared_p
= (!w
->pseudo_window_p
30878 && phys_cursor_in_rect_p (w
, &r
));
30879 if (cursor_cleared_p
)
30880 x_clear_cursor (w
);
30882 /* If the row containing the cursor extends face to end of line,
30883 then expose_area might overwrite the cursor outside the
30884 rectangle and thus notice_overwritten_cursor might clear
30885 w->phys_cursor_on_p. We remember the original value and
30886 check later if it is changed. */
30887 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
30889 /* Use a signed int intermediate value to avoid catastrophic
30890 failures due to comparison between signed and unsigned, when
30891 y0 or y1 is negative (can happen for tall images). */
30892 int r_bottom
= r
.y
+ r
.height
;
30894 /* Update lines intersecting rectangle R. */
30895 first_overlapping_row
= last_overlapping_row
= NULL
;
30896 for (row
= w
->current_matrix
->rows
;
30901 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
30903 if ((y0
>= r
.y
&& y0
< r_bottom
)
30904 || (y1
> r
.y
&& y1
< r_bottom
)
30905 || (r
.y
>= y0
&& r
.y
< y1
)
30906 || (r_bottom
> y0
&& r_bottom
< y1
))
30908 /* A header line may be overlapping, but there is no need
30909 to fix overlapping areas for them. KFS 2005-02-12 */
30910 if (row
->overlapping_p
&& !row
->mode_line_p
)
30912 if (first_overlapping_row
== NULL
)
30913 first_overlapping_row
= row
;
30914 last_overlapping_row
= row
;
30918 if (expose_line (w
, row
, &r
))
30919 mouse_face_overwritten_p
= true;
30922 else if (row
->overlapping_p
)
30924 /* We must redraw a row overlapping the exposed area. */
30926 ? y0
+ row
->phys_height
> r
.y
30927 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30929 if (first_overlapping_row
== NULL
)
30930 first_overlapping_row
= row
;
30931 last_overlapping_row
= row
;
30939 /* Display the mode line if there is one. */
30940 if (WINDOW_WANTS_MODELINE_P (w
)
30941 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30943 && row
->y
< r_bottom
)
30945 if (expose_line (w
, row
, &r
))
30946 mouse_face_overwritten_p
= true;
30949 if (!w
->pseudo_window_p
)
30951 /* Fix the display of overlapping rows. */
30952 if (first_overlapping_row
)
30953 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30956 /* Draw border between windows. */
30957 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30958 x_draw_right_divider (w
);
30960 x_draw_vertical_border (w
);
30962 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30963 x_draw_bottom_divider (w
);
30965 /* Turn the cursor on again. */
30966 if (cursor_cleared_p
30967 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30968 update_window_cursor (w
, true);
30972 return mouse_face_overwritten_p
;
30977 /* Redraw (parts) of all windows in the window tree rooted at W that
30978 intersect R. R contains frame pixel coordinates. Value is
30979 true if the exposure overwrites mouse-face. */
30982 expose_window_tree (struct window
*w
, XRectangle
*r
)
30984 struct frame
*f
= XFRAME (w
->frame
);
30985 bool mouse_face_overwritten_p
= false;
30987 while (w
&& !FRAME_GARBAGED_P (f
))
30989 mouse_face_overwritten_p
30990 |= (WINDOWP (w
->contents
)
30991 ? expose_window_tree (XWINDOW (w
->contents
), r
)
30992 : expose_window (w
, r
));
30994 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
30997 return mouse_face_overwritten_p
;
31002 Redisplay an exposed area of frame F. X and Y are the upper-left
31003 corner of the exposed rectangle. W and H are width and height of
31004 the exposed area. All are pixel values. W or H zero means redraw
31005 the entire frame. */
31008 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
31011 bool mouse_face_overwritten_p
= false;
31013 TRACE ((stderr
, "expose_frame "));
31015 /* No need to redraw if frame will be redrawn soon. */
31016 if (FRAME_GARBAGED_P (f
))
31018 TRACE ((stderr
, " garbaged\n"));
31022 /* If basic faces haven't been realized yet, there is no point in
31023 trying to redraw anything. This can happen when we get an expose
31024 event while Emacs is starting, e.g. by moving another window. */
31025 if (FRAME_FACE_CACHE (f
) == NULL
31026 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
31028 TRACE ((stderr
, " no faces\n"));
31032 if (w
== 0 || h
== 0)
31035 r
.width
= FRAME_TEXT_WIDTH (f
);
31036 r
.height
= FRAME_TEXT_HEIGHT (f
);
31046 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
31047 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
31049 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
31050 if (WINDOWP (f
->tool_bar_window
))
31051 mouse_face_overwritten_p
31052 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
31055 #ifdef HAVE_X_WINDOWS
31057 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
31058 if (WINDOWP (f
->menu_bar_window
))
31059 mouse_face_overwritten_p
31060 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
31061 #endif /* not USE_X_TOOLKIT and not USE_GTK */
31065 /* Some window managers support a focus-follows-mouse style with
31066 delayed raising of frames. Imagine a partially obscured frame,
31067 and moving the mouse into partially obscured mouse-face on that
31068 frame. The visible part of the mouse-face will be highlighted,
31069 then the WM raises the obscured frame. With at least one WM, KDE
31070 2.1, Emacs is not getting any event for the raising of the frame
31071 (even tried with SubstructureRedirectMask), only Expose events.
31072 These expose events will draw text normally, i.e. not
31073 highlighted. Which means we must redo the highlight here.
31074 Subsume it under ``we love X''. --gerd 2001-08-15 */
31075 /* Included in Windows version because Windows most likely does not
31076 do the right thing if any third party tool offers
31077 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
31078 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
31080 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
31081 if (f
== hlinfo
->mouse_face_mouse_frame
)
31083 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
31084 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
31085 clear_mouse_face (hlinfo
);
31086 note_mouse_highlight (f
, mouse_x
, mouse_y
);
31093 Determine the intersection of two rectangles R1 and R2. Return
31094 the intersection in *RESULT. Value is true if RESULT is not
31098 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
31100 XRectangle
*left
, *right
;
31101 XRectangle
*upper
, *lower
;
31102 bool intersection_p
= false;
31104 /* Rearrange so that R1 is the left-most rectangle. */
31106 left
= r1
, right
= r2
;
31108 left
= r2
, right
= r1
;
31110 /* X0 of the intersection is right.x0, if this is inside R1,
31111 otherwise there is no intersection. */
31112 if (right
->x
<= left
->x
+ left
->width
)
31114 result
->x
= right
->x
;
31116 /* The right end of the intersection is the minimum of
31117 the right ends of left and right. */
31118 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
31121 /* Same game for Y. */
31123 upper
= r1
, lower
= r2
;
31125 upper
= r2
, lower
= r1
;
31127 /* The upper end of the intersection is lower.y0, if this is inside
31128 of upper. Otherwise, there is no intersection. */
31129 if (lower
->y
<= upper
->y
+ upper
->height
)
31131 result
->y
= lower
->y
;
31133 /* The lower end of the intersection is the minimum of the lower
31134 ends of upper and lower. */
31135 result
->height
= (min (lower
->y
+ lower
->height
,
31136 upper
->y
+ upper
->height
)
31138 intersection_p
= true;
31142 return intersection_p
;
31145 #endif /* HAVE_WINDOW_SYSTEM */
31148 /***********************************************************************
31150 ***********************************************************************/
31153 syms_of_xdisp (void)
31155 Vwith_echo_area_save_vector
= Qnil
;
31156 staticpro (&Vwith_echo_area_save_vector
);
31158 Vmessage_stack
= Qnil
;
31159 staticpro (&Vmessage_stack
);
31161 /* Non-nil means don't actually do any redisplay. */
31162 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
31164 DEFSYM (Qredisplay_internal_xC_functionx
, "redisplay_internal (C function)");
31166 DEFVAR_BOOL("inhibit-message", inhibit_message
,
31167 doc
: /* Non-nil means calls to `message' are not displayed.
31168 They are still logged to the *Messages* buffer. */);
31169 inhibit_message
= 0;
31171 message_dolog_marker1
= Fmake_marker ();
31172 staticpro (&message_dolog_marker1
);
31173 message_dolog_marker2
= Fmake_marker ();
31174 staticpro (&message_dolog_marker2
);
31175 message_dolog_marker3
= Fmake_marker ();
31176 staticpro (&message_dolog_marker3
);
31179 defsubr (&Sdump_frame_glyph_matrix
);
31180 defsubr (&Sdump_glyph_matrix
);
31181 defsubr (&Sdump_glyph_row
);
31182 defsubr (&Sdump_tool_bar_row
);
31183 defsubr (&Strace_redisplay
);
31184 defsubr (&Strace_to_stderr
);
31186 #ifdef HAVE_WINDOW_SYSTEM
31187 defsubr (&Stool_bar_height
);
31188 defsubr (&Slookup_image_map
);
31190 defsubr (&Sline_pixel_height
);
31191 defsubr (&Sformat_mode_line
);
31192 defsubr (&Sinvisible_p
);
31193 defsubr (&Scurrent_bidi_paragraph_direction
);
31194 defsubr (&Swindow_text_pixel_size
);
31195 defsubr (&Smove_point_visually
);
31196 defsubr (&Sbidi_find_overridden_directionality
);
31198 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
31199 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
31200 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
31201 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
31202 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
31203 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
31204 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
31205 DEFSYM (Qeval
, "eval");
31206 DEFSYM (QCdata
, ":data");
31208 /* Names of text properties relevant for redisplay. */
31209 DEFSYM (Qdisplay
, "display");
31210 DEFSYM (Qspace_width
, "space-width");
31211 DEFSYM (Qraise
, "raise");
31212 DEFSYM (Qslice
, "slice");
31213 DEFSYM (Qspace
, "space");
31214 DEFSYM (Qmargin
, "margin");
31215 DEFSYM (Qpointer
, "pointer");
31216 DEFSYM (Qleft_margin
, "left-margin");
31217 DEFSYM (Qright_margin
, "right-margin");
31218 DEFSYM (Qcenter
, "center");
31219 DEFSYM (Qline_height
, "line-height");
31220 DEFSYM (QCalign_to
, ":align-to");
31221 DEFSYM (QCrelative_width
, ":relative-width");
31222 DEFSYM (QCrelative_height
, ":relative-height");
31223 DEFSYM (QCeval
, ":eval");
31224 DEFSYM (QCpropertize
, ":propertize");
31225 DEFSYM (QCfile
, ":file");
31226 DEFSYM (Qfontified
, "fontified");
31227 DEFSYM (Qfontification_functions
, "fontification-functions");
31229 /* Name of the face used to highlight trailing whitespace. */
31230 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
31232 /* Name and number of the face used to highlight escape glyphs. */
31233 DEFSYM (Qescape_glyph
, "escape-glyph");
31235 /* Name and number of the face used to highlight non-breaking
31237 DEFSYM (Qnobreak_space
, "nobreak-space");
31238 DEFSYM (Qnobreak_hyphen
, "nobreak-hyphen");
31240 /* The symbol 'image' which is the car of the lists used to represent
31241 images in Lisp. Also a tool bar style. */
31242 DEFSYM (Qimage
, "image");
31244 /* Tool bar styles. */
31245 DEFSYM (Qtext
, "text");
31246 DEFSYM (Qboth
, "both");
31247 DEFSYM (Qboth_horiz
, "both-horiz");
31248 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
31250 /* The image map types. */
31251 DEFSYM (QCmap
, ":map");
31252 DEFSYM (QCpointer
, ":pointer");
31253 DEFSYM (Qrect
, "rect");
31254 DEFSYM (Qcircle
, "circle");
31255 DEFSYM (Qpoly
, "poly");
31257 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
31259 DEFSYM (Qgrow_only
, "grow-only");
31260 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
31261 DEFSYM (Qposition
, "position");
31262 DEFSYM (Qbuffer_position
, "buffer-position");
31263 DEFSYM (Qobject
, "object");
31265 /* Cursor shapes. */
31266 DEFSYM (Qbar
, "bar");
31267 DEFSYM (Qhbar
, "hbar");
31268 DEFSYM (Qbox
, "box");
31269 DEFSYM (Qhollow
, "hollow");
31271 /* Pointer shapes. */
31272 DEFSYM (Qhand
, "hand");
31273 DEFSYM (Qarrow
, "arrow");
31276 DEFSYM (Qdragging
, "dragging");
31278 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
31280 list_of_error
= list1 (list2 (Qerror
, Qvoid_variable
));
31281 staticpro (&list_of_error
);
31283 /* Values of those variables at last redisplay are stored as
31284 properties on 'overlay-arrow-position' symbol. However, if
31285 Voverlay_arrow_position is a marker, last-arrow-position is its
31286 numerical position. */
31287 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
31288 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
31290 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
31291 properties on a symbol in overlay-arrow-variable-list. */
31292 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
31293 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
31295 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
31296 staticpro (&echo_buffer
[0]);
31297 staticpro (&echo_buffer
[1]);
31299 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
31300 staticpro (&echo_area_buffer
[0]);
31301 staticpro (&echo_area_buffer
[1]);
31303 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
31304 staticpro (&Vmessages_buffer_name
);
31306 mode_line_proptrans_alist
= Qnil
;
31307 staticpro (&mode_line_proptrans_alist
);
31308 mode_line_string_list
= Qnil
;
31309 staticpro (&mode_line_string_list
);
31310 mode_line_string_face
= Qnil
;
31311 staticpro (&mode_line_string_face
);
31312 mode_line_string_face_prop
= Qnil
;
31313 staticpro (&mode_line_string_face_prop
);
31314 Vmode_line_unwind_vector
= Qnil
;
31315 staticpro (&Vmode_line_unwind_vector
);
31317 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
31319 help_echo_string
= Qnil
;
31320 staticpro (&help_echo_string
);
31321 help_echo_object
= Qnil
;
31322 staticpro (&help_echo_object
);
31323 help_echo_window
= Qnil
;
31324 staticpro (&help_echo_window
);
31325 previous_help_echo_string
= Qnil
;
31326 staticpro (&previous_help_echo_string
);
31327 help_echo_pos
= -1;
31329 DEFSYM (Qright_to_left
, "right-to-left");
31330 DEFSYM (Qleft_to_right
, "left-to-right");
31331 defsubr (&Sbidi_resolved_levels
);
31333 #ifdef HAVE_WINDOW_SYSTEM
31334 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
31335 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
31336 For example, if a block cursor is over a tab, it will be drawn as
31337 wide as that tab on the display. */);
31338 x_stretch_cursor_p
= 0;
31341 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
31342 doc
: /* Non-nil means highlight trailing whitespace.
31343 The face used for trailing whitespace is `trailing-whitespace'. */);
31344 Vshow_trailing_whitespace
= Qnil
;
31346 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
31347 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
31348 If the value is t, Emacs highlights non-ASCII chars which have the
31349 same appearance as an ASCII space or hyphen, using the `nobreak-space'
31350 or `nobreak-hyphen' face respectively.
31352 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
31353 U+2011 (non-breaking hyphen) are affected.
31355 Any other non-nil value means to display these characters as a escape
31356 glyph followed by an ordinary space or hyphen.
31358 A value of nil means no special handling of these characters. */);
31359 Vnobreak_char_display
= Qt
;
31361 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
31362 doc
: /* The pointer shape to show in void text areas.
31363 A value of nil means to show the text pointer. Other options are
31364 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
31366 Vvoid_text_area_pointer
= Qarrow
;
31368 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
31369 doc
: /* Non-nil means don't actually do any redisplay.
31370 This is used for internal purposes. */);
31371 Vinhibit_redisplay
= Qnil
;
31373 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
31374 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
31375 Vglobal_mode_string
= Qnil
;
31377 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
31378 doc
: /* Marker for where to display an arrow on top of the buffer text.
31379 This must be the beginning of a line in order to work.
31380 See also `overlay-arrow-string'. */);
31381 Voverlay_arrow_position
= Qnil
;
31383 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
31384 doc
: /* String to display as an arrow in non-window frames.
31385 See also `overlay-arrow-position'. */);
31386 Voverlay_arrow_string
= build_pure_c_string ("=>");
31388 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
31389 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
31390 The symbols on this list are examined during redisplay to determine
31391 where to display overlay arrows. */);
31392 Voverlay_arrow_variable_list
31393 = list1 (intern_c_string ("overlay-arrow-position"));
31395 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
31396 doc
: /* The number of lines to try scrolling a window by when point moves out.
31397 If that fails to bring point back on frame, point is centered instead.
31398 If this is zero, point is always centered after it moves off frame.
31399 If you want scrolling to always be a line at a time, you should set
31400 `scroll-conservatively' to a large value rather than set this to 1. */);
31402 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
31403 doc
: /* Scroll up to this many lines, to bring point back on screen.
31404 If point moves off-screen, redisplay will scroll by up to
31405 `scroll-conservatively' lines in order to bring point just barely
31406 onto the screen again. If that cannot be done, then redisplay
31407 recenters point as usual.
31409 If the value is greater than 100, redisplay will never recenter point,
31410 but will always scroll just enough text to bring point into view, even
31411 if you move far away.
31413 A value of zero means always recenter point if it moves off screen. */);
31414 scroll_conservatively
= 0;
31416 DEFVAR_INT ("scroll-margin", scroll_margin
,
31417 doc
: /* Number of lines of margin at the top and bottom of a window.
31418 Recenter the window whenever point gets within this many lines
31419 of the top or bottom of the window. */);
31422 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
31423 doc
: /* Pixels per inch value for non-window system displays.
31424 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
31425 Vdisplay_pixels_per_inch
= make_float (72.0);
31428 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
31431 DEFVAR_LISP ("truncate-partial-width-windows",
31432 Vtruncate_partial_width_windows
,
31433 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
31434 For an integer value, truncate lines in each window narrower than the
31435 full frame width, provided the total window width in column units is less
31436 than that integer; otherwise, respect the value of `truncate-lines'.
31437 The total width of the window is as returned by `window-total-width', it
31438 includes the fringes, the continuation and truncation glyphs, the
31439 display margins (if any), and the scroll bar
31441 For any other non-nil value, truncate lines in all windows that do
31442 not span the full frame width.
31444 A value of nil means to respect the value of `truncate-lines'.
31446 If `word-wrap' is enabled, you might want to reduce this. */);
31447 Vtruncate_partial_width_windows
= make_number (50);
31449 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
31450 doc
: /* Maximum buffer size for which line number should be displayed.
31451 If the buffer is bigger than this, the line number does not appear
31452 in the mode line. A value of nil means no limit. */);
31453 Vline_number_display_limit
= Qnil
;
31455 DEFVAR_INT ("line-number-display-limit-width",
31456 line_number_display_limit_width
,
31457 doc
: /* Maximum line width (in characters) for line number display.
31458 If the average length of the lines near point is bigger than this, then the
31459 line number may be omitted from the mode line. */);
31460 line_number_display_limit_width
= 200;
31462 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
31463 doc
: /* Non-nil means highlight region even in nonselected windows. */);
31464 highlight_nonselected_windows
= false;
31466 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
31467 doc
: /* Non-nil if more than one frame is visible on this display.
31468 Minibuffer-only frames don't count, but iconified frames do.
31469 This variable is not guaranteed to be accurate except while processing
31470 `frame-title-format' and `icon-title-format'. */);
31472 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
31473 doc
: /* Template for displaying the title bar of visible frames.
31474 \(Assuming the window manager supports this feature.)
31476 This variable has the same structure as `mode-line-format', except that
31477 the %c and %l constructs are ignored. It is used only on frames for
31478 which no explicit name has been set (see `modify-frame-parameters'). */);
31480 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
31481 doc
: /* Template for displaying the title bar of an iconified frame.
31482 \(Assuming the window manager supports this feature.)
31483 This variable has the same structure as `mode-line-format' (which see),
31484 and is used only on frames for which no explicit name has been set
31485 \(see `modify-frame-parameters'). */);
31487 = Vframe_title_format
31488 = listn (CONSTYPE_PURE
, 3,
31489 intern_c_string ("multiple-frames"),
31490 build_pure_c_string ("%b"),
31491 listn (CONSTYPE_PURE
, 4,
31492 empty_unibyte_string
,
31493 intern_c_string ("invocation-name"),
31494 build_pure_c_string ("@"),
31495 intern_c_string ("system-name")));
31497 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
31498 doc
: /* Maximum number of lines to keep in the message log buffer.
31499 If nil, disable message logging. If t, log messages but don't truncate
31500 the buffer when it becomes large. */);
31501 Vmessage_log_max
= make_number (1000);
31503 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
31504 doc
: /* List of functions to call before redisplaying a window with scrolling.
31505 Each function is called with two arguments, the window and its new
31506 display-start position.
31507 These functions are called whenever the `window-start' marker is modified,
31508 either to point into another buffer (e.g. via `set-window-buffer') or another
31509 place in the same buffer.
31510 Note that the value of `window-end' is not valid when these functions are
31513 Warning: Do not use this feature to alter the way the window
31514 is scrolled. It is not designed for that, and such use probably won't
31516 Vwindow_scroll_functions
= Qnil
;
31518 DEFVAR_LISP ("window-text-change-functions",
31519 Vwindow_text_change_functions
,
31520 doc
: /* Functions to call in redisplay when text in the window might change. */);
31521 Vwindow_text_change_functions
= Qnil
;
31523 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
31524 doc
: /* Functions called when redisplay of a window reaches the end trigger.
31525 Each function is called with two arguments, the window and the end trigger value.
31526 See `set-window-redisplay-end-trigger'. */);
31527 Vredisplay_end_trigger_functions
= Qnil
;
31529 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
31530 doc
: /* Non-nil means autoselect window with mouse pointer.
31531 If nil, do not autoselect windows.
31532 A positive number means delay autoselection by that many seconds: a
31533 window is autoselected only after the mouse has remained in that
31534 window for the duration of the delay.
31535 A negative number has a similar effect, but causes windows to be
31536 autoselected only after the mouse has stopped moving. (Because of
31537 the way Emacs compares mouse events, you will occasionally wait twice
31538 that time before the window gets selected.)
31539 Any other value means to autoselect window instantaneously when the
31540 mouse pointer enters it.
31542 Autoselection selects the minibuffer only if it is active, and never
31543 unselects the minibuffer if it is active.
31545 When customizing this variable make sure that the actual value of
31546 `focus-follows-mouse' matches the behavior of your window manager. */);
31547 Vmouse_autoselect_window
= Qnil
;
31549 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
31550 doc
: /* Non-nil means automatically resize tool-bars.
31551 This dynamically changes the tool-bar's height to the minimum height
31552 that is needed to make all tool-bar items visible.
31553 If value is `grow-only', the tool-bar's height is only increased
31554 automatically; to decrease the tool-bar height, use \\[recenter]. */);
31555 Vauto_resize_tool_bars
= Qt
;
31557 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
31558 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
31559 auto_raise_tool_bar_buttons_p
= true;
31561 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
31562 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
31563 make_cursor_line_fully_visible_p
= true;
31565 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
31566 doc
: /* Border below tool-bar in pixels.
31567 If an integer, use it as the height of the border.
31568 If it is one of `internal-border-width' or `border-width', use the
31569 value of the corresponding frame parameter.
31570 Otherwise, no border is added below the tool-bar. */);
31571 Vtool_bar_border
= Qinternal_border_width
;
31573 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
31574 doc
: /* Margin around tool-bar buttons in pixels.
31575 If an integer, use that for both horizontal and vertical margins.
31576 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
31577 HORZ specifying the horizontal margin, and VERT specifying the
31578 vertical margin. */);
31579 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
31581 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
31582 doc
: /* Relief thickness of tool-bar buttons. */);
31583 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
31585 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
31586 doc
: /* Tool bar style to use.
31588 image - show images only
31589 text - show text only
31590 both - show both, text below image
31591 both-horiz - show text to the right of the image
31592 text-image-horiz - show text to the left of the image
31593 any other - use system default or image if no system default.
31595 This variable only affects the GTK+ toolkit version of Emacs. */);
31596 Vtool_bar_style
= Qnil
;
31598 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
31599 doc
: /* Maximum number of characters a label can have to be shown.
31600 The tool bar style must also show labels for this to have any effect, see
31601 `tool-bar-style'. */);
31602 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
31604 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
31605 doc
: /* List of functions to call to fontify regions of text.
31606 Each function is called with one argument POS. Functions must
31607 fontify a region starting at POS in the current buffer, and give
31608 fontified regions the property `fontified'. */);
31609 Vfontification_functions
= Qnil
;
31610 Fmake_variable_buffer_local (Qfontification_functions
);
31612 DEFVAR_BOOL ("unibyte-display-via-language-environment",
31613 unibyte_display_via_language_environment
,
31614 doc
: /* Non-nil means display unibyte text according to language environment.
31615 Specifically, this means that raw bytes in the range 160-255 decimal
31616 are displayed by converting them to the equivalent multibyte characters
31617 according to the current language environment. As a result, they are
31618 displayed according to the current fontset.
31620 Note that this variable affects only how these bytes are displayed,
31621 but does not change the fact they are interpreted as raw bytes. */);
31622 unibyte_display_via_language_environment
= false;
31624 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
31625 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
31626 If a float, it specifies a fraction of the mini-window frame's height.
31627 If an integer, it specifies a number of lines. */);
31628 Vmax_mini_window_height
= make_float (0.25);
31630 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
31631 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
31632 A value of nil means don't automatically resize mini-windows.
31633 A value of t means resize them to fit the text displayed in them.
31634 A value of `grow-only', the default, means let mini-windows grow only;
31635 they return to their normal size when the minibuffer is closed, or the
31636 echo area becomes empty. */);
31637 /* Contrary to the doc string, we initialize this to nil, so that
31638 loading loadup.el won't try to resize windows before loading
31639 window.el, where some functions we need to call for this live.
31640 We assign the 'grow-only' value right after loading window.el
31642 Vresize_mini_windows
= Qnil
;
31644 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
31645 doc
: /* Alist specifying how to blink the cursor off.
31646 Each element has the form (ON-STATE . OFF-STATE). Whenever the
31647 `cursor-type' frame-parameter or variable equals ON-STATE,
31648 comparing using `equal', Emacs uses OFF-STATE to specify
31649 how to blink it off. ON-STATE and OFF-STATE are values for
31650 the `cursor-type' frame parameter.
31652 If a frame's ON-STATE has no entry in this list,
31653 the frame's other specifications determine how to blink the cursor off. */);
31654 Vblink_cursor_alist
= Qnil
;
31656 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
31657 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
31658 If non-nil, windows are automatically scrolled horizontally to make
31659 point visible. */);
31660 automatic_hscrolling_p
= true;
31661 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
31663 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
31664 doc
: /* How many columns away from the window edge point is allowed to get
31665 before automatic hscrolling will horizontally scroll the window. */);
31666 hscroll_margin
= 5;
31668 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
31669 doc
: /* How many columns to scroll the window when point gets too close to the edge.
31670 When point is less than `hscroll-margin' columns from the window
31671 edge, automatic hscrolling will scroll the window by the amount of columns
31672 determined by this variable. If its value is a positive integer, scroll that
31673 many columns. If it's a positive floating-point number, it specifies the
31674 fraction of the window's width to scroll. If it's nil or zero, point will be
31675 centered horizontally after the scroll. Any other value, including negative
31676 numbers, are treated as if the value were zero.
31678 Automatic hscrolling always moves point outside the scroll margin, so if
31679 point was more than scroll step columns inside the margin, the window will
31680 scroll more than the value given by the scroll step.
31682 Note that the lower bound for automatic hscrolling specified by `scroll-left'
31683 and `scroll-right' overrides this variable's effect. */);
31684 Vhscroll_step
= make_number (0);
31686 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
31687 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
31688 Bind this around calls to `message' to let it take effect. */);
31689 message_truncate_lines
= false;
31691 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
31692 doc
: /* Normal hook run to update the menu bar definitions.
31693 Redisplay runs this hook before it redisplays the menu bar.
31694 This is used to update menus such as Buffers, whose contents depend on
31696 Vmenu_bar_update_hook
= Qnil
;
31698 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
31699 doc
: /* Frame for which we are updating a menu.
31700 The enable predicate for a menu binding should check this variable. */);
31701 Vmenu_updating_frame
= Qnil
;
31703 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
31704 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
31705 inhibit_menubar_update
= false;
31707 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
31708 doc
: /* Prefix prepended to all continuation lines at display time.
31709 The value may be a string, an image, or a stretch-glyph; it is
31710 interpreted in the same way as the value of a `display' text property.
31712 This variable is overridden by any `wrap-prefix' text or overlay
31715 To add a prefix to non-continuation lines, use `line-prefix'. */);
31716 Vwrap_prefix
= Qnil
;
31717 DEFSYM (Qwrap_prefix
, "wrap-prefix");
31718 Fmake_variable_buffer_local (Qwrap_prefix
);
31720 DEFVAR_LISP ("line-prefix", Vline_prefix
,
31721 doc
: /* Prefix prepended to all non-continuation lines at display time.
31722 The value may be a string, an image, or a stretch-glyph; it is
31723 interpreted in the same way as the value of a `display' text property.
31725 This variable is overridden by any `line-prefix' text or overlay
31728 To add a prefix to continuation lines, use `wrap-prefix'. */);
31729 Vline_prefix
= Qnil
;
31730 DEFSYM (Qline_prefix
, "line-prefix");
31731 Fmake_variable_buffer_local (Qline_prefix
);
31733 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
31734 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
31735 inhibit_eval_during_redisplay
= false;
31737 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
31738 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
31739 inhibit_free_realized_faces
= false;
31741 DEFVAR_BOOL ("inhibit-bidi-mirroring", inhibit_bidi_mirroring
,
31742 doc
: /* Non-nil means don't mirror characters even when bidi context requires that.
31743 Intended for use during debugging and for testing bidi display;
31744 see biditest.el in the test suite. */);
31745 inhibit_bidi_mirroring
= false;
31748 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
31749 doc
: /* Inhibit try_window_id display optimization. */);
31750 inhibit_try_window_id
= false;
31752 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
31753 doc
: /* Inhibit try_window_reusing display optimization. */);
31754 inhibit_try_window_reusing
= false;
31756 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
31757 doc
: /* Inhibit try_cursor_movement display optimization. */);
31758 inhibit_try_cursor_movement
= false;
31759 #endif /* GLYPH_DEBUG */
31761 DEFVAR_INT ("overline-margin", overline_margin
,
31762 doc
: /* Space between overline and text, in pixels.
31763 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
31764 margin to the character height. */);
31765 overline_margin
= 2;
31767 DEFVAR_INT ("underline-minimum-offset",
31768 underline_minimum_offset
,
31769 doc
: /* Minimum distance between baseline and underline.
31770 This can improve legibility of underlined text at small font sizes,
31771 particularly when using variable `x-use-underline-position-properties'
31772 with fonts that specify an UNDERLINE_POSITION relatively close to the
31773 baseline. The default value is 1. */);
31774 underline_minimum_offset
= 1;
31776 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
31777 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
31778 This feature only works when on a window system that can change
31779 cursor shapes. */);
31780 display_hourglass_p
= true;
31782 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
31783 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
31784 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
31786 #ifdef HAVE_WINDOW_SYSTEM
31787 hourglass_atimer
= NULL
;
31788 hourglass_shown_p
= false;
31789 #endif /* HAVE_WINDOW_SYSTEM */
31791 /* Name of the face used to display glyphless characters. */
31792 DEFSYM (Qglyphless_char
, "glyphless-char");
31794 /* Method symbols for Vglyphless_char_display. */
31795 DEFSYM (Qhex_code
, "hex-code");
31796 DEFSYM (Qempty_box
, "empty-box");
31797 DEFSYM (Qthin_space
, "thin-space");
31798 DEFSYM (Qzero_width
, "zero-width");
31800 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
31801 doc
: /* Function run just before redisplay.
31802 It is called with one argument, which is the set of windows that are to
31803 be redisplayed. This set can be nil (meaning, only the selected window),
31804 or t (meaning all windows). */);
31805 Vpre_redisplay_function
= intern ("ignore");
31807 /* Symbol for the purpose of Vglyphless_char_display. */
31808 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
31809 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
31811 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
31812 doc
: /* Char-table defining glyphless characters.
31813 Each element, if non-nil, should be one of the following:
31814 an ASCII acronym string: display this string in a box
31815 `hex-code': display the hexadecimal code of a character in a box
31816 `empty-box': display as an empty box
31817 `thin-space': display as 1-pixel width space
31818 `zero-width': don't display
31819 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
31820 display method for graphical terminals and text terminals respectively.
31821 GRAPHICAL and TEXT should each have one of the values listed above.
31823 The char-table has one extra slot to control the display of a character for
31824 which no font is found. This slot only takes effect on graphical terminals.
31825 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
31826 `thin-space'. The default is `empty-box'.
31828 If a character has a non-nil entry in an active display table, the
31829 display table takes effect; in this case, Emacs does not consult
31830 `glyphless-char-display' at all. */);
31831 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
31832 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
31835 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
31836 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
31837 Vdebug_on_message
= Qnil
;
31839 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
31841 Vredisplay__all_windows_cause
= Fmake_hash_table (0, NULL
);
31843 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
31845 Vredisplay__mode_lines_cause
= Fmake_hash_table (0, NULL
);
31847 DEFVAR_LISP ("redisplay--variables", Vredisplay__variables
,
31848 doc
: /* A hash-table of variables changing which triggers a thorough redisplay. */);
31849 Vredisplay__variables
= Qnil
;
31851 DEFVAR_BOOL ("redisplay--inhibit-bidi", redisplay__inhibit_bidi
,
31852 doc
: /* Non-nil means it is not safe to attempt bidi reordering for display. */);
31853 /* Initialize to t, since we need to disable reordering until
31854 loadup.el successfully loads charprop.el. */
31855 redisplay__inhibit_bidi
= true;
31859 /* Initialize this module when Emacs starts. */
31864 CHARPOS (this_line_start_pos
) = 0;
31866 if (!noninteractive
)
31868 struct window
*m
= XWINDOW (minibuf_window
);
31869 Lisp_Object frame
= m
->frame
;
31870 struct frame
*f
= XFRAME (frame
);
31871 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
31872 struct window
*r
= XWINDOW (root
);
31875 echo_area_window
= minibuf_window
;
31877 r
->top_line
= FRAME_TOP_MARGIN (f
);
31878 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
31879 r
->total_cols
= FRAME_COLS (f
);
31880 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31881 r
->total_lines
= FRAME_TOTAL_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
31882 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
31884 m
->top_line
= FRAME_TOTAL_LINES (f
) - 1;
31885 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
31886 m
->total_cols
= FRAME_COLS (f
);
31887 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31888 m
->total_lines
= 1;
31889 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
31891 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
31892 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
31893 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
31895 /* The default ellipsis glyphs `...'. */
31896 for (i
= 0; i
< 3; ++i
)
31897 default_invis_vector
[i
] = make_number ('.');
31901 /* Allocate the buffer for frame titles.
31902 Also used for `format-mode-line'. */
31904 mode_line_noprop_buf
= xmalloc (size
);
31905 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
31906 mode_line_noprop_ptr
= mode_line_noprop_buf
;
31907 mode_line_target
= MODE_LINE_DISPLAY
;
31910 help_echo_showing_p
= false;
31913 #ifdef HAVE_WINDOW_SYSTEM
31915 /* Platform-independent portion of hourglass implementation. */
31917 /* Timer function of hourglass_atimer. */
31920 show_hourglass (struct atimer
*timer
)
31922 /* The timer implementation will cancel this timer automatically
31923 after this function has run. Set hourglass_atimer to null
31924 so that we know the timer doesn't have to be canceled. */
31925 hourglass_atimer
= NULL
;
31927 if (!hourglass_shown_p
)
31929 Lisp_Object tail
, frame
;
31933 FOR_EACH_FRAME (tail
, frame
)
31935 struct frame
*f
= XFRAME (frame
);
31937 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31938 && FRAME_RIF (f
)->show_hourglass
)
31939 FRAME_RIF (f
)->show_hourglass (f
);
31942 hourglass_shown_p
= true;
31947 /* Cancel a currently active hourglass timer, and start a new one. */
31950 start_hourglass (void)
31952 struct timespec delay
;
31954 cancel_hourglass ();
31956 if (INTEGERP (Vhourglass_delay
)
31957 && XINT (Vhourglass_delay
) > 0)
31958 delay
= make_timespec (min (XINT (Vhourglass_delay
),
31959 TYPE_MAXIMUM (time_t)),
31961 else if (FLOATP (Vhourglass_delay
)
31962 && XFLOAT_DATA (Vhourglass_delay
) > 0)
31963 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
31965 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
31967 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
31968 show_hourglass
, NULL
);
31971 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31975 cancel_hourglass (void)
31977 if (hourglass_atimer
)
31979 cancel_atimer (hourglass_atimer
);
31980 hourglass_atimer
= NULL
;
31983 if (hourglass_shown_p
)
31985 Lisp_Object tail
, frame
;
31989 FOR_EACH_FRAME (tail
, frame
)
31991 struct frame
*f
= XFRAME (frame
);
31993 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31994 && FRAME_RIF (f
)->hide_hourglass
)
31995 FRAME_RIF (f
)->hide_hourglass (f
);
31997 /* No cursors on non GUI frames - restore to stock arrow cursor. */
31998 else if (!FRAME_W32_P (f
))
31999 w32_arrow_cursor ();
32003 hourglass_shown_p
= false;
32008 #endif /* HAVE_WINDOW_SYSTEM */