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
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
25 Emacs separates the task of updating the display from code
26 modifying global state, e.g. buffer text. This way functions
27 operating on buffers don't also have to be concerned with updating
30 Updating the display is triggered by the Lisp interpreter when it
31 decides it's time to do it. This is done either automatically for
32 you as part of the interpreter's command loop or as the result of
33 calling Lisp functions like `sit-for'. The C function `redisplay'
34 in xdisp.c is the only entry into the inner redisplay code.
36 The following diagram shows how redisplay code is invoked. As you
37 can see, Lisp calls redisplay and vice versa. Under window systems
38 like X, some portions of the redisplay code are also called
39 asynchronously during mouse movement or expose events. It is very
40 important that these code parts do NOT use the C library (malloc,
41 free) because many C libraries under Unix are not reentrant. They
42 may also NOT call functions of the Lisp interpreter which could
43 change the interpreter's state. If you don't follow these rules,
44 you will encounter bugs which are very hard to explain.
46 +--------------+ redisplay +----------------+
47 | Lisp machine |---------------->| Redisplay code |<--+
48 +--------------+ (xdisp.c) +----------------+ |
50 +----------------------------------+ |
51 Don't use this path when called |
54 expose_window (asynchronous) |
56 X expose events -----+
58 What does redisplay do? Obviously, it has to figure out somehow what
59 has been changed since the last time the display has been updated,
60 and to make these changes visible. Preferably it would do that in
61 a moderately intelligent way, i.e. fast.
63 Changes in buffer text can be deduced from window and buffer
64 structures, and from some global variables like `beg_unchanged' and
65 `end_unchanged'. The contents of the display are additionally
66 recorded in a `glyph matrix', a two-dimensional matrix of glyph
67 structures. Each row in such a matrix corresponds to a line on the
68 display, and each glyph in a row corresponds to a column displaying
69 a character, an image, or what else. This matrix is called the
70 `current glyph matrix' or `current matrix' in redisplay
73 For buffer parts that have been changed since the last update, a
74 second glyph matrix is constructed, the so called `desired glyph
75 matrix' or short `desired matrix'. Current and desired matrix are
76 then compared to find a cheap way to update the display, e.g. by
77 reusing part of the display by scrolling lines.
79 You will find a lot of redisplay optimizations when you start
80 looking at the innards of redisplay. The overall goal of all these
81 optimizations is to make redisplay fast because it is done
82 frequently. Some of these optimizations are implemented by the
87 This function tries to update the display if the text in the
88 window did not change and did not scroll, only point moved, and
89 it did not move off the displayed portion of the text.
91 . try_window_reusing_current_matrix
93 This function reuses the current matrix of a window when text
94 has not changed, but the window start changed (e.g., due to
99 This function attempts to redisplay a window by reusing parts of
100 its existing display. It finds and reuses the part that was not
101 changed, and redraws the rest. (The "id" part in the function's
102 name stands for "insert/delete", not for "identification" or
107 This function performs the full redisplay of a single window
108 assuming that its fonts were not changed and that the cursor
109 will not end up in the scroll margins. (Loading fonts requires
110 re-adjustment of dimensions of glyph matrices, which makes this
111 method impossible to use.)
113 These optimizations are tried in sequence (some can be skipped if
114 it is known that they are not applicable). If none of the
115 optimizations were successful, redisplay calls redisplay_windows,
116 which performs a full redisplay of all windows.
118 Note that there's one more important optimization up Emacs's
119 sleeve, but it is related to actually redrawing the potentially
120 changed portions of the window/frame, not to reproducing the
121 desired matrices of those potentially changed portions. Namely,
122 the function update_frame and its subroutines, which you will find
123 in dispnew.c, compare the desired matrices with the current
124 matrices, and only redraw the portions that changed. So it could
125 happen that the functions in this file for some reason decide that
126 the entire desired matrix needs to be regenerated from scratch, and
127 still only parts of the Emacs display, or even nothing at all, will
128 be actually delivered to the glass, because update_frame has found
129 that the new and the old screen contents are similar or identical.
133 Desired matrices are always built per Emacs window. The function
134 `display_line' is the central function to look at if you are
135 interested. It constructs one row in a desired matrix given an
136 iterator structure containing both a buffer position and a
137 description of the environment in which the text is to be
138 displayed. But this is too early, read on.
140 Characters and pixmaps displayed for a range of buffer text depend
141 on various settings of buffers and windows, on overlays and text
142 properties, on display tables, on selective display. The good news
143 is that all this hairy stuff is hidden behind a small set of
144 interface functions taking an iterator structure (struct it)
147 Iteration over things to be displayed is then simple. It is
148 started by initializing an iterator with a call to init_iterator,
149 passing it the buffer position where to start iteration. For
150 iteration over strings, pass -1 as the position to init_iterator,
151 and call reseat_to_string when the string is ready, to initialize
152 the iterator for that string. Thereafter, calls to
153 get_next_display_element fill the iterator structure with relevant
154 information about the next thing to display. Calls to
155 set_iterator_to_next move the iterator to the next thing.
157 Besides this, an iterator also contains information about the
158 display environment in which glyphs for display elements are to be
159 produced. It has fields for the width and height of the display,
160 the information whether long lines are truncated or continued, a
161 current X and Y position, and lots of other stuff you can better
164 Glyphs in a desired matrix are normally constructed in a loop
165 calling get_next_display_element and then PRODUCE_GLYPHS. The call
166 to PRODUCE_GLYPHS will fill the iterator structure with pixel
167 information about the element being displayed and at the same time
168 produce glyphs for it. If the display element fits on the line
169 being displayed, set_iterator_to_next is called next, otherwise the
170 glyphs produced are discarded. The function display_line is the
171 workhorse of filling glyph rows in the desired matrix with glyphs.
172 In addition to producing glyphs, it also handles line truncation
173 and continuation, word wrap, and cursor positioning (for the
174 latter, see also set_cursor_from_row).
178 That just couldn't be all, could it? What about terminal types not
179 supporting operations on sub-windows of the screen? To update the
180 display on such a terminal, window-based glyph matrices are not
181 well suited. To be able to reuse part of the display (scrolling
182 lines up and down), we must instead have a view of the whole
183 screen. This is what `frame matrices' are for. They are a trick.
185 Frames on terminals like above have a glyph pool. Windows on such
186 a frame sub-allocate their glyph memory from their frame's glyph
187 pool. The frame itself is given its own glyph matrices. By
188 coincidence---or maybe something else---rows in window glyph
189 matrices are slices of corresponding rows in frame matrices. Thus
190 writing to window matrices implicitly updates a frame matrix which
191 provides us with the view of the whole screen that we originally
192 wanted to have without having to move many bytes around. To be
193 honest, there is a little bit more done, but not much more. If you
194 plan to extend that code, take a look at dispnew.c. The function
195 build_frame_matrix is a good starting point.
197 Bidirectional display.
199 Bidirectional display adds quite some hair to this already complex
200 design. The good news are that a large portion of that hairy stuff
201 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
202 reordering engine which is called by set_iterator_to_next and
203 returns the next character to display in the visual order. See
204 commentary on bidi.c for more details. As far as redisplay is
205 concerned, the effect of calling bidi_move_to_visually_next, the
206 main interface of the reordering engine, is that the iterator gets
207 magically placed on the buffer or string position that is to be
208 displayed next. In other words, a linear iteration through the
209 buffer/string is replaced with a non-linear one. All the rest of
210 the redisplay is oblivious to the bidi reordering.
212 Well, almost oblivious---there are still complications, most of
213 them due to the fact that buffer and string positions no longer
214 change monotonously with glyph indices in a glyph row. Moreover,
215 for continued lines, the buffer positions may not even be
216 monotonously changing with vertical positions. Also, accounting
217 for face changes, overlays, etc. becomes more complex because
218 non-linear iteration could potentially skip many positions with
219 changes, and then cross them again on the way back...
221 One other prominent effect of bidirectional display is that some
222 paragraphs of text need to be displayed starting at the right
223 margin of the window---the so-called right-to-left, or R2L
224 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
225 which have their reversed_p flag set. The bidi reordering engine
226 produces characters in such rows starting from the character which
227 should be the rightmost on display. PRODUCE_GLYPHS then reverses
228 the order, when it fills up the glyph row whose reversed_p flag is
229 set, by prepending each new glyph to what is already there, instead
230 of appending it. When the glyph row is complete, the function
231 extend_face_to_end_of_line fills the empty space to the left of the
232 leftmost character with special glyphs, which will display as,
233 well, empty. On text terminals, these special glyphs are simply
234 blank characters. On graphics terminals, there's a single stretch
235 glyph of a suitably computed width. Both the blanks and the
236 stretch glyph are given the face of the background of the line.
237 This way, the terminal-specific back-end can still draw the glyphs
238 left to right, even for R2L lines.
240 Bidirectional display and character compositions
242 Some scripts cannot be displayed by drawing each character
243 individually, because adjacent characters change each other's shape
244 on display. For example, Arabic and Indic scripts belong to this
247 Emacs display supports this by providing "character compositions",
248 most of which is implemented in composite.c. During the buffer
249 scan that delivers characters to PRODUCE_GLYPHS, if the next
250 character to be delivered is a composed character, the iteration
251 calls composition_reseat_it and next_element_from_composition. If
252 they succeed to compose the character with one or more of the
253 following characters, the whole sequence of characters that where
254 composed is recorded in the `struct composition_it' object that is
255 part of the buffer iterator. The composed sequence could produce
256 one or more font glyphs (called "grapheme clusters") on the screen.
257 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
258 in the direction corresponding to the current bidi scan direction
259 (recorded in the scan_dir member of the `struct bidi_it' object
260 that is part of the buffer iterator). In particular, if the bidi
261 iterator currently scans the buffer backwards, the grapheme
262 clusters are delivered back to front. This reorders the grapheme
263 clusters as appropriate for the current bidi context. Note that
264 this means that the grapheme clusters are always stored in the
265 LGSTRING object (see composite.c) in the logical order.
267 Moving an iterator in bidirectional text
268 without producing glyphs
270 Note one important detail mentioned above: that the bidi reordering
271 engine, driven by the iterator, produces characters in R2L rows
272 starting at the character that will be the rightmost on display.
273 As far as the iterator is concerned, the geometry of such rows is
274 still left to right, i.e. the iterator "thinks" the first character
275 is at the leftmost pixel position. The iterator does not know that
276 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
277 delivers. This is important when functions from the move_it_*
278 family are used to get to certain screen position or to match
279 screen coordinates with buffer coordinates: these functions use the
280 iterator geometry, which is left to right even in R2L paragraphs.
281 This works well with most callers of move_it_*, because they need
282 to get to a specific column, and columns are still numbered in the
283 reading order, i.e. the rightmost character in a R2L paragraph is
284 still column zero. But some callers do not get well with this; a
285 notable example is mouse clicks that need to find the character
286 that corresponds to certain pixel coordinates. See
287 buffer_posn_from_coords in dispnew.c for how this is handled. */
295 #include "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"
317 #ifdef HAVE_WINDOW_SYSTEM
319 #endif /* HAVE_WINDOW_SYSTEM */
321 #ifndef FRAME_X_OUTPUT
322 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
325 #define INFINITY 10000000
327 /* Holds the list (error). */
328 static Lisp_Object list_of_error
;
330 #ifdef HAVE_WINDOW_SYSTEM
332 /* Test if overflow newline into fringe. Called with iterator IT
333 at or past right window margin, and with IT->current_x set. */
335 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
336 (!NILP (Voverflow_newline_into_fringe) \
337 && FRAME_WINDOW_P ((IT)->f) \
338 && ((IT)->bidi_it.paragraph_dir == R2L \
339 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
340 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
341 && (IT)->current_x == (IT)->last_visible_x)
343 #else /* !HAVE_WINDOW_SYSTEM */
344 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) false
345 #endif /* HAVE_WINDOW_SYSTEM */
347 /* Test if the display element loaded in IT, or the underlying buffer
348 or string character, is a space or a TAB character. This is used
349 to determine where word wrapping can occur. */
351 #define IT_DISPLAYING_WHITESPACE(it) \
352 ((it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t')) \
353 || ((STRINGP (it->string) \
354 && (SREF (it->string, IT_STRING_BYTEPOS (*it)) == ' ' \
355 || SREF (it->string, IT_STRING_BYTEPOS (*it)) == '\t')) \
357 && (it->s[IT_BYTEPOS (*it)] == ' ' \
358 || it->s[IT_BYTEPOS (*it)] == '\t')) \
359 || (IT_BYTEPOS (*it) < ZV_BYTE \
360 && (*BYTE_POS_ADDR (IT_BYTEPOS (*it)) == ' ' \
361 || *BYTE_POS_ADDR (IT_BYTEPOS (*it)) == '\t')))) \
363 /* True means print newline to stdout before next mini-buffer message. */
365 bool noninteractive_need_newline
;
367 /* True means print newline to message log before next message. */
369 static bool message_log_need_newline
;
371 /* Three markers that message_dolog uses.
372 It could allocate them itself, but that causes trouble
373 in handling memory-full errors. */
374 static Lisp_Object message_dolog_marker1
;
375 static Lisp_Object message_dolog_marker2
;
376 static Lisp_Object message_dolog_marker3
;
378 /* The buffer position of the first character appearing entirely or
379 partially on the line of the selected window which contains the
380 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
381 redisplay optimization in redisplay_internal. */
383 static struct text_pos this_line_start_pos
;
385 /* Number of characters past the end of the line above, including the
386 terminating newline. */
388 static struct text_pos this_line_end_pos
;
390 /* The vertical positions and the height of this line. */
392 static int this_line_vpos
;
393 static int this_line_y
;
394 static int this_line_pixel_height
;
396 /* X position at which this display line starts. Usually zero;
397 negative if first character is partially visible. */
399 static int this_line_start_x
;
401 /* The smallest character position seen by move_it_* functions as they
402 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
403 hscrolled lines, see display_line. */
405 static struct text_pos this_line_min_pos
;
407 /* Buffer that this_line_.* variables are referring to. */
409 static struct buffer
*this_line_buffer
;
411 /* True if an overlay arrow has been displayed in this window. */
413 static bool overlay_arrow_seen
;
415 /* Vector containing glyphs for an ellipsis `...'. */
417 static Lisp_Object default_invis_vector
[3];
419 /* This is the window where the echo area message was displayed. It
420 is always a mini-buffer window, but it may not be the same window
421 currently active as a mini-buffer. */
423 Lisp_Object echo_area_window
;
425 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
426 pushes the current message and the value of
427 message_enable_multibyte on the stack, the function restore_message
428 pops the stack and displays MESSAGE again. */
430 static Lisp_Object Vmessage_stack
;
432 /* True means multibyte characters were enabled when the echo area
433 message was specified. */
435 static bool message_enable_multibyte
;
437 /* At each redisplay cycle, we should refresh everything there is to refresh.
438 To do that efficiently, we use many optimizations that try to make sure we
439 don't waste too much time updating things that haven't changed.
440 The coarsest such optimization is that, in the most common cases, we only
441 look at the selected-window.
443 To know whether other windows should be considered for redisplay, we use the
444 variable windows_or_buffers_changed: as long as it is 0, it means that we
445 have not noticed anything that should require updating anything else than
446 the selected-window. If it is set to REDISPLAY_SOME, it means that since
447 last redisplay, some changes have been made which could impact other
448 windows. To know which ones need redisplay, every buffer, window, and frame
449 has a `redisplay' bit, which (if true) means that this object needs to be
450 redisplayed. If windows_or_buffers_changed is 0, we know there's no point
451 looking for those `redisplay' bits (actually, there might be some such bits
452 set, but then only on objects which aren't displayed anyway).
454 OTOH if it's non-zero we wil have to loop through all windows and then check
455 the `redisplay' bit of the corresponding window, frame, and buffer, in order
456 to decide whether that window needs attention or not. Note that we can't
457 just look at the frame's redisplay bit to decide that the whole frame can be
458 skipped, since even if the frame's redisplay bit is unset, some of its
459 windows's redisplay bits may be set.
461 Mostly for historical reasons, windows_or_buffers_changed can also take
462 other non-zero values. In that case, the precise value doesn't matter (it
463 encodes the cause of the setting but is only used for debugging purposes),
464 and what it means is that we shouldn't pay attention to any `redisplay' bits
465 and we should simply try and redisplay every window out there. */
467 int windows_or_buffers_changed
;
469 /* Nonzero if we should redraw the mode lines on the next redisplay.
470 Similarly to `windows_or_buffers_changed', If it has value REDISPLAY_SOME,
471 then only redisplay the mode lines in those buffers/windows/frames where the
472 `redisplay' bit has been set.
473 For any other value, redisplay all mode lines (the number used is then only
474 used to track down the cause for this full-redisplay).
476 Since the frame title uses the same %-constructs as the mode line
477 (except %c and %l), if this variable is non-zero, we also consider
478 redisplaying the title of each frame, see x_consider_frame_title.
480 The `redisplay' bits are the same as those used for
481 windows_or_buffers_changed, and setting windows_or_buffers_changed also
482 causes recomputation of the mode lines of all those windows. IOW this
483 variable only has an effect if windows_or_buffers_changed is zero, in which
484 case we should only need to redisplay the mode-line of those objects with
485 a `redisplay' bit set but not the window's text content (tho we may still
486 need to refresh the text content of the selected-window). */
488 int update_mode_lines
;
490 /* True after display_mode_line if %l was used and it displayed a
493 static bool line_number_displayed
;
495 /* The name of the *Messages* buffer, a string. */
497 static Lisp_Object Vmessages_buffer_name
;
499 /* Current, index 0, and last displayed echo area message. Either
500 buffers from echo_buffers, or nil to indicate no message. */
502 Lisp_Object echo_area_buffer
[2];
504 /* The buffers referenced from echo_area_buffer. */
506 static Lisp_Object echo_buffer
[2];
508 /* A vector saved used in with_area_buffer to reduce consing. */
510 static Lisp_Object Vwith_echo_area_save_vector
;
512 /* True means display_echo_area should display the last echo area
513 message again. Set by redisplay_preserve_echo_area. */
515 static bool display_last_displayed_message_p
;
517 /* True if echo area is being used by print; false if being used by
520 static bool message_buf_print
;
522 /* Set to true in clear_message to make redisplay_internal aware
523 of an emptied echo area. */
525 static bool message_cleared_p
;
527 /* A scratch glyph row with contents used for generating truncation
528 glyphs. Also used in direct_output_for_insert. */
530 #define MAX_SCRATCH_GLYPHS 100
531 static struct glyph_row scratch_glyph_row
;
532 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
534 /* Ascent and height of the last line processed by move_it_to. */
536 static int last_height
;
538 /* True if there's a help-echo in the echo area. */
540 bool help_echo_showing_p
;
542 /* The maximum distance to look ahead for text properties. Values
543 that are too small let us call compute_char_face and similar
544 functions too often which is expensive. Values that are too large
545 let us call compute_char_face and alike too often because we
546 might not be interested in text properties that far away. */
548 #define TEXT_PROP_DISTANCE_LIMIT 100
550 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
551 iterator state and later restore it. This is needed because the
552 bidi iterator on bidi.c keeps a stacked cache of its states, which
553 is really a singleton. When we use scratch iterator objects to
554 move around the buffer, we can cause the bidi cache to be pushed or
555 popped, and therefore we need to restore the cache state when we
556 return to the original iterator. */
557 #define SAVE_IT(ITCOPY, ITORIG, CACHE) \
560 bidi_unshelve_cache (CACHE, true); \
562 CACHE = bidi_shelve_cache (); \
565 #define RESTORE_IT(pITORIG, pITCOPY, CACHE) \
567 if (pITORIG != pITCOPY) \
568 *(pITORIG) = *(pITCOPY); \
569 bidi_unshelve_cache (CACHE, false); \
573 /* Functions to mark elements as needing redisplay. */
574 enum { REDISPLAY_SOME
= 2}; /* Arbitrary choice. */
577 redisplay_other_windows (void)
579 if (!windows_or_buffers_changed
)
580 windows_or_buffers_changed
= REDISPLAY_SOME
;
584 wset_redisplay (struct window
*w
)
586 /* Beware: selected_window can be nil during early stages. */
587 if (!EQ (make_lisp_ptr (w
, Lisp_Vectorlike
), selected_window
))
588 redisplay_other_windows ();
593 fset_redisplay (struct frame
*f
)
595 redisplay_other_windows ();
600 bset_redisplay (struct buffer
*b
)
602 int count
= buffer_window_count (b
);
605 /* ... it's visible in other window than selected, */
606 if (count
> 1 || b
!= XBUFFER (XWINDOW (selected_window
)->contents
))
607 redisplay_other_windows ();
608 /* Even if we don't set windows_or_buffers_changed, do set `redisplay'
609 so that if we later set windows_or_buffers_changed, this buffer will
611 b
->text
->redisplay
= true;
616 bset_update_mode_line (struct buffer
*b
)
618 if (!update_mode_lines
)
619 update_mode_lines
= REDISPLAY_SOME
;
620 b
->text
->redisplay
= true;
624 maybe_set_redisplay (Lisp_Object symbol
)
626 if (HASH_TABLE_P (Vredisplay__variables
)
627 && hash_lookup (XHASH_TABLE (Vredisplay__variables
), symbol
, NULL
) >= 0)
629 bset_update_mode_line (current_buffer
);
630 current_buffer
->prevent_redisplay_optimizations_p
= true;
636 /* True means print traces of redisplay if compiled with
637 GLYPH_DEBUG defined. */
639 bool trace_redisplay_p
;
641 #endif /* GLYPH_DEBUG */
643 #ifdef DEBUG_TRACE_MOVE
644 /* True means trace with TRACE_MOVE to stderr. */
645 static bool trace_move
;
647 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
649 #define TRACE_MOVE(x) (void) 0
652 /* Buffer being redisplayed -- for redisplay_window_error. */
654 static struct buffer
*displayed_buffer
;
656 /* Value returned from text property handlers (see below). */
661 HANDLED_RECOMPUTE_PROPS
,
662 HANDLED_OVERLAY_STRING_CONSUMED
,
666 /* A description of text properties that redisplay is interested
671 /* The symbol index of the name of the property. */
674 /* A unique index for the property. */
677 /* A handler function called to set up iterator IT from the property
678 at IT's current position. Value is used to steer handle_stop. */
679 enum prop_handled (*handler
) (struct it
*it
);
682 static enum prop_handled
handle_face_prop (struct it
*);
683 static enum prop_handled
handle_invisible_prop (struct it
*);
684 static enum prop_handled
handle_display_prop (struct it
*);
685 static enum prop_handled
handle_composition_prop (struct it
*);
686 static enum prop_handled
handle_overlay_change (struct it
*);
687 static enum prop_handled
handle_fontified_prop (struct it
*);
689 /* Properties handled by iterators. */
691 static struct props it_props
[] =
693 {SYMBOL_INDEX (Qfontified
), FONTIFIED_PROP_IDX
, handle_fontified_prop
},
694 /* Handle `face' before `display' because some sub-properties of
695 `display' need to know the face. */
696 {SYMBOL_INDEX (Qface
), FACE_PROP_IDX
, handle_face_prop
},
697 {SYMBOL_INDEX (Qdisplay
), DISPLAY_PROP_IDX
, handle_display_prop
},
698 {SYMBOL_INDEX (Qinvisible
), INVISIBLE_PROP_IDX
, handle_invisible_prop
},
699 {SYMBOL_INDEX (Qcomposition
), COMPOSITION_PROP_IDX
, handle_composition_prop
},
703 /* Value is the position described by X. If X is a marker, value is
704 the marker_position of X. Otherwise, value is X. */
706 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
708 /* Enumeration returned by some move_it_.* functions internally. */
712 /* Not used. Undefined value. */
715 /* Move ended at the requested buffer position or ZV. */
716 MOVE_POS_MATCH_OR_ZV
,
718 /* Move ended at the requested X pixel position. */
721 /* Move within a line ended at the end of a line that must be
725 /* Move within a line ended at the end of a line that would
726 be displayed truncated. */
729 /* Move within a line ended at a line end. */
733 /* This counter is used to clear the face cache every once in a while
734 in redisplay_internal. It is incremented for each redisplay.
735 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
738 #define CLEAR_FACE_CACHE_COUNT 500
739 static int clear_face_cache_count
;
741 /* Similarly for the image cache. */
743 #ifdef HAVE_WINDOW_SYSTEM
744 #define CLEAR_IMAGE_CACHE_COUNT 101
745 static int clear_image_cache_count
;
747 /* Null glyph slice */
748 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
751 /* True while redisplay_internal is in progress. */
755 /* If a string, XTread_socket generates an event to display that string.
756 (The display is done in read_char.) */
758 Lisp_Object help_echo_string
;
759 Lisp_Object help_echo_window
;
760 Lisp_Object help_echo_object
;
761 ptrdiff_t help_echo_pos
;
763 /* Temporary variable for XTread_socket. */
765 Lisp_Object previous_help_echo_string
;
767 /* Platform-independent portion of hourglass implementation. */
769 #ifdef HAVE_WINDOW_SYSTEM
771 /* True means an hourglass cursor is currently shown. */
772 static bool hourglass_shown_p
;
774 /* If non-null, an asynchronous timer that, when it expires, displays
775 an hourglass cursor on all frames. */
776 static struct atimer
*hourglass_atimer
;
778 #endif /* HAVE_WINDOW_SYSTEM */
780 /* Default number of seconds to wait before displaying an hourglass
782 #define DEFAULT_HOURGLASS_DELAY 1
784 #ifdef HAVE_WINDOW_SYSTEM
786 /* Default pixel width of `thin-space' display method. */
787 #define THIN_SPACE_WIDTH 1
789 #endif /* HAVE_WINDOW_SYSTEM */
791 /* Function prototypes. */
793 static void setup_for_ellipsis (struct it
*, int);
794 static void set_iterator_to_next (struct it
*, bool);
795 static void mark_window_display_accurate_1 (struct window
*, bool);
796 static bool row_for_charpos_p (struct glyph_row
*, ptrdiff_t);
797 static bool cursor_row_p (struct glyph_row
*);
798 static int redisplay_mode_lines (Lisp_Object
, bool);
800 static void handle_line_prefix (struct it
*);
802 static void handle_stop_backwards (struct it
*, ptrdiff_t);
803 static void unwind_with_echo_area_buffer (Lisp_Object
);
804 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
805 static bool current_message_1 (ptrdiff_t, Lisp_Object
);
806 static bool truncate_message_1 (ptrdiff_t, Lisp_Object
);
807 static void set_message (Lisp_Object
);
808 static bool set_message_1 (ptrdiff_t, Lisp_Object
);
809 static bool display_echo_area_1 (ptrdiff_t, Lisp_Object
);
810 static bool resize_mini_window_1 (ptrdiff_t, Lisp_Object
);
811 static void unwind_redisplay (void);
812 static void extend_face_to_end_of_line (struct it
*);
813 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
814 static void push_it (struct it
*, struct text_pos
*);
815 static void iterate_out_of_display_property (struct it
*);
816 static void pop_it (struct it
*);
817 static void redisplay_internal (void);
818 static void echo_area_display (bool);
819 static void redisplay_windows (Lisp_Object
);
820 static void redisplay_window (Lisp_Object
, bool);
821 static Lisp_Object
redisplay_window_error (Lisp_Object
);
822 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
823 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
824 static bool set_cursor_from_row (struct window
*, struct glyph_row
*,
825 struct glyph_matrix
*, ptrdiff_t, ptrdiff_t,
827 static bool update_menu_bar (struct frame
*, bool, bool);
828 static bool try_window_reusing_current_matrix (struct window
*);
829 static int try_window_id (struct window
*);
830 static bool display_line (struct it
*);
831 static int display_mode_lines (struct window
*);
832 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
833 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
,
835 static int store_mode_line_string (const char *, Lisp_Object
, bool, int, int,
837 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
838 static void display_menu_bar (struct window
*);
839 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
841 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
842 ptrdiff_t, ptrdiff_t, struct it
*, int, int, int, int);
843 static void compute_line_metrics (struct it
*);
844 static void run_redisplay_end_trigger_hook (struct it
*);
845 static bool get_overlay_strings (struct it
*, ptrdiff_t);
846 static bool get_overlay_strings_1 (struct it
*, ptrdiff_t, bool);
847 static void next_overlay_string (struct it
*);
848 static void reseat (struct it
*, struct text_pos
, bool);
849 static void reseat_1 (struct it
*, struct text_pos
, bool);
850 static bool next_element_from_display_vector (struct it
*);
851 static bool next_element_from_string (struct it
*);
852 static bool next_element_from_c_string (struct it
*);
853 static bool next_element_from_buffer (struct it
*);
854 static bool next_element_from_composition (struct it
*);
855 static bool next_element_from_image (struct it
*);
856 static bool next_element_from_stretch (struct it
*);
857 static void load_overlay_strings (struct it
*, ptrdiff_t);
858 static bool get_next_display_element (struct it
*);
859 static enum move_it_result
860 move_it_in_display_line_to (struct it
*, ptrdiff_t, int,
861 enum move_operation_enum
);
862 static void get_visually_first_element (struct it
*);
863 static void compute_stop_pos (struct it
*);
864 static int face_before_or_after_it_pos (struct it
*, bool);
865 static ptrdiff_t next_overlay_change (ptrdiff_t);
866 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
867 Lisp_Object
, struct text_pos
*, ptrdiff_t, bool);
868 static int handle_single_display_spec (struct it
*, Lisp_Object
,
869 Lisp_Object
, Lisp_Object
,
870 struct text_pos
*, ptrdiff_t, int, bool);
871 static int underlying_face_id (struct it
*);
873 #define face_before_it_pos(IT) face_before_or_after_it_pos (IT, true)
874 #define face_after_it_pos(IT) face_before_or_after_it_pos (IT, false)
876 #ifdef HAVE_WINDOW_SYSTEM
878 static void update_tool_bar (struct frame
*, bool);
879 static void x_draw_bottom_divider (struct window
*w
);
880 static void notice_overwritten_cursor (struct window
*,
883 static int normal_char_height (struct font
*, int);
884 static void normal_char_ascent_descent (struct font
*, int, int *, int *);
886 static void append_stretch_glyph (struct it
*, Lisp_Object
,
889 static Lisp_Object
get_it_property (struct it
*, Lisp_Object
);
890 static Lisp_Object
calc_line_height_property (struct it
*, Lisp_Object
,
891 struct font
*, int, bool);
893 #endif /* HAVE_WINDOW_SYSTEM */
895 static void produce_special_glyphs (struct it
*, enum display_element_type
);
896 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
897 static bool coords_in_mouse_face_p (struct window
*, int, int);
901 /***********************************************************************
902 Window display dimensions
903 ***********************************************************************/
905 /* Return the bottom boundary y-position for text lines in window W.
906 This is the first y position at which a line cannot start.
907 It is relative to the top of the window.
909 This is the height of W minus the height of a mode line, if any. */
912 window_text_bottom_y (struct window
*w
)
914 int height
= WINDOW_PIXEL_HEIGHT (w
);
916 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
918 if (WINDOW_WANTS_MODELINE_P (w
))
919 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
921 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
926 /* Return the pixel width of display area AREA of window W.
927 ANY_AREA means return the total width of W, not including
928 fringes to the left and right of the window. */
931 window_box_width (struct window
*w
, enum glyph_row_area area
)
933 int width
= w
->pixel_width
;
935 if (!w
->pseudo_window_p
)
937 width
-= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
938 width
-= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
940 if (area
== TEXT_AREA
)
941 width
-= (WINDOW_MARGINS_WIDTH (w
)
942 + WINDOW_FRINGES_WIDTH (w
));
943 else if (area
== LEFT_MARGIN_AREA
)
944 width
= WINDOW_LEFT_MARGIN_WIDTH (w
);
945 else if (area
== RIGHT_MARGIN_AREA
)
946 width
= WINDOW_RIGHT_MARGIN_WIDTH (w
);
949 /* With wide margins, fringes, etc. we might end up with a negative
950 width, correct that here. */
951 return max (0, width
);
955 /* Return the pixel height of the display area of window W, not
956 including mode lines of W, if any. */
959 window_box_height (struct window
*w
)
961 struct frame
*f
= XFRAME (w
->frame
);
962 int height
= WINDOW_PIXEL_HEIGHT (w
);
964 eassert (height
>= 0);
966 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
967 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
969 /* Note: the code below that determines the mode-line/header-line
970 height is essentially the same as that contained in the macro
971 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
972 the appropriate glyph row has its `mode_line_p' flag set,
973 and if it doesn't, uses estimate_mode_line_height instead. */
975 if (WINDOW_WANTS_MODELINE_P (w
))
977 struct glyph_row
*ml_row
978 = (w
->current_matrix
&& w
->current_matrix
->rows
979 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
981 if (ml_row
&& ml_row
->mode_line_p
)
982 height
-= ml_row
->height
;
984 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
987 if (WINDOW_WANTS_HEADER_LINE_P (w
))
989 struct glyph_row
*hl_row
990 = (w
->current_matrix
&& w
->current_matrix
->rows
991 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
993 if (hl_row
&& hl_row
->mode_line_p
)
994 height
-= hl_row
->height
;
996 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
999 /* With a very small font and a mode-line that's taller than
1000 default, we might end up with a negative height. */
1001 return max (0, height
);
1004 /* Return the window-relative coordinate of the left edge of display
1005 area AREA of window W. ANY_AREA means return the left edge of the
1006 whole window, to the right of the left fringe of W. */
1009 window_box_left_offset (struct window
*w
, enum glyph_row_area area
)
1013 if (w
->pseudo_window_p
)
1016 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1018 if (area
== TEXT_AREA
)
1019 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1020 + window_box_width (w
, LEFT_MARGIN_AREA
));
1021 else if (area
== RIGHT_MARGIN_AREA
)
1022 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1023 + window_box_width (w
, LEFT_MARGIN_AREA
)
1024 + window_box_width (w
, TEXT_AREA
)
1025 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1027 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1028 else if (area
== LEFT_MARGIN_AREA
1029 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1030 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1032 /* Don't return more than the window's pixel width. */
1033 return min (x
, w
->pixel_width
);
1037 /* Return the window-relative coordinate of the right edge of display
1038 area AREA of window W. ANY_AREA means return the right edge of the
1039 whole window, to the left of the right fringe of W. */
1042 window_box_right_offset (struct window
*w
, enum glyph_row_area area
)
1044 /* Don't return more than the window's pixel width. */
1045 return min (window_box_left_offset (w
, area
) + window_box_width (w
, area
),
1049 /* Return the frame-relative coordinate of the left edge of display
1050 area AREA of window W. ANY_AREA means return the left edge of the
1051 whole window, to the right of the left fringe of W. */
1054 window_box_left (struct window
*w
, enum glyph_row_area area
)
1056 struct frame
*f
= XFRAME (w
->frame
);
1059 if (w
->pseudo_window_p
)
1060 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1062 x
= (WINDOW_LEFT_EDGE_X (w
)
1063 + window_box_left_offset (w
, area
));
1069 /* Return the frame-relative coordinate of the right edge of display
1070 area AREA of window W. ANY_AREA means return the right edge of the
1071 whole window, to the left of the right fringe of W. */
1074 window_box_right (struct window
*w
, enum glyph_row_area area
)
1076 return window_box_left (w
, area
) + window_box_width (w
, area
);
1079 /* Get the bounding box of the display area AREA of window W, without
1080 mode lines, in frame-relative coordinates. ANY_AREA means the
1081 whole window, not including the left and right fringes of
1082 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1083 coordinates of the upper-left corner of the box. Return in
1084 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1087 window_box (struct window
*w
, enum glyph_row_area area
, int *box_x
,
1088 int *box_y
, int *box_width
, int *box_height
)
1091 *box_width
= window_box_width (w
, area
);
1093 *box_height
= window_box_height (w
);
1095 *box_x
= window_box_left (w
, area
);
1098 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1099 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1100 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1104 #ifdef HAVE_WINDOW_SYSTEM
1106 /* Get the bounding box of the display area AREA of window W, without
1107 mode lines and both fringes of the window. Return in *TOP_LEFT_X
1108 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1109 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1110 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1114 window_box_edges (struct window
*w
, int *top_left_x
, int *top_left_y
,
1115 int *bottom_right_x
, int *bottom_right_y
)
1117 window_box (w
, ANY_AREA
, top_left_x
, top_left_y
,
1118 bottom_right_x
, bottom_right_y
);
1119 *bottom_right_x
+= *top_left_x
;
1120 *bottom_right_y
+= *top_left_y
;
1123 #endif /* HAVE_WINDOW_SYSTEM */
1125 /***********************************************************************
1127 ***********************************************************************/
1129 /* Return the bottom y-position of the line the iterator IT is in.
1130 This can modify IT's settings. */
1133 line_bottom_y (struct it
*it
)
1135 int line_height
= it
->max_ascent
+ it
->max_descent
;
1136 int line_top_y
= it
->current_y
;
1138 if (line_height
== 0)
1141 line_height
= last_height
;
1142 else if (IT_CHARPOS (*it
) < ZV
)
1144 move_it_by_lines (it
, 1);
1145 line_height
= (it
->max_ascent
|| it
->max_descent
1146 ? it
->max_ascent
+ it
->max_descent
1151 struct glyph_row
*row
= it
->glyph_row
;
1153 /* Use the default character height. */
1154 it
->glyph_row
= NULL
;
1155 it
->what
= IT_CHARACTER
;
1158 PRODUCE_GLYPHS (it
);
1159 line_height
= it
->ascent
+ it
->descent
;
1160 it
->glyph_row
= row
;
1164 return line_top_y
+ line_height
;
1167 DEFUN ("line-pixel-height", Fline_pixel_height
,
1168 Sline_pixel_height
, 0, 0, 0,
1169 doc
: /* Return height in pixels of text line in the selected window.
1171 Value is the height in pixels of the line at point. */)
1176 struct window
*w
= XWINDOW (selected_window
);
1177 struct buffer
*old_buffer
= NULL
;
1180 if (XBUFFER (w
->contents
) != current_buffer
)
1182 old_buffer
= current_buffer
;
1183 set_buffer_internal_1 (XBUFFER (w
->contents
));
1185 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
1186 start_display (&it
, w
, pt
);
1187 it
.vpos
= it
.current_y
= 0;
1189 result
= make_number (line_bottom_y (&it
));
1191 set_buffer_internal_1 (old_buffer
);
1196 /* Return the default pixel height of text lines in window W. The
1197 value is the canonical height of the W frame's default font, plus
1198 any extra space required by the line-spacing variable or frame
1201 Implementation note: this ignores any line-spacing text properties
1202 put on the newline characters. This is because those properties
1203 only affect the _screen_ line ending in the newline (i.e., in a
1204 continued line, only the last screen line will be affected), which
1205 means only a small number of lines in a buffer can ever use this
1206 feature. Since this function is used to compute the default pixel
1207 equivalent of text lines in a window, we can safely ignore those
1208 few lines. For the same reasons, we ignore the line-height
1211 default_line_pixel_height (struct window
*w
)
1213 struct frame
*f
= WINDOW_XFRAME (w
);
1214 int height
= FRAME_LINE_HEIGHT (f
);
1216 if (!FRAME_INITIAL_P (f
) && BUFFERP (w
->contents
))
1218 struct buffer
*b
= XBUFFER (w
->contents
);
1219 Lisp_Object val
= BVAR (b
, extra_line_spacing
);
1222 val
= BVAR (&buffer_defaults
, extra_line_spacing
);
1225 if (RANGED_INTEGERP (0, val
, INT_MAX
))
1226 height
+= XFASTINT (val
);
1227 else if (FLOATP (val
))
1229 int addon
= XFLOAT_DATA (val
) * height
+ 0.5;
1236 height
+= f
->extra_line_spacing
;
1242 /* Subroutine of pos_visible_p below. Extracts a display string, if
1243 any, from the display spec given as its argument. */
1245 string_from_display_spec (Lisp_Object spec
)
1249 while (CONSP (spec
))
1251 if (STRINGP (XCAR (spec
)))
1256 else if (VECTORP (spec
))
1260 for (i
= 0; i
< ASIZE (spec
); i
++)
1262 if (STRINGP (AREF (spec
, i
)))
1263 return AREF (spec
, i
);
1272 /* Limit insanely large values of W->hscroll on frame F to the largest
1273 value that will still prevent first_visible_x and last_visible_x of
1274 'struct it' from overflowing an int. */
1276 window_hscroll_limited (struct window
*w
, struct frame
*f
)
1278 ptrdiff_t window_hscroll
= w
->hscroll
;
1279 int window_text_width
= window_box_width (w
, TEXT_AREA
);
1280 int colwidth
= FRAME_COLUMN_WIDTH (f
);
1282 if (window_hscroll
> (INT_MAX
- window_text_width
) / colwidth
- 1)
1283 window_hscroll
= (INT_MAX
- window_text_width
) / colwidth
- 1;
1285 return window_hscroll
;
1288 /* Return true if position CHARPOS is visible in window W.
1289 CHARPOS < 0 means return info about WINDOW_END position.
1290 If visible, set *X and *Y to pixel coordinates of top left corner.
1291 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1292 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1295 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1296 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1299 void *itdata
= bidi_shelve_cache ();
1300 struct text_pos top
;
1301 bool visible_p
= false;
1302 struct buffer
*old_buffer
= NULL
;
1305 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1308 if (XBUFFER (w
->contents
) != current_buffer
)
1310 old_buffer
= current_buffer
;
1311 set_buffer_internal_1 (XBUFFER (w
->contents
));
1314 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1315 /* Scrolling a minibuffer window via scroll bar when the echo area
1316 shows long text sometimes resets the minibuffer contents behind
1318 if (CHARPOS (top
) > ZV
)
1319 SET_TEXT_POS (top
, BEGV
, BEGV_BYTE
);
1321 /* Compute exact mode line heights. */
1322 if (WINDOW_WANTS_MODELINE_P (w
))
1324 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1325 BVAR (current_buffer
, mode_line_format
));
1327 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1328 w
->header_line_height
1329 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1330 BVAR (current_buffer
, header_line_format
));
1332 start_display (&it
, w
, top
);
1333 move_it_to (&it
, charpos
, -1, it
.last_visible_y
- 1, -1,
1334 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1337 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
!= -1)
1338 && IT_CHARPOS (it
) >= charpos
)
1339 /* When scanning backwards under bidi iteration, move_it_to
1340 stops at or _before_ CHARPOS, because it stops at or to
1341 the _right_ of the character at CHARPOS. */
1342 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1343 && IT_CHARPOS (it
) <= charpos
)))
1345 /* We have reached CHARPOS, or passed it. How the call to
1346 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1347 or covered by a display property, move_it_to stops at the end
1348 of the invisible text, to the right of CHARPOS. (ii) If
1349 CHARPOS is in a display vector, move_it_to stops on its last
1351 int top_x
= it
.current_x
;
1352 int top_y
= it
.current_y
;
1353 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1356 void *save_it_data
= NULL
;
1358 /* Calling line_bottom_y may change it.method, it.position, etc. */
1359 SAVE_IT (save_it
, it
, save_it_data
);
1361 bottom_y
= line_bottom_y (&it
);
1362 if (top_y
< window_top_y
)
1363 visible_p
= bottom_y
> window_top_y
;
1364 else if (top_y
< it
.last_visible_y
)
1366 if (bottom_y
>= it
.last_visible_y
1367 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1368 && IT_CHARPOS (it
) < charpos
)
1370 /* When the last line of the window is scanned backwards
1371 under bidi iteration, we could be duped into thinking
1372 that we have passed CHARPOS, when in fact move_it_to
1373 simply stopped short of CHARPOS because it reached
1374 last_visible_y. To see if that's what happened, we call
1375 move_it_to again with a slightly larger vertical limit,
1376 and see if it actually moved vertically; if it did, we
1377 didn't really reach CHARPOS, which is beyond window end. */
1378 /* Why 10? because we don't know how many canonical lines
1379 will the height of the next line(s) be. So we guess. */
1380 int ten_more_lines
= 10 * default_line_pixel_height (w
);
1382 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1383 MOVE_TO_POS
| MOVE_TO_Y
);
1384 if (it
.current_y
> top_y
)
1388 RESTORE_IT (&it
, &save_it
, save_it_data
);
1391 if (it
.method
== GET_FROM_DISPLAY_VECTOR
)
1393 /* We stopped on the last glyph of a display vector.
1394 Try and recompute. Hack alert! */
1395 if (charpos
< 2 || top
.charpos
>= charpos
)
1396 top_x
= it
.glyph_row
->x
;
1399 struct it it2
, it2_prev
;
1400 /* The idea is to get to the previous buffer
1401 position, consume the character there, and use
1402 the pixel coordinates we get after that. But if
1403 the previous buffer position is also displayed
1404 from a display vector, we need to consume all of
1405 the glyphs from that display vector. */
1406 start_display (&it2
, w
, top
);
1407 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1408 /* If we didn't get to CHARPOS - 1, there's some
1409 replacing display property at that position, and
1410 we stopped after it. That is exactly the place
1411 whose coordinates we want. */
1412 if (IT_CHARPOS (it2
) != charpos
- 1)
1416 /* Iterate until we get out of the display
1417 vector that displays the character at
1420 get_next_display_element (&it2
);
1421 PRODUCE_GLYPHS (&it2
);
1423 set_iterator_to_next (&it2
, true);
1424 } while (it2
.method
== GET_FROM_DISPLAY_VECTOR
1425 && IT_CHARPOS (it2
) < charpos
);
1427 if (ITERATOR_AT_END_OF_LINE_P (&it2_prev
)
1428 || it2_prev
.current_x
> it2_prev
.last_visible_x
)
1429 top_x
= it
.glyph_row
->x
;
1432 top_x
= it2_prev
.current_x
;
1433 top_y
= it2_prev
.current_y
;
1437 else if (IT_CHARPOS (it
) != charpos
)
1439 Lisp_Object cpos
= make_number (charpos
);
1440 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1441 Lisp_Object string
= string_from_display_spec (spec
);
1442 struct text_pos tpos
;
1443 bool newline_in_string
1445 && memchr (SDATA (string
), '\n', SBYTES (string
)));
1447 SET_TEXT_POS (tpos
, charpos
, CHAR_TO_BYTE (charpos
));
1448 bool replacing_spec_p
1450 && handle_display_spec (NULL
, spec
, Qnil
, Qnil
, &tpos
,
1451 charpos
, FRAME_WINDOW_P (it
.f
)));
1452 /* The tricky code below is needed because there's a
1453 discrepancy between move_it_to and how we set cursor
1454 when PT is at the beginning of a portion of text
1455 covered by a display property or an overlay with a
1456 display property, or the display line ends in a
1457 newline from a display string. move_it_to will stop
1458 _after_ such display strings, whereas
1459 set_cursor_from_row conspires with cursor_row_p to
1460 place the cursor on the first glyph produced from the
1463 /* We have overshoot PT because it is covered by a
1464 display property that replaces the text it covers.
1465 If the string includes embedded newlines, we are also
1466 in the wrong display line. Backtrack to the correct
1467 line, where the display property begins. */
1468 if (replacing_spec_p
)
1470 Lisp_Object startpos
, endpos
;
1471 EMACS_INT start
, end
;
1474 /* Find the first and the last buffer positions
1475 covered by the display string. */
1477 Fnext_single_char_property_change (cpos
, Qdisplay
,
1480 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1482 start
= XFASTINT (startpos
);
1483 end
= XFASTINT (endpos
);
1484 /* Move to the last buffer position before the
1485 display property. */
1486 start_display (&it3
, w
, top
);
1487 if (start
> CHARPOS (top
))
1488 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1489 /* Move forward one more line if the position before
1490 the display string is a newline or if it is the
1491 rightmost character on a line that is
1492 continued or word-wrapped. */
1493 if (it3
.method
== GET_FROM_BUFFER
1495 || FETCH_BYTE (IT_BYTEPOS (it3
)) == '\n'))
1496 move_it_by_lines (&it3
, 1);
1497 else if (move_it_in_display_line_to (&it3
, -1,
1501 == MOVE_LINE_CONTINUED
)
1503 move_it_by_lines (&it3
, 1);
1504 /* When we are under word-wrap, the #$@%!
1505 move_it_by_lines moves 2 lines, so we need to
1507 if (it3
.line_wrap
== WORD_WRAP
)
1508 move_it_by_lines (&it3
, -1);
1511 /* Record the vertical coordinate of the display
1512 line where we wound up. */
1513 top_y
= it3
.current_y
;
1516 /* When characters are reordered for display,
1517 the character displayed to the left of the
1518 display string could be _after_ the display
1519 property in the logical order. Use the
1520 smallest vertical position of these two. */
1521 start_display (&it3
, w
, top
);
1522 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1523 if (it3
.current_y
< top_y
)
1524 top_y
= it3
.current_y
;
1526 /* Move from the top of the window to the beginning
1527 of the display line where the display string
1529 start_display (&it3
, w
, top
);
1530 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1531 /* If it3_moved stays false after the 'while' loop
1532 below, that means we already were at a newline
1533 before the loop (e.g., the display string begins
1534 with a newline), so we don't need to (and cannot)
1535 inspect the glyphs of it3.glyph_row, because
1536 PRODUCE_GLYPHS will not produce anything for a
1537 newline, and thus it3.glyph_row stays at its
1538 stale content it got at top of the window. */
1539 bool it3_moved
= false;
1540 /* Finally, advance the iterator until we hit the
1541 first display element whose character position is
1542 CHARPOS, or until the first newline from the
1543 display string, which signals the end of the
1545 while (get_next_display_element (&it3
))
1547 PRODUCE_GLYPHS (&it3
);
1548 if (IT_CHARPOS (it3
) == charpos
1549 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1552 set_iterator_to_next (&it3
, false);
1554 top_x
= it3
.current_x
- it3
.pixel_width
;
1555 /* Normally, we would exit the above loop because we
1556 found the display element whose character
1557 position is CHARPOS. For the contingency that we
1558 didn't, and stopped at the first newline from the
1559 display string, move back over the glyphs
1560 produced from the string, until we find the
1561 rightmost glyph not from the string. */
1563 && newline_in_string
1564 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1566 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1567 + it3
.glyph_row
->used
[TEXT_AREA
];
1569 while (EQ ((g
- 1)->object
, string
))
1572 top_x
-= g
->pixel_width
;
1574 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1575 + it3
.glyph_row
->used
[TEXT_AREA
]);
1581 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1582 *rtop
= max (0, window_top_y
- top_y
);
1583 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1584 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1585 - max (top_y
, window_top_y
)));
1587 if (it
.bidi_it
.paragraph_dir
== R2L
)
1593 /* Either we were asked to provide info about WINDOW_END, or
1594 CHARPOS is in the partially visible glyph row at end of
1597 void *it2data
= NULL
;
1599 SAVE_IT (it2
, it
, it2data
);
1600 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1601 move_it_by_lines (&it
, 1);
1602 if (charpos
< IT_CHARPOS (it
)
1603 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1606 RESTORE_IT (&it2
, &it2
, it2data
);
1607 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1609 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1610 *rtop
= max (0, -it2
.current_y
);
1611 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1612 - it
.last_visible_y
));
1613 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1615 - max (it2
.current_y
,
1616 WINDOW_HEADER_LINE_HEIGHT (w
))));
1618 if (it2
.bidi_it
.paragraph_dir
== R2L
)
1622 bidi_unshelve_cache (it2data
, true);
1624 bidi_unshelve_cache (itdata
, false);
1627 set_buffer_internal_1 (old_buffer
);
1633 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1634 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1635 /* For lines in an R2L paragraph, we need to mirror the X pixel
1636 coordinate wrt the text area. For the reasons, see the
1637 commentary in buffer_posn_from_coords and the explanation of
1638 the geometry used by the move_it_* functions at the end of
1639 the large commentary near the beginning of this file. */
1641 *x
= window_box_width (w
, TEXT_AREA
) - *x
- 1;
1645 /* Debugging code. */
1647 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1648 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1650 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1657 /* Return the next character from STR. Return in *LEN the length of
1658 the character. This is like STRING_CHAR_AND_LENGTH but never
1659 returns an invalid character. If we find one, we return a `?', but
1660 with the length of the invalid character. */
1663 string_char_and_length (const unsigned char *str
, int *len
)
1667 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1668 if (!CHAR_VALID_P (c
))
1669 /* We may not change the length here because other places in Emacs
1670 don't use this function, i.e. they silently accept invalid
1679 /* Given a position POS containing a valid character and byte position
1680 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1682 static struct text_pos
1683 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1685 eassert (STRINGP (string
) && nchars
>= 0);
1687 if (STRING_MULTIBYTE (string
))
1689 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1694 string_char_and_length (p
, &len
);
1697 BYTEPOS (pos
) += len
;
1701 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1707 /* Value is the text position, i.e. character and byte position,
1708 for character position CHARPOS in STRING. */
1710 static struct text_pos
1711 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1713 struct text_pos pos
;
1714 eassert (STRINGP (string
));
1715 eassert (charpos
>= 0);
1716 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1721 /* Value is a text position, i.e. character and byte position, for
1722 character position CHARPOS in C string S. MULTIBYTE_P
1723 means recognize multibyte characters. */
1725 static struct text_pos
1726 c_string_pos (ptrdiff_t charpos
, const char *s
, bool multibyte_p
)
1728 struct text_pos pos
;
1730 eassert (s
!= NULL
);
1731 eassert (charpos
>= 0);
1737 SET_TEXT_POS (pos
, 0, 0);
1740 string_char_and_length ((const unsigned char *) s
, &len
);
1743 BYTEPOS (pos
) += len
;
1747 SET_TEXT_POS (pos
, charpos
, charpos
);
1753 /* Value is the number of characters in C string S. MULTIBYTE_P
1754 means recognize multibyte characters. */
1757 number_of_chars (const char *s
, bool multibyte_p
)
1763 ptrdiff_t rest
= strlen (s
);
1765 const unsigned char *p
= (const unsigned char *) s
;
1767 for (nchars
= 0; rest
> 0; ++nchars
)
1769 string_char_and_length (p
, &len
);
1770 rest
-= len
, p
+= len
;
1774 nchars
= strlen (s
);
1780 /* Compute byte position NEWPOS->bytepos corresponding to
1781 NEWPOS->charpos. POS is a known position in string STRING.
1782 NEWPOS->charpos must be >= POS.charpos. */
1785 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1787 eassert (STRINGP (string
));
1788 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1790 if (STRING_MULTIBYTE (string
))
1791 *newpos
= string_pos_nchars_ahead (pos
, string
,
1792 CHARPOS (*newpos
) - CHARPOS (pos
));
1794 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1798 Return an estimation of the pixel height of mode or header lines on
1799 frame F. FACE_ID specifies what line's height to estimate. */
1802 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1804 #ifdef HAVE_WINDOW_SYSTEM
1805 if (FRAME_WINDOW_P (f
))
1807 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1809 /* This function is called so early when Emacs starts that the face
1810 cache and mode line face are not yet initialized. */
1811 if (FRAME_FACE_CACHE (f
))
1813 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1817 height
= normal_char_height (face
->font
, -1);
1818 if (face
->box_line_width
> 0)
1819 height
+= 2 * face
->box_line_width
;
1830 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1831 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1832 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP, do
1833 not force the value into range. */
1836 pixel_to_glyph_coords (struct frame
*f
, int pix_x
, int pix_y
, int *x
, int *y
,
1837 NativeRectangle
*bounds
, bool noclip
)
1840 #ifdef HAVE_WINDOW_SYSTEM
1841 if (FRAME_WINDOW_P (f
))
1843 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1844 even for negative values. */
1846 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1848 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1850 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1851 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1854 STORE_NATIVE_RECT (*bounds
,
1855 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1856 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1857 FRAME_COLUMN_WIDTH (f
) - 1,
1858 FRAME_LINE_HEIGHT (f
) - 1);
1860 /* PXW: Should we clip pixels before converting to columns/lines? */
1865 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1866 pix_x
= FRAME_TOTAL_COLS (f
);
1870 else if (pix_y
> FRAME_TOTAL_LINES (f
))
1871 pix_y
= FRAME_TOTAL_LINES (f
);
1881 /* Find the glyph under window-relative coordinates X/Y in window W.
1882 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1883 strings. Return in *HPOS and *VPOS the row and column number of
1884 the glyph found. Return in *AREA the glyph area containing X.
1885 Value is a pointer to the glyph found or null if X/Y is not on
1886 text, or we can't tell because W's current matrix is not up to
1889 static struct glyph
*
1890 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1891 int *dx
, int *dy
, int *area
)
1893 struct glyph
*glyph
, *end
;
1894 struct glyph_row
*row
= NULL
;
1897 /* Find row containing Y. Give up if some row is not enabled. */
1898 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1900 row
= MATRIX_ROW (w
->current_matrix
, i
);
1901 if (!row
->enabled_p
)
1903 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1910 /* Give up if Y is not in the window. */
1911 if (i
== w
->current_matrix
->nrows
)
1914 /* Get the glyph area containing X. */
1915 if (w
->pseudo_window_p
)
1922 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1924 *area
= LEFT_MARGIN_AREA
;
1925 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1927 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1930 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1934 *area
= RIGHT_MARGIN_AREA
;
1935 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1939 /* Find glyph containing X. */
1940 glyph
= row
->glyphs
[*area
];
1941 end
= glyph
+ row
->used
[*area
];
1943 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1945 x
-= glyph
->pixel_width
;
1955 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1958 *hpos
= glyph
- row
->glyphs
[*area
];
1962 /* Convert frame-relative x/y to coordinates relative to window W.
1963 Takes pseudo-windows into account. */
1966 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1968 if (w
->pseudo_window_p
)
1970 /* A pseudo-window is always full-width, and starts at the
1971 left edge of the frame, plus a frame border. */
1972 struct frame
*f
= XFRAME (w
->frame
);
1973 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1974 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1978 *x
-= WINDOW_LEFT_EDGE_X (w
);
1979 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1983 #ifdef HAVE_WINDOW_SYSTEM
1986 Return in RECTS[] at most N clipping rectangles for glyph string S.
1987 Return the number of stored rectangles. */
1990 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1997 if (s
->row
->full_width_p
)
1999 /* Draw full-width. X coordinates are relative to S->w->left_col. */
2000 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
2001 if (s
->row
->mode_line_p
)
2002 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
) - WINDOW_RIGHT_DIVIDER_WIDTH (s
->w
);
2004 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
);
2006 /* Unless displaying a mode or menu bar line, which are always
2007 fully visible, clip to the visible part of the row. */
2008 if (s
->w
->pseudo_window_p
)
2009 r
.height
= s
->row
->visible_height
;
2011 r
.height
= s
->height
;
2015 /* This is a text line that may be partially visible. */
2016 r
.x
= window_box_left (s
->w
, s
->area
);
2017 r
.width
= window_box_width (s
->w
, s
->area
);
2018 r
.height
= s
->row
->visible_height
;
2022 if (r
.x
< s
->clip_head
->x
)
2024 if (r
.width
>= s
->clip_head
->x
- r
.x
)
2025 r
.width
-= s
->clip_head
->x
- r
.x
;
2028 r
.x
= s
->clip_head
->x
;
2031 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
2033 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
2034 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
2039 /* If S draws overlapping rows, it's sufficient to use the top and
2040 bottom of the window for clipping because this glyph string
2041 intentionally draws over other lines. */
2042 if (s
->for_overlaps
)
2044 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2045 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
2047 /* Alas, the above simple strategy does not work for the
2048 environments with anti-aliased text: if the same text is
2049 drawn onto the same place multiple times, it gets thicker.
2050 If the overlap we are processing is for the erased cursor, we
2051 take the intersection with the rectangle of the cursor. */
2052 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
2054 XRectangle rc
, r_save
= r
;
2056 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
2057 rc
.y
= s
->w
->phys_cursor
.y
;
2058 rc
.width
= s
->w
->phys_cursor_width
;
2059 rc
.height
= s
->w
->phys_cursor_height
;
2061 x_intersect_rectangles (&r_save
, &rc
, &r
);
2066 /* Don't use S->y for clipping because it doesn't take partially
2067 visible lines into account. For example, it can be negative for
2068 partially visible lines at the top of a window. */
2069 if (!s
->row
->full_width_p
2070 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2071 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2073 r
.y
= max (0, s
->row
->y
);
2076 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2078 /* If drawing the cursor, don't let glyph draw outside its
2079 advertised boundaries. Cleartype does this under some circumstances. */
2080 if (s
->hl
== DRAW_CURSOR
)
2082 struct glyph
*glyph
= s
->first_glyph
;
2087 if (r
.width
>= s
->x
- r
.x
)
2088 r
.width
-= s
->x
- r
.x
;
2089 else /* R2L hscrolled row with cursor outside text area */
2093 r
.width
= min (r
.width
, glyph
->pixel_width
);
2095 /* If r.y is below window bottom, ensure that we still see a cursor. */
2096 height
= min (glyph
->ascent
+ glyph
->descent
,
2097 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2098 max_y
= window_text_bottom_y (s
->w
) - height
;
2099 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2100 if (s
->ybase
- glyph
->ascent
> max_y
)
2107 /* Don't draw cursor glyph taller than our actual glyph. */
2108 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2109 if (height
< r
.height
)
2111 max_y
= r
.y
+ r
.height
;
2112 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2113 r
.height
= min (max_y
- r
.y
, height
);
2120 XRectangle r_save
= r
;
2122 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2126 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2127 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2129 #ifdef CONVERT_FROM_XRECT
2130 CONVERT_FROM_XRECT (r
, *rects
);
2138 /* If we are processing overlapping and allowed to return
2139 multiple clipping rectangles, we exclude the row of the glyph
2140 string from the clipping rectangle. This is to avoid drawing
2141 the same text on the environment with anti-aliasing. */
2142 #ifdef CONVERT_FROM_XRECT
2145 XRectangle
*rs
= rects
;
2147 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2149 if (s
->for_overlaps
& OVERLAPS_PRED
)
2152 if (r
.y
+ r
.height
> row_y
)
2155 rs
[i
].height
= row_y
- r
.y
;
2161 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2164 if (r
.y
< row_y
+ s
->row
->visible_height
)
2166 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2168 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2169 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2178 #ifdef CONVERT_FROM_XRECT
2179 for (i
= 0; i
< n
; i
++)
2180 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2187 Return in *NR the clipping rectangle for glyph string S. */
2190 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2192 get_glyph_string_clip_rects (s
, nr
, 1);
2197 Return the position and height of the phys cursor in window W.
2198 Set w->phys_cursor_width to width of phys cursor.
2202 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2203 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2205 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2206 int x
, y
, wd
, h
, h0
, y0
, ascent
;
2208 /* Compute the width of the rectangle to draw. If on a stretch
2209 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2210 rectangle as wide as the glyph, but use a canonical character
2212 wd
= glyph
->pixel_width
;
2214 x
= w
->phys_cursor
.x
;
2221 if (glyph
->type
== STRETCH_GLYPH
2222 && !x_stretch_cursor_p
)
2223 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2224 w
->phys_cursor_width
= wd
;
2226 /* Don't let the hollow cursor glyph descend below the glyph row's
2227 ascent value, lest the hollow cursor looks funny. */
2228 y
= w
->phys_cursor
.y
;
2229 ascent
= row
->ascent
;
2230 if (row
->ascent
< glyph
->ascent
)
2232 y
=- glyph
->ascent
- row
->ascent
;
2233 ascent
= glyph
->ascent
;
2236 /* If y is below window bottom, ensure that we still see a cursor. */
2237 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2239 h
= max (h0
, ascent
+ glyph
->descent
);
2240 h0
= min (h0
, ascent
+ glyph
->descent
);
2242 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2245 h
= max (h
- (y0
- y
) + 1, h0
);
2250 y0
= window_text_bottom_y (w
) - h0
;
2258 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2259 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2264 * Remember which glyph the mouse is over.
2268 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2272 struct glyph_row
*r
, *gr
, *end_row
;
2273 enum window_part part
;
2274 enum glyph_row_area area
;
2275 int x
, y
, width
, height
;
2277 /* Try to determine frame pixel position and size of the glyph under
2278 frame pixel coordinates X/Y on frame F. */
2280 if (window_resize_pixelwise
)
2285 else if (!f
->glyphs_initialized_p
2286 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, false),
2289 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2290 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2294 w
= XWINDOW (window
);
2295 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2296 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2298 x
= window_relative_x_coord (w
, part
, gx
);
2299 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2301 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2302 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2304 if (w
->pseudo_window_p
)
2307 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2313 case ON_LEFT_MARGIN
:
2314 area
= LEFT_MARGIN_AREA
;
2317 case ON_RIGHT_MARGIN
:
2318 area
= RIGHT_MARGIN_AREA
;
2321 case ON_HEADER_LINE
:
2323 gr
= (part
== ON_HEADER_LINE
2324 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2325 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2328 goto text_glyph_row_found
;
2335 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2336 if (r
->y
+ r
->height
> y
)
2342 text_glyph_row_found
:
2345 struct glyph
*g
= gr
->glyphs
[area
];
2346 struct glyph
*end
= g
+ gr
->used
[area
];
2348 height
= gr
->height
;
2349 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2350 if (gx
+ g
->pixel_width
> x
)
2355 if (g
->type
== IMAGE_GLYPH
)
2357 /* Don't remember when mouse is over image, as
2358 image may have hot-spots. */
2359 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2362 width
= g
->pixel_width
;
2366 /* Use nominal char spacing at end of line. */
2368 gx
+= (x
/ width
) * width
;
2371 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2373 gx
+= window_box_left_offset (w
, area
);
2374 /* Don't expand over the modeline to make sure the vertical
2375 drag cursor is shown early enough. */
2376 height
= min (height
,
2377 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2382 /* Use nominal line height at end of window. */
2383 gx
= (x
/ width
) * width
;
2385 gy
+= (y
/ height
) * height
;
2386 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2387 /* See comment above. */
2388 height
= min (height
,
2389 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2393 case ON_LEFT_FRINGE
:
2394 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2395 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2396 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2397 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2400 case ON_RIGHT_FRINGE
:
2401 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2402 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2403 : window_box_right_offset (w
, TEXT_AREA
));
2404 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
) == 0
2405 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w
)
2406 && !WINDOW_RIGHTMOST_P (w
))
2407 if (gx
< WINDOW_PIXEL_WIDTH (w
) - width
)
2408 /* Make sure the vertical border can get her own glyph to the
2409 right of the one we build here. */
2410 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
) - width
;
2412 width
= WINDOW_PIXEL_WIDTH (w
) - gx
;
2414 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2418 case ON_VERTICAL_BORDER
:
2419 gx
= WINDOW_PIXEL_WIDTH (w
) - width
;
2422 case ON_VERTICAL_SCROLL_BAR
:
2423 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2425 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2426 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2427 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2429 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2433 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2434 if (r
->y
+ r
->height
> y
)
2441 height
= gr
->height
;
2444 /* Use nominal line height at end of window. */
2446 gy
+= (y
/ height
) * height
;
2450 case ON_RIGHT_DIVIDER
:
2451 gx
= WINDOW_PIXEL_WIDTH (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2452 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2454 /* The bottom divider prevails. */
2455 height
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2458 case ON_BOTTOM_DIVIDER
:
2460 width
= WINDOW_PIXEL_WIDTH (w
);
2461 gy
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2462 height
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2468 /* If there is no glyph under the mouse, then we divide the screen
2469 into a grid of the smallest glyph in the frame, and use that
2472 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2473 round down even for negative values. */
2479 gx
= (gx
/ width
) * width
;
2480 gy
= (gy
/ height
) * height
;
2486 gx
+= WINDOW_LEFT_EDGE_X (w
);
2487 gy
+= WINDOW_TOP_EDGE_Y (w
);
2490 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2492 /* Visible feedback for debugging. */
2493 #if false && defined HAVE_X_WINDOWS
2494 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2495 f
->output_data
.x
->normal_gc
,
2496 gx
, gy
, width
, height
);
2501 #endif /* HAVE_WINDOW_SYSTEM */
2504 adjust_window_ends (struct window
*w
, struct glyph_row
*row
, bool current
)
2507 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
2508 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
2510 = MATRIX_ROW_VPOS (row
, current
? w
->current_matrix
: w
->desired_matrix
);
2513 /***********************************************************************
2514 Lisp form evaluation
2515 ***********************************************************************/
2517 /* Error handler for safe_eval and safe_call. */
2520 safe_eval_handler (Lisp_Object arg
, ptrdiff_t nargs
, Lisp_Object
*args
)
2522 add_to_log ("Error during redisplay: %S signaled %S",
2523 Flist (nargs
, args
), arg
);
2527 /* Call function FUNC with the rest of NARGS - 1 arguments
2528 following. Return the result, or nil if something went
2529 wrong. Prevent redisplay during the evaluation. */
2532 safe__call (bool inhibit_quit
, ptrdiff_t nargs
, Lisp_Object func
, va_list ap
)
2536 if (inhibit_eval_during_redisplay
)
2541 ptrdiff_t count
= SPECPDL_INDEX ();
2544 SAFE_ALLOCA_LISP (args
, nargs
);
2547 for (i
= 1; i
< nargs
; i
++)
2548 args
[i
] = va_arg (ap
, Lisp_Object
);
2550 specbind (Qinhibit_redisplay
, Qt
);
2552 specbind (Qinhibit_quit
, Qt
);
2553 /* Use Qt to ensure debugger does not run,
2554 so there is no possibility of wanting to redisplay. */
2555 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2558 val
= unbind_to (count
, val
);
2565 safe_call (ptrdiff_t nargs
, Lisp_Object func
, ...)
2570 va_start (ap
, func
);
2571 retval
= safe__call (false, nargs
, func
, ap
);
2576 /* Call function FN with one argument ARG.
2577 Return the result, or nil if something went wrong. */
2580 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2582 return safe_call (2, fn
, arg
);
2586 safe__call1 (bool inhibit_quit
, Lisp_Object fn
, ...)
2592 retval
= safe__call (inhibit_quit
, 2, fn
, ap
);
2598 safe_eval (Lisp_Object sexpr
)
2600 return safe__call1 (false, Qeval
, sexpr
);
2604 safe__eval (bool inhibit_quit
, Lisp_Object sexpr
)
2606 return safe__call1 (inhibit_quit
, Qeval
, sexpr
);
2609 /* Call function FN with two arguments ARG1 and ARG2.
2610 Return the result, or nil if something went wrong. */
2613 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2615 return safe_call (3, fn
, arg1
, arg2
);
2620 /***********************************************************************
2622 ***********************************************************************/
2624 /* Define CHECK_IT to perform sanity checks on iterators.
2625 This is for debugging. It is too slow to do unconditionally. */
2628 CHECK_IT (struct it
*it
)
2631 if (it
->method
== GET_FROM_STRING
)
2633 eassert (STRINGP (it
->string
));
2634 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2638 eassert (IT_STRING_CHARPOS (*it
) < 0);
2639 if (it
->method
== GET_FROM_BUFFER
)
2641 /* Check that character and byte positions agree. */
2642 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2647 eassert (it
->current
.dpvec_index
>= 0);
2649 eassert (it
->current
.dpvec_index
< 0);
2654 /* Check that the window end of window W is what we expect it
2655 to be---the last row in the current matrix displaying text. */
2658 CHECK_WINDOW_END (struct window
*w
)
2660 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2661 if (!MINI_WINDOW_P (w
) && w
->window_end_valid
)
2663 struct glyph_row
*row
;
2664 eassert ((row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
),
2666 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2667 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2672 /***********************************************************************
2673 Iterator initialization
2674 ***********************************************************************/
2676 /* Initialize IT for displaying current_buffer in window W, starting
2677 at character position CHARPOS. CHARPOS < 0 means that no buffer
2678 position is specified which is useful when the iterator is assigned
2679 a position later. BYTEPOS is the byte position corresponding to
2682 If ROW is not null, calls to produce_glyphs with IT as parameter
2683 will produce glyphs in that row.
2685 BASE_FACE_ID is the id of a base face to use. It must be one of
2686 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2687 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2688 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2690 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2691 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2692 will be initialized to use the corresponding mode line glyph row of
2693 the desired matrix of W. */
2696 init_iterator (struct it
*it
, struct window
*w
,
2697 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2698 struct glyph_row
*row
, enum face_id base_face_id
)
2700 enum face_id remapped_base_face_id
= base_face_id
;
2702 /* Some precondition checks. */
2703 eassert (w
!= NULL
&& it
!= NULL
);
2704 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2707 /* If face attributes have been changed since the last redisplay,
2708 free realized faces now because they depend on face definitions
2709 that might have changed. Don't free faces while there might be
2710 desired matrices pending which reference these faces. */
2711 if (!inhibit_free_realized_faces
)
2715 face_change
= false;
2716 free_all_realized_faces (Qnil
);
2718 else if (XFRAME (w
->frame
)->face_change
)
2720 XFRAME (w
->frame
)->face_change
= 0;
2721 free_all_realized_faces (w
->frame
);
2725 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2726 if (! NILP (Vface_remapping_alist
))
2727 remapped_base_face_id
2728 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2730 /* Use one of the mode line rows of W's desired matrix if
2734 if (base_face_id
== MODE_LINE_FACE_ID
2735 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2736 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2737 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2738 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2741 /* Clear IT, and set it->object and other IT's Lisp objects to Qnil.
2742 Other parts of redisplay rely on that. */
2743 memclear (it
, sizeof *it
);
2744 it
->current
.overlay_string_index
= -1;
2745 it
->current
.dpvec_index
= -1;
2746 it
->base_face_id
= remapped_base_face_id
;
2747 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2748 it
->paragraph_embedding
= L2R
;
2751 /* The window in which we iterate over current_buffer: */
2752 XSETWINDOW (it
->window
, w
);
2754 it
->f
= XFRAME (w
->frame
);
2758 /* Extra space between lines (on window systems only). */
2759 if (base_face_id
== DEFAULT_FACE_ID
2760 && FRAME_WINDOW_P (it
->f
))
2762 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2763 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2764 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2765 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2766 * FRAME_LINE_HEIGHT (it
->f
));
2767 else if (it
->f
->extra_line_spacing
> 0)
2768 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2771 /* If realized faces have been removed, e.g. because of face
2772 attribute changes of named faces, recompute them. When running
2773 in batch mode, the face cache of the initial frame is null. If
2774 we happen to get called, make a dummy face cache. */
2775 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2776 init_frame_faces (it
->f
);
2777 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2778 recompute_basic_faces (it
->f
);
2780 it
->override_ascent
= -1;
2782 /* Are control characters displayed as `^C'? */
2783 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2785 /* -1 means everything between a CR and the following line end
2786 is invisible. >0 means lines indented more than this value are
2788 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2790 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2792 : (!NILP (BVAR (current_buffer
, selective_display
))
2794 it
->selective_display_ellipsis_p
2795 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2797 /* Display table to use. */
2798 it
->dp
= window_display_table (w
);
2800 /* Are multibyte characters enabled in current_buffer? */
2801 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2803 /* Get the position at which the redisplay_end_trigger hook should
2804 be run, if it is to be run at all. */
2805 if (MARKERP (w
->redisplay_end_trigger
)
2806 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2807 it
->redisplay_end_trigger_charpos
2808 = marker_position (w
->redisplay_end_trigger
);
2809 else if (INTEGERP (w
->redisplay_end_trigger
))
2810 it
->redisplay_end_trigger_charpos
2811 = clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
),
2814 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2816 /* Are lines in the display truncated? */
2818 it
->line_wrap
= TRUNCATE
;
2819 if (base_face_id
== DEFAULT_FACE_ID
2821 && (WINDOW_FULL_WIDTH_P (it
->w
)
2822 || NILP (Vtruncate_partial_width_windows
)
2823 || (INTEGERP (Vtruncate_partial_width_windows
)
2824 /* PXW: Shall we do something about this? */
2825 && (XINT (Vtruncate_partial_width_windows
)
2826 <= WINDOW_TOTAL_COLS (it
->w
))))
2827 && NILP (BVAR (current_buffer
, truncate_lines
)))
2828 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2829 ? WINDOW_WRAP
: WORD_WRAP
;
2831 /* Get dimensions of truncation and continuation glyphs. These are
2832 displayed as fringe bitmaps under X, but we need them for such
2833 frames when the fringes are turned off. But leave the dimensions
2834 zero for tooltip frames, as these glyphs look ugly there and also
2835 sabotage calculations of tooltip dimensions in x-show-tip. */
2836 #ifdef HAVE_WINDOW_SYSTEM
2837 if (!(FRAME_WINDOW_P (it
->f
)
2838 && FRAMEP (tip_frame
)
2839 && it
->f
== XFRAME (tip_frame
)))
2842 if (it
->line_wrap
== TRUNCATE
)
2844 /* We will need the truncation glyph. */
2845 eassert (it
->glyph_row
== NULL
);
2846 produce_special_glyphs (it
, IT_TRUNCATION
);
2847 it
->truncation_pixel_width
= it
->pixel_width
;
2851 /* We will need the continuation glyph. */
2852 eassert (it
->glyph_row
== NULL
);
2853 produce_special_glyphs (it
, IT_CONTINUATION
);
2854 it
->continuation_pixel_width
= it
->pixel_width
;
2858 /* Reset these values to zero because the produce_special_glyphs
2859 above has changed them. */
2860 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2861 it
->phys_ascent
= it
->phys_descent
= 0;
2863 /* Set this after getting the dimensions of truncation and
2864 continuation glyphs, so that we don't produce glyphs when calling
2865 produce_special_glyphs, above. */
2866 it
->glyph_row
= row
;
2867 it
->area
= TEXT_AREA
;
2869 /* Get the dimensions of the display area. The display area
2870 consists of the visible window area plus a horizontally scrolled
2871 part to the left of the window. All x-values are relative to the
2872 start of this total display area. */
2873 if (base_face_id
!= DEFAULT_FACE_ID
)
2875 /* Mode lines, menu bar in terminal frames. */
2876 it
->first_visible_x
= 0;
2877 it
->last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
2882 = window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2883 it
->last_visible_x
= (it
->first_visible_x
2884 + window_box_width (w
, TEXT_AREA
));
2886 /* If we truncate lines, leave room for the truncation glyph(s) at
2887 the right margin. Otherwise, leave room for the continuation
2888 glyph(s). Done only if the window has no right fringe. */
2889 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
2891 if (it
->line_wrap
== TRUNCATE
)
2892 it
->last_visible_x
-= it
->truncation_pixel_width
;
2894 it
->last_visible_x
-= it
->continuation_pixel_width
;
2897 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2898 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2901 /* Leave room for a border glyph. */
2902 if (!FRAME_WINDOW_P (it
->f
)
2903 && !WINDOW_RIGHTMOST_P (it
->w
))
2904 it
->last_visible_x
-= 1;
2906 it
->last_visible_y
= window_text_bottom_y (w
);
2908 /* For mode lines and alike, arrange for the first glyph having a
2909 left box line if the face specifies a box. */
2910 if (base_face_id
!= DEFAULT_FACE_ID
)
2914 it
->face_id
= remapped_base_face_id
;
2916 /* If we have a boxed mode line, make the first character appear
2917 with a left box line. */
2918 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2919 if (face
&& face
->box
!= FACE_NO_BOX
)
2920 it
->start_of_box_run_p
= true;
2923 /* If a buffer position was specified, set the iterator there,
2924 getting overlays and face properties from that position. */
2925 if (charpos
>= BUF_BEG (current_buffer
))
2927 it
->stop_charpos
= charpos
;
2928 it
->end_charpos
= ZV
;
2929 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
2930 IT_CHARPOS (*it
) = charpos
;
2931 IT_BYTEPOS (*it
) = bytepos
;
2933 /* We will rely on `reseat' to set this up properly, via
2934 handle_face_prop. */
2935 it
->face_id
= it
->base_face_id
;
2937 it
->start
= it
->current
;
2938 /* Do we need to reorder bidirectional text? Not if this is a
2939 unibyte buffer: by definition, none of the single-byte
2940 characters are strong R2L, so no reordering is needed. And
2941 bidi.c doesn't support unibyte buffers anyway. Also, don't
2942 reorder while we are loading loadup.el, since the tables of
2943 character properties needed for reordering are not yet
2947 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2950 /* If we are to reorder bidirectional text, init the bidi
2954 /* Since we don't know at this point whether there will be
2955 any R2L lines in the window, we reserve space for
2956 truncation/continuation glyphs even if only the left
2957 fringe is absent. */
2958 if (base_face_id
== DEFAULT_FACE_ID
2959 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
2960 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
2962 if (it
->line_wrap
== TRUNCATE
)
2963 it
->last_visible_x
-= it
->truncation_pixel_width
;
2965 it
->last_visible_x
-= it
->continuation_pixel_width
;
2967 /* Note the paragraph direction that this buffer wants to
2969 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2971 it
->paragraph_embedding
= L2R
;
2972 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2974 it
->paragraph_embedding
= R2L
;
2976 it
->paragraph_embedding
= NEUTRAL_DIR
;
2977 bidi_unshelve_cache (NULL
, false);
2978 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2982 /* Compute faces etc. */
2983 reseat (it
, it
->current
.pos
, true);
2990 /* Initialize IT for the display of window W with window start POS. */
2993 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2995 struct glyph_row
*row
;
2996 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
2998 row
= w
->desired_matrix
->rows
+ first_vpos
;
2999 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
3000 it
->first_vpos
= first_vpos
;
3002 /* Don't reseat to previous visible line start if current start
3003 position is in a string or image. */
3004 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
3006 int first_y
= it
->current_y
;
3008 /* If window start is not at a line start, skip forward to POS to
3009 get the correct continuation lines width. */
3010 bool start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
3011 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
3012 if (!start_at_line_beg_p
)
3016 reseat_at_previous_visible_line_start (it
);
3017 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
3019 new_x
= it
->current_x
+ it
->pixel_width
;
3021 /* If lines are continued, this line may end in the middle
3022 of a multi-glyph character (e.g. a control character
3023 displayed as \003, or in the middle of an overlay
3024 string). In this case move_it_to above will not have
3025 taken us to the start of the continuation line but to the
3026 end of the continued line. */
3027 if (it
->current_x
> 0
3028 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
3029 && (/* And glyph doesn't fit on the line. */
3030 new_x
> it
->last_visible_x
3031 /* Or it fits exactly and we're on a window
3033 || (new_x
== it
->last_visible_x
3034 && FRAME_WINDOW_P (it
->f
)
3035 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
3036 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
3037 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
3039 if ((it
->current
.dpvec_index
>= 0
3040 || it
->current
.overlay_string_index
>= 0)
3041 /* If we are on a newline from a display vector or
3042 overlay string, then we are already at the end of
3043 a screen line; no need to go to the next line in
3044 that case, as this line is not really continued.
3045 (If we do go to the next line, C-e will not DTRT.) */
3048 set_iterator_to_next (it
, true);
3049 move_it_in_display_line_to (it
, -1, -1, 0);
3052 it
->continuation_lines_width
+= it
->current_x
;
3054 /* If the character at POS is displayed via a display
3055 vector, move_it_to above stops at the final glyph of
3056 IT->dpvec. To make the caller redisplay that character
3057 again (a.k.a. start at POS), we need to reset the
3058 dpvec_index to the beginning of IT->dpvec. */
3059 else if (it
->current
.dpvec_index
>= 0)
3060 it
->current
.dpvec_index
= 0;
3062 /* We're starting a new display line, not affected by the
3063 height of the continued line, so clear the appropriate
3064 fields in the iterator structure. */
3065 it
->max_ascent
= it
->max_descent
= 0;
3066 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3068 it
->current_y
= first_y
;
3070 it
->current_x
= it
->hpos
= 0;
3076 /* Return true if POS is a position in ellipses displayed for invisible
3077 text. W is the window we display, for text property lookup. */
3080 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3082 Lisp_Object prop
, window
;
3083 bool ellipses_p
= false;
3084 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3086 /* If POS specifies a position in a display vector, this might
3087 be for an ellipsis displayed for invisible text. We won't
3088 get the iterator set up for delivering that ellipsis unless
3089 we make sure that it gets aware of the invisible text. */
3090 if (pos
->dpvec_index
>= 0
3091 && pos
->overlay_string_index
< 0
3092 && CHARPOS (pos
->string_pos
) < 0
3094 && (XSETWINDOW (window
, w
),
3095 prop
= Fget_char_property (make_number (charpos
),
3096 Qinvisible
, window
),
3097 TEXT_PROP_MEANS_INVISIBLE (prop
) == 0))
3099 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3101 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3108 /* Initialize IT for stepping through current_buffer in window W,
3109 starting at position POS that includes overlay string and display
3110 vector/ control character translation position information. Value
3111 is false if there are overlay strings with newlines at POS. */
3114 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3116 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3118 bool overlay_strings_with_newlines
= false;
3120 /* If POS specifies a position in a display vector, this might
3121 be for an ellipsis displayed for invisible text. We won't
3122 get the iterator set up for delivering that ellipsis unless
3123 we make sure that it gets aware of the invisible text. */
3124 if (in_ellipses_for_invisible_text_p (pos
, w
))
3130 /* Keep in mind: the call to reseat in init_iterator skips invisible
3131 text, so we might end up at a position different from POS. This
3132 is only a problem when POS is a row start after a newline and an
3133 overlay starts there with an after-string, and the overlay has an
3134 invisible property. Since we don't skip invisible text in
3135 display_line and elsewhere immediately after consuming the
3136 newline before the row start, such a POS will not be in a string,
3137 but the call to init_iterator below will move us to the
3139 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3141 /* This only scans the current chunk -- it should scan all chunks.
3142 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3143 to 16 in 22.1 to make this a lesser problem. */
3144 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3146 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3147 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3149 while (s
< e
&& *s
!= '\n')
3154 overlay_strings_with_newlines
= true;
3159 /* If position is within an overlay string, set up IT to the right
3161 if (pos
->overlay_string_index
>= 0)
3165 /* If the first overlay string happens to have a `display'
3166 property for an image, the iterator will be set up for that
3167 image, and we have to undo that setup first before we can
3168 correct the overlay string index. */
3169 if (it
->method
== GET_FROM_IMAGE
)
3172 /* We already have the first chunk of overlay strings in
3173 IT->overlay_strings. Load more until the one for
3174 pos->overlay_string_index is in IT->overlay_strings. */
3175 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3177 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3178 it
->current
.overlay_string_index
= 0;
3181 load_overlay_strings (it
, 0);
3182 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3186 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3187 relative_index
= (it
->current
.overlay_string_index
3188 % OVERLAY_STRING_CHUNK_SIZE
);
3189 it
->string
= it
->overlay_strings
[relative_index
];
3190 eassert (STRINGP (it
->string
));
3191 it
->current
.string_pos
= pos
->string_pos
;
3192 it
->method
= GET_FROM_STRING
;
3193 it
->end_charpos
= SCHARS (it
->string
);
3194 /* Set up the bidi iterator for this overlay string. */
3197 it
->bidi_it
.string
.lstring
= it
->string
;
3198 it
->bidi_it
.string
.s
= NULL
;
3199 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3200 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3201 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3202 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3203 it
->bidi_it
.w
= it
->w
;
3204 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3205 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3207 /* Synchronize the state of the bidi iterator with
3208 pos->string_pos. For any string position other than
3209 zero, this will be done automagically when we resume
3210 iteration over the string and get_visually_first_element
3211 is called. But if string_pos is zero, and the string is
3212 to be reordered for display, we need to resync manually,
3213 since it could be that the iteration state recorded in
3214 pos ended at string_pos of 0 moving backwards in string. */
3215 if (CHARPOS (pos
->string_pos
) == 0)
3217 get_visually_first_element (it
);
3218 if (IT_STRING_CHARPOS (*it
) != 0)
3221 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3222 bidi_move_to_visually_next (&it
->bidi_it
);
3223 } while (it
->bidi_it
.charpos
!= 0);
3225 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3226 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3230 if (CHARPOS (pos
->string_pos
) >= 0)
3232 /* Recorded position is not in an overlay string, but in another
3233 string. This can only be a string from a `display' property.
3234 IT should already be filled with that string. */
3235 it
->current
.string_pos
= pos
->string_pos
;
3236 eassert (STRINGP (it
->string
));
3238 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3239 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3242 /* Restore position in display vector translations, control
3243 character translations or ellipses. */
3244 if (pos
->dpvec_index
>= 0)
3246 if (it
->dpvec
== NULL
)
3247 get_next_display_element (it
);
3248 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3249 it
->current
.dpvec_index
= pos
->dpvec_index
;
3253 return !overlay_strings_with_newlines
;
3257 /* Initialize IT for stepping through current_buffer in window W
3258 starting at ROW->start. */
3261 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3263 init_from_display_pos (it
, w
, &row
->start
);
3264 it
->start
= row
->start
;
3265 it
->continuation_lines_width
= row
->continuation_lines_width
;
3270 /* Initialize IT for stepping through current_buffer in window W
3271 starting in the line following ROW, i.e. starting at ROW->end.
3272 Value is false if there are overlay strings with newlines at ROW's
3276 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3278 bool success
= false;
3280 if (init_from_display_pos (it
, w
, &row
->end
))
3282 if (row
->continued_p
)
3283 it
->continuation_lines_width
3284 = row
->continuation_lines_width
+ row
->pixel_width
;
3295 /***********************************************************************
3297 ***********************************************************************/
3299 /* Called when IT reaches IT->stop_charpos. Handle text property and
3300 overlay changes. Set IT->stop_charpos to the next position where
3304 handle_stop (struct it
*it
)
3306 enum prop_handled handled
;
3307 bool handle_overlay_change_p
;
3311 it
->current
.dpvec_index
= -1;
3312 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3313 it
->ellipsis_p
= false;
3315 /* Use face of preceding text for ellipsis (if invisible) */
3316 if (it
->selective_display_ellipsis_p
)
3317 it
->saved_face_id
= it
->face_id
;
3319 /* Here's the description of the semantics of, and the logic behind,
3320 the various HANDLED_* statuses:
3322 HANDLED_NORMALLY means the handler did its job, and the loop
3323 should proceed to calling the next handler in order.
3325 HANDLED_RECOMPUTE_PROPS means the handler caused a significant
3326 change in the properties and overlays at current position, so the
3327 loop should be restarted, to re-invoke the handlers that were
3328 already called. This happens when fontification-functions were
3329 called by handle_fontified_prop, and actually fontified
3330 something. Another case where HANDLED_RECOMPUTE_PROPS is
3331 returned is when we discover overlay strings that need to be
3332 displayed right away. The loop below will continue for as long
3333 as the status is HANDLED_RECOMPUTE_PROPS.
3335 HANDLED_RETURN means return immediately to the caller, to
3336 continue iteration without calling any further handlers. This is
3337 used when we need to act on some property right away, for example
3338 when we need to display the ellipsis or a replacing display
3339 property, such as display string or image.
3341 HANDLED_OVERLAY_STRING_CONSUMED means an overlay string was just
3342 consumed, and the handler switched to the next overlay string.
3343 This signals the loop below to refrain from looking for more
3344 overlays before all the overlay strings of the current overlay
3347 Some of the handlers called by the loop push the iterator state
3348 onto the stack (see 'push_it'), and arrange for the iteration to
3349 continue with another object, such as an image, a display string,
3350 or an overlay string. In most such cases, it->stop_charpos is
3351 set to the first character of the string, so that when the
3352 iteration resumes, this function will immediately be called
3353 again, to examine the properties at the beginning of the string.
3355 When a display or overlay string is exhausted, the iterator state
3356 is popped (see 'pop_it'), and iteration continues with the
3357 previous object. Again, in many such cases this function is
3358 called again to find the next position where properties might
3363 handled
= HANDLED_NORMALLY
;
3365 /* Call text property handlers. */
3366 for (p
= it_props
; p
->handler
; ++p
)
3368 handled
= p
->handler (it
);
3370 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3372 else if (handled
== HANDLED_RETURN
)
3374 /* We still want to show before and after strings from
3375 overlays even if the actual buffer text is replaced. */
3376 if (!handle_overlay_change_p
3378 /* Don't call get_overlay_strings_1 if we already
3379 have overlay strings loaded, because doing so
3380 will load them again and push the iterator state
3381 onto the stack one more time, which is not
3382 expected by the rest of the code that processes
3384 || (it
->current
.overlay_string_index
< 0
3385 && !get_overlay_strings_1 (it
, 0, false)))
3388 setup_for_ellipsis (it
, 0);
3389 /* When handling a display spec, we might load an
3390 empty string. In that case, discard it here. We
3391 used to discard it in handle_single_display_spec,
3392 but that causes get_overlay_strings_1, above, to
3393 ignore overlay strings that we must check. */
3394 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3398 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3402 it
->string_from_display_prop_p
= false;
3403 it
->from_disp_prop_p
= false;
3404 handle_overlay_change_p
= false;
3406 handled
= HANDLED_RECOMPUTE_PROPS
;
3409 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3410 handle_overlay_change_p
= false;
3413 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3415 /* Don't check for overlay strings below when set to deliver
3416 characters from a display vector. */
3417 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3418 handle_overlay_change_p
= false;
3420 /* Handle overlay changes.
3421 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3422 if it finds overlays. */
3423 if (handle_overlay_change_p
)
3424 handled
= handle_overlay_change (it
);
3429 setup_for_ellipsis (it
, 0);
3433 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3435 /* Determine where to stop next. */
3436 if (handled
== HANDLED_NORMALLY
)
3437 compute_stop_pos (it
);
3441 /* Compute IT->stop_charpos from text property and overlay change
3442 information for IT's current position. */
3445 compute_stop_pos (struct it
*it
)
3447 register INTERVAL iv
, next_iv
;
3448 Lisp_Object object
, limit
, position
;
3449 ptrdiff_t charpos
, bytepos
;
3451 if (STRINGP (it
->string
))
3453 /* Strings are usually short, so don't limit the search for
3455 it
->stop_charpos
= it
->end_charpos
;
3456 object
= it
->string
;
3458 charpos
= IT_STRING_CHARPOS (*it
);
3459 bytepos
= IT_STRING_BYTEPOS (*it
);
3465 /* If end_charpos is out of range for some reason, such as a
3466 misbehaving display function, rationalize it (Bug#5984). */
3467 if (it
->end_charpos
> ZV
)
3468 it
->end_charpos
= ZV
;
3469 it
->stop_charpos
= it
->end_charpos
;
3471 /* If next overlay change is in front of the current stop pos
3472 (which is IT->end_charpos), stop there. Note: value of
3473 next_overlay_change is point-max if no overlay change
3475 charpos
= IT_CHARPOS (*it
);
3476 bytepos
= IT_BYTEPOS (*it
);
3477 pos
= next_overlay_change (charpos
);
3478 if (pos
< it
->stop_charpos
)
3479 it
->stop_charpos
= pos
;
3481 /* Set up variables for computing the stop position from text
3482 property changes. */
3483 XSETBUFFER (object
, current_buffer
);
3484 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3487 /* Get the interval containing IT's position. Value is a null
3488 interval if there isn't such an interval. */
3489 position
= make_number (charpos
);
3490 iv
= validate_interval_range (object
, &position
, &position
, false);
3493 Lisp_Object values_here
[LAST_PROP_IDX
];
3496 /* Get properties here. */
3497 for (p
= it_props
; p
->handler
; ++p
)
3498 values_here
[p
->idx
] = textget (iv
->plist
,
3499 builtin_lisp_symbol (p
->name
));
3501 /* Look for an interval following iv that has different
3503 for (next_iv
= next_interval (iv
);
3506 || XFASTINT (limit
) > next_iv
->position
));
3507 next_iv
= next_interval (next_iv
))
3509 for (p
= it_props
; p
->handler
; ++p
)
3511 Lisp_Object new_value
= textget (next_iv
->plist
,
3512 builtin_lisp_symbol (p
->name
));
3513 if (!EQ (values_here
[p
->idx
], new_value
))
3523 if (INTEGERP (limit
)
3524 && next_iv
->position
>= XFASTINT (limit
))
3525 /* No text property change up to limit. */
3526 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3528 /* Text properties change in next_iv. */
3529 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3533 if (it
->cmp_it
.id
< 0)
3535 ptrdiff_t stoppos
= it
->end_charpos
;
3537 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3539 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3540 stoppos
, it
->string
);
3543 eassert (STRINGP (it
->string
)
3544 || (it
->stop_charpos
>= BEGV
3545 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3549 /* Return the position of the next overlay change after POS in
3550 current_buffer. Value is point-max if no overlay change
3551 follows. This is like `next-overlay-change' but doesn't use
3555 next_overlay_change (ptrdiff_t pos
)
3557 ptrdiff_t i
, noverlays
;
3559 Lisp_Object
*overlays
;
3562 /* Get all overlays at the given position. */
3563 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, true);
3565 /* If any of these overlays ends before endpos,
3566 use its ending point instead. */
3567 for (i
= 0; i
< noverlays
; ++i
)
3572 oend
= OVERLAY_END (overlays
[i
]);
3573 oendpos
= OVERLAY_POSITION (oend
);
3574 endpos
= min (endpos
, oendpos
);
3581 /* How many characters forward to search for a display property or
3582 display string. Searching too far forward makes the bidi display
3583 sluggish, especially in small windows. */
3584 #define MAX_DISP_SCAN 250
3586 /* Return the character position of a display string at or after
3587 position specified by POSITION. If no display string exists at or
3588 after POSITION, return ZV. A display string is either an overlay
3589 with `display' property whose value is a string, or a `display'
3590 text property whose value is a string. STRING is data about the
3591 string to iterate; if STRING->lstring is nil, we are iterating a
3592 buffer. FRAME_WINDOW_P is true when we are displaying a window
3593 on a GUI frame. DISP_PROP is set to zero if we searched
3594 MAX_DISP_SCAN characters forward without finding any display
3595 strings, non-zero otherwise. It is set to 2 if the display string
3596 uses any kind of `(space ...)' spec that will produce a stretch of
3597 white space in the text area. */
3599 compute_display_string_pos (struct text_pos
*position
,
3600 struct bidi_string_data
*string
,
3602 bool frame_window_p
, int *disp_prop
)
3604 /* OBJECT = nil means current buffer. */
3605 Lisp_Object object
, object1
;
3606 Lisp_Object pos
, spec
, limpos
;
3607 bool string_p
= string
&& (STRINGP (string
->lstring
) || string
->s
);
3608 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3609 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3610 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3612 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3613 struct text_pos tpos
;
3616 if (string
&& STRINGP (string
->lstring
))
3617 object1
= object
= string
->lstring
;
3618 else if (w
&& !string_p
)
3620 XSETWINDOW (object
, w
);
3624 object1
= object
= Qnil
;
3629 /* We don't support display properties whose values are strings
3630 that have display string properties. */
3631 || string
->from_disp_str
3632 /* C strings cannot have display properties. */
3633 || (string
->s
&& !STRINGP (object
)))
3639 /* If the character at CHARPOS is where the display string begins,
3641 pos
= make_number (charpos
);
3642 if (STRINGP (object
))
3643 bufpos
= string
->bufpos
;
3647 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3649 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3652 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3660 /* Look forward for the first character with a `display' property
3661 that will replace the underlying text when displayed. */
3662 limpos
= make_number (lim
);
3664 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3665 CHARPOS (tpos
) = XFASTINT (pos
);
3666 if (CHARPOS (tpos
) >= lim
)
3671 if (STRINGP (object
))
3672 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3674 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3675 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3676 if (!STRINGP (object
))
3677 bufpos
= CHARPOS (tpos
);
3678 } while (NILP (spec
)
3679 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3680 bufpos
, frame_window_p
)));
3684 return CHARPOS (tpos
);
3687 /* Return the character position of the end of the display string that
3688 started at CHARPOS. If there's no display string at CHARPOS,
3689 return -1. A display string is either an overlay with `display'
3690 property whose value is a string or a `display' text property whose
3691 value is a string. */
3693 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3695 /* OBJECT = nil means current buffer. */
3696 Lisp_Object object
=
3697 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3698 Lisp_Object pos
= make_number (charpos
);
3700 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3702 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3705 /* It could happen that the display property or overlay was removed
3706 since we found it in compute_display_string_pos above. One way
3707 this can happen is if JIT font-lock was called (through
3708 handle_fontified_prop), and jit-lock-functions remove text
3709 properties or overlays from the portion of buffer that includes
3710 CHARPOS. Muse mode is known to do that, for example. In this
3711 case, we return -1 to the caller, to signal that no display
3712 string is actually present at CHARPOS. See bidi_fetch_char for
3713 how this is handled.
3715 An alternative would be to never look for display properties past
3716 it->stop_charpos. But neither compute_display_string_pos nor
3717 bidi_fetch_char that calls it know or care where the next
3719 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3722 /* Look forward for the first character where the `display' property
3724 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3726 return XFASTINT (pos
);
3731 /***********************************************************************
3733 ***********************************************************************/
3735 /* Handle changes in the `fontified' property of the current buffer by
3736 calling hook functions from Qfontification_functions to fontify
3739 static enum prop_handled
3740 handle_fontified_prop (struct it
*it
)
3742 Lisp_Object prop
, pos
;
3743 enum prop_handled handled
= HANDLED_NORMALLY
;
3745 if (!NILP (Vmemory_full
))
3748 /* Get the value of the `fontified' property at IT's current buffer
3749 position. (The `fontified' property doesn't have a special
3750 meaning in strings.) If the value is nil, call functions from
3751 Qfontification_functions. */
3752 if (!STRINGP (it
->string
)
3754 && !NILP (Vfontification_functions
)
3755 && !NILP (Vrun_hooks
)
3756 && (pos
= make_number (IT_CHARPOS (*it
)),
3757 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3758 /* Ignore the special cased nil value always present at EOB since
3759 no amount of fontifying will be able to change it. */
3760 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3762 ptrdiff_t count
= SPECPDL_INDEX ();
3764 struct buffer
*obuf
= current_buffer
;
3765 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3766 bool old_clip_changed
= current_buffer
->clip_changed
;
3768 val
= Vfontification_functions
;
3769 specbind (Qfontification_functions
, Qnil
);
3771 eassert (it
->end_charpos
== ZV
);
3773 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3774 safe_call1 (val
, pos
);
3777 Lisp_Object fns
, fn
;
3781 for (; CONSP (val
); val
= XCDR (val
))
3787 /* A value of t indicates this hook has a local
3788 binding; it means to run the global binding too.
3789 In a global value, t should not occur. If it
3790 does, we must ignore it to avoid an endless
3792 for (fns
= Fdefault_value (Qfontification_functions
);
3798 safe_call1 (fn
, pos
);
3802 safe_call1 (fn
, pos
);
3806 unbind_to (count
, Qnil
);
3808 /* Fontification functions routinely call `save-restriction'.
3809 Normally, this tags clip_changed, which can confuse redisplay
3810 (see discussion in Bug#6671). Since we don't perform any
3811 special handling of fontification changes in the case where
3812 `save-restriction' isn't called, there's no point doing so in
3813 this case either. So, if the buffer's restrictions are
3814 actually left unchanged, reset clip_changed. */
3815 if (obuf
== current_buffer
)
3817 if (begv
== BEGV
&& zv
== ZV
)
3818 current_buffer
->clip_changed
= old_clip_changed
;
3820 /* There isn't much we can reasonably do to protect against
3821 misbehaving fontification, but here's a fig leaf. */
3822 else if (BUFFER_LIVE_P (obuf
))
3823 set_buffer_internal_1 (obuf
);
3825 /* The fontification code may have added/removed text.
3826 It could do even a lot worse, but let's at least protect against
3827 the most obvious case where only the text past `pos' gets changed',
3828 as is/was done in grep.el where some escapes sequences are turned
3829 into face properties (bug#7876). */
3830 it
->end_charpos
= ZV
;
3832 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3833 something. This avoids an endless loop if they failed to
3834 fontify the text for which reason ever. */
3835 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3836 handled
= HANDLED_RECOMPUTE_PROPS
;
3844 /***********************************************************************
3846 ***********************************************************************/
3848 /* Set up iterator IT from face properties at its current position.
3849 Called from handle_stop. */
3851 static enum prop_handled
3852 handle_face_prop (struct it
*it
)
3855 ptrdiff_t next_stop
;
3857 if (!STRINGP (it
->string
))
3860 = face_at_buffer_position (it
->w
,
3864 + TEXT_PROP_DISTANCE_LIMIT
),
3865 false, it
->base_face_id
);
3867 /* Is this a start of a run of characters with box face?
3868 Caveat: this can be called for a freshly initialized
3869 iterator; face_id is -1 in this case. We know that the new
3870 face will not change until limit, i.e. if the new face has a
3871 box, all characters up to limit will have one. But, as
3872 usual, we don't know whether limit is really the end. */
3873 if (new_face_id
!= it
->face_id
)
3875 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3876 /* If it->face_id is -1, old_face below will be NULL, see
3877 the definition of FACE_FROM_ID. This will happen if this
3878 is the initial call that gets the face. */
3879 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3881 /* If the value of face_id of the iterator is -1, we have to
3882 look in front of IT's position and see whether there is a
3883 face there that's different from new_face_id. */
3884 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
3886 int prev_face_id
= face_before_it_pos (it
);
3888 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
3891 /* If the new face has a box, but the old face does not,
3892 this is the start of a run of characters with box face,
3893 i.e. this character has a shadow on the left side. */
3894 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
3895 && (old_face
== NULL
|| !old_face
->box
));
3896 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3904 Lisp_Object from_overlay
3905 = (it
->current
.overlay_string_index
>= 0
3906 ? it
->string_overlays
[it
->current
.overlay_string_index
3907 % OVERLAY_STRING_CHUNK_SIZE
]
3910 /* See if we got to this string directly or indirectly from
3911 an overlay property. That includes the before-string or
3912 after-string of an overlay, strings in display properties
3913 provided by an overlay, their text properties, etc.
3915 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3916 if (! NILP (from_overlay
))
3917 for (i
= it
->sp
- 1; i
>= 0; i
--)
3919 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3921 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3922 % OVERLAY_STRING_CHUNK_SIZE
];
3923 else if (! NILP (it
->stack
[i
].from_overlay
))
3924 from_overlay
= it
->stack
[i
].from_overlay
;
3926 if (!NILP (from_overlay
))
3930 if (! NILP (from_overlay
))
3932 bufpos
= IT_CHARPOS (*it
);
3933 /* For a string from an overlay, the base face depends
3934 only on text properties and ignores overlays. */
3936 = face_for_overlay_string (it
->w
,
3940 + TEXT_PROP_DISTANCE_LIMIT
),
3948 /* For strings from a `display' property, use the face at
3949 IT's current buffer position as the base face to merge
3950 with, so that overlay strings appear in the same face as
3951 surrounding text, unless they specify their own faces.
3952 For strings from wrap-prefix and line-prefix properties,
3953 use the default face, possibly remapped via
3954 Vface_remapping_alist. */
3955 /* Note that the fact that we use the face at _buffer_
3956 position means that a 'display' property on an overlay
3957 string will not inherit the face of that overlay string,
3958 but will instead revert to the face of buffer text
3959 covered by the overlay. This is visible, e.g., when the
3960 overlay specifies a box face, but neither the buffer nor
3961 the display string do. This sounds like a design bug,
3962 but Emacs always did that since v21.1, so changing that
3963 might be a big deal. */
3964 base_face_id
= it
->string_from_prefix_prop_p
3965 ? (!NILP (Vface_remapping_alist
)
3966 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
3968 : underlying_face_id (it
);
3971 new_face_id
= face_at_string_position (it
->w
,
3973 IT_STRING_CHARPOS (*it
),
3976 base_face_id
, false);
3978 /* Is this a start of a run of characters with box? Caveat:
3979 this can be called for a freshly allocated iterator; face_id
3980 is -1 is this case. We know that the new face will not
3981 change until the next check pos, i.e. if the new face has a
3982 box, all characters up to that position will have a
3983 box. But, as usual, we don't know whether that position
3984 is really the end. */
3985 if (new_face_id
!= it
->face_id
)
3987 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3988 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3990 /* If new face has a box but old face hasn't, this is the
3991 start of a run of characters with box, i.e. it has a
3992 shadow on the left side. */
3993 it
->start_of_box_run_p
3994 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3995 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3999 it
->face_id
= new_face_id
;
4000 return HANDLED_NORMALLY
;
4004 /* Return the ID of the face ``underlying'' IT's current position,
4005 which is in a string. If the iterator is associated with a
4006 buffer, return the face at IT's current buffer position.
4007 Otherwise, use the iterator's base_face_id. */
4010 underlying_face_id (struct it
*it
)
4012 int face_id
= it
->base_face_id
, i
;
4014 eassert (STRINGP (it
->string
));
4016 for (i
= it
->sp
- 1; i
>= 0; --i
)
4017 if (NILP (it
->stack
[i
].string
))
4018 face_id
= it
->stack
[i
].face_id
;
4024 /* Compute the face one character before or after the current position
4025 of IT, in the visual order. BEFORE_P means get the face
4026 in front (to the left in L2R paragraphs, to the right in R2L
4027 paragraphs) of IT's screen position. Value is the ID of the face. */
4030 face_before_or_after_it_pos (struct it
*it
, bool before_p
)
4033 ptrdiff_t next_check_charpos
;
4035 void *it_copy_data
= NULL
;
4037 eassert (it
->s
== NULL
);
4039 if (STRINGP (it
->string
))
4041 ptrdiff_t bufpos
, charpos
;
4044 /* No face change past the end of the string (for the case
4045 we are padding with spaces). No face change before the
4047 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
4048 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
4053 /* Set charpos to the position before or after IT's current
4054 position, in the logical order, which in the non-bidi
4055 case is the same as the visual order. */
4057 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4058 else if (it
->what
== IT_COMPOSITION
)
4059 /* For composition, we must check the character after the
4061 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4063 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4069 /* With bidi iteration, the character before the current
4070 in the visual order cannot be found by simple
4071 iteration, because "reverse" reordering is not
4072 supported. Instead, we need to start from the string
4073 beginning and go all the way to the current string
4074 position, remembering the previous position. */
4075 /* Ignore face changes before the first visible
4076 character on this display line. */
4077 if (it
->current_x
<= it
->first_visible_x
)
4079 SAVE_IT (it_copy
, *it
, it_copy_data
);
4080 IT_STRING_CHARPOS (it_copy
) = 0;
4081 bidi_init_it (0, 0, FRAME_WINDOW_P (it_copy
.f
), &it_copy
.bidi_it
);
4085 charpos
= IT_STRING_CHARPOS (it_copy
);
4086 if (charpos
>= SCHARS (it
->string
))
4088 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4090 while (IT_STRING_CHARPOS (it_copy
) != IT_STRING_CHARPOS (*it
));
4092 RESTORE_IT (it
, it
, it_copy_data
);
4096 /* Set charpos to the string position of the character
4097 that comes after IT's current position in the visual
4099 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4103 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4105 charpos
= it_copy
.bidi_it
.charpos
;
4108 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4110 if (it
->current
.overlay_string_index
>= 0)
4111 bufpos
= IT_CHARPOS (*it
);
4115 base_face_id
= underlying_face_id (it
);
4117 /* Get the face for ASCII, or unibyte. */
4118 face_id
= face_at_string_position (it
->w
,
4122 &next_check_charpos
,
4123 base_face_id
, false);
4125 /* Correct the face for charsets different from ASCII. Do it
4126 for the multibyte case only. The face returned above is
4127 suitable for unibyte text if IT->string is unibyte. */
4128 if (STRING_MULTIBYTE (it
->string
))
4130 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4131 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4133 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4135 c
= string_char_and_length (p
, &len
);
4136 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4141 struct text_pos pos
;
4143 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4144 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4147 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4148 pos
= it
->current
.pos
;
4153 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4156 if (it
->what
== IT_COMPOSITION
)
4158 /* For composition, we must check the position after
4160 pos
.charpos
+= it
->cmp_it
.nchars
;
4161 pos
.bytepos
+= it
->len
;
4164 INC_TEXT_POS (pos
, it
->multibyte_p
);
4173 /* With bidi iteration, the character before the current
4174 in the visual order cannot be found by simple
4175 iteration, because "reverse" reordering is not
4176 supported. Instead, we need to use the move_it_*
4177 family of functions, and move to the previous
4178 character starting from the beginning of the visual
4180 /* Ignore face changes before the first visible
4181 character on this display line. */
4182 if (it
->current_x
<= it
->first_visible_x
)
4184 SAVE_IT (it_copy
, *it
, it_copy_data
);
4185 /* Implementation note: Since move_it_in_display_line
4186 works in the iterator geometry, and thinks the first
4187 character is always the leftmost, even in R2L lines,
4188 we don't need to distinguish between the R2L and L2R
4190 current_x
= it_copy
.current_x
;
4191 move_it_vertically_backward (&it_copy
, 0);
4192 move_it_in_display_line (&it_copy
, ZV
, current_x
- 1, MOVE_TO_X
);
4193 pos
= it_copy
.current
.pos
;
4194 RESTORE_IT (it
, it
, it_copy_data
);
4198 /* Set charpos to the buffer position of the character
4199 that comes after IT's current position in the visual
4201 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4205 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4208 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4211 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4213 /* Determine face for CHARSET_ASCII, or unibyte. */
4214 face_id
= face_at_buffer_position (it
->w
,
4216 &next_check_charpos
,
4219 /* Correct the face for charsets different from ASCII. Do it
4220 for the multibyte case only. The face returned above is
4221 suitable for unibyte text if current_buffer is unibyte. */
4222 if (it
->multibyte_p
)
4224 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4225 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4226 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4235 /***********************************************************************
4237 ***********************************************************************/
4239 /* Set up iterator IT from invisible properties at its current
4240 position. Called from handle_stop. */
4242 static enum prop_handled
4243 handle_invisible_prop (struct it
*it
)
4245 enum prop_handled handled
= HANDLED_NORMALLY
;
4249 if (STRINGP (it
->string
))
4251 Lisp_Object end_charpos
, limit
;
4253 /* Get the value of the invisible text property at the
4254 current position. Value will be nil if there is no such
4256 end_charpos
= make_number (IT_STRING_CHARPOS (*it
));
4257 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4258 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4260 if (invis
!= 0 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4262 /* Record whether we have to display an ellipsis for the
4264 bool display_ellipsis_p
= (invis
== 2);
4265 ptrdiff_t len
, endpos
;
4267 handled
= HANDLED_RECOMPUTE_PROPS
;
4269 /* Get the position at which the next visible text can be
4270 found in IT->string, if any. */
4271 endpos
= len
= SCHARS (it
->string
);
4272 XSETINT (limit
, len
);
4276 = Fnext_single_property_change (end_charpos
, Qinvisible
,
4278 /* Since LIMIT is always an integer, so should be the
4279 value returned by Fnext_single_property_change. */
4280 eassert (INTEGERP (end_charpos
));
4281 if (INTEGERP (end_charpos
))
4283 endpos
= XFASTINT (end_charpos
);
4284 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4285 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4287 display_ellipsis_p
= true;
4289 else /* Should never happen; but if it does, exit the loop. */
4292 while (invis
!= 0 && endpos
< len
);
4294 if (display_ellipsis_p
)
4295 it
->ellipsis_p
= true;
4299 /* Text at END_CHARPOS is visible. Move IT there. */
4300 struct text_pos old
;
4303 old
= it
->current
.string_pos
;
4304 oldpos
= CHARPOS (old
);
4307 if (it
->bidi_it
.first_elt
4308 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4309 bidi_paragraph_init (it
->paragraph_embedding
,
4310 &it
->bidi_it
, true);
4311 /* Bidi-iterate out of the invisible text. */
4314 bidi_move_to_visually_next (&it
->bidi_it
);
4316 while (oldpos
<= it
->bidi_it
.charpos
4317 && it
->bidi_it
.charpos
< endpos
);
4319 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4320 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4321 if (IT_CHARPOS (*it
) >= endpos
)
4322 it
->prev_stop
= endpos
;
4326 IT_STRING_CHARPOS (*it
) = endpos
;
4327 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4332 /* The rest of the string is invisible. If this is an
4333 overlay string, proceed with the next overlay string
4334 or whatever comes and return a character from there. */
4335 if (it
->current
.overlay_string_index
>= 0
4336 && !display_ellipsis_p
)
4338 next_overlay_string (it
);
4339 /* Don't check for overlay strings when we just
4340 finished processing them. */
4341 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4345 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4346 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4353 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4354 Lisp_Object pos
, overlay
;
4356 /* First of all, is there invisible text at this position? */
4357 tem
= start_charpos
= IT_CHARPOS (*it
);
4358 pos
= make_number (tem
);
4359 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4361 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4363 /* If we are on invisible text, skip over it. */
4364 if (invis
!= 0 && start_charpos
< it
->end_charpos
)
4366 /* Record whether we have to display an ellipsis for the
4368 bool display_ellipsis_p
= invis
== 2;
4370 handled
= HANDLED_RECOMPUTE_PROPS
;
4372 /* Loop skipping over invisible text. The loop is left at
4373 ZV or with IT on the first char being visible again. */
4376 /* Try to skip some invisible text. Return value is the
4377 position reached which can be equal to where we start
4378 if there is nothing invisible there. This skips both
4379 over invisible text properties and overlays with
4380 invisible property. */
4381 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4383 /* If we skipped nothing at all we weren't at invisible
4384 text in the first place. If everything to the end of
4385 the buffer was skipped, end the loop. */
4386 if (newpos
== tem
|| newpos
>= ZV
)
4390 /* We skipped some characters but not necessarily
4391 all there are. Check if we ended up on visible
4392 text. Fget_char_property returns the property of
4393 the char before the given position, i.e. if we
4394 get invis = 0, this means that the char at
4395 newpos is visible. */
4396 pos
= make_number (newpos
);
4397 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4398 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4401 /* If we ended up on invisible text, proceed to
4402 skip starting with next_stop. */
4406 /* If there are adjacent invisible texts, don't lose the
4407 second one's ellipsis. */
4409 display_ellipsis_p
= true;
4413 /* The position newpos is now either ZV or on visible text. */
4416 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4418 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4420 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4422 /* If the invisible text ends on a newline or on a
4423 character after a newline, we can avoid the costly,
4424 character by character, bidi iteration to NEWPOS, and
4425 instead simply reseat the iterator there. That's
4426 because all bidi reordering information is tossed at
4427 the newline. This is a big win for modes that hide
4428 complete lines, like Outline, Org, etc. */
4429 if (on_newline
|| after_newline
)
4431 struct text_pos tpos
;
4432 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4434 SET_TEXT_POS (tpos
, newpos
, bpos
);
4435 reseat_1 (it
, tpos
, false);
4436 /* If we reseat on a newline/ZV, we need to prep the
4437 bidi iterator for advancing to the next character
4438 after the newline/EOB, keeping the current paragraph
4439 direction (so that PRODUCE_GLYPHS does TRT wrt
4440 prepending/appending glyphs to a glyph row). */
4443 it
->bidi_it
.first_elt
= false;
4444 it
->bidi_it
.paragraph_dir
= pdir
;
4445 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4446 it
->bidi_it
.nchars
= 1;
4447 it
->bidi_it
.ch_len
= 1;
4450 else /* Must use the slow method. */
4452 /* With bidi iteration, the region of invisible text
4453 could start and/or end in the middle of a
4454 non-base embedding level. Therefore, we need to
4455 skip invisible text using the bidi iterator,
4456 starting at IT's current position, until we find
4457 ourselves outside of the invisible text.
4458 Skipping invisible text _after_ bidi iteration
4459 avoids affecting the visual order of the
4460 displayed text when invisible properties are
4461 added or removed. */
4462 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4464 /* If we were `reseat'ed to a new paragraph,
4465 determine the paragraph base direction. We
4466 need to do it now because
4467 next_element_from_buffer may not have a
4468 chance to do it, if we are going to skip any
4469 text at the beginning, which resets the
4471 bidi_paragraph_init (it
->paragraph_embedding
,
4472 &it
->bidi_it
, true);
4476 bidi_move_to_visually_next (&it
->bidi_it
);
4478 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4479 && it
->bidi_it
.charpos
< newpos
);
4480 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4481 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4482 /* If we overstepped NEWPOS, record its position in
4483 the iterator, so that we skip invisible text if
4484 later the bidi iteration lands us in the
4485 invisible region again. */
4486 if (IT_CHARPOS (*it
) >= newpos
)
4487 it
->prev_stop
= newpos
;
4492 IT_CHARPOS (*it
) = newpos
;
4493 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4496 if (display_ellipsis_p
)
4498 /* Make sure that the glyphs of the ellipsis will get
4499 correct `charpos' values. If we would not update
4500 it->position here, the glyphs would belong to the
4501 last visible character _before_ the invisible
4502 text, which confuses `set_cursor_from_row'.
4504 We use the last invisible position instead of the
4505 first because this way the cursor is always drawn on
4506 the first "." of the ellipsis, whenever PT is inside
4507 the invisible text. Otherwise the cursor would be
4508 placed _after_ the ellipsis when the point is after the
4509 first invisible character. */
4510 if (!STRINGP (it
->object
))
4512 it
->position
.charpos
= newpos
- 1;
4513 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4517 /* If there are before-strings at the start of invisible
4518 text, and the text is invisible because of a text
4519 property, arrange to show before-strings because 20.x did
4520 it that way. (If the text is invisible because of an
4521 overlay property instead of a text property, this is
4522 already handled in the overlay code.) */
4524 && get_overlay_strings (it
, it
->stop_charpos
))
4526 handled
= HANDLED_RECOMPUTE_PROPS
;
4529 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4530 /* The call to get_overlay_strings above recomputes
4531 it->stop_charpos, but it only considers changes
4532 in properties and overlays beyond iterator's
4533 current position. This causes us to miss changes
4534 that happen exactly where the invisible property
4535 ended. So we play it safe here and force the
4536 iterator to check for potential stop positions
4537 immediately after the invisible text. Note that
4538 if get_overlay_strings returns true, it
4539 normally also pushed the iterator stack, so we
4540 need to update the stop position in the slot
4541 below the current one. */
4542 it
->stack
[it
->sp
- 1].stop_charpos
4543 = CHARPOS (it
->stack
[it
->sp
- 1].current
.pos
);
4546 else if (display_ellipsis_p
)
4548 it
->ellipsis_p
= true;
4549 /* Let the ellipsis display before
4550 considering any properties of the following char.
4551 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4552 handled
= HANDLED_RETURN
;
4561 /* Make iterator IT return `...' next.
4562 Replaces LEN characters from buffer. */
4565 setup_for_ellipsis (struct it
*it
, int len
)
4567 /* Use the display table definition for `...'. Invalid glyphs
4568 will be handled by the method returning elements from dpvec. */
4569 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4571 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4572 it
->dpvec
= v
->contents
;
4573 it
->dpend
= v
->contents
+ v
->header
.size
;
4577 /* Default `...'. */
4578 it
->dpvec
= default_invis_vector
;
4579 it
->dpend
= default_invis_vector
+ 3;
4582 it
->dpvec_char_len
= len
;
4583 it
->current
.dpvec_index
= 0;
4584 it
->dpvec_face_id
= -1;
4586 /* Remember the current face id in case glyphs specify faces.
4587 IT's face is restored in set_iterator_to_next.
4588 saved_face_id was set to preceding char's face in handle_stop. */
4589 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4590 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4592 /* If the ellipsis represents buffer text, it means we advanced in
4593 the buffer, so we should no longer ignore overlay strings. */
4594 if (it
->method
== GET_FROM_BUFFER
)
4595 it
->ignore_overlay_strings_at_pos_p
= false;
4597 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4598 it
->ellipsis_p
= true;
4603 /***********************************************************************
4605 ***********************************************************************/
4607 /* Set up iterator IT from `display' property at its current position.
4608 Called from handle_stop.
4609 We return HANDLED_RETURN if some part of the display property
4610 overrides the display of the buffer text itself.
4611 Otherwise we return HANDLED_NORMALLY. */
4613 static enum prop_handled
4614 handle_display_prop (struct it
*it
)
4616 Lisp_Object propval
, object
, overlay
;
4617 struct text_pos
*position
;
4619 /* Nonzero if some property replaces the display of the text itself. */
4620 int display_replaced
= 0;
4622 if (STRINGP (it
->string
))
4624 object
= it
->string
;
4625 position
= &it
->current
.string_pos
;
4626 bufpos
= CHARPOS (it
->current
.pos
);
4630 XSETWINDOW (object
, it
->w
);
4631 position
= &it
->current
.pos
;
4632 bufpos
= CHARPOS (*position
);
4635 /* Reset those iterator values set from display property values. */
4636 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4637 it
->space_width
= Qnil
;
4638 it
->font_height
= Qnil
;
4641 /* We don't support recursive `display' properties, i.e. string
4642 values that have a string `display' property, that have a string
4643 `display' property etc. */
4644 if (!it
->string_from_display_prop_p
)
4645 it
->area
= TEXT_AREA
;
4647 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4648 Qdisplay
, object
, &overlay
);
4650 return HANDLED_NORMALLY
;
4651 /* Now OVERLAY is the overlay that gave us this property, or nil
4652 if it was a text property. */
4654 if (!STRINGP (it
->string
))
4655 object
= it
->w
->contents
;
4657 display_replaced
= handle_display_spec (it
, propval
, object
, overlay
,
4659 FRAME_WINDOW_P (it
->f
));
4660 return display_replaced
!= 0 ? HANDLED_RETURN
: HANDLED_NORMALLY
;
4663 /* Subroutine of handle_display_prop. Returns non-zero if the display
4664 specification in SPEC is a replacing specification, i.e. it would
4665 replace the text covered by `display' property with something else,
4666 such as an image or a display string. If SPEC includes any kind or
4667 `(space ...) specification, the value is 2; this is used by
4668 compute_display_string_pos, which see.
4670 See handle_single_display_spec for documentation of arguments.
4671 FRAME_WINDOW_P is true if the window being redisplayed is on a
4672 GUI frame; this argument is used only if IT is NULL, see below.
4674 IT can be NULL, if this is called by the bidi reordering code
4675 through compute_display_string_pos, which see. In that case, this
4676 function only examines SPEC, but does not otherwise "handle" it, in
4677 the sense that it doesn't set up members of IT from the display
4680 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4681 Lisp_Object overlay
, struct text_pos
*position
,
4682 ptrdiff_t bufpos
, bool frame_window_p
)
4687 /* Simple specifications. */
4688 && !EQ (XCAR (spec
), Qimage
)
4689 && !EQ (XCAR (spec
), Qspace
)
4690 && !EQ (XCAR (spec
), Qwhen
)
4691 && !EQ (XCAR (spec
), Qslice
)
4692 && !EQ (XCAR (spec
), Qspace_width
)
4693 && !EQ (XCAR (spec
), Qheight
)
4694 && !EQ (XCAR (spec
), Qraise
)
4695 /* Marginal area specifications. */
4696 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4697 && !EQ (XCAR (spec
), Qleft_fringe
)
4698 && !EQ (XCAR (spec
), Qright_fringe
)
4699 && !NILP (XCAR (spec
)))
4701 for (; CONSP (spec
); spec
= XCDR (spec
))
4703 int rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4704 overlay
, position
, bufpos
,
4705 replacing
, frame_window_p
);
4709 /* If some text in a string is replaced, `position' no
4710 longer points to the position of `object'. */
4711 if (!it
|| STRINGP (object
))
4716 else if (VECTORP (spec
))
4719 for (i
= 0; i
< ASIZE (spec
); ++i
)
4721 int rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4722 overlay
, position
, bufpos
,
4723 replacing
, frame_window_p
);
4727 /* If some text in a string is replaced, `position' no
4728 longer points to the position of `object'. */
4729 if (!it
|| STRINGP (object
))
4735 replacing
= handle_single_display_spec (it
, spec
, object
, overlay
, position
,
4736 bufpos
, 0, frame_window_p
);
4740 /* Value is the position of the end of the `display' property starting
4741 at START_POS in OBJECT. */
4743 static struct text_pos
4744 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4747 struct text_pos end_pos
;
4749 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4750 Qdisplay
, object
, Qnil
);
4751 CHARPOS (end_pos
) = XFASTINT (end
);
4752 if (STRINGP (object
))
4753 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4755 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4761 /* Set up IT from a single `display' property specification SPEC. OBJECT
4762 is the object in which the `display' property was found. *POSITION
4763 is the position in OBJECT at which the `display' property was found.
4764 BUFPOS is the buffer position of OBJECT (different from POSITION if
4765 OBJECT is not a buffer). DISPLAY_REPLACED non-zero means that we
4766 previously saw a display specification which already replaced text
4767 display with something else, for example an image; we ignore such
4768 properties after the first one has been processed.
4770 OVERLAY is the overlay this `display' property came from,
4771 or nil if it was a text property.
4773 If SPEC is a `space' or `image' specification, and in some other
4774 cases too, set *POSITION to the position where the `display'
4777 If IT is NULL, only examine the property specification in SPEC, but
4778 don't set up IT. In that case, FRAME_WINDOW_P means SPEC
4779 is intended to be displayed in a window on a GUI frame.
4781 Value is non-zero if something was found which replaces the display
4782 of buffer or string text. */
4785 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4786 Lisp_Object overlay
, struct text_pos
*position
,
4787 ptrdiff_t bufpos
, int display_replaced
,
4788 bool frame_window_p
)
4791 Lisp_Object location
, value
;
4792 struct text_pos start_pos
= *position
;
4794 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4795 If the result is non-nil, use VALUE instead of SPEC. */
4797 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4806 if (!NILP (form
) && !EQ (form
, Qt
))
4808 ptrdiff_t count
= SPECPDL_INDEX ();
4810 /* Bind `object' to the object having the `display' property, a
4811 buffer or string. Bind `position' to the position in the
4812 object where the property was found, and `buffer-position'
4813 to the current position in the buffer. */
4816 XSETBUFFER (object
, current_buffer
);
4817 specbind (Qobject
, object
);
4818 specbind (Qposition
, make_number (CHARPOS (*position
)));
4819 specbind (Qbuffer_position
, make_number (bufpos
));
4820 form
= safe_eval (form
);
4821 unbind_to (count
, Qnil
);
4827 /* Handle `(height HEIGHT)' specifications. */
4829 && EQ (XCAR (spec
), Qheight
)
4830 && CONSP (XCDR (spec
)))
4834 if (!FRAME_WINDOW_P (it
->f
))
4837 it
->font_height
= XCAR (XCDR (spec
));
4838 if (!NILP (it
->font_height
))
4840 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4841 int new_height
= -1;
4843 if (CONSP (it
->font_height
)
4844 && (EQ (XCAR (it
->font_height
), Qplus
)
4845 || EQ (XCAR (it
->font_height
), Qminus
))
4846 && CONSP (XCDR (it
->font_height
))
4847 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4849 /* `(+ N)' or `(- N)' where N is an integer. */
4850 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4851 if (EQ (XCAR (it
->font_height
), Qplus
))
4853 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4855 else if (FUNCTIONP (it
->font_height
))
4857 /* Call function with current height as argument.
4858 Value is the new height. */
4860 height
= safe_call1 (it
->font_height
,
4861 face
->lface
[LFACE_HEIGHT_INDEX
]);
4862 if (NUMBERP (height
))
4863 new_height
= XFLOATINT (height
);
4865 else if (NUMBERP (it
->font_height
))
4867 /* Value is a multiple of the canonical char height. */
4870 f
= FACE_FROM_ID (it
->f
,
4871 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4872 new_height
= (XFLOATINT (it
->font_height
)
4873 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4877 /* Evaluate IT->font_height with `height' bound to the
4878 current specified height to get the new height. */
4879 ptrdiff_t count
= SPECPDL_INDEX ();
4881 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4882 value
= safe_eval (it
->font_height
);
4883 unbind_to (count
, Qnil
);
4885 if (NUMBERP (value
))
4886 new_height
= XFLOATINT (value
);
4890 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4897 /* Handle `(space-width WIDTH)'. */
4899 && EQ (XCAR (spec
), Qspace_width
)
4900 && CONSP (XCDR (spec
)))
4904 if (!FRAME_WINDOW_P (it
->f
))
4907 value
= XCAR (XCDR (spec
));
4908 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4909 it
->space_width
= value
;
4915 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4917 && EQ (XCAR (spec
), Qslice
))
4923 if (!FRAME_WINDOW_P (it
->f
))
4926 if (tem
= XCDR (spec
), CONSP (tem
))
4928 it
->slice
.x
= XCAR (tem
);
4929 if (tem
= XCDR (tem
), CONSP (tem
))
4931 it
->slice
.y
= XCAR (tem
);
4932 if (tem
= XCDR (tem
), CONSP (tem
))
4934 it
->slice
.width
= XCAR (tem
);
4935 if (tem
= XCDR (tem
), CONSP (tem
))
4936 it
->slice
.height
= XCAR (tem
);
4945 /* Handle `(raise FACTOR)'. */
4947 && EQ (XCAR (spec
), Qraise
)
4948 && CONSP (XCDR (spec
)))
4952 if (!FRAME_WINDOW_P (it
->f
))
4955 #ifdef HAVE_WINDOW_SYSTEM
4956 value
= XCAR (XCDR (spec
));
4957 if (NUMBERP (value
))
4959 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4960 it
->voffset
= - (XFLOATINT (value
)
4961 * (normal_char_height (face
->font
, -1)));
4963 #endif /* HAVE_WINDOW_SYSTEM */
4969 /* Don't handle the other kinds of display specifications
4970 inside a string that we got from a `display' property. */
4971 if (it
&& it
->string_from_display_prop_p
)
4974 /* Characters having this form of property are not displayed, so
4975 we have to find the end of the property. */
4978 start_pos
= *position
;
4979 *position
= display_prop_end (it
, object
, start_pos
);
4980 /* If the display property comes from an overlay, don't consider
4981 any potential stop_charpos values before the end of that
4982 overlay. Since display_prop_end will happily find another
4983 'display' property coming from some other overlay or text
4984 property on buffer positions before this overlay's end, we
4985 need to ignore them, or else we risk displaying this
4986 overlay's display string/image twice. */
4987 if (!NILP (overlay
))
4989 ptrdiff_t ovendpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4991 if (ovendpos
> CHARPOS (*position
))
4992 SET_TEXT_POS (*position
, ovendpos
, CHAR_TO_BYTE (ovendpos
));
4997 /* Stop the scan at that end position--we assume that all
4998 text properties change there. */
5000 it
->stop_charpos
= position
->charpos
;
5002 /* Handle `(left-fringe BITMAP [FACE])'
5003 and `(right-fringe BITMAP [FACE])'. */
5005 && (EQ (XCAR (spec
), Qleft_fringe
)
5006 || EQ (XCAR (spec
), Qright_fringe
))
5007 && CONSP (XCDR (spec
)))
5013 if (!FRAME_WINDOW_P (it
->f
))
5014 /* If we return here, POSITION has been advanced
5015 across the text with this property. */
5017 /* Synchronize the bidi iterator with POSITION. This is
5018 needed because we are not going to push the iterator
5019 on behalf of this display property, so there will be
5020 no pop_it call to do this synchronization for us. */
5023 it
->position
= *position
;
5024 iterate_out_of_display_property (it
);
5025 *position
= it
->position
;
5030 else if (!frame_window_p
)
5033 #ifdef HAVE_WINDOW_SYSTEM
5034 value
= XCAR (XCDR (spec
));
5035 if (!SYMBOLP (value
)
5036 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
5037 /* If we return here, POSITION has been advanced
5038 across the text with this property. */
5040 if (it
&& it
->bidi_p
)
5042 it
->position
= *position
;
5043 iterate_out_of_display_property (it
);
5044 *position
= it
->position
;
5051 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
5053 if (CONSP (XCDR (XCDR (spec
))))
5055 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
5056 int face_id2
= lookup_derived_face (it
->f
, face_name
,
5057 FRINGE_FACE_ID
, false);
5062 /* Save current settings of IT so that we can restore them
5063 when we are finished with the glyph property value. */
5064 push_it (it
, position
);
5066 it
->area
= TEXT_AREA
;
5067 it
->what
= IT_IMAGE
;
5068 it
->image_id
= -1; /* no image */
5069 it
->position
= start_pos
;
5070 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5071 it
->method
= GET_FROM_IMAGE
;
5072 it
->from_overlay
= Qnil
;
5073 it
->face_id
= face_id
;
5074 it
->from_disp_prop_p
= true;
5076 /* Say that we haven't consumed the characters with
5077 `display' property yet. The call to pop_it in
5078 set_iterator_to_next will clean this up. */
5079 *position
= start_pos
;
5081 if (EQ (XCAR (spec
), Qleft_fringe
))
5083 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5084 it
->left_user_fringe_face_id
= face_id
;
5088 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5089 it
->right_user_fringe_face_id
= face_id
;
5092 #endif /* HAVE_WINDOW_SYSTEM */
5096 /* Prepare to handle `((margin left-margin) ...)',
5097 `((margin right-margin) ...)' and `((margin nil) ...)'
5098 prefixes for display specifications. */
5099 location
= Qunbound
;
5100 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5104 value
= XCDR (spec
);
5106 value
= XCAR (value
);
5109 if (EQ (XCAR (tem
), Qmargin
)
5110 && (tem
= XCDR (tem
),
5111 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5113 || EQ (tem
, Qleft_margin
)
5114 || EQ (tem
, Qright_margin
))))
5118 if (EQ (location
, Qunbound
))
5124 /* After this point, VALUE is the property after any
5125 margin prefix has been stripped. It must be a string,
5126 an image specification, or `(space ...)'.
5128 LOCATION specifies where to display: `left-margin',
5129 `right-margin' or nil. */
5131 bool valid_p
= (STRINGP (value
)
5132 #ifdef HAVE_WINDOW_SYSTEM
5133 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5134 && valid_image_p (value
))
5135 #endif /* not HAVE_WINDOW_SYSTEM */
5136 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
5138 if (valid_p
&& display_replaced
== 0)
5144 /* Callers need to know whether the display spec is any kind
5145 of `(space ...)' spec that is about to affect text-area
5147 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5152 /* Save current settings of IT so that we can restore them
5153 when we are finished with the glyph property value. */
5154 push_it (it
, position
);
5155 it
->from_overlay
= overlay
;
5156 it
->from_disp_prop_p
= true;
5158 if (NILP (location
))
5159 it
->area
= TEXT_AREA
;
5160 else if (EQ (location
, Qleft_margin
))
5161 it
->area
= LEFT_MARGIN_AREA
;
5163 it
->area
= RIGHT_MARGIN_AREA
;
5165 if (STRINGP (value
))
5168 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5169 it
->current
.overlay_string_index
= -1;
5170 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5171 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5172 it
->method
= GET_FROM_STRING
;
5173 it
->stop_charpos
= 0;
5175 it
->base_level_stop
= 0;
5176 it
->string_from_display_prop_p
= true;
5177 /* Say that we haven't consumed the characters with
5178 `display' property yet. The call to pop_it in
5179 set_iterator_to_next will clean this up. */
5180 if (BUFFERP (object
))
5181 *position
= start_pos
;
5183 /* Force paragraph direction to be that of the parent
5184 object. If the parent object's paragraph direction is
5185 not yet determined, default to L2R. */
5186 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5187 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5189 it
->paragraph_embedding
= L2R
;
5191 /* Set up the bidi iterator for this display string. */
5194 it
->bidi_it
.string
.lstring
= it
->string
;
5195 it
->bidi_it
.string
.s
= NULL
;
5196 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5197 it
->bidi_it
.string
.bufpos
= bufpos
;
5198 it
->bidi_it
.string
.from_disp_str
= true;
5199 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5200 it
->bidi_it
.w
= it
->w
;
5201 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5204 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5206 it
->method
= GET_FROM_STRETCH
;
5208 *position
= it
->position
= start_pos
;
5209 retval
= 1 + (it
->area
== TEXT_AREA
);
5211 #ifdef HAVE_WINDOW_SYSTEM
5214 it
->what
= IT_IMAGE
;
5215 it
->image_id
= lookup_image (it
->f
, value
);
5216 it
->position
= start_pos
;
5217 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5218 it
->method
= GET_FROM_IMAGE
;
5220 /* Say that we haven't consumed the characters with
5221 `display' property yet. The call to pop_it in
5222 set_iterator_to_next will clean this up. */
5223 *position
= start_pos
;
5225 #endif /* HAVE_WINDOW_SYSTEM */
5230 /* Invalid property or property not supported. Restore
5231 POSITION to what it was before. */
5232 *position
= start_pos
;
5236 /* Check if PROP is a display property value whose text should be
5237 treated as intangible. OVERLAY is the overlay from which PROP
5238 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5239 specify the buffer position covered by PROP. */
5242 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5243 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5245 bool frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5246 struct text_pos position
;
5248 SET_TEXT_POS (position
, charpos
, bytepos
);
5249 return (handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5250 &position
, charpos
, frame_window_p
)
5255 /* Return true if PROP is a display sub-property value containing STRING.
5257 Implementation note: this and the following function are really
5258 special cases of handle_display_spec and
5259 handle_single_display_spec, and should ideally use the same code.
5260 Until they do, these two pairs must be consistent and must be
5261 modified in sync. */
5264 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5266 if (EQ (string
, prop
))
5269 /* Skip over `when FORM'. */
5270 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5275 /* Actually, the condition following `when' should be eval'ed,
5276 like handle_single_display_spec does, and we should return
5277 false if it evaluates to nil. However, this function is
5278 called only when the buffer was already displayed and some
5279 glyph in the glyph matrix was found to come from a display
5280 string. Therefore, the condition was already evaluated, and
5281 the result was non-nil, otherwise the display string wouldn't
5282 have been displayed and we would have never been called for
5283 this property. Thus, we can skip the evaluation and assume
5284 its result is non-nil. */
5289 /* Skip over `margin LOCATION'. */
5290 if (EQ (XCAR (prop
), Qmargin
))
5301 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5305 /* Return true if STRING appears in the `display' property PROP. */
5308 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5311 && !EQ (XCAR (prop
), Qwhen
)
5312 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5314 /* A list of sub-properties. */
5315 while (CONSP (prop
))
5317 if (single_display_spec_string_p (XCAR (prop
), string
))
5322 else if (VECTORP (prop
))
5324 /* A vector of sub-properties. */
5326 for (i
= 0; i
< ASIZE (prop
); ++i
)
5327 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5331 return single_display_spec_string_p (prop
, string
);
5336 /* Look for STRING in overlays and text properties in the current
5337 buffer, between character positions FROM and TO (excluding TO).
5338 BACK_P means look back (in this case, TO is supposed to be
5340 Value is the first character position where STRING was found, or
5341 zero if it wasn't found before hitting TO.
5343 This function may only use code that doesn't eval because it is
5344 called asynchronously from note_mouse_highlight. */
5347 string_buffer_position_lim (Lisp_Object string
,
5348 ptrdiff_t from
, ptrdiff_t to
, bool back_p
)
5350 Lisp_Object limit
, prop
, pos
;
5353 pos
= make_number (max (from
, BEGV
));
5355 if (!back_p
) /* looking forward */
5357 limit
= make_number (min (to
, ZV
));
5358 while (!found
&& !EQ (pos
, limit
))
5360 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5361 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5364 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5368 else /* looking back */
5370 limit
= make_number (max (to
, BEGV
));
5371 while (!found
&& !EQ (pos
, limit
))
5373 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5374 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5377 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5382 return found
? XINT (pos
) : 0;
5385 /* Determine which buffer position in current buffer STRING comes from.
5386 AROUND_CHARPOS is an approximate position where it could come from.
5387 Value is the buffer position or 0 if it couldn't be determined.
5389 This function is necessary because we don't record buffer positions
5390 in glyphs generated from strings (to keep struct glyph small).
5391 This function may only use code that doesn't eval because it is
5392 called asynchronously from note_mouse_highlight. */
5395 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5397 const int MAX_DISTANCE
= 1000;
5398 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5399 around_charpos
+ MAX_DISTANCE
,
5403 found
= string_buffer_position_lim (string
, around_charpos
,
5404 around_charpos
- MAX_DISTANCE
, true);
5410 /***********************************************************************
5411 `composition' property
5412 ***********************************************************************/
5414 /* Set up iterator IT from `composition' property at its current
5415 position. Called from handle_stop. */
5417 static enum prop_handled
5418 handle_composition_prop (struct it
*it
)
5420 Lisp_Object prop
, string
;
5421 ptrdiff_t pos
, pos_byte
, start
, end
;
5423 if (STRINGP (it
->string
))
5427 pos
= IT_STRING_CHARPOS (*it
);
5428 pos_byte
= IT_STRING_BYTEPOS (*it
);
5429 string
= it
->string
;
5430 s
= SDATA (string
) + pos_byte
;
5431 it
->c
= STRING_CHAR (s
);
5435 pos
= IT_CHARPOS (*it
);
5436 pos_byte
= IT_BYTEPOS (*it
);
5438 it
->c
= FETCH_CHAR (pos_byte
);
5441 /* If there's a valid composition and point is not inside of the
5442 composition (in the case that the composition is from the current
5443 buffer), draw a glyph composed from the composition components. */
5444 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5445 && composition_valid_p (start
, end
, prop
)
5446 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5449 /* As we can't handle this situation (perhaps font-lock added
5450 a new composition), we just return here hoping that next
5451 redisplay will detect this composition much earlier. */
5452 return HANDLED_NORMALLY
;
5455 if (STRINGP (it
->string
))
5456 pos_byte
= string_char_to_byte (it
->string
, start
);
5458 pos_byte
= CHAR_TO_BYTE (start
);
5460 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5463 if (it
->cmp_it
.id
>= 0)
5466 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5467 it
->cmp_it
.nglyphs
= -1;
5471 return HANDLED_NORMALLY
;
5476 /***********************************************************************
5478 ***********************************************************************/
5480 /* The following structure is used to record overlay strings for
5481 later sorting in load_overlay_strings. */
5483 struct overlay_entry
5485 Lisp_Object overlay
;
5488 bool after_string_p
;
5492 /* Set up iterator IT from overlay strings at its current position.
5493 Called from handle_stop. */
5495 static enum prop_handled
5496 handle_overlay_change (struct it
*it
)
5498 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5499 return HANDLED_RECOMPUTE_PROPS
;
5501 return HANDLED_NORMALLY
;
5505 /* Set up the next overlay string for delivery by IT, if there is an
5506 overlay string to deliver. Called by set_iterator_to_next when the
5507 end of the current overlay string is reached. If there are more
5508 overlay strings to display, IT->string and
5509 IT->current.overlay_string_index are set appropriately here.
5510 Otherwise IT->string is set to nil. */
5513 next_overlay_string (struct it
*it
)
5515 ++it
->current
.overlay_string_index
;
5516 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5518 /* No more overlay strings. Restore IT's settings to what
5519 they were before overlay strings were processed, and
5520 continue to deliver from current_buffer. */
5522 it
->ellipsis_p
= it
->stack
[it
->sp
- 1].display_ellipsis_p
;
5525 || (NILP (it
->string
)
5526 && it
->method
== GET_FROM_BUFFER
5527 && it
->stop_charpos
>= BEGV
5528 && it
->stop_charpos
<= it
->end_charpos
));
5529 it
->current
.overlay_string_index
= -1;
5530 it
->n_overlay_strings
= 0;
5531 /* If there's an empty display string on the stack, pop the
5532 stack, to resync the bidi iterator with IT's position. Such
5533 empty strings are pushed onto the stack in
5534 get_overlay_strings_1. */
5535 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5538 /* Since we've exhausted overlay strings at this buffer
5539 position, set the flag to ignore overlays until we move to
5540 another position. The flag is reset in
5541 next_element_from_buffer. */
5542 it
->ignore_overlay_strings_at_pos_p
= true;
5544 /* If we're at the end of the buffer, record that we have
5545 processed the overlay strings there already, so that
5546 next_element_from_buffer doesn't try it again. */
5547 if (NILP (it
->string
)
5548 && IT_CHARPOS (*it
) >= it
->end_charpos
5549 && it
->overlay_strings_charpos
>= it
->end_charpos
)
5550 it
->overlay_strings_at_end_processed_p
= true;
5551 /* Note: we reset overlay_strings_charpos only here, to make
5552 sure the just-processed overlays were indeed at EOB.
5553 Otherwise, overlays on text with invisible text property,
5554 which are processed with IT's position past the invisible
5555 text, might fool us into thinking the overlays at EOB were
5556 already processed (linum-mode can cause this, for
5558 it
->overlay_strings_charpos
= -1;
5562 /* There are more overlay strings to process. If
5563 IT->current.overlay_string_index has advanced to a position
5564 where we must load IT->overlay_strings with more strings, do
5565 it. We must load at the IT->overlay_strings_charpos where
5566 IT->n_overlay_strings was originally computed; when invisible
5567 text is present, this might not be IT_CHARPOS (Bug#7016). */
5568 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5570 if (it
->current
.overlay_string_index
&& i
== 0)
5571 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5573 /* Initialize IT to deliver display elements from the overlay
5575 it
->string
= it
->overlay_strings
[i
];
5576 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5577 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5578 it
->method
= GET_FROM_STRING
;
5579 it
->stop_charpos
= 0;
5580 it
->end_charpos
= SCHARS (it
->string
);
5581 if (it
->cmp_it
.stop_pos
>= 0)
5582 it
->cmp_it
.stop_pos
= 0;
5584 it
->base_level_stop
= 0;
5586 /* Set up the bidi iterator for this overlay string. */
5589 it
->bidi_it
.string
.lstring
= it
->string
;
5590 it
->bidi_it
.string
.s
= NULL
;
5591 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5592 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5593 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5594 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5595 it
->bidi_it
.w
= it
->w
;
5596 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5604 /* Compare two overlay_entry structures E1 and E2. Used as a
5605 comparison function for qsort in load_overlay_strings. Overlay
5606 strings for the same position are sorted so that
5608 1. All after-strings come in front of before-strings, except
5609 when they come from the same overlay.
5611 2. Within after-strings, strings are sorted so that overlay strings
5612 from overlays with higher priorities come first.
5614 2. Within before-strings, strings are sorted so that overlay
5615 strings from overlays with higher priorities come last.
5617 Value is analogous to strcmp. */
5621 compare_overlay_entries (const void *e1
, const void *e2
)
5623 struct overlay_entry
const *entry1
= e1
;
5624 struct overlay_entry
const *entry2
= e2
;
5627 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5629 /* Let after-strings appear in front of before-strings if
5630 they come from different overlays. */
5631 if (EQ (entry1
->overlay
, entry2
->overlay
))
5632 result
= entry1
->after_string_p
? 1 : -1;
5634 result
= entry1
->after_string_p
? -1 : 1;
5636 else if (entry1
->priority
!= entry2
->priority
)
5638 if (entry1
->after_string_p
)
5639 /* After-strings sorted in order of decreasing priority. */
5640 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5642 /* Before-strings sorted in order of increasing priority. */
5643 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5652 /* Load the vector IT->overlay_strings with overlay strings from IT's
5653 current buffer position, or from CHARPOS if that is > 0. Set
5654 IT->n_overlays to the total number of overlay strings found.
5656 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5657 a time. On entry into load_overlay_strings,
5658 IT->current.overlay_string_index gives the number of overlay
5659 strings that have already been loaded by previous calls to this
5662 IT->add_overlay_start contains an additional overlay start
5663 position to consider for taking overlay strings from, if non-zero.
5664 This position comes into play when the overlay has an `invisible'
5665 property, and both before and after-strings. When we've skipped to
5666 the end of the overlay, because of its `invisible' property, we
5667 nevertheless want its before-string to appear.
5668 IT->add_overlay_start will contain the overlay start position
5671 Overlay strings are sorted so that after-string strings come in
5672 front of before-string strings. Within before and after-strings,
5673 strings are sorted by overlay priority. See also function
5674 compare_overlay_entries. */
5677 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5679 Lisp_Object overlay
, window
, str
, invisible
;
5680 struct Lisp_Overlay
*ov
;
5681 ptrdiff_t start
, end
;
5682 ptrdiff_t n
= 0, i
, j
;
5684 struct overlay_entry entriesbuf
[20];
5685 ptrdiff_t size
= ARRAYELTS (entriesbuf
);
5686 struct overlay_entry
*entries
= entriesbuf
;
5690 charpos
= IT_CHARPOS (*it
);
5692 /* Append the overlay string STRING of overlay OVERLAY to vector
5693 `entries' which has size `size' and currently contains `n'
5694 elements. AFTER_P means STRING is an after-string of
5696 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5699 Lisp_Object priority; \
5703 struct overlay_entry *old = entries; \
5704 SAFE_NALLOCA (entries, 2, size); \
5705 memcpy (entries, old, size * sizeof *entries); \
5709 entries[n].string = (STRING); \
5710 entries[n].overlay = (OVERLAY); \
5711 priority = Foverlay_get ((OVERLAY), Qpriority); \
5712 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5713 entries[n].after_string_p = (AFTER_P); \
5718 /* Process overlay before the overlay center. */
5719 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5721 XSETMISC (overlay
, ov
);
5722 eassert (OVERLAYP (overlay
));
5723 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5724 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5729 /* Skip this overlay if it doesn't start or end at IT's current
5731 if (end
!= charpos
&& start
!= charpos
)
5734 /* Skip this overlay if it doesn't apply to IT->w. */
5735 window
= Foverlay_get (overlay
, Qwindow
);
5736 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5739 /* If the text ``under'' the overlay is invisible, both before-
5740 and after-strings from this overlay are visible; start and
5741 end position are indistinguishable. */
5742 invisible
= Foverlay_get (overlay
, Qinvisible
);
5743 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5745 /* If overlay has a non-empty before-string, record it. */
5746 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5747 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5749 RECORD_OVERLAY_STRING (overlay
, str
, false);
5751 /* If overlay has a non-empty after-string, record it. */
5752 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5753 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5755 RECORD_OVERLAY_STRING (overlay
, str
, true);
5758 /* Process overlays after the overlay center. */
5759 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5761 XSETMISC (overlay
, ov
);
5762 eassert (OVERLAYP (overlay
));
5763 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5764 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5766 if (start
> charpos
)
5769 /* Skip this overlay if it doesn't start or end at IT's current
5771 if (end
!= charpos
&& start
!= charpos
)
5774 /* Skip this overlay if it doesn't apply to IT->w. */
5775 window
= Foverlay_get (overlay
, Qwindow
);
5776 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5779 /* If the text ``under'' the overlay is invisible, it has a zero
5780 dimension, and both before- and after-strings apply. */
5781 invisible
= Foverlay_get (overlay
, Qinvisible
);
5782 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5784 /* If overlay has a non-empty before-string, record it. */
5785 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5786 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5788 RECORD_OVERLAY_STRING (overlay
, str
, false);
5790 /* If overlay has a non-empty after-string, record it. */
5791 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5792 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5794 RECORD_OVERLAY_STRING (overlay
, str
, true);
5797 #undef RECORD_OVERLAY_STRING
5801 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5803 /* Record number of overlay strings, and where we computed it. */
5804 it
->n_overlay_strings
= n
;
5805 it
->overlay_strings_charpos
= charpos
;
5807 /* IT->current.overlay_string_index is the number of overlay strings
5808 that have already been consumed by IT. Copy some of the
5809 remaining overlay strings to IT->overlay_strings. */
5811 j
= it
->current
.overlay_string_index
;
5812 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5814 it
->overlay_strings
[i
] = entries
[j
].string
;
5815 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5823 /* Get the first chunk of overlay strings at IT's current buffer
5824 position, or at CHARPOS if that is > 0. Value is true if at
5825 least one overlay string was found. */
5828 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, bool compute_stop_p
)
5830 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5831 process. This fills IT->overlay_strings with strings, and sets
5832 IT->n_overlay_strings to the total number of strings to process.
5833 IT->pos.overlay_string_index has to be set temporarily to zero
5834 because load_overlay_strings needs this; it must be set to -1
5835 when no overlay strings are found because a zero value would
5836 indicate a position in the first overlay string. */
5837 it
->current
.overlay_string_index
= 0;
5838 load_overlay_strings (it
, charpos
);
5840 /* If we found overlay strings, set up IT to deliver display
5841 elements from the first one. Otherwise set up IT to deliver
5842 from current_buffer. */
5843 if (it
->n_overlay_strings
)
5845 /* Make sure we know settings in current_buffer, so that we can
5846 restore meaningful values when we're done with the overlay
5849 compute_stop_pos (it
);
5850 eassert (it
->face_id
>= 0);
5852 /* Save IT's settings. They are restored after all overlay
5853 strings have been processed. */
5854 eassert (!compute_stop_p
|| it
->sp
== 0);
5856 /* When called from handle_stop, there might be an empty display
5857 string loaded. In that case, don't bother saving it. But
5858 don't use this optimization with the bidi iterator, since we
5859 need the corresponding pop_it call to resync the bidi
5860 iterator's position with IT's position, after we are done
5861 with the overlay strings. (The corresponding call to pop_it
5862 in case of an empty display string is in
5863 next_overlay_string.) */
5865 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5868 /* Set up IT to deliver display elements from the first overlay
5870 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5871 it
->string
= it
->overlay_strings
[0];
5872 it
->from_overlay
= Qnil
;
5873 it
->stop_charpos
= 0;
5874 eassert (STRINGP (it
->string
));
5875 it
->end_charpos
= SCHARS (it
->string
);
5877 it
->base_level_stop
= 0;
5878 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5879 it
->method
= GET_FROM_STRING
;
5880 it
->from_disp_prop_p
= 0;
5882 /* Force paragraph direction to be that of the parent
5884 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5885 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5887 it
->paragraph_embedding
= L2R
;
5889 /* Set up the bidi iterator for this overlay string. */
5892 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5894 it
->bidi_it
.string
.lstring
= it
->string
;
5895 it
->bidi_it
.string
.s
= NULL
;
5896 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5897 it
->bidi_it
.string
.bufpos
= pos
;
5898 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5899 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5900 it
->bidi_it
.w
= it
->w
;
5901 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5906 it
->current
.overlay_string_index
= -1;
5911 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5914 it
->method
= GET_FROM_BUFFER
;
5916 get_overlay_strings_1 (it
, charpos
, true);
5920 /* Value is true if we found at least one overlay string. */
5921 return STRINGP (it
->string
);
5926 /***********************************************************************
5927 Saving and restoring state
5928 ***********************************************************************/
5930 /* Save current settings of IT on IT->stack. Called, for example,
5931 before setting up IT for an overlay string, to be able to restore
5932 IT's settings to what they were after the overlay string has been
5933 processed. If POSITION is non-NULL, it is the position to save on
5934 the stack instead of IT->position. */
5937 push_it (struct it
*it
, struct text_pos
*position
)
5939 struct iterator_stack_entry
*p
;
5941 eassert (it
->sp
< IT_STACK_SIZE
);
5942 p
= it
->stack
+ it
->sp
;
5944 p
->stop_charpos
= it
->stop_charpos
;
5945 p
->prev_stop
= it
->prev_stop
;
5946 p
->base_level_stop
= it
->base_level_stop
;
5947 p
->cmp_it
= it
->cmp_it
;
5948 eassert (it
->face_id
>= 0);
5949 p
->face_id
= it
->face_id
;
5950 p
->string
= it
->string
;
5951 p
->method
= it
->method
;
5952 p
->from_overlay
= it
->from_overlay
;
5955 case GET_FROM_IMAGE
:
5956 p
->u
.image
.object
= it
->object
;
5957 p
->u
.image
.image_id
= it
->image_id
;
5958 p
->u
.image
.slice
= it
->slice
;
5960 case GET_FROM_STRETCH
:
5961 p
->u
.stretch
.object
= it
->object
;
5963 case GET_FROM_BUFFER
:
5964 case GET_FROM_DISPLAY_VECTOR
:
5965 case GET_FROM_STRING
:
5966 case GET_FROM_C_STRING
:
5971 p
->position
= position
? *position
: it
->position
;
5972 p
->current
= it
->current
;
5973 p
->end_charpos
= it
->end_charpos
;
5974 p
->string_nchars
= it
->string_nchars
;
5976 p
->multibyte_p
= it
->multibyte_p
;
5977 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5978 p
->space_width
= it
->space_width
;
5979 p
->font_height
= it
->font_height
;
5980 p
->voffset
= it
->voffset
;
5981 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5982 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5983 p
->display_ellipsis_p
= false;
5984 p
->line_wrap
= it
->line_wrap
;
5985 p
->bidi_p
= it
->bidi_p
;
5986 p
->paragraph_embedding
= it
->paragraph_embedding
;
5987 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5990 /* Save the state of the bidi iterator as well. */
5992 bidi_push_it (&it
->bidi_it
);
5996 iterate_out_of_display_property (struct it
*it
)
5998 bool buffer_p
= !STRINGP (it
->string
);
5999 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
6000 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
6002 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
6004 /* Maybe initialize paragraph direction. If we are at the beginning
6005 of a new paragraph, next_element_from_buffer may not have a
6006 chance to do that. */
6007 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
6008 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
6009 /* prev_stop can be zero, so check against BEGV as well. */
6010 while (it
->bidi_it
.charpos
>= bob
6011 && it
->prev_stop
<= it
->bidi_it
.charpos
6012 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
6013 && it
->bidi_it
.charpos
< eob
)
6014 bidi_move_to_visually_next (&it
->bidi_it
);
6015 /* Record the stop_pos we just crossed, for when we cross it
6017 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
6018 it
->prev_stop
= CHARPOS (it
->position
);
6019 /* If we ended up not where pop_it put us, resync IT's
6020 positional members with the bidi iterator. */
6021 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
6022 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
6024 it
->current
.pos
= it
->position
;
6026 it
->current
.string_pos
= it
->position
;
6029 /* Restore IT's settings from IT->stack. Called, for example, when no
6030 more overlay strings must be processed, and we return to delivering
6031 display elements from a buffer, or when the end of a string from a
6032 `display' property is reached and we return to delivering display
6033 elements from an overlay string, or from a buffer. */
6036 pop_it (struct it
*it
)
6038 struct iterator_stack_entry
*p
;
6039 bool from_display_prop
= it
->from_disp_prop_p
;
6040 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
6042 eassert (it
->sp
> 0);
6044 p
= it
->stack
+ it
->sp
;
6045 it
->stop_charpos
= p
->stop_charpos
;
6046 it
->prev_stop
= p
->prev_stop
;
6047 it
->base_level_stop
= p
->base_level_stop
;
6048 it
->cmp_it
= p
->cmp_it
;
6049 it
->face_id
= p
->face_id
;
6050 it
->current
= p
->current
;
6051 it
->position
= p
->position
;
6052 it
->string
= p
->string
;
6053 it
->from_overlay
= p
->from_overlay
;
6054 if (NILP (it
->string
))
6055 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
6056 it
->method
= p
->method
;
6059 case GET_FROM_IMAGE
:
6060 it
->image_id
= p
->u
.image
.image_id
;
6061 it
->object
= p
->u
.image
.object
;
6062 it
->slice
= p
->u
.image
.slice
;
6064 case GET_FROM_STRETCH
:
6065 it
->object
= p
->u
.stretch
.object
;
6067 case GET_FROM_BUFFER
:
6068 it
->object
= it
->w
->contents
;
6070 case GET_FROM_STRING
:
6072 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6074 /* Restore the face_box_p flag, since it could have been
6075 overwritten by the face of the object that we just finished
6078 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6079 it
->object
= it
->string
;
6082 case GET_FROM_DISPLAY_VECTOR
:
6084 it
->method
= GET_FROM_C_STRING
;
6085 else if (STRINGP (it
->string
))
6086 it
->method
= GET_FROM_STRING
;
6089 it
->method
= GET_FROM_BUFFER
;
6090 it
->object
= it
->w
->contents
;
6093 case GET_FROM_C_STRING
:
6098 it
->end_charpos
= p
->end_charpos
;
6099 it
->string_nchars
= p
->string_nchars
;
6101 it
->multibyte_p
= p
->multibyte_p
;
6102 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6103 it
->space_width
= p
->space_width
;
6104 it
->font_height
= p
->font_height
;
6105 it
->voffset
= p
->voffset
;
6106 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6107 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6108 it
->line_wrap
= p
->line_wrap
;
6109 it
->bidi_p
= p
->bidi_p
;
6110 it
->paragraph_embedding
= p
->paragraph_embedding
;
6111 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6114 bidi_pop_it (&it
->bidi_it
);
6115 /* Bidi-iterate until we get out of the portion of text, if any,
6116 covered by a `display' text property or by an overlay with
6117 `display' property. (We cannot just jump there, because the
6118 internal coherency of the bidi iterator state can not be
6119 preserved across such jumps.) We also must determine the
6120 paragraph base direction if the overlay we just processed is
6121 at the beginning of a new paragraph. */
6122 if (from_display_prop
6123 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6124 iterate_out_of_display_property (it
);
6126 eassert ((BUFFERP (it
->object
)
6127 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6128 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6129 || (STRINGP (it
->object
)
6130 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6131 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6132 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6134 /* If we move the iterator over text covered by a display property
6135 to a new buffer position, any info about previously seen overlays
6136 is no longer valid. */
6137 if (from_display_prop
&& it
->sp
== 0 && CHARPOS (it
->position
) != prev_pos
)
6138 it
->ignore_overlay_strings_at_pos_p
= false;
6143 /***********************************************************************
6145 ***********************************************************************/
6147 /* Set IT's current position to the previous line start. */
6150 back_to_previous_line_start (struct it
*it
)
6152 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6155 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6159 /* Move IT to the next line start.
6161 Value is true if a newline was found. Set *SKIPPED_P to true if
6162 we skipped over part of the text (as opposed to moving the iterator
6163 continuously over the text). Otherwise, don't change the value
6166 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6167 iterator on the newline, if it was found.
6169 Newlines may come from buffer text, overlay strings, or strings
6170 displayed via the `display' property. That's the reason we can't
6171 simply use find_newline_no_quit.
6173 Note that this function may not skip over invisible text that is so
6174 because of text properties and immediately follows a newline. If
6175 it would, function reseat_at_next_visible_line_start, when called
6176 from set_iterator_to_next, would effectively make invisible
6177 characters following a newline part of the wrong glyph row, which
6178 leads to wrong cursor motion. */
6181 forward_to_next_line_start (struct it
*it
, bool *skipped_p
,
6182 struct bidi_it
*bidi_it_prev
)
6184 ptrdiff_t old_selective
;
6185 bool newline_found_p
= false;
6187 const int MAX_NEWLINE_DISTANCE
= 500;
6189 /* If already on a newline, just consume it to avoid unintended
6190 skipping over invisible text below. */
6191 if (it
->what
== IT_CHARACTER
6193 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6195 if (it
->bidi_p
&& bidi_it_prev
)
6196 *bidi_it_prev
= it
->bidi_it
;
6197 set_iterator_to_next (it
, false);
6202 /* Don't handle selective display in the following. It's (a)
6203 unnecessary because it's done by the caller, and (b) leads to an
6204 infinite recursion because next_element_from_ellipsis indirectly
6205 calls this function. */
6206 old_selective
= it
->selective
;
6209 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6210 from buffer text. */
6212 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6213 n
+= !STRINGP (it
->string
))
6215 if (!get_next_display_element (it
))
6217 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6218 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6219 *bidi_it_prev
= it
->bidi_it
;
6220 set_iterator_to_next (it
, false);
6223 /* If we didn't find a newline near enough, see if we can use a
6225 if (!newline_found_p
)
6227 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6228 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6232 eassert (!STRINGP (it
->string
));
6234 /* If there isn't any `display' property in sight, and no
6235 overlays, we can just use the position of the newline in
6237 if (it
->stop_charpos
>= limit
6238 || ((pos
= Fnext_single_property_change (make_number (start
),
6240 make_number (limit
)),
6242 && next_overlay_change (start
) == ZV
))
6246 IT_CHARPOS (*it
) = limit
;
6247 IT_BYTEPOS (*it
) = bytepos
;
6251 struct bidi_it bprev
;
6253 /* Help bidi.c avoid expensive searches for display
6254 properties and overlays, by telling it that there are
6255 none up to `limit'. */
6256 if (it
->bidi_it
.disp_pos
< limit
)
6258 it
->bidi_it
.disp_pos
= limit
;
6259 it
->bidi_it
.disp_prop
= 0;
6262 bprev
= it
->bidi_it
;
6263 bidi_move_to_visually_next (&it
->bidi_it
);
6264 } while (it
->bidi_it
.charpos
!= limit
);
6265 IT_CHARPOS (*it
) = limit
;
6266 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6268 *bidi_it_prev
= bprev
;
6270 *skipped_p
= newline_found_p
= true;
6274 while (get_next_display_element (it
)
6275 && !newline_found_p
)
6277 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6278 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6279 *bidi_it_prev
= it
->bidi_it
;
6280 set_iterator_to_next (it
, false);
6285 it
->selective
= old_selective
;
6286 return newline_found_p
;
6290 /* Set IT's current position to the previous visible line start. Skip
6291 invisible text that is so either due to text properties or due to
6292 selective display. Caution: this does not change IT->current_x and
6296 back_to_previous_visible_line_start (struct it
*it
)
6298 while (IT_CHARPOS (*it
) > BEGV
)
6300 back_to_previous_line_start (it
);
6302 if (IT_CHARPOS (*it
) <= BEGV
)
6305 /* If selective > 0, then lines indented more than its value are
6307 if (it
->selective
> 0
6308 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6312 /* Check the newline before point for invisibility. */
6315 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6316 Qinvisible
, it
->window
);
6317 if (TEXT_PROP_MEANS_INVISIBLE (prop
) != 0)
6321 if (IT_CHARPOS (*it
) <= BEGV
)
6326 void *it2data
= NULL
;
6329 Lisp_Object val
, overlay
;
6331 SAVE_IT (it2
, *it
, it2data
);
6333 /* If newline is part of a composition, continue from start of composition */
6334 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6335 && beg
< IT_CHARPOS (*it
))
6338 /* If newline is replaced by a display property, find start of overlay
6339 or interval and continue search from that point. */
6340 pos
= --IT_CHARPOS (it2
);
6343 bidi_unshelve_cache (NULL
, false);
6344 it2
.string_from_display_prop_p
= false;
6345 it2
.from_disp_prop_p
= false;
6346 if (handle_display_prop (&it2
) == HANDLED_RETURN
6347 && !NILP (val
= get_char_property_and_overlay
6348 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6349 && (OVERLAYP (overlay
)
6350 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6351 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6353 RESTORE_IT (it
, it
, it2data
);
6357 /* Newline is not replaced by anything -- so we are done. */
6358 RESTORE_IT (it
, it
, it2data
);
6364 IT_CHARPOS (*it
) = beg
;
6365 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6369 it
->continuation_lines_width
= 0;
6371 eassert (IT_CHARPOS (*it
) >= BEGV
);
6372 eassert (IT_CHARPOS (*it
) == BEGV
6373 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6378 /* Reseat iterator IT at the previous visible line start. Skip
6379 invisible text that is so either due to text properties or due to
6380 selective display. At the end, update IT's overlay information,
6381 face information etc. */
6384 reseat_at_previous_visible_line_start (struct it
*it
)
6386 back_to_previous_visible_line_start (it
);
6387 reseat (it
, it
->current
.pos
, true);
6392 /* Reseat iterator IT on the next visible line start in the current
6393 buffer. ON_NEWLINE_P means position IT on the newline
6394 preceding the line start. Skip over invisible text that is so
6395 because of selective display. Compute faces, overlays etc at the
6396 new position. Note that this function does not skip over text that
6397 is invisible because of text properties. */
6400 reseat_at_next_visible_line_start (struct it
*it
, bool on_newline_p
)
6402 bool skipped_p
= false;
6403 struct bidi_it bidi_it_prev
;
6404 bool newline_found_p
6405 = forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6407 /* Skip over lines that are invisible because they are indented
6408 more than the value of IT->selective. */
6409 if (it
->selective
> 0)
6410 while (IT_CHARPOS (*it
) < ZV
6411 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6414 eassert (IT_BYTEPOS (*it
) == BEGV
6415 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6417 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6420 /* Position on the newline if that's what's requested. */
6421 if (on_newline_p
&& newline_found_p
)
6423 if (STRINGP (it
->string
))
6425 if (IT_STRING_CHARPOS (*it
) > 0)
6429 --IT_STRING_CHARPOS (*it
);
6430 --IT_STRING_BYTEPOS (*it
);
6434 /* We need to restore the bidi iterator to the state
6435 it had on the newline, and resync the IT's
6436 position with that. */
6437 it
->bidi_it
= bidi_it_prev
;
6438 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6439 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6443 else if (IT_CHARPOS (*it
) > BEGV
)
6452 /* We need to restore the bidi iterator to the state it
6453 had on the newline and resync IT with that. */
6454 it
->bidi_it
= bidi_it_prev
;
6455 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6456 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6458 reseat (it
, it
->current
.pos
, false);
6462 reseat (it
, it
->current
.pos
, false);
6469 /***********************************************************************
6470 Changing an iterator's position
6471 ***********************************************************************/
6473 /* Change IT's current position to POS in current_buffer.
6474 If FORCE_P, always check for text properties at the new position.
6475 Otherwise, text properties are only looked up if POS >=
6476 IT->check_charpos of a property. */
6479 reseat (struct it
*it
, struct text_pos pos
, bool force_p
)
6481 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6483 reseat_1 (it
, pos
, false);
6485 /* Determine where to check text properties. Avoid doing it
6486 where possible because text property lookup is very expensive. */
6488 || CHARPOS (pos
) > it
->stop_charpos
6489 || CHARPOS (pos
) < original_pos
)
6493 /* For bidi iteration, we need to prime prev_stop and
6494 base_level_stop with our best estimations. */
6495 /* Implementation note: Of course, POS is not necessarily a
6496 stop position, so assigning prev_pos to it is a lie; we
6497 should have called compute_stop_backwards. However, if
6498 the current buffer does not include any R2L characters,
6499 that call would be a waste of cycles, because the
6500 iterator will never move back, and thus never cross this
6501 "fake" stop position. So we delay that backward search
6502 until the time we really need it, in next_element_from_buffer. */
6503 if (CHARPOS (pos
) != it
->prev_stop
)
6504 it
->prev_stop
= CHARPOS (pos
);
6505 if (CHARPOS (pos
) < it
->base_level_stop
)
6506 it
->base_level_stop
= 0; /* meaning it's unknown */
6512 it
->prev_stop
= it
->base_level_stop
= 0;
6521 /* Change IT's buffer position to POS. SET_STOP_P means set
6522 IT->stop_pos to POS, also. */
6525 reseat_1 (struct it
*it
, struct text_pos pos
, bool set_stop_p
)
6527 /* Don't call this function when scanning a C string. */
6528 eassert (it
->s
== NULL
);
6530 /* POS must be a reasonable value. */
6531 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6533 it
->current
.pos
= it
->position
= pos
;
6534 it
->end_charpos
= ZV
;
6536 it
->current
.dpvec_index
= -1;
6537 it
->current
.overlay_string_index
= -1;
6538 IT_STRING_CHARPOS (*it
) = -1;
6539 IT_STRING_BYTEPOS (*it
) = -1;
6541 it
->method
= GET_FROM_BUFFER
;
6542 it
->object
= it
->w
->contents
;
6543 it
->area
= TEXT_AREA
;
6544 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6546 it
->string_from_display_prop_p
= false;
6547 it
->string_from_prefix_prop_p
= false;
6549 it
->from_disp_prop_p
= false;
6550 it
->face_before_selective_p
= false;
6553 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6555 bidi_unshelve_cache (NULL
, false);
6556 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6557 it
->bidi_it
.string
.s
= NULL
;
6558 it
->bidi_it
.string
.lstring
= Qnil
;
6559 it
->bidi_it
.string
.bufpos
= 0;
6560 it
->bidi_it
.string
.from_disp_str
= false;
6561 it
->bidi_it
.string
.unibyte
= false;
6562 it
->bidi_it
.w
= it
->w
;
6567 it
->stop_charpos
= CHARPOS (pos
);
6568 it
->base_level_stop
= CHARPOS (pos
);
6570 /* This make the information stored in it->cmp_it invalidate. */
6575 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6576 If S is non-null, it is a C string to iterate over. Otherwise,
6577 STRING gives a Lisp string to iterate over.
6579 If PRECISION > 0, don't return more then PRECISION number of
6580 characters from the string.
6582 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6583 characters have been returned. FIELD_WIDTH < 0 means an infinite
6586 MULTIBYTE = 0 means disable processing of multibyte characters,
6587 MULTIBYTE > 0 means enable it,
6588 MULTIBYTE < 0 means use IT->multibyte_p.
6590 IT must be initialized via a prior call to init_iterator before
6591 calling this function. */
6594 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6595 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6598 /* No text property checks performed by default, but see below. */
6599 it
->stop_charpos
= -1;
6601 /* Set iterator position and end position. */
6602 memset (&it
->current
, 0, sizeof it
->current
);
6603 it
->current
.overlay_string_index
= -1;
6604 it
->current
.dpvec_index
= -1;
6605 eassert (charpos
>= 0);
6607 /* If STRING is specified, use its multibyteness, otherwise use the
6608 setting of MULTIBYTE, if specified. */
6610 it
->multibyte_p
= multibyte
> 0;
6612 /* Bidirectional reordering of strings is controlled by the default
6613 value of bidi-display-reordering. Don't try to reorder while
6614 loading loadup.el, as the necessary character property tables are
6615 not yet available. */
6618 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6622 eassert (STRINGP (string
));
6623 it
->string
= string
;
6625 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6626 it
->method
= GET_FROM_STRING
;
6627 it
->current
.string_pos
= string_pos (charpos
, string
);
6631 it
->bidi_it
.string
.lstring
= string
;
6632 it
->bidi_it
.string
.s
= NULL
;
6633 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6634 it
->bidi_it
.string
.bufpos
= 0;
6635 it
->bidi_it
.string
.from_disp_str
= false;
6636 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6637 it
->bidi_it
.w
= it
->w
;
6638 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6639 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6644 it
->s
= (const unsigned char *) s
;
6647 /* Note that we use IT->current.pos, not it->current.string_pos,
6648 for displaying C strings. */
6649 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6650 if (it
->multibyte_p
)
6652 it
->current
.pos
= c_string_pos (charpos
, s
, true);
6653 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, true);
6657 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6658 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6663 it
->bidi_it
.string
.lstring
= Qnil
;
6664 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6665 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6666 it
->bidi_it
.string
.bufpos
= 0;
6667 it
->bidi_it
.string
.from_disp_str
= false;
6668 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6669 it
->bidi_it
.w
= it
->w
;
6670 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6673 it
->method
= GET_FROM_C_STRING
;
6676 /* PRECISION > 0 means don't return more than PRECISION characters
6678 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6680 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6682 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6685 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6686 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6687 FIELD_WIDTH < 0 means infinite field width. This is useful for
6688 padding with `-' at the end of a mode line. */
6689 if (field_width
< 0)
6690 field_width
= INFINITY
;
6691 /* Implementation note: We deliberately don't enlarge
6692 it->bidi_it.string.schars here to fit it->end_charpos, because
6693 the bidi iterator cannot produce characters out of thin air. */
6694 if (field_width
> it
->end_charpos
- charpos
)
6695 it
->end_charpos
= charpos
+ field_width
;
6697 /* Use the standard display table for displaying strings. */
6698 if (DISP_TABLE_P (Vstandard_display_table
))
6699 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6701 it
->stop_charpos
= charpos
;
6702 it
->prev_stop
= charpos
;
6703 it
->base_level_stop
= 0;
6706 it
->bidi_it
.first_elt
= true;
6707 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6708 it
->bidi_it
.disp_pos
= -1;
6710 if (s
== NULL
&& it
->multibyte_p
)
6712 ptrdiff_t endpos
= SCHARS (it
->string
);
6713 if (endpos
> it
->end_charpos
)
6714 endpos
= it
->end_charpos
;
6715 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6723 /***********************************************************************
6725 ***********************************************************************/
6727 /* Map enum it_method value to corresponding next_element_from_* function. */
6729 typedef bool (*next_element_function
) (struct it
*);
6731 static next_element_function
const get_next_element
[NUM_IT_METHODS
] =
6733 next_element_from_buffer
,
6734 next_element_from_display_vector
,
6735 next_element_from_string
,
6736 next_element_from_c_string
,
6737 next_element_from_image
,
6738 next_element_from_stretch
6741 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6744 /* Return true iff a character at CHARPOS (and BYTEPOS) is composed
6745 (possibly with the following characters). */
6747 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6748 ((IT)->cmp_it.id >= 0 \
6749 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6750 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6751 END_CHARPOS, (IT)->w, \
6752 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6756 /* Lookup the char-table Vglyphless_char_display for character C (-1
6757 if we want information for no-font case), and return the display
6758 method symbol. By side-effect, update it->what and
6759 it->glyphless_method. This function is called from
6760 get_next_display_element for each character element, and from
6761 x_produce_glyphs when no suitable font was found. */
6764 lookup_glyphless_char_display (int c
, struct it
*it
)
6766 Lisp_Object glyphless_method
= Qnil
;
6768 if (CHAR_TABLE_P (Vglyphless_char_display
)
6769 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6773 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6774 if (CONSP (glyphless_method
))
6775 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6776 ? XCAR (glyphless_method
)
6777 : XCDR (glyphless_method
);
6780 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6784 if (NILP (glyphless_method
))
6787 /* The default is to display the character by a proper font. */
6789 /* The default for the no-font case is to display an empty box. */
6790 glyphless_method
= Qempty_box
;
6792 if (EQ (glyphless_method
, Qzero_width
))
6795 return glyphless_method
;
6796 /* This method can't be used for the no-font case. */
6797 glyphless_method
= Qempty_box
;
6799 if (EQ (glyphless_method
, Qthin_space
))
6800 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6801 else if (EQ (glyphless_method
, Qempty_box
))
6802 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6803 else if (EQ (glyphless_method
, Qhex_code
))
6804 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6805 else if (STRINGP (glyphless_method
))
6806 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6809 /* Invalid value. We use the default method. */
6810 glyphless_method
= Qnil
;
6813 it
->what
= IT_GLYPHLESS
;
6814 return glyphless_method
;
6817 /* Merge escape glyph face and cache the result. */
6819 static struct frame
*last_escape_glyph_frame
= NULL
;
6820 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6821 static int last_escape_glyph_merged_face_id
= 0;
6824 merge_escape_glyph_face (struct it
*it
)
6828 if (it
->f
== last_escape_glyph_frame
6829 && it
->face_id
== last_escape_glyph_face_id
)
6830 face_id
= last_escape_glyph_merged_face_id
;
6833 /* Merge the `escape-glyph' face into the current face. */
6834 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6835 last_escape_glyph_frame
= it
->f
;
6836 last_escape_glyph_face_id
= it
->face_id
;
6837 last_escape_glyph_merged_face_id
= face_id
;
6842 /* Likewise for glyphless glyph face. */
6844 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6845 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6846 static int last_glyphless_glyph_merged_face_id
= 0;
6849 merge_glyphless_glyph_face (struct it
*it
)
6853 if (it
->f
== last_glyphless_glyph_frame
6854 && it
->face_id
== last_glyphless_glyph_face_id
)
6855 face_id
= last_glyphless_glyph_merged_face_id
;
6858 /* Merge the `glyphless-char' face into the current face. */
6859 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6860 last_glyphless_glyph_frame
= it
->f
;
6861 last_glyphless_glyph_face_id
= it
->face_id
;
6862 last_glyphless_glyph_merged_face_id
= face_id
;
6867 /* Forget the `escape-glyph' and `glyphless-char' faces. This should
6868 be called before redisplaying windows, and when the frame's face
6871 forget_escape_and_glyphless_faces (void)
6873 last_escape_glyph_frame
= NULL
;
6874 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6875 last_glyphless_glyph_frame
= NULL
;
6876 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6879 /* Load IT's display element fields with information about the next
6880 display element from the current position of IT. Value is false if
6881 end of buffer (or C string) is reached. */
6884 get_next_display_element (struct it
*it
)
6886 /* True means that we found a display element. False means that
6887 we hit the end of what we iterate over. Performance note: the
6888 function pointer `method' used here turns out to be faster than
6889 using a sequence of if-statements. */
6893 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6895 if (it
->what
== IT_CHARACTER
)
6897 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6898 and only if (a) the resolved directionality of that character
6900 /* FIXME: Do we need an exception for characters from display
6902 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
6903 && !inhibit_bidi_mirroring
)
6904 it
->c
= bidi_mirror_char (it
->c
);
6905 /* Map via display table or translate control characters.
6906 IT->c, IT->len etc. have been set to the next character by
6907 the function call above. If we have a display table, and it
6908 contains an entry for IT->c, translate it. Don't do this if
6909 IT->c itself comes from a display table, otherwise we could
6910 end up in an infinite recursion. (An alternative could be to
6911 count the recursion depth of this function and signal an
6912 error when a certain maximum depth is reached.) Is it worth
6914 if (success_p
&& it
->dpvec
== NULL
)
6917 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6918 bool nonascii_space_p
= false;
6919 bool nonascii_hyphen_p
= false;
6920 int c
= it
->c
; /* This is the character to display. */
6922 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6924 eassert (SINGLE_BYTE_CHAR_P (c
));
6925 if (unibyte_display_via_language_environment
)
6927 c
= DECODE_CHAR (unibyte
, c
);
6929 c
= BYTE8_TO_CHAR (it
->c
);
6932 c
= BYTE8_TO_CHAR (it
->c
);
6936 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6939 struct Lisp_Vector
*v
= XVECTOR (dv
);
6941 /* Return the first character from the display table
6942 entry, if not empty. If empty, don't display the
6943 current character. */
6946 it
->dpvec_char_len
= it
->len
;
6947 it
->dpvec
= v
->contents
;
6948 it
->dpend
= v
->contents
+ v
->header
.size
;
6949 it
->current
.dpvec_index
= 0;
6950 it
->dpvec_face_id
= -1;
6951 it
->saved_face_id
= it
->face_id
;
6952 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6953 it
->ellipsis_p
= false;
6957 set_iterator_to_next (it
, false);
6962 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6964 if (it
->what
== IT_GLYPHLESS
)
6966 /* Don't display this character. */
6967 set_iterator_to_next (it
, false);
6971 /* If `nobreak-char-display' is non-nil, we display
6972 non-ASCII spaces and hyphens specially. */
6973 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6975 if (c
== NO_BREAK_SPACE
)
6976 nonascii_space_p
= true;
6977 else if (c
== SOFT_HYPHEN
|| c
== HYPHEN
6978 || c
== NON_BREAKING_HYPHEN
)
6979 nonascii_hyphen_p
= true;
6982 /* Translate control characters into `\003' or `^C' form.
6983 Control characters coming from a display table entry are
6984 currently not translated because we use IT->dpvec to hold
6985 the translation. This could easily be changed but I
6986 don't believe that it is worth doing.
6988 The characters handled by `nobreak-char-display' must be
6991 Non-printable characters and raw-byte characters are also
6992 translated to octal form. */
6993 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
6994 ? (it
->area
!= TEXT_AREA
6995 /* In mode line, treat \n, \t like other crl chars. */
6998 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6999 || (c
!= '\n' && c
!= '\t'))
7001 || nonascii_hyphen_p
7003 || ! CHAR_PRINTABLE_P (c
))))
7005 /* C is a control character, non-ASCII space/hyphen,
7006 raw-byte, or a non-printable character which must be
7007 displayed either as '\003' or as `^C' where the '\\'
7008 and '^' can be defined in the display table. Fill
7009 IT->ctl_chars with glyphs for what we have to
7010 display. Then, set IT->dpvec to these glyphs. */
7017 /* Handle control characters with ^. */
7019 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
7023 g
= '^'; /* default glyph for Control */
7024 /* Set IT->ctl_chars[0] to the glyph for `^'. */
7026 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7028 g
= GLYPH_CODE_CHAR (gc
);
7029 lface_id
= GLYPH_CODE_FACE (gc
);
7033 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7034 : merge_escape_glyph_face (it
));
7036 XSETINT (it
->ctl_chars
[0], g
);
7037 XSETINT (it
->ctl_chars
[1], c
^ 0100);
7039 goto display_control
;
7042 /* Handle non-ascii space in the mode where it only gets
7045 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
7047 /* Merge `nobreak-space' into the current face. */
7048 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
7050 XSETINT (it
->ctl_chars
[0], ' ');
7052 goto display_control
;
7055 /* Handle sequences that start with the "escape glyph". */
7057 /* the default escape glyph is \. */
7058 escape_glyph
= '\\';
7061 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7063 escape_glyph
= GLYPH_CODE_CHAR (gc
);
7064 lface_id
= GLYPH_CODE_FACE (gc
);
7068 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7069 : merge_escape_glyph_face (it
));
7071 /* Draw non-ASCII hyphen with just highlighting: */
7073 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
7075 XSETINT (it
->ctl_chars
[0], '-');
7077 goto display_control
;
7080 /* Draw non-ASCII space/hyphen with escape glyph: */
7082 if (nonascii_space_p
|| nonascii_hyphen_p
)
7084 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7085 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7087 goto display_control
;
7094 if (CHAR_BYTE8_P (c
))
7095 /* Display \200 instead of \17777600. */
7096 c
= CHAR_TO_BYTE8 (c
);
7097 len
= sprintf (str
, "%03o", c
+ 0u);
7099 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7100 for (i
= 0; i
< len
; i
++)
7101 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7106 /* Set up IT->dpvec and return first character from it. */
7107 it
->dpvec_char_len
= it
->len
;
7108 it
->dpvec
= it
->ctl_chars
;
7109 it
->dpend
= it
->dpvec
+ ctl_len
;
7110 it
->current
.dpvec_index
= 0;
7111 it
->dpvec_face_id
= face_id
;
7112 it
->saved_face_id
= it
->face_id
;
7113 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7114 it
->ellipsis_p
= false;
7117 it
->char_to_display
= c
;
7121 it
->char_to_display
= it
->c
;
7125 #ifdef HAVE_WINDOW_SYSTEM
7126 /* Adjust face id for a multibyte character. There are no multibyte
7127 character in unibyte text. */
7128 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7131 && FRAME_WINDOW_P (it
->f
))
7133 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7135 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7137 /* Automatic composition with glyph-string. */
7138 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7140 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7144 ptrdiff_t pos
= (it
->s
? -1
7145 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7146 : IT_CHARPOS (*it
));
7149 if (it
->what
== IT_CHARACTER
)
7150 c
= it
->char_to_display
;
7153 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7157 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7158 /* TAB in a composition means display glyphs with
7159 padding space on the left or right. */
7160 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7163 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7166 #endif /* HAVE_WINDOW_SYSTEM */
7169 /* Is this character the last one of a run of characters with
7170 box? If yes, set IT->end_of_box_run_p to true. */
7174 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7176 int face_id
= underlying_face_id (it
);
7177 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7181 if (face
->box
== FACE_NO_BOX
)
7183 /* If the box comes from face properties in a
7184 display string, check faces in that string. */
7185 int string_face_id
= face_after_it_pos (it
);
7186 it
->end_of_box_run_p
7187 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7190 /* Otherwise, the box comes from the underlying face.
7191 If this is the last string character displayed, check
7192 the next buffer location. */
7193 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7194 /* n_overlay_strings is unreliable unless
7195 overlay_string_index is non-negative. */
7196 && ((it
->current
.overlay_string_index
>= 0
7197 && (it
->current
.overlay_string_index
7198 == it
->n_overlay_strings
- 1))
7199 /* A string from display property. */
7200 || it
->from_disp_prop_p
))
7204 struct text_pos pos
= it
->current
.pos
;
7206 /* For a string from a display property, the next
7207 buffer position is stored in the 'position'
7208 member of the iteration stack slot below the
7209 current one, see handle_single_display_spec. By
7210 contrast, it->current.pos was is not yet updated
7211 to point to that buffer position; that will
7212 happen in pop_it, after we finish displaying the
7213 current string. Note that we already checked
7214 above that it->sp is positive, so subtracting one
7216 if (it
->from_disp_prop_p
)
7217 pos
= (it
->stack
+ it
->sp
- 1)->position
;
7219 INC_TEXT_POS (pos
, it
->multibyte_p
);
7221 if (CHARPOS (pos
) >= ZV
)
7222 it
->end_of_box_run_p
= true;
7225 next_face_id
= face_at_buffer_position
7226 (it
->w
, CHARPOS (pos
), &ignore
,
7227 CHARPOS (pos
) + TEXT_PROP_DISTANCE_LIMIT
, false, -1);
7228 it
->end_of_box_run_p
7229 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7235 /* next_element_from_display_vector sets this flag according to
7236 faces of the display vector glyphs, see there. */
7237 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7239 int face_id
= face_after_it_pos (it
);
7240 it
->end_of_box_run_p
7241 = (face_id
!= it
->face_id
7242 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7245 /* If we reached the end of the object we've been iterating (e.g., a
7246 display string or an overlay string), and there's something on
7247 IT->stack, proceed with what's on the stack. It doesn't make
7248 sense to return false if there's unprocessed stuff on the stack,
7249 because otherwise that stuff will never be displayed. */
7250 if (!success_p
&& it
->sp
> 0)
7252 set_iterator_to_next (it
, false);
7253 success_p
= get_next_display_element (it
);
7256 /* Value is false if end of buffer or string reached. */
7261 /* Move IT to the next display element.
7263 RESEAT_P means if called on a newline in buffer text,
7264 skip to the next visible line start.
7266 Functions get_next_display_element and set_iterator_to_next are
7267 separate because I find this arrangement easier to handle than a
7268 get_next_display_element function that also increments IT's
7269 position. The way it is we can first look at an iterator's current
7270 display element, decide whether it fits on a line, and if it does,
7271 increment the iterator position. The other way around we probably
7272 would either need a flag indicating whether the iterator has to be
7273 incremented the next time, or we would have to implement a
7274 decrement position function which would not be easy to write. */
7277 set_iterator_to_next (struct it
*it
, bool reseat_p
)
7279 /* Reset flags indicating start and end of a sequence of characters
7280 with box. Reset them at the start of this function because
7281 moving the iterator to a new position might set them. */
7282 it
->start_of_box_run_p
= it
->end_of_box_run_p
= false;
7286 case GET_FROM_BUFFER
:
7287 /* The current display element of IT is a character from
7288 current_buffer. Advance in the buffer, and maybe skip over
7289 invisible lines that are so because of selective display. */
7290 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7291 reseat_at_next_visible_line_start (it
, false);
7292 else if (it
->cmp_it
.id
>= 0)
7294 /* We are currently getting glyphs from a composition. */
7297 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7298 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7304 /* Update IT's char/byte positions to point to the first
7305 character of the next grapheme cluster, or to the
7306 character visually after the current composition. */
7307 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7308 bidi_move_to_visually_next (&it
->bidi_it
);
7309 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7310 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7313 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7314 && it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7316 /* Composition created while scanning forward. Proceed
7317 to the next grapheme cluster. */
7318 it
->cmp_it
.from
= it
->cmp_it
.to
;
7320 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7321 && it
->cmp_it
.from
> 0)
7323 /* Composition created while scanning backward. Proceed
7324 to the previous grapheme cluster. */
7325 it
->cmp_it
.to
= it
->cmp_it
.from
;
7329 /* No more grapheme clusters in this composition.
7330 Find the next stop position. */
7331 ptrdiff_t stop
= it
->end_charpos
;
7333 if (it
->bidi_it
.scan_dir
< 0)
7334 /* Now we are scanning backward and don't know
7337 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7338 IT_BYTEPOS (*it
), stop
, Qnil
);
7343 eassert (it
->len
!= 0);
7347 IT_BYTEPOS (*it
) += it
->len
;
7348 IT_CHARPOS (*it
) += 1;
7352 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7353 /* If this is a new paragraph, determine its base
7354 direction (a.k.a. its base embedding level). */
7355 if (it
->bidi_it
.new_paragraph
)
7356 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
7358 bidi_move_to_visually_next (&it
->bidi_it
);
7359 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7360 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7361 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7363 /* As the scan direction was changed, we must
7364 re-compute the stop position for composition. */
7365 ptrdiff_t stop
= it
->end_charpos
;
7366 if (it
->bidi_it
.scan_dir
< 0)
7368 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7369 IT_BYTEPOS (*it
), stop
, Qnil
);
7372 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7376 case GET_FROM_C_STRING
:
7377 /* Current display element of IT is from a C string. */
7379 /* If the string position is beyond string's end, it means
7380 next_element_from_c_string is padding the string with
7381 blanks, in which case we bypass the bidi iterator,
7382 because it cannot deal with such virtual characters. */
7383 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7385 IT_BYTEPOS (*it
) += it
->len
;
7386 IT_CHARPOS (*it
) += 1;
7390 bidi_move_to_visually_next (&it
->bidi_it
);
7391 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7392 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7396 case GET_FROM_DISPLAY_VECTOR
:
7397 /* Current display element of IT is from a display table entry.
7398 Advance in the display table definition. Reset it to null if
7399 end reached, and continue with characters from buffers/
7401 ++it
->current
.dpvec_index
;
7403 /* Restore face of the iterator to what they were before the
7404 display vector entry (these entries may contain faces). */
7405 it
->face_id
= it
->saved_face_id
;
7407 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7409 bool recheck_faces
= it
->ellipsis_p
;
7412 it
->method
= GET_FROM_C_STRING
;
7413 else if (STRINGP (it
->string
))
7414 it
->method
= GET_FROM_STRING
;
7417 it
->method
= GET_FROM_BUFFER
;
7418 it
->object
= it
->w
->contents
;
7422 it
->current
.dpvec_index
= -1;
7424 /* Skip over characters which were displayed via IT->dpvec. */
7425 if (it
->dpvec_char_len
< 0)
7426 reseat_at_next_visible_line_start (it
, true);
7427 else if (it
->dpvec_char_len
> 0)
7429 it
->len
= it
->dpvec_char_len
;
7430 set_iterator_to_next (it
, reseat_p
);
7433 /* Maybe recheck faces after display vector. */
7436 if (it
->method
== GET_FROM_STRING
)
7437 it
->stop_charpos
= IT_STRING_CHARPOS (*it
);
7439 it
->stop_charpos
= IT_CHARPOS (*it
);
7444 case GET_FROM_STRING
:
7445 /* Current display element is a character from a Lisp string. */
7446 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7447 /* Don't advance past string end. These conditions are true
7448 when set_iterator_to_next is called at the end of
7449 get_next_display_element, in which case the Lisp string is
7450 already exhausted, and all we want is pop the iterator
7452 if (it
->current
.overlay_string_index
>= 0)
7454 /* This is an overlay string, so there's no padding with
7455 spaces, and the number of characters in the string is
7456 where the string ends. */
7457 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7458 goto consider_string_end
;
7462 /* Not an overlay string. There could be padding, so test
7463 against it->end_charpos. */
7464 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7465 goto consider_string_end
;
7467 if (it
->cmp_it
.id
>= 0)
7469 /* We are delivering display elements from a composition.
7470 Update the string position past the grapheme cluster
7471 we've just processed. */
7474 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7475 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7481 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7482 bidi_move_to_visually_next (&it
->bidi_it
);
7483 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7484 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7487 /* Did we exhaust all the grapheme clusters of this
7489 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7490 && (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
))
7492 /* Not all the grapheme clusters were processed yet;
7493 advance to the next cluster. */
7494 it
->cmp_it
.from
= it
->cmp_it
.to
;
7496 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7497 && it
->cmp_it
.from
> 0)
7499 /* Likewise: advance to the next cluster, but going in
7500 the reverse direction. */
7501 it
->cmp_it
.to
= it
->cmp_it
.from
;
7505 /* This composition was fully processed; find the next
7506 candidate place for checking for composed
7508 /* Always limit string searches to the string length;
7509 any padding spaces are not part of the string, and
7510 there cannot be any compositions in that padding. */
7511 ptrdiff_t stop
= SCHARS (it
->string
);
7513 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
7515 else if (it
->end_charpos
< stop
)
7517 /* Cf. PRECISION in reseat_to_string: we might be
7518 limited in how many of the string characters we
7520 stop
= it
->end_charpos
;
7522 composition_compute_stop_pos (&it
->cmp_it
,
7523 IT_STRING_CHARPOS (*it
),
7524 IT_STRING_BYTEPOS (*it
), stop
,
7531 /* If the string position is beyond string's end, it
7532 means next_element_from_string is padding the string
7533 with blanks, in which case we bypass the bidi
7534 iterator, because it cannot deal with such virtual
7536 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7538 IT_STRING_BYTEPOS (*it
) += it
->len
;
7539 IT_STRING_CHARPOS (*it
) += 1;
7543 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7545 bidi_move_to_visually_next (&it
->bidi_it
);
7546 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7547 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7548 /* If the scan direction changes, we may need to update
7549 the place where to check for composed characters. */
7550 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7552 ptrdiff_t stop
= SCHARS (it
->string
);
7554 if (it
->bidi_it
.scan_dir
< 0)
7556 else if (it
->end_charpos
< stop
)
7557 stop
= it
->end_charpos
;
7559 composition_compute_stop_pos (&it
->cmp_it
,
7560 IT_STRING_CHARPOS (*it
),
7561 IT_STRING_BYTEPOS (*it
), stop
,
7567 consider_string_end
:
7569 if (it
->current
.overlay_string_index
>= 0)
7571 /* IT->string is an overlay string. Advance to the
7572 next, if there is one. */
7573 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7575 it
->ellipsis_p
= false;
7576 next_overlay_string (it
);
7578 setup_for_ellipsis (it
, 0);
7583 /* IT->string is not an overlay string. If we reached
7584 its end, and there is something on IT->stack, proceed
7585 with what is on the stack. This can be either another
7586 string, this time an overlay string, or a buffer. */
7587 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7591 if (it
->method
== GET_FROM_STRING
)
7592 goto consider_string_end
;
7597 case GET_FROM_IMAGE
:
7598 case GET_FROM_STRETCH
:
7599 /* The position etc with which we have to proceed are on
7600 the stack. The position may be at the end of a string,
7601 if the `display' property takes up the whole string. */
7602 eassert (it
->sp
> 0);
7604 if (it
->method
== GET_FROM_STRING
)
7605 goto consider_string_end
;
7609 /* There are no other methods defined, so this should be a bug. */
7613 eassert (it
->method
!= GET_FROM_STRING
7614 || (STRINGP (it
->string
)
7615 && IT_STRING_CHARPOS (*it
) >= 0));
7618 /* Load IT's display element fields with information about the next
7619 display element which comes from a display table entry or from the
7620 result of translating a control character to one of the forms `^C'
7623 IT->dpvec holds the glyphs to return as characters.
7624 IT->saved_face_id holds the face id before the display vector--it
7625 is restored into IT->face_id in set_iterator_to_next. */
7628 next_element_from_display_vector (struct it
*it
)
7631 int prev_face_id
= it
->face_id
;
7635 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7637 it
->face_id
= it
->saved_face_id
;
7639 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7640 That seemed totally bogus - so I changed it... */
7641 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7643 if (GLYPH_CODE_P (gc
))
7645 struct face
*this_face
, *prev_face
, *next_face
;
7647 it
->c
= GLYPH_CODE_CHAR (gc
);
7648 it
->len
= CHAR_BYTES (it
->c
);
7650 /* The entry may contain a face id to use. Such a face id is
7651 the id of a Lisp face, not a realized face. A face id of
7652 zero means no face is specified. */
7653 if (it
->dpvec_face_id
>= 0)
7654 it
->face_id
= it
->dpvec_face_id
;
7657 int lface_id
= GLYPH_CODE_FACE (gc
);
7659 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7663 /* Glyphs in the display vector could have the box face, so we
7664 need to set the related flags in the iterator, as
7666 this_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7667 prev_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
7669 /* Is this character the first character of a box-face run? */
7670 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7672 || prev_face
->box
== FACE_NO_BOX
));
7674 /* For the last character of the box-face run, we need to look
7675 either at the next glyph from the display vector, or at the
7676 face we saw before the display vector. */
7677 next_face_id
= it
->saved_face_id
;
7678 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7680 if (it
->dpvec_face_id
>= 0)
7681 next_face_id
= it
->dpvec_face_id
;
7685 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7688 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7692 next_face
= FACE_FROM_ID (it
->f
, next_face_id
);
7693 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7695 || next_face
->box
== FACE_NO_BOX
));
7696 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7699 /* Display table entry is invalid. Return a space. */
7700 it
->c
= ' ', it
->len
= 1;
7702 /* Don't change position and object of the iterator here. They are
7703 still the values of the character that had this display table
7704 entry or was translated, and that's what we want. */
7705 it
->what
= IT_CHARACTER
;
7709 /* Get the first element of string/buffer in the visual order, after
7710 being reseated to a new position in a string or a buffer. */
7712 get_visually_first_element (struct it
*it
)
7714 bool string_p
= STRINGP (it
->string
) || it
->s
;
7715 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7716 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7718 if (STRINGP (it
->string
))
7720 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7721 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7725 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7726 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7729 if (it
->bidi_it
.charpos
== eob
)
7731 /* Nothing to do, but reset the FIRST_ELT flag, like
7732 bidi_paragraph_init does, because we are not going to
7734 it
->bidi_it
.first_elt
= false;
7736 else if (it
->bidi_it
.charpos
== bob
7738 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7739 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7741 /* If we are at the beginning of a line/string, we can produce
7742 the next element right away. */
7743 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7744 bidi_move_to_visually_next (&it
->bidi_it
);
7748 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7750 /* We need to prime the bidi iterator starting at the line's or
7751 string's beginning, before we will be able to produce the
7754 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7756 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7757 IT_BYTEPOS (*it
), -1,
7758 &it
->bidi_it
.bytepos
);
7759 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7762 /* Now return to buffer/string position where we were asked
7763 to get the next display element, and produce that. */
7764 bidi_move_to_visually_next (&it
->bidi_it
);
7766 while (it
->bidi_it
.bytepos
!= orig_bytepos
7767 && it
->bidi_it
.charpos
< eob
);
7770 /* Adjust IT's position information to where we ended up. */
7771 if (STRINGP (it
->string
))
7773 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7774 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7778 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7779 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7782 if (STRINGP (it
->string
) || !it
->s
)
7784 ptrdiff_t stop
, charpos
, bytepos
;
7786 if (STRINGP (it
->string
))
7789 stop
= SCHARS (it
->string
);
7790 if (stop
> it
->end_charpos
)
7791 stop
= it
->end_charpos
;
7792 charpos
= IT_STRING_CHARPOS (*it
);
7793 bytepos
= IT_STRING_BYTEPOS (*it
);
7797 stop
= it
->end_charpos
;
7798 charpos
= IT_CHARPOS (*it
);
7799 bytepos
= IT_BYTEPOS (*it
);
7801 if (it
->bidi_it
.scan_dir
< 0)
7803 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7808 /* Load IT with the next display element from Lisp string IT->string.
7809 IT->current.string_pos is the current position within the string.
7810 If IT->current.overlay_string_index >= 0, the Lisp string is an
7814 next_element_from_string (struct it
*it
)
7816 struct text_pos position
;
7818 eassert (STRINGP (it
->string
));
7819 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7820 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7821 position
= it
->current
.string_pos
;
7823 /* With bidi reordering, the character to display might not be the
7824 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT means
7825 that we were reseat()ed to a new string, whose paragraph
7826 direction is not known. */
7827 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7829 get_visually_first_element (it
);
7830 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7833 /* Time to check for invisible text? */
7834 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7836 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7839 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7840 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7842 /* With bidi non-linear iteration, we could find
7843 ourselves far beyond the last computed stop_charpos,
7844 with several other stop positions in between that we
7845 missed. Scan them all now, in buffer's logical
7846 order, until we find and handle the last stop_charpos
7847 that precedes our current position. */
7848 handle_stop_backwards (it
, it
->stop_charpos
);
7849 return GET_NEXT_DISPLAY_ELEMENT (it
);
7855 /* Take note of the stop position we just moved
7856 across, for when we will move back across it. */
7857 it
->prev_stop
= it
->stop_charpos
;
7858 /* If we are at base paragraph embedding level, take
7859 note of the last stop position seen at this
7861 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7862 it
->base_level_stop
= it
->stop_charpos
;
7866 /* Since a handler may have changed IT->method, we must
7868 return GET_NEXT_DISPLAY_ELEMENT (it
);
7872 /* If we are before prev_stop, we may have overstepped
7873 on our way backwards a stop_pos, and if so, we need
7874 to handle that stop_pos. */
7875 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7876 /* We can sometimes back up for reasons that have nothing
7877 to do with bidi reordering. E.g., compositions. The
7878 code below is only needed when we are above the base
7879 embedding level, so test for that explicitly. */
7880 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7882 /* If we lost track of base_level_stop, we have no better
7883 place for handle_stop_backwards to start from than string
7884 beginning. This happens, e.g., when we were reseated to
7885 the previous screenful of text by vertical-motion. */
7886 if (it
->base_level_stop
<= 0
7887 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7888 it
->base_level_stop
= 0;
7889 handle_stop_backwards (it
, it
->base_level_stop
);
7890 return GET_NEXT_DISPLAY_ELEMENT (it
);
7894 if (it
->current
.overlay_string_index
>= 0)
7896 /* Get the next character from an overlay string. In overlay
7897 strings, there is no field width or padding with spaces to
7899 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7904 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7905 IT_STRING_BYTEPOS (*it
),
7906 it
->bidi_it
.scan_dir
< 0
7908 : SCHARS (it
->string
))
7909 && next_element_from_composition (it
))
7913 else if (STRING_MULTIBYTE (it
->string
))
7915 const unsigned char *s
= (SDATA (it
->string
)
7916 + IT_STRING_BYTEPOS (*it
));
7917 it
->c
= string_char_and_length (s
, &it
->len
);
7921 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7927 /* Get the next character from a Lisp string that is not an
7928 overlay string. Such strings come from the mode line, for
7929 example. We may have to pad with spaces, or truncate the
7930 string. See also next_element_from_c_string. */
7931 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7936 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7938 /* Pad with spaces. */
7939 it
->c
= ' ', it
->len
= 1;
7940 CHARPOS (position
) = BYTEPOS (position
) = -1;
7942 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7943 IT_STRING_BYTEPOS (*it
),
7944 it
->bidi_it
.scan_dir
< 0
7946 : it
->string_nchars
)
7947 && next_element_from_composition (it
))
7951 else if (STRING_MULTIBYTE (it
->string
))
7953 const unsigned char *s
= (SDATA (it
->string
)
7954 + IT_STRING_BYTEPOS (*it
));
7955 it
->c
= string_char_and_length (s
, &it
->len
);
7959 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7964 /* Record what we have and where it came from. */
7965 it
->what
= IT_CHARACTER
;
7966 it
->object
= it
->string
;
7967 it
->position
= position
;
7972 /* Load IT with next display element from C string IT->s.
7973 IT->string_nchars is the maximum number of characters to return
7974 from the string. IT->end_charpos may be greater than
7975 IT->string_nchars when this function is called, in which case we
7976 may have to return padding spaces. Value is false if end of string
7977 reached, including padding spaces. */
7980 next_element_from_c_string (struct it
*it
)
7982 bool success_p
= true;
7985 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7986 it
->what
= IT_CHARACTER
;
7987 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7988 it
->object
= make_number (0);
7990 /* With bidi reordering, the character to display might not be the
7991 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
7992 we were reseated to a new string, whose paragraph direction is
7994 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7995 get_visually_first_element (it
);
7997 /* IT's position can be greater than IT->string_nchars in case a
7998 field width or precision has been specified when the iterator was
8000 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8002 /* End of the game. */
8006 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
8008 /* Pad with spaces. */
8009 it
->c
= ' ', it
->len
= 1;
8010 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
8012 else if (it
->multibyte_p
)
8013 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
8015 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
8021 /* Set up IT to return characters from an ellipsis, if appropriate.
8022 The definition of the ellipsis glyphs may come from a display table
8023 entry. This function fills IT with the first glyph from the
8024 ellipsis if an ellipsis is to be displayed. */
8027 next_element_from_ellipsis (struct it
*it
)
8029 if (it
->selective_display_ellipsis_p
)
8030 setup_for_ellipsis (it
, it
->len
);
8033 /* The face at the current position may be different from the
8034 face we find after the invisible text. Remember what it
8035 was in IT->saved_face_id, and signal that it's there by
8036 setting face_before_selective_p. */
8037 it
->saved_face_id
= it
->face_id
;
8038 it
->method
= GET_FROM_BUFFER
;
8039 it
->object
= it
->w
->contents
;
8040 reseat_at_next_visible_line_start (it
, true);
8041 it
->face_before_selective_p
= true;
8044 return GET_NEXT_DISPLAY_ELEMENT (it
);
8048 /* Deliver an image display element. The iterator IT is already
8049 filled with image information (done in handle_display_prop). Value
8054 next_element_from_image (struct it
*it
)
8056 it
->what
= IT_IMAGE
;
8061 /* Fill iterator IT with next display element from a stretch glyph
8062 property. IT->object is the value of the text property. Value is
8066 next_element_from_stretch (struct it
*it
)
8068 it
->what
= IT_STRETCH
;
8072 /* Scan backwards from IT's current position until we find a stop
8073 position, or until BEGV. This is called when we find ourself
8074 before both the last known prev_stop and base_level_stop while
8075 reordering bidirectional text. */
8078 compute_stop_pos_backwards (struct it
*it
)
8080 const int SCAN_BACK_LIMIT
= 1000;
8081 struct text_pos pos
;
8082 struct display_pos save_current
= it
->current
;
8083 struct text_pos save_position
= it
->position
;
8084 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8085 ptrdiff_t where_we_are
= charpos
;
8086 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8087 ptrdiff_t save_end_pos
= it
->end_charpos
;
8089 eassert (NILP (it
->string
) && !it
->s
);
8090 eassert (it
->bidi_p
);
8094 it
->end_charpos
= min (charpos
+ 1, ZV
);
8095 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8096 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8097 reseat_1 (it
, pos
, false);
8098 compute_stop_pos (it
);
8099 /* We must advance forward, right? */
8100 if (it
->stop_charpos
<= charpos
)
8103 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8105 if (it
->stop_charpos
<= where_we_are
)
8106 it
->prev_stop
= it
->stop_charpos
;
8108 it
->prev_stop
= BEGV
;
8110 it
->current
= save_current
;
8111 it
->position
= save_position
;
8112 it
->stop_charpos
= save_stop_pos
;
8113 it
->end_charpos
= save_end_pos
;
8116 /* Scan forward from CHARPOS in the current buffer/string, until we
8117 find a stop position > current IT's position. Then handle the stop
8118 position before that. This is called when we bump into a stop
8119 position while reordering bidirectional text. CHARPOS should be
8120 the last previously processed stop_pos (or BEGV/0, if none were
8121 processed yet) whose position is less that IT's current
8125 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8127 bool bufp
= !STRINGP (it
->string
);
8128 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8129 struct display_pos save_current
= it
->current
;
8130 struct text_pos save_position
= it
->position
;
8131 struct text_pos pos1
;
8132 ptrdiff_t next_stop
;
8134 /* Scan in strict logical order. */
8135 eassert (it
->bidi_p
);
8139 it
->prev_stop
= charpos
;
8142 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8143 reseat_1 (it
, pos1
, false);
8146 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8147 compute_stop_pos (it
);
8148 /* We must advance forward, right? */
8149 if (it
->stop_charpos
<= it
->prev_stop
)
8151 charpos
= it
->stop_charpos
;
8153 while (charpos
<= where_we_are
);
8156 it
->current
= save_current
;
8157 it
->position
= save_position
;
8158 next_stop
= it
->stop_charpos
;
8159 it
->stop_charpos
= it
->prev_stop
;
8161 it
->stop_charpos
= next_stop
;
8164 /* Load IT with the next display element from current_buffer. Value
8165 is false if end of buffer reached. IT->stop_charpos is the next
8166 position at which to stop and check for text properties or buffer
8170 next_element_from_buffer (struct it
*it
)
8172 bool success_p
= true;
8174 eassert (IT_CHARPOS (*it
) >= BEGV
);
8175 eassert (NILP (it
->string
) && !it
->s
);
8176 eassert (!it
->bidi_p
8177 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8178 && it
->bidi_it
.string
.s
== NULL
));
8180 /* With bidi reordering, the character to display might not be the
8181 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
8182 we were reseat()ed to a new buffer position, which is potentially
8183 a different paragraph. */
8184 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8186 get_visually_first_element (it
);
8187 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8190 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8192 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8194 bool overlay_strings_follow_p
;
8196 /* End of the game, except when overlay strings follow that
8197 haven't been returned yet. */
8198 if (it
->overlay_strings_at_end_processed_p
)
8199 overlay_strings_follow_p
= false;
8202 it
->overlay_strings_at_end_processed_p
= true;
8203 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8206 if (overlay_strings_follow_p
)
8207 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8211 it
->position
= it
->current
.pos
;
8215 else if (!(!it
->bidi_p
8216 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8217 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8219 /* With bidi non-linear iteration, we could find ourselves
8220 far beyond the last computed stop_charpos, with several
8221 other stop positions in between that we missed. Scan
8222 them all now, in buffer's logical order, until we find
8223 and handle the last stop_charpos that precedes our
8224 current position. */
8225 handle_stop_backwards (it
, it
->stop_charpos
);
8226 it
->ignore_overlay_strings_at_pos_p
= false;
8227 return GET_NEXT_DISPLAY_ELEMENT (it
);
8233 /* Take note of the stop position we just moved across,
8234 for when we will move back across it. */
8235 it
->prev_stop
= it
->stop_charpos
;
8236 /* If we are at base paragraph embedding level, take
8237 note of the last stop position seen at this
8239 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8240 it
->base_level_stop
= it
->stop_charpos
;
8243 it
->ignore_overlay_strings_at_pos_p
= false;
8244 return GET_NEXT_DISPLAY_ELEMENT (it
);
8248 /* If we are before prev_stop, we may have overstepped on
8249 our way backwards a stop_pos, and if so, we need to
8250 handle that stop_pos. */
8251 && IT_CHARPOS (*it
) < it
->prev_stop
8252 /* We can sometimes back up for reasons that have nothing
8253 to do with bidi reordering. E.g., compositions. The
8254 code below is only needed when we are above the base
8255 embedding level, so test for that explicitly. */
8256 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8258 if (it
->base_level_stop
<= 0
8259 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8261 /* If we lost track of base_level_stop, we need to find
8262 prev_stop by looking backwards. This happens, e.g., when
8263 we were reseated to the previous screenful of text by
8265 it
->base_level_stop
= BEGV
;
8266 compute_stop_pos_backwards (it
);
8267 handle_stop_backwards (it
, it
->prev_stop
);
8270 handle_stop_backwards (it
, it
->base_level_stop
);
8271 it
->ignore_overlay_strings_at_pos_p
= false;
8272 return GET_NEXT_DISPLAY_ELEMENT (it
);
8276 /* No face changes, overlays etc. in sight, so just return a
8277 character from current_buffer. */
8281 /* We moved to the next buffer position, so any info about
8282 previously seen overlays is no longer valid. */
8283 it
->ignore_overlay_strings_at_pos_p
= false;
8285 /* Maybe run the redisplay end trigger hook. Performance note:
8286 This doesn't seem to cost measurable time. */
8287 if (it
->redisplay_end_trigger_charpos
8289 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8290 run_redisplay_end_trigger_hook (it
);
8292 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8293 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8295 && next_element_from_composition (it
))
8300 /* Get the next character, maybe multibyte. */
8301 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8302 if (it
->multibyte_p
&& !ASCII_CHAR_P (*p
))
8303 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8305 it
->c
= *p
, it
->len
= 1;
8307 /* Record what we have and where it came from. */
8308 it
->what
= IT_CHARACTER
;
8309 it
->object
= it
->w
->contents
;
8310 it
->position
= it
->current
.pos
;
8312 /* Normally we return the character found above, except when we
8313 really want to return an ellipsis for selective display. */
8318 /* A value of selective > 0 means hide lines indented more
8319 than that number of columns. */
8320 if (it
->selective
> 0
8321 && IT_CHARPOS (*it
) + 1 < ZV
8322 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8323 IT_BYTEPOS (*it
) + 1,
8326 success_p
= next_element_from_ellipsis (it
);
8327 it
->dpvec_char_len
= -1;
8330 else if (it
->c
== '\r' && it
->selective
== -1)
8332 /* A value of selective == -1 means that everything from the
8333 CR to the end of the line is invisible, with maybe an
8334 ellipsis displayed for it. */
8335 success_p
= next_element_from_ellipsis (it
);
8336 it
->dpvec_char_len
= -1;
8341 /* Value is false if end of buffer reached. */
8342 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8347 /* Run the redisplay end trigger hook for IT. */
8350 run_redisplay_end_trigger_hook (struct it
*it
)
8352 /* IT->glyph_row should be non-null, i.e. we should be actually
8353 displaying something, or otherwise we should not run the hook. */
8354 eassert (it
->glyph_row
);
8356 ptrdiff_t charpos
= it
->redisplay_end_trigger_charpos
;
8357 it
->redisplay_end_trigger_charpos
= 0;
8359 /* Since we are *trying* to run these functions, don't try to run
8360 them again, even if they get an error. */
8361 wset_redisplay_end_trigger (it
->w
, Qnil
);
8362 CALLN (Frun_hook_with_args
, Qredisplay_end_trigger_functions
, it
->window
,
8363 make_number (charpos
));
8365 /* Notice if it changed the face of the character we are on. */
8366 handle_face_prop (it
);
8370 /* Deliver a composition display element. Unlike the other
8371 next_element_from_XXX, this function is not registered in the array
8372 get_next_element[]. It is called from next_element_from_buffer and
8373 next_element_from_string when necessary. */
8376 next_element_from_composition (struct it
*it
)
8378 it
->what
= IT_COMPOSITION
;
8379 it
->len
= it
->cmp_it
.nbytes
;
8380 if (STRINGP (it
->string
))
8384 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8385 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8388 it
->position
= it
->current
.string_pos
;
8389 it
->object
= it
->string
;
8390 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8391 IT_STRING_BYTEPOS (*it
), it
->string
);
8397 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8398 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8401 if (it
->bidi_it
.new_paragraph
)
8402 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
8404 /* Resync the bidi iterator with IT's new position.
8405 FIXME: this doesn't support bidirectional text. */
8406 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8407 bidi_move_to_visually_next (&it
->bidi_it
);
8411 it
->position
= it
->current
.pos
;
8412 it
->object
= it
->w
->contents
;
8413 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8414 IT_BYTEPOS (*it
), Qnil
);
8421 /***********************************************************************
8422 Moving an iterator without producing glyphs
8423 ***********************************************************************/
8425 /* Check if iterator is at a position corresponding to a valid buffer
8426 position after some move_it_ call. */
8428 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8429 ((it)->method != GET_FROM_STRING || IT_STRING_CHARPOS (*it) == 0)
8432 /* Move iterator IT to a specified buffer or X position within one
8433 line on the display without producing glyphs.
8435 OP should be a bit mask including some or all of these bits:
8436 MOVE_TO_X: Stop upon reaching x-position TO_X.
8437 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8438 Regardless of OP's value, stop upon reaching the end of the display line.
8440 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8441 This means, in particular, that TO_X includes window's horizontal
8444 The return value has several possible values that
8445 say what condition caused the scan to stop:
8447 MOVE_POS_MATCH_OR_ZV
8448 - when TO_POS or ZV was reached.
8451 -when TO_X was reached before TO_POS or ZV were reached.
8454 - when we reached the end of the display area and the line must
8458 - when we reached the end of the display area and the line is
8462 - when we stopped at a line end, i.e. a newline or a CR and selective
8465 static enum move_it_result
8466 move_it_in_display_line_to (struct it
*it
,
8467 ptrdiff_t to_charpos
, int to_x
,
8468 enum move_operation_enum op
)
8470 enum move_it_result result
= MOVE_UNDEFINED
;
8471 struct glyph_row
*saved_glyph_row
;
8472 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8473 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8474 void *ppos_data
= NULL
;
8475 bool may_wrap
= false;
8476 enum it_method prev_method
= it
->method
;
8477 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8478 bool saw_smaller_pos
= prev_pos
< to_charpos
;
8480 /* Don't produce glyphs in produce_glyphs. */
8481 saved_glyph_row
= it
->glyph_row
;
8482 it
->glyph_row
= NULL
;
8484 /* Use wrap_it to save a copy of IT wherever a word wrap could
8485 occur. Use atpos_it to save a copy of IT at the desired buffer
8486 position, if found, so that we can scan ahead and check if the
8487 word later overshoots the window edge. Use atx_it similarly, for
8493 /* Use ppos_it under bidi reordering to save a copy of IT for the
8494 initial position. We restore that position in IT when we have
8495 scanned the entire display line without finding a match for
8496 TO_CHARPOS and all the character positions are greater than
8497 TO_CHARPOS. We then restart the scan from the initial position,
8498 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8499 the closest to TO_CHARPOS. */
8502 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8504 SAVE_IT (ppos_it
, *it
, ppos_data
);
8505 closest_pos
= IT_CHARPOS (*it
);
8511 #define BUFFER_POS_REACHED_P() \
8512 ((op & MOVE_TO_POS) != 0 \
8513 && BUFFERP (it->object) \
8514 && (IT_CHARPOS (*it) == to_charpos \
8516 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8517 && IT_CHARPOS (*it) > to_charpos) \
8518 || (it->what == IT_COMPOSITION \
8519 && ((IT_CHARPOS (*it) > to_charpos \
8520 && to_charpos >= it->cmp_it.charpos) \
8521 || (IT_CHARPOS (*it) < to_charpos \
8522 && to_charpos <= it->cmp_it.charpos)))) \
8523 && (it->method == GET_FROM_BUFFER \
8524 || (it->method == GET_FROM_DISPLAY_VECTOR \
8525 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8527 /* If there's a line-/wrap-prefix, handle it. */
8528 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8529 && it
->current_y
< it
->last_visible_y
)
8530 handle_line_prefix (it
);
8532 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8533 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8537 int x
, i
, ascent
= 0, descent
= 0;
8539 /* Utility macro to reset an iterator with x, ascent, and descent. */
8540 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8541 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8542 (IT)->max_descent = descent)
8544 /* Stop if we move beyond TO_CHARPOS (after an image or a
8545 display string or stretch glyph). */
8546 if ((op
& MOVE_TO_POS
) != 0
8547 && BUFFERP (it
->object
)
8548 && it
->method
== GET_FROM_BUFFER
8550 /* When the iterator is at base embedding level, we
8551 are guaranteed that characters are delivered for
8552 display in strictly increasing order of their
8553 buffer positions. */
8554 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8555 && IT_CHARPOS (*it
) > to_charpos
)
8557 && (prev_method
== GET_FROM_IMAGE
8558 || prev_method
== GET_FROM_STRETCH
8559 || prev_method
== GET_FROM_STRING
)
8560 /* Passed TO_CHARPOS from left to right. */
8561 && ((prev_pos
< to_charpos
8562 && IT_CHARPOS (*it
) > to_charpos
)
8563 /* Passed TO_CHARPOS from right to left. */
8564 || (prev_pos
> to_charpos
8565 && IT_CHARPOS (*it
) < to_charpos
)))))
8567 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8569 result
= MOVE_POS_MATCH_OR_ZV
;
8572 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8573 /* If wrap_it is valid, the current position might be in a
8574 word that is wrapped. So, save the iterator in
8575 atpos_it and continue to see if wrapping happens. */
8576 SAVE_IT (atpos_it
, *it
, atpos_data
);
8579 /* Stop when ZV reached.
8580 We used to stop here when TO_CHARPOS reached as well, but that is
8581 too soon if this glyph does not fit on this line. So we handle it
8582 explicitly below. */
8583 if (!get_next_display_element (it
))
8585 result
= MOVE_POS_MATCH_OR_ZV
;
8589 if (it
->line_wrap
== TRUNCATE
)
8591 if (BUFFER_POS_REACHED_P ())
8593 result
= MOVE_POS_MATCH_OR_ZV
;
8599 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8601 if (IT_DISPLAYING_WHITESPACE (it
))
8605 /* We have reached a glyph that follows one or more
8606 whitespace characters. If the position is
8607 already found, we are done. */
8608 if (atpos_it
.sp
>= 0)
8610 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8611 result
= MOVE_POS_MATCH_OR_ZV
;
8616 RESTORE_IT (it
, &atx_it
, atx_data
);
8617 result
= MOVE_X_REACHED
;
8620 /* Otherwise, we can wrap here. */
8621 SAVE_IT (wrap_it
, *it
, wrap_data
);
8627 /* Remember the line height for the current line, in case
8628 the next element doesn't fit on the line. */
8629 ascent
= it
->max_ascent
;
8630 descent
= it
->max_descent
;
8632 /* The call to produce_glyphs will get the metrics of the
8633 display element IT is loaded with. Record the x-position
8634 before this display element, in case it doesn't fit on the
8638 PRODUCE_GLYPHS (it
);
8640 if (it
->area
!= TEXT_AREA
)
8642 prev_method
= it
->method
;
8643 if (it
->method
== GET_FROM_BUFFER
)
8644 prev_pos
= IT_CHARPOS (*it
);
8645 set_iterator_to_next (it
, true);
8646 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8647 SET_TEXT_POS (this_line_min_pos
,
8648 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8650 && (op
& MOVE_TO_POS
)
8651 && IT_CHARPOS (*it
) > to_charpos
8652 && IT_CHARPOS (*it
) < closest_pos
)
8653 closest_pos
= IT_CHARPOS (*it
);
8657 /* The number of glyphs we get back in IT->nglyphs will normally
8658 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8659 character on a terminal frame, or (iii) a line end. For the
8660 second case, IT->nglyphs - 1 padding glyphs will be present.
8661 (On X frames, there is only one glyph produced for a
8662 composite character.)
8664 The behavior implemented below means, for continuation lines,
8665 that as many spaces of a TAB as fit on the current line are
8666 displayed there. For terminal frames, as many glyphs of a
8667 multi-glyph character are displayed in the current line, too.
8668 This is what the old redisplay code did, and we keep it that
8669 way. Under X, the whole shape of a complex character must
8670 fit on the line or it will be completely displayed in the
8673 Note that both for tabs and padding glyphs, all glyphs have
8677 /* More than one glyph or glyph doesn't fit on line. All
8678 glyphs have the same width. */
8679 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8681 int x_before_this_char
= x
;
8682 int hpos_before_this_char
= it
->hpos
;
8684 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8686 new_x
= x
+ single_glyph_width
;
8688 /* We want to leave anything reaching TO_X to the caller. */
8689 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8691 if (BUFFER_POS_REACHED_P ())
8693 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8694 goto buffer_pos_reached
;
8695 if (atpos_it
.sp
< 0)
8697 SAVE_IT (atpos_it
, *it
, atpos_data
);
8698 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8703 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8706 result
= MOVE_X_REACHED
;
8711 SAVE_IT (atx_it
, *it
, atx_data
);
8712 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8717 if (/* Lines are continued. */
8718 it
->line_wrap
!= TRUNCATE
8719 && (/* And glyph doesn't fit on the line. */
8720 new_x
> it
->last_visible_x
8721 /* Or it fits exactly and we're on a window
8723 || (new_x
== it
->last_visible_x
8724 && FRAME_WINDOW_P (it
->f
)
8725 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8726 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8727 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8729 if (/* IT->hpos == 0 means the very first glyph
8730 doesn't fit on the line, e.g. a wide image. */
8732 || (new_x
== it
->last_visible_x
8733 && FRAME_WINDOW_P (it
->f
)))
8736 it
->current_x
= new_x
;
8738 /* The character's last glyph just barely fits
8740 if (i
== it
->nglyphs
- 1)
8742 /* If this is the destination position,
8743 return a position *before* it in this row,
8744 now that we know it fits in this row. */
8745 if (BUFFER_POS_REACHED_P ())
8747 if (it
->line_wrap
!= WORD_WRAP
8749 /* If we've just found whitespace to
8750 wrap, effectively ignore the
8751 previous wrap point -- it is no
8752 longer relevant, but we won't
8753 have an opportunity to update it,
8754 since we've reached the edge of
8755 this screen line. */
8757 && IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8759 it
->hpos
= hpos_before_this_char
;
8760 it
->current_x
= x_before_this_char
;
8761 result
= MOVE_POS_MATCH_OR_ZV
;
8764 if (it
->line_wrap
== WORD_WRAP
8767 SAVE_IT (atpos_it
, *it
, atpos_data
);
8768 atpos_it
.current_x
= x_before_this_char
;
8769 atpos_it
.hpos
= hpos_before_this_char
;
8773 prev_method
= it
->method
;
8774 if (it
->method
== GET_FROM_BUFFER
)
8775 prev_pos
= IT_CHARPOS (*it
);
8776 set_iterator_to_next (it
, true);
8777 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8778 SET_TEXT_POS (this_line_min_pos
,
8779 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8780 /* On graphical terminals, newlines may
8781 "overflow" into the fringe if
8782 overflow-newline-into-fringe is non-nil.
8783 On text terminals, and on graphical
8784 terminals with no right margin, newlines
8785 may overflow into the last glyph on the
8787 if (!FRAME_WINDOW_P (it
->f
)
8789 && it
->bidi_it
.paragraph_dir
== R2L
)
8790 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8791 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8792 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8794 if (!get_next_display_element (it
))
8796 result
= MOVE_POS_MATCH_OR_ZV
;
8799 if (BUFFER_POS_REACHED_P ())
8801 if (ITERATOR_AT_END_OF_LINE_P (it
))
8802 result
= MOVE_POS_MATCH_OR_ZV
;
8804 result
= MOVE_LINE_CONTINUED
;
8807 if (ITERATOR_AT_END_OF_LINE_P (it
)
8808 && (it
->line_wrap
!= WORD_WRAP
8810 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8812 result
= MOVE_NEWLINE_OR_CR
;
8819 IT_RESET_X_ASCENT_DESCENT (it
);
8821 /* If the screen line ends with whitespace, and we
8822 are under word-wrap, don't use wrap_it: it is no
8823 longer relevant, but we won't have an opportunity
8824 to update it, since we are done with this screen
8826 if (may_wrap
&& IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8828 /* If we've found TO_X, go back there, as we now
8829 know the last word fits on this screen line. */
8830 if ((op
& MOVE_TO_X
) && new_x
== it
->last_visible_x
8833 RESTORE_IT (it
, &atx_it
, atx_data
);
8836 result
= MOVE_X_REACHED
;
8840 else if (wrap_it
.sp
>= 0)
8842 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8847 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8849 result
= MOVE_LINE_CONTINUED
;
8853 if (BUFFER_POS_REACHED_P ())
8855 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8856 goto buffer_pos_reached
;
8857 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8859 SAVE_IT (atpos_it
, *it
, atpos_data
);
8860 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8864 if (new_x
> it
->first_visible_x
)
8866 /* Glyph is visible. Increment number of glyphs that
8867 would be displayed. */
8872 if (result
!= MOVE_UNDEFINED
)
8875 else if (BUFFER_POS_REACHED_P ())
8878 IT_RESET_X_ASCENT_DESCENT (it
);
8879 result
= MOVE_POS_MATCH_OR_ZV
;
8882 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8884 /* Stop when TO_X specified and reached. This check is
8885 necessary here because of lines consisting of a line end,
8886 only. The line end will not produce any glyphs and we
8887 would never get MOVE_X_REACHED. */
8888 eassert (it
->nglyphs
== 0);
8889 result
= MOVE_X_REACHED
;
8893 /* Is this a line end? If yes, we're done. */
8894 if (ITERATOR_AT_END_OF_LINE_P (it
))
8896 /* If we are past TO_CHARPOS, but never saw any character
8897 positions smaller than TO_CHARPOS, return
8898 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8900 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8902 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8904 if (closest_pos
< ZV
)
8906 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8907 /* Don't recurse if closest_pos is equal to
8908 to_charpos, since we have just tried that. */
8909 if (closest_pos
!= to_charpos
)
8910 move_it_in_display_line_to (it
, closest_pos
, -1,
8912 result
= MOVE_POS_MATCH_OR_ZV
;
8915 goto buffer_pos_reached
;
8917 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8918 && IT_CHARPOS (*it
) > to_charpos
)
8919 goto buffer_pos_reached
;
8921 result
= MOVE_NEWLINE_OR_CR
;
8924 result
= MOVE_NEWLINE_OR_CR
;
8928 prev_method
= it
->method
;
8929 if (it
->method
== GET_FROM_BUFFER
)
8930 prev_pos
= IT_CHARPOS (*it
);
8931 /* The current display element has been consumed. Advance
8933 set_iterator_to_next (it
, true);
8934 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8935 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8936 if (IT_CHARPOS (*it
) < to_charpos
)
8937 saw_smaller_pos
= true;
8939 && (op
& MOVE_TO_POS
)
8940 && IT_CHARPOS (*it
) >= to_charpos
8941 && IT_CHARPOS (*it
) < closest_pos
)
8942 closest_pos
= IT_CHARPOS (*it
);
8944 /* Stop if lines are truncated and IT's current x-position is
8945 past the right edge of the window now. */
8946 if (it
->line_wrap
== TRUNCATE
8947 && it
->current_x
>= it
->last_visible_x
)
8949 if (!FRAME_WINDOW_P (it
->f
)
8950 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8951 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8952 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8953 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8955 bool at_eob_p
= false;
8957 if ((at_eob_p
= !get_next_display_element (it
))
8958 || BUFFER_POS_REACHED_P ()
8959 /* If we are past TO_CHARPOS, but never saw any
8960 character positions smaller than TO_CHARPOS,
8961 return MOVE_POS_MATCH_OR_ZV, like the
8962 unidirectional display did. */
8963 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8965 && IT_CHARPOS (*it
) > to_charpos
))
8968 && !BUFFER_POS_REACHED_P ()
8969 && !at_eob_p
&& closest_pos
< ZV
)
8971 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8972 if (closest_pos
!= to_charpos
)
8973 move_it_in_display_line_to (it
, closest_pos
, -1,
8976 result
= MOVE_POS_MATCH_OR_ZV
;
8979 if (ITERATOR_AT_END_OF_LINE_P (it
))
8981 result
= MOVE_NEWLINE_OR_CR
;
8985 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8987 && IT_CHARPOS (*it
) > to_charpos
)
8989 if (closest_pos
< ZV
)
8991 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8992 if (closest_pos
!= to_charpos
)
8993 move_it_in_display_line_to (it
, closest_pos
, -1,
8996 result
= MOVE_POS_MATCH_OR_ZV
;
8999 result
= MOVE_LINE_TRUNCATED
;
9002 #undef IT_RESET_X_ASCENT_DESCENT
9005 #undef BUFFER_POS_REACHED_P
9007 /* If we scanned beyond to_pos and didn't find a point to wrap at,
9008 restore the saved iterator. */
9009 if (atpos_it
.sp
>= 0)
9010 RESTORE_IT (it
, &atpos_it
, atpos_data
);
9011 else if (atx_it
.sp
>= 0)
9012 RESTORE_IT (it
, &atx_it
, atx_data
);
9017 bidi_unshelve_cache (atpos_data
, true);
9019 bidi_unshelve_cache (atx_data
, true);
9021 bidi_unshelve_cache (wrap_data
, true);
9023 bidi_unshelve_cache (ppos_data
, true);
9025 /* Restore the iterator settings altered at the beginning of this
9027 it
->glyph_row
= saved_glyph_row
;
9031 /* For external use. */
9033 move_it_in_display_line (struct it
*it
,
9034 ptrdiff_t to_charpos
, int to_x
,
9035 enum move_operation_enum op
)
9037 if (it
->line_wrap
== WORD_WRAP
9038 && (op
& MOVE_TO_X
))
9041 void *save_data
= NULL
;
9044 SAVE_IT (save_it
, *it
, save_data
);
9045 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9046 /* When word-wrap is on, TO_X may lie past the end
9047 of a wrapped line. Then it->current is the
9048 character on the next line, so backtrack to the
9049 space before the wrap point. */
9050 if (skip
== MOVE_LINE_CONTINUED
)
9052 int prev_x
= max (it
->current_x
- 1, 0);
9053 RESTORE_IT (it
, &save_it
, save_data
);
9054 move_it_in_display_line_to
9055 (it
, -1, prev_x
, MOVE_TO_X
);
9058 bidi_unshelve_cache (save_data
, true);
9061 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9065 /* Move IT forward until it satisfies one or more of the criteria in
9066 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9068 OP is a bit-mask that specifies where to stop, and in particular,
9069 which of those four position arguments makes a difference. See the
9070 description of enum move_operation_enum.
9072 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9073 screen line, this function will set IT to the next position that is
9074 displayed to the right of TO_CHARPOS on the screen.
9076 Return the maximum pixel length of any line scanned but never more
9077 than it.last_visible_x. */
9080 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9082 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9083 int line_height
, line_start_x
= 0, reached
= 0;
9084 int max_current_x
= 0;
9085 void *backup_data
= NULL
;
9089 if (op
& MOVE_TO_VPOS
)
9091 /* If no TO_CHARPOS and no TO_X specified, stop at the
9092 start of the line TO_VPOS. */
9093 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9095 if (it
->vpos
== to_vpos
)
9101 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9105 /* TO_VPOS >= 0 means stop at TO_X in the line at
9106 TO_VPOS, or at TO_POS, whichever comes first. */
9107 if (it
->vpos
== to_vpos
)
9113 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9115 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9120 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9122 /* We have reached TO_X but not in the line we want. */
9123 skip
= move_it_in_display_line_to (it
, to_charpos
,
9125 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9133 else if (op
& MOVE_TO_Y
)
9135 struct it it_backup
;
9137 if (it
->line_wrap
== WORD_WRAP
)
9138 SAVE_IT (it_backup
, *it
, backup_data
);
9140 /* TO_Y specified means stop at TO_X in the line containing
9141 TO_Y---or at TO_CHARPOS if this is reached first. The
9142 problem is that we can't really tell whether the line
9143 contains TO_Y before we have completely scanned it, and
9144 this may skip past TO_X. What we do is to first scan to
9147 If TO_X is not specified, use a TO_X of zero. The reason
9148 is to make the outcome of this function more predictable.
9149 If we didn't use TO_X == 0, we would stop at the end of
9150 the line which is probably not what a caller would expect
9152 skip
= move_it_in_display_line_to
9153 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9154 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9156 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9157 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9159 else if (skip
== MOVE_X_REACHED
)
9161 /* If TO_X was reached, we want to know whether TO_Y is
9162 in the line. We know this is the case if the already
9163 scanned glyphs make the line tall enough. Otherwise,
9164 we must check by scanning the rest of the line. */
9165 line_height
= it
->max_ascent
+ it
->max_descent
;
9166 if (to_y
>= it
->current_y
9167 && to_y
< it
->current_y
+ line_height
)
9172 SAVE_IT (it_backup
, *it
, backup_data
);
9173 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9174 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9176 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9177 line_height
= it
->max_ascent
+ it
->max_descent
;
9178 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9180 if (to_y
>= it
->current_y
9181 && to_y
< it
->current_y
+ line_height
)
9183 /* If TO_Y is in this line and TO_X was reached
9184 above, we scanned too far. We have to restore
9185 IT's settings to the ones before skipping. But
9186 keep the more accurate values of max_ascent and
9187 max_descent we've found while skipping the rest
9188 of the line, for the sake of callers, such as
9189 pos_visible_p, that need to know the line
9191 int max_ascent
= it
->max_ascent
;
9192 int max_descent
= it
->max_descent
;
9194 RESTORE_IT (it
, &it_backup
, backup_data
);
9195 it
->max_ascent
= max_ascent
;
9196 it
->max_descent
= max_descent
;
9202 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9208 /* Check whether TO_Y is in this line. */
9209 line_height
= it
->max_ascent
+ it
->max_descent
;
9210 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9212 if (to_y
>= it
->current_y
9213 && to_y
< it
->current_y
+ line_height
)
9215 if (to_y
> it
->current_y
)
9216 max_current_x
= max (it
->current_x
, max_current_x
);
9218 /* When word-wrap is on, TO_X may lie past the end
9219 of a wrapped line. Then it->current is the
9220 character on the next line, so backtrack to the
9221 space before the wrap point. */
9222 if (skip
== MOVE_LINE_CONTINUED
9223 && it
->line_wrap
== WORD_WRAP
)
9225 int prev_x
= max (it
->current_x
- 1, 0);
9226 RESTORE_IT (it
, &it_backup
, backup_data
);
9227 skip
= move_it_in_display_line_to
9228 (it
, -1, prev_x
, MOVE_TO_X
);
9237 max_current_x
= max (it
->current_x
, max_current_x
);
9241 else if (BUFFERP (it
->object
)
9242 && (it
->method
== GET_FROM_BUFFER
9243 || it
->method
== GET_FROM_STRETCH
)
9244 && IT_CHARPOS (*it
) >= to_charpos
9245 /* Under bidi iteration, a call to set_iterator_to_next
9246 can scan far beyond to_charpos if the initial
9247 portion of the next line needs to be reordered. In
9248 that case, give move_it_in_display_line_to another
9251 && it
->bidi_it
.scan_dir
== -1))
9252 skip
= MOVE_POS_MATCH_OR_ZV
;
9254 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9258 case MOVE_POS_MATCH_OR_ZV
:
9259 max_current_x
= max (it
->current_x
, max_current_x
);
9263 case MOVE_NEWLINE_OR_CR
:
9264 max_current_x
= max (it
->current_x
, max_current_x
);
9265 set_iterator_to_next (it
, true);
9266 it
->continuation_lines_width
= 0;
9269 case MOVE_LINE_TRUNCATED
:
9270 max_current_x
= it
->last_visible_x
;
9271 it
->continuation_lines_width
= 0;
9272 reseat_at_next_visible_line_start (it
, false);
9273 if ((op
& MOVE_TO_POS
) != 0
9274 && IT_CHARPOS (*it
) > to_charpos
)
9281 case MOVE_LINE_CONTINUED
:
9282 max_current_x
= it
->last_visible_x
;
9283 /* For continued lines ending in a tab, some of the glyphs
9284 associated with the tab are displayed on the current
9285 line. Since it->current_x does not include these glyphs,
9286 we use it->last_visible_x instead. */
9289 it
->continuation_lines_width
+= it
->last_visible_x
;
9290 /* When moving by vpos, ensure that the iterator really
9291 advances to the next line (bug#847, bug#969). Fixme:
9292 do we need to do this in other circumstances? */
9293 if (it
->current_x
!= it
->last_visible_x
9294 && (op
& MOVE_TO_VPOS
)
9295 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9297 line_start_x
= it
->current_x
+ it
->pixel_width
9298 - it
->last_visible_x
;
9299 if (FRAME_WINDOW_P (it
->f
))
9301 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9302 struct font
*face_font
= face
->font
;
9304 /* When display_line produces a continued line
9305 that ends in a TAB, it skips a tab stop that
9306 is closer than the font's space character
9307 width (see x_produce_glyphs where it produces
9308 the stretch glyph which represents a TAB).
9309 We need to reproduce the same logic here. */
9310 eassert (face_font
);
9313 if (line_start_x
< face_font
->space_width
)
9315 += it
->tab_width
* face_font
->space_width
;
9318 set_iterator_to_next (it
, false);
9322 it
->continuation_lines_width
+= it
->current_x
;
9329 /* Reset/increment for the next run. */
9330 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9331 it
->current_x
= line_start_x
;
9334 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9336 last_height
= it
->max_ascent
+ it
->max_descent
;
9337 it
->max_ascent
= it
->max_descent
= 0;
9342 /* On text terminals, we may stop at the end of a line in the middle
9343 of a multi-character glyph. If the glyph itself is continued,
9344 i.e. it is actually displayed on the next line, don't treat this
9345 stopping point as valid; move to the next line instead (unless
9346 that brings us offscreen). */
9347 if (!FRAME_WINDOW_P (it
->f
)
9349 && IT_CHARPOS (*it
) == to_charpos
9350 && it
->what
== IT_CHARACTER
9352 && it
->line_wrap
== WINDOW_WRAP
9353 && it
->current_x
== it
->last_visible_x
- 1
9356 && it
->w
->window_end_valid
9357 && it
->vpos
< it
->w
->window_end_vpos
)
9359 it
->continuation_lines_width
+= it
->current_x
;
9360 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9361 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9363 last_height
= it
->max_ascent
+ it
->max_descent
;
9367 bidi_unshelve_cache (backup_data
, true);
9369 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9371 return max_current_x
;
9375 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9377 If DY > 0, move IT backward at least that many pixels. DY = 0
9378 means move IT backward to the preceding line start or BEGV. This
9379 function may move over more than DY pixels if IT->current_y - DY
9380 ends up in the middle of a line; in this case IT->current_y will be
9381 set to the top of the line moved to. */
9384 move_it_vertically_backward (struct it
*it
, int dy
)
9388 void *it2data
= NULL
, *it3data
= NULL
;
9389 ptrdiff_t start_pos
;
9391 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9392 ptrdiff_t pos_limit
;
9397 start_pos
= IT_CHARPOS (*it
);
9399 /* Estimate how many newlines we must move back. */
9400 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9401 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9404 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9406 /* Set the iterator's position that many lines back. But don't go
9407 back more than NLINES full screen lines -- this wins a day with
9408 buffers which have very long lines. */
9409 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9410 back_to_previous_visible_line_start (it
);
9412 /* Reseat the iterator here. When moving backward, we don't want
9413 reseat to skip forward over invisible text, set up the iterator
9414 to deliver from overlay strings at the new position etc. So,
9415 use reseat_1 here. */
9416 reseat_1 (it
, it
->current
.pos
, true);
9418 /* We are now surely at a line start. */
9419 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9420 reordering is in effect. */
9421 it
->continuation_lines_width
= 0;
9423 /* Move forward and see what y-distance we moved. First move to the
9424 start of the next line so that we get its height. We need this
9425 height to be able to tell whether we reached the specified
9427 SAVE_IT (it2
, *it
, it2data
);
9428 it2
.max_ascent
= it2
.max_descent
= 0;
9431 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9432 MOVE_TO_POS
| MOVE_TO_VPOS
);
9434 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9435 /* If we are in a display string which starts at START_POS,
9436 and that display string includes a newline, and we are
9437 right after that newline (i.e. at the beginning of a
9438 display line), exit the loop, because otherwise we will
9439 infloop, since move_it_to will see that it is already at
9440 START_POS and will not move. */
9441 || (it2
.method
== GET_FROM_STRING
9442 && IT_CHARPOS (it2
) == start_pos
9443 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9444 eassert (IT_CHARPOS (*it
) >= BEGV
);
9445 SAVE_IT (it3
, it2
, it3data
);
9447 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9448 eassert (IT_CHARPOS (*it
) >= BEGV
);
9449 /* H is the actual vertical distance from the position in *IT
9450 and the starting position. */
9451 h
= it2
.current_y
- it
->current_y
;
9452 /* NLINES is the distance in number of lines. */
9453 nlines
= it2
.vpos
- it
->vpos
;
9455 /* Correct IT's y and vpos position
9456 so that they are relative to the starting point. */
9462 /* DY == 0 means move to the start of the screen line. The
9463 value of nlines is > 0 if continuation lines were involved,
9464 or if the original IT position was at start of a line. */
9465 RESTORE_IT (it
, it
, it2data
);
9467 move_it_by_lines (it
, nlines
);
9468 /* The above code moves us to some position NLINES down,
9469 usually to its first glyph (leftmost in an L2R line), but
9470 that's not necessarily the start of the line, under bidi
9471 reordering. We want to get to the character position
9472 that is immediately after the newline of the previous
9475 && !it
->continuation_lines_width
9476 && !STRINGP (it
->string
)
9477 && IT_CHARPOS (*it
) > BEGV
9478 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9480 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9483 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9484 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9486 bidi_unshelve_cache (it3data
, true);
9490 /* The y-position we try to reach, relative to *IT.
9491 Note that H has been subtracted in front of the if-statement. */
9492 int target_y
= it
->current_y
+ h
- dy
;
9493 int y0
= it3
.current_y
;
9497 RESTORE_IT (&it3
, &it3
, it3data
);
9498 y1
= line_bottom_y (&it3
);
9499 line_height
= y1
- y0
;
9500 RESTORE_IT (it
, it
, it2data
);
9501 /* If we did not reach target_y, try to move further backward if
9502 we can. If we moved too far backward, try to move forward. */
9503 if (target_y
< it
->current_y
9504 /* This is heuristic. In a window that's 3 lines high, with
9505 a line height of 13 pixels each, recentering with point
9506 on the bottom line will try to move -39/2 = 19 pixels
9507 backward. Try to avoid moving into the first line. */
9508 && (it
->current_y
- target_y
9509 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9510 && IT_CHARPOS (*it
) > BEGV
)
9512 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9513 target_y
- it
->current_y
));
9514 dy
= it
->current_y
- target_y
;
9515 goto move_further_back
;
9517 else if (target_y
>= it
->current_y
+ line_height
9518 && IT_CHARPOS (*it
) < ZV
)
9520 /* Should move forward by at least one line, maybe more.
9522 Note: Calling move_it_by_lines can be expensive on
9523 terminal frames, where compute_motion is used (via
9524 vmotion) to do the job, when there are very long lines
9525 and truncate-lines is nil. That's the reason for
9526 treating terminal frames specially here. */
9528 if (!FRAME_WINDOW_P (it
->f
))
9529 move_it_vertically (it
, target_y
- it
->current_y
);
9534 move_it_by_lines (it
, 1);
9536 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9543 /* Move IT by a specified amount of pixel lines DY. DY negative means
9544 move backwards. DY = 0 means move to start of screen line. At the
9545 end, IT will be on the start of a screen line. */
9548 move_it_vertically (struct it
*it
, int dy
)
9551 move_it_vertically_backward (it
, -dy
);
9554 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9555 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9556 MOVE_TO_POS
| MOVE_TO_Y
);
9557 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9559 /* If buffer ends in ZV without a newline, move to the start of
9560 the line to satisfy the post-condition. */
9561 if (IT_CHARPOS (*it
) == ZV
9563 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9564 move_it_by_lines (it
, 0);
9569 /* Move iterator IT past the end of the text line it is in. */
9572 move_it_past_eol (struct it
*it
)
9574 enum move_it_result rc
;
9576 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9577 if (rc
== MOVE_NEWLINE_OR_CR
)
9578 set_iterator_to_next (it
, false);
9582 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9583 negative means move up. DVPOS == 0 means move to the start of the
9586 Optimization idea: If we would know that IT->f doesn't use
9587 a face with proportional font, we could be faster for
9588 truncate-lines nil. */
9591 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9594 /* The commented-out optimization uses vmotion on terminals. This
9595 gives bad results, because elements like it->what, on which
9596 callers such as pos_visible_p rely, aren't updated. */
9597 /* struct position pos;
9598 if (!FRAME_WINDOW_P (it->f))
9600 struct text_pos textpos;
9602 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9603 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9604 reseat (it, textpos, true);
9605 it->vpos += pos.vpos;
9606 it->current_y += pos.vpos;
9612 /* DVPOS == 0 means move to the start of the screen line. */
9613 move_it_vertically_backward (it
, 0);
9614 /* Let next call to line_bottom_y calculate real line height. */
9619 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9620 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9622 /* Only move to the next buffer position if we ended up in a
9623 string from display property, not in an overlay string
9624 (before-string or after-string). That is because the
9625 latter don't conceal the underlying buffer position, so
9626 we can ask to move the iterator to the exact position we
9627 are interested in. Note that, even if we are already at
9628 IT_CHARPOS (*it), the call below is not a no-op, as it
9629 will detect that we are at the end of the string, pop the
9630 iterator, and compute it->current_x and it->hpos
9632 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9633 -1, -1, -1, MOVE_TO_POS
);
9639 void *it2data
= NULL
;
9640 ptrdiff_t start_charpos
, i
;
9642 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9643 bool hit_pos_limit
= false;
9644 ptrdiff_t pos_limit
;
9646 /* Start at the beginning of the screen line containing IT's
9647 position. This may actually move vertically backwards,
9648 in case of overlays, so adjust dvpos accordingly. */
9650 move_it_vertically_backward (it
, 0);
9653 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9654 screen lines, and reseat the iterator there. */
9655 start_charpos
= IT_CHARPOS (*it
);
9656 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9659 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9661 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9662 back_to_previous_visible_line_start (it
);
9663 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9664 hit_pos_limit
= true;
9665 reseat (it
, it
->current
.pos
, true);
9667 /* Move further back if we end up in a string or an image. */
9668 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9670 /* First try to move to start of display line. */
9672 move_it_vertically_backward (it
, 0);
9674 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9676 /* If start of line is still in string or image,
9677 move further back. */
9678 back_to_previous_visible_line_start (it
);
9679 reseat (it
, it
->current
.pos
, true);
9683 it
->current_x
= it
->hpos
= 0;
9685 /* Above call may have moved too far if continuation lines
9686 are involved. Scan forward and see if it did. */
9687 SAVE_IT (it2
, *it
, it2data
);
9688 it2
.vpos
= it2
.current_y
= 0;
9689 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9690 it
->vpos
-= it2
.vpos
;
9691 it
->current_y
-= it2
.current_y
;
9692 it
->current_x
= it
->hpos
= 0;
9694 /* If we moved too far back, move IT some lines forward. */
9695 if (it2
.vpos
> -dvpos
)
9697 int delta
= it2
.vpos
+ dvpos
;
9699 RESTORE_IT (&it2
, &it2
, it2data
);
9700 SAVE_IT (it2
, *it
, it2data
);
9701 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9702 /* Move back again if we got too far ahead. */
9703 if (IT_CHARPOS (*it
) >= start_charpos
)
9704 RESTORE_IT (it
, &it2
, it2data
);
9706 bidi_unshelve_cache (it2data
, true);
9708 else if (hit_pos_limit
&& pos_limit
> BEGV
9709 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9711 /* If we hit the limit, but still didn't make it far enough
9712 back, that means there's a display string with a newline
9713 covering a large chunk of text, and that caused
9714 back_to_previous_visible_line_start try to go too far.
9715 Punish those who commit such atrocities by going back
9716 until we've reached DVPOS, after lifting the limit, which
9717 could make it slow for very long lines. "If it hurts,
9720 RESTORE_IT (it
, it
, it2data
);
9721 for (i
= -dvpos
; i
> 0; --i
)
9723 back_to_previous_visible_line_start (it
);
9726 reseat_1 (it
, it
->current
.pos
, true);
9729 RESTORE_IT (it
, it
, it2data
);
9733 /* Return true if IT points into the middle of a display vector. */
9736 in_display_vector_p (struct it
*it
)
9738 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9739 && it
->current
.dpvec_index
> 0
9740 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9743 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9744 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9745 WINDOW must be a live window and defaults to the selected one. The
9746 return value is a cons of the maximum pixel-width of any text line and
9747 the maximum pixel-height of all text lines.
9749 The optional argument FROM, if non-nil, specifies the first text
9750 position and defaults to the minimum accessible position of the buffer.
9751 If FROM is t, use the minimum accessible position that is not a newline
9752 character. TO, if non-nil, specifies the last text position and
9753 defaults to the maximum accessible position of the buffer. If TO is t,
9754 use the maximum accessible position that is not a newline character.
9756 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9757 width that can be returned. X-LIMIT nil or omitted, means to use the
9758 pixel-width of WINDOW's body; use this if you do not intend to change
9759 the width of WINDOW. Use the maximum width WINDOW may assume if you
9760 intend to change WINDOW's width. In any case, text whose x-coordinate
9761 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9762 can take some time, it's always a good idea to make this argument as
9763 small as possible; in particular, if the buffer contains long lines that
9764 shall be truncated anyway.
9766 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9767 height that can be returned. Text lines whose y-coordinate is beyond
9768 Y-LIMIT are ignored. Since calculating the text height of a large
9769 buffer can take some time, it makes sense to specify this argument if
9770 the size of the buffer is unknown.
9772 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9773 include the height of the mode- or header-line of WINDOW in the return
9774 value. If it is either the symbol `mode-line' or `header-line', include
9775 only the height of that line, if present, in the return value. If t,
9776 include the height of both, if present, in the return value. */)
9777 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
,
9778 Lisp_Object y_limit
, Lisp_Object mode_and_header_line
)
9780 struct window
*w
= decode_live_window (window
);
9781 Lisp_Object buffer
= w
->contents
;
9784 struct buffer
*old_b
= NULL
;
9785 ptrdiff_t start
, end
, pos
;
9786 struct text_pos startp
;
9787 void *itdata
= NULL
;
9788 int c
, max_y
= -1, x
= 0, y
= 0;
9790 CHECK_BUFFER (buffer
);
9791 b
= XBUFFER (buffer
);
9793 if (b
!= current_buffer
)
9795 old_b
= current_buffer
;
9796 set_buffer_internal (b
);
9801 else if (EQ (from
, Qt
))
9804 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9805 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9807 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9812 CHECK_NUMBER_COERCE_MARKER (from
);
9813 start
= min (max (XINT (from
), BEGV
), ZV
);
9818 else if (EQ (to
, Qt
))
9821 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9822 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9824 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9829 CHECK_NUMBER_COERCE_MARKER (to
);
9830 end
= max (start
, min (XINT (to
), ZV
));
9833 if (!NILP (y_limit
))
9835 CHECK_NUMBER (y_limit
);
9836 max_y
= min (XINT (y_limit
), INT_MAX
);
9839 itdata
= bidi_shelve_cache ();
9840 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9841 start_display (&it
, w
, startp
);
9844 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9847 CHECK_NUMBER (x_limit
);
9848 it
.last_visible_x
= min (XINT (x_limit
), INFINITY
);
9849 /* Actually, we never want move_it_to stop at to_x. But to make
9850 sure that move_it_in_display_line_to always moves far enough,
9851 we set it to INT_MAX and specify MOVE_TO_X. */
9852 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9853 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9856 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9858 if (!EQ (mode_and_header_line
, Qheader_line
)
9859 && !EQ (mode_and_header_line
, Qt
))
9860 /* Do not count the header-line which was counted automatically by
9862 y
= y
- WINDOW_HEADER_LINE_HEIGHT (w
);
9864 if (EQ (mode_and_header_line
, Qmode_line
)
9865 || EQ (mode_and_header_line
, Qt
))
9866 /* Do count the mode-line which is not included automatically by
9868 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9870 bidi_unshelve_cache (itdata
, false);
9873 set_buffer_internal (old_b
);
9875 return Fcons (make_number (x
), make_number (y
));
9878 /***********************************************************************
9880 ***********************************************************************/
9882 /* Return the number of arguments the format string FORMAT needs. */
9885 format_nargs (char const *format
)
9887 ptrdiff_t nargs
= 0;
9888 for (char const *p
= format
; (p
= strchr (p
, '%')); p
++)
9896 /* Add a message with format string FORMAT and formatted arguments
9900 add_to_log (const char *format
, ...)
9903 va_start (ap
, format
);
9904 vadd_to_log (format
, ap
);
9909 vadd_to_log (char const *format
, va_list ap
)
9911 ptrdiff_t form_nargs
= format_nargs (format
);
9912 ptrdiff_t nargs
= 1 + form_nargs
;
9913 Lisp_Object args
[10];
9914 eassert (nargs
<= ARRAYELTS (args
));
9915 AUTO_STRING (args0
, format
);
9917 for (ptrdiff_t i
= 1; i
<= nargs
; i
++)
9918 args
[i
] = va_arg (ap
, Lisp_Object
);
9919 Lisp_Object msg
= Qnil
;
9920 msg
= Fformat_message (nargs
, args
);
9922 ptrdiff_t len
= SBYTES (msg
) + 1;
9924 char *buffer
= SAFE_ALLOCA (len
);
9925 memcpy (buffer
, SDATA (msg
), len
);
9927 message_dolog (buffer
, len
- 1, true, STRING_MULTIBYTE (msg
));
9932 /* Output a newline in the *Messages* buffer if "needs" one. */
9935 message_log_maybe_newline (void)
9937 if (message_log_need_newline
)
9938 message_dolog ("", 0, true, false);
9942 /* Add a string M of length NBYTES to the message log, optionally
9943 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9944 true, means interpret the contents of M as multibyte. This
9945 function calls low-level routines in order to bypass text property
9946 hooks, etc. which might not be safe to run.
9948 This may GC (insert may run before/after change hooks),
9949 so the buffer M must NOT point to a Lisp string. */
9952 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9954 const unsigned char *msg
= (const unsigned char *) m
;
9956 if (!NILP (Vmemory_full
))
9959 if (!NILP (Vmessage_log_max
))
9961 struct buffer
*oldbuf
;
9962 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9963 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9964 ptrdiff_t point_at_end
= 0;
9965 ptrdiff_t zv_at_end
= 0;
9966 Lisp_Object old_deactivate_mark
;
9968 old_deactivate_mark
= Vdeactivate_mark
;
9969 oldbuf
= current_buffer
;
9971 /* Ensure the Messages buffer exists, and switch to it.
9972 If we created it, set the major-mode. */
9973 bool newbuffer
= NILP (Fget_buffer (Vmessages_buffer_name
));
9974 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9976 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9977 call0 (intern ("messages-buffer-mode"));
9979 bset_undo_list (current_buffer
, Qt
);
9980 bset_cache_long_scans (current_buffer
, Qnil
);
9982 oldpoint
= message_dolog_marker1
;
9983 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
9984 oldbegv
= message_dolog_marker2
;
9985 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
9986 oldzv
= message_dolog_marker3
;
9987 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
9995 BEGV_BYTE
= BEG_BYTE
;
9998 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10000 /* Insert the string--maybe converting multibyte to single byte
10001 or vice versa, so that all the text fits the buffer. */
10003 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10009 /* Convert a multibyte string to single-byte
10010 for the *Message* buffer. */
10011 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
10013 c
= string_char_and_length (msg
+ i
, &char_bytes
);
10014 work
[0] = CHAR_TO_BYTE8 (c
);
10015 insert_1_both (work
, 1, 1, true, false, false);
10018 else if (! multibyte
10019 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10023 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10024 /* Convert a single-byte string to multibyte
10025 for the *Message* buffer. */
10026 for (i
= 0; i
< nbytes
; i
++)
10029 MAKE_CHAR_MULTIBYTE (c
);
10030 char_bytes
= CHAR_STRING (c
, str
);
10031 insert_1_both ((char *) str
, 1, char_bytes
, true, false, false);
10035 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
,
10036 true, false, false);
10040 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
10043 insert_1_both ("\n", 1, 1, true, false, false);
10045 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, false);
10047 this_bol_byte
= PT_BYTE
;
10049 /* See if this line duplicates the previous one.
10050 If so, combine duplicates. */
10051 if (this_bol
> BEG
)
10053 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, false);
10055 prev_bol_byte
= PT_BYTE
;
10057 dups
= message_log_check_duplicate (prev_bol_byte
,
10061 del_range_both (prev_bol
, prev_bol_byte
,
10062 this_bol
, this_bol_byte
, false);
10065 char dupstr
[sizeof " [ times]"
10066 + INT_STRLEN_BOUND (printmax_t
)];
10068 /* If you change this format, don't forget to also
10069 change message_log_check_duplicate. */
10070 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
10071 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
10072 insert_1_both (dupstr
, duplen
, duplen
,
10073 true, false, true);
10078 /* If we have more than the desired maximum number of lines
10079 in the *Messages* buffer now, delete the oldest ones.
10080 This is safe because we don't have undo in this buffer. */
10082 if (NATNUMP (Vmessage_log_max
))
10084 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10085 -XFASTINT (Vmessage_log_max
) - 1, false);
10086 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, false);
10089 BEGV
= marker_position (oldbegv
);
10090 BEGV_BYTE
= marker_byte_position (oldbegv
);
10099 ZV
= marker_position (oldzv
);
10100 ZV_BYTE
= marker_byte_position (oldzv
);
10104 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10106 /* We can't do Fgoto_char (oldpoint) because it will run some
10108 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10109 marker_byte_position (oldpoint
));
10111 unchain_marker (XMARKER (oldpoint
));
10112 unchain_marker (XMARKER (oldbegv
));
10113 unchain_marker (XMARKER (oldzv
));
10115 /* We called insert_1_both above with its 5th argument (PREPARE)
10116 false, which prevents insert_1_both from calling
10117 prepare_to_modify_buffer, which in turns prevents us from
10118 incrementing windows_or_buffers_changed even if *Messages* is
10119 shown in some window. So we must manually set
10120 windows_or_buffers_changed here to make up for that. */
10121 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10122 bset_redisplay (current_buffer
);
10124 set_buffer_internal (oldbuf
);
10126 message_log_need_newline
= !nlflag
;
10127 Vdeactivate_mark
= old_deactivate_mark
;
10132 /* We are at the end of the buffer after just having inserted a newline.
10133 (Note: We depend on the fact we won't be crossing the gap.)
10134 Check to see if the most recent message looks a lot like the previous one.
10135 Return 0 if different, 1 if the new one should just replace it, or a
10136 value N > 1 if we should also append " [N times]". */
10139 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10142 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10143 bool seen_dots
= false;
10144 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10145 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10147 for (i
= 0; i
< len
; i
++)
10149 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10151 if (p1
[i
] != p2
[i
])
10157 if (*p1
++ == ' ' && *p1
++ == '[')
10160 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10161 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10168 /* Display an echo area message M with a specified length of NBYTES
10169 bytes. The string may include null characters. If M is not a
10170 string, clear out any existing message, and let the mini-buffer
10173 This function cancels echoing. */
10176 message3 (Lisp_Object m
)
10178 clear_message (true, true);
10181 /* First flush out any partial line written with print. */
10182 message_log_maybe_newline ();
10185 ptrdiff_t nbytes
= SBYTES (m
);
10186 bool multibyte
= STRING_MULTIBYTE (m
);
10189 SAFE_ALLOCA_STRING (buffer
, m
);
10190 message_dolog (buffer
, nbytes
, true, multibyte
);
10193 if (! inhibit_message
)
10194 message3_nolog (m
);
10197 /* Log the message M to stderr. Log an empty line if M is not a string. */
10200 message_to_stderr (Lisp_Object m
)
10202 if (noninteractive_need_newline
)
10204 noninteractive_need_newline
= false;
10205 fputc ('\n', stderr
);
10209 Lisp_Object coding_system
= Vlocale_coding_system
;
10212 if (!NILP (Vcoding_system_for_write
))
10213 coding_system
= Vcoding_system_for_write
;
10214 if (!NILP (coding_system
))
10215 s
= code_convert_string_norecord (m
, coding_system
, true);
10219 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10221 if (!cursor_in_echo_area
)
10222 fputc ('\n', stderr
);
10226 /* The non-logging version of message3.
10227 This does not cancel echoing, because it is used for echoing.
10228 Perhaps we need to make a separate function for echoing
10229 and make this cancel echoing. */
10232 message3_nolog (Lisp_Object m
)
10234 struct frame
*sf
= SELECTED_FRAME ();
10236 if (FRAME_INITIAL_P (sf
))
10237 message_to_stderr (m
);
10238 /* Error messages get reported properly by cmd_error, so this must be just an
10239 informative message; if the frame hasn't really been initialized yet, just
10241 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10243 /* Get the frame containing the mini-buffer
10244 that the selected frame is using. */
10245 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10246 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10247 struct frame
*f
= XFRAME (frame
);
10249 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10250 Fmake_frame_visible (frame
);
10252 if (STRINGP (m
) && SCHARS (m
) > 0)
10255 if (minibuffer_auto_raise
)
10256 Fraise_frame (frame
);
10257 /* Assume we are not echoing.
10258 (If we are, echo_now will override this.) */
10259 echo_message_buffer
= Qnil
;
10262 clear_message (true, true);
10264 do_pending_window_change (false);
10265 echo_area_display (true);
10266 do_pending_window_change (false);
10267 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10268 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10273 /* Display a null-terminated echo area message M. If M is 0, clear
10274 out any existing message, and let the mini-buffer text show through.
10276 The buffer M must continue to exist until after the echo area gets
10277 cleared or some other message gets displayed there. Do not pass
10278 text that is stored in a Lisp string. Do not pass text in a buffer
10279 that was alloca'd. */
10282 message1 (const char *m
)
10284 message3 (m
? build_unibyte_string (m
) : Qnil
);
10288 /* The non-logging counterpart of message1. */
10291 message1_nolog (const char *m
)
10293 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10296 /* Display a message M which contains a single %s
10297 which gets replaced with STRING. */
10300 message_with_string (const char *m
, Lisp_Object string
, bool log
)
10302 CHECK_STRING (string
);
10305 if (noninteractive
)
10306 need_message
= !!m
;
10307 else if (!INTERACTIVE
)
10308 need_message
= false;
10311 /* The frame whose minibuffer we're going to display the message on.
10312 It may be larger than the selected frame, so we need
10313 to use its buffer, not the selected frame's buffer. */
10314 Lisp_Object mini_window
;
10315 struct frame
*f
, *sf
= SELECTED_FRAME ();
10317 /* Get the frame containing the minibuffer
10318 that the selected frame is using. */
10319 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10320 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10322 /* Error messages get reported properly by cmd_error, so this must be
10323 just an informative message; if the frame hasn't really been
10324 initialized yet, just toss it. */
10325 need_message
= f
->glyphs_initialized_p
;
10330 AUTO_STRING (fmt
, m
);
10331 Lisp_Object msg
= CALLN (Fformat_message
, fmt
, string
);
10333 if (noninteractive
)
10334 message_to_stderr (msg
);
10340 message3_nolog (msg
);
10342 /* Print should start at the beginning of the message
10343 buffer next time. */
10344 message_buf_print
= false;
10350 /* Dump an informative message to the minibuf. If M is 0, clear out
10351 any existing message, and let the mini-buffer text show through.
10353 The message must be safe ASCII and the format must not contain ` or
10354 '. If your message and format do not fit into this category,
10355 convert your arguments to Lisp objects and use Fmessage instead. */
10357 static void ATTRIBUTE_FORMAT_PRINTF (1, 0)
10358 vmessage (const char *m
, va_list ap
)
10360 if (noninteractive
)
10364 if (noninteractive_need_newline
)
10365 putc ('\n', stderr
);
10366 noninteractive_need_newline
= false;
10367 vfprintf (stderr
, m
, ap
);
10368 if (!cursor_in_echo_area
)
10369 fprintf (stderr
, "\n");
10373 else if (INTERACTIVE
)
10375 /* The frame whose mini-buffer we're going to display the message
10376 on. It may be larger than the selected frame, so we need to
10377 use its buffer, not the selected frame's buffer. */
10378 Lisp_Object mini_window
;
10379 struct frame
*f
, *sf
= SELECTED_FRAME ();
10381 /* Get the frame containing the mini-buffer
10382 that the selected frame is using. */
10383 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10384 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10386 /* Error messages get reported properly by cmd_error, so this must be
10387 just an informative message; if the frame hasn't really been
10388 initialized yet, just toss it. */
10389 if (f
->glyphs_initialized_p
)
10394 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10396 char *message_buf
= SAFE_ALLOCA (maxsize
+ 1);
10398 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10400 message3 (make_string (message_buf
, len
));
10406 /* Print should start at the beginning of the message
10407 buffer next time. */
10408 message_buf_print
= false;
10414 message (const char *m
, ...)
10423 /* Display the current message in the current mini-buffer. This is
10424 only called from error handlers in process.c, and is not time
10428 update_echo_area (void)
10430 if (!NILP (echo_area_buffer
[0]))
10432 Lisp_Object string
;
10433 string
= Fcurrent_message ();
10439 /* Make sure echo area buffers in `echo_buffers' are live.
10440 If they aren't, make new ones. */
10443 ensure_echo_area_buffers (void)
10447 for (i
= 0; i
< 2; ++i
)
10448 if (!BUFFERP (echo_buffer
[i
])
10449 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10452 Lisp_Object old_buffer
;
10455 old_buffer
= echo_buffer
[i
];
10456 echo_buffer
[i
] = Fget_buffer_create
10457 (make_formatted_string (name
, " *Echo Area %d*", i
));
10458 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10459 /* to force word wrap in echo area -
10460 it was decided to postpone this*/
10461 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10463 for (j
= 0; j
< 2; ++j
)
10464 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10465 echo_area_buffer
[j
] = echo_buffer
[i
];
10470 /* Call FN with args A1..A2 with either the current or last displayed
10471 echo_area_buffer as current buffer.
10473 WHICH zero means use the current message buffer
10474 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10475 from echo_buffer[] and clear it.
10477 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10478 suitable buffer from echo_buffer[] and clear it.
10480 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10481 that the current message becomes the last displayed one, make
10482 choose a suitable buffer for echo_area_buffer[0], and clear it.
10484 Value is what FN returns. */
10487 with_echo_area_buffer (struct window
*w
, int which
,
10488 bool (*fn
) (ptrdiff_t, Lisp_Object
),
10489 ptrdiff_t a1
, Lisp_Object a2
)
10491 Lisp_Object buffer
;
10492 bool this_one
, the_other
, clear_buffer_p
, rc
;
10493 ptrdiff_t count
= SPECPDL_INDEX ();
10495 /* If buffers aren't live, make new ones. */
10496 ensure_echo_area_buffers ();
10498 clear_buffer_p
= false;
10501 this_one
= false, the_other
= true;
10502 else if (which
> 0)
10503 this_one
= true, the_other
= false;
10506 this_one
= false, the_other
= true;
10507 clear_buffer_p
= true;
10509 /* We need a fresh one in case the current echo buffer equals
10510 the one containing the last displayed echo area message. */
10511 if (!NILP (echo_area_buffer
[this_one
])
10512 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10513 echo_area_buffer
[this_one
] = Qnil
;
10516 /* Choose a suitable buffer from echo_buffer[] is we don't
10518 if (NILP (echo_area_buffer
[this_one
]))
10520 echo_area_buffer
[this_one
]
10521 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10522 ? echo_buffer
[the_other
]
10523 : echo_buffer
[this_one
]);
10524 clear_buffer_p
= true;
10527 buffer
= echo_area_buffer
[this_one
];
10529 /* Don't get confused by reusing the buffer used for echoing
10530 for a different purpose. */
10531 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10534 record_unwind_protect (unwind_with_echo_area_buffer
,
10535 with_echo_area_buffer_unwind_data (w
));
10537 /* Make the echo area buffer current. Note that for display
10538 purposes, it is not necessary that the displayed window's buffer
10539 == current_buffer, except for text property lookup. So, let's
10540 only set that buffer temporarily here without doing a full
10541 Fset_window_buffer. We must also change w->pointm, though,
10542 because otherwise an assertions in unshow_buffer fails, and Emacs
10544 set_buffer_internal_1 (XBUFFER (buffer
));
10547 wset_buffer (w
, buffer
);
10548 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10549 set_marker_both (w
->old_pointm
, buffer
, BEG
, BEG_BYTE
);
10552 bset_undo_list (current_buffer
, Qt
);
10553 bset_read_only (current_buffer
, Qnil
);
10554 specbind (Qinhibit_read_only
, Qt
);
10555 specbind (Qinhibit_modification_hooks
, Qt
);
10557 if (clear_buffer_p
&& Z
> BEG
)
10558 del_range (BEG
, Z
);
10560 eassert (BEGV
>= BEG
);
10561 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10565 eassert (BEGV
>= BEG
);
10566 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10568 unbind_to (count
, Qnil
);
10573 /* Save state that should be preserved around the call to the function
10574 FN called in with_echo_area_buffer. */
10577 with_echo_area_buffer_unwind_data (struct window
*w
)
10580 Lisp_Object vector
, tmp
;
10582 /* Reduce consing by keeping one vector in
10583 Vwith_echo_area_save_vector. */
10584 vector
= Vwith_echo_area_save_vector
;
10585 Vwith_echo_area_save_vector
= Qnil
;
10588 vector
= Fmake_vector (make_number (11), Qnil
);
10590 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10591 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10592 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10596 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10597 ASET (vector
, i
, w
->contents
); ++i
;
10598 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10599 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10600 ASET (vector
, i
, make_number (marker_position (w
->old_pointm
))); ++i
;
10601 ASET (vector
, i
, make_number (marker_byte_position (w
->old_pointm
))); ++i
;
10602 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10603 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10608 for (; i
< end
; ++i
)
10609 ASET (vector
, i
, Qnil
);
10612 eassert (i
== ASIZE (vector
));
10617 /* Restore global state from VECTOR which was created by
10618 with_echo_area_buffer_unwind_data. */
10621 unwind_with_echo_area_buffer (Lisp_Object vector
)
10623 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10624 Vdeactivate_mark
= AREF (vector
, 1);
10625 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10627 if (WINDOWP (AREF (vector
, 3)))
10630 Lisp_Object buffer
;
10632 w
= XWINDOW (AREF (vector
, 3));
10633 buffer
= AREF (vector
, 4);
10635 wset_buffer (w
, buffer
);
10636 set_marker_both (w
->pointm
, buffer
,
10637 XFASTINT (AREF (vector
, 5)),
10638 XFASTINT (AREF (vector
, 6)));
10639 set_marker_both (w
->old_pointm
, buffer
,
10640 XFASTINT (AREF (vector
, 7)),
10641 XFASTINT (AREF (vector
, 8)));
10642 set_marker_both (w
->start
, buffer
,
10643 XFASTINT (AREF (vector
, 9)),
10644 XFASTINT (AREF (vector
, 10)));
10647 Vwith_echo_area_save_vector
= vector
;
10651 /* Set up the echo area for use by print functions. MULTIBYTE_P
10652 means we will print multibyte. */
10655 setup_echo_area_for_printing (bool multibyte_p
)
10657 /* If we can't find an echo area any more, exit. */
10658 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10659 Fkill_emacs (Qnil
);
10661 ensure_echo_area_buffers ();
10663 if (!message_buf_print
)
10665 /* A message has been output since the last time we printed.
10666 Choose a fresh echo area buffer. */
10667 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10668 echo_area_buffer
[0] = echo_buffer
[1];
10670 echo_area_buffer
[0] = echo_buffer
[0];
10672 /* Switch to that buffer and clear it. */
10673 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10674 bset_truncate_lines (current_buffer
, Qnil
);
10678 ptrdiff_t count
= SPECPDL_INDEX ();
10679 specbind (Qinhibit_read_only
, Qt
);
10680 /* Note that undo recording is always disabled. */
10681 del_range (BEG
, Z
);
10682 unbind_to (count
, Qnil
);
10684 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10686 /* Set up the buffer for the multibyteness we need. */
10688 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10689 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10691 /* Raise the frame containing the echo area. */
10692 if (minibuffer_auto_raise
)
10694 struct frame
*sf
= SELECTED_FRAME ();
10695 Lisp_Object mini_window
;
10696 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10697 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10700 message_log_maybe_newline ();
10701 message_buf_print
= true;
10705 if (NILP (echo_area_buffer
[0]))
10707 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10708 echo_area_buffer
[0] = echo_buffer
[1];
10710 echo_area_buffer
[0] = echo_buffer
[0];
10713 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10715 /* Someone switched buffers between print requests. */
10716 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10717 bset_truncate_lines (current_buffer
, Qnil
);
10723 /* Display an echo area message in window W. Value is true if W's
10724 height is changed. If display_last_displayed_message_p,
10725 display the message that was last displayed, otherwise
10726 display the current message. */
10729 display_echo_area (struct window
*w
)
10731 bool no_message_p
, window_height_changed_p
;
10733 /* Temporarily disable garbage collections while displaying the echo
10734 area. This is done because a GC can print a message itself.
10735 That message would modify the echo area buffer's contents while a
10736 redisplay of the buffer is going on, and seriously confuse
10738 ptrdiff_t count
= inhibit_garbage_collection ();
10740 /* If there is no message, we must call display_echo_area_1
10741 nevertheless because it resizes the window. But we will have to
10742 reset the echo_area_buffer in question to nil at the end because
10743 with_echo_area_buffer will sets it to an empty buffer. */
10744 bool i
= display_last_displayed_message_p
;
10745 /* According to the C99, C11 and C++11 standards, the integral value
10746 of a "bool" is always 0 or 1, so this array access is safe here,
10748 no_message_p
= NILP (echo_area_buffer
[i
]);
10750 window_height_changed_p
10751 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10752 display_echo_area_1
,
10753 (intptr_t) w
, Qnil
);
10756 echo_area_buffer
[i
] = Qnil
;
10758 unbind_to (count
, Qnil
);
10759 return window_height_changed_p
;
10763 /* Helper for display_echo_area. Display the current buffer which
10764 contains the current echo area message in window W, a mini-window,
10765 a pointer to which is passed in A1. A2..A4 are currently not used.
10766 Change the height of W so that all of the message is displayed.
10767 Value is true if height of W was changed. */
10770 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10773 struct window
*w
= (struct window
*) i1
;
10774 Lisp_Object window
;
10775 struct text_pos start
;
10777 /* We are about to enter redisplay without going through
10778 redisplay_internal, so we need to forget these faces by hand
10780 forget_escape_and_glyphless_faces ();
10782 /* Do this before displaying, so that we have a large enough glyph
10783 matrix for the display. If we can't get enough space for the
10784 whole text, display the last N lines. That works by setting w->start. */
10785 bool window_height_changed_p
= resize_mini_window (w
, false);
10787 /* Use the starting position chosen by resize_mini_window. */
10788 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10791 clear_glyph_matrix (w
->desired_matrix
);
10792 XSETWINDOW (window
, w
);
10793 try_window (window
, start
, 0);
10795 return window_height_changed_p
;
10799 /* Resize the echo area window to exactly the size needed for the
10800 currently displayed message, if there is one. If a mini-buffer
10801 is active, don't shrink it. */
10804 resize_echo_area_exactly (void)
10806 if (BUFFERP (echo_area_buffer
[0])
10807 && WINDOWP (echo_area_window
))
10809 struct window
*w
= XWINDOW (echo_area_window
);
10810 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10811 bool resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10812 (intptr_t) w
, resize_exactly
);
10815 windows_or_buffers_changed
= 42;
10816 update_mode_lines
= 30;
10817 redisplay_internal ();
10823 /* Callback function for with_echo_area_buffer, when used from
10824 resize_echo_area_exactly. A1 contains a pointer to the window to
10825 resize, EXACTLY non-nil means resize the mini-window exactly to the
10826 size of the text displayed. A3 and A4 are not used. Value is what
10827 resize_mini_window returns. */
10830 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10833 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10837 /* Resize mini-window W to fit the size of its contents. EXACT_P
10838 means size the window exactly to the size needed. Otherwise, it's
10839 only enlarged until W's buffer is empty.
10841 Set W->start to the right place to begin display. If the whole
10842 contents fit, start at the beginning. Otherwise, start so as
10843 to make the end of the contents appear. This is particularly
10844 important for y-or-n-p, but seems desirable generally.
10846 Value is true if the window height has been changed. */
10849 resize_mini_window (struct window
*w
, bool exact_p
)
10851 struct frame
*f
= XFRAME (w
->frame
);
10852 bool window_height_changed_p
= false;
10854 eassert (MINI_WINDOW_P (w
));
10856 /* By default, start display at the beginning. */
10857 set_marker_both (w
->start
, w
->contents
,
10858 BUF_BEGV (XBUFFER (w
->contents
)),
10859 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10861 /* Don't resize windows while redisplaying a window; it would
10862 confuse redisplay functions when the size of the window they are
10863 displaying changes from under them. Such a resizing can happen,
10864 for instance, when which-func prints a long message while
10865 we are running fontification-functions. We're running these
10866 functions with safe_call which binds inhibit-redisplay to t. */
10867 if (!NILP (Vinhibit_redisplay
))
10870 /* Nil means don't try to resize. */
10871 if (NILP (Vresize_mini_windows
)
10872 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10875 if (!FRAME_MINIBUF_ONLY_P (f
))
10878 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10879 + WINDOW_PIXEL_HEIGHT (w
));
10880 int unit
= FRAME_LINE_HEIGHT (f
);
10881 int height
, max_height
;
10882 struct text_pos start
;
10883 struct buffer
*old_current_buffer
= NULL
;
10885 if (current_buffer
!= XBUFFER (w
->contents
))
10887 old_current_buffer
= current_buffer
;
10888 set_buffer_internal (XBUFFER (w
->contents
));
10891 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10893 /* Compute the max. number of lines specified by the user. */
10894 if (FLOATP (Vmax_mini_window_height
))
10895 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10896 else if (INTEGERP (Vmax_mini_window_height
))
10897 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10899 max_height
= total_height
/ 4;
10901 /* Correct that max. height if it's bogus. */
10902 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10904 /* Find out the height of the text in the window. */
10905 if (it
.line_wrap
== TRUNCATE
)
10910 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10911 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10912 height
= it
.current_y
+ last_height
;
10914 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10915 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10918 /* Compute a suitable window start. */
10919 if (height
> max_height
)
10921 height
= (max_height
/ unit
) * unit
;
10922 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10923 move_it_vertically_backward (&it
, height
- unit
);
10924 start
= it
.current
.pos
;
10927 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10928 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10930 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10932 /* Let it grow only, until we display an empty message, in which
10933 case the window shrinks again. */
10934 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10936 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10938 FRAME_WINDOWS_FROZEN (f
) = true;
10939 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10940 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10942 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10943 && (exact_p
|| BEGV
== ZV
))
10945 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10947 FRAME_WINDOWS_FROZEN (f
) = false;
10948 shrink_mini_window (w
, true);
10949 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10954 /* Always resize to exact size needed. */
10955 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10957 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10959 FRAME_WINDOWS_FROZEN (f
) = true;
10960 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10961 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10963 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
10965 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10967 FRAME_WINDOWS_FROZEN (f
) = false;
10968 shrink_mini_window (w
, true);
10972 FRAME_WINDOWS_FROZEN (f
) = true;
10973 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10976 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10980 if (old_current_buffer
)
10981 set_buffer_internal (old_current_buffer
);
10984 return window_height_changed_p
;
10988 /* Value is the current message, a string, or nil if there is no
10989 current message. */
10992 current_message (void)
10996 if (!BUFFERP (echo_area_buffer
[0]))
11000 with_echo_area_buffer (0, 0, current_message_1
,
11001 (intptr_t) &msg
, Qnil
);
11003 echo_area_buffer
[0] = Qnil
;
11011 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
11014 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
11017 *msg
= make_buffer_string (BEG
, Z
, true);
11024 /* Push the current message on Vmessage_stack for later restoration
11025 by restore_message. Value is true if the current message isn't
11026 empty. This is a relatively infrequent operation, so it's not
11027 worth optimizing. */
11030 push_message (void)
11032 Lisp_Object msg
= current_message ();
11033 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
11034 return STRINGP (msg
);
11038 /* Restore message display from the top of Vmessage_stack. */
11041 restore_message (void)
11043 eassert (CONSP (Vmessage_stack
));
11044 message3_nolog (XCAR (Vmessage_stack
));
11048 /* Handler for unwind-protect calling pop_message. */
11051 pop_message_unwind (void)
11053 /* Pop the top-most entry off Vmessage_stack. */
11054 eassert (CONSP (Vmessage_stack
));
11055 Vmessage_stack
= XCDR (Vmessage_stack
);
11059 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11060 exits. If the stack is not empty, we have a missing pop_message
11064 check_message_stack (void)
11066 if (!NILP (Vmessage_stack
))
11071 /* Truncate to NCHARS what will be displayed in the echo area the next
11072 time we display it---but don't redisplay it now. */
11075 truncate_echo_area (ptrdiff_t nchars
)
11078 echo_area_buffer
[0] = Qnil
;
11079 else if (!noninteractive
11081 && !NILP (echo_area_buffer
[0]))
11083 struct frame
*sf
= SELECTED_FRAME ();
11084 /* Error messages get reported properly by cmd_error, so this must be
11085 just an informative message; if the frame hasn't really been
11086 initialized yet, just toss it. */
11087 if (sf
->glyphs_initialized_p
)
11088 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11093 /* Helper function for truncate_echo_area. Truncate the current
11094 message to at most NCHARS characters. */
11097 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11099 if (BEG
+ nchars
< Z
)
11100 del_range (BEG
+ nchars
, Z
);
11102 echo_area_buffer
[0] = Qnil
;
11106 /* Set the current message to STRING. */
11109 set_message (Lisp_Object string
)
11111 eassert (STRINGP (string
));
11113 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11115 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11116 message_buf_print
= false;
11117 help_echo_showing_p
= false;
11119 if (STRINGP (Vdebug_on_message
)
11120 && STRINGP (string
)
11121 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11122 call_debugger (list2 (Qerror
, string
));
11126 /* Helper function for set_message. First argument is ignored and second
11127 argument has the same meaning as for set_message.
11128 This function is called with the echo area buffer being current. */
11131 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11133 eassert (STRINGP (string
));
11135 /* Change multibyteness of the echo buffer appropriately. */
11136 if (message_enable_multibyte
11137 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11138 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11140 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11141 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11142 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11144 /* Insert new message at BEG. */
11145 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11147 /* This function takes care of single/multibyte conversion.
11148 We just have to ensure that the echo area buffer has the right
11149 setting of enable_multibyte_characters. */
11150 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), true);
11156 /* Clear messages. CURRENT_P means clear the current message.
11157 LAST_DISPLAYED_P means clear the message last displayed. */
11160 clear_message (bool current_p
, bool last_displayed_p
)
11164 echo_area_buffer
[0] = Qnil
;
11165 message_cleared_p
= true;
11168 if (last_displayed_p
)
11169 echo_area_buffer
[1] = Qnil
;
11171 message_buf_print
= false;
11174 /* Clear garbaged frames.
11176 This function is used where the old redisplay called
11177 redraw_garbaged_frames which in turn called redraw_frame which in
11178 turn called clear_frame. The call to clear_frame was a source of
11179 flickering. I believe a clear_frame is not necessary. It should
11180 suffice in the new redisplay to invalidate all current matrices,
11181 and ensure a complete redisplay of all windows. */
11184 clear_garbaged_frames (void)
11186 if (frame_garbaged
)
11188 Lisp_Object tail
, frame
;
11190 FOR_EACH_FRAME (tail
, frame
)
11192 struct frame
*f
= XFRAME (frame
);
11194 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11199 clear_current_matrices (f
);
11200 fset_redisplay (f
);
11201 f
->garbaged
= false;
11202 f
->resized_p
= false;
11206 frame_garbaged
= false;
11211 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P, update
11215 echo_area_display (bool update_frame_p
)
11217 Lisp_Object mini_window
;
11220 bool window_height_changed_p
= false;
11221 struct frame
*sf
= SELECTED_FRAME ();
11223 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11224 w
= XWINDOW (mini_window
);
11225 f
= XFRAME (WINDOW_FRAME (w
));
11227 /* Don't display if frame is invisible or not yet initialized. */
11228 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11231 #ifdef HAVE_WINDOW_SYSTEM
11232 /* When Emacs starts, selected_frame may be the initial terminal
11233 frame. If we let this through, a message would be displayed on
11235 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11237 #endif /* HAVE_WINDOW_SYSTEM */
11239 /* Redraw garbaged frames. */
11240 clear_garbaged_frames ();
11242 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11244 echo_area_window
= mini_window
;
11245 window_height_changed_p
= display_echo_area (w
);
11246 w
->must_be_updated_p
= true;
11248 /* Update the display, unless called from redisplay_internal.
11249 Also don't update the screen during redisplay itself. The
11250 update will happen at the end of redisplay, and an update
11251 here could cause confusion. */
11252 if (update_frame_p
&& !redisplaying_p
)
11256 /* If the display update has been interrupted by pending
11257 input, update mode lines in the frame. Due to the
11258 pending input, it might have been that redisplay hasn't
11259 been called, so that mode lines above the echo area are
11260 garbaged. This looks odd, so we prevent it here. */
11261 if (!display_completed
)
11262 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11264 if (window_height_changed_p
11265 /* Don't do this if Emacs is shutting down. Redisplay
11266 needs to run hooks. */
11267 && !NILP (Vrun_hooks
))
11269 /* Must update other windows. Likewise as in other
11270 cases, don't let this update be interrupted by
11272 ptrdiff_t count
= SPECPDL_INDEX ();
11273 specbind (Qredisplay_dont_pause
, Qt
);
11274 fset_redisplay (f
);
11275 redisplay_internal ();
11276 unbind_to (count
, Qnil
);
11278 else if (FRAME_WINDOW_P (f
) && n
== 0)
11280 /* Window configuration is the same as before.
11281 Can do with a display update of the echo area,
11282 unless we displayed some mode lines. */
11283 update_single_window (w
);
11287 update_frame (f
, true, true);
11289 /* If cursor is in the echo area, make sure that the next
11290 redisplay displays the minibuffer, so that the cursor will
11291 be replaced with what the minibuffer wants. */
11292 if (cursor_in_echo_area
)
11293 wset_redisplay (XWINDOW (mini_window
));
11296 else if (!EQ (mini_window
, selected_window
))
11297 wset_redisplay (XWINDOW (mini_window
));
11299 /* Last displayed message is now the current message. */
11300 echo_area_buffer
[1] = echo_area_buffer
[0];
11301 /* Inform read_char that we're not echoing. */
11302 echo_message_buffer
= Qnil
;
11304 /* Prevent redisplay optimization in redisplay_internal by resetting
11305 this_line_start_pos. This is done because the mini-buffer now
11306 displays the message instead of its buffer text. */
11307 if (EQ (mini_window
, selected_window
))
11308 CHARPOS (this_line_start_pos
) = 0;
11310 if (window_height_changed_p
)
11312 fset_redisplay (f
);
11314 /* If window configuration was changed, frames may have been
11315 marked garbaged. Clear them or we will experience
11316 surprises wrt scrolling.
11317 FIXME: How/why/when? */
11318 clear_garbaged_frames ();
11322 /* True if W's buffer was changed but not saved. */
11325 window_buffer_changed (struct window
*w
)
11327 struct buffer
*b
= XBUFFER (w
->contents
);
11329 eassert (BUFFER_LIVE_P (b
));
11331 return (BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
;
11334 /* True if W has %c in its mode line and mode line should be updated. */
11337 mode_line_update_needed (struct window
*w
)
11339 return (w
->column_number_displayed
!= -1
11340 && !(PT
== w
->last_point
&& !window_outdated (w
))
11341 && (w
->column_number_displayed
!= current_column ()));
11344 /* True if window start of W is frozen and may not be changed during
11348 window_frozen_p (struct window
*w
)
11350 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11352 Lisp_Object window
;
11354 XSETWINDOW (window
, w
);
11355 if (MINI_WINDOW_P (w
))
11357 else if (EQ (window
, selected_window
))
11359 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11360 && EQ (window
, Vminibuf_scroll_window
))
11361 /* This special window can't be frozen too. */
11369 /***********************************************************************
11370 Mode Lines and Frame Titles
11371 ***********************************************************************/
11373 /* A buffer for constructing non-propertized mode-line strings and
11374 frame titles in it; allocated from the heap in init_xdisp and
11375 resized as needed in store_mode_line_noprop_char. */
11377 static char *mode_line_noprop_buf
;
11379 /* The buffer's end, and a current output position in it. */
11381 static char *mode_line_noprop_buf_end
;
11382 static char *mode_line_noprop_ptr
;
11384 #define MODE_LINE_NOPROP_LEN(start) \
11385 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11388 MODE_LINE_DISPLAY
= 0,
11392 } mode_line_target
;
11394 /* Alist that caches the results of :propertize.
11395 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11396 static Lisp_Object mode_line_proptrans_alist
;
11398 /* List of strings making up the mode-line. */
11399 static Lisp_Object mode_line_string_list
;
11401 /* Base face property when building propertized mode line string. */
11402 static Lisp_Object mode_line_string_face
;
11403 static Lisp_Object mode_line_string_face_prop
;
11406 /* Unwind data for mode line strings */
11408 static Lisp_Object Vmode_line_unwind_vector
;
11411 format_mode_line_unwind_data (struct frame
*target_frame
,
11412 struct buffer
*obuf
,
11414 bool save_proptrans
)
11416 Lisp_Object vector
, tmp
;
11418 /* Reduce consing by keeping one vector in
11419 Vwith_echo_area_save_vector. */
11420 vector
= Vmode_line_unwind_vector
;
11421 Vmode_line_unwind_vector
= Qnil
;
11424 vector
= Fmake_vector (make_number (10), Qnil
);
11426 ASET (vector
, 0, make_number (mode_line_target
));
11427 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11428 ASET (vector
, 2, mode_line_string_list
);
11429 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11430 ASET (vector
, 4, mode_line_string_face
);
11431 ASET (vector
, 5, mode_line_string_face_prop
);
11434 XSETBUFFER (tmp
, obuf
);
11437 ASET (vector
, 6, tmp
);
11438 ASET (vector
, 7, owin
);
11441 /* Similarly to `with-selected-window', if the operation selects
11442 a window on another frame, we must restore that frame's
11443 selected window, and (for a tty) the top-frame. */
11444 ASET (vector
, 8, target_frame
->selected_window
);
11445 if (FRAME_TERMCAP_P (target_frame
))
11446 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11453 unwind_format_mode_line (Lisp_Object vector
)
11455 Lisp_Object old_window
= AREF (vector
, 7);
11456 Lisp_Object target_frame_window
= AREF (vector
, 8);
11457 Lisp_Object old_top_frame
= AREF (vector
, 9);
11459 mode_line_target
= XINT (AREF (vector
, 0));
11460 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11461 mode_line_string_list
= AREF (vector
, 2);
11462 if (! EQ (AREF (vector
, 3), Qt
))
11463 mode_line_proptrans_alist
= AREF (vector
, 3);
11464 mode_line_string_face
= AREF (vector
, 4);
11465 mode_line_string_face_prop
= AREF (vector
, 5);
11467 /* Select window before buffer, since it may change the buffer. */
11468 if (!NILP (old_window
))
11470 /* If the operation that we are unwinding had selected a window
11471 on a different frame, reset its frame-selected-window. For a
11472 text terminal, reset its top-frame if necessary. */
11473 if (!NILP (target_frame_window
))
11476 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11478 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11479 Fselect_window (target_frame_window
, Qt
);
11481 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11482 Fselect_frame (old_top_frame
, Qt
);
11485 Fselect_window (old_window
, Qt
);
11488 if (!NILP (AREF (vector
, 6)))
11490 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11491 ASET (vector
, 6, Qnil
);
11494 Vmode_line_unwind_vector
= vector
;
11498 /* Store a single character C for the frame title in mode_line_noprop_buf.
11499 Re-allocate mode_line_noprop_buf if necessary. */
11502 store_mode_line_noprop_char (char c
)
11504 /* If output position has reached the end of the allocated buffer,
11505 increase the buffer's size. */
11506 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11508 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11509 ptrdiff_t size
= len
;
11510 mode_line_noprop_buf
=
11511 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11512 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11513 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11516 *mode_line_noprop_ptr
++ = c
;
11520 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11521 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11522 characters that yield more columns than PRECISION; PRECISION <= 0
11523 means copy the whole string. Pad with spaces until FIELD_WIDTH
11524 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11525 pad. Called from display_mode_element when it is used to build a
11529 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11531 const unsigned char *str
= (const unsigned char *) string
;
11533 ptrdiff_t dummy
, nbytes
;
11535 /* Copy at most PRECISION chars from STR. */
11536 nbytes
= strlen (string
);
11537 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11539 store_mode_line_noprop_char (*str
++);
11541 /* Fill up with spaces until FIELD_WIDTH reached. */
11542 while (field_width
> 0
11543 && n
< field_width
)
11545 store_mode_line_noprop_char (' ');
11552 /***********************************************************************
11554 ***********************************************************************/
11556 #ifdef HAVE_WINDOW_SYSTEM
11558 /* Set the title of FRAME, if it has changed. The title format is
11559 Vicon_title_format if FRAME is iconified, otherwise it is
11560 frame_title_format. */
11563 x_consider_frame_title (Lisp_Object frame
)
11565 struct frame
*f
= XFRAME (frame
);
11567 if ((FRAME_WINDOW_P (f
)
11568 || FRAME_MINIBUF_ONLY_P (f
)
11569 || f
->explicit_name
)
11570 && NILP (Fframe_parameter (frame
, Qtooltip
)))
11572 /* Do we have more than one visible frame on this X display? */
11573 Lisp_Object tail
, other_frame
, fmt
;
11574 ptrdiff_t title_start
;
11578 ptrdiff_t count
= SPECPDL_INDEX ();
11580 FOR_EACH_FRAME (tail
, other_frame
)
11582 struct frame
*tf
= XFRAME (other_frame
);
11585 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11586 && !FRAME_MINIBUF_ONLY_P (tf
)
11587 && !EQ (other_frame
, tip_frame
)
11588 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11592 /* Set global variable indicating that multiple frames exist. */
11593 multiple_frames
= CONSP (tail
);
11595 /* Switch to the buffer of selected window of the frame. Set up
11596 mode_line_target so that display_mode_element will output into
11597 mode_line_noprop_buf; then display the title. */
11598 record_unwind_protect (unwind_format_mode_line
,
11599 format_mode_line_unwind_data
11600 (f
, current_buffer
, selected_window
, false));
11602 Fselect_window (f
->selected_window
, Qt
);
11603 set_buffer_internal_1
11604 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11605 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11607 mode_line_target
= MODE_LINE_TITLE
;
11608 title_start
= MODE_LINE_NOPROP_LEN (0);
11609 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11610 NULL
, DEFAULT_FACE_ID
);
11611 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, false);
11612 len
= MODE_LINE_NOPROP_LEN (title_start
);
11613 title
= mode_line_noprop_buf
+ title_start
;
11614 unbind_to (count
, Qnil
);
11616 /* Set the title only if it's changed. This avoids consing in
11617 the common case where it hasn't. (If it turns out that we've
11618 already wasted too much time by walking through the list with
11619 display_mode_element, then we might need to optimize at a
11620 higher level than this.) */
11621 if (! STRINGP (f
->name
)
11622 || SBYTES (f
->name
) != len
11623 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11624 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11628 #endif /* not HAVE_WINDOW_SYSTEM */
11631 /***********************************************************************
11633 ***********************************************************************/
11635 /* True if we will not redisplay all visible windows. */
11636 #define REDISPLAY_SOME_P() \
11637 ((windows_or_buffers_changed == 0 \
11638 || windows_or_buffers_changed == REDISPLAY_SOME) \
11639 && (update_mode_lines == 0 \
11640 || update_mode_lines == REDISPLAY_SOME))
11642 /* Prepare for redisplay by updating menu-bar item lists when
11643 appropriate. This can call eval. */
11646 prepare_menu_bars (void)
11648 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11649 bool some_windows
= REDISPLAY_SOME_P ();
11650 Lisp_Object tooltip_frame
;
11652 #ifdef HAVE_WINDOW_SYSTEM
11653 tooltip_frame
= tip_frame
;
11655 tooltip_frame
= Qnil
;
11658 if (FUNCTIONP (Vpre_redisplay_function
))
11660 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11661 if (all_windows
&& some_windows
)
11663 Lisp_Object ws
= window_list ();
11664 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11666 Lisp_Object
this = XCAR (ws
);
11667 struct window
*w
= XWINDOW (this);
11669 || XFRAME (w
->frame
)->redisplay
11670 || XBUFFER (w
->contents
)->text
->redisplay
)
11672 windows
= Fcons (this, windows
);
11676 safe__call1 (true, Vpre_redisplay_function
, windows
);
11679 /* Update all frame titles based on their buffer names, etc. We do
11680 this before the menu bars so that the buffer-menu will show the
11681 up-to-date frame titles. */
11682 #ifdef HAVE_WINDOW_SYSTEM
11685 Lisp_Object tail
, frame
;
11687 FOR_EACH_FRAME (tail
, frame
)
11689 struct frame
*f
= XFRAME (frame
);
11690 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11694 && !XBUFFER (w
->contents
)->text
->redisplay
)
11697 if (!EQ (frame
, tooltip_frame
)
11698 && (FRAME_ICONIFIED_P (f
)
11699 || FRAME_VISIBLE_P (f
) == 1
11700 /* Exclude TTY frames that are obscured because they
11701 are not the top frame on their console. This is
11702 because x_consider_frame_title actually switches
11703 to the frame, which for TTY frames means it is
11704 marked as garbaged, and will be completely
11705 redrawn on the next redisplay cycle. This causes
11706 TTY frames to be completely redrawn, when there
11707 are more than one of them, even though nothing
11708 should be changed on display. */
11709 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11710 x_consider_frame_title (frame
);
11713 #endif /* HAVE_WINDOW_SYSTEM */
11715 /* Update the menu bar item lists, if appropriate. This has to be
11716 done before any actual redisplay or generation of display lines. */
11720 Lisp_Object tail
, frame
;
11721 ptrdiff_t count
= SPECPDL_INDEX ();
11722 /* True means that update_menu_bar has run its hooks
11723 so any further calls to update_menu_bar shouldn't do so again. */
11724 bool menu_bar_hooks_run
= false;
11726 record_unwind_save_match_data ();
11728 FOR_EACH_FRAME (tail
, frame
)
11730 struct frame
*f
= XFRAME (frame
);
11731 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11733 /* Ignore tooltip frame. */
11734 if (EQ (frame
, tooltip_frame
))
11740 && !XBUFFER (w
->contents
)->text
->redisplay
)
11743 /* If a window on this frame changed size, report that to
11744 the user and clear the size-change flag. */
11745 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11747 Lisp_Object functions
;
11749 /* Clear flag first in case we get an error below. */
11750 FRAME_WINDOW_SIZES_CHANGED (f
) = false;
11751 functions
= Vwindow_size_change_functions
;
11753 while (CONSP (functions
))
11755 if (!EQ (XCAR (functions
), Qt
))
11756 call1 (XCAR (functions
), frame
);
11757 functions
= XCDR (functions
);
11761 menu_bar_hooks_run
= update_menu_bar (f
, false, menu_bar_hooks_run
);
11762 #ifdef HAVE_WINDOW_SYSTEM
11763 update_tool_bar (f
, false);
11767 unbind_to (count
, Qnil
);
11771 struct frame
*sf
= SELECTED_FRAME ();
11772 update_menu_bar (sf
, true, false);
11773 #ifdef HAVE_WINDOW_SYSTEM
11774 update_tool_bar (sf
, true);
11780 /* Update the menu bar item list for frame F. This has to be done
11781 before we start to fill in any display lines, because it can call
11784 If SAVE_MATCH_DATA, we must save and restore it here.
11786 If HOOKS_RUN, a previous call to update_menu_bar
11787 already ran the menu bar hooks for this redisplay, so there
11788 is no need to run them again. The return value is the
11789 updated value of this flag, to pass to the next call. */
11792 update_menu_bar (struct frame
*f
, bool save_match_data
, bool hooks_run
)
11794 Lisp_Object window
;
11797 /* If called recursively during a menu update, do nothing. This can
11798 happen when, for instance, an activate-menubar-hook causes a
11800 if (inhibit_menubar_update
)
11803 window
= FRAME_SELECTED_WINDOW (f
);
11804 w
= XWINDOW (window
);
11806 if (FRAME_WINDOW_P (f
)
11808 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11809 || defined (HAVE_NS) || defined (USE_GTK)
11810 FRAME_EXTERNAL_MENU_BAR (f
)
11812 FRAME_MENU_BAR_LINES (f
) > 0
11814 : FRAME_MENU_BAR_LINES (f
) > 0)
11816 /* If the user has switched buffers or windows, we need to
11817 recompute to reflect the new bindings. But we'll
11818 recompute when update_mode_lines is set too; that means
11819 that people can use force-mode-line-update to request
11820 that the menu bar be recomputed. The adverse effect on
11821 the rest of the redisplay algorithm is about the same as
11822 windows_or_buffers_changed anyway. */
11823 if (windows_or_buffers_changed
11824 /* This used to test w->update_mode_line, but we believe
11825 there is no need to recompute the menu in that case. */
11826 || update_mode_lines
11827 || window_buffer_changed (w
))
11829 struct buffer
*prev
= current_buffer
;
11830 ptrdiff_t count
= SPECPDL_INDEX ();
11832 specbind (Qinhibit_menubar_update
, Qt
);
11834 set_buffer_internal_1 (XBUFFER (w
->contents
));
11835 if (save_match_data
)
11836 record_unwind_save_match_data ();
11837 if (NILP (Voverriding_local_map_menu_flag
))
11839 specbind (Qoverriding_terminal_local_map
, Qnil
);
11840 specbind (Qoverriding_local_map
, Qnil
);
11845 /* Run the Lucid hook. */
11846 safe_run_hooks (Qactivate_menubar_hook
);
11848 /* If it has changed current-menubar from previous value,
11849 really recompute the menu-bar from the value. */
11850 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11851 call0 (Qrecompute_lucid_menubar
);
11853 safe_run_hooks (Qmenu_bar_update_hook
);
11858 XSETFRAME (Vmenu_updating_frame
, f
);
11859 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11861 /* Redisplay the menu bar in case we changed it. */
11862 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11863 || defined (HAVE_NS) || defined (USE_GTK)
11864 if (FRAME_WINDOW_P (f
))
11866 #if defined (HAVE_NS)
11867 /* All frames on Mac OS share the same menubar. So only
11868 the selected frame should be allowed to set it. */
11869 if (f
== SELECTED_FRAME ())
11871 set_frame_menubar (f
, false, false);
11874 /* On a terminal screen, the menu bar is an ordinary screen
11875 line, and this makes it get updated. */
11876 w
->update_mode_line
= true;
11877 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11878 /* In the non-toolkit version, the menu bar is an ordinary screen
11879 line, and this makes it get updated. */
11880 w
->update_mode_line
= true;
11881 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11883 unbind_to (count
, Qnil
);
11884 set_buffer_internal_1 (prev
);
11891 /***********************************************************************
11893 ***********************************************************************/
11895 #ifdef HAVE_WINDOW_SYSTEM
11897 /* Select `frame' temporarily without running all the code in
11899 FIXME: Maybe do_switch_frame should be trimmed down similarly
11900 when `norecord' is set. */
11902 fast_set_selected_frame (Lisp_Object frame
)
11904 if (!EQ (selected_frame
, frame
))
11906 selected_frame
= frame
;
11907 selected_window
= XFRAME (frame
)->selected_window
;
11911 /* Update the tool-bar item list for frame F. This has to be done
11912 before we start to fill in any display lines. Called from
11913 prepare_menu_bars. If SAVE_MATCH_DATA, we must save
11914 and restore it here. */
11917 update_tool_bar (struct frame
*f
, bool save_match_data
)
11919 #if defined (USE_GTK) || defined (HAVE_NS)
11920 bool do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11922 bool do_update
= (WINDOWP (f
->tool_bar_window
)
11923 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0);
11928 Lisp_Object window
;
11931 window
= FRAME_SELECTED_WINDOW (f
);
11932 w
= XWINDOW (window
);
11934 /* If the user has switched buffers or windows, we need to
11935 recompute to reflect the new bindings. But we'll
11936 recompute when update_mode_lines is set too; that means
11937 that people can use force-mode-line-update to request
11938 that the menu bar be recomputed. The adverse effect on
11939 the rest of the redisplay algorithm is about the same as
11940 windows_or_buffers_changed anyway. */
11941 if (windows_or_buffers_changed
11942 || w
->update_mode_line
11943 || update_mode_lines
11944 || window_buffer_changed (w
))
11946 struct buffer
*prev
= current_buffer
;
11947 ptrdiff_t count
= SPECPDL_INDEX ();
11948 Lisp_Object frame
, new_tool_bar
;
11949 int new_n_tool_bar
;
11951 /* Set current_buffer to the buffer of the selected
11952 window of the frame, so that we get the right local
11954 set_buffer_internal_1 (XBUFFER (w
->contents
));
11956 /* Save match data, if we must. */
11957 if (save_match_data
)
11958 record_unwind_save_match_data ();
11960 /* Make sure that we don't accidentally use bogus keymaps. */
11961 if (NILP (Voverriding_local_map_menu_flag
))
11963 specbind (Qoverriding_terminal_local_map
, Qnil
);
11964 specbind (Qoverriding_local_map
, Qnil
);
11967 /* We must temporarily set the selected frame to this frame
11968 before calling tool_bar_items, because the calculation of
11969 the tool-bar keymap uses the selected frame (see
11970 `tool-bar-make-keymap' in tool-bar.el). */
11971 eassert (EQ (selected_window
,
11972 /* Since we only explicitly preserve selected_frame,
11973 check that selected_window would be redundant. */
11974 XFRAME (selected_frame
)->selected_window
));
11975 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
11976 XSETFRAME (frame
, f
);
11977 fast_set_selected_frame (frame
);
11979 /* Build desired tool-bar items from keymaps. */
11981 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11984 /* Redisplay the tool-bar if we changed it. */
11985 if (new_n_tool_bar
!= f
->n_tool_bar_items
11986 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11988 /* Redisplay that happens asynchronously due to an expose event
11989 may access f->tool_bar_items. Make sure we update both
11990 variables within BLOCK_INPUT so no such event interrupts. */
11992 fset_tool_bar_items (f
, new_tool_bar
);
11993 f
->n_tool_bar_items
= new_n_tool_bar
;
11994 w
->update_mode_line
= true;
11998 unbind_to (count
, Qnil
);
11999 set_buffer_internal_1 (prev
);
12004 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12006 /* Set F->desired_tool_bar_string to a Lisp string representing frame
12007 F's desired tool-bar contents. F->tool_bar_items must have
12008 been set up previously by calling prepare_menu_bars. */
12011 build_desired_tool_bar_string (struct frame
*f
)
12013 int i
, size
, size_needed
;
12014 Lisp_Object image
, plist
;
12016 image
= plist
= Qnil
;
12018 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
12019 Otherwise, make a new string. */
12021 /* The size of the string we might be able to reuse. */
12022 size
= (STRINGP (f
->desired_tool_bar_string
)
12023 ? SCHARS (f
->desired_tool_bar_string
)
12026 /* We need one space in the string for each image. */
12027 size_needed
= f
->n_tool_bar_items
;
12029 /* Reuse f->desired_tool_bar_string, if possible. */
12030 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
12031 fset_desired_tool_bar_string
12032 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
12035 AUTO_LIST4 (props
, Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
12036 Fremove_text_properties (make_number (0), make_number (size
),
12037 props
, f
->desired_tool_bar_string
);
12040 /* Put a `display' property on the string for the images to display,
12041 put a `menu_item' property on tool-bar items with a value that
12042 is the index of the item in F's tool-bar item vector. */
12043 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
12045 #define PROP(IDX) \
12046 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
12048 bool enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
12049 bool selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
12050 int hmargin
, vmargin
, relief
, idx
, end
;
12052 /* If image is a vector, choose the image according to the
12054 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
12055 if (VECTORP (image
))
12059 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12060 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
12063 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12064 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
12066 eassert (ASIZE (image
) >= idx
);
12067 image
= AREF (image
, idx
);
12072 /* Ignore invalid image specifications. */
12073 if (!valid_image_p (image
))
12076 /* Display the tool-bar button pressed, or depressed. */
12077 plist
= Fcopy_sequence (XCDR (image
));
12079 /* Compute margin and relief to draw. */
12080 relief
= (tool_bar_button_relief
>= 0
12081 ? tool_bar_button_relief
12082 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12083 hmargin
= vmargin
= relief
;
12085 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12086 INT_MAX
- max (hmargin
, vmargin
)))
12088 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12089 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12091 else if (CONSP (Vtool_bar_button_margin
))
12093 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12094 INT_MAX
- hmargin
))
12095 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12097 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12098 INT_MAX
- vmargin
))
12099 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12102 if (auto_raise_tool_bar_buttons_p
)
12104 /* Add a `:relief' property to the image spec if the item is
12108 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12115 /* If image is selected, display it pressed, i.e. with a
12116 negative relief. If it's not selected, display it with a
12118 plist
= Fplist_put (plist
, QCrelief
,
12120 ? make_number (-relief
)
12121 : make_number (relief
)));
12126 /* Put a margin around the image. */
12127 if (hmargin
|| vmargin
)
12129 if (hmargin
== vmargin
)
12130 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12132 plist
= Fplist_put (plist
, QCmargin
,
12133 Fcons (make_number (hmargin
),
12134 make_number (vmargin
)));
12137 /* If button is not enabled, and we don't have special images
12138 for the disabled state, make the image appear disabled by
12139 applying an appropriate algorithm to it. */
12140 if (!enabled_p
&& idx
< 0)
12141 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12143 /* Put a `display' text property on the string for the image to
12144 display. Put a `menu-item' property on the string that gives
12145 the start of this item's properties in the tool-bar items
12147 image
= Fcons (Qimage
, plist
);
12148 AUTO_LIST4 (props
, Qdisplay
, image
, Qmenu_item
,
12149 make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12151 /* Let the last image hide all remaining spaces in the tool bar
12152 string. The string can be longer than needed when we reuse a
12153 previous string. */
12154 if (i
+ 1 == f
->n_tool_bar_items
)
12155 end
= SCHARS (f
->desired_tool_bar_string
);
12158 Fadd_text_properties (make_number (i
), make_number (end
),
12159 props
, f
->desired_tool_bar_string
);
12165 /* Display one line of the tool-bar of frame IT->f.
12167 HEIGHT specifies the desired height of the tool-bar line.
12168 If the actual height of the glyph row is less than HEIGHT, the
12169 row's height is increased to HEIGHT, and the icons are centered
12170 vertically in the new height.
12172 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12173 count a final empty row in case the tool-bar width exactly matches
12178 display_tool_bar_line (struct it
*it
, int height
)
12180 struct glyph_row
*row
= it
->glyph_row
;
12181 int max_x
= it
->last_visible_x
;
12182 struct glyph
*last
;
12184 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12185 clear_glyph_row (row
);
12186 row
->enabled_p
= true;
12187 row
->y
= it
->current_y
;
12189 /* Note that this isn't made use of if the face hasn't a box,
12190 so there's no need to check the face here. */
12191 it
->start_of_box_run_p
= true;
12193 while (it
->current_x
< max_x
)
12195 int x
, n_glyphs_before
, i
, nglyphs
;
12196 struct it it_before
;
12198 /* Get the next display element. */
12199 if (!get_next_display_element (it
))
12201 /* Don't count empty row if we are counting needed tool-bar lines. */
12202 if (height
< 0 && !it
->hpos
)
12207 /* Produce glyphs. */
12208 n_glyphs_before
= row
->used
[TEXT_AREA
];
12211 PRODUCE_GLYPHS (it
);
12213 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12215 x
= it_before
.current_x
;
12216 while (i
< nglyphs
)
12218 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12220 if (x
+ glyph
->pixel_width
> max_x
)
12222 /* Glyph doesn't fit on line. Backtrack. */
12223 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12225 /* If this is the only glyph on this line, it will never fit on the
12226 tool-bar, so skip it. But ensure there is at least one glyph,
12227 so we don't accidentally disable the tool-bar. */
12228 if (n_glyphs_before
== 0
12229 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12235 x
+= glyph
->pixel_width
;
12239 /* Stop at line end. */
12240 if (ITERATOR_AT_END_OF_LINE_P (it
))
12243 set_iterator_to_next (it
, true);
12248 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12250 /* Use default face for the border below the tool bar.
12252 FIXME: When auto-resize-tool-bars is grow-only, there is
12253 no additional border below the possibly empty tool-bar lines.
12254 So to make the extra empty lines look "normal", we have to
12255 use the tool-bar face for the border too. */
12256 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12257 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12258 it
->face_id
= DEFAULT_FACE_ID
;
12260 extend_face_to_end_of_line (it
);
12261 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12262 last
->right_box_line_p
= true;
12263 if (last
== row
->glyphs
[TEXT_AREA
])
12264 last
->left_box_line_p
= true;
12266 /* Make line the desired height and center it vertically. */
12267 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12269 /* Don't add more than one line height. */
12270 height
%= FRAME_LINE_HEIGHT (it
->f
);
12271 it
->max_ascent
+= height
/ 2;
12272 it
->max_descent
+= (height
+ 1) / 2;
12275 compute_line_metrics (it
);
12277 /* If line is empty, make it occupy the rest of the tool-bar. */
12278 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12280 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12281 row
->visible_height
= row
->height
;
12282 row
->ascent
= row
->phys_ascent
= 0;
12283 row
->extra_line_spacing
= 0;
12286 row
->full_width_p
= true;
12287 row
->continued_p
= false;
12288 row
->truncated_on_left_p
= false;
12289 row
->truncated_on_right_p
= false;
12291 it
->current_x
= it
->hpos
= 0;
12292 it
->current_y
+= row
->height
;
12298 /* Value is the number of pixels needed to make all tool-bar items of
12299 frame F visible. The actual number of glyph rows needed is
12300 returned in *N_ROWS if non-NULL. */
12302 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12304 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12306 /* tool_bar_height is called from redisplay_tool_bar after building
12307 the desired matrix, so use (unused) mode-line row as temporary row to
12308 avoid destroying the first tool-bar row. */
12309 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12311 /* Initialize an iterator for iteration over
12312 F->desired_tool_bar_string in the tool-bar window of frame F. */
12313 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12314 temp_row
->reversed_p
= false;
12315 it
.first_visible_x
= 0;
12316 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12317 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12318 it
.paragraph_embedding
= L2R
;
12320 while (!ITERATOR_AT_END_P (&it
))
12322 clear_glyph_row (temp_row
);
12323 it
.glyph_row
= temp_row
;
12324 display_tool_bar_line (&it
, -1);
12326 clear_glyph_row (temp_row
);
12328 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12330 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12333 return it
.current_y
;
12335 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12338 #endif /* !USE_GTK && !HAVE_NS */
12340 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12342 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12343 If FRAME is nil or omitted, use the selected frame. Optional argument
12344 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12345 (Lisp_Object frame
, Lisp_Object pixelwise
)
12349 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12350 struct frame
*f
= decode_any_frame (frame
);
12352 if (WINDOWP (f
->tool_bar_window
)
12353 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12355 update_tool_bar (f
, true);
12356 if (f
->n_tool_bar_items
)
12358 build_desired_tool_bar_string (f
);
12359 height
= tool_bar_height (f
, NULL
, !NILP (pixelwise
));
12364 return make_number (height
);
12368 /* Display the tool-bar of frame F. Value is true if tool-bar's
12369 height should be changed. */
12371 redisplay_tool_bar (struct frame
*f
)
12373 f
->tool_bar_redisplayed
= true;
12374 #if defined (USE_GTK) || defined (HAVE_NS)
12376 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12377 update_frame_tool_bar (f
);
12380 #else /* !USE_GTK && !HAVE_NS */
12384 struct glyph_row
*row
;
12386 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12387 do anything. This means you must start with tool-bar-lines
12388 non-zero to get the auto-sizing effect. Or in other words, you
12389 can turn off tool-bars by specifying tool-bar-lines zero. */
12390 if (!WINDOWP (f
->tool_bar_window
)
12391 || (w
= XWINDOW (f
->tool_bar_window
),
12392 WINDOW_TOTAL_LINES (w
) == 0))
12395 /* Set up an iterator for the tool-bar window. */
12396 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12397 it
.first_visible_x
= 0;
12398 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12399 row
= it
.glyph_row
;
12400 row
->reversed_p
= false;
12402 /* Build a string that represents the contents of the tool-bar. */
12403 build_desired_tool_bar_string (f
);
12404 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12405 /* FIXME: This should be controlled by a user option. But it
12406 doesn't make sense to have an R2L tool bar if the menu bar cannot
12407 be drawn also R2L, and making the menu bar R2L is tricky due
12408 toolkit-specific code that implements it. If an R2L tool bar is
12409 ever supported, display_tool_bar_line should also be augmented to
12410 call unproduce_glyphs like display_line and display_string
12412 it
.paragraph_embedding
= L2R
;
12414 if (f
->n_tool_bar_rows
== 0)
12416 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, true);
12418 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12420 x_change_tool_bar_height (f
, new_height
);
12421 frame_default_tool_bar_height
= new_height
;
12422 /* Always do that now. */
12423 clear_glyph_matrix (w
->desired_matrix
);
12424 f
->fonts_changed
= true;
12429 /* Display as many lines as needed to display all tool-bar items. */
12431 if (f
->n_tool_bar_rows
> 0)
12433 int border
, rows
, height
, extra
;
12435 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12436 border
= XINT (Vtool_bar_border
);
12437 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12438 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12439 else if (EQ (Vtool_bar_border
, Qborder_width
))
12440 border
= f
->border_width
;
12446 rows
= f
->n_tool_bar_rows
;
12447 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12448 extra
= it
.last_visible_y
- border
- height
* rows
;
12450 while (it
.current_y
< it
.last_visible_y
)
12453 if (extra
> 0 && rows
-- > 0)
12455 h
= (extra
+ rows
- 1) / rows
;
12458 display_tool_bar_line (&it
, height
+ h
);
12463 while (it
.current_y
< it
.last_visible_y
)
12464 display_tool_bar_line (&it
, 0);
12467 /* It doesn't make much sense to try scrolling in the tool-bar
12468 window, so don't do it. */
12469 w
->desired_matrix
->no_scrolling_p
= true;
12470 w
->must_be_updated_p
= true;
12472 if (!NILP (Vauto_resize_tool_bars
))
12474 bool change_height_p
= true;
12476 /* If we couldn't display everything, change the tool-bar's
12477 height if there is room for more. */
12478 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
12479 change_height_p
= true;
12481 /* We subtract 1 because display_tool_bar_line advances the
12482 glyph_row pointer before returning to its caller. We want to
12483 examine the last glyph row produced by
12484 display_tool_bar_line. */
12485 row
= it
.glyph_row
- 1;
12487 /* If there are blank lines at the end, except for a partially
12488 visible blank line at the end that is smaller than
12489 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12490 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12491 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12492 change_height_p
= true;
12494 /* If row displays tool-bar items, but is partially visible,
12495 change the tool-bar's height. */
12496 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12497 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
12498 change_height_p
= true;
12500 /* Resize windows as needed by changing the `tool-bar-lines'
12501 frame parameter. */
12502 if (change_height_p
)
12505 int new_height
= tool_bar_height (f
, &nrows
, true);
12507 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12508 && !f
->minimize_tool_bar_window_p
)
12509 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12510 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12511 f
->minimize_tool_bar_window_p
= false;
12513 if (change_height_p
)
12515 x_change_tool_bar_height (f
, new_height
);
12516 frame_default_tool_bar_height
= new_height
;
12517 clear_glyph_matrix (w
->desired_matrix
);
12518 f
->n_tool_bar_rows
= nrows
;
12519 f
->fonts_changed
= true;
12526 f
->minimize_tool_bar_window_p
= false;
12529 #endif /* USE_GTK || HAVE_NS */
12532 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12534 /* Get information about the tool-bar item which is displayed in GLYPH
12535 on frame F. Return in *PROP_IDX the index where tool-bar item
12536 properties start in F->tool_bar_items. Value is false if
12537 GLYPH doesn't display a tool-bar item. */
12540 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12545 /* This function can be called asynchronously, which means we must
12546 exclude any possibility that Fget_text_property signals an
12548 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12549 charpos
= max (0, charpos
);
12551 /* Get the text property `menu-item' at pos. The value of that
12552 property is the start index of this item's properties in
12553 F->tool_bar_items. */
12554 prop
= Fget_text_property (make_number (charpos
),
12555 Qmenu_item
, f
->current_tool_bar_string
);
12556 if (! INTEGERP (prop
))
12558 *prop_idx
= XINT (prop
);
12563 /* Get information about the tool-bar item at position X/Y on frame F.
12564 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12565 the current matrix of the tool-bar window of F, or NULL if not
12566 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12567 item in F->tool_bar_items. Value is
12569 -1 if X/Y is not on a tool-bar item
12570 0 if X/Y is on the same item that was highlighted before.
12574 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12575 int *hpos
, int *vpos
, int *prop_idx
)
12577 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12578 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12581 /* Find the glyph under X/Y. */
12582 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12583 if (*glyph
== NULL
)
12586 /* Get the start of this tool-bar item's properties in
12587 f->tool_bar_items. */
12588 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12591 /* Is mouse on the highlighted item? */
12592 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12593 && *vpos
>= hlinfo
->mouse_face_beg_row
12594 && *vpos
<= hlinfo
->mouse_face_end_row
12595 && (*vpos
> hlinfo
->mouse_face_beg_row
12596 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12597 && (*vpos
< hlinfo
->mouse_face_end_row
12598 || *hpos
< hlinfo
->mouse_face_end_col
12599 || hlinfo
->mouse_face_past_end
))
12607 Handle mouse button event on the tool-bar of frame F, at
12608 frame-relative coordinates X/Y. DOWN_P is true for a button press,
12609 false for button release. MODIFIERS is event modifiers for button
12613 handle_tool_bar_click (struct frame
*f
, int x
, int y
, bool down_p
,
12616 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12617 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12618 int hpos
, vpos
, prop_idx
;
12619 struct glyph
*glyph
;
12620 Lisp_Object enabled_p
;
12623 /* If not on the highlighted tool-bar item, and mouse-highlight is
12624 non-nil, return. This is so we generate the tool-bar button
12625 click only when the mouse button is released on the same item as
12626 where it was pressed. However, when mouse-highlight is disabled,
12627 generate the click when the button is released regardless of the
12628 highlight, since tool-bar items are not highlighted in that
12630 frame_to_window_pixel_xy (w
, &x
, &y
);
12631 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12633 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12636 /* When mouse-highlight is off, generate the click for the item
12637 where the button was pressed, disregarding where it was
12639 if (NILP (Vmouse_highlight
) && !down_p
)
12640 prop_idx
= f
->last_tool_bar_item
;
12642 /* If item is disabled, do nothing. */
12643 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12644 if (NILP (enabled_p
))
12649 /* Show item in pressed state. */
12650 if (!NILP (Vmouse_highlight
))
12651 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12652 f
->last_tool_bar_item
= prop_idx
;
12656 Lisp_Object key
, frame
;
12657 struct input_event event
;
12658 EVENT_INIT (event
);
12660 /* Show item in released state. */
12661 if (!NILP (Vmouse_highlight
))
12662 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12664 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12666 XSETFRAME (frame
, f
);
12667 event
.kind
= TOOL_BAR_EVENT
;
12668 event
.frame_or_window
= frame
;
12670 kbd_buffer_store_event (&event
);
12672 event
.kind
= TOOL_BAR_EVENT
;
12673 event
.frame_or_window
= frame
;
12675 event
.modifiers
= modifiers
;
12676 kbd_buffer_store_event (&event
);
12677 f
->last_tool_bar_item
= -1;
12682 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12683 tool-bar window-relative coordinates X/Y. Called from
12684 note_mouse_highlight. */
12687 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12689 Lisp_Object window
= f
->tool_bar_window
;
12690 struct window
*w
= XWINDOW (window
);
12691 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12692 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12694 struct glyph
*glyph
;
12695 struct glyph_row
*row
;
12697 Lisp_Object enabled_p
;
12699 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12703 /* Function note_mouse_highlight is called with negative X/Y
12704 values when mouse moves outside of the frame. */
12705 if (x
<= 0 || y
<= 0)
12707 clear_mouse_face (hlinfo
);
12711 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12714 /* Not on tool-bar item. */
12715 clear_mouse_face (hlinfo
);
12719 /* On same tool-bar item as before. */
12720 goto set_help_echo
;
12722 clear_mouse_face (hlinfo
);
12724 /* Mouse is down, but on different tool-bar item? */
12725 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12726 && f
== dpyinfo
->last_mouse_frame
);
12728 if (mouse_down_p
&& f
->last_tool_bar_item
!= prop_idx
)
12731 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12733 /* If tool-bar item is not enabled, don't highlight it. */
12734 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12735 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12737 /* Compute the x-position of the glyph. In front and past the
12738 image is a space. We include this in the highlighted area. */
12739 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12740 for (i
= x
= 0; i
< hpos
; ++i
)
12741 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12743 /* Record this as the current active region. */
12744 hlinfo
->mouse_face_beg_col
= hpos
;
12745 hlinfo
->mouse_face_beg_row
= vpos
;
12746 hlinfo
->mouse_face_beg_x
= x
;
12747 hlinfo
->mouse_face_past_end
= false;
12749 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12750 hlinfo
->mouse_face_end_row
= vpos
;
12751 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12752 hlinfo
->mouse_face_window
= window
;
12753 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12755 /* Display it as active. */
12756 show_mouse_face (hlinfo
, draw
);
12761 /* Set help_echo_string to a help string to display for this tool-bar item.
12762 XTread_socket does the rest. */
12763 help_echo_object
= help_echo_window
= Qnil
;
12764 help_echo_pos
= -1;
12765 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12766 if (NILP (help_echo_string
))
12767 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12770 #endif /* !USE_GTK && !HAVE_NS */
12772 #endif /* HAVE_WINDOW_SYSTEM */
12776 /************************************************************************
12777 Horizontal scrolling
12778 ************************************************************************/
12780 /* For all leaf windows in the window tree rooted at WINDOW, set their
12781 hscroll value so that PT is (i) visible in the window, and (ii) so
12782 that it is not within a certain margin at the window's left and
12783 right border. Value is true if any window's hscroll has been
12787 hscroll_window_tree (Lisp_Object window
)
12789 bool hscrolled_p
= false;
12790 bool hscroll_relative_p
= FLOATP (Vhscroll_step
);
12791 int hscroll_step_abs
= 0;
12792 double hscroll_step_rel
= 0;
12794 if (hscroll_relative_p
)
12796 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12797 if (hscroll_step_rel
< 0)
12799 hscroll_relative_p
= false;
12800 hscroll_step_abs
= 0;
12803 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12805 hscroll_step_abs
= XINT (Vhscroll_step
);
12806 if (hscroll_step_abs
< 0)
12807 hscroll_step_abs
= 0;
12810 hscroll_step_abs
= 0;
12812 while (WINDOWP (window
))
12814 struct window
*w
= XWINDOW (window
);
12816 if (WINDOWP (w
->contents
))
12817 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12818 else if (w
->cursor
.vpos
>= 0)
12821 int text_area_width
;
12822 struct glyph_row
*cursor_row
;
12823 struct glyph_row
*bottom_row
;
12825 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12826 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12827 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12829 cursor_row
= bottom_row
- 1;
12831 if (!cursor_row
->enabled_p
)
12833 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12834 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12835 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12837 cursor_row
= bottom_row
- 1;
12839 bool row_r2l_p
= cursor_row
->reversed_p
;
12841 text_area_width
= window_box_width (w
, TEXT_AREA
);
12843 /* Scroll when cursor is inside this scroll margin. */
12844 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12846 /* If the position of this window's point has explicitly
12847 changed, no more suspend auto hscrolling. */
12848 if (NILP (Fequal (Fwindow_point (window
), Fwindow_old_point (window
))))
12849 w
->suspend_auto_hscroll
= false;
12851 /* Remember window point. */
12852 Fset_marker (w
->old_pointm
,
12853 ((w
== XWINDOW (selected_window
))
12854 ? make_number (BUF_PT (XBUFFER (w
->contents
)))
12855 : Fmarker_position (w
->pointm
)),
12858 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12859 && !w
->suspend_auto_hscroll
12860 /* In some pathological cases, like restoring a window
12861 configuration into a frame that is much smaller than
12862 the one from which the configuration was saved, we
12863 get glyph rows whose start and end have zero buffer
12864 positions, which we cannot handle below. Just skip
12866 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12867 /* For left-to-right rows, hscroll when cursor is either
12868 (i) inside the right hscroll margin, or (ii) if it is
12869 inside the left margin and the window is already
12872 && ((w
->hscroll
&& w
->cursor
.x
<= h_margin
)
12873 || (cursor_row
->enabled_p
12874 && cursor_row
->truncated_on_right_p
12875 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12876 /* For right-to-left rows, the logic is similar,
12877 except that rules for scrolling to left and right
12878 are reversed. E.g., if cursor.x <= h_margin, we
12879 need to hscroll "to the right" unconditionally,
12880 and that will scroll the screen to the left so as
12881 to reveal the next portion of the row. */
12883 && ((cursor_row
->enabled_p
12884 /* FIXME: It is confusing to set the
12885 truncated_on_right_p flag when R2L rows
12886 are actually truncated on the left. */
12887 && cursor_row
->truncated_on_right_p
12888 && w
->cursor
.x
<= h_margin
)
12890 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12894 struct buffer
*saved_current_buffer
;
12898 /* Find point in a display of infinite width. */
12899 saved_current_buffer
= current_buffer
;
12900 current_buffer
= XBUFFER (w
->contents
);
12902 if (w
== XWINDOW (selected_window
))
12905 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12907 /* Move iterator to pt starting at cursor_row->start in
12908 a line with infinite width. */
12909 init_to_row_start (&it
, w
, cursor_row
);
12910 it
.last_visible_x
= INFINITY
;
12911 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12912 current_buffer
= saved_current_buffer
;
12914 /* Position cursor in window. */
12915 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12916 hscroll
= max (0, (it
.current_x
12917 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12918 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12919 : (text_area_width
/ 2))))
12920 / FRAME_COLUMN_WIDTH (it
.f
);
12921 else if ((!row_r2l_p
12922 && w
->cursor
.x
>= text_area_width
- h_margin
)
12923 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12925 if (hscroll_relative_p
)
12926 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12929 wanted_x
= text_area_width
12930 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12933 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12937 if (hscroll_relative_p
)
12938 wanted_x
= text_area_width
* hscroll_step_rel
12941 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12944 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12946 hscroll
= max (hscroll
, w
->min_hscroll
);
12948 /* Don't prevent redisplay optimizations if hscroll
12949 hasn't changed, as it will unnecessarily slow down
12951 if (w
->hscroll
!= hscroll
)
12953 struct buffer
*b
= XBUFFER (w
->contents
);
12954 b
->prevent_redisplay_optimizations_p
= true;
12955 w
->hscroll
= hscroll
;
12956 hscrolled_p
= true;
12964 /* Value is true if hscroll of any leaf window has been changed. */
12965 return hscrolled_p
;
12969 /* Set hscroll so that cursor is visible and not inside horizontal
12970 scroll margins for all windows in the tree rooted at WINDOW. See
12971 also hscroll_window_tree above. Value is true if any window's
12972 hscroll has been changed. If it has, desired matrices on the frame
12973 of WINDOW are cleared. */
12976 hscroll_windows (Lisp_Object window
)
12978 bool hscrolled_p
= hscroll_window_tree (window
);
12980 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12981 return hscrolled_p
;
12986 /************************************************************************
12988 ************************************************************************/
12990 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined.
12991 This is sometimes handy to have in a debugger session. */
12995 /* First and last unchanged row for try_window_id. */
12997 static int debug_first_unchanged_at_end_vpos
;
12998 static int debug_last_unchanged_at_beg_vpos
;
13000 /* Delta vpos and y. */
13002 static int debug_dvpos
, debug_dy
;
13004 /* Delta in characters and bytes for try_window_id. */
13006 static ptrdiff_t debug_delta
, debug_delta_bytes
;
13008 /* Values of window_end_pos and window_end_vpos at the end of
13011 static ptrdiff_t debug_end_vpos
;
13013 /* Append a string to W->desired_matrix->method. FMT is a printf
13014 format string. If trace_redisplay_p is true also printf the
13015 resulting string to stderr. */
13017 static void debug_method_add (struct window
*, char const *, ...)
13018 ATTRIBUTE_FORMAT_PRINTF (2, 3);
13021 debug_method_add (struct window
*w
, char const *fmt
, ...)
13024 char *method
= w
->desired_matrix
->method
;
13025 int len
= strlen (method
);
13026 int size
= sizeof w
->desired_matrix
->method
;
13027 int remaining
= size
- len
- 1;
13030 if (len
&& remaining
)
13033 --remaining
, ++len
;
13036 va_start (ap
, fmt
);
13037 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
13040 if (trace_redisplay_p
)
13041 fprintf (stderr
, "%p (%s): %s\n",
13043 ((BUFFERP (w
->contents
)
13044 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
13045 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13050 #endif /* GLYPH_DEBUG */
13053 /* Value is true if all changes in window W, which displays
13054 current_buffer, are in the text between START and END. START is a
13055 buffer position, END is given as a distance from Z. Used in
13056 redisplay_internal for display optimization. */
13059 text_outside_line_unchanged_p (struct window
*w
,
13060 ptrdiff_t start
, ptrdiff_t end
)
13062 bool unchanged_p
= true;
13064 /* If text or overlays have changed, see where. */
13065 if (window_outdated (w
))
13067 /* Gap in the line? */
13068 if (GPT
< start
|| Z
- GPT
< end
)
13069 unchanged_p
= false;
13071 /* Changes start in front of the line, or end after it? */
13073 && (BEG_UNCHANGED
< start
- 1
13074 || END_UNCHANGED
< end
))
13075 unchanged_p
= false;
13077 /* If selective display, can't optimize if changes start at the
13078 beginning of the line. */
13080 && INTEGERP (BVAR (current_buffer
, selective_display
))
13081 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13082 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13083 unchanged_p
= false;
13085 /* If there are overlays at the start or end of the line, these
13086 may have overlay strings with newlines in them. A change at
13087 START, for instance, may actually concern the display of such
13088 overlay strings as well, and they are displayed on different
13089 lines. So, quickly rule out this case. (For the future, it
13090 might be desirable to implement something more telling than
13091 just BEG/END_UNCHANGED.) */
13094 if (BEG
+ BEG_UNCHANGED
== start
13095 && overlay_touches_p (start
))
13096 unchanged_p
= false;
13097 if (END_UNCHANGED
== end
13098 && overlay_touches_p (Z
- end
))
13099 unchanged_p
= false;
13102 /* Under bidi reordering, adding or deleting a character in the
13103 beginning of a paragraph, before the first strong directional
13104 character, can change the base direction of the paragraph (unless
13105 the buffer specifies a fixed paragraph direction), which will
13106 require to redisplay the whole paragraph. It might be worthwhile
13107 to find the paragraph limits and widen the range of redisplayed
13108 lines to that, but for now just give up this optimization. */
13109 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13110 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13111 unchanged_p
= false;
13114 return unchanged_p
;
13118 /* Do a frame update, taking possible shortcuts into account. This is
13119 the main external entry point for redisplay.
13121 If the last redisplay displayed an echo area message and that message
13122 is no longer requested, we clear the echo area or bring back the
13123 mini-buffer if that is in use. */
13128 redisplay_internal ();
13133 overlay_arrow_string_or_property (Lisp_Object var
)
13137 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13140 return Voverlay_arrow_string
;
13143 /* Return true if there are any overlay-arrows in current_buffer. */
13145 overlay_arrow_in_current_buffer_p (void)
13149 for (vlist
= Voverlay_arrow_variable_list
;
13151 vlist
= XCDR (vlist
))
13153 Lisp_Object var
= XCAR (vlist
);
13156 if (!SYMBOLP (var
))
13158 val
= find_symbol_value (var
);
13160 && current_buffer
== XMARKER (val
)->buffer
)
13167 /* Return true if any overlay_arrows have moved or overlay-arrow-string
13171 overlay_arrows_changed_p (void)
13175 for (vlist
= Voverlay_arrow_variable_list
;
13177 vlist
= XCDR (vlist
))
13179 Lisp_Object var
= XCAR (vlist
);
13180 Lisp_Object val
, pstr
;
13182 if (!SYMBOLP (var
))
13184 val
= find_symbol_value (var
);
13185 if (!MARKERP (val
))
13187 if (! EQ (COERCE_MARKER (val
),
13188 Fget (var
, Qlast_arrow_position
))
13189 || ! (pstr
= overlay_arrow_string_or_property (var
),
13190 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13196 /* Mark overlay arrows to be updated on next redisplay. */
13199 update_overlay_arrows (int up_to_date
)
13203 for (vlist
= Voverlay_arrow_variable_list
;
13205 vlist
= XCDR (vlist
))
13207 Lisp_Object var
= XCAR (vlist
);
13209 if (!SYMBOLP (var
))
13212 if (up_to_date
> 0)
13214 Lisp_Object val
= find_symbol_value (var
);
13215 Fput (var
, Qlast_arrow_position
,
13216 COERCE_MARKER (val
));
13217 Fput (var
, Qlast_arrow_string
,
13218 overlay_arrow_string_or_property (var
));
13220 else if (up_to_date
< 0
13221 || !NILP (Fget (var
, Qlast_arrow_position
)))
13223 Fput (var
, Qlast_arrow_position
, Qt
);
13224 Fput (var
, Qlast_arrow_string
, Qt
);
13230 /* Return overlay arrow string to display at row.
13231 Return integer (bitmap number) for arrow bitmap in left fringe.
13232 Return nil if no overlay arrow. */
13235 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13239 for (vlist
= Voverlay_arrow_variable_list
;
13241 vlist
= XCDR (vlist
))
13243 Lisp_Object var
= XCAR (vlist
);
13246 if (!SYMBOLP (var
))
13249 val
= find_symbol_value (var
);
13252 && current_buffer
== XMARKER (val
)->buffer
13253 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13255 if (FRAME_WINDOW_P (it
->f
)
13256 /* FIXME: if ROW->reversed_p is set, this should test
13257 the right fringe, not the left one. */
13258 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13260 #ifdef HAVE_WINDOW_SYSTEM
13261 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13263 int fringe_bitmap
= lookup_fringe_bitmap (val
);
13264 if (fringe_bitmap
!= 0)
13265 return make_number (fringe_bitmap
);
13268 return make_number (-1); /* Use default arrow bitmap. */
13270 return overlay_arrow_string_or_property (var
);
13277 /* Return true if point moved out of or into a composition. Otherwise
13278 return false. PREV_BUF and PREV_PT are the last point buffer and
13279 position. BUF and PT are the current point buffer and position. */
13282 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13283 struct buffer
*buf
, ptrdiff_t pt
)
13285 ptrdiff_t start
, end
;
13287 Lisp_Object buffer
;
13289 XSETBUFFER (buffer
, buf
);
13290 /* Check a composition at the last point if point moved within the
13292 if (prev_buf
== buf
)
13295 /* Point didn't move. */
13298 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13299 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13300 && composition_valid_p (start
, end
, prop
)
13301 && start
< prev_pt
&& end
> prev_pt
)
13302 /* The last point was within the composition. Return true iff
13303 point moved out of the composition. */
13304 return (pt
<= start
|| pt
>= end
);
13307 /* Check a composition at the current point. */
13308 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13309 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13310 && composition_valid_p (start
, end
, prop
)
13311 && start
< pt
&& end
> pt
);
13314 /* Reconsider the clip changes of buffer which is displayed in W. */
13317 reconsider_clip_changes (struct window
*w
)
13319 struct buffer
*b
= XBUFFER (w
->contents
);
13321 if (b
->clip_changed
13322 && w
->window_end_valid
13323 && w
->current_matrix
->buffer
== b
13324 && w
->current_matrix
->zv
== BUF_ZV (b
)
13325 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13326 b
->clip_changed
= false;
13328 /* If display wasn't paused, and W is not a tool bar window, see if
13329 point has been moved into or out of a composition. In that case,
13330 set b->clip_changed to force updating the screen. If
13331 b->clip_changed has already been set, skip this check. */
13332 if (!b
->clip_changed
&& w
->window_end_valid
)
13334 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13335 ? PT
: marker_position (w
->pointm
));
13337 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13338 && check_point_in_composition (w
->current_matrix
->buffer
,
13339 w
->last_point
, b
, pt
))
13340 b
->clip_changed
= true;
13345 propagate_buffer_redisplay (void)
13346 { /* Resetting b->text->redisplay is problematic!
13347 We can't just reset it in the case that some window that displays
13348 it has not been redisplayed; and such a window can stay
13349 unredisplayed for a long time if it's currently invisible.
13350 But we do want to reset it at the end of redisplay otherwise
13351 its displayed windows will keep being redisplayed over and over
13353 So we copy all b->text->redisplay flags up to their windows here,
13354 such that mark_window_display_accurate can safely reset
13355 b->text->redisplay. */
13356 Lisp_Object ws
= window_list ();
13357 for (; CONSP (ws
); ws
= XCDR (ws
))
13359 struct window
*thisw
= XWINDOW (XCAR (ws
));
13360 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13361 if (thisb
->text
->redisplay
)
13362 thisw
->redisplay
= true;
13366 #define STOP_POLLING \
13367 do { if (! polling_stopped_here) stop_polling (); \
13368 polling_stopped_here = true; } while (false)
13370 #define RESUME_POLLING \
13371 do { if (polling_stopped_here) start_polling (); \
13372 polling_stopped_here = false; } while (false)
13375 /* Perhaps in the future avoid recentering windows if it
13376 is not necessary; currently that causes some problems. */
13379 redisplay_internal (void)
13381 struct window
*w
= XWINDOW (selected_window
);
13385 bool must_finish
= false, match_p
;
13386 struct text_pos tlbufpos
, tlendpos
;
13387 int number_of_visible_frames
;
13390 bool polling_stopped_here
= false;
13391 Lisp_Object tail
, frame
;
13393 /* True means redisplay has to consider all windows on all
13394 frames. False, only selected_window is considered. */
13395 bool consider_all_windows_p
;
13397 /* True means redisplay has to redisplay the miniwindow. */
13398 bool update_miniwindow_p
= false;
13400 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13402 /* No redisplay if running in batch mode or frame is not yet fully
13403 initialized, or redisplay is explicitly turned off by setting
13404 Vinhibit_redisplay. */
13405 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13406 || !NILP (Vinhibit_redisplay
))
13409 /* Don't examine these until after testing Vinhibit_redisplay.
13410 When Emacs is shutting down, perhaps because its connection to
13411 X has dropped, we should not look at them at all. */
13412 fr
= XFRAME (w
->frame
);
13413 sf
= SELECTED_FRAME ();
13415 if (!fr
->glyphs_initialized_p
)
13418 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13419 if (popup_activated ())
13423 /* I don't think this happens but let's be paranoid. */
13424 if (redisplaying_p
)
13427 /* Record a function that clears redisplaying_p
13428 when we leave this function. */
13429 count
= SPECPDL_INDEX ();
13430 record_unwind_protect_void (unwind_redisplay
);
13431 redisplaying_p
= true;
13432 specbind (Qinhibit_free_realized_faces
, Qnil
);
13434 /* Record this function, so it appears on the profiler's backtraces. */
13435 record_in_backtrace (Qredisplay_internal
, 0, 0);
13437 FOR_EACH_FRAME (tail
, frame
)
13438 XFRAME (frame
)->already_hscrolled_p
= false;
13441 /* Remember the currently selected window. */
13445 forget_escape_and_glyphless_faces ();
13447 inhibit_free_realized_faces
= false;
13449 /* If face_change, init_iterator will free all realized faces, which
13450 includes the faces referenced from current matrices. So, we
13451 can't reuse current matrices in this case. */
13453 windows_or_buffers_changed
= 47;
13455 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13456 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13458 /* Since frames on a single ASCII terminal share the same
13459 display area, displaying a different frame means redisplay
13460 the whole thing. */
13461 SET_FRAME_GARBAGED (sf
);
13463 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13465 FRAME_TTY (sf
)->previous_frame
= sf
;
13468 /* Set the visible flags for all frames. Do this before checking for
13469 resized or garbaged frames; they want to know if their frames are
13470 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13471 number_of_visible_frames
= 0;
13473 FOR_EACH_FRAME (tail
, frame
)
13475 struct frame
*f
= XFRAME (frame
);
13477 if (FRAME_VISIBLE_P (f
))
13479 ++number_of_visible_frames
;
13480 /* Adjust matrices for visible frames only. */
13481 if (f
->fonts_changed
)
13483 adjust_frame_glyphs (f
);
13484 /* Disable all redisplay optimizations for this frame.
13485 This is because adjust_frame_glyphs resets the
13486 enabled_p flag for all glyph rows of all windows, so
13487 many optimizations will fail anyway, and some might
13488 fail to test that flag and do bogus things as
13490 SET_FRAME_GARBAGED (f
);
13491 f
->fonts_changed
= false;
13493 /* If cursor type has been changed on the frame
13494 other than selected, consider all frames. */
13495 if (f
!= sf
&& f
->cursor_type_changed
)
13496 fset_redisplay (f
);
13498 clear_desired_matrices (f
);
13501 /* Notice any pending interrupt request to change frame size. */
13502 do_pending_window_change (true);
13504 /* do_pending_window_change could change the selected_window due to
13505 frame resizing which makes the selected window too small. */
13506 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13509 /* Clear frames marked as garbaged. */
13510 clear_garbaged_frames ();
13512 /* Build menubar and tool-bar items. */
13513 if (NILP (Vmemory_full
))
13514 prepare_menu_bars ();
13516 reconsider_clip_changes (w
);
13518 /* In most cases selected window displays current buffer. */
13519 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13522 /* Detect case that we need to write or remove a star in the mode line. */
13523 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13524 w
->update_mode_line
= true;
13526 if (mode_line_update_needed (w
))
13527 w
->update_mode_line
= true;
13529 /* If reconsider_clip_changes above decided that the narrowing
13530 in the current buffer changed, make sure all other windows
13531 showing that buffer will be redisplayed. */
13532 if (current_buffer
->clip_changed
)
13533 bset_update_mode_line (current_buffer
);
13536 /* Normally the message* functions will have already displayed and
13537 updated the echo area, but the frame may have been trashed, or
13538 the update may have been preempted, so display the echo area
13539 again here. Checking message_cleared_p captures the case that
13540 the echo area should be cleared. */
13541 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13542 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13543 || (message_cleared_p
13544 && minibuf_level
== 0
13545 /* If the mini-window is currently selected, this means the
13546 echo-area doesn't show through. */
13547 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13549 echo_area_display (false);
13551 /* If echo_area_display resizes the mini-window, the redisplay and
13552 window_sizes_changed flags of the selected frame are set, but
13553 it's too late for the hooks in window-size-change-functions,
13554 which have been examined already in prepare_menu_bars. So in
13555 that case we call the hooks here only for the selected frame. */
13556 if (sf
->redisplay
&& FRAME_WINDOW_SIZES_CHANGED (sf
))
13558 Lisp_Object functions
;
13559 ptrdiff_t count1
= SPECPDL_INDEX ();
13561 record_unwind_save_match_data ();
13563 /* Clear flag first in case we get an error below. */
13564 FRAME_WINDOW_SIZES_CHANGED (sf
) = false;
13565 functions
= Vwindow_size_change_functions
;
13567 while (CONSP (functions
))
13569 if (!EQ (XCAR (functions
), Qt
))
13570 call1 (XCAR (functions
), selected_frame
);
13571 functions
= XCDR (functions
);
13574 unbind_to (count1
, Qnil
);
13577 if (message_cleared_p
)
13578 update_miniwindow_p
= true;
13580 must_finish
= true;
13582 /* If we don't display the current message, don't clear the
13583 message_cleared_p flag, because, if we did, we wouldn't clear
13584 the echo area in the next redisplay which doesn't preserve
13586 if (!display_last_displayed_message_p
)
13587 message_cleared_p
= false;
13589 else if (EQ (selected_window
, minibuf_window
)
13590 && (current_buffer
->clip_changed
|| window_outdated (w
))
13591 && resize_mini_window (w
, false))
13595 Lisp_Object functions
;
13596 ptrdiff_t count1
= SPECPDL_INDEX ();
13598 record_unwind_save_match_data ();
13600 /* Clear flag first in case we get an error below. */
13601 FRAME_WINDOW_SIZES_CHANGED (sf
) = false;
13602 functions
= Vwindow_size_change_functions
;
13604 while (CONSP (functions
))
13606 if (!EQ (XCAR (functions
), Qt
))
13607 call1 (XCAR (functions
), selected_frame
);
13608 functions
= XCDR (functions
);
13611 unbind_to (count1
, Qnil
);
13614 /* Resized active mini-window to fit the size of what it is
13615 showing if its contents might have changed. */
13616 must_finish
= true;
13618 /* If window configuration was changed, frames may have been
13619 marked garbaged. Clear them or we will experience
13620 surprises wrt scrolling. */
13621 clear_garbaged_frames ();
13624 if (windows_or_buffers_changed
&& !update_mode_lines
)
13625 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13626 only the windows's contents needs to be refreshed, or whether the
13627 mode-lines also need a refresh. */
13628 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13629 ? REDISPLAY_SOME
: 32);
13631 /* If specs for an arrow have changed, do thorough redisplay
13632 to ensure we remove any arrow that should no longer exist. */
13633 if (overlay_arrows_changed_p ())
13634 /* Apparently, this is the only case where we update other windows,
13635 without updating other mode-lines. */
13636 windows_or_buffers_changed
= 49;
13638 consider_all_windows_p
= (update_mode_lines
13639 || windows_or_buffers_changed
);
13641 #define AINC(a,i) \
13643 Lisp_Object entry = Fgethash (make_number (i), a, make_number (0)); \
13644 if (INTEGERP (entry)) \
13645 Fputhash (make_number (i), make_number (1 + XINT (entry)), a); \
13648 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13649 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13651 /* Optimize the case that only the line containing the cursor in the
13652 selected window has changed. Variables starting with this_ are
13653 set in display_line and record information about the line
13654 containing the cursor. */
13655 tlbufpos
= this_line_start_pos
;
13656 tlendpos
= this_line_end_pos
;
13657 if (!consider_all_windows_p
13658 && CHARPOS (tlbufpos
) > 0
13659 && !w
->update_mode_line
13660 && !current_buffer
->clip_changed
13661 && !current_buffer
->prevent_redisplay_optimizations_p
13662 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13663 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13664 && !XFRAME (w
->frame
)->cursor_type_changed
13665 && !XFRAME (w
->frame
)->face_change
13666 /* Make sure recorded data applies to current buffer, etc. */
13667 && this_line_buffer
== current_buffer
13670 && !w
->optional_new_start
13671 /* Point must be on the line that we have info recorded about. */
13672 && PT
>= CHARPOS (tlbufpos
)
13673 && PT
<= Z
- CHARPOS (tlendpos
)
13674 /* All text outside that line, including its final newline,
13675 must be unchanged. */
13676 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13677 CHARPOS (tlendpos
)))
13679 if (CHARPOS (tlbufpos
) > BEGV
13680 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13681 && (CHARPOS (tlbufpos
) == ZV
13682 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13683 /* Former continuation line has disappeared by becoming empty. */
13685 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13687 /* We have to handle the case of continuation around a
13688 wide-column character (see the comment in indent.c around
13691 For instance, in the following case:
13693 -------- Insert --------
13694 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13695 J_I_ ==> J_I_ `^^' are cursors.
13699 As we have to redraw the line above, we cannot use this
13703 int line_height_before
= this_line_pixel_height
;
13705 /* Note that start_display will handle the case that the
13706 line starting at tlbufpos is a continuation line. */
13707 start_display (&it
, w
, tlbufpos
);
13709 /* Implementation note: It this still necessary? */
13710 if (it
.current_x
!= this_line_start_x
)
13713 TRACE ((stderr
, "trying display optimization 1\n"));
13714 w
->cursor
.vpos
= -1;
13715 overlay_arrow_seen
= false;
13716 it
.vpos
= this_line_vpos
;
13717 it
.current_y
= this_line_y
;
13718 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13719 display_line (&it
);
13721 /* If line contains point, is not continued,
13722 and ends at same distance from eob as before, we win. */
13723 if (w
->cursor
.vpos
>= 0
13724 /* Line is not continued, otherwise this_line_start_pos
13725 would have been set to 0 in display_line. */
13726 && CHARPOS (this_line_start_pos
)
13727 /* Line ends as before. */
13728 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13729 /* Line has same height as before. Otherwise other lines
13730 would have to be shifted up or down. */
13731 && this_line_pixel_height
== line_height_before
)
13733 /* If this is not the window's last line, we must adjust
13734 the charstarts of the lines below. */
13735 if (it
.current_y
< it
.last_visible_y
)
13737 struct glyph_row
*row
13738 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13739 ptrdiff_t delta
, delta_bytes
;
13741 /* We used to distinguish between two cases here,
13742 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13743 when the line ends in a newline or the end of the
13744 buffer's accessible portion. But both cases did
13745 the same, so they were collapsed. */
13747 - CHARPOS (tlendpos
)
13748 - MATRIX_ROW_START_CHARPOS (row
));
13749 delta_bytes
= (Z_BYTE
13750 - BYTEPOS (tlendpos
)
13751 - MATRIX_ROW_START_BYTEPOS (row
));
13753 increment_matrix_positions (w
->current_matrix
,
13754 this_line_vpos
+ 1,
13755 w
->current_matrix
->nrows
,
13756 delta
, delta_bytes
);
13759 /* If this row displays text now but previously didn't,
13760 or vice versa, w->window_end_vpos may have to be
13762 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13764 if (w
->window_end_vpos
< this_line_vpos
)
13765 w
->window_end_vpos
= this_line_vpos
;
13767 else if (w
->window_end_vpos
== this_line_vpos
13768 && this_line_vpos
> 0)
13769 w
->window_end_vpos
= this_line_vpos
- 1;
13770 w
->window_end_valid
= false;
13772 /* Update hint: No need to try to scroll in update_window. */
13773 w
->desired_matrix
->no_scrolling_p
= true;
13776 *w
->desired_matrix
->method
= 0;
13777 debug_method_add (w
, "optimization 1");
13779 #ifdef HAVE_WINDOW_SYSTEM
13780 update_window_fringes (w
, false);
13787 else if (/* Cursor position hasn't changed. */
13788 PT
== w
->last_point
13789 /* Make sure the cursor was last displayed
13790 in this window. Otherwise we have to reposition it. */
13792 /* PXW: Must be converted to pixels, probably. */
13793 && 0 <= w
->cursor
.vpos
13794 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13798 do_pending_window_change (true);
13799 /* If selected_window changed, redisplay again. */
13800 if (WINDOWP (selected_window
)
13801 && (w
= XWINDOW (selected_window
)) != sw
)
13804 /* We used to always goto end_of_redisplay here, but this
13805 isn't enough if we have a blinking cursor. */
13806 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13807 goto end_of_redisplay
;
13811 /* If highlighting the region, or if the cursor is in the echo area,
13812 then we can't just move the cursor. */
13813 else if (NILP (Vshow_trailing_whitespace
)
13814 && !cursor_in_echo_area
)
13817 struct glyph_row
*row
;
13819 /* Skip from tlbufpos to PT and see where it is. Note that
13820 PT may be in invisible text. If so, we will end at the
13821 next visible position. */
13822 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13823 NULL
, DEFAULT_FACE_ID
);
13824 it
.current_x
= this_line_start_x
;
13825 it
.current_y
= this_line_y
;
13826 it
.vpos
= this_line_vpos
;
13828 /* The call to move_it_to stops in front of PT, but
13829 moves over before-strings. */
13830 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13832 if (it
.vpos
== this_line_vpos
13833 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13836 eassert (this_line_vpos
== it
.vpos
);
13837 eassert (this_line_y
== it
.current_y
);
13838 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13840 *w
->desired_matrix
->method
= 0;
13841 debug_method_add (w
, "optimization 3");
13850 /* Text changed drastically or point moved off of line. */
13851 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13854 CHARPOS (this_line_start_pos
) = 0;
13855 ++clear_face_cache_count
;
13856 #ifdef HAVE_WINDOW_SYSTEM
13857 ++clear_image_cache_count
;
13860 /* Build desired matrices, and update the display. If
13861 consider_all_windows_p, do it for all windows on all frames that
13862 require redisplay, as specified by their 'redisplay' flag.
13863 Otherwise do it for selected_window, only. */
13865 if (consider_all_windows_p
)
13867 FOR_EACH_FRAME (tail
, frame
)
13868 XFRAME (frame
)->updated_p
= false;
13870 propagate_buffer_redisplay ();
13872 FOR_EACH_FRAME (tail
, frame
)
13874 struct frame
*f
= XFRAME (frame
);
13876 /* We don't have to do anything for unselected terminal
13878 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13879 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13883 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13886 /* Only GC scrollbars when we redisplay the whole frame. */
13887 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13888 bool f_redisplay_flag
= f
->redisplay
;
13889 /* Mark all the scroll bars to be removed; we'll redeem
13890 the ones we want when we redisplay their windows. */
13891 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13892 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13894 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13895 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13896 /* Remember that the invisible frames need to be redisplayed next
13897 time they're visible. */
13898 else if (!REDISPLAY_SOME_P ())
13899 f
->redisplay
= true;
13901 /* The X error handler may have deleted that frame. */
13902 if (!FRAME_LIVE_P (f
))
13905 /* Any scroll bars which redisplay_windows should have
13906 nuked should now go away. */
13907 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13908 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13910 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13912 /* If fonts changed on visible frame, display again. */
13913 if (f
->fonts_changed
)
13915 adjust_frame_glyphs (f
);
13916 /* Disable all redisplay optimizations for this
13917 frame. For the reasons, see the comment near
13918 the previous call to adjust_frame_glyphs above. */
13919 SET_FRAME_GARBAGED (f
);
13920 f
->fonts_changed
= false;
13924 /* See if we have to hscroll. */
13925 if (!f
->already_hscrolled_p
)
13927 f
->already_hscrolled_p
= true;
13928 if (hscroll_windows (f
->root_window
))
13932 /* If the frame's redisplay flag was not set before
13933 we went about redisplaying its windows, but it is
13934 set now, that means we employed some redisplay
13935 optimizations inside redisplay_windows, and
13936 bypassed producing some screen lines. But if
13937 f->redisplay is now set, it might mean the old
13938 faces are no longer valid (e.g., if redisplaying
13939 some window called some Lisp which defined a new
13940 face or redefined an existing face), so trying to
13941 use them in update_frame will segfault.
13942 Therefore, we must redisplay this frame. */
13943 if (!f_redisplay_flag
&& f
->redisplay
)
13946 /* Prevent various kinds of signals during display
13947 update. stdio is not robust about handling
13948 signals, which can cause an apparent I/O error. */
13949 if (interrupt_input
)
13950 unrequest_sigio ();
13953 pending
|= update_frame (f
, false, false);
13954 f
->cursor_type_changed
= false;
13955 f
->updated_p
= true;
13960 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13964 /* Do the mark_window_display_accurate after all windows have
13965 been redisplayed because this call resets flags in buffers
13966 which are needed for proper redisplay. */
13967 FOR_EACH_FRAME (tail
, frame
)
13969 struct frame
*f
= XFRAME (frame
);
13972 f
->redisplay
= false;
13973 mark_window_display_accurate (f
->root_window
, true);
13974 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13975 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13980 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13982 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13983 struct frame
*mini_frame
;
13985 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13986 /* Use list_of_error, not Qerror, so that
13987 we catch only errors and don't run the debugger. */
13988 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13990 redisplay_window_error
);
13991 if (update_miniwindow_p
)
13992 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13994 redisplay_window_error
);
13996 /* Compare desired and current matrices, perform output. */
13999 /* If fonts changed, display again. Likewise if redisplay_window_1
14000 above caused some change (e.g., a change in faces) that requires
14001 considering the entire frame again. */
14002 if (sf
->fonts_changed
|| sf
->redisplay
)
14006 /* Set this to force a more thorough redisplay.
14007 Otherwise, we might immediately loop back to the
14008 above "else-if" clause (since all the conditions that
14009 led here might still be true), and we will then
14010 infloop, because the selected-frame's redisplay flag
14011 is not (and cannot be) reset. */
14012 windows_or_buffers_changed
= 50;
14017 /* Prevent freeing of realized faces, since desired matrices are
14018 pending that reference the faces we computed and cached. */
14019 inhibit_free_realized_faces
= true;
14021 /* Prevent various kinds of signals during display update.
14022 stdio is not robust about handling signals,
14023 which can cause an apparent I/O error. */
14024 if (interrupt_input
)
14025 unrequest_sigio ();
14028 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
14030 if (hscroll_windows (selected_window
))
14033 XWINDOW (selected_window
)->must_be_updated_p
= true;
14034 pending
= update_frame (sf
, false, false);
14035 sf
->cursor_type_changed
= false;
14038 /* We may have called echo_area_display at the top of this
14039 function. If the echo area is on another frame, that may
14040 have put text on a frame other than the selected one, so the
14041 above call to update_frame would not have caught it. Catch
14043 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
14044 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
14046 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
14048 XWINDOW (mini_window
)->must_be_updated_p
= true;
14049 pending
|= update_frame (mini_frame
, false, false);
14050 mini_frame
->cursor_type_changed
= false;
14051 if (!pending
&& hscroll_windows (mini_window
))
14056 /* If display was paused because of pending input, make sure we do a
14057 thorough update the next time. */
14060 /* Prevent the optimization at the beginning of
14061 redisplay_internal that tries a single-line update of the
14062 line containing the cursor in the selected window. */
14063 CHARPOS (this_line_start_pos
) = 0;
14065 /* Let the overlay arrow be updated the next time. */
14066 update_overlay_arrows (0);
14068 /* If we pause after scrolling, some rows in the current
14069 matrices of some windows are not valid. */
14070 if (!WINDOW_FULL_WIDTH_P (w
)
14071 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
14072 update_mode_lines
= 36;
14076 if (!consider_all_windows_p
)
14078 /* This has already been done above if
14079 consider_all_windows_p is set. */
14080 if (XBUFFER (w
->contents
)->text
->redisplay
14081 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
14082 /* This can happen if b->text->redisplay was set during
14084 propagate_buffer_redisplay ();
14085 mark_window_display_accurate_1 (w
, true);
14087 /* Say overlay arrows are up to date. */
14088 update_overlay_arrows (1);
14090 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
14091 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
14094 update_mode_lines
= 0;
14095 windows_or_buffers_changed
= 0;
14098 /* Start SIGIO interrupts coming again. Having them off during the
14099 code above makes it less likely one will discard output, but not
14100 impossible, since there might be stuff in the system buffer here.
14101 But it is much hairier to try to do anything about that. */
14102 if (interrupt_input
)
14106 /* If a frame has become visible which was not before, redisplay
14107 again, so that we display it. Expose events for such a frame
14108 (which it gets when becoming visible) don't call the parts of
14109 redisplay constructing glyphs, so simply exposing a frame won't
14110 display anything in this case. So, we have to display these
14111 frames here explicitly. */
14116 FOR_EACH_FRAME (tail
, frame
)
14118 if (XFRAME (frame
)->visible
)
14122 if (new_count
!= number_of_visible_frames
)
14123 windows_or_buffers_changed
= 52;
14126 /* Change frame size now if a change is pending. */
14127 do_pending_window_change (true);
14129 /* If we just did a pending size change, or have additional
14130 visible frames, or selected_window changed, redisplay again. */
14131 if ((windows_or_buffers_changed
&& !pending
)
14132 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14135 /* Clear the face and image caches.
14137 We used to do this only if consider_all_windows_p. But the cache
14138 needs to be cleared if a timer creates images in the current
14139 buffer (e.g. the test case in Bug#6230). */
14141 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14143 clear_face_cache (false);
14144 clear_face_cache_count
= 0;
14147 #ifdef HAVE_WINDOW_SYSTEM
14148 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14150 clear_image_caches (Qnil
);
14151 clear_image_cache_count
= 0;
14153 #endif /* HAVE_WINDOW_SYSTEM */
14157 ns_set_doc_edited ();
14159 if (interrupt_input
&& interrupts_deferred
)
14162 unbind_to (count
, Qnil
);
14167 /* Redisplay, but leave alone any recent echo area message unless
14168 another message has been requested in its place.
14170 This is useful in situations where you need to redisplay but no
14171 user action has occurred, making it inappropriate for the message
14172 area to be cleared. See tracking_off and
14173 wait_reading_process_output for examples of these situations.
14175 FROM_WHERE is an integer saying from where this function was
14176 called. This is useful for debugging. */
14179 redisplay_preserve_echo_area (int from_where
)
14181 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14183 if (!NILP (echo_area_buffer
[1]))
14185 /* We have a previously displayed message, but no current
14186 message. Redisplay the previous message. */
14187 display_last_displayed_message_p
= true;
14188 redisplay_internal ();
14189 display_last_displayed_message_p
= false;
14192 redisplay_internal ();
14194 flush_frame (SELECTED_FRAME ());
14198 /* Function registered with record_unwind_protect in redisplay_internal. */
14201 unwind_redisplay (void)
14203 redisplaying_p
= false;
14207 /* Mark the display of leaf window W as accurate or inaccurate.
14208 If ACCURATE_P, mark display of W as accurate.
14209 If !ACCURATE_P, arrange for W to be redisplayed the next
14210 time redisplay_internal is called. */
14213 mark_window_display_accurate_1 (struct window
*w
, bool accurate_p
)
14215 struct buffer
*b
= XBUFFER (w
->contents
);
14217 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14218 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14219 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14223 b
->clip_changed
= false;
14224 b
->prevent_redisplay_optimizations_p
= false;
14225 eassert (buffer_window_count (b
) > 0);
14226 /* Resetting b->text->redisplay is problematic!
14227 In order to make it safer to do it here, redisplay_internal must
14228 have copied all b->text->redisplay to their respective windows. */
14229 b
->text
->redisplay
= false;
14231 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14232 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14233 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14234 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14236 w
->current_matrix
->buffer
= b
;
14237 w
->current_matrix
->begv
= BUF_BEGV (b
);
14238 w
->current_matrix
->zv
= BUF_ZV (b
);
14240 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14241 w
->last_cursor_off_p
= w
->cursor_off_p
;
14243 if (w
== XWINDOW (selected_window
))
14244 w
->last_point
= BUF_PT (b
);
14246 w
->last_point
= marker_position (w
->pointm
);
14248 w
->window_end_valid
= true;
14249 w
->update_mode_line
= false;
14252 w
->redisplay
= !accurate_p
;
14256 /* Mark the display of windows in the window tree rooted at WINDOW as
14257 accurate or inaccurate. If ACCURATE_P, mark display of
14258 windows as accurate. If !ACCURATE_P, arrange for windows to
14259 be redisplayed the next time redisplay_internal is called. */
14262 mark_window_display_accurate (Lisp_Object window
, bool accurate_p
)
14266 for (; !NILP (window
); window
= w
->next
)
14268 w
= XWINDOW (window
);
14269 if (WINDOWP (w
->contents
))
14270 mark_window_display_accurate (w
->contents
, accurate_p
);
14272 mark_window_display_accurate_1 (w
, accurate_p
);
14276 update_overlay_arrows (1);
14278 /* Force a thorough redisplay the next time by setting
14279 last_arrow_position and last_arrow_string to t, which is
14280 unequal to any useful value of Voverlay_arrow_... */
14281 update_overlay_arrows (-1);
14285 /* Return value in display table DP (Lisp_Char_Table *) for character
14286 C. Since a display table doesn't have any parent, we don't have to
14287 follow parent. Do not call this function directly but use the
14288 macro DISP_CHAR_VECTOR. */
14291 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14295 if (ASCII_CHAR_P (c
))
14298 if (SUB_CHAR_TABLE_P (val
))
14299 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14305 XSETCHAR_TABLE (table
, dp
);
14306 val
= char_table_ref (table
, c
);
14315 /***********************************************************************
14317 ***********************************************************************/
14319 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14322 redisplay_windows (Lisp_Object window
)
14324 while (!NILP (window
))
14326 struct window
*w
= XWINDOW (window
);
14328 if (WINDOWP (w
->contents
))
14329 redisplay_windows (w
->contents
);
14330 else if (BUFFERP (w
->contents
))
14332 displayed_buffer
= XBUFFER (w
->contents
);
14333 /* Use list_of_error, not Qerror, so that
14334 we catch only errors and don't run the debugger. */
14335 internal_condition_case_1 (redisplay_window_0
, window
,
14337 redisplay_window_error
);
14345 redisplay_window_error (Lisp_Object ignore
)
14347 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14352 redisplay_window_0 (Lisp_Object window
)
14354 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14355 redisplay_window (window
, false);
14360 redisplay_window_1 (Lisp_Object window
)
14362 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14363 redisplay_window (window
, true);
14368 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14369 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14370 which positions recorded in ROW differ from current buffer
14373 Return true iff cursor is on this row. */
14376 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14377 struct glyph_matrix
*matrix
,
14378 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14381 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14382 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14383 struct glyph
*cursor
= NULL
;
14384 /* The last known character position in row. */
14385 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14387 ptrdiff_t pt_old
= PT
- delta
;
14388 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14389 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14390 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14391 /* A glyph beyond the edge of TEXT_AREA which we should never
14393 struct glyph
*glyphs_end
= end
;
14394 /* True means we've found a match for cursor position, but that
14395 glyph has the avoid_cursor_p flag set. */
14396 bool match_with_avoid_cursor
= false;
14397 /* True means we've seen at least one glyph that came from a
14399 bool string_seen
= false;
14400 /* Largest and smallest buffer positions seen so far during scan of
14402 ptrdiff_t bpos_max
= pos_before
;
14403 ptrdiff_t bpos_min
= pos_after
;
14404 /* Last buffer position covered by an overlay string with an integer
14405 `cursor' property. */
14406 ptrdiff_t bpos_covered
= 0;
14407 /* True means the display string on which to display the cursor
14408 comes from a text property, not from an overlay. */
14409 bool string_from_text_prop
= false;
14411 /* Don't even try doing anything if called for a mode-line or
14412 header-line row, since the rest of the code isn't prepared to
14413 deal with such calamities. */
14414 eassert (!row
->mode_line_p
);
14415 if (row
->mode_line_p
)
14418 /* Skip over glyphs not having an object at the start and the end of
14419 the row. These are special glyphs like truncation marks on
14420 terminal frames. */
14421 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14423 if (!row
->reversed_p
)
14426 && NILP (glyph
->object
)
14427 && glyph
->charpos
< 0)
14429 x
+= glyph
->pixel_width
;
14433 && NILP ((end
- 1)->object
)
14434 /* CHARPOS is zero for blanks and stretch glyphs
14435 inserted by extend_face_to_end_of_line. */
14436 && (end
- 1)->charpos
<= 0)
14438 glyph_before
= glyph
- 1;
14445 /* If the glyph row is reversed, we need to process it from back
14446 to front, so swap the edge pointers. */
14447 glyphs_end
= end
= glyph
- 1;
14448 glyph
+= row
->used
[TEXT_AREA
] - 1;
14450 while (glyph
> end
+ 1
14451 && NILP (glyph
->object
)
14452 && glyph
->charpos
< 0)
14455 x
-= glyph
->pixel_width
;
14457 if (NILP (glyph
->object
) && glyph
->charpos
< 0)
14459 /* By default, in reversed rows we put the cursor on the
14460 rightmost (first in the reading order) glyph. */
14461 for (g
= end
+ 1; g
< glyph
; g
++)
14462 x
+= g
->pixel_width
;
14464 && NILP ((end
+ 1)->object
)
14465 && (end
+ 1)->charpos
<= 0)
14467 glyph_before
= glyph
+ 1;
14471 else if (row
->reversed_p
)
14473 /* In R2L rows that don't display text, put the cursor on the
14474 rightmost glyph. Case in point: an empty last line that is
14475 part of an R2L paragraph. */
14477 /* Avoid placing the cursor on the last glyph of the row, where
14478 on terminal frames we hold the vertical border between
14479 adjacent windows. */
14480 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14481 && !WINDOW_RIGHTMOST_P (w
)
14482 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14484 x
= -1; /* will be computed below, at label compute_x */
14487 /* Step 1: Try to find the glyph whose character position
14488 corresponds to point. If that's not possible, find 2 glyphs
14489 whose character positions are the closest to point, one before
14490 point, the other after it. */
14491 if (!row
->reversed_p
)
14492 while (/* not marched to end of glyph row */
14494 /* glyph was not inserted by redisplay for internal purposes */
14495 && !NILP (glyph
->object
))
14497 if (BUFFERP (glyph
->object
))
14499 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14501 if (glyph
->charpos
> bpos_max
)
14502 bpos_max
= glyph
->charpos
;
14503 if (glyph
->charpos
< bpos_min
)
14504 bpos_min
= glyph
->charpos
;
14505 if (!glyph
->avoid_cursor_p
)
14507 /* If we hit point, we've found the glyph on which to
14508 display the cursor. */
14511 match_with_avoid_cursor
= false;
14514 /* See if we've found a better approximation to
14515 POS_BEFORE or to POS_AFTER. */
14516 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14518 pos_before
= glyph
->charpos
;
14519 glyph_before
= glyph
;
14521 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14523 pos_after
= glyph
->charpos
;
14524 glyph_after
= glyph
;
14527 else if (dpos
== 0)
14528 match_with_avoid_cursor
= true;
14530 else if (STRINGP (glyph
->object
))
14532 Lisp_Object chprop
;
14533 ptrdiff_t glyph_pos
= glyph
->charpos
;
14535 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14537 if (!NILP (chprop
))
14539 /* If the string came from a `display' text property,
14540 look up the buffer position of that property and
14541 use that position to update bpos_max, as if we
14542 actually saw such a position in one of the row's
14543 glyphs. This helps with supporting integer values
14544 of `cursor' property on the display string in
14545 situations where most or all of the row's buffer
14546 text is completely covered by display properties,
14547 so that no glyph with valid buffer positions is
14548 ever seen in the row. */
14549 ptrdiff_t prop_pos
=
14550 string_buffer_position_lim (glyph
->object
, pos_before
,
14553 if (prop_pos
>= pos_before
)
14554 bpos_max
= prop_pos
;
14556 if (INTEGERP (chprop
))
14558 bpos_covered
= bpos_max
+ XINT (chprop
);
14559 /* If the `cursor' property covers buffer positions up
14560 to and including point, we should display cursor on
14561 this glyph. Note that, if a `cursor' property on one
14562 of the string's characters has an integer value, we
14563 will break out of the loop below _before_ we get to
14564 the position match above. IOW, integer values of
14565 the `cursor' property override the "exact match for
14566 point" strategy of positioning the cursor. */
14567 /* Implementation note: bpos_max == pt_old when, e.g.,
14568 we are in an empty line, where bpos_max is set to
14569 MATRIX_ROW_START_CHARPOS, see above. */
14570 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14577 string_seen
= true;
14579 x
+= glyph
->pixel_width
;
14582 else if (glyph
> end
) /* row is reversed */
14583 while (!NILP (glyph
->object
))
14585 if (BUFFERP (glyph
->object
))
14587 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14589 if (glyph
->charpos
> bpos_max
)
14590 bpos_max
= glyph
->charpos
;
14591 if (glyph
->charpos
< bpos_min
)
14592 bpos_min
= glyph
->charpos
;
14593 if (!glyph
->avoid_cursor_p
)
14597 match_with_avoid_cursor
= false;
14600 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14602 pos_before
= glyph
->charpos
;
14603 glyph_before
= glyph
;
14605 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14607 pos_after
= glyph
->charpos
;
14608 glyph_after
= glyph
;
14611 else if (dpos
== 0)
14612 match_with_avoid_cursor
= true;
14614 else if (STRINGP (glyph
->object
))
14616 Lisp_Object chprop
;
14617 ptrdiff_t glyph_pos
= glyph
->charpos
;
14619 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14621 if (!NILP (chprop
))
14623 ptrdiff_t prop_pos
=
14624 string_buffer_position_lim (glyph
->object
, pos_before
,
14627 if (prop_pos
>= pos_before
)
14628 bpos_max
= prop_pos
;
14630 if (INTEGERP (chprop
))
14632 bpos_covered
= bpos_max
+ XINT (chprop
);
14633 /* If the `cursor' property covers buffer positions up
14634 to and including point, we should display cursor on
14636 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14642 string_seen
= true;
14645 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14647 x
--; /* can't use any pixel_width */
14650 x
-= glyph
->pixel_width
;
14653 /* Step 2: If we didn't find an exact match for point, we need to
14654 look for a proper place to put the cursor among glyphs between
14655 GLYPH_BEFORE and GLYPH_AFTER. */
14656 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14657 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14658 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14660 /* An empty line has a single glyph whose OBJECT is nil and
14661 whose CHARPOS is the position of a newline on that line.
14662 Note that on a TTY, there are more glyphs after that, which
14663 were produced by extend_face_to_end_of_line, but their
14664 CHARPOS is zero or negative. */
14665 bool empty_line_p
=
14666 ((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14667 && NILP (glyph
->object
) && glyph
->charpos
> 0
14668 /* On a TTY, continued and truncated rows also have a glyph at
14669 their end whose OBJECT is nil and whose CHARPOS is
14670 positive (the continuation and truncation glyphs), but such
14671 rows are obviously not "empty". */
14672 && !(row
->continued_p
|| row
->truncated_on_right_p
));
14674 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14676 ptrdiff_t ellipsis_pos
;
14678 /* Scan back over the ellipsis glyphs. */
14679 if (!row
->reversed_p
)
14681 ellipsis_pos
= (glyph
- 1)->charpos
;
14682 while (glyph
> row
->glyphs
[TEXT_AREA
]
14683 && (glyph
- 1)->charpos
== ellipsis_pos
)
14684 glyph
--, x
-= glyph
->pixel_width
;
14685 /* That loop always goes one position too far, including
14686 the glyph before the ellipsis. So scan forward over
14688 x
+= glyph
->pixel_width
;
14691 else /* row is reversed */
14693 ellipsis_pos
= (glyph
+ 1)->charpos
;
14694 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14695 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14696 glyph
++, x
+= glyph
->pixel_width
;
14697 x
-= glyph
->pixel_width
;
14701 else if (match_with_avoid_cursor
)
14703 cursor
= glyph_after
;
14706 else if (string_seen
)
14708 int incr
= row
->reversed_p
? -1 : +1;
14710 /* Need to find the glyph that came out of a string which is
14711 present at point. That glyph is somewhere between
14712 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14713 positioned between POS_BEFORE and POS_AFTER in the
14715 struct glyph
*start
, *stop
;
14716 ptrdiff_t pos
= pos_before
;
14720 /* If the row ends in a newline from a display string,
14721 reordering could have moved the glyphs belonging to the
14722 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14723 in this case we extend the search to the last glyph in
14724 the row that was not inserted by redisplay. */
14725 if (row
->ends_in_newline_from_string_p
)
14728 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14731 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14732 correspond to POS_BEFORE and POS_AFTER, respectively. We
14733 need START and STOP in the order that corresponds to the
14734 row's direction as given by its reversed_p flag. If the
14735 directionality of characters between POS_BEFORE and
14736 POS_AFTER is the opposite of the row's base direction,
14737 these characters will have been reordered for display,
14738 and we need to reverse START and STOP. */
14739 if (!row
->reversed_p
)
14741 start
= min (glyph_before
, glyph_after
);
14742 stop
= max (glyph_before
, glyph_after
);
14746 start
= max (glyph_before
, glyph_after
);
14747 stop
= min (glyph_before
, glyph_after
);
14749 for (glyph
= start
+ incr
;
14750 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14753 /* Any glyphs that come from the buffer are here because
14754 of bidi reordering. Skip them, and only pay
14755 attention to glyphs that came from some string. */
14756 if (STRINGP (glyph
->object
))
14760 /* If the display property covers the newline, we
14761 need to search for it one position farther. */
14762 ptrdiff_t lim
= pos_after
14763 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14765 string_from_text_prop
= false;
14766 str
= glyph
->object
;
14767 tem
= string_buffer_position_lim (str
, pos
, lim
, false);
14768 if (tem
== 0 /* from overlay */
14771 /* If the string from which this glyph came is
14772 found in the buffer at point, or at position
14773 that is closer to point than pos_after, then
14774 we've found the glyph we've been looking for.
14775 If it comes from an overlay (tem == 0), and
14776 it has the `cursor' property on one of its
14777 glyphs, record that glyph as a candidate for
14778 displaying the cursor. (As in the
14779 unidirectional version, we will display the
14780 cursor on the last candidate we find.) */
14783 || (tem
- pt_old
> 0 && tem
< pos_after
))
14785 /* The glyphs from this string could have
14786 been reordered. Find the one with the
14787 smallest string position. Or there could
14788 be a character in the string with the
14789 `cursor' property, which means display
14790 cursor on that character's glyph. */
14791 ptrdiff_t strpos
= glyph
->charpos
;
14796 string_from_text_prop
= true;
14799 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14800 && EQ (glyph
->object
, str
);
14804 ptrdiff_t gpos
= glyph
->charpos
;
14806 cprop
= Fget_char_property (make_number (gpos
),
14814 if (tem
&& glyph
->charpos
< strpos
)
14816 strpos
= glyph
->charpos
;
14822 || (tem
- pt_old
> 0 && tem
< pos_after
))
14826 pos
= tem
+ 1; /* don't find previous instances */
14828 /* This string is not what we want; skip all of the
14829 glyphs that came from it. */
14830 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14831 && EQ (glyph
->object
, str
))
14838 /* If we reached the end of the line, and END was from a string,
14839 the cursor is not on this line. */
14841 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14842 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14843 && STRINGP (end
->object
)
14844 && row
->continued_p
)
14847 /* A truncated row may not include PT among its character positions.
14848 Setting the cursor inside the scroll margin will trigger
14849 recalculation of hscroll in hscroll_window_tree. But if a
14850 display string covers point, defer to the string-handling
14851 code below to figure this out. */
14852 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14854 cursor
= glyph_before
;
14857 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14858 /* Zero-width characters produce no glyphs. */
14860 && (row
->reversed_p
14861 ? glyph_after
> glyphs_end
14862 : glyph_after
< glyphs_end
)))
14864 cursor
= glyph_after
;
14870 if (cursor
!= NULL
)
14872 else if (glyph
== glyphs_end
14873 && pos_before
== pos_after
14874 && STRINGP ((row
->reversed_p
14875 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14876 : row
->glyphs
[TEXT_AREA
])->object
))
14878 /* If all the glyphs of this row came from strings, put the
14879 cursor on the first glyph of the row. This avoids having the
14880 cursor outside of the text area in this very rare and hard
14884 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14885 : row
->glyphs
[TEXT_AREA
];
14891 /* Need to compute x that corresponds to GLYPH. */
14892 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14894 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14896 x
+= g
->pixel_width
;
14900 /* ROW could be part of a continued line, which, under bidi
14901 reordering, might have other rows whose start and end charpos
14902 occlude point. Only set w->cursor if we found a better
14903 approximation to the cursor position than we have from previously
14904 examined candidate rows belonging to the same continued line. */
14905 if (/* We already have a candidate row. */
14906 w
->cursor
.vpos
>= 0
14907 /* That candidate is not the row we are processing. */
14908 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14909 /* Make sure cursor.vpos specifies a row whose start and end
14910 charpos occlude point, and it is valid candidate for being a
14911 cursor-row. This is because some callers of this function
14912 leave cursor.vpos at the row where the cursor was displayed
14913 during the last redisplay cycle. */
14914 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14915 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14916 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14919 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14921 /* Don't consider glyphs that are outside TEXT_AREA. */
14922 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14924 /* Keep the candidate whose buffer position is the closest to
14925 point or has the `cursor' property. */
14926 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14927 w
->cursor
.hpos
>= 0
14928 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14929 && ((BUFFERP (g1
->object
)
14930 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14931 || (BUFFERP (glyph
->object
)
14932 && eabs (g1
->charpos
- pt_old
)
14933 < eabs (glyph
->charpos
- pt_old
))))
14934 /* Previous candidate is a glyph from a string that has
14935 a non-nil `cursor' property. */
14936 || (STRINGP (g1
->object
)
14937 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14938 Qcursor
, g1
->object
))
14939 /* Previous candidate is from the same display
14940 string as this one, and the display string
14941 came from a text property. */
14942 || (EQ (g1
->object
, glyph
->object
)
14943 && string_from_text_prop
)
14944 /* this candidate is from newline and its
14945 position is not an exact match */
14946 || (NILP (glyph
->object
)
14947 && glyph
->charpos
!= pt_old
)))))
14949 /* If this candidate gives an exact match, use that. */
14950 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14951 /* If this candidate is a glyph created for the
14952 terminating newline of a line, and point is on that
14953 newline, it wins because it's an exact match. */
14954 || (!row
->continued_p
14955 && NILP (glyph
->object
)
14956 && glyph
->charpos
== 0
14957 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14958 /* Otherwise, keep the candidate that comes from a row
14959 spanning less buffer positions. This may win when one or
14960 both candidate positions are on glyphs that came from
14961 display strings, for which we cannot compare buffer
14963 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14964 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14965 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14968 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14970 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14971 w
->cursor
.y
= row
->y
+ dy
;
14973 if (w
== XWINDOW (selected_window
))
14975 if (!row
->continued_p
14976 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14979 this_line_buffer
= XBUFFER (w
->contents
);
14981 CHARPOS (this_line_start_pos
)
14982 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14983 BYTEPOS (this_line_start_pos
)
14984 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14986 CHARPOS (this_line_end_pos
)
14987 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14988 BYTEPOS (this_line_end_pos
)
14989 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14991 this_line_y
= w
->cursor
.y
;
14992 this_line_pixel_height
= row
->height
;
14993 this_line_vpos
= w
->cursor
.vpos
;
14994 this_line_start_x
= row
->x
;
14997 CHARPOS (this_line_start_pos
) = 0;
15004 /* Run window scroll functions, if any, for WINDOW with new window
15005 start STARTP. Sets the window start of WINDOW to that position.
15007 We assume that the window's buffer is really current. */
15009 static struct text_pos
15010 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
15012 struct window
*w
= XWINDOW (window
);
15013 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
15015 eassert (current_buffer
== XBUFFER (w
->contents
));
15017 if (!NILP (Vwindow_scroll_functions
))
15019 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
15020 make_number (CHARPOS (startp
)));
15021 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15022 /* In case the hook functions switch buffers. */
15023 set_buffer_internal (XBUFFER (w
->contents
));
15030 /* Make sure the line containing the cursor is fully visible.
15031 A value of true means there is nothing to be done.
15032 (Either the line is fully visible, or it cannot be made so,
15033 or we cannot tell.)
15035 If FORCE_P, return false even if partial visible cursor row
15036 is higher than window.
15038 If CURRENT_MATRIX_P, use the information from the
15039 window's current glyph matrix; otherwise use the desired glyph
15042 A value of false means the caller should do scrolling
15043 as if point had gone off the screen. */
15046 cursor_row_fully_visible_p (struct window
*w
, bool force_p
,
15047 bool current_matrix_p
)
15049 struct glyph_matrix
*matrix
;
15050 struct glyph_row
*row
;
15053 if (!make_cursor_line_fully_visible_p
)
15056 /* It's not always possible to find the cursor, e.g, when a window
15057 is full of overlay strings. Don't do anything in that case. */
15058 if (w
->cursor
.vpos
< 0)
15061 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
15062 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
15064 /* If the cursor row is not partially visible, there's nothing to do. */
15065 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
15068 /* If the row the cursor is in is taller than the window's height,
15069 it's not clear what to do, so do nothing. */
15070 window_height
= window_box_height (w
);
15071 if (row
->height
>= window_height
)
15073 if (!force_p
|| MINI_WINDOW_P (w
)
15074 || w
->vscroll
|| w
->cursor
.vpos
== 0)
15081 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
15082 means only WINDOW is redisplayed in redisplay_internal.
15083 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
15084 in redisplay_window to bring a partially visible line into view in
15085 the case that only the cursor has moved.
15087 LAST_LINE_MISFIT should be true if we're scrolling because the
15088 last screen line's vertical height extends past the end of the screen.
15092 1 if scrolling succeeded
15094 0 if scrolling didn't find point.
15096 -1 if new fonts have been loaded so that we must interrupt
15097 redisplay, adjust glyph matrices, and try again. */
15103 SCROLLING_NEED_LARGER_MATRICES
15106 /* If scroll-conservatively is more than this, never recenter.
15108 If you change this, don't forget to update the doc string of
15109 `scroll-conservatively' and the Emacs manual. */
15110 #define SCROLL_LIMIT 100
15113 try_scrolling (Lisp_Object window
, bool just_this_one_p
,
15114 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
15115 bool temp_scroll_step
, bool last_line_misfit
)
15117 struct window
*w
= XWINDOW (window
);
15118 struct frame
*f
= XFRAME (w
->frame
);
15119 struct text_pos pos
, startp
;
15121 int this_scroll_margin
, scroll_max
, rc
, height
;
15122 int dy
= 0, amount_to_scroll
= 0;
15123 bool scroll_down_p
= false;
15124 int extra_scroll_margin_lines
= last_line_misfit
;
15125 Lisp_Object aggressive
;
15126 /* We will never try scrolling more than this number of lines. */
15127 int scroll_limit
= SCROLL_LIMIT
;
15128 int frame_line_height
= default_line_pixel_height (w
);
15129 int window_total_lines
15130 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15133 debug_method_add (w
, "try_scrolling");
15136 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15138 /* Compute scroll margin height in pixels. We scroll when point is
15139 within this distance from the top or bottom of the window. */
15140 if (scroll_margin
> 0)
15141 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15142 * frame_line_height
;
15144 this_scroll_margin
= 0;
15146 /* Force arg_scroll_conservatively to have a reasonable value, to
15147 avoid scrolling too far away with slow move_it_* functions. Note
15148 that the user can supply scroll-conservatively equal to
15149 `most-positive-fixnum', which can be larger than INT_MAX. */
15150 if (arg_scroll_conservatively
> scroll_limit
)
15152 arg_scroll_conservatively
= scroll_limit
+ 1;
15153 scroll_max
= scroll_limit
* frame_line_height
;
15155 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15156 /* Compute how much we should try to scroll maximally to bring
15157 point into view. */
15158 scroll_max
= (max (scroll_step
,
15159 max (arg_scroll_conservatively
, temp_scroll_step
))
15160 * frame_line_height
);
15161 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15162 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15163 /* We're trying to scroll because of aggressive scrolling but no
15164 scroll_step is set. Choose an arbitrary one. */
15165 scroll_max
= 10 * frame_line_height
;
15171 /* Decide whether to scroll down. */
15172 if (PT
> CHARPOS (startp
))
15174 int scroll_margin_y
;
15176 /* Compute the pixel ypos of the scroll margin, then move IT to
15177 either that ypos or PT, whichever comes first. */
15178 start_display (&it
, w
, startp
);
15179 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15180 - frame_line_height
* extra_scroll_margin_lines
;
15181 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15182 (MOVE_TO_POS
| MOVE_TO_Y
));
15184 if (PT
> CHARPOS (it
.current
.pos
))
15186 int y0
= line_bottom_y (&it
);
15187 /* Compute how many pixels below window bottom to stop searching
15188 for PT. This avoids costly search for PT that is far away if
15189 the user limited scrolling by a small number of lines, but
15190 always finds PT if scroll_conservatively is set to a large
15191 number, such as most-positive-fixnum. */
15192 int slack
= max (scroll_max
, 10 * frame_line_height
);
15193 int y_to_move
= it
.last_visible_y
+ slack
;
15195 /* Compute the distance from the scroll margin to PT or to
15196 the scroll limit, whichever comes first. This should
15197 include the height of the cursor line, to make that line
15199 move_it_to (&it
, PT
, -1, y_to_move
,
15200 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15201 dy
= line_bottom_y (&it
) - y0
;
15203 if (dy
> scroll_max
)
15204 return SCROLLING_FAILED
;
15207 scroll_down_p
= true;
15213 /* Point is in or below the bottom scroll margin, so move the
15214 window start down. If scrolling conservatively, move it just
15215 enough down to make point visible. If scroll_step is set,
15216 move it down by scroll_step. */
15217 if (arg_scroll_conservatively
)
15219 = min (max (dy
, frame_line_height
),
15220 frame_line_height
* arg_scroll_conservatively
);
15221 else if (scroll_step
|| temp_scroll_step
)
15222 amount_to_scroll
= scroll_max
;
15225 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15226 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15227 if (NUMBERP (aggressive
))
15229 double float_amount
= XFLOATINT (aggressive
) * height
;
15230 int aggressive_scroll
= float_amount
;
15231 if (aggressive_scroll
== 0 && float_amount
> 0)
15232 aggressive_scroll
= 1;
15233 /* Don't let point enter the scroll margin near top of
15234 the window. This could happen if the value of
15235 scroll_up_aggressively is too large and there are
15236 non-zero margins, because scroll_up_aggressively
15237 means put point that fraction of window height
15238 _from_the_bottom_margin_. */
15239 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15240 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15241 amount_to_scroll
= dy
+ aggressive_scroll
;
15245 if (amount_to_scroll
<= 0)
15246 return SCROLLING_FAILED
;
15248 start_display (&it
, w
, startp
);
15249 if (arg_scroll_conservatively
<= scroll_limit
)
15250 move_it_vertically (&it
, amount_to_scroll
);
15253 /* Extra precision for users who set scroll-conservatively
15254 to a large number: make sure the amount we scroll
15255 the window start is never less than amount_to_scroll,
15256 which was computed as distance from window bottom to
15257 point. This matters when lines at window top and lines
15258 below window bottom have different height. */
15260 void *it1data
= NULL
;
15261 /* We use a temporary it1 because line_bottom_y can modify
15262 its argument, if it moves one line down; see there. */
15265 SAVE_IT (it1
, it
, it1data
);
15266 start_y
= line_bottom_y (&it1
);
15268 RESTORE_IT (&it
, &it
, it1data
);
15269 move_it_by_lines (&it
, 1);
15270 SAVE_IT (it1
, it
, it1data
);
15271 } while (IT_CHARPOS (it
) < ZV
15272 && line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15273 bidi_unshelve_cache (it1data
, true);
15276 /* If STARTP is unchanged, move it down another screen line. */
15277 if (IT_CHARPOS (it
) == CHARPOS (startp
))
15278 move_it_by_lines (&it
, 1);
15279 startp
= it
.current
.pos
;
15283 struct text_pos scroll_margin_pos
= startp
;
15286 /* See if point is inside the scroll margin at the top of the
15288 if (this_scroll_margin
)
15292 start_display (&it
, w
, startp
);
15293 y_start
= it
.current_y
;
15294 move_it_vertically (&it
, this_scroll_margin
);
15295 scroll_margin_pos
= it
.current
.pos
;
15296 /* If we didn't move enough before hitting ZV, request
15297 additional amount of scroll, to move point out of the
15299 if (IT_CHARPOS (it
) == ZV
15300 && it
.current_y
- y_start
< this_scroll_margin
)
15301 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15304 if (PT
< CHARPOS (scroll_margin_pos
))
15306 /* Point is in the scroll margin at the top of the window or
15307 above what is displayed in the window. */
15310 /* Compute the vertical distance from PT to the scroll
15311 margin position. Move as far as scroll_max allows, or
15312 one screenful, or 10 screen lines, whichever is largest.
15313 Give up if distance is greater than scroll_max or if we
15314 didn't reach the scroll margin position. */
15315 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15316 start_display (&it
, w
, pos
);
15318 y_to_move
= max (it
.last_visible_y
,
15319 max (scroll_max
, 10 * frame_line_height
));
15320 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15322 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15323 dy
= it
.current_y
- y0
;
15324 if (dy
> scroll_max
15325 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15326 return SCROLLING_FAILED
;
15328 /* Additional scroll for when ZV was too close to point. */
15331 /* Compute new window start. */
15332 start_display (&it
, w
, startp
);
15334 if (arg_scroll_conservatively
)
15335 amount_to_scroll
= max (dy
, frame_line_height
15336 * max (scroll_step
, temp_scroll_step
));
15337 else if (scroll_step
|| temp_scroll_step
)
15338 amount_to_scroll
= scroll_max
;
15341 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15342 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15343 if (NUMBERP (aggressive
))
15345 double float_amount
= XFLOATINT (aggressive
) * height
;
15346 int aggressive_scroll
= float_amount
;
15347 if (aggressive_scroll
== 0 && float_amount
> 0)
15348 aggressive_scroll
= 1;
15349 /* Don't let point enter the scroll margin near
15350 bottom of the window, if the value of
15351 scroll_down_aggressively happens to be too
15353 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15354 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15355 amount_to_scroll
= dy
+ aggressive_scroll
;
15359 if (amount_to_scroll
<= 0)
15360 return SCROLLING_FAILED
;
15362 move_it_vertically_backward (&it
, amount_to_scroll
);
15363 startp
= it
.current
.pos
;
15367 /* Run window scroll functions. */
15368 startp
= run_window_scroll_functions (window
, startp
);
15370 /* Display the window. Give up if new fonts are loaded, or if point
15372 if (!try_window (window
, startp
, 0))
15373 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15374 else if (w
->cursor
.vpos
< 0)
15376 clear_glyph_matrix (w
->desired_matrix
);
15377 rc
= SCROLLING_FAILED
;
15381 /* Maybe forget recorded base line for line number display. */
15382 if (!just_this_one_p
15383 || current_buffer
->clip_changed
15384 || BEG_UNCHANGED
< CHARPOS (startp
))
15385 w
->base_line_number
= 0;
15387 /* If cursor ends up on a partially visible line,
15388 treat that as being off the bottom of the screen. */
15389 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1,
15391 /* It's possible that the cursor is on the first line of the
15392 buffer, which is partially obscured due to a vscroll
15393 (Bug#7537). In that case, avoid looping forever. */
15394 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15396 clear_glyph_matrix (w
->desired_matrix
);
15397 ++extra_scroll_margin_lines
;
15400 rc
= SCROLLING_SUCCESS
;
15407 /* Compute a suitable window start for window W if display of W starts
15408 on a continuation line. Value is true if a new window start
15411 The new window start will be computed, based on W's width, starting
15412 from the start of the continued line. It is the start of the
15413 screen line with the minimum distance from the old start W->start. */
15416 compute_window_start_on_continuation_line (struct window
*w
)
15418 struct text_pos pos
, start_pos
;
15419 bool window_start_changed_p
= false;
15421 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15423 /* If window start is on a continuation line... Window start may be
15424 < BEGV in case there's invisible text at the start of the
15425 buffer (M-x rmail, for example). */
15426 if (CHARPOS (start_pos
) > BEGV
15427 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15430 struct glyph_row
*row
;
15432 /* Handle the case that the window start is out of range. */
15433 if (CHARPOS (start_pos
) < BEGV
)
15434 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15435 else if (CHARPOS (start_pos
) > ZV
)
15436 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15438 /* Find the start of the continued line. This should be fast
15439 because find_newline is fast (newline cache). */
15440 row
= w
->desired_matrix
->rows
+ WINDOW_WANTS_HEADER_LINE_P (w
);
15441 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15442 row
, DEFAULT_FACE_ID
);
15443 reseat_at_previous_visible_line_start (&it
);
15445 /* If the line start is "too far" away from the window start,
15446 say it takes too much time to compute a new window start. */
15447 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15448 /* PXW: Do we need upper bounds here? */
15449 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15451 int min_distance
, distance
;
15453 /* Move forward by display lines to find the new window
15454 start. If window width was enlarged, the new start can
15455 be expected to be > the old start. If window width was
15456 decreased, the new window start will be < the old start.
15457 So, we're looking for the display line start with the
15458 minimum distance from the old window start. */
15459 pos
= it
.current
.pos
;
15460 min_distance
= INFINITY
;
15461 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15462 distance
< min_distance
)
15464 min_distance
= distance
;
15465 pos
= it
.current
.pos
;
15466 if (it
.line_wrap
== WORD_WRAP
)
15468 /* Under WORD_WRAP, move_it_by_lines is likely to
15469 overshoot and stop not at the first, but the
15470 second character from the left margin. So in
15471 that case, we need a more tight control on the X
15472 coordinate of the iterator than move_it_by_lines
15473 promises in its contract. The method is to first
15474 go to the last (rightmost) visible character of a
15475 line, then move to the leftmost character on the
15476 next line in a separate call. */
15477 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15478 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15479 move_it_to (&it
, ZV
, 0,
15480 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15481 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15484 move_it_by_lines (&it
, 1);
15487 /* Set the window start there. */
15488 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15489 window_start_changed_p
= true;
15493 return window_start_changed_p
;
15497 /* Try cursor movement in case text has not changed in window WINDOW,
15498 with window start STARTP. Value is
15500 CURSOR_MOVEMENT_SUCCESS if successful
15502 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15504 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15505 display. *SCROLL_STEP is set to true, under certain circumstances, if
15506 we want to scroll as if scroll-step were set to 1. See the code.
15508 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15509 which case we have to abort this redisplay, and adjust matrices
15514 CURSOR_MOVEMENT_SUCCESS
,
15515 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15516 CURSOR_MOVEMENT_MUST_SCROLL
,
15517 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15521 try_cursor_movement (Lisp_Object window
, struct text_pos startp
,
15524 struct window
*w
= XWINDOW (window
);
15525 struct frame
*f
= XFRAME (w
->frame
);
15526 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15529 if (inhibit_try_cursor_movement
)
15533 /* Previously, there was a check for Lisp integer in the
15534 if-statement below. Now, this field is converted to
15535 ptrdiff_t, thus zero means invalid position in a buffer. */
15536 eassert (w
->last_point
> 0);
15537 /* Likewise there was a check whether window_end_vpos is nil or larger
15538 than the window. Now window_end_vpos is int and so never nil, but
15539 let's leave eassert to check whether it fits in the window. */
15540 eassert (!w
->window_end_valid
15541 || w
->window_end_vpos
< w
->current_matrix
->nrows
);
15543 /* Handle case where text has not changed, only point, and it has
15544 not moved off the frame. */
15545 if (/* Point may be in this window. */
15546 PT
>= CHARPOS (startp
)
15547 /* Selective display hasn't changed. */
15548 && !current_buffer
->clip_changed
15549 /* Function force-mode-line-update is used to force a thorough
15550 redisplay. It sets either windows_or_buffers_changed or
15551 update_mode_lines. So don't take a shortcut here for these
15553 && !update_mode_lines
15554 && !windows_or_buffers_changed
15555 && !f
->cursor_type_changed
15556 && NILP (Vshow_trailing_whitespace
)
15557 /* This code is not used for mini-buffer for the sake of the case
15558 of redisplaying to replace an echo area message; since in
15559 that case the mini-buffer contents per se are usually
15560 unchanged. This code is of no real use in the mini-buffer
15561 since the handling of this_line_start_pos, etc., in redisplay
15562 handles the same cases. */
15563 && !EQ (window
, minibuf_window
)
15564 && (FRAME_WINDOW_P (f
)
15565 || !overlay_arrow_in_current_buffer_p ()))
15567 int this_scroll_margin
, top_scroll_margin
;
15568 struct glyph_row
*row
= NULL
;
15569 int frame_line_height
= default_line_pixel_height (w
);
15570 int window_total_lines
15571 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15574 debug_method_add (w
, "cursor movement");
15577 /* Scroll if point within this distance from the top or bottom
15578 of the window. This is a pixel value. */
15579 if (scroll_margin
> 0)
15581 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15582 this_scroll_margin
*= frame_line_height
;
15585 this_scroll_margin
= 0;
15587 top_scroll_margin
= this_scroll_margin
;
15588 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15589 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15591 /* Start with the row the cursor was displayed during the last
15592 not paused redisplay. Give up if that row is not valid. */
15593 if (w
->last_cursor_vpos
< 0
15594 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15595 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15598 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15599 if (row
->mode_line_p
)
15601 if (!row
->enabled_p
)
15602 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15605 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15607 bool scroll_p
= false, must_scroll
= false;
15608 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15610 if (PT
> w
->last_point
)
15612 /* Point has moved forward. */
15613 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15614 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15616 eassert (row
->enabled_p
);
15620 /* If the end position of a row equals the start
15621 position of the next row, and PT is at that position,
15622 we would rather display cursor in the next line. */
15623 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15624 && MATRIX_ROW_END_CHARPOS (row
) == PT
15625 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15626 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15627 && !cursor_row_p (row
))
15630 /* If within the scroll margin, scroll. Note that
15631 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15632 the next line would be drawn, and that
15633 this_scroll_margin can be zero. */
15634 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15635 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15636 /* Line is completely visible last line in window
15637 and PT is to be set in the next line. */
15638 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15639 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15640 && !row
->ends_at_zv_p
15641 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15644 else if (PT
< w
->last_point
)
15646 /* Cursor has to be moved backward. Note that PT >=
15647 CHARPOS (startp) because of the outer if-statement. */
15648 while (!row
->mode_line_p
15649 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15650 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15651 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15652 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15653 row
> w
->current_matrix
->rows
15654 && (row
-1)->ends_in_newline_from_string_p
))))
15655 && (row
->y
> top_scroll_margin
15656 || CHARPOS (startp
) == BEGV
))
15658 eassert (row
->enabled_p
);
15662 /* Consider the following case: Window starts at BEGV,
15663 there is invisible, intangible text at BEGV, so that
15664 display starts at some point START > BEGV. It can
15665 happen that we are called with PT somewhere between
15666 BEGV and START. Try to handle that case. */
15667 if (row
< w
->current_matrix
->rows
15668 || row
->mode_line_p
)
15670 row
= w
->current_matrix
->rows
;
15671 if (row
->mode_line_p
)
15675 /* Due to newlines in overlay strings, we may have to
15676 skip forward over overlay strings. */
15677 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15678 && MATRIX_ROW_END_CHARPOS (row
) == PT
15679 && !cursor_row_p (row
))
15682 /* If within the scroll margin, scroll. */
15683 if (row
->y
< top_scroll_margin
15684 && CHARPOS (startp
) != BEGV
)
15689 /* Cursor did not move. So don't scroll even if cursor line
15690 is partially visible, as it was so before. */
15691 rc
= CURSOR_MOVEMENT_SUCCESS
;
15694 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15695 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15697 /* if PT is not in the glyph row, give up. */
15698 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15699 must_scroll
= true;
15701 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15702 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15704 struct glyph_row
*row1
;
15706 /* If rows are bidi-reordered and point moved, back up
15707 until we find a row that does not belong to a
15708 continuation line. This is because we must consider
15709 all rows of a continued line as candidates for the
15710 new cursor positioning, since row start and end
15711 positions change non-linearly with vertical position
15713 /* FIXME: Revisit this when glyph ``spilling'' in
15714 continuation lines' rows is implemented for
15715 bidi-reordered rows. */
15716 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15717 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15720 /* If we hit the beginning of the displayed portion
15721 without finding the first row of a continued
15725 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15728 eassert (row
->enabled_p
);
15733 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15734 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15735 /* Make sure this isn't a header line by any chance, since
15736 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield true. */
15737 && !row
->mode_line_p
15738 && make_cursor_line_fully_visible_p
)
15740 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15741 && !row
->ends_at_zv_p
15742 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15743 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15744 else if (row
->height
> window_box_height (w
))
15746 /* If we end up in a partially visible line, let's
15747 make it fully visible, except when it's taller
15748 than the window, in which case we can't do much
15750 *scroll_step
= true;
15751 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15755 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15756 if (!cursor_row_fully_visible_p (w
, false, true))
15757 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15759 rc
= CURSOR_MOVEMENT_SUCCESS
;
15763 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15764 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15765 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15767 /* With bidi-reordered rows, there could be more than
15768 one candidate row whose start and end positions
15769 occlude point. We need to let set_cursor_from_row
15770 find the best candidate. */
15771 /* FIXME: Revisit this when glyph ``spilling'' in
15772 continuation lines' rows is implemented for
15773 bidi-reordered rows. */
15778 bool at_zv_p
= false, exact_match_p
= false;
15780 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15781 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15782 && cursor_row_p (row
))
15783 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15785 /* As soon as we've found the exact match for point,
15786 or the first suitable row whose ends_at_zv_p flag
15787 is set, we are done. */
15790 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15791 w
->cursor
.vpos
)->ends_at_zv_p
;
15793 && w
->cursor
.hpos
>= 0
15794 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15797 struct glyph_row
*candidate
=
15798 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15800 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15801 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15804 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15805 || (NILP (g
->object
)
15806 && (g
->charpos
== PT
15807 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15809 if (at_zv_p
|| exact_match_p
)
15811 rc
= CURSOR_MOVEMENT_SUCCESS
;
15815 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15819 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15820 || row
->continued_p
)
15821 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15822 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15823 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15824 /* If we didn't find any candidate rows, or exited the
15825 loop before all the candidates were examined, signal
15826 to the caller that this method failed. */
15827 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15829 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15830 && !row
->continued_p
))
15831 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15833 rc
= CURSOR_MOVEMENT_SUCCESS
;
15839 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15841 rc
= CURSOR_MOVEMENT_SUCCESS
;
15846 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15847 && MATRIX_ROW_START_CHARPOS (row
) == PT
15848 && cursor_row_p (row
));
15858 set_vertical_scroll_bar (struct window
*w
)
15860 ptrdiff_t start
, end
, whole
;
15862 /* Calculate the start and end positions for the current window.
15863 At some point, it would be nice to choose between scrollbars
15864 which reflect the whole buffer size, with special markers
15865 indicating narrowing, and scrollbars which reflect only the
15868 Note that mini-buffers sometimes aren't displaying any text. */
15869 if (!MINI_WINDOW_P (w
)
15870 || (w
== XWINDOW (minibuf_window
)
15871 && NILP (echo_area_buffer
[0])))
15873 struct buffer
*buf
= XBUFFER (w
->contents
);
15874 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15875 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15876 /* I don't think this is guaranteed to be right. For the
15877 moment, we'll pretend it is. */
15878 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15882 if (whole
< (end
- start
))
15883 whole
= end
- start
;
15886 start
= end
= whole
= 0;
15888 /* Indicate what this scroll bar ought to be displaying now. */
15889 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15890 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15891 (w
, end
- start
, whole
, start
);
15896 set_horizontal_scroll_bar (struct window
*w
)
15898 int start
, end
, whole
, portion
;
15900 if (!MINI_WINDOW_P (w
)
15901 || (w
== XWINDOW (minibuf_window
)
15902 && NILP (echo_area_buffer
[0])))
15904 struct buffer
*b
= XBUFFER (w
->contents
);
15905 struct buffer
*old_buffer
= NULL
;
15907 struct text_pos startp
;
15909 if (b
!= current_buffer
)
15911 old_buffer
= current_buffer
;
15912 set_buffer_internal (b
);
15915 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15916 start_display (&it
, w
, startp
);
15917 it
.last_visible_x
= INT_MAX
;
15918 whole
= move_it_to (&it
, -1, INT_MAX
, window_box_height (w
), -1,
15919 MOVE_TO_X
| MOVE_TO_Y
);
15920 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
15921 window_box_height (w), -1,
15922 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
15924 start
= w
->hscroll
* FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
));
15925 end
= start
+ window_box_width (w
, TEXT_AREA
);
15926 portion
= end
- start
;
15927 /* After enlarging a horizontally scrolled window such that it
15928 gets at least as wide as the text it contains, make sure that
15929 the thumb doesn't fill the entire scroll bar so we can still
15930 drag it back to see the entire text. */
15931 whole
= max (whole
, end
);
15937 pdir
= Fcurrent_bidi_paragraph_direction (Qnil
);
15938 if (EQ (pdir
, Qright_to_left
))
15940 start
= whole
- end
;
15941 end
= start
+ portion
;
15946 set_buffer_internal (old_buffer
);
15949 start
= end
= whole
= portion
= 0;
15951 w
->hscroll_whole
= whole
;
15953 /* Indicate what this scroll bar ought to be displaying now. */
15954 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15955 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15956 (w
, portion
, whole
, start
);
15960 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P means only
15961 selected_window is redisplayed.
15963 We can return without actually redisplaying the window if fonts has been
15964 changed on window's frame. In that case, redisplay_internal will retry.
15966 As one of the important parts of redisplaying a window, we need to
15967 decide whether the previous window-start position (stored in the
15968 window's w->start marker position) is still valid, and if it isn't,
15969 recompute it. Some details about that:
15971 . The previous window-start could be in a continuation line, in
15972 which case we need to recompute it when the window width
15973 changes. See compute_window_start_on_continuation_line and its
15976 . The text that changed since last redisplay could include the
15977 previous window-start position. In that case, we try to salvage
15978 what we can from the current glyph matrix by calling
15979 try_scrolling, which see.
15981 . Some Emacs command could force us to use a specific window-start
15982 position by setting the window's force_start flag, or gently
15983 propose doing that by setting the window's optional_new_start
15984 flag. In these cases, we try using the specified start point if
15985 that succeeds (i.e. the window desired matrix is successfully
15986 recomputed, and point location is within the window). In case
15987 of optional_new_start, we first check if the specified start
15988 position is feasible, i.e. if it will allow point to be
15989 displayed in the window. If using the specified start point
15990 fails, e.g., if new fonts are needed to be loaded, we abort the
15991 redisplay cycle and leave it up to the next cycle to figure out
15994 . Note that the window's force_start flag is sometimes set by
15995 redisplay itself, when it decides that the previous window start
15996 point is fine and should be kept. Search for "goto force_start"
15997 below to see the details. Like the values of window-start
15998 specified outside of redisplay, these internally-deduced values
15999 are tested for feasibility, and ignored if found to be
16002 . Note that the function try_window, used to completely redisplay
16003 a window, accepts the window's start point as its argument.
16004 This is used several times in the redisplay code to control
16005 where the window start will be, according to user options such
16006 as scroll-conservatively, and also to ensure the screen line
16007 showing point will be fully (as opposed to partially) visible on
16011 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
16013 struct window
*w
= XWINDOW (window
);
16014 struct frame
*f
= XFRAME (w
->frame
);
16015 struct buffer
*buffer
= XBUFFER (w
->contents
);
16016 struct buffer
*old
= current_buffer
;
16017 struct text_pos lpoint
, opoint
, startp
;
16018 bool update_mode_line
;
16021 /* Record it now because it's overwritten. */
16022 bool current_matrix_up_to_date_p
= false;
16023 bool used_current_matrix_p
= false;
16024 /* This is less strict than current_matrix_up_to_date_p.
16025 It indicates that the buffer contents and narrowing are unchanged. */
16026 bool buffer_unchanged_p
= false;
16027 bool temp_scroll_step
= false;
16028 ptrdiff_t count
= SPECPDL_INDEX ();
16030 int centering_position
= -1;
16031 bool last_line_misfit
= false;
16032 ptrdiff_t beg_unchanged
, end_unchanged
;
16033 int frame_line_height
;
16035 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16039 *w
->desired_matrix
->method
= 0;
16042 if (!just_this_one_p
16043 && REDISPLAY_SOME_P ()
16045 && !w
->update_mode_line
16048 && !buffer
->text
->redisplay
16049 && BUF_PT (buffer
) == w
->last_point
)
16052 /* Make sure that both W's markers are valid. */
16053 eassert (XMARKER (w
->start
)->buffer
== buffer
);
16054 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
16056 /* We come here again if we need to run window-text-change-functions
16059 reconsider_clip_changes (w
);
16060 frame_line_height
= default_line_pixel_height (w
);
16062 /* Has the mode line to be updated? */
16063 update_mode_line
= (w
->update_mode_line
16064 || update_mode_lines
16065 || buffer
->clip_changed
16066 || buffer
->prevent_redisplay_optimizations_p
);
16068 if (!just_this_one_p
)
16069 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
16070 cleverly elsewhere. */
16071 w
->must_be_updated_p
= true;
16073 if (MINI_WINDOW_P (w
))
16075 if (w
== XWINDOW (echo_area_window
)
16076 && !NILP (echo_area_buffer
[0]))
16078 if (update_mode_line
)
16079 /* We may have to update a tty frame's menu bar or a
16080 tool-bar. Example `M-x C-h C-h C-g'. */
16081 goto finish_menu_bars
;
16083 /* We've already displayed the echo area glyphs in this window. */
16084 goto finish_scroll_bars
;
16086 else if ((w
!= XWINDOW (minibuf_window
)
16087 || minibuf_level
== 0)
16088 /* When buffer is nonempty, redisplay window normally. */
16089 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
16090 /* Quail displays non-mini buffers in minibuffer window.
16091 In that case, redisplay the window normally. */
16092 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
16094 /* W is a mini-buffer window, but it's not active, so clear
16096 int yb
= window_text_bottom_y (w
);
16097 struct glyph_row
*row
;
16100 for (y
= 0, row
= w
->desired_matrix
->rows
;
16102 y
+= row
->height
, ++row
)
16103 blank_row (w
, row
, y
);
16104 goto finish_scroll_bars
;
16107 clear_glyph_matrix (w
->desired_matrix
);
16110 /* Otherwise set up data on this window; select its buffer and point
16112 /* Really select the buffer, for the sake of buffer-local
16114 set_buffer_internal_1 (XBUFFER (w
->contents
));
16116 current_matrix_up_to_date_p
16117 = (w
->window_end_valid
16118 && !current_buffer
->clip_changed
16119 && !current_buffer
->prevent_redisplay_optimizations_p
16120 && !window_outdated (w
));
16122 /* Run the window-text-change-functions
16123 if it is possible that the text on the screen has changed
16124 (either due to modification of the text, or any other reason). */
16125 if (!current_matrix_up_to_date_p
16126 && !NILP (Vwindow_text_change_functions
))
16128 safe_run_hooks (Qwindow_text_change_functions
);
16132 beg_unchanged
= BEG_UNCHANGED
;
16133 end_unchanged
= END_UNCHANGED
;
16135 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
16137 specbind (Qinhibit_point_motion_hooks
, Qt
);
16140 = (w
->window_end_valid
16141 && !current_buffer
->clip_changed
16142 && !window_outdated (w
));
16144 /* When windows_or_buffers_changed is non-zero, we can't rely
16145 on the window end being valid, so set it to zero there. */
16146 if (windows_or_buffers_changed
)
16148 /* If window starts on a continuation line, maybe adjust the
16149 window start in case the window's width changed. */
16150 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16151 compute_window_start_on_continuation_line (w
);
16153 w
->window_end_valid
= false;
16154 /* If so, we also can't rely on current matrix
16155 and should not fool try_cursor_movement below. */
16156 current_matrix_up_to_date_p
= false;
16159 /* Some sanity checks. */
16160 CHECK_WINDOW_END (w
);
16161 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16163 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16166 if (mode_line_update_needed (w
))
16167 update_mode_line
= true;
16169 /* Point refers normally to the selected window. For any other
16170 window, set up appropriate value. */
16171 if (!EQ (window
, selected_window
))
16173 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16174 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16179 new_pt_byte
= BEGV_BYTE
;
16180 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16182 else if (new_pt
> (ZV
- 1))
16185 new_pt_byte
= ZV_BYTE
;
16186 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16189 /* We don't use SET_PT so that the point-motion hooks don't run. */
16190 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16193 /* If any of the character widths specified in the display table
16194 have changed, invalidate the width run cache. It's true that
16195 this may be a bit late to catch such changes, but the rest of
16196 redisplay goes (non-fatally) haywire when the display table is
16197 changed, so why should we worry about doing any better? */
16198 if (current_buffer
->width_run_cache
16199 || (current_buffer
->base_buffer
16200 && current_buffer
->base_buffer
->width_run_cache
))
16202 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16204 if (! disptab_matches_widthtab
16205 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16207 struct buffer
*buf
= current_buffer
;
16209 if (buf
->base_buffer
)
16210 buf
= buf
->base_buffer
;
16211 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16212 recompute_width_table (current_buffer
, disptab
);
16216 /* If window-start is screwed up, choose a new one. */
16217 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16220 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16222 /* If someone specified a new starting point but did not insist,
16223 check whether it can be used. */
16224 if ((w
->optional_new_start
|| window_frozen_p (w
))
16225 && CHARPOS (startp
) >= BEGV
16226 && CHARPOS (startp
) <= ZV
)
16228 ptrdiff_t it_charpos
;
16230 w
->optional_new_start
= false;
16231 start_display (&it
, w
, startp
);
16232 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16233 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16234 /* Record IT's position now, since line_bottom_y might change
16236 it_charpos
= IT_CHARPOS (it
);
16237 /* Make sure we set the force_start flag only if the cursor row
16238 will be fully visible. Otherwise, the code under force_start
16239 label below will try to move point back into view, which is
16240 not what the code which sets optional_new_start wants. */
16241 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
16242 && !w
->force_start
)
16244 if (it_charpos
== PT
)
16245 w
->force_start
= true;
16246 /* IT may overshoot PT if text at PT is invisible. */
16247 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16248 w
->force_start
= true;
16250 if (w
->force_start
)
16252 if (window_frozen_p (w
))
16253 debug_method_add (w
, "set force_start from frozen window start");
16255 debug_method_add (w
, "set force_start from optional_new_start");
16263 /* Handle case where place to start displaying has been specified,
16264 unless the specified location is outside the accessible range. */
16265 if (w
->force_start
)
16267 /* We set this later on if we have to adjust point. */
16270 w
->force_start
= false;
16272 w
->window_end_valid
= false;
16274 /* Forget any recorded base line for line number display. */
16275 if (!buffer_unchanged_p
)
16276 w
->base_line_number
= 0;
16278 /* Redisplay the mode line. Select the buffer properly for that.
16279 Also, run the hook window-scroll-functions
16280 because we have scrolled. */
16281 /* Note, we do this after clearing force_start because
16282 if there's an error, it is better to forget about force_start
16283 than to get into an infinite loop calling the hook functions
16284 and having them get more errors. */
16285 if (!update_mode_line
16286 || ! NILP (Vwindow_scroll_functions
))
16288 update_mode_line
= true;
16289 w
->update_mode_line
= true;
16290 startp
= run_window_scroll_functions (window
, startp
);
16293 if (CHARPOS (startp
) < BEGV
)
16294 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16295 else if (CHARPOS (startp
) > ZV
)
16296 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16298 /* Redisplay, then check if cursor has been set during the
16299 redisplay. Give up if new fonts were loaded. */
16300 /* We used to issue a CHECK_MARGINS argument to try_window here,
16301 but this causes scrolling to fail when point begins inside
16302 the scroll margin (bug#148) -- cyd */
16303 if (!try_window (window
, startp
, 0))
16305 w
->force_start
= true;
16306 clear_glyph_matrix (w
->desired_matrix
);
16307 goto need_larger_matrices
;
16310 if (w
->cursor
.vpos
< 0)
16312 /* If point does not appear, try to move point so it does
16313 appear. The desired matrix has been built above, so we
16314 can use it here. First see if point is in invisible
16315 text, and if so, move it to the first visible buffer
16316 position past that. */
16317 struct glyph_row
*r
= NULL
;
16318 Lisp_Object invprop
=
16319 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16322 if (TEXT_PROP_MEANS_INVISIBLE (invprop
) != 0)
16325 Lisp_Object invprop_end
=
16326 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16329 if (NATNUMP (invprop_end
))
16330 alt_pt
= XFASTINT (invprop_end
);
16333 r
= row_containing_pos (w
, alt_pt
, w
->desired_matrix
->rows
,
16337 new_vpos
= MATRIX_ROW_BOTTOM_Y (r
);
16338 else /* Give up and just move to the middle of the window. */
16339 new_vpos
= window_box_height (w
) / 2;
16342 if (!cursor_row_fully_visible_p (w
, false, false))
16344 /* Point does appear, but on a line partly visible at end of window.
16345 Move it back to a fully-visible line. */
16346 new_vpos
= window_box_height (w
);
16347 /* But if window_box_height suggests a Y coordinate that is
16348 not less than we already have, that line will clearly not
16349 be fully visible, so give up and scroll the display.
16350 This can happen when the default face uses a font whose
16351 dimensions are different from the frame's default
16353 if (new_vpos
>= w
->cursor
.y
)
16355 w
->cursor
.vpos
= -1;
16356 clear_glyph_matrix (w
->desired_matrix
);
16357 goto try_to_scroll
;
16360 else if (w
->cursor
.vpos
>= 0)
16362 /* Some people insist on not letting point enter the scroll
16363 margin, even though this part handles windows that didn't
16365 int window_total_lines
16366 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16367 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16368 int pixel_margin
= margin
* frame_line_height
;
16369 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16371 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16372 below, which finds the row to move point to, advances by
16373 the Y coordinate of the _next_ row, see the definition of
16374 MATRIX_ROW_BOTTOM_Y. */
16375 if (w
->cursor
.vpos
< margin
+ header_line
)
16377 w
->cursor
.vpos
= -1;
16378 clear_glyph_matrix (w
->desired_matrix
);
16379 goto try_to_scroll
;
16383 int window_height
= window_box_height (w
);
16386 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16387 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16389 w
->cursor
.vpos
= -1;
16390 clear_glyph_matrix (w
->desired_matrix
);
16391 goto try_to_scroll
;
16396 /* If we need to move point for either of the above reasons,
16397 now actually do it. */
16400 struct glyph_row
*row
;
16402 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16403 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16406 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16407 MATRIX_ROW_START_BYTEPOS (row
));
16409 if (w
!= XWINDOW (selected_window
))
16410 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16411 else if (current_buffer
== old
)
16412 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16414 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16416 /* Re-run pre-redisplay-function so it can update the region
16417 according to the new position of point. */
16418 /* Other than the cursor, w's redisplay is done so we can set its
16419 redisplay to false. Also the buffer's redisplay can be set to
16420 false, since propagate_buffer_redisplay should have already
16421 propagated its info to `w' anyway. */
16422 w
->redisplay
= false;
16423 XBUFFER (w
->contents
)->text
->redisplay
= false;
16424 safe__call1 (true, Vpre_redisplay_function
, Fcons (window
, Qnil
));
16426 if (w
->redisplay
|| XBUFFER (w
->contents
)->text
->redisplay
)
16428 /* pre-redisplay-function made changes (e.g. move the region)
16429 that require another round of redisplay. */
16430 clear_glyph_matrix (w
->desired_matrix
);
16431 if (!try_window (window
, startp
, 0))
16432 goto need_larger_matrices
;
16435 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, false, false))
16437 clear_glyph_matrix (w
->desired_matrix
);
16438 goto try_to_scroll
;
16442 debug_method_add (w
, "forced window start");
16447 /* Handle case where text has not changed, only point, and it has
16448 not moved off the frame, and we are not retrying after hscroll.
16449 (current_matrix_up_to_date_p is true when retrying.) */
16450 if (current_matrix_up_to_date_p
16451 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16452 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16456 case CURSOR_MOVEMENT_SUCCESS
:
16457 used_current_matrix_p
= true;
16460 case CURSOR_MOVEMENT_MUST_SCROLL
:
16461 goto try_to_scroll
;
16467 /* If current starting point was originally the beginning of a line
16468 but no longer is, find a new starting point. */
16469 else if (w
->start_at_line_beg
16470 && !(CHARPOS (startp
) <= BEGV
16471 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16474 debug_method_add (w
, "recenter 1");
16479 /* Try scrolling with try_window_id. Value is > 0 if update has
16480 been done, it is -1 if we know that the same window start will
16481 not work. It is 0 if unsuccessful for some other reason. */
16482 else if ((tem
= try_window_id (w
)) != 0)
16485 debug_method_add (w
, "try_window_id %d", tem
);
16488 if (f
->fonts_changed
)
16489 goto need_larger_matrices
;
16493 /* Otherwise try_window_id has returned -1 which means that we
16494 don't want the alternative below this comment to execute. */
16496 else if (CHARPOS (startp
) >= BEGV
16497 && CHARPOS (startp
) <= ZV
16498 && PT
>= CHARPOS (startp
)
16499 && (CHARPOS (startp
) < ZV
16500 /* Avoid starting at end of buffer. */
16501 || CHARPOS (startp
) == BEGV
16502 || !window_outdated (w
)))
16504 int d1
, d2
, d5
, d6
;
16507 /* If first window line is a continuation line, and window start
16508 is inside the modified region, but the first change is before
16509 current window start, we must select a new window start.
16511 However, if this is the result of a down-mouse event (e.g. by
16512 extending the mouse-drag-overlay), we don't want to select a
16513 new window start, since that would change the position under
16514 the mouse, resulting in an unwanted mouse-movement rather
16515 than a simple mouse-click. */
16516 if (!w
->start_at_line_beg
16517 && NILP (do_mouse_tracking
)
16518 && CHARPOS (startp
) > BEGV
16519 && CHARPOS (startp
) > BEG
+ beg_unchanged
16520 && CHARPOS (startp
) <= Z
- end_unchanged
16521 /* Even if w->start_at_line_beg is nil, a new window may
16522 start at a line_beg, since that's how set_buffer_window
16523 sets it. So, we need to check the return value of
16524 compute_window_start_on_continuation_line. (See also
16526 && XMARKER (w
->start
)->buffer
== current_buffer
16527 && compute_window_start_on_continuation_line (w
)
16528 /* It doesn't make sense to force the window start like we
16529 do at label force_start if it is already known that point
16530 will not be fully visible in the resulting window, because
16531 doing so will move point from its correct position
16532 instead of scrolling the window to bring point into view.
16534 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16535 /* A very tall row could need more than the window height,
16536 in which case we accept that it is partially visible. */
16537 && (rtop
!= 0) == (rbot
!= 0))
16539 w
->force_start
= true;
16540 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16542 debug_method_add (w
, "recomputed window start in continuation line");
16548 debug_method_add (w
, "same window start");
16551 /* Try to redisplay starting at same place as before.
16552 If point has not moved off frame, accept the results. */
16553 if (!current_matrix_up_to_date_p
16554 /* Don't use try_window_reusing_current_matrix in this case
16555 because a window scroll function can have changed the
16557 || !NILP (Vwindow_scroll_functions
)
16558 || MINI_WINDOW_P (w
)
16559 || !(used_current_matrix_p
16560 = try_window_reusing_current_matrix (w
)))
16562 IF_DEBUG (debug_method_add (w
, "1"));
16563 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16564 /* -1 means we need to scroll.
16565 0 means we need new matrices, but fonts_changed
16566 is set in that case, so we will detect it below. */
16567 goto try_to_scroll
;
16570 if (f
->fonts_changed
)
16571 goto need_larger_matrices
;
16573 if (w
->cursor
.vpos
>= 0)
16575 if (!just_this_one_p
16576 || current_buffer
->clip_changed
16577 || BEG_UNCHANGED
< CHARPOS (startp
))
16578 /* Forget any recorded base line for line number display. */
16579 w
->base_line_number
= 0;
16581 if (!cursor_row_fully_visible_p (w
, true, false))
16583 clear_glyph_matrix (w
->desired_matrix
);
16584 last_line_misfit
= true;
16586 /* Drop through and scroll. */
16591 clear_glyph_matrix (w
->desired_matrix
);
16596 /* Redisplay the mode line. Select the buffer properly for that. */
16597 if (!update_mode_line
)
16599 update_mode_line
= true;
16600 w
->update_mode_line
= true;
16603 /* Try to scroll by specified few lines. */
16604 if ((scroll_conservatively
16605 || emacs_scroll_step
16606 || temp_scroll_step
16607 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16608 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16609 && CHARPOS (startp
) >= BEGV
16610 && CHARPOS (startp
) <= ZV
)
16612 /* The function returns -1 if new fonts were loaded, 1 if
16613 successful, 0 if not successful. */
16614 int ss
= try_scrolling (window
, just_this_one_p
,
16615 scroll_conservatively
,
16617 temp_scroll_step
, last_line_misfit
);
16620 case SCROLLING_SUCCESS
:
16623 case SCROLLING_NEED_LARGER_MATRICES
:
16624 goto need_larger_matrices
;
16626 case SCROLLING_FAILED
:
16634 /* Finally, just choose a place to start which positions point
16635 according to user preferences. */
16640 debug_method_add (w
, "recenter");
16643 /* Forget any previously recorded base line for line number display. */
16644 if (!buffer_unchanged_p
)
16645 w
->base_line_number
= 0;
16647 /* Determine the window start relative to point. */
16648 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16649 it
.current_y
= it
.last_visible_y
;
16650 if (centering_position
< 0)
16652 int window_total_lines
16653 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16655 = scroll_margin
> 0
16656 ? min (scroll_margin
, window_total_lines
/ 4)
16658 ptrdiff_t margin_pos
= CHARPOS (startp
);
16659 Lisp_Object aggressive
;
16662 /* If there is a scroll margin at the top of the window, find
16663 its character position. */
16665 /* Cannot call start_display if startp is not in the
16666 accessible region of the buffer. This can happen when we
16667 have just switched to a different buffer and/or changed
16668 its restriction. In that case, startp is initialized to
16669 the character position 1 (BEGV) because we did not yet
16670 have chance to display the buffer even once. */
16671 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16674 void *it1data
= NULL
;
16676 SAVE_IT (it1
, it
, it1data
);
16677 start_display (&it1
, w
, startp
);
16678 move_it_vertically (&it1
, margin
* frame_line_height
);
16679 margin_pos
= IT_CHARPOS (it1
);
16680 RESTORE_IT (&it
, &it
, it1data
);
16682 scrolling_up
= PT
> margin_pos
;
16685 ? BVAR (current_buffer
, scroll_up_aggressively
)
16686 : BVAR (current_buffer
, scroll_down_aggressively
);
16688 if (!MINI_WINDOW_P (w
)
16689 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16693 /* Setting scroll-conservatively overrides
16694 scroll-*-aggressively. */
16695 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16697 double float_amount
= XFLOATINT (aggressive
);
16699 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16700 if (pt_offset
== 0 && float_amount
> 0)
16702 if (pt_offset
&& margin
> 0)
16705 /* Compute how much to move the window start backward from
16706 point so that point will be displayed where the user
16710 centering_position
= it
.last_visible_y
;
16712 centering_position
-= pt_offset
;
16713 centering_position
-=
16714 (frame_line_height
* (1 + margin
+ last_line_misfit
)
16715 + WINDOW_HEADER_LINE_HEIGHT (w
));
16716 /* Don't let point enter the scroll margin near top of
16718 if (centering_position
< margin
* frame_line_height
)
16719 centering_position
= margin
* frame_line_height
;
16722 centering_position
= margin
* frame_line_height
+ pt_offset
;
16725 /* Set the window start half the height of the window backward
16727 centering_position
= window_box_height (w
) / 2;
16729 move_it_vertically_backward (&it
, centering_position
);
16731 eassert (IT_CHARPOS (it
) >= BEGV
);
16733 /* The function move_it_vertically_backward may move over more
16734 than the specified y-distance. If it->w is small, e.g. a
16735 mini-buffer window, we may end up in front of the window's
16736 display area. Start displaying at the start of the line
16737 containing PT in this case. */
16738 if (it
.current_y
<= 0)
16740 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16741 move_it_vertically_backward (&it
, 0);
16745 it
.current_x
= it
.hpos
= 0;
16747 /* Set the window start position here explicitly, to avoid an
16748 infinite loop in case the functions in window-scroll-functions
16750 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16752 /* Run scroll hooks. */
16753 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16755 /* Redisplay the window. */
16756 bool use_desired_matrix
= false;
16757 if (!current_matrix_up_to_date_p
16758 || windows_or_buffers_changed
16759 || f
->cursor_type_changed
16760 /* Don't use try_window_reusing_current_matrix in this case
16761 because it can have changed the buffer. */
16762 || !NILP (Vwindow_scroll_functions
)
16763 || !just_this_one_p
16764 || MINI_WINDOW_P (w
)
16765 || !(used_current_matrix_p
16766 = try_window_reusing_current_matrix (w
)))
16767 use_desired_matrix
= (try_window (window
, startp
, 0) == 1);
16769 /* If new fonts have been loaded (due to fontsets), give up. We
16770 have to start a new redisplay since we need to re-adjust glyph
16772 if (f
->fonts_changed
)
16773 goto need_larger_matrices
;
16775 /* If cursor did not appear assume that the middle of the window is
16776 in the first line of the window. Do it again with the next line.
16777 (Imagine a window of height 100, displaying two lines of height
16778 60. Moving back 50 from it->last_visible_y will end in the first
16780 if (w
->cursor
.vpos
< 0)
16782 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16784 clear_glyph_matrix (w
->desired_matrix
);
16785 move_it_by_lines (&it
, 1);
16786 try_window (window
, it
.current
.pos
, 0);
16788 else if (PT
< IT_CHARPOS (it
))
16790 clear_glyph_matrix (w
->desired_matrix
);
16791 move_it_by_lines (&it
, -1);
16792 try_window (window
, it
.current
.pos
, 0);
16796 /* Not much we can do about it. */
16800 /* Consider the following case: Window starts at BEGV, there is
16801 invisible, intangible text at BEGV, so that display starts at
16802 some point START > BEGV. It can happen that we are called with
16803 PT somewhere between BEGV and START. Try to handle that case,
16804 and similar ones. */
16805 if (w
->cursor
.vpos
< 0)
16807 /* Prefer the desired matrix to the current matrix, if possible,
16808 in the fallback calculations below. This is because using
16809 the current matrix might completely goof, e.g. if its first
16810 row is after point. */
16811 struct glyph_matrix
*matrix
=
16812 use_desired_matrix
? w
->desired_matrix
: w
->current_matrix
;
16813 /* First, try locating the proper glyph row for PT. */
16814 struct glyph_row
*row
=
16815 row_containing_pos (w
, PT
, matrix
->rows
, NULL
, 0);
16817 /* Sometimes point is at the beginning of invisible text that is
16818 before the 1st character displayed in the row. In that case,
16819 row_containing_pos fails to find the row, because no glyphs
16820 with appropriate buffer positions are present in the row.
16821 Therefore, we next try to find the row which shows the 1st
16822 position after the invisible text. */
16826 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16829 if (TEXT_PROP_MEANS_INVISIBLE (val
) != 0)
16832 Lisp_Object invis_end
=
16833 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16836 if (NATNUMP (invis_end
))
16837 alt_pos
= XFASTINT (invis_end
);
16840 row
= row_containing_pos (w
, alt_pos
, matrix
->rows
, NULL
, 0);
16843 /* Finally, fall back on the first row of the window after the
16844 header line (if any). This is slightly better than not
16845 displaying the cursor at all. */
16848 row
= matrix
->rows
;
16849 if (row
->mode_line_p
)
16852 set_cursor_from_row (w
, row
, matrix
, 0, 0, 0, 0);
16855 if (!cursor_row_fully_visible_p (w
, false, false))
16857 /* If vscroll is enabled, disable it and try again. */
16861 clear_glyph_matrix (w
->desired_matrix
);
16865 /* Users who set scroll-conservatively to a large number want
16866 point just above/below the scroll margin. If we ended up
16867 with point's row partially visible, move the window start to
16868 make that row fully visible and out of the margin. */
16869 if (scroll_conservatively
> SCROLL_LIMIT
)
16871 int window_total_lines
16872 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16875 ? min (scroll_margin
, window_total_lines
/ 4)
16877 bool move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16879 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16880 clear_glyph_matrix (w
->desired_matrix
);
16881 if (1 == try_window (window
, it
.current
.pos
,
16882 TRY_WINDOW_CHECK_MARGINS
))
16886 /* If centering point failed to make the whole line visible,
16887 put point at the top instead. That has to make the whole line
16888 visible, if it can be done. */
16889 if (centering_position
== 0)
16892 clear_glyph_matrix (w
->desired_matrix
);
16893 centering_position
= 0;
16899 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16900 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16901 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16903 /* Display the mode line, if we must. */
16904 if ((update_mode_line
16905 /* If window not full width, must redo its mode line
16906 if (a) the window to its side is being redone and
16907 (b) we do a frame-based redisplay. This is a consequence
16908 of how inverted lines are drawn in frame-based redisplay. */
16909 || (!just_this_one_p
16910 && !FRAME_WINDOW_P (f
)
16911 && !WINDOW_FULL_WIDTH_P (w
))
16912 /* Line number to display. */
16913 || w
->base_line_pos
> 0
16914 /* Column number is displayed and different from the one displayed. */
16915 || (w
->column_number_displayed
!= -1
16916 && (w
->column_number_displayed
!= current_column ())))
16917 /* This means that the window has a mode line. */
16918 && (WINDOW_WANTS_MODELINE_P (w
)
16919 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16922 display_mode_lines (w
);
16924 /* If mode line height has changed, arrange for a thorough
16925 immediate redisplay using the correct mode line height. */
16926 if (WINDOW_WANTS_MODELINE_P (w
)
16927 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16929 f
->fonts_changed
= true;
16930 w
->mode_line_height
= -1;
16931 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16932 = DESIRED_MODE_LINE_HEIGHT (w
);
16935 /* If header line height has changed, arrange for a thorough
16936 immediate redisplay using the correct header line height. */
16937 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16938 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16940 f
->fonts_changed
= true;
16941 w
->header_line_height
= -1;
16942 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16943 = DESIRED_HEADER_LINE_HEIGHT (w
);
16946 if (f
->fonts_changed
)
16947 goto need_larger_matrices
;
16950 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16952 w
->base_line_pos
= 0;
16953 w
->base_line_number
= 0;
16958 /* When we reach a frame's selected window, redo the frame's menu
16959 bar and the frame's title. */
16960 if (update_mode_line
16961 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16963 bool redisplay_menu_p
;
16965 if (FRAME_WINDOW_P (f
))
16967 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16968 || defined (HAVE_NS) || defined (USE_GTK)
16969 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16971 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16975 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16977 if (redisplay_menu_p
)
16978 display_menu_bar (w
);
16980 #ifdef HAVE_WINDOW_SYSTEM
16981 if (FRAME_WINDOW_P (f
))
16983 #if defined (USE_GTK) || defined (HAVE_NS)
16984 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16985 redisplay_tool_bar (f
);
16987 if (WINDOWP (f
->tool_bar_window
)
16988 && (FRAME_TOOL_BAR_LINES (f
) > 0
16989 || !NILP (Vauto_resize_tool_bars
))
16990 && redisplay_tool_bar (f
))
16991 ignore_mouse_drag_p
= true;
16994 x_consider_frame_title (w
->frame
);
16998 #ifdef HAVE_WINDOW_SYSTEM
16999 if (FRAME_WINDOW_P (f
)
17000 && update_window_fringes (w
, (just_this_one_p
17001 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
17002 || w
->pseudo_window_p
)))
17006 if (draw_window_fringes (w
, true))
17008 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
17009 x_draw_right_divider (w
);
17011 x_draw_vertical_border (w
);
17017 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
17018 x_draw_bottom_divider (w
);
17019 #endif /* HAVE_WINDOW_SYSTEM */
17021 /* We go to this label, with fonts_changed set, if it is
17022 necessary to try again using larger glyph matrices.
17023 We have to redeem the scroll bar even in this case,
17024 because the loop in redisplay_internal expects that. */
17025 need_larger_matrices
:
17027 finish_scroll_bars
:
17029 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
17031 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
17032 /* Set the thumb's position and size. */
17033 set_vertical_scroll_bar (w
);
17035 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
17036 /* Set the thumb's position and size. */
17037 set_horizontal_scroll_bar (w
);
17039 /* Note that we actually used the scroll bar attached to this
17040 window, so it shouldn't be deleted at the end of redisplay. */
17041 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
17042 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
17045 /* Restore current_buffer and value of point in it. The window
17046 update may have changed the buffer, so first make sure `opoint'
17047 is still valid (Bug#6177). */
17048 if (CHARPOS (opoint
) < BEGV
)
17049 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
17050 else if (CHARPOS (opoint
) > ZV
)
17051 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
17053 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
17055 set_buffer_internal_1 (old
);
17056 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
17057 shorter. This can be caused by log truncation in *Messages*. */
17058 if (CHARPOS (lpoint
) <= ZV
)
17059 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
17061 unbind_to (count
, Qnil
);
17065 /* Build the complete desired matrix of WINDOW with a window start
17066 buffer position POS.
17068 Value is 1 if successful. It is zero if fonts were loaded during
17069 redisplay which makes re-adjusting glyph matrices necessary, and -1
17070 if point would appear in the scroll margins.
17071 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
17072 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
17076 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
17078 struct window
*w
= XWINDOW (window
);
17080 struct glyph_row
*last_text_row
= NULL
;
17081 struct frame
*f
= XFRAME (w
->frame
);
17082 int frame_line_height
= default_line_pixel_height (w
);
17084 /* Make POS the new window start. */
17085 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
17087 /* Mark cursor position as unknown. No overlay arrow seen. */
17088 w
->cursor
.vpos
= -1;
17089 overlay_arrow_seen
= false;
17091 /* Initialize iterator and info to start at POS. */
17092 start_display (&it
, w
, pos
);
17093 it
.glyph_row
->reversed_p
= false;
17095 /* Display all lines of W. */
17096 while (it
.current_y
< it
.last_visible_y
)
17098 if (display_line (&it
))
17099 last_text_row
= it
.glyph_row
- 1;
17100 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
17104 /* Don't let the cursor end in the scroll margins. */
17105 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
17106 && !MINI_WINDOW_P (w
))
17108 int this_scroll_margin
;
17109 int window_total_lines
17110 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
17112 if (scroll_margin
> 0)
17114 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
17115 this_scroll_margin
*= frame_line_height
;
17118 this_scroll_margin
= 0;
17120 if ((w
->cursor
.y
>= 0 /* not vscrolled */
17121 && w
->cursor
.y
< this_scroll_margin
17122 && CHARPOS (pos
) > BEGV
17123 && IT_CHARPOS (it
) < ZV
)
17124 /* rms: considering make_cursor_line_fully_visible_p here
17125 seems to give wrong results. We don't want to recenter
17126 when the last line is partly visible, we want to allow
17127 that case to be handled in the usual way. */
17128 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
17130 w
->cursor
.vpos
= -1;
17131 clear_glyph_matrix (w
->desired_matrix
);
17136 /* If bottom moved off end of frame, change mode line percentage. */
17137 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
17138 w
->update_mode_line
= true;
17140 /* Set window_end_pos to the offset of the last character displayed
17141 on the window from the end of current_buffer. Set
17142 window_end_vpos to its row number. */
17145 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
17146 adjust_window_ends (w
, last_text_row
, false);
17148 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
17149 w
->window_end_vpos
)));
17153 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17154 w
->window_end_pos
= Z
- ZV
;
17155 w
->window_end_vpos
= 0;
17158 /* But that is not valid info until redisplay finishes. */
17159 w
->window_end_valid
= false;
17165 /************************************************************************
17166 Window redisplay reusing current matrix when buffer has not changed
17167 ************************************************************************/
17169 /* Try redisplay of window W showing an unchanged buffer with a
17170 different window start than the last time it was displayed by
17171 reusing its current matrix. Value is true if successful.
17172 W->start is the new window start. */
17175 try_window_reusing_current_matrix (struct window
*w
)
17177 struct frame
*f
= XFRAME (w
->frame
);
17178 struct glyph_row
*bottom_row
;
17181 struct text_pos start
, new_start
;
17182 int nrows_scrolled
, i
;
17183 struct glyph_row
*last_text_row
;
17184 struct glyph_row
*last_reused_text_row
;
17185 struct glyph_row
*start_row
;
17186 int start_vpos
, min_y
, max_y
;
17189 if (inhibit_try_window_reusing
)
17193 if (/* This function doesn't handle terminal frames. */
17194 !FRAME_WINDOW_P (f
)
17195 /* Don't try to reuse the display if windows have been split
17197 || windows_or_buffers_changed
17198 || f
->cursor_type_changed
)
17201 /* Can't do this if showing trailing whitespace. */
17202 if (!NILP (Vshow_trailing_whitespace
))
17205 /* If top-line visibility has changed, give up. */
17206 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17207 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17210 /* Give up if old or new display is scrolled vertically. We could
17211 make this function handle this, but right now it doesn't. */
17212 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17213 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17216 /* The variable new_start now holds the new window start. The old
17217 start `start' can be determined from the current matrix. */
17218 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17219 start
= start_row
->minpos
;
17220 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17222 /* Clear the desired matrix for the display below. */
17223 clear_glyph_matrix (w
->desired_matrix
);
17225 if (CHARPOS (new_start
) <= CHARPOS (start
))
17227 /* Don't use this method if the display starts with an ellipsis
17228 displayed for invisible text. It's not easy to handle that case
17229 below, and it's certainly not worth the effort since this is
17230 not a frequent case. */
17231 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17234 IF_DEBUG (debug_method_add (w
, "twu1"));
17236 /* Display up to a row that can be reused. The variable
17237 last_text_row is set to the last row displayed that displays
17238 text. Note that it.vpos == 0 if or if not there is a
17239 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17240 start_display (&it
, w
, new_start
);
17241 w
->cursor
.vpos
= -1;
17242 last_text_row
= last_reused_text_row
= NULL
;
17244 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17246 /* If we have reached into the characters in the START row,
17247 that means the line boundaries have changed. So we
17248 can't start copying with the row START. Maybe it will
17249 work to start copying with the following row. */
17250 while (IT_CHARPOS (it
) > CHARPOS (start
))
17252 /* Advance to the next row as the "start". */
17254 start
= start_row
->minpos
;
17255 /* If there are no more rows to try, or just one, give up. */
17256 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17257 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17258 || CHARPOS (start
) == ZV
)
17260 clear_glyph_matrix (w
->desired_matrix
);
17264 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17266 /* If we have reached alignment, we can copy the rest of the
17268 if (IT_CHARPOS (it
) == CHARPOS (start
)
17269 /* Don't accept "alignment" inside a display vector,
17270 since start_row could have started in the middle of
17271 that same display vector (thus their character
17272 positions match), and we have no way of telling if
17273 that is the case. */
17274 && it
.current
.dpvec_index
< 0)
17277 it
.glyph_row
->reversed_p
= false;
17278 if (display_line (&it
))
17279 last_text_row
= it
.glyph_row
- 1;
17283 /* A value of current_y < last_visible_y means that we stopped
17284 at the previous window start, which in turn means that we
17285 have at least one reusable row. */
17286 if (it
.current_y
< it
.last_visible_y
)
17288 struct glyph_row
*row
;
17290 /* IT.vpos always starts from 0; it counts text lines. */
17291 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17293 /* Find PT if not already found in the lines displayed. */
17294 if (w
->cursor
.vpos
< 0)
17296 int dy
= it
.current_y
- start_row
->y
;
17298 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17299 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17301 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17302 dy
, nrows_scrolled
);
17305 clear_glyph_matrix (w
->desired_matrix
);
17310 /* Scroll the display. Do it before the current matrix is
17311 changed. The problem here is that update has not yet
17312 run, i.e. part of the current matrix is not up to date.
17313 scroll_run_hook will clear the cursor, and use the
17314 current matrix to get the height of the row the cursor is
17316 run
.current_y
= start_row
->y
;
17317 run
.desired_y
= it
.current_y
;
17318 run
.height
= it
.last_visible_y
- it
.current_y
;
17320 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17323 FRAME_RIF (f
)->update_window_begin_hook (w
);
17324 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17325 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17326 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17330 /* Shift current matrix down by nrows_scrolled lines. */
17331 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17332 rotate_matrix (w
->current_matrix
,
17334 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17337 /* Disable lines that must be updated. */
17338 for (i
= 0; i
< nrows_scrolled
; ++i
)
17339 (start_row
+ i
)->enabled_p
= false;
17341 /* Re-compute Y positions. */
17342 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17343 max_y
= it
.last_visible_y
;
17344 for (row
= start_row
+ nrows_scrolled
;
17348 row
->y
= it
.current_y
;
17349 row
->visible_height
= row
->height
;
17351 if (row
->y
< min_y
)
17352 row
->visible_height
-= min_y
- row
->y
;
17353 if (row
->y
+ row
->height
> max_y
)
17354 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17355 if (row
->fringe_bitmap_periodic_p
)
17356 row
->redraw_fringe_bitmaps_p
= true;
17358 it
.current_y
+= row
->height
;
17360 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17361 last_reused_text_row
= row
;
17362 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17366 /* Disable lines in the current matrix which are now
17367 below the window. */
17368 for (++row
; row
< bottom_row
; ++row
)
17369 row
->enabled_p
= row
->mode_line_p
= false;
17372 /* Update window_end_pos etc.; last_reused_text_row is the last
17373 reused row from the current matrix containing text, if any.
17374 The value of last_text_row is the last displayed line
17375 containing text. */
17376 if (last_reused_text_row
)
17377 adjust_window_ends (w
, last_reused_text_row
, true);
17378 else if (last_text_row
)
17379 adjust_window_ends (w
, last_text_row
, false);
17382 /* This window must be completely empty. */
17383 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17384 w
->window_end_pos
= Z
- ZV
;
17385 w
->window_end_vpos
= 0;
17387 w
->window_end_valid
= false;
17389 /* Update hint: don't try scrolling again in update_window. */
17390 w
->desired_matrix
->no_scrolling_p
= true;
17393 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17397 else if (CHARPOS (new_start
) > CHARPOS (start
))
17399 struct glyph_row
*pt_row
, *row
;
17400 struct glyph_row
*first_reusable_row
;
17401 struct glyph_row
*first_row_to_display
;
17403 int yb
= window_text_bottom_y (w
);
17405 /* Find the row starting at new_start, if there is one. Don't
17406 reuse a partially visible line at the end. */
17407 first_reusable_row
= start_row
;
17408 while (first_reusable_row
->enabled_p
17409 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17410 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17411 < CHARPOS (new_start
)))
17412 ++first_reusable_row
;
17414 /* Give up if there is no row to reuse. */
17415 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17416 || !first_reusable_row
->enabled_p
17417 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17418 != CHARPOS (new_start
)))
17421 /* We can reuse fully visible rows beginning with
17422 first_reusable_row to the end of the window. Set
17423 first_row_to_display to the first row that cannot be reused.
17424 Set pt_row to the row containing point, if there is any. */
17426 for (first_row_to_display
= first_reusable_row
;
17427 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17428 ++first_row_to_display
)
17430 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17431 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17432 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17433 && first_row_to_display
->ends_at_zv_p
17434 && pt_row
== NULL
)))
17435 pt_row
= first_row_to_display
;
17438 /* Start displaying at the start of first_row_to_display. */
17439 eassert (first_row_to_display
->y
< yb
);
17440 init_to_row_start (&it
, w
, first_row_to_display
);
17442 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17444 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17446 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17447 + WINDOW_HEADER_LINE_HEIGHT (w
));
17449 /* Display lines beginning with first_row_to_display in the
17450 desired matrix. Set last_text_row to the last row displayed
17451 that displays text. */
17452 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17453 if (pt_row
== NULL
)
17454 w
->cursor
.vpos
= -1;
17455 last_text_row
= NULL
;
17456 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17457 if (display_line (&it
))
17458 last_text_row
= it
.glyph_row
- 1;
17460 /* If point is in a reused row, adjust y and vpos of the cursor
17464 w
->cursor
.vpos
-= nrows_scrolled
;
17465 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17468 /* Give up if point isn't in a row displayed or reused. (This
17469 also handles the case where w->cursor.vpos < nrows_scrolled
17470 after the calls to display_line, which can happen with scroll
17471 margins. See bug#1295.) */
17472 if (w
->cursor
.vpos
< 0)
17474 clear_glyph_matrix (w
->desired_matrix
);
17478 /* Scroll the display. */
17479 run
.current_y
= first_reusable_row
->y
;
17480 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17481 run
.height
= it
.last_visible_y
- run
.current_y
;
17482 dy
= run
.current_y
- run
.desired_y
;
17487 FRAME_RIF (f
)->update_window_begin_hook (w
);
17488 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17489 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17490 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17494 /* Adjust Y positions of reused rows. */
17495 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17496 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17497 max_y
= it
.last_visible_y
;
17498 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17501 row
->visible_height
= row
->height
;
17502 if (row
->y
< min_y
)
17503 row
->visible_height
-= min_y
- row
->y
;
17504 if (row
->y
+ row
->height
> max_y
)
17505 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17506 if (row
->fringe_bitmap_periodic_p
)
17507 row
->redraw_fringe_bitmaps_p
= true;
17510 /* Scroll the current matrix. */
17511 eassert (nrows_scrolled
> 0);
17512 rotate_matrix (w
->current_matrix
,
17514 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17517 /* Disable rows not reused. */
17518 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17519 row
->enabled_p
= false;
17521 /* Point may have moved to a different line, so we cannot assume that
17522 the previous cursor position is valid; locate the correct row. */
17525 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17527 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17528 && !row
->ends_at_zv_p
;
17532 w
->cursor
.y
= row
->y
;
17534 if (row
< bottom_row
)
17536 /* Can't simply scan the row for point with
17537 bidi-reordered glyph rows. Let set_cursor_from_row
17538 figure out where to put the cursor, and if it fails,
17540 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17542 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17545 clear_glyph_matrix (w
->desired_matrix
);
17551 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17552 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17555 && (!BUFFERP (glyph
->object
)
17556 || glyph
->charpos
< PT
);
17560 w
->cursor
.x
+= glyph
->pixel_width
;
17566 /* Adjust window end. A null value of last_text_row means that
17567 the window end is in reused rows which in turn means that
17568 only its vpos can have changed. */
17570 adjust_window_ends (w
, last_text_row
, false);
17572 w
->window_end_vpos
-= nrows_scrolled
;
17574 w
->window_end_valid
= false;
17575 w
->desired_matrix
->no_scrolling_p
= true;
17578 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17588 /************************************************************************
17589 Window redisplay reusing current matrix when buffer has changed
17590 ************************************************************************/
17592 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17593 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17594 ptrdiff_t *, ptrdiff_t *);
17595 static struct glyph_row
*
17596 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17597 struct glyph_row
*);
17600 /* Return the last row in MATRIX displaying text. If row START is
17601 non-null, start searching with that row. IT gives the dimensions
17602 of the display. Value is null if matrix is empty; otherwise it is
17603 a pointer to the row found. */
17605 static struct glyph_row
*
17606 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17607 struct glyph_row
*start
)
17609 struct glyph_row
*row
, *row_found
;
17611 /* Set row_found to the last row in IT->w's current matrix
17612 displaying text. The loop looks funny but think of partially
17615 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17616 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17618 eassert (row
->enabled_p
);
17620 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17629 /* Return the last row in the current matrix of W that is not affected
17630 by changes at the start of current_buffer that occurred since W's
17631 current matrix was built. Value is null if no such row exists.
17633 BEG_UNCHANGED us the number of characters unchanged at the start of
17634 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17635 first changed character in current_buffer. Characters at positions <
17636 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17637 when the current matrix was built. */
17639 static struct glyph_row
*
17640 find_last_unchanged_at_beg_row (struct window
*w
)
17642 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17643 struct glyph_row
*row
;
17644 struct glyph_row
*row_found
= NULL
;
17645 int yb
= window_text_bottom_y (w
);
17647 /* Find the last row displaying unchanged text. */
17648 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17649 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17650 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17653 if (/* If row ends before first_changed_pos, it is unchanged,
17654 except in some case. */
17655 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17656 /* When row ends in ZV and we write at ZV it is not
17658 && !row
->ends_at_zv_p
17659 /* When first_changed_pos is the end of a continued line,
17660 row is not unchanged because it may be no longer
17662 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17663 && (row
->continued_p
17664 || row
->exact_window_width_line_p
))
17665 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17666 needs to be recomputed, so don't consider this row as
17667 unchanged. This happens when the last line was
17668 bidi-reordered and was killed immediately before this
17669 redisplay cycle. In that case, ROW->end stores the
17670 buffer position of the first visual-order character of
17671 the killed text, which is now beyond ZV. */
17672 && CHARPOS (row
->end
.pos
) <= ZV
)
17675 /* Stop if last visible row. */
17676 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17684 /* Find the first glyph row in the current matrix of W that is not
17685 affected by changes at the end of current_buffer since the
17686 time W's current matrix was built.
17688 Return in *DELTA the number of chars by which buffer positions in
17689 unchanged text at the end of current_buffer must be adjusted.
17691 Return in *DELTA_BYTES the corresponding number of bytes.
17693 Value is null if no such row exists, i.e. all rows are affected by
17696 static struct glyph_row
*
17697 find_first_unchanged_at_end_row (struct window
*w
,
17698 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17700 struct glyph_row
*row
;
17701 struct glyph_row
*row_found
= NULL
;
17703 *delta
= *delta_bytes
= 0;
17705 /* Display must not have been paused, otherwise the current matrix
17706 is not up to date. */
17707 eassert (w
->window_end_valid
);
17709 /* A value of window_end_pos >= END_UNCHANGED means that the window
17710 end is in the range of changed text. If so, there is no
17711 unchanged row at the end of W's current matrix. */
17712 if (w
->window_end_pos
>= END_UNCHANGED
)
17715 /* Set row to the last row in W's current matrix displaying text. */
17716 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17718 /* If matrix is entirely empty, no unchanged row exists. */
17719 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17721 /* The value of row is the last glyph row in the matrix having a
17722 meaningful buffer position in it. The end position of row
17723 corresponds to window_end_pos. This allows us to translate
17724 buffer positions in the current matrix to current buffer
17725 positions for characters not in changed text. */
17727 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17728 ptrdiff_t Z_BYTE_old
=
17729 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17730 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17731 struct glyph_row
*first_text_row
17732 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17734 *delta
= Z
- Z_old
;
17735 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17737 /* Set last_unchanged_pos to the buffer position of the last
17738 character in the buffer that has not been changed. Z is the
17739 index + 1 of the last character in current_buffer, i.e. by
17740 subtracting END_UNCHANGED we get the index of the last
17741 unchanged character, and we have to add BEG to get its buffer
17743 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17744 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17746 /* Search backward from ROW for a row displaying a line that
17747 starts at a minimum position >= last_unchanged_pos_old. */
17748 for (; row
> first_text_row
; --row
)
17750 /* This used to abort, but it can happen.
17751 It is ok to just stop the search instead here. KFS. */
17752 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17755 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17760 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17766 /* Make sure that glyph rows in the current matrix of window W
17767 reference the same glyph memory as corresponding rows in the
17768 frame's frame matrix. This function is called after scrolling W's
17769 current matrix on a terminal frame in try_window_id and
17770 try_window_reusing_current_matrix. */
17773 sync_frame_with_window_matrix_rows (struct window
*w
)
17775 struct frame
*f
= XFRAME (w
->frame
);
17776 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17778 /* Preconditions: W must be a leaf window and full-width. Its frame
17779 must have a frame matrix. */
17780 eassert (BUFFERP (w
->contents
));
17781 eassert (WINDOW_FULL_WIDTH_P (w
));
17782 eassert (!FRAME_WINDOW_P (f
));
17784 /* If W is a full-width window, glyph pointers in W's current matrix
17785 have, by definition, to be the same as glyph pointers in the
17786 corresponding frame matrix. Note that frame matrices have no
17787 marginal areas (see build_frame_matrix). */
17788 window_row
= w
->current_matrix
->rows
;
17789 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17790 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17791 while (window_row
< window_row_end
)
17793 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17794 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17796 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17797 frame_row
->glyphs
[TEXT_AREA
] = start
;
17798 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17799 frame_row
->glyphs
[LAST_AREA
] = end
;
17801 /* Disable frame rows whose corresponding window rows have
17802 been disabled in try_window_id. */
17803 if (!window_row
->enabled_p
)
17804 frame_row
->enabled_p
= false;
17806 ++window_row
, ++frame_row
;
17811 /* Find the glyph row in window W containing CHARPOS. Consider all
17812 rows between START and END (not inclusive). END null means search
17813 all rows to the end of the display area of W. Value is the row
17814 containing CHARPOS or null. */
17817 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17818 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17820 struct glyph_row
*row
= start
;
17821 struct glyph_row
*best_row
= NULL
;
17822 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17825 /* If we happen to start on a header-line, skip that. */
17826 if (row
->mode_line_p
)
17829 if ((end
&& row
>= end
) || !row
->enabled_p
)
17832 last_y
= window_text_bottom_y (w
) - dy
;
17836 /* Give up if we have gone too far. */
17837 if ((end
&& row
>= end
) || !row
->enabled_p
)
17839 /* This formerly returned if they were equal.
17840 I think that both quantities are of a "last plus one" type;
17841 if so, when they are equal, the row is within the screen. -- rms. */
17842 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17845 /* If it is in this row, return this row. */
17846 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17847 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17848 /* The end position of a row equals the start
17849 position of the next row. If CHARPOS is there, we
17850 would rather consider it displayed in the next
17851 line, except when this line ends in ZV. */
17852 && !row_for_charpos_p (row
, charpos
)))
17853 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17857 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17858 || (!best_row
&& !row
->continued_p
))
17860 /* In bidi-reordered rows, there could be several rows whose
17861 edges surround CHARPOS, all of these rows belonging to
17862 the same continued line. We need to find the row which
17863 fits CHARPOS the best. */
17864 for (g
= row
->glyphs
[TEXT_AREA
];
17865 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17868 if (!STRINGP (g
->object
))
17870 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17872 mindif
= eabs (g
->charpos
- charpos
);
17874 /* Exact match always wins. */
17881 else if (best_row
&& !row
->continued_p
)
17888 /* Try to redisplay window W by reusing its existing display. W's
17889 current matrix must be up to date when this function is called,
17890 i.e., window_end_valid must be true.
17894 >= 1 if successful, i.e. display has been updated
17896 1 means the changes were in front of a newline that precedes
17897 the window start, and the whole current matrix was reused
17898 2 means the changes were after the last position displayed
17899 in the window, and the whole current matrix was reused
17900 3 means portions of the current matrix were reused, while
17901 some of the screen lines were redrawn
17902 -1 if redisplay with same window start is known not to succeed
17903 0 if otherwise unsuccessful
17905 The following steps are performed:
17907 1. Find the last row in the current matrix of W that is not
17908 affected by changes at the start of current_buffer. If no such row
17911 2. Find the first row in W's current matrix that is not affected by
17912 changes at the end of current_buffer. Maybe there is no such row.
17914 3. Display lines beginning with the row + 1 found in step 1 to the
17915 row found in step 2 or, if step 2 didn't find a row, to the end of
17918 4. If cursor is not known to appear on the window, give up.
17920 5. If display stopped at the row found in step 2, scroll the
17921 display and current matrix as needed.
17923 6. Maybe display some lines at the end of W, if we must. This can
17924 happen under various circumstances, like a partially visible line
17925 becoming fully visible, or because newly displayed lines are displayed
17926 in smaller font sizes.
17928 7. Update W's window end information. */
17931 try_window_id (struct window
*w
)
17933 struct frame
*f
= XFRAME (w
->frame
);
17934 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17935 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17936 struct glyph_row
*last_unchanged_at_beg_row
;
17937 struct glyph_row
*first_unchanged_at_end_row
;
17938 struct glyph_row
*row
;
17939 struct glyph_row
*bottom_row
;
17942 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17944 struct text_pos start_pos
;
17946 int first_unchanged_at_end_vpos
= 0;
17947 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17948 struct text_pos start
;
17949 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17952 if (inhibit_try_window_id
)
17956 /* This is handy for debugging. */
17958 #define GIVE_UP(X) \
17960 TRACE ((stderr, "try_window_id give up %d\n", (X))); \
17964 #define GIVE_UP(X) return 0
17967 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17969 /* Don't use this for mini-windows because these can show
17970 messages and mini-buffers, and we don't handle that here. */
17971 if (MINI_WINDOW_P (w
))
17974 /* This flag is used to prevent redisplay optimizations. */
17975 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17978 /* This function's optimizations cannot be used if overlays have
17979 changed in the buffer displayed by the window, so give up if they
17981 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17984 /* Verify that narrowing has not changed.
17985 Also verify that we were not told to prevent redisplay optimizations.
17986 It would be nice to further
17987 reduce the number of cases where this prevents try_window_id. */
17988 if (current_buffer
->clip_changed
17989 || current_buffer
->prevent_redisplay_optimizations_p
)
17992 /* Window must either use window-based redisplay or be full width. */
17993 if (!FRAME_WINDOW_P (f
)
17994 && (!FRAME_LINE_INS_DEL_OK (f
)
17995 || !WINDOW_FULL_WIDTH_P (w
)))
17998 /* Give up if point is known NOT to appear in W. */
17999 if (PT
< CHARPOS (start
))
18002 /* Another way to prevent redisplay optimizations. */
18003 if (w
->last_modified
== 0)
18006 /* Verify that window is not hscrolled. */
18007 if (w
->hscroll
!= 0)
18010 /* Verify that display wasn't paused. */
18011 if (!w
->window_end_valid
)
18014 /* Likewise if highlighting trailing whitespace. */
18015 if (!NILP (Vshow_trailing_whitespace
))
18018 /* Can't use this if overlay arrow position and/or string have
18020 if (overlay_arrows_changed_p ())
18023 /* When word-wrap is on, adding a space to the first word of a
18024 wrapped line can change the wrap position, altering the line
18025 above it. It might be worthwhile to handle this more
18026 intelligently, but for now just redisplay from scratch. */
18027 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
18030 /* Under bidi reordering, adding or deleting a character in the
18031 beginning of a paragraph, before the first strong directional
18032 character, can change the base direction of the paragraph (unless
18033 the buffer specifies a fixed paragraph direction), which will
18034 require to redisplay the whole paragraph. It might be worthwhile
18035 to find the paragraph limits and widen the range of redisplayed
18036 lines to that, but for now just give up this optimization and
18037 redisplay from scratch. */
18038 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
18039 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
18042 /* Give up if the buffer has line-spacing set, as Lisp-level changes
18043 to that variable require thorough redisplay. */
18044 if (!NILP (BVAR (XBUFFER (w
->contents
), extra_line_spacing
)))
18047 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
18048 only if buffer has really changed. The reason is that the gap is
18049 initially at Z for freshly visited files. The code below would
18050 set end_unchanged to 0 in that case. */
18051 if (MODIFF
> SAVE_MODIFF
18052 /* This seems to happen sometimes after saving a buffer. */
18053 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
18055 if (GPT
- BEG
< BEG_UNCHANGED
)
18056 BEG_UNCHANGED
= GPT
- BEG
;
18057 if (Z
- GPT
< END_UNCHANGED
)
18058 END_UNCHANGED
= Z
- GPT
;
18061 /* The position of the first and last character that has been changed. */
18062 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
18063 last_changed_charpos
= Z
- END_UNCHANGED
;
18065 /* If window starts after a line end, and the last change is in
18066 front of that newline, then changes don't affect the display.
18067 This case happens with stealth-fontification. Note that although
18068 the display is unchanged, glyph positions in the matrix have to
18069 be adjusted, of course. */
18070 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
18071 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
18072 && ((last_changed_charpos
< CHARPOS (start
)
18073 && CHARPOS (start
) == BEGV
)
18074 || (last_changed_charpos
< CHARPOS (start
) - 1
18075 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
18077 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
18078 struct glyph_row
*r0
;
18080 /* Compute how many chars/bytes have been added to or removed
18081 from the buffer. */
18082 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
18083 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
18084 Z_delta
= Z
- Z_old
;
18085 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
18087 /* Give up if PT is not in the window. Note that it already has
18088 been checked at the start of try_window_id that PT is not in
18089 front of the window start. */
18090 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
18093 /* If window start is unchanged, we can reuse the whole matrix
18094 as is, after adjusting glyph positions. No need to compute
18095 the window end again, since its offset from Z hasn't changed. */
18096 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18097 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
18098 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
18099 /* PT must not be in a partially visible line. */
18100 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
18101 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18103 /* Adjust positions in the glyph matrix. */
18104 if (Z_delta
|| Z_delta_bytes
)
18106 struct glyph_row
*r1
18107 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18108 increment_matrix_positions (w
->current_matrix
,
18109 MATRIX_ROW_VPOS (r0
, current_matrix
),
18110 MATRIX_ROW_VPOS (r1
, current_matrix
),
18111 Z_delta
, Z_delta_bytes
);
18114 /* Set the cursor. */
18115 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18117 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18122 /* Handle the case that changes are all below what is displayed in
18123 the window, and that PT is in the window. This shortcut cannot
18124 be taken if ZV is visible in the window, and text has been added
18125 there that is visible in the window. */
18126 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
18127 /* ZV is not visible in the window, or there are no
18128 changes at ZV, actually. */
18129 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
18130 || first_changed_charpos
== last_changed_charpos
))
18132 struct glyph_row
*r0
;
18134 /* Give up if PT is not in the window. Note that it already has
18135 been checked at the start of try_window_id that PT is not in
18136 front of the window start. */
18137 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
18140 /* If window start is unchanged, we can reuse the whole matrix
18141 as is, without changing glyph positions since no text has
18142 been added/removed in front of the window end. */
18143 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18144 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
18145 /* PT must not be in a partially visible line. */
18146 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
18147 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18149 /* We have to compute the window end anew since text
18150 could have been added/removed after it. */
18151 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18152 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18154 /* Set the cursor. */
18155 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18157 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18162 /* Give up if window start is in the changed area.
18164 The condition used to read
18166 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18168 but why that was tested escapes me at the moment. */
18169 if (CHARPOS (start
) >= first_changed_charpos
18170 && CHARPOS (start
) <= last_changed_charpos
)
18173 /* Check that window start agrees with the start of the first glyph
18174 row in its current matrix. Check this after we know the window
18175 start is not in changed text, otherwise positions would not be
18177 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18178 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
18181 /* Give up if the window ends in strings. Overlay strings
18182 at the end are difficult to handle, so don't try. */
18183 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
18184 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
18187 /* Compute the position at which we have to start displaying new
18188 lines. Some of the lines at the top of the window might be
18189 reusable because they are not displaying changed text. Find the
18190 last row in W's current matrix not affected by changes at the
18191 start of current_buffer. Value is null if changes start in the
18192 first line of window. */
18193 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18194 if (last_unchanged_at_beg_row
)
18196 /* Avoid starting to display in the middle of a character, a TAB
18197 for instance. This is easier than to set up the iterator
18198 exactly, and it's not a frequent case, so the additional
18199 effort wouldn't really pay off. */
18200 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18201 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18202 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18203 --last_unchanged_at_beg_row
;
18205 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18208 if (! init_to_row_end (&it
, w
, last_unchanged_at_beg_row
))
18210 start_pos
= it
.current
.pos
;
18212 /* Start displaying new lines in the desired matrix at the same
18213 vpos we would use in the current matrix, i.e. below
18214 last_unchanged_at_beg_row. */
18215 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18217 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18218 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18220 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18224 /* There are no reusable lines at the start of the window.
18225 Start displaying in the first text line. */
18226 start_display (&it
, w
, start
);
18227 it
.vpos
= it
.first_vpos
;
18228 start_pos
= it
.current
.pos
;
18231 /* Find the first row that is not affected by changes at the end of
18232 the buffer. Value will be null if there is no unchanged row, in
18233 which case we must redisplay to the end of the window. delta
18234 will be set to the value by which buffer positions beginning with
18235 first_unchanged_at_end_row have to be adjusted due to text
18237 first_unchanged_at_end_row
18238 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18239 IF_DEBUG (debug_delta
= delta
);
18240 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18242 /* Set stop_pos to the buffer position up to which we will have to
18243 display new lines. If first_unchanged_at_end_row != NULL, this
18244 is the buffer position of the start of the line displayed in that
18245 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18246 that we don't stop at a buffer position. */
18248 if (first_unchanged_at_end_row
)
18250 eassert (last_unchanged_at_beg_row
== NULL
18251 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18253 /* If this is a continuation line, move forward to the next one
18254 that isn't. Changes in lines above affect this line.
18255 Caution: this may move first_unchanged_at_end_row to a row
18256 not displaying text. */
18257 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18258 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18259 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18260 < it
.last_visible_y
))
18261 ++first_unchanged_at_end_row
;
18263 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18264 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18265 >= it
.last_visible_y
))
18266 first_unchanged_at_end_row
= NULL
;
18269 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18271 first_unchanged_at_end_vpos
18272 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18273 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18276 else if (last_unchanged_at_beg_row
== NULL
)
18282 /* Either there is no unchanged row at the end, or the one we have
18283 now displays text. This is a necessary condition for the window
18284 end pos calculation at the end of this function. */
18285 eassert (first_unchanged_at_end_row
== NULL
18286 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18288 debug_last_unchanged_at_beg_vpos
18289 = (last_unchanged_at_beg_row
18290 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18292 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18294 #endif /* GLYPH_DEBUG */
18297 /* Display new lines. Set last_text_row to the last new line
18298 displayed which has text on it, i.e. might end up as being the
18299 line where the window_end_vpos is. */
18300 w
->cursor
.vpos
= -1;
18301 last_text_row
= NULL
;
18302 overlay_arrow_seen
= false;
18303 if (it
.current_y
< it
.last_visible_y
18304 && !f
->fonts_changed
18305 && (first_unchanged_at_end_row
== NULL
18306 || IT_CHARPOS (it
) < stop_pos
))
18307 it
.glyph_row
->reversed_p
= false;
18308 while (it
.current_y
< it
.last_visible_y
18309 && !f
->fonts_changed
18310 && (first_unchanged_at_end_row
== NULL
18311 || IT_CHARPOS (it
) < stop_pos
))
18313 if (display_line (&it
))
18314 last_text_row
= it
.glyph_row
- 1;
18317 if (f
->fonts_changed
)
18320 /* The redisplay iterations in display_line above could have
18321 triggered font-lock, which could have done something that
18322 invalidates IT->w window's end-point information, on which we
18323 rely below. E.g., one package, which will remain unnamed, used
18324 to install a font-lock-fontify-region-function that called
18325 bury-buffer, whose side effect is to switch the buffer displayed
18326 by IT->w, and that predictably resets IT->w's window_end_valid
18327 flag, which we already tested at the entry to this function.
18328 Amply punish such packages/modes by giving up on this
18329 optimization in those cases. */
18330 if (!w
->window_end_valid
)
18332 clear_glyph_matrix (w
->desired_matrix
);
18336 /* Compute differences in buffer positions, y-positions etc. for
18337 lines reused at the bottom of the window. Compute what we can
18339 if (first_unchanged_at_end_row
18340 /* No lines reused because we displayed everything up to the
18341 bottom of the window. */
18342 && it
.current_y
< it
.last_visible_y
)
18345 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18347 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18348 run
.current_y
= first_unchanged_at_end_row
->y
;
18349 run
.desired_y
= run
.current_y
+ dy
;
18350 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18354 delta
= delta_bytes
= dvpos
= dy
18355 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18356 first_unchanged_at_end_row
= NULL
;
18358 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18361 /* Find the cursor if not already found. We have to decide whether
18362 PT will appear on this window (it sometimes doesn't, but this is
18363 not a very frequent case.) This decision has to be made before
18364 the current matrix is altered. A value of cursor.vpos < 0 means
18365 that PT is either in one of the lines beginning at
18366 first_unchanged_at_end_row or below the window. Don't care for
18367 lines that might be displayed later at the window end; as
18368 mentioned, this is not a frequent case. */
18369 if (w
->cursor
.vpos
< 0)
18371 /* Cursor in unchanged rows at the top? */
18372 if (PT
< CHARPOS (start_pos
)
18373 && last_unchanged_at_beg_row
)
18375 row
= row_containing_pos (w
, PT
,
18376 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18377 last_unchanged_at_beg_row
+ 1, 0);
18379 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18382 /* Start from first_unchanged_at_end_row looking for PT. */
18383 else if (first_unchanged_at_end_row
)
18385 row
= row_containing_pos (w
, PT
- delta
,
18386 first_unchanged_at_end_row
, NULL
, 0);
18388 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18389 delta_bytes
, dy
, dvpos
);
18392 /* Give up if cursor was not found. */
18393 if (w
->cursor
.vpos
< 0)
18395 clear_glyph_matrix (w
->desired_matrix
);
18400 /* Don't let the cursor end in the scroll margins. */
18402 int this_scroll_margin
, cursor_height
;
18403 int frame_line_height
= default_line_pixel_height (w
);
18404 int window_total_lines
18405 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18407 this_scroll_margin
=
18408 max (0, min (scroll_margin
, window_total_lines
/ 4));
18409 this_scroll_margin
*= frame_line_height
;
18410 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18412 if ((w
->cursor
.y
< this_scroll_margin
18413 && CHARPOS (start
) > BEGV
)
18414 /* Old redisplay didn't take scroll margin into account at the bottom,
18415 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18416 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18417 ? cursor_height
+ this_scroll_margin
18418 : 1)) > it
.last_visible_y
)
18420 w
->cursor
.vpos
= -1;
18421 clear_glyph_matrix (w
->desired_matrix
);
18426 /* Scroll the display. Do it before changing the current matrix so
18427 that xterm.c doesn't get confused about where the cursor glyph is
18429 if (dy
&& run
.height
)
18433 if (FRAME_WINDOW_P (f
))
18435 FRAME_RIF (f
)->update_window_begin_hook (w
);
18436 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18437 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18438 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
18442 /* Terminal frame. In this case, dvpos gives the number of
18443 lines to scroll by; dvpos < 0 means scroll up. */
18445 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18446 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18447 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18448 + WINDOW_WANTS_HEADER_LINE_P (w
)
18449 + window_internal_height (w
));
18451 #if defined (HAVE_GPM) || defined (MSDOS)
18452 x_clear_window_mouse_face (w
);
18454 /* Perform the operation on the screen. */
18457 /* Scroll last_unchanged_at_beg_row to the end of the
18458 window down dvpos lines. */
18459 set_terminal_window (f
, end
);
18461 /* On dumb terminals delete dvpos lines at the end
18462 before inserting dvpos empty lines. */
18463 if (!FRAME_SCROLL_REGION_OK (f
))
18464 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18466 /* Insert dvpos empty lines in front of
18467 last_unchanged_at_beg_row. */
18468 ins_del_lines (f
, from
, dvpos
);
18470 else if (dvpos
< 0)
18472 /* Scroll up last_unchanged_at_beg_vpos to the end of
18473 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18474 set_terminal_window (f
, end
);
18476 /* Delete dvpos lines in front of
18477 last_unchanged_at_beg_vpos. ins_del_lines will set
18478 the cursor to the given vpos and emit |dvpos| delete
18480 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18482 /* On a dumb terminal insert dvpos empty lines at the
18484 if (!FRAME_SCROLL_REGION_OK (f
))
18485 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18488 set_terminal_window (f
, 0);
18494 /* Shift reused rows of the current matrix to the right position.
18495 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18497 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18498 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18501 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18502 bottom_vpos
, dvpos
);
18503 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18506 else if (dvpos
> 0)
18508 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18509 bottom_vpos
, dvpos
);
18510 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18511 first_unchanged_at_end_vpos
+ dvpos
);
18514 /* For frame-based redisplay, make sure that current frame and window
18515 matrix are in sync with respect to glyph memory. */
18516 if (!FRAME_WINDOW_P (f
))
18517 sync_frame_with_window_matrix_rows (w
);
18519 /* Adjust buffer positions in reused rows. */
18520 if (delta
|| delta_bytes
)
18521 increment_matrix_positions (current_matrix
,
18522 first_unchanged_at_end_vpos
+ dvpos
,
18523 bottom_vpos
, delta
, delta_bytes
);
18525 /* Adjust Y positions. */
18527 shift_glyph_matrix (w
, current_matrix
,
18528 first_unchanged_at_end_vpos
+ dvpos
,
18531 if (first_unchanged_at_end_row
)
18533 first_unchanged_at_end_row
+= dvpos
;
18534 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18535 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18536 first_unchanged_at_end_row
= NULL
;
18539 /* If scrolling up, there may be some lines to display at the end of
18541 last_text_row_at_end
= NULL
;
18544 /* Scrolling up can leave for example a partially visible line
18545 at the end of the window to be redisplayed. */
18546 /* Set last_row to the glyph row in the current matrix where the
18547 window end line is found. It has been moved up or down in
18548 the matrix by dvpos. */
18549 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18550 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18552 /* If last_row is the window end line, it should display text. */
18553 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18555 /* If window end line was partially visible before, begin
18556 displaying at that line. Otherwise begin displaying with the
18557 line following it. */
18558 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18560 init_to_row_start (&it
, w
, last_row
);
18561 it
.vpos
= last_vpos
;
18562 it
.current_y
= last_row
->y
;
18566 init_to_row_end (&it
, w
, last_row
);
18567 it
.vpos
= 1 + last_vpos
;
18568 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18572 /* We may start in a continuation line. If so, we have to
18573 get the right continuation_lines_width and current_x. */
18574 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18575 it
.hpos
= it
.current_x
= 0;
18577 /* Display the rest of the lines at the window end. */
18578 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18579 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18581 /* Is it always sure that the display agrees with lines in
18582 the current matrix? I don't think so, so we mark rows
18583 displayed invalid in the current matrix by setting their
18584 enabled_p flag to false. */
18585 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18586 if (display_line (&it
))
18587 last_text_row_at_end
= it
.glyph_row
- 1;
18591 /* Update window_end_pos and window_end_vpos. */
18592 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18594 /* Window end line if one of the preserved rows from the current
18595 matrix. Set row to the last row displaying text in current
18596 matrix starting at first_unchanged_at_end_row, after
18598 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18599 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18600 first_unchanged_at_end_row
);
18601 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18602 adjust_window_ends (w
, row
, true);
18603 eassert (w
->window_end_bytepos
>= 0);
18604 IF_DEBUG (debug_method_add (w
, "A"));
18606 else if (last_text_row_at_end
)
18608 adjust_window_ends (w
, last_text_row_at_end
, false);
18609 eassert (w
->window_end_bytepos
>= 0);
18610 IF_DEBUG (debug_method_add (w
, "B"));
18612 else if (last_text_row
)
18614 /* We have displayed either to the end of the window or at the
18615 end of the window, i.e. the last row with text is to be found
18616 in the desired matrix. */
18617 adjust_window_ends (w
, last_text_row
, false);
18618 eassert (w
->window_end_bytepos
>= 0);
18620 else if (first_unchanged_at_end_row
== NULL
18621 && last_text_row
== NULL
18622 && last_text_row_at_end
== NULL
)
18624 /* Displayed to end of window, but no line containing text was
18625 displayed. Lines were deleted at the end of the window. */
18626 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
18627 int vpos
= w
->window_end_vpos
;
18628 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18629 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18632 row
== NULL
&& vpos
>= first_vpos
;
18633 --vpos
, --current_row
, --desired_row
)
18635 if (desired_row
->enabled_p
)
18637 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18640 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18644 eassert (row
!= NULL
);
18645 w
->window_end_vpos
= vpos
+ 1;
18646 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18647 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18648 eassert (w
->window_end_bytepos
>= 0);
18649 IF_DEBUG (debug_method_add (w
, "C"));
18654 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18655 debug_end_vpos
= w
->window_end_vpos
));
18657 /* Record that display has not been completed. */
18658 w
->window_end_valid
= false;
18659 w
->desired_matrix
->no_scrolling_p
= true;
18667 /***********************************************************************
18668 More debugging support
18669 ***********************************************************************/
18673 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18674 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18675 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18678 /* Dump the contents of glyph matrix MATRIX on stderr.
18680 GLYPHS 0 means don't show glyph contents.
18681 GLYPHS 1 means show glyphs in short form
18682 GLYPHS > 1 means show glyphs in long form. */
18685 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18688 for (i
= 0; i
< matrix
->nrows
; ++i
)
18689 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18693 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18694 the glyph row and area where the glyph comes from. */
18697 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18699 if (glyph
->type
== CHAR_GLYPH
18700 || glyph
->type
== GLYPHLESS_GLYPH
)
18703 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18704 glyph
- row
->glyphs
[TEXT_AREA
],
18705 (glyph
->type
== CHAR_GLYPH
18709 (BUFFERP (glyph
->object
)
18711 : (STRINGP (glyph
->object
)
18713 : (NILP (glyph
->object
)
18716 glyph
->pixel_width
,
18718 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18722 glyph
->left_box_line_p
,
18723 glyph
->right_box_line_p
);
18725 else if (glyph
->type
== STRETCH_GLYPH
)
18728 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18729 glyph
- row
->glyphs
[TEXT_AREA
],
18732 (BUFFERP (glyph
->object
)
18734 : (STRINGP (glyph
->object
)
18736 : (NILP (glyph
->object
)
18739 glyph
->pixel_width
,
18743 glyph
->left_box_line_p
,
18744 glyph
->right_box_line_p
);
18746 else if (glyph
->type
== IMAGE_GLYPH
)
18749 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18750 glyph
- row
->glyphs
[TEXT_AREA
],
18753 (BUFFERP (glyph
->object
)
18755 : (STRINGP (glyph
->object
)
18757 : (NILP (glyph
->object
)
18760 glyph
->pixel_width
,
18764 glyph
->left_box_line_p
,
18765 glyph
->right_box_line_p
);
18767 else if (glyph
->type
== COMPOSITE_GLYPH
)
18770 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18771 glyph
- row
->glyphs
[TEXT_AREA
],
18774 (BUFFERP (glyph
->object
)
18776 : (STRINGP (glyph
->object
)
18778 : (NILP (glyph
->object
)
18781 glyph
->pixel_width
,
18783 if (glyph
->u
.cmp
.automatic
)
18786 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18787 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18789 glyph
->left_box_line_p
,
18790 glyph
->right_box_line_p
);
18795 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18796 GLYPHS 0 means don't show glyph contents.
18797 GLYPHS 1 means show glyphs in short form
18798 GLYPHS > 1 means show glyphs in long form. */
18801 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18805 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18806 fprintf (stderr
, "==============================================================================\n");
18808 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18809 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18811 MATRIX_ROW_START_CHARPOS (row
),
18812 MATRIX_ROW_END_CHARPOS (row
),
18813 row
->used
[TEXT_AREA
],
18814 row
->contains_overlapping_glyphs_p
,
18816 row
->truncated_on_left_p
,
18817 row
->truncated_on_right_p
,
18819 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18820 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18823 row
->ends_in_middle_of_char_p
,
18824 row
->starts_in_middle_of_char_p
,
18830 row
->visible_height
,
18833 /* The next 3 lines should align to "Start" in the header. */
18834 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18835 row
->end
.overlay_string_index
,
18836 row
->continuation_lines_width
);
18837 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18838 CHARPOS (row
->start
.string_pos
),
18839 CHARPOS (row
->end
.string_pos
));
18840 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18841 row
->end
.dpvec_index
);
18848 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18850 struct glyph
*glyph
= row
->glyphs
[area
];
18851 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18853 /* Glyph for a line end in text. */
18854 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18857 if (glyph
< glyph_end
)
18858 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18860 for (; glyph
< glyph_end
; ++glyph
)
18861 dump_glyph (row
, glyph
, area
);
18864 else if (glyphs
== 1)
18867 char s
[SHRT_MAX
+ 4];
18869 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18873 for (i
= 0; i
< row
->used
[area
]; ++i
)
18875 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18876 if (i
== row
->used
[area
] - 1
18877 && area
== TEXT_AREA
18878 && NILP (glyph
->object
)
18879 && glyph
->type
== CHAR_GLYPH
18880 && glyph
->u
.ch
== ' ')
18882 strcpy (&s
[i
], "[\\n]");
18885 else if (glyph
->type
== CHAR_GLYPH
18886 && glyph
->u
.ch
< 0x80
18887 && glyph
->u
.ch
>= ' ')
18888 s
[i
] = glyph
->u
.ch
;
18894 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18900 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18901 Sdump_glyph_matrix
, 0, 1, "p",
18902 doc
: /* Dump the current matrix of the selected window to stderr.
18903 Shows contents of glyph row structures. With non-nil
18904 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18905 glyphs in short form, otherwise show glyphs in long form.
18907 Interactively, no argument means show glyphs in short form;
18908 with numeric argument, its value is passed as the GLYPHS flag. */)
18909 (Lisp_Object glyphs
)
18911 struct window
*w
= XWINDOW (selected_window
);
18912 struct buffer
*buffer
= XBUFFER (w
->contents
);
18914 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18915 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18916 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18917 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18918 fprintf (stderr
, "=============================================\n");
18919 dump_glyph_matrix (w
->current_matrix
,
18920 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18925 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18926 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* Dump the current glyph matrix of the selected frame to stderr.
18927 Only text-mode frames have frame glyph matrices. */)
18930 struct frame
*f
= XFRAME (selected_frame
);
18932 if (f
->current_matrix
)
18933 dump_glyph_matrix (f
->current_matrix
, 1);
18935 fprintf (stderr
, "*** This frame doesn't have a frame glyph matrix ***\n");
18940 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18941 doc
: /* Dump glyph row ROW to stderr.
18942 GLYPH 0 means don't dump glyphs.
18943 GLYPH 1 means dump glyphs in short form.
18944 GLYPH > 1 or omitted means dump glyphs in long form. */)
18945 (Lisp_Object row
, Lisp_Object glyphs
)
18947 struct glyph_matrix
*matrix
;
18950 CHECK_NUMBER (row
);
18951 matrix
= XWINDOW (selected_window
)->current_matrix
;
18953 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18954 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18956 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18961 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18962 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18963 GLYPH 0 means don't dump glyphs.
18964 GLYPH 1 means dump glyphs in short form.
18965 GLYPH > 1 or omitted means dump glyphs in long form.
18967 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18969 (Lisp_Object row
, Lisp_Object glyphs
)
18971 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18972 struct frame
*sf
= SELECTED_FRAME ();
18973 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18976 CHECK_NUMBER (row
);
18978 if (vpos
>= 0 && vpos
< m
->nrows
)
18979 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18980 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18986 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18987 doc
: /* Toggle tracing of redisplay.
18988 With ARG, turn tracing on if and only if ARG is positive. */)
18992 trace_redisplay_p
= !trace_redisplay_p
;
18995 arg
= Fprefix_numeric_value (arg
);
18996 trace_redisplay_p
= XINT (arg
) > 0;
19003 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
19004 doc
: /* Like `format', but print result to stderr.
19005 usage: (trace-to-stderr STRING &rest OBJECTS) */)
19006 (ptrdiff_t nargs
, Lisp_Object
*args
)
19008 Lisp_Object s
= Fformat (nargs
, args
);
19009 fwrite (SDATA (s
), 1, SBYTES (s
), stderr
);
19013 #endif /* GLYPH_DEBUG */
19017 /***********************************************************************
19018 Building Desired Matrix Rows
19019 ***********************************************************************/
19021 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
19022 Used for non-window-redisplay windows, and for windows w/o left fringe. */
19024 static struct glyph_row
*
19025 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
19027 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19028 struct buffer
*buffer
= XBUFFER (w
->contents
);
19029 struct buffer
*old
= current_buffer
;
19030 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
19031 ptrdiff_t arrow_len
= SCHARS (overlay_arrow_string
);
19032 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
19033 const unsigned char *p
;
19036 int n_glyphs_before
;
19038 set_buffer_temp (buffer
);
19039 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
19040 scratch_glyph_row
.reversed_p
= false;
19041 it
.glyph_row
->used
[TEXT_AREA
] = 0;
19042 SET_TEXT_POS (it
.position
, 0, 0);
19044 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
19046 while (p
< arrow_end
)
19048 Lisp_Object face
, ilisp
;
19050 /* Get the next character. */
19052 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
19055 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
19056 if (! ASCII_CHAR_P (it
.c
))
19057 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
19061 /* Get its face. */
19062 ilisp
= make_number (p
- arrow_string
);
19063 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
19064 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
19066 /* Compute its width, get its glyphs. */
19067 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
19068 SET_TEXT_POS (it
.position
, -1, -1);
19069 PRODUCE_GLYPHS (&it
);
19071 /* If this character doesn't fit any more in the line, we have
19072 to remove some glyphs. */
19073 if (it
.current_x
> it
.last_visible_x
)
19075 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19080 set_buffer_temp (old
);
19081 return it
.glyph_row
;
19085 /* Insert truncation glyphs at the start of IT->glyph_row. Which
19086 glyphs to insert is determined by produce_special_glyphs. */
19089 insert_left_trunc_glyphs (struct it
*it
)
19091 struct it truncate_it
;
19092 struct glyph
*from
, *end
, *to
, *toend
;
19094 eassert (!FRAME_WINDOW_P (it
->f
)
19095 || (!it
->glyph_row
->reversed_p
19096 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19097 || (it
->glyph_row
->reversed_p
19098 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
19100 /* Get the truncation glyphs. */
19102 truncate_it
.current_x
= 0;
19103 truncate_it
.face_id
= DEFAULT_FACE_ID
;
19104 truncate_it
.glyph_row
= &scratch_glyph_row
;
19105 truncate_it
.area
= TEXT_AREA
;
19106 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
19107 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
19108 truncate_it
.object
= Qnil
;
19109 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
19111 /* Overwrite glyphs from IT with truncation glyphs. */
19112 if (!it
->glyph_row
->reversed_p
)
19114 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19116 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19117 end
= from
+ tused
;
19118 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19119 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
19120 if (FRAME_WINDOW_P (it
->f
))
19122 /* On GUI frames, when variable-size fonts are displayed,
19123 the truncation glyphs may need more pixels than the row's
19124 glyphs they overwrite. We overwrite more glyphs to free
19125 enough screen real estate, and enlarge the stretch glyph
19126 on the right (see display_line), if there is one, to
19127 preserve the screen position of the truncation glyphs on
19130 struct glyph
*g
= to
;
19133 /* The first glyph could be partially visible, in which case
19134 it->glyph_row->x will be negative. But we want the left
19135 truncation glyphs to be aligned at the left margin of the
19136 window, so we override the x coordinate at which the row
19138 it
->glyph_row
->x
= 0;
19139 while (g
< toend
&& w
< it
->truncation_pixel_width
)
19141 w
+= g
->pixel_width
;
19144 if (g
- to
- tused
> 0)
19146 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
19147 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
19149 used
= it
->glyph_row
->used
[TEXT_AREA
];
19150 if (it
->glyph_row
->truncated_on_right_p
19151 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
19152 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
19155 int extra
= w
- it
->truncation_pixel_width
;
19157 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
19164 /* There may be padding glyphs left over. Overwrite them too. */
19165 if (!FRAME_WINDOW_P (it
->f
))
19167 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
19169 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19176 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
19180 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19182 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19183 that back to front. */
19184 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19185 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19186 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19187 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19188 if (FRAME_WINDOW_P (it
->f
))
19191 struct glyph
*g
= to
;
19193 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19195 w
+= g
->pixel_width
;
19198 if (to
- g
- tused
> 0)
19200 if (it
->glyph_row
->truncated_on_right_p
19201 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19202 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19204 int extra
= w
- it
->truncation_pixel_width
;
19206 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19210 while (from
>= end
&& to
>= toend
)
19212 if (!FRAME_WINDOW_P (it
->f
))
19214 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19217 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19218 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19219 while (from
>= end
&& to
>= toend
)
19225 /* Need to free some room before prepending additional
19227 int move_by
= from
- end
+ 1;
19228 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19229 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19231 for ( ; g
>= g0
; g
--)
19233 while (from
>= end
)
19235 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19240 /* Compute the hash code for ROW. */
19242 row_hash (struct glyph_row
*row
)
19245 unsigned hashval
= 0;
19247 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19248 for (k
= 0; k
< row
->used
[area
]; ++k
)
19249 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19250 + row
->glyphs
[area
][k
].u
.val
19251 + row
->glyphs
[area
][k
].face_id
19252 + row
->glyphs
[area
][k
].padding_p
19253 + (row
->glyphs
[area
][k
].type
<< 2));
19258 /* Compute the pixel height and width of IT->glyph_row.
19260 Most of the time, ascent and height of a display line will be equal
19261 to the max_ascent and max_height values of the display iterator
19262 structure. This is not the case if
19264 1. We hit ZV without displaying anything. In this case, max_ascent
19265 and max_height will be zero.
19267 2. We have some glyphs that don't contribute to the line height.
19268 (The glyph row flag contributes_to_line_height_p is for future
19269 pixmap extensions).
19271 The first case is easily covered by using default values because in
19272 these cases, the line height does not really matter, except that it
19273 must not be zero. */
19276 compute_line_metrics (struct it
*it
)
19278 struct glyph_row
*row
= it
->glyph_row
;
19280 if (FRAME_WINDOW_P (it
->f
))
19282 int i
, min_y
, max_y
;
19284 /* The line may consist of one space only, that was added to
19285 place the cursor on it. If so, the row's height hasn't been
19287 if (row
->height
== 0)
19289 if (it
->max_ascent
+ it
->max_descent
== 0)
19290 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19291 row
->ascent
= it
->max_ascent
;
19292 row
->height
= it
->max_ascent
+ it
->max_descent
;
19293 row
->phys_ascent
= it
->max_phys_ascent
;
19294 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19295 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19298 /* Compute the width of this line. */
19299 row
->pixel_width
= row
->x
;
19300 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19301 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19303 eassert (row
->pixel_width
>= 0);
19304 eassert (row
->ascent
>= 0 && row
->height
> 0);
19306 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19307 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19309 /* If first line's physical ascent is larger than its logical
19310 ascent, use the physical ascent, and make the row taller.
19311 This makes accented characters fully visible. */
19312 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19313 && row
->phys_ascent
> row
->ascent
)
19315 row
->height
+= row
->phys_ascent
- row
->ascent
;
19316 row
->ascent
= row
->phys_ascent
;
19319 /* Compute how much of the line is visible. */
19320 row
->visible_height
= row
->height
;
19322 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19323 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19325 if (row
->y
< min_y
)
19326 row
->visible_height
-= min_y
- row
->y
;
19327 if (row
->y
+ row
->height
> max_y
)
19328 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19332 row
->pixel_width
= row
->used
[TEXT_AREA
];
19333 if (row
->continued_p
)
19334 row
->pixel_width
-= it
->continuation_pixel_width
;
19335 else if (row
->truncated_on_right_p
)
19336 row
->pixel_width
-= it
->truncation_pixel_width
;
19337 row
->ascent
= row
->phys_ascent
= 0;
19338 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19339 row
->extra_line_spacing
= 0;
19342 /* Compute a hash code for this row. */
19343 row
->hash
= row_hash (row
);
19345 it
->max_ascent
= it
->max_descent
= 0;
19346 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19350 /* Append one space to the glyph row of iterator IT if doing a
19351 window-based redisplay. The space has the same face as
19352 IT->face_id. Value is true if a space was added.
19354 This function is called to make sure that there is always one glyph
19355 at the end of a glyph row that the cursor can be set on under
19356 window-systems. (If there weren't such a glyph we would not know
19357 how wide and tall a box cursor should be displayed).
19359 At the same time this space let's a nicely handle clearing to the
19360 end of the line if the row ends in italic text. */
19363 append_space_for_newline (struct it
*it
, bool default_face_p
)
19365 if (FRAME_WINDOW_P (it
->f
))
19367 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19369 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19370 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19372 /* Save some values that must not be changed.
19373 Must save IT->c and IT->len because otherwise
19374 ITERATOR_AT_END_P wouldn't work anymore after
19375 append_space_for_newline has been called. */
19376 enum display_element_type saved_what
= it
->what
;
19377 int saved_c
= it
->c
, saved_len
= it
->len
;
19378 int saved_char_to_display
= it
->char_to_display
;
19379 int saved_x
= it
->current_x
;
19380 int saved_face_id
= it
->face_id
;
19381 bool saved_box_end
= it
->end_of_box_run_p
;
19382 struct text_pos saved_pos
;
19383 Lisp_Object saved_object
;
19387 saved_object
= it
->object
;
19388 saved_pos
= it
->position
;
19390 it
->what
= IT_CHARACTER
;
19391 memset (&it
->position
, 0, sizeof it
->position
);
19393 it
->c
= it
->char_to_display
= ' ';
19396 /* If the default face was remapped, be sure to use the
19397 remapped face for the appended newline. */
19398 if (default_face_p
)
19399 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19400 else if (it
->face_before_selective_p
)
19401 it
->face_id
= it
->saved_face_id
;
19402 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19403 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19404 /* In R2L rows, we will prepend a stretch glyph that will
19405 have the end_of_box_run_p flag set for it, so there's no
19406 need for the appended newline glyph to have that flag
19408 if (it
->glyph_row
->reversed_p
19409 /* But if the appended newline glyph goes all the way to
19410 the end of the row, there will be no stretch glyph,
19411 so leave the box flag set. */
19412 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19413 it
->end_of_box_run_p
= false;
19415 PRODUCE_GLYPHS (it
);
19417 #ifdef HAVE_WINDOW_SYSTEM
19418 /* Make sure this space glyph has the right ascent and
19419 descent values, or else cursor at end of line will look
19420 funny, and height of empty lines will be incorrect. */
19421 g
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19422 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
19425 Lisp_Object height
, total_height
;
19426 int extra_line_spacing
= it
->extra_line_spacing
;
19427 int boff
= font
->baseline_offset
;
19429 if (font
->vertical_centering
)
19430 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
19432 it
->object
= saved_object
; /* get_it_property needs this */
19433 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
19434 /* Must do a subset of line height processing from
19435 x_produce_glyph for newline characters. */
19436 height
= get_it_property (it
, Qline_height
);
19438 && CONSP (XCDR (height
))
19439 && NILP (XCDR (XCDR (height
))))
19441 total_height
= XCAR (XCDR (height
));
19442 height
= XCAR (height
);
19445 total_height
= Qnil
;
19446 height
= calc_line_height_property (it
, height
, font
, boff
, true);
19448 if (it
->override_ascent
>= 0)
19450 it
->ascent
= it
->override_ascent
;
19451 it
->descent
= it
->override_descent
;
19452 boff
= it
->override_boff
;
19454 if (EQ (height
, Qt
))
19455 extra_line_spacing
= 0;
19458 Lisp_Object spacing
;
19460 it
->phys_ascent
= it
->ascent
;
19461 it
->phys_descent
= it
->descent
;
19463 && XINT (height
) > it
->ascent
+ it
->descent
)
19464 it
->ascent
= XINT (height
) - it
->descent
;
19466 if (!NILP (total_height
))
19467 spacing
= calc_line_height_property (it
, total_height
, font
,
19471 spacing
= get_it_property (it
, Qline_spacing
);
19472 spacing
= calc_line_height_property (it
, spacing
, font
,
19475 if (INTEGERP (spacing
))
19477 extra_line_spacing
= XINT (spacing
);
19478 if (!NILP (total_height
))
19479 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
19482 if (extra_line_spacing
> 0)
19484 it
->descent
+= extra_line_spacing
;
19485 if (extra_line_spacing
> it
->max_extra_line_spacing
)
19486 it
->max_extra_line_spacing
= extra_line_spacing
;
19488 it
->max_ascent
= it
->ascent
;
19489 it
->max_descent
= it
->descent
;
19490 /* Make sure compute_line_metrics recomputes the row height. */
19491 it
->glyph_row
->height
= 0;
19494 g
->ascent
= it
->max_ascent
;
19495 g
->descent
= it
->max_descent
;
19498 it
->override_ascent
= -1;
19499 it
->constrain_row_ascent_descent_p
= false;
19500 it
->current_x
= saved_x
;
19501 it
->object
= saved_object
;
19502 it
->position
= saved_pos
;
19503 it
->what
= saved_what
;
19504 it
->face_id
= saved_face_id
;
19505 it
->len
= saved_len
;
19507 it
->char_to_display
= saved_char_to_display
;
19508 it
->end_of_box_run_p
= saved_box_end
;
19517 /* Extend the face of the last glyph in the text area of IT->glyph_row
19518 to the end of the display line. Called from display_line. If the
19519 glyph row is empty, add a space glyph to it so that we know the
19520 face to draw. Set the glyph row flag fill_line_p. If the glyph
19521 row is R2L, prepend a stretch glyph to cover the empty space to the
19522 left of the leftmost glyph. */
19525 extend_face_to_end_of_line (struct it
*it
)
19527 struct face
*face
, *default_face
;
19528 struct frame
*f
= it
->f
;
19530 /* If line is already filled, do nothing. Non window-system frames
19531 get a grace of one more ``pixel'' because their characters are
19532 1-``pixel'' wide, so they hit the equality too early. This grace
19533 is needed only for R2L rows that are not continued, to produce
19534 one extra blank where we could display the cursor. */
19535 if ((it
->current_x
>= it
->last_visible_x
19536 + (!FRAME_WINDOW_P (f
)
19537 && it
->glyph_row
->reversed_p
19538 && !it
->glyph_row
->continued_p
))
19539 /* If the window has display margins, we will need to extend
19540 their face even if the text area is filled. */
19541 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19542 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19545 /* The default face, possibly remapped. */
19546 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19548 /* Face extension extends the background and box of IT->face_id
19549 to the end of the line. If the background equals the background
19550 of the frame, we don't have to do anything. */
19551 if (it
->face_before_selective_p
)
19552 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19554 face
= FACE_FROM_ID (f
, it
->face_id
);
19556 if (FRAME_WINDOW_P (f
)
19557 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19558 && face
->box
== FACE_NO_BOX
19559 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19560 #ifdef HAVE_WINDOW_SYSTEM
19563 && !it
->glyph_row
->reversed_p
)
19566 /* Set the glyph row flag indicating that the face of the last glyph
19567 in the text area has to be drawn to the end of the text area. */
19568 it
->glyph_row
->fill_line_p
= true;
19570 /* If current character of IT is not ASCII, make sure we have the
19571 ASCII face. This will be automatically undone the next time
19572 get_next_display_element returns a multibyte character. Note
19573 that the character will always be single byte in unibyte
19575 if (!ASCII_CHAR_P (it
->c
))
19577 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19580 if (FRAME_WINDOW_P (f
))
19582 /* If the row is empty, add a space with the current face of IT,
19583 so that we know which face to draw. */
19584 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19586 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19587 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19588 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19590 /* Mode line and the header line don't have margins, and
19591 likewise the frame's tool-bar window, if there is any. */
19592 if (!(it
->glyph_row
->mode_line_p
19593 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19594 || (WINDOWP (f
->tool_bar_window
)
19595 && it
->w
== XWINDOW (f
->tool_bar_window
))
19599 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19600 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19602 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19603 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19605 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19607 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19608 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19610 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19611 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19613 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19616 #ifdef HAVE_WINDOW_SYSTEM
19617 if (it
->glyph_row
->reversed_p
)
19619 /* Prepend a stretch glyph to the row, such that the
19620 rightmost glyph will be drawn flushed all the way to the
19621 right margin of the window. The stretch glyph that will
19622 occupy the empty space, if any, to the left of the
19624 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19625 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19626 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19628 int row_width
, stretch_ascent
, stretch_width
;
19629 struct text_pos saved_pos
;
19631 bool saved_avoid_cursor
, saved_box_start
;
19633 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19634 row_width
+= g
->pixel_width
;
19636 /* FIXME: There are various minor display glitches in R2L
19637 rows when only one of the fringes is missing. The
19638 strange condition below produces the least bad effect. */
19639 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19640 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19641 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19642 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19644 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19645 stretch_width
-= row_width
;
19647 if (stretch_width
> 0)
19650 (((it
->ascent
+ it
->descent
)
19651 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19652 saved_pos
= it
->position
;
19653 memset (&it
->position
, 0, sizeof it
->position
);
19654 saved_avoid_cursor
= it
->avoid_cursor_p
;
19655 it
->avoid_cursor_p
= true;
19656 saved_face_id
= it
->face_id
;
19657 saved_box_start
= it
->start_of_box_run_p
;
19658 /* The last row's stretch glyph should get the default
19659 face, to avoid painting the rest of the window with
19660 the region face, if the region ends at ZV. */
19661 if (it
->glyph_row
->ends_at_zv_p
)
19662 it
->face_id
= default_face
->id
;
19664 it
->face_id
= face
->id
;
19665 it
->start_of_box_run_p
= false;
19666 append_stretch_glyph (it
, Qnil
, stretch_width
,
19667 it
->ascent
+ it
->descent
, stretch_ascent
);
19668 it
->position
= saved_pos
;
19669 it
->avoid_cursor_p
= saved_avoid_cursor
;
19670 it
->face_id
= saved_face_id
;
19671 it
->start_of_box_run_p
= saved_box_start
;
19673 /* If stretch_width comes out negative, it means that the
19674 last glyph is only partially visible. In R2L rows, we
19675 want the leftmost glyph to be partially visible, so we
19676 need to give the row the corresponding left offset. */
19677 if (stretch_width
< 0)
19678 it
->glyph_row
->x
= stretch_width
;
19680 #endif /* HAVE_WINDOW_SYSTEM */
19684 /* Save some values that must not be changed. */
19685 int saved_x
= it
->current_x
;
19686 struct text_pos saved_pos
;
19687 Lisp_Object saved_object
;
19688 enum display_element_type saved_what
= it
->what
;
19689 int saved_face_id
= it
->face_id
;
19691 saved_object
= it
->object
;
19692 saved_pos
= it
->position
;
19694 it
->what
= IT_CHARACTER
;
19695 memset (&it
->position
, 0, sizeof it
->position
);
19697 it
->c
= it
->char_to_display
= ' ';
19700 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19701 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19702 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19703 && !it
->glyph_row
->mode_line_p
19704 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19706 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19707 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19709 for (it
->current_x
= 0; g
< e
; g
++)
19710 it
->current_x
+= g
->pixel_width
;
19712 it
->area
= LEFT_MARGIN_AREA
;
19713 it
->face_id
= default_face
->id
;
19714 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19715 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19717 PRODUCE_GLYPHS (it
);
19718 /* term.c:produce_glyphs advances it->current_x only for
19720 it
->current_x
+= it
->pixel_width
;
19723 it
->current_x
= saved_x
;
19724 it
->area
= TEXT_AREA
;
19727 /* The last row's blank glyphs should get the default face, to
19728 avoid painting the rest of the window with the region face,
19729 if the region ends at ZV. */
19730 if (it
->glyph_row
->ends_at_zv_p
)
19731 it
->face_id
= default_face
->id
;
19733 it
->face_id
= face
->id
;
19734 PRODUCE_GLYPHS (it
);
19736 while (it
->current_x
<= it
->last_visible_x
)
19737 PRODUCE_GLYPHS (it
);
19739 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19740 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19741 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19742 && !it
->glyph_row
->mode_line_p
19743 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19745 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19746 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19748 for ( ; g
< e
; g
++)
19749 it
->current_x
+= g
->pixel_width
;
19751 it
->area
= RIGHT_MARGIN_AREA
;
19752 it
->face_id
= default_face
->id
;
19753 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19754 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19756 PRODUCE_GLYPHS (it
);
19757 it
->current_x
+= it
->pixel_width
;
19760 it
->area
= TEXT_AREA
;
19763 /* Don't count these blanks really. It would let us insert a left
19764 truncation glyph below and make us set the cursor on them, maybe. */
19765 it
->current_x
= saved_x
;
19766 it
->object
= saved_object
;
19767 it
->position
= saved_pos
;
19768 it
->what
= saved_what
;
19769 it
->face_id
= saved_face_id
;
19774 /* Value is true if text starting at CHARPOS in current_buffer is
19775 trailing whitespace. */
19778 trailing_whitespace_p (ptrdiff_t charpos
)
19780 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19783 while (bytepos
< ZV_BYTE
19784 && (c
= FETCH_CHAR (bytepos
),
19785 c
== ' ' || c
== '\t'))
19788 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19790 if (bytepos
!= PT_BYTE
)
19797 /* Highlight trailing whitespace, if any, in ROW. */
19800 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19802 int used
= row
->used
[TEXT_AREA
];
19806 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19807 struct glyph
*glyph
= start
+ used
- 1;
19809 if (row
->reversed_p
)
19811 /* Right-to-left rows need to be processed in the opposite
19812 direction, so swap the edge pointers. */
19814 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19817 /* Skip over glyphs inserted to display the cursor at the
19818 end of a line, for extending the face of the last glyph
19819 to the end of the line on terminals, and for truncation
19820 and continuation glyphs. */
19821 if (!row
->reversed_p
)
19823 while (glyph
>= start
19824 && glyph
->type
== CHAR_GLYPH
19825 && NILP (glyph
->object
))
19830 while (glyph
<= start
19831 && glyph
->type
== CHAR_GLYPH
19832 && NILP (glyph
->object
))
19836 /* If last glyph is a space or stretch, and it's trailing
19837 whitespace, set the face of all trailing whitespace glyphs in
19838 IT->glyph_row to `trailing-whitespace'. */
19839 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19840 && BUFFERP (glyph
->object
)
19841 && (glyph
->type
== STRETCH_GLYPH
19842 || (glyph
->type
== CHAR_GLYPH
19843 && glyph
->u
.ch
== ' '))
19844 && trailing_whitespace_p (glyph
->charpos
))
19846 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, false);
19850 if (!row
->reversed_p
)
19852 while (glyph
>= start
19853 && BUFFERP (glyph
->object
)
19854 && (glyph
->type
== STRETCH_GLYPH
19855 || (glyph
->type
== CHAR_GLYPH
19856 && glyph
->u
.ch
== ' ')))
19857 (glyph
--)->face_id
= face_id
;
19861 while (glyph
<= start
19862 && BUFFERP (glyph
->object
)
19863 && (glyph
->type
== STRETCH_GLYPH
19864 || (glyph
->type
== CHAR_GLYPH
19865 && glyph
->u
.ch
== ' ')))
19866 (glyph
++)->face_id
= face_id
;
19873 /* Value is true if glyph row ROW should be
19874 considered to hold the buffer position CHARPOS. */
19877 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19879 bool result
= true;
19881 if (charpos
== CHARPOS (row
->end
.pos
)
19882 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19884 /* Suppose the row ends on a string.
19885 Unless the row is continued, that means it ends on a newline
19886 in the string. If it's anything other than a display string
19887 (e.g., a before-string from an overlay), we don't want the
19888 cursor there. (This heuristic seems to give the optimal
19889 behavior for the various types of multi-line strings.)
19890 One exception: if the string has `cursor' property on one of
19891 its characters, we _do_ want the cursor there. */
19892 if (CHARPOS (row
->end
.string_pos
) >= 0)
19894 if (row
->continued_p
)
19898 /* Check for `display' property. */
19899 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19900 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19901 struct glyph
*glyph
;
19904 for (glyph
= end
; glyph
>= beg
; --glyph
)
19905 if (STRINGP (glyph
->object
))
19908 = Fget_char_property (make_number (charpos
),
19912 && display_prop_string_p (prop
, glyph
->object
));
19913 /* If there's a `cursor' property on one of the
19914 string's characters, this row is a cursor row,
19915 even though this is not a display string. */
19918 Lisp_Object s
= glyph
->object
;
19920 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19922 ptrdiff_t gpos
= glyph
->charpos
;
19924 if (!NILP (Fget_char_property (make_number (gpos
),
19936 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19938 /* If the row ends in middle of a real character,
19939 and the line is continued, we want the cursor here.
19940 That's because CHARPOS (ROW->end.pos) would equal
19941 PT if PT is before the character. */
19942 if (!row
->ends_in_ellipsis_p
)
19943 result
= row
->continued_p
;
19945 /* If the row ends in an ellipsis, then
19946 CHARPOS (ROW->end.pos) will equal point after the
19947 invisible text. We want that position to be displayed
19948 after the ellipsis. */
19951 /* If the row ends at ZV, display the cursor at the end of that
19952 row instead of at the start of the row below. */
19954 result
= row
->ends_at_zv_p
;
19960 /* Value is true if glyph row ROW should be
19961 used to hold the cursor. */
19964 cursor_row_p (struct glyph_row
*row
)
19966 return row_for_charpos_p (row
, PT
);
19971 /* Push the property PROP so that it will be rendered at the current
19972 position in IT. Return true if PROP was successfully pushed, false
19973 otherwise. Called from handle_line_prefix to handle the
19974 `line-prefix' and `wrap-prefix' properties. */
19977 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19979 struct text_pos pos
=
19980 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19982 eassert (it
->method
== GET_FROM_BUFFER
19983 || it
->method
== GET_FROM_DISPLAY_VECTOR
19984 || it
->method
== GET_FROM_STRING
19985 || it
->method
== GET_FROM_IMAGE
);
19987 /* We need to save the current buffer/string position, so it will be
19988 restored by pop_it, because iterate_out_of_display_property
19989 depends on that being set correctly, but some situations leave
19990 it->position not yet set when this function is called. */
19991 push_it (it
, &pos
);
19993 if (STRINGP (prop
))
19995 if (SCHARS (prop
) == 0)
20002 it
->string_from_prefix_prop_p
= true;
20003 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
20004 it
->current
.overlay_string_index
= -1;
20005 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
20006 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
20007 it
->method
= GET_FROM_STRING
;
20008 it
->stop_charpos
= 0;
20010 it
->base_level_stop
= 0;
20012 /* Force paragraph direction to be that of the parent
20014 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
20015 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
20017 it
->paragraph_embedding
= L2R
;
20019 /* Set up the bidi iterator for this display string. */
20022 it
->bidi_it
.string
.lstring
= it
->string
;
20023 it
->bidi_it
.string
.s
= NULL
;
20024 it
->bidi_it
.string
.schars
= it
->end_charpos
;
20025 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
20026 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
20027 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
20028 it
->bidi_it
.w
= it
->w
;
20029 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
20032 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
20034 it
->method
= GET_FROM_STRETCH
;
20037 #ifdef HAVE_WINDOW_SYSTEM
20038 else if (IMAGEP (prop
))
20040 it
->what
= IT_IMAGE
;
20041 it
->image_id
= lookup_image (it
->f
, prop
);
20042 it
->method
= GET_FROM_IMAGE
;
20044 #endif /* HAVE_WINDOW_SYSTEM */
20047 pop_it (it
); /* bogus display property, give up */
20054 /* Return the character-property PROP at the current position in IT. */
20057 get_it_property (struct it
*it
, Lisp_Object prop
)
20059 Lisp_Object position
, object
= it
->object
;
20061 if (STRINGP (object
))
20062 position
= make_number (IT_STRING_CHARPOS (*it
));
20063 else if (BUFFERP (object
))
20065 position
= make_number (IT_CHARPOS (*it
));
20066 object
= it
->window
;
20071 return Fget_char_property (position
, prop
, object
);
20074 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
20077 handle_line_prefix (struct it
*it
)
20079 Lisp_Object prefix
;
20081 if (it
->continuation_lines_width
> 0)
20083 prefix
= get_it_property (it
, Qwrap_prefix
);
20085 prefix
= Vwrap_prefix
;
20089 prefix
= get_it_property (it
, Qline_prefix
);
20091 prefix
= Vline_prefix
;
20093 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
20095 /* If the prefix is wider than the window, and we try to wrap
20096 it, it would acquire its own wrap prefix, and so on till the
20097 iterator stack overflows. So, don't wrap the prefix. */
20098 it
->line_wrap
= TRUNCATE
;
20099 it
->avoid_cursor_p
= true;
20105 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
20106 only for R2L lines from display_line and display_string, when they
20107 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
20108 the line/string needs to be continued on the next glyph row. */
20110 unproduce_glyphs (struct it
*it
, int n
)
20112 struct glyph
*glyph
, *end
;
20114 eassert (it
->glyph_row
);
20115 eassert (it
->glyph_row
->reversed_p
);
20116 eassert (it
->area
== TEXT_AREA
);
20117 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
20119 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
20120 n
= it
->glyph_row
->used
[TEXT_AREA
];
20121 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
20122 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
20123 for ( ; glyph
< end
; glyph
++)
20124 glyph
[-n
] = *glyph
;
20127 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
20128 and ROW->maxpos. */
20130 find_row_edges (struct it
*it
, struct glyph_row
*row
,
20131 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
20132 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
20134 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20135 lines' rows is implemented for bidi-reordered rows. */
20137 /* ROW->minpos is the value of min_pos, the minimal buffer position
20138 we have in ROW, or ROW->start.pos if that is smaller. */
20139 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
20140 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
20142 /* We didn't find buffer positions smaller than ROW->start, or
20143 didn't find _any_ valid buffer positions in any of the glyphs,
20144 so we must trust the iterator's computed positions. */
20145 row
->minpos
= row
->start
.pos
;
20148 max_pos
= CHARPOS (it
->current
.pos
);
20149 max_bpos
= BYTEPOS (it
->current
.pos
);
20152 /* Here are the various use-cases for ending the row, and the
20153 corresponding values for ROW->maxpos:
20155 Line ends in a newline from buffer eol_pos + 1
20156 Line is continued from buffer max_pos + 1
20157 Line is truncated on right it->current.pos
20158 Line ends in a newline from string max_pos + 1(*)
20159 (*) + 1 only when line ends in a forward scan
20160 Line is continued from string max_pos
20161 Line is continued from display vector max_pos
20162 Line is entirely from a string min_pos == max_pos
20163 Line is entirely from a display vector min_pos == max_pos
20164 Line that ends at ZV ZV
20166 If you discover other use-cases, please add them here as
20168 if (row
->ends_at_zv_p
)
20169 row
->maxpos
= it
->current
.pos
;
20170 else if (row
->used
[TEXT_AREA
])
20172 bool seen_this_string
= false;
20173 struct glyph_row
*r1
= row
- 1;
20175 /* Did we see the same display string on the previous row? */
20176 if (STRINGP (it
->object
)
20177 /* this is not the first row */
20178 && row
> it
->w
->desired_matrix
->rows
20179 /* previous row is not the header line */
20180 && !r1
->mode_line_p
20181 /* previous row also ends in a newline from a string */
20182 && r1
->ends_in_newline_from_string_p
)
20184 struct glyph
*start
, *end
;
20186 /* Search for the last glyph of the previous row that came
20187 from buffer or string. Depending on whether the row is
20188 L2R or R2L, we need to process it front to back or the
20189 other way round. */
20190 if (!r1
->reversed_p
)
20192 start
= r1
->glyphs
[TEXT_AREA
];
20193 end
= start
+ r1
->used
[TEXT_AREA
];
20194 /* Glyphs inserted by redisplay have nil as their object. */
20196 && NILP ((end
- 1)->object
)
20197 && (end
- 1)->charpos
<= 0)
20201 if (EQ ((end
- 1)->object
, it
->object
))
20202 seen_this_string
= true;
20205 /* If all the glyphs of the previous row were inserted
20206 by redisplay, it means the previous row was
20207 produced from a single newline, which is only
20208 possible if that newline came from the same string
20209 as the one which produced this ROW. */
20210 seen_this_string
= true;
20214 end
= r1
->glyphs
[TEXT_AREA
] - 1;
20215 start
= end
+ r1
->used
[TEXT_AREA
];
20217 && NILP ((end
+ 1)->object
)
20218 && (end
+ 1)->charpos
<= 0)
20222 if (EQ ((end
+ 1)->object
, it
->object
))
20223 seen_this_string
= true;
20226 seen_this_string
= true;
20229 /* Take note of each display string that covers a newline only
20230 once, the first time we see it. This is for when a display
20231 string includes more than one newline in it. */
20232 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
20234 /* If we were scanning the buffer forward when we displayed
20235 the string, we want to account for at least one buffer
20236 position that belongs to this row (position covered by
20237 the display string), so that cursor positioning will
20238 consider this row as a candidate when point is at the end
20239 of the visual line represented by this row. This is not
20240 required when scanning back, because max_pos will already
20241 have a much larger value. */
20242 if (CHARPOS (row
->end
.pos
) > max_pos
)
20243 INC_BOTH (max_pos
, max_bpos
);
20244 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20246 else if (CHARPOS (it
->eol_pos
) > 0)
20247 SET_TEXT_POS (row
->maxpos
,
20248 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
20249 else if (row
->continued_p
)
20251 /* If max_pos is different from IT's current position, it
20252 means IT->method does not belong to the display element
20253 at max_pos. However, it also means that the display
20254 element at max_pos was displayed in its entirety on this
20255 line, which is equivalent to saying that the next line
20256 starts at the next buffer position. */
20257 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
20258 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20261 INC_BOTH (max_pos
, max_bpos
);
20262 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20265 else if (row
->truncated_on_right_p
)
20266 /* display_line already called reseat_at_next_visible_line_start,
20267 which puts the iterator at the beginning of the next line, in
20268 the logical order. */
20269 row
->maxpos
= it
->current
.pos
;
20270 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20271 /* A line that is entirely from a string/image/stretch... */
20272 row
->maxpos
= row
->minpos
;
20277 row
->maxpos
= it
->current
.pos
;
20280 /* Construct the glyph row IT->glyph_row in the desired matrix of
20281 IT->w from text at the current position of IT. See dispextern.h
20282 for an overview of struct it. Value is true if
20283 IT->glyph_row displays text, as opposed to a line displaying ZV
20287 display_line (struct it
*it
)
20289 struct glyph_row
*row
= it
->glyph_row
;
20290 Lisp_Object overlay_arrow_string
;
20292 void *wrap_data
= NULL
;
20293 bool may_wrap
= false;
20294 int wrap_x
IF_LINT (= 0);
20295 int wrap_row_used
= -1;
20296 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
20297 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
20298 int wrap_row_extra_line_spacing
IF_LINT (= 0);
20299 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
20300 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
20302 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20303 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
20304 bool pending_handle_line_prefix
= false;
20306 /* We always start displaying at hpos zero even if hscrolled. */
20307 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20309 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20310 >= it
->w
->desired_matrix
->nrows
)
20312 it
->w
->nrows_scale_factor
++;
20313 it
->f
->fonts_changed
= true;
20317 /* Clear the result glyph row and enable it. */
20318 prepare_desired_row (it
->w
, row
, false);
20320 row
->y
= it
->current_y
;
20321 row
->start
= it
->start
;
20322 row
->continuation_lines_width
= it
->continuation_lines_width
;
20323 row
->displays_text_p
= true;
20324 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20325 it
->starts_in_middle_of_char_p
= false;
20327 /* Arrange the overlays nicely for our purposes. Usually, we call
20328 display_line on only one line at a time, in which case this
20329 can't really hurt too much, or we call it on lines which appear
20330 one after another in the buffer, in which case all calls to
20331 recenter_overlay_lists but the first will be pretty cheap. */
20332 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20334 /* Move over display elements that are not visible because we are
20335 hscrolled. This may stop at an x-position < IT->first_visible_x
20336 if the first glyph is partially visible or if we hit a line end. */
20337 if (it
->current_x
< it
->first_visible_x
)
20339 enum move_it_result move_result
;
20341 this_line_min_pos
= row
->start
.pos
;
20342 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20343 MOVE_TO_POS
| MOVE_TO_X
);
20344 /* If we are under a large hscroll, move_it_in_display_line_to
20345 could hit the end of the line without reaching
20346 it->first_visible_x. Pretend that we did reach it. This is
20347 especially important on a TTY, where we will call
20348 extend_face_to_end_of_line, which needs to know how many
20349 blank glyphs to produce. */
20350 if (it
->current_x
< it
->first_visible_x
20351 && (move_result
== MOVE_NEWLINE_OR_CR
20352 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20353 it
->current_x
= it
->first_visible_x
;
20355 /* Record the smallest positions seen while we moved over
20356 display elements that are not visible. This is needed by
20357 redisplay_internal for optimizing the case where the cursor
20358 stays inside the same line. The rest of this function only
20359 considers positions that are actually displayed, so
20360 RECORD_MAX_MIN_POS will not otherwise record positions that
20361 are hscrolled to the left of the left edge of the window. */
20362 min_pos
= CHARPOS (this_line_min_pos
);
20363 min_bpos
= BYTEPOS (this_line_min_pos
);
20365 else if (it
->area
== TEXT_AREA
)
20367 /* We only do this when not calling move_it_in_display_line_to
20368 above, because that function calls itself handle_line_prefix. */
20369 handle_line_prefix (it
);
20373 /* Line-prefix and wrap-prefix are always displayed in the text
20374 area. But if this is the first call to display_line after
20375 init_iterator, the iterator might have been set up to write
20376 into a marginal area, e.g. if the line begins with some
20377 display property that writes to the margins. So we need to
20378 wait with the call to handle_line_prefix until whatever
20379 writes to the margin has done its job. */
20380 pending_handle_line_prefix
= true;
20383 /* Get the initial row height. This is either the height of the
20384 text hscrolled, if there is any, or zero. */
20385 row
->ascent
= it
->max_ascent
;
20386 row
->height
= it
->max_ascent
+ it
->max_descent
;
20387 row
->phys_ascent
= it
->max_phys_ascent
;
20388 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20389 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20391 /* Utility macro to record max and min buffer positions seen until now. */
20392 #define RECORD_MAX_MIN_POS(IT) \
20395 bool composition_p \
20396 = !STRINGP ((IT)->string) && ((IT)->what == IT_COMPOSITION); \
20397 ptrdiff_t current_pos = \
20398 composition_p ? (IT)->cmp_it.charpos \
20399 : IT_CHARPOS (*(IT)); \
20400 ptrdiff_t current_bpos = \
20401 composition_p ? CHAR_TO_BYTE (current_pos) \
20402 : IT_BYTEPOS (*(IT)); \
20403 if (current_pos < min_pos) \
20405 min_pos = current_pos; \
20406 min_bpos = current_bpos; \
20408 if (IT_CHARPOS (*it) > max_pos) \
20410 max_pos = IT_CHARPOS (*it); \
20411 max_bpos = IT_BYTEPOS (*it); \
20416 /* Loop generating characters. The loop is left with IT on the next
20417 character to display. */
20420 int n_glyphs_before
, hpos_before
, x_before
;
20422 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20424 /* Retrieve the next thing to display. Value is false if end of
20426 if (!get_next_display_element (it
))
20428 /* Maybe add a space at the end of this line that is used to
20429 display the cursor there under X. Set the charpos of the
20430 first glyph of blank lines not corresponding to any text
20432 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20433 row
->exact_window_width_line_p
= true;
20434 else if ((append_space_for_newline (it
, true)
20435 && row
->used
[TEXT_AREA
] == 1)
20436 || row
->used
[TEXT_AREA
] == 0)
20438 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20439 row
->displays_text_p
= false;
20441 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20442 && (!MINI_WINDOW_P (it
->w
)
20443 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20444 row
->indicate_empty_line_p
= true;
20447 it
->continuation_lines_width
= 0;
20448 row
->ends_at_zv_p
= true;
20449 /* A row that displays right-to-left text must always have
20450 its last face extended all the way to the end of line,
20451 even if this row ends in ZV, because we still write to
20452 the screen left to right. We also need to extend the
20453 last face if the default face is remapped to some
20454 different face, otherwise the functions that clear
20455 portions of the screen will clear with the default face's
20456 background color. */
20457 if (row
->reversed_p
20458 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20459 extend_face_to_end_of_line (it
);
20463 /* Now, get the metrics of what we want to display. This also
20464 generates glyphs in `row' (which is IT->glyph_row). */
20465 n_glyphs_before
= row
->used
[TEXT_AREA
];
20468 /* Remember the line height so far in case the next element doesn't
20469 fit on the line. */
20470 if (it
->line_wrap
!= TRUNCATE
)
20472 ascent
= it
->max_ascent
;
20473 descent
= it
->max_descent
;
20474 phys_ascent
= it
->max_phys_ascent
;
20475 phys_descent
= it
->max_phys_descent
;
20477 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20479 if (IT_DISPLAYING_WHITESPACE (it
))
20483 SAVE_IT (wrap_it
, *it
, wrap_data
);
20485 wrap_row_used
= row
->used
[TEXT_AREA
];
20486 wrap_row_ascent
= row
->ascent
;
20487 wrap_row_height
= row
->height
;
20488 wrap_row_phys_ascent
= row
->phys_ascent
;
20489 wrap_row_phys_height
= row
->phys_height
;
20490 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20491 wrap_row_min_pos
= min_pos
;
20492 wrap_row_min_bpos
= min_bpos
;
20493 wrap_row_max_pos
= max_pos
;
20494 wrap_row_max_bpos
= max_bpos
;
20500 PRODUCE_GLYPHS (it
);
20502 /* If this display element was in marginal areas, continue with
20504 if (it
->area
!= TEXT_AREA
)
20506 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20507 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20508 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20509 row
->phys_height
= max (row
->phys_height
,
20510 it
->max_phys_ascent
+ it
->max_phys_descent
);
20511 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20512 it
->max_extra_line_spacing
);
20513 set_iterator_to_next (it
, true);
20514 /* If we didn't handle the line/wrap prefix above, and the
20515 call to set_iterator_to_next just switched to TEXT_AREA,
20516 process the prefix now. */
20517 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20519 pending_handle_line_prefix
= false;
20520 handle_line_prefix (it
);
20525 /* Does the display element fit on the line? If we truncate
20526 lines, we should draw past the right edge of the window. If
20527 we don't truncate, we want to stop so that we can display the
20528 continuation glyph before the right margin. If lines are
20529 continued, there are two possible strategies for characters
20530 resulting in more than 1 glyph (e.g. tabs): Display as many
20531 glyphs as possible in this line and leave the rest for the
20532 continuation line, or display the whole element in the next
20533 line. Original redisplay did the former, so we do it also. */
20534 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20535 hpos_before
= it
->hpos
;
20538 if (/* Not a newline. */
20540 /* Glyphs produced fit entirely in the line. */
20541 && it
->current_x
< it
->last_visible_x
)
20543 it
->hpos
+= nglyphs
;
20544 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20545 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20546 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20547 row
->phys_height
= max (row
->phys_height
,
20548 it
->max_phys_ascent
+ it
->max_phys_descent
);
20549 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20550 it
->max_extra_line_spacing
);
20551 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20552 /* In R2L rows, we arrange in extend_face_to_end_of_line
20553 to add a right offset to the line, by a suitable
20554 change to the stretch glyph that is the leftmost
20555 glyph of the line. */
20556 && !row
->reversed_p
)
20557 row
->x
= x
- it
->first_visible_x
;
20558 /* Record the maximum and minimum buffer positions seen so
20559 far in glyphs that will be displayed by this row. */
20561 RECORD_MAX_MIN_POS (it
);
20566 struct glyph
*glyph
;
20568 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20570 /* Identify the glyphs added by the last call to
20571 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20572 the previous glyphs. */
20573 if (!row
->reversed_p
)
20574 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20576 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20577 new_x
= x
+ glyph
->pixel_width
;
20579 if (/* Lines are continued. */
20580 it
->line_wrap
!= TRUNCATE
20581 && (/* Glyph doesn't fit on the line. */
20582 new_x
> it
->last_visible_x
20583 /* Or it fits exactly on a window system frame. */
20584 || (new_x
== it
->last_visible_x
20585 && FRAME_WINDOW_P (it
->f
)
20586 && (row
->reversed_p
20587 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20588 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20590 /* End of a continued line. */
20593 || (new_x
== it
->last_visible_x
20594 && FRAME_WINDOW_P (it
->f
)
20595 && (row
->reversed_p
20596 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20597 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20599 /* Current glyph is the only one on the line or
20600 fits exactly on the line. We must continue
20601 the line because we can't draw the cursor
20602 after the glyph. */
20603 row
->continued_p
= true;
20604 it
->current_x
= new_x
;
20605 it
->continuation_lines_width
+= new_x
;
20607 if (i
== nglyphs
- 1)
20609 /* If line-wrap is on, check if a previous
20610 wrap point was found. */
20611 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)
20612 && wrap_row_used
> 0
20613 /* Even if there is a previous wrap
20614 point, continue the line here as
20615 usual, if (i) the previous character
20616 was a space or tab AND (ii) the
20617 current character is not. */
20619 || IT_DISPLAYING_WHITESPACE (it
)))
20622 /* Record the maximum and minimum buffer
20623 positions seen so far in glyphs that will be
20624 displayed by this row. */
20626 RECORD_MAX_MIN_POS (it
);
20627 set_iterator_to_next (it
, true);
20628 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20630 if (!get_next_display_element (it
))
20632 row
->exact_window_width_line_p
= true;
20633 it
->continuation_lines_width
= 0;
20634 row
->continued_p
= false;
20635 row
->ends_at_zv_p
= true;
20637 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20639 row
->continued_p
= false;
20640 row
->exact_window_width_line_p
= true;
20642 /* If line-wrap is on, check if a
20643 previous wrap point was found. */
20644 else if (wrap_row_used
> 0
20645 /* Even if there is a previous wrap
20646 point, continue the line here as
20647 usual, if (i) the previous character
20648 was a space or tab AND (ii) the
20649 current character is not. */
20651 || IT_DISPLAYING_WHITESPACE (it
)))
20656 else if (it
->bidi_p
)
20657 RECORD_MAX_MIN_POS (it
);
20658 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20659 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20660 extend_face_to_end_of_line (it
);
20662 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20663 && !FRAME_WINDOW_P (it
->f
))
20665 /* A padding glyph that doesn't fit on this line.
20666 This means the whole character doesn't fit
20668 if (row
->reversed_p
)
20669 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20670 - n_glyphs_before
);
20671 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20673 /* Fill the rest of the row with continuation
20674 glyphs like in 20.x. */
20675 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20676 < row
->glyphs
[1 + TEXT_AREA
])
20677 produce_special_glyphs (it
, IT_CONTINUATION
);
20679 row
->continued_p
= true;
20680 it
->current_x
= x_before
;
20681 it
->continuation_lines_width
+= x_before
;
20683 /* Restore the height to what it was before the
20684 element not fitting on the line. */
20685 it
->max_ascent
= ascent
;
20686 it
->max_descent
= descent
;
20687 it
->max_phys_ascent
= phys_ascent
;
20688 it
->max_phys_descent
= phys_descent
;
20689 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20690 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20691 extend_face_to_end_of_line (it
);
20693 else if (wrap_row_used
> 0)
20696 if (row
->reversed_p
)
20697 unproduce_glyphs (it
,
20698 row
->used
[TEXT_AREA
] - wrap_row_used
);
20699 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20700 it
->continuation_lines_width
+= wrap_x
;
20701 row
->used
[TEXT_AREA
] = wrap_row_used
;
20702 row
->ascent
= wrap_row_ascent
;
20703 row
->height
= wrap_row_height
;
20704 row
->phys_ascent
= wrap_row_phys_ascent
;
20705 row
->phys_height
= wrap_row_phys_height
;
20706 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20707 min_pos
= wrap_row_min_pos
;
20708 min_bpos
= wrap_row_min_bpos
;
20709 max_pos
= wrap_row_max_pos
;
20710 max_bpos
= wrap_row_max_bpos
;
20711 row
->continued_p
= true;
20712 row
->ends_at_zv_p
= false;
20713 row
->exact_window_width_line_p
= false;
20714 it
->continuation_lines_width
+= x
;
20716 /* Make sure that a non-default face is extended
20717 up to the right margin of the window. */
20718 extend_face_to_end_of_line (it
);
20720 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20722 /* A TAB that extends past the right edge of the
20723 window. This produces a single glyph on
20724 window system frames. We leave the glyph in
20725 this row and let it fill the row, but don't
20726 consume the TAB. */
20727 if ((row
->reversed_p
20728 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20729 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20730 produce_special_glyphs (it
, IT_CONTINUATION
);
20731 it
->continuation_lines_width
+= it
->last_visible_x
;
20732 row
->ends_in_middle_of_char_p
= true;
20733 row
->continued_p
= true;
20734 glyph
->pixel_width
= it
->last_visible_x
- x
;
20735 it
->starts_in_middle_of_char_p
= true;
20736 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20737 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20738 extend_face_to_end_of_line (it
);
20742 /* Something other than a TAB that draws past
20743 the right edge of the window. Restore
20744 positions to values before the element. */
20745 if (row
->reversed_p
)
20746 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20747 - (n_glyphs_before
+ i
));
20748 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20750 /* Display continuation glyphs. */
20751 it
->current_x
= x_before
;
20752 it
->continuation_lines_width
+= x
;
20753 if (!FRAME_WINDOW_P (it
->f
)
20754 || (row
->reversed_p
20755 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20756 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20757 produce_special_glyphs (it
, IT_CONTINUATION
);
20758 row
->continued_p
= true;
20760 extend_face_to_end_of_line (it
);
20762 if (nglyphs
> 1 && i
> 0)
20764 row
->ends_in_middle_of_char_p
= true;
20765 it
->starts_in_middle_of_char_p
= true;
20768 /* Restore the height to what it was before the
20769 element not fitting on the line. */
20770 it
->max_ascent
= ascent
;
20771 it
->max_descent
= descent
;
20772 it
->max_phys_ascent
= phys_ascent
;
20773 it
->max_phys_descent
= phys_descent
;
20778 else if (new_x
> it
->first_visible_x
)
20780 /* Increment number of glyphs actually displayed. */
20783 /* Record the maximum and minimum buffer positions
20784 seen so far in glyphs that will be displayed by
20787 RECORD_MAX_MIN_POS (it
);
20789 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20790 /* Glyph is partially visible, i.e. row starts at
20791 negative X position. Don't do that in R2L
20792 rows, where we arrange to add a right offset to
20793 the line in extend_face_to_end_of_line, by a
20794 suitable change to the stretch glyph that is
20795 the leftmost glyph of the line. */
20796 row
->x
= x
- it
->first_visible_x
;
20797 /* When the last glyph of an R2L row only fits
20798 partially on the line, we need to set row->x to a
20799 negative offset, so that the leftmost glyph is
20800 the one that is partially visible. But if we are
20801 going to produce the truncation glyph, this will
20802 be taken care of in produce_special_glyphs. */
20803 if (row
->reversed_p
20804 && new_x
> it
->last_visible_x
20805 && !(it
->line_wrap
== TRUNCATE
20806 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
20808 eassert (FRAME_WINDOW_P (it
->f
));
20809 row
->x
= it
->last_visible_x
- new_x
;
20814 /* Glyph is completely off the left margin of the
20815 window. This should not happen because of the
20816 move_it_in_display_line at the start of this
20817 function, unless the text display area of the
20818 window is empty. */
20819 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20822 /* Even if this display element produced no glyphs at all,
20823 we want to record its position. */
20824 if (it
->bidi_p
&& nglyphs
== 0)
20825 RECORD_MAX_MIN_POS (it
);
20827 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20828 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20829 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20830 row
->phys_height
= max (row
->phys_height
,
20831 it
->max_phys_ascent
+ it
->max_phys_descent
);
20832 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20833 it
->max_extra_line_spacing
);
20835 /* End of this display line if row is continued. */
20836 if (row
->continued_p
|| row
->ends_at_zv_p
)
20841 /* Is this a line end? If yes, we're also done, after making
20842 sure that a non-default face is extended up to the right
20843 margin of the window. */
20844 if (ITERATOR_AT_END_OF_LINE_P (it
))
20846 int used_before
= row
->used
[TEXT_AREA
];
20848 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20850 /* Add a space at the end of the line that is used to
20851 display the cursor there. */
20852 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20853 append_space_for_newline (it
, false);
20855 /* Extend the face to the end of the line. */
20856 extend_face_to_end_of_line (it
);
20858 /* Make sure we have the position. */
20859 if (used_before
== 0)
20860 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20862 /* Record the position of the newline, for use in
20864 it
->eol_pos
= it
->current
.pos
;
20866 /* Consume the line end. This skips over invisible lines. */
20867 set_iterator_to_next (it
, true);
20868 it
->continuation_lines_width
= 0;
20872 /* Proceed with next display element. Note that this skips
20873 over lines invisible because of selective display. */
20874 set_iterator_to_next (it
, true);
20876 /* If we truncate lines, we are done when the last displayed
20877 glyphs reach past the right margin of the window. */
20878 if (it
->line_wrap
== TRUNCATE
20879 && ((FRAME_WINDOW_P (it
->f
)
20880 /* Images are preprocessed in produce_image_glyph such
20881 that they are cropped at the right edge of the
20882 window, so an image glyph will always end exactly at
20883 last_visible_x, even if there's no right fringe. */
20884 && ((row
->reversed_p
20885 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20886 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
20887 || it
->what
== IT_IMAGE
))
20888 ? (it
->current_x
>= it
->last_visible_x
)
20889 : (it
->current_x
> it
->last_visible_x
)))
20891 /* Maybe add truncation glyphs. */
20892 if (!FRAME_WINDOW_P (it
->f
)
20893 || (row
->reversed_p
20894 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20895 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20899 if (!row
->reversed_p
)
20901 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20902 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20907 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20908 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20910 /* Remove any padding glyphs at the front of ROW, to
20911 make room for the truncation glyphs we will be
20912 adding below. The loop below always inserts at
20913 least one truncation glyph, so also remove the
20914 last glyph added to ROW. */
20915 unproduce_glyphs (it
, i
+ 1);
20916 /* Adjust i for the loop below. */
20917 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20920 /* produce_special_glyphs overwrites the last glyph, so
20921 we don't want that if we want to keep that last
20922 glyph, which means it's an image. */
20923 if (it
->current_x
> it
->last_visible_x
)
20925 it
->current_x
= x_before
;
20926 if (!FRAME_WINDOW_P (it
->f
))
20928 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20930 row
->used
[TEXT_AREA
] = i
;
20931 produce_special_glyphs (it
, IT_TRUNCATION
);
20936 row
->used
[TEXT_AREA
] = i
;
20937 produce_special_glyphs (it
, IT_TRUNCATION
);
20939 it
->hpos
= hpos_before
;
20942 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20944 /* Don't truncate if we can overflow newline into fringe. */
20945 if (!get_next_display_element (it
))
20947 it
->continuation_lines_width
= 0;
20948 row
->ends_at_zv_p
= true;
20949 row
->exact_window_width_line_p
= true;
20952 if (ITERATOR_AT_END_OF_LINE_P (it
))
20954 row
->exact_window_width_line_p
= true;
20955 goto at_end_of_line
;
20957 it
->current_x
= x_before
;
20958 it
->hpos
= hpos_before
;
20961 row
->truncated_on_right_p
= true;
20962 it
->continuation_lines_width
= 0;
20963 reseat_at_next_visible_line_start (it
, false);
20964 /* We insist below that IT's position be at ZV because in
20965 bidi-reordered lines the character at visible line start
20966 might not be the character that follows the newline in
20967 the logical order. */
20968 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
20969 row
->ends_at_zv_p
=
20970 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
20972 row
->ends_at_zv_p
= false;
20978 bidi_unshelve_cache (wrap_data
, true);
20980 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20981 at the left window margin. */
20982 if (it
->first_visible_x
20983 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20985 if (!FRAME_WINDOW_P (it
->f
)
20986 || (((row
->reversed_p
20987 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20988 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20989 /* Don't let insert_left_trunc_glyphs overwrite the
20990 first glyph of the row if it is an image. */
20991 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20992 insert_left_trunc_glyphs (it
);
20993 row
->truncated_on_left_p
= true;
20996 /* Remember the position at which this line ends.
20998 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20999 cannot be before the call to find_row_edges below, since that is
21000 where these positions are determined. */
21001 row
->end
= it
->current
;
21004 row
->minpos
= row
->start
.pos
;
21005 row
->maxpos
= row
->end
.pos
;
21009 /* ROW->minpos and ROW->maxpos must be the smallest and
21010 `1 + the largest' buffer positions in ROW. But if ROW was
21011 bidi-reordered, these two positions can be anywhere in the
21012 row, so we must determine them now. */
21013 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
21016 /* If the start of this line is the overlay arrow-position, then
21017 mark this glyph row as the one containing the overlay arrow.
21018 This is clearly a mess with variable size fonts. It would be
21019 better to let it be displayed like cursors under X. */
21020 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
21021 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
21022 !NILP (overlay_arrow_string
)))
21024 /* Overlay arrow in window redisplay is a fringe bitmap. */
21025 if (STRINGP (overlay_arrow_string
))
21027 struct glyph_row
*arrow_row
21028 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
21029 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
21030 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
21031 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
21032 struct glyph
*p2
, *end
;
21034 /* Copy the arrow glyphs. */
21035 while (glyph
< arrow_end
)
21038 /* Throw away padding glyphs. */
21040 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
21041 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
21047 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
21052 eassert (INTEGERP (overlay_arrow_string
));
21053 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
21055 overlay_arrow_seen
= true;
21058 /* Highlight trailing whitespace. */
21059 if (!NILP (Vshow_trailing_whitespace
))
21060 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
21062 /* Compute pixel dimensions of this line. */
21063 compute_line_metrics (it
);
21065 /* Implementation note: No changes in the glyphs of ROW or in their
21066 faces can be done past this point, because compute_line_metrics
21067 computes ROW's hash value and stores it within the glyph_row
21070 /* Record whether this row ends inside an ellipsis. */
21071 row
->ends_in_ellipsis_p
21072 = (it
->method
== GET_FROM_DISPLAY_VECTOR
21073 && it
->ellipsis_p
);
21075 /* Save fringe bitmaps in this row. */
21076 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
21077 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
21078 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
21079 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
21081 it
->left_user_fringe_bitmap
= 0;
21082 it
->left_user_fringe_face_id
= 0;
21083 it
->right_user_fringe_bitmap
= 0;
21084 it
->right_user_fringe_face_id
= 0;
21086 /* Maybe set the cursor. */
21087 cvpos
= it
->w
->cursor
.vpos
;
21089 /* In bidi-reordered rows, keep checking for proper cursor
21090 position even if one has been found already, because buffer
21091 positions in such rows change non-linearly with ROW->VPOS,
21092 when a line is continued. One exception: when we are at ZV,
21093 display cursor on the first suitable glyph row, since all
21094 the empty rows after that also have their position set to ZV. */
21095 /* FIXME: Revisit this when glyph ``spilling'' in continuation
21096 lines' rows is implemented for bidi-reordered rows. */
21098 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
21099 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
21100 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
21101 && cursor_row_p (row
))
21102 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
21104 /* Prepare for the next line. This line starts horizontally at (X
21105 HPOS) = (0 0). Vertical positions are incremented. As a
21106 convenience for the caller, IT->glyph_row is set to the next
21108 it
->current_x
= it
->hpos
= 0;
21109 it
->current_y
+= row
->height
;
21110 SET_TEXT_POS (it
->eol_pos
, 0, 0);
21113 /* The next row should by default use the same value of the
21114 reversed_p flag as this one. set_iterator_to_next decides when
21115 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
21116 the flag accordingly. */
21117 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
21118 it
->glyph_row
->reversed_p
= row
->reversed_p
;
21119 it
->start
= row
->end
;
21120 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
21122 #undef RECORD_MAX_MIN_POS
21125 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
21126 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
21127 doc
: /* Return paragraph direction at point in BUFFER.
21128 Value is either `left-to-right' or `right-to-left'.
21129 If BUFFER is omitted or nil, it defaults to the current buffer.
21131 Paragraph direction determines how the text in the paragraph is displayed.
21132 In left-to-right paragraphs, text begins at the left margin of the window
21133 and the reading direction is generally left to right. In right-to-left
21134 paragraphs, text begins at the right margin and is read from right to left.
21136 See also `bidi-paragraph-direction'. */)
21137 (Lisp_Object buffer
)
21139 struct buffer
*buf
= current_buffer
;
21140 struct buffer
*old
= buf
;
21142 if (! NILP (buffer
))
21144 CHECK_BUFFER (buffer
);
21145 buf
= XBUFFER (buffer
);
21148 if (NILP (BVAR (buf
, bidi_display_reordering
))
21149 || NILP (BVAR (buf
, enable_multibyte_characters
))
21150 /* When we are loading loadup.el, the character property tables
21151 needed for bidi iteration are not yet available. */
21152 || !NILP (Vpurify_flag
))
21153 return Qleft_to_right
;
21154 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
21155 return BVAR (buf
, bidi_paragraph_direction
);
21158 /* Determine the direction from buffer text. We could try to
21159 use current_matrix if it is up to date, but this seems fast
21160 enough as it is. */
21161 struct bidi_it itb
;
21162 ptrdiff_t pos
= BUF_PT (buf
);
21163 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
21165 void *itb_data
= bidi_shelve_cache ();
21167 set_buffer_temp (buf
);
21168 /* bidi_paragraph_init finds the base direction of the paragraph
21169 by searching forward from paragraph start. We need the base
21170 direction of the current or _previous_ paragraph, so we need
21171 to make sure we are within that paragraph. To that end, find
21172 the previous non-empty line. */
21173 if (pos
>= ZV
&& pos
> BEGV
)
21174 DEC_BOTH (pos
, bytepos
);
21175 AUTO_STRING (trailing_white_space
, "[\f\t ]*\n");
21176 if (fast_looking_at (trailing_white_space
,
21177 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
21179 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
21180 || c
== ' ' || c
== '\t' || c
== '\f')
21182 if (bytepos
<= BEGV_BYTE
)
21187 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
21190 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
21191 itb
.paragraph_dir
= NEUTRAL_DIR
;
21192 itb
.string
.s
= NULL
;
21193 itb
.string
.lstring
= Qnil
;
21194 itb
.string
.bufpos
= 0;
21195 itb
.string
.from_disp_str
= false;
21196 itb
.string
.unibyte
= false;
21197 /* We have no window to use here for ignoring window-specific
21198 overlays. Using NULL for window pointer will cause
21199 compute_display_string_pos to use the current buffer. */
21201 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, true);
21202 bidi_unshelve_cache (itb_data
, false);
21203 set_buffer_temp (old
);
21204 switch (itb
.paragraph_dir
)
21207 return Qleft_to_right
;
21210 return Qright_to_left
;
21218 DEFUN ("bidi-find-overridden-directionality",
21219 Fbidi_find_overridden_directionality
,
21220 Sbidi_find_overridden_directionality
, 2, 3, 0,
21221 doc
: /* Return position between FROM and TO where directionality was overridden.
21223 This function returns the first character position in the specified
21224 region of OBJECT where there is a character whose `bidi-class' property
21225 is `L', but which was forced to display as `R' by a directional
21226 override, and likewise with characters whose `bidi-class' is `R'
21227 or `AL' that were forced to display as `L'.
21229 If no such character is found, the function returns nil.
21231 OBJECT is a Lisp string or buffer to search for overridden
21232 directionality, and defaults to the current buffer if nil or omitted.
21233 OBJECT can also be a window, in which case the function will search
21234 the buffer displayed in that window. Passing the window instead of
21235 a buffer is preferable when the buffer is displayed in some window,
21236 because this function will then be able to correctly account for
21237 window-specific overlays, which can affect the results.
21239 Strong directional characters `L', `R', and `AL' can have their
21240 intrinsic directionality overridden by directional override
21241 control characters RLO (u+202e) and LRO (u+202d). See the
21242 function `get-char-code-property' for a way to inquire about
21243 the `bidi-class' property of a character. */)
21244 (Lisp_Object from
, Lisp_Object to
, Lisp_Object object
)
21246 struct buffer
*buf
= current_buffer
;
21247 struct buffer
*old
= buf
;
21248 struct window
*w
= NULL
;
21249 bool frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ());
21250 struct bidi_it itb
;
21251 ptrdiff_t from_pos
, to_pos
, from_bpos
;
21254 if (!NILP (object
))
21256 if (BUFFERP (object
))
21257 buf
= XBUFFER (object
);
21258 else if (WINDOWP (object
))
21260 w
= decode_live_window (object
);
21261 buf
= XBUFFER (w
->contents
);
21262 frame_window_p
= FRAME_WINDOW_P (XFRAME (w
->frame
));
21265 CHECK_STRING (object
);
21268 if (STRINGP (object
))
21270 /* Characters in unibyte strings are always treated by bidi.c as
21272 if (!STRING_MULTIBYTE (object
)
21273 /* When we are loading loadup.el, the character property
21274 tables needed for bidi iteration are not yet
21276 || !NILP (Vpurify_flag
))
21279 validate_subarray (object
, from
, to
, SCHARS (object
), &from_pos
, &to_pos
);
21280 if (from_pos
>= SCHARS (object
))
21283 /* Set up the bidi iterator. */
21284 itb_data
= bidi_shelve_cache ();
21285 itb
.paragraph_dir
= NEUTRAL_DIR
;
21286 itb
.string
.lstring
= object
;
21287 itb
.string
.s
= NULL
;
21288 itb
.string
.schars
= SCHARS (object
);
21289 itb
.string
.bufpos
= 0;
21290 itb
.string
.from_disp_str
= false;
21291 itb
.string
.unibyte
= false;
21293 bidi_init_it (0, 0, frame_window_p
, &itb
);
21297 /* Nothing this fancy can happen in unibyte buffers, or in a
21298 buffer that disabled reordering, or if FROM is at EOB. */
21299 if (NILP (BVAR (buf
, bidi_display_reordering
))
21300 || NILP (BVAR (buf
, enable_multibyte_characters
))
21301 /* When we are loading loadup.el, the character property
21302 tables needed for bidi iteration are not yet
21304 || !NILP (Vpurify_flag
))
21307 set_buffer_temp (buf
);
21308 validate_region (&from
, &to
);
21309 from_pos
= XINT (from
);
21310 to_pos
= XINT (to
);
21311 if (from_pos
>= ZV
)
21314 /* Set up the bidi iterator. */
21315 itb_data
= bidi_shelve_cache ();
21316 from_bpos
= CHAR_TO_BYTE (from_pos
);
21317 if (from_pos
== BEGV
)
21319 itb
.charpos
= BEGV
;
21320 itb
.bytepos
= BEGV_BYTE
;
21322 else if (FETCH_CHAR (from_bpos
- 1) == '\n')
21324 itb
.charpos
= from_pos
;
21325 itb
.bytepos
= from_bpos
;
21328 itb
.charpos
= find_newline_no_quit (from_pos
, CHAR_TO_BYTE (from_pos
),
21330 itb
.paragraph_dir
= NEUTRAL_DIR
;
21331 itb
.string
.s
= NULL
;
21332 itb
.string
.lstring
= Qnil
;
21333 itb
.string
.bufpos
= 0;
21334 itb
.string
.from_disp_str
= false;
21335 itb
.string
.unibyte
= false;
21337 bidi_init_it (itb
.charpos
, itb
.bytepos
, frame_window_p
, &itb
);
21342 /* For the purposes of this function, the actual base direction of
21343 the paragraph doesn't matter, so just set it to L2R. */
21344 bidi_paragraph_init (L2R
, &itb
, false);
21345 while ((found
= bidi_find_first_overridden (&itb
)) < from_pos
)
21347 } while (found
== ZV
&& itb
.ch
== '\n' && itb
.charpos
< to_pos
);
21349 bidi_unshelve_cache (itb_data
, false);
21350 set_buffer_temp (old
);
21352 return (from_pos
<= found
&& found
< to_pos
) ? make_number (found
) : Qnil
;
21355 DEFUN ("move-point-visually", Fmove_point_visually
,
21356 Smove_point_visually
, 1, 1, 0,
21357 doc
: /* Move point in the visual order in the specified DIRECTION.
21358 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
21361 Value is the new character position of point. */)
21362 (Lisp_Object direction
)
21364 struct window
*w
= XWINDOW (selected_window
);
21365 struct buffer
*b
= XBUFFER (w
->contents
);
21366 struct glyph_row
*row
;
21368 Lisp_Object paragraph_dir
;
21370 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21371 (!(ROW)->continued_p \
21372 && NILP ((GLYPH)->object) \
21373 && (GLYPH)->type == CHAR_GLYPH \
21374 && (GLYPH)->u.ch == ' ' \
21375 && (GLYPH)->charpos >= 0 \
21376 && !(GLYPH)->avoid_cursor_p)
21378 CHECK_NUMBER (direction
);
21379 dir
= XINT (direction
);
21385 /* If current matrix is up-to-date, we can use the information
21386 recorded in the glyphs, at least as long as the goal is on the
21388 if (w
->window_end_valid
21389 && !windows_or_buffers_changed
21391 && !b
->clip_changed
21392 && !b
->prevent_redisplay_optimizations_p
21393 && !window_outdated (w
)
21394 /* We rely below on the cursor coordinates to be up to date, but
21395 we cannot trust them if some command moved point since the
21396 last complete redisplay. */
21397 && w
->last_point
== BUF_PT (b
)
21398 && w
->cursor
.vpos
>= 0
21399 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21400 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21402 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21403 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21404 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21406 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21408 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21410 SET_PT (g
->charpos
);
21411 w
->cursor
.vpos
= -1;
21412 return make_number (PT
);
21414 else if (!NILP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21418 if (BUFFERP (gpt
->object
))
21421 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21422 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21424 new_pos
-= (row
->reversed_p
? -dir
: dir
);
21426 else if (BUFFERP (g
->object
))
21427 new_pos
= g
->charpos
;
21431 w
->cursor
.vpos
= -1;
21432 return make_number (PT
);
21434 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21436 /* Glyphs inserted at the end of a non-empty line for
21437 positioning the cursor have zero charpos, so we must
21438 deduce the value of point by other means. */
21439 if (g
->charpos
> 0)
21440 SET_PT (g
->charpos
);
21441 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21443 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21444 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21447 w
->cursor
.vpos
= -1;
21448 return make_number (PT
);
21451 if (g
== e
|| NILP (g
->object
))
21453 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21454 goto simulate_display
;
21455 if (!row
->reversed_p
)
21459 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21460 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21461 goto simulate_display
;
21465 if (row
->reversed_p
&& !row
->continued_p
)
21467 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21468 w
->cursor
.vpos
= -1;
21469 return make_number (PT
);
21471 g
= row
->glyphs
[TEXT_AREA
];
21472 e
= g
+ row
->used
[TEXT_AREA
];
21473 for ( ; g
< e
; g
++)
21475 if (BUFFERP (g
->object
)
21476 /* Empty lines have only one glyph, which stands
21477 for the newline, and whose charpos is the
21478 buffer position of the newline. */
21479 || ROW_GLYPH_NEWLINE_P (row
, g
)
21480 /* When the buffer ends in a newline, the line at
21481 EOB also has one glyph, but its charpos is -1. */
21482 || (row
->ends_at_zv_p
21483 && !row
->reversed_p
21484 && NILP (g
->object
)
21485 && g
->type
== CHAR_GLYPH
21486 && g
->u
.ch
== ' '))
21488 if (g
->charpos
> 0)
21489 SET_PT (g
->charpos
);
21490 else if (!row
->reversed_p
21491 && row
->ends_at_zv_p
21496 w
->cursor
.vpos
= -1;
21497 return make_number (PT
);
21503 if (!row
->reversed_p
&& !row
->continued_p
)
21505 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21506 w
->cursor
.vpos
= -1;
21507 return make_number (PT
);
21509 e
= row
->glyphs
[TEXT_AREA
];
21510 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21511 for ( ; g
>= e
; g
--)
21513 if (BUFFERP (g
->object
)
21514 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21516 /* Empty R2L lines on GUI frames have the buffer
21517 position of the newline stored in the stretch
21519 || g
->type
== STRETCH_GLYPH
21520 || (row
->ends_at_zv_p
21522 && NILP (g
->object
)
21523 && g
->type
== CHAR_GLYPH
21524 && g
->u
.ch
== ' '))
21526 if (g
->charpos
> 0)
21527 SET_PT (g
->charpos
);
21528 else if (row
->reversed_p
21529 && row
->ends_at_zv_p
21534 w
->cursor
.vpos
= -1;
21535 return make_number (PT
);
21544 /* If we wind up here, we failed to move by using the glyphs, so we
21545 need to simulate display instead. */
21548 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21550 paragraph_dir
= Qleft_to_right
;
21551 if (EQ (paragraph_dir
, Qright_to_left
))
21553 if (PT
<= BEGV
&& dir
< 0)
21554 xsignal0 (Qbeginning_of_buffer
);
21555 else if (PT
>= ZV
&& dir
> 0)
21556 xsignal0 (Qend_of_buffer
);
21559 struct text_pos pt
;
21561 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21563 bool overshoot_expected
= false;
21564 bool target_is_eol_p
= false;
21566 /* Setup the arena. */
21567 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21568 start_display (&it
, w
, pt
);
21569 /* When lines are truncated, we could be called with point
21570 outside of the windows edges, in which case move_it_*
21571 functions either prematurely stop at window's edge or jump to
21572 the next screen line, whereas we rely below on our ability to
21573 reach point, in order to start from its X coordinate. So we
21574 need to disregard the window's horizontal extent in that case. */
21575 if (it
.line_wrap
== TRUNCATE
)
21576 it
.last_visible_x
= INFINITY
;
21578 if (it
.cmp_it
.id
< 0
21579 && it
.method
== GET_FROM_STRING
21580 && it
.area
== TEXT_AREA
21581 && it
.string_from_display_prop_p
21582 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21583 overshoot_expected
= true;
21585 /* Find the X coordinate of point. We start from the beginning
21586 of this or previous line to make sure we are before point in
21587 the logical order (since the move_it_* functions can only
21590 reseat_at_previous_visible_line_start (&it
);
21591 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21592 if (IT_CHARPOS (it
) != PT
)
21594 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21595 -1, -1, -1, MOVE_TO_POS
);
21596 /* If we missed point because the character there is
21597 displayed out of a display vector that has more than one
21598 glyph, retry expecting overshoot. */
21599 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21600 && it
.current
.dpvec_index
> 0
21601 && !overshoot_expected
)
21603 overshoot_expected
= true;
21606 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21607 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21609 pt_x
= it
.current_x
;
21611 if (dir
> 0 || overshoot_expected
)
21613 struct glyph_row
*row
= it
.glyph_row
;
21615 /* When point is at beginning of line, we don't have
21616 information about the glyph there loaded into struct
21617 it. Calling get_next_display_element fixes that. */
21619 get_next_display_element (&it
);
21620 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21621 it
.glyph_row
= NULL
;
21622 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21623 it
.glyph_row
= row
;
21624 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21625 it, lest it will become out of sync with it's buffer
21627 it
.current_x
= pt_x
;
21630 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21631 pixel_width
= it
.pixel_width
;
21632 if (overshoot_expected
&& at_eol_p
)
21634 else if (pixel_width
<= 0)
21637 /* If there's a display string (or something similar) at point,
21638 we are actually at the glyph to the left of point, so we need
21639 to correct the X coordinate. */
21640 if (overshoot_expected
)
21643 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21645 pt_x
+= pixel_width
;
21648 /* Compute target X coordinate, either to the left or to the
21649 right of point. On TTY frames, all characters have the same
21650 pixel width of 1, so we can use that. On GUI frames we don't
21651 have an easy way of getting at the pixel width of the
21652 character to the left of point, so we use a different method
21653 of getting to that place. */
21655 target_x
= pt_x
+ pixel_width
;
21657 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21659 /* Target X coordinate could be one line above or below the line
21660 of point, in which case we need to adjust the target X
21661 coordinate. Also, if moving to the left, we need to begin at
21662 the left edge of the point's screen line. */
21667 start_display (&it
, w
, pt
);
21668 if (it
.line_wrap
== TRUNCATE
)
21669 it
.last_visible_x
= INFINITY
;
21670 reseat_at_previous_visible_line_start (&it
);
21671 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21673 move_it_by_lines (&it
, pt_vpos
);
21677 move_it_by_lines (&it
, -1);
21678 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21679 target_is_eol_p
= true;
21680 /* Under word-wrap, we don't know the x coordinate of
21681 the last character displayed on the previous line,
21682 which immediately precedes the wrap point. To find
21683 out its x coordinate, we try moving to the right
21684 margin of the window, which will stop at the wrap
21685 point, and then reset target_x to point at the
21686 character that precedes the wrap point. This is not
21687 needed on GUI frames, because (see below) there we
21688 move from the left margin one grapheme cluster at a
21689 time, and stop when we hit the wrap point. */
21690 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21692 void *it_data
= NULL
;
21695 SAVE_IT (it2
, it
, it_data
);
21696 move_it_in_display_line_to (&it
, ZV
, target_x
,
21697 MOVE_TO_POS
| MOVE_TO_X
);
21698 /* If we arrived at target_x, that _is_ the last
21699 character on the previous line. */
21700 if (it
.current_x
!= target_x
)
21701 target_x
= it
.current_x
- 1;
21702 RESTORE_IT (&it
, &it2
, it_data
);
21709 || (target_x
>= it
.last_visible_x
21710 && it
.line_wrap
!= TRUNCATE
))
21713 move_it_by_lines (&it
, 0);
21714 move_it_by_lines (&it
, 1);
21719 /* Move to the target X coordinate. */
21720 #ifdef HAVE_WINDOW_SYSTEM
21721 /* On GUI frames, as we don't know the X coordinate of the
21722 character to the left of point, moving point to the left
21723 requires walking, one grapheme cluster at a time, until we
21724 find ourself at a place immediately to the left of the
21725 character at point. */
21726 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21728 struct text_pos new_pos
;
21729 enum move_it_result rc
= MOVE_X_REACHED
;
21731 if (it
.current_x
== 0)
21732 get_next_display_element (&it
);
21733 if (it
.what
== IT_COMPOSITION
)
21735 new_pos
.charpos
= it
.cmp_it
.charpos
;
21736 new_pos
.bytepos
= -1;
21739 new_pos
= it
.current
.pos
;
21741 while (it
.current_x
+ it
.pixel_width
<= target_x
21742 && (rc
== MOVE_X_REACHED
21743 /* Under word-wrap, move_it_in_display_line_to
21744 stops at correct coordinates, but sometimes
21745 returns MOVE_POS_MATCH_OR_ZV. */
21746 || (it
.line_wrap
== WORD_WRAP
21747 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21749 int new_x
= it
.current_x
+ it
.pixel_width
;
21751 /* For composed characters, we want the position of the
21752 first character in the grapheme cluster (usually, the
21753 composition's base character), whereas it.current
21754 might give us the position of the _last_ one, e.g. if
21755 the composition is rendered in reverse due to bidi
21757 if (it
.what
== IT_COMPOSITION
)
21759 new_pos
.charpos
= it
.cmp_it
.charpos
;
21760 new_pos
.bytepos
= -1;
21763 new_pos
= it
.current
.pos
;
21764 if (new_x
== it
.current_x
)
21766 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21767 MOVE_TO_POS
| MOVE_TO_X
);
21768 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21771 /* The previous position we saw in the loop is the one we
21773 if (new_pos
.bytepos
== -1)
21774 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21775 it
.current
.pos
= new_pos
;
21779 if (it
.current_x
!= target_x
)
21780 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21782 /* If we ended up in a display string that covers point, move to
21783 buffer position to the right in the visual order. */
21786 while (IT_CHARPOS (it
) == PT
)
21788 set_iterator_to_next (&it
, false);
21789 if (!get_next_display_element (&it
))
21794 /* Move point to that position. */
21795 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21798 return make_number (PT
);
21800 #undef ROW_GLYPH_NEWLINE_P
21803 DEFUN ("bidi-resolved-levels", Fbidi_resolved_levels
,
21804 Sbidi_resolved_levels
, 0, 1, 0,
21805 doc
: /* Return the resolved bidirectional levels of characters at VPOS.
21807 The resolved levels are produced by the Emacs bidi reordering engine
21808 that implements the UBA, the Unicode Bidirectional Algorithm. Please
21809 read the Unicode Standard Annex 9 (UAX#9) for background information
21810 about these levels.
21812 VPOS is the zero-based number of the current window's screen line
21813 for which to produce the resolved levels. If VPOS is nil or omitted,
21814 it defaults to the screen line of point. If the window displays a
21815 header line, VPOS of zero will report on the header line, and first
21816 line of text in the window will have VPOS of 1.
21818 Value is an array of resolved levels, indexed by glyph number.
21819 Glyphs are numbered from zero starting from the beginning of the
21820 screen line, i.e. the left edge of the window for left-to-right lines
21821 and from the right edge for right-to-left lines. The resolved levels
21822 are produced only for the window's text area; text in display margins
21825 If the selected window's display is not up-to-date, or if the specified
21826 screen line does not display text, this function returns nil. It is
21827 highly recommended to bind this function to some simple key, like F8,
21828 in order to avoid these problems.
21830 This function exists mainly for testing the correctness of the
21831 Emacs UBA implementation, in particular with the test suite. */)
21834 struct window
*w
= XWINDOW (selected_window
);
21835 struct buffer
*b
= XBUFFER (w
->contents
);
21837 struct glyph_row
*row
;
21841 int d1
, d2
, d3
, d4
, d5
;
21843 pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &nrow
);
21847 CHECK_NUMBER_COERCE_MARKER (vpos
);
21848 nrow
= XINT (vpos
);
21851 /* We require up-to-date glyph matrix for this window. */
21852 if (w
->window_end_valid
21853 && !windows_or_buffers_changed
21855 && !b
->clip_changed
21856 && !b
->prevent_redisplay_optimizations_p
21857 && !window_outdated (w
)
21859 && nrow
< w
->current_matrix
->nrows
21860 && (row
= MATRIX_ROW (w
->current_matrix
, nrow
))->enabled_p
21861 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
21863 struct glyph
*g
, *e
, *g1
;
21865 Lisp_Object levels
;
21867 if (!row
->reversed_p
) /* Left-to-right glyph row. */
21869 g
= g1
= row
->glyphs
[TEXT_AREA
];
21870 e
= g
+ row
->used
[TEXT_AREA
];
21872 /* Skip over glyphs at the start of the row that was
21873 generated by redisplay for its own needs. */
21875 && NILP (g
->object
)
21880 /* Count the "interesting" glyphs in this row. */
21881 for (nglyphs
= 0; g
< e
&& !NILP (g
->object
); g
++)
21884 /* Create and fill the array. */
21885 levels
= make_uninit_vector (nglyphs
);
21886 for (i
= 0; g1
< g
; i
++, g1
++)
21887 ASET (levels
, i
, make_number (g1
->resolved_level
));
21889 else /* Right-to-left glyph row. */
21891 g
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
21892 e
= row
->glyphs
[TEXT_AREA
] - 1;
21894 && NILP (g
->object
)
21898 for (nglyphs
= 0; g
> e
&& !NILP (g
->object
); g
--)
21900 levels
= make_uninit_vector (nglyphs
);
21901 for (i
= 0; g1
> g
; i
++, g1
--)
21902 ASET (levels
, i
, make_number (g1
->resolved_level
));
21912 /***********************************************************************
21914 ***********************************************************************/
21916 /* Redisplay the menu bar in the frame for window W.
21918 The menu bar of X frames that don't have X toolkit support is
21919 displayed in a special window W->frame->menu_bar_window.
21921 The menu bar of terminal frames is treated specially as far as
21922 glyph matrices are concerned. Menu bar lines are not part of
21923 windows, so the update is done directly on the frame matrix rows
21924 for the menu bar. */
21927 display_menu_bar (struct window
*w
)
21929 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21934 /* Don't do all this for graphical frames. */
21936 if (FRAME_W32_P (f
))
21939 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21945 if (FRAME_NS_P (f
))
21947 #endif /* HAVE_NS */
21949 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21950 eassert (!FRAME_WINDOW_P (f
));
21951 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21952 it
.first_visible_x
= 0;
21953 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21954 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21955 if (FRAME_WINDOW_P (f
))
21957 /* Menu bar lines are displayed in the desired matrix of the
21958 dummy window menu_bar_window. */
21959 struct window
*menu_w
;
21960 menu_w
= XWINDOW (f
->menu_bar_window
);
21961 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21963 it
.first_visible_x
= 0;
21964 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21967 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21969 /* This is a TTY frame, i.e. character hpos/vpos are used as
21971 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21973 it
.first_visible_x
= 0;
21974 it
.last_visible_x
= FRAME_COLS (f
);
21977 /* FIXME: This should be controlled by a user option. See the
21978 comments in redisplay_tool_bar and display_mode_line about
21980 it
.paragraph_embedding
= L2R
;
21982 /* Clear all rows of the menu bar. */
21983 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21985 struct glyph_row
*row
= it
.glyph_row
+ i
;
21986 clear_glyph_row (row
);
21987 row
->enabled_p
= true;
21988 row
->full_width_p
= true;
21989 row
->reversed_p
= false;
21992 /* Display all items of the menu bar. */
21993 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21994 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21996 Lisp_Object string
;
21998 /* Stop at nil string. */
21999 string
= AREF (items
, i
+ 1);
22003 /* Remember where item was displayed. */
22004 ASET (items
, i
+ 3, make_number (it
.hpos
));
22006 /* Display the item, pad with one space. */
22007 if (it
.current_x
< it
.last_visible_x
)
22008 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
22009 SCHARS (string
) + 1, 0, 0, -1);
22012 /* Fill out the line with spaces. */
22013 if (it
.current_x
< it
.last_visible_x
)
22014 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
22016 /* Compute the total height of the lines. */
22017 compute_line_metrics (&it
);
22020 /* Deep copy of a glyph row, including the glyphs. */
22022 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
22024 struct glyph
*pointers
[1 + LAST_AREA
];
22025 int to_used
= to
->used
[TEXT_AREA
];
22027 /* Save glyph pointers of TO. */
22028 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
22030 /* Do a structure assignment. */
22033 /* Restore original glyph pointers of TO. */
22034 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
22036 /* Copy the glyphs. */
22037 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
22038 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
22040 /* If we filled only part of the TO row, fill the rest with
22041 space_glyph (which will display as empty space). */
22042 if (to_used
> from
->used
[TEXT_AREA
])
22043 fill_up_frame_row_with_spaces (to
, to_used
);
22046 /* Display one menu item on a TTY, by overwriting the glyphs in the
22047 frame F's desired glyph matrix with glyphs produced from the menu
22048 item text. Called from term.c to display TTY drop-down menus one
22051 ITEM_TEXT is the menu item text as a C string.
22053 FACE_ID is the face ID to be used for this menu item. FACE_ID
22054 could specify one of 3 faces: a face for an enabled item, a face
22055 for a disabled item, or a face for a selected item.
22057 X and Y are coordinates of the first glyph in the frame's desired
22058 matrix to be overwritten by the menu item. Since this is a TTY, Y
22059 is the zero-based number of the glyph row and X is the zero-based
22060 glyph number in the row, starting from left, where to start
22061 displaying the item.
22063 SUBMENU means this menu item drops down a submenu, which
22064 should be indicated by displaying a proper visual cue after the
22068 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
22069 int x
, int y
, bool submenu
)
22072 struct frame
*f
= SELECTED_FRAME ();
22073 struct window
*w
= XWINDOW (f
->selected_window
);
22074 struct glyph_row
*row
;
22075 size_t item_len
= strlen (item_text
);
22077 eassert (FRAME_TERMCAP_P (f
));
22079 /* Don't write beyond the matrix's last row. This can happen for
22080 TTY screens that are not high enough to show the entire menu.
22081 (This is actually a bit of defensive programming, as
22082 tty_menu_display already limits the number of menu items to one
22083 less than the number of screen lines.) */
22084 if (y
>= f
->desired_matrix
->nrows
)
22087 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
22088 it
.first_visible_x
= 0;
22089 it
.last_visible_x
= FRAME_COLS (f
) - 1;
22090 row
= it
.glyph_row
;
22091 /* Start with the row contents from the current matrix. */
22092 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
22093 bool saved_width
= row
->full_width_p
;
22094 row
->full_width_p
= true;
22095 bool saved_reversed
= row
->reversed_p
;
22096 row
->reversed_p
= false;
22097 row
->enabled_p
= true;
22099 /* Arrange for the menu item glyphs to start at (X,Y) and have the
22101 eassert (x
< f
->desired_matrix
->matrix_w
);
22102 it
.current_x
= it
.hpos
= x
;
22103 it
.current_y
= it
.vpos
= y
;
22104 int saved_used
= row
->used
[TEXT_AREA
];
22105 bool saved_truncated
= row
->truncated_on_right_p
;
22106 row
->used
[TEXT_AREA
] = x
;
22107 it
.face_id
= face_id
;
22108 it
.line_wrap
= TRUNCATE
;
22110 /* FIXME: This should be controlled by a user option. See the
22111 comments in redisplay_tool_bar and display_mode_line about this.
22112 Also, if paragraph_embedding could ever be R2L, changes will be
22113 needed to avoid shifting to the right the row characters in
22114 term.c:append_glyph. */
22115 it
.paragraph_embedding
= L2R
;
22117 /* Pad with a space on the left. */
22118 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
22120 /* Display the menu item, pad with spaces to WIDTH. */
22123 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
22124 item_len
, 0, FRAME_COLS (f
) - 1, -1);
22126 /* Indicate with " >" that there's a submenu. */
22127 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
22128 FRAME_COLS (f
) - 1, -1);
22131 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
22132 width
, 0, FRAME_COLS (f
) - 1, -1);
22134 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
22135 row
->truncated_on_right_p
= saved_truncated
;
22136 row
->hash
= row_hash (row
);
22137 row
->full_width_p
= saved_width
;
22138 row
->reversed_p
= saved_reversed
;
22141 /***********************************************************************
22143 ***********************************************************************/
22145 /* Redisplay mode lines in the window tree whose root is WINDOW.
22146 If FORCE, redisplay mode lines unconditionally.
22147 Otherwise, redisplay only mode lines that are garbaged. Value is
22148 the number of windows whose mode lines were redisplayed. */
22151 redisplay_mode_lines (Lisp_Object window
, bool force
)
22155 while (!NILP (window
))
22157 struct window
*w
= XWINDOW (window
);
22159 if (WINDOWP (w
->contents
))
22160 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
22162 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
22163 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
22165 struct text_pos lpoint
;
22166 struct buffer
*old
= current_buffer
;
22168 /* Set the window's buffer for the mode line display. */
22169 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
22170 set_buffer_internal_1 (XBUFFER (w
->contents
));
22172 /* Point refers normally to the selected window. For any
22173 other window, set up appropriate value. */
22174 if (!EQ (window
, selected_window
))
22176 struct text_pos pt
;
22178 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
22179 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
22182 /* Display mode lines. */
22183 clear_glyph_matrix (w
->desired_matrix
);
22184 if (display_mode_lines (w
))
22187 /* Restore old settings. */
22188 set_buffer_internal_1 (old
);
22189 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
22199 /* Display the mode and/or header line of window W. Value is the
22200 sum number of mode lines and header lines displayed. */
22203 display_mode_lines (struct window
*w
)
22205 Lisp_Object old_selected_window
= selected_window
;
22206 Lisp_Object old_selected_frame
= selected_frame
;
22207 Lisp_Object new_frame
= w
->frame
;
22208 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
22211 selected_frame
= new_frame
;
22212 /* FIXME: If we were to allow the mode-line's computation changing the buffer
22213 or window's point, then we'd need select_window_1 here as well. */
22214 XSETWINDOW (selected_window
, w
);
22215 XFRAME (new_frame
)->selected_window
= selected_window
;
22217 /* These will be set while the mode line specs are processed. */
22218 line_number_displayed
= false;
22219 w
->column_number_displayed
= -1;
22221 if (WINDOW_WANTS_MODELINE_P (w
))
22223 struct window
*sel_w
= XWINDOW (old_selected_window
);
22225 /* Select mode line face based on the real selected window. */
22226 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
22227 BVAR (current_buffer
, mode_line_format
));
22231 if (WINDOW_WANTS_HEADER_LINE_P (w
))
22233 display_mode_line (w
, HEADER_LINE_FACE_ID
,
22234 BVAR (current_buffer
, header_line_format
));
22238 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
22239 selected_frame
= old_selected_frame
;
22240 selected_window
= old_selected_window
;
22242 w
->must_be_updated_p
= true;
22247 /* Display mode or header line of window W. FACE_ID specifies which
22248 line to display; it is either MODE_LINE_FACE_ID or
22249 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
22250 display. Value is the pixel height of the mode/header line
22254 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
22258 ptrdiff_t count
= SPECPDL_INDEX ();
22260 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22261 /* Don't extend on a previously drawn mode-line.
22262 This may happen if called from pos_visible_p. */
22263 it
.glyph_row
->enabled_p
= false;
22264 prepare_desired_row (w
, it
.glyph_row
, true);
22266 it
.glyph_row
->mode_line_p
= true;
22268 /* FIXME: This should be controlled by a user option. But
22269 supporting such an option is not trivial, since the mode line is
22270 made up of many separate strings. */
22271 it
.paragraph_embedding
= L2R
;
22273 record_unwind_protect (unwind_format_mode_line
,
22274 format_mode_line_unwind_data (NULL
, NULL
,
22277 mode_line_target
= MODE_LINE_DISPLAY
;
22279 /* Temporarily make frame's keyboard the current kboard so that
22280 kboard-local variables in the mode_line_format will get the right
22282 push_kboard (FRAME_KBOARD (it
.f
));
22283 record_unwind_save_match_data ();
22284 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22287 unbind_to (count
, Qnil
);
22289 /* Fill up with spaces. */
22290 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
22292 compute_line_metrics (&it
);
22293 it
.glyph_row
->full_width_p
= true;
22294 it
.glyph_row
->continued_p
= false;
22295 it
.glyph_row
->truncated_on_left_p
= false;
22296 it
.glyph_row
->truncated_on_right_p
= false;
22298 /* Make a 3D mode-line have a shadow at its right end. */
22299 face
= FACE_FROM_ID (it
.f
, face_id
);
22300 extend_face_to_end_of_line (&it
);
22301 if (face
->box
!= FACE_NO_BOX
)
22303 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
22304 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
22305 last
->right_box_line_p
= true;
22308 return it
.glyph_row
->height
;
22311 /* Move element ELT in LIST to the front of LIST.
22312 Return the updated list. */
22315 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
22317 register Lisp_Object tail
, prev
;
22318 register Lisp_Object tem
;
22322 while (CONSP (tail
))
22328 /* Splice out the link TAIL. */
22330 list
= XCDR (tail
);
22332 Fsetcdr (prev
, XCDR (tail
));
22334 /* Now make it the first. */
22335 Fsetcdr (tail
, list
);
22340 tail
= XCDR (tail
);
22344 /* Not found--return unchanged LIST. */
22348 /* Contribute ELT to the mode line for window IT->w. How it
22349 translates into text depends on its data type.
22351 IT describes the display environment in which we display, as usual.
22353 DEPTH is the depth in recursion. It is used to prevent
22354 infinite recursion here.
22356 FIELD_WIDTH is the number of characters the display of ELT should
22357 occupy in the mode line, and PRECISION is the maximum number of
22358 characters to display from ELT's representation. See
22359 display_string for details.
22361 Returns the hpos of the end of the text generated by ELT.
22363 PROPS is a property list to add to any string we encounter.
22365 If RISKY, remove (disregard) any properties in any string
22366 we encounter, and ignore :eval and :propertize.
22368 The global variable `mode_line_target' determines whether the
22369 output is passed to `store_mode_line_noprop',
22370 `store_mode_line_string', or `display_string'. */
22373 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
22374 Lisp_Object elt
, Lisp_Object props
, bool risky
)
22376 int n
= 0, field
, prec
;
22377 bool literal
= false;
22381 elt
= build_string ("*too-deep*");
22385 switch (XTYPE (elt
))
22389 /* A string: output it and check for %-constructs within it. */
22391 ptrdiff_t offset
= 0;
22393 if (SCHARS (elt
) > 0
22394 && (!NILP (props
) || risky
))
22396 Lisp_Object oprops
, aelt
;
22397 oprops
= Ftext_properties_at (make_number (0), elt
);
22399 /* If the starting string's properties are not what
22400 we want, translate the string. Also, if the string
22401 is risky, do that anyway. */
22403 if (NILP (Fequal (props
, oprops
)) || risky
)
22405 /* If the starting string has properties,
22406 merge the specified ones onto the existing ones. */
22407 if (! NILP (oprops
) && !risky
)
22411 oprops
= Fcopy_sequence (oprops
);
22413 while (CONSP (tem
))
22415 oprops
= Fplist_put (oprops
, XCAR (tem
),
22416 XCAR (XCDR (tem
)));
22417 tem
= XCDR (XCDR (tem
));
22422 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
22423 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
22425 /* AELT is what we want. Move it to the front
22426 without consing. */
22428 mode_line_proptrans_alist
22429 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
22435 /* If AELT has the wrong props, it is useless.
22436 so get rid of it. */
22438 mode_line_proptrans_alist
22439 = Fdelq (aelt
, mode_line_proptrans_alist
);
22441 elt
= Fcopy_sequence (elt
);
22442 Fset_text_properties (make_number (0), Flength (elt
),
22444 /* Add this item to mode_line_proptrans_alist. */
22445 mode_line_proptrans_alist
22446 = Fcons (Fcons (elt
, props
),
22447 mode_line_proptrans_alist
);
22448 /* Truncate mode_line_proptrans_alist
22449 to at most 50 elements. */
22450 tem
= Fnthcdr (make_number (50),
22451 mode_line_proptrans_alist
);
22453 XSETCDR (tem
, Qnil
);
22462 prec
= precision
- n
;
22463 switch (mode_line_target
)
22465 case MODE_LINE_NOPROP
:
22466 case MODE_LINE_TITLE
:
22467 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
22469 case MODE_LINE_STRING
:
22470 n
+= store_mode_line_string (NULL
, elt
, true, 0, prec
, Qnil
);
22472 case MODE_LINE_DISPLAY
:
22473 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
22474 0, prec
, 0, STRING_MULTIBYTE (elt
));
22481 /* Handle the non-literal case. */
22483 while ((precision
<= 0 || n
< precision
)
22484 && SREF (elt
, offset
) != 0
22485 && (mode_line_target
!= MODE_LINE_DISPLAY
22486 || it
->current_x
< it
->last_visible_x
))
22488 ptrdiff_t last_offset
= offset
;
22490 /* Advance to end of string or next format specifier. */
22491 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22494 if (offset
- 1 != last_offset
)
22496 ptrdiff_t nchars
, nbytes
;
22498 /* Output to end of string or up to '%'. Field width
22499 is length of string. Don't output more than
22500 PRECISION allows us. */
22503 prec
= c_string_width (SDATA (elt
) + last_offset
,
22504 offset
- last_offset
, precision
- n
,
22507 switch (mode_line_target
)
22509 case MODE_LINE_NOPROP
:
22510 case MODE_LINE_TITLE
:
22511 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22513 case MODE_LINE_STRING
:
22515 ptrdiff_t bytepos
= last_offset
;
22516 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22517 ptrdiff_t endpos
= (precision
<= 0
22518 ? string_byte_to_char (elt
, offset
)
22519 : charpos
+ nchars
);
22520 Lisp_Object mode_string
22521 = Fsubstring (elt
, make_number (charpos
),
22522 make_number (endpos
));
22523 n
+= store_mode_line_string (NULL
, mode_string
, false,
22527 case MODE_LINE_DISPLAY
:
22529 ptrdiff_t bytepos
= last_offset
;
22530 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22532 if (precision
<= 0)
22533 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22534 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22536 STRING_MULTIBYTE (elt
));
22541 else /* c == '%' */
22543 ptrdiff_t percent_position
= offset
;
22545 /* Get the specified minimum width. Zero means
22548 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22549 field
= field
* 10 + c
- '0';
22551 /* Don't pad beyond the total padding allowed. */
22552 if (field_width
- n
> 0 && field
> field_width
- n
)
22553 field
= field_width
- n
;
22555 /* Note that either PRECISION <= 0 or N < PRECISION. */
22556 prec
= precision
- n
;
22559 n
+= display_mode_element (it
, depth
, field
, prec
,
22560 Vglobal_mode_string
, props
,
22565 ptrdiff_t bytepos
, charpos
;
22567 Lisp_Object string
;
22569 bytepos
= percent_position
;
22570 charpos
= (STRING_MULTIBYTE (elt
)
22571 ? string_byte_to_char (elt
, bytepos
)
22573 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22574 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22576 switch (mode_line_target
)
22578 case MODE_LINE_NOPROP
:
22579 case MODE_LINE_TITLE
:
22580 n
+= store_mode_line_noprop (spec
, field
, prec
);
22582 case MODE_LINE_STRING
:
22584 Lisp_Object tem
= build_string (spec
);
22585 props
= Ftext_properties_at (make_number (charpos
), elt
);
22586 /* Should only keep face property in props */
22587 n
+= store_mode_line_string (NULL
, tem
, false,
22588 field
, prec
, props
);
22591 case MODE_LINE_DISPLAY
:
22593 int nglyphs_before
, nwritten
;
22595 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22596 nwritten
= display_string (spec
, string
, elt
,
22601 /* Assign to the glyphs written above the
22602 string where the `%x' came from, position
22606 struct glyph
*glyph
22607 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22611 for (i
= 0; i
< nwritten
; ++i
)
22613 glyph
[i
].object
= elt
;
22614 glyph
[i
].charpos
= charpos
;
22631 /* A symbol: process the value of the symbol recursively
22632 as if it appeared here directly. Avoid error if symbol void.
22633 Special case: if value of symbol is a string, output the string
22636 register Lisp_Object tem
;
22638 /* If the variable is not marked as risky to set
22639 then its contents are risky to use. */
22640 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22643 tem
= Fboundp (elt
);
22646 tem
= Fsymbol_value (elt
);
22647 /* If value is a string, output that string literally:
22648 don't check for % within it. */
22652 if (!EQ (tem
, elt
))
22654 /* Give up right away for nil or t. */
22664 register Lisp_Object car
, tem
;
22666 /* A cons cell: five distinct cases.
22667 If first element is :eval or :propertize, do something special.
22668 If first element is a string or a cons, process all the elements
22669 and effectively concatenate them.
22670 If first element is a negative number, truncate displaying cdr to
22671 at most that many characters. If positive, pad (with spaces)
22672 to at least that many characters.
22673 If first element is a symbol, process the cadr or caddr recursively
22674 according to whether the symbol's value is non-nil or nil. */
22676 if (EQ (car
, QCeval
))
22678 /* An element of the form (:eval FORM) means evaluate FORM
22679 and use the result as mode line elements. */
22684 if (CONSP (XCDR (elt
)))
22687 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22688 n
+= display_mode_element (it
, depth
, field_width
- n
,
22689 precision
- n
, spec
, props
,
22693 else if (EQ (car
, QCpropertize
))
22695 /* An element of the form (:propertize ELT PROPS...)
22696 means display ELT but applying properties PROPS. */
22701 if (CONSP (XCDR (elt
)))
22702 n
+= display_mode_element (it
, depth
, field_width
- n
,
22703 precision
- n
, XCAR (XCDR (elt
)),
22704 XCDR (XCDR (elt
)), risky
);
22706 else if (SYMBOLP (car
))
22708 tem
= Fboundp (car
);
22712 /* elt is now the cdr, and we know it is a cons cell.
22713 Use its car if CAR has a non-nil value. */
22716 tem
= Fsymbol_value (car
);
22723 /* Symbol's value is nil (or symbol is unbound)
22724 Get the cddr of the original list
22725 and if possible find the caddr and use that. */
22729 else if (!CONSP (elt
))
22734 else if (INTEGERP (car
))
22736 register int lim
= XINT (car
);
22740 /* Negative int means reduce maximum width. */
22741 if (precision
<= 0)
22744 precision
= min (precision
, -lim
);
22748 /* Padding specified. Don't let it be more than
22749 current maximum. */
22751 lim
= min (precision
, lim
);
22753 /* If that's more padding than already wanted, queue it.
22754 But don't reduce padding already specified even if
22755 that is beyond the current truncation point. */
22756 field_width
= max (lim
, field_width
);
22760 else if (STRINGP (car
) || CONSP (car
))
22762 Lisp_Object halftail
= elt
;
22766 && (precision
<= 0 || n
< precision
))
22768 n
+= display_mode_element (it
, depth
,
22769 /* Do padding only after the last
22770 element in the list. */
22771 (! CONSP (XCDR (elt
))
22774 precision
- n
, XCAR (elt
),
22778 if ((len
& 1) == 0)
22779 halftail
= XCDR (halftail
);
22780 /* Check for cycle. */
22781 if (EQ (halftail
, elt
))
22790 elt
= build_string ("*invalid*");
22794 /* Pad to FIELD_WIDTH. */
22795 if (field_width
> 0 && n
< field_width
)
22797 switch (mode_line_target
)
22799 case MODE_LINE_NOPROP
:
22800 case MODE_LINE_TITLE
:
22801 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22803 case MODE_LINE_STRING
:
22804 n
+= store_mode_line_string ("", Qnil
, false, field_width
- n
, 0,
22807 case MODE_LINE_DISPLAY
:
22808 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22817 /* Store a mode-line string element in mode_line_string_list.
22819 If STRING is non-null, display that C string. Otherwise, the Lisp
22820 string LISP_STRING is displayed.
22822 FIELD_WIDTH is the minimum number of output glyphs to produce.
22823 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22824 with spaces. FIELD_WIDTH <= 0 means don't pad.
22826 PRECISION is the maximum number of characters to output from
22827 STRING. PRECISION <= 0 means don't truncate the string.
22829 If COPY_STRING, make a copy of LISP_STRING before adding
22830 properties to the string.
22832 PROPS are the properties to add to the string.
22833 The mode_line_string_face face property is always added to the string.
22837 store_mode_line_string (const char *string
, Lisp_Object lisp_string
,
22839 int field_width
, int precision
, Lisp_Object props
)
22844 if (string
!= NULL
)
22846 len
= strlen (string
);
22847 if (precision
> 0 && len
> precision
)
22849 lisp_string
= make_string (string
, len
);
22851 props
= mode_line_string_face_prop
;
22852 else if (!NILP (mode_line_string_face
))
22854 Lisp_Object face
= Fplist_get (props
, Qface
);
22855 props
= Fcopy_sequence (props
);
22857 face
= mode_line_string_face
;
22859 face
= list2 (face
, mode_line_string_face
);
22860 props
= Fplist_put (props
, Qface
, face
);
22862 Fadd_text_properties (make_number (0), make_number (len
),
22863 props
, lisp_string
);
22867 len
= XFASTINT (Flength (lisp_string
));
22868 if (precision
> 0 && len
> precision
)
22871 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22874 if (!NILP (mode_line_string_face
))
22878 props
= Ftext_properties_at (make_number (0), lisp_string
);
22879 face
= Fplist_get (props
, Qface
);
22881 face
= mode_line_string_face
;
22883 face
= list2 (face
, mode_line_string_face
);
22884 props
= list2 (Qface
, face
);
22886 lisp_string
= Fcopy_sequence (lisp_string
);
22889 Fadd_text_properties (make_number (0), make_number (len
),
22890 props
, lisp_string
);
22895 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22899 if (field_width
> len
)
22901 field_width
-= len
;
22902 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22904 Fadd_text_properties (make_number (0), make_number (field_width
),
22905 props
, lisp_string
);
22906 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22914 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22916 doc
: /* Format a string out of a mode line format specification.
22917 First arg FORMAT specifies the mode line format (see `mode-line-format'
22918 for details) to use.
22920 By default, the format is evaluated for the currently selected window.
22922 Optional second arg FACE specifies the face property to put on all
22923 characters for which no face is specified. The value nil means the
22924 default face. The value t means whatever face the window's mode line
22925 currently uses (either `mode-line' or `mode-line-inactive',
22926 depending on whether the window is the selected window or not).
22927 An integer value means the value string has no text
22930 Optional third and fourth args WINDOW and BUFFER specify the window
22931 and buffer to use as the context for the formatting (defaults
22932 are the selected window and the WINDOW's buffer). */)
22933 (Lisp_Object format
, Lisp_Object face
,
22934 Lisp_Object window
, Lisp_Object buffer
)
22939 struct buffer
*old_buffer
= NULL
;
22941 bool no_props
= INTEGERP (face
);
22942 ptrdiff_t count
= SPECPDL_INDEX ();
22944 int string_start
= 0;
22946 w
= decode_any_window (window
);
22947 XSETWINDOW (window
, w
);
22950 buffer
= w
->contents
;
22951 CHECK_BUFFER (buffer
);
22953 /* Make formatting the modeline a non-op when noninteractive, otherwise
22954 there will be problems later caused by a partially initialized frame. */
22955 if (NILP (format
) || noninteractive
)
22956 return empty_unibyte_string
;
22961 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22962 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22963 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22964 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22965 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22966 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22967 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22970 old_buffer
= current_buffer
;
22972 /* Save things including mode_line_proptrans_alist,
22973 and set that to nil so that we don't alter the outer value. */
22974 record_unwind_protect (unwind_format_mode_line
,
22975 format_mode_line_unwind_data
22976 (XFRAME (WINDOW_FRAME (w
)),
22977 old_buffer
, selected_window
, true));
22978 mode_line_proptrans_alist
= Qnil
;
22980 Fselect_window (window
, Qt
);
22981 set_buffer_internal_1 (XBUFFER (buffer
));
22983 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22987 mode_line_target
= MODE_LINE_NOPROP
;
22988 mode_line_string_face_prop
= Qnil
;
22989 mode_line_string_list
= Qnil
;
22990 string_start
= MODE_LINE_NOPROP_LEN (0);
22994 mode_line_target
= MODE_LINE_STRING
;
22995 mode_line_string_list
= Qnil
;
22996 mode_line_string_face
= face
;
22997 mode_line_string_face_prop
22998 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
23001 push_kboard (FRAME_KBOARD (it
.f
));
23002 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
23007 len
= MODE_LINE_NOPROP_LEN (string_start
);
23008 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
23012 mode_line_string_list
= Fnreverse (mode_line_string_list
);
23013 str
= Fmapconcat (Qidentity
, mode_line_string_list
,
23014 empty_unibyte_string
);
23017 unbind_to (count
, Qnil
);
23021 /* Write a null-terminated, right justified decimal representation of
23022 the positive integer D to BUF using a minimal field width WIDTH. */
23025 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
23027 register char *p
= buf
;
23035 *p
++ = d
% 10 + '0';
23040 for (width
-= (int) (p
- buf
); width
> 0; --width
)
23051 /* Write a null-terminated, right justified decimal and "human
23052 readable" representation of the nonnegative integer D to BUF using
23053 a minimal field width WIDTH. D should be smaller than 999.5e24. */
23055 static const char power_letter
[] =
23069 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
23071 /* We aim to represent the nonnegative integer D as
23072 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
23073 ptrdiff_t quotient
= d
;
23075 /* -1 means: do not use TENTHS. */
23079 /* Length of QUOTIENT.TENTHS as a string. */
23085 if (quotient
>= 1000)
23087 /* Scale to the appropriate EXPONENT. */
23090 remainder
= quotient
% 1000;
23094 while (quotient
>= 1000);
23096 /* Round to nearest and decide whether to use TENTHS or not. */
23099 tenths
= remainder
/ 100;
23100 if (remainder
% 100 >= 50)
23107 if (quotient
== 10)
23115 if (remainder
>= 500)
23117 if (quotient
< 999)
23128 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
23129 if (tenths
== -1 && quotient
<= 99)
23136 p
= psuffix
= buf
+ max (width
, length
);
23138 /* Print EXPONENT. */
23139 *psuffix
++ = power_letter
[exponent
];
23142 /* Print TENTHS. */
23145 *--p
= '0' + tenths
;
23149 /* Print QUOTIENT. */
23152 int digit
= quotient
% 10;
23153 *--p
= '0' + digit
;
23155 while ((quotient
/= 10) != 0);
23157 /* Print leading spaces. */
23162 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
23163 If EOL_FLAG, set also a mnemonic character for end-of-line
23164 type of CODING_SYSTEM. Return updated pointer into BUF. */
23166 static unsigned char invalid_eol_type
[] = "(*invalid*)";
23169 decode_mode_spec_coding (Lisp_Object coding_system
, char *buf
, bool eol_flag
)
23172 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
23173 const unsigned char *eol_str
;
23175 /* The EOL conversion we are using. */
23176 Lisp_Object eoltype
;
23178 val
= CODING_SYSTEM_SPEC (coding_system
);
23181 if (!VECTORP (val
)) /* Not yet decided. */
23183 *buf
++ = multibyte
? '-' : ' ';
23185 eoltype
= eol_mnemonic_undecided
;
23186 /* Don't mention EOL conversion if it isn't decided. */
23191 Lisp_Object eolvalue
;
23193 attrs
= AREF (val
, 0);
23194 eolvalue
= AREF (val
, 2);
23197 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
23202 /* The EOL conversion that is normal on this system. */
23204 if (NILP (eolvalue
)) /* Not yet decided. */
23205 eoltype
= eol_mnemonic_undecided
;
23206 else if (VECTORP (eolvalue
)) /* Not yet decided. */
23207 eoltype
= eol_mnemonic_undecided
;
23208 else /* eolvalue is Qunix, Qdos, or Qmac. */
23209 eoltype
= (EQ (eolvalue
, Qunix
)
23210 ? eol_mnemonic_unix
23211 : EQ (eolvalue
, Qdos
)
23212 ? eol_mnemonic_dos
: eol_mnemonic_mac
);
23218 /* Mention the EOL conversion if it is not the usual one. */
23219 if (STRINGP (eoltype
))
23221 eol_str
= SDATA (eoltype
);
23222 eol_str_len
= SBYTES (eoltype
);
23224 else if (CHARACTERP (eoltype
))
23226 int c
= XFASTINT (eoltype
);
23227 return buf
+ CHAR_STRING (c
, (unsigned char *) buf
);
23231 eol_str
= invalid_eol_type
;
23232 eol_str_len
= sizeof (invalid_eol_type
) - 1;
23234 memcpy (buf
, eol_str
, eol_str_len
);
23235 buf
+= eol_str_len
;
23241 /* Return a string for the output of a mode line %-spec for window W,
23242 generated by character C. FIELD_WIDTH > 0 means pad the string
23243 returned with spaces to that value. Return a Lisp string in
23244 *STRING if the resulting string is taken from that Lisp string.
23246 Note we operate on the current buffer for most purposes. */
23248 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
23250 static const char *
23251 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
23252 Lisp_Object
*string
)
23255 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23256 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
23257 /* We are going to use f->decode_mode_spec_buffer as the buffer to
23258 produce strings from numerical values, so limit preposterously
23259 large values of FIELD_WIDTH to avoid overrunning the buffer's
23260 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
23261 bytes plus the terminating null. */
23262 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
23263 struct buffer
*b
= current_buffer
;
23271 if (!NILP (BVAR (b
, read_only
)))
23273 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23278 /* This differs from %* only for a modified read-only buffer. */
23279 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23281 if (!NILP (BVAR (b
, read_only
)))
23286 /* This differs from %* in ignoring read-only-ness. */
23287 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23299 if (command_loop_level
> 5)
23301 p
= decode_mode_spec_buf
;
23302 for (i
= 0; i
< command_loop_level
; i
++)
23305 return decode_mode_spec_buf
;
23313 if (command_loop_level
> 5)
23315 p
= decode_mode_spec_buf
;
23316 for (i
= 0; i
< command_loop_level
; i
++)
23319 return decode_mode_spec_buf
;
23326 /* Let lots_of_dashes be a string of infinite length. */
23327 if (mode_line_target
== MODE_LINE_NOPROP
23328 || mode_line_target
== MODE_LINE_STRING
)
23330 if (field_width
<= 0
23331 || field_width
> sizeof (lots_of_dashes
))
23333 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
23334 decode_mode_spec_buf
[i
] = '-';
23335 decode_mode_spec_buf
[i
] = '\0';
23336 return decode_mode_spec_buf
;
23339 return lots_of_dashes
;
23343 obj
= BVAR (b
, name
);
23347 /* %c and %l are ignored in `frame-title-format'.
23348 (In redisplay_internal, the frame title is drawn _before_ the
23349 windows are updated, so the stuff which depends on actual
23350 window contents (such as %l) may fail to render properly, or
23351 even crash emacs.) */
23352 if (mode_line_target
== MODE_LINE_TITLE
)
23356 ptrdiff_t col
= current_column ();
23357 w
->column_number_displayed
= col
;
23358 pint2str (decode_mode_spec_buf
, width
, col
);
23359 return decode_mode_spec_buf
;
23363 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
23365 if (NILP (Vmemory_full
))
23368 return "!MEM FULL! ";
23375 /* %F displays the frame name. */
23376 if (!NILP (f
->title
))
23377 return SSDATA (f
->title
);
23378 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
23379 return SSDATA (f
->name
);
23383 obj
= BVAR (b
, filename
);
23388 ptrdiff_t size
= ZV
- BEGV
;
23389 pint2str (decode_mode_spec_buf
, width
, size
);
23390 return decode_mode_spec_buf
;
23395 ptrdiff_t size
= ZV
- BEGV
;
23396 pint2hrstr (decode_mode_spec_buf
, width
, size
);
23397 return decode_mode_spec_buf
;
23402 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
23403 ptrdiff_t topline
, nlines
, height
;
23406 /* %c and %l are ignored in `frame-title-format'. */
23407 if (mode_line_target
== MODE_LINE_TITLE
)
23410 startpos
= marker_position (w
->start
);
23411 startpos_byte
= marker_byte_position (w
->start
);
23412 height
= WINDOW_TOTAL_LINES (w
);
23414 /* If we decided that this buffer isn't suitable for line numbers,
23415 don't forget that too fast. */
23416 if (w
->base_line_pos
== -1)
23419 /* If the buffer is very big, don't waste time. */
23420 if (INTEGERP (Vline_number_display_limit
)
23421 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
23423 w
->base_line_pos
= 0;
23424 w
->base_line_number
= 0;
23428 if (w
->base_line_number
> 0
23429 && w
->base_line_pos
> 0
23430 && w
->base_line_pos
<= startpos
)
23432 line
= w
->base_line_number
;
23433 linepos
= w
->base_line_pos
;
23434 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
23439 linepos
= BUF_BEGV (b
);
23440 linepos_byte
= BUF_BEGV_BYTE (b
);
23443 /* Count lines from base line to window start position. */
23444 nlines
= display_count_lines (linepos_byte
,
23448 topline
= nlines
+ line
;
23450 /* Determine a new base line, if the old one is too close
23451 or too far away, or if we did not have one.
23452 "Too close" means it's plausible a scroll-down would
23453 go back past it. */
23454 if (startpos
== BUF_BEGV (b
))
23456 w
->base_line_number
= topline
;
23457 w
->base_line_pos
= BUF_BEGV (b
);
23459 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
23460 || linepos
== BUF_BEGV (b
))
23462 ptrdiff_t limit
= BUF_BEGV (b
);
23463 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
23464 ptrdiff_t position
;
23465 ptrdiff_t distance
=
23466 (height
* 2 + 30) * line_number_display_limit_width
;
23468 if (startpos
- distance
> limit
)
23470 limit
= startpos
- distance
;
23471 limit_byte
= CHAR_TO_BYTE (limit
);
23474 nlines
= display_count_lines (startpos_byte
,
23476 - (height
* 2 + 30),
23478 /* If we couldn't find the lines we wanted within
23479 line_number_display_limit_width chars per line,
23480 give up on line numbers for this window. */
23481 if (position
== limit_byte
&& limit
== startpos
- distance
)
23483 w
->base_line_pos
= -1;
23484 w
->base_line_number
= 0;
23488 w
->base_line_number
= topline
- nlines
;
23489 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23492 /* Now count lines from the start pos to point. */
23493 nlines
= display_count_lines (startpos_byte
,
23494 PT_BYTE
, PT
, &junk
);
23496 /* Record that we did display the line number. */
23497 line_number_displayed
= true;
23499 /* Make the string to show. */
23500 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23501 return decode_mode_spec_buf
;
23504 char *p
= decode_mode_spec_buf
;
23505 int pad
= width
- 2;
23511 return decode_mode_spec_buf
;
23517 obj
= BVAR (b
, mode_name
);
23521 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23527 ptrdiff_t pos
= marker_position (w
->start
);
23528 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23530 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23532 if (pos
<= BUF_BEGV (b
))
23537 else if (pos
<= BUF_BEGV (b
))
23541 if (total
> 1000000)
23542 /* Do it differently for a large value, to avoid overflow. */
23543 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23545 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23546 /* We can't normally display a 3-digit number,
23547 so get us a 2-digit number that is close. */
23550 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23551 return decode_mode_spec_buf
;
23555 /* Display percentage of size above the bottom of the screen. */
23558 ptrdiff_t toppos
= marker_position (w
->start
);
23559 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23560 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23562 if (botpos
>= BUF_ZV (b
))
23564 if (toppos
<= BUF_BEGV (b
))
23571 if (total
> 1000000)
23572 /* Do it differently for a large value, to avoid overflow. */
23573 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23575 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23576 /* We can't normally display a 3-digit number,
23577 so get us a 2-digit number that is close. */
23580 if (toppos
<= BUF_BEGV (b
))
23581 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23583 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23584 return decode_mode_spec_buf
;
23589 /* status of process */
23590 obj
= Fget_buffer_process (Fcurrent_buffer ());
23592 return "no process";
23594 obj
= Fsymbol_name (Fprocess_status (obj
));
23600 ptrdiff_t count
= inhibit_garbage_collection ();
23601 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23602 Lisp_Object val
= Qnil
;
23604 if (STRINGP (curdir
))
23605 val
= call1 (intern ("file-remote-p"), curdir
);
23607 unbind_to (count
, Qnil
);
23616 /* coding-system (not including end-of-line format) */
23618 /* coding-system (including end-of-line type) */
23620 bool eol_flag
= (c
== 'Z');
23621 char *p
= decode_mode_spec_buf
;
23623 if (! FRAME_WINDOW_P (f
))
23625 /* No need to mention EOL here--the terminal never needs
23626 to do EOL conversion. */
23627 p
= decode_mode_spec_coding (CODING_ID_NAME
23628 (FRAME_KEYBOARD_CODING (f
)->id
),
23630 p
= decode_mode_spec_coding (CODING_ID_NAME
23631 (FRAME_TERMINAL_CODING (f
)->id
),
23634 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23637 #if false /* This proves to be annoying; I think we can do without. -- rms. */
23638 #ifdef subprocesses
23639 obj
= Fget_buffer_process (Fcurrent_buffer ());
23640 if (PROCESSP (obj
))
23642 p
= decode_mode_spec_coding
23643 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23644 p
= decode_mode_spec_coding
23645 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23647 #endif /* subprocesses */
23650 return decode_mode_spec_buf
;
23657 return SSDATA (obj
);
23664 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23665 means count lines back from START_BYTE. But don't go beyond
23666 LIMIT_BYTE. Return the number of lines thus found (always
23669 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23670 either the position COUNT lines after/before START_BYTE, if we
23671 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23675 display_count_lines (ptrdiff_t start_byte
,
23676 ptrdiff_t limit_byte
, ptrdiff_t count
,
23677 ptrdiff_t *byte_pos_ptr
)
23679 register unsigned char *cursor
;
23680 unsigned char *base
;
23682 register ptrdiff_t ceiling
;
23683 register unsigned char *ceiling_addr
;
23684 ptrdiff_t orig_count
= count
;
23686 /* If we are not in selective display mode,
23687 check only for newlines. */
23688 bool selective_display
23689 = (!NILP (BVAR (current_buffer
, selective_display
))
23690 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23694 while (start_byte
< limit_byte
)
23696 ceiling
= BUFFER_CEILING_OF (start_byte
);
23697 ceiling
= min (limit_byte
- 1, ceiling
);
23698 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23699 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23703 if (selective_display
)
23705 while (*cursor
!= '\n' && *cursor
!= 015
23706 && ++cursor
!= ceiling_addr
)
23708 if (cursor
== ceiling_addr
)
23713 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23722 start_byte
+= cursor
- base
;
23723 *byte_pos_ptr
= start_byte
;
23727 while (cursor
< ceiling_addr
);
23729 start_byte
+= ceiling_addr
- base
;
23734 while (start_byte
> limit_byte
)
23736 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23737 ceiling
= max (limit_byte
, ceiling
);
23738 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23739 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23742 if (selective_display
)
23744 while (--cursor
>= ceiling_addr
23745 && *cursor
!= '\n' && *cursor
!= 015)
23747 if (cursor
< ceiling_addr
)
23752 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23759 start_byte
+= cursor
- base
+ 1;
23760 *byte_pos_ptr
= start_byte
;
23761 /* When scanning backwards, we should
23762 not count the newline posterior to which we stop. */
23763 return - orig_count
- 1;
23766 start_byte
+= ceiling_addr
- base
;
23770 *byte_pos_ptr
= limit_byte
;
23773 return - orig_count
+ count
;
23774 return orig_count
- count
;
23780 /***********************************************************************
23782 ***********************************************************************/
23784 /* Display a NUL-terminated string, starting with index START.
23786 If STRING is non-null, display that C string. Otherwise, the Lisp
23787 string LISP_STRING is displayed. There's a case that STRING is
23788 non-null and LISP_STRING is not nil. It means STRING is a string
23789 data of LISP_STRING. In that case, we display LISP_STRING while
23790 ignoring its text properties.
23792 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23793 FACE_STRING. Display STRING or LISP_STRING with the face at
23794 FACE_STRING_POS in FACE_STRING:
23796 Display the string in the environment given by IT, but use the
23797 standard display table, temporarily.
23799 FIELD_WIDTH is the minimum number of output glyphs to produce.
23800 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23801 with spaces. If STRING has more characters, more than FIELD_WIDTH
23802 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23804 PRECISION is the maximum number of characters to output from
23805 STRING. PRECISION < 0 means don't truncate the string.
23807 This is roughly equivalent to printf format specifiers:
23809 FIELD_WIDTH PRECISION PRINTF
23810 ----------------------------------------
23816 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23817 display them, and < 0 means obey the current buffer's value of
23818 enable_multibyte_characters.
23820 Value is the number of columns displayed. */
23823 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23824 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23825 int field_width
, int precision
, int max_x
, int multibyte
)
23827 int hpos_at_start
= it
->hpos
;
23828 int saved_face_id
= it
->face_id
;
23829 struct glyph_row
*row
= it
->glyph_row
;
23830 ptrdiff_t it_charpos
;
23832 /* Initialize the iterator IT for iteration over STRING beginning
23833 with index START. */
23834 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23835 precision
, field_width
, multibyte
);
23836 if (string
&& STRINGP (lisp_string
))
23837 /* LISP_STRING is the one returned by decode_mode_spec. We should
23838 ignore its text properties. */
23839 it
->stop_charpos
= it
->end_charpos
;
23841 /* If displaying STRING, set up the face of the iterator from
23842 FACE_STRING, if that's given. */
23843 if (STRINGP (face_string
))
23849 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23850 0, &endptr
, it
->base_face_id
, false);
23851 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23852 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23855 /* Set max_x to the maximum allowed X position. Don't let it go
23856 beyond the right edge of the window. */
23858 max_x
= it
->last_visible_x
;
23860 max_x
= min (max_x
, it
->last_visible_x
);
23862 /* Skip over display elements that are not visible. because IT->w is
23864 if (it
->current_x
< it
->first_visible_x
)
23865 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23866 MOVE_TO_POS
| MOVE_TO_X
);
23868 row
->ascent
= it
->max_ascent
;
23869 row
->height
= it
->max_ascent
+ it
->max_descent
;
23870 row
->phys_ascent
= it
->max_phys_ascent
;
23871 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23872 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23874 if (STRINGP (it
->string
))
23875 it_charpos
= IT_STRING_CHARPOS (*it
);
23877 it_charpos
= IT_CHARPOS (*it
);
23879 /* This condition is for the case that we are called with current_x
23880 past last_visible_x. */
23881 while (it
->current_x
< max_x
)
23883 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23885 /* Get the next display element. */
23886 if (!get_next_display_element (it
))
23889 /* Produce glyphs. */
23890 x_before
= it
->current_x
;
23891 n_glyphs_before
= row
->used
[TEXT_AREA
];
23892 PRODUCE_GLYPHS (it
);
23894 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23897 while (i
< nglyphs
)
23899 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23901 if (it
->line_wrap
!= TRUNCATE
23902 && x
+ glyph
->pixel_width
> max_x
)
23904 /* End of continued line or max_x reached. */
23905 if (CHAR_GLYPH_PADDING_P (*glyph
))
23907 /* A wide character is unbreakable. */
23908 if (row
->reversed_p
)
23909 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23910 - n_glyphs_before
);
23911 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23912 it
->current_x
= x_before
;
23916 if (row
->reversed_p
)
23917 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23918 - (n_glyphs_before
+ i
));
23919 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23924 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23926 /* Glyph is at least partially visible. */
23928 if (x
< it
->first_visible_x
)
23929 row
->x
= x
- it
->first_visible_x
;
23933 /* Glyph is off the left margin of the display area.
23934 Should not happen. */
23938 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23939 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23940 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23941 row
->phys_height
= max (row
->phys_height
,
23942 it
->max_phys_ascent
+ it
->max_phys_descent
);
23943 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23944 it
->max_extra_line_spacing
);
23945 x
+= glyph
->pixel_width
;
23949 /* Stop if max_x reached. */
23953 /* Stop at line ends. */
23954 if (ITERATOR_AT_END_OF_LINE_P (it
))
23956 it
->continuation_lines_width
= 0;
23960 set_iterator_to_next (it
, true);
23961 if (STRINGP (it
->string
))
23962 it_charpos
= IT_STRING_CHARPOS (*it
);
23964 it_charpos
= IT_CHARPOS (*it
);
23966 /* Stop if truncating at the right edge. */
23967 if (it
->line_wrap
== TRUNCATE
23968 && it
->current_x
>= it
->last_visible_x
)
23970 /* Add truncation mark, but don't do it if the line is
23971 truncated at a padding space. */
23972 if (it_charpos
< it
->string_nchars
)
23974 if (!FRAME_WINDOW_P (it
->f
))
23978 if (it
->current_x
> it
->last_visible_x
)
23980 if (!row
->reversed_p
)
23982 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23983 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23988 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23989 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23991 unproduce_glyphs (it
, ii
+ 1);
23992 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23994 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23996 row
->used
[TEXT_AREA
] = ii
;
23997 produce_special_glyphs (it
, IT_TRUNCATION
);
24000 produce_special_glyphs (it
, IT_TRUNCATION
);
24002 row
->truncated_on_right_p
= true;
24008 /* Maybe insert a truncation at the left. */
24009 if (it
->first_visible_x
24012 if (!FRAME_WINDOW_P (it
->f
)
24013 || (row
->reversed_p
24014 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24015 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
24016 insert_left_trunc_glyphs (it
);
24017 row
->truncated_on_left_p
= true;
24020 it
->face_id
= saved_face_id
;
24022 /* Value is number of columns displayed. */
24023 return it
->hpos
- hpos_at_start
;
24028 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
24029 appears as an element of LIST or as the car of an element of LIST.
24030 If PROPVAL is a list, compare each element against LIST in that
24031 way, and return 1/2 if any element of PROPVAL is found in LIST.
24032 Otherwise return 0. This function cannot quit.
24033 The return value is 2 if the text is invisible but with an ellipsis
24034 and 1 if it's invisible and without an ellipsis. */
24037 invisible_prop (Lisp_Object propval
, Lisp_Object list
)
24039 Lisp_Object tail
, proptail
;
24041 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
24043 register Lisp_Object tem
;
24045 if (EQ (propval
, tem
))
24047 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
24048 return NILP (XCDR (tem
)) ? 1 : 2;
24051 if (CONSP (propval
))
24053 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
24055 Lisp_Object propelt
;
24056 propelt
= XCAR (proptail
);
24057 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
24059 register Lisp_Object tem
;
24061 if (EQ (propelt
, tem
))
24063 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
24064 return NILP (XCDR (tem
)) ? 1 : 2;
24072 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
24073 doc
: /* Non-nil if the property makes the text invisible.
24074 POS-OR-PROP can be a marker or number, in which case it is taken to be
24075 a position in the current buffer and the value of the `invisible' property
24076 is checked; or it can be some other value, which is then presumed to be the
24077 value of the `invisible' property of the text of interest.
24078 The non-nil value returned can be t for truly invisible text or something
24079 else if the text is replaced by an ellipsis. */)
24080 (Lisp_Object pos_or_prop
)
24083 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
24084 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
24086 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
24087 return (invis
== 0 ? Qnil
24089 : make_number (invis
));
24092 /* Calculate a width or height in pixels from a specification using
24093 the following elements:
24096 NUM - a (fractional) multiple of the default font width/height
24097 (NUM) - specifies exactly NUM pixels
24098 UNIT - a fixed number of pixels, see below.
24099 ELEMENT - size of a display element in pixels, see below.
24100 (NUM . SPEC) - equals NUM * SPEC
24101 (+ SPEC SPEC ...) - add pixel values
24102 (- SPEC SPEC ...) - subtract pixel values
24103 (- SPEC) - negate pixel value
24106 INT or FLOAT - a number constant
24107 SYMBOL - use symbol's (buffer local) variable binding.
24110 in - pixels per inch *)
24111 mm - pixels per 1/1000 meter *)
24112 cm - pixels per 1/100 meter *)
24113 width - width of current font in pixels.
24114 height - height of current font in pixels.
24116 *) using the ratio(s) defined in display-pixels-per-inch.
24120 left-fringe - left fringe width in pixels
24121 right-fringe - right fringe width in pixels
24123 left-margin - left margin width in pixels
24124 right-margin - right margin width in pixels
24126 scroll-bar - scroll-bar area width in pixels
24130 Pixels corresponding to 5 inches:
24133 Total width of non-text areas on left side of window (if scroll-bar is on left):
24134 '(space :width (+ left-fringe left-margin scroll-bar))
24136 Align to first text column (in header line):
24137 '(space :align-to 0)
24139 Align to middle of text area minus half the width of variable `my-image'
24140 containing a loaded image:
24141 '(space :align-to (0.5 . (- text my-image)))
24143 Width of left margin minus width of 1 character in the default font:
24144 '(space :width (- left-margin 1))
24146 Width of left margin minus width of 2 characters in the current font:
24147 '(space :width (- left-margin (2 . width)))
24149 Center 1 character over left-margin (in header line):
24150 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
24152 Different ways to express width of left fringe plus left margin minus one pixel:
24153 '(space :width (- (+ left-fringe left-margin) (1)))
24154 '(space :width (+ left-fringe left-margin (- (1))))
24155 '(space :width (+ left-fringe left-margin (-1)))
24160 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
24161 struct font
*font
, bool width_p
, int *align_to
)
24165 # define OK_PIXELS(val) (*res = (val), true)
24166 # define OK_ALIGN_TO(val) (*align_to = (val), true)
24169 return OK_PIXELS (0);
24171 eassert (FRAME_LIVE_P (it
->f
));
24173 if (SYMBOLP (prop
))
24175 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
24177 char *unit
= SSDATA (SYMBOL_NAME (prop
));
24179 if (unit
[0] == 'i' && unit
[1] == 'n')
24181 else if (unit
[0] == 'm' && unit
[1] == 'm')
24183 else if (unit
[0] == 'c' && unit
[1] == 'm')
24189 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
24190 : FRAME_RES_Y (it
->f
));
24193 return OK_PIXELS (ppi
/ pixels
);
24198 #ifdef HAVE_WINDOW_SYSTEM
24199 if (EQ (prop
, Qheight
))
24200 return OK_PIXELS (font
24201 ? normal_char_height (font
, -1)
24202 : FRAME_LINE_HEIGHT (it
->f
));
24203 if (EQ (prop
, Qwidth
))
24204 return OK_PIXELS (font
24205 ? FONT_WIDTH (font
)
24206 : FRAME_COLUMN_WIDTH (it
->f
));
24208 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
24209 return OK_PIXELS (1);
24212 if (EQ (prop
, Qtext
))
24213 return OK_PIXELS (width_p
24214 ? window_box_width (it
->w
, TEXT_AREA
)
24215 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
24217 if (align_to
&& *align_to
< 0)
24220 if (EQ (prop
, Qleft
))
24221 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
24222 if (EQ (prop
, Qright
))
24223 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
24224 if (EQ (prop
, Qcenter
))
24225 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
24226 + window_box_width (it
->w
, TEXT_AREA
) / 2);
24227 if (EQ (prop
, Qleft_fringe
))
24228 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24229 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
24230 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
24231 if (EQ (prop
, Qright_fringe
))
24232 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24233 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24234 : window_box_right_offset (it
->w
, TEXT_AREA
));
24235 if (EQ (prop
, Qleft_margin
))
24236 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
24237 if (EQ (prop
, Qright_margin
))
24238 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
24239 if (EQ (prop
, Qscroll_bar
))
24240 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
24242 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24243 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24244 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24249 if (EQ (prop
, Qleft_fringe
))
24250 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
24251 if (EQ (prop
, Qright_fringe
))
24252 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
24253 if (EQ (prop
, Qleft_margin
))
24254 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
24255 if (EQ (prop
, Qright_margin
))
24256 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
24257 if (EQ (prop
, Qscroll_bar
))
24258 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
24261 prop
= buffer_local_value (prop
, it
->w
->contents
);
24262 if (EQ (prop
, Qunbound
))
24266 if (NUMBERP (prop
))
24268 int base_unit
= (width_p
24269 ? FRAME_COLUMN_WIDTH (it
->f
)
24270 : FRAME_LINE_HEIGHT (it
->f
));
24271 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
24276 Lisp_Object car
= XCAR (prop
);
24277 Lisp_Object cdr
= XCDR (prop
);
24281 #ifdef HAVE_WINDOW_SYSTEM
24282 if (FRAME_WINDOW_P (it
->f
)
24283 && valid_image_p (prop
))
24285 ptrdiff_t id
= lookup_image (it
->f
, prop
);
24286 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
24288 return OK_PIXELS (width_p
? img
->width
: img
->height
);
24291 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
24297 while (CONSP (cdr
))
24299 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
24300 font
, width_p
, align_to
))
24303 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= false;
24308 if (EQ (car
, Qminus
))
24310 return OK_PIXELS (pixels
);
24313 car
= buffer_local_value (car
, it
->w
->contents
);
24314 if (EQ (car
, Qunbound
))
24321 pixels
= XFLOATINT (car
);
24323 return OK_PIXELS (pixels
);
24324 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
24325 font
, width_p
, align_to
))
24326 return OK_PIXELS (pixels
* fact
);
24337 get_font_ascent_descent (struct font
*font
, int *ascent
, int *descent
)
24339 #ifdef HAVE_WINDOW_SYSTEM
24340 normal_char_ascent_descent (font
, -1, ascent
, descent
);
24348 /***********************************************************************
24350 ***********************************************************************/
24352 #ifdef HAVE_WINDOW_SYSTEM
24357 dump_glyph_string (struct glyph_string
*s
)
24359 fprintf (stderr
, "glyph string\n");
24360 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
24361 s
->x
, s
->y
, s
->width
, s
->height
);
24362 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
24363 fprintf (stderr
, " hl = %d\n", s
->hl
);
24364 fprintf (stderr
, " left overhang = %d, right = %d\n",
24365 s
->left_overhang
, s
->right_overhang
);
24366 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
24367 fprintf (stderr
, " extends to end of line = %d\n",
24368 s
->extends_to_end_of_line_p
);
24369 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
24370 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
24373 #endif /* GLYPH_DEBUG */
24375 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
24376 of XChar2b structures for S; it can't be allocated in
24377 init_glyph_string because it must be allocated via `alloca'. W
24378 is the window on which S is drawn. ROW and AREA are the glyph row
24379 and area within the row from which S is constructed. START is the
24380 index of the first glyph structure covered by S. HL is a
24381 face-override for drawing S. */
24384 #define OPTIONAL_HDC(hdc) HDC hdc,
24385 #define DECLARE_HDC(hdc) HDC hdc;
24386 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
24387 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
24390 #ifndef OPTIONAL_HDC
24391 #define OPTIONAL_HDC(hdc)
24392 #define DECLARE_HDC(hdc)
24393 #define ALLOCATE_HDC(hdc, f)
24394 #define RELEASE_HDC(hdc, f)
24398 init_glyph_string (struct glyph_string
*s
,
24400 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
24401 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
24403 memset (s
, 0, sizeof *s
);
24405 s
->f
= XFRAME (w
->frame
);
24409 s
->display
= FRAME_X_DISPLAY (s
->f
);
24410 s
->window
= FRAME_X_WINDOW (s
->f
);
24411 s
->char2b
= char2b
;
24415 s
->first_glyph
= row
->glyphs
[area
] + start
;
24416 s
->height
= row
->height
;
24417 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
24418 s
->ybase
= s
->y
+ row
->ascent
;
24422 /* Append the list of glyph strings with head H and tail T to the list
24423 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
24426 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24427 struct glyph_string
*h
, struct glyph_string
*t
)
24441 /* Prepend the list of glyph strings with head H and tail T to the
24442 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
24446 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24447 struct glyph_string
*h
, struct glyph_string
*t
)
24461 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
24462 Set *HEAD and *TAIL to the resulting list. */
24465 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
24466 struct glyph_string
*s
)
24468 s
->next
= s
->prev
= NULL
;
24469 append_glyph_string_lists (head
, tail
, s
, s
);
24473 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24474 The encoding of C is returned in *CHAR2B. DISPLAY_P means
24475 make sure that X resources for the face returned are allocated.
24476 Value is a pointer to a realized face that is ready for display if
24479 static struct face
*
24480 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
24481 XChar2b
*char2b
, bool display_p
)
24483 struct face
*face
= FACE_FROM_ID (f
, face_id
);
24488 code
= face
->font
->driver
->encode_char (face
->font
, c
);
24490 if (code
== FONT_INVALID_CODE
)
24493 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24495 /* Make sure X resources of the face are allocated. */
24496 #ifdef HAVE_X_WINDOWS
24500 eassert (face
!= NULL
);
24501 prepare_face_for_display (f
, face
);
24508 /* Get face and two-byte form of character glyph GLYPH on frame F.
24509 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24510 a pointer to a realized face that is ready for display. */
24512 static struct face
*
24513 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24519 eassert (glyph
->type
== CHAR_GLYPH
);
24520 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24522 /* Make sure X resources of the face are allocated. */
24523 eassert (face
!= NULL
);
24524 prepare_face_for_display (f
, face
);
24528 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24529 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24531 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24533 if (code
== FONT_INVALID_CODE
)
24537 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24542 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24543 Return true iff FONT has a glyph for C. */
24546 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24550 if (CHAR_BYTE8_P (c
))
24551 code
= CHAR_TO_BYTE8 (c
);
24553 code
= font
->driver
->encode_char (font
, c
);
24555 if (code
== FONT_INVALID_CODE
)
24557 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24562 /* Fill glyph string S with composition components specified by S->cmp.
24564 BASE_FACE is the base face of the composition.
24565 S->cmp_from is the index of the first component for S.
24567 OVERLAPS non-zero means S should draw the foreground only, and use
24568 its physical height for clipping. See also draw_glyphs.
24570 Value is the index of a component not in S. */
24573 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24577 /* For all glyphs of this composition, starting at the offset
24578 S->cmp_from, until we reach the end of the definition or encounter a
24579 glyph that requires the different face, add it to S. */
24584 s
->for_overlaps
= overlaps
;
24587 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24589 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24591 /* TAB in a composition means display glyphs with padding space
24592 on the left or right. */
24595 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24598 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24599 s
->char2b
+ i
, true);
24605 s
->font
= s
->face
->font
;
24607 else if (s
->face
!= face
)
24615 if (s
->face
== NULL
)
24617 s
->face
= base_face
->ascii_face
;
24618 s
->font
= s
->face
->font
;
24621 /* All glyph strings for the same composition has the same width,
24622 i.e. the width set for the first component of the composition. */
24623 s
->width
= s
->first_glyph
->pixel_width
;
24625 /* If the specified font could not be loaded, use the frame's
24626 default font, but record the fact that we couldn't load it in
24627 the glyph string so that we can draw rectangles for the
24628 characters of the glyph string. */
24629 if (s
->font
== NULL
)
24631 s
->font_not_found_p
= true;
24632 s
->font
= FRAME_FONT (s
->f
);
24635 /* Adjust base line for subscript/superscript text. */
24636 s
->ybase
+= s
->first_glyph
->voffset
;
24642 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24643 int start
, int end
, int overlaps
)
24645 struct glyph
*glyph
, *last
;
24646 Lisp_Object lgstring
;
24649 s
->for_overlaps
= overlaps
;
24650 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24651 last
= s
->row
->glyphs
[s
->area
] + end
;
24652 s
->cmp_id
= glyph
->u
.cmp
.id
;
24653 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24654 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24655 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24656 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24657 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24659 while (glyph
< last
24660 && glyph
->u
.cmp
.automatic
24661 && glyph
->u
.cmp
.id
== s
->cmp_id
24662 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24663 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24665 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24667 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24668 unsigned code
= LGLYPH_CODE (lglyph
);
24670 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24672 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24673 return glyph
- s
->row
->glyphs
[s
->area
];
24677 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24678 See the comment of fill_glyph_string for arguments.
24679 Value is the index of the first glyph not in S. */
24683 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24684 int start
, int end
, int overlaps
)
24686 struct glyph
*glyph
, *last
;
24689 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24690 s
->for_overlaps
= overlaps
;
24691 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24692 last
= s
->row
->glyphs
[s
->area
] + end
;
24693 voffset
= glyph
->voffset
;
24694 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24695 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24697 s
->width
= glyph
->pixel_width
;
24699 while (glyph
< last
24700 && glyph
->type
== GLYPHLESS_GLYPH
24701 && glyph
->voffset
== voffset
24702 && glyph
->face_id
== face_id
)
24705 s
->width
+= glyph
->pixel_width
;
24708 s
->ybase
+= voffset
;
24709 return glyph
- s
->row
->glyphs
[s
->area
];
24713 /* Fill glyph string S from a sequence of character glyphs.
24715 FACE_ID is the face id of the string. START is the index of the
24716 first glyph to consider, END is the index of the last + 1.
24717 OVERLAPS non-zero means S should draw the foreground only, and use
24718 its physical height for clipping. See also draw_glyphs.
24720 Value is the index of the first glyph not in S. */
24723 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24724 int start
, int end
, int overlaps
)
24726 struct glyph
*glyph
, *last
;
24728 bool glyph_not_available_p
;
24730 eassert (s
->f
== XFRAME (s
->w
->frame
));
24731 eassert (s
->nchars
== 0);
24732 eassert (start
>= 0 && end
> start
);
24734 s
->for_overlaps
= overlaps
;
24735 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24736 last
= s
->row
->glyphs
[s
->area
] + end
;
24737 voffset
= glyph
->voffset
;
24738 s
->padding_p
= glyph
->padding_p
;
24739 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24741 while (glyph
< last
24742 && glyph
->type
== CHAR_GLYPH
24743 && glyph
->voffset
== voffset
24744 /* Same face id implies same font, nowadays. */
24745 && glyph
->face_id
== face_id
24746 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24748 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24749 s
->char2b
+ s
->nchars
);
24751 eassert (s
->nchars
<= end
- start
);
24752 s
->width
+= glyph
->pixel_width
;
24753 if (glyph
++->padding_p
!= s
->padding_p
)
24757 s
->font
= s
->face
->font
;
24759 /* If the specified font could not be loaded, use the frame's font,
24760 but record the fact that we couldn't load it in
24761 S->font_not_found_p so that we can draw rectangles for the
24762 characters of the glyph string. */
24763 if (s
->font
== NULL
|| glyph_not_available_p
)
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
+= voffset
;
24772 eassert (s
->face
&& s
->face
->gc
);
24773 return glyph
- s
->row
->glyphs
[s
->area
];
24777 /* Fill glyph string S from image glyph S->first_glyph. */
24780 fill_image_glyph_string (struct glyph_string
*s
)
24782 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24783 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24785 s
->slice
= s
->first_glyph
->slice
.img
;
24786 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24787 s
->font
= s
->face
->font
;
24788 s
->width
= s
->first_glyph
->pixel_width
;
24790 /* Adjust base line for subscript/superscript text. */
24791 s
->ybase
+= s
->first_glyph
->voffset
;
24795 /* Fill glyph string S from a sequence of stretch glyphs.
24797 START is the index of the first glyph to consider,
24798 END is the index of the last + 1.
24800 Value is the index of the first glyph not in S. */
24803 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24805 struct glyph
*glyph
, *last
;
24806 int voffset
, face_id
;
24808 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24810 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24811 last
= s
->row
->glyphs
[s
->area
] + end
;
24812 face_id
= glyph
->face_id
;
24813 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24814 s
->font
= s
->face
->font
;
24815 s
->width
= glyph
->pixel_width
;
24817 voffset
= glyph
->voffset
;
24821 && glyph
->type
== STRETCH_GLYPH
24822 && glyph
->voffset
== voffset
24823 && glyph
->face_id
== face_id
);
24825 s
->width
+= glyph
->pixel_width
;
24827 /* Adjust base line for subscript/superscript text. */
24828 s
->ybase
+= voffset
;
24830 /* The case that face->gc == 0 is handled when drawing the glyph
24831 string by calling prepare_face_for_display. */
24833 return glyph
- s
->row
->glyphs
[s
->area
];
24836 static struct font_metrics
*
24837 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24839 static struct font_metrics metrics
;
24844 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24845 if (code
== FONT_INVALID_CODE
)
24847 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24851 /* A subroutine that computes "normal" values of ASCENT and DESCENT
24852 for FONT. Values are taken from font-global ones, except for fonts
24853 that claim preposterously large values, but whose glyphs actually
24854 have reasonable dimensions. C is the character to use for metrics
24855 if the font-global values are too large; if C is negative, the
24856 function selects a default character. */
24858 normal_char_ascent_descent (struct font
*font
, int c
, int *ascent
, int *descent
)
24860 *ascent
= FONT_BASE (font
);
24861 *descent
= FONT_DESCENT (font
);
24863 if (FONT_TOO_HIGH (font
))
24867 /* Get metrics of C, defaulting to a reasonably sized ASCII
24869 if (get_char_glyph_code (c
>= 0 ? c
: '{', font
, &char2b
))
24871 struct font_metrics
*pcm
= get_per_char_metric (font
, &char2b
);
24873 if (!(pcm
->width
== 0 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0))
24875 /* We add 1 pixel to character dimensions as heuristics
24876 that produces nicer display, e.g. when the face has
24877 the box attribute. */
24878 *ascent
= pcm
->ascent
+ 1;
24879 *descent
= pcm
->descent
+ 1;
24885 /* A subroutine that computes a reasonable "normal character height"
24886 for fonts that claim preposterously large vertical dimensions, but
24887 whose glyphs are actually reasonably sized. C is the character
24888 whose metrics to use for those fonts, or -1 for default
24891 normal_char_height (struct font
*font
, int c
)
24893 int ascent
, descent
;
24895 normal_char_ascent_descent (font
, c
, &ascent
, &descent
);
24897 return ascent
+ descent
;
24901 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24902 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24903 assumed to be zero. */
24906 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24908 *left
= *right
= 0;
24910 if (glyph
->type
== CHAR_GLYPH
)
24913 struct face
*face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
);
24916 struct font_metrics
*pcm
= get_per_char_metric (face
->font
, &char2b
);
24919 if (pcm
->rbearing
> pcm
->width
)
24920 *right
= pcm
->rbearing
- pcm
->width
;
24921 if (pcm
->lbearing
< 0)
24922 *left
= -pcm
->lbearing
;
24926 else if (glyph
->type
== COMPOSITE_GLYPH
)
24928 if (! glyph
->u
.cmp
.automatic
)
24930 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24932 if (cmp
->rbearing
> cmp
->pixel_width
)
24933 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24934 if (cmp
->lbearing
< 0)
24935 *left
= - cmp
->lbearing
;
24939 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24940 struct font_metrics metrics
;
24942 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24943 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24944 if (metrics
.rbearing
> metrics
.width
)
24945 *right
= metrics
.rbearing
- metrics
.width
;
24946 if (metrics
.lbearing
< 0)
24947 *left
= - metrics
.lbearing
;
24953 /* Return the index of the first glyph preceding glyph string S that
24954 is overwritten by S because of S's left overhang. Value is -1
24955 if no glyphs are overwritten. */
24958 left_overwritten (struct glyph_string
*s
)
24962 if (s
->left_overhang
)
24965 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24966 int first
= s
->first_glyph
- glyphs
;
24968 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24969 x
-= glyphs
[i
].pixel_width
;
24980 /* Return the index of the first glyph preceding glyph string S that
24981 is overwriting S because of its right overhang. Value is -1 if no
24982 glyph in front of S overwrites S. */
24985 left_overwriting (struct glyph_string
*s
)
24988 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24989 int first
= s
->first_glyph
- glyphs
;
24993 for (i
= first
- 1; i
>= 0; --i
)
24996 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24999 x
-= glyphs
[i
].pixel_width
;
25006 /* Return the index of the last glyph following glyph string S that is
25007 overwritten by S because of S's right overhang. Value is -1 if
25008 no such glyph is found. */
25011 right_overwritten (struct glyph_string
*s
)
25015 if (s
->right_overhang
)
25018 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25019 int first
= (s
->first_glyph
- glyphs
25020 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
25021 int end
= s
->row
->used
[s
->area
];
25023 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
25024 x
+= glyphs
[i
].pixel_width
;
25033 /* Return the index of the last glyph following glyph string S that
25034 overwrites S because of its left overhang. Value is negative
25035 if no such glyph is found. */
25038 right_overwriting (struct glyph_string
*s
)
25041 int end
= s
->row
->used
[s
->area
];
25042 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25043 int first
= (s
->first_glyph
- glyphs
25044 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
25048 for (i
= first
; i
< end
; ++i
)
25051 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
25054 x
+= glyphs
[i
].pixel_width
;
25061 /* Set background width of glyph string S. START is the index of the
25062 first glyph following S. LAST_X is the right-most x-position + 1
25063 in the drawing area. */
25066 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
25068 /* If the face of this glyph string has to be drawn to the end of
25069 the drawing area, set S->extends_to_end_of_line_p. */
25071 if (start
== s
->row
->used
[s
->area
]
25072 && ((s
->row
->fill_line_p
25073 && (s
->hl
== DRAW_NORMAL_TEXT
25074 || s
->hl
== DRAW_IMAGE_RAISED
25075 || s
->hl
== DRAW_IMAGE_SUNKEN
))
25076 || s
->hl
== DRAW_MOUSE_FACE
))
25077 s
->extends_to_end_of_line_p
= true;
25079 /* If S extends its face to the end of the line, set its
25080 background_width to the distance to the right edge of the drawing
25082 if (s
->extends_to_end_of_line_p
)
25083 s
->background_width
= last_x
- s
->x
+ 1;
25085 s
->background_width
= s
->width
;
25089 /* Compute overhangs and x-positions for glyph string S and its
25090 predecessors, or successors. X is the starting x-position for S.
25091 BACKWARD_P means process predecessors. */
25094 compute_overhangs_and_x (struct glyph_string
*s
, int x
, bool backward_p
)
25100 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
25101 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
25111 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
25112 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
25122 /* The following macros are only called from draw_glyphs below.
25123 They reference the following parameters of that function directly:
25124 `w', `row', `area', and `overlap_p'
25125 as well as the following local variables:
25126 `s', `f', and `hdc' (in W32) */
25129 /* On W32, silently add local `hdc' variable to argument list of
25130 init_glyph_string. */
25131 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
25132 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
25134 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
25135 init_glyph_string (s, char2b, w, row, area, start, hl)
25138 /* Add a glyph string for a stretch glyph to the list of strings
25139 between HEAD and TAIL. START is the index of the stretch glyph in
25140 row area AREA of glyph row ROW. END is the index of the last glyph
25141 in that glyph row area. X is the current output position assigned
25142 to the new glyph string constructed. HL overrides that face of the
25143 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25144 is the right-most x-position of the drawing area. */
25146 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
25147 and below -- keep them on one line. */
25148 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25151 s = alloca (sizeof *s); \
25152 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25153 START = fill_stretch_glyph_string (s, START, END); \
25154 append_glyph_string (&HEAD, &TAIL, s); \
25160 /* Add a glyph string for an image glyph to the list of strings
25161 between HEAD and TAIL. START is the index of the image glyph in
25162 row area AREA of glyph row ROW. END is the index of the last glyph
25163 in that glyph row area. X is the current output position assigned
25164 to the new glyph string constructed. HL overrides that face of the
25165 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25166 is the right-most x-position of the drawing area. */
25168 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25171 s = alloca (sizeof *s); \
25172 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25173 fill_image_glyph_string (s); \
25174 append_glyph_string (&HEAD, &TAIL, s); \
25181 /* Add a glyph string for a sequence of character glyphs to the list
25182 of strings between HEAD and TAIL. START is the index of the first
25183 glyph in row area AREA of glyph row ROW that is part of the new
25184 glyph string. END is the index of the last glyph in that glyph row
25185 area. X is the current output position assigned to the new glyph
25186 string constructed. HL overrides that face of the glyph; e.g. it
25187 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
25188 right-most x-position of the drawing area. */
25190 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25196 face_id = (row)->glyphs[area][START].face_id; \
25198 s = alloca (sizeof *s); \
25199 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
25200 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25201 append_glyph_string (&HEAD, &TAIL, s); \
25203 START = fill_glyph_string (s, face_id, START, END, overlaps); \
25208 /* Add a glyph string for a composite sequence to the list of strings
25209 between HEAD and TAIL. START is the index of the first glyph in
25210 row area AREA of glyph row ROW that is part of the new glyph
25211 string. END is the index of the last glyph in that glyph row area.
25212 X is the current output position assigned to the new glyph string
25213 constructed. HL overrides that face of the glyph; e.g. it is
25214 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
25215 x-position of the drawing area. */
25217 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25219 int face_id = (row)->glyphs[area][START].face_id; \
25220 struct face *base_face = FACE_FROM_ID (f, face_id); \
25221 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
25222 struct composition *cmp = composition_table[cmp_id]; \
25224 struct glyph_string *first_s = NULL; \
25227 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
25229 /* Make glyph_strings for each glyph sequence that is drawable by \
25230 the same face, and append them to HEAD/TAIL. */ \
25231 for (n = 0; n < cmp->glyph_len;) \
25233 s = alloca (sizeof *s); \
25234 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25235 append_glyph_string (&(HEAD), &(TAIL), s); \
25241 n = fill_composite_glyph_string (s, base_face, overlaps); \
25249 /* Add a glyph string for a glyph-string sequence to the list of strings
25250 between HEAD and TAIL. */
25252 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25256 Lisp_Object gstring; \
25258 face_id = (row)->glyphs[area][START].face_id; \
25259 gstring = (composition_gstring_from_id \
25260 ((row)->glyphs[area][START].u.cmp.id)); \
25261 s = alloca (sizeof *s); \
25262 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
25263 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25264 append_glyph_string (&(HEAD), &(TAIL), s); \
25266 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
25270 /* Add a glyph string for a sequence of glyphless character's glyphs
25271 to the list of strings between HEAD and TAIL. The meanings of
25272 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
25274 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25279 face_id = (row)->glyphs[area][START].face_id; \
25281 s = alloca (sizeof *s); \
25282 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25283 append_glyph_string (&HEAD, &TAIL, s); \
25285 START = fill_glyphless_glyph_string (s, face_id, START, END, \
25291 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
25292 of AREA of glyph row ROW on window W between indices START and END.
25293 HL overrides the face for drawing glyph strings, e.g. it is
25294 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
25295 x-positions of the drawing area.
25297 This is an ugly monster macro construct because we must use alloca
25298 to allocate glyph strings (because draw_glyphs can be called
25299 asynchronously). */
25301 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25304 HEAD = TAIL = NULL; \
25305 while (START < END) \
25307 struct glyph *first_glyph = (row)->glyphs[area] + START; \
25308 switch (first_glyph->type) \
25311 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
25315 case COMPOSITE_GLYPH: \
25316 if (first_glyph->u.cmp.automatic) \
25317 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
25320 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
25324 case STRETCH_GLYPH: \
25325 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
25329 case IMAGE_GLYPH: \
25330 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
25334 case GLYPHLESS_GLYPH: \
25335 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
25345 set_glyph_string_background_width (s, START, LAST_X); \
25352 /* Draw glyphs between START and END in AREA of ROW on window W,
25353 starting at x-position X. X is relative to AREA in W. HL is a
25354 face-override with the following meaning:
25356 DRAW_NORMAL_TEXT draw normally
25357 DRAW_CURSOR draw in cursor face
25358 DRAW_MOUSE_FACE draw in mouse face.
25359 DRAW_INVERSE_VIDEO draw in mode line face
25360 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
25361 DRAW_IMAGE_RAISED draw an image with a raised relief around it
25363 If OVERLAPS is non-zero, draw only the foreground of characters and
25364 clip to the physical height of ROW. Non-zero value also defines
25365 the overlapping part to be drawn:
25367 OVERLAPS_PRED overlap with preceding rows
25368 OVERLAPS_SUCC overlap with succeeding rows
25369 OVERLAPS_BOTH overlap with both preceding/succeeding rows
25370 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
25372 Value is the x-position reached, relative to AREA of W. */
25375 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
25376 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
25377 enum draw_glyphs_face hl
, int overlaps
)
25379 struct glyph_string
*head
, *tail
;
25380 struct glyph_string
*s
;
25381 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
25382 int i
, j
, x_reached
, last_x
, area_left
= 0;
25383 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25386 ALLOCATE_HDC (hdc
, f
);
25388 /* Let's rather be paranoid than getting a SEGV. */
25389 end
= min (end
, row
->used
[area
]);
25390 start
= clip_to_bounds (0, start
, end
);
25392 /* Translate X to frame coordinates. Set last_x to the right
25393 end of the drawing area. */
25394 if (row
->full_width_p
)
25396 /* X is relative to the left edge of W, without scroll bars
25398 area_left
= WINDOW_LEFT_EDGE_X (w
);
25399 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
25400 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
25404 area_left
= window_box_left (w
, area
);
25405 last_x
= area_left
+ window_box_width (w
, area
);
25409 /* Build a doubly-linked list of glyph_string structures between
25410 head and tail from what we have to draw. Note that the macro
25411 BUILD_GLYPH_STRINGS will modify its start parameter. That's
25412 the reason we use a separate variable `i'. */
25415 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
25417 x_reached
= tail
->x
+ tail
->background_width
;
25421 /* If there are any glyphs with lbearing < 0 or rbearing > width in
25422 the row, redraw some glyphs in front or following the glyph
25423 strings built above. */
25424 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
25426 struct glyph_string
*h
, *t
;
25427 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25428 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
25429 bool check_mouse_face
= false;
25432 /* If mouse highlighting is on, we may need to draw adjacent
25433 glyphs using mouse-face highlighting. */
25434 if (area
== TEXT_AREA
&& row
->mouse_face_p
25435 && hlinfo
->mouse_face_beg_row
>= 0
25436 && hlinfo
->mouse_face_end_row
>= 0)
25438 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
25440 if (row_vpos
>= hlinfo
->mouse_face_beg_row
25441 && row_vpos
<= hlinfo
->mouse_face_end_row
)
25443 check_mouse_face
= true;
25444 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
25445 ? hlinfo
->mouse_face_beg_col
: 0;
25446 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
25447 ? hlinfo
->mouse_face_end_col
25448 : row
->used
[TEXT_AREA
];
25452 /* Compute overhangs for all glyph strings. */
25453 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
25454 for (s
= head
; s
; s
= s
->next
)
25455 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
25457 /* Prepend glyph strings for glyphs in front of the first glyph
25458 string that are overwritten because of the first glyph
25459 string's left overhang. The background of all strings
25460 prepended must be drawn because the first glyph string
25462 i
= left_overwritten (head
);
25465 enum draw_glyphs_face overlap_hl
;
25467 /* If this row contains mouse highlighting, attempt to draw
25468 the overlapped glyphs with the correct highlight. This
25469 code fails if the overlap encompasses more than one glyph
25470 and mouse-highlight spans only some of these glyphs.
25471 However, making it work perfectly involves a lot more
25472 code, and I don't know if the pathological case occurs in
25473 practice, so we'll stick to this for now. --- cyd */
25474 if (check_mouse_face
25475 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25476 overlap_hl
= DRAW_MOUSE_FACE
;
25478 overlap_hl
= DRAW_NORMAL_TEXT
;
25480 if (hl
!= overlap_hl
)
25483 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
25484 overlap_hl
, dummy_x
, last_x
);
25486 compute_overhangs_and_x (t
, head
->x
, true);
25487 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25488 if (clip_head
== NULL
)
25492 /* Prepend glyph strings for glyphs in front of the first glyph
25493 string that overwrite that glyph string because of their
25494 right overhang. For these strings, only the foreground must
25495 be drawn, because it draws over the glyph string at `head'.
25496 The background must not be drawn because this would overwrite
25497 right overhangs of preceding glyphs for which no glyph
25499 i
= left_overwriting (head
);
25502 enum draw_glyphs_face overlap_hl
;
25504 if (check_mouse_face
25505 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25506 overlap_hl
= DRAW_MOUSE_FACE
;
25508 overlap_hl
= DRAW_NORMAL_TEXT
;
25510 if (hl
== overlap_hl
|| clip_head
== NULL
)
25512 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
25513 overlap_hl
, dummy_x
, last_x
);
25514 for (s
= h
; s
; s
= s
->next
)
25515 s
->background_filled_p
= true;
25516 compute_overhangs_and_x (t
, head
->x
, true);
25517 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25520 /* Append glyphs strings for glyphs following the last glyph
25521 string tail that are overwritten by tail. The background of
25522 these strings has to be drawn because tail's foreground draws
25524 i
= right_overwritten (tail
);
25527 enum draw_glyphs_face overlap_hl
;
25529 if (check_mouse_face
25530 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25531 overlap_hl
= DRAW_MOUSE_FACE
;
25533 overlap_hl
= DRAW_NORMAL_TEXT
;
25535 if (hl
!= overlap_hl
)
25537 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25538 overlap_hl
, x
, last_x
);
25539 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25540 we don't have `end = i;' here. */
25541 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25542 append_glyph_string_lists (&head
, &tail
, h
, t
);
25543 if (clip_tail
== NULL
)
25547 /* Append glyph strings for glyphs following the last glyph
25548 string tail that overwrite tail. The foreground of such
25549 glyphs has to be drawn because it writes into the background
25550 of tail. The background must not be drawn because it could
25551 paint over the foreground of following glyphs. */
25552 i
= right_overwriting (tail
);
25555 enum draw_glyphs_face overlap_hl
;
25556 if (check_mouse_face
25557 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25558 overlap_hl
= DRAW_MOUSE_FACE
;
25560 overlap_hl
= DRAW_NORMAL_TEXT
;
25562 if (hl
== overlap_hl
|| clip_tail
== NULL
)
25564 i
++; /* We must include the Ith glyph. */
25565 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25566 overlap_hl
, x
, last_x
);
25567 for (s
= h
; s
; s
= s
->next
)
25568 s
->background_filled_p
= true;
25569 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25570 append_glyph_string_lists (&head
, &tail
, h
, t
);
25572 if (clip_head
|| clip_tail
)
25573 for (s
= head
; s
; s
= s
->next
)
25575 s
->clip_head
= clip_head
;
25576 s
->clip_tail
= clip_tail
;
25580 /* Draw all strings. */
25581 for (s
= head
; s
; s
= s
->next
)
25582 FRAME_RIF (f
)->draw_glyph_string (s
);
25585 /* When focus a sole frame and move horizontally, this clears on_p
25586 causing a failure to erase prev cursor position. */
25587 if (area
== TEXT_AREA
25588 && !row
->full_width_p
25589 /* When drawing overlapping rows, only the glyph strings'
25590 foreground is drawn, which doesn't erase a cursor
25594 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25595 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25596 : (tail
? tail
->x
+ tail
->background_width
: x
));
25600 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25601 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25605 /* Value is the x-position up to which drawn, relative to AREA of W.
25606 This doesn't include parts drawn because of overhangs. */
25607 if (row
->full_width_p
)
25608 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25610 x_reached
-= area_left
;
25612 RELEASE_HDC (hdc
, f
);
25618 /* Expand row matrix if too narrow. Don't expand if area
25621 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25623 if (!it->f->fonts_changed \
25624 && (it->glyph_row->glyphs[area] \
25625 < it->glyph_row->glyphs[area + 1])) \
25627 it->w->ncols_scale_factor++; \
25628 it->f->fonts_changed = true; \
25632 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25633 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25636 append_glyph (struct it
*it
)
25638 struct glyph
*glyph
;
25639 enum glyph_row_area area
= it
->area
;
25641 eassert (it
->glyph_row
);
25642 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25644 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25645 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25647 /* If the glyph row is reversed, we need to prepend the glyph
25648 rather than append it. */
25649 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25653 /* Make room for the additional glyph. */
25654 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25656 glyph
= it
->glyph_row
->glyphs
[area
];
25658 glyph
->charpos
= CHARPOS (it
->position
);
25659 glyph
->object
= it
->object
;
25660 if (it
->pixel_width
> 0)
25662 glyph
->pixel_width
= it
->pixel_width
;
25663 glyph
->padding_p
= false;
25667 /* Assure at least 1-pixel width. Otherwise, cursor can't
25668 be displayed correctly. */
25669 glyph
->pixel_width
= 1;
25670 glyph
->padding_p
= true;
25672 glyph
->ascent
= it
->ascent
;
25673 glyph
->descent
= it
->descent
;
25674 glyph
->voffset
= it
->voffset
;
25675 glyph
->type
= CHAR_GLYPH
;
25676 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25677 glyph
->multibyte_p
= it
->multibyte_p
;
25678 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25680 /* In R2L rows, the left and the right box edges need to be
25681 drawn in reverse direction. */
25682 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25683 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25687 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25688 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25690 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25691 || it
->phys_descent
> it
->descent
);
25692 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25693 glyph
->face_id
= it
->face_id
;
25694 glyph
->u
.ch
= it
->char_to_display
;
25695 glyph
->slice
.img
= null_glyph_slice
;
25696 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25699 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25700 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25701 glyph
->bidi_type
= it
->bidi_it
.type
;
25705 glyph
->resolved_level
= 0;
25706 glyph
->bidi_type
= UNKNOWN_BT
;
25708 ++it
->glyph_row
->used
[area
];
25711 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25714 /* Store one glyph for the composition IT->cmp_it.id in
25715 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25719 append_composite_glyph (struct it
*it
)
25721 struct glyph
*glyph
;
25722 enum glyph_row_area area
= it
->area
;
25724 eassert (it
->glyph_row
);
25726 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25727 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25729 /* If the glyph row is reversed, we need to prepend the glyph
25730 rather than append it. */
25731 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25735 /* Make room for the new glyph. */
25736 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25738 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25740 glyph
->charpos
= it
->cmp_it
.charpos
;
25741 glyph
->object
= it
->object
;
25742 glyph
->pixel_width
= it
->pixel_width
;
25743 glyph
->ascent
= it
->ascent
;
25744 glyph
->descent
= it
->descent
;
25745 glyph
->voffset
= it
->voffset
;
25746 glyph
->type
= COMPOSITE_GLYPH
;
25747 if (it
->cmp_it
.ch
< 0)
25749 glyph
->u
.cmp
.automatic
= false;
25750 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25751 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25755 glyph
->u
.cmp
.automatic
= true;
25756 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25757 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25758 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25760 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25761 glyph
->multibyte_p
= it
->multibyte_p
;
25762 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25764 /* In R2L rows, the left and the right box edges need to be
25765 drawn in reverse direction. */
25766 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25767 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25771 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25772 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25774 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25775 || it
->phys_descent
> it
->descent
);
25776 glyph
->padding_p
= false;
25777 glyph
->glyph_not_available_p
= false;
25778 glyph
->face_id
= it
->face_id
;
25779 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25782 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25783 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25784 glyph
->bidi_type
= it
->bidi_it
.type
;
25786 ++it
->glyph_row
->used
[area
];
25789 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25793 /* Change IT->ascent and IT->height according to the setting of
25797 take_vertical_position_into_account (struct it
*it
)
25801 if (it
->voffset
< 0)
25802 /* Increase the ascent so that we can display the text higher
25804 it
->ascent
-= it
->voffset
;
25806 /* Increase the descent so that we can display the text lower
25808 it
->descent
+= it
->voffset
;
25813 /* Produce glyphs/get display metrics for the image IT is loaded with.
25814 See the description of struct display_iterator in dispextern.h for
25815 an overview of struct display_iterator. */
25818 produce_image_glyph (struct it
*it
)
25822 int glyph_ascent
, crop
;
25823 struct glyph_slice slice
;
25825 eassert (it
->what
== IT_IMAGE
);
25827 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25829 /* Make sure X resources of the face is loaded. */
25830 prepare_face_for_display (it
->f
, face
);
25832 if (it
->image_id
< 0)
25834 /* Fringe bitmap. */
25835 it
->ascent
= it
->phys_ascent
= 0;
25836 it
->descent
= it
->phys_descent
= 0;
25837 it
->pixel_width
= 0;
25842 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25844 /* Make sure X resources of the image is loaded. */
25845 prepare_image_for_display (it
->f
, img
);
25847 slice
.x
= slice
.y
= 0;
25848 slice
.width
= img
->width
;
25849 slice
.height
= img
->height
;
25851 if (INTEGERP (it
->slice
.x
))
25852 slice
.x
= XINT (it
->slice
.x
);
25853 else if (FLOATP (it
->slice
.x
))
25854 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25856 if (INTEGERP (it
->slice
.y
))
25857 slice
.y
= XINT (it
->slice
.y
);
25858 else if (FLOATP (it
->slice
.y
))
25859 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25861 if (INTEGERP (it
->slice
.width
))
25862 slice
.width
= XINT (it
->slice
.width
);
25863 else if (FLOATP (it
->slice
.width
))
25864 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25866 if (INTEGERP (it
->slice
.height
))
25867 slice
.height
= XINT (it
->slice
.height
);
25868 else if (FLOATP (it
->slice
.height
))
25869 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25871 if (slice
.x
>= img
->width
)
25872 slice
.x
= img
->width
;
25873 if (slice
.y
>= img
->height
)
25874 slice
.y
= img
->height
;
25875 if (slice
.x
+ slice
.width
>= img
->width
)
25876 slice
.width
= img
->width
- slice
.x
;
25877 if (slice
.y
+ slice
.height
> img
->height
)
25878 slice
.height
= img
->height
- slice
.y
;
25880 if (slice
.width
== 0 || slice
.height
== 0)
25883 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25885 it
->descent
= slice
.height
- glyph_ascent
;
25887 it
->descent
+= img
->vmargin
;
25888 if (slice
.y
+ slice
.height
== img
->height
)
25889 it
->descent
+= img
->vmargin
;
25890 it
->phys_descent
= it
->descent
;
25892 it
->pixel_width
= slice
.width
;
25894 it
->pixel_width
+= img
->hmargin
;
25895 if (slice
.x
+ slice
.width
== img
->width
)
25896 it
->pixel_width
+= img
->hmargin
;
25898 /* It's quite possible for images to have an ascent greater than
25899 their height, so don't get confused in that case. */
25900 if (it
->descent
< 0)
25905 if (face
->box
!= FACE_NO_BOX
)
25907 if (face
->box_line_width
> 0)
25910 it
->ascent
+= face
->box_line_width
;
25911 if (slice
.y
+ slice
.height
== img
->height
)
25912 it
->descent
+= face
->box_line_width
;
25915 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25916 it
->pixel_width
+= eabs (face
->box_line_width
);
25917 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25918 it
->pixel_width
+= eabs (face
->box_line_width
);
25921 take_vertical_position_into_account (it
);
25923 /* Automatically crop wide image glyphs at right edge so we can
25924 draw the cursor on same display row. */
25925 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25926 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25928 it
->pixel_width
-= crop
;
25929 slice
.width
-= crop
;
25934 struct glyph
*glyph
;
25935 enum glyph_row_area area
= it
->area
;
25937 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25938 if (it
->glyph_row
->reversed_p
)
25942 /* Make room for the new glyph. */
25943 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25945 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25947 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25949 glyph
->charpos
= CHARPOS (it
->position
);
25950 glyph
->object
= it
->object
;
25951 glyph
->pixel_width
= it
->pixel_width
;
25952 glyph
->ascent
= glyph_ascent
;
25953 glyph
->descent
= it
->descent
;
25954 glyph
->voffset
= it
->voffset
;
25955 glyph
->type
= IMAGE_GLYPH
;
25956 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25957 glyph
->multibyte_p
= it
->multibyte_p
;
25958 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25960 /* In R2L rows, the left and the right box edges need to be
25961 drawn in reverse direction. */
25962 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25963 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25967 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25968 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25970 glyph
->overlaps_vertically_p
= false;
25971 glyph
->padding_p
= false;
25972 glyph
->glyph_not_available_p
= false;
25973 glyph
->face_id
= it
->face_id
;
25974 glyph
->u
.img_id
= img
->id
;
25975 glyph
->slice
.img
= slice
;
25976 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25979 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25980 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25981 glyph
->bidi_type
= it
->bidi_it
.type
;
25983 ++it
->glyph_row
->used
[area
];
25986 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25991 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25992 of the glyph, WIDTH and HEIGHT are the width and height of the
25993 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25996 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25997 int width
, int height
, int ascent
)
25999 struct glyph
*glyph
;
26000 enum glyph_row_area area
= it
->area
;
26002 eassert (ascent
>= 0 && ascent
<= height
);
26004 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26005 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26007 /* If the glyph row is reversed, we need to prepend the glyph
26008 rather than append it. */
26009 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26013 /* Make room for the additional glyph. */
26014 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26016 glyph
= it
->glyph_row
->glyphs
[area
];
26018 /* Decrease the width of the first glyph of the row that
26019 begins before first_visible_x (e.g., due to hscroll).
26020 This is so the overall width of the row becomes smaller
26021 by the scroll amount, and the stretch glyph appended by
26022 extend_face_to_end_of_line will be wider, to shift the
26023 row glyphs to the right. (In L2R rows, the corresponding
26024 left-shift effect is accomplished by setting row->x to a
26025 negative value, which won't work with R2L rows.)
26027 This must leave us with a positive value of WIDTH, since
26028 otherwise the call to move_it_in_display_line_to at the
26029 beginning of display_line would have got past the entire
26030 first glyph, and then it->current_x would have been
26031 greater or equal to it->first_visible_x. */
26032 if (it
->current_x
< it
->first_visible_x
)
26033 width
-= it
->first_visible_x
- it
->current_x
;
26034 eassert (width
> 0);
26036 glyph
->charpos
= CHARPOS (it
->position
);
26037 glyph
->object
= object
;
26038 glyph
->pixel_width
= width
;
26039 glyph
->ascent
= ascent
;
26040 glyph
->descent
= height
- ascent
;
26041 glyph
->voffset
= it
->voffset
;
26042 glyph
->type
= STRETCH_GLYPH
;
26043 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26044 glyph
->multibyte_p
= it
->multibyte_p
;
26045 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26047 /* In R2L rows, the left and the right box edges need to be
26048 drawn in reverse direction. */
26049 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26050 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26054 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26055 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26057 glyph
->overlaps_vertically_p
= false;
26058 glyph
->padding_p
= false;
26059 glyph
->glyph_not_available_p
= false;
26060 glyph
->face_id
= it
->face_id
;
26061 glyph
->u
.stretch
.ascent
= ascent
;
26062 glyph
->u
.stretch
.height
= height
;
26063 glyph
->slice
.img
= null_glyph_slice
;
26064 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26067 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26068 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26069 glyph
->bidi_type
= it
->bidi_it
.type
;
26073 glyph
->resolved_level
= 0;
26074 glyph
->bidi_type
= UNKNOWN_BT
;
26076 ++it
->glyph_row
->used
[area
];
26079 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26082 #endif /* HAVE_WINDOW_SYSTEM */
26084 /* Produce a stretch glyph for iterator IT. IT->object is the value
26085 of the glyph property displayed. The value must be a list
26086 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
26089 1. `:width WIDTH' specifies that the space should be WIDTH *
26090 canonical char width wide. WIDTH may be an integer or floating
26093 2. `:relative-width FACTOR' specifies that the width of the stretch
26094 should be computed from the width of the first character having the
26095 `glyph' property, and should be FACTOR times that width.
26097 3. `:align-to HPOS' specifies that the space should be wide enough
26098 to reach HPOS, a value in canonical character units.
26100 Exactly one of the above pairs must be present.
26102 4. `:height HEIGHT' specifies that the height of the stretch produced
26103 should be HEIGHT, measured in canonical character units.
26105 5. `:relative-height FACTOR' specifies that the height of the
26106 stretch should be FACTOR times the height of the characters having
26107 the glyph property.
26109 Either none or exactly one of 4 or 5 must be present.
26111 6. `:ascent ASCENT' specifies that ASCENT percent of the height
26112 of the stretch should be used for the ascent of the stretch.
26113 ASCENT must be in the range 0 <= ASCENT <= 100. */
26116 produce_stretch_glyph (struct it
*it
)
26118 /* (space :width WIDTH :height HEIGHT ...) */
26119 Lisp_Object prop
, plist
;
26120 int width
= 0, height
= 0, align_to
= -1;
26121 bool zero_width_ok_p
= false;
26123 struct font
*font
= NULL
;
26125 #ifdef HAVE_WINDOW_SYSTEM
26127 bool zero_height_ok_p
= false;
26129 if (FRAME_WINDOW_P (it
->f
))
26131 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26132 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26133 prepare_face_for_display (it
->f
, face
);
26137 /* List should start with `space'. */
26138 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
26139 plist
= XCDR (it
->object
);
26141 /* Compute the width of the stretch. */
26142 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
26143 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true, 0))
26145 /* Absolute width `:width WIDTH' specified and valid. */
26146 zero_width_ok_p
= true;
26149 else if (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0)
26151 /* Relative width `:relative-width FACTOR' specified and valid.
26152 Compute the width of the characters having the `glyph'
26155 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
26158 if (it
->multibyte_p
)
26159 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
26162 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
26163 if (! ASCII_CHAR_P (it2
.c
))
26164 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
26167 it2
.glyph_row
= NULL
;
26168 it2
.what
= IT_CHARACTER
;
26169 PRODUCE_GLYPHS (&it2
);
26170 width
= NUMVAL (prop
) * it2
.pixel_width
;
26172 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
26173 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true,
26176 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
26177 align_to
= (align_to
< 0
26179 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
26180 else if (align_to
< 0)
26181 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
26182 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
26183 zero_width_ok_p
= true;
26186 /* Nothing specified -> width defaults to canonical char width. */
26187 width
= FRAME_COLUMN_WIDTH (it
->f
);
26189 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
26192 #ifdef HAVE_WINDOW_SYSTEM
26193 /* Compute height. */
26194 if (FRAME_WINDOW_P (it
->f
))
26196 int default_height
= normal_char_height (font
, ' ');
26198 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
26199 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26202 zero_height_ok_p
= true;
26204 else if (prop
= Fplist_get (plist
, QCrelative_height
),
26206 height
= default_height
* NUMVAL (prop
);
26208 height
= default_height
;
26210 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
26213 /* Compute percentage of height used for ascent. If
26214 `:ascent ASCENT' is present and valid, use that. Otherwise,
26215 derive the ascent from the font in use. */
26216 if (prop
= Fplist_get (plist
, QCascent
),
26217 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
26218 ascent
= height
* NUMVAL (prop
) / 100.0;
26219 else if (!NILP (prop
)
26220 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26221 ascent
= min (max (0, (int)tem
), height
);
26223 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
26226 #endif /* HAVE_WINDOW_SYSTEM */
26229 if (width
> 0 && it
->line_wrap
!= TRUNCATE
26230 && it
->current_x
+ width
> it
->last_visible_x
)
26232 width
= it
->last_visible_x
- it
->current_x
;
26233 #ifdef HAVE_WINDOW_SYSTEM
26234 /* Subtract one more pixel from the stretch width, but only on
26235 GUI frames, since on a TTY each glyph is one "pixel" wide. */
26236 width
-= FRAME_WINDOW_P (it
->f
);
26240 if (width
> 0 && height
> 0 && it
->glyph_row
)
26242 Lisp_Object o_object
= it
->object
;
26243 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
26246 if (!STRINGP (object
))
26247 object
= it
->w
->contents
;
26248 #ifdef HAVE_WINDOW_SYSTEM
26249 if (FRAME_WINDOW_P (it
->f
))
26250 append_stretch_glyph (it
, object
, width
, height
, ascent
);
26254 it
->object
= object
;
26255 it
->char_to_display
= ' ';
26256 it
->pixel_width
= it
->len
= 1;
26258 tty_append_glyph (it
);
26259 it
->object
= o_object
;
26263 it
->pixel_width
= width
;
26264 #ifdef HAVE_WINDOW_SYSTEM
26265 if (FRAME_WINDOW_P (it
->f
))
26267 it
->ascent
= it
->phys_ascent
= ascent
;
26268 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
26269 it
->nglyphs
= width
> 0 && height
> 0;
26270 take_vertical_position_into_account (it
);
26274 it
->nglyphs
= width
;
26277 /* Get information about special display element WHAT in an
26278 environment described by IT. WHAT is one of IT_TRUNCATION or
26279 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
26280 non-null glyph_row member. This function ensures that fields like
26281 face_id, c, len of IT are left untouched. */
26284 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
26291 temp_it
.object
= Qnil
;
26292 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
26294 if (what
== IT_CONTINUATION
)
26296 /* Continuation glyph. For R2L lines, we mirror it by hand. */
26297 if (it
->bidi_it
.paragraph_dir
== R2L
)
26298 SET_GLYPH_FROM_CHAR (glyph
, '/');
26300 SET_GLYPH_FROM_CHAR (glyph
, '\\');
26302 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26304 /* FIXME: Should we mirror GC for R2L lines? */
26305 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26306 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26309 else if (what
== IT_TRUNCATION
)
26311 /* Truncation glyph. */
26312 SET_GLYPH_FROM_CHAR (glyph
, '$');
26314 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26316 /* FIXME: Should we mirror GC for R2L lines? */
26317 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26318 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26324 #ifdef HAVE_WINDOW_SYSTEM
26325 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
26326 is turned off, we precede the truncation/continuation glyphs by a
26327 stretch glyph whose width is computed such that these special
26328 glyphs are aligned at the window margin, even when very different
26329 fonts are used in different glyph rows. */
26330 if (FRAME_WINDOW_P (temp_it
.f
)
26331 /* init_iterator calls this with it->glyph_row == NULL, and it
26332 wants only the pixel width of the truncation/continuation
26334 && temp_it
.glyph_row
26335 /* insert_left_trunc_glyphs calls us at the beginning of the
26336 row, and it has its own calculation of the stretch glyph
26338 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
26339 && (temp_it
.glyph_row
->reversed_p
26340 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
26341 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
26343 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
26345 if (stretch_width
> 0)
26347 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
26348 struct font
*font
=
26349 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
26350 int stretch_ascent
=
26351 (((temp_it
.ascent
+ temp_it
.descent
)
26352 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
26354 append_stretch_glyph (&temp_it
, Qnil
, stretch_width
,
26355 temp_it
.ascent
+ temp_it
.descent
,
26362 temp_it
.what
= IT_CHARACTER
;
26363 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
26364 temp_it
.face_id
= GLYPH_FACE (glyph
);
26365 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
26367 PRODUCE_GLYPHS (&temp_it
);
26368 it
->pixel_width
= temp_it
.pixel_width
;
26369 it
->nglyphs
= temp_it
.nglyphs
;
26372 #ifdef HAVE_WINDOW_SYSTEM
26374 /* Calculate line-height and line-spacing properties.
26375 An integer value specifies explicit pixel value.
26376 A float value specifies relative value to current face height.
26377 A cons (float . face-name) specifies relative value to
26378 height of specified face font.
26380 Returns height in pixels, or nil. */
26383 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
26384 int boff
, bool override
)
26386 Lisp_Object face_name
= Qnil
;
26387 int ascent
, descent
, height
;
26389 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
26394 face_name
= XCAR (val
);
26396 if (!NUMBERP (val
))
26397 val
= make_number (1);
26398 if (NILP (face_name
))
26400 height
= it
->ascent
+ it
->descent
;
26405 if (NILP (face_name
))
26407 font
= FRAME_FONT (it
->f
);
26408 boff
= FRAME_BASELINE_OFFSET (it
->f
);
26410 else if (EQ (face_name
, Qt
))
26419 face_id
= lookup_named_face (it
->f
, face_name
, false);
26421 return make_number (-1);
26423 face
= FACE_FROM_ID (it
->f
, face_id
);
26426 return make_number (-1);
26427 boff
= font
->baseline_offset
;
26428 if (font
->vertical_centering
)
26429 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26432 normal_char_ascent_descent (font
, -1, &ascent
, &descent
);
26436 it
->override_ascent
= ascent
;
26437 it
->override_descent
= descent
;
26438 it
->override_boff
= boff
;
26441 height
= ascent
+ descent
;
26445 height
= (int)(XFLOAT_DATA (val
) * height
);
26446 else if (INTEGERP (val
))
26447 height
*= XINT (val
);
26449 return make_number (height
);
26453 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
26454 is a face ID to be used for the glyph. FOR_NO_FONT is true if
26455 and only if this is for a character for which no font was found.
26457 If the display method (it->glyphless_method) is
26458 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
26459 length of the acronym or the hexadecimal string, UPPER_XOFF and
26460 UPPER_YOFF are pixel offsets for the upper part of the string,
26461 LOWER_XOFF and LOWER_YOFF are for the lower part.
26463 For the other display methods, LEN through LOWER_YOFF are zero. */
26466 append_glyphless_glyph (struct it
*it
, int face_id
, bool for_no_font
, int len
,
26467 short upper_xoff
, short upper_yoff
,
26468 short lower_xoff
, short lower_yoff
)
26470 struct glyph
*glyph
;
26471 enum glyph_row_area area
= it
->area
;
26473 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26474 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26476 /* If the glyph row is reversed, we need to prepend the glyph
26477 rather than append it. */
26478 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26482 /* Make room for the additional glyph. */
26483 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26485 glyph
= it
->glyph_row
->glyphs
[area
];
26487 glyph
->charpos
= CHARPOS (it
->position
);
26488 glyph
->object
= it
->object
;
26489 glyph
->pixel_width
= it
->pixel_width
;
26490 glyph
->ascent
= it
->ascent
;
26491 glyph
->descent
= it
->descent
;
26492 glyph
->voffset
= it
->voffset
;
26493 glyph
->type
= GLYPHLESS_GLYPH
;
26494 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
26495 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
26496 glyph
->u
.glyphless
.len
= len
;
26497 glyph
->u
.glyphless
.ch
= it
->c
;
26498 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
26499 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
26500 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
26501 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
26502 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26503 glyph
->multibyte_p
= it
->multibyte_p
;
26504 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26506 /* In R2L rows, the left and the right box edges need to be
26507 drawn in reverse direction. */
26508 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26509 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26513 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26514 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26516 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
26517 || it
->phys_descent
> it
->descent
);
26518 glyph
->padding_p
= false;
26519 glyph
->glyph_not_available_p
= false;
26520 glyph
->face_id
= face_id
;
26521 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26524 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26525 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26526 glyph
->bidi_type
= it
->bidi_it
.type
;
26528 ++it
->glyph_row
->used
[area
];
26531 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26535 /* Produce a glyph for a glyphless character for iterator IT.
26536 IT->glyphless_method specifies which method to use for displaying
26537 the character. See the description of enum
26538 glyphless_display_method in dispextern.h for the detail.
26540 FOR_NO_FONT is true if and only if this is for a character for
26541 which no font was found. ACRONYM, if non-nil, is an acronym string
26542 for the character. */
26545 produce_glyphless_glyph (struct it
*it
, bool for_no_font
, Lisp_Object acronym
)
26550 int base_width
, base_height
, width
, height
;
26551 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26554 /* Get the metrics of the base font. We always refer to the current
26556 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26557 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26558 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
26559 it
->ascent
+= font
->baseline_offset
;
26560 it
->descent
-= font
->baseline_offset
;
26561 base_height
= it
->ascent
+ it
->descent
;
26562 base_width
= font
->average_width
;
26564 face_id
= merge_glyphless_glyph_face (it
);
26566 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26568 it
->pixel_width
= THIN_SPACE_WIDTH
;
26570 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26572 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26574 width
= CHAR_WIDTH (it
->c
);
26577 else if (width
> 4)
26579 it
->pixel_width
= base_width
* width
;
26581 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26587 unsigned int code
[6];
26589 int ascent
, descent
;
26590 struct font_metrics metrics_upper
, metrics_lower
;
26592 face
= FACE_FROM_ID (it
->f
, face_id
);
26593 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26594 prepare_face_for_display (it
->f
, face
);
26596 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26598 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26599 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26600 if (CONSP (acronym
))
26601 acronym
= XCAR (acronym
);
26602 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26606 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26607 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
+ 0u);
26610 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
26611 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26612 upper_len
= (len
+ 1) / 2;
26613 font
->driver
->text_extents (font
, code
, upper_len
,
26615 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26620 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26621 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26622 upper_xoff
= upper_yoff
= 2; /* the typical case */
26623 if (base_width
>= width
)
26625 /* Align the upper to the left, the lower to the right. */
26626 it
->pixel_width
= base_width
;
26627 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26631 /* Center the shorter one. */
26632 it
->pixel_width
= width
;
26633 if (metrics_upper
.width
>= metrics_lower
.width
)
26634 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26637 /* FIXME: This code doesn't look right. It formerly was
26638 missing the "lower_xoff = 0;", which couldn't have
26639 been right since it left lower_xoff uninitialized. */
26641 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26645 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26646 top, bottom, and between upper and lower strings. */
26647 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26648 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26649 /* Center vertically.
26650 H:base_height, D:base_descent
26651 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26653 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26654 descent = D - H/2 + h/2;
26655 lower_yoff = descent - 2 - ld;
26656 upper_yoff = lower_yoff - la - 1 - ud; */
26657 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26658 descent
= it
->descent
- (base_height
- height
) / 2;
26659 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26660 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26661 - metrics_upper
.descent
);
26662 /* Don't make the height shorter than the base height. */
26663 if (height
> base_height
)
26665 it
->ascent
= ascent
;
26666 it
->descent
= descent
;
26670 it
->phys_ascent
= it
->ascent
;
26671 it
->phys_descent
= it
->descent
;
26673 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26674 upper_xoff
, upper_yoff
,
26675 lower_xoff
, lower_yoff
);
26677 take_vertical_position_into_account (it
);
26682 Produce glyphs/get display metrics for the display element IT is
26683 loaded with. See the description of struct it in dispextern.h
26684 for an overview of struct it. */
26687 x_produce_glyphs (struct it
*it
)
26689 int extra_line_spacing
= it
->extra_line_spacing
;
26691 it
->glyph_not_available_p
= false;
26693 if (it
->what
== IT_CHARACTER
)
26696 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26697 struct font
*font
= face
->font
;
26698 struct font_metrics
*pcm
= NULL
;
26699 int boff
; /* Baseline offset. */
26703 /* When no suitable font is found, display this character by
26704 the method specified in the first extra slot of
26705 Vglyphless_char_display. */
26706 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26708 eassert (it
->what
== IT_GLYPHLESS
);
26709 produce_glyphless_glyph (it
, true,
26710 STRINGP (acronym
) ? acronym
: Qnil
);
26714 boff
= font
->baseline_offset
;
26715 if (font
->vertical_centering
)
26716 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26718 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26722 if (it
->override_ascent
>= 0)
26724 it
->ascent
= it
->override_ascent
;
26725 it
->descent
= it
->override_descent
;
26726 boff
= it
->override_boff
;
26730 it
->ascent
= FONT_BASE (font
) + boff
;
26731 it
->descent
= FONT_DESCENT (font
) - boff
;
26734 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
26736 pcm
= get_per_char_metric (font
, &char2b
);
26737 if (pcm
->width
== 0
26738 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26744 it
->phys_ascent
= pcm
->ascent
+ boff
;
26745 it
->phys_descent
= pcm
->descent
- boff
;
26746 it
->pixel_width
= pcm
->width
;
26747 /* Don't use font-global values for ascent and descent
26748 if they result in an exceedingly large line height. */
26749 if (it
->override_ascent
< 0)
26751 if (FONT_TOO_HIGH (font
))
26753 it
->ascent
= it
->phys_ascent
;
26754 it
->descent
= it
->phys_descent
;
26755 /* These limitations are enforced by an
26756 assertion near the end of this function. */
26757 if (it
->ascent
< 0)
26759 if (it
->descent
< 0)
26766 it
->glyph_not_available_p
= true;
26767 it
->phys_ascent
= it
->ascent
;
26768 it
->phys_descent
= it
->descent
;
26769 it
->pixel_width
= font
->space_width
;
26772 if (it
->constrain_row_ascent_descent_p
)
26774 if (it
->descent
> it
->max_descent
)
26776 it
->ascent
+= it
->descent
- it
->max_descent
;
26777 it
->descent
= it
->max_descent
;
26779 if (it
->ascent
> it
->max_ascent
)
26781 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26782 it
->ascent
= it
->max_ascent
;
26784 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26785 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26786 extra_line_spacing
= 0;
26789 /* If this is a space inside a region of text with
26790 `space-width' property, change its width. */
26792 = it
->char_to_display
== ' ' && !NILP (it
->space_width
);
26794 it
->pixel_width
*= XFLOATINT (it
->space_width
);
26796 /* If face has a box, add the box thickness to the character
26797 height. If character has a box line to the left and/or
26798 right, add the box line width to the character's width. */
26799 if (face
->box
!= FACE_NO_BOX
)
26801 int thick
= face
->box_line_width
;
26805 it
->ascent
+= thick
;
26806 it
->descent
+= thick
;
26811 if (it
->start_of_box_run_p
)
26812 it
->pixel_width
+= thick
;
26813 if (it
->end_of_box_run_p
)
26814 it
->pixel_width
+= thick
;
26817 /* If face has an overline, add the height of the overline
26818 (1 pixel) and a 1 pixel margin to the character height. */
26819 if (face
->overline_p
)
26820 it
->ascent
+= overline_margin
;
26822 if (it
->constrain_row_ascent_descent_p
)
26824 if (it
->ascent
> it
->max_ascent
)
26825 it
->ascent
= it
->max_ascent
;
26826 if (it
->descent
> it
->max_descent
)
26827 it
->descent
= it
->max_descent
;
26830 take_vertical_position_into_account (it
);
26832 /* If we have to actually produce glyphs, do it. */
26837 /* Translate a space with a `space-width' property
26838 into a stretch glyph. */
26839 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
26840 / FONT_HEIGHT (font
));
26841 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26842 it
->ascent
+ it
->descent
, ascent
);
26847 /* If characters with lbearing or rbearing are displayed
26848 in this line, record that fact in a flag of the
26849 glyph row. This is used to optimize X output code. */
26850 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
26851 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
26853 if (! stretched_p
&& it
->pixel_width
== 0)
26854 /* We assure that all visible glyphs have at least 1-pixel
26856 it
->pixel_width
= 1;
26858 else if (it
->char_to_display
== '\n')
26860 /* A newline has no width, but we need the height of the
26861 line. But if previous part of the line sets a height,
26862 don't increase that height. */
26864 Lisp_Object height
;
26865 Lisp_Object total_height
= Qnil
;
26867 it
->override_ascent
= -1;
26868 it
->pixel_width
= 0;
26871 height
= get_it_property (it
, Qline_height
);
26872 /* Split (line-height total-height) list. */
26874 && CONSP (XCDR (height
))
26875 && NILP (XCDR (XCDR (height
))))
26877 total_height
= XCAR (XCDR (height
));
26878 height
= XCAR (height
);
26880 height
= calc_line_height_property (it
, height
, font
, boff
, true);
26882 if (it
->override_ascent
>= 0)
26884 it
->ascent
= it
->override_ascent
;
26885 it
->descent
= it
->override_descent
;
26886 boff
= it
->override_boff
;
26890 if (FONT_TOO_HIGH (font
))
26892 it
->ascent
= font
->pixel_size
+ boff
- 1;
26893 it
->descent
= -boff
+ 1;
26894 if (it
->descent
< 0)
26899 it
->ascent
= FONT_BASE (font
) + boff
;
26900 it
->descent
= FONT_DESCENT (font
) - boff
;
26904 if (EQ (height
, Qt
))
26906 if (it
->descent
> it
->max_descent
)
26908 it
->ascent
+= it
->descent
- it
->max_descent
;
26909 it
->descent
= it
->max_descent
;
26911 if (it
->ascent
> it
->max_ascent
)
26913 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26914 it
->ascent
= it
->max_ascent
;
26916 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26917 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26918 it
->constrain_row_ascent_descent_p
= true;
26919 extra_line_spacing
= 0;
26923 Lisp_Object spacing
;
26925 it
->phys_ascent
= it
->ascent
;
26926 it
->phys_descent
= it
->descent
;
26928 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26929 && face
->box
!= FACE_NO_BOX
26930 && face
->box_line_width
> 0)
26932 it
->ascent
+= face
->box_line_width
;
26933 it
->descent
+= face
->box_line_width
;
26936 && XINT (height
) > it
->ascent
+ it
->descent
)
26937 it
->ascent
= XINT (height
) - it
->descent
;
26939 if (!NILP (total_height
))
26940 spacing
= calc_line_height_property (it
, total_height
, font
,
26944 spacing
= get_it_property (it
, Qline_spacing
);
26945 spacing
= calc_line_height_property (it
, spacing
, font
,
26948 if (INTEGERP (spacing
))
26950 extra_line_spacing
= XINT (spacing
);
26951 if (!NILP (total_height
))
26952 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26956 else /* i.e. (it->char_to_display == '\t') */
26958 if (font
->space_width
> 0)
26960 int tab_width
= it
->tab_width
* font
->space_width
;
26961 int x
= it
->current_x
+ it
->continuation_lines_width
;
26962 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26964 /* If the distance from the current position to the next tab
26965 stop is less than a space character width, use the
26966 tab stop after that. */
26967 if (next_tab_x
- x
< font
->space_width
)
26968 next_tab_x
+= tab_width
;
26970 it
->pixel_width
= next_tab_x
- x
;
26972 if (FONT_TOO_HIGH (font
))
26974 if (get_char_glyph_code (' ', font
, &char2b
))
26976 pcm
= get_per_char_metric (font
, &char2b
);
26977 if (pcm
->width
== 0
26978 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26984 it
->ascent
= pcm
->ascent
+ boff
;
26985 it
->descent
= pcm
->descent
- boff
;
26989 it
->ascent
= font
->pixel_size
+ boff
- 1;
26990 it
->descent
= -boff
+ 1;
26992 if (it
->ascent
< 0)
26994 if (it
->descent
< 0)
26999 it
->ascent
= FONT_BASE (font
) + boff
;
27000 it
->descent
= FONT_DESCENT (font
) - boff
;
27002 it
->phys_ascent
= it
->ascent
;
27003 it
->phys_descent
= it
->descent
;
27007 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
27008 it
->ascent
+ it
->descent
, it
->ascent
);
27013 it
->pixel_width
= 0;
27018 if (FONT_TOO_HIGH (font
))
27020 int font_ascent
, font_descent
;
27022 /* For very large fonts, where we ignore the declared font
27023 dimensions, and go by per-character metrics instead,
27024 don't let the row ascent and descent values (and the row
27025 height computed from them) be smaller than the "normal"
27026 character metrics. This avoids unpleasant effects
27027 whereby lines on display would change their height
27028 depending on which characters are shown. */
27029 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
27030 it
->max_ascent
= max (it
->max_ascent
, font_ascent
);
27031 it
->max_descent
= max (it
->max_descent
, font_descent
);
27034 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
27036 /* A static composition.
27038 Note: A composition is represented as one glyph in the
27039 glyph matrix. There are no padding glyphs.
27041 Important note: pixel_width, ascent, and descent are the
27042 values of what is drawn by draw_glyphs (i.e. the values of
27043 the overall glyphs composed). */
27044 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27045 int boff
; /* baseline offset */
27046 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
27047 int glyph_len
= cmp
->glyph_len
;
27048 struct font
*font
= face
->font
;
27052 /* If we have not yet calculated pixel size data of glyphs of
27053 the composition for the current face font, calculate them
27054 now. Theoretically, we have to check all fonts for the
27055 glyphs, but that requires much time and memory space. So,
27056 here we check only the font of the first glyph. This may
27057 lead to incorrect display, but it's very rare, and C-l
27058 (recenter-top-bottom) can correct the display anyway. */
27059 if (! cmp
->font
|| cmp
->font
!= font
)
27061 /* Ascent and descent of the font of the first character
27062 of this composition (adjusted by baseline offset).
27063 Ascent and descent of overall glyphs should not be less
27064 than these, respectively. */
27065 int font_ascent
, font_descent
, font_height
;
27066 /* Bounding box of the overall glyphs. */
27067 int leftmost
, rightmost
, lowest
, highest
;
27068 int lbearing
, rbearing
;
27069 int i
, width
, ascent
, descent
;
27070 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
27072 struct font_metrics
*pcm
;
27075 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
27076 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
27078 bool right_padded
= glyph_len
< cmp
->glyph_len
;
27079 for (i
= 0; i
< glyph_len
; i
++)
27081 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
27083 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
27085 bool left_padded
= i
> 0;
27087 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
27088 : IT_CHARPOS (*it
));
27089 /* If no suitable font is found, use the default font. */
27090 bool font_not_found_p
= font
== NULL
;
27091 if (font_not_found_p
)
27093 face
= face
->ascii_face
;
27096 boff
= font
->baseline_offset
;
27097 if (font
->vertical_centering
)
27098 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
27099 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
27100 font_ascent
+= boff
;
27101 font_descent
-= boff
;
27102 font_height
= font_ascent
+ font_descent
;
27107 if (! font_not_found_p
)
27109 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
27111 pcm
= get_per_char_metric (font
, &char2b
);
27114 /* Initialize the bounding box. */
27117 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
27118 ascent
= pcm
->ascent
;
27119 descent
= pcm
->descent
;
27120 lbearing
= pcm
->lbearing
;
27121 rbearing
= pcm
->rbearing
;
27125 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
27126 ascent
= FONT_BASE (font
);
27127 descent
= FONT_DESCENT (font
);
27134 lowest
= - descent
+ boff
;
27135 highest
= ascent
+ boff
;
27137 if (! font_not_found_p
27138 && font
->default_ascent
27139 && CHAR_TABLE_P (Vuse_default_ascent
)
27140 && !NILP (Faref (Vuse_default_ascent
,
27141 make_number (it
->char_to_display
))))
27142 highest
= font
->default_ascent
+ boff
;
27144 /* Draw the first glyph at the normal position. It may be
27145 shifted to right later if some other glyphs are drawn
27147 cmp
->offsets
[i
* 2] = 0;
27148 cmp
->offsets
[i
* 2 + 1] = boff
;
27149 cmp
->lbearing
= lbearing
;
27150 cmp
->rbearing
= rbearing
;
27152 /* Set cmp->offsets for the remaining glyphs. */
27153 for (i
++; i
< glyph_len
; i
++)
27155 int left
, right
, btm
, top
;
27156 int ch
= COMPOSITION_GLYPH (cmp
, i
);
27158 struct face
*this_face
;
27162 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
27163 this_face
= FACE_FROM_ID (it
->f
, face_id
);
27164 font
= this_face
->font
;
27170 get_char_face_and_encoding (it
->f
, ch
, face_id
,
27172 pcm
= get_per_char_metric (font
, &char2b
);
27175 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
27178 width
= pcm
->width
;
27179 ascent
= pcm
->ascent
;
27180 descent
= pcm
->descent
;
27181 lbearing
= pcm
->lbearing
;
27182 rbearing
= pcm
->rbearing
;
27183 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
27185 /* Relative composition with or without
27186 alternate chars. */
27187 left
= (leftmost
+ rightmost
- width
) / 2;
27188 btm
= - descent
+ boff
;
27189 if (font
->relative_compose
27190 && (! CHAR_TABLE_P (Vignore_relative_composition
)
27191 || NILP (Faref (Vignore_relative_composition
,
27192 make_number (ch
)))))
27195 if (- descent
>= font
->relative_compose
)
27196 /* One extra pixel between two glyphs. */
27198 else if (ascent
<= 0)
27199 /* One extra pixel between two glyphs. */
27200 btm
= lowest
- 1 - ascent
- descent
;
27205 /* A composition rule is specified by an integer
27206 value that encodes global and new reference
27207 points (GREF and NREF). GREF and NREF are
27208 specified by numbers as below:
27210 0---1---2 -- ascent
27214 9--10--11 -- center
27216 ---3---4---5--- baseline
27218 6---7---8 -- descent
27220 int rule
= COMPOSITION_RULE (cmp
, i
);
27221 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
27223 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
27224 grefx
= gref
% 3, nrefx
= nref
% 3;
27225 grefy
= gref
/ 3, nrefy
= nref
/ 3;
27227 xoff
= font_height
* (xoff
- 128) / 256;
27229 yoff
= font_height
* (yoff
- 128) / 256;
27232 + grefx
* (rightmost
- leftmost
) / 2
27233 - nrefx
* width
/ 2
27236 btm
= ((grefy
== 0 ? highest
27238 : grefy
== 2 ? lowest
27239 : (highest
+ lowest
) / 2)
27240 - (nrefy
== 0 ? ascent
+ descent
27241 : nrefy
== 1 ? descent
- boff
27243 : (ascent
+ descent
) / 2)
27247 cmp
->offsets
[i
* 2] = left
;
27248 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
27250 /* Update the bounding box of the overall glyphs. */
27253 right
= left
+ width
;
27254 if (left
< leftmost
)
27256 if (right
> rightmost
)
27259 top
= btm
+ descent
+ ascent
;
27265 if (cmp
->lbearing
> left
+ lbearing
)
27266 cmp
->lbearing
= left
+ lbearing
;
27267 if (cmp
->rbearing
< left
+ rbearing
)
27268 cmp
->rbearing
= left
+ rbearing
;
27272 /* If there are glyphs whose x-offsets are negative,
27273 shift all glyphs to the right and make all x-offsets
27277 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27278 cmp
->offsets
[i
* 2] -= leftmost
;
27279 rightmost
-= leftmost
;
27280 cmp
->lbearing
-= leftmost
;
27281 cmp
->rbearing
-= leftmost
;
27284 if (left_padded
&& cmp
->lbearing
< 0)
27286 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27287 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
27288 rightmost
-= cmp
->lbearing
;
27289 cmp
->rbearing
-= cmp
->lbearing
;
27292 if (right_padded
&& rightmost
< cmp
->rbearing
)
27294 rightmost
= cmp
->rbearing
;
27297 cmp
->pixel_width
= rightmost
;
27298 cmp
->ascent
= highest
;
27299 cmp
->descent
= - lowest
;
27300 if (cmp
->ascent
< font_ascent
)
27301 cmp
->ascent
= font_ascent
;
27302 if (cmp
->descent
< font_descent
)
27303 cmp
->descent
= font_descent
;
27307 && (cmp
->lbearing
< 0
27308 || cmp
->rbearing
> cmp
->pixel_width
))
27309 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27311 it
->pixel_width
= cmp
->pixel_width
;
27312 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
27313 it
->descent
= it
->phys_descent
= cmp
->descent
;
27314 if (face
->box
!= FACE_NO_BOX
)
27316 int thick
= face
->box_line_width
;
27320 it
->ascent
+= thick
;
27321 it
->descent
+= thick
;
27326 if (it
->start_of_box_run_p
)
27327 it
->pixel_width
+= thick
;
27328 if (it
->end_of_box_run_p
)
27329 it
->pixel_width
+= thick
;
27332 /* If face has an overline, add the height of the overline
27333 (1 pixel) and a 1 pixel margin to the character height. */
27334 if (face
->overline_p
)
27335 it
->ascent
+= overline_margin
;
27337 take_vertical_position_into_account (it
);
27338 if (it
->ascent
< 0)
27340 if (it
->descent
< 0)
27343 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
27344 append_composite_glyph (it
);
27346 else if (it
->what
== IT_COMPOSITION
)
27348 /* A dynamic (automatic) composition. */
27349 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27350 Lisp_Object gstring
;
27351 struct font_metrics metrics
;
27355 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
27357 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
27360 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
27361 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27362 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
27363 it
->descent
= it
->phys_descent
= metrics
.descent
;
27364 if (face
->box
!= FACE_NO_BOX
)
27366 int thick
= face
->box_line_width
;
27370 it
->ascent
+= thick
;
27371 it
->descent
+= thick
;
27376 if (it
->start_of_box_run_p
)
27377 it
->pixel_width
+= thick
;
27378 if (it
->end_of_box_run_p
)
27379 it
->pixel_width
+= thick
;
27381 /* If face has an overline, add the height of the overline
27382 (1 pixel) and a 1 pixel margin to the character height. */
27383 if (face
->overline_p
)
27384 it
->ascent
+= overline_margin
;
27385 take_vertical_position_into_account (it
);
27386 if (it
->ascent
< 0)
27388 if (it
->descent
< 0)
27392 append_composite_glyph (it
);
27394 else if (it
->what
== IT_GLYPHLESS
)
27395 produce_glyphless_glyph (it
, false, Qnil
);
27396 else if (it
->what
== IT_IMAGE
)
27397 produce_image_glyph (it
);
27398 else if (it
->what
== IT_STRETCH
)
27399 produce_stretch_glyph (it
);
27402 /* Accumulate dimensions. Note: can't assume that it->descent > 0
27403 because this isn't true for images with `:ascent 100'. */
27404 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
27405 if (it
->area
== TEXT_AREA
)
27406 it
->current_x
+= it
->pixel_width
;
27408 if (extra_line_spacing
> 0)
27410 it
->descent
+= extra_line_spacing
;
27411 if (extra_line_spacing
> it
->max_extra_line_spacing
)
27412 it
->max_extra_line_spacing
= extra_line_spacing
;
27415 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
27416 it
->max_descent
= max (it
->max_descent
, it
->descent
);
27417 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
27418 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
27422 Output LEN glyphs starting at START at the nominal cursor position.
27423 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
27424 being updated, and UPDATED_AREA is the area of that row being updated. */
27427 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27428 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27430 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
27432 eassert (updated_row
);
27433 /* When the window is hscrolled, cursor hpos can legitimately be out
27434 of bounds, but we draw the cursor at the corresponding window
27435 margin in that case. */
27436 if (!updated_row
->reversed_p
&& chpos
< 0)
27438 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
27439 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
27443 /* Write glyphs. */
27445 hpos
= start
- updated_row
->glyphs
[updated_area
];
27446 x
= draw_glyphs (w
, w
->output_cursor
.x
,
27447 updated_row
, updated_area
,
27449 DRAW_NORMAL_TEXT
, 0);
27451 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
27452 if (updated_area
== TEXT_AREA
27453 && w
->phys_cursor_on_p
27454 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
27456 && chpos
< hpos
+ len
)
27457 w
->phys_cursor_on_p
= false;
27461 /* Advance the output cursor. */
27462 w
->output_cursor
.hpos
+= len
;
27463 w
->output_cursor
.x
= x
;
27468 Insert LEN glyphs from START at the nominal cursor position. */
27471 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27472 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27475 int line_height
, shift_by_width
, shifted_region_width
;
27476 struct glyph_row
*row
;
27477 struct glyph
*glyph
;
27478 int frame_x
, frame_y
;
27481 eassert (updated_row
);
27483 f
= XFRAME (WINDOW_FRAME (w
));
27485 /* Get the height of the line we are in. */
27487 line_height
= row
->height
;
27489 /* Get the width of the glyphs to insert. */
27490 shift_by_width
= 0;
27491 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
27492 shift_by_width
+= glyph
->pixel_width
;
27494 /* Get the width of the region to shift right. */
27495 shifted_region_width
= (window_box_width (w
, updated_area
)
27496 - w
->output_cursor
.x
27500 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
27501 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
27503 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
27504 line_height
, shift_by_width
);
27506 /* Write the glyphs. */
27507 hpos
= start
- row
->glyphs
[updated_area
];
27508 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
27510 DRAW_NORMAL_TEXT
, 0);
27512 /* Advance the output cursor. */
27513 w
->output_cursor
.hpos
+= len
;
27514 w
->output_cursor
.x
+= shift_by_width
;
27520 Erase the current text line from the nominal cursor position
27521 (inclusive) to pixel column TO_X (exclusive). The idea is that
27522 everything from TO_X onward is already erased.
27524 TO_X is a pixel position relative to UPDATED_AREA of currently
27525 updated window W. TO_X == -1 means clear to the end of this area. */
27528 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
27529 enum glyph_row_area updated_area
, int to_x
)
27532 int max_x
, min_y
, max_y
;
27533 int from_x
, from_y
, to_y
;
27535 eassert (updated_row
);
27536 f
= XFRAME (w
->frame
);
27538 if (updated_row
->full_width_p
)
27539 max_x
= (WINDOW_PIXEL_WIDTH (w
)
27540 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
27542 max_x
= window_box_width (w
, updated_area
);
27543 max_y
= window_text_bottom_y (w
);
27545 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
27546 of window. For TO_X > 0, truncate to end of drawing area. */
27552 to_x
= min (to_x
, max_x
);
27554 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
27556 /* Notice if the cursor will be cleared by this operation. */
27557 if (!updated_row
->full_width_p
)
27558 notice_overwritten_cursor (w
, updated_area
,
27559 w
->output_cursor
.x
, -1,
27561 MATRIX_ROW_BOTTOM_Y (updated_row
));
27563 from_x
= w
->output_cursor
.x
;
27565 /* Translate to frame coordinates. */
27566 if (updated_row
->full_width_p
)
27568 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
27569 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
27573 int area_left
= window_box_left (w
, updated_area
);
27574 from_x
+= area_left
;
27578 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
27579 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
27580 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
27582 /* Prevent inadvertently clearing to end of the X window. */
27583 if (to_x
> from_x
&& to_y
> from_y
)
27586 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
27587 to_x
- from_x
, to_y
- from_y
);
27592 #endif /* HAVE_WINDOW_SYSTEM */
27596 /***********************************************************************
27598 ***********************************************************************/
27600 /* Value is the internal representation of the specified cursor type
27601 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27602 of the bar cursor. */
27604 static enum text_cursor_kinds
27605 get_specified_cursor_type (Lisp_Object arg
, int *width
)
27607 enum text_cursor_kinds type
;
27612 if (EQ (arg
, Qbox
))
27613 return FILLED_BOX_CURSOR
;
27615 if (EQ (arg
, Qhollow
))
27616 return HOLLOW_BOX_CURSOR
;
27618 if (EQ (arg
, Qbar
))
27625 && EQ (XCAR (arg
), Qbar
)
27626 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27628 *width
= XINT (XCDR (arg
));
27632 if (EQ (arg
, Qhbar
))
27635 return HBAR_CURSOR
;
27639 && EQ (XCAR (arg
), Qhbar
)
27640 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27642 *width
= XINT (XCDR (arg
));
27643 return HBAR_CURSOR
;
27646 /* Treat anything unknown as "hollow box cursor".
27647 It was bad to signal an error; people have trouble fixing
27648 .Xdefaults with Emacs, when it has something bad in it. */
27649 type
= HOLLOW_BOX_CURSOR
;
27654 /* Set the default cursor types for specified frame. */
27656 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27661 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27662 FRAME_CURSOR_WIDTH (f
) = width
;
27664 /* By default, set up the blink-off state depending on the on-state. */
27666 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27669 FRAME_BLINK_OFF_CURSOR (f
)
27670 = get_specified_cursor_type (XCDR (tem
), &width
);
27671 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27674 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27676 /* Make sure the cursor gets redrawn. */
27677 f
->cursor_type_changed
= true;
27681 #ifdef HAVE_WINDOW_SYSTEM
27683 /* Return the cursor we want to be displayed in window W. Return
27684 width of bar/hbar cursor through WIDTH arg. Return with
27685 ACTIVE_CURSOR arg set to true if cursor in window W is `active'
27686 (i.e. if the `system caret' should track this cursor).
27688 In a mini-buffer window, we want the cursor only to appear if we
27689 are reading input from this window. For the selected window, we
27690 want the cursor type given by the frame parameter or buffer local
27691 setting of cursor-type. If explicitly marked off, draw no cursor.
27692 In all other cases, we want a hollow box cursor. */
27694 static enum text_cursor_kinds
27695 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27696 bool *active_cursor
)
27698 struct frame
*f
= XFRAME (w
->frame
);
27699 struct buffer
*b
= XBUFFER (w
->contents
);
27700 int cursor_type
= DEFAULT_CURSOR
;
27701 Lisp_Object alt_cursor
;
27702 bool non_selected
= false;
27704 *active_cursor
= true;
27707 if (cursor_in_echo_area
27708 && FRAME_HAS_MINIBUF_P (f
)
27709 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27711 if (w
== XWINDOW (echo_area_window
))
27713 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27715 *width
= FRAME_CURSOR_WIDTH (f
);
27716 return FRAME_DESIRED_CURSOR (f
);
27719 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27722 *active_cursor
= false;
27723 non_selected
= true;
27726 /* Detect a nonselected window or nonselected frame. */
27727 else if (w
!= XWINDOW (f
->selected_window
)
27728 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
27730 *active_cursor
= false;
27732 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
27735 non_selected
= true;
27738 /* Never display a cursor in a window in which cursor-type is nil. */
27739 if (NILP (BVAR (b
, cursor_type
)))
27742 /* Get the normal cursor type for this window. */
27743 if (EQ (BVAR (b
, cursor_type
), Qt
))
27745 cursor_type
= FRAME_DESIRED_CURSOR (f
);
27746 *width
= FRAME_CURSOR_WIDTH (f
);
27749 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27751 /* Use cursor-in-non-selected-windows instead
27752 for non-selected window or frame. */
27755 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
27756 if (!EQ (Qt
, alt_cursor
))
27757 return get_specified_cursor_type (alt_cursor
, width
);
27758 /* t means modify the normal cursor type. */
27759 if (cursor_type
== FILLED_BOX_CURSOR
)
27760 cursor_type
= HOLLOW_BOX_CURSOR
;
27761 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
27763 return cursor_type
;
27766 /* Use normal cursor if not blinked off. */
27767 if (!w
->cursor_off_p
)
27769 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27771 if (cursor_type
== FILLED_BOX_CURSOR
)
27773 /* Using a block cursor on large images can be very annoying.
27774 So use a hollow cursor for "large" images.
27775 If image is not transparent (no mask), also use hollow cursor. */
27776 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27777 if (img
!= NULL
&& IMAGEP (img
->spec
))
27779 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27780 where N = size of default frame font size.
27781 This should cover most of the "tiny" icons people may use. */
27783 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
27784 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
27785 cursor_type
= HOLLOW_BOX_CURSOR
;
27788 else if (cursor_type
!= NO_CURSOR
)
27790 /* Display current only supports BOX and HOLLOW cursors for images.
27791 So for now, unconditionally use a HOLLOW cursor when cursor is
27792 not a solid box cursor. */
27793 cursor_type
= HOLLOW_BOX_CURSOR
;
27796 return cursor_type
;
27799 /* Cursor is blinked off, so determine how to "toggle" it. */
27801 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27802 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
27803 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
27805 /* Then see if frame has specified a specific blink off cursor type. */
27806 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
27808 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
27809 return FRAME_BLINK_OFF_CURSOR (f
);
27813 /* Some people liked having a permanently visible blinking cursor,
27814 while others had very strong opinions against it. So it was
27815 decided to remove it. KFS 2003-09-03 */
27817 /* Finally perform built-in cursor blinking:
27818 filled box <-> hollow box
27819 wide [h]bar <-> narrow [h]bar
27820 narrow [h]bar <-> no cursor
27821 other type <-> no cursor */
27823 if (cursor_type
== FILLED_BOX_CURSOR
)
27824 return HOLLOW_BOX_CURSOR
;
27826 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
27829 return cursor_type
;
27837 /* Notice when the text cursor of window W has been completely
27838 overwritten by a drawing operation that outputs glyphs in AREA
27839 starting at X0 and ending at X1 in the line starting at Y0 and
27840 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27841 the rest of the line after X0 has been written. Y coordinates
27842 are window-relative. */
27845 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
27846 int x0
, int x1
, int y0
, int y1
)
27848 int cx0
, cx1
, cy0
, cy1
;
27849 struct glyph_row
*row
;
27851 if (!w
->phys_cursor_on_p
)
27853 if (area
!= TEXT_AREA
)
27856 if (w
->phys_cursor
.vpos
< 0
27857 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
27858 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
27859 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
27862 if (row
->cursor_in_fringe_p
)
27864 row
->cursor_in_fringe_p
= false;
27865 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
27866 w
->phys_cursor_on_p
= false;
27870 cx0
= w
->phys_cursor
.x
;
27871 cx1
= cx0
+ w
->phys_cursor_width
;
27872 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
27875 /* The cursor image will be completely removed from the
27876 screen if the output area intersects the cursor area in
27877 y-direction. When we draw in [y0 y1[, and some part of
27878 the cursor is at y < y0, that part must have been drawn
27879 before. When scrolling, the cursor is erased before
27880 actually scrolling, so we don't come here. When not
27881 scrolling, the rows above the old cursor row must have
27882 changed, and in this case these rows must have written
27883 over the cursor image.
27885 Likewise if part of the cursor is below y1, with the
27886 exception of the cursor being in the first blank row at
27887 the buffer and window end because update_text_area
27888 doesn't draw that row. (Except when it does, but
27889 that's handled in update_text_area.) */
27891 cy0
= w
->phys_cursor
.y
;
27892 cy1
= cy0
+ w
->phys_cursor_height
;
27893 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
27896 w
->phys_cursor_on_p
= false;
27899 #endif /* HAVE_WINDOW_SYSTEM */
27902 /************************************************************************
27904 ************************************************************************/
27906 #ifdef HAVE_WINDOW_SYSTEM
27909 Fix the display of area AREA of overlapping row ROW in window W
27910 with respect to the overlapping part OVERLAPS. */
27913 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
27914 enum glyph_row_area area
, int overlaps
)
27921 for (i
= 0; i
< row
->used
[area
];)
27923 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
27925 int start
= i
, start_x
= x
;
27929 x
+= row
->glyphs
[area
][i
].pixel_width
;
27932 while (i
< row
->used
[area
]
27933 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
27935 draw_glyphs (w
, start_x
, row
, area
,
27937 DRAW_NORMAL_TEXT
, overlaps
);
27941 x
+= row
->glyphs
[area
][i
].pixel_width
;
27951 Draw the cursor glyph of window W in glyph row ROW. See the
27952 comment of draw_glyphs for the meaning of HL. */
27955 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27956 enum draw_glyphs_face hl
)
27958 /* If cursor hpos is out of bounds, don't draw garbage. This can
27959 happen in mini-buffer windows when switching between echo area
27960 glyphs and mini-buffer. */
27961 if ((row
->reversed_p
27962 ? (w
->phys_cursor
.hpos
>= 0)
27963 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27965 bool on_p
= w
->phys_cursor_on_p
;
27967 int hpos
= w
->phys_cursor
.hpos
;
27969 /* When the window is hscrolled, cursor hpos can legitimately be
27970 out of bounds, but we draw the cursor at the corresponding
27971 window margin in that case. */
27972 if (!row
->reversed_p
&& hpos
< 0)
27974 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27975 hpos
= row
->used
[TEXT_AREA
] - 1;
27977 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27979 w
->phys_cursor_on_p
= on_p
;
27981 if (hl
== DRAW_CURSOR
)
27982 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27983 /* When we erase the cursor, and ROW is overlapped by other
27984 rows, make sure that these overlapping parts of other rows
27986 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27988 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27990 if (row
> w
->current_matrix
->rows
27991 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27992 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27993 OVERLAPS_ERASED_CURSOR
);
27995 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27996 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27997 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27998 OVERLAPS_ERASED_CURSOR
);
28004 /* Erase the image of a cursor of window W from the screen. */
28007 erase_phys_cursor (struct window
*w
)
28009 struct frame
*f
= XFRAME (w
->frame
);
28010 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28011 int hpos
= w
->phys_cursor
.hpos
;
28012 int vpos
= w
->phys_cursor
.vpos
;
28013 bool mouse_face_here_p
= false;
28014 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
28015 struct glyph_row
*cursor_row
;
28016 struct glyph
*cursor_glyph
;
28017 enum draw_glyphs_face hl
;
28019 /* No cursor displayed or row invalidated => nothing to do on the
28021 if (w
->phys_cursor_type
== NO_CURSOR
)
28022 goto mark_cursor_off
;
28024 /* VPOS >= active_glyphs->nrows means that window has been resized.
28025 Don't bother to erase the cursor. */
28026 if (vpos
>= active_glyphs
->nrows
)
28027 goto mark_cursor_off
;
28029 /* If row containing cursor is marked invalid, there is nothing we
28031 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
28032 if (!cursor_row
->enabled_p
)
28033 goto mark_cursor_off
;
28035 /* If line spacing is > 0, old cursor may only be partially visible in
28036 window after split-window. So adjust visible height. */
28037 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
28038 window_text_bottom_y (w
) - cursor_row
->y
);
28040 /* If row is completely invisible, don't attempt to delete a cursor which
28041 isn't there. This can happen if cursor is at top of a window, and
28042 we switch to a buffer with a header line in that window. */
28043 if (cursor_row
->visible_height
<= 0)
28044 goto mark_cursor_off
;
28046 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
28047 if (cursor_row
->cursor_in_fringe_p
)
28049 cursor_row
->cursor_in_fringe_p
= false;
28050 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
28051 goto mark_cursor_off
;
28054 /* This can happen when the new row is shorter than the old one.
28055 In this case, either draw_glyphs or clear_end_of_line
28056 should have cleared the cursor. Note that we wouldn't be
28057 able to erase the cursor in this case because we don't have a
28058 cursor glyph at hand. */
28059 if ((cursor_row
->reversed_p
28060 ? (w
->phys_cursor
.hpos
< 0)
28061 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
28062 goto mark_cursor_off
;
28064 /* When the window is hscrolled, cursor hpos can legitimately be out
28065 of bounds, but we draw the cursor at the corresponding window
28066 margin in that case. */
28067 if (!cursor_row
->reversed_p
&& hpos
< 0)
28069 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
28070 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
28072 /* If the cursor is in the mouse face area, redisplay that when
28073 we clear the cursor. */
28074 if (! NILP (hlinfo
->mouse_face_window
)
28075 && coords_in_mouse_face_p (w
, hpos
, vpos
)
28076 /* Don't redraw the cursor's spot in mouse face if it is at the
28077 end of a line (on a newline). The cursor appears there, but
28078 mouse highlighting does not. */
28079 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
28080 mouse_face_here_p
= true;
28082 /* Maybe clear the display under the cursor. */
28083 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
28086 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
28089 cursor_glyph
= get_phys_cursor_glyph (w
);
28090 if (cursor_glyph
== NULL
)
28091 goto mark_cursor_off
;
28093 width
= cursor_glyph
->pixel_width
;
28094 x
= w
->phys_cursor
.x
;
28100 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
28101 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
28102 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
28105 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
28108 /* Erase the cursor by redrawing the character underneath it. */
28109 if (mouse_face_here_p
)
28110 hl
= DRAW_MOUSE_FACE
;
28112 hl
= DRAW_NORMAL_TEXT
;
28113 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
28116 w
->phys_cursor_on_p
= false;
28117 w
->phys_cursor_type
= NO_CURSOR
;
28121 /* Display or clear cursor of window W. If !ON, clear the cursor.
28122 If ON, display the cursor; where to put the cursor is specified by
28123 HPOS, VPOS, X and Y. */
28126 display_and_set_cursor (struct window
*w
, bool on
,
28127 int hpos
, int vpos
, int x
, int y
)
28129 struct frame
*f
= XFRAME (w
->frame
);
28130 int new_cursor_type
;
28131 int new_cursor_width
;
28132 bool active_cursor
;
28133 struct glyph_row
*glyph_row
;
28134 struct glyph
*glyph
;
28136 /* This is pointless on invisible frames, and dangerous on garbaged
28137 windows and frames; in the latter case, the frame or window may
28138 be in the midst of changing its size, and x and y may be off the
28140 if (! FRAME_VISIBLE_P (f
)
28141 || FRAME_GARBAGED_P (f
)
28142 || vpos
>= w
->current_matrix
->nrows
28143 || hpos
>= w
->current_matrix
->matrix_w
)
28146 /* If cursor is off and we want it off, return quickly. */
28147 if (!on
&& !w
->phys_cursor_on_p
)
28150 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28151 /* If cursor row is not enabled, we don't really know where to
28152 display the cursor. */
28153 if (!glyph_row
->enabled_p
)
28155 w
->phys_cursor_on_p
= false;
28160 if (!glyph_row
->exact_window_width_line_p
28161 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
28162 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
28164 eassert (input_blocked_p ());
28166 /* Set new_cursor_type to the cursor we want to be displayed. */
28167 new_cursor_type
= get_window_cursor_type (w
, glyph
,
28168 &new_cursor_width
, &active_cursor
);
28170 /* If cursor is currently being shown and we don't want it to be or
28171 it is in the wrong place, or the cursor type is not what we want,
28173 if (w
->phys_cursor_on_p
28175 || w
->phys_cursor
.x
!= x
28176 || w
->phys_cursor
.y
!= y
28177 /* HPOS can be negative in R2L rows whose
28178 exact_window_width_line_p flag is set (i.e. their newline
28179 would "overflow into the fringe"). */
28181 || new_cursor_type
!= w
->phys_cursor_type
28182 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
28183 && new_cursor_width
!= w
->phys_cursor_width
)))
28184 erase_phys_cursor (w
);
28186 /* Don't check phys_cursor_on_p here because that flag is only set
28187 to false in some cases where we know that the cursor has been
28188 completely erased, to avoid the extra work of erasing the cursor
28189 twice. In other words, phys_cursor_on_p can be true and the cursor
28190 still not be visible, or it has only been partly erased. */
28193 w
->phys_cursor_ascent
= glyph_row
->ascent
;
28194 w
->phys_cursor_height
= glyph_row
->height
;
28196 /* Set phys_cursor_.* before x_draw_.* is called because some
28197 of them may need the information. */
28198 w
->phys_cursor
.x
= x
;
28199 w
->phys_cursor
.y
= glyph_row
->y
;
28200 w
->phys_cursor
.hpos
= hpos
;
28201 w
->phys_cursor
.vpos
= vpos
;
28204 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
28205 new_cursor_type
, new_cursor_width
,
28206 on
, active_cursor
);
28210 /* Switch the display of W's cursor on or off, according to the value
28214 update_window_cursor (struct window
*w
, bool on
)
28216 /* Don't update cursor in windows whose frame is in the process
28217 of being deleted. */
28218 if (w
->current_matrix
)
28220 int hpos
= w
->phys_cursor
.hpos
;
28221 int vpos
= w
->phys_cursor
.vpos
;
28222 struct glyph_row
*row
;
28224 if (vpos
>= w
->current_matrix
->nrows
28225 || hpos
>= w
->current_matrix
->matrix_w
)
28228 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28230 /* When the window is hscrolled, cursor hpos can legitimately be
28231 out of bounds, but we draw the cursor at the corresponding
28232 window margin in that case. */
28233 if (!row
->reversed_p
&& hpos
< 0)
28235 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28236 hpos
= row
->used
[TEXT_AREA
] - 1;
28239 display_and_set_cursor (w
, on
, hpos
, vpos
,
28240 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28246 /* Call update_window_cursor with parameter ON_P on all leaf windows
28247 in the window tree rooted at W. */
28250 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
28254 if (WINDOWP (w
->contents
))
28255 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
28257 update_window_cursor (w
, on_p
);
28259 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
28265 Display the cursor on window W, or clear it, according to ON_P.
28266 Don't change the cursor's position. */
28269 x_update_cursor (struct frame
*f
, bool on_p
)
28271 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
28276 Clear the cursor of window W to background color, and mark the
28277 cursor as not shown. This is used when the text where the cursor
28278 is about to be rewritten. */
28281 x_clear_cursor (struct window
*w
)
28283 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
28284 update_window_cursor (w
, false);
28287 #endif /* HAVE_WINDOW_SYSTEM */
28289 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
28292 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
28293 int start_hpos
, int end_hpos
,
28294 enum draw_glyphs_face draw
)
28296 #ifdef HAVE_WINDOW_SYSTEM
28297 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
28299 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
28303 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
28304 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
28308 /* Display the active region described by mouse_face_* according to DRAW. */
28311 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
28313 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
28314 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28316 if (/* If window is in the process of being destroyed, don't bother
28318 w
->current_matrix
!= NULL
28319 /* Don't update mouse highlight if hidden. */
28320 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
28321 /* Recognize when we are called to operate on rows that don't exist
28322 anymore. This can happen when a window is split. */
28323 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
28325 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
28326 struct glyph_row
*row
, *first
, *last
;
28328 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
28329 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
28331 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
28333 int start_hpos
, end_hpos
, start_x
;
28335 /* For all but the first row, the highlight starts at column 0. */
28338 /* R2L rows have BEG and END in reversed order, but the
28339 screen drawing geometry is always left to right. So
28340 we need to mirror the beginning and end of the
28341 highlighted area in R2L rows. */
28342 if (!row
->reversed_p
)
28344 start_hpos
= hlinfo
->mouse_face_beg_col
;
28345 start_x
= hlinfo
->mouse_face_beg_x
;
28347 else if (row
== last
)
28349 start_hpos
= hlinfo
->mouse_face_end_col
;
28350 start_x
= hlinfo
->mouse_face_end_x
;
28358 else if (row
->reversed_p
&& row
== last
)
28360 start_hpos
= hlinfo
->mouse_face_end_col
;
28361 start_x
= hlinfo
->mouse_face_end_x
;
28371 if (!row
->reversed_p
)
28372 end_hpos
= hlinfo
->mouse_face_end_col
;
28373 else if (row
== first
)
28374 end_hpos
= hlinfo
->mouse_face_beg_col
;
28377 end_hpos
= row
->used
[TEXT_AREA
];
28378 if (draw
== DRAW_NORMAL_TEXT
)
28379 row
->fill_line_p
= true; /* Clear to end of line. */
28382 else if (row
->reversed_p
&& row
== first
)
28383 end_hpos
= hlinfo
->mouse_face_beg_col
;
28386 end_hpos
= row
->used
[TEXT_AREA
];
28387 if (draw
== DRAW_NORMAL_TEXT
)
28388 row
->fill_line_p
= true; /* Clear to end of line. */
28391 if (end_hpos
> start_hpos
)
28393 draw_row_with_mouse_face (w
, start_x
, row
,
28394 start_hpos
, end_hpos
, draw
);
28397 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
28401 #ifdef HAVE_WINDOW_SYSTEM
28402 /* When we've written over the cursor, arrange for it to
28403 be displayed again. */
28404 if (FRAME_WINDOW_P (f
)
28405 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
28407 int hpos
= w
->phys_cursor
.hpos
;
28409 /* When the window is hscrolled, cursor hpos can legitimately be
28410 out of bounds, but we draw the cursor at the corresponding
28411 window margin in that case. */
28412 if (!row
->reversed_p
&& hpos
< 0)
28414 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28415 hpos
= row
->used
[TEXT_AREA
] - 1;
28418 display_and_set_cursor (w
, true, hpos
, w
->phys_cursor
.vpos
,
28419 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28422 #endif /* HAVE_WINDOW_SYSTEM */
28425 #ifdef HAVE_WINDOW_SYSTEM
28426 /* Change the mouse cursor. */
28427 if (FRAME_WINDOW_P (f
) && NILP (do_mouse_tracking
))
28429 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
28430 if (draw
== DRAW_NORMAL_TEXT
28431 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
28432 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
28435 if (draw
== DRAW_MOUSE_FACE
)
28436 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
28438 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
28440 #endif /* HAVE_WINDOW_SYSTEM */
28444 Clear out the mouse-highlighted active region.
28445 Redraw it un-highlighted first. Value is true if mouse
28446 face was actually drawn unhighlighted. */
28449 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
28452 = !hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
);
28454 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
28455 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28456 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28457 hlinfo
->mouse_face_window
= Qnil
;
28458 hlinfo
->mouse_face_overlay
= Qnil
;
28462 /* Return true if the coordinates HPOS and VPOS on windows W are
28463 within the mouse face on that window. */
28465 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
28467 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28469 /* Quickly resolve the easy cases. */
28470 if (!(WINDOWP (hlinfo
->mouse_face_window
)
28471 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
28473 if (vpos
< hlinfo
->mouse_face_beg_row
28474 || vpos
> hlinfo
->mouse_face_end_row
)
28476 if (vpos
> hlinfo
->mouse_face_beg_row
28477 && vpos
< hlinfo
->mouse_face_end_row
)
28480 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
28482 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28484 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
28487 else if ((vpos
== hlinfo
->mouse_face_beg_row
28488 && hpos
>= hlinfo
->mouse_face_beg_col
)
28489 || (vpos
== hlinfo
->mouse_face_end_row
28490 && hpos
< hlinfo
->mouse_face_end_col
))
28495 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28497 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
28500 else if ((vpos
== hlinfo
->mouse_face_beg_row
28501 && hpos
<= hlinfo
->mouse_face_beg_col
)
28502 || (vpos
== hlinfo
->mouse_face_end_row
28503 && hpos
> hlinfo
->mouse_face_end_col
))
28511 True if physical cursor of window W is within mouse face. */
28514 cursor_in_mouse_face_p (struct window
*w
)
28516 int hpos
= w
->phys_cursor
.hpos
;
28517 int vpos
= w
->phys_cursor
.vpos
;
28518 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28520 /* When the window is hscrolled, cursor hpos can legitimately be out
28521 of bounds, but we draw the cursor at the corresponding window
28522 margin in that case. */
28523 if (!row
->reversed_p
&& hpos
< 0)
28525 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28526 hpos
= row
->used
[TEXT_AREA
] - 1;
28528 return coords_in_mouse_face_p (w
, hpos
, vpos
);
28533 /* Find the glyph rows START_ROW and END_ROW of window W that display
28534 characters between buffer positions START_CHARPOS and END_CHARPOS
28535 (excluding END_CHARPOS). DISP_STRING is a display string that
28536 covers these buffer positions. This is similar to
28537 row_containing_pos, but is more accurate when bidi reordering makes
28538 buffer positions change non-linearly with glyph rows. */
28540 rows_from_pos_range (struct window
*w
,
28541 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
28542 Lisp_Object disp_string
,
28543 struct glyph_row
**start
, struct glyph_row
**end
)
28545 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28546 int last_y
= window_text_bottom_y (w
);
28547 struct glyph_row
*row
;
28552 while (!first
->enabled_p
28553 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
28556 /* Find the START row. */
28558 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
28561 /* A row can potentially be the START row if the range of the
28562 characters it displays intersects the range
28563 [START_CHARPOS..END_CHARPOS). */
28564 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
28565 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
28566 /* See the commentary in row_containing_pos, for the
28567 explanation of the complicated way to check whether
28568 some position is beyond the end of the characters
28569 displayed by a row. */
28570 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28571 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28572 && !row
->ends_at_zv_p
28573 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
28574 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28575 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28576 && !row
->ends_at_zv_p
28577 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
28579 /* Found a candidate row. Now make sure at least one of the
28580 glyphs it displays has a charpos from the range
28581 [START_CHARPOS..END_CHARPOS).
28583 This is not obvious because bidi reordering could make
28584 buffer positions of a row be 1,2,3,102,101,100, and if we
28585 want to highlight characters in [50..60), we don't want
28586 this row, even though [50..60) does intersect [1..103),
28587 the range of character positions given by the row's start
28588 and end positions. */
28589 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
28590 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
28594 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28595 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28596 /* A glyph that comes from DISP_STRING is by
28597 definition to be highlighted. */
28598 || EQ (g
->object
, disp_string
))
28607 /* Find the END row. */
28609 /* If the last row is partially visible, start looking for END
28610 from that row, instead of starting from FIRST. */
28611 && !(row
->enabled_p
28612 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
28614 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
28616 struct glyph_row
*next
= row
+ 1;
28617 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
28619 if (!next
->enabled_p
28620 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
28621 /* The first row >= START whose range of displayed characters
28622 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28623 is the row END + 1. */
28624 || (start_charpos
< next_start
28625 && end_charpos
< next_start
)
28626 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28627 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28628 && !next
->ends_at_zv_p
28629 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28630 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28631 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28632 && !next
->ends_at_zv_p
28633 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28640 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28641 but none of the characters it displays are in the range, it is
28643 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28644 struct glyph
*s
= g
;
28645 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28649 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28650 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28651 /* If the buffer position of the first glyph in
28652 the row is equal to END_CHARPOS, it means
28653 the last character to be highlighted is the
28654 newline of ROW, and we must consider NEXT as
28656 || (((!next
->reversed_p
&& g
== s
)
28657 || (next
->reversed_p
&& g
== e
- 1))
28658 && (g
->charpos
== end_charpos
28659 /* Special case for when NEXT is an
28660 empty line at ZV. */
28661 || (g
->charpos
== -1
28662 && !row
->ends_at_zv_p
28663 && next_start
== end_charpos
)))))
28664 /* A glyph that comes from DISP_STRING is by
28665 definition to be highlighted. */
28666 || EQ (g
->object
, disp_string
))
28675 /* The first row that ends at ZV must be the last to be
28677 else if (next
->ends_at_zv_p
)
28686 /* This function sets the mouse_face_* elements of HLINFO, assuming
28687 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28688 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28689 for the overlay or run of text properties specifying the mouse
28690 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28691 before-string and after-string that must also be highlighted.
28692 DISP_STRING, if non-nil, is a display string that may cover some
28693 or all of the highlighted text. */
28696 mouse_face_from_buffer_pos (Lisp_Object window
,
28697 Mouse_HLInfo
*hlinfo
,
28698 ptrdiff_t mouse_charpos
,
28699 ptrdiff_t start_charpos
,
28700 ptrdiff_t end_charpos
,
28701 Lisp_Object before_string
,
28702 Lisp_Object after_string
,
28703 Lisp_Object disp_string
)
28705 struct window
*w
= XWINDOW (window
);
28706 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28707 struct glyph_row
*r1
, *r2
;
28708 struct glyph
*glyph
, *end
;
28709 ptrdiff_t ignore
, pos
;
28712 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28713 eassert (NILP (before_string
) || STRINGP (before_string
));
28714 eassert (NILP (after_string
) || STRINGP (after_string
));
28716 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28717 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
28719 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28720 /* If the before-string or display-string contains newlines,
28721 rows_from_pos_range skips to its last row. Move back. */
28722 if (!NILP (before_string
) || !NILP (disp_string
))
28724 struct glyph_row
*prev
;
28725 while ((prev
= r1
- 1, prev
>= first
)
28726 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
28727 && prev
->used
[TEXT_AREA
] > 0)
28729 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
28730 glyph
= beg
+ prev
->used
[TEXT_AREA
];
28731 while (--glyph
>= beg
&& NILP (glyph
->object
));
28733 || !(EQ (glyph
->object
, before_string
)
28734 || EQ (glyph
->object
, disp_string
)))
28741 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28742 hlinfo
->mouse_face_past_end
= true;
28744 else if (!NILP (after_string
))
28746 /* If the after-string has newlines, advance to its last row. */
28747 struct glyph_row
*next
;
28748 struct glyph_row
*last
28749 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28751 for (next
= r2
+ 1;
28753 && next
->used
[TEXT_AREA
] > 0
28754 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
28758 /* The rest of the display engine assumes that mouse_face_beg_row is
28759 either above mouse_face_end_row or identical to it. But with
28760 bidi-reordered continued lines, the row for START_CHARPOS could
28761 be below the row for END_CHARPOS. If so, swap the rows and store
28762 them in correct order. */
28765 struct glyph_row
*tem
= r2
;
28771 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
28772 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
28774 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28775 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28776 could be anywhere in the row and in any order. The strategy
28777 below is to find the leftmost and the rightmost glyph that
28778 belongs to either of these 3 strings, or whose position is
28779 between START_CHARPOS and END_CHARPOS, and highlight all the
28780 glyphs between those two. This may cover more than just the text
28781 between START_CHARPOS and END_CHARPOS if the range of characters
28782 strides the bidi level boundary, e.g. if the beginning is in R2L
28783 text while the end is in L2R text or vice versa. */
28784 if (!r1
->reversed_p
)
28786 /* This row is in a left to right paragraph. Scan it left to
28788 glyph
= r1
->glyphs
[TEXT_AREA
];
28789 end
= glyph
+ r1
->used
[TEXT_AREA
];
28792 /* Skip truncation glyphs at the start of the glyph row. */
28793 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28795 && NILP (glyph
->object
)
28796 && glyph
->charpos
< 0;
28798 x
+= glyph
->pixel_width
;
28800 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28801 or DISP_STRING, and the first glyph from buffer whose
28802 position is between START_CHARPOS and END_CHARPOS. */
28804 && !NILP (glyph
->object
)
28805 && !EQ (glyph
->object
, disp_string
)
28806 && !(BUFFERP (glyph
->object
)
28807 && (glyph
->charpos
>= start_charpos
28808 && glyph
->charpos
< end_charpos
));
28811 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28812 are present at buffer positions between START_CHARPOS and
28813 END_CHARPOS, or if they come from an overlay. */
28814 if (EQ (glyph
->object
, before_string
))
28816 pos
= string_buffer_position (before_string
,
28818 /* If pos == 0, it means before_string came from an
28819 overlay, not from a buffer position. */
28820 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28823 else if (EQ (glyph
->object
, after_string
))
28825 pos
= string_buffer_position (after_string
, end_charpos
);
28826 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28829 x
+= glyph
->pixel_width
;
28831 hlinfo
->mouse_face_beg_x
= x
;
28832 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28836 /* This row is in a right to left paragraph. Scan it right to
28840 end
= r1
->glyphs
[TEXT_AREA
] - 1;
28841 glyph
= end
+ r1
->used
[TEXT_AREA
];
28843 /* Skip truncation glyphs at the start of the glyph row. */
28844 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28846 && NILP (glyph
->object
)
28847 && glyph
->charpos
< 0;
28851 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28852 or DISP_STRING, and the first glyph from buffer whose
28853 position is between START_CHARPOS and END_CHARPOS. */
28855 && !NILP (glyph
->object
)
28856 && !EQ (glyph
->object
, disp_string
)
28857 && !(BUFFERP (glyph
->object
)
28858 && (glyph
->charpos
>= start_charpos
28859 && glyph
->charpos
< end_charpos
));
28862 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28863 are present at buffer positions between START_CHARPOS and
28864 END_CHARPOS, or if they come from an overlay. */
28865 if (EQ (glyph
->object
, before_string
))
28867 pos
= string_buffer_position (before_string
, start_charpos
);
28868 /* If pos == 0, it means before_string came from an
28869 overlay, not from a buffer position. */
28870 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28873 else if (EQ (glyph
->object
, after_string
))
28875 pos
= string_buffer_position (after_string
, end_charpos
);
28876 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28881 glyph
++; /* first glyph to the right of the highlighted area */
28882 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
28883 x
+= g
->pixel_width
;
28884 hlinfo
->mouse_face_beg_x
= x
;
28885 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28888 /* If the highlight ends in a different row, compute GLYPH and END
28889 for the end row. Otherwise, reuse the values computed above for
28890 the row where the highlight begins. */
28893 if (!r2
->reversed_p
)
28895 glyph
= r2
->glyphs
[TEXT_AREA
];
28896 end
= glyph
+ r2
->used
[TEXT_AREA
];
28901 end
= r2
->glyphs
[TEXT_AREA
] - 1;
28902 glyph
= end
+ r2
->used
[TEXT_AREA
];
28906 if (!r2
->reversed_p
)
28908 /* Skip truncation and continuation glyphs near the end of the
28909 row, and also blanks and stretch glyphs inserted by
28910 extend_face_to_end_of_line. */
28912 && NILP ((end
- 1)->object
))
28914 /* Scan the rest of the glyph row from the end, looking for the
28915 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28916 DISP_STRING, or whose position is between START_CHARPOS
28920 && !NILP (end
->object
)
28921 && !EQ (end
->object
, disp_string
)
28922 && !(BUFFERP (end
->object
)
28923 && (end
->charpos
>= start_charpos
28924 && end
->charpos
< end_charpos
));
28927 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28928 are present at buffer positions between START_CHARPOS and
28929 END_CHARPOS, or if they come from an overlay. */
28930 if (EQ (end
->object
, before_string
))
28932 pos
= string_buffer_position (before_string
, start_charpos
);
28933 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28936 else if (EQ (end
->object
, after_string
))
28938 pos
= string_buffer_position (after_string
, end_charpos
);
28939 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28943 /* Find the X coordinate of the last glyph to be highlighted. */
28944 for (; glyph
<= end
; ++glyph
)
28945 x
+= glyph
->pixel_width
;
28947 hlinfo
->mouse_face_end_x
= x
;
28948 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28952 /* Skip truncation and continuation glyphs near the end of the
28953 row, and also blanks and stretch glyphs inserted by
28954 extend_face_to_end_of_line. */
28958 && NILP (end
->object
))
28960 x
+= end
->pixel_width
;
28963 /* Scan the rest of the glyph row from the end, looking for the
28964 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28965 DISP_STRING, or whose position is between START_CHARPOS
28969 && !NILP (end
->object
)
28970 && !EQ (end
->object
, disp_string
)
28971 && !(BUFFERP (end
->object
)
28972 && (end
->charpos
>= start_charpos
28973 && end
->charpos
< end_charpos
));
28976 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28977 are present at buffer positions between START_CHARPOS and
28978 END_CHARPOS, or if they come from an overlay. */
28979 if (EQ (end
->object
, before_string
))
28981 pos
= string_buffer_position (before_string
, start_charpos
);
28982 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28985 else if (EQ (end
->object
, after_string
))
28987 pos
= string_buffer_position (after_string
, end_charpos
);
28988 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28991 x
+= end
->pixel_width
;
28993 /* If we exited the above loop because we arrived at the last
28994 glyph of the row, and its buffer position is still not in
28995 range, it means the last character in range is the preceding
28996 newline. Bump the end column and x values to get past the
28999 && BUFFERP (end
->object
)
29000 && (end
->charpos
< start_charpos
29001 || end
->charpos
>= end_charpos
))
29003 x
+= end
->pixel_width
;
29006 hlinfo
->mouse_face_end_x
= x
;
29007 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
29010 hlinfo
->mouse_face_window
= window
;
29011 hlinfo
->mouse_face_face_id
29012 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
29014 !hlinfo
->mouse_face_hidden
, -1);
29015 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29018 /* The following function is not used anymore (replaced with
29019 mouse_face_from_string_pos), but I leave it here for the time
29020 being, in case someone would. */
29022 #if false /* not used */
29024 /* Find the position of the glyph for position POS in OBJECT in
29025 window W's current matrix, and return in *X, *Y the pixel
29026 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
29028 RIGHT_P means return the position of the right edge of the glyph.
29029 !RIGHT_P means return the left edge position.
29031 If no glyph for POS exists in the matrix, return the position of
29032 the glyph with the next smaller position that is in the matrix, if
29033 RIGHT_P is false. If RIGHT_P, and no glyph for POS
29034 exists in the matrix, return the position of the glyph with the
29035 next larger position in OBJECT.
29037 Value is true if a glyph was found. */
29040 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
29041 int *hpos
, int *vpos
, int *x
, int *y
, bool right_p
)
29043 int yb
= window_text_bottom_y (w
);
29044 struct glyph_row
*r
;
29045 struct glyph
*best_glyph
= NULL
;
29046 struct glyph_row
*best_row
= NULL
;
29049 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
29050 r
->enabled_p
&& r
->y
< yb
;
29053 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
29054 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
29057 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
29058 if (EQ (g
->object
, object
))
29060 if (g
->charpos
== pos
)
29067 else if (best_glyph
== NULL
29068 || ((eabs (g
->charpos
- pos
)
29069 < eabs (best_glyph
->charpos
- pos
))
29072 : g
->charpos
> pos
)))
29086 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
29090 *x
+= best_glyph
->pixel_width
;
29095 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
29098 return best_glyph
!= NULL
;
29100 #endif /* not used */
29102 /* Find the positions of the first and the last glyphs in window W's
29103 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
29104 (assumed to be a string), and return in HLINFO's mouse_face_*
29105 members the pixel and column/row coordinates of those glyphs. */
29108 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
29109 Lisp_Object object
,
29110 ptrdiff_t startpos
, ptrdiff_t endpos
)
29112 int yb
= window_text_bottom_y (w
);
29113 struct glyph_row
*r
;
29114 struct glyph
*g
, *e
;
29116 bool found
= false;
29118 /* Find the glyph row with at least one position in the range
29119 [STARTPOS..ENDPOS), and the first glyph in that row whose
29120 position belongs to that range. */
29121 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
29122 r
->enabled_p
&& r
->y
< yb
;
29125 if (!r
->reversed_p
)
29127 g
= r
->glyphs
[TEXT_AREA
];
29128 e
= g
+ r
->used
[TEXT_AREA
];
29129 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
29130 if (EQ (g
->object
, object
)
29131 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29133 hlinfo
->mouse_face_beg_row
29134 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29135 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29136 hlinfo
->mouse_face_beg_x
= gx
;
29145 e
= r
->glyphs
[TEXT_AREA
];
29146 g
= e
+ r
->used
[TEXT_AREA
];
29147 for ( ; g
> e
; --g
)
29148 if (EQ ((g
-1)->object
, object
)
29149 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
29151 hlinfo
->mouse_face_beg_row
29152 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29153 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29154 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
29155 gx
+= g1
->pixel_width
;
29156 hlinfo
->mouse_face_beg_x
= gx
;
29168 /* Starting with the next row, look for the first row which does NOT
29169 include any glyphs whose positions are in the range. */
29170 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
29172 g
= r
->glyphs
[TEXT_AREA
];
29173 e
= g
+ r
->used
[TEXT_AREA
];
29175 for ( ; g
< e
; ++g
)
29176 if (EQ (g
->object
, object
)
29177 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29186 /* The highlighted region ends on the previous row. */
29189 /* Set the end row. */
29190 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29192 /* Compute and set the end column and the end column's horizontal
29193 pixel coordinate. */
29194 if (!r
->reversed_p
)
29196 g
= r
->glyphs
[TEXT_AREA
];
29197 e
= g
+ r
->used
[TEXT_AREA
];
29198 for ( ; e
> g
; --e
)
29199 if (EQ ((e
-1)->object
, object
)
29200 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
29202 hlinfo
->mouse_face_end_col
= e
- g
;
29204 for (gx
= r
->x
; g
< e
; ++g
)
29205 gx
+= g
->pixel_width
;
29206 hlinfo
->mouse_face_end_x
= gx
;
29210 e
= r
->glyphs
[TEXT_AREA
];
29211 g
= e
+ r
->used
[TEXT_AREA
];
29212 for (gx
= r
->x
; e
< g
; ++e
)
29214 if (EQ (e
->object
, object
)
29215 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
29217 gx
+= e
->pixel_width
;
29219 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
29220 hlinfo
->mouse_face_end_x
= gx
;
29224 #ifdef HAVE_WINDOW_SYSTEM
29226 /* See if position X, Y is within a hot-spot of an image. */
29229 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
29231 if (!CONSP (hot_spot
))
29234 if (EQ (XCAR (hot_spot
), Qrect
))
29236 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
29237 Lisp_Object rect
= XCDR (hot_spot
);
29241 if (!CONSP (XCAR (rect
)))
29243 if (!CONSP (XCDR (rect
)))
29245 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
29247 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
29249 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
29251 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
29255 else if (EQ (XCAR (hot_spot
), Qcircle
))
29257 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
29258 Lisp_Object circ
= XCDR (hot_spot
);
29259 Lisp_Object lr
, lx0
, ly0
;
29261 && CONSP (XCAR (circ
))
29262 && (lr
= XCDR (circ
), NUMBERP (lr
))
29263 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
29264 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
29266 double r
= XFLOATINT (lr
);
29267 double dx
= XINT (lx0
) - x
;
29268 double dy
= XINT (ly0
) - y
;
29269 return (dx
* dx
+ dy
* dy
<= r
* r
);
29272 else if (EQ (XCAR (hot_spot
), Qpoly
))
29274 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
29275 if (VECTORP (XCDR (hot_spot
)))
29277 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
29278 Lisp_Object
*poly
= v
->contents
;
29279 ptrdiff_t n
= v
->header
.size
;
29281 bool inside
= false;
29282 Lisp_Object lx
, ly
;
29285 /* Need an even number of coordinates, and at least 3 edges. */
29286 if (n
< 6 || n
& 1)
29289 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
29290 If count is odd, we are inside polygon. Pixels on edges
29291 may or may not be included depending on actual geometry of the
29293 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
29294 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
29296 x0
= XINT (lx
), y0
= XINT (ly
);
29297 for (i
= 0; i
< n
; i
+= 2)
29299 int x1
= x0
, y1
= y0
;
29300 if ((lx
= poly
[i
], !INTEGERP (lx
))
29301 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
29303 x0
= XINT (lx
), y0
= XINT (ly
);
29305 /* Does this segment cross the X line? */
29313 if (y
> y0
&& y
> y1
)
29315 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
29325 find_hot_spot (Lisp_Object map
, int x
, int y
)
29327 while (CONSP (map
))
29329 if (CONSP (XCAR (map
))
29330 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
29338 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
29340 doc
: /* Lookup in image map MAP coordinates X and Y.
29341 An image map is an alist where each element has the format (AREA ID PLIST).
29342 An AREA is specified as either a rectangle, a circle, or a polygon:
29343 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
29344 pixel coordinates of the upper left and bottom right corners.
29345 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
29346 and the radius of the circle; r may be a float or integer.
29347 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
29348 vector describes one corner in the polygon.
29349 Returns the alist element for the first matching AREA in MAP. */)
29350 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
29358 return find_hot_spot (map
,
29359 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
29360 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
29364 /* Display frame CURSOR, optionally using shape defined by POINTER. */
29366 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
29368 /* Do not change cursor shape while dragging mouse. */
29369 if (EQ (do_mouse_tracking
, Qdragging
))
29372 if (!NILP (pointer
))
29374 if (EQ (pointer
, Qarrow
))
29375 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29376 else if (EQ (pointer
, Qhand
))
29377 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
29378 else if (EQ (pointer
, Qtext
))
29379 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29380 else if (EQ (pointer
, intern ("hdrag")))
29381 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29382 else if (EQ (pointer
, intern ("nhdrag")))
29383 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29384 #ifdef HAVE_X_WINDOWS
29385 else if (EQ (pointer
, intern ("vdrag")))
29386 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29388 else if (EQ (pointer
, intern ("hourglass")))
29389 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
29390 else if (EQ (pointer
, Qmodeline
))
29391 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
29393 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29396 if (cursor
!= No_Cursor
)
29397 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
29400 #endif /* HAVE_WINDOW_SYSTEM */
29402 /* Take proper action when mouse has moved to the mode or header line
29403 or marginal area AREA of window W, x-position X and y-position Y.
29404 X is relative to the start of the text display area of W, so the
29405 width of bitmap areas and scroll bars must be subtracted to get a
29406 position relative to the start of the mode line. */
29409 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
29410 enum window_part area
)
29412 struct window
*w
= XWINDOW (window
);
29413 struct frame
*f
= XFRAME (w
->frame
);
29414 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29415 #ifdef HAVE_WINDOW_SYSTEM
29416 Display_Info
*dpyinfo
;
29418 Cursor cursor
= No_Cursor
;
29419 Lisp_Object pointer
= Qnil
;
29420 int dx
, dy
, width
, height
;
29422 Lisp_Object string
, object
= Qnil
;
29423 Lisp_Object pos
IF_LINT (= Qnil
), help
;
29425 Lisp_Object mouse_face
;
29426 int original_x_pixel
= x
;
29427 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
29428 struct glyph_row
*row
IF_LINT (= 0);
29430 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
29435 /* Kludge alert: mode_line_string takes X/Y in pixels, but
29436 returns them in row/column units! */
29437 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
29438 &object
, &dx
, &dy
, &width
, &height
);
29440 row
= (area
== ON_MODE_LINE
29441 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
29442 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
29444 /* Find the glyph under the mouse pointer. */
29445 if (row
->mode_line_p
&& row
->enabled_p
)
29447 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
29448 end
= glyph
+ row
->used
[TEXT_AREA
];
29450 for (x0
= original_x_pixel
;
29451 glyph
< end
&& x0
>= glyph
->pixel_width
;
29453 x0
-= glyph
->pixel_width
;
29461 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
29462 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
29463 returns them in row/column units! */
29464 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
29465 &object
, &dx
, &dy
, &width
, &height
);
29470 #ifdef HAVE_WINDOW_SYSTEM
29471 if (IMAGEP (object
))
29473 Lisp_Object image_map
, hotspot
;
29474 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
29476 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
29478 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29482 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
29483 If so, we could look for mouse-enter, mouse-leave
29484 properties in PLIST (and do something...). */
29485 hotspot
= XCDR (hotspot
);
29486 if (CONSP (hotspot
)
29487 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29489 pointer
= Fplist_get (plist
, Qpointer
);
29490 if (NILP (pointer
))
29492 help
= Fplist_get (plist
, Qhelp_echo
);
29495 help_echo_string
= help
;
29496 XSETWINDOW (help_echo_window
, w
);
29497 help_echo_object
= w
->contents
;
29498 help_echo_pos
= charpos
;
29502 if (NILP (pointer
))
29503 pointer
= Fplist_get (XCDR (object
), QCpointer
);
29505 #endif /* HAVE_WINDOW_SYSTEM */
29507 if (STRINGP (string
))
29508 pos
= make_number (charpos
);
29510 /* Set the help text and mouse pointer. If the mouse is on a part
29511 of the mode line without any text (e.g. past the right edge of
29512 the mode line text), use the default help text and pointer. */
29513 if (STRINGP (string
) || area
== ON_MODE_LINE
)
29515 /* Arrange to display the help by setting the global variables
29516 help_echo_string, help_echo_object, and help_echo_pos. */
29519 if (STRINGP (string
))
29520 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
29524 help_echo_string
= help
;
29525 XSETWINDOW (help_echo_window
, w
);
29526 help_echo_object
= string
;
29527 help_echo_pos
= charpos
;
29529 else if (area
== ON_MODE_LINE
)
29531 Lisp_Object default_help
29532 = buffer_local_value (Qmode_line_default_help_echo
,
29535 if (STRINGP (default_help
))
29537 help_echo_string
= default_help
;
29538 XSETWINDOW (help_echo_window
, w
);
29539 help_echo_object
= Qnil
;
29540 help_echo_pos
= -1;
29545 #ifdef HAVE_WINDOW_SYSTEM
29546 /* Change the mouse pointer according to what is under it. */
29547 if (FRAME_WINDOW_P (f
))
29549 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
29551 || NILP (Vresize_mini_windows
));
29553 dpyinfo
= FRAME_DISPLAY_INFO (f
);
29554 if (STRINGP (string
))
29556 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29558 if (NILP (pointer
))
29559 pointer
= Fget_text_property (pos
, Qpointer
, string
);
29561 /* Change the mouse pointer according to what is under X/Y. */
29563 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
29566 map
= Fget_text_property (pos
, Qlocal_map
, string
);
29567 if (!KEYMAPP (map
))
29568 map
= Fget_text_property (pos
, Qkeymap
, string
);
29569 if (!KEYMAPP (map
) && draggable
)
29570 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
29573 else if (draggable
)
29574 /* Default mode-line pointer. */
29575 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29580 /* Change the mouse face according to what is under X/Y. */
29581 bool mouse_face_shown
= false;
29582 if (STRINGP (string
))
29584 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
29585 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
29586 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29591 struct glyph
* tmp_glyph
;
29595 int total_pixel_width
;
29596 ptrdiff_t begpos
, endpos
, ignore
;
29600 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
29601 Qmouse_face
, string
, Qnil
);
29607 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
29609 endpos
= SCHARS (string
);
29613 /* Calculate the glyph position GPOS of GLYPH in the
29614 displayed string, relative to the beginning of the
29615 highlighted part of the string.
29617 Note: GPOS is different from CHARPOS. CHARPOS is the
29618 position of GLYPH in the internal string object. A mode
29619 line string format has structures which are converted to
29620 a flattened string by the Emacs Lisp interpreter. The
29621 internal string is an element of those structures. The
29622 displayed string is the flattened string. */
29623 tmp_glyph
= row_start_glyph
;
29624 while (tmp_glyph
< glyph
29625 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29626 && begpos
<= tmp_glyph
->charpos
29627 && tmp_glyph
->charpos
< endpos
)))
29629 gpos
= glyph
- tmp_glyph
;
29631 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29632 the highlighted part of the displayed string to which
29633 GLYPH belongs. Note: GSEQ_LENGTH is different from
29634 SCHARS (STRING), because the latter returns the length of
29635 the internal string. */
29636 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29638 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29639 && begpos
<= tmp_glyph
->charpos
29640 && tmp_glyph
->charpos
< endpos
));
29643 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29645 /* Calculate the total pixel width of all the glyphs between
29646 the beginning of the highlighted area and GLYPH. */
29647 total_pixel_width
= 0;
29648 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29649 total_pixel_width
+= tmp_glyph
->pixel_width
;
29651 /* Pre calculation of re-rendering position. Note: X is in
29652 column units here, after the call to mode_line_string or
29653 marginal_area_string. */
29655 vpos
= (area
== ON_MODE_LINE
29656 ? (w
->current_matrix
)->nrows
- 1
29659 /* If GLYPH's position is included in the region that is
29660 already drawn in mouse face, we have nothing to do. */
29661 if ( EQ (window
, hlinfo
->mouse_face_window
)
29662 && (!row
->reversed_p
29663 ? (hlinfo
->mouse_face_beg_col
<= hpos
29664 && hpos
< hlinfo
->mouse_face_end_col
)
29665 /* In R2L rows we swap BEG and END, see below. */
29666 : (hlinfo
->mouse_face_end_col
<= hpos
29667 && hpos
< hlinfo
->mouse_face_beg_col
))
29668 && hlinfo
->mouse_face_beg_row
== vpos
)
29671 if (clear_mouse_face (hlinfo
))
29672 cursor
= No_Cursor
;
29674 if (!row
->reversed_p
)
29676 hlinfo
->mouse_face_beg_col
= hpos
;
29677 hlinfo
->mouse_face_beg_x
= original_x_pixel
29678 - (total_pixel_width
+ dx
);
29679 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29680 hlinfo
->mouse_face_end_x
= 0;
29684 /* In R2L rows, show_mouse_face expects BEG and END
29685 coordinates to be swapped. */
29686 hlinfo
->mouse_face_end_col
= hpos
;
29687 hlinfo
->mouse_face_end_x
= original_x_pixel
29688 - (total_pixel_width
+ dx
);
29689 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29690 hlinfo
->mouse_face_beg_x
= 0;
29693 hlinfo
->mouse_face_beg_row
= vpos
;
29694 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29695 hlinfo
->mouse_face_past_end
= false;
29696 hlinfo
->mouse_face_window
= window
;
29698 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29703 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29704 mouse_face_shown
= true;
29706 if (NILP (pointer
))
29711 /* If mouse-face doesn't need to be shown, clear any existing
29713 if ((area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
) && !mouse_face_shown
)
29714 clear_mouse_face (hlinfo
);
29716 #ifdef HAVE_WINDOW_SYSTEM
29717 if (FRAME_WINDOW_P (f
))
29718 define_frame_cursor1 (f
, cursor
, pointer
);
29724 Take proper action when the mouse has moved to position X, Y on
29725 frame F with regards to highlighting portions of display that have
29726 mouse-face properties. Also de-highlight portions of display where
29727 the mouse was before, set the mouse pointer shape as appropriate
29728 for the mouse coordinates, and activate help echo (tooltips).
29729 X and Y can be negative or out of range. */
29732 note_mouse_highlight (struct frame
*f
, int x
, int y
)
29734 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29735 enum window_part part
= ON_NOTHING
;
29736 Lisp_Object window
;
29738 Cursor cursor
= No_Cursor
;
29739 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
29742 /* When a menu is active, don't highlight because this looks odd. */
29743 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29744 if (popup_activated ())
29748 if (!f
->glyphs_initialized_p
29749 || f
->pointer_invisible
)
29752 hlinfo
->mouse_face_mouse_x
= x
;
29753 hlinfo
->mouse_face_mouse_y
= y
;
29754 hlinfo
->mouse_face_mouse_frame
= f
;
29756 if (hlinfo
->mouse_face_defer
)
29759 /* Which window is that in? */
29760 window
= window_from_coordinates (f
, x
, y
, &part
, true);
29762 /* If displaying active text in another window, clear that. */
29763 if (! EQ (window
, hlinfo
->mouse_face_window
)
29764 /* Also clear if we move out of text area in same window. */
29765 || (!NILP (hlinfo
->mouse_face_window
)
29768 && part
!= ON_MODE_LINE
29769 && part
!= ON_HEADER_LINE
))
29770 clear_mouse_face (hlinfo
);
29772 /* Not on a window -> return. */
29773 if (!WINDOWP (window
))
29776 /* Reset help_echo_string. It will get recomputed below. */
29777 help_echo_string
= Qnil
;
29779 /* Convert to window-relative pixel coordinates. */
29780 w
= XWINDOW (window
);
29781 frame_to_window_pixel_xy (w
, &x
, &y
);
29783 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29784 /* Handle tool-bar window differently since it doesn't display a
29786 if (EQ (window
, f
->tool_bar_window
))
29788 note_tool_bar_highlight (f
, x
, y
);
29793 /* Mouse is on the mode, header line or margin? */
29794 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
29795 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29797 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
29799 #ifdef HAVE_WINDOW_SYSTEM
29800 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29802 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29803 /* Show non-text cursor (Bug#16647). */
29811 #ifdef HAVE_WINDOW_SYSTEM
29812 if (part
== ON_VERTICAL_BORDER
)
29814 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29815 help_echo_string
= build_string ("drag-mouse-1: resize");
29817 else if (part
== ON_RIGHT_DIVIDER
)
29819 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29820 help_echo_string
= build_string ("drag-mouse-1: resize");
29822 else if (part
== ON_BOTTOM_DIVIDER
)
29823 if (! WINDOW_BOTTOMMOST_P (w
)
29825 || NILP (Vresize_mini_windows
))
29827 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29828 help_echo_string
= build_string ("drag-mouse-1: resize");
29831 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29832 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
29833 || part
== ON_VERTICAL_SCROLL_BAR
29834 || part
== ON_HORIZONTAL_SCROLL_BAR
)
29835 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29837 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29840 /* Are we in a window whose display is up to date?
29841 And verify the buffer's text has not changed. */
29842 b
= XBUFFER (w
->contents
);
29843 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
29845 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
29847 struct glyph
*glyph
;
29848 Lisp_Object object
;
29849 Lisp_Object mouse_face
= Qnil
, position
;
29850 Lisp_Object
*overlay_vec
= NULL
;
29851 ptrdiff_t i
, noverlays
;
29852 struct buffer
*obuf
;
29853 ptrdiff_t obegv
, ozv
;
29856 /* Find the glyph under X/Y. */
29857 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
29859 #ifdef HAVE_WINDOW_SYSTEM
29860 /* Look for :pointer property on image. */
29861 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
29863 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
29864 if (img
!= NULL
&& IMAGEP (img
->spec
))
29866 Lisp_Object image_map
, hotspot
;
29867 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
29869 && (hotspot
= find_hot_spot (image_map
,
29870 glyph
->slice
.img
.x
+ dx
,
29871 glyph
->slice
.img
.y
+ dy
),
29873 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29877 /* Could check XCAR (hotspot) to see if we enter/leave
29879 If so, we could look for mouse-enter, mouse-leave
29880 properties in PLIST (and do something...). */
29881 hotspot
= XCDR (hotspot
);
29882 if (CONSP (hotspot
)
29883 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29885 pointer
= Fplist_get (plist
, Qpointer
);
29886 if (NILP (pointer
))
29888 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
29889 if (!NILP (help_echo_string
))
29891 help_echo_window
= window
;
29892 help_echo_object
= glyph
->object
;
29893 help_echo_pos
= glyph
->charpos
;
29897 if (NILP (pointer
))
29898 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
29901 #endif /* HAVE_WINDOW_SYSTEM */
29903 /* Clear mouse face if X/Y not over text. */
29905 || area
!= TEXT_AREA
29906 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
29907 /* Glyph's OBJECT is nil for glyphs inserted by the
29908 display engine for its internal purposes, like truncation
29909 and continuation glyphs and blanks beyond the end of
29910 line's text on text terminals. If we are over such a
29911 glyph, we are not over any text. */
29912 || NILP (glyph
->object
)
29913 /* R2L rows have a stretch glyph at their front, which
29914 stands for no text, whereas L2R rows have no glyphs at
29915 all beyond the end of text. Treat such stretch glyphs
29916 like we do with NULL glyphs in L2R rows. */
29917 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
29918 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
29919 && glyph
->type
== STRETCH_GLYPH
29920 && glyph
->avoid_cursor_p
))
29922 if (clear_mouse_face (hlinfo
))
29923 cursor
= No_Cursor
;
29924 #ifdef HAVE_WINDOW_SYSTEM
29925 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29927 if (area
!= TEXT_AREA
)
29928 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29930 pointer
= Vvoid_text_area_pointer
;
29936 pos
= glyph
->charpos
;
29937 object
= glyph
->object
;
29938 if (!STRINGP (object
) && !BUFFERP (object
))
29941 /* If we get an out-of-range value, return now; avoid an error. */
29942 if (BUFFERP (object
) && pos
> BUF_Z (b
))
29945 /* Make the window's buffer temporarily current for
29946 overlays_at and compute_char_face. */
29947 obuf
= current_buffer
;
29948 current_buffer
= b
;
29954 /* Is this char mouse-active or does it have help-echo? */
29955 position
= make_number (pos
);
29959 if (BUFFERP (object
))
29961 /* Put all the overlays we want in a vector in overlay_vec. */
29962 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, false);
29963 /* Sort overlays into increasing priority order. */
29964 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29969 if (NILP (Vmouse_highlight
))
29971 clear_mouse_face (hlinfo
);
29972 goto check_help_echo
;
29975 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29978 cursor
= No_Cursor
;
29980 /* Check mouse-face highlighting. */
29982 /* If there exists an overlay with mouse-face overlapping
29983 the one we are currently highlighting, we have to
29984 check if we enter the overlapping overlay, and then
29985 highlight only that. */
29986 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29987 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29989 /* Find the highest priority overlay with a mouse-face. */
29990 Lisp_Object overlay
= Qnil
;
29991 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29993 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29994 if (!NILP (mouse_face
))
29995 overlay
= overlay_vec
[i
];
29998 /* If we're highlighting the same overlay as before, there's
29999 no need to do that again. */
30000 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
30001 goto check_help_echo
;
30002 hlinfo
->mouse_face_overlay
= overlay
;
30004 /* Clear the display of the old active region, if any. */
30005 if (clear_mouse_face (hlinfo
))
30006 cursor
= No_Cursor
;
30008 /* If no overlay applies, get a text property. */
30009 if (NILP (overlay
))
30010 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
30012 /* Next, compute the bounds of the mouse highlighting and
30014 if (!NILP (mouse_face
) && STRINGP (object
))
30016 /* The mouse-highlighting comes from a display string
30017 with a mouse-face. */
30021 s
= Fprevious_single_property_change
30022 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
30023 e
= Fnext_single_property_change
30024 (position
, Qmouse_face
, object
, Qnil
);
30026 s
= make_number (0);
30028 e
= make_number (SCHARS (object
));
30029 mouse_face_from_string_pos (w
, hlinfo
, object
,
30030 XINT (s
), XINT (e
));
30031 hlinfo
->mouse_face_past_end
= false;
30032 hlinfo
->mouse_face_window
= window
;
30033 hlinfo
->mouse_face_face_id
30034 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
30035 glyph
->face_id
, true);
30036 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
30037 cursor
= No_Cursor
;
30041 /* The mouse-highlighting, if any, comes from an overlay
30042 or text property in the buffer. */
30043 Lisp_Object buffer
IF_LINT (= Qnil
);
30044 Lisp_Object disp_string
IF_LINT (= Qnil
);
30046 if (STRINGP (object
))
30048 /* If we are on a display string with no mouse-face,
30049 check if the text under it has one. */
30050 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
30051 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30052 pos
= string_buffer_position (object
, start
);
30055 mouse_face
= get_char_property_and_overlay
30056 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
30057 buffer
= w
->contents
;
30058 disp_string
= object
;
30064 disp_string
= Qnil
;
30067 if (!NILP (mouse_face
))
30069 Lisp_Object before
, after
;
30070 Lisp_Object before_string
, after_string
;
30071 /* To correctly find the limits of mouse highlight
30072 in a bidi-reordered buffer, we must not use the
30073 optimization of limiting the search in
30074 previous-single-property-change and
30075 next-single-property-change, because
30076 rows_from_pos_range needs the real start and end
30077 positions to DTRT in this case. That's because
30078 the first row visible in a window does not
30079 necessarily display the character whose position
30080 is the smallest. */
30082 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
30083 ? Fmarker_position (w
->start
)
30086 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
30087 ? make_number (BUF_Z (XBUFFER (buffer
))
30088 - w
->window_end_pos
)
30091 if (NILP (overlay
))
30093 /* Handle the text property case. */
30094 before
= Fprevious_single_property_change
30095 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
30096 after
= Fnext_single_property_change
30097 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
30098 before_string
= after_string
= Qnil
;
30102 /* Handle the overlay case. */
30103 before
= Foverlay_start (overlay
);
30104 after
= Foverlay_end (overlay
);
30105 before_string
= Foverlay_get (overlay
, Qbefore_string
);
30106 after_string
= Foverlay_get (overlay
, Qafter_string
);
30108 if (!STRINGP (before_string
)) before_string
= Qnil
;
30109 if (!STRINGP (after_string
)) after_string
= Qnil
;
30112 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
30115 : XFASTINT (before
),
30117 ? BUF_Z (XBUFFER (buffer
))
30118 : XFASTINT (after
),
30119 before_string
, after_string
,
30121 cursor
= No_Cursor
;
30128 /* Look for a `help-echo' property. */
30129 if (NILP (help_echo_string
)) {
30130 Lisp_Object help
, overlay
;
30132 /* Check overlays first. */
30133 help
= overlay
= Qnil
;
30134 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
30136 overlay
= overlay_vec
[i
];
30137 help
= Foverlay_get (overlay
, Qhelp_echo
);
30142 help_echo_string
= help
;
30143 help_echo_window
= window
;
30144 help_echo_object
= overlay
;
30145 help_echo_pos
= pos
;
30149 Lisp_Object obj
= glyph
->object
;
30150 ptrdiff_t charpos
= glyph
->charpos
;
30152 /* Try text properties. */
30155 && charpos
< SCHARS (obj
))
30157 help
= Fget_text_property (make_number (charpos
),
30161 /* If the string itself doesn't specify a help-echo,
30162 see if the buffer text ``under'' it does. */
30163 struct glyph_row
*r
30164 = MATRIX_ROW (w
->current_matrix
, vpos
);
30165 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30166 ptrdiff_t p
= string_buffer_position (obj
, start
);
30169 help
= Fget_char_property (make_number (p
),
30170 Qhelp_echo
, w
->contents
);
30179 else if (BUFFERP (obj
)
30182 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
30187 help_echo_string
= help
;
30188 help_echo_window
= window
;
30189 help_echo_object
= obj
;
30190 help_echo_pos
= charpos
;
30195 #ifdef HAVE_WINDOW_SYSTEM
30196 /* Look for a `pointer' property. */
30197 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30199 /* Check overlays first. */
30200 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
30201 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
30203 if (NILP (pointer
))
30205 Lisp_Object obj
= glyph
->object
;
30206 ptrdiff_t charpos
= glyph
->charpos
;
30208 /* Try text properties. */
30211 && charpos
< SCHARS (obj
))
30213 pointer
= Fget_text_property (make_number (charpos
),
30215 if (NILP (pointer
))
30217 /* If the string itself doesn't specify a pointer,
30218 see if the buffer text ``under'' it does. */
30219 struct glyph_row
*r
30220 = MATRIX_ROW (w
->current_matrix
, vpos
);
30221 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30222 ptrdiff_t p
= string_buffer_position (obj
, start
);
30224 pointer
= Fget_char_property (make_number (p
),
30225 Qpointer
, w
->contents
);
30228 else if (BUFFERP (obj
)
30231 pointer
= Fget_text_property (make_number (charpos
),
30235 #endif /* HAVE_WINDOW_SYSTEM */
30239 current_buffer
= obuf
;
30245 #ifdef HAVE_WINDOW_SYSTEM
30246 if (FRAME_WINDOW_P (f
))
30247 define_frame_cursor1 (f
, cursor
, pointer
);
30249 /* This is here to prevent a compiler error, about "label at end of
30250 compound statement". */
30257 Clear any mouse-face on window W. This function is part of the
30258 redisplay interface, and is called from try_window_id and similar
30259 functions to ensure the mouse-highlight is off. */
30262 x_clear_window_mouse_face (struct window
*w
)
30264 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
30265 Lisp_Object window
;
30268 XSETWINDOW (window
, w
);
30269 if (EQ (window
, hlinfo
->mouse_face_window
))
30270 clear_mouse_face (hlinfo
);
30276 Just discard the mouse face information for frame F, if any.
30277 This is used when the size of F is changed. */
30280 cancel_mouse_face (struct frame
*f
)
30282 Lisp_Object window
;
30283 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30285 window
= hlinfo
->mouse_face_window
;
30286 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
30287 reset_mouse_highlight (hlinfo
);
30292 /***********************************************************************
30294 ***********************************************************************/
30296 #ifdef HAVE_WINDOW_SYSTEM
30298 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
30299 which intersects rectangle R. R is in window-relative coordinates. */
30302 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
30303 enum glyph_row_area area
)
30305 struct glyph
*first
= row
->glyphs
[area
];
30306 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
30307 struct glyph
*last
;
30308 int first_x
, start_x
, x
;
30310 if (area
== TEXT_AREA
&& row
->fill_line_p
)
30311 /* If row extends face to end of line write the whole line. */
30312 draw_glyphs (w
, 0, row
, area
,
30313 0, row
->used
[area
],
30314 DRAW_NORMAL_TEXT
, 0);
30317 /* Set START_X to the window-relative start position for drawing glyphs of
30318 AREA. The first glyph of the text area can be partially visible.
30319 The first glyphs of other areas cannot. */
30320 start_x
= window_box_left_offset (w
, area
);
30322 if (area
== TEXT_AREA
)
30325 /* Find the first glyph that must be redrawn. */
30327 && x
+ first
->pixel_width
< r
->x
)
30329 x
+= first
->pixel_width
;
30333 /* Find the last one. */
30336 /* Use a signed int intermediate value to avoid catastrophic
30337 failures due to comparison between signed and unsigned, when
30338 x is negative (can happen for wide images that are hscrolled). */
30339 int r_end
= r
->x
+ r
->width
;
30340 while (last
< end
&& x
< r_end
)
30342 x
+= last
->pixel_width
;
30348 draw_glyphs (w
, first_x
- start_x
, row
, area
,
30349 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
30350 DRAW_NORMAL_TEXT
, 0);
30355 /* Redraw the parts of the glyph row ROW on window W intersecting
30356 rectangle R. R is in window-relative coordinates. Value is
30357 true if mouse-face was overwritten. */
30360 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
30362 eassert (row
->enabled_p
);
30364 if (row
->mode_line_p
|| w
->pseudo_window_p
)
30365 draw_glyphs (w
, 0, row
, TEXT_AREA
,
30366 0, row
->used
[TEXT_AREA
],
30367 DRAW_NORMAL_TEXT
, 0);
30370 if (row
->used
[LEFT_MARGIN_AREA
])
30371 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
30372 if (row
->used
[TEXT_AREA
])
30373 expose_area (w
, row
, r
, TEXT_AREA
);
30374 if (row
->used
[RIGHT_MARGIN_AREA
])
30375 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
30376 draw_row_fringe_bitmaps (w
, row
);
30379 return row
->mouse_face_p
;
30383 /* Redraw those parts of glyphs rows during expose event handling that
30384 overlap other rows. Redrawing of an exposed line writes over parts
30385 of lines overlapping that exposed line; this function fixes that.
30387 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
30388 row in W's current matrix that is exposed and overlaps other rows.
30389 LAST_OVERLAPPING_ROW is the last such row. */
30392 expose_overlaps (struct window
*w
,
30393 struct glyph_row
*first_overlapping_row
,
30394 struct glyph_row
*last_overlapping_row
,
30397 struct glyph_row
*row
;
30399 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
30400 if (row
->overlapping_p
)
30402 eassert (row
->enabled_p
&& !row
->mode_line_p
);
30405 if (row
->used
[LEFT_MARGIN_AREA
])
30406 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
30408 if (row
->used
[TEXT_AREA
])
30409 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
30411 if (row
->used
[RIGHT_MARGIN_AREA
])
30412 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
30418 /* Return true if W's cursor intersects rectangle R. */
30421 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
30423 XRectangle cr
, result
;
30424 struct glyph
*cursor_glyph
;
30425 struct glyph_row
*row
;
30427 if (w
->phys_cursor
.vpos
>= 0
30428 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
30429 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
30431 && row
->cursor_in_fringe_p
)
30433 /* Cursor is in the fringe. */
30434 cr
.x
= window_box_right_offset (w
,
30435 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
30436 ? RIGHT_MARGIN_AREA
30439 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
30440 cr
.height
= row
->height
;
30441 return x_intersect_rectangles (&cr
, r
, &result
);
30444 cursor_glyph
= get_phys_cursor_glyph (w
);
30447 /* r is relative to W's box, but w->phys_cursor.x is relative
30448 to left edge of W's TEXT area. Adjust it. */
30449 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
30450 cr
.y
= w
->phys_cursor
.y
;
30451 cr
.width
= cursor_glyph
->pixel_width
;
30452 cr
.height
= w
->phys_cursor_height
;
30453 /* ++KFS: W32 version used W32-specific IntersectRect here, but
30454 I assume the effect is the same -- and this is portable. */
30455 return x_intersect_rectangles (&cr
, r
, &result
);
30457 /* If we don't understand the format, pretend we're not in the hot-spot. */
30463 Draw a vertical window border to the right of window W if W doesn't
30464 have vertical scroll bars. */
30467 x_draw_vertical_border (struct window
*w
)
30469 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30471 /* We could do better, if we knew what type of scroll-bar the adjacent
30472 windows (on either side) have... But we don't :-(
30473 However, I think this works ok. ++KFS 2003-04-25 */
30475 /* Redraw borders between horizontally adjacent windows. Don't
30476 do it for frames with vertical scroll bars because either the
30477 right scroll bar of a window, or the left scroll bar of its
30478 neighbor will suffice as a border. */
30479 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
30482 /* Note: It is necessary to redraw both the left and the right
30483 borders, for when only this single window W is being
30485 if (!WINDOW_RIGHTMOST_P (w
)
30486 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
30488 int x0
, x1
, y0
, y1
;
30490 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30493 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30496 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
30499 if (!WINDOW_LEFTMOST_P (w
)
30500 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
30502 int x0
, x1
, y0
, y1
;
30504 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30507 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30510 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
30515 /* Draw window dividers for window W. */
30518 x_draw_right_divider (struct window
*w
)
30520 struct frame
*f
= WINDOW_XFRAME (w
);
30522 if (w
->mini
|| w
->pseudo_window_p
)
30524 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30526 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
30527 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30528 int y0
= WINDOW_TOP_EDGE_Y (w
);
30529 /* The bottom divider prevails. */
30530 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30532 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30537 x_draw_bottom_divider (struct window
*w
)
30539 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30541 if (w
->mini
|| w
->pseudo_window_p
)
30543 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30545 int x0
= WINDOW_LEFT_EDGE_X (w
);
30546 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30547 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30548 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
30550 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30554 /* Redraw the part of window W intersection rectangle FR. Pixel
30555 coordinates in FR are frame-relative. Call this function with
30556 input blocked. Value is true if the exposure overwrites
30560 expose_window (struct window
*w
, XRectangle
*fr
)
30562 struct frame
*f
= XFRAME (w
->frame
);
30564 bool mouse_face_overwritten_p
= false;
30566 /* If window is not yet fully initialized, do nothing. This can
30567 happen when toolkit scroll bars are used and a window is split.
30568 Reconfiguring the scroll bar will generate an expose for a newly
30570 if (w
->current_matrix
== NULL
)
30573 /* When we're currently updating the window, display and current
30574 matrix usually don't agree. Arrange for a thorough display
30576 if (w
->must_be_updated_p
)
30578 SET_FRAME_GARBAGED (f
);
30582 /* Frame-relative pixel rectangle of W. */
30583 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
30584 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
30585 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
30586 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
30588 if (x_intersect_rectangles (fr
, &wr
, &r
))
30590 int yb
= window_text_bottom_y (w
);
30591 struct glyph_row
*row
;
30592 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
30594 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
30595 r
.x
, r
.y
, r
.width
, r
.height
));
30597 /* Convert to window coordinates. */
30598 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
30599 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
30601 /* Turn off the cursor. */
30602 bool cursor_cleared_p
= (!w
->pseudo_window_p
30603 && phys_cursor_in_rect_p (w
, &r
));
30604 if (cursor_cleared_p
)
30605 x_clear_cursor (w
);
30607 /* If the row containing the cursor extends face to end of line,
30608 then expose_area might overwrite the cursor outside the
30609 rectangle and thus notice_overwritten_cursor might clear
30610 w->phys_cursor_on_p. We remember the original value and
30611 check later if it is changed. */
30612 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
30614 /* Use a signed int intermediate value to avoid catastrophic
30615 failures due to comparison between signed and unsigned, when
30616 y0 or y1 is negative (can happen for tall images). */
30617 int r_bottom
= r
.y
+ r
.height
;
30619 /* Update lines intersecting rectangle R. */
30620 first_overlapping_row
= last_overlapping_row
= NULL
;
30621 for (row
= w
->current_matrix
->rows
;
30626 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
30628 if ((y0
>= r
.y
&& y0
< r_bottom
)
30629 || (y1
> r
.y
&& y1
< r_bottom
)
30630 || (r
.y
>= y0
&& r
.y
< y1
)
30631 || (r_bottom
> y0
&& r_bottom
< y1
))
30633 /* A header line may be overlapping, but there is no need
30634 to fix overlapping areas for them. KFS 2005-02-12 */
30635 if (row
->overlapping_p
&& !row
->mode_line_p
)
30637 if (first_overlapping_row
== NULL
)
30638 first_overlapping_row
= row
;
30639 last_overlapping_row
= row
;
30643 if (expose_line (w
, row
, &r
))
30644 mouse_face_overwritten_p
= true;
30647 else if (row
->overlapping_p
)
30649 /* We must redraw a row overlapping the exposed area. */
30651 ? y0
+ row
->phys_height
> r
.y
30652 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30654 if (first_overlapping_row
== NULL
)
30655 first_overlapping_row
= row
;
30656 last_overlapping_row
= row
;
30664 /* Display the mode line if there is one. */
30665 if (WINDOW_WANTS_MODELINE_P (w
)
30666 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30668 && row
->y
< r_bottom
)
30670 if (expose_line (w
, row
, &r
))
30671 mouse_face_overwritten_p
= true;
30674 if (!w
->pseudo_window_p
)
30676 /* Fix the display of overlapping rows. */
30677 if (first_overlapping_row
)
30678 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30681 /* Draw border between windows. */
30682 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30683 x_draw_right_divider (w
);
30685 x_draw_vertical_border (w
);
30687 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30688 x_draw_bottom_divider (w
);
30690 /* Turn the cursor on again. */
30691 if (cursor_cleared_p
30692 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30693 update_window_cursor (w
, true);
30697 return mouse_face_overwritten_p
;
30702 /* Redraw (parts) of all windows in the window tree rooted at W that
30703 intersect R. R contains frame pixel coordinates. Value is
30704 true if the exposure overwrites mouse-face. */
30707 expose_window_tree (struct window
*w
, XRectangle
*r
)
30709 struct frame
*f
= XFRAME (w
->frame
);
30710 bool mouse_face_overwritten_p
= false;
30712 while (w
&& !FRAME_GARBAGED_P (f
))
30714 mouse_face_overwritten_p
30715 |= (WINDOWP (w
->contents
)
30716 ? expose_window_tree (XWINDOW (w
->contents
), r
)
30717 : expose_window (w
, r
));
30719 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
30722 return mouse_face_overwritten_p
;
30727 Redisplay an exposed area of frame F. X and Y are the upper-left
30728 corner of the exposed rectangle. W and H are width and height of
30729 the exposed area. All are pixel values. W or H zero means redraw
30730 the entire frame. */
30733 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
30736 bool mouse_face_overwritten_p
= false;
30738 TRACE ((stderr
, "expose_frame "));
30740 /* No need to redraw if frame will be redrawn soon. */
30741 if (FRAME_GARBAGED_P (f
))
30743 TRACE ((stderr
, " garbaged\n"));
30747 /* If basic faces haven't been realized yet, there is no point in
30748 trying to redraw anything. This can happen when we get an expose
30749 event while Emacs is starting, e.g. by moving another window. */
30750 if (FRAME_FACE_CACHE (f
) == NULL
30751 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
30753 TRACE ((stderr
, " no faces\n"));
30757 if (w
== 0 || h
== 0)
30760 r
.width
= FRAME_TEXT_WIDTH (f
);
30761 r
.height
= FRAME_TEXT_HEIGHT (f
);
30771 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
30772 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
30774 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30775 if (WINDOWP (f
->tool_bar_window
))
30776 mouse_face_overwritten_p
30777 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
30780 #ifdef HAVE_X_WINDOWS
30782 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30783 if (WINDOWP (f
->menu_bar_window
))
30784 mouse_face_overwritten_p
30785 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
30786 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30790 /* Some window managers support a focus-follows-mouse style with
30791 delayed raising of frames. Imagine a partially obscured frame,
30792 and moving the mouse into partially obscured mouse-face on that
30793 frame. The visible part of the mouse-face will be highlighted,
30794 then the WM raises the obscured frame. With at least one WM, KDE
30795 2.1, Emacs is not getting any event for the raising of the frame
30796 (even tried with SubstructureRedirectMask), only Expose events.
30797 These expose events will draw text normally, i.e. not
30798 highlighted. Which means we must redo the highlight here.
30799 Subsume it under ``we love X''. --gerd 2001-08-15 */
30800 /* Included in Windows version because Windows most likely does not
30801 do the right thing if any third party tool offers
30802 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30803 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
30805 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30806 if (f
== hlinfo
->mouse_face_mouse_frame
)
30808 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
30809 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
30810 clear_mouse_face (hlinfo
);
30811 note_mouse_highlight (f
, mouse_x
, mouse_y
);
30818 Determine the intersection of two rectangles R1 and R2. Return
30819 the intersection in *RESULT. Value is true if RESULT is not
30823 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
30825 XRectangle
*left
, *right
;
30826 XRectangle
*upper
, *lower
;
30827 bool intersection_p
= false;
30829 /* Rearrange so that R1 is the left-most rectangle. */
30831 left
= r1
, right
= r2
;
30833 left
= r2
, right
= r1
;
30835 /* X0 of the intersection is right.x0, if this is inside R1,
30836 otherwise there is no intersection. */
30837 if (right
->x
<= left
->x
+ left
->width
)
30839 result
->x
= right
->x
;
30841 /* The right end of the intersection is the minimum of
30842 the right ends of left and right. */
30843 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
30846 /* Same game for Y. */
30848 upper
= r1
, lower
= r2
;
30850 upper
= r2
, lower
= r1
;
30852 /* The upper end of the intersection is lower.y0, if this is inside
30853 of upper. Otherwise, there is no intersection. */
30854 if (lower
->y
<= upper
->y
+ upper
->height
)
30856 result
->y
= lower
->y
;
30858 /* The lower end of the intersection is the minimum of the lower
30859 ends of upper and lower. */
30860 result
->height
= (min (lower
->y
+ lower
->height
,
30861 upper
->y
+ upper
->height
)
30863 intersection_p
= true;
30867 return intersection_p
;
30870 #endif /* HAVE_WINDOW_SYSTEM */
30873 /***********************************************************************
30875 ***********************************************************************/
30878 syms_of_xdisp (void)
30880 Vwith_echo_area_save_vector
= Qnil
;
30881 staticpro (&Vwith_echo_area_save_vector
);
30883 Vmessage_stack
= Qnil
;
30884 staticpro (&Vmessage_stack
);
30886 /* Non-nil means don't actually do any redisplay. */
30887 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
30889 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
30891 DEFVAR_BOOL("inhibit-message", inhibit_message
,
30892 doc
: /* Non-nil means calls to `message' are not displayed.
30893 They are still logged to the *Messages* buffer. */);
30894 inhibit_message
= 0;
30896 message_dolog_marker1
= Fmake_marker ();
30897 staticpro (&message_dolog_marker1
);
30898 message_dolog_marker2
= Fmake_marker ();
30899 staticpro (&message_dolog_marker2
);
30900 message_dolog_marker3
= Fmake_marker ();
30901 staticpro (&message_dolog_marker3
);
30904 defsubr (&Sdump_frame_glyph_matrix
);
30905 defsubr (&Sdump_glyph_matrix
);
30906 defsubr (&Sdump_glyph_row
);
30907 defsubr (&Sdump_tool_bar_row
);
30908 defsubr (&Strace_redisplay
);
30909 defsubr (&Strace_to_stderr
);
30911 #ifdef HAVE_WINDOW_SYSTEM
30912 defsubr (&Stool_bar_height
);
30913 defsubr (&Slookup_image_map
);
30915 defsubr (&Sline_pixel_height
);
30916 defsubr (&Sformat_mode_line
);
30917 defsubr (&Sinvisible_p
);
30918 defsubr (&Scurrent_bidi_paragraph_direction
);
30919 defsubr (&Swindow_text_pixel_size
);
30920 defsubr (&Smove_point_visually
);
30921 defsubr (&Sbidi_find_overridden_directionality
);
30923 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
30924 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
30925 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
30926 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
30927 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
30928 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
30929 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
30930 DEFSYM (Qeval
, "eval");
30931 DEFSYM (QCdata
, ":data");
30933 /* Names of text properties relevant for redisplay. */
30934 DEFSYM (Qdisplay
, "display");
30935 DEFSYM (Qspace_width
, "space-width");
30936 DEFSYM (Qraise
, "raise");
30937 DEFSYM (Qslice
, "slice");
30938 DEFSYM (Qspace
, "space");
30939 DEFSYM (Qmargin
, "margin");
30940 DEFSYM (Qpointer
, "pointer");
30941 DEFSYM (Qleft_margin
, "left-margin");
30942 DEFSYM (Qright_margin
, "right-margin");
30943 DEFSYM (Qcenter
, "center");
30944 DEFSYM (Qline_height
, "line-height");
30945 DEFSYM (QCalign_to
, ":align-to");
30946 DEFSYM (QCrelative_width
, ":relative-width");
30947 DEFSYM (QCrelative_height
, ":relative-height");
30948 DEFSYM (QCeval
, ":eval");
30949 DEFSYM (QCpropertize
, ":propertize");
30950 DEFSYM (QCfile
, ":file");
30951 DEFSYM (Qfontified
, "fontified");
30952 DEFSYM (Qfontification_functions
, "fontification-functions");
30954 /* Name of the face used to highlight trailing whitespace. */
30955 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
30957 /* Name and number of the face used to highlight escape glyphs. */
30958 DEFSYM (Qescape_glyph
, "escape-glyph");
30960 /* Name and number of the face used to highlight non-breaking spaces. */
30961 DEFSYM (Qnobreak_space
, "nobreak-space");
30963 /* The symbol 'image' which is the car of the lists used to represent
30964 images in Lisp. Also a tool bar style. */
30965 DEFSYM (Qimage
, "image");
30967 /* Tool bar styles. */
30968 DEFSYM (Qtext
, "text");
30969 DEFSYM (Qboth
, "both");
30970 DEFSYM (Qboth_horiz
, "both-horiz");
30971 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
30973 /* The image map types. */
30974 DEFSYM (QCmap
, ":map");
30975 DEFSYM (QCpointer
, ":pointer");
30976 DEFSYM (Qrect
, "rect");
30977 DEFSYM (Qcircle
, "circle");
30978 DEFSYM (Qpoly
, "poly");
30980 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
30982 DEFSYM (Qgrow_only
, "grow-only");
30983 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
30984 DEFSYM (Qposition
, "position");
30985 DEFSYM (Qbuffer_position
, "buffer-position");
30986 DEFSYM (Qobject
, "object");
30988 /* Cursor shapes. */
30989 DEFSYM (Qbar
, "bar");
30990 DEFSYM (Qhbar
, "hbar");
30991 DEFSYM (Qbox
, "box");
30992 DEFSYM (Qhollow
, "hollow");
30994 /* Pointer shapes. */
30995 DEFSYM (Qhand
, "hand");
30996 DEFSYM (Qarrow
, "arrow");
30999 DEFSYM (Qdragging
, "dragging");
31001 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
31003 list_of_error
= list1 (list2 (Qerror
, Qvoid_variable
));
31004 staticpro (&list_of_error
);
31006 /* Values of those variables at last redisplay are stored as
31007 properties on 'overlay-arrow-position' symbol. However, if
31008 Voverlay_arrow_position is a marker, last-arrow-position is its
31009 numerical position. */
31010 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
31011 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
31013 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
31014 properties on a symbol in overlay-arrow-variable-list. */
31015 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
31016 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
31018 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
31019 staticpro (&echo_buffer
[0]);
31020 staticpro (&echo_buffer
[1]);
31022 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
31023 staticpro (&echo_area_buffer
[0]);
31024 staticpro (&echo_area_buffer
[1]);
31026 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
31027 staticpro (&Vmessages_buffer_name
);
31029 mode_line_proptrans_alist
= Qnil
;
31030 staticpro (&mode_line_proptrans_alist
);
31031 mode_line_string_list
= Qnil
;
31032 staticpro (&mode_line_string_list
);
31033 mode_line_string_face
= Qnil
;
31034 staticpro (&mode_line_string_face
);
31035 mode_line_string_face_prop
= Qnil
;
31036 staticpro (&mode_line_string_face_prop
);
31037 Vmode_line_unwind_vector
= Qnil
;
31038 staticpro (&Vmode_line_unwind_vector
);
31040 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
31042 help_echo_string
= Qnil
;
31043 staticpro (&help_echo_string
);
31044 help_echo_object
= Qnil
;
31045 staticpro (&help_echo_object
);
31046 help_echo_window
= Qnil
;
31047 staticpro (&help_echo_window
);
31048 previous_help_echo_string
= Qnil
;
31049 staticpro (&previous_help_echo_string
);
31050 help_echo_pos
= -1;
31052 DEFSYM (Qright_to_left
, "right-to-left");
31053 DEFSYM (Qleft_to_right
, "left-to-right");
31054 defsubr (&Sbidi_resolved_levels
);
31056 #ifdef HAVE_WINDOW_SYSTEM
31057 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
31058 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
31059 For example, if a block cursor is over a tab, it will be drawn as
31060 wide as that tab on the display. */);
31061 x_stretch_cursor_p
= 0;
31064 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
31065 doc
: /* Non-nil means highlight trailing whitespace.
31066 The face used for trailing whitespace is `trailing-whitespace'. */);
31067 Vshow_trailing_whitespace
= Qnil
;
31069 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
31070 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
31071 If the value is t, Emacs highlights non-ASCII chars which have the
31072 same appearance as an ASCII space or hyphen, using the `nobreak-space'
31073 or `escape-glyph' face respectively.
31075 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
31076 U+2011 (non-breaking hyphen) are affected.
31078 Any other non-nil value means to display these characters as a escape
31079 glyph followed by an ordinary space or hyphen.
31081 A value of nil means no special handling of these characters. */);
31082 Vnobreak_char_display
= Qt
;
31084 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
31085 doc
: /* The pointer shape to show in void text areas.
31086 A value of nil means to show the text pointer. Other options are
31087 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
31089 Vvoid_text_area_pointer
= Qarrow
;
31091 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
31092 doc
: /* Non-nil means don't actually do any redisplay.
31093 This is used for internal purposes. */);
31094 Vinhibit_redisplay
= Qnil
;
31096 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
31097 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
31098 Vglobal_mode_string
= Qnil
;
31100 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
31101 doc
: /* Marker for where to display an arrow on top of the buffer text.
31102 This must be the beginning of a line in order to work.
31103 See also `overlay-arrow-string'. */);
31104 Voverlay_arrow_position
= Qnil
;
31106 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
31107 doc
: /* String to display as an arrow in non-window frames.
31108 See also `overlay-arrow-position'. */);
31109 Voverlay_arrow_string
= build_pure_c_string ("=>");
31111 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
31112 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
31113 The symbols on this list are examined during redisplay to determine
31114 where to display overlay arrows. */);
31115 Voverlay_arrow_variable_list
31116 = list1 (intern_c_string ("overlay-arrow-position"));
31118 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
31119 doc
: /* The number of lines to try scrolling a window by when point moves out.
31120 If that fails to bring point back on frame, point is centered instead.
31121 If this is zero, point is always centered after it moves off frame.
31122 If you want scrolling to always be a line at a time, you should set
31123 `scroll-conservatively' to a large value rather than set this to 1. */);
31125 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
31126 doc
: /* Scroll up to this many lines, to bring point back on screen.
31127 If point moves off-screen, redisplay will scroll by up to
31128 `scroll-conservatively' lines in order to bring point just barely
31129 onto the screen again. If that cannot be done, then redisplay
31130 recenters point as usual.
31132 If the value is greater than 100, redisplay will never recenter point,
31133 but will always scroll just enough text to bring point into view, even
31134 if you move far away.
31136 A value of zero means always recenter point if it moves off screen. */);
31137 scroll_conservatively
= 0;
31139 DEFVAR_INT ("scroll-margin", scroll_margin
,
31140 doc
: /* Number of lines of margin at the top and bottom of a window.
31141 Recenter the window whenever point gets within this many lines
31142 of the top or bottom of the window. */);
31145 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
31146 doc
: /* Pixels per inch value for non-window system displays.
31147 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
31148 Vdisplay_pixels_per_inch
= make_float (72.0);
31151 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
31154 DEFVAR_LISP ("truncate-partial-width-windows",
31155 Vtruncate_partial_width_windows
,
31156 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
31157 For an integer value, truncate lines in each window narrower than the
31158 full frame width, provided the window width is less than that integer;
31159 otherwise, respect the value of `truncate-lines'.
31161 For any other non-nil value, truncate lines in all windows that do
31162 not span the full frame width.
31164 A value of nil means to respect the value of `truncate-lines'.
31166 If `word-wrap' is enabled, you might want to reduce this. */);
31167 Vtruncate_partial_width_windows
= make_number (50);
31169 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
31170 doc
: /* Maximum buffer size for which line number should be displayed.
31171 If the buffer is bigger than this, the line number does not appear
31172 in the mode line. A value of nil means no limit. */);
31173 Vline_number_display_limit
= Qnil
;
31175 DEFVAR_INT ("line-number-display-limit-width",
31176 line_number_display_limit_width
,
31177 doc
: /* Maximum line width (in characters) for line number display.
31178 If the average length of the lines near point is bigger than this, then the
31179 line number may be omitted from the mode line. */);
31180 line_number_display_limit_width
= 200;
31182 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
31183 doc
: /* Non-nil means highlight region even in nonselected windows. */);
31184 highlight_nonselected_windows
= false;
31186 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
31187 doc
: /* Non-nil if more than one frame is visible on this display.
31188 Minibuffer-only frames don't count, but iconified frames do.
31189 This variable is not guaranteed to be accurate except while processing
31190 `frame-title-format' and `icon-title-format'. */);
31192 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
31193 doc
: /* Template for displaying the title bar of visible frames.
31194 (Assuming the window manager supports this feature.)
31196 This variable has the same structure as `mode-line-format', except that
31197 the %c and %l constructs are ignored. It is used only on frames for
31198 which no explicit name has been set (see `modify-frame-parameters'). */);
31200 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
31201 doc
: /* Template for displaying the title bar of an iconified frame.
31202 (Assuming the window manager supports this feature.)
31203 This variable has the same structure as `mode-line-format' (which see),
31204 and is used only on frames for which no explicit name has been set
31205 (see `modify-frame-parameters'). */);
31207 = Vframe_title_format
31208 = listn (CONSTYPE_PURE
, 3,
31209 intern_c_string ("multiple-frames"),
31210 build_pure_c_string ("%b"),
31211 listn (CONSTYPE_PURE
, 4,
31212 empty_unibyte_string
,
31213 intern_c_string ("invocation-name"),
31214 build_pure_c_string ("@"),
31215 intern_c_string ("system-name")));
31217 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
31218 doc
: /* Maximum number of lines to keep in the message log buffer.
31219 If nil, disable message logging. If t, log messages but don't truncate
31220 the buffer when it becomes large. */);
31221 Vmessage_log_max
= make_number (1000);
31223 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
31224 doc
: /* Functions called during redisplay, if window sizes have changed.
31225 The value should be a list of functions that take one argument.
31226 During the first part of redisplay, for each frame, if any of its windows
31227 have changed size since the last redisplay, or have been split or deleted,
31228 all the functions in the list are called, with the frame as argument.
31229 If redisplay decides to resize the minibuffer window, it calls these
31230 functions on behalf of that as well. */);
31231 Vwindow_size_change_functions
= Qnil
;
31233 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
31234 doc
: /* List of functions to call before redisplaying a window with scrolling.
31235 Each function is called with two arguments, the window and its new
31236 display-start position.
31237 These functions are called whenever the `window-start' marker is modified,
31238 either to point into another buffer (e.g. via `set-window-buffer') or another
31239 place in the same buffer.
31240 Note that the value of `window-end' is not valid when these functions are
31243 Warning: Do not use this feature to alter the way the window
31244 is scrolled. It is not designed for that, and such use probably won't
31246 Vwindow_scroll_functions
= Qnil
;
31248 DEFVAR_LISP ("window-text-change-functions",
31249 Vwindow_text_change_functions
,
31250 doc
: /* Functions to call in redisplay when text in the window might change. */);
31251 Vwindow_text_change_functions
= Qnil
;
31253 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
31254 doc
: /* Functions called when redisplay of a window reaches the end trigger.
31255 Each function is called with two arguments, the window and the end trigger value.
31256 See `set-window-redisplay-end-trigger'. */);
31257 Vredisplay_end_trigger_functions
= Qnil
;
31259 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
31260 doc
: /* Non-nil means autoselect window with mouse pointer.
31261 If nil, do not autoselect windows.
31262 A positive number means delay autoselection by that many seconds: a
31263 window is autoselected only after the mouse has remained in that
31264 window for the duration of the delay.
31265 A negative number has a similar effect, but causes windows to be
31266 autoselected only after the mouse has stopped moving. (Because of
31267 the way Emacs compares mouse events, you will occasionally wait twice
31268 that time before the window gets selected.)
31269 Any other value means to autoselect window instantaneously when the
31270 mouse pointer enters it.
31272 Autoselection selects the minibuffer only if it is active, and never
31273 unselects the minibuffer if it is active.
31275 When customizing this variable make sure that the actual value of
31276 `focus-follows-mouse' matches the behavior of your window manager. */);
31277 Vmouse_autoselect_window
= Qnil
;
31279 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
31280 doc
: /* Non-nil means automatically resize tool-bars.
31281 This dynamically changes the tool-bar's height to the minimum height
31282 that is needed to make all tool-bar items visible.
31283 If value is `grow-only', the tool-bar's height is only increased
31284 automatically; to decrease the tool-bar height, use \\[recenter]. */);
31285 Vauto_resize_tool_bars
= Qt
;
31287 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
31288 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
31289 auto_raise_tool_bar_buttons_p
= true;
31291 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
31292 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
31293 make_cursor_line_fully_visible_p
= true;
31295 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
31296 doc
: /* Border below tool-bar in pixels.
31297 If an integer, use it as the height of the border.
31298 If it is one of `internal-border-width' or `border-width', use the
31299 value of the corresponding frame parameter.
31300 Otherwise, no border is added below the tool-bar. */);
31301 Vtool_bar_border
= Qinternal_border_width
;
31303 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
31304 doc
: /* Margin around tool-bar buttons in pixels.
31305 If an integer, use that for both horizontal and vertical margins.
31306 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
31307 HORZ specifying the horizontal margin, and VERT specifying the
31308 vertical margin. */);
31309 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
31311 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
31312 doc
: /* Relief thickness of tool-bar buttons. */);
31313 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
31315 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
31316 doc
: /* Tool bar style to use.
31318 image - show images only
31319 text - show text only
31320 both - show both, text below image
31321 both-horiz - show text to the right of the image
31322 text-image-horiz - show text to the left of the image
31323 any other - use system default or image if no system default.
31325 This variable only affects the GTK+ toolkit version of Emacs. */);
31326 Vtool_bar_style
= Qnil
;
31328 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
31329 doc
: /* Maximum number of characters a label can have to be shown.
31330 The tool bar style must also show labels for this to have any effect, see
31331 `tool-bar-style'. */);
31332 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
31334 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
31335 doc
: /* List of functions to call to fontify regions of text.
31336 Each function is called with one argument POS. Functions must
31337 fontify a region starting at POS in the current buffer, and give
31338 fontified regions the property `fontified'. */);
31339 Vfontification_functions
= Qnil
;
31340 Fmake_variable_buffer_local (Qfontification_functions
);
31342 DEFVAR_BOOL ("unibyte-display-via-language-environment",
31343 unibyte_display_via_language_environment
,
31344 doc
: /* Non-nil means display unibyte text according to language environment.
31345 Specifically, this means that raw bytes in the range 160-255 decimal
31346 are displayed by converting them to the equivalent multibyte characters
31347 according to the current language environment. As a result, they are
31348 displayed according to the current fontset.
31350 Note that this variable affects only how these bytes are displayed,
31351 but does not change the fact they are interpreted as raw bytes. */);
31352 unibyte_display_via_language_environment
= false;
31354 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
31355 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
31356 If a float, it specifies a fraction of the mini-window frame's height.
31357 If an integer, it specifies a number of lines. */);
31358 Vmax_mini_window_height
= make_float (0.25);
31360 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
31361 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
31362 A value of nil means don't automatically resize mini-windows.
31363 A value of t means resize them to fit the text displayed in them.
31364 A value of `grow-only', the default, means let mini-windows grow only;
31365 they return to their normal size when the minibuffer is closed, or the
31366 echo area becomes empty. */);
31367 Vresize_mini_windows
= Qgrow_only
;
31369 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
31370 doc
: /* Alist specifying how to blink the cursor off.
31371 Each element has the form (ON-STATE . OFF-STATE). Whenever the
31372 `cursor-type' frame-parameter or variable equals ON-STATE,
31373 comparing using `equal', Emacs uses OFF-STATE to specify
31374 how to blink it off. ON-STATE and OFF-STATE are values for
31375 the `cursor-type' frame parameter.
31377 If a frame's ON-STATE has no entry in this list,
31378 the frame's other specifications determine how to blink the cursor off. */);
31379 Vblink_cursor_alist
= Qnil
;
31381 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
31382 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
31383 If non-nil, windows are automatically scrolled horizontally to make
31384 point visible. */);
31385 automatic_hscrolling_p
= true;
31386 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
31388 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
31389 doc
: /* How many columns away from the window edge point is allowed to get
31390 before automatic hscrolling will horizontally scroll the window. */);
31391 hscroll_margin
= 5;
31393 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
31394 doc
: /* How many columns to scroll the window when point gets too close to the edge.
31395 When point is less than `hscroll-margin' columns from the window
31396 edge, automatic hscrolling will scroll the window by the amount of columns
31397 determined by this variable. If its value is a positive integer, scroll that
31398 many columns. If it's a positive floating-point number, it specifies the
31399 fraction of the window's width to scroll. If it's nil or zero, point will be
31400 centered horizontally after the scroll. Any other value, including negative
31401 numbers, are treated as if the value were zero.
31403 Automatic hscrolling always moves point outside the scroll margin, so if
31404 point was more than scroll step columns inside the margin, the window will
31405 scroll more than the value given by the scroll step.
31407 Note that the lower bound for automatic hscrolling specified by `scroll-left'
31408 and `scroll-right' overrides this variable's effect. */);
31409 Vhscroll_step
= make_number (0);
31411 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
31412 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
31413 Bind this around calls to `message' to let it take effect. */);
31414 message_truncate_lines
= false;
31416 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
31417 doc
: /* Normal hook run to update the menu bar definitions.
31418 Redisplay runs this hook before it redisplays the menu bar.
31419 This is used to update menus such as Buffers, whose contents depend on
31421 Vmenu_bar_update_hook
= Qnil
;
31423 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
31424 doc
: /* Frame for which we are updating a menu.
31425 The enable predicate for a menu binding should check this variable. */);
31426 Vmenu_updating_frame
= Qnil
;
31428 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
31429 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
31430 inhibit_menubar_update
= false;
31432 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
31433 doc
: /* Prefix prepended to all continuation lines at display time.
31434 The value may be a string, an image, or a stretch-glyph; it is
31435 interpreted in the same way as the value of a `display' text property.
31437 This variable is overridden by any `wrap-prefix' text or overlay
31440 To add a prefix to non-continuation lines, use `line-prefix'. */);
31441 Vwrap_prefix
= Qnil
;
31442 DEFSYM (Qwrap_prefix
, "wrap-prefix");
31443 Fmake_variable_buffer_local (Qwrap_prefix
);
31445 DEFVAR_LISP ("line-prefix", Vline_prefix
,
31446 doc
: /* Prefix prepended to all non-continuation lines at display time.
31447 The value may be a string, an image, or a stretch-glyph; it is
31448 interpreted in the same way as the value of a `display' text property.
31450 This variable is overridden by any `line-prefix' text or overlay
31453 To add a prefix to continuation lines, use `wrap-prefix'. */);
31454 Vline_prefix
= Qnil
;
31455 DEFSYM (Qline_prefix
, "line-prefix");
31456 Fmake_variable_buffer_local (Qline_prefix
);
31458 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
31459 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
31460 inhibit_eval_during_redisplay
= false;
31462 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
31463 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
31464 inhibit_free_realized_faces
= false;
31466 DEFVAR_BOOL ("inhibit-bidi-mirroring", inhibit_bidi_mirroring
,
31467 doc
: /* Non-nil means don't mirror characters even when bidi context requires that.
31468 Intended for use during debugging and for testing bidi display;
31469 see biditest.el in the test suite. */);
31470 inhibit_bidi_mirroring
= false;
31473 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
31474 doc
: /* Inhibit try_window_id display optimization. */);
31475 inhibit_try_window_id
= false;
31477 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
31478 doc
: /* Inhibit try_window_reusing display optimization. */);
31479 inhibit_try_window_reusing
= false;
31481 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
31482 doc
: /* Inhibit try_cursor_movement display optimization. */);
31483 inhibit_try_cursor_movement
= false;
31484 #endif /* GLYPH_DEBUG */
31486 DEFVAR_INT ("overline-margin", overline_margin
,
31487 doc
: /* Space between overline and text, in pixels.
31488 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
31489 margin to the character height. */);
31490 overline_margin
= 2;
31492 DEFVAR_INT ("underline-minimum-offset",
31493 underline_minimum_offset
,
31494 doc
: /* Minimum distance between baseline and underline.
31495 This can improve legibility of underlined text at small font sizes,
31496 particularly when using variable `x-use-underline-position-properties'
31497 with fonts that specify an UNDERLINE_POSITION relatively close to the
31498 baseline. The default value is 1. */);
31499 underline_minimum_offset
= 1;
31501 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
31502 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
31503 This feature only works when on a window system that can change
31504 cursor shapes. */);
31505 display_hourglass_p
= true;
31507 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
31508 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
31509 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
31511 #ifdef HAVE_WINDOW_SYSTEM
31512 hourglass_atimer
= NULL
;
31513 hourglass_shown_p
= false;
31514 #endif /* HAVE_WINDOW_SYSTEM */
31516 /* Name of the face used to display glyphless characters. */
31517 DEFSYM (Qglyphless_char
, "glyphless-char");
31519 /* Method symbols for Vglyphless_char_display. */
31520 DEFSYM (Qhex_code
, "hex-code");
31521 DEFSYM (Qempty_box
, "empty-box");
31522 DEFSYM (Qthin_space
, "thin-space");
31523 DEFSYM (Qzero_width
, "zero-width");
31525 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
31526 doc
: /* Function run just before redisplay.
31527 It is called with one argument, which is the set of windows that are to
31528 be redisplayed. This set can be nil (meaning, only the selected window),
31529 or t (meaning all windows). */);
31530 Vpre_redisplay_function
= intern ("ignore");
31532 /* Symbol for the purpose of Vglyphless_char_display. */
31533 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
31534 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
31536 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
31537 doc
: /* Char-table defining glyphless characters.
31538 Each element, if non-nil, should be one of the following:
31539 an ASCII acronym string: display this string in a box
31540 `hex-code': display the hexadecimal code of a character in a box
31541 `empty-box': display as an empty box
31542 `thin-space': display as 1-pixel width space
31543 `zero-width': don't display
31544 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
31545 display method for graphical terminals and text terminals respectively.
31546 GRAPHICAL and TEXT should each have one of the values listed above.
31548 The char-table has one extra slot to control the display of a character for
31549 which no font is found. This slot only takes effect on graphical terminals.
31550 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
31551 `thin-space'. The default is `empty-box'.
31553 If a character has a non-nil entry in an active display table, the
31554 display table takes effect; in this case, Emacs does not consult
31555 `glyphless-char-display' at all. */);
31556 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
31557 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
31560 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
31561 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
31562 Vdebug_on_message
= Qnil
;
31564 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
31566 Vredisplay__all_windows_cause
= Fmake_hash_table (0, NULL
);
31568 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
31570 Vredisplay__mode_lines_cause
= Fmake_hash_table (0, NULL
);
31572 DEFVAR_LISP ("redisplay--variables", Vredisplay__variables
,
31573 doc
: /* A hash-table of variables changing which triggers a thorough redisplay. */);
31574 Vredisplay__variables
= Qnil
;
31578 /* Initialize this module when Emacs starts. */
31583 CHARPOS (this_line_start_pos
) = 0;
31585 if (!noninteractive
)
31587 struct window
*m
= XWINDOW (minibuf_window
);
31588 Lisp_Object frame
= m
->frame
;
31589 struct frame
*f
= XFRAME (frame
);
31590 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
31591 struct window
*r
= XWINDOW (root
);
31594 echo_area_window
= minibuf_window
;
31596 r
->top_line
= FRAME_TOP_MARGIN (f
);
31597 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
31598 r
->total_cols
= FRAME_COLS (f
);
31599 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31600 r
->total_lines
= FRAME_TOTAL_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
31601 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
31603 m
->top_line
= FRAME_TOTAL_LINES (f
) - 1;
31604 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
31605 m
->total_cols
= FRAME_COLS (f
);
31606 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31607 m
->total_lines
= 1;
31608 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
31610 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
31611 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
31612 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
31614 /* The default ellipsis glyphs `...'. */
31615 for (i
= 0; i
< 3; ++i
)
31616 default_invis_vector
[i
] = make_number ('.');
31620 /* Allocate the buffer for frame titles.
31621 Also used for `format-mode-line'. */
31623 mode_line_noprop_buf
= xmalloc (size
);
31624 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
31625 mode_line_noprop_ptr
= mode_line_noprop_buf
;
31626 mode_line_target
= MODE_LINE_DISPLAY
;
31629 help_echo_showing_p
= false;
31632 #ifdef HAVE_WINDOW_SYSTEM
31634 /* Platform-independent portion of hourglass implementation. */
31636 /* Timer function of hourglass_atimer. */
31639 show_hourglass (struct atimer
*timer
)
31641 /* The timer implementation will cancel this timer automatically
31642 after this function has run. Set hourglass_atimer to null
31643 so that we know the timer doesn't have to be canceled. */
31644 hourglass_atimer
= NULL
;
31646 if (!hourglass_shown_p
)
31648 Lisp_Object tail
, frame
;
31652 FOR_EACH_FRAME (tail
, frame
)
31654 struct frame
*f
= XFRAME (frame
);
31656 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31657 && FRAME_RIF (f
)->show_hourglass
)
31658 FRAME_RIF (f
)->show_hourglass (f
);
31661 hourglass_shown_p
= true;
31666 /* Cancel a currently active hourglass timer, and start a new one. */
31669 start_hourglass (void)
31671 struct timespec delay
;
31673 cancel_hourglass ();
31675 if (INTEGERP (Vhourglass_delay
)
31676 && XINT (Vhourglass_delay
) > 0)
31677 delay
= make_timespec (min (XINT (Vhourglass_delay
),
31678 TYPE_MAXIMUM (time_t)),
31680 else if (FLOATP (Vhourglass_delay
)
31681 && XFLOAT_DATA (Vhourglass_delay
) > 0)
31682 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
31684 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
31686 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
31687 show_hourglass
, NULL
);
31690 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31694 cancel_hourglass (void)
31696 if (hourglass_atimer
)
31698 cancel_atimer (hourglass_atimer
);
31699 hourglass_atimer
= NULL
;
31702 if (hourglass_shown_p
)
31704 Lisp_Object tail
, frame
;
31708 FOR_EACH_FRAME (tail
, frame
)
31710 struct frame
*f
= XFRAME (frame
);
31712 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31713 && FRAME_RIF (f
)->hide_hourglass
)
31714 FRAME_RIF (f
)->hide_hourglass (f
);
31716 /* No cursors on non GUI frames - restore to stock arrow cursor. */
31717 else if (!FRAME_W32_P (f
))
31718 w32_arrow_cursor ();
31722 hourglass_shown_p
= false;
31727 #endif /* HAVE_WINDOW_SYSTEM */