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"
318 #ifdef HAVE_WINDOW_SYSTEM
320 #endif /* HAVE_WINDOW_SYSTEM */
322 #ifndef FRAME_X_OUTPUT
323 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
326 #define INFINITY 10000000
328 /* Holds the list (error). */
329 static Lisp_Object list_of_error
;
331 #ifdef HAVE_WINDOW_SYSTEM
333 /* Test if overflow newline into fringe. Called with iterator IT
334 at or past right window margin, and with IT->current_x set. */
336 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
337 (!NILP (Voverflow_newline_into_fringe) \
338 && FRAME_WINDOW_P ((IT)->f) \
339 && ((IT)->bidi_it.paragraph_dir == R2L \
340 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
341 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
342 && (IT)->current_x == (IT)->last_visible_x)
344 #else /* !HAVE_WINDOW_SYSTEM */
345 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) false
346 #endif /* HAVE_WINDOW_SYSTEM */
348 /* Test if the display element loaded in IT, or the underlying buffer
349 or string character, is a space or a TAB character. This is used
350 to determine where word wrapping can occur. */
352 #define IT_DISPLAYING_WHITESPACE(it) \
353 ((it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t')) \
354 || ((STRINGP (it->string) \
355 && (SREF (it->string, IT_STRING_BYTEPOS (*it)) == ' ' \
356 || SREF (it->string, IT_STRING_BYTEPOS (*it)) == '\t')) \
358 && (it->s[IT_BYTEPOS (*it)] == ' ' \
359 || it->s[IT_BYTEPOS (*it)] == '\t')) \
360 || (IT_BYTEPOS (*it) < ZV_BYTE \
361 && (*BYTE_POS_ADDR (IT_BYTEPOS (*it)) == ' ' \
362 || *BYTE_POS_ADDR (IT_BYTEPOS (*it)) == '\t')))) \
364 /* True means print newline to stdout before next mini-buffer message. */
366 bool noninteractive_need_newline
;
368 /* True means print newline to message log before next message. */
370 static bool message_log_need_newline
;
372 /* Three markers that message_dolog uses.
373 It could allocate them itself, but that causes trouble
374 in handling memory-full errors. */
375 static Lisp_Object message_dolog_marker1
;
376 static Lisp_Object message_dolog_marker2
;
377 static Lisp_Object message_dolog_marker3
;
379 /* The buffer position of the first character appearing entirely or
380 partially on the line of the selected window which contains the
381 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
382 redisplay optimization in redisplay_internal. */
384 static struct text_pos this_line_start_pos
;
386 /* Number of characters past the end of the line above, including the
387 terminating newline. */
389 static struct text_pos this_line_end_pos
;
391 /* The vertical positions and the height of this line. */
393 static int this_line_vpos
;
394 static int this_line_y
;
395 static int this_line_pixel_height
;
397 /* X position at which this display line starts. Usually zero;
398 negative if first character is partially visible. */
400 static int this_line_start_x
;
402 /* The smallest character position seen by move_it_* functions as they
403 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
404 hscrolled lines, see display_line. */
406 static struct text_pos this_line_min_pos
;
408 /* Buffer that this_line_.* variables are referring to. */
410 static struct buffer
*this_line_buffer
;
412 /* True if an overlay arrow has been displayed in this window. */
414 static bool overlay_arrow_seen
;
416 /* Vector containing glyphs for an ellipsis `...'. */
418 static Lisp_Object default_invis_vector
[3];
420 /* This is the window where the echo area message was displayed. It
421 is always a mini-buffer window, but it may not be the same window
422 currently active as a mini-buffer. */
424 Lisp_Object echo_area_window
;
426 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
427 pushes the current message and the value of
428 message_enable_multibyte on the stack, the function restore_message
429 pops the stack and displays MESSAGE again. */
431 static Lisp_Object Vmessage_stack
;
433 /* True means multibyte characters were enabled when the echo area
434 message was specified. */
436 static bool message_enable_multibyte
;
438 /* At each redisplay cycle, we should refresh everything there is to refresh.
439 To do that efficiently, we use many optimizations that try to make sure we
440 don't waste too much time updating things that haven't changed.
441 The coarsest such optimization is that, in the most common cases, we only
442 look at the selected-window.
444 To know whether other windows should be considered for redisplay, we use the
445 variable windows_or_buffers_changed: as long as it is 0, it means that we
446 have not noticed anything that should require updating anything else than
447 the selected-window. If it is set to REDISPLAY_SOME, it means that since
448 last redisplay, some changes have been made which could impact other
449 windows. To know which ones need redisplay, every buffer, window, and frame
450 has a `redisplay' bit, which (if true) means that this object needs to be
451 redisplayed. If windows_or_buffers_changed is 0, we know there's no point
452 looking for those `redisplay' bits (actually, there might be some such bits
453 set, but then only on objects which aren't displayed anyway).
455 OTOH if it's non-zero we wil have to loop through all windows and then check
456 the `redisplay' bit of the corresponding window, frame, and buffer, in order
457 to decide whether that window needs attention or not. Note that we can't
458 just look at the frame's redisplay bit to decide that the whole frame can be
459 skipped, since even if the frame's redisplay bit is unset, some of its
460 windows's redisplay bits may be set.
462 Mostly for historical reasons, windows_or_buffers_changed can also take
463 other non-zero values. In that case, the precise value doesn't matter (it
464 encodes the cause of the setting but is only used for debugging purposes),
465 and what it means is that we shouldn't pay attention to any `redisplay' bits
466 and we should simply try and redisplay every window out there. */
468 int windows_or_buffers_changed
;
470 /* Nonzero if we should redraw the mode lines on the next redisplay.
471 Similarly to `windows_or_buffers_changed', If it has value REDISPLAY_SOME,
472 then only redisplay the mode lines in those buffers/windows/frames where the
473 `redisplay' bit has been set.
474 For any other value, redisplay all mode lines (the number used is then only
475 used to track down the cause for this full-redisplay).
477 Since the frame title uses the same %-constructs as the mode line
478 (except %c and %l), if this variable is non-zero, we also consider
479 redisplaying the title of each frame, see x_consider_frame_title.
481 The `redisplay' bits are the same as those used for
482 windows_or_buffers_changed, and setting windows_or_buffers_changed also
483 causes recomputation of the mode lines of all those windows. IOW this
484 variable only has an effect if windows_or_buffers_changed is zero, in which
485 case we should only need to redisplay the mode-line of those objects with
486 a `redisplay' bit set but not the window's text content (tho we may still
487 need to refresh the text content of the selected-window). */
489 int update_mode_lines
;
491 /* True after display_mode_line if %l was used and it displayed a
494 static bool line_number_displayed
;
496 /* The name of the *Messages* buffer, a string. */
498 static Lisp_Object Vmessages_buffer_name
;
500 /* Current, index 0, and last displayed echo area message. Either
501 buffers from echo_buffers, or nil to indicate no message. */
503 Lisp_Object echo_area_buffer
[2];
505 /* The buffers referenced from echo_area_buffer. */
507 static Lisp_Object echo_buffer
[2];
509 /* A vector saved used in with_area_buffer to reduce consing. */
511 static Lisp_Object Vwith_echo_area_save_vector
;
513 /* True means display_echo_area should display the last echo area
514 message again. Set by redisplay_preserve_echo_area. */
516 static bool display_last_displayed_message_p
;
518 /* True if echo area is being used by print; false if being used by
521 static bool message_buf_print
;
523 /* Set to true in clear_message to make redisplay_internal aware
524 of an emptied echo area. */
526 static bool message_cleared_p
;
528 /* A scratch glyph row with contents used for generating truncation
529 glyphs. Also used in direct_output_for_insert. */
531 #define MAX_SCRATCH_GLYPHS 100
532 static struct glyph_row scratch_glyph_row
;
533 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
535 /* Ascent and height of the last line processed by move_it_to. */
537 static int last_height
;
539 /* True if there's a help-echo in the echo area. */
541 bool help_echo_showing_p
;
543 /* The maximum distance to look ahead for text properties. Values
544 that are too small let us call compute_char_face and similar
545 functions too often which is expensive. Values that are too large
546 let us call compute_char_face and alike too often because we
547 might not be interested in text properties that far away. */
549 #define TEXT_PROP_DISTANCE_LIMIT 100
551 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
552 iterator state and later restore it. This is needed because the
553 bidi iterator on bidi.c keeps a stacked cache of its states, which
554 is really a singleton. When we use scratch iterator objects to
555 move around the buffer, we can cause the bidi cache to be pushed or
556 popped, and therefore we need to restore the cache state when we
557 return to the original iterator. */
558 #define SAVE_IT(ITCOPY, ITORIG, CACHE) \
561 bidi_unshelve_cache (CACHE, true); \
563 CACHE = bidi_shelve_cache (); \
566 #define RESTORE_IT(pITORIG, pITCOPY, CACHE) \
568 if (pITORIG != pITCOPY) \
569 *(pITORIG) = *(pITCOPY); \
570 bidi_unshelve_cache (CACHE, false); \
574 /* Functions to mark elements as needing redisplay. */
575 enum { REDISPLAY_SOME
= 2}; /* Arbitrary choice. */
578 redisplay_other_windows (void)
580 if (!windows_or_buffers_changed
)
581 windows_or_buffers_changed
= REDISPLAY_SOME
;
585 wset_redisplay (struct window
*w
)
587 /* Beware: selected_window can be nil during early stages. */
588 if (!EQ (make_lisp_ptr (w
, Lisp_Vectorlike
), selected_window
))
589 redisplay_other_windows ();
594 fset_redisplay (struct frame
*f
)
596 redisplay_other_windows ();
601 bset_redisplay (struct buffer
*b
)
603 int count
= buffer_window_count (b
);
606 /* ... it's visible in other window than selected, */
607 if (count
> 1 || b
!= XBUFFER (XWINDOW (selected_window
)->contents
))
608 redisplay_other_windows ();
609 /* Even if we don't set windows_or_buffers_changed, do set `redisplay'
610 so that if we later set windows_or_buffers_changed, this buffer will
612 b
->text
->redisplay
= true;
617 bset_update_mode_line (struct buffer
*b
)
619 if (!update_mode_lines
)
620 update_mode_lines
= REDISPLAY_SOME
;
621 b
->text
->redisplay
= true;
625 maybe_set_redisplay (Lisp_Object symbol
)
627 if (HASH_TABLE_P (Vredisplay__variables
)
628 && hash_lookup (XHASH_TABLE (Vredisplay__variables
), symbol
, NULL
) >= 0)
630 bset_update_mode_line (current_buffer
);
631 current_buffer
->prevent_redisplay_optimizations_p
= true;
637 /* True means print traces of redisplay if compiled with
638 GLYPH_DEBUG defined. */
640 bool trace_redisplay_p
;
642 #endif /* GLYPH_DEBUG */
644 #ifdef DEBUG_TRACE_MOVE
645 /* True means trace with TRACE_MOVE to stderr. */
646 static bool trace_move
;
648 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
650 #define TRACE_MOVE(x) (void) 0
653 /* Buffer being redisplayed -- for redisplay_window_error. */
655 static struct buffer
*displayed_buffer
;
657 /* Value returned from text property handlers (see below). */
662 HANDLED_RECOMPUTE_PROPS
,
663 HANDLED_OVERLAY_STRING_CONSUMED
,
667 /* A description of text properties that redisplay is interested
672 /* The symbol index of the name of the property. */
675 /* A unique index for the property. */
678 /* A handler function called to set up iterator IT from the property
679 at IT's current position. Value is used to steer handle_stop. */
680 enum prop_handled (*handler
) (struct it
*it
);
683 static enum prop_handled
handle_face_prop (struct it
*);
684 static enum prop_handled
handle_invisible_prop (struct it
*);
685 static enum prop_handled
handle_display_prop (struct it
*);
686 static enum prop_handled
handle_composition_prop (struct it
*);
687 static enum prop_handled
handle_overlay_change (struct it
*);
688 static enum prop_handled
handle_fontified_prop (struct it
*);
690 /* Properties handled by iterators. */
692 static struct props it_props
[] =
694 {SYMBOL_INDEX (Qfontified
), FONTIFIED_PROP_IDX
, handle_fontified_prop
},
695 /* Handle `face' before `display' because some sub-properties of
696 `display' need to know the face. */
697 {SYMBOL_INDEX (Qface
), FACE_PROP_IDX
, handle_face_prop
},
698 {SYMBOL_INDEX (Qdisplay
), DISPLAY_PROP_IDX
, handle_display_prop
},
699 {SYMBOL_INDEX (Qinvisible
), INVISIBLE_PROP_IDX
, handle_invisible_prop
},
700 {SYMBOL_INDEX (Qcomposition
), COMPOSITION_PROP_IDX
, handle_composition_prop
},
704 /* Value is the position described by X. If X is a marker, value is
705 the marker_position of X. Otherwise, value is X. */
707 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
709 /* Enumeration returned by some move_it_.* functions internally. */
713 /* Not used. Undefined value. */
716 /* Move ended at the requested buffer position or ZV. */
717 MOVE_POS_MATCH_OR_ZV
,
719 /* Move ended at the requested X pixel position. */
722 /* Move within a line ended at the end of a line that must be
726 /* Move within a line ended at the end of a line that would
727 be displayed truncated. */
730 /* Move within a line ended at a line end. */
734 /* This counter is used to clear the face cache every once in a while
735 in redisplay_internal. It is incremented for each redisplay.
736 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
739 #define CLEAR_FACE_CACHE_COUNT 500
740 static int clear_face_cache_count
;
742 /* Similarly for the image cache. */
744 #ifdef HAVE_WINDOW_SYSTEM
745 #define CLEAR_IMAGE_CACHE_COUNT 101
746 static int clear_image_cache_count
;
748 /* Null glyph slice */
749 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
752 /* True while redisplay_internal is in progress. */
756 /* If a string, XTread_socket generates an event to display that string.
757 (The display is done in read_char.) */
759 Lisp_Object help_echo_string
;
760 Lisp_Object help_echo_window
;
761 Lisp_Object help_echo_object
;
762 ptrdiff_t help_echo_pos
;
764 /* Temporary variable for XTread_socket. */
766 Lisp_Object previous_help_echo_string
;
768 /* Platform-independent portion of hourglass implementation. */
770 #ifdef HAVE_WINDOW_SYSTEM
772 /* True means an hourglass cursor is currently shown. */
773 static bool hourglass_shown_p
;
775 /* If non-null, an asynchronous timer that, when it expires, displays
776 an hourglass cursor on all frames. */
777 static struct atimer
*hourglass_atimer
;
779 #endif /* HAVE_WINDOW_SYSTEM */
781 /* Default number of seconds to wait before displaying an hourglass
783 #define DEFAULT_HOURGLASS_DELAY 1
785 #ifdef HAVE_WINDOW_SYSTEM
787 /* Default pixel width of `thin-space' display method. */
788 #define THIN_SPACE_WIDTH 1
790 #endif /* HAVE_WINDOW_SYSTEM */
792 /* Function prototypes. */
794 static void setup_for_ellipsis (struct it
*, int);
795 static void set_iterator_to_next (struct it
*, bool);
796 static void mark_window_display_accurate_1 (struct window
*, bool);
797 static bool row_for_charpos_p (struct glyph_row
*, ptrdiff_t);
798 static bool cursor_row_p (struct glyph_row
*);
799 static int redisplay_mode_lines (Lisp_Object
, bool);
801 static void handle_line_prefix (struct it
*);
803 static void handle_stop_backwards (struct it
*, ptrdiff_t);
804 static void unwind_with_echo_area_buffer (Lisp_Object
);
805 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
806 static bool current_message_1 (ptrdiff_t, Lisp_Object
);
807 static bool truncate_message_1 (ptrdiff_t, Lisp_Object
);
808 static void set_message (Lisp_Object
);
809 static bool set_message_1 (ptrdiff_t, Lisp_Object
);
810 static bool display_echo_area_1 (ptrdiff_t, Lisp_Object
);
811 static bool resize_mini_window_1 (ptrdiff_t, Lisp_Object
);
812 static void unwind_redisplay (void);
813 static void extend_face_to_end_of_line (struct it
*);
814 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
815 static void push_it (struct it
*, struct text_pos
*);
816 static void iterate_out_of_display_property (struct it
*);
817 static void pop_it (struct it
*);
818 static void redisplay_internal (void);
819 static void echo_area_display (bool);
820 static void redisplay_windows (Lisp_Object
);
821 static void redisplay_window (Lisp_Object
, bool);
822 static Lisp_Object
redisplay_window_error (Lisp_Object
);
823 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
824 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
825 static bool set_cursor_from_row (struct window
*, struct glyph_row
*,
826 struct glyph_matrix
*, ptrdiff_t, ptrdiff_t,
828 static bool cursor_row_fully_visible_p (struct window
*, bool, bool);
829 static bool update_menu_bar (struct frame
*, bool, bool);
830 static bool try_window_reusing_current_matrix (struct window
*);
831 static int try_window_id (struct window
*);
832 static bool display_line (struct it
*);
833 static int display_mode_lines (struct window
*);
834 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
835 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
,
837 static int store_mode_line_string (const char *, Lisp_Object
, bool, int, int,
839 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
840 static void display_menu_bar (struct window
*);
841 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
843 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
844 ptrdiff_t, ptrdiff_t, struct it
*, int, int, int, int);
845 static void compute_line_metrics (struct it
*);
846 static void run_redisplay_end_trigger_hook (struct it
*);
847 static bool get_overlay_strings (struct it
*, ptrdiff_t);
848 static bool get_overlay_strings_1 (struct it
*, ptrdiff_t, bool);
849 static void next_overlay_string (struct it
*);
850 static void reseat (struct it
*, struct text_pos
, bool);
851 static void reseat_1 (struct it
*, struct text_pos
, bool);
852 static bool next_element_from_display_vector (struct it
*);
853 static bool next_element_from_string (struct it
*);
854 static bool next_element_from_c_string (struct it
*);
855 static bool next_element_from_buffer (struct it
*);
856 static bool next_element_from_composition (struct it
*);
857 static bool next_element_from_image (struct it
*);
858 static bool next_element_from_stretch (struct it
*);
859 static bool next_element_from_xwidget (struct it
*);
860 static void load_overlay_strings (struct it
*, ptrdiff_t);
861 static bool get_next_display_element (struct it
*);
862 static enum move_it_result
863 move_it_in_display_line_to (struct it
*, ptrdiff_t, int,
864 enum move_operation_enum
);
865 static void get_visually_first_element (struct it
*);
866 static void compute_stop_pos (struct it
*);
867 static int face_before_or_after_it_pos (struct it
*, bool);
868 static ptrdiff_t next_overlay_change (ptrdiff_t);
869 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
870 Lisp_Object
, struct text_pos
*, ptrdiff_t, bool);
871 static int handle_single_display_spec (struct it
*, Lisp_Object
,
872 Lisp_Object
, Lisp_Object
,
873 struct text_pos
*, ptrdiff_t, int, bool);
874 static int underlying_face_id (struct it
*);
876 #define face_before_it_pos(IT) face_before_or_after_it_pos (IT, true)
877 #define face_after_it_pos(IT) face_before_or_after_it_pos (IT, false)
879 #ifdef HAVE_WINDOW_SYSTEM
881 static void update_tool_bar (struct frame
*, bool);
882 static void x_draw_bottom_divider (struct window
*w
);
883 static void notice_overwritten_cursor (struct window
*,
886 static int normal_char_height (struct font
*, int);
887 static void normal_char_ascent_descent (struct font
*, int, int *, int *);
889 static void append_stretch_glyph (struct it
*, Lisp_Object
,
892 static Lisp_Object
get_it_property (struct it
*, Lisp_Object
);
893 static Lisp_Object
calc_line_height_property (struct it
*, Lisp_Object
,
894 struct font
*, int, bool);
896 #endif /* HAVE_WINDOW_SYSTEM */
898 static void produce_special_glyphs (struct it
*, enum display_element_type
);
899 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
900 static bool coords_in_mouse_face_p (struct window
*, int, int);
904 /***********************************************************************
905 Window display dimensions
906 ***********************************************************************/
908 /* Return the bottom boundary y-position for text lines in window W.
909 This is the first y position at which a line cannot start.
910 It is relative to the top of the window.
912 This is the height of W minus the height of a mode line, if any. */
915 window_text_bottom_y (struct window
*w
)
917 int height
= WINDOW_PIXEL_HEIGHT (w
);
919 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
921 if (WINDOW_WANTS_MODELINE_P (w
))
922 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
924 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
929 /* Return the pixel width of display area AREA of window W.
930 ANY_AREA means return the total width of W, not including
931 fringes to the left and right of the window. */
934 window_box_width (struct window
*w
, enum glyph_row_area area
)
936 int width
= w
->pixel_width
;
938 if (!w
->pseudo_window_p
)
940 width
-= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
941 width
-= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
943 if (area
== TEXT_AREA
)
944 width
-= (WINDOW_MARGINS_WIDTH (w
)
945 + WINDOW_FRINGES_WIDTH (w
));
946 else if (area
== LEFT_MARGIN_AREA
)
947 width
= WINDOW_LEFT_MARGIN_WIDTH (w
);
948 else if (area
== RIGHT_MARGIN_AREA
)
949 width
= WINDOW_RIGHT_MARGIN_WIDTH (w
);
952 /* With wide margins, fringes, etc. we might end up with a negative
953 width, correct that here. */
954 return max (0, width
);
958 /* Return the pixel height of the display area of window W, not
959 including mode lines of W, if any. */
962 window_box_height (struct window
*w
)
964 struct frame
*f
= XFRAME (w
->frame
);
965 int height
= WINDOW_PIXEL_HEIGHT (w
);
967 eassert (height
>= 0);
969 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
970 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
972 /* Note: the code below that determines the mode-line/header-line
973 height is essentially the same as that contained in the macro
974 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
975 the appropriate glyph row has its `mode_line_p' flag set,
976 and if it doesn't, uses estimate_mode_line_height instead. */
978 if (WINDOW_WANTS_MODELINE_P (w
))
980 struct glyph_row
*ml_row
981 = (w
->current_matrix
&& w
->current_matrix
->rows
982 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
984 if (ml_row
&& ml_row
->mode_line_p
)
985 height
-= ml_row
->height
;
987 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
990 if (WINDOW_WANTS_HEADER_LINE_P (w
))
992 struct glyph_row
*hl_row
993 = (w
->current_matrix
&& w
->current_matrix
->rows
994 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
996 if (hl_row
&& hl_row
->mode_line_p
)
997 height
-= hl_row
->height
;
999 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1002 /* With a very small font and a mode-line that's taller than
1003 default, we might end up with a negative height. */
1004 return max (0, height
);
1007 /* Return the window-relative coordinate of the left edge of display
1008 area AREA of window W. ANY_AREA means return the left edge of the
1009 whole window, to the right of the left fringe of W. */
1012 window_box_left_offset (struct window
*w
, enum glyph_row_area area
)
1016 if (w
->pseudo_window_p
)
1019 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1021 if (area
== TEXT_AREA
)
1022 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1023 + window_box_width (w
, LEFT_MARGIN_AREA
));
1024 else if (area
== RIGHT_MARGIN_AREA
)
1025 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1026 + window_box_width (w
, LEFT_MARGIN_AREA
)
1027 + window_box_width (w
, TEXT_AREA
)
1028 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1030 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1031 else if (area
== LEFT_MARGIN_AREA
1032 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1033 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1035 /* Don't return more than the window's pixel width. */
1036 return min (x
, w
->pixel_width
);
1040 /* Return the window-relative coordinate of the right edge of display
1041 area AREA of window W. ANY_AREA means return the right edge of the
1042 whole window, to the left of the right fringe of W. */
1045 window_box_right_offset (struct window
*w
, enum glyph_row_area area
)
1047 /* Don't return more than the window's pixel width. */
1048 return min (window_box_left_offset (w
, area
) + window_box_width (w
, area
),
1052 /* Return the frame-relative coordinate of the left edge of display
1053 area AREA of window W. ANY_AREA means return the left edge of the
1054 whole window, to the right of the left fringe of W. */
1057 window_box_left (struct window
*w
, enum glyph_row_area area
)
1059 struct frame
*f
= XFRAME (w
->frame
);
1062 if (w
->pseudo_window_p
)
1063 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1065 x
= (WINDOW_LEFT_EDGE_X (w
)
1066 + window_box_left_offset (w
, area
));
1072 /* Return the frame-relative coordinate of the right edge of display
1073 area AREA of window W. ANY_AREA means return the right edge of the
1074 whole window, to the left of the right fringe of W. */
1077 window_box_right (struct window
*w
, enum glyph_row_area area
)
1079 return window_box_left (w
, area
) + window_box_width (w
, area
);
1082 /* Get the bounding box of the display area AREA of window W, without
1083 mode lines, in frame-relative coordinates. ANY_AREA means the
1084 whole window, not including the left and right fringes of
1085 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1086 coordinates of the upper-left corner of the box. Return in
1087 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1090 window_box (struct window
*w
, enum glyph_row_area area
, int *box_x
,
1091 int *box_y
, int *box_width
, int *box_height
)
1094 *box_width
= window_box_width (w
, area
);
1096 *box_height
= window_box_height (w
);
1098 *box_x
= window_box_left (w
, area
);
1101 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1102 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1103 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1107 #ifdef HAVE_WINDOW_SYSTEM
1109 /* Get the bounding box of the display area AREA of window W, without
1110 mode lines and both fringes of the window. Return in *TOP_LEFT_X
1111 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1112 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1113 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1117 window_box_edges (struct window
*w
, int *top_left_x
, int *top_left_y
,
1118 int *bottom_right_x
, int *bottom_right_y
)
1120 window_box (w
, ANY_AREA
, top_left_x
, top_left_y
,
1121 bottom_right_x
, bottom_right_y
);
1122 *bottom_right_x
+= *top_left_x
;
1123 *bottom_right_y
+= *top_left_y
;
1126 #endif /* HAVE_WINDOW_SYSTEM */
1128 /***********************************************************************
1130 ***********************************************************************/
1132 /* Return the bottom y-position of the line the iterator IT is in.
1133 This can modify IT's settings. */
1136 line_bottom_y (struct it
*it
)
1138 int line_height
= it
->max_ascent
+ it
->max_descent
;
1139 int line_top_y
= it
->current_y
;
1141 if (line_height
== 0)
1144 line_height
= last_height
;
1145 else if (IT_CHARPOS (*it
) < ZV
)
1147 move_it_by_lines (it
, 1);
1148 line_height
= (it
->max_ascent
|| it
->max_descent
1149 ? it
->max_ascent
+ it
->max_descent
1154 struct glyph_row
*row
= it
->glyph_row
;
1156 /* Use the default character height. */
1157 it
->glyph_row
= NULL
;
1158 it
->what
= IT_CHARACTER
;
1161 PRODUCE_GLYPHS (it
);
1162 line_height
= it
->ascent
+ it
->descent
;
1163 it
->glyph_row
= row
;
1167 return line_top_y
+ line_height
;
1170 DEFUN ("line-pixel-height", Fline_pixel_height
,
1171 Sline_pixel_height
, 0, 0, 0,
1172 doc
: /* Return height in pixels of text line in the selected window.
1174 Value is the height in pixels of the line at point. */)
1179 struct window
*w
= XWINDOW (selected_window
);
1180 struct buffer
*old_buffer
= NULL
;
1183 if (XBUFFER (w
->contents
) != current_buffer
)
1185 old_buffer
= current_buffer
;
1186 set_buffer_internal_1 (XBUFFER (w
->contents
));
1188 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
1189 start_display (&it
, w
, pt
);
1190 it
.vpos
= it
.current_y
= 0;
1192 result
= make_number (line_bottom_y (&it
));
1194 set_buffer_internal_1 (old_buffer
);
1199 /* Return the default pixel height of text lines in window W. The
1200 value is the canonical height of the W frame's default font, plus
1201 any extra space required by the line-spacing variable or frame
1204 Implementation note: this ignores any line-spacing text properties
1205 put on the newline characters. This is because those properties
1206 only affect the _screen_ line ending in the newline (i.e., in a
1207 continued line, only the last screen line will be affected), which
1208 means only a small number of lines in a buffer can ever use this
1209 feature. Since this function is used to compute the default pixel
1210 equivalent of text lines in a window, we can safely ignore those
1211 few lines. For the same reasons, we ignore the line-height
1214 default_line_pixel_height (struct window
*w
)
1216 struct frame
*f
= WINDOW_XFRAME (w
);
1217 int height
= FRAME_LINE_HEIGHT (f
);
1219 if (!FRAME_INITIAL_P (f
) && BUFFERP (w
->contents
))
1221 struct buffer
*b
= XBUFFER (w
->contents
);
1222 Lisp_Object val
= BVAR (b
, extra_line_spacing
);
1225 val
= BVAR (&buffer_defaults
, extra_line_spacing
);
1228 if (RANGED_INTEGERP (0, val
, INT_MAX
))
1229 height
+= XFASTINT (val
);
1230 else if (FLOATP (val
))
1232 int addon
= XFLOAT_DATA (val
) * height
+ 0.5;
1239 height
+= f
->extra_line_spacing
;
1245 /* Subroutine of pos_visible_p below. Extracts a display string, if
1246 any, from the display spec given as its argument. */
1248 string_from_display_spec (Lisp_Object spec
)
1252 while (CONSP (spec
))
1254 if (STRINGP (XCAR (spec
)))
1259 else if (VECTORP (spec
))
1263 for (i
= 0; i
< ASIZE (spec
); i
++)
1265 if (STRINGP (AREF (spec
, i
)))
1266 return AREF (spec
, i
);
1275 /* Limit insanely large values of W->hscroll on frame F to the largest
1276 value that will still prevent first_visible_x and last_visible_x of
1277 'struct it' from overflowing an int. */
1279 window_hscroll_limited (struct window
*w
, struct frame
*f
)
1281 ptrdiff_t window_hscroll
= w
->hscroll
;
1282 int window_text_width
= window_box_width (w
, TEXT_AREA
);
1283 int colwidth
= FRAME_COLUMN_WIDTH (f
);
1285 if (window_hscroll
> (INT_MAX
- window_text_width
) / colwidth
- 1)
1286 window_hscroll
= (INT_MAX
- window_text_width
) / colwidth
- 1;
1288 return window_hscroll
;
1291 /* Return true if position CHARPOS is visible in window W.
1292 CHARPOS < 0 means return info about WINDOW_END position.
1293 If visible, set *X and *Y to pixel coordinates of top left corner.
1294 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1295 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1298 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1299 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1302 void *itdata
= bidi_shelve_cache ();
1303 struct text_pos top
;
1304 bool visible_p
= false;
1305 struct buffer
*old_buffer
= NULL
;
1308 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1311 if (XBUFFER (w
->contents
) != current_buffer
)
1313 old_buffer
= current_buffer
;
1314 set_buffer_internal_1 (XBUFFER (w
->contents
));
1317 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1318 /* Scrolling a minibuffer window via scroll bar when the echo area
1319 shows long text sometimes resets the minibuffer contents behind
1321 if (CHARPOS (top
) > ZV
)
1322 SET_TEXT_POS (top
, BEGV
, BEGV_BYTE
);
1324 /* Compute exact mode line heights. */
1325 if (WINDOW_WANTS_MODELINE_P (w
))
1327 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1328 BVAR (current_buffer
, mode_line_format
));
1330 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1331 w
->header_line_height
1332 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1333 BVAR (current_buffer
, header_line_format
));
1335 start_display (&it
, w
, top
);
1336 move_it_to (&it
, charpos
, -1, it
.last_visible_y
- 1, -1,
1337 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1340 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
!= -1)
1341 && IT_CHARPOS (it
) >= charpos
)
1342 /* When scanning backwards under bidi iteration, move_it_to
1343 stops at or _before_ CHARPOS, because it stops at or to
1344 the _right_ of the character at CHARPOS. */
1345 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1346 && IT_CHARPOS (it
) <= charpos
)))
1348 /* We have reached CHARPOS, or passed it. How the call to
1349 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1350 or covered by a display property, move_it_to stops at the end
1351 of the invisible text, to the right of CHARPOS. (ii) If
1352 CHARPOS is in a display vector, move_it_to stops on its last
1354 int top_x
= it
.current_x
;
1355 int top_y
= it
.current_y
;
1356 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1359 void *save_it_data
= NULL
;
1361 /* Calling line_bottom_y may change it.method, it.position, etc. */
1362 SAVE_IT (save_it
, it
, save_it_data
);
1364 bottom_y
= line_bottom_y (&it
);
1365 if (top_y
< window_top_y
)
1366 visible_p
= bottom_y
> window_top_y
;
1367 else if (top_y
< it
.last_visible_y
)
1369 if (bottom_y
>= it
.last_visible_y
1370 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1371 && IT_CHARPOS (it
) < charpos
)
1373 /* When the last line of the window is scanned backwards
1374 under bidi iteration, we could be duped into thinking
1375 that we have passed CHARPOS, when in fact move_it_to
1376 simply stopped short of CHARPOS because it reached
1377 last_visible_y. To see if that's what happened, we call
1378 move_it_to again with a slightly larger vertical limit,
1379 and see if it actually moved vertically; if it did, we
1380 didn't really reach CHARPOS, which is beyond window end. */
1381 /* Why 10? because we don't know how many canonical lines
1382 will the height of the next line(s) be. So we guess. */
1383 int ten_more_lines
= 10 * default_line_pixel_height (w
);
1385 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1386 MOVE_TO_POS
| MOVE_TO_Y
);
1387 if (it
.current_y
> top_y
)
1391 RESTORE_IT (&it
, &save_it
, save_it_data
);
1394 if (it
.method
== GET_FROM_DISPLAY_VECTOR
)
1396 /* We stopped on the last glyph of a display vector.
1397 Try and recompute. Hack alert! */
1398 if (charpos
< 2 || top
.charpos
>= charpos
)
1399 top_x
= it
.glyph_row
->x
;
1402 struct it it2
, it2_prev
;
1403 /* The idea is to get to the previous buffer
1404 position, consume the character there, and use
1405 the pixel coordinates we get after that. But if
1406 the previous buffer position is also displayed
1407 from a display vector, we need to consume all of
1408 the glyphs from that display vector. */
1409 start_display (&it2
, w
, top
);
1410 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1411 /* If we didn't get to CHARPOS - 1, there's some
1412 replacing display property at that position, and
1413 we stopped after it. That is exactly the place
1414 whose coordinates we want. */
1415 if (IT_CHARPOS (it2
) != charpos
- 1)
1419 /* Iterate until we get out of the display
1420 vector that displays the character at
1423 get_next_display_element (&it2
);
1424 PRODUCE_GLYPHS (&it2
);
1426 set_iterator_to_next (&it2
, true);
1427 } while (it2
.method
== GET_FROM_DISPLAY_VECTOR
1428 && IT_CHARPOS (it2
) < charpos
);
1430 if (ITERATOR_AT_END_OF_LINE_P (&it2_prev
)
1431 || it2_prev
.current_x
> it2_prev
.last_visible_x
)
1432 top_x
= it
.glyph_row
->x
;
1435 top_x
= it2_prev
.current_x
;
1436 top_y
= it2_prev
.current_y
;
1440 else if (IT_CHARPOS (it
) != charpos
)
1442 Lisp_Object cpos
= make_number (charpos
);
1443 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1444 Lisp_Object string
= string_from_display_spec (spec
);
1445 struct text_pos tpos
;
1446 bool newline_in_string
1448 && memchr (SDATA (string
), '\n', SBYTES (string
)));
1450 SET_TEXT_POS (tpos
, charpos
, CHAR_TO_BYTE (charpos
));
1451 bool replacing_spec_p
1453 && handle_display_spec (NULL
, spec
, Qnil
, Qnil
, &tpos
,
1454 charpos
, FRAME_WINDOW_P (it
.f
)));
1455 /* The tricky code below is needed because there's a
1456 discrepancy between move_it_to and how we set cursor
1457 when PT is at the beginning of a portion of text
1458 covered by a display property or an overlay with a
1459 display property, or the display line ends in a
1460 newline from a display string. move_it_to will stop
1461 _after_ such display strings, whereas
1462 set_cursor_from_row conspires with cursor_row_p to
1463 place the cursor on the first glyph produced from the
1466 /* We have overshoot PT because it is covered by a
1467 display property that replaces the text it covers.
1468 If the string includes embedded newlines, we are also
1469 in the wrong display line. Backtrack to the correct
1470 line, where the display property begins. */
1471 if (replacing_spec_p
)
1473 Lisp_Object startpos
, endpos
;
1474 EMACS_INT start
, end
;
1477 /* Find the first and the last buffer positions
1478 covered by the display string. */
1480 Fnext_single_char_property_change (cpos
, Qdisplay
,
1483 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1485 start
= XFASTINT (startpos
);
1486 end
= XFASTINT (endpos
);
1487 /* Move to the last buffer position before the
1488 display property. */
1489 start_display (&it3
, w
, top
);
1490 if (start
> CHARPOS (top
))
1491 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1492 /* Move forward one more line if the position before
1493 the display string is a newline or if it is the
1494 rightmost character on a line that is
1495 continued or word-wrapped. */
1496 if (it3
.method
== GET_FROM_BUFFER
1498 || FETCH_BYTE (IT_BYTEPOS (it3
)) == '\n'))
1499 move_it_by_lines (&it3
, 1);
1500 else if (move_it_in_display_line_to (&it3
, -1,
1504 == MOVE_LINE_CONTINUED
)
1506 move_it_by_lines (&it3
, 1);
1507 /* When we are under word-wrap, the #$@%!
1508 move_it_by_lines moves 2 lines, so we need to
1510 if (it3
.line_wrap
== WORD_WRAP
)
1511 move_it_by_lines (&it3
, -1);
1514 /* Record the vertical coordinate of the display
1515 line where we wound up. */
1516 top_y
= it3
.current_y
;
1519 /* When characters are reordered for display,
1520 the character displayed to the left of the
1521 display string could be _after_ the display
1522 property in the logical order. Use the
1523 smallest vertical position of these two. */
1524 start_display (&it3
, w
, top
);
1525 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1526 if (it3
.current_y
< top_y
)
1527 top_y
= it3
.current_y
;
1529 /* Move from the top of the window to the beginning
1530 of the display line where the display string
1532 start_display (&it3
, w
, top
);
1533 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1534 /* If it3_moved stays false after the 'while' loop
1535 below, that means we already were at a newline
1536 before the loop (e.g., the display string begins
1537 with a newline), so we don't need to (and cannot)
1538 inspect the glyphs of it3.glyph_row, because
1539 PRODUCE_GLYPHS will not produce anything for a
1540 newline, and thus it3.glyph_row stays at its
1541 stale content it got at top of the window. */
1542 bool it3_moved
= false;
1543 /* Finally, advance the iterator until we hit the
1544 first display element whose character position is
1545 CHARPOS, or until the first newline from the
1546 display string, which signals the end of the
1548 while (get_next_display_element (&it3
))
1550 PRODUCE_GLYPHS (&it3
);
1551 if (IT_CHARPOS (it3
) == charpos
1552 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1555 set_iterator_to_next (&it3
, false);
1557 top_x
= it3
.current_x
- it3
.pixel_width
;
1558 /* Normally, we would exit the above loop because we
1559 found the display element whose character
1560 position is CHARPOS. For the contingency that we
1561 didn't, and stopped at the first newline from the
1562 display string, move back over the glyphs
1563 produced from the string, until we find the
1564 rightmost glyph not from the string. */
1566 && newline_in_string
1567 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1569 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1570 + it3
.glyph_row
->used
[TEXT_AREA
];
1572 while (EQ ((g
- 1)->object
, string
))
1575 top_x
-= g
->pixel_width
;
1577 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1578 + it3
.glyph_row
->used
[TEXT_AREA
]);
1584 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1585 *rtop
= max (0, window_top_y
- top_y
);
1586 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1587 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1588 - max (top_y
, window_top_y
)));
1590 if (it
.bidi_it
.paragraph_dir
== R2L
)
1596 /* Either we were asked to provide info about WINDOW_END, or
1597 CHARPOS is in the partially visible glyph row at end of
1600 void *it2data
= NULL
;
1602 SAVE_IT (it2
, it
, it2data
);
1603 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1604 move_it_by_lines (&it
, 1);
1605 if (charpos
< IT_CHARPOS (it
)
1606 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1609 RESTORE_IT (&it2
, &it2
, it2data
);
1610 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1612 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1613 *rtop
= max (0, -it2
.current_y
);
1614 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1615 - it
.last_visible_y
));
1616 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1618 - max (it2
.current_y
,
1619 WINDOW_HEADER_LINE_HEIGHT (w
))));
1621 if (it2
.bidi_it
.paragraph_dir
== R2L
)
1625 bidi_unshelve_cache (it2data
, true);
1627 bidi_unshelve_cache (itdata
, false);
1630 set_buffer_internal_1 (old_buffer
);
1636 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1637 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1638 /* For lines in an R2L paragraph, we need to mirror the X pixel
1639 coordinate wrt the text area. For the reasons, see the
1640 commentary in buffer_posn_from_coords and the explanation of
1641 the geometry used by the move_it_* functions at the end of
1642 the large commentary near the beginning of this file. */
1644 *x
= window_box_width (w
, TEXT_AREA
) - *x
- 1;
1648 /* Debugging code. */
1650 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1651 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1653 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1660 /* Return the next character from STR. Return in *LEN the length of
1661 the character. This is like STRING_CHAR_AND_LENGTH but never
1662 returns an invalid character. If we find one, we return a `?', but
1663 with the length of the invalid character. */
1666 string_char_and_length (const unsigned char *str
, int *len
)
1670 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1671 if (!CHAR_VALID_P (c
))
1672 /* We may not change the length here because other places in Emacs
1673 don't use this function, i.e. they silently accept invalid
1682 /* Given a position POS containing a valid character and byte position
1683 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1685 static struct text_pos
1686 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1688 eassert (STRINGP (string
) && nchars
>= 0);
1690 if (STRING_MULTIBYTE (string
))
1692 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1697 string_char_and_length (p
, &len
);
1700 BYTEPOS (pos
) += len
;
1704 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1710 /* Value is the text position, i.e. character and byte position,
1711 for character position CHARPOS in STRING. */
1713 static struct text_pos
1714 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1716 struct text_pos pos
;
1717 eassert (STRINGP (string
));
1718 eassert (charpos
>= 0);
1719 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1724 /* Value is a text position, i.e. character and byte position, for
1725 character position CHARPOS in C string S. MULTIBYTE_P
1726 means recognize multibyte characters. */
1728 static struct text_pos
1729 c_string_pos (ptrdiff_t charpos
, const char *s
, bool multibyte_p
)
1731 struct text_pos pos
;
1733 eassert (s
!= NULL
);
1734 eassert (charpos
>= 0);
1740 SET_TEXT_POS (pos
, 0, 0);
1743 string_char_and_length ((const unsigned char *) s
, &len
);
1746 BYTEPOS (pos
) += len
;
1750 SET_TEXT_POS (pos
, charpos
, charpos
);
1756 /* Value is the number of characters in C string S. MULTIBYTE_P
1757 means recognize multibyte characters. */
1760 number_of_chars (const char *s
, bool multibyte_p
)
1766 ptrdiff_t rest
= strlen (s
);
1768 const unsigned char *p
= (const unsigned char *) s
;
1770 for (nchars
= 0; rest
> 0; ++nchars
)
1772 string_char_and_length (p
, &len
);
1773 rest
-= len
, p
+= len
;
1777 nchars
= strlen (s
);
1783 /* Compute byte position NEWPOS->bytepos corresponding to
1784 NEWPOS->charpos. POS is a known position in string STRING.
1785 NEWPOS->charpos must be >= POS.charpos. */
1788 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1790 eassert (STRINGP (string
));
1791 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1793 if (STRING_MULTIBYTE (string
))
1794 *newpos
= string_pos_nchars_ahead (pos
, string
,
1795 CHARPOS (*newpos
) - CHARPOS (pos
));
1797 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1801 Return an estimation of the pixel height of mode or header lines on
1802 frame F. FACE_ID specifies what line's height to estimate. */
1805 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1807 #ifdef HAVE_WINDOW_SYSTEM
1808 if (FRAME_WINDOW_P (f
))
1810 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1812 /* This function is called so early when Emacs starts that the face
1813 cache and mode line face are not yet initialized. */
1814 if (FRAME_FACE_CACHE (f
))
1816 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1820 height
= normal_char_height (face
->font
, -1);
1821 if (face
->box_line_width
> 0)
1822 height
+= 2 * face
->box_line_width
;
1833 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1834 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1835 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP, do
1836 not force the value into range. */
1839 pixel_to_glyph_coords (struct frame
*f
, int pix_x
, int pix_y
, int *x
, int *y
,
1840 NativeRectangle
*bounds
, bool noclip
)
1843 #ifdef HAVE_WINDOW_SYSTEM
1844 if (FRAME_WINDOW_P (f
))
1846 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1847 even for negative values. */
1849 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1851 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1853 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1854 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1857 STORE_NATIVE_RECT (*bounds
,
1858 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1859 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1860 FRAME_COLUMN_WIDTH (f
) - 1,
1861 FRAME_LINE_HEIGHT (f
) - 1);
1863 /* PXW: Should we clip pixels before converting to columns/lines? */
1868 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1869 pix_x
= FRAME_TOTAL_COLS (f
);
1873 else if (pix_y
> FRAME_TOTAL_LINES (f
))
1874 pix_y
= FRAME_TOTAL_LINES (f
);
1884 /* Find the glyph under window-relative coordinates X/Y in window W.
1885 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1886 strings. Return in *HPOS and *VPOS the row and column number of
1887 the glyph found. Return in *AREA the glyph area containing X.
1888 Value is a pointer to the glyph found or null if X/Y is not on
1889 text, or we can't tell because W's current matrix is not up to
1892 static struct glyph
*
1893 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1894 int *dx
, int *dy
, int *area
)
1896 struct glyph
*glyph
, *end
;
1897 struct glyph_row
*row
= NULL
;
1900 /* Find row containing Y. Give up if some row is not enabled. */
1901 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1903 row
= MATRIX_ROW (w
->current_matrix
, i
);
1904 if (!row
->enabled_p
)
1906 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1913 /* Give up if Y is not in the window. */
1914 if (i
== w
->current_matrix
->nrows
)
1917 /* Get the glyph area containing X. */
1918 if (w
->pseudo_window_p
)
1925 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1927 *area
= LEFT_MARGIN_AREA
;
1928 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1930 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1933 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1937 *area
= RIGHT_MARGIN_AREA
;
1938 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1942 /* Find glyph containing X. */
1943 glyph
= row
->glyphs
[*area
];
1944 end
= glyph
+ row
->used
[*area
];
1946 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1948 x
-= glyph
->pixel_width
;
1958 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1961 *hpos
= glyph
- row
->glyphs
[*area
];
1965 /* Convert frame-relative x/y to coordinates relative to window W.
1966 Takes pseudo-windows into account. */
1969 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1971 if (w
->pseudo_window_p
)
1973 /* A pseudo-window is always full-width, and starts at the
1974 left edge of the frame, plus a frame border. */
1975 struct frame
*f
= XFRAME (w
->frame
);
1976 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1977 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1981 *x
-= WINDOW_LEFT_EDGE_X (w
);
1982 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1986 #ifdef HAVE_WINDOW_SYSTEM
1989 Return in RECTS[] at most N clipping rectangles for glyph string S.
1990 Return the number of stored rectangles. */
1993 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
2000 if (s
->row
->full_width_p
)
2002 /* Draw full-width. X coordinates are relative to S->w->left_col. */
2003 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
2004 if (s
->row
->mode_line_p
)
2005 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
) - WINDOW_RIGHT_DIVIDER_WIDTH (s
->w
);
2007 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
);
2009 /* Unless displaying a mode or menu bar line, which are always
2010 fully visible, clip to the visible part of the row. */
2011 if (s
->w
->pseudo_window_p
)
2012 r
.height
= s
->row
->visible_height
;
2014 r
.height
= s
->height
;
2018 /* This is a text line that may be partially visible. */
2019 r
.x
= window_box_left (s
->w
, s
->area
);
2020 r
.width
= window_box_width (s
->w
, s
->area
);
2021 r
.height
= s
->row
->visible_height
;
2025 if (r
.x
< s
->clip_head
->x
)
2027 if (r
.width
>= s
->clip_head
->x
- r
.x
)
2028 r
.width
-= s
->clip_head
->x
- r
.x
;
2031 r
.x
= s
->clip_head
->x
;
2034 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
2036 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
2037 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
2042 /* If S draws overlapping rows, it's sufficient to use the top and
2043 bottom of the window for clipping because this glyph string
2044 intentionally draws over other lines. */
2045 if (s
->for_overlaps
)
2047 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2048 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
2050 /* Alas, the above simple strategy does not work for the
2051 environments with anti-aliased text: if the same text is
2052 drawn onto the same place multiple times, it gets thicker.
2053 If the overlap we are processing is for the erased cursor, we
2054 take the intersection with the rectangle of the cursor. */
2055 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
2057 XRectangle rc
, r_save
= r
;
2059 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
2060 rc
.y
= s
->w
->phys_cursor
.y
;
2061 rc
.width
= s
->w
->phys_cursor_width
;
2062 rc
.height
= s
->w
->phys_cursor_height
;
2064 x_intersect_rectangles (&r_save
, &rc
, &r
);
2069 /* Don't use S->y for clipping because it doesn't take partially
2070 visible lines into account. For example, it can be negative for
2071 partially visible lines at the top of a window. */
2072 if (!s
->row
->full_width_p
2073 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2074 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2076 r
.y
= max (0, s
->row
->y
);
2079 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2081 /* If drawing the cursor, don't let glyph draw outside its
2082 advertised boundaries. Cleartype does this under some circumstances. */
2083 if (s
->hl
== DRAW_CURSOR
)
2085 struct glyph
*glyph
= s
->first_glyph
;
2090 if (r
.width
>= s
->x
- r
.x
)
2091 r
.width
-= s
->x
- r
.x
;
2092 else /* R2L hscrolled row with cursor outside text area */
2096 r
.width
= min (r
.width
, glyph
->pixel_width
);
2098 /* If r.y is below window bottom, ensure that we still see a cursor. */
2099 height
= min (glyph
->ascent
+ glyph
->descent
,
2100 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2101 max_y
= window_text_bottom_y (s
->w
) - height
;
2102 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2103 if (s
->ybase
- glyph
->ascent
> max_y
)
2110 /* Don't draw cursor glyph taller than our actual glyph. */
2111 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2112 if (height
< r
.height
)
2114 max_y
= r
.y
+ r
.height
;
2115 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2116 r
.height
= min (max_y
- r
.y
, height
);
2123 XRectangle r_save
= r
;
2125 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2129 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2130 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2132 #ifdef CONVERT_FROM_XRECT
2133 CONVERT_FROM_XRECT (r
, *rects
);
2141 /* If we are processing overlapping and allowed to return
2142 multiple clipping rectangles, we exclude the row of the glyph
2143 string from the clipping rectangle. This is to avoid drawing
2144 the same text on the environment with anti-aliasing. */
2145 #ifdef CONVERT_FROM_XRECT
2148 XRectangle
*rs
= rects
;
2150 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2152 if (s
->for_overlaps
& OVERLAPS_PRED
)
2155 if (r
.y
+ r
.height
> row_y
)
2158 rs
[i
].height
= row_y
- r
.y
;
2164 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2167 if (r
.y
< row_y
+ s
->row
->visible_height
)
2169 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2171 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2172 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2181 #ifdef CONVERT_FROM_XRECT
2182 for (i
= 0; i
< n
; i
++)
2183 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2190 Return in *NR the clipping rectangle for glyph string S. */
2193 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2195 get_glyph_string_clip_rects (s
, nr
, 1);
2200 Return the position and height of the phys cursor in window W.
2201 Set w->phys_cursor_width to width of phys cursor.
2205 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2206 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2208 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2209 int x
, y
, wd
, h
, h0
, y0
, ascent
;
2211 /* Compute the width of the rectangle to draw. If on a stretch
2212 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2213 rectangle as wide as the glyph, but use a canonical character
2215 wd
= glyph
->pixel_width
;
2217 x
= w
->phys_cursor
.x
;
2224 if (glyph
->type
== STRETCH_GLYPH
2225 && !x_stretch_cursor_p
)
2226 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2227 w
->phys_cursor_width
= wd
;
2229 /* Don't let the hollow cursor glyph descend below the glyph row's
2230 ascent value, lest the hollow cursor looks funny. */
2231 y
= w
->phys_cursor
.y
;
2232 ascent
= row
->ascent
;
2233 if (row
->ascent
< glyph
->ascent
)
2235 y
=- glyph
->ascent
- row
->ascent
;
2236 ascent
= glyph
->ascent
;
2239 /* If y is below window bottom, ensure that we still see a cursor. */
2240 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2242 h
= max (h0
, ascent
+ glyph
->descent
);
2243 h0
= min (h0
, ascent
+ glyph
->descent
);
2245 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2248 h
= max (h
- (y0
- y
) + 1, h0
);
2253 y0
= window_text_bottom_y (w
) - h0
;
2261 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2262 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2267 * Remember which glyph the mouse is over.
2271 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2275 struct glyph_row
*r
, *gr
, *end_row
;
2276 enum window_part part
;
2277 enum glyph_row_area area
;
2278 int x
, y
, width
, height
;
2280 /* Try to determine frame pixel position and size of the glyph under
2281 frame pixel coordinates X/Y on frame F. */
2283 if (window_resize_pixelwise
)
2288 else if (!f
->glyphs_initialized_p
2289 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, false),
2292 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2293 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2297 w
= XWINDOW (window
);
2298 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2299 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2301 x
= window_relative_x_coord (w
, part
, gx
);
2302 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2304 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2305 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2307 if (w
->pseudo_window_p
)
2310 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2316 case ON_LEFT_MARGIN
:
2317 area
= LEFT_MARGIN_AREA
;
2320 case ON_RIGHT_MARGIN
:
2321 area
= RIGHT_MARGIN_AREA
;
2324 case ON_HEADER_LINE
:
2326 gr
= (part
== ON_HEADER_LINE
2327 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2328 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2331 goto text_glyph_row_found
;
2338 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2339 if (r
->y
+ r
->height
> y
)
2345 text_glyph_row_found
:
2348 struct glyph
*g
= gr
->glyphs
[area
];
2349 struct glyph
*end
= g
+ gr
->used
[area
];
2351 height
= gr
->height
;
2352 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2353 if (gx
+ g
->pixel_width
> x
)
2358 if (g
->type
== IMAGE_GLYPH
)
2360 /* Don't remember when mouse is over image, as
2361 image may have hot-spots. */
2362 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2365 width
= g
->pixel_width
;
2369 /* Use nominal char spacing at end of line. */
2371 gx
+= (x
/ width
) * width
;
2374 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2376 gx
+= window_box_left_offset (w
, area
);
2377 /* Don't expand over the modeline to make sure the vertical
2378 drag cursor is shown early enough. */
2379 height
= min (height
,
2380 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2385 /* Use nominal line height at end of window. */
2386 gx
= (x
/ width
) * width
;
2388 gy
+= (y
/ height
) * height
;
2389 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2390 /* See comment above. */
2391 height
= min (height
,
2392 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2396 case ON_LEFT_FRINGE
:
2397 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2398 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2399 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2400 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2403 case ON_RIGHT_FRINGE
:
2404 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2405 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2406 : window_box_right_offset (w
, TEXT_AREA
));
2407 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
) == 0
2408 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w
)
2409 && !WINDOW_RIGHTMOST_P (w
))
2410 if (gx
< WINDOW_PIXEL_WIDTH (w
) - width
)
2411 /* Make sure the vertical border can get her own glyph to the
2412 right of the one we build here. */
2413 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
) - width
;
2415 width
= WINDOW_PIXEL_WIDTH (w
) - gx
;
2417 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2421 case ON_VERTICAL_BORDER
:
2422 gx
= WINDOW_PIXEL_WIDTH (w
) - width
;
2425 case ON_VERTICAL_SCROLL_BAR
:
2426 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2428 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2429 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2430 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2432 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2436 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2437 if (r
->y
+ r
->height
> y
)
2444 height
= gr
->height
;
2447 /* Use nominal line height at end of window. */
2449 gy
+= (y
/ height
) * height
;
2453 case ON_RIGHT_DIVIDER
:
2454 gx
= WINDOW_PIXEL_WIDTH (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2455 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2457 /* The bottom divider prevails. */
2458 height
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2461 case ON_BOTTOM_DIVIDER
:
2463 width
= WINDOW_PIXEL_WIDTH (w
);
2464 gy
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2465 height
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2471 /* If there is no glyph under the mouse, then we divide the screen
2472 into a grid of the smallest glyph in the frame, and use that
2475 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2476 round down even for negative values. */
2482 gx
= (gx
/ width
) * width
;
2483 gy
= (gy
/ height
) * height
;
2489 gx
+= WINDOW_LEFT_EDGE_X (w
);
2490 gy
+= WINDOW_TOP_EDGE_Y (w
);
2493 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2495 /* Visible feedback for debugging. */
2496 #if false && defined HAVE_X_WINDOWS
2497 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2498 f
->output_data
.x
->normal_gc
,
2499 gx
, gy
, width
, height
);
2504 #endif /* HAVE_WINDOW_SYSTEM */
2507 adjust_window_ends (struct window
*w
, struct glyph_row
*row
, bool current
)
2510 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
2511 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
2513 = MATRIX_ROW_VPOS (row
, current
? w
->current_matrix
: w
->desired_matrix
);
2516 /***********************************************************************
2517 Lisp form evaluation
2518 ***********************************************************************/
2520 /* Error handler for safe_eval and safe_call. */
2523 safe_eval_handler (Lisp_Object arg
, ptrdiff_t nargs
, Lisp_Object
*args
)
2525 add_to_log ("Error during redisplay: %S signaled %S",
2526 Flist (nargs
, args
), arg
);
2530 /* Call function FUNC with the rest of NARGS - 1 arguments
2531 following. Return the result, or nil if something went
2532 wrong. Prevent redisplay during the evaluation. */
2535 safe__call (bool inhibit_quit
, ptrdiff_t nargs
, Lisp_Object func
, va_list ap
)
2539 if (inhibit_eval_during_redisplay
)
2544 ptrdiff_t count
= SPECPDL_INDEX ();
2547 SAFE_ALLOCA_LISP (args
, nargs
);
2550 for (i
= 1; i
< nargs
; i
++)
2551 args
[i
] = va_arg (ap
, Lisp_Object
);
2553 specbind (Qinhibit_redisplay
, Qt
);
2555 specbind (Qinhibit_quit
, Qt
);
2556 /* Use Qt to ensure debugger does not run,
2557 so there is no possibility of wanting to redisplay. */
2558 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2561 val
= unbind_to (count
, val
);
2568 safe_call (ptrdiff_t nargs
, Lisp_Object func
, ...)
2573 va_start (ap
, func
);
2574 retval
= safe__call (false, nargs
, func
, ap
);
2579 /* Call function FN with one argument ARG.
2580 Return the result, or nil if something went wrong. */
2583 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2585 return safe_call (2, fn
, arg
);
2589 safe__call1 (bool inhibit_quit
, Lisp_Object fn
, ...)
2595 retval
= safe__call (inhibit_quit
, 2, fn
, ap
);
2601 safe_eval (Lisp_Object sexpr
)
2603 return safe__call1 (false, Qeval
, sexpr
);
2607 safe__eval (bool inhibit_quit
, Lisp_Object sexpr
)
2609 return safe__call1 (inhibit_quit
, Qeval
, sexpr
);
2612 /* Call function FN with two arguments ARG1 and ARG2.
2613 Return the result, or nil if something went wrong. */
2616 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2618 return safe_call (3, fn
, arg1
, arg2
);
2623 /***********************************************************************
2625 ***********************************************************************/
2627 /* Define CHECK_IT to perform sanity checks on iterators.
2628 This is for debugging. It is too slow to do unconditionally. */
2631 CHECK_IT (struct it
*it
)
2634 if (it
->method
== GET_FROM_STRING
)
2636 eassert (STRINGP (it
->string
));
2637 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2641 eassert (IT_STRING_CHARPOS (*it
) < 0);
2642 if (it
->method
== GET_FROM_BUFFER
)
2644 /* Check that character and byte positions agree. */
2645 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2650 eassert (it
->current
.dpvec_index
>= 0);
2652 eassert (it
->current
.dpvec_index
< 0);
2657 /* Check that the window end of window W is what we expect it
2658 to be---the last row in the current matrix displaying text. */
2661 CHECK_WINDOW_END (struct window
*w
)
2663 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2664 if (!MINI_WINDOW_P (w
) && w
->window_end_valid
)
2666 struct glyph_row
*row
;
2667 eassert ((row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
),
2669 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2670 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2675 /***********************************************************************
2676 Iterator initialization
2677 ***********************************************************************/
2679 /* Initialize IT for displaying current_buffer in window W, starting
2680 at character position CHARPOS. CHARPOS < 0 means that no buffer
2681 position is specified which is useful when the iterator is assigned
2682 a position later. BYTEPOS is the byte position corresponding to
2685 If ROW is not null, calls to produce_glyphs with IT as parameter
2686 will produce glyphs in that row.
2688 BASE_FACE_ID is the id of a base face to use. It must be one of
2689 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2690 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2691 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2693 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2694 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2695 will be initialized to use the corresponding mode line glyph row of
2696 the desired matrix of W. */
2699 init_iterator (struct it
*it
, struct window
*w
,
2700 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2701 struct glyph_row
*row
, enum face_id base_face_id
)
2703 enum face_id remapped_base_face_id
= base_face_id
;
2705 /* Some precondition checks. */
2706 eassert (w
!= NULL
&& it
!= NULL
);
2707 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2710 /* If face attributes have been changed since the last redisplay,
2711 free realized faces now because they depend on face definitions
2712 that might have changed. Don't free faces while there might be
2713 desired matrices pending which reference these faces. */
2714 if (!inhibit_free_realized_faces
)
2718 face_change
= false;
2719 free_all_realized_faces (Qnil
);
2721 else if (XFRAME (w
->frame
)->face_change
)
2723 XFRAME (w
->frame
)->face_change
= 0;
2724 free_all_realized_faces (w
->frame
);
2728 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2729 if (! NILP (Vface_remapping_alist
))
2730 remapped_base_face_id
2731 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2733 /* Use one of the mode line rows of W's desired matrix if
2737 if (base_face_id
== MODE_LINE_FACE_ID
2738 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2739 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2740 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2741 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2744 /* Clear IT, and set it->object and other IT's Lisp objects to Qnil.
2745 Other parts of redisplay rely on that. */
2746 memclear (it
, sizeof *it
);
2747 it
->current
.overlay_string_index
= -1;
2748 it
->current
.dpvec_index
= -1;
2749 it
->base_face_id
= remapped_base_face_id
;
2750 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2751 it
->paragraph_embedding
= L2R
;
2754 /* The window in which we iterate over current_buffer: */
2755 XSETWINDOW (it
->window
, w
);
2757 it
->f
= XFRAME (w
->frame
);
2761 /* Extra space between lines (on window systems only). */
2762 if (base_face_id
== DEFAULT_FACE_ID
2763 && FRAME_WINDOW_P (it
->f
))
2765 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2766 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2767 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2768 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2769 * FRAME_LINE_HEIGHT (it
->f
));
2770 else if (it
->f
->extra_line_spacing
> 0)
2771 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2774 /* If realized faces have been removed, e.g. because of face
2775 attribute changes of named faces, recompute them. When running
2776 in batch mode, the face cache of the initial frame is null. If
2777 we happen to get called, make a dummy face cache. */
2778 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2779 init_frame_faces (it
->f
);
2780 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2781 recompute_basic_faces (it
->f
);
2783 it
->override_ascent
= -1;
2785 /* Are control characters displayed as `^C'? */
2786 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2788 /* -1 means everything between a CR and the following line end
2789 is invisible. >0 means lines indented more than this value are
2791 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2793 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2795 : (!NILP (BVAR (current_buffer
, selective_display
))
2797 it
->selective_display_ellipsis_p
2798 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2800 /* Display table to use. */
2801 it
->dp
= window_display_table (w
);
2803 /* Are multibyte characters enabled in current_buffer? */
2804 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2806 /* Get the position at which the redisplay_end_trigger hook should
2807 be run, if it is to be run at all. */
2808 if (MARKERP (w
->redisplay_end_trigger
)
2809 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2810 it
->redisplay_end_trigger_charpos
2811 = marker_position (w
->redisplay_end_trigger
);
2812 else if (INTEGERP (w
->redisplay_end_trigger
))
2813 it
->redisplay_end_trigger_charpos
2814 = clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
),
2817 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2819 /* Are lines in the display truncated? */
2821 it
->line_wrap
= TRUNCATE
;
2822 if (base_face_id
== DEFAULT_FACE_ID
2824 && (WINDOW_FULL_WIDTH_P (it
->w
)
2825 || NILP (Vtruncate_partial_width_windows
)
2826 || (INTEGERP (Vtruncate_partial_width_windows
)
2827 /* PXW: Shall we do something about this? */
2828 && (XINT (Vtruncate_partial_width_windows
)
2829 <= WINDOW_TOTAL_COLS (it
->w
))))
2830 && NILP (BVAR (current_buffer
, truncate_lines
)))
2831 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2832 ? WINDOW_WRAP
: WORD_WRAP
;
2834 /* Get dimensions of truncation and continuation glyphs. These are
2835 displayed as fringe bitmaps under X, but we need them for such
2836 frames when the fringes are turned off. But leave the dimensions
2837 zero for tooltip frames, as these glyphs look ugly there and also
2838 sabotage calculations of tooltip dimensions in x-show-tip. */
2839 #ifdef HAVE_WINDOW_SYSTEM
2840 if (!(FRAME_WINDOW_P (it
->f
)
2841 && FRAMEP (tip_frame
)
2842 && it
->f
== XFRAME (tip_frame
)))
2845 if (it
->line_wrap
== TRUNCATE
)
2847 /* We will need the truncation glyph. */
2848 eassert (it
->glyph_row
== NULL
);
2849 produce_special_glyphs (it
, IT_TRUNCATION
);
2850 it
->truncation_pixel_width
= it
->pixel_width
;
2854 /* We will need the continuation glyph. */
2855 eassert (it
->glyph_row
== NULL
);
2856 produce_special_glyphs (it
, IT_CONTINUATION
);
2857 it
->continuation_pixel_width
= it
->pixel_width
;
2861 /* Reset these values to zero because the produce_special_glyphs
2862 above has changed them. */
2863 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2864 it
->phys_ascent
= it
->phys_descent
= 0;
2866 /* Set this after getting the dimensions of truncation and
2867 continuation glyphs, so that we don't produce glyphs when calling
2868 produce_special_glyphs, above. */
2869 it
->glyph_row
= row
;
2870 it
->area
= TEXT_AREA
;
2872 /* Get the dimensions of the display area. The display area
2873 consists of the visible window area plus a horizontally scrolled
2874 part to the left of the window. All x-values are relative to the
2875 start of this total display area. */
2876 if (base_face_id
!= DEFAULT_FACE_ID
)
2878 /* Mode lines, menu bar in terminal frames. */
2879 it
->first_visible_x
= 0;
2880 it
->last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
2885 = window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2886 it
->last_visible_x
= (it
->first_visible_x
2887 + window_box_width (w
, TEXT_AREA
));
2889 /* If we truncate lines, leave room for the truncation glyph(s) at
2890 the right margin. Otherwise, leave room for the continuation
2891 glyph(s). Done only if the window has no right fringe. */
2892 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
2894 if (it
->line_wrap
== TRUNCATE
)
2895 it
->last_visible_x
-= it
->truncation_pixel_width
;
2897 it
->last_visible_x
-= it
->continuation_pixel_width
;
2900 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2901 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2904 /* Leave room for a border glyph. */
2905 if (!FRAME_WINDOW_P (it
->f
)
2906 && !WINDOW_RIGHTMOST_P (it
->w
))
2907 it
->last_visible_x
-= 1;
2909 it
->last_visible_y
= window_text_bottom_y (w
);
2911 /* For mode lines and alike, arrange for the first glyph having a
2912 left box line if the face specifies a box. */
2913 if (base_face_id
!= DEFAULT_FACE_ID
)
2917 it
->face_id
= remapped_base_face_id
;
2919 /* If we have a boxed mode line, make the first character appear
2920 with a left box line. */
2921 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2922 if (face
&& face
->box
!= FACE_NO_BOX
)
2923 it
->start_of_box_run_p
= true;
2926 /* If a buffer position was specified, set the iterator there,
2927 getting overlays and face properties from that position. */
2928 if (charpos
>= BUF_BEG (current_buffer
))
2930 it
->stop_charpos
= charpos
;
2931 it
->end_charpos
= ZV
;
2932 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
2933 IT_CHARPOS (*it
) = charpos
;
2934 IT_BYTEPOS (*it
) = bytepos
;
2936 /* We will rely on `reseat' to set this up properly, via
2937 handle_face_prop. */
2938 it
->face_id
= it
->base_face_id
;
2940 it
->start
= it
->current
;
2941 /* Do we need to reorder bidirectional text? Not if this is a
2942 unibyte buffer: by definition, none of the single-byte
2943 characters are strong R2L, so no reordering is needed. And
2944 bidi.c doesn't support unibyte buffers anyway. Also, don't
2945 reorder while we are loading loadup.el, since the tables of
2946 character properties needed for reordering are not yet
2950 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2953 /* If we are to reorder bidirectional text, init the bidi
2957 /* Since we don't know at this point whether there will be
2958 any R2L lines in the window, we reserve space for
2959 truncation/continuation glyphs even if only the left
2960 fringe is absent. */
2961 if (base_face_id
== DEFAULT_FACE_ID
2962 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
2963 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
2965 if (it
->line_wrap
== TRUNCATE
)
2966 it
->last_visible_x
-= it
->truncation_pixel_width
;
2968 it
->last_visible_x
-= it
->continuation_pixel_width
;
2970 /* Note the paragraph direction that this buffer wants to
2972 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2974 it
->paragraph_embedding
= L2R
;
2975 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2977 it
->paragraph_embedding
= R2L
;
2979 it
->paragraph_embedding
= NEUTRAL_DIR
;
2980 bidi_unshelve_cache (NULL
, false);
2981 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2985 /* Compute faces etc. */
2986 reseat (it
, it
->current
.pos
, true);
2993 /* Initialize IT for the display of window W with window start POS. */
2996 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2998 struct glyph_row
*row
;
2999 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
3001 row
= w
->desired_matrix
->rows
+ first_vpos
;
3002 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
3003 it
->first_vpos
= first_vpos
;
3005 /* Don't reseat to previous visible line start if current start
3006 position is in a string or image. */
3007 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
3009 int first_y
= it
->current_y
;
3011 /* If window start is not at a line start, skip forward to POS to
3012 get the correct continuation lines width. */
3013 bool start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
3014 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
3015 if (!start_at_line_beg_p
)
3019 reseat_at_previous_visible_line_start (it
);
3020 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
3022 new_x
= it
->current_x
+ it
->pixel_width
;
3024 /* If lines are continued, this line may end in the middle
3025 of a multi-glyph character (e.g. a control character
3026 displayed as \003, or in the middle of an overlay
3027 string). In this case move_it_to above will not have
3028 taken us to the start of the continuation line but to the
3029 end of the continued line. */
3030 if (it
->current_x
> 0
3031 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
3032 && (/* And glyph doesn't fit on the line. */
3033 new_x
> it
->last_visible_x
3034 /* Or it fits exactly and we're on a window
3036 || (new_x
== it
->last_visible_x
3037 && FRAME_WINDOW_P (it
->f
)
3038 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
3039 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
3040 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
3042 if ((it
->current
.dpvec_index
>= 0
3043 || it
->current
.overlay_string_index
>= 0)
3044 /* If we are on a newline from a display vector or
3045 overlay string, then we are already at the end of
3046 a screen line; no need to go to the next line in
3047 that case, as this line is not really continued.
3048 (If we do go to the next line, C-e will not DTRT.) */
3051 set_iterator_to_next (it
, true);
3052 move_it_in_display_line_to (it
, -1, -1, 0);
3055 it
->continuation_lines_width
+= it
->current_x
;
3057 /* If the character at POS is displayed via a display
3058 vector, move_it_to above stops at the final glyph of
3059 IT->dpvec. To make the caller redisplay that character
3060 again (a.k.a. start at POS), we need to reset the
3061 dpvec_index to the beginning of IT->dpvec. */
3062 else if (it
->current
.dpvec_index
>= 0)
3063 it
->current
.dpvec_index
= 0;
3065 /* We're starting a new display line, not affected by the
3066 height of the continued line, so clear the appropriate
3067 fields in the iterator structure. */
3068 it
->max_ascent
= it
->max_descent
= 0;
3069 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3071 it
->current_y
= first_y
;
3073 it
->current_x
= it
->hpos
= 0;
3079 /* Return true if POS is a position in ellipses displayed for invisible
3080 text. W is the window we display, for text property lookup. */
3083 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3085 Lisp_Object prop
, window
;
3086 bool ellipses_p
= false;
3087 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3089 /* If POS specifies a position in a display vector, this might
3090 be for an ellipsis displayed for invisible text. We won't
3091 get the iterator set up for delivering that ellipsis unless
3092 we make sure that it gets aware of the invisible text. */
3093 if (pos
->dpvec_index
>= 0
3094 && pos
->overlay_string_index
< 0
3095 && CHARPOS (pos
->string_pos
) < 0
3097 && (XSETWINDOW (window
, w
),
3098 prop
= Fget_char_property (make_number (charpos
),
3099 Qinvisible
, window
),
3100 TEXT_PROP_MEANS_INVISIBLE (prop
) == 0))
3102 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3104 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3111 /* Initialize IT for stepping through current_buffer in window W,
3112 starting at position POS that includes overlay string and display
3113 vector/ control character translation position information. Value
3114 is false if there are overlay strings with newlines at POS. */
3117 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3119 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3121 bool overlay_strings_with_newlines
= false;
3123 /* If POS specifies a position in a display vector, this might
3124 be for an ellipsis displayed for invisible text. We won't
3125 get the iterator set up for delivering that ellipsis unless
3126 we make sure that it gets aware of the invisible text. */
3127 if (in_ellipses_for_invisible_text_p (pos
, w
))
3133 /* Keep in mind: the call to reseat in init_iterator skips invisible
3134 text, so we might end up at a position different from POS. This
3135 is only a problem when POS is a row start after a newline and an
3136 overlay starts there with an after-string, and the overlay has an
3137 invisible property. Since we don't skip invisible text in
3138 display_line and elsewhere immediately after consuming the
3139 newline before the row start, such a POS will not be in a string,
3140 but the call to init_iterator below will move us to the
3142 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3144 /* This only scans the current chunk -- it should scan all chunks.
3145 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3146 to 16 in 22.1 to make this a lesser problem. */
3147 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3149 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3150 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3152 while (s
< e
&& *s
!= '\n')
3157 overlay_strings_with_newlines
= true;
3162 /* If position is within an overlay string, set up IT to the right
3164 if (pos
->overlay_string_index
>= 0)
3168 /* If the first overlay string happens to have a `display'
3169 property for an image, the iterator will be set up for that
3170 image, and we have to undo that setup first before we can
3171 correct the overlay string index. */
3172 if (it
->method
== GET_FROM_IMAGE
)
3175 /* We already have the first chunk of overlay strings in
3176 IT->overlay_strings. Load more until the one for
3177 pos->overlay_string_index is in IT->overlay_strings. */
3178 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3180 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3181 it
->current
.overlay_string_index
= 0;
3184 load_overlay_strings (it
, 0);
3185 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3189 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3190 relative_index
= (it
->current
.overlay_string_index
3191 % OVERLAY_STRING_CHUNK_SIZE
);
3192 it
->string
= it
->overlay_strings
[relative_index
];
3193 eassert (STRINGP (it
->string
));
3194 it
->current
.string_pos
= pos
->string_pos
;
3195 it
->method
= GET_FROM_STRING
;
3196 it
->end_charpos
= SCHARS (it
->string
);
3197 /* Set up the bidi iterator for this overlay string. */
3200 it
->bidi_it
.string
.lstring
= it
->string
;
3201 it
->bidi_it
.string
.s
= NULL
;
3202 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3203 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3204 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3205 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3206 it
->bidi_it
.w
= it
->w
;
3207 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3208 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3210 /* Synchronize the state of the bidi iterator with
3211 pos->string_pos. For any string position other than
3212 zero, this will be done automagically when we resume
3213 iteration over the string and get_visually_first_element
3214 is called. But if string_pos is zero, and the string is
3215 to be reordered for display, we need to resync manually,
3216 since it could be that the iteration state recorded in
3217 pos ended at string_pos of 0 moving backwards in string. */
3218 if (CHARPOS (pos
->string_pos
) == 0)
3220 get_visually_first_element (it
);
3221 if (IT_STRING_CHARPOS (*it
) != 0)
3224 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3225 bidi_move_to_visually_next (&it
->bidi_it
);
3226 } while (it
->bidi_it
.charpos
!= 0);
3228 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3229 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3233 if (CHARPOS (pos
->string_pos
) >= 0)
3235 /* Recorded position is not in an overlay string, but in another
3236 string. This can only be a string from a `display' property.
3237 IT should already be filled with that string. */
3238 it
->current
.string_pos
= pos
->string_pos
;
3239 eassert (STRINGP (it
->string
));
3241 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3242 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3245 /* Restore position in display vector translations, control
3246 character translations or ellipses. */
3247 if (pos
->dpvec_index
>= 0)
3249 if (it
->dpvec
== NULL
)
3250 get_next_display_element (it
);
3251 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3252 it
->current
.dpvec_index
= pos
->dpvec_index
;
3256 return !overlay_strings_with_newlines
;
3260 /* Initialize IT for stepping through current_buffer in window W
3261 starting at ROW->start. */
3264 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3266 init_from_display_pos (it
, w
, &row
->start
);
3267 it
->start
= row
->start
;
3268 it
->continuation_lines_width
= row
->continuation_lines_width
;
3273 /* Initialize IT for stepping through current_buffer in window W
3274 starting in the line following ROW, i.e. starting at ROW->end.
3275 Value is false if there are overlay strings with newlines at ROW's
3279 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3281 bool success
= false;
3283 if (init_from_display_pos (it
, w
, &row
->end
))
3285 if (row
->continued_p
)
3286 it
->continuation_lines_width
3287 = row
->continuation_lines_width
+ row
->pixel_width
;
3298 /***********************************************************************
3300 ***********************************************************************/
3302 /* Called when IT reaches IT->stop_charpos. Handle text property and
3303 overlay changes. Set IT->stop_charpos to the next position where
3307 handle_stop (struct it
*it
)
3309 enum prop_handled handled
;
3310 bool handle_overlay_change_p
;
3314 it
->current
.dpvec_index
= -1;
3315 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3316 it
->ellipsis_p
= false;
3318 /* Use face of preceding text for ellipsis (if invisible) */
3319 if (it
->selective_display_ellipsis_p
)
3320 it
->saved_face_id
= it
->face_id
;
3322 /* Here's the description of the semantics of, and the logic behind,
3323 the various HANDLED_* statuses:
3325 HANDLED_NORMALLY means the handler did its job, and the loop
3326 should proceed to calling the next handler in order.
3328 HANDLED_RECOMPUTE_PROPS means the handler caused a significant
3329 change in the properties and overlays at current position, so the
3330 loop should be restarted, to re-invoke the handlers that were
3331 already called. This happens when fontification-functions were
3332 called by handle_fontified_prop, and actually fontified
3333 something. Another case where HANDLED_RECOMPUTE_PROPS is
3334 returned is when we discover overlay strings that need to be
3335 displayed right away. The loop below will continue for as long
3336 as the status is HANDLED_RECOMPUTE_PROPS.
3338 HANDLED_RETURN means return immediately to the caller, to
3339 continue iteration without calling any further handlers. This is
3340 used when we need to act on some property right away, for example
3341 when we need to display the ellipsis or a replacing display
3342 property, such as display string or image.
3344 HANDLED_OVERLAY_STRING_CONSUMED means an overlay string was just
3345 consumed, and the handler switched to the next overlay string.
3346 This signals the loop below to refrain from looking for more
3347 overlays before all the overlay strings of the current overlay
3350 Some of the handlers called by the loop push the iterator state
3351 onto the stack (see 'push_it'), and arrange for the iteration to
3352 continue with another object, such as an image, a display string,
3353 or an overlay string. In most such cases, it->stop_charpos is
3354 set to the first character of the string, so that when the
3355 iteration resumes, this function will immediately be called
3356 again, to examine the properties at the beginning of the string.
3358 When a display or overlay string is exhausted, the iterator state
3359 is popped (see 'pop_it'), and iteration continues with the
3360 previous object. Again, in many such cases this function is
3361 called again to find the next position where properties might
3366 handled
= HANDLED_NORMALLY
;
3368 /* Call text property handlers. */
3369 for (p
= it_props
; p
->handler
; ++p
)
3371 handled
= p
->handler (it
);
3373 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3375 else if (handled
== HANDLED_RETURN
)
3377 /* We still want to show before and after strings from
3378 overlays even if the actual buffer text is replaced. */
3379 if (!handle_overlay_change_p
3381 /* Don't call get_overlay_strings_1 if we already
3382 have overlay strings loaded, because doing so
3383 will load them again and push the iterator state
3384 onto the stack one more time, which is not
3385 expected by the rest of the code that processes
3387 || (it
->current
.overlay_string_index
< 0
3388 && !get_overlay_strings_1 (it
, 0, false)))
3391 setup_for_ellipsis (it
, 0);
3392 /* When handling a display spec, we might load an
3393 empty string. In that case, discard it here. We
3394 used to discard it in handle_single_display_spec,
3395 but that causes get_overlay_strings_1, above, to
3396 ignore overlay strings that we must check. */
3397 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3401 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3405 it
->string_from_display_prop_p
= false;
3406 it
->from_disp_prop_p
= false;
3407 handle_overlay_change_p
= false;
3409 handled
= HANDLED_RECOMPUTE_PROPS
;
3412 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3413 handle_overlay_change_p
= false;
3416 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3418 /* Don't check for overlay strings below when set to deliver
3419 characters from a display vector. */
3420 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3421 handle_overlay_change_p
= false;
3423 /* Handle overlay changes.
3424 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3425 if it finds overlays. */
3426 if (handle_overlay_change_p
)
3427 handled
= handle_overlay_change (it
);
3432 setup_for_ellipsis (it
, 0);
3436 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3438 /* Determine where to stop next. */
3439 if (handled
== HANDLED_NORMALLY
)
3440 compute_stop_pos (it
);
3444 /* Compute IT->stop_charpos from text property and overlay change
3445 information for IT's current position. */
3448 compute_stop_pos (struct it
*it
)
3450 register INTERVAL iv
, next_iv
;
3451 Lisp_Object object
, limit
, position
;
3452 ptrdiff_t charpos
, bytepos
;
3454 if (STRINGP (it
->string
))
3456 /* Strings are usually short, so don't limit the search for
3458 it
->stop_charpos
= it
->end_charpos
;
3459 object
= it
->string
;
3461 charpos
= IT_STRING_CHARPOS (*it
);
3462 bytepos
= IT_STRING_BYTEPOS (*it
);
3468 /* If end_charpos is out of range for some reason, such as a
3469 misbehaving display function, rationalize it (Bug#5984). */
3470 if (it
->end_charpos
> ZV
)
3471 it
->end_charpos
= ZV
;
3472 it
->stop_charpos
= it
->end_charpos
;
3474 /* If next overlay change is in front of the current stop pos
3475 (which is IT->end_charpos), stop there. Note: value of
3476 next_overlay_change is point-max if no overlay change
3478 charpos
= IT_CHARPOS (*it
);
3479 bytepos
= IT_BYTEPOS (*it
);
3480 pos
= next_overlay_change (charpos
);
3481 if (pos
< it
->stop_charpos
)
3482 it
->stop_charpos
= pos
;
3484 /* Set up variables for computing the stop position from text
3485 property changes. */
3486 XSETBUFFER (object
, current_buffer
);
3487 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3490 /* Get the interval containing IT's position. Value is a null
3491 interval if there isn't such an interval. */
3492 position
= make_number (charpos
);
3493 iv
= validate_interval_range (object
, &position
, &position
, false);
3496 Lisp_Object values_here
[LAST_PROP_IDX
];
3499 /* Get properties here. */
3500 for (p
= it_props
; p
->handler
; ++p
)
3501 values_here
[p
->idx
] = textget (iv
->plist
,
3502 builtin_lisp_symbol (p
->name
));
3504 /* Look for an interval following iv that has different
3506 for (next_iv
= next_interval (iv
);
3509 || XFASTINT (limit
) > next_iv
->position
));
3510 next_iv
= next_interval (next_iv
))
3512 for (p
= it_props
; p
->handler
; ++p
)
3514 Lisp_Object new_value
= textget (next_iv
->plist
,
3515 builtin_lisp_symbol (p
->name
));
3516 if (!EQ (values_here
[p
->idx
], new_value
))
3526 if (INTEGERP (limit
)
3527 && next_iv
->position
>= XFASTINT (limit
))
3528 /* No text property change up to limit. */
3529 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3531 /* Text properties change in next_iv. */
3532 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3536 if (it
->cmp_it
.id
< 0)
3538 ptrdiff_t stoppos
= it
->end_charpos
;
3540 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3542 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3543 stoppos
, it
->string
);
3546 eassert (STRINGP (it
->string
)
3547 || (it
->stop_charpos
>= BEGV
3548 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3552 /* Return the position of the next overlay change after POS in
3553 current_buffer. Value is point-max if no overlay change
3554 follows. This is like `next-overlay-change' but doesn't use
3558 next_overlay_change (ptrdiff_t pos
)
3560 ptrdiff_t i
, noverlays
;
3562 Lisp_Object
*overlays
;
3565 /* Get all overlays at the given position. */
3566 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, true);
3568 /* If any of these overlays ends before endpos,
3569 use its ending point instead. */
3570 for (i
= 0; i
< noverlays
; ++i
)
3575 oend
= OVERLAY_END (overlays
[i
]);
3576 oendpos
= OVERLAY_POSITION (oend
);
3577 endpos
= min (endpos
, oendpos
);
3584 /* How many characters forward to search for a display property or
3585 display string. Searching too far forward makes the bidi display
3586 sluggish, especially in small windows. */
3587 #define MAX_DISP_SCAN 250
3589 /* Return the character position of a display string at or after
3590 position specified by POSITION. If no display string exists at or
3591 after POSITION, return ZV. A display string is either an overlay
3592 with `display' property whose value is a string, or a `display'
3593 text property whose value is a string. STRING is data about the
3594 string to iterate; if STRING->lstring is nil, we are iterating a
3595 buffer. FRAME_WINDOW_P is true when we are displaying a window
3596 on a GUI frame. DISP_PROP is set to zero if we searched
3597 MAX_DISP_SCAN characters forward without finding any display
3598 strings, non-zero otherwise. It is set to 2 if the display string
3599 uses any kind of `(space ...)' spec that will produce a stretch of
3600 white space in the text area. */
3602 compute_display_string_pos (struct text_pos
*position
,
3603 struct bidi_string_data
*string
,
3605 bool frame_window_p
, int *disp_prop
)
3607 /* OBJECT = nil means current buffer. */
3608 Lisp_Object object
, object1
;
3609 Lisp_Object pos
, spec
, limpos
;
3610 bool string_p
= string
&& (STRINGP (string
->lstring
) || string
->s
);
3611 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3612 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3613 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3615 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3616 struct text_pos tpos
;
3619 if (string
&& STRINGP (string
->lstring
))
3620 object1
= object
= string
->lstring
;
3621 else if (w
&& !string_p
)
3623 XSETWINDOW (object
, w
);
3627 object1
= object
= Qnil
;
3632 /* We don't support display properties whose values are strings
3633 that have display string properties. */
3634 || string
->from_disp_str
3635 /* C strings cannot have display properties. */
3636 || (string
->s
&& !STRINGP (object
)))
3642 /* If the character at CHARPOS is where the display string begins,
3644 pos
= make_number (charpos
);
3645 if (STRINGP (object
))
3646 bufpos
= string
->bufpos
;
3650 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3652 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3655 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3663 /* Look forward for the first character with a `display' property
3664 that will replace the underlying text when displayed. */
3665 limpos
= make_number (lim
);
3667 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3668 CHARPOS (tpos
) = XFASTINT (pos
);
3669 if (CHARPOS (tpos
) >= lim
)
3674 if (STRINGP (object
))
3675 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3677 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3678 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3679 if (!STRINGP (object
))
3680 bufpos
= CHARPOS (tpos
);
3681 } while (NILP (spec
)
3682 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3683 bufpos
, frame_window_p
)));
3687 return CHARPOS (tpos
);
3690 /* Return the character position of the end of the display string that
3691 started at CHARPOS. If there's no display string at CHARPOS,
3692 return -1. A display string is either an overlay with `display'
3693 property whose value is a string or a `display' text property whose
3694 value is a string. */
3696 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3698 /* OBJECT = nil means current buffer. */
3699 Lisp_Object object
=
3700 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3701 Lisp_Object pos
= make_number (charpos
);
3703 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3705 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3708 /* It could happen that the display property or overlay was removed
3709 since we found it in compute_display_string_pos above. One way
3710 this can happen is if JIT font-lock was called (through
3711 handle_fontified_prop), and jit-lock-functions remove text
3712 properties or overlays from the portion of buffer that includes
3713 CHARPOS. Muse mode is known to do that, for example. In this
3714 case, we return -1 to the caller, to signal that no display
3715 string is actually present at CHARPOS. See bidi_fetch_char for
3716 how this is handled.
3718 An alternative would be to never look for display properties past
3719 it->stop_charpos. But neither compute_display_string_pos nor
3720 bidi_fetch_char that calls it know or care where the next
3722 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3725 /* Look forward for the first character where the `display' property
3727 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3729 return XFASTINT (pos
);
3734 /***********************************************************************
3736 ***********************************************************************/
3738 /* Handle changes in the `fontified' property of the current buffer by
3739 calling hook functions from Qfontification_functions to fontify
3742 static enum prop_handled
3743 handle_fontified_prop (struct it
*it
)
3745 Lisp_Object prop
, pos
;
3746 enum prop_handled handled
= HANDLED_NORMALLY
;
3748 if (!NILP (Vmemory_full
))
3751 /* Get the value of the `fontified' property at IT's current buffer
3752 position. (The `fontified' property doesn't have a special
3753 meaning in strings.) If the value is nil, call functions from
3754 Qfontification_functions. */
3755 if (!STRINGP (it
->string
)
3757 && !NILP (Vfontification_functions
)
3758 && !NILP (Vrun_hooks
)
3759 && (pos
= make_number (IT_CHARPOS (*it
)),
3760 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3761 /* Ignore the special cased nil value always present at EOB since
3762 no amount of fontifying will be able to change it. */
3763 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3765 ptrdiff_t count
= SPECPDL_INDEX ();
3767 struct buffer
*obuf
= current_buffer
;
3768 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3769 bool old_clip_changed
= current_buffer
->clip_changed
;
3771 val
= Vfontification_functions
;
3772 specbind (Qfontification_functions
, Qnil
);
3774 eassert (it
->end_charpos
== ZV
);
3776 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3777 safe_call1 (val
, pos
);
3780 Lisp_Object fns
, fn
;
3784 for (; CONSP (val
); val
= XCDR (val
))
3790 /* A value of t indicates this hook has a local
3791 binding; it means to run the global binding too.
3792 In a global value, t should not occur. If it
3793 does, we must ignore it to avoid an endless
3795 for (fns
= Fdefault_value (Qfontification_functions
);
3801 safe_call1 (fn
, pos
);
3805 safe_call1 (fn
, pos
);
3809 unbind_to (count
, Qnil
);
3811 /* Fontification functions routinely call `save-restriction'.
3812 Normally, this tags clip_changed, which can confuse redisplay
3813 (see discussion in Bug#6671). Since we don't perform any
3814 special handling of fontification changes in the case where
3815 `save-restriction' isn't called, there's no point doing so in
3816 this case either. So, if the buffer's restrictions are
3817 actually left unchanged, reset clip_changed. */
3818 if (obuf
== current_buffer
)
3820 if (begv
== BEGV
&& zv
== ZV
)
3821 current_buffer
->clip_changed
= old_clip_changed
;
3823 /* There isn't much we can reasonably do to protect against
3824 misbehaving fontification, but here's a fig leaf. */
3825 else if (BUFFER_LIVE_P (obuf
))
3826 set_buffer_internal_1 (obuf
);
3828 /* The fontification code may have added/removed text.
3829 It could do even a lot worse, but let's at least protect against
3830 the most obvious case where only the text past `pos' gets changed',
3831 as is/was done in grep.el where some escapes sequences are turned
3832 into face properties (bug#7876). */
3833 it
->end_charpos
= ZV
;
3835 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3836 something. This avoids an endless loop if they failed to
3837 fontify the text for which reason ever. */
3838 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3839 handled
= HANDLED_RECOMPUTE_PROPS
;
3847 /***********************************************************************
3849 ***********************************************************************/
3851 /* Set up iterator IT from face properties at its current position.
3852 Called from handle_stop. */
3854 static enum prop_handled
3855 handle_face_prop (struct it
*it
)
3858 ptrdiff_t next_stop
;
3860 if (!STRINGP (it
->string
))
3863 = face_at_buffer_position (it
->w
,
3867 + TEXT_PROP_DISTANCE_LIMIT
),
3868 false, it
->base_face_id
);
3870 /* Is this a start of a run of characters with box face?
3871 Caveat: this can be called for a freshly initialized
3872 iterator; face_id is -1 in this case. We know that the new
3873 face will not change until limit, i.e. if the new face has a
3874 box, all characters up to limit will have one. But, as
3875 usual, we don't know whether limit is really the end. */
3876 if (new_face_id
!= it
->face_id
)
3878 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3879 /* If it->face_id is -1, old_face below will be NULL, see
3880 the definition of FACE_FROM_ID. This will happen if this
3881 is the initial call that gets the face. */
3882 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3884 /* If the value of face_id of the iterator is -1, we have to
3885 look in front of IT's position and see whether there is a
3886 face there that's different from new_face_id. */
3887 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
3889 int prev_face_id
= face_before_it_pos (it
);
3891 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
3894 /* If the new face has a box, but the old face does not,
3895 this is the start of a run of characters with box face,
3896 i.e. this character has a shadow on the left side. */
3897 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
3898 && (old_face
== NULL
|| !old_face
->box
));
3899 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3907 Lisp_Object from_overlay
3908 = (it
->current
.overlay_string_index
>= 0
3909 ? it
->string_overlays
[it
->current
.overlay_string_index
3910 % OVERLAY_STRING_CHUNK_SIZE
]
3913 /* See if we got to this string directly or indirectly from
3914 an overlay property. That includes the before-string or
3915 after-string of an overlay, strings in display properties
3916 provided by an overlay, their text properties, etc.
3918 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3919 if (! NILP (from_overlay
))
3920 for (i
= it
->sp
- 1; i
>= 0; i
--)
3922 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3924 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3925 % OVERLAY_STRING_CHUNK_SIZE
];
3926 else if (! NILP (it
->stack
[i
].from_overlay
))
3927 from_overlay
= it
->stack
[i
].from_overlay
;
3929 if (!NILP (from_overlay
))
3933 if (! NILP (from_overlay
))
3935 bufpos
= IT_CHARPOS (*it
);
3936 /* For a string from an overlay, the base face depends
3937 only on text properties and ignores overlays. */
3939 = face_for_overlay_string (it
->w
,
3943 + TEXT_PROP_DISTANCE_LIMIT
),
3951 /* For strings from a `display' property, use the face at
3952 IT's current buffer position as the base face to merge
3953 with, so that overlay strings appear in the same face as
3954 surrounding text, unless they specify their own faces.
3955 For strings from wrap-prefix and line-prefix properties,
3956 use the default face, possibly remapped via
3957 Vface_remapping_alist. */
3958 /* Note that the fact that we use the face at _buffer_
3959 position means that a 'display' property on an overlay
3960 string will not inherit the face of that overlay string,
3961 but will instead revert to the face of buffer text
3962 covered by the overlay. This is visible, e.g., when the
3963 overlay specifies a box face, but neither the buffer nor
3964 the display string do. This sounds like a design bug,
3965 but Emacs always did that since v21.1, so changing that
3966 might be a big deal. */
3967 base_face_id
= it
->string_from_prefix_prop_p
3968 ? (!NILP (Vface_remapping_alist
)
3969 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
3971 : underlying_face_id (it
);
3974 new_face_id
= face_at_string_position (it
->w
,
3976 IT_STRING_CHARPOS (*it
),
3979 base_face_id
, false);
3981 /* Is this a start of a run of characters with box? Caveat:
3982 this can be called for a freshly allocated iterator; face_id
3983 is -1 is this case. We know that the new face will not
3984 change until the next check pos, i.e. if the new face has a
3985 box, all characters up to that position will have a
3986 box. But, as usual, we don't know whether that position
3987 is really the end. */
3988 if (new_face_id
!= it
->face_id
)
3990 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3991 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3993 /* If new face has a box but old face hasn't, this is the
3994 start of a run of characters with box, i.e. it has a
3995 shadow on the left side. */
3996 it
->start_of_box_run_p
3997 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3998 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
4002 it
->face_id
= new_face_id
;
4003 return HANDLED_NORMALLY
;
4007 /* Return the ID of the face ``underlying'' IT's current position,
4008 which is in a string. If the iterator is associated with a
4009 buffer, return the face at IT's current buffer position.
4010 Otherwise, use the iterator's base_face_id. */
4013 underlying_face_id (struct it
*it
)
4015 int face_id
= it
->base_face_id
, i
;
4017 eassert (STRINGP (it
->string
));
4019 for (i
= it
->sp
- 1; i
>= 0; --i
)
4020 if (NILP (it
->stack
[i
].string
))
4021 face_id
= it
->stack
[i
].face_id
;
4027 /* Compute the face one character before or after the current position
4028 of IT, in the visual order. BEFORE_P means get the face
4029 in front (to the left in L2R paragraphs, to the right in R2L
4030 paragraphs) of IT's screen position. Value is the ID of the face. */
4033 face_before_or_after_it_pos (struct it
*it
, bool before_p
)
4036 ptrdiff_t next_check_charpos
;
4038 void *it_copy_data
= NULL
;
4040 eassert (it
->s
== NULL
);
4042 if (STRINGP (it
->string
))
4044 ptrdiff_t bufpos
, charpos
;
4047 /* No face change past the end of the string (for the case
4048 we are padding with spaces). No face change before the
4050 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
4051 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
4056 /* Set charpos to the position before or after IT's current
4057 position, in the logical order, which in the non-bidi
4058 case is the same as the visual order. */
4060 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4061 else if (it
->what
== IT_COMPOSITION
)
4062 /* For composition, we must check the character after the
4064 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4066 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4072 /* With bidi iteration, the character before the current
4073 in the visual order cannot be found by simple
4074 iteration, because "reverse" reordering is not
4075 supported. Instead, we need to start from the string
4076 beginning and go all the way to the current string
4077 position, remembering the previous position. */
4078 /* Ignore face changes before the first visible
4079 character on this display line. */
4080 if (it
->current_x
<= it
->first_visible_x
)
4082 SAVE_IT (it_copy
, *it
, it_copy_data
);
4083 IT_STRING_CHARPOS (it_copy
) = 0;
4084 bidi_init_it (0, 0, FRAME_WINDOW_P (it_copy
.f
), &it_copy
.bidi_it
);
4088 charpos
= IT_STRING_CHARPOS (it_copy
);
4089 if (charpos
>= SCHARS (it
->string
))
4091 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4093 while (IT_STRING_CHARPOS (it_copy
) != IT_STRING_CHARPOS (*it
));
4095 RESTORE_IT (it
, it
, it_copy_data
);
4099 /* Set charpos to the string position of the character
4100 that comes after IT's current position in the visual
4102 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4106 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4108 charpos
= it_copy
.bidi_it
.charpos
;
4111 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4113 if (it
->current
.overlay_string_index
>= 0)
4114 bufpos
= IT_CHARPOS (*it
);
4118 base_face_id
= underlying_face_id (it
);
4120 /* Get the face for ASCII, or unibyte. */
4121 face_id
= face_at_string_position (it
->w
,
4125 &next_check_charpos
,
4126 base_face_id
, false);
4128 /* Correct the face for charsets different from ASCII. Do it
4129 for the multibyte case only. The face returned above is
4130 suitable for unibyte text if IT->string is unibyte. */
4131 if (STRING_MULTIBYTE (it
->string
))
4133 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4134 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4136 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4138 c
= string_char_and_length (p
, &len
);
4139 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4144 struct text_pos pos
;
4146 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4147 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4150 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4151 pos
= it
->current
.pos
;
4156 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4159 if (it
->what
== IT_COMPOSITION
)
4161 /* For composition, we must check the position after
4163 pos
.charpos
+= it
->cmp_it
.nchars
;
4164 pos
.bytepos
+= it
->len
;
4167 INC_TEXT_POS (pos
, it
->multibyte_p
);
4176 /* With bidi iteration, the character before the current
4177 in the visual order cannot be found by simple
4178 iteration, because "reverse" reordering is not
4179 supported. Instead, we need to use the move_it_*
4180 family of functions, and move to the previous
4181 character starting from the beginning of the visual
4183 /* Ignore face changes before the first visible
4184 character on this display line. */
4185 if (it
->current_x
<= it
->first_visible_x
)
4187 SAVE_IT (it_copy
, *it
, it_copy_data
);
4188 /* Implementation note: Since move_it_in_display_line
4189 works in the iterator geometry, and thinks the first
4190 character is always the leftmost, even in R2L lines,
4191 we don't need to distinguish between the R2L and L2R
4193 current_x
= it_copy
.current_x
;
4194 move_it_vertically_backward (&it_copy
, 0);
4195 move_it_in_display_line (&it_copy
, ZV
, current_x
- 1, MOVE_TO_X
);
4196 pos
= it_copy
.current
.pos
;
4197 RESTORE_IT (it
, it
, it_copy_data
);
4201 /* Set charpos to the buffer position of the character
4202 that comes after IT's current position in the visual
4204 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4208 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4211 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4214 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4216 /* Determine face for CHARSET_ASCII, or unibyte. */
4217 face_id
= face_at_buffer_position (it
->w
,
4219 &next_check_charpos
,
4222 /* Correct the face for charsets different from ASCII. Do it
4223 for the multibyte case only. The face returned above is
4224 suitable for unibyte text if current_buffer is unibyte. */
4225 if (it
->multibyte_p
)
4227 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4228 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4229 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4238 /***********************************************************************
4240 ***********************************************************************/
4242 /* Set up iterator IT from invisible properties at its current
4243 position. Called from handle_stop. */
4245 static enum prop_handled
4246 handle_invisible_prop (struct it
*it
)
4248 enum prop_handled handled
= HANDLED_NORMALLY
;
4252 if (STRINGP (it
->string
))
4254 Lisp_Object end_charpos
, limit
;
4256 /* Get the value of the invisible text property at the
4257 current position. Value will be nil if there is no such
4259 end_charpos
= make_number (IT_STRING_CHARPOS (*it
));
4260 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4261 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4263 if (invis
!= 0 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4265 /* Record whether we have to display an ellipsis for the
4267 bool display_ellipsis_p
= (invis
== 2);
4268 ptrdiff_t len
, endpos
;
4270 handled
= HANDLED_RECOMPUTE_PROPS
;
4272 /* Get the position at which the next visible text can be
4273 found in IT->string, if any. */
4274 endpos
= len
= SCHARS (it
->string
);
4275 XSETINT (limit
, len
);
4279 = Fnext_single_property_change (end_charpos
, Qinvisible
,
4281 /* Since LIMIT is always an integer, so should be the
4282 value returned by Fnext_single_property_change. */
4283 eassert (INTEGERP (end_charpos
));
4284 if (INTEGERP (end_charpos
))
4286 endpos
= XFASTINT (end_charpos
);
4287 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4288 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4290 display_ellipsis_p
= true;
4292 else /* Should never happen; but if it does, exit the loop. */
4295 while (invis
!= 0 && endpos
< len
);
4297 if (display_ellipsis_p
)
4298 it
->ellipsis_p
= true;
4302 /* Text at END_CHARPOS is visible. Move IT there. */
4303 struct text_pos old
;
4306 old
= it
->current
.string_pos
;
4307 oldpos
= CHARPOS (old
);
4310 if (it
->bidi_it
.first_elt
4311 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4312 bidi_paragraph_init (it
->paragraph_embedding
,
4313 &it
->bidi_it
, true);
4314 /* Bidi-iterate out of the invisible text. */
4317 bidi_move_to_visually_next (&it
->bidi_it
);
4319 while (oldpos
<= it
->bidi_it
.charpos
4320 && it
->bidi_it
.charpos
< endpos
);
4322 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4323 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4324 if (IT_CHARPOS (*it
) >= endpos
)
4325 it
->prev_stop
= endpos
;
4329 IT_STRING_CHARPOS (*it
) = endpos
;
4330 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4335 /* The rest of the string is invisible. If this is an
4336 overlay string, proceed with the next overlay string
4337 or whatever comes and return a character from there. */
4338 if (it
->current
.overlay_string_index
>= 0
4339 && !display_ellipsis_p
)
4341 next_overlay_string (it
);
4342 /* Don't check for overlay strings when we just
4343 finished processing them. */
4344 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4348 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4349 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4356 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4357 Lisp_Object pos
, overlay
;
4359 /* First of all, is there invisible text at this position? */
4360 tem
= start_charpos
= IT_CHARPOS (*it
);
4361 pos
= make_number (tem
);
4362 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4364 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4366 /* If we are on invisible text, skip over it. */
4367 if (invis
!= 0 && start_charpos
< it
->end_charpos
)
4369 /* Record whether we have to display an ellipsis for the
4371 bool display_ellipsis_p
= invis
== 2;
4373 handled
= HANDLED_RECOMPUTE_PROPS
;
4375 /* Loop skipping over invisible text. The loop is left at
4376 ZV or with IT on the first char being visible again. */
4379 /* Try to skip some invisible text. Return value is the
4380 position reached which can be equal to where we start
4381 if there is nothing invisible there. This skips both
4382 over invisible text properties and overlays with
4383 invisible property. */
4384 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4386 /* If we skipped nothing at all we weren't at invisible
4387 text in the first place. If everything to the end of
4388 the buffer was skipped, end the loop. */
4389 if (newpos
== tem
|| newpos
>= ZV
)
4393 /* We skipped some characters but not necessarily
4394 all there are. Check if we ended up on visible
4395 text. Fget_char_property returns the property of
4396 the char before the given position, i.e. if we
4397 get invis = 0, this means that the char at
4398 newpos is visible. */
4399 pos
= make_number (newpos
);
4400 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4401 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4404 /* If we ended up on invisible text, proceed to
4405 skip starting with next_stop. */
4409 /* If there are adjacent invisible texts, don't lose the
4410 second one's ellipsis. */
4412 display_ellipsis_p
= true;
4416 /* The position newpos is now either ZV or on visible text. */
4419 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4421 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4423 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4425 /* If the invisible text ends on a newline or on a
4426 character after a newline, we can avoid the costly,
4427 character by character, bidi iteration to NEWPOS, and
4428 instead simply reseat the iterator there. That's
4429 because all bidi reordering information is tossed at
4430 the newline. This is a big win for modes that hide
4431 complete lines, like Outline, Org, etc. */
4432 if (on_newline
|| after_newline
)
4434 struct text_pos tpos
;
4435 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4437 SET_TEXT_POS (tpos
, newpos
, bpos
);
4438 reseat_1 (it
, tpos
, false);
4439 /* If we reseat on a newline/ZV, we need to prep the
4440 bidi iterator for advancing to the next character
4441 after the newline/EOB, keeping the current paragraph
4442 direction (so that PRODUCE_GLYPHS does TRT wrt
4443 prepending/appending glyphs to a glyph row). */
4446 it
->bidi_it
.first_elt
= false;
4447 it
->bidi_it
.paragraph_dir
= pdir
;
4448 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4449 it
->bidi_it
.nchars
= 1;
4450 it
->bidi_it
.ch_len
= 1;
4453 else /* Must use the slow method. */
4455 /* With bidi iteration, the region of invisible text
4456 could start and/or end in the middle of a
4457 non-base embedding level. Therefore, we need to
4458 skip invisible text using the bidi iterator,
4459 starting at IT's current position, until we find
4460 ourselves outside of the invisible text.
4461 Skipping invisible text _after_ bidi iteration
4462 avoids affecting the visual order of the
4463 displayed text when invisible properties are
4464 added or removed. */
4465 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4467 /* If we were `reseat'ed to a new paragraph,
4468 determine the paragraph base direction. We
4469 need to do it now because
4470 next_element_from_buffer may not have a
4471 chance to do it, if we are going to skip any
4472 text at the beginning, which resets the
4474 bidi_paragraph_init (it
->paragraph_embedding
,
4475 &it
->bidi_it
, true);
4479 bidi_move_to_visually_next (&it
->bidi_it
);
4481 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4482 && it
->bidi_it
.charpos
< newpos
);
4483 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4484 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4485 /* If we overstepped NEWPOS, record its position in
4486 the iterator, so that we skip invisible text if
4487 later the bidi iteration lands us in the
4488 invisible region again. */
4489 if (IT_CHARPOS (*it
) >= newpos
)
4490 it
->prev_stop
= newpos
;
4495 IT_CHARPOS (*it
) = newpos
;
4496 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4499 if (display_ellipsis_p
)
4501 /* Make sure that the glyphs of the ellipsis will get
4502 correct `charpos' values. If we would not update
4503 it->position here, the glyphs would belong to the
4504 last visible character _before_ the invisible
4505 text, which confuses `set_cursor_from_row'.
4507 We use the last invisible position instead of the
4508 first because this way the cursor is always drawn on
4509 the first "." of the ellipsis, whenever PT is inside
4510 the invisible text. Otherwise the cursor would be
4511 placed _after_ the ellipsis when the point is after the
4512 first invisible character. */
4513 if (!STRINGP (it
->object
))
4515 it
->position
.charpos
= newpos
- 1;
4516 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4520 /* If there are before-strings at the start of invisible
4521 text, and the text is invisible because of a text
4522 property, arrange to show before-strings because 20.x did
4523 it that way. (If the text is invisible because of an
4524 overlay property instead of a text property, this is
4525 already handled in the overlay code.) */
4527 && get_overlay_strings (it
, it
->stop_charpos
))
4529 handled
= HANDLED_RECOMPUTE_PROPS
;
4532 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4533 /* The call to get_overlay_strings above recomputes
4534 it->stop_charpos, but it only considers changes
4535 in properties and overlays beyond iterator's
4536 current position. This causes us to miss changes
4537 that happen exactly where the invisible property
4538 ended. So we play it safe here and force the
4539 iterator to check for potential stop positions
4540 immediately after the invisible text. Note that
4541 if get_overlay_strings returns true, it
4542 normally also pushed the iterator stack, so we
4543 need to update the stop position in the slot
4544 below the current one. */
4545 it
->stack
[it
->sp
- 1].stop_charpos
4546 = CHARPOS (it
->stack
[it
->sp
- 1].current
.pos
);
4549 else if (display_ellipsis_p
)
4551 it
->ellipsis_p
= true;
4552 /* Let the ellipsis display before
4553 considering any properties of the following char.
4554 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4555 handled
= HANDLED_RETURN
;
4564 /* Make iterator IT return `...' next.
4565 Replaces LEN characters from buffer. */
4568 setup_for_ellipsis (struct it
*it
, int len
)
4570 /* Use the display table definition for `...'. Invalid glyphs
4571 will be handled by the method returning elements from dpvec. */
4572 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4574 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4575 it
->dpvec
= v
->contents
;
4576 it
->dpend
= v
->contents
+ v
->header
.size
;
4580 /* Default `...'. */
4581 it
->dpvec
= default_invis_vector
;
4582 it
->dpend
= default_invis_vector
+ 3;
4585 it
->dpvec_char_len
= len
;
4586 it
->current
.dpvec_index
= 0;
4587 it
->dpvec_face_id
= -1;
4589 /* Use IT->saved_face_id for the ellipsis, so that it has the same
4590 face as the preceding text. IT->saved_face_id was set in
4591 handle_stop to the face of the preceding character, and will be
4592 different from IT->face_id only if the invisible text skipped in
4593 handle_invisible_prop has some non-default face on its first
4594 character. We thus ignore the face of the invisible text when we
4595 display the ellipsis. IT's face is restored in set_iterator_to_next. */
4596 if (it
->saved_face_id
>= 0)
4597 it
->face_id
= it
->saved_face_id
;
4599 /* If the ellipsis represents buffer text, it means we advanced in
4600 the buffer, so we should no longer ignore overlay strings. */
4601 if (it
->method
== GET_FROM_BUFFER
)
4602 it
->ignore_overlay_strings_at_pos_p
= false;
4604 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4605 it
->ellipsis_p
= true;
4610 /***********************************************************************
4612 ***********************************************************************/
4614 /* Set up iterator IT from `display' property at its current position.
4615 Called from handle_stop.
4616 We return HANDLED_RETURN if some part of the display property
4617 overrides the display of the buffer text itself.
4618 Otherwise we return HANDLED_NORMALLY. */
4620 static enum prop_handled
4621 handle_display_prop (struct it
*it
)
4623 Lisp_Object propval
, object
, overlay
;
4624 struct text_pos
*position
;
4626 /* Nonzero if some property replaces the display of the text itself. */
4627 int display_replaced
= 0;
4629 if (STRINGP (it
->string
))
4631 object
= it
->string
;
4632 position
= &it
->current
.string_pos
;
4633 bufpos
= CHARPOS (it
->current
.pos
);
4637 XSETWINDOW (object
, it
->w
);
4638 position
= &it
->current
.pos
;
4639 bufpos
= CHARPOS (*position
);
4642 /* Reset those iterator values set from display property values. */
4643 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4644 it
->space_width
= Qnil
;
4645 it
->font_height
= Qnil
;
4648 /* We don't support recursive `display' properties, i.e. string
4649 values that have a string `display' property, that have a string
4650 `display' property etc. */
4651 if (!it
->string_from_display_prop_p
)
4652 it
->area
= TEXT_AREA
;
4654 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4655 Qdisplay
, object
, &overlay
);
4657 return HANDLED_NORMALLY
;
4658 /* Now OVERLAY is the overlay that gave us this property, or nil
4659 if it was a text property. */
4661 if (!STRINGP (it
->string
))
4662 object
= it
->w
->contents
;
4664 display_replaced
= handle_display_spec (it
, propval
, object
, overlay
,
4666 FRAME_WINDOW_P (it
->f
));
4667 return display_replaced
!= 0 ? HANDLED_RETURN
: HANDLED_NORMALLY
;
4670 /* Subroutine of handle_display_prop. Returns non-zero if the display
4671 specification in SPEC is a replacing specification, i.e. it would
4672 replace the text covered by `display' property with something else,
4673 such as an image or a display string. If SPEC includes any kind or
4674 `(space ...) specification, the value is 2; this is used by
4675 compute_display_string_pos, which see.
4677 See handle_single_display_spec for documentation of arguments.
4678 FRAME_WINDOW_P is true if the window being redisplayed is on a
4679 GUI frame; this argument is used only if IT is NULL, see below.
4681 IT can be NULL, if this is called by the bidi reordering code
4682 through compute_display_string_pos, which see. In that case, this
4683 function only examines SPEC, but does not otherwise "handle" it, in
4684 the sense that it doesn't set up members of IT from the display
4687 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4688 Lisp_Object overlay
, struct text_pos
*position
,
4689 ptrdiff_t bufpos
, bool frame_window_p
)
4694 /* Simple specifications. */
4695 && !EQ (XCAR (spec
), Qimage
)
4696 #ifdef HAVE_XWIDGETS
4697 && !EQ (XCAR (spec
), Qxwidget
)
4699 && !EQ (XCAR (spec
), Qspace
)
4700 && !EQ (XCAR (spec
), Qwhen
)
4701 && !EQ (XCAR (spec
), Qslice
)
4702 && !EQ (XCAR (spec
), Qspace_width
)
4703 && !EQ (XCAR (spec
), Qheight
)
4704 && !EQ (XCAR (spec
), Qraise
)
4705 /* Marginal area specifications. */
4706 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4707 && !EQ (XCAR (spec
), Qleft_fringe
)
4708 && !EQ (XCAR (spec
), Qright_fringe
)
4709 && !NILP (XCAR (spec
)))
4711 for (; CONSP (spec
); spec
= XCDR (spec
))
4713 int rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4714 overlay
, position
, bufpos
,
4715 replacing
, frame_window_p
);
4719 /* If some text in a string is replaced, `position' no
4720 longer points to the position of `object'. */
4721 if (!it
|| STRINGP (object
))
4726 else if (VECTORP (spec
))
4729 for (i
= 0; i
< ASIZE (spec
); ++i
)
4731 int rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4732 overlay
, position
, bufpos
,
4733 replacing
, frame_window_p
);
4737 /* If some text in a string is replaced, `position' no
4738 longer points to the position of `object'. */
4739 if (!it
|| STRINGP (object
))
4745 replacing
= handle_single_display_spec (it
, spec
, object
, overlay
, position
,
4746 bufpos
, 0, frame_window_p
);
4750 /* Value is the position of the end of the `display' property starting
4751 at START_POS in OBJECT. */
4753 static struct text_pos
4754 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4757 struct text_pos end_pos
;
4759 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4760 Qdisplay
, object
, Qnil
);
4761 CHARPOS (end_pos
) = XFASTINT (end
);
4762 if (STRINGP (object
))
4763 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4765 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4771 /* Set up IT from a single `display' property specification SPEC. OBJECT
4772 is the object in which the `display' property was found. *POSITION
4773 is the position in OBJECT at which the `display' property was found.
4774 BUFPOS is the buffer position of OBJECT (different from POSITION if
4775 OBJECT is not a buffer). DISPLAY_REPLACED non-zero means that we
4776 previously saw a display specification which already replaced text
4777 display with something else, for example an image; we ignore such
4778 properties after the first one has been processed.
4780 OVERLAY is the overlay this `display' property came from,
4781 or nil if it was a text property.
4783 If SPEC is a `space' or `image' specification, and in some other
4784 cases too, set *POSITION to the position where the `display'
4787 If IT is NULL, only examine the property specification in SPEC, but
4788 don't set up IT. In that case, FRAME_WINDOW_P means SPEC
4789 is intended to be displayed in a window on a GUI frame.
4791 Value is non-zero if something was found which replaces the display
4792 of buffer or string text. */
4795 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4796 Lisp_Object overlay
, struct text_pos
*position
,
4797 ptrdiff_t bufpos
, int display_replaced
,
4798 bool frame_window_p
)
4801 Lisp_Object location
, value
;
4802 struct text_pos start_pos
= *position
;
4804 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4805 If the result is non-nil, use VALUE instead of SPEC. */
4807 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4816 if (!NILP (form
) && !EQ (form
, Qt
))
4818 ptrdiff_t count
= SPECPDL_INDEX ();
4820 /* Bind `object' to the object having the `display' property, a
4821 buffer or string. Bind `position' to the position in the
4822 object where the property was found, and `buffer-position'
4823 to the current position in the buffer. */
4826 XSETBUFFER (object
, current_buffer
);
4827 specbind (Qobject
, object
);
4828 specbind (Qposition
, make_number (CHARPOS (*position
)));
4829 specbind (Qbuffer_position
, make_number (bufpos
));
4830 form
= safe_eval (form
);
4831 unbind_to (count
, Qnil
);
4837 /* Handle `(height HEIGHT)' specifications. */
4839 && EQ (XCAR (spec
), Qheight
)
4840 && CONSP (XCDR (spec
)))
4844 if (!FRAME_WINDOW_P (it
->f
))
4847 it
->font_height
= XCAR (XCDR (spec
));
4848 if (!NILP (it
->font_height
))
4850 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4851 int new_height
= -1;
4853 if (CONSP (it
->font_height
)
4854 && (EQ (XCAR (it
->font_height
), Qplus
)
4855 || EQ (XCAR (it
->font_height
), Qminus
))
4856 && CONSP (XCDR (it
->font_height
))
4857 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4859 /* `(+ N)' or `(- N)' where N is an integer. */
4860 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4861 if (EQ (XCAR (it
->font_height
), Qplus
))
4863 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4865 else if (FUNCTIONP (it
->font_height
))
4867 /* Call function with current height as argument.
4868 Value is the new height. */
4870 height
= safe_call1 (it
->font_height
,
4871 face
->lface
[LFACE_HEIGHT_INDEX
]);
4872 if (NUMBERP (height
))
4873 new_height
= XFLOATINT (height
);
4875 else if (NUMBERP (it
->font_height
))
4877 /* Value is a multiple of the canonical char height. */
4880 f
= FACE_FROM_ID (it
->f
,
4881 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4882 new_height
= (XFLOATINT (it
->font_height
)
4883 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4887 /* Evaluate IT->font_height with `height' bound to the
4888 current specified height to get the new height. */
4889 ptrdiff_t count
= SPECPDL_INDEX ();
4891 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4892 value
= safe_eval (it
->font_height
);
4893 unbind_to (count
, Qnil
);
4895 if (NUMBERP (value
))
4896 new_height
= XFLOATINT (value
);
4900 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4907 /* Handle `(space-width WIDTH)'. */
4909 && EQ (XCAR (spec
), Qspace_width
)
4910 && CONSP (XCDR (spec
)))
4914 if (!FRAME_WINDOW_P (it
->f
))
4917 value
= XCAR (XCDR (spec
));
4918 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4919 it
->space_width
= value
;
4925 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4927 && EQ (XCAR (spec
), Qslice
))
4933 if (!FRAME_WINDOW_P (it
->f
))
4936 if (tem
= XCDR (spec
), CONSP (tem
))
4938 it
->slice
.x
= XCAR (tem
);
4939 if (tem
= XCDR (tem
), CONSP (tem
))
4941 it
->slice
.y
= XCAR (tem
);
4942 if (tem
= XCDR (tem
), CONSP (tem
))
4944 it
->slice
.width
= XCAR (tem
);
4945 if (tem
= XCDR (tem
), CONSP (tem
))
4946 it
->slice
.height
= XCAR (tem
);
4955 /* Handle `(raise FACTOR)'. */
4957 && EQ (XCAR (spec
), Qraise
)
4958 && CONSP (XCDR (spec
)))
4962 if (!FRAME_WINDOW_P (it
->f
))
4965 #ifdef HAVE_WINDOW_SYSTEM
4966 value
= XCAR (XCDR (spec
));
4967 if (NUMBERP (value
))
4969 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4970 it
->voffset
= - (XFLOATINT (value
)
4971 * (normal_char_height (face
->font
, -1)));
4973 #endif /* HAVE_WINDOW_SYSTEM */
4979 /* Don't handle the other kinds of display specifications
4980 inside a string that we got from a `display' property. */
4981 if (it
&& it
->string_from_display_prop_p
)
4984 /* Characters having this form of property are not displayed, so
4985 we have to find the end of the property. */
4988 start_pos
= *position
;
4989 *position
= display_prop_end (it
, object
, start_pos
);
4990 /* If the display property comes from an overlay, don't consider
4991 any potential stop_charpos values before the end of that
4992 overlay. Since display_prop_end will happily find another
4993 'display' property coming from some other overlay or text
4994 property on buffer positions before this overlay's end, we
4995 need to ignore them, or else we risk displaying this
4996 overlay's display string/image twice. */
4997 if (!NILP (overlay
))
4999 ptrdiff_t ovendpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5001 if (ovendpos
> CHARPOS (*position
))
5002 SET_TEXT_POS (*position
, ovendpos
, CHAR_TO_BYTE (ovendpos
));
5007 /* Stop the scan at that end position--we assume that all
5008 text properties change there. */
5010 it
->stop_charpos
= position
->charpos
;
5012 /* Handle `(left-fringe BITMAP [FACE])'
5013 and `(right-fringe BITMAP [FACE])'. */
5015 && (EQ (XCAR (spec
), Qleft_fringe
)
5016 || EQ (XCAR (spec
), Qright_fringe
))
5017 && CONSP (XCDR (spec
)))
5023 if (!FRAME_WINDOW_P (it
->f
))
5024 /* If we return here, POSITION has been advanced
5025 across the text with this property. */
5027 /* Synchronize the bidi iterator with POSITION. This is
5028 needed because we are not going to push the iterator
5029 on behalf of this display property, so there will be
5030 no pop_it call to do this synchronization for us. */
5033 it
->position
= *position
;
5034 iterate_out_of_display_property (it
);
5035 *position
= it
->position
;
5040 else if (!frame_window_p
)
5043 #ifdef HAVE_WINDOW_SYSTEM
5044 value
= XCAR (XCDR (spec
));
5045 if (!SYMBOLP (value
)
5046 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
5047 /* If we return here, POSITION has been advanced
5048 across the text with this property. */
5050 if (it
&& it
->bidi_p
)
5052 it
->position
= *position
;
5053 iterate_out_of_display_property (it
);
5054 *position
= it
->position
;
5061 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
5063 if (CONSP (XCDR (XCDR (spec
))))
5065 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
5066 int face_id2
= lookup_derived_face (it
->f
, face_name
,
5067 FRINGE_FACE_ID
, false);
5072 /* Save current settings of IT so that we can restore them
5073 when we are finished with the glyph property value. */
5074 push_it (it
, position
);
5076 it
->area
= TEXT_AREA
;
5077 it
->what
= IT_IMAGE
;
5078 it
->image_id
= -1; /* no image */
5079 it
->position
= start_pos
;
5080 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5081 it
->method
= GET_FROM_IMAGE
;
5082 it
->from_overlay
= Qnil
;
5083 it
->face_id
= face_id
;
5084 it
->from_disp_prop_p
= true;
5086 /* Say that we haven't consumed the characters with
5087 `display' property yet. The call to pop_it in
5088 set_iterator_to_next will clean this up. */
5089 *position
= start_pos
;
5091 if (EQ (XCAR (spec
), Qleft_fringe
))
5093 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5094 it
->left_user_fringe_face_id
= face_id
;
5098 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5099 it
->right_user_fringe_face_id
= face_id
;
5102 #endif /* HAVE_WINDOW_SYSTEM */
5106 /* Prepare to handle `((margin left-margin) ...)',
5107 `((margin right-margin) ...)' and `((margin nil) ...)'
5108 prefixes for display specifications. */
5109 location
= Qunbound
;
5110 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5114 value
= XCDR (spec
);
5116 value
= XCAR (value
);
5119 if (EQ (XCAR (tem
), Qmargin
)
5120 && (tem
= XCDR (tem
),
5121 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5123 || EQ (tem
, Qleft_margin
)
5124 || EQ (tem
, Qright_margin
))))
5128 if (EQ (location
, Qunbound
))
5134 /* After this point, VALUE is the property after any
5135 margin prefix has been stripped. It must be a string,
5136 an image specification, or `(space ...)'.
5138 LOCATION specifies where to display: `left-margin',
5139 `right-margin' or nil. */
5141 bool valid_p
= (STRINGP (value
)
5142 #ifdef HAVE_WINDOW_SYSTEM
5143 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5144 && valid_image_p (value
))
5145 #endif /* not HAVE_WINDOW_SYSTEM */
5146 || (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5147 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5148 && valid_xwidget_spec_p (value
)));
5150 if (valid_p
&& display_replaced
== 0)
5156 /* Callers need to know whether the display spec is any kind
5157 of `(space ...)' spec that is about to affect text-area
5159 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5164 /* Save current settings of IT so that we can restore them
5165 when we are finished with the glyph property value. */
5166 push_it (it
, position
);
5167 it
->from_overlay
= overlay
;
5168 it
->from_disp_prop_p
= true;
5170 if (NILP (location
))
5171 it
->area
= TEXT_AREA
;
5172 else if (EQ (location
, Qleft_margin
))
5173 it
->area
= LEFT_MARGIN_AREA
;
5175 it
->area
= RIGHT_MARGIN_AREA
;
5177 if (STRINGP (value
))
5180 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5181 it
->current
.overlay_string_index
= -1;
5182 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5183 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5184 it
->method
= GET_FROM_STRING
;
5185 it
->stop_charpos
= 0;
5187 it
->base_level_stop
= 0;
5188 it
->string_from_display_prop_p
= true;
5189 /* Say that we haven't consumed the characters with
5190 `display' property yet. The call to pop_it in
5191 set_iterator_to_next will clean this up. */
5192 if (BUFFERP (object
))
5193 *position
= start_pos
;
5195 /* Force paragraph direction to be that of the parent
5196 object. If the parent object's paragraph direction is
5197 not yet determined, default to L2R. */
5198 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5199 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5201 it
->paragraph_embedding
= L2R
;
5203 /* Set up the bidi iterator for this display string. */
5206 it
->bidi_it
.string
.lstring
= it
->string
;
5207 it
->bidi_it
.string
.s
= NULL
;
5208 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5209 it
->bidi_it
.string
.bufpos
= bufpos
;
5210 it
->bidi_it
.string
.from_disp_str
= true;
5211 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5212 it
->bidi_it
.w
= it
->w
;
5213 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5216 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5218 it
->method
= GET_FROM_STRETCH
;
5220 *position
= it
->position
= start_pos
;
5221 retval
= 1 + (it
->area
== TEXT_AREA
);
5223 else if (valid_xwidget_spec_p (value
))
5225 it
->what
= IT_XWIDGET
;
5226 it
->method
= GET_FROM_XWIDGET
;
5227 it
->position
= start_pos
;
5228 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5229 *position
= start_pos
;
5230 it
->xwidget
= lookup_xwidget (value
);
5232 #ifdef HAVE_WINDOW_SYSTEM
5235 it
->what
= IT_IMAGE
;
5236 it
->image_id
= lookup_image (it
->f
, value
);
5237 it
->position
= start_pos
;
5238 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5239 it
->method
= GET_FROM_IMAGE
;
5241 /* Say that we haven't consumed the characters with
5242 `display' property yet. The call to pop_it in
5243 set_iterator_to_next will clean this up. */
5244 *position
= start_pos
;
5246 #endif /* HAVE_WINDOW_SYSTEM */
5251 /* Invalid property or property not supported. Restore
5252 POSITION to what it was before. */
5253 *position
= start_pos
;
5257 /* Check if PROP is a display property value whose text should be
5258 treated as intangible. OVERLAY is the overlay from which PROP
5259 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5260 specify the buffer position covered by PROP. */
5263 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5264 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5266 bool frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5267 struct text_pos position
;
5269 SET_TEXT_POS (position
, charpos
, bytepos
);
5270 return (handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5271 &position
, charpos
, frame_window_p
)
5276 /* Return true if PROP is a display sub-property value containing STRING.
5278 Implementation note: this and the following function are really
5279 special cases of handle_display_spec and
5280 handle_single_display_spec, and should ideally use the same code.
5281 Until they do, these two pairs must be consistent and must be
5282 modified in sync. */
5285 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5287 if (EQ (string
, prop
))
5290 /* Skip over `when FORM'. */
5291 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5296 /* Actually, the condition following `when' should be eval'ed,
5297 like handle_single_display_spec does, and we should return
5298 false if it evaluates to nil. However, this function is
5299 called only when the buffer was already displayed and some
5300 glyph in the glyph matrix was found to come from a display
5301 string. Therefore, the condition was already evaluated, and
5302 the result was non-nil, otherwise the display string wouldn't
5303 have been displayed and we would have never been called for
5304 this property. Thus, we can skip the evaluation and assume
5305 its result is non-nil. */
5310 /* Skip over `margin LOCATION'. */
5311 if (EQ (XCAR (prop
), Qmargin
))
5322 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5326 /* Return true if STRING appears in the `display' property PROP. */
5329 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5332 && !EQ (XCAR (prop
), Qwhen
)
5333 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5335 /* A list of sub-properties. */
5336 while (CONSP (prop
))
5338 if (single_display_spec_string_p (XCAR (prop
), string
))
5343 else if (VECTORP (prop
))
5345 /* A vector of sub-properties. */
5347 for (i
= 0; i
< ASIZE (prop
); ++i
)
5348 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5352 return single_display_spec_string_p (prop
, string
);
5357 /* Look for STRING in overlays and text properties in the current
5358 buffer, between character positions FROM and TO (excluding TO).
5359 BACK_P means look back (in this case, TO is supposed to be
5361 Value is the first character position where STRING was found, or
5362 zero if it wasn't found before hitting TO.
5364 This function may only use code that doesn't eval because it is
5365 called asynchronously from note_mouse_highlight. */
5368 string_buffer_position_lim (Lisp_Object string
,
5369 ptrdiff_t from
, ptrdiff_t to
, bool back_p
)
5371 Lisp_Object limit
, prop
, pos
;
5374 pos
= make_number (max (from
, BEGV
));
5376 if (!back_p
) /* looking forward */
5378 limit
= make_number (min (to
, ZV
));
5379 while (!found
&& !EQ (pos
, limit
))
5381 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5382 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5385 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5389 else /* looking back */
5391 limit
= make_number (max (to
, BEGV
));
5392 while (!found
&& !EQ (pos
, limit
))
5394 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5395 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5398 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5403 return found
? XINT (pos
) : 0;
5406 /* Determine which buffer position in current buffer STRING comes from.
5407 AROUND_CHARPOS is an approximate position where it could come from.
5408 Value is the buffer position or 0 if it couldn't be determined.
5410 This function is necessary because we don't record buffer positions
5411 in glyphs generated from strings (to keep struct glyph small).
5412 This function may only use code that doesn't eval because it is
5413 called asynchronously from note_mouse_highlight. */
5416 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5418 const int MAX_DISTANCE
= 1000;
5419 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5420 around_charpos
+ MAX_DISTANCE
,
5424 found
= string_buffer_position_lim (string
, around_charpos
,
5425 around_charpos
- MAX_DISTANCE
, true);
5431 /***********************************************************************
5432 `composition' property
5433 ***********************************************************************/
5435 /* Set up iterator IT from `composition' property at its current
5436 position. Called from handle_stop. */
5438 static enum prop_handled
5439 handle_composition_prop (struct it
*it
)
5441 Lisp_Object prop
, string
;
5442 ptrdiff_t pos
, pos_byte
, start
, end
;
5444 if (STRINGP (it
->string
))
5448 pos
= IT_STRING_CHARPOS (*it
);
5449 pos_byte
= IT_STRING_BYTEPOS (*it
);
5450 string
= it
->string
;
5451 s
= SDATA (string
) + pos_byte
;
5452 it
->c
= STRING_CHAR (s
);
5456 pos
= IT_CHARPOS (*it
);
5457 pos_byte
= IT_BYTEPOS (*it
);
5459 it
->c
= FETCH_CHAR (pos_byte
);
5462 /* If there's a valid composition and point is not inside of the
5463 composition (in the case that the composition is from the current
5464 buffer), draw a glyph composed from the composition components. */
5465 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5466 && composition_valid_p (start
, end
, prop
)
5467 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5470 /* As we can't handle this situation (perhaps font-lock added
5471 a new composition), we just return here hoping that next
5472 redisplay will detect this composition much earlier. */
5473 return HANDLED_NORMALLY
;
5476 if (STRINGP (it
->string
))
5477 pos_byte
= string_char_to_byte (it
->string
, start
);
5479 pos_byte
= CHAR_TO_BYTE (start
);
5481 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5484 if (it
->cmp_it
.id
>= 0)
5487 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5488 it
->cmp_it
.nglyphs
= -1;
5492 return HANDLED_NORMALLY
;
5497 /***********************************************************************
5499 ***********************************************************************/
5501 /* The following structure is used to record overlay strings for
5502 later sorting in load_overlay_strings. */
5504 struct overlay_entry
5506 Lisp_Object overlay
;
5509 bool after_string_p
;
5513 /* Set up iterator IT from overlay strings at its current position.
5514 Called from handle_stop. */
5516 static enum prop_handled
5517 handle_overlay_change (struct it
*it
)
5519 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5520 return HANDLED_RECOMPUTE_PROPS
;
5522 return HANDLED_NORMALLY
;
5526 /* Set up the next overlay string for delivery by IT, if there is an
5527 overlay string to deliver. Called by set_iterator_to_next when the
5528 end of the current overlay string is reached. If there are more
5529 overlay strings to display, IT->string and
5530 IT->current.overlay_string_index are set appropriately here.
5531 Otherwise IT->string is set to nil. */
5534 next_overlay_string (struct it
*it
)
5536 ++it
->current
.overlay_string_index
;
5537 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5539 /* No more overlay strings. Restore IT's settings to what
5540 they were before overlay strings were processed, and
5541 continue to deliver from current_buffer. */
5543 it
->ellipsis_p
= it
->stack
[it
->sp
- 1].display_ellipsis_p
;
5546 || (NILP (it
->string
)
5547 && it
->method
== GET_FROM_BUFFER
5548 && it
->stop_charpos
>= BEGV
5549 && it
->stop_charpos
<= it
->end_charpos
));
5550 it
->current
.overlay_string_index
= -1;
5551 it
->n_overlay_strings
= 0;
5552 /* If there's an empty display string on the stack, pop the
5553 stack, to resync the bidi iterator with IT's position. Such
5554 empty strings are pushed onto the stack in
5555 get_overlay_strings_1. */
5556 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5559 /* Since we've exhausted overlay strings at this buffer
5560 position, set the flag to ignore overlays until we move to
5561 another position. The flag is reset in
5562 next_element_from_buffer. */
5563 it
->ignore_overlay_strings_at_pos_p
= true;
5565 /* If we're at the end of the buffer, record that we have
5566 processed the overlay strings there already, so that
5567 next_element_from_buffer doesn't try it again. */
5568 if (NILP (it
->string
)
5569 && IT_CHARPOS (*it
) >= it
->end_charpos
5570 && it
->overlay_strings_charpos
>= it
->end_charpos
)
5571 it
->overlay_strings_at_end_processed_p
= true;
5572 /* Note: we reset overlay_strings_charpos only here, to make
5573 sure the just-processed overlays were indeed at EOB.
5574 Otherwise, overlays on text with invisible text property,
5575 which are processed with IT's position past the invisible
5576 text, might fool us into thinking the overlays at EOB were
5577 already processed (linum-mode can cause this, for
5579 it
->overlay_strings_charpos
= -1;
5583 /* There are more overlay strings to process. If
5584 IT->current.overlay_string_index has advanced to a position
5585 where we must load IT->overlay_strings with more strings, do
5586 it. We must load at the IT->overlay_strings_charpos where
5587 IT->n_overlay_strings was originally computed; when invisible
5588 text is present, this might not be IT_CHARPOS (Bug#7016). */
5589 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5591 if (it
->current
.overlay_string_index
&& i
== 0)
5592 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5594 /* Initialize IT to deliver display elements from the overlay
5596 it
->string
= it
->overlay_strings
[i
];
5597 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5598 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5599 it
->method
= GET_FROM_STRING
;
5600 it
->stop_charpos
= 0;
5601 it
->end_charpos
= SCHARS (it
->string
);
5602 if (it
->cmp_it
.stop_pos
>= 0)
5603 it
->cmp_it
.stop_pos
= 0;
5605 it
->base_level_stop
= 0;
5607 /* Set up the bidi iterator for this overlay string. */
5610 it
->bidi_it
.string
.lstring
= it
->string
;
5611 it
->bidi_it
.string
.s
= NULL
;
5612 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5613 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5614 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5615 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5616 it
->bidi_it
.w
= it
->w
;
5617 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5625 /* Compare two overlay_entry structures E1 and E2. Used as a
5626 comparison function for qsort in load_overlay_strings. Overlay
5627 strings for the same position are sorted so that
5629 1. All after-strings come in front of before-strings, except
5630 when they come from the same overlay.
5632 2. Within after-strings, strings are sorted so that overlay strings
5633 from overlays with higher priorities come first.
5635 2. Within before-strings, strings are sorted so that overlay
5636 strings from overlays with higher priorities come last.
5638 Value is analogous to strcmp. */
5642 compare_overlay_entries (const void *e1
, const void *e2
)
5644 struct overlay_entry
const *entry1
= e1
;
5645 struct overlay_entry
const *entry2
= e2
;
5648 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5650 /* Let after-strings appear in front of before-strings if
5651 they come from different overlays. */
5652 if (EQ (entry1
->overlay
, entry2
->overlay
))
5653 result
= entry1
->after_string_p
? 1 : -1;
5655 result
= entry1
->after_string_p
? -1 : 1;
5657 else if (entry1
->priority
!= entry2
->priority
)
5659 if (entry1
->after_string_p
)
5660 /* After-strings sorted in order of decreasing priority. */
5661 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5663 /* Before-strings sorted in order of increasing priority. */
5664 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5673 /* Load the vector IT->overlay_strings with overlay strings from IT's
5674 current buffer position, or from CHARPOS if that is > 0. Set
5675 IT->n_overlays to the total number of overlay strings found.
5677 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5678 a time. On entry into load_overlay_strings,
5679 IT->current.overlay_string_index gives the number of overlay
5680 strings that have already been loaded by previous calls to this
5683 IT->add_overlay_start contains an additional overlay start
5684 position to consider for taking overlay strings from, if non-zero.
5685 This position comes into play when the overlay has an `invisible'
5686 property, and both before and after-strings. When we've skipped to
5687 the end of the overlay, because of its `invisible' property, we
5688 nevertheless want its before-string to appear.
5689 IT->add_overlay_start will contain the overlay start position
5692 Overlay strings are sorted so that after-string strings come in
5693 front of before-string strings. Within before and after-strings,
5694 strings are sorted by overlay priority. See also function
5695 compare_overlay_entries. */
5698 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5700 Lisp_Object overlay
, window
, str
, invisible
;
5701 struct Lisp_Overlay
*ov
;
5702 ptrdiff_t start
, end
;
5703 ptrdiff_t n
= 0, i
, j
;
5705 struct overlay_entry entriesbuf
[20];
5706 ptrdiff_t size
= ARRAYELTS (entriesbuf
);
5707 struct overlay_entry
*entries
= entriesbuf
;
5711 charpos
= IT_CHARPOS (*it
);
5713 /* Append the overlay string STRING of overlay OVERLAY to vector
5714 `entries' which has size `size' and currently contains `n'
5715 elements. AFTER_P means STRING is an after-string of
5717 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5720 Lisp_Object priority; \
5724 struct overlay_entry *old = entries; \
5725 SAFE_NALLOCA (entries, 2, size); \
5726 memcpy (entries, old, size * sizeof *entries); \
5730 entries[n].string = (STRING); \
5731 entries[n].overlay = (OVERLAY); \
5732 priority = Foverlay_get ((OVERLAY), Qpriority); \
5733 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5734 entries[n].after_string_p = (AFTER_P); \
5739 /* Process overlay before the overlay center. */
5740 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5742 XSETMISC (overlay
, ov
);
5743 eassert (OVERLAYP (overlay
));
5744 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5745 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5750 /* Skip this overlay if it doesn't start or end at IT's current
5752 if (end
!= charpos
&& start
!= charpos
)
5755 /* Skip this overlay if it doesn't apply to IT->w. */
5756 window
= Foverlay_get (overlay
, Qwindow
);
5757 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5760 /* If the text ``under'' the overlay is invisible, both before-
5761 and after-strings from this overlay are visible; start and
5762 end position are indistinguishable. */
5763 invisible
= Foverlay_get (overlay
, Qinvisible
);
5764 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5766 /* If overlay has a non-empty before-string, record it. */
5767 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5768 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5770 RECORD_OVERLAY_STRING (overlay
, str
, false);
5772 /* If overlay has a non-empty after-string, record it. */
5773 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5774 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5776 RECORD_OVERLAY_STRING (overlay
, str
, true);
5779 /* Process overlays after the overlay center. */
5780 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5782 XSETMISC (overlay
, ov
);
5783 eassert (OVERLAYP (overlay
));
5784 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5785 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5787 if (start
> charpos
)
5790 /* Skip this overlay if it doesn't start or end at IT's current
5792 if (end
!= charpos
&& start
!= charpos
)
5795 /* Skip this overlay if it doesn't apply to IT->w. */
5796 window
= Foverlay_get (overlay
, Qwindow
);
5797 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5800 /* If the text ``under'' the overlay is invisible, it has a zero
5801 dimension, and both before- and after-strings apply. */
5802 invisible
= Foverlay_get (overlay
, Qinvisible
);
5803 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5805 /* If overlay has a non-empty before-string, record it. */
5806 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5807 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5809 RECORD_OVERLAY_STRING (overlay
, str
, false);
5811 /* If overlay has a non-empty after-string, record it. */
5812 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5813 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5815 RECORD_OVERLAY_STRING (overlay
, str
, true);
5818 #undef RECORD_OVERLAY_STRING
5822 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5824 /* Record number of overlay strings, and where we computed it. */
5825 it
->n_overlay_strings
= n
;
5826 it
->overlay_strings_charpos
= charpos
;
5828 /* IT->current.overlay_string_index is the number of overlay strings
5829 that have already been consumed by IT. Copy some of the
5830 remaining overlay strings to IT->overlay_strings. */
5832 j
= it
->current
.overlay_string_index
;
5833 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5835 it
->overlay_strings
[i
] = entries
[j
].string
;
5836 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5844 /* Get the first chunk of overlay strings at IT's current buffer
5845 position, or at CHARPOS if that is > 0. Value is true if at
5846 least one overlay string was found. */
5849 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, bool compute_stop_p
)
5851 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5852 process. This fills IT->overlay_strings with strings, and sets
5853 IT->n_overlay_strings to the total number of strings to process.
5854 IT->pos.overlay_string_index has to be set temporarily to zero
5855 because load_overlay_strings needs this; it must be set to -1
5856 when no overlay strings are found because a zero value would
5857 indicate a position in the first overlay string. */
5858 it
->current
.overlay_string_index
= 0;
5859 load_overlay_strings (it
, charpos
);
5861 /* If we found overlay strings, set up IT to deliver display
5862 elements from the first one. Otherwise set up IT to deliver
5863 from current_buffer. */
5864 if (it
->n_overlay_strings
)
5866 /* Make sure we know settings in current_buffer, so that we can
5867 restore meaningful values when we're done with the overlay
5870 compute_stop_pos (it
);
5871 eassert (it
->face_id
>= 0);
5873 /* Save IT's settings. They are restored after all overlay
5874 strings have been processed. */
5875 eassert (!compute_stop_p
|| it
->sp
== 0);
5877 /* When called from handle_stop, there might be an empty display
5878 string loaded. In that case, don't bother saving it. But
5879 don't use this optimization with the bidi iterator, since we
5880 need the corresponding pop_it call to resync the bidi
5881 iterator's position with IT's position, after we are done
5882 with the overlay strings. (The corresponding call to pop_it
5883 in case of an empty display string is in
5884 next_overlay_string.) */
5886 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5889 /* Set up IT to deliver display elements from the first overlay
5891 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5892 it
->string
= it
->overlay_strings
[0];
5893 it
->from_overlay
= Qnil
;
5894 it
->stop_charpos
= 0;
5895 eassert (STRINGP (it
->string
));
5896 it
->end_charpos
= SCHARS (it
->string
);
5898 it
->base_level_stop
= 0;
5899 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5900 it
->method
= GET_FROM_STRING
;
5901 it
->from_disp_prop_p
= 0;
5903 /* Force paragraph direction to be that of the parent
5905 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5906 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5908 it
->paragraph_embedding
= L2R
;
5910 /* Set up the bidi iterator for this overlay string. */
5913 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5915 it
->bidi_it
.string
.lstring
= it
->string
;
5916 it
->bidi_it
.string
.s
= NULL
;
5917 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5918 it
->bidi_it
.string
.bufpos
= pos
;
5919 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5920 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5921 it
->bidi_it
.w
= it
->w
;
5922 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5927 it
->current
.overlay_string_index
= -1;
5932 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5935 it
->method
= GET_FROM_BUFFER
;
5937 get_overlay_strings_1 (it
, charpos
, true);
5941 /* Value is true if we found at least one overlay string. */
5942 return STRINGP (it
->string
);
5947 /***********************************************************************
5948 Saving and restoring state
5949 ***********************************************************************/
5951 /* Save current settings of IT on IT->stack. Called, for example,
5952 before setting up IT for an overlay string, to be able to restore
5953 IT's settings to what they were after the overlay string has been
5954 processed. If POSITION is non-NULL, it is the position to save on
5955 the stack instead of IT->position. */
5958 push_it (struct it
*it
, struct text_pos
*position
)
5960 struct iterator_stack_entry
*p
;
5962 eassert (it
->sp
< IT_STACK_SIZE
);
5963 p
= it
->stack
+ it
->sp
;
5965 p
->stop_charpos
= it
->stop_charpos
;
5966 p
->prev_stop
= it
->prev_stop
;
5967 p
->base_level_stop
= it
->base_level_stop
;
5968 p
->cmp_it
= it
->cmp_it
;
5969 eassert (it
->face_id
>= 0);
5970 p
->face_id
= it
->face_id
;
5971 p
->string
= it
->string
;
5972 p
->method
= it
->method
;
5973 p
->from_overlay
= it
->from_overlay
;
5976 case GET_FROM_IMAGE
:
5977 p
->u
.image
.object
= it
->object
;
5978 p
->u
.image
.image_id
= it
->image_id
;
5979 p
->u
.image
.slice
= it
->slice
;
5981 case GET_FROM_STRETCH
:
5982 p
->u
.stretch
.object
= it
->object
;
5984 case GET_FROM_XWIDGET
:
5985 p
->u
.xwidget
.object
= it
->object
;
5987 case GET_FROM_BUFFER
:
5988 case GET_FROM_DISPLAY_VECTOR
:
5989 case GET_FROM_STRING
:
5990 case GET_FROM_C_STRING
:
5995 p
->position
= position
? *position
: it
->position
;
5996 p
->current
= it
->current
;
5997 p
->end_charpos
= it
->end_charpos
;
5998 p
->string_nchars
= it
->string_nchars
;
6000 p
->multibyte_p
= it
->multibyte_p
;
6001 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
6002 p
->space_width
= it
->space_width
;
6003 p
->font_height
= it
->font_height
;
6004 p
->voffset
= it
->voffset
;
6005 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
6006 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
6007 p
->display_ellipsis_p
= false;
6008 p
->line_wrap
= it
->line_wrap
;
6009 p
->bidi_p
= it
->bidi_p
;
6010 p
->paragraph_embedding
= it
->paragraph_embedding
;
6011 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
6014 /* Save the state of the bidi iterator as well. */
6016 bidi_push_it (&it
->bidi_it
);
6020 iterate_out_of_display_property (struct it
*it
)
6022 bool buffer_p
= !STRINGP (it
->string
);
6023 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
6024 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
6026 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
6028 /* Maybe initialize paragraph direction. If we are at the beginning
6029 of a new paragraph, next_element_from_buffer may not have a
6030 chance to do that. */
6031 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
6032 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
6033 /* prev_stop can be zero, so check against BEGV as well. */
6034 while (it
->bidi_it
.charpos
>= bob
6035 && it
->prev_stop
<= it
->bidi_it
.charpos
6036 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
6037 && it
->bidi_it
.charpos
< eob
)
6038 bidi_move_to_visually_next (&it
->bidi_it
);
6039 /* Record the stop_pos we just crossed, for when we cross it
6041 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
6042 it
->prev_stop
= CHARPOS (it
->position
);
6043 /* If we ended up not where pop_it put us, resync IT's
6044 positional members with the bidi iterator. */
6045 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
6046 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
6048 it
->current
.pos
= it
->position
;
6050 it
->current
.string_pos
= it
->position
;
6053 /* Restore IT's settings from IT->stack. Called, for example, when no
6054 more overlay strings must be processed, and we return to delivering
6055 display elements from a buffer, or when the end of a string from a
6056 `display' property is reached and we return to delivering display
6057 elements from an overlay string, or from a buffer. */
6060 pop_it (struct it
*it
)
6062 struct iterator_stack_entry
*p
;
6063 bool from_display_prop
= it
->from_disp_prop_p
;
6064 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
6066 eassert (it
->sp
> 0);
6068 p
= it
->stack
+ it
->sp
;
6069 it
->stop_charpos
= p
->stop_charpos
;
6070 it
->prev_stop
= p
->prev_stop
;
6071 it
->base_level_stop
= p
->base_level_stop
;
6072 it
->cmp_it
= p
->cmp_it
;
6073 it
->face_id
= p
->face_id
;
6074 it
->current
= p
->current
;
6075 it
->position
= p
->position
;
6076 it
->string
= p
->string
;
6077 it
->from_overlay
= p
->from_overlay
;
6078 if (NILP (it
->string
))
6079 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
6080 it
->method
= p
->method
;
6083 case GET_FROM_IMAGE
:
6084 it
->image_id
= p
->u
.image
.image_id
;
6085 it
->object
= p
->u
.image
.object
;
6086 it
->slice
= p
->u
.image
.slice
;
6088 case GET_FROM_XWIDGET
:
6089 it
->object
= p
->u
.xwidget
.object
;
6091 case GET_FROM_STRETCH
:
6092 it
->object
= p
->u
.stretch
.object
;
6094 case GET_FROM_BUFFER
:
6095 it
->object
= it
->w
->contents
;
6097 case GET_FROM_STRING
:
6099 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6101 /* Restore the face_box_p flag, since it could have been
6102 overwritten by the face of the object that we just finished
6105 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6106 it
->object
= it
->string
;
6109 case GET_FROM_DISPLAY_VECTOR
:
6111 it
->method
= GET_FROM_C_STRING
;
6112 else if (STRINGP (it
->string
))
6113 it
->method
= GET_FROM_STRING
;
6116 it
->method
= GET_FROM_BUFFER
;
6117 it
->object
= it
->w
->contents
;
6120 case GET_FROM_C_STRING
:
6125 it
->end_charpos
= p
->end_charpos
;
6126 it
->string_nchars
= p
->string_nchars
;
6128 it
->multibyte_p
= p
->multibyte_p
;
6129 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6130 it
->space_width
= p
->space_width
;
6131 it
->font_height
= p
->font_height
;
6132 it
->voffset
= p
->voffset
;
6133 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6134 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6135 it
->line_wrap
= p
->line_wrap
;
6136 it
->bidi_p
= p
->bidi_p
;
6137 it
->paragraph_embedding
= p
->paragraph_embedding
;
6138 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6141 bidi_pop_it (&it
->bidi_it
);
6142 /* Bidi-iterate until we get out of the portion of text, if any,
6143 covered by a `display' text property or by an overlay with
6144 `display' property. (We cannot just jump there, because the
6145 internal coherency of the bidi iterator state can not be
6146 preserved across such jumps.) We also must determine the
6147 paragraph base direction if the overlay we just processed is
6148 at the beginning of a new paragraph. */
6149 if (from_display_prop
6150 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6151 iterate_out_of_display_property (it
);
6153 eassert ((BUFFERP (it
->object
)
6154 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6155 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6156 || (STRINGP (it
->object
)
6157 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6158 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6159 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6161 /* If we move the iterator over text covered by a display property
6162 to a new buffer position, any info about previously seen overlays
6163 is no longer valid. */
6164 if (from_display_prop
&& it
->sp
== 0 && CHARPOS (it
->position
) != prev_pos
)
6165 it
->ignore_overlay_strings_at_pos_p
= false;
6170 /***********************************************************************
6172 ***********************************************************************/
6174 /* Set IT's current position to the previous line start. */
6177 back_to_previous_line_start (struct it
*it
)
6179 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6182 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6186 /* Move IT to the next line start.
6188 Value is true if a newline was found. Set *SKIPPED_P to true if
6189 we skipped over part of the text (as opposed to moving the iterator
6190 continuously over the text). Otherwise, don't change the value
6193 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6194 iterator on the newline, if it was found.
6196 Newlines may come from buffer text, overlay strings, or strings
6197 displayed via the `display' property. That's the reason we can't
6198 simply use find_newline_no_quit.
6200 Note that this function may not skip over invisible text that is so
6201 because of text properties and immediately follows a newline. If
6202 it would, function reseat_at_next_visible_line_start, when called
6203 from set_iterator_to_next, would effectively make invisible
6204 characters following a newline part of the wrong glyph row, which
6205 leads to wrong cursor motion. */
6208 forward_to_next_line_start (struct it
*it
, bool *skipped_p
,
6209 struct bidi_it
*bidi_it_prev
)
6211 ptrdiff_t old_selective
;
6212 bool newline_found_p
= false;
6214 const int MAX_NEWLINE_DISTANCE
= 500;
6216 /* If already on a newline, just consume it to avoid unintended
6217 skipping over invisible text below. */
6218 if (it
->what
== IT_CHARACTER
6220 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6222 if (it
->bidi_p
&& bidi_it_prev
)
6223 *bidi_it_prev
= it
->bidi_it
;
6224 set_iterator_to_next (it
, false);
6229 /* Don't handle selective display in the following. It's (a)
6230 unnecessary because it's done by the caller, and (b) leads to an
6231 infinite recursion because next_element_from_ellipsis indirectly
6232 calls this function. */
6233 old_selective
= it
->selective
;
6236 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6237 from buffer text. */
6239 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6240 n
+= !STRINGP (it
->string
))
6242 if (!get_next_display_element (it
))
6244 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6245 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6246 *bidi_it_prev
= it
->bidi_it
;
6247 set_iterator_to_next (it
, false);
6250 /* If we didn't find a newline near enough, see if we can use a
6252 if (!newline_found_p
)
6254 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6255 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6259 eassert (!STRINGP (it
->string
));
6261 /* If there isn't any `display' property in sight, and no
6262 overlays, we can just use the position of the newline in
6264 if (it
->stop_charpos
>= limit
6265 || ((pos
= Fnext_single_property_change (make_number (start
),
6267 make_number (limit
)),
6269 && next_overlay_change (start
) == ZV
))
6273 IT_CHARPOS (*it
) = limit
;
6274 IT_BYTEPOS (*it
) = bytepos
;
6278 struct bidi_it bprev
;
6280 /* Help bidi.c avoid expensive searches for display
6281 properties and overlays, by telling it that there are
6282 none up to `limit'. */
6283 if (it
->bidi_it
.disp_pos
< limit
)
6285 it
->bidi_it
.disp_pos
= limit
;
6286 it
->bidi_it
.disp_prop
= 0;
6289 bprev
= it
->bidi_it
;
6290 bidi_move_to_visually_next (&it
->bidi_it
);
6291 } while (it
->bidi_it
.charpos
!= limit
);
6292 IT_CHARPOS (*it
) = limit
;
6293 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6295 *bidi_it_prev
= bprev
;
6297 *skipped_p
= newline_found_p
= true;
6301 while (get_next_display_element (it
)
6302 && !newline_found_p
)
6304 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6305 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6306 *bidi_it_prev
= it
->bidi_it
;
6307 set_iterator_to_next (it
, false);
6312 it
->selective
= old_selective
;
6313 return newline_found_p
;
6317 /* Set IT's current position to the previous visible line start. Skip
6318 invisible text that is so either due to text properties or due to
6319 selective display. Caution: this does not change IT->current_x and
6323 back_to_previous_visible_line_start (struct it
*it
)
6325 while (IT_CHARPOS (*it
) > BEGV
)
6327 back_to_previous_line_start (it
);
6329 if (IT_CHARPOS (*it
) <= BEGV
)
6332 /* If selective > 0, then lines indented more than its value are
6334 if (it
->selective
> 0
6335 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6339 /* Check the newline before point for invisibility. */
6342 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6343 Qinvisible
, it
->window
);
6344 if (TEXT_PROP_MEANS_INVISIBLE (prop
) != 0)
6348 if (IT_CHARPOS (*it
) <= BEGV
)
6353 void *it2data
= NULL
;
6356 Lisp_Object val
, overlay
;
6358 SAVE_IT (it2
, *it
, it2data
);
6360 /* If newline is part of a composition, continue from start of composition */
6361 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6362 && beg
< IT_CHARPOS (*it
))
6365 /* If newline is replaced by a display property, find start of overlay
6366 or interval and continue search from that point. */
6367 pos
= --IT_CHARPOS (it2
);
6370 bidi_unshelve_cache (NULL
, false);
6371 it2
.string_from_display_prop_p
= false;
6372 it2
.from_disp_prop_p
= false;
6373 if (handle_display_prop (&it2
) == HANDLED_RETURN
6374 && !NILP (val
= get_char_property_and_overlay
6375 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6376 && (OVERLAYP (overlay
)
6377 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6378 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6380 RESTORE_IT (it
, it
, it2data
);
6384 /* Newline is not replaced by anything -- so we are done. */
6385 RESTORE_IT (it
, it
, it2data
);
6391 IT_CHARPOS (*it
) = beg
;
6392 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6396 it
->continuation_lines_width
= 0;
6398 eassert (IT_CHARPOS (*it
) >= BEGV
);
6399 eassert (IT_CHARPOS (*it
) == BEGV
6400 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6405 /* Reseat iterator IT at the previous visible line start. Skip
6406 invisible text that is so either due to text properties or due to
6407 selective display. At the end, update IT's overlay information,
6408 face information etc. */
6411 reseat_at_previous_visible_line_start (struct it
*it
)
6413 back_to_previous_visible_line_start (it
);
6414 reseat (it
, it
->current
.pos
, true);
6419 /* Reseat iterator IT on the next visible line start in the current
6420 buffer. ON_NEWLINE_P means position IT on the newline
6421 preceding the line start. Skip over invisible text that is so
6422 because of selective display. Compute faces, overlays etc at the
6423 new position. Note that this function does not skip over text that
6424 is invisible because of text properties. */
6427 reseat_at_next_visible_line_start (struct it
*it
, bool on_newline_p
)
6429 bool skipped_p
= false;
6430 struct bidi_it bidi_it_prev
;
6431 bool newline_found_p
6432 = forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6434 /* Skip over lines that are invisible because they are indented
6435 more than the value of IT->selective. */
6436 if (it
->selective
> 0)
6437 while (IT_CHARPOS (*it
) < ZV
6438 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6441 eassert (IT_BYTEPOS (*it
) == BEGV
6442 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6444 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6447 /* Position on the newline if that's what's requested. */
6448 if (on_newline_p
&& newline_found_p
)
6450 if (STRINGP (it
->string
))
6452 if (IT_STRING_CHARPOS (*it
) > 0)
6456 --IT_STRING_CHARPOS (*it
);
6457 --IT_STRING_BYTEPOS (*it
);
6461 /* We need to restore the bidi iterator to the state
6462 it had on the newline, and resync the IT's
6463 position with that. */
6464 it
->bidi_it
= bidi_it_prev
;
6465 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6466 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6470 else if (IT_CHARPOS (*it
) > BEGV
)
6479 /* We need to restore the bidi iterator to the state it
6480 had on the newline and resync IT with that. */
6481 it
->bidi_it
= bidi_it_prev
;
6482 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6483 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6485 reseat (it
, it
->current
.pos
, false);
6489 reseat (it
, it
->current
.pos
, false);
6496 /***********************************************************************
6497 Changing an iterator's position
6498 ***********************************************************************/
6500 /* Change IT's current position to POS in current_buffer.
6501 If FORCE_P, always check for text properties at the new position.
6502 Otherwise, text properties are only looked up if POS >=
6503 IT->check_charpos of a property. */
6506 reseat (struct it
*it
, struct text_pos pos
, bool force_p
)
6508 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6510 reseat_1 (it
, pos
, false);
6512 /* Determine where to check text properties. Avoid doing it
6513 where possible because text property lookup is very expensive. */
6515 || CHARPOS (pos
) > it
->stop_charpos
6516 || CHARPOS (pos
) < original_pos
)
6520 /* For bidi iteration, we need to prime prev_stop and
6521 base_level_stop with our best estimations. */
6522 /* Implementation note: Of course, POS is not necessarily a
6523 stop position, so assigning prev_pos to it is a lie; we
6524 should have called compute_stop_backwards. However, if
6525 the current buffer does not include any R2L characters,
6526 that call would be a waste of cycles, because the
6527 iterator will never move back, and thus never cross this
6528 "fake" stop position. So we delay that backward search
6529 until the time we really need it, in next_element_from_buffer. */
6530 if (CHARPOS (pos
) != it
->prev_stop
)
6531 it
->prev_stop
= CHARPOS (pos
);
6532 if (CHARPOS (pos
) < it
->base_level_stop
)
6533 it
->base_level_stop
= 0; /* meaning it's unknown */
6539 it
->prev_stop
= it
->base_level_stop
= 0;
6548 /* Change IT's buffer position to POS. SET_STOP_P means set
6549 IT->stop_pos to POS, also. */
6552 reseat_1 (struct it
*it
, struct text_pos pos
, bool set_stop_p
)
6554 /* Don't call this function when scanning a C string. */
6555 eassert (it
->s
== NULL
);
6557 /* POS must be a reasonable value. */
6558 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6560 it
->current
.pos
= it
->position
= pos
;
6561 it
->end_charpos
= ZV
;
6563 it
->current
.dpvec_index
= -1;
6564 it
->current
.overlay_string_index
= -1;
6565 IT_STRING_CHARPOS (*it
) = -1;
6566 IT_STRING_BYTEPOS (*it
) = -1;
6568 it
->method
= GET_FROM_BUFFER
;
6569 it
->object
= it
->w
->contents
;
6570 it
->area
= TEXT_AREA
;
6571 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6573 it
->string_from_display_prop_p
= false;
6574 it
->string_from_prefix_prop_p
= false;
6576 it
->from_disp_prop_p
= false;
6577 it
->face_before_selective_p
= false;
6580 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6582 bidi_unshelve_cache (NULL
, false);
6583 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6584 it
->bidi_it
.string
.s
= NULL
;
6585 it
->bidi_it
.string
.lstring
= Qnil
;
6586 it
->bidi_it
.string
.bufpos
= 0;
6587 it
->bidi_it
.string
.from_disp_str
= false;
6588 it
->bidi_it
.string
.unibyte
= false;
6589 it
->bidi_it
.w
= it
->w
;
6594 it
->stop_charpos
= CHARPOS (pos
);
6595 it
->base_level_stop
= CHARPOS (pos
);
6597 /* This make the information stored in it->cmp_it invalidate. */
6602 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6603 If S is non-null, it is a C string to iterate over. Otherwise,
6604 STRING gives a Lisp string to iterate over.
6606 If PRECISION > 0, don't return more then PRECISION number of
6607 characters from the string.
6609 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6610 characters have been returned. FIELD_WIDTH < 0 means an infinite
6613 MULTIBYTE = 0 means disable processing of multibyte characters,
6614 MULTIBYTE > 0 means enable it,
6615 MULTIBYTE < 0 means use IT->multibyte_p.
6617 IT must be initialized via a prior call to init_iterator before
6618 calling this function. */
6621 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6622 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6625 /* No text property checks performed by default, but see below. */
6626 it
->stop_charpos
= -1;
6628 /* Set iterator position and end position. */
6629 memset (&it
->current
, 0, sizeof it
->current
);
6630 it
->current
.overlay_string_index
= -1;
6631 it
->current
.dpvec_index
= -1;
6632 eassert (charpos
>= 0);
6634 /* If STRING is specified, use its multibyteness, otherwise use the
6635 setting of MULTIBYTE, if specified. */
6637 it
->multibyte_p
= multibyte
> 0;
6639 /* Bidirectional reordering of strings is controlled by the default
6640 value of bidi-display-reordering. Don't try to reorder while
6641 loading loadup.el, as the necessary character property tables are
6642 not yet available. */
6645 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6649 eassert (STRINGP (string
));
6650 it
->string
= string
;
6652 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6653 it
->method
= GET_FROM_STRING
;
6654 it
->current
.string_pos
= string_pos (charpos
, string
);
6658 it
->bidi_it
.string
.lstring
= string
;
6659 it
->bidi_it
.string
.s
= NULL
;
6660 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6661 it
->bidi_it
.string
.bufpos
= 0;
6662 it
->bidi_it
.string
.from_disp_str
= false;
6663 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6664 it
->bidi_it
.w
= it
->w
;
6665 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6666 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6671 it
->s
= (const unsigned char *) s
;
6674 /* Note that we use IT->current.pos, not it->current.string_pos,
6675 for displaying C strings. */
6676 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6677 if (it
->multibyte_p
)
6679 it
->current
.pos
= c_string_pos (charpos
, s
, true);
6680 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, true);
6684 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6685 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6690 it
->bidi_it
.string
.lstring
= Qnil
;
6691 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6692 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6693 it
->bidi_it
.string
.bufpos
= 0;
6694 it
->bidi_it
.string
.from_disp_str
= false;
6695 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6696 it
->bidi_it
.w
= it
->w
;
6697 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6700 it
->method
= GET_FROM_C_STRING
;
6703 /* PRECISION > 0 means don't return more than PRECISION characters
6705 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6707 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6709 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6712 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6713 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6714 FIELD_WIDTH < 0 means infinite field width. This is useful for
6715 padding with `-' at the end of a mode line. */
6716 if (field_width
< 0)
6717 field_width
= INFINITY
;
6718 /* Implementation note: We deliberately don't enlarge
6719 it->bidi_it.string.schars here to fit it->end_charpos, because
6720 the bidi iterator cannot produce characters out of thin air. */
6721 if (field_width
> it
->end_charpos
- charpos
)
6722 it
->end_charpos
= charpos
+ field_width
;
6724 /* Use the standard display table for displaying strings. */
6725 if (DISP_TABLE_P (Vstandard_display_table
))
6726 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6728 it
->stop_charpos
= charpos
;
6729 it
->prev_stop
= charpos
;
6730 it
->base_level_stop
= 0;
6733 it
->bidi_it
.first_elt
= true;
6734 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6735 it
->bidi_it
.disp_pos
= -1;
6737 if (s
== NULL
&& it
->multibyte_p
)
6739 ptrdiff_t endpos
= SCHARS (it
->string
);
6740 if (endpos
> it
->end_charpos
)
6741 endpos
= it
->end_charpos
;
6742 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6750 /***********************************************************************
6752 ***********************************************************************/
6754 /* Map enum it_method value to corresponding next_element_from_* function. */
6756 typedef bool (*next_element_function
) (struct it
*);
6758 static next_element_function
const get_next_element
[NUM_IT_METHODS
] =
6760 next_element_from_buffer
,
6761 next_element_from_display_vector
,
6762 next_element_from_string
,
6763 next_element_from_c_string
,
6764 next_element_from_image
,
6765 next_element_from_stretch
,
6766 next_element_from_xwidget
,
6769 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6772 /* Return true iff a character at CHARPOS (and BYTEPOS) is composed
6773 (possibly with the following characters). */
6775 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6776 ((IT)->cmp_it.id >= 0 \
6777 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6778 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6779 END_CHARPOS, (IT)->w, \
6780 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6784 /* Lookup the char-table Vglyphless_char_display for character C (-1
6785 if we want information for no-font case), and return the display
6786 method symbol. By side-effect, update it->what and
6787 it->glyphless_method. This function is called from
6788 get_next_display_element for each character element, and from
6789 x_produce_glyphs when no suitable font was found. */
6792 lookup_glyphless_char_display (int c
, struct it
*it
)
6794 Lisp_Object glyphless_method
= Qnil
;
6796 if (CHAR_TABLE_P (Vglyphless_char_display
)
6797 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6801 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6802 if (CONSP (glyphless_method
))
6803 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6804 ? XCAR (glyphless_method
)
6805 : XCDR (glyphless_method
);
6808 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6812 if (NILP (glyphless_method
))
6815 /* The default is to display the character by a proper font. */
6817 /* The default for the no-font case is to display an empty box. */
6818 glyphless_method
= Qempty_box
;
6820 if (EQ (glyphless_method
, Qzero_width
))
6823 return glyphless_method
;
6824 /* This method can't be used for the no-font case. */
6825 glyphless_method
= Qempty_box
;
6827 if (EQ (glyphless_method
, Qthin_space
))
6828 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6829 else if (EQ (glyphless_method
, Qempty_box
))
6830 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6831 else if (EQ (glyphless_method
, Qhex_code
))
6832 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6833 else if (STRINGP (glyphless_method
))
6834 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6837 /* Invalid value. We use the default method. */
6838 glyphless_method
= Qnil
;
6841 it
->what
= IT_GLYPHLESS
;
6842 return glyphless_method
;
6845 /* Merge escape glyph face and cache the result. */
6847 static struct frame
*last_escape_glyph_frame
= NULL
;
6848 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6849 static int last_escape_glyph_merged_face_id
= 0;
6852 merge_escape_glyph_face (struct it
*it
)
6856 if (it
->f
== last_escape_glyph_frame
6857 && it
->face_id
== last_escape_glyph_face_id
)
6858 face_id
= last_escape_glyph_merged_face_id
;
6861 /* Merge the `escape-glyph' face into the current face. */
6862 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6863 last_escape_glyph_frame
= it
->f
;
6864 last_escape_glyph_face_id
= it
->face_id
;
6865 last_escape_glyph_merged_face_id
= face_id
;
6870 /* Likewise for glyphless glyph face. */
6872 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6873 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6874 static int last_glyphless_glyph_merged_face_id
= 0;
6877 merge_glyphless_glyph_face (struct it
*it
)
6881 if (it
->f
== last_glyphless_glyph_frame
6882 && it
->face_id
== last_glyphless_glyph_face_id
)
6883 face_id
= last_glyphless_glyph_merged_face_id
;
6886 /* Merge the `glyphless-char' face into the current face. */
6887 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6888 last_glyphless_glyph_frame
= it
->f
;
6889 last_glyphless_glyph_face_id
= it
->face_id
;
6890 last_glyphless_glyph_merged_face_id
= face_id
;
6895 /* Forget the `escape-glyph' and `glyphless-char' faces. This should
6896 be called before redisplaying windows, and when the frame's face
6899 forget_escape_and_glyphless_faces (void)
6901 last_escape_glyph_frame
= NULL
;
6902 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6903 last_glyphless_glyph_frame
= NULL
;
6904 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6907 /* Load IT's display element fields with information about the next
6908 display element from the current position of IT. Value is false if
6909 end of buffer (or C string) is reached. */
6912 get_next_display_element (struct it
*it
)
6914 /* True means that we found a display element. False means that
6915 we hit the end of what we iterate over. Performance note: the
6916 function pointer `method' used here turns out to be faster than
6917 using a sequence of if-statements. */
6921 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6923 if (it
->what
== IT_CHARACTER
)
6925 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6926 and only if (a) the resolved directionality of that character
6928 /* FIXME: Do we need an exception for characters from display
6930 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
6931 && !inhibit_bidi_mirroring
)
6932 it
->c
= bidi_mirror_char (it
->c
);
6933 /* Map via display table or translate control characters.
6934 IT->c, IT->len etc. have been set to the next character by
6935 the function call above. If we have a display table, and it
6936 contains an entry for IT->c, translate it. Don't do this if
6937 IT->c itself comes from a display table, otherwise we could
6938 end up in an infinite recursion. (An alternative could be to
6939 count the recursion depth of this function and signal an
6940 error when a certain maximum depth is reached.) Is it worth
6942 if (success_p
&& it
->dpvec
== NULL
)
6945 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6946 bool nonascii_space_p
= false;
6947 bool nonascii_hyphen_p
= false;
6948 int c
= it
->c
; /* This is the character to display. */
6950 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6952 eassert (SINGLE_BYTE_CHAR_P (c
));
6953 if (unibyte_display_via_language_environment
)
6955 c
= DECODE_CHAR (unibyte
, c
);
6957 c
= BYTE8_TO_CHAR (it
->c
);
6960 c
= BYTE8_TO_CHAR (it
->c
);
6964 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6967 struct Lisp_Vector
*v
= XVECTOR (dv
);
6969 /* Return the first character from the display table
6970 entry, if not empty. If empty, don't display the
6971 current character. */
6974 it
->dpvec_char_len
= it
->len
;
6975 it
->dpvec
= v
->contents
;
6976 it
->dpend
= v
->contents
+ v
->header
.size
;
6977 it
->current
.dpvec_index
= 0;
6978 it
->dpvec_face_id
= -1;
6979 it
->saved_face_id
= it
->face_id
;
6980 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6981 it
->ellipsis_p
= false;
6985 set_iterator_to_next (it
, false);
6990 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6992 if (it
->what
== IT_GLYPHLESS
)
6994 /* Don't display this character. */
6995 set_iterator_to_next (it
, false);
6999 /* If `nobreak-char-display' is non-nil, we display
7000 non-ASCII spaces and hyphens specially. */
7001 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
7003 if (c
== NO_BREAK_SPACE
)
7004 nonascii_space_p
= true;
7005 else if (c
== SOFT_HYPHEN
|| c
== HYPHEN
7006 || c
== NON_BREAKING_HYPHEN
)
7007 nonascii_hyphen_p
= true;
7010 /* Translate control characters into `\003' or `^C' form.
7011 Control characters coming from a display table entry are
7012 currently not translated because we use IT->dpvec to hold
7013 the translation. This could easily be changed but I
7014 don't believe that it is worth doing.
7016 The characters handled by `nobreak-char-display' must be
7019 Non-printable characters and raw-byte characters are also
7020 translated to octal form. */
7021 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
7022 ? (it
->area
!= TEXT_AREA
7023 /* In mode line, treat \n, \t like other crl chars. */
7026 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
7027 || (c
!= '\n' && c
!= '\t'))
7029 || nonascii_hyphen_p
7031 || ! CHAR_PRINTABLE_P (c
))))
7033 /* C is a control character, non-ASCII space/hyphen,
7034 raw-byte, or a non-printable character which must be
7035 displayed either as '\003' or as `^C' where the '\\'
7036 and '^' can be defined in the display table. Fill
7037 IT->ctl_chars with glyphs for what we have to
7038 display. Then, set IT->dpvec to these glyphs. */
7045 /* Handle control characters with ^. */
7047 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
7051 g
= '^'; /* default glyph for Control */
7052 /* Set IT->ctl_chars[0] to the glyph for `^'. */
7054 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7056 g
= GLYPH_CODE_CHAR (gc
);
7057 lface_id
= GLYPH_CODE_FACE (gc
);
7061 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7062 : merge_escape_glyph_face (it
));
7064 XSETINT (it
->ctl_chars
[0], g
);
7065 XSETINT (it
->ctl_chars
[1], c
^ 0100);
7067 goto display_control
;
7070 /* Handle non-ascii space in the mode where it only gets
7073 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
7075 /* Merge `nobreak-space' into the current face. */
7076 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
7078 XSETINT (it
->ctl_chars
[0], ' ');
7080 goto display_control
;
7083 /* Handle sequences that start with the "escape glyph". */
7085 /* the default escape glyph is \. */
7086 escape_glyph
= '\\';
7089 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7091 escape_glyph
= GLYPH_CODE_CHAR (gc
);
7092 lface_id
= GLYPH_CODE_FACE (gc
);
7096 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7097 : merge_escape_glyph_face (it
));
7099 /* Draw non-ASCII hyphen with just highlighting: */
7101 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
7103 XSETINT (it
->ctl_chars
[0], '-');
7105 goto display_control
;
7108 /* Draw non-ASCII space/hyphen with escape glyph: */
7110 if (nonascii_space_p
|| nonascii_hyphen_p
)
7112 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7113 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7115 goto display_control
;
7122 if (CHAR_BYTE8_P (c
))
7123 /* Display \200 instead of \17777600. */
7124 c
= CHAR_TO_BYTE8 (c
);
7125 len
= sprintf (str
, "%03o", c
+ 0u);
7127 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7128 for (i
= 0; i
< len
; i
++)
7129 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7134 /* Set up IT->dpvec and return first character from it. */
7135 it
->dpvec_char_len
= it
->len
;
7136 it
->dpvec
= it
->ctl_chars
;
7137 it
->dpend
= it
->dpvec
+ ctl_len
;
7138 it
->current
.dpvec_index
= 0;
7139 it
->dpvec_face_id
= face_id
;
7140 it
->saved_face_id
= it
->face_id
;
7141 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7142 it
->ellipsis_p
= false;
7145 it
->char_to_display
= c
;
7149 it
->char_to_display
= it
->c
;
7153 #ifdef HAVE_WINDOW_SYSTEM
7154 /* Adjust face id for a multibyte character. There are no multibyte
7155 character in unibyte text. */
7156 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7159 && FRAME_WINDOW_P (it
->f
))
7161 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7163 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7165 /* Automatic composition with glyph-string. */
7166 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7168 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7172 ptrdiff_t pos
= (it
->s
? -1
7173 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7174 : IT_CHARPOS (*it
));
7177 if (it
->what
== IT_CHARACTER
)
7178 c
= it
->char_to_display
;
7181 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7185 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7186 /* TAB in a composition means display glyphs with
7187 padding space on the left or right. */
7188 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7191 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7194 #endif /* HAVE_WINDOW_SYSTEM */
7197 /* Is this character the last one of a run of characters with
7198 box? If yes, set IT->end_of_box_run_p to true. */
7202 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7204 int face_id
= underlying_face_id (it
);
7205 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7209 if (face
->box
== FACE_NO_BOX
)
7211 /* If the box comes from face properties in a
7212 display string, check faces in that string. */
7213 int string_face_id
= face_after_it_pos (it
);
7214 it
->end_of_box_run_p
7215 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7218 /* Otherwise, the box comes from the underlying face.
7219 If this is the last string character displayed, check
7220 the next buffer location. */
7221 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7222 /* n_overlay_strings is unreliable unless
7223 overlay_string_index is non-negative. */
7224 && ((it
->current
.overlay_string_index
>= 0
7225 && (it
->current
.overlay_string_index
7226 == it
->n_overlay_strings
- 1))
7227 /* A string from display property. */
7228 || it
->from_disp_prop_p
))
7232 struct text_pos pos
= it
->current
.pos
;
7234 /* For a string from a display property, the next
7235 buffer position is stored in the 'position'
7236 member of the iteration stack slot below the
7237 current one, see handle_single_display_spec. By
7238 contrast, it->current.pos was not yet updated
7239 to point to that buffer position; that will
7240 happen in pop_it, after we finish displaying the
7241 current string. Note that we already checked
7242 above that it->sp is positive, so subtracting one
7244 if (it
->from_disp_prop_p
)
7246 int stackp
= it
->sp
- 1;
7248 /* Find the stack level with data from buffer. */
7250 && STRINGP ((it
->stack
+ stackp
)->string
))
7252 eassert (stackp
>= 0);
7253 pos
= (it
->stack
+ stackp
)->position
;
7256 INC_TEXT_POS (pos
, it
->multibyte_p
);
7258 if (CHARPOS (pos
) >= ZV
)
7259 it
->end_of_box_run_p
= true;
7262 next_face_id
= face_at_buffer_position
7263 (it
->w
, CHARPOS (pos
), &ignore
,
7264 CHARPOS (pos
) + TEXT_PROP_DISTANCE_LIMIT
, false, -1);
7265 it
->end_of_box_run_p
7266 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7272 /* next_element_from_display_vector sets this flag according to
7273 faces of the display vector glyphs, see there. */
7274 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7276 int face_id
= face_after_it_pos (it
);
7277 it
->end_of_box_run_p
7278 = (face_id
!= it
->face_id
7279 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7282 /* If we reached the end of the object we've been iterating (e.g., a
7283 display string or an overlay string), and there's something on
7284 IT->stack, proceed with what's on the stack. It doesn't make
7285 sense to return false if there's unprocessed stuff on the stack,
7286 because otherwise that stuff will never be displayed. */
7287 if (!success_p
&& it
->sp
> 0)
7289 set_iterator_to_next (it
, false);
7290 success_p
= get_next_display_element (it
);
7293 /* Value is false if end of buffer or string reached. */
7298 /* Move IT to the next display element.
7300 RESEAT_P means if called on a newline in buffer text,
7301 skip to the next visible line start.
7303 Functions get_next_display_element and set_iterator_to_next are
7304 separate because I find this arrangement easier to handle than a
7305 get_next_display_element function that also increments IT's
7306 position. The way it is we can first look at an iterator's current
7307 display element, decide whether it fits on a line, and if it does,
7308 increment the iterator position. The other way around we probably
7309 would either need a flag indicating whether the iterator has to be
7310 incremented the next time, or we would have to implement a
7311 decrement position function which would not be easy to write. */
7314 set_iterator_to_next (struct it
*it
, bool reseat_p
)
7316 /* Reset flags indicating start and end of a sequence of characters
7317 with box. Reset them at the start of this function because
7318 moving the iterator to a new position might set them. */
7319 it
->start_of_box_run_p
= it
->end_of_box_run_p
= false;
7323 case GET_FROM_BUFFER
:
7324 /* The current display element of IT is a character from
7325 current_buffer. Advance in the buffer, and maybe skip over
7326 invisible lines that are so because of selective display. */
7327 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7328 reseat_at_next_visible_line_start (it
, false);
7329 else if (it
->cmp_it
.id
>= 0)
7331 /* We are currently getting glyphs from a composition. */
7334 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7335 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7341 /* Update IT's char/byte positions to point to the first
7342 character of the next grapheme cluster, or to the
7343 character visually after the current composition. */
7344 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7345 bidi_move_to_visually_next (&it
->bidi_it
);
7346 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7347 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7350 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7351 && it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7353 /* Composition created while scanning forward. Proceed
7354 to the next grapheme cluster. */
7355 it
->cmp_it
.from
= it
->cmp_it
.to
;
7357 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7358 && it
->cmp_it
.from
> 0)
7360 /* Composition created while scanning backward. Proceed
7361 to the previous grapheme cluster. */
7362 it
->cmp_it
.to
= it
->cmp_it
.from
;
7366 /* No more grapheme clusters in this composition.
7367 Find the next stop position. */
7368 ptrdiff_t stop
= it
->end_charpos
;
7370 if (it
->bidi_it
.scan_dir
< 0)
7371 /* Now we are scanning backward and don't know
7374 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7375 IT_BYTEPOS (*it
), stop
, Qnil
);
7380 eassert (it
->len
!= 0);
7384 IT_BYTEPOS (*it
) += it
->len
;
7385 IT_CHARPOS (*it
) += 1;
7389 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7390 /* If this is a new paragraph, determine its base
7391 direction (a.k.a. its base embedding level). */
7392 if (it
->bidi_it
.new_paragraph
)
7393 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
7395 bidi_move_to_visually_next (&it
->bidi_it
);
7396 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7397 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7398 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7400 /* As the scan direction was changed, we must
7401 re-compute the stop position for composition. */
7402 ptrdiff_t stop
= it
->end_charpos
;
7403 if (it
->bidi_it
.scan_dir
< 0)
7405 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7406 IT_BYTEPOS (*it
), stop
, Qnil
);
7409 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7413 case GET_FROM_C_STRING
:
7414 /* Current display element of IT is from a C string. */
7416 /* If the string position is beyond string's end, it means
7417 next_element_from_c_string is padding the string with
7418 blanks, in which case we bypass the bidi iterator,
7419 because it cannot deal with such virtual characters. */
7420 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7422 IT_BYTEPOS (*it
) += it
->len
;
7423 IT_CHARPOS (*it
) += 1;
7427 bidi_move_to_visually_next (&it
->bidi_it
);
7428 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7429 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7433 case GET_FROM_DISPLAY_VECTOR
:
7434 /* Current display element of IT is from a display table entry.
7435 Advance in the display table definition. Reset it to null if
7436 end reached, and continue with characters from buffers/
7438 ++it
->current
.dpvec_index
;
7440 /* Restore face of the iterator to what they were before the
7441 display vector entry (these entries may contain faces). */
7442 it
->face_id
= it
->saved_face_id
;
7444 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7446 bool recheck_faces
= it
->ellipsis_p
;
7449 it
->method
= GET_FROM_C_STRING
;
7450 else if (STRINGP (it
->string
))
7451 it
->method
= GET_FROM_STRING
;
7454 it
->method
= GET_FROM_BUFFER
;
7455 it
->object
= it
->w
->contents
;
7459 it
->current
.dpvec_index
= -1;
7461 /* Skip over characters which were displayed via IT->dpvec. */
7462 if (it
->dpvec_char_len
< 0)
7463 reseat_at_next_visible_line_start (it
, true);
7464 else if (it
->dpvec_char_len
> 0)
7466 it
->len
= it
->dpvec_char_len
;
7467 set_iterator_to_next (it
, reseat_p
);
7470 /* Maybe recheck faces after display vector. */
7473 if (it
->method
== GET_FROM_STRING
)
7474 it
->stop_charpos
= IT_STRING_CHARPOS (*it
);
7476 it
->stop_charpos
= IT_CHARPOS (*it
);
7481 case GET_FROM_STRING
:
7482 /* Current display element is a character from a Lisp string. */
7483 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7484 /* Don't advance past string end. These conditions are true
7485 when set_iterator_to_next is called at the end of
7486 get_next_display_element, in which case the Lisp string is
7487 already exhausted, and all we want is pop the iterator
7489 if (it
->current
.overlay_string_index
>= 0)
7491 /* This is an overlay string, so there's no padding with
7492 spaces, and the number of characters in the string is
7493 where the string ends. */
7494 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7495 goto consider_string_end
;
7499 /* Not an overlay string. There could be padding, so test
7500 against it->end_charpos. */
7501 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7502 goto consider_string_end
;
7504 if (it
->cmp_it
.id
>= 0)
7506 /* We are delivering display elements from a composition.
7507 Update the string position past the grapheme cluster
7508 we've just processed. */
7511 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7512 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7518 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7519 bidi_move_to_visually_next (&it
->bidi_it
);
7520 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7521 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7524 /* Did we exhaust all the grapheme clusters of this
7526 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7527 && (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
))
7529 /* Not all the grapheme clusters were processed yet;
7530 advance to the next cluster. */
7531 it
->cmp_it
.from
= it
->cmp_it
.to
;
7533 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7534 && it
->cmp_it
.from
> 0)
7536 /* Likewise: advance to the next cluster, but going in
7537 the reverse direction. */
7538 it
->cmp_it
.to
= it
->cmp_it
.from
;
7542 /* This composition was fully processed; find the next
7543 candidate place for checking for composed
7545 /* Always limit string searches to the string length;
7546 any padding spaces are not part of the string, and
7547 there cannot be any compositions in that padding. */
7548 ptrdiff_t stop
= SCHARS (it
->string
);
7550 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
7552 else if (it
->end_charpos
< stop
)
7554 /* Cf. PRECISION in reseat_to_string: we might be
7555 limited in how many of the string characters we
7557 stop
= it
->end_charpos
;
7559 composition_compute_stop_pos (&it
->cmp_it
,
7560 IT_STRING_CHARPOS (*it
),
7561 IT_STRING_BYTEPOS (*it
), stop
,
7568 /* If the string position is beyond string's end, it
7569 means next_element_from_string is padding the string
7570 with blanks, in which case we bypass the bidi
7571 iterator, because it cannot deal with such virtual
7573 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7575 IT_STRING_BYTEPOS (*it
) += it
->len
;
7576 IT_STRING_CHARPOS (*it
) += 1;
7580 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7582 bidi_move_to_visually_next (&it
->bidi_it
);
7583 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7584 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7585 /* If the scan direction changes, we may need to update
7586 the place where to check for composed characters. */
7587 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7589 ptrdiff_t stop
= SCHARS (it
->string
);
7591 if (it
->bidi_it
.scan_dir
< 0)
7593 else if (it
->end_charpos
< stop
)
7594 stop
= it
->end_charpos
;
7596 composition_compute_stop_pos (&it
->cmp_it
,
7597 IT_STRING_CHARPOS (*it
),
7598 IT_STRING_BYTEPOS (*it
), stop
,
7604 consider_string_end
:
7606 if (it
->current
.overlay_string_index
>= 0)
7608 /* IT->string is an overlay string. Advance to the
7609 next, if there is one. */
7610 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7612 it
->ellipsis_p
= false;
7613 next_overlay_string (it
);
7615 setup_for_ellipsis (it
, 0);
7620 /* IT->string is not an overlay string. If we reached
7621 its end, and there is something on IT->stack, proceed
7622 with what is on the stack. This can be either another
7623 string, this time an overlay string, or a buffer. */
7624 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7628 if (it
->method
== GET_FROM_STRING
)
7629 goto consider_string_end
;
7634 case GET_FROM_IMAGE
:
7635 case GET_FROM_STRETCH
:
7636 case GET_FROM_XWIDGET
:
7638 /* The position etc with which we have to proceed are on
7639 the stack. The position may be at the end of a string,
7640 if the `display' property takes up the whole string. */
7641 eassert (it
->sp
> 0);
7643 if (it
->method
== GET_FROM_STRING
)
7644 goto consider_string_end
;
7648 /* There are no other methods defined, so this should be a bug. */
7652 eassert (it
->method
!= GET_FROM_STRING
7653 || (STRINGP (it
->string
)
7654 && IT_STRING_CHARPOS (*it
) >= 0));
7657 /* Load IT's display element fields with information about the next
7658 display element which comes from a display table entry or from the
7659 result of translating a control character to one of the forms `^C'
7662 IT->dpvec holds the glyphs to return as characters.
7663 IT->saved_face_id holds the face id before the display vector--it
7664 is restored into IT->face_id in set_iterator_to_next. */
7667 next_element_from_display_vector (struct it
*it
)
7670 int prev_face_id
= it
->face_id
;
7674 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7676 it
->face_id
= it
->saved_face_id
;
7678 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7679 That seemed totally bogus - so I changed it... */
7680 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7682 if (GLYPH_CODE_P (gc
))
7684 struct face
*this_face
, *prev_face
, *next_face
;
7686 it
->c
= GLYPH_CODE_CHAR (gc
);
7687 it
->len
= CHAR_BYTES (it
->c
);
7689 /* The entry may contain a face id to use. Such a face id is
7690 the id of a Lisp face, not a realized face. A face id of
7691 zero means no face is specified. */
7692 if (it
->dpvec_face_id
>= 0)
7693 it
->face_id
= it
->dpvec_face_id
;
7696 int lface_id
= GLYPH_CODE_FACE (gc
);
7698 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7702 /* Glyphs in the display vector could have the box face, so we
7703 need to set the related flags in the iterator, as
7705 this_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7706 prev_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
7708 /* Is this character the first character of a box-face run? */
7709 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7711 || prev_face
->box
== FACE_NO_BOX
));
7713 /* For the last character of the box-face run, we need to look
7714 either at the next glyph from the display vector, or at the
7715 face we saw before the display vector. */
7716 next_face_id
= it
->saved_face_id
;
7717 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7719 if (it
->dpvec_face_id
>= 0)
7720 next_face_id
= it
->dpvec_face_id
;
7724 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7727 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7731 next_face
= FACE_FROM_ID (it
->f
, next_face_id
);
7732 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7734 || next_face
->box
== FACE_NO_BOX
));
7735 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7738 /* Display table entry is invalid. Return a space. */
7739 it
->c
= ' ', it
->len
= 1;
7741 /* Don't change position and object of the iterator here. They are
7742 still the values of the character that had this display table
7743 entry or was translated, and that's what we want. */
7744 it
->what
= IT_CHARACTER
;
7748 /* Get the first element of string/buffer in the visual order, after
7749 being reseated to a new position in a string or a buffer. */
7751 get_visually_first_element (struct it
*it
)
7753 bool string_p
= STRINGP (it
->string
) || it
->s
;
7754 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7755 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7757 if (STRINGP (it
->string
))
7759 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7760 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7764 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7765 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7768 if (it
->bidi_it
.charpos
== eob
)
7770 /* Nothing to do, but reset the FIRST_ELT flag, like
7771 bidi_paragraph_init does, because we are not going to
7773 it
->bidi_it
.first_elt
= false;
7775 else if (it
->bidi_it
.charpos
== bob
7777 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7778 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7780 /* If we are at the beginning of a line/string, we can produce
7781 the next element right away. */
7782 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7783 bidi_move_to_visually_next (&it
->bidi_it
);
7787 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7789 /* We need to prime the bidi iterator starting at the line's or
7790 string's beginning, before we will be able to produce the
7793 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7795 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7796 IT_BYTEPOS (*it
), -1,
7797 &it
->bidi_it
.bytepos
);
7798 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7801 /* Now return to buffer/string position where we were asked
7802 to get the next display element, and produce that. */
7803 bidi_move_to_visually_next (&it
->bidi_it
);
7805 while (it
->bidi_it
.bytepos
!= orig_bytepos
7806 && it
->bidi_it
.charpos
< eob
);
7809 /* Adjust IT's position information to where we ended up. */
7810 if (STRINGP (it
->string
))
7812 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7813 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7817 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7818 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7821 if (STRINGP (it
->string
) || !it
->s
)
7823 ptrdiff_t stop
, charpos
, bytepos
;
7825 if (STRINGP (it
->string
))
7828 stop
= SCHARS (it
->string
);
7829 if (stop
> it
->end_charpos
)
7830 stop
= it
->end_charpos
;
7831 charpos
= IT_STRING_CHARPOS (*it
);
7832 bytepos
= IT_STRING_BYTEPOS (*it
);
7836 stop
= it
->end_charpos
;
7837 charpos
= IT_CHARPOS (*it
);
7838 bytepos
= IT_BYTEPOS (*it
);
7840 if (it
->bidi_it
.scan_dir
< 0)
7842 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7847 /* Load IT with the next display element from Lisp string IT->string.
7848 IT->current.string_pos is the current position within the string.
7849 If IT->current.overlay_string_index >= 0, the Lisp string is an
7853 next_element_from_string (struct it
*it
)
7855 struct text_pos position
;
7857 eassert (STRINGP (it
->string
));
7858 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7859 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7860 position
= it
->current
.string_pos
;
7862 /* With bidi reordering, the character to display might not be the
7863 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT means
7864 that we were reseat()ed to a new string, whose paragraph
7865 direction is not known. */
7866 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7868 get_visually_first_element (it
);
7869 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7872 /* Time to check for invisible text? */
7873 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7875 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7878 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7879 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7881 /* With bidi non-linear iteration, we could find
7882 ourselves far beyond the last computed stop_charpos,
7883 with several other stop positions in between that we
7884 missed. Scan them all now, in buffer's logical
7885 order, until we find and handle the last stop_charpos
7886 that precedes our current position. */
7887 handle_stop_backwards (it
, it
->stop_charpos
);
7888 return GET_NEXT_DISPLAY_ELEMENT (it
);
7894 /* Take note of the stop position we just moved
7895 across, for when we will move back across it. */
7896 it
->prev_stop
= it
->stop_charpos
;
7897 /* If we are at base paragraph embedding level, take
7898 note of the last stop position seen at this
7900 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7901 it
->base_level_stop
= it
->stop_charpos
;
7905 /* Since a handler may have changed IT->method, we must
7907 return GET_NEXT_DISPLAY_ELEMENT (it
);
7911 /* If we are before prev_stop, we may have overstepped
7912 on our way backwards a stop_pos, and if so, we need
7913 to handle that stop_pos. */
7914 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7915 /* We can sometimes back up for reasons that have nothing
7916 to do with bidi reordering. E.g., compositions. The
7917 code below is only needed when we are above the base
7918 embedding level, so test for that explicitly. */
7919 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7921 /* If we lost track of base_level_stop, we have no better
7922 place for handle_stop_backwards to start from than string
7923 beginning. This happens, e.g., when we were reseated to
7924 the previous screenful of text by vertical-motion. */
7925 if (it
->base_level_stop
<= 0
7926 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7927 it
->base_level_stop
= 0;
7928 handle_stop_backwards (it
, it
->base_level_stop
);
7929 return GET_NEXT_DISPLAY_ELEMENT (it
);
7933 if (it
->current
.overlay_string_index
>= 0)
7935 /* Get the next character from an overlay string. In overlay
7936 strings, there is no field width or padding with spaces to
7938 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7943 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7944 IT_STRING_BYTEPOS (*it
),
7945 it
->bidi_it
.scan_dir
< 0
7947 : SCHARS (it
->string
))
7948 && next_element_from_composition (it
))
7952 else if (STRING_MULTIBYTE (it
->string
))
7954 const unsigned char *s
= (SDATA (it
->string
)
7955 + IT_STRING_BYTEPOS (*it
));
7956 it
->c
= string_char_and_length (s
, &it
->len
);
7960 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7966 /* Get the next character from a Lisp string that is not an
7967 overlay string. Such strings come from the mode line, for
7968 example. We may have to pad with spaces, or truncate the
7969 string. See also next_element_from_c_string. */
7970 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7975 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7977 /* Pad with spaces. */
7978 it
->c
= ' ', it
->len
= 1;
7979 CHARPOS (position
) = BYTEPOS (position
) = -1;
7981 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7982 IT_STRING_BYTEPOS (*it
),
7983 it
->bidi_it
.scan_dir
< 0
7985 : it
->string_nchars
)
7986 && next_element_from_composition (it
))
7990 else if (STRING_MULTIBYTE (it
->string
))
7992 const unsigned char *s
= (SDATA (it
->string
)
7993 + IT_STRING_BYTEPOS (*it
));
7994 it
->c
= string_char_and_length (s
, &it
->len
);
7998 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
8003 /* Record what we have and where it came from. */
8004 it
->what
= IT_CHARACTER
;
8005 it
->object
= it
->string
;
8006 it
->position
= position
;
8011 /* Load IT with next display element from C string IT->s.
8012 IT->string_nchars is the maximum number of characters to return
8013 from the string. IT->end_charpos may be greater than
8014 IT->string_nchars when this function is called, in which case we
8015 may have to return padding spaces. Value is false if end of string
8016 reached, including padding spaces. */
8019 next_element_from_c_string (struct it
*it
)
8021 bool success_p
= true;
8024 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
8025 it
->what
= IT_CHARACTER
;
8026 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
8027 it
->object
= make_number (0);
8029 /* With bidi reordering, the character to display might not be the
8030 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
8031 we were reseated to a new string, whose paragraph direction is
8033 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8034 get_visually_first_element (it
);
8036 /* IT's position can be greater than IT->string_nchars in case a
8037 field width or precision has been specified when the iterator was
8039 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8041 /* End of the game. */
8045 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
8047 /* Pad with spaces. */
8048 it
->c
= ' ', it
->len
= 1;
8049 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
8051 else if (it
->multibyte_p
)
8052 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
8054 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
8060 /* Set up IT to return characters from an ellipsis, if appropriate.
8061 The definition of the ellipsis glyphs may come from a display table
8062 entry. This function fills IT with the first glyph from the
8063 ellipsis if an ellipsis is to be displayed. */
8066 next_element_from_ellipsis (struct it
*it
)
8068 if (it
->selective_display_ellipsis_p
)
8069 setup_for_ellipsis (it
, it
->len
);
8072 /* The face at the current position may be different from the
8073 face we find after the invisible text. Remember what it
8074 was in IT->saved_face_id, and signal that it's there by
8075 setting face_before_selective_p. */
8076 it
->saved_face_id
= it
->face_id
;
8077 it
->method
= GET_FROM_BUFFER
;
8078 it
->object
= it
->w
->contents
;
8079 reseat_at_next_visible_line_start (it
, true);
8080 it
->face_before_selective_p
= true;
8083 return GET_NEXT_DISPLAY_ELEMENT (it
);
8087 /* Deliver an image display element. The iterator IT is already
8088 filled with image information (done in handle_display_prop). Value
8093 next_element_from_image (struct it
*it
)
8095 it
->what
= IT_IMAGE
;
8100 next_element_from_xwidget (struct it
*it
)
8102 it
->what
= IT_XWIDGET
;
8107 /* Fill iterator IT with next display element from a stretch glyph
8108 property. IT->object is the value of the text property. Value is
8112 next_element_from_stretch (struct it
*it
)
8114 it
->what
= IT_STRETCH
;
8118 /* Scan backwards from IT's current position until we find a stop
8119 position, or until BEGV. This is called when we find ourself
8120 before both the last known prev_stop and base_level_stop while
8121 reordering bidirectional text. */
8124 compute_stop_pos_backwards (struct it
*it
)
8126 const int SCAN_BACK_LIMIT
= 1000;
8127 struct text_pos pos
;
8128 struct display_pos save_current
= it
->current
;
8129 struct text_pos save_position
= it
->position
;
8130 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8131 ptrdiff_t where_we_are
= charpos
;
8132 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8133 ptrdiff_t save_end_pos
= it
->end_charpos
;
8135 eassert (NILP (it
->string
) && !it
->s
);
8136 eassert (it
->bidi_p
);
8140 it
->end_charpos
= min (charpos
+ 1, ZV
);
8141 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8142 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8143 reseat_1 (it
, pos
, false);
8144 compute_stop_pos (it
);
8145 /* We must advance forward, right? */
8146 if (it
->stop_charpos
<= charpos
)
8149 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8151 if (it
->stop_charpos
<= where_we_are
)
8152 it
->prev_stop
= it
->stop_charpos
;
8154 it
->prev_stop
= BEGV
;
8156 it
->current
= save_current
;
8157 it
->position
= save_position
;
8158 it
->stop_charpos
= save_stop_pos
;
8159 it
->end_charpos
= save_end_pos
;
8162 /* Scan forward from CHARPOS in the current buffer/string, until we
8163 find a stop position > current IT's position. Then handle the stop
8164 position before that. This is called when we bump into a stop
8165 position while reordering bidirectional text. CHARPOS should be
8166 the last previously processed stop_pos (or BEGV/0, if none were
8167 processed yet) whose position is less that IT's current
8171 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8173 bool bufp
= !STRINGP (it
->string
);
8174 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8175 struct display_pos save_current
= it
->current
;
8176 struct text_pos save_position
= it
->position
;
8177 struct text_pos pos1
;
8178 ptrdiff_t next_stop
;
8180 /* Scan in strict logical order. */
8181 eassert (it
->bidi_p
);
8185 it
->prev_stop
= charpos
;
8188 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8189 reseat_1 (it
, pos1
, false);
8192 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8193 compute_stop_pos (it
);
8194 /* We must advance forward, right? */
8195 if (it
->stop_charpos
<= it
->prev_stop
)
8197 charpos
= it
->stop_charpos
;
8199 while (charpos
<= where_we_are
);
8202 it
->current
= save_current
;
8203 it
->position
= save_position
;
8204 next_stop
= it
->stop_charpos
;
8205 it
->stop_charpos
= it
->prev_stop
;
8207 it
->stop_charpos
= next_stop
;
8210 /* Load IT with the next display element from current_buffer. Value
8211 is false if end of buffer reached. IT->stop_charpos is the next
8212 position at which to stop and check for text properties or buffer
8216 next_element_from_buffer (struct it
*it
)
8218 bool success_p
= true;
8220 eassert (IT_CHARPOS (*it
) >= BEGV
);
8221 eassert (NILP (it
->string
) && !it
->s
);
8222 eassert (!it
->bidi_p
8223 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8224 && it
->bidi_it
.string
.s
== NULL
));
8226 /* With bidi reordering, the character to display might not be the
8227 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
8228 we were reseat()ed to a new buffer position, which is potentially
8229 a different paragraph. */
8230 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8232 get_visually_first_element (it
);
8233 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8236 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8238 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8240 bool overlay_strings_follow_p
;
8242 /* End of the game, except when overlay strings follow that
8243 haven't been returned yet. */
8244 if (it
->overlay_strings_at_end_processed_p
)
8245 overlay_strings_follow_p
= false;
8248 it
->overlay_strings_at_end_processed_p
= true;
8249 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8252 if (overlay_strings_follow_p
)
8253 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8257 it
->position
= it
->current
.pos
;
8261 else if (!(!it
->bidi_p
8262 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8263 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8265 /* With bidi non-linear iteration, we could find ourselves
8266 far beyond the last computed stop_charpos, with several
8267 other stop positions in between that we missed. Scan
8268 them all now, in buffer's logical order, until we find
8269 and handle the last stop_charpos that precedes our
8270 current position. */
8271 handle_stop_backwards (it
, it
->stop_charpos
);
8272 it
->ignore_overlay_strings_at_pos_p
= false;
8273 return GET_NEXT_DISPLAY_ELEMENT (it
);
8279 /* Take note of the stop position we just moved across,
8280 for when we will move back across it. */
8281 it
->prev_stop
= it
->stop_charpos
;
8282 /* If we are at base paragraph embedding level, take
8283 note of the last stop position seen at this
8285 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8286 it
->base_level_stop
= it
->stop_charpos
;
8289 it
->ignore_overlay_strings_at_pos_p
= false;
8290 return GET_NEXT_DISPLAY_ELEMENT (it
);
8294 /* If we are before prev_stop, we may have overstepped on
8295 our way backwards a stop_pos, and if so, we need to
8296 handle that stop_pos. */
8297 && IT_CHARPOS (*it
) < it
->prev_stop
8298 /* We can sometimes back up for reasons that have nothing
8299 to do with bidi reordering. E.g., compositions. The
8300 code below is only needed when we are above the base
8301 embedding level, so test for that explicitly. */
8302 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8304 if (it
->base_level_stop
<= 0
8305 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8307 /* If we lost track of base_level_stop, we need to find
8308 prev_stop by looking backwards. This happens, e.g., when
8309 we were reseated to the previous screenful of text by
8311 it
->base_level_stop
= BEGV
;
8312 compute_stop_pos_backwards (it
);
8313 handle_stop_backwards (it
, it
->prev_stop
);
8316 handle_stop_backwards (it
, it
->base_level_stop
);
8317 it
->ignore_overlay_strings_at_pos_p
= false;
8318 return GET_NEXT_DISPLAY_ELEMENT (it
);
8322 /* No face changes, overlays etc. in sight, so just return a
8323 character from current_buffer. */
8327 /* We moved to the next buffer position, so any info about
8328 previously seen overlays is no longer valid. */
8329 it
->ignore_overlay_strings_at_pos_p
= false;
8331 /* Maybe run the redisplay end trigger hook. Performance note:
8332 This doesn't seem to cost measurable time. */
8333 if (it
->redisplay_end_trigger_charpos
8335 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8336 run_redisplay_end_trigger_hook (it
);
8338 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8339 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8341 && next_element_from_composition (it
))
8346 /* Get the next character, maybe multibyte. */
8347 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8348 if (it
->multibyte_p
&& !ASCII_CHAR_P (*p
))
8349 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8351 it
->c
= *p
, it
->len
= 1;
8353 /* Record what we have and where it came from. */
8354 it
->what
= IT_CHARACTER
;
8355 it
->object
= it
->w
->contents
;
8356 it
->position
= it
->current
.pos
;
8358 /* Normally we return the character found above, except when we
8359 really want to return an ellipsis for selective display. */
8364 /* A value of selective > 0 means hide lines indented more
8365 than that number of columns. */
8366 if (it
->selective
> 0
8367 && IT_CHARPOS (*it
) + 1 < ZV
8368 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8369 IT_BYTEPOS (*it
) + 1,
8372 success_p
= next_element_from_ellipsis (it
);
8373 it
->dpvec_char_len
= -1;
8376 else if (it
->c
== '\r' && it
->selective
== -1)
8378 /* A value of selective == -1 means that everything from the
8379 CR to the end of the line is invisible, with maybe an
8380 ellipsis displayed for it. */
8381 success_p
= next_element_from_ellipsis (it
);
8382 it
->dpvec_char_len
= -1;
8387 /* Value is false if end of buffer reached. */
8388 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8393 /* Run the redisplay end trigger hook for IT. */
8396 run_redisplay_end_trigger_hook (struct it
*it
)
8398 /* IT->glyph_row should be non-null, i.e. we should be actually
8399 displaying something, or otherwise we should not run the hook. */
8400 eassert (it
->glyph_row
);
8402 ptrdiff_t charpos
= it
->redisplay_end_trigger_charpos
;
8403 it
->redisplay_end_trigger_charpos
= 0;
8405 /* Since we are *trying* to run these functions, don't try to run
8406 them again, even if they get an error. */
8407 wset_redisplay_end_trigger (it
->w
, Qnil
);
8408 CALLN (Frun_hook_with_args
, Qredisplay_end_trigger_functions
, it
->window
,
8409 make_number (charpos
));
8411 /* Notice if it changed the face of the character we are on. */
8412 handle_face_prop (it
);
8416 /* Deliver a composition display element. Unlike the other
8417 next_element_from_XXX, this function is not registered in the array
8418 get_next_element[]. It is called from next_element_from_buffer and
8419 next_element_from_string when necessary. */
8422 next_element_from_composition (struct it
*it
)
8424 it
->what
= IT_COMPOSITION
;
8425 it
->len
= it
->cmp_it
.nbytes
;
8426 if (STRINGP (it
->string
))
8430 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8431 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8434 it
->position
= it
->current
.string_pos
;
8435 it
->object
= it
->string
;
8436 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8437 IT_STRING_BYTEPOS (*it
), it
->string
);
8443 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8444 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8447 if (it
->bidi_it
.new_paragraph
)
8448 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
8450 /* Resync the bidi iterator with IT's new position.
8451 FIXME: this doesn't support bidirectional text. */
8452 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8453 bidi_move_to_visually_next (&it
->bidi_it
);
8457 it
->position
= it
->current
.pos
;
8458 it
->object
= it
->w
->contents
;
8459 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8460 IT_BYTEPOS (*it
), Qnil
);
8467 /***********************************************************************
8468 Moving an iterator without producing glyphs
8469 ***********************************************************************/
8471 /* Check if iterator is at a position corresponding to a valid buffer
8472 position after some move_it_ call. */
8474 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8475 ((it)->method != GET_FROM_STRING || IT_STRING_CHARPOS (*it) == 0)
8478 /* Move iterator IT to a specified buffer or X position within one
8479 line on the display without producing glyphs.
8481 OP should be a bit mask including some or all of these bits:
8482 MOVE_TO_X: Stop upon reaching x-position TO_X.
8483 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8484 Regardless of OP's value, stop upon reaching the end of the display line.
8486 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8487 This means, in particular, that TO_X includes window's horizontal
8490 The return value has several possible values that
8491 say what condition caused the scan to stop:
8493 MOVE_POS_MATCH_OR_ZV
8494 - when TO_POS or ZV was reached.
8497 -when TO_X was reached before TO_POS or ZV were reached.
8500 - when we reached the end of the display area and the line must
8504 - when we reached the end of the display area and the line is
8508 - when we stopped at a line end, i.e. a newline or a CR and selective
8511 static enum move_it_result
8512 move_it_in_display_line_to (struct it
*it
,
8513 ptrdiff_t to_charpos
, int to_x
,
8514 enum move_operation_enum op
)
8516 enum move_it_result result
= MOVE_UNDEFINED
;
8517 struct glyph_row
*saved_glyph_row
;
8518 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8519 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8520 void *ppos_data
= NULL
;
8521 bool may_wrap
= false;
8522 enum it_method prev_method
= it
->method
;
8523 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8524 bool saw_smaller_pos
= prev_pos
< to_charpos
;
8526 /* Don't produce glyphs in produce_glyphs. */
8527 saved_glyph_row
= it
->glyph_row
;
8528 it
->glyph_row
= NULL
;
8530 /* Use wrap_it to save a copy of IT wherever a word wrap could
8531 occur. Use atpos_it to save a copy of IT at the desired buffer
8532 position, if found, so that we can scan ahead and check if the
8533 word later overshoots the window edge. Use atx_it similarly, for
8539 /* Use ppos_it under bidi reordering to save a copy of IT for the
8540 initial position. We restore that position in IT when we have
8541 scanned the entire display line without finding a match for
8542 TO_CHARPOS and all the character positions are greater than
8543 TO_CHARPOS. We then restart the scan from the initial position,
8544 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8545 the closest to TO_CHARPOS. */
8548 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8550 SAVE_IT (ppos_it
, *it
, ppos_data
);
8551 closest_pos
= IT_CHARPOS (*it
);
8557 #define BUFFER_POS_REACHED_P() \
8558 ((op & MOVE_TO_POS) != 0 \
8559 && BUFFERP (it->object) \
8560 && (IT_CHARPOS (*it) == to_charpos \
8562 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8563 && IT_CHARPOS (*it) > to_charpos) \
8564 || (it->what == IT_COMPOSITION \
8565 && ((IT_CHARPOS (*it) > to_charpos \
8566 && to_charpos >= it->cmp_it.charpos) \
8567 || (IT_CHARPOS (*it) < to_charpos \
8568 && to_charpos <= it->cmp_it.charpos)))) \
8569 && (it->method == GET_FROM_BUFFER \
8570 || (it->method == GET_FROM_DISPLAY_VECTOR \
8571 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8573 /* If there's a line-/wrap-prefix, handle it. */
8574 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8575 && it
->current_y
< it
->last_visible_y
)
8576 handle_line_prefix (it
);
8578 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8579 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8583 int x
, i
, ascent
= 0, descent
= 0;
8585 /* Utility macro to reset an iterator with x, ascent, and descent. */
8586 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8587 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8588 (IT)->max_descent = descent)
8590 /* Stop if we move beyond TO_CHARPOS (after an image or a
8591 display string or stretch glyph). */
8592 if ((op
& MOVE_TO_POS
) != 0
8593 && BUFFERP (it
->object
)
8594 && it
->method
== GET_FROM_BUFFER
8596 /* When the iterator is at base embedding level, we
8597 are guaranteed that characters are delivered for
8598 display in strictly increasing order of their
8599 buffer positions. */
8600 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8601 && IT_CHARPOS (*it
) > to_charpos
)
8603 && (prev_method
== GET_FROM_IMAGE
8604 || prev_method
== GET_FROM_STRETCH
8605 || prev_method
== GET_FROM_STRING
)
8606 /* Passed TO_CHARPOS from left to right. */
8607 && ((prev_pos
< to_charpos
8608 && IT_CHARPOS (*it
) > to_charpos
)
8609 /* Passed TO_CHARPOS from right to left. */
8610 || (prev_pos
> to_charpos
8611 && IT_CHARPOS (*it
) < to_charpos
)))))
8613 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8615 result
= MOVE_POS_MATCH_OR_ZV
;
8618 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8619 /* If wrap_it is valid, the current position might be in a
8620 word that is wrapped. So, save the iterator in
8621 atpos_it and continue to see if wrapping happens. */
8622 SAVE_IT (atpos_it
, *it
, atpos_data
);
8625 /* Stop when ZV reached.
8626 We used to stop here when TO_CHARPOS reached as well, but that is
8627 too soon if this glyph does not fit on this line. So we handle it
8628 explicitly below. */
8629 if (!get_next_display_element (it
))
8631 result
= MOVE_POS_MATCH_OR_ZV
;
8635 if (it
->line_wrap
== TRUNCATE
)
8637 if (BUFFER_POS_REACHED_P ())
8639 result
= MOVE_POS_MATCH_OR_ZV
;
8645 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8647 if (IT_DISPLAYING_WHITESPACE (it
))
8651 /* We have reached a glyph that follows one or more
8652 whitespace characters. If the position is
8653 already found, we are done. */
8654 if (atpos_it
.sp
>= 0)
8656 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8657 result
= MOVE_POS_MATCH_OR_ZV
;
8662 RESTORE_IT (it
, &atx_it
, atx_data
);
8663 result
= MOVE_X_REACHED
;
8666 /* Otherwise, we can wrap here. */
8667 SAVE_IT (wrap_it
, *it
, wrap_data
);
8673 /* Remember the line height for the current line, in case
8674 the next element doesn't fit on the line. */
8675 ascent
= it
->max_ascent
;
8676 descent
= it
->max_descent
;
8678 /* The call to produce_glyphs will get the metrics of the
8679 display element IT is loaded with. Record the x-position
8680 before this display element, in case it doesn't fit on the
8684 PRODUCE_GLYPHS (it
);
8686 if (it
->area
!= TEXT_AREA
)
8688 prev_method
= it
->method
;
8689 if (it
->method
== GET_FROM_BUFFER
)
8690 prev_pos
= IT_CHARPOS (*it
);
8691 set_iterator_to_next (it
, true);
8692 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8693 SET_TEXT_POS (this_line_min_pos
,
8694 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8696 && (op
& MOVE_TO_POS
)
8697 && IT_CHARPOS (*it
) > to_charpos
8698 && IT_CHARPOS (*it
) < closest_pos
)
8699 closest_pos
= IT_CHARPOS (*it
);
8703 /* The number of glyphs we get back in IT->nglyphs will normally
8704 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8705 character on a terminal frame, or (iii) a line end. For the
8706 second case, IT->nglyphs - 1 padding glyphs will be present.
8707 (On X frames, there is only one glyph produced for a
8708 composite character.)
8710 The behavior implemented below means, for continuation lines,
8711 that as many spaces of a TAB as fit on the current line are
8712 displayed there. For terminal frames, as many glyphs of a
8713 multi-glyph character are displayed in the current line, too.
8714 This is what the old redisplay code did, and we keep it that
8715 way. Under X, the whole shape of a complex character must
8716 fit on the line or it will be completely displayed in the
8719 Note that both for tabs and padding glyphs, all glyphs have
8723 /* More than one glyph or glyph doesn't fit on line. All
8724 glyphs have the same width. */
8725 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8727 int x_before_this_char
= x
;
8728 int hpos_before_this_char
= it
->hpos
;
8730 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8732 new_x
= x
+ single_glyph_width
;
8734 /* We want to leave anything reaching TO_X to the caller. */
8735 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8737 if (BUFFER_POS_REACHED_P ())
8739 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8740 goto buffer_pos_reached
;
8741 if (atpos_it
.sp
< 0)
8743 SAVE_IT (atpos_it
, *it
, atpos_data
);
8744 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8749 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8752 result
= MOVE_X_REACHED
;
8757 SAVE_IT (atx_it
, *it
, atx_data
);
8758 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8763 if (/* Lines are continued. */
8764 it
->line_wrap
!= TRUNCATE
8765 && (/* And glyph doesn't fit on the line. */
8766 new_x
> it
->last_visible_x
8767 /* Or it fits exactly and we're on a window
8769 || (new_x
== it
->last_visible_x
8770 && FRAME_WINDOW_P (it
->f
)
8771 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8772 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8773 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8775 if (/* IT->hpos == 0 means the very first glyph
8776 doesn't fit on the line, e.g. a wide image. */
8778 || (new_x
== it
->last_visible_x
8779 && FRAME_WINDOW_P (it
->f
)))
8782 it
->current_x
= new_x
;
8784 /* The character's last glyph just barely fits
8786 if (i
== it
->nglyphs
- 1)
8788 /* If this is the destination position,
8789 return a position *before* it in this row,
8790 now that we know it fits in this row. */
8791 if (BUFFER_POS_REACHED_P ())
8793 if (it
->line_wrap
!= WORD_WRAP
8795 /* If we've just found whitespace to
8796 wrap, effectively ignore the
8797 previous wrap point -- it is no
8798 longer relevant, but we won't
8799 have an opportunity to update it,
8800 since we've reached the edge of
8801 this screen line. */
8803 && IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8805 it
->hpos
= hpos_before_this_char
;
8806 it
->current_x
= x_before_this_char
;
8807 result
= MOVE_POS_MATCH_OR_ZV
;
8810 if (it
->line_wrap
== WORD_WRAP
8813 SAVE_IT (atpos_it
, *it
, atpos_data
);
8814 atpos_it
.current_x
= x_before_this_char
;
8815 atpos_it
.hpos
= hpos_before_this_char
;
8819 prev_method
= it
->method
;
8820 if (it
->method
== GET_FROM_BUFFER
)
8821 prev_pos
= IT_CHARPOS (*it
);
8822 set_iterator_to_next (it
, true);
8823 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8824 SET_TEXT_POS (this_line_min_pos
,
8825 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8826 /* On graphical terminals, newlines may
8827 "overflow" into the fringe if
8828 overflow-newline-into-fringe is non-nil.
8829 On text terminals, and on graphical
8830 terminals with no right margin, newlines
8831 may overflow into the last glyph on the
8833 if (!FRAME_WINDOW_P (it
->f
)
8835 && it
->bidi_it
.paragraph_dir
== R2L
)
8836 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8837 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8838 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8840 if (!get_next_display_element (it
))
8842 result
= MOVE_POS_MATCH_OR_ZV
;
8845 if (BUFFER_POS_REACHED_P ())
8847 if (ITERATOR_AT_END_OF_LINE_P (it
))
8848 result
= MOVE_POS_MATCH_OR_ZV
;
8850 result
= MOVE_LINE_CONTINUED
;
8853 if (ITERATOR_AT_END_OF_LINE_P (it
)
8854 && (it
->line_wrap
!= WORD_WRAP
8856 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8858 result
= MOVE_NEWLINE_OR_CR
;
8865 IT_RESET_X_ASCENT_DESCENT (it
);
8867 /* If the screen line ends with whitespace, and we
8868 are under word-wrap, don't use wrap_it: it is no
8869 longer relevant, but we won't have an opportunity
8870 to update it, since we are done with this screen
8872 if (may_wrap
&& IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8874 /* If we've found TO_X, go back there, as we now
8875 know the last word fits on this screen line. */
8876 if ((op
& MOVE_TO_X
) && new_x
== it
->last_visible_x
8879 RESTORE_IT (it
, &atx_it
, atx_data
);
8882 result
= MOVE_X_REACHED
;
8886 else if (wrap_it
.sp
>= 0)
8888 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8893 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8895 result
= MOVE_LINE_CONTINUED
;
8899 if (BUFFER_POS_REACHED_P ())
8901 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8902 goto buffer_pos_reached
;
8903 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8905 SAVE_IT (atpos_it
, *it
, atpos_data
);
8906 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8910 if (new_x
> it
->first_visible_x
)
8912 /* Glyph is visible. Increment number of glyphs that
8913 would be displayed. */
8918 if (result
!= MOVE_UNDEFINED
)
8921 else if (BUFFER_POS_REACHED_P ())
8924 IT_RESET_X_ASCENT_DESCENT (it
);
8925 result
= MOVE_POS_MATCH_OR_ZV
;
8928 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8930 /* Stop when TO_X specified and reached. This check is
8931 necessary here because of lines consisting of a line end,
8932 only. The line end will not produce any glyphs and we
8933 would never get MOVE_X_REACHED. */
8934 eassert (it
->nglyphs
== 0);
8935 result
= MOVE_X_REACHED
;
8939 /* Is this a line end? If yes, we're done. */
8940 if (ITERATOR_AT_END_OF_LINE_P (it
))
8942 /* If we are past TO_CHARPOS, but never saw any character
8943 positions smaller than TO_CHARPOS, return
8944 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8946 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8948 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8950 if (closest_pos
< ZV
)
8952 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8953 /* Don't recurse if closest_pos is equal to
8954 to_charpos, since we have just tried that. */
8955 if (closest_pos
!= to_charpos
)
8956 move_it_in_display_line_to (it
, closest_pos
, -1,
8958 result
= MOVE_POS_MATCH_OR_ZV
;
8961 goto buffer_pos_reached
;
8963 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8964 && IT_CHARPOS (*it
) > to_charpos
)
8965 goto buffer_pos_reached
;
8967 result
= MOVE_NEWLINE_OR_CR
;
8970 result
= MOVE_NEWLINE_OR_CR
;
8974 prev_method
= it
->method
;
8975 if (it
->method
== GET_FROM_BUFFER
)
8976 prev_pos
= IT_CHARPOS (*it
);
8977 /* The current display element has been consumed. Advance
8979 set_iterator_to_next (it
, true);
8980 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8981 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8982 if (IT_CHARPOS (*it
) < to_charpos
)
8983 saw_smaller_pos
= true;
8985 && (op
& MOVE_TO_POS
)
8986 && IT_CHARPOS (*it
) >= to_charpos
8987 && IT_CHARPOS (*it
) < closest_pos
)
8988 closest_pos
= IT_CHARPOS (*it
);
8990 /* Stop if lines are truncated and IT's current x-position is
8991 past the right edge of the window now. */
8992 if (it
->line_wrap
== TRUNCATE
8993 && it
->current_x
>= it
->last_visible_x
)
8995 if (!FRAME_WINDOW_P (it
->f
)
8996 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8997 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8998 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8999 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
9001 bool at_eob_p
= false;
9003 if ((at_eob_p
= !get_next_display_element (it
))
9004 || BUFFER_POS_REACHED_P ()
9005 /* If we are past TO_CHARPOS, but never saw any
9006 character positions smaller than TO_CHARPOS,
9007 return MOVE_POS_MATCH_OR_ZV, like the
9008 unidirectional display did. */
9009 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
9011 && IT_CHARPOS (*it
) > to_charpos
))
9014 && !BUFFER_POS_REACHED_P ()
9015 && !at_eob_p
&& closest_pos
< ZV
)
9017 RESTORE_IT (it
, &ppos_it
, ppos_data
);
9018 if (closest_pos
!= to_charpos
)
9019 move_it_in_display_line_to (it
, closest_pos
, -1,
9022 result
= MOVE_POS_MATCH_OR_ZV
;
9025 if (ITERATOR_AT_END_OF_LINE_P (it
))
9027 result
= MOVE_NEWLINE_OR_CR
;
9031 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
9033 && IT_CHARPOS (*it
) > to_charpos
)
9035 if (closest_pos
< ZV
)
9037 RESTORE_IT (it
, &ppos_it
, ppos_data
);
9038 if (closest_pos
!= to_charpos
)
9039 move_it_in_display_line_to (it
, closest_pos
, -1,
9042 result
= MOVE_POS_MATCH_OR_ZV
;
9045 result
= MOVE_LINE_TRUNCATED
;
9048 #undef IT_RESET_X_ASCENT_DESCENT
9051 #undef BUFFER_POS_REACHED_P
9053 /* If we scanned beyond to_pos and didn't find a point to wrap at,
9054 restore the saved iterator. */
9055 if (atpos_it
.sp
>= 0)
9056 RESTORE_IT (it
, &atpos_it
, atpos_data
);
9057 else if (atx_it
.sp
>= 0)
9058 RESTORE_IT (it
, &atx_it
, atx_data
);
9063 bidi_unshelve_cache (atpos_data
, true);
9065 bidi_unshelve_cache (atx_data
, true);
9067 bidi_unshelve_cache (wrap_data
, true);
9069 bidi_unshelve_cache (ppos_data
, true);
9071 /* Restore the iterator settings altered at the beginning of this
9073 it
->glyph_row
= saved_glyph_row
;
9077 /* For external use. */
9079 move_it_in_display_line (struct it
*it
,
9080 ptrdiff_t to_charpos
, int to_x
,
9081 enum move_operation_enum op
)
9083 if (it
->line_wrap
== WORD_WRAP
9084 && (op
& MOVE_TO_X
))
9087 void *save_data
= NULL
;
9090 SAVE_IT (save_it
, *it
, save_data
);
9091 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9092 /* When word-wrap is on, TO_X may lie past the end
9093 of a wrapped line. Then it->current is the
9094 character on the next line, so backtrack to the
9095 space before the wrap point. */
9096 if (skip
== MOVE_LINE_CONTINUED
)
9098 int prev_x
= max (it
->current_x
- 1, 0);
9099 RESTORE_IT (it
, &save_it
, save_data
);
9100 move_it_in_display_line_to
9101 (it
, -1, prev_x
, MOVE_TO_X
);
9104 bidi_unshelve_cache (save_data
, true);
9107 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9111 /* Move IT forward until it satisfies one or more of the criteria in
9112 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9114 OP is a bit-mask that specifies where to stop, and in particular,
9115 which of those four position arguments makes a difference. See the
9116 description of enum move_operation_enum.
9118 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9119 screen line, this function will set IT to the next position that is
9120 displayed to the right of TO_CHARPOS on the screen.
9122 Return the maximum pixel length of any line scanned but never more
9123 than it.last_visible_x. */
9126 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9128 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9129 int line_height
, line_start_x
= 0, reached
= 0;
9130 int max_current_x
= 0;
9131 void *backup_data
= NULL
;
9135 if (op
& MOVE_TO_VPOS
)
9137 /* If no TO_CHARPOS and no TO_X specified, stop at the
9138 start of the line TO_VPOS. */
9139 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9141 if (it
->vpos
== to_vpos
)
9147 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9151 /* TO_VPOS >= 0 means stop at TO_X in the line at
9152 TO_VPOS, or at TO_POS, whichever comes first. */
9153 if (it
->vpos
== to_vpos
)
9159 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9161 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9166 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9168 /* We have reached TO_X but not in the line we want. */
9169 skip
= move_it_in_display_line_to (it
, to_charpos
,
9171 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9179 else if (op
& MOVE_TO_Y
)
9181 struct it it_backup
;
9183 if (it
->line_wrap
== WORD_WRAP
)
9184 SAVE_IT (it_backup
, *it
, backup_data
);
9186 /* TO_Y specified means stop at TO_X in the line containing
9187 TO_Y---or at TO_CHARPOS if this is reached first. The
9188 problem is that we can't really tell whether the line
9189 contains TO_Y before we have completely scanned it, and
9190 this may skip past TO_X. What we do is to first scan to
9193 If TO_X is not specified, use a TO_X of zero. The reason
9194 is to make the outcome of this function more predictable.
9195 If we didn't use TO_X == 0, we would stop at the end of
9196 the line which is probably not what a caller would expect
9198 skip
= move_it_in_display_line_to
9199 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9200 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9202 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9203 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9205 else if (skip
== MOVE_X_REACHED
)
9207 /* If TO_X was reached, we want to know whether TO_Y is
9208 in the line. We know this is the case if the already
9209 scanned glyphs make the line tall enough. Otherwise,
9210 we must check by scanning the rest of the line. */
9211 line_height
= it
->max_ascent
+ it
->max_descent
;
9212 if (to_y
>= it
->current_y
9213 && to_y
< it
->current_y
+ line_height
)
9218 SAVE_IT (it_backup
, *it
, backup_data
);
9219 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9220 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9222 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9223 line_height
= it
->max_ascent
+ it
->max_descent
;
9224 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9226 if (to_y
>= it
->current_y
9227 && to_y
< it
->current_y
+ line_height
)
9229 /* If TO_Y is in this line and TO_X was reached
9230 above, we scanned too far. We have to restore
9231 IT's settings to the ones before skipping. But
9232 keep the more accurate values of max_ascent and
9233 max_descent we've found while skipping the rest
9234 of the line, for the sake of callers, such as
9235 pos_visible_p, that need to know the line
9237 int max_ascent
= it
->max_ascent
;
9238 int max_descent
= it
->max_descent
;
9240 RESTORE_IT (it
, &it_backup
, backup_data
);
9241 it
->max_ascent
= max_ascent
;
9242 it
->max_descent
= max_descent
;
9248 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9254 /* Check whether TO_Y is in this line. */
9255 line_height
= it
->max_ascent
+ it
->max_descent
;
9256 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9258 if (to_y
>= it
->current_y
9259 && to_y
< it
->current_y
+ line_height
)
9261 if (to_y
> it
->current_y
)
9262 max_current_x
= max (it
->current_x
, max_current_x
);
9264 /* When word-wrap is on, TO_X may lie past the end
9265 of a wrapped line. Then it->current is the
9266 character on the next line, so backtrack to the
9267 space before the wrap point. */
9268 if (skip
== MOVE_LINE_CONTINUED
9269 && it
->line_wrap
== WORD_WRAP
)
9271 int prev_x
= max (it
->current_x
- 1, 0);
9272 RESTORE_IT (it
, &it_backup
, backup_data
);
9273 skip
= move_it_in_display_line_to
9274 (it
, -1, prev_x
, MOVE_TO_X
);
9283 max_current_x
= max (it
->current_x
, max_current_x
);
9287 else if (BUFFERP (it
->object
)
9288 && (it
->method
== GET_FROM_BUFFER
9289 || it
->method
== GET_FROM_STRETCH
)
9290 && IT_CHARPOS (*it
) >= to_charpos
9291 /* Under bidi iteration, a call to set_iterator_to_next
9292 can scan far beyond to_charpos if the initial
9293 portion of the next line needs to be reordered. In
9294 that case, give move_it_in_display_line_to another
9297 && it
->bidi_it
.scan_dir
== -1))
9298 skip
= MOVE_POS_MATCH_OR_ZV
;
9300 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9304 case MOVE_POS_MATCH_OR_ZV
:
9305 max_current_x
= max (it
->current_x
, max_current_x
);
9309 case MOVE_NEWLINE_OR_CR
:
9310 max_current_x
= max (it
->current_x
, max_current_x
);
9311 set_iterator_to_next (it
, true);
9312 it
->continuation_lines_width
= 0;
9315 case MOVE_LINE_TRUNCATED
:
9316 max_current_x
= it
->last_visible_x
;
9317 it
->continuation_lines_width
= 0;
9318 reseat_at_next_visible_line_start (it
, false);
9319 if ((op
& MOVE_TO_POS
) != 0
9320 && IT_CHARPOS (*it
) > to_charpos
)
9327 case MOVE_LINE_CONTINUED
:
9328 max_current_x
= it
->last_visible_x
;
9329 /* For continued lines ending in a tab, some of the glyphs
9330 associated with the tab are displayed on the current
9331 line. Since it->current_x does not include these glyphs,
9332 we use it->last_visible_x instead. */
9335 it
->continuation_lines_width
+= it
->last_visible_x
;
9336 /* When moving by vpos, ensure that the iterator really
9337 advances to the next line (bug#847, bug#969). Fixme:
9338 do we need to do this in other circumstances? */
9339 if (it
->current_x
!= it
->last_visible_x
9340 && (op
& MOVE_TO_VPOS
)
9341 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9343 line_start_x
= it
->current_x
+ it
->pixel_width
9344 - it
->last_visible_x
;
9345 if (FRAME_WINDOW_P (it
->f
))
9347 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9348 struct font
*face_font
= face
->font
;
9350 /* When display_line produces a continued line
9351 that ends in a TAB, it skips a tab stop that
9352 is closer than the font's space character
9353 width (see x_produce_glyphs where it produces
9354 the stretch glyph which represents a TAB).
9355 We need to reproduce the same logic here. */
9356 eassert (face_font
);
9359 if (line_start_x
< face_font
->space_width
)
9361 += it
->tab_width
* face_font
->space_width
;
9364 set_iterator_to_next (it
, false);
9368 it
->continuation_lines_width
+= it
->current_x
;
9375 /* Reset/increment for the next run. */
9376 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9377 it
->current_x
= line_start_x
;
9380 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9382 last_height
= it
->max_ascent
+ it
->max_descent
;
9383 it
->max_ascent
= it
->max_descent
= 0;
9388 /* On text terminals, we may stop at the end of a line in the middle
9389 of a multi-character glyph. If the glyph itself is continued,
9390 i.e. it is actually displayed on the next line, don't treat this
9391 stopping point as valid; move to the next line instead (unless
9392 that brings us offscreen). */
9393 if (!FRAME_WINDOW_P (it
->f
)
9395 && IT_CHARPOS (*it
) == to_charpos
9396 && it
->what
== IT_CHARACTER
9398 && it
->line_wrap
== WINDOW_WRAP
9399 && it
->current_x
== it
->last_visible_x
- 1
9402 && it
->w
->window_end_valid
9403 && it
->vpos
< it
->w
->window_end_vpos
)
9405 it
->continuation_lines_width
+= it
->current_x
;
9406 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9407 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9409 last_height
= it
->max_ascent
+ it
->max_descent
;
9413 bidi_unshelve_cache (backup_data
, true);
9415 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9417 return max_current_x
;
9421 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9423 If DY > 0, move IT backward at least that many pixels. DY = 0
9424 means move IT backward to the preceding line start or BEGV. This
9425 function may move over more than DY pixels if IT->current_y - DY
9426 ends up in the middle of a line; in this case IT->current_y will be
9427 set to the top of the line moved to. */
9430 move_it_vertically_backward (struct it
*it
, int dy
)
9434 void *it2data
= NULL
, *it3data
= NULL
;
9435 ptrdiff_t start_pos
;
9437 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9438 ptrdiff_t pos_limit
;
9443 start_pos
= IT_CHARPOS (*it
);
9445 /* Estimate how many newlines we must move back. */
9446 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9447 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9450 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9452 /* Set the iterator's position that many lines back. But don't go
9453 back more than NLINES full screen lines -- this wins a day with
9454 buffers which have very long lines. */
9455 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9456 back_to_previous_visible_line_start (it
);
9458 /* Reseat the iterator here. When moving backward, we don't want
9459 reseat to skip forward over invisible text, set up the iterator
9460 to deliver from overlay strings at the new position etc. So,
9461 use reseat_1 here. */
9462 reseat_1 (it
, it
->current
.pos
, true);
9464 /* We are now surely at a line start. */
9465 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9466 reordering is in effect. */
9467 it
->continuation_lines_width
= 0;
9469 /* Move forward and see what y-distance we moved. First move to the
9470 start of the next line so that we get its height. We need this
9471 height to be able to tell whether we reached the specified
9473 SAVE_IT (it2
, *it
, it2data
);
9474 it2
.max_ascent
= it2
.max_descent
= 0;
9477 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9478 MOVE_TO_POS
| MOVE_TO_VPOS
);
9480 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9481 /* If we are in a display string which starts at START_POS,
9482 and that display string includes a newline, and we are
9483 right after that newline (i.e. at the beginning of a
9484 display line), exit the loop, because otherwise we will
9485 infloop, since move_it_to will see that it is already at
9486 START_POS and will not move. */
9487 || (it2
.method
== GET_FROM_STRING
9488 && IT_CHARPOS (it2
) == start_pos
9489 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9490 eassert (IT_CHARPOS (*it
) >= BEGV
);
9491 SAVE_IT (it3
, it2
, it3data
);
9493 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9494 eassert (IT_CHARPOS (*it
) >= BEGV
);
9495 /* H is the actual vertical distance from the position in *IT
9496 and the starting position. */
9497 h
= it2
.current_y
- it
->current_y
;
9498 /* NLINES is the distance in number of lines. */
9499 nlines
= it2
.vpos
- it
->vpos
;
9501 /* Correct IT's y and vpos position
9502 so that they are relative to the starting point. */
9508 /* DY == 0 means move to the start of the screen line. The
9509 value of nlines is > 0 if continuation lines were involved,
9510 or if the original IT position was at start of a line. */
9511 RESTORE_IT (it
, it
, it2data
);
9513 move_it_by_lines (it
, nlines
);
9514 /* The above code moves us to some position NLINES down,
9515 usually to its first glyph (leftmost in an L2R line), but
9516 that's not necessarily the start of the line, under bidi
9517 reordering. We want to get to the character position
9518 that is immediately after the newline of the previous
9521 && !it
->continuation_lines_width
9522 && !STRINGP (it
->string
)
9523 && IT_CHARPOS (*it
) > BEGV
9524 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9526 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9529 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9530 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9532 bidi_unshelve_cache (it3data
, true);
9536 /* The y-position we try to reach, relative to *IT.
9537 Note that H has been subtracted in front of the if-statement. */
9538 int target_y
= it
->current_y
+ h
- dy
;
9539 int y0
= it3
.current_y
;
9543 RESTORE_IT (&it3
, &it3
, it3data
);
9544 y1
= line_bottom_y (&it3
);
9545 line_height
= y1
- y0
;
9546 RESTORE_IT (it
, it
, it2data
);
9547 /* If we did not reach target_y, try to move further backward if
9548 we can. If we moved too far backward, try to move forward. */
9549 if (target_y
< it
->current_y
9550 /* This is heuristic. In a window that's 3 lines high, with
9551 a line height of 13 pixels each, recentering with point
9552 on the bottom line will try to move -39/2 = 19 pixels
9553 backward. Try to avoid moving into the first line. */
9554 && (it
->current_y
- target_y
9555 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9556 && IT_CHARPOS (*it
) > BEGV
)
9558 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9559 target_y
- it
->current_y
));
9560 dy
= it
->current_y
- target_y
;
9561 goto move_further_back
;
9563 else if (target_y
>= it
->current_y
+ line_height
9564 && IT_CHARPOS (*it
) < ZV
)
9566 /* Should move forward by at least one line, maybe more.
9568 Note: Calling move_it_by_lines can be expensive on
9569 terminal frames, where compute_motion is used (via
9570 vmotion) to do the job, when there are very long lines
9571 and truncate-lines is nil. That's the reason for
9572 treating terminal frames specially here. */
9574 if (!FRAME_WINDOW_P (it
->f
))
9575 move_it_vertically (it
, target_y
- it
->current_y
);
9580 move_it_by_lines (it
, 1);
9582 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9589 /* Move IT by a specified amount of pixel lines DY. DY negative means
9590 move backwards. DY = 0 means move to start of screen line. At the
9591 end, IT will be on the start of a screen line. */
9594 move_it_vertically (struct it
*it
, int dy
)
9597 move_it_vertically_backward (it
, -dy
);
9600 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9601 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9602 MOVE_TO_POS
| MOVE_TO_Y
);
9603 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9605 /* If buffer ends in ZV without a newline, move to the start of
9606 the line to satisfy the post-condition. */
9607 if (IT_CHARPOS (*it
) == ZV
9609 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9610 move_it_by_lines (it
, 0);
9615 /* Move iterator IT past the end of the text line it is in. */
9618 move_it_past_eol (struct it
*it
)
9620 enum move_it_result rc
;
9622 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9623 if (rc
== MOVE_NEWLINE_OR_CR
)
9624 set_iterator_to_next (it
, false);
9628 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9629 negative means move up. DVPOS == 0 means move to the start of the
9632 Optimization idea: If we would know that IT->f doesn't use
9633 a face with proportional font, we could be faster for
9634 truncate-lines nil. */
9637 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9640 /* The commented-out optimization uses vmotion on terminals. This
9641 gives bad results, because elements like it->what, on which
9642 callers such as pos_visible_p rely, aren't updated. */
9643 /* struct position pos;
9644 if (!FRAME_WINDOW_P (it->f))
9646 struct text_pos textpos;
9648 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9649 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9650 reseat (it, textpos, true);
9651 it->vpos += pos.vpos;
9652 it->current_y += pos.vpos;
9658 /* DVPOS == 0 means move to the start of the screen line. */
9659 move_it_vertically_backward (it
, 0);
9660 /* Let next call to line_bottom_y calculate real line height. */
9665 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9666 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9668 /* Only move to the next buffer position if we ended up in a
9669 string from display property, not in an overlay string
9670 (before-string or after-string). That is because the
9671 latter don't conceal the underlying buffer position, so
9672 we can ask to move the iterator to the exact position we
9673 are interested in. Note that, even if we are already at
9674 IT_CHARPOS (*it), the call below is not a no-op, as it
9675 will detect that we are at the end of the string, pop the
9676 iterator, and compute it->current_x and it->hpos
9678 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9679 -1, -1, -1, MOVE_TO_POS
);
9685 void *it2data
= NULL
;
9686 ptrdiff_t start_charpos
, i
;
9688 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9689 bool hit_pos_limit
= false;
9690 ptrdiff_t pos_limit
;
9692 /* Start at the beginning of the screen line containing IT's
9693 position. This may actually move vertically backwards,
9694 in case of overlays, so adjust dvpos accordingly. */
9696 move_it_vertically_backward (it
, 0);
9699 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9700 screen lines, and reseat the iterator there. */
9701 start_charpos
= IT_CHARPOS (*it
);
9702 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9705 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9707 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9708 back_to_previous_visible_line_start (it
);
9709 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9710 hit_pos_limit
= true;
9711 reseat (it
, it
->current
.pos
, true);
9713 /* Move further back if we end up in a string or an image. */
9714 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9716 /* First try to move to start of display line. */
9718 move_it_vertically_backward (it
, 0);
9720 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9722 /* If start of line is still in string or image,
9723 move further back. */
9724 back_to_previous_visible_line_start (it
);
9725 reseat (it
, it
->current
.pos
, true);
9729 it
->current_x
= it
->hpos
= 0;
9731 /* Above call may have moved too far if continuation lines
9732 are involved. Scan forward and see if it did. */
9733 SAVE_IT (it2
, *it
, it2data
);
9734 it2
.vpos
= it2
.current_y
= 0;
9735 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9736 it
->vpos
-= it2
.vpos
;
9737 it
->current_y
-= it2
.current_y
;
9738 it
->current_x
= it
->hpos
= 0;
9740 /* If we moved too far back, move IT some lines forward. */
9741 if (it2
.vpos
> -dvpos
)
9743 int delta
= it2
.vpos
+ dvpos
;
9745 RESTORE_IT (&it2
, &it2
, it2data
);
9746 SAVE_IT (it2
, *it
, it2data
);
9747 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9748 /* Move back again if we got too far ahead. */
9749 if (IT_CHARPOS (*it
) >= start_charpos
)
9750 RESTORE_IT (it
, &it2
, it2data
);
9752 bidi_unshelve_cache (it2data
, true);
9754 else if (hit_pos_limit
&& pos_limit
> BEGV
9755 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9757 /* If we hit the limit, but still didn't make it far enough
9758 back, that means there's a display string with a newline
9759 covering a large chunk of text, and that caused
9760 back_to_previous_visible_line_start try to go too far.
9761 Punish those who commit such atrocities by going back
9762 until we've reached DVPOS, after lifting the limit, which
9763 could make it slow for very long lines. "If it hurts,
9766 RESTORE_IT (it
, it
, it2data
);
9767 for (i
= -dvpos
; i
> 0; --i
)
9769 back_to_previous_visible_line_start (it
);
9772 reseat_1 (it
, it
->current
.pos
, true);
9775 RESTORE_IT (it
, it
, it2data
);
9779 /* Return true if IT points into the middle of a display vector. */
9782 in_display_vector_p (struct it
*it
)
9784 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9785 && it
->current
.dpvec_index
> 0
9786 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9789 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9790 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9791 WINDOW must be a live window and defaults to the selected one. The
9792 return value is a cons of the maximum pixel-width of any text line and
9793 the maximum pixel-height of all text lines.
9795 The optional argument FROM, if non-nil, specifies the first text
9796 position and defaults to the minimum accessible position of the buffer.
9797 If FROM is t, use the minimum accessible position that starts a
9798 non-empty line. TO, if non-nil, specifies the last text position and
9799 defaults to the maximum accessible position of the buffer. If TO is t,
9800 use the maximum accessible position that ends a non-empty line.
9802 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9803 width that can be returned. X-LIMIT nil or omitted, means to use the
9804 pixel-width of WINDOW's body; use this if you want to know how high
9805 WINDOW should be become in order to fit all of its buffer's text with
9806 the width of WINDOW unaltered. Use the maximum width WINDOW may assume
9807 if you intend to change WINDOW's width. In any case, text whose
9808 x-coordinate is beyond X-LIMIT is ignored. Since calculating the width
9809 of long lines can take some time, it's always a good idea to make this
9810 argument as small as possible; in particular, if the buffer contains
9811 long lines that shall be truncated anyway.
9813 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9814 height (exluding the height of the mode- or header-line, if any) that
9815 can be returned. Text lines whose y-coordinate is beyond Y-LIMIT are
9816 ignored. Since calculating the text height of a large buffer can take
9817 some time, it makes sense to specify this argument if the size of the
9818 buffer is large or unknown.
9820 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9821 include the height of the mode- or header-line of WINDOW in the return
9822 value. If it is either the symbol `mode-line' or `header-line', include
9823 only the height of that line, if present, in the return value. If t,
9824 include the height of both, if present, in the return value. */)
9825 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
,
9826 Lisp_Object y_limit
, Lisp_Object mode_and_header_line
)
9828 struct window
*w
= decode_live_window (window
);
9829 Lisp_Object buffer
= w
->contents
;
9832 struct buffer
*old_b
= NULL
;
9833 ptrdiff_t start
, end
, pos
;
9834 struct text_pos startp
;
9835 void *itdata
= NULL
;
9836 int c
, max_x
= 0, max_y
= 0, x
= 0, y
= 0;
9838 CHECK_BUFFER (buffer
);
9839 b
= XBUFFER (buffer
);
9841 if (b
!= current_buffer
)
9843 old_b
= current_buffer
;
9844 set_buffer_internal (b
);
9849 else if (EQ (from
, Qt
))
9852 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9853 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9855 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9860 CHECK_NUMBER_COERCE_MARKER (from
);
9861 start
= min (max (XINT (from
), BEGV
), ZV
);
9866 else if (EQ (to
, Qt
))
9869 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9870 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9872 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9877 CHECK_NUMBER_COERCE_MARKER (to
);
9878 end
= max (start
, min (XINT (to
), ZV
));
9881 if (!NILP (x_limit
) && RANGED_INTEGERP (0, x_limit
, INT_MAX
))
9882 max_x
= XINT (x_limit
);
9886 else if (RANGED_INTEGERP (0, y_limit
, INT_MAX
))
9887 max_y
= XINT (y_limit
);
9889 itdata
= bidi_shelve_cache ();
9890 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9891 start_display (&it
, w
, startp
);
9894 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9897 it
.last_visible_x
= max_x
;
9898 /* Actually, we never want move_it_to stop at to_x. But to make
9899 sure that move_it_in_display_line_to always moves far enough,
9900 we set it to INT_MAX and specify MOVE_TO_X. Also bound width
9901 value by X-LIMIT. */
9902 x
= min (move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9903 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
),
9907 /* Subtract height of header-line which was counted automatically by
9909 y
= min (it
.current_y
+ it
.max_ascent
+ it
.max_descent
9910 - WINDOW_HEADER_LINE_HEIGHT (w
),
9913 if (EQ (mode_and_header_line
, Qheader_line
)
9914 || EQ (mode_and_header_line
, Qt
))
9915 /* Re-add height of header-line as requested. */
9916 y
= y
+ WINDOW_HEADER_LINE_HEIGHT (w
);
9918 if (EQ (mode_and_header_line
, Qmode_line
)
9919 || EQ (mode_and_header_line
, Qt
))
9920 /* Add height of mode-line as requested. */
9921 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9923 bidi_unshelve_cache (itdata
, false);
9926 set_buffer_internal (old_b
);
9928 return Fcons (make_number (x
), make_number (y
));
9931 /***********************************************************************
9933 ***********************************************************************/
9935 /* Return the number of arguments the format string FORMAT needs. */
9938 format_nargs (char const *format
)
9940 ptrdiff_t nargs
= 0;
9941 for (char const *p
= format
; (p
= strchr (p
, '%')); p
++)
9949 /* Add a message with format string FORMAT and formatted arguments
9953 add_to_log (const char *format
, ...)
9956 va_start (ap
, format
);
9957 vadd_to_log (format
, ap
);
9962 vadd_to_log (char const *format
, va_list ap
)
9964 ptrdiff_t form_nargs
= format_nargs (format
);
9965 ptrdiff_t nargs
= 1 + form_nargs
;
9966 Lisp_Object args
[10];
9967 eassert (nargs
<= ARRAYELTS (args
));
9968 AUTO_STRING (args0
, format
);
9970 for (ptrdiff_t i
= 1; i
<= nargs
; i
++)
9971 args
[i
] = va_arg (ap
, Lisp_Object
);
9972 Lisp_Object msg
= Qnil
;
9973 msg
= Fformat_message (nargs
, args
);
9975 ptrdiff_t len
= SBYTES (msg
) + 1;
9977 char *buffer
= SAFE_ALLOCA (len
);
9978 memcpy (buffer
, SDATA (msg
), len
);
9980 message_dolog (buffer
, len
- 1, true, STRING_MULTIBYTE (msg
));
9985 /* Output a newline in the *Messages* buffer if "needs" one. */
9988 message_log_maybe_newline (void)
9990 if (message_log_need_newline
)
9991 message_dolog ("", 0, true, false);
9995 /* Add a string M of length NBYTES to the message log, optionally
9996 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9997 true, means interpret the contents of M as multibyte. This
9998 function calls low-level routines in order to bypass text property
9999 hooks, etc. which might not be safe to run.
10001 This may GC (insert may run before/after change hooks),
10002 so the buffer M must NOT point to a Lisp string. */
10005 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
10007 const unsigned char *msg
= (const unsigned char *) m
;
10009 if (!NILP (Vmemory_full
))
10012 if (!NILP (Vmessage_log_max
))
10014 struct buffer
*oldbuf
;
10015 Lisp_Object oldpoint
, oldbegv
, oldzv
;
10016 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
10017 ptrdiff_t point_at_end
= 0;
10018 ptrdiff_t zv_at_end
= 0;
10019 Lisp_Object old_deactivate_mark
;
10021 old_deactivate_mark
= Vdeactivate_mark
;
10022 oldbuf
= current_buffer
;
10024 /* Ensure the Messages buffer exists, and switch to it.
10025 If we created it, set the major-mode. */
10026 bool newbuffer
= NILP (Fget_buffer (Vmessages_buffer_name
));
10027 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
10029 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
10030 call0 (intern ("messages-buffer-mode"));
10032 bset_undo_list (current_buffer
, Qt
);
10033 bset_cache_long_scans (current_buffer
, Qnil
);
10035 oldpoint
= message_dolog_marker1
;
10036 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
10037 oldbegv
= message_dolog_marker2
;
10038 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
10039 oldzv
= message_dolog_marker3
;
10040 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
10048 BEGV_BYTE
= BEG_BYTE
;
10051 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10053 /* Insert the string--maybe converting multibyte to single byte
10054 or vice versa, so that all the text fits the buffer. */
10056 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10062 /* Convert a multibyte string to single-byte
10063 for the *Message* buffer. */
10064 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
10066 c
= string_char_and_length (msg
+ i
, &char_bytes
);
10067 work
[0] = CHAR_TO_BYTE8 (c
);
10068 insert_1_both (work
, 1, 1, true, false, false);
10071 else if (! multibyte
10072 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10076 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10077 /* Convert a single-byte string to multibyte
10078 for the *Message* buffer. */
10079 for (i
= 0; i
< nbytes
; i
++)
10082 MAKE_CHAR_MULTIBYTE (c
);
10083 char_bytes
= CHAR_STRING (c
, str
);
10084 insert_1_both ((char *) str
, 1, char_bytes
, true, false, false);
10088 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
,
10089 true, false, false);
10093 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
10096 insert_1_both ("\n", 1, 1, true, false, false);
10098 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, false);
10100 this_bol_byte
= PT_BYTE
;
10102 /* See if this line duplicates the previous one.
10103 If so, combine duplicates. */
10104 if (this_bol
> BEG
)
10106 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, false);
10108 prev_bol_byte
= PT_BYTE
;
10110 dups
= message_log_check_duplicate (prev_bol_byte
,
10114 del_range_both (prev_bol
, prev_bol_byte
,
10115 this_bol
, this_bol_byte
, false);
10118 char dupstr
[sizeof " [ times]"
10119 + INT_STRLEN_BOUND (printmax_t
)];
10121 /* If you change this format, don't forget to also
10122 change message_log_check_duplicate. */
10123 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
10124 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
10125 insert_1_both (dupstr
, duplen
, duplen
,
10126 true, false, true);
10131 /* If we have more than the desired maximum number of lines
10132 in the *Messages* buffer now, delete the oldest ones.
10133 This is safe because we don't have undo in this buffer. */
10135 if (NATNUMP (Vmessage_log_max
))
10137 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10138 -XFASTINT (Vmessage_log_max
) - 1, false);
10139 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, false);
10142 BEGV
= marker_position (oldbegv
);
10143 BEGV_BYTE
= marker_byte_position (oldbegv
);
10152 ZV
= marker_position (oldzv
);
10153 ZV_BYTE
= marker_byte_position (oldzv
);
10157 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10159 /* We can't do Fgoto_char (oldpoint) because it will run some
10161 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10162 marker_byte_position (oldpoint
));
10164 unchain_marker (XMARKER (oldpoint
));
10165 unchain_marker (XMARKER (oldbegv
));
10166 unchain_marker (XMARKER (oldzv
));
10168 /* We called insert_1_both above with its 5th argument (PREPARE)
10169 false, which prevents insert_1_both from calling
10170 prepare_to_modify_buffer, which in turns prevents us from
10171 incrementing windows_or_buffers_changed even if *Messages* is
10172 shown in some window. So we must manually set
10173 windows_or_buffers_changed here to make up for that. */
10174 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10175 bset_redisplay (current_buffer
);
10177 set_buffer_internal (oldbuf
);
10179 message_log_need_newline
= !nlflag
;
10180 Vdeactivate_mark
= old_deactivate_mark
;
10185 /* We are at the end of the buffer after just having inserted a newline.
10186 (Note: We depend on the fact we won't be crossing the gap.)
10187 Check to see if the most recent message looks a lot like the previous one.
10188 Return 0 if different, 1 if the new one should just replace it, or a
10189 value N > 1 if we should also append " [N times]". */
10192 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10195 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10196 bool seen_dots
= false;
10197 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10198 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10200 for (i
= 0; i
< len
; i
++)
10202 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10204 if (p1
[i
] != p2
[i
])
10210 if (*p1
++ == ' ' && *p1
++ == '[')
10213 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10214 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10221 /* Display an echo area message M with a specified length of NBYTES
10222 bytes. The string may include null characters. If M is not a
10223 string, clear out any existing message, and let the mini-buffer
10226 This function cancels echoing. */
10229 message3 (Lisp_Object m
)
10231 clear_message (true, true);
10234 /* First flush out any partial line written with print. */
10235 message_log_maybe_newline ();
10238 ptrdiff_t nbytes
= SBYTES (m
);
10239 bool multibyte
= STRING_MULTIBYTE (m
);
10242 SAFE_ALLOCA_STRING (buffer
, m
);
10243 message_dolog (buffer
, nbytes
, true, multibyte
);
10246 if (! inhibit_message
)
10247 message3_nolog (m
);
10250 /* Log the message M to stderr. Log an empty line if M is not a string. */
10253 message_to_stderr (Lisp_Object m
)
10255 if (noninteractive_need_newline
)
10257 noninteractive_need_newline
= false;
10258 fputc ('\n', stderr
);
10262 Lisp_Object coding_system
= Vlocale_coding_system
;
10265 if (!NILP (Vcoding_system_for_write
))
10266 coding_system
= Vcoding_system_for_write
;
10267 if (!NILP (coding_system
))
10268 s
= code_convert_string_norecord (m
, coding_system
, true);
10272 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10274 if (!cursor_in_echo_area
)
10275 fputc ('\n', stderr
);
10279 /* The non-logging version of message3.
10280 This does not cancel echoing, because it is used for echoing.
10281 Perhaps we need to make a separate function for echoing
10282 and make this cancel echoing. */
10285 message3_nolog (Lisp_Object m
)
10287 struct frame
*sf
= SELECTED_FRAME ();
10289 if (FRAME_INITIAL_P (sf
))
10290 message_to_stderr (m
);
10291 /* Error messages get reported properly by cmd_error, so this must be just an
10292 informative message; if the frame hasn't really been initialized yet, just
10294 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10296 /* Get the frame containing the mini-buffer
10297 that the selected frame is using. */
10298 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10299 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10300 struct frame
*f
= XFRAME (frame
);
10302 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10303 Fmake_frame_visible (frame
);
10305 if (STRINGP (m
) && SCHARS (m
) > 0)
10308 if (minibuffer_auto_raise
)
10309 Fraise_frame (frame
);
10310 /* Assume we are not echoing.
10311 (If we are, echo_now will override this.) */
10312 echo_message_buffer
= Qnil
;
10315 clear_message (true, true);
10317 do_pending_window_change (false);
10318 echo_area_display (true);
10319 do_pending_window_change (false);
10320 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10321 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10326 /* Display a null-terminated echo area message M. If M is 0, clear
10327 out any existing message, and let the mini-buffer text show through.
10329 The buffer M must continue to exist until after the echo area gets
10330 cleared or some other message gets displayed there. Do not pass
10331 text that is stored in a Lisp string. Do not pass text in a buffer
10332 that was alloca'd. */
10335 message1 (const char *m
)
10337 message3 (m
? build_unibyte_string (m
) : Qnil
);
10341 /* The non-logging counterpart of message1. */
10344 message1_nolog (const char *m
)
10346 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10349 /* Display a message M which contains a single %s
10350 which gets replaced with STRING. */
10353 message_with_string (const char *m
, Lisp_Object string
, bool log
)
10355 CHECK_STRING (string
);
10358 if (noninteractive
)
10359 need_message
= !!m
;
10360 else if (!INTERACTIVE
)
10361 need_message
= false;
10364 /* The frame whose minibuffer we're going to display the message on.
10365 It may be larger than the selected frame, so we need
10366 to use its buffer, not the selected frame's buffer. */
10367 Lisp_Object mini_window
;
10368 struct frame
*f
, *sf
= SELECTED_FRAME ();
10370 /* Get the frame containing the minibuffer
10371 that the selected frame is using. */
10372 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10373 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10375 /* Error messages get reported properly by cmd_error, so this must be
10376 just an informative message; if the frame hasn't really been
10377 initialized yet, just toss it. */
10378 need_message
= f
->glyphs_initialized_p
;
10383 AUTO_STRING (fmt
, m
);
10384 Lisp_Object msg
= CALLN (Fformat_message
, fmt
, string
);
10386 if (noninteractive
)
10387 message_to_stderr (msg
);
10393 message3_nolog (msg
);
10395 /* Print should start at the beginning of the message
10396 buffer next time. */
10397 message_buf_print
= false;
10403 /* Dump an informative message to the minibuf. If M is 0, clear out
10404 any existing message, and let the mini-buffer text show through.
10406 The message must be safe ASCII and the format must not contain ` or
10407 '. If your message and format do not fit into this category,
10408 convert your arguments to Lisp objects and use Fmessage instead. */
10410 static void ATTRIBUTE_FORMAT_PRINTF (1, 0)
10411 vmessage (const char *m
, va_list ap
)
10413 if (noninteractive
)
10417 if (noninteractive_need_newline
)
10418 putc ('\n', stderr
);
10419 noninteractive_need_newline
= false;
10420 vfprintf (stderr
, m
, ap
);
10421 if (!cursor_in_echo_area
)
10422 fprintf (stderr
, "\n");
10426 else if (INTERACTIVE
)
10428 /* The frame whose mini-buffer we're going to display the message
10429 on. It may be larger than the selected frame, so we need to
10430 use its buffer, not the selected frame's buffer. */
10431 Lisp_Object mini_window
;
10432 struct frame
*f
, *sf
= SELECTED_FRAME ();
10434 /* Get the frame containing the mini-buffer
10435 that the selected frame is using. */
10436 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10437 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10439 /* Error messages get reported properly by cmd_error, so this must be
10440 just an informative message; if the frame hasn't really been
10441 initialized yet, just toss it. */
10442 if (f
->glyphs_initialized_p
)
10447 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10449 char *message_buf
= SAFE_ALLOCA (maxsize
+ 1);
10451 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10453 message3 (make_string (message_buf
, len
));
10459 /* Print should start at the beginning of the message
10460 buffer next time. */
10461 message_buf_print
= false;
10467 message (const char *m
, ...)
10476 /* Display the current message in the current mini-buffer. This is
10477 only called from error handlers in process.c, and is not time
10481 update_echo_area (void)
10483 if (!NILP (echo_area_buffer
[0]))
10485 Lisp_Object string
;
10486 string
= Fcurrent_message ();
10492 /* Make sure echo area buffers in `echo_buffers' are live.
10493 If they aren't, make new ones. */
10496 ensure_echo_area_buffers (void)
10500 for (i
= 0; i
< 2; ++i
)
10501 if (!BUFFERP (echo_buffer
[i
])
10502 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10505 Lisp_Object old_buffer
;
10508 old_buffer
= echo_buffer
[i
];
10509 echo_buffer
[i
] = Fget_buffer_create
10510 (make_formatted_string (name
, " *Echo Area %d*", i
));
10511 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10512 /* to force word wrap in echo area -
10513 it was decided to postpone this*/
10514 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10516 for (j
= 0; j
< 2; ++j
)
10517 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10518 echo_area_buffer
[j
] = echo_buffer
[i
];
10523 /* Call FN with args A1..A2 with either the current or last displayed
10524 echo_area_buffer as current buffer.
10526 WHICH zero means use the current message buffer
10527 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10528 from echo_buffer[] and clear it.
10530 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10531 suitable buffer from echo_buffer[] and clear it.
10533 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10534 that the current message becomes the last displayed one, make
10535 choose a suitable buffer for echo_area_buffer[0], and clear it.
10537 Value is what FN returns. */
10540 with_echo_area_buffer (struct window
*w
, int which
,
10541 bool (*fn
) (ptrdiff_t, Lisp_Object
),
10542 ptrdiff_t a1
, Lisp_Object a2
)
10544 Lisp_Object buffer
;
10545 bool this_one
, the_other
, clear_buffer_p
, rc
;
10546 ptrdiff_t count
= SPECPDL_INDEX ();
10548 /* If buffers aren't live, make new ones. */
10549 ensure_echo_area_buffers ();
10551 clear_buffer_p
= false;
10554 this_one
= false, the_other
= true;
10555 else if (which
> 0)
10556 this_one
= true, the_other
= false;
10559 this_one
= false, the_other
= true;
10560 clear_buffer_p
= true;
10562 /* We need a fresh one in case the current echo buffer equals
10563 the one containing the last displayed echo area message. */
10564 if (!NILP (echo_area_buffer
[this_one
])
10565 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10566 echo_area_buffer
[this_one
] = Qnil
;
10569 /* Choose a suitable buffer from echo_buffer[] is we don't
10571 if (NILP (echo_area_buffer
[this_one
]))
10573 echo_area_buffer
[this_one
]
10574 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10575 ? echo_buffer
[the_other
]
10576 : echo_buffer
[this_one
]);
10577 clear_buffer_p
= true;
10580 buffer
= echo_area_buffer
[this_one
];
10582 /* Don't get confused by reusing the buffer used for echoing
10583 for a different purpose. */
10584 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10587 record_unwind_protect (unwind_with_echo_area_buffer
,
10588 with_echo_area_buffer_unwind_data (w
));
10590 /* Make the echo area buffer current. Note that for display
10591 purposes, it is not necessary that the displayed window's buffer
10592 == current_buffer, except for text property lookup. So, let's
10593 only set that buffer temporarily here without doing a full
10594 Fset_window_buffer. We must also change w->pointm, though,
10595 because otherwise an assertions in unshow_buffer fails, and Emacs
10597 set_buffer_internal_1 (XBUFFER (buffer
));
10600 wset_buffer (w
, buffer
);
10601 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10602 set_marker_both (w
->old_pointm
, buffer
, BEG
, BEG_BYTE
);
10605 bset_undo_list (current_buffer
, Qt
);
10606 bset_read_only (current_buffer
, Qnil
);
10607 specbind (Qinhibit_read_only
, Qt
);
10608 specbind (Qinhibit_modification_hooks
, Qt
);
10610 if (clear_buffer_p
&& Z
> BEG
)
10611 del_range (BEG
, Z
);
10613 eassert (BEGV
>= BEG
);
10614 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10618 eassert (BEGV
>= BEG
);
10619 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10621 unbind_to (count
, Qnil
);
10626 /* Save state that should be preserved around the call to the function
10627 FN called in with_echo_area_buffer. */
10630 with_echo_area_buffer_unwind_data (struct window
*w
)
10633 Lisp_Object vector
, tmp
;
10635 /* Reduce consing by keeping one vector in
10636 Vwith_echo_area_save_vector. */
10637 vector
= Vwith_echo_area_save_vector
;
10638 Vwith_echo_area_save_vector
= Qnil
;
10641 vector
= Fmake_vector (make_number (11), Qnil
);
10643 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10644 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10645 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10649 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10650 ASET (vector
, i
, w
->contents
); ++i
;
10651 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10652 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10653 ASET (vector
, i
, make_number (marker_position (w
->old_pointm
))); ++i
;
10654 ASET (vector
, i
, make_number (marker_byte_position (w
->old_pointm
))); ++i
;
10655 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10656 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10661 for (; i
< end
; ++i
)
10662 ASET (vector
, i
, Qnil
);
10665 eassert (i
== ASIZE (vector
));
10670 /* Restore global state from VECTOR which was created by
10671 with_echo_area_buffer_unwind_data. */
10674 unwind_with_echo_area_buffer (Lisp_Object vector
)
10676 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10677 Vdeactivate_mark
= AREF (vector
, 1);
10678 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10680 if (WINDOWP (AREF (vector
, 3)))
10683 Lisp_Object buffer
;
10685 w
= XWINDOW (AREF (vector
, 3));
10686 buffer
= AREF (vector
, 4);
10688 wset_buffer (w
, buffer
);
10689 set_marker_both (w
->pointm
, buffer
,
10690 XFASTINT (AREF (vector
, 5)),
10691 XFASTINT (AREF (vector
, 6)));
10692 set_marker_both (w
->old_pointm
, buffer
,
10693 XFASTINT (AREF (vector
, 7)),
10694 XFASTINT (AREF (vector
, 8)));
10695 set_marker_both (w
->start
, buffer
,
10696 XFASTINT (AREF (vector
, 9)),
10697 XFASTINT (AREF (vector
, 10)));
10700 Vwith_echo_area_save_vector
= vector
;
10704 /* Set up the echo area for use by print functions. MULTIBYTE_P
10705 means we will print multibyte. */
10708 setup_echo_area_for_printing (bool multibyte_p
)
10710 /* If we can't find an echo area any more, exit. */
10711 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10712 Fkill_emacs (Qnil
);
10714 ensure_echo_area_buffers ();
10716 if (!message_buf_print
)
10718 /* A message has been output since the last time we printed.
10719 Choose a fresh echo area buffer. */
10720 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10721 echo_area_buffer
[0] = echo_buffer
[1];
10723 echo_area_buffer
[0] = echo_buffer
[0];
10725 /* Switch to that buffer and clear it. */
10726 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10727 bset_truncate_lines (current_buffer
, Qnil
);
10731 ptrdiff_t count
= SPECPDL_INDEX ();
10732 specbind (Qinhibit_read_only
, Qt
);
10733 /* Note that undo recording is always disabled. */
10734 del_range (BEG
, Z
);
10735 unbind_to (count
, Qnil
);
10737 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10739 /* Set up the buffer for the multibyteness we need. */
10741 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10742 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10744 /* Raise the frame containing the echo area. */
10745 if (minibuffer_auto_raise
)
10747 struct frame
*sf
= SELECTED_FRAME ();
10748 Lisp_Object mini_window
;
10749 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10750 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10753 message_log_maybe_newline ();
10754 message_buf_print
= true;
10758 if (NILP (echo_area_buffer
[0]))
10760 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10761 echo_area_buffer
[0] = echo_buffer
[1];
10763 echo_area_buffer
[0] = echo_buffer
[0];
10766 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10768 /* Someone switched buffers between print requests. */
10769 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10770 bset_truncate_lines (current_buffer
, Qnil
);
10776 /* Display an echo area message in window W. Value is true if W's
10777 height is changed. If display_last_displayed_message_p,
10778 display the message that was last displayed, otherwise
10779 display the current message. */
10782 display_echo_area (struct window
*w
)
10784 bool no_message_p
, window_height_changed_p
;
10786 /* Temporarily disable garbage collections while displaying the echo
10787 area. This is done because a GC can print a message itself.
10788 That message would modify the echo area buffer's contents while a
10789 redisplay of the buffer is going on, and seriously confuse
10791 ptrdiff_t count
= inhibit_garbage_collection ();
10793 /* If there is no message, we must call display_echo_area_1
10794 nevertheless because it resizes the window. But we will have to
10795 reset the echo_area_buffer in question to nil at the end because
10796 with_echo_area_buffer will sets it to an empty buffer. */
10797 bool i
= display_last_displayed_message_p
;
10798 /* According to the C99, C11 and C++11 standards, the integral value
10799 of a "bool" is always 0 or 1, so this array access is safe here,
10801 no_message_p
= NILP (echo_area_buffer
[i
]);
10803 window_height_changed_p
10804 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10805 display_echo_area_1
,
10806 (intptr_t) w
, Qnil
);
10809 echo_area_buffer
[i
] = Qnil
;
10811 unbind_to (count
, Qnil
);
10812 return window_height_changed_p
;
10816 /* Helper for display_echo_area. Display the current buffer which
10817 contains the current echo area message in window W, a mini-window,
10818 a pointer to which is passed in A1. A2..A4 are currently not used.
10819 Change the height of W so that all of the message is displayed.
10820 Value is true if height of W was changed. */
10823 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10826 struct window
*w
= (struct window
*) i1
;
10827 Lisp_Object window
;
10828 struct text_pos start
;
10830 /* We are about to enter redisplay without going through
10831 redisplay_internal, so we need to forget these faces by hand
10833 forget_escape_and_glyphless_faces ();
10835 /* Do this before displaying, so that we have a large enough glyph
10836 matrix for the display. If we can't get enough space for the
10837 whole text, display the last N lines. That works by setting w->start. */
10838 bool window_height_changed_p
= resize_mini_window (w
, false);
10840 /* Use the starting position chosen by resize_mini_window. */
10841 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10844 clear_glyph_matrix (w
->desired_matrix
);
10845 XSETWINDOW (window
, w
);
10846 try_window (window
, start
, 0);
10848 return window_height_changed_p
;
10852 /* Resize the echo area window to exactly the size needed for the
10853 currently displayed message, if there is one. If a mini-buffer
10854 is active, don't shrink it. */
10857 resize_echo_area_exactly (void)
10859 if (BUFFERP (echo_area_buffer
[0])
10860 && WINDOWP (echo_area_window
))
10862 struct window
*w
= XWINDOW (echo_area_window
);
10863 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10864 bool resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10865 (intptr_t) w
, resize_exactly
);
10868 windows_or_buffers_changed
= 42;
10869 update_mode_lines
= 30;
10870 redisplay_internal ();
10876 /* Callback function for with_echo_area_buffer, when used from
10877 resize_echo_area_exactly. A1 contains a pointer to the window to
10878 resize, EXACTLY non-nil means resize the mini-window exactly to the
10879 size of the text displayed. A3 and A4 are not used. Value is what
10880 resize_mini_window returns. */
10883 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10886 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10890 /* Resize mini-window W to fit the size of its contents. EXACT_P
10891 means size the window exactly to the size needed. Otherwise, it's
10892 only enlarged until W's buffer is empty.
10894 Set W->start to the right place to begin display. If the whole
10895 contents fit, start at the beginning. Otherwise, start so as
10896 to make the end of the contents appear. This is particularly
10897 important for y-or-n-p, but seems desirable generally.
10899 Value is true if the window height has been changed. */
10902 resize_mini_window (struct window
*w
, bool exact_p
)
10904 struct frame
*f
= XFRAME (w
->frame
);
10905 bool window_height_changed_p
= false;
10907 eassert (MINI_WINDOW_P (w
));
10909 /* By default, start display at the beginning. */
10910 set_marker_both (w
->start
, w
->contents
,
10911 BUF_BEGV (XBUFFER (w
->contents
)),
10912 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10914 /* Don't resize windows while redisplaying a window; it would
10915 confuse redisplay functions when the size of the window they are
10916 displaying changes from under them. Such a resizing can happen,
10917 for instance, when which-func prints a long message while
10918 we are running fontification-functions. We're running these
10919 functions with safe_call which binds inhibit-redisplay to t. */
10920 if (!NILP (Vinhibit_redisplay
))
10923 /* Nil means don't try to resize. */
10924 if (NILP (Vresize_mini_windows
)
10925 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10928 if (!FRAME_MINIBUF_ONLY_P (f
))
10931 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10932 + WINDOW_PIXEL_HEIGHT (w
));
10933 int unit
= FRAME_LINE_HEIGHT (f
);
10934 int height
, max_height
;
10935 struct text_pos start
;
10936 struct buffer
*old_current_buffer
= NULL
;
10938 if (current_buffer
!= XBUFFER (w
->contents
))
10940 old_current_buffer
= current_buffer
;
10941 set_buffer_internal (XBUFFER (w
->contents
));
10944 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10946 /* Compute the max. number of lines specified by the user. */
10947 if (FLOATP (Vmax_mini_window_height
))
10948 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10949 else if (INTEGERP (Vmax_mini_window_height
))
10950 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10952 max_height
= total_height
/ 4;
10954 /* Correct that max. height if it's bogus. */
10955 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10957 /* Find out the height of the text in the window. */
10958 if (it
.line_wrap
== TRUNCATE
)
10963 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10964 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10965 height
= it
.current_y
+ last_height
;
10967 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10968 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10971 /* Compute a suitable window start. */
10972 if (height
> max_height
)
10974 height
= (max_height
/ unit
) * unit
;
10975 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10976 move_it_vertically_backward (&it
, height
- unit
);
10977 start
= it
.current
.pos
;
10980 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10981 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10983 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10985 /* Let it grow only, until we display an empty message, in which
10986 case the window shrinks again. */
10987 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10989 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10991 FRAME_WINDOWS_FROZEN (f
) = true;
10992 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10993 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10995 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10996 && (exact_p
|| BEGV
== ZV
))
10998 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11000 FRAME_WINDOWS_FROZEN (f
) = false;
11001 shrink_mini_window (w
, true);
11002 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11007 /* Always resize to exact size needed. */
11008 if (height
> WINDOW_PIXEL_HEIGHT (w
))
11010 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11012 FRAME_WINDOWS_FROZEN (f
) = true;
11013 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
11014 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11016 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
11018 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11020 FRAME_WINDOWS_FROZEN (f
) = false;
11021 shrink_mini_window (w
, true);
11025 FRAME_WINDOWS_FROZEN (f
) = true;
11026 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
11029 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11033 if (old_current_buffer
)
11034 set_buffer_internal (old_current_buffer
);
11037 return window_height_changed_p
;
11041 /* Value is the current message, a string, or nil if there is no
11042 current message. */
11045 current_message (void)
11049 if (!BUFFERP (echo_area_buffer
[0]))
11053 with_echo_area_buffer (0, 0, current_message_1
,
11054 (intptr_t) &msg
, Qnil
);
11056 echo_area_buffer
[0] = Qnil
;
11064 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
11067 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
11070 *msg
= make_buffer_string (BEG
, Z
, true);
11077 /* Push the current message on Vmessage_stack for later restoration
11078 by restore_message. Value is true if the current message isn't
11079 empty. This is a relatively infrequent operation, so it's not
11080 worth optimizing. */
11083 push_message (void)
11085 Lisp_Object msg
= current_message ();
11086 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
11087 return STRINGP (msg
);
11091 /* Restore message display from the top of Vmessage_stack. */
11094 restore_message (void)
11096 eassert (CONSP (Vmessage_stack
));
11097 message3_nolog (XCAR (Vmessage_stack
));
11101 /* Handler for unwind-protect calling pop_message. */
11104 pop_message_unwind (void)
11106 /* Pop the top-most entry off Vmessage_stack. */
11107 eassert (CONSP (Vmessage_stack
));
11108 Vmessage_stack
= XCDR (Vmessage_stack
);
11112 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11113 exits. If the stack is not empty, we have a missing pop_message
11117 check_message_stack (void)
11119 if (!NILP (Vmessage_stack
))
11124 /* Truncate to NCHARS what will be displayed in the echo area the next
11125 time we display it---but don't redisplay it now. */
11128 truncate_echo_area (ptrdiff_t nchars
)
11131 echo_area_buffer
[0] = Qnil
;
11132 else if (!noninteractive
11134 && !NILP (echo_area_buffer
[0]))
11136 struct frame
*sf
= SELECTED_FRAME ();
11137 /* Error messages get reported properly by cmd_error, so this must be
11138 just an informative message; if the frame hasn't really been
11139 initialized yet, just toss it. */
11140 if (sf
->glyphs_initialized_p
)
11141 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11146 /* Helper function for truncate_echo_area. Truncate the current
11147 message to at most NCHARS characters. */
11150 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11152 if (BEG
+ nchars
< Z
)
11153 del_range (BEG
+ nchars
, Z
);
11155 echo_area_buffer
[0] = Qnil
;
11159 /* Set the current message to STRING. */
11162 set_message (Lisp_Object string
)
11164 eassert (STRINGP (string
));
11166 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11168 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11169 message_buf_print
= false;
11170 help_echo_showing_p
= false;
11172 if (STRINGP (Vdebug_on_message
)
11173 && STRINGP (string
)
11174 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11175 call_debugger (list2 (Qerror
, string
));
11179 /* Helper function for set_message. First argument is ignored and second
11180 argument has the same meaning as for set_message.
11181 This function is called with the echo area buffer being current. */
11184 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11186 eassert (STRINGP (string
));
11188 /* Change multibyteness of the echo buffer appropriately. */
11189 if (message_enable_multibyte
11190 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11191 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11193 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11194 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11195 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11197 /* Insert new message at BEG. */
11198 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11200 /* This function takes care of single/multibyte conversion.
11201 We just have to ensure that the echo area buffer has the right
11202 setting of enable_multibyte_characters. */
11203 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), true);
11209 /* Clear messages. CURRENT_P means clear the current message.
11210 LAST_DISPLAYED_P means clear the message last displayed. */
11213 clear_message (bool current_p
, bool last_displayed_p
)
11217 echo_area_buffer
[0] = Qnil
;
11218 message_cleared_p
= true;
11221 if (last_displayed_p
)
11222 echo_area_buffer
[1] = Qnil
;
11224 message_buf_print
= false;
11227 /* Clear garbaged frames.
11229 This function is used where the old redisplay called
11230 redraw_garbaged_frames which in turn called redraw_frame which in
11231 turn called clear_frame. The call to clear_frame was a source of
11232 flickering. I believe a clear_frame is not necessary. It should
11233 suffice in the new redisplay to invalidate all current matrices,
11234 and ensure a complete redisplay of all windows. */
11237 clear_garbaged_frames (void)
11239 if (frame_garbaged
)
11241 Lisp_Object tail
, frame
;
11242 struct frame
*sf
= SELECTED_FRAME ();
11244 FOR_EACH_FRAME (tail
, frame
)
11246 struct frame
*f
= XFRAME (frame
);
11248 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11251 /* It makes no sense to redraw a non-selected TTY
11252 frame, since that will actually clear the
11253 selected frame, and might leave the selected
11254 frame with corrupted display, if it happens not
11255 to be marked garbaged. */
11256 && !(f
!= sf
&& (FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))))
11259 clear_current_matrices (f
);
11260 fset_redisplay (f
);
11261 f
->garbaged
= false;
11262 f
->resized_p
= false;
11266 frame_garbaged
= false;
11271 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P, update
11275 echo_area_display (bool update_frame_p
)
11277 Lisp_Object mini_window
;
11280 bool window_height_changed_p
= false;
11281 struct frame
*sf
= SELECTED_FRAME ();
11283 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11284 w
= XWINDOW (mini_window
);
11285 f
= XFRAME (WINDOW_FRAME (w
));
11287 /* Don't display if frame is invisible or not yet initialized. */
11288 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11291 #ifdef HAVE_WINDOW_SYSTEM
11292 /* When Emacs starts, selected_frame may be the initial terminal
11293 frame. If we let this through, a message would be displayed on
11295 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11297 #endif /* HAVE_WINDOW_SYSTEM */
11299 /* Redraw garbaged frames. */
11300 clear_garbaged_frames ();
11302 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11304 echo_area_window
= mini_window
;
11305 window_height_changed_p
= display_echo_area (w
);
11306 w
->must_be_updated_p
= true;
11308 /* Update the display, unless called from redisplay_internal.
11309 Also don't update the screen during redisplay itself. The
11310 update will happen at the end of redisplay, and an update
11311 here could cause confusion. */
11312 if (update_frame_p
&& !redisplaying_p
)
11316 /* If the display update has been interrupted by pending
11317 input, update mode lines in the frame. Due to the
11318 pending input, it might have been that redisplay hasn't
11319 been called, so that mode lines above the echo area are
11320 garbaged. This looks odd, so we prevent it here. */
11321 if (!display_completed
)
11322 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11324 if (window_height_changed_p
11325 /* Don't do this if Emacs is shutting down. Redisplay
11326 needs to run hooks. */
11327 && !NILP (Vrun_hooks
))
11329 /* Must update other windows. Likewise as in other
11330 cases, don't let this update be interrupted by
11332 ptrdiff_t count
= SPECPDL_INDEX ();
11333 specbind (Qredisplay_dont_pause
, Qt
);
11334 fset_redisplay (f
);
11335 redisplay_internal ();
11336 unbind_to (count
, Qnil
);
11338 else if (FRAME_WINDOW_P (f
) && n
== 0)
11340 /* Window configuration is the same as before.
11341 Can do with a display update of the echo area,
11342 unless we displayed some mode lines. */
11343 update_single_window (w
);
11347 update_frame (f
, true, true);
11349 /* If cursor is in the echo area, make sure that the next
11350 redisplay displays the minibuffer, so that the cursor will
11351 be replaced with what the minibuffer wants. */
11352 if (cursor_in_echo_area
)
11353 wset_redisplay (XWINDOW (mini_window
));
11356 else if (!EQ (mini_window
, selected_window
))
11357 wset_redisplay (XWINDOW (mini_window
));
11359 /* Last displayed message is now the current message. */
11360 echo_area_buffer
[1] = echo_area_buffer
[0];
11361 /* Inform read_char that we're not echoing. */
11362 echo_message_buffer
= Qnil
;
11364 /* Prevent redisplay optimization in redisplay_internal by resetting
11365 this_line_start_pos. This is done because the mini-buffer now
11366 displays the message instead of its buffer text. */
11367 if (EQ (mini_window
, selected_window
))
11368 CHARPOS (this_line_start_pos
) = 0;
11370 if (window_height_changed_p
)
11372 fset_redisplay (f
);
11374 /* If window configuration was changed, frames may have been
11375 marked garbaged. Clear them or we will experience
11376 surprises wrt scrolling.
11377 FIXME: How/why/when? */
11378 clear_garbaged_frames ();
11382 /* True if W's buffer was changed but not saved. */
11385 window_buffer_changed (struct window
*w
)
11387 struct buffer
*b
= XBUFFER (w
->contents
);
11389 eassert (BUFFER_LIVE_P (b
));
11391 return (BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
;
11394 /* True if W has %c in its mode line and mode line should be updated. */
11397 mode_line_update_needed (struct window
*w
)
11399 return (w
->column_number_displayed
!= -1
11400 && !(PT
== w
->last_point
&& !window_outdated (w
))
11401 && (w
->column_number_displayed
!= current_column ()));
11404 /* True if window start of W is frozen and may not be changed during
11408 window_frozen_p (struct window
*w
)
11410 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11412 Lisp_Object window
;
11414 XSETWINDOW (window
, w
);
11415 if (MINI_WINDOW_P (w
))
11417 else if (EQ (window
, selected_window
))
11419 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11420 && EQ (window
, Vminibuf_scroll_window
))
11421 /* This special window can't be frozen too. */
11429 /***********************************************************************
11430 Mode Lines and Frame Titles
11431 ***********************************************************************/
11433 /* A buffer for constructing non-propertized mode-line strings and
11434 frame titles in it; allocated from the heap in init_xdisp and
11435 resized as needed in store_mode_line_noprop_char. */
11437 static char *mode_line_noprop_buf
;
11439 /* The buffer's end, and a current output position in it. */
11441 static char *mode_line_noprop_buf_end
;
11442 static char *mode_line_noprop_ptr
;
11444 #define MODE_LINE_NOPROP_LEN(start) \
11445 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11448 MODE_LINE_DISPLAY
= 0,
11452 } mode_line_target
;
11454 /* Alist that caches the results of :propertize.
11455 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11456 static Lisp_Object mode_line_proptrans_alist
;
11458 /* List of strings making up the mode-line. */
11459 static Lisp_Object mode_line_string_list
;
11461 /* Base face property when building propertized mode line string. */
11462 static Lisp_Object mode_line_string_face
;
11463 static Lisp_Object mode_line_string_face_prop
;
11466 /* Unwind data for mode line strings */
11468 static Lisp_Object Vmode_line_unwind_vector
;
11471 format_mode_line_unwind_data (struct frame
*target_frame
,
11472 struct buffer
*obuf
,
11474 bool save_proptrans
)
11476 Lisp_Object vector
, tmp
;
11478 /* Reduce consing by keeping one vector in
11479 Vwith_echo_area_save_vector. */
11480 vector
= Vmode_line_unwind_vector
;
11481 Vmode_line_unwind_vector
= Qnil
;
11484 vector
= Fmake_vector (make_number (10), Qnil
);
11486 ASET (vector
, 0, make_number (mode_line_target
));
11487 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11488 ASET (vector
, 2, mode_line_string_list
);
11489 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11490 ASET (vector
, 4, mode_line_string_face
);
11491 ASET (vector
, 5, mode_line_string_face_prop
);
11494 XSETBUFFER (tmp
, obuf
);
11497 ASET (vector
, 6, tmp
);
11498 ASET (vector
, 7, owin
);
11501 /* Similarly to `with-selected-window', if the operation selects
11502 a window on another frame, we must restore that frame's
11503 selected window, and (for a tty) the top-frame. */
11504 ASET (vector
, 8, target_frame
->selected_window
);
11505 if (FRAME_TERMCAP_P (target_frame
))
11506 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11513 unwind_format_mode_line (Lisp_Object vector
)
11515 Lisp_Object old_window
= AREF (vector
, 7);
11516 Lisp_Object target_frame_window
= AREF (vector
, 8);
11517 Lisp_Object old_top_frame
= AREF (vector
, 9);
11519 mode_line_target
= XINT (AREF (vector
, 0));
11520 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11521 mode_line_string_list
= AREF (vector
, 2);
11522 if (! EQ (AREF (vector
, 3), Qt
))
11523 mode_line_proptrans_alist
= AREF (vector
, 3);
11524 mode_line_string_face
= AREF (vector
, 4);
11525 mode_line_string_face_prop
= AREF (vector
, 5);
11527 /* Select window before buffer, since it may change the buffer. */
11528 if (!NILP (old_window
))
11530 /* If the operation that we are unwinding had selected a window
11531 on a different frame, reset its frame-selected-window. For a
11532 text terminal, reset its top-frame if necessary. */
11533 if (!NILP (target_frame_window
))
11536 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11538 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11539 Fselect_window (target_frame_window
, Qt
);
11541 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11542 Fselect_frame (old_top_frame
, Qt
);
11545 Fselect_window (old_window
, Qt
);
11548 if (!NILP (AREF (vector
, 6)))
11550 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11551 ASET (vector
, 6, Qnil
);
11554 Vmode_line_unwind_vector
= vector
;
11558 /* Store a single character C for the frame title in mode_line_noprop_buf.
11559 Re-allocate mode_line_noprop_buf if necessary. */
11562 store_mode_line_noprop_char (char c
)
11564 /* If output position has reached the end of the allocated buffer,
11565 increase the buffer's size. */
11566 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11568 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11569 ptrdiff_t size
= len
;
11570 mode_line_noprop_buf
=
11571 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11572 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11573 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11576 *mode_line_noprop_ptr
++ = c
;
11580 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11581 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11582 characters that yield more columns than PRECISION; PRECISION <= 0
11583 means copy the whole string. Pad with spaces until FIELD_WIDTH
11584 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11585 pad. Called from display_mode_element when it is used to build a
11589 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11591 const unsigned char *str
= (const unsigned char *) string
;
11593 ptrdiff_t dummy
, nbytes
;
11595 /* Copy at most PRECISION chars from STR. */
11596 nbytes
= strlen (string
);
11597 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11599 store_mode_line_noprop_char (*str
++);
11601 /* Fill up with spaces until FIELD_WIDTH reached. */
11602 while (field_width
> 0
11603 && n
< field_width
)
11605 store_mode_line_noprop_char (' ');
11612 /***********************************************************************
11614 ***********************************************************************/
11616 #ifdef HAVE_WINDOW_SYSTEM
11618 /* Set the title of FRAME, if it has changed. The title format is
11619 Vicon_title_format if FRAME is iconified, otherwise it is
11620 frame_title_format. */
11623 x_consider_frame_title (Lisp_Object frame
)
11625 struct frame
*f
= XFRAME (frame
);
11627 if ((FRAME_WINDOW_P (f
)
11628 || FRAME_MINIBUF_ONLY_P (f
)
11629 || f
->explicit_name
)
11630 && NILP (Fframe_parameter (frame
, Qtooltip
)))
11632 /* Do we have more than one visible frame on this X display? */
11633 Lisp_Object tail
, other_frame
, fmt
;
11634 ptrdiff_t title_start
;
11638 ptrdiff_t count
= SPECPDL_INDEX ();
11640 FOR_EACH_FRAME (tail
, other_frame
)
11642 struct frame
*tf
= XFRAME (other_frame
);
11645 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11646 && !FRAME_MINIBUF_ONLY_P (tf
)
11647 && !EQ (other_frame
, tip_frame
)
11648 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11652 /* Set global variable indicating that multiple frames exist. */
11653 multiple_frames
= CONSP (tail
);
11655 /* Switch to the buffer of selected window of the frame. Set up
11656 mode_line_target so that display_mode_element will output into
11657 mode_line_noprop_buf; then display the title. */
11658 record_unwind_protect (unwind_format_mode_line
,
11659 format_mode_line_unwind_data
11660 (f
, current_buffer
, selected_window
, false));
11662 Fselect_window (f
->selected_window
, Qt
);
11663 set_buffer_internal_1
11664 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11665 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11667 mode_line_target
= MODE_LINE_TITLE
;
11668 title_start
= MODE_LINE_NOPROP_LEN (0);
11669 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11670 NULL
, DEFAULT_FACE_ID
);
11671 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, false);
11672 len
= MODE_LINE_NOPROP_LEN (title_start
);
11673 title
= mode_line_noprop_buf
+ title_start
;
11674 unbind_to (count
, Qnil
);
11676 /* Set the title only if it's changed. This avoids consing in
11677 the common case where it hasn't. (If it turns out that we've
11678 already wasted too much time by walking through the list with
11679 display_mode_element, then we might need to optimize at a
11680 higher level than this.) */
11681 if (! STRINGP (f
->name
)
11682 || SBYTES (f
->name
) != len
11683 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11684 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11688 #endif /* not HAVE_WINDOW_SYSTEM */
11691 /***********************************************************************
11693 ***********************************************************************/
11695 /* True if we will not redisplay all visible windows. */
11696 #define REDISPLAY_SOME_P() \
11697 ((windows_or_buffers_changed == 0 \
11698 || windows_or_buffers_changed == REDISPLAY_SOME) \
11699 && (update_mode_lines == 0 \
11700 || update_mode_lines == REDISPLAY_SOME))
11702 /* Prepare for redisplay by updating menu-bar item lists when
11703 appropriate. This can call eval. */
11706 prepare_menu_bars (void)
11708 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11709 bool some_windows
= REDISPLAY_SOME_P ();
11710 Lisp_Object tooltip_frame
;
11712 #ifdef HAVE_WINDOW_SYSTEM
11713 tooltip_frame
= tip_frame
;
11715 tooltip_frame
= Qnil
;
11718 if (FUNCTIONP (Vpre_redisplay_function
))
11720 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11721 if (all_windows
&& some_windows
)
11723 Lisp_Object ws
= window_list ();
11724 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11726 Lisp_Object
this = XCAR (ws
);
11727 struct window
*w
= XWINDOW (this);
11729 || XFRAME (w
->frame
)->redisplay
11730 || XBUFFER (w
->contents
)->text
->redisplay
)
11732 windows
= Fcons (this, windows
);
11736 safe__call1 (true, Vpre_redisplay_function
, windows
);
11739 /* Update all frame titles based on their buffer names, etc. We do
11740 this before the menu bars so that the buffer-menu will show the
11741 up-to-date frame titles. */
11742 #ifdef HAVE_WINDOW_SYSTEM
11745 Lisp_Object tail
, frame
;
11747 FOR_EACH_FRAME (tail
, frame
)
11749 struct frame
*f
= XFRAME (frame
);
11750 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11754 && !XBUFFER (w
->contents
)->text
->redisplay
)
11757 if (!EQ (frame
, tooltip_frame
)
11758 && (FRAME_ICONIFIED_P (f
)
11759 || FRAME_VISIBLE_P (f
) == 1
11760 /* Exclude TTY frames that are obscured because they
11761 are not the top frame on their console. This is
11762 because x_consider_frame_title actually switches
11763 to the frame, which for TTY frames means it is
11764 marked as garbaged, and will be completely
11765 redrawn on the next redisplay cycle. This causes
11766 TTY frames to be completely redrawn, when there
11767 are more than one of them, even though nothing
11768 should be changed on display. */
11769 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11770 x_consider_frame_title (frame
);
11773 #endif /* HAVE_WINDOW_SYSTEM */
11775 /* Update the menu bar item lists, if appropriate. This has to be
11776 done before any actual redisplay or generation of display lines. */
11780 Lisp_Object tail
, frame
;
11781 ptrdiff_t count
= SPECPDL_INDEX ();
11782 /* True means that update_menu_bar has run its hooks
11783 so any further calls to update_menu_bar shouldn't do so again. */
11784 bool menu_bar_hooks_run
= false;
11786 record_unwind_save_match_data ();
11788 FOR_EACH_FRAME (tail
, frame
)
11790 struct frame
*f
= XFRAME (frame
);
11791 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11793 /* Ignore tooltip frame. */
11794 if (EQ (frame
, tooltip_frame
))
11800 && !XBUFFER (w
->contents
)->text
->redisplay
)
11803 run_window_size_change_functions (frame
);
11804 menu_bar_hooks_run
= update_menu_bar (f
, false, menu_bar_hooks_run
);
11805 #ifdef HAVE_WINDOW_SYSTEM
11806 update_tool_bar (f
, false);
11810 unbind_to (count
, Qnil
);
11814 struct frame
*sf
= SELECTED_FRAME ();
11815 update_menu_bar (sf
, true, false);
11816 #ifdef HAVE_WINDOW_SYSTEM
11817 update_tool_bar (sf
, true);
11823 /* Update the menu bar item list for frame F. This has to be done
11824 before we start to fill in any display lines, because it can call
11827 If SAVE_MATCH_DATA, we must save and restore it here.
11829 If HOOKS_RUN, a previous call to update_menu_bar
11830 already ran the menu bar hooks for this redisplay, so there
11831 is no need to run them again. The return value is the
11832 updated value of this flag, to pass to the next call. */
11835 update_menu_bar (struct frame
*f
, bool save_match_data
, bool hooks_run
)
11837 Lisp_Object window
;
11840 /* If called recursively during a menu update, do nothing. This can
11841 happen when, for instance, an activate-menubar-hook causes a
11843 if (inhibit_menubar_update
)
11846 window
= FRAME_SELECTED_WINDOW (f
);
11847 w
= XWINDOW (window
);
11849 if (FRAME_WINDOW_P (f
)
11851 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11852 || defined (HAVE_NS) || defined (USE_GTK)
11853 FRAME_EXTERNAL_MENU_BAR (f
)
11855 FRAME_MENU_BAR_LINES (f
) > 0
11857 : FRAME_MENU_BAR_LINES (f
) > 0)
11859 /* If the user has switched buffers or windows, we need to
11860 recompute to reflect the new bindings. But we'll
11861 recompute when update_mode_lines is set too; that means
11862 that people can use force-mode-line-update to request
11863 that the menu bar be recomputed. The adverse effect on
11864 the rest of the redisplay algorithm is about the same as
11865 windows_or_buffers_changed anyway. */
11866 if (windows_or_buffers_changed
11867 /* This used to test w->update_mode_line, but we believe
11868 there is no need to recompute the menu in that case. */
11869 || update_mode_lines
11870 || window_buffer_changed (w
))
11872 struct buffer
*prev
= current_buffer
;
11873 ptrdiff_t count
= SPECPDL_INDEX ();
11875 specbind (Qinhibit_menubar_update
, Qt
);
11877 set_buffer_internal_1 (XBUFFER (w
->contents
));
11878 if (save_match_data
)
11879 record_unwind_save_match_data ();
11880 if (NILP (Voverriding_local_map_menu_flag
))
11882 specbind (Qoverriding_terminal_local_map
, Qnil
);
11883 specbind (Qoverriding_local_map
, Qnil
);
11888 /* Run the Lucid hook. */
11889 safe_run_hooks (Qactivate_menubar_hook
);
11891 /* If it has changed current-menubar from previous value,
11892 really recompute the menu-bar from the value. */
11893 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11894 call0 (Qrecompute_lucid_menubar
);
11896 safe_run_hooks (Qmenu_bar_update_hook
);
11901 XSETFRAME (Vmenu_updating_frame
, f
);
11902 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11904 /* Redisplay the menu bar in case we changed it. */
11905 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11906 || defined (HAVE_NS) || defined (USE_GTK)
11907 if (FRAME_WINDOW_P (f
))
11909 #if defined (HAVE_NS)
11910 /* All frames on Mac OS share the same menubar. So only
11911 the selected frame should be allowed to set it. */
11912 if (f
== SELECTED_FRAME ())
11914 set_frame_menubar (f
, false, false);
11917 /* On a terminal screen, the menu bar is an ordinary screen
11918 line, and this makes it get updated. */
11919 w
->update_mode_line
= true;
11920 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11921 /* In the non-toolkit version, the menu bar is an ordinary screen
11922 line, and this makes it get updated. */
11923 w
->update_mode_line
= true;
11924 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11926 unbind_to (count
, Qnil
);
11927 set_buffer_internal_1 (prev
);
11934 /***********************************************************************
11936 ***********************************************************************/
11938 #ifdef HAVE_WINDOW_SYSTEM
11940 /* Select `frame' temporarily without running all the code in
11942 FIXME: Maybe do_switch_frame should be trimmed down similarly
11943 when `norecord' is set. */
11945 fast_set_selected_frame (Lisp_Object frame
)
11947 if (!EQ (selected_frame
, frame
))
11949 selected_frame
= frame
;
11950 selected_window
= XFRAME (frame
)->selected_window
;
11954 /* Update the tool-bar item list for frame F. This has to be done
11955 before we start to fill in any display lines. Called from
11956 prepare_menu_bars. If SAVE_MATCH_DATA, we must save
11957 and restore it here. */
11960 update_tool_bar (struct frame
*f
, bool save_match_data
)
11962 #if defined (USE_GTK) || defined (HAVE_NS)
11963 bool do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11965 bool do_update
= (WINDOWP (f
->tool_bar_window
)
11966 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0);
11971 Lisp_Object window
;
11974 window
= FRAME_SELECTED_WINDOW (f
);
11975 w
= XWINDOW (window
);
11977 /* If the user has switched buffers or windows, we need to
11978 recompute to reflect the new bindings. But we'll
11979 recompute when update_mode_lines is set too; that means
11980 that people can use force-mode-line-update to request
11981 that the menu bar be recomputed. The adverse effect on
11982 the rest of the redisplay algorithm is about the same as
11983 windows_or_buffers_changed anyway. */
11984 if (windows_or_buffers_changed
11985 || w
->update_mode_line
11986 || update_mode_lines
11987 || window_buffer_changed (w
))
11989 struct buffer
*prev
= current_buffer
;
11990 ptrdiff_t count
= SPECPDL_INDEX ();
11991 Lisp_Object frame
, new_tool_bar
;
11992 int new_n_tool_bar
;
11994 /* Set current_buffer to the buffer of the selected
11995 window of the frame, so that we get the right local
11997 set_buffer_internal_1 (XBUFFER (w
->contents
));
11999 /* Save match data, if we must. */
12000 if (save_match_data
)
12001 record_unwind_save_match_data ();
12003 /* Make sure that we don't accidentally use bogus keymaps. */
12004 if (NILP (Voverriding_local_map_menu_flag
))
12006 specbind (Qoverriding_terminal_local_map
, Qnil
);
12007 specbind (Qoverriding_local_map
, Qnil
);
12010 /* We must temporarily set the selected frame to this frame
12011 before calling tool_bar_items, because the calculation of
12012 the tool-bar keymap uses the selected frame (see
12013 `tool-bar-make-keymap' in tool-bar.el). */
12014 eassert (EQ (selected_window
,
12015 /* Since we only explicitly preserve selected_frame,
12016 check that selected_window would be redundant. */
12017 XFRAME (selected_frame
)->selected_window
));
12018 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
12019 XSETFRAME (frame
, f
);
12020 fast_set_selected_frame (frame
);
12022 /* Build desired tool-bar items from keymaps. */
12024 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
12027 /* Redisplay the tool-bar if we changed it. */
12028 if (new_n_tool_bar
!= f
->n_tool_bar_items
12029 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
12031 /* Redisplay that happens asynchronously due to an expose event
12032 may access f->tool_bar_items. Make sure we update both
12033 variables within BLOCK_INPUT so no such event interrupts. */
12035 fset_tool_bar_items (f
, new_tool_bar
);
12036 f
->n_tool_bar_items
= new_n_tool_bar
;
12037 w
->update_mode_line
= true;
12041 unbind_to (count
, Qnil
);
12042 set_buffer_internal_1 (prev
);
12047 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12049 /* Set F->desired_tool_bar_string to a Lisp string representing frame
12050 F's desired tool-bar contents. F->tool_bar_items must have
12051 been set up previously by calling prepare_menu_bars. */
12054 build_desired_tool_bar_string (struct frame
*f
)
12056 int i
, size
, size_needed
;
12057 Lisp_Object image
, plist
;
12059 image
= plist
= Qnil
;
12061 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
12062 Otherwise, make a new string. */
12064 /* The size of the string we might be able to reuse. */
12065 size
= (STRINGP (f
->desired_tool_bar_string
)
12066 ? SCHARS (f
->desired_tool_bar_string
)
12069 /* We need one space in the string for each image. */
12070 size_needed
= f
->n_tool_bar_items
;
12072 /* Reuse f->desired_tool_bar_string, if possible. */
12073 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
12074 fset_desired_tool_bar_string
12075 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
12078 AUTO_LIST4 (props
, Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
12079 Fremove_text_properties (make_number (0), make_number (size
),
12080 props
, f
->desired_tool_bar_string
);
12083 /* Put a `display' property on the string for the images to display,
12084 put a `menu_item' property on tool-bar items with a value that
12085 is the index of the item in F's tool-bar item vector. */
12086 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
12088 #define PROP(IDX) \
12089 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
12091 bool enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
12092 bool selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
12093 int hmargin
, vmargin
, relief
, idx
, end
;
12095 /* If image is a vector, choose the image according to the
12097 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
12098 if (VECTORP (image
))
12102 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12103 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
12106 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12107 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
12109 eassert (ASIZE (image
) >= idx
);
12110 image
= AREF (image
, idx
);
12115 /* Ignore invalid image specifications. */
12116 if (!valid_image_p (image
))
12119 /* Display the tool-bar button pressed, or depressed. */
12120 plist
= Fcopy_sequence (XCDR (image
));
12122 /* Compute margin and relief to draw. */
12123 relief
= (tool_bar_button_relief
>= 0
12124 ? tool_bar_button_relief
12125 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12126 hmargin
= vmargin
= relief
;
12128 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12129 INT_MAX
- max (hmargin
, vmargin
)))
12131 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12132 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12134 else if (CONSP (Vtool_bar_button_margin
))
12136 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12137 INT_MAX
- hmargin
))
12138 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12140 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12141 INT_MAX
- vmargin
))
12142 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12145 if (auto_raise_tool_bar_buttons_p
)
12147 /* Add a `:relief' property to the image spec if the item is
12151 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12158 /* If image is selected, display it pressed, i.e. with a
12159 negative relief. If it's not selected, display it with a
12161 plist
= Fplist_put (plist
, QCrelief
,
12163 ? make_number (-relief
)
12164 : make_number (relief
)));
12169 /* Put a margin around the image. */
12170 if (hmargin
|| vmargin
)
12172 if (hmargin
== vmargin
)
12173 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12175 plist
= Fplist_put (plist
, QCmargin
,
12176 Fcons (make_number (hmargin
),
12177 make_number (vmargin
)));
12180 /* If button is not enabled, and we don't have special images
12181 for the disabled state, make the image appear disabled by
12182 applying an appropriate algorithm to it. */
12183 if (!enabled_p
&& idx
< 0)
12184 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12186 /* Put a `display' text property on the string for the image to
12187 display. Put a `menu-item' property on the string that gives
12188 the start of this item's properties in the tool-bar items
12190 image
= Fcons (Qimage
, plist
);
12191 AUTO_LIST4 (props
, Qdisplay
, image
, Qmenu_item
,
12192 make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12194 /* Let the last image hide all remaining spaces in the tool bar
12195 string. The string can be longer than needed when we reuse a
12196 previous string. */
12197 if (i
+ 1 == f
->n_tool_bar_items
)
12198 end
= SCHARS (f
->desired_tool_bar_string
);
12201 Fadd_text_properties (make_number (i
), make_number (end
),
12202 props
, f
->desired_tool_bar_string
);
12208 /* Display one line of the tool-bar of frame IT->f.
12210 HEIGHT specifies the desired height of the tool-bar line.
12211 If the actual height of the glyph row is less than HEIGHT, the
12212 row's height is increased to HEIGHT, and the icons are centered
12213 vertically in the new height.
12215 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12216 count a final empty row in case the tool-bar width exactly matches
12221 display_tool_bar_line (struct it
*it
, int height
)
12223 struct glyph_row
*row
= it
->glyph_row
;
12224 int max_x
= it
->last_visible_x
;
12225 struct glyph
*last
;
12227 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12228 clear_glyph_row (row
);
12229 row
->enabled_p
= true;
12230 row
->y
= it
->current_y
;
12232 /* Note that this isn't made use of if the face hasn't a box,
12233 so there's no need to check the face here. */
12234 it
->start_of_box_run_p
= true;
12236 while (it
->current_x
< max_x
)
12238 int x
, n_glyphs_before
, i
, nglyphs
;
12239 struct it it_before
;
12241 /* Get the next display element. */
12242 if (!get_next_display_element (it
))
12244 /* Don't count empty row if we are counting needed tool-bar lines. */
12245 if (height
< 0 && !it
->hpos
)
12250 /* Produce glyphs. */
12251 n_glyphs_before
= row
->used
[TEXT_AREA
];
12254 PRODUCE_GLYPHS (it
);
12256 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12258 x
= it_before
.current_x
;
12259 while (i
< nglyphs
)
12261 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12263 if (x
+ glyph
->pixel_width
> max_x
)
12265 /* Glyph doesn't fit on line. Backtrack. */
12266 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12268 /* If this is the only glyph on this line, it will never fit on the
12269 tool-bar, so skip it. But ensure there is at least one glyph,
12270 so we don't accidentally disable the tool-bar. */
12271 if (n_glyphs_before
== 0
12272 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12278 x
+= glyph
->pixel_width
;
12282 /* Stop at line end. */
12283 if (ITERATOR_AT_END_OF_LINE_P (it
))
12286 set_iterator_to_next (it
, true);
12291 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12293 /* Use default face for the border below the tool bar.
12295 FIXME: When auto-resize-tool-bars is grow-only, there is
12296 no additional border below the possibly empty tool-bar lines.
12297 So to make the extra empty lines look "normal", we have to
12298 use the tool-bar face for the border too. */
12299 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12300 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12301 it
->face_id
= DEFAULT_FACE_ID
;
12303 extend_face_to_end_of_line (it
);
12304 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12305 last
->right_box_line_p
= true;
12306 if (last
== row
->glyphs
[TEXT_AREA
])
12307 last
->left_box_line_p
= true;
12309 /* Make line the desired height and center it vertically. */
12310 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12312 /* Don't add more than one line height. */
12313 height
%= FRAME_LINE_HEIGHT (it
->f
);
12314 it
->max_ascent
+= height
/ 2;
12315 it
->max_descent
+= (height
+ 1) / 2;
12318 compute_line_metrics (it
);
12320 /* If line is empty, make it occupy the rest of the tool-bar. */
12321 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12323 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12324 row
->visible_height
= row
->height
;
12325 row
->ascent
= row
->phys_ascent
= 0;
12326 row
->extra_line_spacing
= 0;
12329 row
->full_width_p
= true;
12330 row
->continued_p
= false;
12331 row
->truncated_on_left_p
= false;
12332 row
->truncated_on_right_p
= false;
12334 it
->current_x
= it
->hpos
= 0;
12335 it
->current_y
+= row
->height
;
12341 /* Value is the number of pixels needed to make all tool-bar items of
12342 frame F visible. The actual number of glyph rows needed is
12343 returned in *N_ROWS if non-NULL. */
12345 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12347 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12349 /* tool_bar_height is called from redisplay_tool_bar after building
12350 the desired matrix, so use (unused) mode-line row as temporary row to
12351 avoid destroying the first tool-bar row. */
12352 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12354 /* Initialize an iterator for iteration over
12355 F->desired_tool_bar_string in the tool-bar window of frame F. */
12356 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12357 temp_row
->reversed_p
= false;
12358 it
.first_visible_x
= 0;
12359 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12360 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12361 it
.paragraph_embedding
= L2R
;
12363 while (!ITERATOR_AT_END_P (&it
))
12365 clear_glyph_row (temp_row
);
12366 it
.glyph_row
= temp_row
;
12367 display_tool_bar_line (&it
, -1);
12369 clear_glyph_row (temp_row
);
12371 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12373 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12376 return it
.current_y
;
12378 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12381 #endif /* !USE_GTK && !HAVE_NS */
12383 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12385 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12386 If FRAME is nil or omitted, use the selected frame. Optional argument
12387 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12388 (Lisp_Object frame
, Lisp_Object pixelwise
)
12392 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12393 struct frame
*f
= decode_any_frame (frame
);
12395 if (WINDOWP (f
->tool_bar_window
)
12396 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12398 update_tool_bar (f
, true);
12399 if (f
->n_tool_bar_items
)
12401 build_desired_tool_bar_string (f
);
12402 height
= tool_bar_height (f
, NULL
, !NILP (pixelwise
));
12407 return make_number (height
);
12411 /* Display the tool-bar of frame F. Value is true if tool-bar's
12412 height should be changed. */
12414 redisplay_tool_bar (struct frame
*f
)
12416 f
->tool_bar_redisplayed
= true;
12417 #if defined (USE_GTK) || defined (HAVE_NS)
12419 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12420 update_frame_tool_bar (f
);
12423 #else /* !USE_GTK && !HAVE_NS */
12427 struct glyph_row
*row
;
12429 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12430 do anything. This means you must start with tool-bar-lines
12431 non-zero to get the auto-sizing effect. Or in other words, you
12432 can turn off tool-bars by specifying tool-bar-lines zero. */
12433 if (!WINDOWP (f
->tool_bar_window
)
12434 || (w
= XWINDOW (f
->tool_bar_window
),
12435 WINDOW_TOTAL_LINES (w
) == 0))
12438 /* Set up an iterator for the tool-bar window. */
12439 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12440 it
.first_visible_x
= 0;
12441 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12442 row
= it
.glyph_row
;
12443 row
->reversed_p
= false;
12445 /* Build a string that represents the contents of the tool-bar. */
12446 build_desired_tool_bar_string (f
);
12447 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12448 /* FIXME: This should be controlled by a user option. But it
12449 doesn't make sense to have an R2L tool bar if the menu bar cannot
12450 be drawn also R2L, and making the menu bar R2L is tricky due
12451 toolkit-specific code that implements it. If an R2L tool bar is
12452 ever supported, display_tool_bar_line should also be augmented to
12453 call unproduce_glyphs like display_line and display_string
12455 it
.paragraph_embedding
= L2R
;
12457 if (f
->n_tool_bar_rows
== 0)
12459 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, true);
12461 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12463 x_change_tool_bar_height (f
, new_height
);
12464 frame_default_tool_bar_height
= new_height
;
12465 /* Always do that now. */
12466 clear_glyph_matrix (w
->desired_matrix
);
12467 f
->fonts_changed
= true;
12472 /* Display as many lines as needed to display all tool-bar items. */
12474 if (f
->n_tool_bar_rows
> 0)
12476 int border
, rows
, height
, extra
;
12478 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12479 border
= XINT (Vtool_bar_border
);
12480 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12481 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12482 else if (EQ (Vtool_bar_border
, Qborder_width
))
12483 border
= f
->border_width
;
12489 rows
= f
->n_tool_bar_rows
;
12490 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12491 extra
= it
.last_visible_y
- border
- height
* rows
;
12493 while (it
.current_y
< it
.last_visible_y
)
12496 if (extra
> 0 && rows
-- > 0)
12498 h
= (extra
+ rows
- 1) / rows
;
12501 display_tool_bar_line (&it
, height
+ h
);
12506 while (it
.current_y
< it
.last_visible_y
)
12507 display_tool_bar_line (&it
, 0);
12510 /* It doesn't make much sense to try scrolling in the tool-bar
12511 window, so don't do it. */
12512 w
->desired_matrix
->no_scrolling_p
= true;
12513 w
->must_be_updated_p
= true;
12515 if (!NILP (Vauto_resize_tool_bars
))
12517 bool change_height_p
= true;
12519 /* If we couldn't display everything, change the tool-bar's
12520 height if there is room for more. */
12521 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
12522 change_height_p
= true;
12524 /* We subtract 1 because display_tool_bar_line advances the
12525 glyph_row pointer before returning to its caller. We want to
12526 examine the last glyph row produced by
12527 display_tool_bar_line. */
12528 row
= it
.glyph_row
- 1;
12530 /* If there are blank lines at the end, except for a partially
12531 visible blank line at the end that is smaller than
12532 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12533 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12534 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12535 change_height_p
= true;
12537 /* If row displays tool-bar items, but is partially visible,
12538 change the tool-bar's height. */
12539 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12540 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
12541 change_height_p
= true;
12543 /* Resize windows as needed by changing the `tool-bar-lines'
12544 frame parameter. */
12545 if (change_height_p
)
12548 int new_height
= tool_bar_height (f
, &nrows
, true);
12550 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12551 && !f
->minimize_tool_bar_window_p
)
12552 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12553 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12554 f
->minimize_tool_bar_window_p
= false;
12556 if (change_height_p
)
12558 x_change_tool_bar_height (f
, new_height
);
12559 frame_default_tool_bar_height
= new_height
;
12560 clear_glyph_matrix (w
->desired_matrix
);
12561 f
->n_tool_bar_rows
= nrows
;
12562 f
->fonts_changed
= true;
12569 f
->minimize_tool_bar_window_p
= false;
12572 #endif /* USE_GTK || HAVE_NS */
12575 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12577 /* Get information about the tool-bar item which is displayed in GLYPH
12578 on frame F. Return in *PROP_IDX the index where tool-bar item
12579 properties start in F->tool_bar_items. Value is false if
12580 GLYPH doesn't display a tool-bar item. */
12583 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12588 /* This function can be called asynchronously, which means we must
12589 exclude any possibility that Fget_text_property signals an
12591 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12592 charpos
= max (0, charpos
);
12594 /* Get the text property `menu-item' at pos. The value of that
12595 property is the start index of this item's properties in
12596 F->tool_bar_items. */
12597 prop
= Fget_text_property (make_number (charpos
),
12598 Qmenu_item
, f
->current_tool_bar_string
);
12599 if (! INTEGERP (prop
))
12601 *prop_idx
= XINT (prop
);
12606 /* Get information about the tool-bar item at position X/Y on frame F.
12607 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12608 the current matrix of the tool-bar window of F, or NULL if not
12609 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12610 item in F->tool_bar_items. Value is
12612 -1 if X/Y is not on a tool-bar item
12613 0 if X/Y is on the same item that was highlighted before.
12617 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12618 int *hpos
, int *vpos
, int *prop_idx
)
12620 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12621 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12624 /* Find the glyph under X/Y. */
12625 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12626 if (*glyph
== NULL
)
12629 /* Get the start of this tool-bar item's properties in
12630 f->tool_bar_items. */
12631 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12634 /* Is mouse on the highlighted item? */
12635 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12636 && *vpos
>= hlinfo
->mouse_face_beg_row
12637 && *vpos
<= hlinfo
->mouse_face_end_row
12638 && (*vpos
> hlinfo
->mouse_face_beg_row
12639 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12640 && (*vpos
< hlinfo
->mouse_face_end_row
12641 || *hpos
< hlinfo
->mouse_face_end_col
12642 || hlinfo
->mouse_face_past_end
))
12650 Handle mouse button event on the tool-bar of frame F, at
12651 frame-relative coordinates X/Y. DOWN_P is true for a button press,
12652 false for button release. MODIFIERS is event modifiers for button
12656 handle_tool_bar_click (struct frame
*f
, int x
, int y
, bool down_p
,
12659 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12660 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12661 int hpos
, vpos
, prop_idx
;
12662 struct glyph
*glyph
;
12663 Lisp_Object enabled_p
;
12666 /* If not on the highlighted tool-bar item, and mouse-highlight is
12667 non-nil, return. This is so we generate the tool-bar button
12668 click only when the mouse button is released on the same item as
12669 where it was pressed. However, when mouse-highlight is disabled,
12670 generate the click when the button is released regardless of the
12671 highlight, since tool-bar items are not highlighted in that
12673 frame_to_window_pixel_xy (w
, &x
, &y
);
12674 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12676 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12679 /* When mouse-highlight is off, generate the click for the item
12680 where the button was pressed, disregarding where it was
12682 if (NILP (Vmouse_highlight
) && !down_p
)
12683 prop_idx
= f
->last_tool_bar_item
;
12685 /* If item is disabled, do nothing. */
12686 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12687 if (NILP (enabled_p
))
12692 /* Show item in pressed state. */
12693 if (!NILP (Vmouse_highlight
))
12694 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12695 f
->last_tool_bar_item
= prop_idx
;
12699 Lisp_Object key
, frame
;
12700 struct input_event event
;
12701 EVENT_INIT (event
);
12703 /* Show item in released state. */
12704 if (!NILP (Vmouse_highlight
))
12705 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12707 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12709 XSETFRAME (frame
, f
);
12710 event
.kind
= TOOL_BAR_EVENT
;
12711 event
.frame_or_window
= frame
;
12713 kbd_buffer_store_event (&event
);
12715 event
.kind
= TOOL_BAR_EVENT
;
12716 event
.frame_or_window
= frame
;
12718 event
.modifiers
= modifiers
;
12719 kbd_buffer_store_event (&event
);
12720 f
->last_tool_bar_item
= -1;
12725 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12726 tool-bar window-relative coordinates X/Y. Called from
12727 note_mouse_highlight. */
12730 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12732 Lisp_Object window
= f
->tool_bar_window
;
12733 struct window
*w
= XWINDOW (window
);
12734 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12735 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12737 struct glyph
*glyph
;
12738 struct glyph_row
*row
;
12740 Lisp_Object enabled_p
;
12742 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12746 /* Function note_mouse_highlight is called with negative X/Y
12747 values when mouse moves outside of the frame. */
12748 if (x
<= 0 || y
<= 0)
12750 clear_mouse_face (hlinfo
);
12754 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12757 /* Not on tool-bar item. */
12758 clear_mouse_face (hlinfo
);
12762 /* On same tool-bar item as before. */
12763 goto set_help_echo
;
12765 clear_mouse_face (hlinfo
);
12767 /* Mouse is down, but on different tool-bar item? */
12768 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12769 && f
== dpyinfo
->last_mouse_frame
);
12771 if (mouse_down_p
&& f
->last_tool_bar_item
!= prop_idx
)
12774 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12776 /* If tool-bar item is not enabled, don't highlight it. */
12777 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12778 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12780 /* Compute the x-position of the glyph. In front and past the
12781 image is a space. We include this in the highlighted area. */
12782 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12783 for (i
= x
= 0; i
< hpos
; ++i
)
12784 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12786 /* Record this as the current active region. */
12787 hlinfo
->mouse_face_beg_col
= hpos
;
12788 hlinfo
->mouse_face_beg_row
= vpos
;
12789 hlinfo
->mouse_face_beg_x
= x
;
12790 hlinfo
->mouse_face_past_end
= false;
12792 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12793 hlinfo
->mouse_face_end_row
= vpos
;
12794 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12795 hlinfo
->mouse_face_window
= window
;
12796 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12798 /* Display it as active. */
12799 show_mouse_face (hlinfo
, draw
);
12804 /* Set help_echo_string to a help string to display for this tool-bar item.
12805 XTread_socket does the rest. */
12806 help_echo_object
= help_echo_window
= Qnil
;
12807 help_echo_pos
= -1;
12808 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12809 if (NILP (help_echo_string
))
12810 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12813 #endif /* !USE_GTK && !HAVE_NS */
12815 #endif /* HAVE_WINDOW_SYSTEM */
12819 /************************************************************************
12820 Horizontal scrolling
12821 ************************************************************************/
12823 /* For all leaf windows in the window tree rooted at WINDOW, set their
12824 hscroll value so that PT is (i) visible in the window, and (ii) so
12825 that it is not within a certain margin at the window's left and
12826 right border. Value is true if any window's hscroll has been
12830 hscroll_window_tree (Lisp_Object window
)
12832 bool hscrolled_p
= false;
12833 bool hscroll_relative_p
= FLOATP (Vhscroll_step
);
12834 int hscroll_step_abs
= 0;
12835 double hscroll_step_rel
= 0;
12837 if (hscroll_relative_p
)
12839 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12840 if (hscroll_step_rel
< 0)
12842 hscroll_relative_p
= false;
12843 hscroll_step_abs
= 0;
12846 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12848 hscroll_step_abs
= XINT (Vhscroll_step
);
12849 if (hscroll_step_abs
< 0)
12850 hscroll_step_abs
= 0;
12853 hscroll_step_abs
= 0;
12855 while (WINDOWP (window
))
12857 struct window
*w
= XWINDOW (window
);
12859 if (WINDOWP (w
->contents
))
12860 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12861 else if (w
->cursor
.vpos
>= 0)
12864 int text_area_width
;
12865 struct glyph_row
*cursor_row
;
12866 struct glyph_row
*bottom_row
;
12868 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12869 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12870 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12872 cursor_row
= bottom_row
- 1;
12874 if (!cursor_row
->enabled_p
)
12876 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12877 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12878 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12880 cursor_row
= bottom_row
- 1;
12882 bool row_r2l_p
= cursor_row
->reversed_p
;
12884 text_area_width
= window_box_width (w
, TEXT_AREA
);
12886 /* Scroll when cursor is inside this scroll margin. */
12887 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12889 /* If the position of this window's point has explicitly
12890 changed, no more suspend auto hscrolling. */
12891 if (NILP (Fequal (Fwindow_point (window
), Fwindow_old_point (window
))))
12892 w
->suspend_auto_hscroll
= false;
12894 /* Remember window point. */
12895 Fset_marker (w
->old_pointm
,
12896 ((w
== XWINDOW (selected_window
))
12897 ? make_number (BUF_PT (XBUFFER (w
->contents
)))
12898 : Fmarker_position (w
->pointm
)),
12901 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12902 && !w
->suspend_auto_hscroll
12903 /* In some pathological cases, like restoring a window
12904 configuration into a frame that is much smaller than
12905 the one from which the configuration was saved, we
12906 get glyph rows whose start and end have zero buffer
12907 positions, which we cannot handle below. Just skip
12909 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12910 /* For left-to-right rows, hscroll when cursor is either
12911 (i) inside the right hscroll margin, or (ii) if it is
12912 inside the left margin and the window is already
12915 && ((w
->hscroll
&& w
->cursor
.x
<= h_margin
)
12916 || (cursor_row
->enabled_p
12917 && cursor_row
->truncated_on_right_p
12918 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12919 /* For right-to-left rows, the logic is similar,
12920 except that rules for scrolling to left and right
12921 are reversed. E.g., if cursor.x <= h_margin, we
12922 need to hscroll "to the right" unconditionally,
12923 and that will scroll the screen to the left so as
12924 to reveal the next portion of the row. */
12926 && ((cursor_row
->enabled_p
12927 /* FIXME: It is confusing to set the
12928 truncated_on_right_p flag when R2L rows
12929 are actually truncated on the left. */
12930 && cursor_row
->truncated_on_right_p
12931 && w
->cursor
.x
<= h_margin
)
12933 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12937 struct buffer
*saved_current_buffer
;
12941 /* Find point in a display of infinite width. */
12942 saved_current_buffer
= current_buffer
;
12943 current_buffer
= XBUFFER (w
->contents
);
12945 if (w
== XWINDOW (selected_window
))
12948 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12950 /* Move iterator to pt starting at cursor_row->start in
12951 a line with infinite width. */
12952 init_to_row_start (&it
, w
, cursor_row
);
12953 it
.last_visible_x
= INFINITY
;
12954 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12955 current_buffer
= saved_current_buffer
;
12957 /* Position cursor in window. */
12958 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12959 hscroll
= max (0, (it
.current_x
12960 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12961 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12962 : (text_area_width
/ 2))))
12963 / FRAME_COLUMN_WIDTH (it
.f
);
12964 else if ((!row_r2l_p
12965 && w
->cursor
.x
>= text_area_width
- h_margin
)
12966 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12968 if (hscroll_relative_p
)
12969 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12972 wanted_x
= text_area_width
12973 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12976 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12980 if (hscroll_relative_p
)
12981 wanted_x
= text_area_width
* hscroll_step_rel
12984 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12987 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12989 hscroll
= max (hscroll
, w
->min_hscroll
);
12991 /* Don't prevent redisplay optimizations if hscroll
12992 hasn't changed, as it will unnecessarily slow down
12994 if (w
->hscroll
!= hscroll
)
12996 struct buffer
*b
= XBUFFER (w
->contents
);
12997 b
->prevent_redisplay_optimizations_p
= true;
12998 w
->hscroll
= hscroll
;
12999 hscrolled_p
= true;
13007 /* Value is true if hscroll of any leaf window has been changed. */
13008 return hscrolled_p
;
13012 /* Set hscroll so that cursor is visible and not inside horizontal
13013 scroll margins for all windows in the tree rooted at WINDOW. See
13014 also hscroll_window_tree above. Value is true if any window's
13015 hscroll has been changed. If it has, desired matrices on the frame
13016 of WINDOW are cleared. */
13019 hscroll_windows (Lisp_Object window
)
13021 bool hscrolled_p
= hscroll_window_tree (window
);
13023 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
13024 return hscrolled_p
;
13029 /************************************************************************
13031 ************************************************************************/
13033 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined.
13034 This is sometimes handy to have in a debugger session. */
13038 /* First and last unchanged row for try_window_id. */
13040 static int debug_first_unchanged_at_end_vpos
;
13041 static int debug_last_unchanged_at_beg_vpos
;
13043 /* Delta vpos and y. */
13045 static int debug_dvpos
, debug_dy
;
13047 /* Delta in characters and bytes for try_window_id. */
13049 static ptrdiff_t debug_delta
, debug_delta_bytes
;
13051 /* Values of window_end_pos and window_end_vpos at the end of
13054 static ptrdiff_t debug_end_vpos
;
13056 /* Append a string to W->desired_matrix->method. FMT is a printf
13057 format string. If trace_redisplay_p is true also printf the
13058 resulting string to stderr. */
13060 static void debug_method_add (struct window
*, char const *, ...)
13061 ATTRIBUTE_FORMAT_PRINTF (2, 3);
13064 debug_method_add (struct window
*w
, char const *fmt
, ...)
13067 char *method
= w
->desired_matrix
->method
;
13068 int len
= strlen (method
);
13069 int size
= sizeof w
->desired_matrix
->method
;
13070 int remaining
= size
- len
- 1;
13073 if (len
&& remaining
)
13076 --remaining
, ++len
;
13079 va_start (ap
, fmt
);
13080 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
13083 if (trace_redisplay_p
)
13084 fprintf (stderr
, "%p (%s): %s\n",
13086 ((BUFFERP (w
->contents
)
13087 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
13088 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13093 #endif /* GLYPH_DEBUG */
13096 /* Value is true if all changes in window W, which displays
13097 current_buffer, are in the text between START and END. START is a
13098 buffer position, END is given as a distance from Z. Used in
13099 redisplay_internal for display optimization. */
13102 text_outside_line_unchanged_p (struct window
*w
,
13103 ptrdiff_t start
, ptrdiff_t end
)
13105 bool unchanged_p
= true;
13107 /* If text or overlays have changed, see where. */
13108 if (window_outdated (w
))
13110 /* Gap in the line? */
13111 if (GPT
< start
|| Z
- GPT
< end
)
13112 unchanged_p
= false;
13114 /* Changes start in front of the line, or end after it? */
13116 && (BEG_UNCHANGED
< start
- 1
13117 || END_UNCHANGED
< end
))
13118 unchanged_p
= false;
13120 /* If selective display, can't optimize if changes start at the
13121 beginning of the line. */
13123 && INTEGERP (BVAR (current_buffer
, selective_display
))
13124 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13125 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13126 unchanged_p
= false;
13128 /* If there are overlays at the start or end of the line, these
13129 may have overlay strings with newlines in them. A change at
13130 START, for instance, may actually concern the display of such
13131 overlay strings as well, and they are displayed on different
13132 lines. So, quickly rule out this case. (For the future, it
13133 might be desirable to implement something more telling than
13134 just BEG/END_UNCHANGED.) */
13137 if (BEG
+ BEG_UNCHANGED
== start
13138 && overlay_touches_p (start
))
13139 unchanged_p
= false;
13140 if (END_UNCHANGED
== end
13141 && overlay_touches_p (Z
- end
))
13142 unchanged_p
= false;
13145 /* Under bidi reordering, adding or deleting a character in the
13146 beginning of a paragraph, before the first strong directional
13147 character, can change the base direction of the paragraph (unless
13148 the buffer specifies a fixed paragraph direction), which will
13149 require redisplaying the whole paragraph. It might be worthwhile
13150 to find the paragraph limits and widen the range of redisplayed
13151 lines to that, but for now just give up this optimization. */
13152 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13153 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13154 unchanged_p
= false;
13157 return unchanged_p
;
13161 /* Do a frame update, taking possible shortcuts into account. This is
13162 the main external entry point for redisplay.
13164 If the last redisplay displayed an echo area message and that message
13165 is no longer requested, we clear the echo area or bring back the
13166 mini-buffer if that is in use. */
13171 redisplay_internal ();
13176 overlay_arrow_string_or_property (Lisp_Object var
)
13180 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13183 return Voverlay_arrow_string
;
13186 /* Return true if there are any overlay-arrows in current_buffer. */
13188 overlay_arrow_in_current_buffer_p (void)
13192 for (vlist
= Voverlay_arrow_variable_list
;
13194 vlist
= XCDR (vlist
))
13196 Lisp_Object var
= XCAR (vlist
);
13199 if (!SYMBOLP (var
))
13201 val
= find_symbol_value (var
);
13203 && current_buffer
== XMARKER (val
)->buffer
)
13210 /* Return true if any overlay_arrows have moved or overlay-arrow-string
13214 overlay_arrows_changed_p (void)
13218 for (vlist
= Voverlay_arrow_variable_list
;
13220 vlist
= XCDR (vlist
))
13222 Lisp_Object var
= XCAR (vlist
);
13223 Lisp_Object val
, pstr
;
13225 if (!SYMBOLP (var
))
13227 val
= find_symbol_value (var
);
13228 if (!MARKERP (val
))
13230 if (! EQ (COERCE_MARKER (val
),
13231 Fget (var
, Qlast_arrow_position
))
13232 || ! (pstr
= overlay_arrow_string_or_property (var
),
13233 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13239 /* Mark overlay arrows to be updated on next redisplay. */
13242 update_overlay_arrows (int up_to_date
)
13246 for (vlist
= Voverlay_arrow_variable_list
;
13248 vlist
= XCDR (vlist
))
13250 Lisp_Object var
= XCAR (vlist
);
13252 if (!SYMBOLP (var
))
13255 if (up_to_date
> 0)
13257 Lisp_Object val
= find_symbol_value (var
);
13258 Fput (var
, Qlast_arrow_position
,
13259 COERCE_MARKER (val
));
13260 Fput (var
, Qlast_arrow_string
,
13261 overlay_arrow_string_or_property (var
));
13263 else if (up_to_date
< 0
13264 || !NILP (Fget (var
, Qlast_arrow_position
)))
13266 Fput (var
, Qlast_arrow_position
, Qt
);
13267 Fput (var
, Qlast_arrow_string
, Qt
);
13273 /* Return overlay arrow string to display at row.
13274 Return integer (bitmap number) for arrow bitmap in left fringe.
13275 Return nil if no overlay arrow. */
13278 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13282 for (vlist
= Voverlay_arrow_variable_list
;
13284 vlist
= XCDR (vlist
))
13286 Lisp_Object var
= XCAR (vlist
);
13289 if (!SYMBOLP (var
))
13292 val
= find_symbol_value (var
);
13295 && current_buffer
== XMARKER (val
)->buffer
13296 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13298 if (FRAME_WINDOW_P (it
->f
)
13299 /* FIXME: if ROW->reversed_p is set, this should test
13300 the right fringe, not the left one. */
13301 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13303 #ifdef HAVE_WINDOW_SYSTEM
13304 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13306 int fringe_bitmap
= lookup_fringe_bitmap (val
);
13307 if (fringe_bitmap
!= 0)
13308 return make_number (fringe_bitmap
);
13311 return make_number (-1); /* Use default arrow bitmap. */
13313 return overlay_arrow_string_or_property (var
);
13320 /* Return true if point moved out of or into a composition. Otherwise
13321 return false. PREV_BUF and PREV_PT are the last point buffer and
13322 position. BUF and PT are the current point buffer and position. */
13325 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13326 struct buffer
*buf
, ptrdiff_t pt
)
13328 ptrdiff_t start
, end
;
13330 Lisp_Object buffer
;
13332 XSETBUFFER (buffer
, buf
);
13333 /* Check a composition at the last point if point moved within the
13335 if (prev_buf
== buf
)
13338 /* Point didn't move. */
13341 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13342 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13343 && composition_valid_p (start
, end
, prop
)
13344 && start
< prev_pt
&& end
> prev_pt
)
13345 /* The last point was within the composition. Return true iff
13346 point moved out of the composition. */
13347 return (pt
<= start
|| pt
>= end
);
13350 /* Check a composition at the current point. */
13351 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13352 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13353 && composition_valid_p (start
, end
, prop
)
13354 && start
< pt
&& end
> pt
);
13357 /* Reconsider the clip changes of buffer which is displayed in W. */
13360 reconsider_clip_changes (struct window
*w
)
13362 struct buffer
*b
= XBUFFER (w
->contents
);
13364 if (b
->clip_changed
13365 && w
->window_end_valid
13366 && w
->current_matrix
->buffer
== b
13367 && w
->current_matrix
->zv
== BUF_ZV (b
)
13368 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13369 b
->clip_changed
= false;
13371 /* If display wasn't paused, and W is not a tool bar window, see if
13372 point has been moved into or out of a composition. In that case,
13373 set b->clip_changed to force updating the screen. If
13374 b->clip_changed has already been set, skip this check. */
13375 if (!b
->clip_changed
&& w
->window_end_valid
)
13377 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13378 ? PT
: marker_position (w
->pointm
));
13380 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13381 && check_point_in_composition (w
->current_matrix
->buffer
,
13382 w
->last_point
, b
, pt
))
13383 b
->clip_changed
= true;
13388 propagate_buffer_redisplay (void)
13389 { /* Resetting b->text->redisplay is problematic!
13390 We can't just reset it in the case that some window that displays
13391 it has not been redisplayed; and such a window can stay
13392 unredisplayed for a long time if it's currently invisible.
13393 But we do want to reset it at the end of redisplay otherwise
13394 its displayed windows will keep being redisplayed over and over
13396 So we copy all b->text->redisplay flags up to their windows here,
13397 such that mark_window_display_accurate can safely reset
13398 b->text->redisplay. */
13399 Lisp_Object ws
= window_list ();
13400 for (; CONSP (ws
); ws
= XCDR (ws
))
13402 struct window
*thisw
= XWINDOW (XCAR (ws
));
13403 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13404 if (thisb
->text
->redisplay
)
13405 thisw
->redisplay
= true;
13409 #define STOP_POLLING \
13410 do { if (! polling_stopped_here) stop_polling (); \
13411 polling_stopped_here = true; } while (false)
13413 #define RESUME_POLLING \
13414 do { if (polling_stopped_here) start_polling (); \
13415 polling_stopped_here = false; } while (false)
13418 /* Perhaps in the future avoid recentering windows if it
13419 is not necessary; currently that causes some problems. */
13422 redisplay_internal (void)
13424 struct window
*w
= XWINDOW (selected_window
);
13428 bool must_finish
= false, match_p
;
13429 struct text_pos tlbufpos
, tlendpos
;
13430 int number_of_visible_frames
;
13433 bool polling_stopped_here
= false;
13434 Lisp_Object tail
, frame
;
13436 /* True means redisplay has to consider all windows on all
13437 frames. False, only selected_window is considered. */
13438 bool consider_all_windows_p
;
13440 /* True means redisplay has to redisplay the miniwindow. */
13441 bool update_miniwindow_p
= false;
13443 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13445 /* No redisplay if running in batch mode or frame is not yet fully
13446 initialized, or redisplay is explicitly turned off by setting
13447 Vinhibit_redisplay. */
13448 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13449 || !NILP (Vinhibit_redisplay
))
13452 /* Don't examine these until after testing Vinhibit_redisplay.
13453 When Emacs is shutting down, perhaps because its connection to
13454 X has dropped, we should not look at them at all. */
13455 fr
= XFRAME (w
->frame
);
13456 sf
= SELECTED_FRAME ();
13458 if (!fr
->glyphs_initialized_p
)
13461 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13462 if (popup_activated ())
13466 /* I don't think this happens but let's be paranoid. */
13467 if (redisplaying_p
)
13470 /* Record a function that clears redisplaying_p
13471 when we leave this function. */
13472 count
= SPECPDL_INDEX ();
13473 record_unwind_protect_void (unwind_redisplay
);
13474 redisplaying_p
= true;
13475 specbind (Qinhibit_free_realized_faces
, Qnil
);
13477 /* Record this function, so it appears on the profiler's backtraces. */
13478 record_in_backtrace (Qredisplay_internal
, 0, 0);
13480 FOR_EACH_FRAME (tail
, frame
)
13481 XFRAME (frame
)->already_hscrolled_p
= false;
13484 /* Remember the currently selected window. */
13488 forget_escape_and_glyphless_faces ();
13490 inhibit_free_realized_faces
= false;
13492 /* If face_change, init_iterator will free all realized faces, which
13493 includes the faces referenced from current matrices. So, we
13494 can't reuse current matrices in this case. */
13496 windows_or_buffers_changed
= 47;
13498 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13499 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13501 /* Since frames on a single ASCII terminal share the same
13502 display area, displaying a different frame means redisplay
13503 the whole thing. */
13504 SET_FRAME_GARBAGED (sf
);
13506 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13508 FRAME_TTY (sf
)->previous_frame
= sf
;
13511 /* Set the visible flags for all frames. Do this before checking for
13512 resized or garbaged frames; they want to know if their frames are
13513 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13514 number_of_visible_frames
= 0;
13516 FOR_EACH_FRAME (tail
, frame
)
13518 struct frame
*f
= XFRAME (frame
);
13520 if (FRAME_VISIBLE_P (f
))
13522 ++number_of_visible_frames
;
13523 /* Adjust matrices for visible frames only. */
13524 if (f
->fonts_changed
)
13526 adjust_frame_glyphs (f
);
13527 /* Disable all redisplay optimizations for this frame.
13528 This is because adjust_frame_glyphs resets the
13529 enabled_p flag for all glyph rows of all windows, so
13530 many optimizations will fail anyway, and some might
13531 fail to test that flag and do bogus things as
13533 SET_FRAME_GARBAGED (f
);
13534 f
->fonts_changed
= false;
13536 /* If cursor type has been changed on the frame
13537 other than selected, consider all frames. */
13538 if (f
!= sf
&& f
->cursor_type_changed
)
13539 fset_redisplay (f
);
13541 clear_desired_matrices (f
);
13544 /* Notice any pending interrupt request to change frame size. */
13545 do_pending_window_change (true);
13547 /* do_pending_window_change could change the selected_window due to
13548 frame resizing which makes the selected window too small. */
13549 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13552 /* Clear frames marked as garbaged. */
13553 clear_garbaged_frames ();
13555 /* Build menubar and tool-bar items. */
13556 if (NILP (Vmemory_full
))
13557 prepare_menu_bars ();
13559 reconsider_clip_changes (w
);
13561 /* In most cases selected window displays current buffer. */
13562 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13565 /* Detect case that we need to write or remove a star in the mode line. */
13566 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13567 w
->update_mode_line
= true;
13569 if (mode_line_update_needed (w
))
13570 w
->update_mode_line
= true;
13572 /* If reconsider_clip_changes above decided that the narrowing
13573 in the current buffer changed, make sure all other windows
13574 showing that buffer will be redisplayed. */
13575 if (current_buffer
->clip_changed
)
13576 bset_update_mode_line (current_buffer
);
13579 /* Normally the message* functions will have already displayed and
13580 updated the echo area, but the frame may have been trashed, or
13581 the update may have been preempted, so display the echo area
13582 again here. Checking message_cleared_p captures the case that
13583 the echo area should be cleared. */
13584 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13585 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13586 || (message_cleared_p
13587 && minibuf_level
== 0
13588 /* If the mini-window is currently selected, this means the
13589 echo-area doesn't show through. */
13590 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13592 echo_area_display (false);
13594 /* If echo_area_display resizes the mini-window, the redisplay and
13595 window_sizes_changed flags of the selected frame are set, but
13596 it's too late for the hooks in window-size-change-functions,
13597 which have been examined already in prepare_menu_bars. So in
13598 that case we call the hooks here only for the selected frame. */
13601 ptrdiff_t count1
= SPECPDL_INDEX ();
13603 record_unwind_save_match_data ();
13604 run_window_size_change_functions (selected_frame
);
13605 unbind_to (count1
, Qnil
);
13608 if (message_cleared_p
)
13609 update_miniwindow_p
= true;
13611 must_finish
= true;
13613 /* If we don't display the current message, don't clear the
13614 message_cleared_p flag, because, if we did, we wouldn't clear
13615 the echo area in the next redisplay which doesn't preserve
13617 if (!display_last_displayed_message_p
)
13618 message_cleared_p
= false;
13620 else if (EQ (selected_window
, minibuf_window
)
13621 && (current_buffer
->clip_changed
|| window_outdated (w
))
13622 && resize_mini_window (w
, false))
13626 ptrdiff_t count1
= SPECPDL_INDEX ();
13628 record_unwind_save_match_data ();
13629 run_window_size_change_functions (selected_frame
);
13630 unbind_to (count1
, Qnil
);
13633 /* Resized active mini-window to fit the size of what it is
13634 showing if its contents might have changed. */
13635 must_finish
= true;
13637 /* If window configuration was changed, frames may have been
13638 marked garbaged. Clear them or we will experience
13639 surprises wrt scrolling. */
13640 clear_garbaged_frames ();
13643 if (windows_or_buffers_changed
&& !update_mode_lines
)
13644 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13645 only the windows's contents needs to be refreshed, or whether the
13646 mode-lines also need a refresh. */
13647 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13648 ? REDISPLAY_SOME
: 32);
13650 /* If specs for an arrow have changed, do thorough redisplay
13651 to ensure we remove any arrow that should no longer exist. */
13652 if (overlay_arrows_changed_p ())
13653 /* Apparently, this is the only case where we update other windows,
13654 without updating other mode-lines. */
13655 windows_or_buffers_changed
= 49;
13657 consider_all_windows_p
= (update_mode_lines
13658 || windows_or_buffers_changed
);
13660 #define AINC(a,i) \
13662 Lisp_Object entry = Fgethash (make_number (i), a, make_number (0)); \
13663 if (INTEGERP (entry)) \
13664 Fputhash (make_number (i), make_number (1 + XINT (entry)), a); \
13667 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13668 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13670 /* Optimize the case that only the line containing the cursor in the
13671 selected window has changed. Variables starting with this_ are
13672 set in display_line and record information about the line
13673 containing the cursor. */
13674 tlbufpos
= this_line_start_pos
;
13675 tlendpos
= this_line_end_pos
;
13676 if (!consider_all_windows_p
13677 && CHARPOS (tlbufpos
) > 0
13678 && !w
->update_mode_line
13679 && !current_buffer
->clip_changed
13680 && !current_buffer
->prevent_redisplay_optimizations_p
13681 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13682 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13683 && !XFRAME (w
->frame
)->cursor_type_changed
13684 && !XFRAME (w
->frame
)->face_change
13685 /* Make sure recorded data applies to current buffer, etc. */
13686 && this_line_buffer
== current_buffer
13689 && !w
->optional_new_start
13690 /* Point must be on the line that we have info recorded about. */
13691 && PT
>= CHARPOS (tlbufpos
)
13692 && PT
<= Z
- CHARPOS (tlendpos
)
13693 /* All text outside that line, including its final newline,
13694 must be unchanged. */
13695 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13696 CHARPOS (tlendpos
)))
13698 if (CHARPOS (tlbufpos
) > BEGV
13699 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13700 && (CHARPOS (tlbufpos
) == ZV
13701 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13702 /* Former continuation line has disappeared by becoming empty. */
13704 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13706 /* We have to handle the case of continuation around a
13707 wide-column character (see the comment in indent.c around
13710 For instance, in the following case:
13712 -------- Insert --------
13713 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13714 J_I_ ==> J_I_ `^^' are cursors.
13718 As we have to redraw the line above, we cannot use this
13722 int line_height_before
= this_line_pixel_height
;
13724 /* Note that start_display will handle the case that the
13725 line starting at tlbufpos is a continuation line. */
13726 start_display (&it
, w
, tlbufpos
);
13728 /* Implementation note: It this still necessary? */
13729 if (it
.current_x
!= this_line_start_x
)
13732 TRACE ((stderr
, "trying display optimization 1\n"));
13733 w
->cursor
.vpos
= -1;
13734 overlay_arrow_seen
= false;
13735 it
.vpos
= this_line_vpos
;
13736 it
.current_y
= this_line_y
;
13737 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13738 display_line (&it
);
13740 /* If line contains point, is not continued,
13741 and ends at same distance from eob as before, we win. */
13742 if (w
->cursor
.vpos
>= 0
13743 /* Line is not continued, otherwise this_line_start_pos
13744 would have been set to 0 in display_line. */
13745 && CHARPOS (this_line_start_pos
)
13746 /* Line ends as before. */
13747 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13748 /* Line has same height as before. Otherwise other lines
13749 would have to be shifted up or down. */
13750 && this_line_pixel_height
== line_height_before
)
13752 /* If this is not the window's last line, we must adjust
13753 the charstarts of the lines below. */
13754 if (it
.current_y
< it
.last_visible_y
)
13756 struct glyph_row
*row
13757 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13758 ptrdiff_t delta
, delta_bytes
;
13760 /* We used to distinguish between two cases here,
13761 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13762 when the line ends in a newline or the end of the
13763 buffer's accessible portion. But both cases did
13764 the same, so they were collapsed. */
13766 - CHARPOS (tlendpos
)
13767 - MATRIX_ROW_START_CHARPOS (row
));
13768 delta_bytes
= (Z_BYTE
13769 - BYTEPOS (tlendpos
)
13770 - MATRIX_ROW_START_BYTEPOS (row
));
13772 increment_matrix_positions (w
->current_matrix
,
13773 this_line_vpos
+ 1,
13774 w
->current_matrix
->nrows
,
13775 delta
, delta_bytes
);
13778 /* If this row displays text now but previously didn't,
13779 or vice versa, w->window_end_vpos may have to be
13781 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13783 if (w
->window_end_vpos
< this_line_vpos
)
13784 w
->window_end_vpos
= this_line_vpos
;
13786 else if (w
->window_end_vpos
== this_line_vpos
13787 && this_line_vpos
> 0)
13788 w
->window_end_vpos
= this_line_vpos
- 1;
13789 w
->window_end_valid
= false;
13791 /* Update hint: No need to try to scroll in update_window. */
13792 w
->desired_matrix
->no_scrolling_p
= true;
13795 *w
->desired_matrix
->method
= 0;
13796 debug_method_add (w
, "optimization 1");
13798 #ifdef HAVE_WINDOW_SYSTEM
13799 update_window_fringes (w
, false);
13806 else if (/* Cursor position hasn't changed. */
13807 PT
== w
->last_point
13808 /* Make sure the cursor was last displayed
13809 in this window. Otherwise we have to reposition it. */
13811 /* PXW: Must be converted to pixels, probably. */
13812 && 0 <= w
->cursor
.vpos
13813 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13817 do_pending_window_change (true);
13818 /* If selected_window changed, redisplay again. */
13819 if (WINDOWP (selected_window
)
13820 && (w
= XWINDOW (selected_window
)) != sw
)
13823 /* We used to always goto end_of_redisplay here, but this
13824 isn't enough if we have a blinking cursor. */
13825 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13826 goto end_of_redisplay
;
13830 /* If highlighting the region, or if the cursor is in the echo area,
13831 then we can't just move the cursor. */
13832 else if (NILP (Vshow_trailing_whitespace
)
13833 && !cursor_in_echo_area
)
13836 struct glyph_row
*row
;
13838 /* Skip from tlbufpos to PT and see where it is. Note that
13839 PT may be in invisible text. If so, we will end at the
13840 next visible position. */
13841 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13842 NULL
, DEFAULT_FACE_ID
);
13843 it
.current_x
= this_line_start_x
;
13844 it
.current_y
= this_line_y
;
13845 it
.vpos
= this_line_vpos
;
13847 /* The call to move_it_to stops in front of PT, but
13848 moves over before-strings. */
13849 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13851 if (it
.vpos
== this_line_vpos
13852 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13855 eassert (this_line_vpos
== it
.vpos
);
13856 eassert (this_line_y
== it
.current_y
);
13857 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13858 if (cursor_row_fully_visible_p (w
, false, true))
13861 *w
->desired_matrix
->method
= 0;
13862 debug_method_add (w
, "optimization 3");
13874 /* Text changed drastically or point moved off of line. */
13875 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13878 CHARPOS (this_line_start_pos
) = 0;
13879 ++clear_face_cache_count
;
13880 #ifdef HAVE_WINDOW_SYSTEM
13881 ++clear_image_cache_count
;
13884 /* Build desired matrices, and update the display. If
13885 consider_all_windows_p, do it for all windows on all frames that
13886 require redisplay, as specified by their 'redisplay' flag.
13887 Otherwise do it for selected_window, only. */
13889 if (consider_all_windows_p
)
13891 FOR_EACH_FRAME (tail
, frame
)
13892 XFRAME (frame
)->updated_p
= false;
13894 propagate_buffer_redisplay ();
13896 FOR_EACH_FRAME (tail
, frame
)
13898 struct frame
*f
= XFRAME (frame
);
13900 /* We don't have to do anything for unselected terminal
13902 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13903 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13907 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13910 /* Only GC scrollbars when we redisplay the whole frame. */
13911 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13912 bool f_redisplay_flag
= f
->redisplay
;
13913 /* Mark all the scroll bars to be removed; we'll redeem
13914 the ones we want when we redisplay their windows. */
13915 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13916 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13918 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13919 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13920 /* Remember that the invisible frames need to be redisplayed next
13921 time they're visible. */
13922 else if (!REDISPLAY_SOME_P ())
13923 f
->redisplay
= true;
13925 /* The X error handler may have deleted that frame. */
13926 if (!FRAME_LIVE_P (f
))
13929 /* Any scroll bars which redisplay_windows should have
13930 nuked should now go away. */
13931 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13932 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13934 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13936 /* If fonts changed on visible frame, display again. */
13937 if (f
->fonts_changed
)
13939 adjust_frame_glyphs (f
);
13940 /* Disable all redisplay optimizations for this
13941 frame. For the reasons, see the comment near
13942 the previous call to adjust_frame_glyphs above. */
13943 SET_FRAME_GARBAGED (f
);
13944 f
->fonts_changed
= false;
13948 /* See if we have to hscroll. */
13949 if (!f
->already_hscrolled_p
)
13951 f
->already_hscrolled_p
= true;
13952 if (hscroll_windows (f
->root_window
))
13956 /* If the frame's redisplay flag was not set before
13957 we went about redisplaying its windows, but it is
13958 set now, that means we employed some redisplay
13959 optimizations inside redisplay_windows, and
13960 bypassed producing some screen lines. But if
13961 f->redisplay is now set, it might mean the old
13962 faces are no longer valid (e.g., if redisplaying
13963 some window called some Lisp which defined a new
13964 face or redefined an existing face), so trying to
13965 use them in update_frame will segfault.
13966 Therefore, we must redisplay this frame. */
13967 if (!f_redisplay_flag
&& f
->redisplay
)
13970 /* Prevent various kinds of signals during display
13971 update. stdio is not robust about handling
13972 signals, which can cause an apparent I/O error. */
13973 if (interrupt_input
)
13974 unrequest_sigio ();
13977 pending
|= update_frame (f
, false, false);
13978 f
->cursor_type_changed
= false;
13979 f
->updated_p
= true;
13984 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13988 /* Do the mark_window_display_accurate after all windows have
13989 been redisplayed because this call resets flags in buffers
13990 which are needed for proper redisplay. */
13991 FOR_EACH_FRAME (tail
, frame
)
13993 struct frame
*f
= XFRAME (frame
);
13996 f
->redisplay
= false;
13997 mark_window_display_accurate (f
->root_window
, true);
13998 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13999 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
14004 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
14006 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
14007 /* Use list_of_error, not Qerror, so that
14008 we catch only errors and don't run the debugger. */
14009 internal_condition_case_1 (redisplay_window_1
, selected_window
,
14011 redisplay_window_error
);
14012 if (update_miniwindow_p
)
14013 internal_condition_case_1 (redisplay_window_1
,
14014 FRAME_MINIBUF_WINDOW (sf
), list_of_error
,
14015 redisplay_window_error
);
14017 /* Compare desired and current matrices, perform output. */
14020 /* If fonts changed, display again. Likewise if redisplay_window_1
14021 above caused some change (e.g., a change in faces) that requires
14022 considering the entire frame again. */
14023 if (sf
->fonts_changed
|| sf
->redisplay
)
14027 /* Set this to force a more thorough redisplay.
14028 Otherwise, we might immediately loop back to the
14029 above "else-if" clause (since all the conditions that
14030 led here might still be true), and we will then
14031 infloop, because the selected-frame's redisplay flag
14032 is not (and cannot be) reset. */
14033 windows_or_buffers_changed
= 50;
14038 /* Prevent freeing of realized faces, since desired matrices are
14039 pending that reference the faces we computed and cached. */
14040 inhibit_free_realized_faces
= true;
14042 /* Prevent various kinds of signals during display update.
14043 stdio is not robust about handling signals,
14044 which can cause an apparent I/O error. */
14045 if (interrupt_input
)
14046 unrequest_sigio ();
14049 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
14051 if (hscroll_windows (selected_window
))
14054 XWINDOW (selected_window
)->must_be_updated_p
= true;
14055 pending
= update_frame (sf
, false, false);
14056 sf
->cursor_type_changed
= false;
14059 /* We may have called echo_area_display at the top of this
14060 function. If the echo area is on another frame, that may
14061 have put text on a frame other than the selected one, so the
14062 above call to update_frame would not have caught it. Catch
14064 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
14065 struct frame
*mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
14067 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
14069 XWINDOW (mini_window
)->must_be_updated_p
= true;
14070 pending
|= update_frame (mini_frame
, false, false);
14071 mini_frame
->cursor_type_changed
= false;
14072 if (!pending
&& hscroll_windows (mini_window
))
14077 /* If display was paused because of pending input, make sure we do a
14078 thorough update the next time. */
14081 /* Prevent the optimization at the beginning of
14082 redisplay_internal that tries a single-line update of the
14083 line containing the cursor in the selected window. */
14084 CHARPOS (this_line_start_pos
) = 0;
14086 /* Let the overlay arrow be updated the next time. */
14087 update_overlay_arrows (0);
14089 /* If we pause after scrolling, some rows in the current
14090 matrices of some windows are not valid. */
14091 if (!WINDOW_FULL_WIDTH_P (w
)
14092 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
14093 update_mode_lines
= 36;
14097 if (!consider_all_windows_p
)
14099 /* This has already been done above if
14100 consider_all_windows_p is set. */
14101 if (XBUFFER (w
->contents
)->text
->redisplay
14102 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
14103 /* This can happen if b->text->redisplay was set during
14105 propagate_buffer_redisplay ();
14106 mark_window_display_accurate_1 (w
, true);
14108 /* Say overlay arrows are up to date. */
14109 update_overlay_arrows (1);
14111 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
14112 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
14115 update_mode_lines
= 0;
14116 windows_or_buffers_changed
= 0;
14119 /* Start SIGIO interrupts coming again. Having them off during the
14120 code above makes it less likely one will discard output, but not
14121 impossible, since there might be stuff in the system buffer here.
14122 But it is much hairier to try to do anything about that. */
14123 if (interrupt_input
)
14127 /* If a frame has become visible which was not before, redisplay
14128 again, so that we display it. Expose events for such a frame
14129 (which it gets when becoming visible) don't call the parts of
14130 redisplay constructing glyphs, so simply exposing a frame won't
14131 display anything in this case. So, we have to display these
14132 frames here explicitly. */
14137 FOR_EACH_FRAME (tail
, frame
)
14139 if (XFRAME (frame
)->visible
)
14143 if (new_count
!= number_of_visible_frames
)
14144 windows_or_buffers_changed
= 52;
14147 /* Change frame size now if a change is pending. */
14148 do_pending_window_change (true);
14150 /* If we just did a pending size change, or have additional
14151 visible frames, or selected_window changed, redisplay again. */
14152 if ((windows_or_buffers_changed
&& !pending
)
14153 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14156 /* Clear the face and image caches.
14158 We used to do this only if consider_all_windows_p. But the cache
14159 needs to be cleared if a timer creates images in the current
14160 buffer (e.g. the test case in Bug#6230). */
14162 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14164 clear_face_cache (false);
14165 clear_face_cache_count
= 0;
14168 #ifdef HAVE_WINDOW_SYSTEM
14169 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14171 clear_image_caches (Qnil
);
14172 clear_image_cache_count
= 0;
14174 #endif /* HAVE_WINDOW_SYSTEM */
14178 ns_set_doc_edited ();
14180 if (interrupt_input
&& interrupts_deferred
)
14183 unbind_to (count
, Qnil
);
14188 /* Redisplay, but leave alone any recent echo area message unless
14189 another message has been requested in its place.
14191 This is useful in situations where you need to redisplay but no
14192 user action has occurred, making it inappropriate for the message
14193 area to be cleared. See tracking_off and
14194 wait_reading_process_output for examples of these situations.
14196 FROM_WHERE is an integer saying from where this function was
14197 called. This is useful for debugging. */
14200 redisplay_preserve_echo_area (int from_where
)
14202 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14204 if (!NILP (echo_area_buffer
[1]))
14206 /* We have a previously displayed message, but no current
14207 message. Redisplay the previous message. */
14208 display_last_displayed_message_p
= true;
14209 redisplay_internal ();
14210 display_last_displayed_message_p
= false;
14213 redisplay_internal ();
14215 flush_frame (SELECTED_FRAME ());
14219 /* Function registered with record_unwind_protect in redisplay_internal. */
14222 unwind_redisplay (void)
14224 redisplaying_p
= false;
14228 /* Mark the display of leaf window W as accurate or inaccurate.
14229 If ACCURATE_P, mark display of W as accurate.
14230 If !ACCURATE_P, arrange for W to be redisplayed the next
14231 time redisplay_internal is called. */
14234 mark_window_display_accurate_1 (struct window
*w
, bool accurate_p
)
14236 struct buffer
*b
= XBUFFER (w
->contents
);
14238 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14239 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14240 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14244 b
->clip_changed
= false;
14245 b
->prevent_redisplay_optimizations_p
= false;
14246 eassert (buffer_window_count (b
) > 0);
14247 /* Resetting b->text->redisplay is problematic!
14248 In order to make it safer to do it here, redisplay_internal must
14249 have copied all b->text->redisplay to their respective windows. */
14250 b
->text
->redisplay
= false;
14252 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14253 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14254 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14255 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14257 w
->current_matrix
->buffer
= b
;
14258 w
->current_matrix
->begv
= BUF_BEGV (b
);
14259 w
->current_matrix
->zv
= BUF_ZV (b
);
14261 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14262 w
->last_cursor_off_p
= w
->cursor_off_p
;
14264 if (w
== XWINDOW (selected_window
))
14265 w
->last_point
= BUF_PT (b
);
14267 w
->last_point
= marker_position (w
->pointm
);
14269 w
->window_end_valid
= true;
14270 w
->update_mode_line
= false;
14273 w
->redisplay
= !accurate_p
;
14277 /* Mark the display of windows in the window tree rooted at WINDOW as
14278 accurate or inaccurate. If ACCURATE_P, mark display of
14279 windows as accurate. If !ACCURATE_P, arrange for windows to
14280 be redisplayed the next time redisplay_internal is called. */
14283 mark_window_display_accurate (Lisp_Object window
, bool accurate_p
)
14287 for (; !NILP (window
); window
= w
->next
)
14289 w
= XWINDOW (window
);
14290 if (WINDOWP (w
->contents
))
14291 mark_window_display_accurate (w
->contents
, accurate_p
);
14293 mark_window_display_accurate_1 (w
, accurate_p
);
14297 update_overlay_arrows (1);
14299 /* Force a thorough redisplay the next time by setting
14300 last_arrow_position and last_arrow_string to t, which is
14301 unequal to any useful value of Voverlay_arrow_... */
14302 update_overlay_arrows (-1);
14306 /* Return value in display table DP (Lisp_Char_Table *) for character
14307 C. Since a display table doesn't have any parent, we don't have to
14308 follow parent. Do not call this function directly but use the
14309 macro DISP_CHAR_VECTOR. */
14312 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14316 if (ASCII_CHAR_P (c
))
14319 if (SUB_CHAR_TABLE_P (val
))
14320 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14326 XSETCHAR_TABLE (table
, dp
);
14327 val
= char_table_ref (table
, c
);
14336 /***********************************************************************
14338 ***********************************************************************/
14340 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14343 redisplay_windows (Lisp_Object window
)
14345 while (!NILP (window
))
14347 struct window
*w
= XWINDOW (window
);
14349 if (WINDOWP (w
->contents
))
14350 redisplay_windows (w
->contents
);
14351 else if (BUFFERP (w
->contents
))
14353 displayed_buffer
= XBUFFER (w
->contents
);
14354 /* Use list_of_error, not Qerror, so that
14355 we catch only errors and don't run the debugger. */
14356 internal_condition_case_1 (redisplay_window_0
, window
,
14358 redisplay_window_error
);
14366 redisplay_window_error (Lisp_Object ignore
)
14368 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14373 redisplay_window_0 (Lisp_Object window
)
14375 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14376 redisplay_window (window
, false);
14381 redisplay_window_1 (Lisp_Object window
)
14383 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14384 redisplay_window (window
, true);
14389 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14390 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14391 which positions recorded in ROW differ from current buffer
14394 Return true iff cursor is on this row. */
14397 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14398 struct glyph_matrix
*matrix
,
14399 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14402 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14403 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14404 struct glyph
*cursor
= NULL
;
14405 /* The last known character position in row. */
14406 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14408 ptrdiff_t pt_old
= PT
- delta
;
14409 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14410 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14411 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14412 /* A glyph beyond the edge of TEXT_AREA which we should never
14414 struct glyph
*glyphs_end
= end
;
14415 /* True means we've found a match for cursor position, but that
14416 glyph has the avoid_cursor_p flag set. */
14417 bool match_with_avoid_cursor
= false;
14418 /* True means we've seen at least one glyph that came from a
14420 bool string_seen
= false;
14421 /* Largest and smallest buffer positions seen so far during scan of
14423 ptrdiff_t bpos_max
= pos_before
;
14424 ptrdiff_t bpos_min
= pos_after
;
14425 /* Last buffer position covered by an overlay string with an integer
14426 `cursor' property. */
14427 ptrdiff_t bpos_covered
= 0;
14428 /* True means the display string on which to display the cursor
14429 comes from a text property, not from an overlay. */
14430 bool string_from_text_prop
= false;
14432 /* Don't even try doing anything if called for a mode-line or
14433 header-line row, since the rest of the code isn't prepared to
14434 deal with such calamities. */
14435 eassert (!row
->mode_line_p
);
14436 if (row
->mode_line_p
)
14439 /* Skip over glyphs not having an object at the start and the end of
14440 the row. These are special glyphs like truncation marks on
14441 terminal frames. */
14442 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14444 if (!row
->reversed_p
)
14447 && NILP (glyph
->object
)
14448 && glyph
->charpos
< 0)
14450 x
+= glyph
->pixel_width
;
14454 && NILP ((end
- 1)->object
)
14455 /* CHARPOS is zero for blanks and stretch glyphs
14456 inserted by extend_face_to_end_of_line. */
14457 && (end
- 1)->charpos
<= 0)
14459 glyph_before
= glyph
- 1;
14466 /* If the glyph row is reversed, we need to process it from back
14467 to front, so swap the edge pointers. */
14468 glyphs_end
= end
= glyph
- 1;
14469 glyph
+= row
->used
[TEXT_AREA
] - 1;
14471 while (glyph
> end
+ 1
14472 && NILP (glyph
->object
)
14473 && glyph
->charpos
< 0)
14476 x
-= glyph
->pixel_width
;
14478 if (NILP (glyph
->object
) && glyph
->charpos
< 0)
14480 /* By default, in reversed rows we put the cursor on the
14481 rightmost (first in the reading order) glyph. */
14482 for (g
= end
+ 1; g
< glyph
; g
++)
14483 x
+= g
->pixel_width
;
14485 && NILP ((end
+ 1)->object
)
14486 && (end
+ 1)->charpos
<= 0)
14488 glyph_before
= glyph
+ 1;
14492 else if (row
->reversed_p
)
14494 /* In R2L rows that don't display text, put the cursor on the
14495 rightmost glyph. Case in point: an empty last line that is
14496 part of an R2L paragraph. */
14498 /* Avoid placing the cursor on the last glyph of the row, where
14499 on terminal frames we hold the vertical border between
14500 adjacent windows. */
14501 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14502 && !WINDOW_RIGHTMOST_P (w
)
14503 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14505 x
= -1; /* will be computed below, at label compute_x */
14508 /* Step 1: Try to find the glyph whose character position
14509 corresponds to point. If that's not possible, find 2 glyphs
14510 whose character positions are the closest to point, one before
14511 point, the other after it. */
14512 if (!row
->reversed_p
)
14513 while (/* not marched to end of glyph row */
14515 /* glyph was not inserted by redisplay for internal purposes */
14516 && !NILP (glyph
->object
))
14518 if (BUFFERP (glyph
->object
))
14520 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14522 if (glyph
->charpos
> bpos_max
)
14523 bpos_max
= glyph
->charpos
;
14524 if (glyph
->charpos
< bpos_min
)
14525 bpos_min
= glyph
->charpos
;
14526 if (!glyph
->avoid_cursor_p
)
14528 /* If we hit point, we've found the glyph on which to
14529 display the cursor. */
14532 match_with_avoid_cursor
= false;
14535 /* See if we've found a better approximation to
14536 POS_BEFORE or to POS_AFTER. */
14537 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14539 pos_before
= glyph
->charpos
;
14540 glyph_before
= glyph
;
14542 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14544 pos_after
= glyph
->charpos
;
14545 glyph_after
= glyph
;
14548 else if (dpos
== 0)
14549 match_with_avoid_cursor
= true;
14551 else if (STRINGP (glyph
->object
))
14553 Lisp_Object chprop
;
14554 ptrdiff_t glyph_pos
= glyph
->charpos
;
14556 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14558 if (!NILP (chprop
))
14560 /* If the string came from a `display' text property,
14561 look up the buffer position of that property and
14562 use that position to update bpos_max, as if we
14563 actually saw such a position in one of the row's
14564 glyphs. This helps with supporting integer values
14565 of `cursor' property on the display string in
14566 situations where most or all of the row's buffer
14567 text is completely covered by display properties,
14568 so that no glyph with valid buffer positions is
14569 ever seen in the row. */
14570 ptrdiff_t prop_pos
=
14571 string_buffer_position_lim (glyph
->object
, pos_before
,
14574 if (prop_pos
>= pos_before
)
14575 bpos_max
= prop_pos
;
14577 if (INTEGERP (chprop
))
14579 bpos_covered
= bpos_max
+ XINT (chprop
);
14580 /* If the `cursor' property covers buffer positions up
14581 to and including point, we should display cursor on
14582 this glyph. Note that, if a `cursor' property on one
14583 of the string's characters has an integer value, we
14584 will break out of the loop below _before_ we get to
14585 the position match above. IOW, integer values of
14586 the `cursor' property override the "exact match for
14587 point" strategy of positioning the cursor. */
14588 /* Implementation note: bpos_max == pt_old when, e.g.,
14589 we are in an empty line, where bpos_max is set to
14590 MATRIX_ROW_START_CHARPOS, see above. */
14591 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14598 string_seen
= true;
14600 x
+= glyph
->pixel_width
;
14603 else if (glyph
> end
) /* row is reversed */
14604 while (!NILP (glyph
->object
))
14606 if (BUFFERP (glyph
->object
))
14608 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14610 if (glyph
->charpos
> bpos_max
)
14611 bpos_max
= glyph
->charpos
;
14612 if (glyph
->charpos
< bpos_min
)
14613 bpos_min
= glyph
->charpos
;
14614 if (!glyph
->avoid_cursor_p
)
14618 match_with_avoid_cursor
= false;
14621 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14623 pos_before
= glyph
->charpos
;
14624 glyph_before
= glyph
;
14626 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14628 pos_after
= glyph
->charpos
;
14629 glyph_after
= glyph
;
14632 else if (dpos
== 0)
14633 match_with_avoid_cursor
= true;
14635 else if (STRINGP (glyph
->object
))
14637 Lisp_Object chprop
;
14638 ptrdiff_t glyph_pos
= glyph
->charpos
;
14640 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14642 if (!NILP (chprop
))
14644 ptrdiff_t prop_pos
=
14645 string_buffer_position_lim (glyph
->object
, pos_before
,
14648 if (prop_pos
>= pos_before
)
14649 bpos_max
= prop_pos
;
14651 if (INTEGERP (chprop
))
14653 bpos_covered
= bpos_max
+ XINT (chprop
);
14654 /* If the `cursor' property covers buffer positions up
14655 to and including point, we should display cursor on
14657 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14663 string_seen
= true;
14666 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14668 x
--; /* can't use any pixel_width */
14671 x
-= glyph
->pixel_width
;
14674 /* Step 2: If we didn't find an exact match for point, we need to
14675 look for a proper place to put the cursor among glyphs between
14676 GLYPH_BEFORE and GLYPH_AFTER. */
14677 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14678 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14679 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14681 /* An empty line has a single glyph whose OBJECT is nil and
14682 whose CHARPOS is the position of a newline on that line.
14683 Note that on a TTY, there are more glyphs after that, which
14684 were produced by extend_face_to_end_of_line, but their
14685 CHARPOS is zero or negative. */
14686 bool empty_line_p
=
14687 ((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14688 && NILP (glyph
->object
) && glyph
->charpos
> 0
14689 /* On a TTY, continued and truncated rows also have a glyph at
14690 their end whose OBJECT is nil and whose CHARPOS is
14691 positive (the continuation and truncation glyphs), but such
14692 rows are obviously not "empty". */
14693 && !(row
->continued_p
|| row
->truncated_on_right_p
));
14695 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14697 ptrdiff_t ellipsis_pos
;
14699 /* Scan back over the ellipsis glyphs. */
14700 if (!row
->reversed_p
)
14702 ellipsis_pos
= (glyph
- 1)->charpos
;
14703 while (glyph
> row
->glyphs
[TEXT_AREA
]
14704 && (glyph
- 1)->charpos
== ellipsis_pos
)
14705 glyph
--, x
-= glyph
->pixel_width
;
14706 /* That loop always goes one position too far, including
14707 the glyph before the ellipsis. So scan forward over
14709 x
+= glyph
->pixel_width
;
14712 else /* row is reversed */
14714 ellipsis_pos
= (glyph
+ 1)->charpos
;
14715 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14716 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14717 glyph
++, x
+= glyph
->pixel_width
;
14718 x
-= glyph
->pixel_width
;
14722 else if (match_with_avoid_cursor
)
14724 cursor
= glyph_after
;
14727 else if (string_seen
)
14729 int incr
= row
->reversed_p
? -1 : +1;
14731 /* Need to find the glyph that came out of a string which is
14732 present at point. That glyph is somewhere between
14733 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14734 positioned between POS_BEFORE and POS_AFTER in the
14736 struct glyph
*start
, *stop
;
14737 ptrdiff_t pos
= pos_before
;
14741 /* If the row ends in a newline from a display string,
14742 reordering could have moved the glyphs belonging to the
14743 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14744 in this case we extend the search to the last glyph in
14745 the row that was not inserted by redisplay. */
14746 if (row
->ends_in_newline_from_string_p
)
14749 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14752 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14753 correspond to POS_BEFORE and POS_AFTER, respectively. We
14754 need START and STOP in the order that corresponds to the
14755 row's direction as given by its reversed_p flag. If the
14756 directionality of characters between POS_BEFORE and
14757 POS_AFTER is the opposite of the row's base direction,
14758 these characters will have been reordered for display,
14759 and we need to reverse START and STOP. */
14760 if (!row
->reversed_p
)
14762 start
= min (glyph_before
, glyph_after
);
14763 stop
= max (glyph_before
, glyph_after
);
14767 start
= max (glyph_before
, glyph_after
);
14768 stop
= min (glyph_before
, glyph_after
);
14770 for (glyph
= start
+ incr
;
14771 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14774 /* Any glyphs that come from the buffer are here because
14775 of bidi reordering. Skip them, and only pay
14776 attention to glyphs that came from some string. */
14777 if (STRINGP (glyph
->object
))
14781 /* If the display property covers the newline, we
14782 need to search for it one position farther. */
14783 ptrdiff_t lim
= pos_after
14784 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14786 string_from_text_prop
= false;
14787 str
= glyph
->object
;
14788 tem
= string_buffer_position_lim (str
, pos
, lim
, false);
14789 if (tem
== 0 /* from overlay */
14792 /* If the string from which this glyph came is
14793 found in the buffer at point, or at position
14794 that is closer to point than pos_after, then
14795 we've found the glyph we've been looking for.
14796 If it comes from an overlay (tem == 0), and
14797 it has the `cursor' property on one of its
14798 glyphs, record that glyph as a candidate for
14799 displaying the cursor. (As in the
14800 unidirectional version, we will display the
14801 cursor on the last candidate we find.) */
14804 || (tem
- pt_old
> 0 && tem
< pos_after
))
14806 /* The glyphs from this string could have
14807 been reordered. Find the one with the
14808 smallest string position. Or there could
14809 be a character in the string with the
14810 `cursor' property, which means display
14811 cursor on that character's glyph. */
14812 ptrdiff_t strpos
= glyph
->charpos
;
14817 string_from_text_prop
= true;
14820 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14821 && EQ (glyph
->object
, str
);
14825 ptrdiff_t gpos
= glyph
->charpos
;
14827 cprop
= Fget_char_property (make_number (gpos
),
14835 if (tem
&& glyph
->charpos
< strpos
)
14837 strpos
= glyph
->charpos
;
14843 || (tem
- pt_old
> 0 && tem
< pos_after
))
14847 pos
= tem
+ 1; /* don't find previous instances */
14849 /* This string is not what we want; skip all of the
14850 glyphs that came from it. */
14851 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14852 && EQ (glyph
->object
, str
))
14859 /* If we reached the end of the line, and END was from a string,
14860 the cursor is not on this line. */
14862 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14863 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14864 && STRINGP (end
->object
)
14865 && row
->continued_p
)
14868 /* A truncated row may not include PT among its character positions.
14869 Setting the cursor inside the scroll margin will trigger
14870 recalculation of hscroll in hscroll_window_tree. But if a
14871 display string covers point, defer to the string-handling
14872 code below to figure this out. */
14873 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14875 cursor
= glyph_before
;
14878 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14879 /* Zero-width characters produce no glyphs. */
14881 && (row
->reversed_p
14882 ? glyph_after
> glyphs_end
14883 : glyph_after
< glyphs_end
)))
14885 cursor
= glyph_after
;
14891 if (cursor
!= NULL
)
14893 else if (glyph
== glyphs_end
14894 && pos_before
== pos_after
14895 && STRINGP ((row
->reversed_p
14896 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14897 : row
->glyphs
[TEXT_AREA
])->object
))
14899 /* If all the glyphs of this row came from strings, put the
14900 cursor on the first glyph of the row. This avoids having the
14901 cursor outside of the text area in this very rare and hard
14905 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14906 : row
->glyphs
[TEXT_AREA
];
14912 /* Need to compute x that corresponds to GLYPH. */
14913 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14915 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14917 x
+= g
->pixel_width
;
14921 /* ROW could be part of a continued line, which, under bidi
14922 reordering, might have other rows whose start and end charpos
14923 occlude point. Only set w->cursor if we found a better
14924 approximation to the cursor position than we have from previously
14925 examined candidate rows belonging to the same continued line. */
14926 if (/* We already have a candidate row. */
14927 w
->cursor
.vpos
>= 0
14928 /* That candidate is not the row we are processing. */
14929 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14930 /* Make sure cursor.vpos specifies a row whose start and end
14931 charpos occlude point, and it is valid candidate for being a
14932 cursor-row. This is because some callers of this function
14933 leave cursor.vpos at the row where the cursor was displayed
14934 during the last redisplay cycle. */
14935 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14936 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14937 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14940 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14942 /* Don't consider glyphs that are outside TEXT_AREA. */
14943 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14945 /* Keep the candidate whose buffer position is the closest to
14946 point or has the `cursor' property. */
14947 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14948 w
->cursor
.hpos
>= 0
14949 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14950 && ((BUFFERP (g1
->object
)
14951 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14952 || (BUFFERP (glyph
->object
)
14953 && eabs (g1
->charpos
- pt_old
)
14954 < eabs (glyph
->charpos
- pt_old
))))
14955 /* Previous candidate is a glyph from a string that has
14956 a non-nil `cursor' property. */
14957 || (STRINGP (g1
->object
)
14958 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14959 Qcursor
, g1
->object
))
14960 /* Previous candidate is from the same display
14961 string as this one, and the display string
14962 came from a text property. */
14963 || (EQ (g1
->object
, glyph
->object
)
14964 && string_from_text_prop
)
14965 /* this candidate is from newline and its
14966 position is not an exact match */
14967 || (NILP (glyph
->object
)
14968 && glyph
->charpos
!= pt_old
)))))
14970 /* If this candidate gives an exact match, use that. */
14971 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14972 /* If this candidate is a glyph created for the
14973 terminating newline of a line, and point is on that
14974 newline, it wins because it's an exact match. */
14975 || (!row
->continued_p
14976 && NILP (glyph
->object
)
14977 && glyph
->charpos
== 0
14978 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14979 /* Otherwise, keep the candidate that comes from a row
14980 spanning less buffer positions. This may win when one or
14981 both candidate positions are on glyphs that came from
14982 display strings, for which we cannot compare buffer
14984 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14985 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14986 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14989 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14991 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14992 w
->cursor
.y
= row
->y
+ dy
;
14994 if (w
== XWINDOW (selected_window
))
14996 if (!row
->continued_p
14997 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15000 this_line_buffer
= XBUFFER (w
->contents
);
15002 CHARPOS (this_line_start_pos
)
15003 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
15004 BYTEPOS (this_line_start_pos
)
15005 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
15007 CHARPOS (this_line_end_pos
)
15008 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
15009 BYTEPOS (this_line_end_pos
)
15010 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
15012 this_line_y
= w
->cursor
.y
;
15013 this_line_pixel_height
= row
->height
;
15014 this_line_vpos
= w
->cursor
.vpos
;
15015 this_line_start_x
= row
->x
;
15018 CHARPOS (this_line_start_pos
) = 0;
15025 /* Run window scroll functions, if any, for WINDOW with new window
15026 start STARTP. Sets the window start of WINDOW to that position.
15028 We assume that the window's buffer is really current. */
15030 static struct text_pos
15031 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
15033 struct window
*w
= XWINDOW (window
);
15034 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
15036 eassert (current_buffer
== XBUFFER (w
->contents
));
15038 if (!NILP (Vwindow_scroll_functions
))
15040 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
15041 make_number (CHARPOS (startp
)));
15042 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15043 /* In case the hook functions switch buffers. */
15044 set_buffer_internal (XBUFFER (w
->contents
));
15051 /* Make sure the line containing the cursor is fully visible.
15052 A value of true means there is nothing to be done.
15053 (Either the line is fully visible, or it cannot be made so,
15054 or we cannot tell.)
15056 If FORCE_P, return false even if partial visible cursor row
15057 is higher than window.
15059 If CURRENT_MATRIX_P, use the information from the
15060 window's current glyph matrix; otherwise use the desired glyph
15063 A value of false means the caller should do scrolling
15064 as if point had gone off the screen. */
15067 cursor_row_fully_visible_p (struct window
*w
, bool force_p
,
15068 bool current_matrix_p
)
15070 struct glyph_matrix
*matrix
;
15071 struct glyph_row
*row
;
15074 if (!make_cursor_line_fully_visible_p
)
15077 /* It's not always possible to find the cursor, e.g, when a window
15078 is full of overlay strings. Don't do anything in that case. */
15079 if (w
->cursor
.vpos
< 0)
15082 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
15083 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
15085 /* If the cursor row is not partially visible, there's nothing to do. */
15086 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
15089 /* If the row the cursor is in is taller than the window's height,
15090 it's not clear what to do, so do nothing. */
15091 window_height
= window_box_height (w
);
15092 if (row
->height
>= window_height
)
15094 if (!force_p
|| MINI_WINDOW_P (w
)
15095 || w
->vscroll
|| w
->cursor
.vpos
== 0)
15102 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
15103 means only WINDOW is redisplayed in redisplay_internal.
15104 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
15105 in redisplay_window to bring a partially visible line into view in
15106 the case that only the cursor has moved.
15108 LAST_LINE_MISFIT should be true if we're scrolling because the
15109 last screen line's vertical height extends past the end of the screen.
15113 1 if scrolling succeeded
15115 0 if scrolling didn't find point.
15117 -1 if new fonts have been loaded so that we must interrupt
15118 redisplay, adjust glyph matrices, and try again. */
15124 SCROLLING_NEED_LARGER_MATRICES
15127 /* If scroll-conservatively is more than this, never recenter.
15129 If you change this, don't forget to update the doc string of
15130 `scroll-conservatively' and the Emacs manual. */
15131 #define SCROLL_LIMIT 100
15134 try_scrolling (Lisp_Object window
, bool just_this_one_p
,
15135 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
15136 bool temp_scroll_step
, bool last_line_misfit
)
15138 struct window
*w
= XWINDOW (window
);
15139 struct frame
*f
= XFRAME (w
->frame
);
15140 struct text_pos pos
, startp
;
15142 int this_scroll_margin
, scroll_max
, rc
, height
;
15143 int dy
= 0, amount_to_scroll
= 0;
15144 bool scroll_down_p
= false;
15145 int extra_scroll_margin_lines
= last_line_misfit
;
15146 Lisp_Object aggressive
;
15147 /* We will never try scrolling more than this number of lines. */
15148 int scroll_limit
= SCROLL_LIMIT
;
15149 int frame_line_height
= default_line_pixel_height (w
);
15150 int window_total_lines
15151 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15154 debug_method_add (w
, "try_scrolling");
15157 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15159 /* Compute scroll margin height in pixels. We scroll when point is
15160 within this distance from the top or bottom of the window. */
15161 if (scroll_margin
> 0)
15162 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15163 * frame_line_height
;
15165 this_scroll_margin
= 0;
15167 /* Force arg_scroll_conservatively to have a reasonable value, to
15168 avoid scrolling too far away with slow move_it_* functions. Note
15169 that the user can supply scroll-conservatively equal to
15170 `most-positive-fixnum', which can be larger than INT_MAX. */
15171 if (arg_scroll_conservatively
> scroll_limit
)
15173 arg_scroll_conservatively
= scroll_limit
+ 1;
15174 scroll_max
= scroll_limit
* frame_line_height
;
15176 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15177 /* Compute how much we should try to scroll maximally to bring
15178 point into view. */
15179 scroll_max
= (max (scroll_step
,
15180 max (arg_scroll_conservatively
, temp_scroll_step
))
15181 * frame_line_height
);
15182 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15183 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15184 /* We're trying to scroll because of aggressive scrolling but no
15185 scroll_step is set. Choose an arbitrary one. */
15186 scroll_max
= 10 * frame_line_height
;
15192 /* Decide whether to scroll down. */
15193 if (PT
> CHARPOS (startp
))
15195 int scroll_margin_y
;
15197 /* Compute the pixel ypos of the scroll margin, then move IT to
15198 either that ypos or PT, whichever comes first. */
15199 start_display (&it
, w
, startp
);
15200 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15201 - frame_line_height
* extra_scroll_margin_lines
;
15202 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15203 (MOVE_TO_POS
| MOVE_TO_Y
));
15205 if (PT
> CHARPOS (it
.current
.pos
))
15207 int y0
= line_bottom_y (&it
);
15208 /* Compute how many pixels below window bottom to stop searching
15209 for PT. This avoids costly search for PT that is far away if
15210 the user limited scrolling by a small number of lines, but
15211 always finds PT if scroll_conservatively is set to a large
15212 number, such as most-positive-fixnum. */
15213 int slack
= max (scroll_max
, 10 * frame_line_height
);
15214 int y_to_move
= it
.last_visible_y
+ slack
;
15216 /* Compute the distance from the scroll margin to PT or to
15217 the scroll limit, whichever comes first. This should
15218 include the height of the cursor line, to make that line
15220 move_it_to (&it
, PT
, -1, y_to_move
,
15221 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15222 dy
= line_bottom_y (&it
) - y0
;
15224 if (dy
> scroll_max
)
15225 return SCROLLING_FAILED
;
15228 scroll_down_p
= true;
15234 /* Point is in or below the bottom scroll margin, so move the
15235 window start down. If scrolling conservatively, move it just
15236 enough down to make point visible. If scroll_step is set,
15237 move it down by scroll_step. */
15238 if (arg_scroll_conservatively
)
15240 = min (max (dy
, frame_line_height
),
15241 frame_line_height
* arg_scroll_conservatively
);
15242 else if (scroll_step
|| temp_scroll_step
)
15243 amount_to_scroll
= scroll_max
;
15246 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15247 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15248 if (NUMBERP (aggressive
))
15250 double float_amount
= XFLOATINT (aggressive
) * height
;
15251 int aggressive_scroll
= float_amount
;
15252 if (aggressive_scroll
== 0 && float_amount
> 0)
15253 aggressive_scroll
= 1;
15254 /* Don't let point enter the scroll margin near top of
15255 the window. This could happen if the value of
15256 scroll_up_aggressively is too large and there are
15257 non-zero margins, because scroll_up_aggressively
15258 means put point that fraction of window height
15259 _from_the_bottom_margin_. */
15260 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15261 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15262 amount_to_scroll
= dy
+ aggressive_scroll
;
15266 if (amount_to_scroll
<= 0)
15267 return SCROLLING_FAILED
;
15269 start_display (&it
, w
, startp
);
15270 if (arg_scroll_conservatively
<= scroll_limit
)
15271 move_it_vertically (&it
, amount_to_scroll
);
15274 /* Extra precision for users who set scroll-conservatively
15275 to a large number: make sure the amount we scroll
15276 the window start is never less than amount_to_scroll,
15277 which was computed as distance from window bottom to
15278 point. This matters when lines at window top and lines
15279 below window bottom have different height. */
15281 void *it1data
= NULL
;
15282 /* We use a temporary it1 because line_bottom_y can modify
15283 its argument, if it moves one line down; see there. */
15286 SAVE_IT (it1
, it
, it1data
);
15287 start_y
= line_bottom_y (&it1
);
15289 RESTORE_IT (&it
, &it
, it1data
);
15290 move_it_by_lines (&it
, 1);
15291 SAVE_IT (it1
, it
, it1data
);
15292 } while (IT_CHARPOS (it
) < ZV
15293 && line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15294 bidi_unshelve_cache (it1data
, true);
15297 /* If STARTP is unchanged, move it down another screen line. */
15298 if (IT_CHARPOS (it
) == CHARPOS (startp
))
15299 move_it_by_lines (&it
, 1);
15300 startp
= it
.current
.pos
;
15304 struct text_pos scroll_margin_pos
= startp
;
15307 /* See if point is inside the scroll margin at the top of the
15309 if (this_scroll_margin
)
15313 start_display (&it
, w
, startp
);
15314 y_start
= it
.current_y
;
15315 move_it_vertically (&it
, this_scroll_margin
);
15316 scroll_margin_pos
= it
.current
.pos
;
15317 /* If we didn't move enough before hitting ZV, request
15318 additional amount of scroll, to move point out of the
15320 if (IT_CHARPOS (it
) == ZV
15321 && it
.current_y
- y_start
< this_scroll_margin
)
15322 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15325 if (PT
< CHARPOS (scroll_margin_pos
))
15327 /* Point is in the scroll margin at the top of the window or
15328 above what is displayed in the window. */
15331 /* Compute the vertical distance from PT to the scroll
15332 margin position. Move as far as scroll_max allows, or
15333 one screenful, or 10 screen lines, whichever is largest.
15334 Give up if distance is greater than scroll_max or if we
15335 didn't reach the scroll margin position. */
15336 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15337 start_display (&it
, w
, pos
);
15339 y_to_move
= max (it
.last_visible_y
,
15340 max (scroll_max
, 10 * frame_line_height
));
15341 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15343 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15344 dy
= it
.current_y
- y0
;
15345 if (dy
> scroll_max
15346 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15347 return SCROLLING_FAILED
;
15349 /* Additional scroll for when ZV was too close to point. */
15352 /* Compute new window start. */
15353 start_display (&it
, w
, startp
);
15355 if (arg_scroll_conservatively
)
15356 amount_to_scroll
= max (dy
, frame_line_height
15357 * max (scroll_step
, temp_scroll_step
));
15358 else if (scroll_step
|| temp_scroll_step
)
15359 amount_to_scroll
= scroll_max
;
15362 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15363 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15364 if (NUMBERP (aggressive
))
15366 double float_amount
= XFLOATINT (aggressive
) * height
;
15367 int aggressive_scroll
= float_amount
;
15368 if (aggressive_scroll
== 0 && float_amount
> 0)
15369 aggressive_scroll
= 1;
15370 /* Don't let point enter the scroll margin near
15371 bottom of the window, if the value of
15372 scroll_down_aggressively happens to be too
15374 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15375 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15376 amount_to_scroll
= dy
+ aggressive_scroll
;
15380 if (amount_to_scroll
<= 0)
15381 return SCROLLING_FAILED
;
15383 move_it_vertically_backward (&it
, amount_to_scroll
);
15384 startp
= it
.current
.pos
;
15388 /* Run window scroll functions. */
15389 startp
= run_window_scroll_functions (window
, startp
);
15391 /* Display the window. Give up if new fonts are loaded, or if point
15393 if (!try_window (window
, startp
, 0))
15394 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15395 else if (w
->cursor
.vpos
< 0)
15397 clear_glyph_matrix (w
->desired_matrix
);
15398 rc
= SCROLLING_FAILED
;
15402 /* Maybe forget recorded base line for line number display. */
15403 if (!just_this_one_p
15404 || current_buffer
->clip_changed
15405 || BEG_UNCHANGED
< CHARPOS (startp
))
15406 w
->base_line_number
= 0;
15408 /* If cursor ends up on a partially visible line,
15409 treat that as being off the bottom of the screen. */
15410 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1,
15412 /* It's possible that the cursor is on the first line of the
15413 buffer, which is partially obscured due to a vscroll
15414 (Bug#7537). In that case, avoid looping forever. */
15415 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15417 clear_glyph_matrix (w
->desired_matrix
);
15418 ++extra_scroll_margin_lines
;
15421 rc
= SCROLLING_SUCCESS
;
15428 /* Compute a suitable window start for window W if display of W starts
15429 on a continuation line. Value is true if a new window start
15432 The new window start will be computed, based on W's width, starting
15433 from the start of the continued line. It is the start of the
15434 screen line with the minimum distance from the old start W->start. */
15437 compute_window_start_on_continuation_line (struct window
*w
)
15439 struct text_pos pos
, start_pos
;
15440 bool window_start_changed_p
= false;
15442 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15444 /* If window start is on a continuation line... Window start may be
15445 < BEGV in case there's invisible text at the start of the
15446 buffer (M-x rmail, for example). */
15447 if (CHARPOS (start_pos
) > BEGV
15448 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15451 struct glyph_row
*row
;
15453 /* Handle the case that the window start is out of range. */
15454 if (CHARPOS (start_pos
) < BEGV
)
15455 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15456 else if (CHARPOS (start_pos
) > ZV
)
15457 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15459 /* Find the start of the continued line. This should be fast
15460 because find_newline is fast (newline cache). */
15461 row
= w
->desired_matrix
->rows
+ WINDOW_WANTS_HEADER_LINE_P (w
);
15462 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15463 row
, DEFAULT_FACE_ID
);
15464 reseat_at_previous_visible_line_start (&it
);
15466 /* If the line start is "too far" away from the window start,
15467 say it takes too much time to compute a new window start. */
15468 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15469 /* PXW: Do we need upper bounds here? */
15470 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15472 int min_distance
, distance
;
15474 /* Move forward by display lines to find the new window
15475 start. If window width was enlarged, the new start can
15476 be expected to be > the old start. If window width was
15477 decreased, the new window start will be < the old start.
15478 So, we're looking for the display line start with the
15479 minimum distance from the old window start. */
15480 pos
= it
.current
.pos
;
15481 min_distance
= INFINITY
;
15482 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15483 distance
< min_distance
)
15485 min_distance
= distance
;
15486 pos
= it
.current
.pos
;
15487 if (it
.line_wrap
== WORD_WRAP
)
15489 /* Under WORD_WRAP, move_it_by_lines is likely to
15490 overshoot and stop not at the first, but the
15491 second character from the left margin. So in
15492 that case, we need a more tight control on the X
15493 coordinate of the iterator than move_it_by_lines
15494 promises in its contract. The method is to first
15495 go to the last (rightmost) visible character of a
15496 line, then move to the leftmost character on the
15497 next line in a separate call. */
15498 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15499 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15500 move_it_to (&it
, ZV
, 0,
15501 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15502 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15505 move_it_by_lines (&it
, 1);
15508 /* Set the window start there. */
15509 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15510 window_start_changed_p
= true;
15514 return window_start_changed_p
;
15518 /* Try cursor movement in case text has not changed in window WINDOW,
15519 with window start STARTP. Value is
15521 CURSOR_MOVEMENT_SUCCESS if successful
15523 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15525 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15526 display. *SCROLL_STEP is set to true, under certain circumstances, if
15527 we want to scroll as if scroll-step were set to 1. See the code.
15529 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15530 which case we have to abort this redisplay, and adjust matrices
15535 CURSOR_MOVEMENT_SUCCESS
,
15536 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15537 CURSOR_MOVEMENT_MUST_SCROLL
,
15538 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15542 try_cursor_movement (Lisp_Object window
, struct text_pos startp
,
15545 struct window
*w
= XWINDOW (window
);
15546 struct frame
*f
= XFRAME (w
->frame
);
15547 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15550 if (inhibit_try_cursor_movement
)
15554 /* Previously, there was a check for Lisp integer in the
15555 if-statement below. Now, this field is converted to
15556 ptrdiff_t, thus zero means invalid position in a buffer. */
15557 eassert (w
->last_point
> 0);
15558 /* Likewise there was a check whether window_end_vpos is nil or larger
15559 than the window. Now window_end_vpos is int and so never nil, but
15560 let's leave eassert to check whether it fits in the window. */
15561 eassert (!w
->window_end_valid
15562 || w
->window_end_vpos
< w
->current_matrix
->nrows
);
15564 /* Handle case where text has not changed, only point, and it has
15565 not moved off the frame. */
15566 if (/* Point may be in this window. */
15567 PT
>= CHARPOS (startp
)
15568 /* Selective display hasn't changed. */
15569 && !current_buffer
->clip_changed
15570 /* Function force-mode-line-update is used to force a thorough
15571 redisplay. It sets either windows_or_buffers_changed or
15572 update_mode_lines. So don't take a shortcut here for these
15574 && !update_mode_lines
15575 && !windows_or_buffers_changed
15576 && !f
->cursor_type_changed
15577 && NILP (Vshow_trailing_whitespace
)
15578 /* This code is not used for mini-buffer for the sake of the case
15579 of redisplaying to replace an echo area message; since in
15580 that case the mini-buffer contents per se are usually
15581 unchanged. This code is of no real use in the mini-buffer
15582 since the handling of this_line_start_pos, etc., in redisplay
15583 handles the same cases. */
15584 && !EQ (window
, minibuf_window
)
15585 && (FRAME_WINDOW_P (f
)
15586 || !overlay_arrow_in_current_buffer_p ()))
15588 int this_scroll_margin
, top_scroll_margin
;
15589 struct glyph_row
*row
= NULL
;
15590 int frame_line_height
= default_line_pixel_height (w
);
15591 int window_total_lines
15592 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15595 debug_method_add (w
, "cursor movement");
15598 /* Scroll if point within this distance from the top or bottom
15599 of the window. This is a pixel value. */
15600 if (scroll_margin
> 0)
15602 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15603 this_scroll_margin
*= frame_line_height
;
15606 this_scroll_margin
= 0;
15608 top_scroll_margin
= this_scroll_margin
;
15609 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15610 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15612 /* Start with the row the cursor was displayed during the last
15613 not paused redisplay. Give up if that row is not valid. */
15614 if (w
->last_cursor_vpos
< 0
15615 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15616 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15619 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15620 if (row
->mode_line_p
)
15622 if (!row
->enabled_p
)
15623 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15626 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15628 bool scroll_p
= false, must_scroll
= false;
15629 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15631 if (PT
> w
->last_point
)
15633 /* Point has moved forward. */
15634 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15635 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15637 eassert (row
->enabled_p
);
15641 /* If the end position of a row equals the start
15642 position of the next row, and PT is at that position,
15643 we would rather display cursor in the next line. */
15644 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15645 && MATRIX_ROW_END_CHARPOS (row
) == PT
15646 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15647 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15648 && !cursor_row_p (row
))
15651 /* If within the scroll margin, scroll. Note that
15652 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15653 the next line would be drawn, and that
15654 this_scroll_margin can be zero. */
15655 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15656 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15657 /* Line is completely visible last line in window
15658 and PT is to be set in the next line. */
15659 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15660 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15661 && !row
->ends_at_zv_p
15662 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15665 else if (PT
< w
->last_point
)
15667 /* Cursor has to be moved backward. Note that PT >=
15668 CHARPOS (startp) because of the outer if-statement. */
15669 while (!row
->mode_line_p
15670 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15671 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15672 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15673 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15674 row
> w
->current_matrix
->rows
15675 && (row
-1)->ends_in_newline_from_string_p
))))
15676 && (row
->y
> top_scroll_margin
15677 || CHARPOS (startp
) == BEGV
))
15679 eassert (row
->enabled_p
);
15683 /* Consider the following case: Window starts at BEGV,
15684 there is invisible, intangible text at BEGV, so that
15685 display starts at some point START > BEGV. It can
15686 happen that we are called with PT somewhere between
15687 BEGV and START. Try to handle that case. */
15688 if (row
< w
->current_matrix
->rows
15689 || row
->mode_line_p
)
15691 row
= w
->current_matrix
->rows
;
15692 if (row
->mode_line_p
)
15696 /* Due to newlines in overlay strings, we may have to
15697 skip forward over overlay strings. */
15698 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15699 && MATRIX_ROW_END_CHARPOS (row
) == PT
15700 && !cursor_row_p (row
))
15703 /* If within the scroll margin, scroll. */
15704 if (row
->y
< top_scroll_margin
15705 && CHARPOS (startp
) != BEGV
)
15710 /* Cursor did not move. So don't scroll even if cursor line
15711 is partially visible, as it was so before. */
15712 rc
= CURSOR_MOVEMENT_SUCCESS
;
15715 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15716 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15718 /* if PT is not in the glyph row, give up. */
15719 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15720 must_scroll
= true;
15722 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15723 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15725 struct glyph_row
*row1
;
15727 /* If rows are bidi-reordered and point moved, back up
15728 until we find a row that does not belong to a
15729 continuation line. This is because we must consider
15730 all rows of a continued line as candidates for the
15731 new cursor positioning, since row start and end
15732 positions change non-linearly with vertical position
15734 /* FIXME: Revisit this when glyph ``spilling'' in
15735 continuation lines' rows is implemented for
15736 bidi-reordered rows. */
15737 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15738 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15741 /* If we hit the beginning of the displayed portion
15742 without finding the first row of a continued
15746 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15749 eassert (row
->enabled_p
);
15754 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15755 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15756 /* Make sure this isn't a header line by any chance, since
15757 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield true. */
15758 && !row
->mode_line_p
15759 && make_cursor_line_fully_visible_p
)
15761 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15762 && !row
->ends_at_zv_p
15763 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15764 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15765 else if (row
->height
> window_box_height (w
))
15767 /* If we end up in a partially visible line, let's
15768 make it fully visible, except when it's taller
15769 than the window, in which case we can't do much
15771 *scroll_step
= true;
15772 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15776 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15777 if (!cursor_row_fully_visible_p (w
, false, true))
15778 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15780 rc
= CURSOR_MOVEMENT_SUCCESS
;
15784 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15785 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15786 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15788 /* With bidi-reordered rows, there could be more than
15789 one candidate row whose start and end positions
15790 occlude point. We need to let set_cursor_from_row
15791 find the best candidate. */
15792 /* FIXME: Revisit this when glyph ``spilling'' in
15793 continuation lines' rows is implemented for
15794 bidi-reordered rows. */
15799 bool at_zv_p
= false, exact_match_p
= false;
15801 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15802 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15803 && cursor_row_p (row
))
15804 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15806 /* As soon as we've found the exact match for point,
15807 or the first suitable row whose ends_at_zv_p flag
15808 is set, we are done. */
15811 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15812 w
->cursor
.vpos
)->ends_at_zv_p
;
15814 && w
->cursor
.hpos
>= 0
15815 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15818 struct glyph_row
*candidate
=
15819 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15821 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15822 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15825 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15826 || (NILP (g
->object
)
15827 && (g
->charpos
== PT
15828 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15830 if (at_zv_p
|| exact_match_p
)
15832 rc
= CURSOR_MOVEMENT_SUCCESS
;
15836 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15840 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15841 || row
->continued_p
)
15842 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15843 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15844 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15845 /* If we didn't find any candidate rows, or exited the
15846 loop before all the candidates were examined, signal
15847 to the caller that this method failed. */
15848 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15850 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15851 && !row
->continued_p
))
15852 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15854 rc
= CURSOR_MOVEMENT_SUCCESS
;
15860 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15862 rc
= CURSOR_MOVEMENT_SUCCESS
;
15867 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15868 && MATRIX_ROW_START_CHARPOS (row
) == PT
15869 && cursor_row_p (row
));
15879 set_vertical_scroll_bar (struct window
*w
)
15881 ptrdiff_t start
, end
, whole
;
15883 /* Calculate the start and end positions for the current window.
15884 At some point, it would be nice to choose between scrollbars
15885 which reflect the whole buffer size, with special markers
15886 indicating narrowing, and scrollbars which reflect only the
15889 Note that mini-buffers sometimes aren't displaying any text. */
15890 if (!MINI_WINDOW_P (w
)
15891 || (w
== XWINDOW (minibuf_window
)
15892 && NILP (echo_area_buffer
[0])))
15894 struct buffer
*buf
= XBUFFER (w
->contents
);
15895 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15896 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15897 /* I don't think this is guaranteed to be right. For the
15898 moment, we'll pretend it is. */
15899 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15903 if (whole
< (end
- start
))
15904 whole
= end
- start
;
15907 start
= end
= whole
= 0;
15909 /* Indicate what this scroll bar ought to be displaying now. */
15910 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15911 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15912 (w
, end
- start
, whole
, start
);
15917 set_horizontal_scroll_bar (struct window
*w
)
15919 int start
, end
, whole
, portion
;
15921 if (!MINI_WINDOW_P (w
)
15922 || (w
== XWINDOW (minibuf_window
)
15923 && NILP (echo_area_buffer
[0])))
15925 struct buffer
*b
= XBUFFER (w
->contents
);
15926 struct buffer
*old_buffer
= NULL
;
15928 struct text_pos startp
;
15930 if (b
!= current_buffer
)
15932 old_buffer
= current_buffer
;
15933 set_buffer_internal (b
);
15936 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15937 start_display (&it
, w
, startp
);
15938 it
.last_visible_x
= INT_MAX
;
15939 whole
= move_it_to (&it
, -1, INT_MAX
, window_box_height (w
), -1,
15940 MOVE_TO_X
| MOVE_TO_Y
);
15941 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
15942 window_box_height (w), -1,
15943 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
15945 start
= w
->hscroll
* FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
));
15946 end
= start
+ window_box_width (w
, TEXT_AREA
);
15947 portion
= end
- start
;
15948 /* After enlarging a horizontally scrolled window such that it
15949 gets at least as wide as the text it contains, make sure that
15950 the thumb doesn't fill the entire scroll bar so we can still
15951 drag it back to see the entire text. */
15952 whole
= max (whole
, end
);
15958 pdir
= Fcurrent_bidi_paragraph_direction (Qnil
);
15959 if (EQ (pdir
, Qright_to_left
))
15961 start
= whole
- end
;
15962 end
= start
+ portion
;
15967 set_buffer_internal (old_buffer
);
15970 start
= end
= whole
= portion
= 0;
15972 w
->hscroll_whole
= whole
;
15974 /* Indicate what this scroll bar ought to be displaying now. */
15975 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15976 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15977 (w
, portion
, whole
, start
);
15981 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P means only
15982 selected_window is redisplayed.
15984 We can return without actually redisplaying the window if fonts has been
15985 changed on window's frame. In that case, redisplay_internal will retry.
15987 As one of the important parts of redisplaying a window, we need to
15988 decide whether the previous window-start position (stored in the
15989 window's w->start marker position) is still valid, and if it isn't,
15990 recompute it. Some details about that:
15992 . The previous window-start could be in a continuation line, in
15993 which case we need to recompute it when the window width
15994 changes. See compute_window_start_on_continuation_line and its
15997 . The text that changed since last redisplay could include the
15998 previous window-start position. In that case, we try to salvage
15999 what we can from the current glyph matrix by calling
16000 try_scrolling, which see.
16002 . Some Emacs command could force us to use a specific window-start
16003 position by setting the window's force_start flag, or gently
16004 propose doing that by setting the window's optional_new_start
16005 flag. In these cases, we try using the specified start point if
16006 that succeeds (i.e. the window desired matrix is successfully
16007 recomputed, and point location is within the window). In case
16008 of optional_new_start, we first check if the specified start
16009 position is feasible, i.e. if it will allow point to be
16010 displayed in the window. If using the specified start point
16011 fails, e.g., if new fonts are needed to be loaded, we abort the
16012 redisplay cycle and leave it up to the next cycle to figure out
16015 . Note that the window's force_start flag is sometimes set by
16016 redisplay itself, when it decides that the previous window start
16017 point is fine and should be kept. Search for "goto force_start"
16018 below to see the details. Like the values of window-start
16019 specified outside of redisplay, these internally-deduced values
16020 are tested for feasibility, and ignored if found to be
16023 . Note that the function try_window, used to completely redisplay
16024 a window, accepts the window's start point as its argument.
16025 This is used several times in the redisplay code to control
16026 where the window start will be, according to user options such
16027 as scroll-conservatively, and also to ensure the screen line
16028 showing point will be fully (as opposed to partially) visible on
16032 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
16034 struct window
*w
= XWINDOW (window
);
16035 struct frame
*f
= XFRAME (w
->frame
);
16036 struct buffer
*buffer
= XBUFFER (w
->contents
);
16037 struct buffer
*old
= current_buffer
;
16038 struct text_pos lpoint
, opoint
, startp
;
16039 bool update_mode_line
;
16042 /* Record it now because it's overwritten. */
16043 bool current_matrix_up_to_date_p
= false;
16044 bool used_current_matrix_p
= false;
16045 /* This is less strict than current_matrix_up_to_date_p.
16046 It indicates that the buffer contents and narrowing are unchanged. */
16047 bool buffer_unchanged_p
= false;
16048 bool temp_scroll_step
= false;
16049 ptrdiff_t count
= SPECPDL_INDEX ();
16051 int centering_position
= -1;
16052 bool last_line_misfit
= false;
16053 ptrdiff_t beg_unchanged
, end_unchanged
;
16054 int frame_line_height
;
16055 bool use_desired_matrix
;
16057 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16061 *w
->desired_matrix
->method
= 0;
16064 if (!just_this_one_p
16065 && REDISPLAY_SOME_P ()
16067 && !w
->update_mode_line
16070 && !buffer
->text
->redisplay
16071 && BUF_PT (buffer
) == w
->last_point
)
16074 /* Make sure that both W's markers are valid. */
16075 eassert (XMARKER (w
->start
)->buffer
== buffer
);
16076 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
16078 /* We come here again if we need to run window-text-change-functions
16081 reconsider_clip_changes (w
);
16082 frame_line_height
= default_line_pixel_height (w
);
16084 /* Has the mode line to be updated? */
16085 update_mode_line
= (w
->update_mode_line
16086 || update_mode_lines
16087 || buffer
->clip_changed
16088 || buffer
->prevent_redisplay_optimizations_p
);
16090 if (!just_this_one_p
)
16091 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
16092 cleverly elsewhere. */
16093 w
->must_be_updated_p
= true;
16095 if (MINI_WINDOW_P (w
))
16097 if (w
== XWINDOW (echo_area_window
)
16098 && !NILP (echo_area_buffer
[0]))
16100 if (update_mode_line
)
16101 /* We may have to update a tty frame's menu bar or a
16102 tool-bar. Example `M-x C-h C-h C-g'. */
16103 goto finish_menu_bars
;
16105 /* We've already displayed the echo area glyphs in this window. */
16106 goto finish_scroll_bars
;
16108 else if ((w
!= XWINDOW (minibuf_window
)
16109 || minibuf_level
== 0)
16110 /* When buffer is nonempty, redisplay window normally. */
16111 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
16112 /* Quail displays non-mini buffers in minibuffer window.
16113 In that case, redisplay the window normally. */
16114 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
16116 /* W is a mini-buffer window, but it's not active, so clear
16118 int yb
= window_text_bottom_y (w
);
16119 struct glyph_row
*row
;
16122 for (y
= 0, row
= w
->desired_matrix
->rows
;
16124 y
+= row
->height
, ++row
)
16125 blank_row (w
, row
, y
);
16126 goto finish_scroll_bars
;
16129 clear_glyph_matrix (w
->desired_matrix
);
16132 /* Otherwise set up data on this window; select its buffer and point
16134 /* Really select the buffer, for the sake of buffer-local
16136 set_buffer_internal_1 (XBUFFER (w
->contents
));
16138 current_matrix_up_to_date_p
16139 = (w
->window_end_valid
16140 && !current_buffer
->clip_changed
16141 && !current_buffer
->prevent_redisplay_optimizations_p
16142 && !window_outdated (w
));
16144 /* Run the window-text-change-functions
16145 if it is possible that the text on the screen has changed
16146 (either due to modification of the text, or any other reason). */
16147 if (!current_matrix_up_to_date_p
16148 && !NILP (Vwindow_text_change_functions
))
16150 safe_run_hooks (Qwindow_text_change_functions
);
16154 beg_unchanged
= BEG_UNCHANGED
;
16155 end_unchanged
= END_UNCHANGED
;
16157 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
16159 specbind (Qinhibit_point_motion_hooks
, Qt
);
16162 = (w
->window_end_valid
16163 && !current_buffer
->clip_changed
16164 && !window_outdated (w
));
16166 /* When windows_or_buffers_changed is non-zero, we can't rely
16167 on the window end being valid, so set it to zero there. */
16168 if (windows_or_buffers_changed
)
16170 /* If window starts on a continuation line, maybe adjust the
16171 window start in case the window's width changed. */
16172 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16173 compute_window_start_on_continuation_line (w
);
16175 w
->window_end_valid
= false;
16176 /* If so, we also can't rely on current matrix
16177 and should not fool try_cursor_movement below. */
16178 current_matrix_up_to_date_p
= false;
16181 /* Some sanity checks. */
16182 CHECK_WINDOW_END (w
);
16183 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16185 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16188 if (mode_line_update_needed (w
))
16189 update_mode_line
= true;
16191 /* Point refers normally to the selected window. For any other
16192 window, set up appropriate value. */
16193 if (!EQ (window
, selected_window
))
16195 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16196 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16201 new_pt_byte
= BEGV_BYTE
;
16202 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16204 else if (new_pt
> (ZV
- 1))
16207 new_pt_byte
= ZV_BYTE
;
16208 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16211 /* We don't use SET_PT so that the point-motion hooks don't run. */
16212 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16215 /* If any of the character widths specified in the display table
16216 have changed, invalidate the width run cache. It's true that
16217 this may be a bit late to catch such changes, but the rest of
16218 redisplay goes (non-fatally) haywire when the display table is
16219 changed, so why should we worry about doing any better? */
16220 if (current_buffer
->width_run_cache
16221 || (current_buffer
->base_buffer
16222 && current_buffer
->base_buffer
->width_run_cache
))
16224 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16226 if (! disptab_matches_widthtab
16227 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16229 struct buffer
*buf
= current_buffer
;
16231 if (buf
->base_buffer
)
16232 buf
= buf
->base_buffer
;
16233 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16234 recompute_width_table (current_buffer
, disptab
);
16238 /* If window-start is screwed up, choose a new one. */
16239 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16242 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16244 /* If someone specified a new starting point but did not insist,
16245 check whether it can be used. */
16246 if ((w
->optional_new_start
|| window_frozen_p (w
))
16247 && CHARPOS (startp
) >= BEGV
16248 && CHARPOS (startp
) <= ZV
)
16250 ptrdiff_t it_charpos
;
16252 w
->optional_new_start
= false;
16253 start_display (&it
, w
, startp
);
16254 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16255 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16256 /* Record IT's position now, since line_bottom_y might change
16258 it_charpos
= IT_CHARPOS (it
);
16259 /* Make sure we set the force_start flag only if the cursor row
16260 will be fully visible. Otherwise, the code under force_start
16261 label below will try to move point back into view, which is
16262 not what the code which sets optional_new_start wants. */
16263 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
16264 && !w
->force_start
)
16266 if (it_charpos
== PT
)
16267 w
->force_start
= true;
16268 /* IT may overshoot PT if text at PT is invisible. */
16269 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16270 w
->force_start
= true;
16272 if (w
->force_start
)
16274 if (window_frozen_p (w
))
16275 debug_method_add (w
, "set force_start from frozen window start");
16277 debug_method_add (w
, "set force_start from optional_new_start");
16285 /* Handle case where place to start displaying has been specified,
16286 unless the specified location is outside the accessible range. */
16287 if (w
->force_start
)
16289 /* We set this later on if we have to adjust point. */
16292 w
->force_start
= false;
16294 w
->window_end_valid
= false;
16296 /* Forget any recorded base line for line number display. */
16297 if (!buffer_unchanged_p
)
16298 w
->base_line_number
= 0;
16300 /* Redisplay the mode line. Select the buffer properly for that.
16301 Also, run the hook window-scroll-functions
16302 because we have scrolled. */
16303 /* Note, we do this after clearing force_start because
16304 if there's an error, it is better to forget about force_start
16305 than to get into an infinite loop calling the hook functions
16306 and having them get more errors. */
16307 if (!update_mode_line
16308 || ! NILP (Vwindow_scroll_functions
))
16310 update_mode_line
= true;
16311 w
->update_mode_line
= true;
16312 startp
= run_window_scroll_functions (window
, startp
);
16315 if (CHARPOS (startp
) < BEGV
)
16316 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16317 else if (CHARPOS (startp
) > ZV
)
16318 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16320 /* Redisplay, then check if cursor has been set during the
16321 redisplay. Give up if new fonts were loaded. */
16322 /* We used to issue a CHECK_MARGINS argument to try_window here,
16323 but this causes scrolling to fail when point begins inside
16324 the scroll margin (bug#148) -- cyd */
16325 if (!try_window (window
, startp
, 0))
16327 w
->force_start
= true;
16328 clear_glyph_matrix (w
->desired_matrix
);
16329 goto need_larger_matrices
;
16332 if (w
->cursor
.vpos
< 0)
16334 /* If point does not appear, try to move point so it does
16335 appear. The desired matrix has been built above, so we
16336 can use it here. First see if point is in invisible
16337 text, and if so, move it to the first visible buffer
16338 position past that. */
16339 struct glyph_row
*r
= NULL
;
16340 Lisp_Object invprop
=
16341 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16344 if (TEXT_PROP_MEANS_INVISIBLE (invprop
) != 0)
16347 Lisp_Object invprop_end
=
16348 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16351 if (NATNUMP (invprop_end
))
16352 alt_pt
= XFASTINT (invprop_end
);
16355 r
= row_containing_pos (w
, alt_pt
, w
->desired_matrix
->rows
,
16359 new_vpos
= MATRIX_ROW_BOTTOM_Y (r
);
16360 else /* Give up and just move to the middle of the window. */
16361 new_vpos
= window_box_height (w
) / 2;
16364 if (!cursor_row_fully_visible_p (w
, false, false))
16366 /* Point does appear, but on a line partly visible at end of window.
16367 Move it back to a fully-visible line. */
16368 new_vpos
= window_box_height (w
);
16369 /* But if window_box_height suggests a Y coordinate that is
16370 not less than we already have, that line will clearly not
16371 be fully visible, so give up and scroll the display.
16372 This can happen when the default face uses a font whose
16373 dimensions are different from the frame's default
16375 if (new_vpos
>= w
->cursor
.y
)
16377 w
->cursor
.vpos
= -1;
16378 clear_glyph_matrix (w
->desired_matrix
);
16379 goto try_to_scroll
;
16382 else if (w
->cursor
.vpos
>= 0)
16384 /* Some people insist on not letting point enter the scroll
16385 margin, even though this part handles windows that didn't
16387 int window_total_lines
16388 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16389 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16390 int pixel_margin
= margin
* frame_line_height
;
16391 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16393 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16394 below, which finds the row to move point to, advances by
16395 the Y coordinate of the _next_ row, see the definition of
16396 MATRIX_ROW_BOTTOM_Y. */
16397 if (w
->cursor
.vpos
< margin
+ header_line
)
16399 w
->cursor
.vpos
= -1;
16400 clear_glyph_matrix (w
->desired_matrix
);
16401 goto try_to_scroll
;
16405 int window_height
= window_box_height (w
);
16408 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16409 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16411 w
->cursor
.vpos
= -1;
16412 clear_glyph_matrix (w
->desired_matrix
);
16413 goto try_to_scroll
;
16418 /* If we need to move point for either of the above reasons,
16419 now actually do it. */
16422 struct glyph_row
*row
;
16424 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16425 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16428 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16429 MATRIX_ROW_START_BYTEPOS (row
));
16431 if (w
!= XWINDOW (selected_window
))
16432 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16433 else if (current_buffer
== old
)
16434 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16436 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16438 /* Re-run pre-redisplay-function so it can update the region
16439 according to the new position of point. */
16440 /* Other than the cursor, w's redisplay is done so we can set its
16441 redisplay to false. Also the buffer's redisplay can be set to
16442 false, since propagate_buffer_redisplay should have already
16443 propagated its info to `w' anyway. */
16444 w
->redisplay
= false;
16445 XBUFFER (w
->contents
)->text
->redisplay
= false;
16446 safe__call1 (true, Vpre_redisplay_function
, Fcons (window
, Qnil
));
16448 if (w
->redisplay
|| XBUFFER (w
->contents
)->text
->redisplay
)
16450 /* pre-redisplay-function made changes (e.g. move the region)
16451 that require another round of redisplay. */
16452 clear_glyph_matrix (w
->desired_matrix
);
16453 if (!try_window (window
, startp
, 0))
16454 goto need_larger_matrices
;
16457 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, false, false))
16459 clear_glyph_matrix (w
->desired_matrix
);
16460 goto try_to_scroll
;
16464 debug_method_add (w
, "forced window start");
16469 /* Handle case where text has not changed, only point, and it has
16470 not moved off the frame, and we are not retrying after hscroll.
16471 (current_matrix_up_to_date_p is true when retrying.) */
16472 if (current_matrix_up_to_date_p
16473 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16474 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16478 case CURSOR_MOVEMENT_SUCCESS
:
16479 used_current_matrix_p
= true;
16482 case CURSOR_MOVEMENT_MUST_SCROLL
:
16483 goto try_to_scroll
;
16489 /* If current starting point was originally the beginning of a line
16490 but no longer is, find a new starting point. */
16491 else if (w
->start_at_line_beg
16492 && !(CHARPOS (startp
) <= BEGV
16493 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16496 debug_method_add (w
, "recenter 1");
16501 /* Try scrolling with try_window_id. Value is > 0 if update has
16502 been done, it is -1 if we know that the same window start will
16503 not work. It is 0 if unsuccessful for some other reason. */
16504 else if ((tem
= try_window_id (w
)) != 0)
16507 debug_method_add (w
, "try_window_id %d", tem
);
16510 if (f
->fonts_changed
)
16511 goto need_larger_matrices
;
16515 /* Otherwise try_window_id has returned -1 which means that we
16516 don't want the alternative below this comment to execute. */
16518 else if (CHARPOS (startp
) >= BEGV
16519 && CHARPOS (startp
) <= ZV
16520 && PT
>= CHARPOS (startp
)
16521 && (CHARPOS (startp
) < ZV
16522 /* Avoid starting at end of buffer. */
16523 || CHARPOS (startp
) == BEGV
16524 || !window_outdated (w
)))
16526 int d1
, d2
, d5
, d6
;
16529 /* If first window line is a continuation line, and window start
16530 is inside the modified region, but the first change is before
16531 current window start, we must select a new window start.
16533 However, if this is the result of a down-mouse event (e.g. by
16534 extending the mouse-drag-overlay), we don't want to select a
16535 new window start, since that would change the position under
16536 the mouse, resulting in an unwanted mouse-movement rather
16537 than a simple mouse-click. */
16538 if (!w
->start_at_line_beg
16539 && NILP (do_mouse_tracking
)
16540 && CHARPOS (startp
) > BEGV
16541 && CHARPOS (startp
) > BEG
+ beg_unchanged
16542 && CHARPOS (startp
) <= Z
- end_unchanged
16543 /* Even if w->start_at_line_beg is nil, a new window may
16544 start at a line_beg, since that's how set_buffer_window
16545 sets it. So, we need to check the return value of
16546 compute_window_start_on_continuation_line. (See also
16548 && XMARKER (w
->start
)->buffer
== current_buffer
16549 && compute_window_start_on_continuation_line (w
)
16550 /* It doesn't make sense to force the window start like we
16551 do at label force_start if it is already known that point
16552 will not be fully visible in the resulting window, because
16553 doing so will move point from its correct position
16554 instead of scrolling the window to bring point into view.
16556 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16557 /* A very tall row could need more than the window height,
16558 in which case we accept that it is partially visible. */
16559 && (rtop
!= 0) == (rbot
!= 0))
16561 w
->force_start
= true;
16562 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16564 debug_method_add (w
, "recomputed window start in continuation line");
16570 debug_method_add (w
, "same window start");
16573 /* Try to redisplay starting at same place as before.
16574 If point has not moved off frame, accept the results. */
16575 if (!current_matrix_up_to_date_p
16576 /* Don't use try_window_reusing_current_matrix in this case
16577 because a window scroll function can have changed the
16579 || !NILP (Vwindow_scroll_functions
)
16580 || MINI_WINDOW_P (w
)
16581 || !(used_current_matrix_p
16582 = try_window_reusing_current_matrix (w
)))
16584 IF_DEBUG (debug_method_add (w
, "1"));
16585 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16586 /* -1 means we need to scroll.
16587 0 means we need new matrices, but fonts_changed
16588 is set in that case, so we will detect it below. */
16589 goto try_to_scroll
;
16592 if (f
->fonts_changed
)
16593 goto need_larger_matrices
;
16595 if (w
->cursor
.vpos
>= 0)
16597 if (!just_this_one_p
16598 || current_buffer
->clip_changed
16599 || BEG_UNCHANGED
< CHARPOS (startp
))
16600 /* Forget any recorded base line for line number display. */
16601 w
->base_line_number
= 0;
16603 if (!cursor_row_fully_visible_p (w
, true, false))
16605 clear_glyph_matrix (w
->desired_matrix
);
16606 last_line_misfit
= true;
16608 /* Drop through and scroll. */
16613 clear_glyph_matrix (w
->desired_matrix
);
16618 /* Redisplay the mode line. Select the buffer properly for that. */
16619 if (!update_mode_line
)
16621 update_mode_line
= true;
16622 w
->update_mode_line
= true;
16625 /* Try to scroll by specified few lines. */
16626 if ((scroll_conservatively
16627 || emacs_scroll_step
16628 || temp_scroll_step
16629 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16630 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16631 && CHARPOS (startp
) >= BEGV
16632 && CHARPOS (startp
) <= ZV
)
16634 /* The function returns -1 if new fonts were loaded, 1 if
16635 successful, 0 if not successful. */
16636 int ss
= try_scrolling (window
, just_this_one_p
,
16637 scroll_conservatively
,
16639 temp_scroll_step
, last_line_misfit
);
16642 case SCROLLING_SUCCESS
:
16645 case SCROLLING_NEED_LARGER_MATRICES
:
16646 goto need_larger_matrices
;
16648 case SCROLLING_FAILED
:
16656 /* Finally, just choose a place to start which positions point
16657 according to user preferences. */
16662 debug_method_add (w
, "recenter");
16665 /* Forget any previously recorded base line for line number display. */
16666 if (!buffer_unchanged_p
)
16667 w
->base_line_number
= 0;
16669 /* Determine the window start relative to point. */
16670 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16671 it
.current_y
= it
.last_visible_y
;
16672 if (centering_position
< 0)
16674 int window_total_lines
16675 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16677 = scroll_margin
> 0
16678 ? min (scroll_margin
, window_total_lines
/ 4)
16680 ptrdiff_t margin_pos
= CHARPOS (startp
);
16681 Lisp_Object aggressive
;
16684 /* If there is a scroll margin at the top of the window, find
16685 its character position. */
16687 /* Cannot call start_display if startp is not in the
16688 accessible region of the buffer. This can happen when we
16689 have just switched to a different buffer and/or changed
16690 its restriction. In that case, startp is initialized to
16691 the character position 1 (BEGV) because we did not yet
16692 have chance to display the buffer even once. */
16693 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16696 void *it1data
= NULL
;
16698 SAVE_IT (it1
, it
, it1data
);
16699 start_display (&it1
, w
, startp
);
16700 move_it_vertically (&it1
, margin
* frame_line_height
);
16701 margin_pos
= IT_CHARPOS (it1
);
16702 RESTORE_IT (&it
, &it
, it1data
);
16704 scrolling_up
= PT
> margin_pos
;
16707 ? BVAR (current_buffer
, scroll_up_aggressively
)
16708 : BVAR (current_buffer
, scroll_down_aggressively
);
16710 if (!MINI_WINDOW_P (w
)
16711 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16715 /* Setting scroll-conservatively overrides
16716 scroll-*-aggressively. */
16717 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16719 double float_amount
= XFLOATINT (aggressive
);
16721 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16722 if (pt_offset
== 0 && float_amount
> 0)
16724 if (pt_offset
&& margin
> 0)
16727 /* Compute how much to move the window start backward from
16728 point so that point will be displayed where the user
16732 centering_position
= it
.last_visible_y
;
16734 centering_position
-= pt_offset
;
16735 centering_position
-=
16736 (frame_line_height
* (1 + margin
+ last_line_misfit
)
16737 + WINDOW_HEADER_LINE_HEIGHT (w
));
16738 /* Don't let point enter the scroll margin near top of
16740 if (centering_position
< margin
* frame_line_height
)
16741 centering_position
= margin
* frame_line_height
;
16744 centering_position
= margin
* frame_line_height
+ pt_offset
;
16747 /* Set the window start half the height of the window backward
16749 centering_position
= window_box_height (w
) / 2;
16751 move_it_vertically_backward (&it
, centering_position
);
16753 eassert (IT_CHARPOS (it
) >= BEGV
);
16755 /* The function move_it_vertically_backward may move over more
16756 than the specified y-distance. If it->w is small, e.g. a
16757 mini-buffer window, we may end up in front of the window's
16758 display area. Start displaying at the start of the line
16759 containing PT in this case. */
16760 if (it
.current_y
<= 0)
16762 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16763 move_it_vertically_backward (&it
, 0);
16767 it
.current_x
= it
.hpos
= 0;
16769 /* Set the window start position here explicitly, to avoid an
16770 infinite loop in case the functions in window-scroll-functions
16772 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16774 /* Run scroll hooks. */
16775 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16777 /* Redisplay the window. */
16778 use_desired_matrix
= false;
16779 if (!current_matrix_up_to_date_p
16780 || windows_or_buffers_changed
16781 || f
->cursor_type_changed
16782 /* Don't use try_window_reusing_current_matrix in this case
16783 because it can have changed the buffer. */
16784 || !NILP (Vwindow_scroll_functions
)
16785 || !just_this_one_p
16786 || MINI_WINDOW_P (w
)
16787 || !(used_current_matrix_p
16788 = try_window_reusing_current_matrix (w
)))
16789 use_desired_matrix
= (try_window (window
, startp
, 0) == 1);
16791 /* If new fonts have been loaded (due to fontsets), give up. We
16792 have to start a new redisplay since we need to re-adjust glyph
16794 if (f
->fonts_changed
)
16795 goto need_larger_matrices
;
16797 /* If cursor did not appear assume that the middle of the window is
16798 in the first line of the window. Do it again with the next line.
16799 (Imagine a window of height 100, displaying two lines of height
16800 60. Moving back 50 from it->last_visible_y will end in the first
16802 if (w
->cursor
.vpos
< 0)
16804 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16806 clear_glyph_matrix (w
->desired_matrix
);
16807 move_it_by_lines (&it
, 1);
16808 try_window (window
, it
.current
.pos
, 0);
16810 else if (PT
< IT_CHARPOS (it
))
16812 clear_glyph_matrix (w
->desired_matrix
);
16813 move_it_by_lines (&it
, -1);
16814 try_window (window
, it
.current
.pos
, 0);
16818 /* Not much we can do about it. */
16822 /* Consider the following case: Window starts at BEGV, there is
16823 invisible, intangible text at BEGV, so that display starts at
16824 some point START > BEGV. It can happen that we are called with
16825 PT somewhere between BEGV and START. Try to handle that case,
16826 and similar ones. */
16827 if (w
->cursor
.vpos
< 0)
16829 /* Prefer the desired matrix to the current matrix, if possible,
16830 in the fallback calculations below. This is because using
16831 the current matrix might completely goof, e.g. if its first
16832 row is after point. */
16833 struct glyph_matrix
*matrix
=
16834 use_desired_matrix
? w
->desired_matrix
: w
->current_matrix
;
16835 /* First, try locating the proper glyph row for PT. */
16836 struct glyph_row
*row
=
16837 row_containing_pos (w
, PT
, matrix
->rows
, NULL
, 0);
16839 /* Sometimes point is at the beginning of invisible text that is
16840 before the 1st character displayed in the row. In that case,
16841 row_containing_pos fails to find the row, because no glyphs
16842 with appropriate buffer positions are present in the row.
16843 Therefore, we next try to find the row which shows the 1st
16844 position after the invisible text. */
16848 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16851 if (TEXT_PROP_MEANS_INVISIBLE (val
) != 0)
16854 Lisp_Object invis_end
=
16855 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16858 if (NATNUMP (invis_end
))
16859 alt_pos
= XFASTINT (invis_end
);
16862 row
= row_containing_pos (w
, alt_pos
, matrix
->rows
, NULL
, 0);
16865 /* Finally, fall back on the first row of the window after the
16866 header line (if any). This is slightly better than not
16867 displaying the cursor at all. */
16870 row
= matrix
->rows
;
16871 if (row
->mode_line_p
)
16874 set_cursor_from_row (w
, row
, matrix
, 0, 0, 0, 0);
16877 if (!cursor_row_fully_visible_p (w
, false, false))
16879 /* If vscroll is enabled, disable it and try again. */
16883 clear_glyph_matrix (w
->desired_matrix
);
16887 /* Users who set scroll-conservatively to a large number want
16888 point just above/below the scroll margin. If we ended up
16889 with point's row partially visible, move the window start to
16890 make that row fully visible and out of the margin. */
16891 if (scroll_conservatively
> SCROLL_LIMIT
)
16893 int window_total_lines
16894 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16897 ? min (scroll_margin
, window_total_lines
/ 4)
16899 bool move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16901 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16902 clear_glyph_matrix (w
->desired_matrix
);
16903 if (1 == try_window (window
, it
.current
.pos
,
16904 TRY_WINDOW_CHECK_MARGINS
))
16908 /* If centering point failed to make the whole line visible,
16909 put point at the top instead. That has to make the whole line
16910 visible, if it can be done. */
16911 if (centering_position
== 0)
16914 clear_glyph_matrix (w
->desired_matrix
);
16915 centering_position
= 0;
16921 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16922 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16923 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16925 /* Display the mode line, if we must. */
16926 if ((update_mode_line
16927 /* If window not full width, must redo its mode line
16928 if (a) the window to its side is being redone and
16929 (b) we do a frame-based redisplay. This is a consequence
16930 of how inverted lines are drawn in frame-based redisplay. */
16931 || (!just_this_one_p
16932 && !FRAME_WINDOW_P (f
)
16933 && !WINDOW_FULL_WIDTH_P (w
))
16934 /* Line number to display. */
16935 || w
->base_line_pos
> 0
16936 /* Column number is displayed and different from the one displayed. */
16937 || (w
->column_number_displayed
!= -1
16938 && (w
->column_number_displayed
!= current_column ())))
16939 /* This means that the window has a mode line. */
16940 && (WINDOW_WANTS_MODELINE_P (w
)
16941 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16944 display_mode_lines (w
);
16946 /* If mode line height has changed, arrange for a thorough
16947 immediate redisplay using the correct mode line height. */
16948 if (WINDOW_WANTS_MODELINE_P (w
)
16949 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16951 f
->fonts_changed
= true;
16952 w
->mode_line_height
= -1;
16953 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16954 = DESIRED_MODE_LINE_HEIGHT (w
);
16957 /* If header line height has changed, arrange for a thorough
16958 immediate redisplay using the correct header line height. */
16959 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16960 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16962 f
->fonts_changed
= true;
16963 w
->header_line_height
= -1;
16964 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16965 = DESIRED_HEADER_LINE_HEIGHT (w
);
16968 if (f
->fonts_changed
)
16969 goto need_larger_matrices
;
16972 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16974 w
->base_line_pos
= 0;
16975 w
->base_line_number
= 0;
16980 /* When we reach a frame's selected window, redo the frame's menu
16981 bar and the frame's title. */
16982 if (update_mode_line
16983 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16985 bool redisplay_menu_p
;
16987 if (FRAME_WINDOW_P (f
))
16989 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16990 || defined (HAVE_NS) || defined (USE_GTK)
16991 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16993 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16997 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16999 if (redisplay_menu_p
)
17000 display_menu_bar (w
);
17002 #ifdef HAVE_WINDOW_SYSTEM
17003 if (FRAME_WINDOW_P (f
))
17005 #if defined (USE_GTK) || defined (HAVE_NS)
17006 if (FRAME_EXTERNAL_TOOL_BAR (f
))
17007 redisplay_tool_bar (f
);
17009 if (WINDOWP (f
->tool_bar_window
)
17010 && (FRAME_TOOL_BAR_LINES (f
) > 0
17011 || !NILP (Vauto_resize_tool_bars
))
17012 && redisplay_tool_bar (f
))
17013 ignore_mouse_drag_p
= true;
17016 x_consider_frame_title (w
->frame
);
17020 #ifdef HAVE_WINDOW_SYSTEM
17021 if (FRAME_WINDOW_P (f
)
17022 && update_window_fringes (w
, (just_this_one_p
17023 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
17024 || w
->pseudo_window_p
)))
17028 if (draw_window_fringes (w
, true))
17030 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
17031 x_draw_right_divider (w
);
17033 x_draw_vertical_border (w
);
17039 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
17040 x_draw_bottom_divider (w
);
17041 #endif /* HAVE_WINDOW_SYSTEM */
17043 /* We go to this label, with fonts_changed set, if it is
17044 necessary to try again using larger glyph matrices.
17045 We have to redeem the scroll bar even in this case,
17046 because the loop in redisplay_internal expects that. */
17047 need_larger_matrices
:
17049 finish_scroll_bars
:
17051 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
17053 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
17054 /* Set the thumb's position and size. */
17055 set_vertical_scroll_bar (w
);
17057 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
17058 /* Set the thumb's position and size. */
17059 set_horizontal_scroll_bar (w
);
17061 /* Note that we actually used the scroll bar attached to this
17062 window, so it shouldn't be deleted at the end of redisplay. */
17063 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
17064 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
17067 /* Restore current_buffer and value of point in it. The window
17068 update may have changed the buffer, so first make sure `opoint'
17069 is still valid (Bug#6177). */
17070 if (CHARPOS (opoint
) < BEGV
)
17071 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
17072 else if (CHARPOS (opoint
) > ZV
)
17073 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
17075 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
17077 set_buffer_internal_1 (old
);
17078 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
17079 shorter. This can be caused by log truncation in *Messages*. */
17080 if (CHARPOS (lpoint
) <= ZV
)
17081 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
17083 unbind_to (count
, Qnil
);
17087 /* Build the complete desired matrix of WINDOW with a window start
17088 buffer position POS.
17090 Value is 1 if successful. It is zero if fonts were loaded during
17091 redisplay which makes re-adjusting glyph matrices necessary, and -1
17092 if point would appear in the scroll margins.
17093 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
17094 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
17098 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
17100 struct window
*w
= XWINDOW (window
);
17102 struct glyph_row
*last_text_row
= NULL
;
17103 struct frame
*f
= XFRAME (w
->frame
);
17104 int frame_line_height
= default_line_pixel_height (w
);
17106 /* Make POS the new window start. */
17107 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
17109 /* Mark cursor position as unknown. No overlay arrow seen. */
17110 w
->cursor
.vpos
= -1;
17111 overlay_arrow_seen
= false;
17113 /* Initialize iterator and info to start at POS. */
17114 start_display (&it
, w
, pos
);
17115 it
.glyph_row
->reversed_p
= false;
17117 /* Display all lines of W. */
17118 while (it
.current_y
< it
.last_visible_y
)
17120 if (display_line (&it
))
17121 last_text_row
= it
.glyph_row
- 1;
17122 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
17126 /* Don't let the cursor end in the scroll margins. */
17127 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
17128 && !MINI_WINDOW_P (w
))
17130 int this_scroll_margin
;
17131 int window_total_lines
17132 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
17134 if (scroll_margin
> 0)
17136 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
17137 this_scroll_margin
*= frame_line_height
;
17140 this_scroll_margin
= 0;
17142 if ((w
->cursor
.y
>= 0 /* not vscrolled */
17143 && w
->cursor
.y
< this_scroll_margin
17144 && CHARPOS (pos
) > BEGV
17145 && IT_CHARPOS (it
) < ZV
)
17146 /* rms: considering make_cursor_line_fully_visible_p here
17147 seems to give wrong results. We don't want to recenter
17148 when the last line is partly visible, we want to allow
17149 that case to be handled in the usual way. */
17150 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
17152 w
->cursor
.vpos
= -1;
17153 clear_glyph_matrix (w
->desired_matrix
);
17158 /* If bottom moved off end of frame, change mode line percentage. */
17159 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
17160 w
->update_mode_line
= true;
17162 /* Set window_end_pos to the offset of the last character displayed
17163 on the window from the end of current_buffer. Set
17164 window_end_vpos to its row number. */
17167 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
17168 adjust_window_ends (w
, last_text_row
, false);
17170 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
17171 w
->window_end_vpos
)));
17175 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17176 w
->window_end_pos
= Z
- ZV
;
17177 w
->window_end_vpos
= 0;
17180 /* But that is not valid info until redisplay finishes. */
17181 w
->window_end_valid
= false;
17187 /************************************************************************
17188 Window redisplay reusing current matrix when buffer has not changed
17189 ************************************************************************/
17191 /* Try redisplay of window W showing an unchanged buffer with a
17192 different window start than the last time it was displayed by
17193 reusing its current matrix. Value is true if successful.
17194 W->start is the new window start. */
17197 try_window_reusing_current_matrix (struct window
*w
)
17199 struct frame
*f
= XFRAME (w
->frame
);
17200 struct glyph_row
*bottom_row
;
17203 struct text_pos start
, new_start
;
17204 int nrows_scrolled
, i
;
17205 struct glyph_row
*last_text_row
;
17206 struct glyph_row
*last_reused_text_row
;
17207 struct glyph_row
*start_row
;
17208 int start_vpos
, min_y
, max_y
;
17211 if (inhibit_try_window_reusing
)
17215 if (/* This function doesn't handle terminal frames. */
17216 !FRAME_WINDOW_P (f
)
17217 /* Don't try to reuse the display if windows have been split
17219 || windows_or_buffers_changed
17220 || f
->cursor_type_changed
)
17223 /* Can't do this if showing trailing whitespace. */
17224 if (!NILP (Vshow_trailing_whitespace
))
17227 /* If top-line visibility has changed, give up. */
17228 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17229 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17232 /* Give up if old or new display is scrolled vertically. We could
17233 make this function handle this, but right now it doesn't. */
17234 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17235 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17238 /* The variable new_start now holds the new window start. The old
17239 start `start' can be determined from the current matrix. */
17240 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17241 start
= start_row
->minpos
;
17242 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17244 /* Clear the desired matrix for the display below. */
17245 clear_glyph_matrix (w
->desired_matrix
);
17247 if (CHARPOS (new_start
) <= CHARPOS (start
))
17249 /* Don't use this method if the display starts with an ellipsis
17250 displayed for invisible text. It's not easy to handle that case
17251 below, and it's certainly not worth the effort since this is
17252 not a frequent case. */
17253 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17256 IF_DEBUG (debug_method_add (w
, "twu1"));
17258 /* Display up to a row that can be reused. The variable
17259 last_text_row is set to the last row displayed that displays
17260 text. Note that it.vpos == 0 if or if not there is a
17261 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17262 start_display (&it
, w
, new_start
);
17263 w
->cursor
.vpos
= -1;
17264 last_text_row
= last_reused_text_row
= NULL
;
17266 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17268 /* If we have reached into the characters in the START row,
17269 that means the line boundaries have changed. So we
17270 can't start copying with the row START. Maybe it will
17271 work to start copying with the following row. */
17272 while (IT_CHARPOS (it
) > CHARPOS (start
))
17274 /* Advance to the next row as the "start". */
17276 start
= start_row
->minpos
;
17277 /* If there are no more rows to try, or just one, give up. */
17278 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17279 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17280 || CHARPOS (start
) == ZV
)
17282 clear_glyph_matrix (w
->desired_matrix
);
17286 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17288 /* If we have reached alignment, we can copy the rest of the
17290 if (IT_CHARPOS (it
) == CHARPOS (start
)
17291 /* Don't accept "alignment" inside a display vector,
17292 since start_row could have started in the middle of
17293 that same display vector (thus their character
17294 positions match), and we have no way of telling if
17295 that is the case. */
17296 && it
.current
.dpvec_index
< 0)
17299 it
.glyph_row
->reversed_p
= false;
17300 if (display_line (&it
))
17301 last_text_row
= it
.glyph_row
- 1;
17305 /* A value of current_y < last_visible_y means that we stopped
17306 at the previous window start, which in turn means that we
17307 have at least one reusable row. */
17308 if (it
.current_y
< it
.last_visible_y
)
17310 struct glyph_row
*row
;
17312 /* IT.vpos always starts from 0; it counts text lines. */
17313 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17315 /* Find PT if not already found in the lines displayed. */
17316 if (w
->cursor
.vpos
< 0)
17318 int dy
= it
.current_y
- start_row
->y
;
17320 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17321 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17323 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17324 dy
, nrows_scrolled
);
17327 clear_glyph_matrix (w
->desired_matrix
);
17332 /* Scroll the display. Do it before the current matrix is
17333 changed. The problem here is that update has not yet
17334 run, i.e. part of the current matrix is not up to date.
17335 scroll_run_hook will clear the cursor, and use the
17336 current matrix to get the height of the row the cursor is
17338 run
.current_y
= start_row
->y
;
17339 run
.desired_y
= it
.current_y
;
17340 run
.height
= it
.last_visible_y
- it
.current_y
;
17342 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17345 FRAME_RIF (f
)->update_window_begin_hook (w
);
17346 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17347 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17348 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17352 /* Shift current matrix down by nrows_scrolled lines. */
17353 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17354 rotate_matrix (w
->current_matrix
,
17356 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17359 /* Disable lines that must be updated. */
17360 for (i
= 0; i
< nrows_scrolled
; ++i
)
17361 (start_row
+ i
)->enabled_p
= false;
17363 /* Re-compute Y positions. */
17364 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17365 max_y
= it
.last_visible_y
;
17366 for (row
= start_row
+ nrows_scrolled
;
17370 row
->y
= it
.current_y
;
17371 row
->visible_height
= row
->height
;
17373 if (row
->y
< min_y
)
17374 row
->visible_height
-= min_y
- row
->y
;
17375 if (row
->y
+ row
->height
> max_y
)
17376 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17377 if (row
->fringe_bitmap_periodic_p
)
17378 row
->redraw_fringe_bitmaps_p
= true;
17380 it
.current_y
+= row
->height
;
17382 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17383 last_reused_text_row
= row
;
17384 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17388 /* Disable lines in the current matrix which are now
17389 below the window. */
17390 for (++row
; row
< bottom_row
; ++row
)
17391 row
->enabled_p
= row
->mode_line_p
= false;
17394 /* Update window_end_pos etc.; last_reused_text_row is the last
17395 reused row from the current matrix containing text, if any.
17396 The value of last_text_row is the last displayed line
17397 containing text. */
17398 if (last_reused_text_row
)
17399 adjust_window_ends (w
, last_reused_text_row
, true);
17400 else if (last_text_row
)
17401 adjust_window_ends (w
, last_text_row
, false);
17404 /* This window must be completely empty. */
17405 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17406 w
->window_end_pos
= Z
- ZV
;
17407 w
->window_end_vpos
= 0;
17409 w
->window_end_valid
= false;
17411 /* Update hint: don't try scrolling again in update_window. */
17412 w
->desired_matrix
->no_scrolling_p
= true;
17415 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17419 else if (CHARPOS (new_start
) > CHARPOS (start
))
17421 struct glyph_row
*pt_row
, *row
;
17422 struct glyph_row
*first_reusable_row
;
17423 struct glyph_row
*first_row_to_display
;
17425 int yb
= window_text_bottom_y (w
);
17427 /* Find the row starting at new_start, if there is one. Don't
17428 reuse a partially visible line at the end. */
17429 first_reusable_row
= start_row
;
17430 while (first_reusable_row
->enabled_p
17431 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17432 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17433 < CHARPOS (new_start
)))
17434 ++first_reusable_row
;
17436 /* Give up if there is no row to reuse. */
17437 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17438 || !first_reusable_row
->enabled_p
17439 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17440 != CHARPOS (new_start
)))
17443 /* We can reuse fully visible rows beginning with
17444 first_reusable_row to the end of the window. Set
17445 first_row_to_display to the first row that cannot be reused.
17446 Set pt_row to the row containing point, if there is any. */
17448 for (first_row_to_display
= first_reusable_row
;
17449 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17450 ++first_row_to_display
)
17452 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17453 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17454 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17455 && first_row_to_display
->ends_at_zv_p
17456 && pt_row
== NULL
)))
17457 pt_row
= first_row_to_display
;
17460 /* Start displaying at the start of first_row_to_display. */
17461 eassert (first_row_to_display
->y
< yb
);
17462 init_to_row_start (&it
, w
, first_row_to_display
);
17464 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17466 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17468 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17469 + WINDOW_HEADER_LINE_HEIGHT (w
));
17471 /* Display lines beginning with first_row_to_display in the
17472 desired matrix. Set last_text_row to the last row displayed
17473 that displays text. */
17474 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17475 if (pt_row
== NULL
)
17476 w
->cursor
.vpos
= -1;
17477 last_text_row
= NULL
;
17478 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17479 if (display_line (&it
))
17480 last_text_row
= it
.glyph_row
- 1;
17482 /* If point is in a reused row, adjust y and vpos of the cursor
17486 w
->cursor
.vpos
-= nrows_scrolled
;
17487 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17490 /* Give up if point isn't in a row displayed or reused. (This
17491 also handles the case where w->cursor.vpos < nrows_scrolled
17492 after the calls to display_line, which can happen with scroll
17493 margins. See bug#1295.) */
17494 if (w
->cursor
.vpos
< 0)
17496 clear_glyph_matrix (w
->desired_matrix
);
17500 /* Scroll the display. */
17501 run
.current_y
= first_reusable_row
->y
;
17502 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17503 run
.height
= it
.last_visible_y
- run
.current_y
;
17504 dy
= run
.current_y
- run
.desired_y
;
17509 FRAME_RIF (f
)->update_window_begin_hook (w
);
17510 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17511 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17512 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17516 /* Adjust Y positions of reused rows. */
17517 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17518 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17519 max_y
= it
.last_visible_y
;
17520 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17523 row
->visible_height
= row
->height
;
17524 if (row
->y
< min_y
)
17525 row
->visible_height
-= min_y
- row
->y
;
17526 if (row
->y
+ row
->height
> max_y
)
17527 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17528 if (row
->fringe_bitmap_periodic_p
)
17529 row
->redraw_fringe_bitmaps_p
= true;
17532 /* Scroll the current matrix. */
17533 eassert (nrows_scrolled
> 0);
17534 rotate_matrix (w
->current_matrix
,
17536 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17539 /* Disable rows not reused. */
17540 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17541 row
->enabled_p
= false;
17543 /* Point may have moved to a different line, so we cannot assume that
17544 the previous cursor position is valid; locate the correct row. */
17547 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17549 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17550 && !row
->ends_at_zv_p
;
17554 w
->cursor
.y
= row
->y
;
17556 if (row
< bottom_row
)
17558 /* Can't simply scan the row for point with
17559 bidi-reordered glyph rows. Let set_cursor_from_row
17560 figure out where to put the cursor, and if it fails,
17562 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17564 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17567 clear_glyph_matrix (w
->desired_matrix
);
17573 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17574 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17577 && (!BUFFERP (glyph
->object
)
17578 || glyph
->charpos
< PT
);
17582 w
->cursor
.x
+= glyph
->pixel_width
;
17588 /* Adjust window end. A null value of last_text_row means that
17589 the window end is in reused rows which in turn means that
17590 only its vpos can have changed. */
17592 adjust_window_ends (w
, last_text_row
, false);
17594 w
->window_end_vpos
-= nrows_scrolled
;
17596 w
->window_end_valid
= false;
17597 w
->desired_matrix
->no_scrolling_p
= true;
17600 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17610 /************************************************************************
17611 Window redisplay reusing current matrix when buffer has changed
17612 ************************************************************************/
17614 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17615 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17616 ptrdiff_t *, ptrdiff_t *);
17617 static struct glyph_row
*
17618 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17619 struct glyph_row
*);
17622 /* Return the last row in MATRIX displaying text. If row START is
17623 non-null, start searching with that row. IT gives the dimensions
17624 of the display. Value is null if matrix is empty; otherwise it is
17625 a pointer to the row found. */
17627 static struct glyph_row
*
17628 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17629 struct glyph_row
*start
)
17631 struct glyph_row
*row
, *row_found
;
17633 /* Set row_found to the last row in IT->w's current matrix
17634 displaying text. The loop looks funny but think of partially
17637 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17638 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17640 eassert (row
->enabled_p
);
17642 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17651 /* Return the last row in the current matrix of W that is not affected
17652 by changes at the start of current_buffer that occurred since W's
17653 current matrix was built. Value is null if no such row exists.
17655 BEG_UNCHANGED us the number of characters unchanged at the start of
17656 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17657 first changed character in current_buffer. Characters at positions <
17658 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17659 when the current matrix was built. */
17661 static struct glyph_row
*
17662 find_last_unchanged_at_beg_row (struct window
*w
)
17664 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17665 struct glyph_row
*row
;
17666 struct glyph_row
*row_found
= NULL
;
17667 int yb
= window_text_bottom_y (w
);
17669 /* Find the last row displaying unchanged text. */
17670 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17671 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17672 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17675 if (/* If row ends before first_changed_pos, it is unchanged,
17676 except in some case. */
17677 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17678 /* When row ends in ZV and we write at ZV it is not
17680 && !row
->ends_at_zv_p
17681 /* When first_changed_pos is the end of a continued line,
17682 row is not unchanged because it may be no longer
17684 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17685 && (row
->continued_p
17686 || row
->exact_window_width_line_p
))
17687 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17688 needs to be recomputed, so don't consider this row as
17689 unchanged. This happens when the last line was
17690 bidi-reordered and was killed immediately before this
17691 redisplay cycle. In that case, ROW->end stores the
17692 buffer position of the first visual-order character of
17693 the killed text, which is now beyond ZV. */
17694 && CHARPOS (row
->end
.pos
) <= ZV
)
17697 /* Stop if last visible row. */
17698 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17706 /* Find the first glyph row in the current matrix of W that is not
17707 affected by changes at the end of current_buffer since the
17708 time W's current matrix was built.
17710 Return in *DELTA the number of chars by which buffer positions in
17711 unchanged text at the end of current_buffer must be adjusted.
17713 Return in *DELTA_BYTES the corresponding number of bytes.
17715 Value is null if no such row exists, i.e. all rows are affected by
17718 static struct glyph_row
*
17719 find_first_unchanged_at_end_row (struct window
*w
,
17720 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17722 struct glyph_row
*row
;
17723 struct glyph_row
*row_found
= NULL
;
17725 *delta
= *delta_bytes
= 0;
17727 /* Display must not have been paused, otherwise the current matrix
17728 is not up to date. */
17729 eassert (w
->window_end_valid
);
17731 /* A value of window_end_pos >= END_UNCHANGED means that the window
17732 end is in the range of changed text. If so, there is no
17733 unchanged row at the end of W's current matrix. */
17734 if (w
->window_end_pos
>= END_UNCHANGED
)
17737 /* Set row to the last row in W's current matrix displaying text. */
17738 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17740 /* If matrix is entirely empty, no unchanged row exists. */
17741 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17743 /* The value of row is the last glyph row in the matrix having a
17744 meaningful buffer position in it. The end position of row
17745 corresponds to window_end_pos. This allows us to translate
17746 buffer positions in the current matrix to current buffer
17747 positions for characters not in changed text. */
17749 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17750 ptrdiff_t Z_BYTE_old
=
17751 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17752 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17753 struct glyph_row
*first_text_row
17754 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17756 *delta
= Z
- Z_old
;
17757 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17759 /* Set last_unchanged_pos to the buffer position of the last
17760 character in the buffer that has not been changed. Z is the
17761 index + 1 of the last character in current_buffer, i.e. by
17762 subtracting END_UNCHANGED we get the index of the last
17763 unchanged character, and we have to add BEG to get its buffer
17765 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17766 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17768 /* Search backward from ROW for a row displaying a line that
17769 starts at a minimum position >= last_unchanged_pos_old. */
17770 for (; row
> first_text_row
; --row
)
17772 /* This used to abort, but it can happen.
17773 It is ok to just stop the search instead here. KFS. */
17774 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17777 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17782 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17788 /* Make sure that glyph rows in the current matrix of window W
17789 reference the same glyph memory as corresponding rows in the
17790 frame's frame matrix. This function is called after scrolling W's
17791 current matrix on a terminal frame in try_window_id and
17792 try_window_reusing_current_matrix. */
17795 sync_frame_with_window_matrix_rows (struct window
*w
)
17797 struct frame
*f
= XFRAME (w
->frame
);
17798 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17800 /* Preconditions: W must be a leaf window and full-width. Its frame
17801 must have a frame matrix. */
17802 eassert (BUFFERP (w
->contents
));
17803 eassert (WINDOW_FULL_WIDTH_P (w
));
17804 eassert (!FRAME_WINDOW_P (f
));
17806 /* If W is a full-width window, glyph pointers in W's current matrix
17807 have, by definition, to be the same as glyph pointers in the
17808 corresponding frame matrix. Note that frame matrices have no
17809 marginal areas (see build_frame_matrix). */
17810 window_row
= w
->current_matrix
->rows
;
17811 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17812 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17813 while (window_row
< window_row_end
)
17815 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17816 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17818 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17819 frame_row
->glyphs
[TEXT_AREA
] = start
;
17820 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17821 frame_row
->glyphs
[LAST_AREA
] = end
;
17823 /* Disable frame rows whose corresponding window rows have
17824 been disabled in try_window_id. */
17825 if (!window_row
->enabled_p
)
17826 frame_row
->enabled_p
= false;
17828 ++window_row
, ++frame_row
;
17833 /* Find the glyph row in window W containing CHARPOS. Consider all
17834 rows between START and END (not inclusive). END null means search
17835 all rows to the end of the display area of W. Value is the row
17836 containing CHARPOS or null. */
17839 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17840 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17842 struct glyph_row
*row
= start
;
17843 struct glyph_row
*best_row
= NULL
;
17844 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17847 /* If we happen to start on a header-line, skip that. */
17848 if (row
->mode_line_p
)
17851 if ((end
&& row
>= end
) || !row
->enabled_p
)
17854 last_y
= window_text_bottom_y (w
) - dy
;
17858 /* Give up if we have gone too far. */
17859 if ((end
&& row
>= end
) || !row
->enabled_p
)
17861 /* This formerly returned if they were equal.
17862 I think that both quantities are of a "last plus one" type;
17863 if so, when they are equal, the row is within the screen. -- rms. */
17864 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17867 /* If it is in this row, return this row. */
17868 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17869 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17870 /* The end position of a row equals the start
17871 position of the next row. If CHARPOS is there, we
17872 would rather consider it displayed in the next
17873 line, except when this line ends in ZV. */
17874 && !row_for_charpos_p (row
, charpos
)))
17875 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17879 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17880 || (!best_row
&& !row
->continued_p
))
17882 /* In bidi-reordered rows, there could be several rows whose
17883 edges surround CHARPOS, all of these rows belonging to
17884 the same continued line. We need to find the row which
17885 fits CHARPOS the best. */
17886 for (g
= row
->glyphs
[TEXT_AREA
];
17887 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17890 if (!STRINGP (g
->object
))
17892 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17894 mindif
= eabs (g
->charpos
- charpos
);
17896 /* Exact match always wins. */
17903 else if (best_row
&& !row
->continued_p
)
17910 /* Try to redisplay window W by reusing its existing display. W's
17911 current matrix must be up to date when this function is called,
17912 i.e., window_end_valid must be true.
17916 >= 1 if successful, i.e. display has been updated
17918 1 means the changes were in front of a newline that precedes
17919 the window start, and the whole current matrix was reused
17920 2 means the changes were after the last position displayed
17921 in the window, and the whole current matrix was reused
17922 3 means portions of the current matrix were reused, while
17923 some of the screen lines were redrawn
17924 -1 if redisplay with same window start is known not to succeed
17925 0 if otherwise unsuccessful
17927 The following steps are performed:
17929 1. Find the last row in the current matrix of W that is not
17930 affected by changes at the start of current_buffer. If no such row
17933 2. Find the first row in W's current matrix that is not affected by
17934 changes at the end of current_buffer. Maybe there is no such row.
17936 3. Display lines beginning with the row + 1 found in step 1 to the
17937 row found in step 2 or, if step 2 didn't find a row, to the end of
17940 4. If cursor is not known to appear on the window, give up.
17942 5. If display stopped at the row found in step 2, scroll the
17943 display and current matrix as needed.
17945 6. Maybe display some lines at the end of W, if we must. This can
17946 happen under various circumstances, like a partially visible line
17947 becoming fully visible, or because newly displayed lines are displayed
17948 in smaller font sizes.
17950 7. Update W's window end information. */
17953 try_window_id (struct window
*w
)
17955 struct frame
*f
= XFRAME (w
->frame
);
17956 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17957 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17958 struct glyph_row
*last_unchanged_at_beg_row
;
17959 struct glyph_row
*first_unchanged_at_end_row
;
17960 struct glyph_row
*row
;
17961 struct glyph_row
*bottom_row
;
17964 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17966 struct text_pos start_pos
;
17968 int first_unchanged_at_end_vpos
= 0;
17969 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17970 struct text_pos start
;
17971 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17974 if (inhibit_try_window_id
)
17978 /* This is handy for debugging. */
17980 #define GIVE_UP(X) \
17982 TRACE ((stderr, "try_window_id give up %d\n", (X))); \
17986 #define GIVE_UP(X) return 0
17989 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17991 /* Don't use this for mini-windows because these can show
17992 messages and mini-buffers, and we don't handle that here. */
17993 if (MINI_WINDOW_P (w
))
17996 /* This flag is used to prevent redisplay optimizations. */
17997 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
18000 /* This function's optimizations cannot be used if overlays have
18001 changed in the buffer displayed by the window, so give up if they
18003 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
18006 /* Verify that narrowing has not changed.
18007 Also verify that we were not told to prevent redisplay optimizations.
18008 It would be nice to further
18009 reduce the number of cases where this prevents try_window_id. */
18010 if (current_buffer
->clip_changed
18011 || current_buffer
->prevent_redisplay_optimizations_p
)
18014 /* Window must either use window-based redisplay or be full width. */
18015 if (!FRAME_WINDOW_P (f
)
18016 && (!FRAME_LINE_INS_DEL_OK (f
)
18017 || !WINDOW_FULL_WIDTH_P (w
)))
18020 /* Give up if point is known NOT to appear in W. */
18021 if (PT
< CHARPOS (start
))
18024 /* Another way to prevent redisplay optimizations. */
18025 if (w
->last_modified
== 0)
18028 /* Verify that window is not hscrolled. */
18029 if (w
->hscroll
!= 0)
18032 /* Verify that display wasn't paused. */
18033 if (!w
->window_end_valid
)
18036 /* Likewise if highlighting trailing whitespace. */
18037 if (!NILP (Vshow_trailing_whitespace
))
18040 /* Can't use this if overlay arrow position and/or string have
18042 if (overlay_arrows_changed_p ())
18045 /* When word-wrap is on, adding a space to the first word of a
18046 wrapped line can change the wrap position, altering the line
18047 above it. It might be worthwhile to handle this more
18048 intelligently, but for now just redisplay from scratch. */
18049 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
18052 /* Under bidi reordering, adding or deleting a character in the
18053 beginning of a paragraph, before the first strong directional
18054 character, can change the base direction of the paragraph (unless
18055 the buffer specifies a fixed paragraph direction), which will
18056 require redisplaying the whole paragraph. It might be worthwhile
18057 to find the paragraph limits and widen the range of redisplayed
18058 lines to that, but for now just give up this optimization and
18059 redisplay from scratch. */
18060 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
18061 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
18064 /* Give up if the buffer has line-spacing set, as Lisp-level changes
18065 to that variable require thorough redisplay. */
18066 if (!NILP (BVAR (XBUFFER (w
->contents
), extra_line_spacing
)))
18069 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
18070 only if buffer has really changed. The reason is that the gap is
18071 initially at Z for freshly visited files. The code below would
18072 set end_unchanged to 0 in that case. */
18073 if (MODIFF
> SAVE_MODIFF
18074 /* This seems to happen sometimes after saving a buffer. */
18075 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
18077 if (GPT
- BEG
< BEG_UNCHANGED
)
18078 BEG_UNCHANGED
= GPT
- BEG
;
18079 if (Z
- GPT
< END_UNCHANGED
)
18080 END_UNCHANGED
= Z
- GPT
;
18083 /* The position of the first and last character that has been changed. */
18084 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
18085 last_changed_charpos
= Z
- END_UNCHANGED
;
18087 /* If window starts after a line end, and the last change is in
18088 front of that newline, then changes don't affect the display.
18089 This case happens with stealth-fontification. Note that although
18090 the display is unchanged, glyph positions in the matrix have to
18091 be adjusted, of course. */
18092 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
18093 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
18094 && ((last_changed_charpos
< CHARPOS (start
)
18095 && CHARPOS (start
) == BEGV
)
18096 || (last_changed_charpos
< CHARPOS (start
) - 1
18097 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
18099 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
18100 struct glyph_row
*r0
;
18102 /* Compute how many chars/bytes have been added to or removed
18103 from the buffer. */
18104 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
18105 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
18106 Z_delta
= Z
- Z_old
;
18107 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
18109 /* Give up if PT is not in the window. Note that it already has
18110 been checked at the start of try_window_id that PT is not in
18111 front of the window start. */
18112 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
18115 /* If window start is unchanged, we can reuse the whole matrix
18116 as is, after adjusting glyph positions. No need to compute
18117 the window end again, since its offset from Z hasn't changed. */
18118 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18119 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
18120 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
18121 /* PT must not be in a partially visible line. */
18122 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
18123 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18125 /* Adjust positions in the glyph matrix. */
18126 if (Z_delta
|| Z_delta_bytes
)
18128 struct glyph_row
*r1
18129 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18130 increment_matrix_positions (w
->current_matrix
,
18131 MATRIX_ROW_VPOS (r0
, current_matrix
),
18132 MATRIX_ROW_VPOS (r1
, current_matrix
),
18133 Z_delta
, Z_delta_bytes
);
18136 /* Set the cursor. */
18137 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18139 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18144 /* Handle the case that changes are all below what is displayed in
18145 the window, and that PT is in the window. This shortcut cannot
18146 be taken if ZV is visible in the window, and text has been added
18147 there that is visible in the window. */
18148 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
18149 /* ZV is not visible in the window, or there are no
18150 changes at ZV, actually. */
18151 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
18152 || first_changed_charpos
== last_changed_charpos
))
18154 struct glyph_row
*r0
;
18156 /* Give up if PT is not in the window. Note that it already has
18157 been checked at the start of try_window_id that PT is not in
18158 front of the window start. */
18159 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
18162 /* If window start is unchanged, we can reuse the whole matrix
18163 as is, without changing glyph positions since no text has
18164 been added/removed in front of the window end. */
18165 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18166 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
18167 /* PT must not be in a partially visible line. */
18168 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
18169 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18171 /* We have to compute the window end anew since text
18172 could have been added/removed after it. */
18173 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18174 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18176 /* Set the cursor. */
18177 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18179 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18184 /* Give up if window start is in the changed area.
18186 The condition used to read
18188 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18190 but why that was tested escapes me at the moment. */
18191 if (CHARPOS (start
) >= first_changed_charpos
18192 && CHARPOS (start
) <= last_changed_charpos
)
18195 /* Check that window start agrees with the start of the first glyph
18196 row in its current matrix. Check this after we know the window
18197 start is not in changed text, otherwise positions would not be
18199 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18200 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
18203 /* Give up if the window ends in strings. Overlay strings
18204 at the end are difficult to handle, so don't try. */
18205 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
18206 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
18209 /* Compute the position at which we have to start displaying new
18210 lines. Some of the lines at the top of the window might be
18211 reusable because they are not displaying changed text. Find the
18212 last row in W's current matrix not affected by changes at the
18213 start of current_buffer. Value is null if changes start in the
18214 first line of window. */
18215 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18216 if (last_unchanged_at_beg_row
)
18218 /* Avoid starting to display in the middle of a character, a TAB
18219 for instance. This is easier than to set up the iterator
18220 exactly, and it's not a frequent case, so the additional
18221 effort wouldn't really pay off. */
18222 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18223 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18224 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18225 --last_unchanged_at_beg_row
;
18227 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18230 if (! init_to_row_end (&it
, w
, last_unchanged_at_beg_row
))
18232 start_pos
= it
.current
.pos
;
18234 /* Start displaying new lines in the desired matrix at the same
18235 vpos we would use in the current matrix, i.e. below
18236 last_unchanged_at_beg_row. */
18237 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18239 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18240 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18242 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18246 /* There are no reusable lines at the start of the window.
18247 Start displaying in the first text line. */
18248 start_display (&it
, w
, start
);
18249 it
.vpos
= it
.first_vpos
;
18250 start_pos
= it
.current
.pos
;
18253 /* Find the first row that is not affected by changes at the end of
18254 the buffer. Value will be null if there is no unchanged row, in
18255 which case we must redisplay to the end of the window. delta
18256 will be set to the value by which buffer positions beginning with
18257 first_unchanged_at_end_row have to be adjusted due to text
18259 first_unchanged_at_end_row
18260 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18261 IF_DEBUG (debug_delta
= delta
);
18262 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18264 /* Set stop_pos to the buffer position up to which we will have to
18265 display new lines. If first_unchanged_at_end_row != NULL, this
18266 is the buffer position of the start of the line displayed in that
18267 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18268 that we don't stop at a buffer position. */
18270 if (first_unchanged_at_end_row
)
18272 eassert (last_unchanged_at_beg_row
== NULL
18273 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18275 /* If this is a continuation line, move forward to the next one
18276 that isn't. Changes in lines above affect this line.
18277 Caution: this may move first_unchanged_at_end_row to a row
18278 not displaying text. */
18279 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18280 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18281 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18282 < it
.last_visible_y
))
18283 ++first_unchanged_at_end_row
;
18285 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18286 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18287 >= it
.last_visible_y
))
18288 first_unchanged_at_end_row
= NULL
;
18291 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18293 first_unchanged_at_end_vpos
18294 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18295 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18298 else if (last_unchanged_at_beg_row
== NULL
)
18304 /* Either there is no unchanged row at the end, or the one we have
18305 now displays text. This is a necessary condition for the window
18306 end pos calculation at the end of this function. */
18307 eassert (first_unchanged_at_end_row
== NULL
18308 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18310 debug_last_unchanged_at_beg_vpos
18311 = (last_unchanged_at_beg_row
18312 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18314 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18316 #endif /* GLYPH_DEBUG */
18319 /* Display new lines. Set last_text_row to the last new line
18320 displayed which has text on it, i.e. might end up as being the
18321 line where the window_end_vpos is. */
18322 w
->cursor
.vpos
= -1;
18323 last_text_row
= NULL
;
18324 overlay_arrow_seen
= false;
18325 if (it
.current_y
< it
.last_visible_y
18326 && !f
->fonts_changed
18327 && (first_unchanged_at_end_row
== NULL
18328 || IT_CHARPOS (it
) < stop_pos
))
18329 it
.glyph_row
->reversed_p
= false;
18330 while (it
.current_y
< it
.last_visible_y
18331 && !f
->fonts_changed
18332 && (first_unchanged_at_end_row
== NULL
18333 || IT_CHARPOS (it
) < stop_pos
))
18335 if (display_line (&it
))
18336 last_text_row
= it
.glyph_row
- 1;
18339 if (f
->fonts_changed
)
18342 /* The redisplay iterations in display_line above could have
18343 triggered font-lock, which could have done something that
18344 invalidates IT->w window's end-point information, on which we
18345 rely below. E.g., one package, which will remain unnamed, used
18346 to install a font-lock-fontify-region-function that called
18347 bury-buffer, whose side effect is to switch the buffer displayed
18348 by IT->w, and that predictably resets IT->w's window_end_valid
18349 flag, which we already tested at the entry to this function.
18350 Amply punish such packages/modes by giving up on this
18351 optimization in those cases. */
18352 if (!w
->window_end_valid
)
18354 clear_glyph_matrix (w
->desired_matrix
);
18358 /* Compute differences in buffer positions, y-positions etc. for
18359 lines reused at the bottom of the window. Compute what we can
18361 if (first_unchanged_at_end_row
18362 /* No lines reused because we displayed everything up to the
18363 bottom of the window. */
18364 && it
.current_y
< it
.last_visible_y
)
18367 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18369 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18370 run
.current_y
= first_unchanged_at_end_row
->y
;
18371 run
.desired_y
= run
.current_y
+ dy
;
18372 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18376 delta
= delta_bytes
= dvpos
= dy
18377 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18378 first_unchanged_at_end_row
= NULL
;
18380 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18383 /* Find the cursor if not already found. We have to decide whether
18384 PT will appear on this window (it sometimes doesn't, but this is
18385 not a very frequent case.) This decision has to be made before
18386 the current matrix is altered. A value of cursor.vpos < 0 means
18387 that PT is either in one of the lines beginning at
18388 first_unchanged_at_end_row or below the window. Don't care for
18389 lines that might be displayed later at the window end; as
18390 mentioned, this is not a frequent case. */
18391 if (w
->cursor
.vpos
< 0)
18393 /* Cursor in unchanged rows at the top? */
18394 if (PT
< CHARPOS (start_pos
)
18395 && last_unchanged_at_beg_row
)
18397 row
= row_containing_pos (w
, PT
,
18398 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18399 last_unchanged_at_beg_row
+ 1, 0);
18401 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18404 /* Start from first_unchanged_at_end_row looking for PT. */
18405 else if (first_unchanged_at_end_row
)
18407 row
= row_containing_pos (w
, PT
- delta
,
18408 first_unchanged_at_end_row
, NULL
, 0);
18410 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18411 delta_bytes
, dy
, dvpos
);
18414 /* Give up if cursor was not found. */
18415 if (w
->cursor
.vpos
< 0)
18417 clear_glyph_matrix (w
->desired_matrix
);
18422 /* Don't let the cursor end in the scroll margins. */
18424 int this_scroll_margin
, cursor_height
;
18425 int frame_line_height
= default_line_pixel_height (w
);
18426 int window_total_lines
18427 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18429 this_scroll_margin
=
18430 max (0, min (scroll_margin
, window_total_lines
/ 4));
18431 this_scroll_margin
*= frame_line_height
;
18432 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18434 if ((w
->cursor
.y
< this_scroll_margin
18435 && CHARPOS (start
) > BEGV
)
18436 /* Old redisplay didn't take scroll margin into account at the bottom,
18437 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18438 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18439 ? cursor_height
+ this_scroll_margin
18440 : 1)) > it
.last_visible_y
)
18442 w
->cursor
.vpos
= -1;
18443 clear_glyph_matrix (w
->desired_matrix
);
18448 /* Scroll the display. Do it before changing the current matrix so
18449 that xterm.c doesn't get confused about where the cursor glyph is
18451 if (dy
&& run
.height
)
18455 if (FRAME_WINDOW_P (f
))
18457 FRAME_RIF (f
)->update_window_begin_hook (w
);
18458 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18459 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18460 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
18464 /* Terminal frame. In this case, dvpos gives the number of
18465 lines to scroll by; dvpos < 0 means scroll up. */
18467 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18468 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18469 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18470 + WINDOW_WANTS_HEADER_LINE_P (w
)
18471 + window_internal_height (w
));
18473 #if defined (HAVE_GPM) || defined (MSDOS)
18474 x_clear_window_mouse_face (w
);
18476 /* Perform the operation on the screen. */
18479 /* Scroll last_unchanged_at_beg_row to the end of the
18480 window down dvpos lines. */
18481 set_terminal_window (f
, end
);
18483 /* On dumb terminals delete dvpos lines at the end
18484 before inserting dvpos empty lines. */
18485 if (!FRAME_SCROLL_REGION_OK (f
))
18486 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18488 /* Insert dvpos empty lines in front of
18489 last_unchanged_at_beg_row. */
18490 ins_del_lines (f
, from
, dvpos
);
18492 else if (dvpos
< 0)
18494 /* Scroll up last_unchanged_at_beg_vpos to the end of
18495 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18496 set_terminal_window (f
, end
);
18498 /* Delete dvpos lines in front of
18499 last_unchanged_at_beg_vpos. ins_del_lines will set
18500 the cursor to the given vpos and emit |dvpos| delete
18502 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18504 /* On a dumb terminal insert dvpos empty lines at the
18506 if (!FRAME_SCROLL_REGION_OK (f
))
18507 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18510 set_terminal_window (f
, 0);
18516 /* Shift reused rows of the current matrix to the right position.
18517 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18519 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18520 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18523 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18524 bottom_vpos
, dvpos
);
18525 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18528 else if (dvpos
> 0)
18530 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18531 bottom_vpos
, dvpos
);
18532 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18533 first_unchanged_at_end_vpos
+ dvpos
);
18536 /* For frame-based redisplay, make sure that current frame and window
18537 matrix are in sync with respect to glyph memory. */
18538 if (!FRAME_WINDOW_P (f
))
18539 sync_frame_with_window_matrix_rows (w
);
18541 /* Adjust buffer positions in reused rows. */
18542 if (delta
|| delta_bytes
)
18543 increment_matrix_positions (current_matrix
,
18544 first_unchanged_at_end_vpos
+ dvpos
,
18545 bottom_vpos
, delta
, delta_bytes
);
18547 /* Adjust Y positions. */
18549 shift_glyph_matrix (w
, current_matrix
,
18550 first_unchanged_at_end_vpos
+ dvpos
,
18553 if (first_unchanged_at_end_row
)
18555 first_unchanged_at_end_row
+= dvpos
;
18556 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18557 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18558 first_unchanged_at_end_row
= NULL
;
18561 /* If scrolling up, there may be some lines to display at the end of
18563 last_text_row_at_end
= NULL
;
18566 /* Scrolling up can leave for example a partially visible line
18567 at the end of the window to be redisplayed. */
18568 /* Set last_row to the glyph row in the current matrix where the
18569 window end line is found. It has been moved up or down in
18570 the matrix by dvpos. */
18571 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18572 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18574 /* If last_row is the window end line, it should display text. */
18575 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18577 /* If window end line was partially visible before, begin
18578 displaying at that line. Otherwise begin displaying with the
18579 line following it. */
18580 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18582 init_to_row_start (&it
, w
, last_row
);
18583 it
.vpos
= last_vpos
;
18584 it
.current_y
= last_row
->y
;
18588 init_to_row_end (&it
, w
, last_row
);
18589 it
.vpos
= 1 + last_vpos
;
18590 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18594 /* We may start in a continuation line. If so, we have to
18595 get the right continuation_lines_width and current_x. */
18596 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18597 it
.hpos
= it
.current_x
= 0;
18599 /* Display the rest of the lines at the window end. */
18600 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18601 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18603 /* Is it always sure that the display agrees with lines in
18604 the current matrix? I don't think so, so we mark rows
18605 displayed invalid in the current matrix by setting their
18606 enabled_p flag to false. */
18607 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18608 if (display_line (&it
))
18609 last_text_row_at_end
= it
.glyph_row
- 1;
18613 /* Update window_end_pos and window_end_vpos. */
18614 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18616 /* Window end line if one of the preserved rows from the current
18617 matrix. Set row to the last row displaying text in current
18618 matrix starting at first_unchanged_at_end_row, after
18620 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18621 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18622 first_unchanged_at_end_row
);
18623 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18624 adjust_window_ends (w
, row
, true);
18625 eassert (w
->window_end_bytepos
>= 0);
18626 IF_DEBUG (debug_method_add (w
, "A"));
18628 else if (last_text_row_at_end
)
18630 adjust_window_ends (w
, last_text_row_at_end
, false);
18631 eassert (w
->window_end_bytepos
>= 0);
18632 IF_DEBUG (debug_method_add (w
, "B"));
18634 else if (last_text_row
)
18636 /* We have displayed either to the end of the window or at the
18637 end of the window, i.e. the last row with text is to be found
18638 in the desired matrix. */
18639 adjust_window_ends (w
, last_text_row
, false);
18640 eassert (w
->window_end_bytepos
>= 0);
18642 else if (first_unchanged_at_end_row
== NULL
18643 && last_text_row
== NULL
18644 && last_text_row_at_end
== NULL
)
18646 /* Displayed to end of window, but no line containing text was
18647 displayed. Lines were deleted at the end of the window. */
18648 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
18649 int vpos
= w
->window_end_vpos
;
18650 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18651 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18654 row
== NULL
&& vpos
>= first_vpos
;
18655 --vpos
, --current_row
, --desired_row
)
18657 if (desired_row
->enabled_p
)
18659 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18662 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18666 eassert (row
!= NULL
);
18667 w
->window_end_vpos
= vpos
+ 1;
18668 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18669 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18670 eassert (w
->window_end_bytepos
>= 0);
18671 IF_DEBUG (debug_method_add (w
, "C"));
18676 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18677 debug_end_vpos
= w
->window_end_vpos
));
18679 /* Record that display has not been completed. */
18680 w
->window_end_valid
= false;
18681 w
->desired_matrix
->no_scrolling_p
= true;
18689 /***********************************************************************
18690 More debugging support
18691 ***********************************************************************/
18695 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18696 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18697 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18700 /* Dump the contents of glyph matrix MATRIX on stderr.
18702 GLYPHS 0 means don't show glyph contents.
18703 GLYPHS 1 means show glyphs in short form
18704 GLYPHS > 1 means show glyphs in long form. */
18707 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18710 for (i
= 0; i
< matrix
->nrows
; ++i
)
18711 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18715 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18716 the glyph row and area where the glyph comes from. */
18719 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18721 if (glyph
->type
== CHAR_GLYPH
18722 || glyph
->type
== GLYPHLESS_GLYPH
)
18725 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18726 glyph
- row
->glyphs
[TEXT_AREA
],
18727 (glyph
->type
== CHAR_GLYPH
18731 (BUFFERP (glyph
->object
)
18733 : (STRINGP (glyph
->object
)
18735 : (NILP (glyph
->object
)
18738 glyph
->pixel_width
,
18740 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18744 glyph
->left_box_line_p
,
18745 glyph
->right_box_line_p
);
18747 else if (glyph
->type
== STRETCH_GLYPH
)
18750 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18751 glyph
- row
->glyphs
[TEXT_AREA
],
18754 (BUFFERP (glyph
->object
)
18756 : (STRINGP (glyph
->object
)
18758 : (NILP (glyph
->object
)
18761 glyph
->pixel_width
,
18765 glyph
->left_box_line_p
,
18766 glyph
->right_box_line_p
);
18768 else if (glyph
->type
== IMAGE_GLYPH
)
18771 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18772 glyph
- row
->glyphs
[TEXT_AREA
],
18775 (BUFFERP (glyph
->object
)
18777 : (STRINGP (glyph
->object
)
18779 : (NILP (glyph
->object
)
18782 glyph
->pixel_width
,
18786 glyph
->left_box_line_p
,
18787 glyph
->right_box_line_p
);
18789 else if (glyph
->type
== COMPOSITE_GLYPH
)
18792 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18793 glyph
- row
->glyphs
[TEXT_AREA
],
18796 (BUFFERP (glyph
->object
)
18798 : (STRINGP (glyph
->object
)
18800 : (NILP (glyph
->object
)
18803 glyph
->pixel_width
,
18805 if (glyph
->u
.cmp
.automatic
)
18808 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18809 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18811 glyph
->left_box_line_p
,
18812 glyph
->right_box_line_p
);
18814 else if (glyph
->type
== XWIDGET_GLYPH
)
18816 #ifndef HAVE_XWIDGETS
18820 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
18821 glyph
- row
->glyphs
[TEXT_AREA
],
18824 (BUFFERP (glyph
->object
)
18826 : (STRINGP (glyph
->object
)
18829 glyph
->pixel_width
,
18833 glyph
->left_box_line_p
,
18834 glyph
->right_box_line_p
);
18840 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18841 GLYPHS 0 means don't show glyph contents.
18842 GLYPHS 1 means show glyphs in short form
18843 GLYPHS > 1 means show glyphs in long form. */
18846 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18850 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18851 fprintf (stderr
, "==============================================================================\n");
18853 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18854 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18856 MATRIX_ROW_START_CHARPOS (row
),
18857 MATRIX_ROW_END_CHARPOS (row
),
18858 row
->used
[TEXT_AREA
],
18859 row
->contains_overlapping_glyphs_p
,
18861 row
->truncated_on_left_p
,
18862 row
->truncated_on_right_p
,
18864 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18865 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18868 row
->ends_in_middle_of_char_p
,
18869 row
->starts_in_middle_of_char_p
,
18875 row
->visible_height
,
18878 /* The next 3 lines should align to "Start" in the header. */
18879 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18880 row
->end
.overlay_string_index
,
18881 row
->continuation_lines_width
);
18882 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18883 CHARPOS (row
->start
.string_pos
),
18884 CHARPOS (row
->end
.string_pos
));
18885 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18886 row
->end
.dpvec_index
);
18893 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18895 struct glyph
*glyph
= row
->glyphs
[area
];
18896 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18898 /* Glyph for a line end in text. */
18899 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18902 if (glyph
< glyph_end
)
18903 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18905 for (; glyph
< glyph_end
; ++glyph
)
18906 dump_glyph (row
, glyph
, area
);
18909 else if (glyphs
== 1)
18912 char s
[SHRT_MAX
+ 4];
18914 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18918 for (i
= 0; i
< row
->used
[area
]; ++i
)
18920 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18921 if (i
== row
->used
[area
] - 1
18922 && area
== TEXT_AREA
18923 && NILP (glyph
->object
)
18924 && glyph
->type
== CHAR_GLYPH
18925 && glyph
->u
.ch
== ' ')
18927 strcpy (&s
[i
], "[\\n]");
18930 else if (glyph
->type
== CHAR_GLYPH
18931 && glyph
->u
.ch
< 0x80
18932 && glyph
->u
.ch
>= ' ')
18933 s
[i
] = glyph
->u
.ch
;
18939 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18945 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18946 Sdump_glyph_matrix
, 0, 1, "p",
18947 doc
: /* Dump the current matrix of the selected window to stderr.
18948 Shows contents of glyph row structures. With non-nil
18949 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18950 glyphs in short form, otherwise show glyphs in long form.
18952 Interactively, no argument means show glyphs in short form;
18953 with numeric argument, its value is passed as the GLYPHS flag. */)
18954 (Lisp_Object glyphs
)
18956 struct window
*w
= XWINDOW (selected_window
);
18957 struct buffer
*buffer
= XBUFFER (w
->contents
);
18959 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18960 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18961 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18962 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18963 fprintf (stderr
, "=============================================\n");
18964 dump_glyph_matrix (w
->current_matrix
,
18965 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18970 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18971 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* Dump the current glyph matrix of the selected frame to stderr.
18972 Only text-mode frames have frame glyph matrices. */)
18975 struct frame
*f
= XFRAME (selected_frame
);
18977 if (f
->current_matrix
)
18978 dump_glyph_matrix (f
->current_matrix
, 1);
18980 fprintf (stderr
, "*** This frame doesn't have a frame glyph matrix ***\n");
18985 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18986 doc
: /* Dump glyph row ROW to stderr.
18987 GLYPH 0 means don't dump glyphs.
18988 GLYPH 1 means dump glyphs in short form.
18989 GLYPH > 1 or omitted means dump glyphs in long form. */)
18990 (Lisp_Object row
, Lisp_Object glyphs
)
18992 struct glyph_matrix
*matrix
;
18995 CHECK_NUMBER (row
);
18996 matrix
= XWINDOW (selected_window
)->current_matrix
;
18998 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18999 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
19001 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
19006 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
19007 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
19008 GLYPH 0 means don't dump glyphs.
19009 GLYPH 1 means dump glyphs in short form.
19010 GLYPH > 1 or omitted means dump glyphs in long form.
19012 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
19014 (Lisp_Object row
, Lisp_Object glyphs
)
19016 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19017 struct frame
*sf
= SELECTED_FRAME ();
19018 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
19021 CHECK_NUMBER (row
);
19023 if (vpos
>= 0 && vpos
< m
->nrows
)
19024 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
19025 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
19031 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
19032 doc
: /* Toggle tracing of redisplay.
19033 With ARG, turn tracing on if and only if ARG is positive. */)
19037 trace_redisplay_p
= !trace_redisplay_p
;
19040 arg
= Fprefix_numeric_value (arg
);
19041 trace_redisplay_p
= XINT (arg
) > 0;
19048 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
19049 doc
: /* Like `format', but print result to stderr.
19050 usage: (trace-to-stderr STRING &rest OBJECTS) */)
19051 (ptrdiff_t nargs
, Lisp_Object
*args
)
19053 Lisp_Object s
= Fformat (nargs
, args
);
19054 fwrite (SDATA (s
), 1, SBYTES (s
), stderr
);
19058 #endif /* GLYPH_DEBUG */
19062 /***********************************************************************
19063 Building Desired Matrix Rows
19064 ***********************************************************************/
19066 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
19067 Used for non-window-redisplay windows, and for windows w/o left fringe. */
19069 static struct glyph_row
*
19070 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
19072 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19073 struct buffer
*buffer
= XBUFFER (w
->contents
);
19074 struct buffer
*old
= current_buffer
;
19075 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
19076 ptrdiff_t arrow_len
= SCHARS (overlay_arrow_string
);
19077 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
19078 const unsigned char *p
;
19081 int n_glyphs_before
;
19083 set_buffer_temp (buffer
);
19084 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
19085 scratch_glyph_row
.reversed_p
= false;
19086 it
.glyph_row
->used
[TEXT_AREA
] = 0;
19087 SET_TEXT_POS (it
.position
, 0, 0);
19089 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
19091 while (p
< arrow_end
)
19093 Lisp_Object face
, ilisp
;
19095 /* Get the next character. */
19097 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
19100 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
19101 if (! ASCII_CHAR_P (it
.c
))
19102 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
19106 /* Get its face. */
19107 ilisp
= make_number (p
- arrow_string
);
19108 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
19109 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
19111 /* Compute its width, get its glyphs. */
19112 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
19113 SET_TEXT_POS (it
.position
, -1, -1);
19114 PRODUCE_GLYPHS (&it
);
19116 /* If this character doesn't fit any more in the line, we have
19117 to remove some glyphs. */
19118 if (it
.current_x
> it
.last_visible_x
)
19120 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19125 set_buffer_temp (old
);
19126 return it
.glyph_row
;
19130 /* Insert truncation glyphs at the start of IT->glyph_row. Which
19131 glyphs to insert is determined by produce_special_glyphs. */
19134 insert_left_trunc_glyphs (struct it
*it
)
19136 struct it truncate_it
;
19137 struct glyph
*from
, *end
, *to
, *toend
;
19139 eassert (!FRAME_WINDOW_P (it
->f
)
19140 || (!it
->glyph_row
->reversed_p
19141 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19142 || (it
->glyph_row
->reversed_p
19143 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
19145 /* Get the truncation glyphs. */
19147 truncate_it
.current_x
= 0;
19148 truncate_it
.face_id
= DEFAULT_FACE_ID
;
19149 truncate_it
.glyph_row
= &scratch_glyph_row
;
19150 truncate_it
.area
= TEXT_AREA
;
19151 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
19152 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
19153 truncate_it
.object
= Qnil
;
19154 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
19156 /* Overwrite glyphs from IT with truncation glyphs. */
19157 if (!it
->glyph_row
->reversed_p
)
19159 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19161 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19162 end
= from
+ tused
;
19163 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19164 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
19165 if (FRAME_WINDOW_P (it
->f
))
19167 /* On GUI frames, when variable-size fonts are displayed,
19168 the truncation glyphs may need more pixels than the row's
19169 glyphs they overwrite. We overwrite more glyphs to free
19170 enough screen real estate, and enlarge the stretch glyph
19171 on the right (see display_line), if there is one, to
19172 preserve the screen position of the truncation glyphs on
19175 struct glyph
*g
= to
;
19178 /* The first glyph could be partially visible, in which case
19179 it->glyph_row->x will be negative. But we want the left
19180 truncation glyphs to be aligned at the left margin of the
19181 window, so we override the x coordinate at which the row
19183 it
->glyph_row
->x
= 0;
19184 while (g
< toend
&& w
< it
->truncation_pixel_width
)
19186 w
+= g
->pixel_width
;
19189 if (g
- to
- tused
> 0)
19191 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
19192 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
19194 used
= it
->glyph_row
->used
[TEXT_AREA
];
19195 if (it
->glyph_row
->truncated_on_right_p
19196 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
19197 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
19200 int extra
= w
- it
->truncation_pixel_width
;
19202 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
19209 /* There may be padding glyphs left over. Overwrite them too. */
19210 if (!FRAME_WINDOW_P (it
->f
))
19212 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
19214 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19221 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
19225 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19227 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19228 that back to front. */
19229 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19230 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19231 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19232 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19233 if (FRAME_WINDOW_P (it
->f
))
19236 struct glyph
*g
= to
;
19238 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19240 w
+= g
->pixel_width
;
19243 if (to
- g
- tused
> 0)
19245 if (it
->glyph_row
->truncated_on_right_p
19246 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19247 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19249 int extra
= w
- it
->truncation_pixel_width
;
19251 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19255 while (from
>= end
&& to
>= toend
)
19257 if (!FRAME_WINDOW_P (it
->f
))
19259 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19262 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19263 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19264 while (from
>= end
&& to
>= toend
)
19270 /* Need to free some room before prepending additional
19272 int move_by
= from
- end
+ 1;
19273 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19274 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19276 for ( ; g
>= g0
; g
--)
19278 while (from
>= end
)
19280 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19285 /* Compute the hash code for ROW. */
19287 row_hash (struct glyph_row
*row
)
19290 unsigned hashval
= 0;
19292 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19293 for (k
= 0; k
< row
->used
[area
]; ++k
)
19294 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19295 + row
->glyphs
[area
][k
].u
.val
19296 + row
->glyphs
[area
][k
].face_id
19297 + row
->glyphs
[area
][k
].padding_p
19298 + (row
->glyphs
[area
][k
].type
<< 2));
19303 /* Compute the pixel height and width of IT->glyph_row.
19305 Most of the time, ascent and height of a display line will be equal
19306 to the max_ascent and max_height values of the display iterator
19307 structure. This is not the case if
19309 1. We hit ZV without displaying anything. In this case, max_ascent
19310 and max_height will be zero.
19312 2. We have some glyphs that don't contribute to the line height.
19313 (The glyph row flag contributes_to_line_height_p is for future
19314 pixmap extensions).
19316 The first case is easily covered by using default values because in
19317 these cases, the line height does not really matter, except that it
19318 must not be zero. */
19321 compute_line_metrics (struct it
*it
)
19323 struct glyph_row
*row
= it
->glyph_row
;
19325 if (FRAME_WINDOW_P (it
->f
))
19327 int i
, min_y
, max_y
;
19329 /* The line may consist of one space only, that was added to
19330 place the cursor on it. If so, the row's height hasn't been
19332 if (row
->height
== 0)
19334 if (it
->max_ascent
+ it
->max_descent
== 0)
19335 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19336 row
->ascent
= it
->max_ascent
;
19337 row
->height
= it
->max_ascent
+ it
->max_descent
;
19338 row
->phys_ascent
= it
->max_phys_ascent
;
19339 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19340 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19343 /* Compute the width of this line. */
19344 row
->pixel_width
= row
->x
;
19345 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19346 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19348 eassert (row
->pixel_width
>= 0);
19349 eassert (row
->ascent
>= 0 && row
->height
> 0);
19351 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19352 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19354 /* If first line's physical ascent is larger than its logical
19355 ascent, use the physical ascent, and make the row taller.
19356 This makes accented characters fully visible. */
19357 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19358 && row
->phys_ascent
> row
->ascent
)
19360 row
->height
+= row
->phys_ascent
- row
->ascent
;
19361 row
->ascent
= row
->phys_ascent
;
19364 /* Compute how much of the line is visible. */
19365 row
->visible_height
= row
->height
;
19367 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19368 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19370 if (row
->y
< min_y
)
19371 row
->visible_height
-= min_y
- row
->y
;
19372 if (row
->y
+ row
->height
> max_y
)
19373 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19377 row
->pixel_width
= row
->used
[TEXT_AREA
];
19378 if (row
->continued_p
)
19379 row
->pixel_width
-= it
->continuation_pixel_width
;
19380 else if (row
->truncated_on_right_p
)
19381 row
->pixel_width
-= it
->truncation_pixel_width
;
19382 row
->ascent
= row
->phys_ascent
= 0;
19383 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19384 row
->extra_line_spacing
= 0;
19387 /* Compute a hash code for this row. */
19388 row
->hash
= row_hash (row
);
19390 it
->max_ascent
= it
->max_descent
= 0;
19391 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19395 /* Append one space to the glyph row of iterator IT if doing a
19396 window-based redisplay. The space has the same face as
19397 IT->face_id. Value is true if a space was added.
19399 This function is called to make sure that there is always one glyph
19400 at the end of a glyph row that the cursor can be set on under
19401 window-systems. (If there weren't such a glyph we would not know
19402 how wide and tall a box cursor should be displayed).
19404 At the same time this space let's a nicely handle clearing to the
19405 end of the line if the row ends in italic text. */
19408 append_space_for_newline (struct it
*it
, bool default_face_p
)
19410 if (FRAME_WINDOW_P (it
->f
))
19412 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19414 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19415 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19417 /* Save some values that must not be changed.
19418 Must save IT->c and IT->len because otherwise
19419 ITERATOR_AT_END_P wouldn't work anymore after
19420 append_space_for_newline has been called. */
19421 enum display_element_type saved_what
= it
->what
;
19422 int saved_c
= it
->c
, saved_len
= it
->len
;
19423 int saved_char_to_display
= it
->char_to_display
;
19424 int saved_x
= it
->current_x
;
19425 int saved_face_id
= it
->face_id
;
19426 bool saved_box_end
= it
->end_of_box_run_p
;
19427 struct text_pos saved_pos
;
19428 Lisp_Object saved_object
;
19432 saved_object
= it
->object
;
19433 saved_pos
= it
->position
;
19435 it
->what
= IT_CHARACTER
;
19436 memset (&it
->position
, 0, sizeof it
->position
);
19438 it
->c
= it
->char_to_display
= ' ';
19441 /* If the default face was remapped, be sure to use the
19442 remapped face for the appended newline. */
19443 if (default_face_p
)
19444 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19445 else if (it
->face_before_selective_p
)
19446 it
->face_id
= it
->saved_face_id
;
19447 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19448 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19449 /* In R2L rows, we will prepend a stretch glyph that will
19450 have the end_of_box_run_p flag set for it, so there's no
19451 need for the appended newline glyph to have that flag
19453 if (it
->glyph_row
->reversed_p
19454 /* But if the appended newline glyph goes all the way to
19455 the end of the row, there will be no stretch glyph,
19456 so leave the box flag set. */
19457 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19458 it
->end_of_box_run_p
= false;
19460 PRODUCE_GLYPHS (it
);
19462 #ifdef HAVE_WINDOW_SYSTEM
19463 /* Make sure this space glyph has the right ascent and
19464 descent values, or else cursor at end of line will look
19465 funny, and height of empty lines will be incorrect. */
19466 g
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19467 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
19470 Lisp_Object height
, total_height
;
19471 int extra_line_spacing
= it
->extra_line_spacing
;
19472 int boff
= font
->baseline_offset
;
19474 if (font
->vertical_centering
)
19475 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
19477 it
->object
= saved_object
; /* get_it_property needs this */
19478 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
19479 /* Must do a subset of line height processing from
19480 x_produce_glyph for newline characters. */
19481 height
= get_it_property (it
, Qline_height
);
19483 && CONSP (XCDR (height
))
19484 && NILP (XCDR (XCDR (height
))))
19486 total_height
= XCAR (XCDR (height
));
19487 height
= XCAR (height
);
19490 total_height
= Qnil
;
19491 height
= calc_line_height_property (it
, height
, font
, boff
, true);
19493 if (it
->override_ascent
>= 0)
19495 it
->ascent
= it
->override_ascent
;
19496 it
->descent
= it
->override_descent
;
19497 boff
= it
->override_boff
;
19499 if (EQ (height
, Qt
))
19500 extra_line_spacing
= 0;
19503 Lisp_Object spacing
;
19505 it
->phys_ascent
= it
->ascent
;
19506 it
->phys_descent
= it
->descent
;
19508 && XINT (height
) > it
->ascent
+ it
->descent
)
19509 it
->ascent
= XINT (height
) - it
->descent
;
19511 if (!NILP (total_height
))
19512 spacing
= calc_line_height_property (it
, total_height
, font
,
19516 spacing
= get_it_property (it
, Qline_spacing
);
19517 spacing
= calc_line_height_property (it
, spacing
, font
,
19520 if (INTEGERP (spacing
))
19522 extra_line_spacing
= XINT (spacing
);
19523 if (!NILP (total_height
))
19524 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
19527 if (extra_line_spacing
> 0)
19529 it
->descent
+= extra_line_spacing
;
19530 if (extra_line_spacing
> it
->max_extra_line_spacing
)
19531 it
->max_extra_line_spacing
= extra_line_spacing
;
19533 it
->max_ascent
= it
->ascent
;
19534 it
->max_descent
= it
->descent
;
19535 /* Make sure compute_line_metrics recomputes the row height. */
19536 it
->glyph_row
->height
= 0;
19539 g
->ascent
= it
->max_ascent
;
19540 g
->descent
= it
->max_descent
;
19543 it
->override_ascent
= -1;
19544 it
->constrain_row_ascent_descent_p
= false;
19545 it
->current_x
= saved_x
;
19546 it
->object
= saved_object
;
19547 it
->position
= saved_pos
;
19548 it
->what
= saved_what
;
19549 it
->face_id
= saved_face_id
;
19550 it
->len
= saved_len
;
19552 it
->char_to_display
= saved_char_to_display
;
19553 it
->end_of_box_run_p
= saved_box_end
;
19562 /* Extend the face of the last glyph in the text area of IT->glyph_row
19563 to the end of the display line. Called from display_line. If the
19564 glyph row is empty, add a space glyph to it so that we know the
19565 face to draw. Set the glyph row flag fill_line_p. If the glyph
19566 row is R2L, prepend a stretch glyph to cover the empty space to the
19567 left of the leftmost glyph. */
19570 extend_face_to_end_of_line (struct it
*it
)
19572 struct face
*face
, *default_face
;
19573 struct frame
*f
= it
->f
;
19575 /* If line is already filled, do nothing. Non window-system frames
19576 get a grace of one more ``pixel'' because their characters are
19577 1-``pixel'' wide, so they hit the equality too early. This grace
19578 is needed only for R2L rows that are not continued, to produce
19579 one extra blank where we could display the cursor. */
19580 if ((it
->current_x
>= it
->last_visible_x
19581 + (!FRAME_WINDOW_P (f
)
19582 && it
->glyph_row
->reversed_p
19583 && !it
->glyph_row
->continued_p
))
19584 /* If the window has display margins, we will need to extend
19585 their face even if the text area is filled. */
19586 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19587 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19590 /* The default face, possibly remapped. */
19591 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19593 /* Face extension extends the background and box of IT->face_id
19594 to the end of the line. If the background equals the background
19595 of the frame, we don't have to do anything. */
19596 if (it
->face_before_selective_p
)
19597 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19599 face
= FACE_FROM_ID (f
, it
->face_id
);
19601 if (FRAME_WINDOW_P (f
)
19602 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19603 && face
->box
== FACE_NO_BOX
19604 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19605 #ifdef HAVE_WINDOW_SYSTEM
19608 && !it
->glyph_row
->reversed_p
)
19611 /* Set the glyph row flag indicating that the face of the last glyph
19612 in the text area has to be drawn to the end of the text area. */
19613 it
->glyph_row
->fill_line_p
= true;
19615 /* If current character of IT is not ASCII, make sure we have the
19616 ASCII face. This will be automatically undone the next time
19617 get_next_display_element returns a multibyte character. Note
19618 that the character will always be single byte in unibyte
19620 if (!ASCII_CHAR_P (it
->c
))
19622 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19625 if (FRAME_WINDOW_P (f
))
19627 /* If the row is empty, add a space with the current face of IT,
19628 so that we know which face to draw. */
19629 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19631 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19632 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19633 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19635 /* Mode line and the header line don't have margins, and
19636 likewise the frame's tool-bar window, if there is any. */
19637 if (!(it
->glyph_row
->mode_line_p
19638 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19639 || (WINDOWP (f
->tool_bar_window
)
19640 && it
->w
== XWINDOW (f
->tool_bar_window
))
19644 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19645 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19647 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19648 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19650 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19652 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19653 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19655 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19656 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19658 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19661 #ifdef HAVE_WINDOW_SYSTEM
19662 if (it
->glyph_row
->reversed_p
)
19664 /* Prepend a stretch glyph to the row, such that the
19665 rightmost glyph will be drawn flushed all the way to the
19666 right margin of the window. The stretch glyph that will
19667 occupy the empty space, if any, to the left of the
19669 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19670 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19671 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19673 int row_width
, stretch_ascent
, stretch_width
;
19674 struct text_pos saved_pos
;
19676 bool saved_avoid_cursor
, saved_box_start
;
19678 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19679 row_width
+= g
->pixel_width
;
19681 /* FIXME: There are various minor display glitches in R2L
19682 rows when only one of the fringes is missing. The
19683 strange condition below produces the least bad effect. */
19684 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19685 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19686 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19687 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19689 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19690 stretch_width
-= row_width
;
19692 if (stretch_width
> 0)
19695 (((it
->ascent
+ it
->descent
)
19696 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19697 saved_pos
= it
->position
;
19698 memset (&it
->position
, 0, sizeof it
->position
);
19699 saved_avoid_cursor
= it
->avoid_cursor_p
;
19700 it
->avoid_cursor_p
= true;
19701 saved_face_id
= it
->face_id
;
19702 saved_box_start
= it
->start_of_box_run_p
;
19703 /* The last row's stretch glyph should get the default
19704 face, to avoid painting the rest of the window with
19705 the region face, if the region ends at ZV. */
19706 if (it
->glyph_row
->ends_at_zv_p
)
19707 it
->face_id
= default_face
->id
;
19709 it
->face_id
= face
->id
;
19710 it
->start_of_box_run_p
= false;
19711 append_stretch_glyph (it
, Qnil
, stretch_width
,
19712 it
->ascent
+ it
->descent
, stretch_ascent
);
19713 it
->position
= saved_pos
;
19714 it
->avoid_cursor_p
= saved_avoid_cursor
;
19715 it
->face_id
= saved_face_id
;
19716 it
->start_of_box_run_p
= saved_box_start
;
19718 /* If stretch_width comes out negative, it means that the
19719 last glyph is only partially visible. In R2L rows, we
19720 want the leftmost glyph to be partially visible, so we
19721 need to give the row the corresponding left offset. */
19722 if (stretch_width
< 0)
19723 it
->glyph_row
->x
= stretch_width
;
19725 #endif /* HAVE_WINDOW_SYSTEM */
19729 /* Save some values that must not be changed. */
19730 int saved_x
= it
->current_x
;
19731 struct text_pos saved_pos
;
19732 Lisp_Object saved_object
;
19733 enum display_element_type saved_what
= it
->what
;
19734 int saved_face_id
= it
->face_id
;
19736 saved_object
= it
->object
;
19737 saved_pos
= it
->position
;
19739 it
->what
= IT_CHARACTER
;
19740 memset (&it
->position
, 0, sizeof it
->position
);
19742 it
->c
= it
->char_to_display
= ' ';
19745 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19746 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19747 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19748 && !it
->glyph_row
->mode_line_p
19749 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19751 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19752 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19754 for (it
->current_x
= 0; g
< e
; g
++)
19755 it
->current_x
+= g
->pixel_width
;
19757 it
->area
= LEFT_MARGIN_AREA
;
19758 it
->face_id
= default_face
->id
;
19759 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19760 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19762 PRODUCE_GLYPHS (it
);
19763 /* term.c:produce_glyphs advances it->current_x only for
19765 it
->current_x
+= it
->pixel_width
;
19768 it
->current_x
= saved_x
;
19769 it
->area
= TEXT_AREA
;
19772 /* The last row's blank glyphs should get the default face, to
19773 avoid painting the rest of the window with the region face,
19774 if the region ends at ZV. */
19775 if (it
->glyph_row
->ends_at_zv_p
)
19776 it
->face_id
= default_face
->id
;
19778 it
->face_id
= face
->id
;
19779 PRODUCE_GLYPHS (it
);
19781 while (it
->current_x
<= it
->last_visible_x
)
19782 PRODUCE_GLYPHS (it
);
19784 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19785 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19786 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19787 && !it
->glyph_row
->mode_line_p
19788 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19790 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19791 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19793 for ( ; g
< e
; g
++)
19794 it
->current_x
+= g
->pixel_width
;
19796 it
->area
= RIGHT_MARGIN_AREA
;
19797 it
->face_id
= default_face
->id
;
19798 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19799 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19801 PRODUCE_GLYPHS (it
);
19802 it
->current_x
+= it
->pixel_width
;
19805 it
->area
= TEXT_AREA
;
19808 /* Don't count these blanks really. It would let us insert a left
19809 truncation glyph below and make us set the cursor on them, maybe. */
19810 it
->current_x
= saved_x
;
19811 it
->object
= saved_object
;
19812 it
->position
= saved_pos
;
19813 it
->what
= saved_what
;
19814 it
->face_id
= saved_face_id
;
19819 /* Value is true if text starting at CHARPOS in current_buffer is
19820 trailing whitespace. */
19823 trailing_whitespace_p (ptrdiff_t charpos
)
19825 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19828 while (bytepos
< ZV_BYTE
19829 && (c
= FETCH_CHAR (bytepos
),
19830 c
== ' ' || c
== '\t'))
19833 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19835 if (bytepos
!= PT_BYTE
)
19842 /* Highlight trailing whitespace, if any, in ROW. */
19845 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19847 int used
= row
->used
[TEXT_AREA
];
19851 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19852 struct glyph
*glyph
= start
+ used
- 1;
19854 if (row
->reversed_p
)
19856 /* Right-to-left rows need to be processed in the opposite
19857 direction, so swap the edge pointers. */
19859 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19862 /* Skip over glyphs inserted to display the cursor at the
19863 end of a line, for extending the face of the last glyph
19864 to the end of the line on terminals, and for truncation
19865 and continuation glyphs. */
19866 if (!row
->reversed_p
)
19868 while (glyph
>= start
19869 && glyph
->type
== CHAR_GLYPH
19870 && NILP (glyph
->object
))
19875 while (glyph
<= start
19876 && glyph
->type
== CHAR_GLYPH
19877 && NILP (glyph
->object
))
19881 /* If last glyph is a space or stretch, and it's trailing
19882 whitespace, set the face of all trailing whitespace glyphs in
19883 IT->glyph_row to `trailing-whitespace'. */
19884 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19885 && BUFFERP (glyph
->object
)
19886 && (glyph
->type
== STRETCH_GLYPH
19887 || (glyph
->type
== CHAR_GLYPH
19888 && glyph
->u
.ch
== ' '))
19889 && trailing_whitespace_p (glyph
->charpos
))
19891 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, false);
19895 if (!row
->reversed_p
)
19897 while (glyph
>= start
19898 && BUFFERP (glyph
->object
)
19899 && (glyph
->type
== STRETCH_GLYPH
19900 || (glyph
->type
== CHAR_GLYPH
19901 && glyph
->u
.ch
== ' ')))
19902 (glyph
--)->face_id
= face_id
;
19906 while (glyph
<= start
19907 && BUFFERP (glyph
->object
)
19908 && (glyph
->type
== STRETCH_GLYPH
19909 || (glyph
->type
== CHAR_GLYPH
19910 && glyph
->u
.ch
== ' ')))
19911 (glyph
++)->face_id
= face_id
;
19918 /* Value is true if glyph row ROW should be
19919 considered to hold the buffer position CHARPOS. */
19922 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19924 bool result
= true;
19926 if (charpos
== CHARPOS (row
->end
.pos
)
19927 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19929 /* Suppose the row ends on a string.
19930 Unless the row is continued, that means it ends on a newline
19931 in the string. If it's anything other than a display string
19932 (e.g., a before-string from an overlay), we don't want the
19933 cursor there. (This heuristic seems to give the optimal
19934 behavior for the various types of multi-line strings.)
19935 One exception: if the string has `cursor' property on one of
19936 its characters, we _do_ want the cursor there. */
19937 if (CHARPOS (row
->end
.string_pos
) >= 0)
19939 if (row
->continued_p
)
19943 /* Check for `display' property. */
19944 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19945 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19946 struct glyph
*glyph
;
19949 for (glyph
= end
; glyph
>= beg
; --glyph
)
19950 if (STRINGP (glyph
->object
))
19953 = Fget_char_property (make_number (charpos
),
19957 && display_prop_string_p (prop
, glyph
->object
));
19958 /* If there's a `cursor' property on one of the
19959 string's characters, this row is a cursor row,
19960 even though this is not a display string. */
19963 Lisp_Object s
= glyph
->object
;
19965 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19967 ptrdiff_t gpos
= glyph
->charpos
;
19969 if (!NILP (Fget_char_property (make_number (gpos
),
19981 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19983 /* If the row ends in middle of a real character,
19984 and the line is continued, we want the cursor here.
19985 That's because CHARPOS (ROW->end.pos) would equal
19986 PT if PT is before the character. */
19987 if (!row
->ends_in_ellipsis_p
)
19988 result
= row
->continued_p
;
19990 /* If the row ends in an ellipsis, then
19991 CHARPOS (ROW->end.pos) will equal point after the
19992 invisible text. We want that position to be displayed
19993 after the ellipsis. */
19996 /* If the row ends at ZV, display the cursor at the end of that
19997 row instead of at the start of the row below. */
19999 result
= row
->ends_at_zv_p
;
20005 /* Value is true if glyph row ROW should be
20006 used to hold the cursor. */
20009 cursor_row_p (struct glyph_row
*row
)
20011 return row_for_charpos_p (row
, PT
);
20016 /* Push the property PROP so that it will be rendered at the current
20017 position in IT. Return true if PROP was successfully pushed, false
20018 otherwise. Called from handle_line_prefix to handle the
20019 `line-prefix' and `wrap-prefix' properties. */
20022 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
20024 struct text_pos pos
=
20025 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
20027 eassert (it
->method
== GET_FROM_BUFFER
20028 || it
->method
== GET_FROM_DISPLAY_VECTOR
20029 || it
->method
== GET_FROM_STRING
20030 || it
->method
== GET_FROM_IMAGE
);
20032 /* We need to save the current buffer/string position, so it will be
20033 restored by pop_it, because iterate_out_of_display_property
20034 depends on that being set correctly, but some situations leave
20035 it->position not yet set when this function is called. */
20036 push_it (it
, &pos
);
20038 if (STRINGP (prop
))
20040 if (SCHARS (prop
) == 0)
20047 it
->string_from_prefix_prop_p
= true;
20048 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
20049 it
->current
.overlay_string_index
= -1;
20050 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
20051 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
20052 it
->method
= GET_FROM_STRING
;
20053 it
->stop_charpos
= 0;
20055 it
->base_level_stop
= 0;
20057 /* Force paragraph direction to be that of the parent
20059 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
20060 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
20062 it
->paragraph_embedding
= L2R
;
20064 /* Set up the bidi iterator for this display string. */
20067 it
->bidi_it
.string
.lstring
= it
->string
;
20068 it
->bidi_it
.string
.s
= NULL
;
20069 it
->bidi_it
.string
.schars
= it
->end_charpos
;
20070 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
20071 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
20072 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
20073 it
->bidi_it
.w
= it
->w
;
20074 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
20077 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
20079 it
->method
= GET_FROM_STRETCH
;
20082 #ifdef HAVE_WINDOW_SYSTEM
20083 else if (IMAGEP (prop
))
20085 it
->what
= IT_IMAGE
;
20086 it
->image_id
= lookup_image (it
->f
, prop
);
20087 it
->method
= GET_FROM_IMAGE
;
20089 #endif /* HAVE_WINDOW_SYSTEM */
20092 pop_it (it
); /* bogus display property, give up */
20099 /* Return the character-property PROP at the current position in IT. */
20102 get_it_property (struct it
*it
, Lisp_Object prop
)
20104 Lisp_Object position
, object
= it
->object
;
20106 if (STRINGP (object
))
20107 position
= make_number (IT_STRING_CHARPOS (*it
));
20108 else if (BUFFERP (object
))
20110 position
= make_number (IT_CHARPOS (*it
));
20111 object
= it
->window
;
20116 return Fget_char_property (position
, prop
, object
);
20119 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
20122 handle_line_prefix (struct it
*it
)
20124 Lisp_Object prefix
;
20126 if (it
->continuation_lines_width
> 0)
20128 prefix
= get_it_property (it
, Qwrap_prefix
);
20130 prefix
= Vwrap_prefix
;
20134 prefix
= get_it_property (it
, Qline_prefix
);
20136 prefix
= Vline_prefix
;
20138 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
20140 /* If the prefix is wider than the window, and we try to wrap
20141 it, it would acquire its own wrap prefix, and so on till the
20142 iterator stack overflows. So, don't wrap the prefix. */
20143 it
->line_wrap
= TRUNCATE
;
20144 it
->avoid_cursor_p
= true;
20150 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
20151 only for R2L lines from display_line and display_string, when they
20152 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
20153 the line/string needs to be continued on the next glyph row. */
20155 unproduce_glyphs (struct it
*it
, int n
)
20157 struct glyph
*glyph
, *end
;
20159 eassert (it
->glyph_row
);
20160 eassert (it
->glyph_row
->reversed_p
);
20161 eassert (it
->area
== TEXT_AREA
);
20162 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
20164 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
20165 n
= it
->glyph_row
->used
[TEXT_AREA
];
20166 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
20167 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
20168 for ( ; glyph
< end
; glyph
++)
20169 glyph
[-n
] = *glyph
;
20172 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
20173 and ROW->maxpos. */
20175 find_row_edges (struct it
*it
, struct glyph_row
*row
,
20176 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
20177 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
20179 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20180 lines' rows is implemented for bidi-reordered rows. */
20182 /* ROW->minpos is the value of min_pos, the minimal buffer position
20183 we have in ROW, or ROW->start.pos if that is smaller. */
20184 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
20185 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
20187 /* We didn't find buffer positions smaller than ROW->start, or
20188 didn't find _any_ valid buffer positions in any of the glyphs,
20189 so we must trust the iterator's computed positions. */
20190 row
->minpos
= row
->start
.pos
;
20193 max_pos
= CHARPOS (it
->current
.pos
);
20194 max_bpos
= BYTEPOS (it
->current
.pos
);
20197 /* Here are the various use-cases for ending the row, and the
20198 corresponding values for ROW->maxpos:
20200 Line ends in a newline from buffer eol_pos + 1
20201 Line is continued from buffer max_pos + 1
20202 Line is truncated on right it->current.pos
20203 Line ends in a newline from string max_pos + 1(*)
20204 (*) + 1 only when line ends in a forward scan
20205 Line is continued from string max_pos
20206 Line is continued from display vector max_pos
20207 Line is entirely from a string min_pos == max_pos
20208 Line is entirely from a display vector min_pos == max_pos
20209 Line that ends at ZV ZV
20211 If you discover other use-cases, please add them here as
20213 if (row
->ends_at_zv_p
)
20214 row
->maxpos
= it
->current
.pos
;
20215 else if (row
->used
[TEXT_AREA
])
20217 bool seen_this_string
= false;
20218 struct glyph_row
*r1
= row
- 1;
20220 /* Did we see the same display string on the previous row? */
20221 if (STRINGP (it
->object
)
20222 /* this is not the first row */
20223 && row
> it
->w
->desired_matrix
->rows
20224 /* previous row is not the header line */
20225 && !r1
->mode_line_p
20226 /* previous row also ends in a newline from a string */
20227 && r1
->ends_in_newline_from_string_p
)
20229 struct glyph
*start
, *end
;
20231 /* Search for the last glyph of the previous row that came
20232 from buffer or string. Depending on whether the row is
20233 L2R or R2L, we need to process it front to back or the
20234 other way round. */
20235 if (!r1
->reversed_p
)
20237 start
= r1
->glyphs
[TEXT_AREA
];
20238 end
= start
+ r1
->used
[TEXT_AREA
];
20239 /* Glyphs inserted by redisplay have nil as their object. */
20241 && NILP ((end
- 1)->object
)
20242 && (end
- 1)->charpos
<= 0)
20246 if (EQ ((end
- 1)->object
, it
->object
))
20247 seen_this_string
= true;
20250 /* If all the glyphs of the previous row were inserted
20251 by redisplay, it means the previous row was
20252 produced from a single newline, which is only
20253 possible if that newline came from the same string
20254 as the one which produced this ROW. */
20255 seen_this_string
= true;
20259 end
= r1
->glyphs
[TEXT_AREA
] - 1;
20260 start
= end
+ r1
->used
[TEXT_AREA
];
20262 && NILP ((end
+ 1)->object
)
20263 && (end
+ 1)->charpos
<= 0)
20267 if (EQ ((end
+ 1)->object
, it
->object
))
20268 seen_this_string
= true;
20271 seen_this_string
= true;
20274 /* Take note of each display string that covers a newline only
20275 once, the first time we see it. This is for when a display
20276 string includes more than one newline in it. */
20277 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
20279 /* If we were scanning the buffer forward when we displayed
20280 the string, we want to account for at least one buffer
20281 position that belongs to this row (position covered by
20282 the display string), so that cursor positioning will
20283 consider this row as a candidate when point is at the end
20284 of the visual line represented by this row. This is not
20285 required when scanning back, because max_pos will already
20286 have a much larger value. */
20287 if (CHARPOS (row
->end
.pos
) > max_pos
)
20288 INC_BOTH (max_pos
, max_bpos
);
20289 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20291 else if (CHARPOS (it
->eol_pos
) > 0)
20292 SET_TEXT_POS (row
->maxpos
,
20293 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
20294 else if (row
->continued_p
)
20296 /* If max_pos is different from IT's current position, it
20297 means IT->method does not belong to the display element
20298 at max_pos. However, it also means that the display
20299 element at max_pos was displayed in its entirety on this
20300 line, which is equivalent to saying that the next line
20301 starts at the next buffer position. */
20302 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
20303 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20306 INC_BOTH (max_pos
, max_bpos
);
20307 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20310 else if (row
->truncated_on_right_p
)
20311 /* display_line already called reseat_at_next_visible_line_start,
20312 which puts the iterator at the beginning of the next line, in
20313 the logical order. */
20314 row
->maxpos
= it
->current
.pos
;
20315 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20316 /* A line that is entirely from a string/image/stretch... */
20317 row
->maxpos
= row
->minpos
;
20322 row
->maxpos
= it
->current
.pos
;
20325 /* Construct the glyph row IT->glyph_row in the desired matrix of
20326 IT->w from text at the current position of IT. See dispextern.h
20327 for an overview of struct it. Value is true if
20328 IT->glyph_row displays text, as opposed to a line displaying ZV
20332 display_line (struct it
*it
)
20334 struct glyph_row
*row
= it
->glyph_row
;
20335 Lisp_Object overlay_arrow_string
;
20337 void *wrap_data
= NULL
;
20338 bool may_wrap
= false;
20339 int wrap_x
IF_LINT (= 0);
20340 int wrap_row_used
= -1;
20341 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
20342 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
20343 int wrap_row_extra_line_spacing
IF_LINT (= 0);
20344 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
20345 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
20347 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20348 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
20349 bool pending_handle_line_prefix
= false;
20351 /* We always start displaying at hpos zero even if hscrolled. */
20352 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20354 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20355 >= it
->w
->desired_matrix
->nrows
)
20357 it
->w
->nrows_scale_factor
++;
20358 it
->f
->fonts_changed
= true;
20362 /* Clear the result glyph row and enable it. */
20363 prepare_desired_row (it
->w
, row
, false);
20365 row
->y
= it
->current_y
;
20366 row
->start
= it
->start
;
20367 row
->continuation_lines_width
= it
->continuation_lines_width
;
20368 row
->displays_text_p
= true;
20369 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20370 it
->starts_in_middle_of_char_p
= false;
20372 /* Arrange the overlays nicely for our purposes. Usually, we call
20373 display_line on only one line at a time, in which case this
20374 can't really hurt too much, or we call it on lines which appear
20375 one after another in the buffer, in which case all calls to
20376 recenter_overlay_lists but the first will be pretty cheap. */
20377 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20379 /* Move over display elements that are not visible because we are
20380 hscrolled. This may stop at an x-position < IT->first_visible_x
20381 if the first glyph is partially visible or if we hit a line end. */
20382 if (it
->current_x
< it
->first_visible_x
)
20384 enum move_it_result move_result
;
20386 this_line_min_pos
= row
->start
.pos
;
20387 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20388 MOVE_TO_POS
| MOVE_TO_X
);
20389 /* If we are under a large hscroll, move_it_in_display_line_to
20390 could hit the end of the line without reaching
20391 it->first_visible_x. Pretend that we did reach it. This is
20392 especially important on a TTY, where we will call
20393 extend_face_to_end_of_line, which needs to know how many
20394 blank glyphs to produce. */
20395 if (it
->current_x
< it
->first_visible_x
20396 && (move_result
== MOVE_NEWLINE_OR_CR
20397 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20398 it
->current_x
= it
->first_visible_x
;
20400 /* Record the smallest positions seen while we moved over
20401 display elements that are not visible. This is needed by
20402 redisplay_internal for optimizing the case where the cursor
20403 stays inside the same line. The rest of this function only
20404 considers positions that are actually displayed, so
20405 RECORD_MAX_MIN_POS will not otherwise record positions that
20406 are hscrolled to the left of the left edge of the window. */
20407 min_pos
= CHARPOS (this_line_min_pos
);
20408 min_bpos
= BYTEPOS (this_line_min_pos
);
20410 else if (it
->area
== TEXT_AREA
)
20412 /* We only do this when not calling move_it_in_display_line_to
20413 above, because that function calls itself handle_line_prefix. */
20414 handle_line_prefix (it
);
20418 /* Line-prefix and wrap-prefix are always displayed in the text
20419 area. But if this is the first call to display_line after
20420 init_iterator, the iterator might have been set up to write
20421 into a marginal area, e.g. if the line begins with some
20422 display property that writes to the margins. So we need to
20423 wait with the call to handle_line_prefix until whatever
20424 writes to the margin has done its job. */
20425 pending_handle_line_prefix
= true;
20428 /* Get the initial row height. This is either the height of the
20429 text hscrolled, if there is any, or zero. */
20430 row
->ascent
= it
->max_ascent
;
20431 row
->height
= it
->max_ascent
+ it
->max_descent
;
20432 row
->phys_ascent
= it
->max_phys_ascent
;
20433 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20434 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20436 /* Utility macro to record max and min buffer positions seen until now. */
20437 #define RECORD_MAX_MIN_POS(IT) \
20440 bool composition_p \
20441 = !STRINGP ((IT)->string) && ((IT)->what == IT_COMPOSITION); \
20442 ptrdiff_t current_pos = \
20443 composition_p ? (IT)->cmp_it.charpos \
20444 : IT_CHARPOS (*(IT)); \
20445 ptrdiff_t current_bpos = \
20446 composition_p ? CHAR_TO_BYTE (current_pos) \
20447 : IT_BYTEPOS (*(IT)); \
20448 if (current_pos < min_pos) \
20450 min_pos = current_pos; \
20451 min_bpos = current_bpos; \
20453 if (IT_CHARPOS (*it) > max_pos) \
20455 max_pos = IT_CHARPOS (*it); \
20456 max_bpos = IT_BYTEPOS (*it); \
20461 /* Loop generating characters. The loop is left with IT on the next
20462 character to display. */
20465 int n_glyphs_before
, hpos_before
, x_before
;
20467 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20469 /* Retrieve the next thing to display. Value is false if end of
20471 if (!get_next_display_element (it
))
20473 /* Maybe add a space at the end of this line that is used to
20474 display the cursor there under X. Set the charpos of the
20475 first glyph of blank lines not corresponding to any text
20477 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20478 row
->exact_window_width_line_p
= true;
20479 else if ((append_space_for_newline (it
, true)
20480 && row
->used
[TEXT_AREA
] == 1)
20481 || row
->used
[TEXT_AREA
] == 0)
20483 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20484 row
->displays_text_p
= false;
20486 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20487 && (!MINI_WINDOW_P (it
->w
)
20488 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20489 row
->indicate_empty_line_p
= true;
20492 it
->continuation_lines_width
= 0;
20493 row
->ends_at_zv_p
= true;
20494 /* A row that displays right-to-left text must always have
20495 its last face extended all the way to the end of line,
20496 even if this row ends in ZV, because we still write to
20497 the screen left to right. We also need to extend the
20498 last face if the default face is remapped to some
20499 different face, otherwise the functions that clear
20500 portions of the screen will clear with the default face's
20501 background color. */
20502 if (row
->reversed_p
20503 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20504 extend_face_to_end_of_line (it
);
20508 /* Now, get the metrics of what we want to display. This also
20509 generates glyphs in `row' (which is IT->glyph_row). */
20510 n_glyphs_before
= row
->used
[TEXT_AREA
];
20513 /* Remember the line height so far in case the next element doesn't
20514 fit on the line. */
20515 if (it
->line_wrap
!= TRUNCATE
)
20517 ascent
= it
->max_ascent
;
20518 descent
= it
->max_descent
;
20519 phys_ascent
= it
->max_phys_ascent
;
20520 phys_descent
= it
->max_phys_descent
;
20522 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20524 if (IT_DISPLAYING_WHITESPACE (it
))
20528 SAVE_IT (wrap_it
, *it
, wrap_data
);
20530 wrap_row_used
= row
->used
[TEXT_AREA
];
20531 wrap_row_ascent
= row
->ascent
;
20532 wrap_row_height
= row
->height
;
20533 wrap_row_phys_ascent
= row
->phys_ascent
;
20534 wrap_row_phys_height
= row
->phys_height
;
20535 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20536 wrap_row_min_pos
= min_pos
;
20537 wrap_row_min_bpos
= min_bpos
;
20538 wrap_row_max_pos
= max_pos
;
20539 wrap_row_max_bpos
= max_bpos
;
20545 PRODUCE_GLYPHS (it
);
20547 /* If this display element was in marginal areas, continue with
20549 if (it
->area
!= TEXT_AREA
)
20551 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20552 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20553 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20554 row
->phys_height
= max (row
->phys_height
,
20555 it
->max_phys_ascent
+ it
->max_phys_descent
);
20556 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20557 it
->max_extra_line_spacing
);
20558 set_iterator_to_next (it
, true);
20559 /* If we didn't handle the line/wrap prefix above, and the
20560 call to set_iterator_to_next just switched to TEXT_AREA,
20561 process the prefix now. */
20562 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20564 pending_handle_line_prefix
= false;
20565 handle_line_prefix (it
);
20570 /* Does the display element fit on the line? If we truncate
20571 lines, we should draw past the right edge of the window. If
20572 we don't truncate, we want to stop so that we can display the
20573 continuation glyph before the right margin. If lines are
20574 continued, there are two possible strategies for characters
20575 resulting in more than 1 glyph (e.g. tabs): Display as many
20576 glyphs as possible in this line and leave the rest for the
20577 continuation line, or display the whole element in the next
20578 line. Original redisplay did the former, so we do it also. */
20579 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20580 hpos_before
= it
->hpos
;
20583 if (/* Not a newline. */
20585 /* Glyphs produced fit entirely in the line. */
20586 && it
->current_x
< it
->last_visible_x
)
20588 it
->hpos
+= nglyphs
;
20589 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20590 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20591 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20592 row
->phys_height
= max (row
->phys_height
,
20593 it
->max_phys_ascent
+ it
->max_phys_descent
);
20594 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20595 it
->max_extra_line_spacing
);
20596 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20597 /* In R2L rows, we arrange in extend_face_to_end_of_line
20598 to add a right offset to the line, by a suitable
20599 change to the stretch glyph that is the leftmost
20600 glyph of the line. */
20601 && !row
->reversed_p
)
20602 row
->x
= x
- it
->first_visible_x
;
20603 /* Record the maximum and minimum buffer positions seen so
20604 far in glyphs that will be displayed by this row. */
20606 RECORD_MAX_MIN_POS (it
);
20611 struct glyph
*glyph
;
20613 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20615 /* Identify the glyphs added by the last call to
20616 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20617 the previous glyphs. */
20618 if (!row
->reversed_p
)
20619 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20621 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20622 new_x
= x
+ glyph
->pixel_width
;
20624 if (/* Lines are continued. */
20625 it
->line_wrap
!= TRUNCATE
20626 && (/* Glyph doesn't fit on the line. */
20627 new_x
> it
->last_visible_x
20628 /* Or it fits exactly on a window system frame. */
20629 || (new_x
== it
->last_visible_x
20630 && FRAME_WINDOW_P (it
->f
)
20631 && (row
->reversed_p
20632 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20633 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20635 /* End of a continued line. */
20638 || (new_x
== it
->last_visible_x
20639 && FRAME_WINDOW_P (it
->f
)
20640 && (row
->reversed_p
20641 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20642 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20644 /* Current glyph is the only one on the line or
20645 fits exactly on the line. We must continue
20646 the line because we can't draw the cursor
20647 after the glyph. */
20648 row
->continued_p
= true;
20649 it
->current_x
= new_x
;
20650 it
->continuation_lines_width
+= new_x
;
20652 if (i
== nglyphs
- 1)
20654 /* If line-wrap is on, check if a previous
20655 wrap point was found. */
20656 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)
20657 && wrap_row_used
> 0
20658 /* Even if there is a previous wrap
20659 point, continue the line here as
20660 usual, if (i) the previous character
20661 was a space or tab AND (ii) the
20662 current character is not. */
20664 || IT_DISPLAYING_WHITESPACE (it
)))
20667 /* Record the maximum and minimum buffer
20668 positions seen so far in glyphs that will be
20669 displayed by this row. */
20671 RECORD_MAX_MIN_POS (it
);
20672 set_iterator_to_next (it
, true);
20673 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20675 if (!get_next_display_element (it
))
20677 row
->exact_window_width_line_p
= true;
20678 it
->continuation_lines_width
= 0;
20679 row
->continued_p
= false;
20680 row
->ends_at_zv_p
= true;
20682 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20684 row
->continued_p
= false;
20685 row
->exact_window_width_line_p
= true;
20687 /* If line-wrap is on, check if a
20688 previous wrap point was found. */
20689 else if (wrap_row_used
> 0
20690 /* Even if there is a previous wrap
20691 point, continue the line here as
20692 usual, if (i) the previous character
20693 was a space or tab AND (ii) the
20694 current character is not. */
20696 || IT_DISPLAYING_WHITESPACE (it
)))
20701 else if (it
->bidi_p
)
20702 RECORD_MAX_MIN_POS (it
);
20703 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20704 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20705 extend_face_to_end_of_line (it
);
20707 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20708 && !FRAME_WINDOW_P (it
->f
))
20710 /* A padding glyph that doesn't fit on this line.
20711 This means the whole character doesn't fit
20713 if (row
->reversed_p
)
20714 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20715 - n_glyphs_before
);
20716 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20718 /* Fill the rest of the row with continuation
20719 glyphs like in 20.x. */
20720 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20721 < row
->glyphs
[1 + TEXT_AREA
])
20722 produce_special_glyphs (it
, IT_CONTINUATION
);
20724 row
->continued_p
= true;
20725 it
->current_x
= x_before
;
20726 it
->continuation_lines_width
+= x_before
;
20728 /* Restore the height to what it was before the
20729 element not fitting on the line. */
20730 it
->max_ascent
= ascent
;
20731 it
->max_descent
= descent
;
20732 it
->max_phys_ascent
= phys_ascent
;
20733 it
->max_phys_descent
= phys_descent
;
20734 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20735 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20736 extend_face_to_end_of_line (it
);
20738 else if (wrap_row_used
> 0)
20741 if (row
->reversed_p
)
20742 unproduce_glyphs (it
,
20743 row
->used
[TEXT_AREA
] - wrap_row_used
);
20744 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20745 it
->continuation_lines_width
+= wrap_x
;
20746 row
->used
[TEXT_AREA
] = wrap_row_used
;
20747 row
->ascent
= wrap_row_ascent
;
20748 row
->height
= wrap_row_height
;
20749 row
->phys_ascent
= wrap_row_phys_ascent
;
20750 row
->phys_height
= wrap_row_phys_height
;
20751 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20752 min_pos
= wrap_row_min_pos
;
20753 min_bpos
= wrap_row_min_bpos
;
20754 max_pos
= wrap_row_max_pos
;
20755 max_bpos
= wrap_row_max_bpos
;
20756 row
->continued_p
= true;
20757 row
->ends_at_zv_p
= false;
20758 row
->exact_window_width_line_p
= false;
20759 it
->continuation_lines_width
+= x
;
20761 /* Make sure that a non-default face is extended
20762 up to the right margin of the window. */
20763 extend_face_to_end_of_line (it
);
20765 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20767 /* A TAB that extends past the right edge of the
20768 window. This produces a single glyph on
20769 window system frames. We leave the glyph in
20770 this row and let it fill the row, but don't
20771 consume the TAB. */
20772 if ((row
->reversed_p
20773 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20774 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20775 produce_special_glyphs (it
, IT_CONTINUATION
);
20776 it
->continuation_lines_width
+= it
->last_visible_x
;
20777 row
->ends_in_middle_of_char_p
= true;
20778 row
->continued_p
= true;
20779 glyph
->pixel_width
= it
->last_visible_x
- x
;
20780 it
->starts_in_middle_of_char_p
= true;
20781 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20782 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20783 extend_face_to_end_of_line (it
);
20787 /* Something other than a TAB that draws past
20788 the right edge of the window. Restore
20789 positions to values before the element. */
20790 if (row
->reversed_p
)
20791 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20792 - (n_glyphs_before
+ i
));
20793 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20795 /* Display continuation glyphs. */
20796 it
->current_x
= x_before
;
20797 it
->continuation_lines_width
+= x
;
20798 if (!FRAME_WINDOW_P (it
->f
)
20799 || (row
->reversed_p
20800 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20801 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20802 produce_special_glyphs (it
, IT_CONTINUATION
);
20803 row
->continued_p
= true;
20805 extend_face_to_end_of_line (it
);
20807 if (nglyphs
> 1 && i
> 0)
20809 row
->ends_in_middle_of_char_p
= true;
20810 it
->starts_in_middle_of_char_p
= true;
20813 /* Restore the height to what it was before the
20814 element not fitting on the line. */
20815 it
->max_ascent
= ascent
;
20816 it
->max_descent
= descent
;
20817 it
->max_phys_ascent
= phys_ascent
;
20818 it
->max_phys_descent
= phys_descent
;
20823 else if (new_x
> it
->first_visible_x
)
20825 /* Increment number of glyphs actually displayed. */
20828 /* Record the maximum and minimum buffer positions
20829 seen so far in glyphs that will be displayed by
20832 RECORD_MAX_MIN_POS (it
);
20834 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20835 /* Glyph is partially visible, i.e. row starts at
20836 negative X position. Don't do that in R2L
20837 rows, where we arrange to add a right offset to
20838 the line in extend_face_to_end_of_line, by a
20839 suitable change to the stretch glyph that is
20840 the leftmost glyph of the line. */
20841 row
->x
= x
- it
->first_visible_x
;
20842 /* When the last glyph of an R2L row only fits
20843 partially on the line, we need to set row->x to a
20844 negative offset, so that the leftmost glyph is
20845 the one that is partially visible. But if we are
20846 going to produce the truncation glyph, this will
20847 be taken care of in produce_special_glyphs. */
20848 if (row
->reversed_p
20849 && new_x
> it
->last_visible_x
20850 && !(it
->line_wrap
== TRUNCATE
20851 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
20853 eassert (FRAME_WINDOW_P (it
->f
));
20854 row
->x
= it
->last_visible_x
- new_x
;
20859 /* Glyph is completely off the left margin of the
20860 window. This should not happen because of the
20861 move_it_in_display_line at the start of this
20862 function, unless the text display area of the
20863 window is empty. */
20864 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20867 /* Even if this display element produced no glyphs at all,
20868 we want to record its position. */
20869 if (it
->bidi_p
&& nglyphs
== 0)
20870 RECORD_MAX_MIN_POS (it
);
20872 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20873 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20874 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20875 row
->phys_height
= max (row
->phys_height
,
20876 it
->max_phys_ascent
+ it
->max_phys_descent
);
20877 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20878 it
->max_extra_line_spacing
);
20880 /* End of this display line if row is continued. */
20881 if (row
->continued_p
|| row
->ends_at_zv_p
)
20886 /* Is this a line end? If yes, we're also done, after making
20887 sure that a non-default face is extended up to the right
20888 margin of the window. */
20889 if (ITERATOR_AT_END_OF_LINE_P (it
))
20891 int used_before
= row
->used
[TEXT_AREA
];
20893 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20895 /* Add a space at the end of the line that is used to
20896 display the cursor there. */
20897 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20898 append_space_for_newline (it
, false);
20900 /* Extend the face to the end of the line. */
20901 extend_face_to_end_of_line (it
);
20903 /* Make sure we have the position. */
20904 if (used_before
== 0)
20905 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20907 /* Record the position of the newline, for use in
20909 it
->eol_pos
= it
->current
.pos
;
20911 /* Consume the line end. This skips over invisible lines. */
20912 set_iterator_to_next (it
, true);
20913 it
->continuation_lines_width
= 0;
20917 /* Proceed with next display element. Note that this skips
20918 over lines invisible because of selective display. */
20919 set_iterator_to_next (it
, true);
20921 /* If we truncate lines, we are done when the last displayed
20922 glyphs reach past the right margin of the window. */
20923 if (it
->line_wrap
== TRUNCATE
20924 && ((FRAME_WINDOW_P (it
->f
)
20925 /* Images are preprocessed in produce_image_glyph such
20926 that they are cropped at the right edge of the
20927 window, so an image glyph will always end exactly at
20928 last_visible_x, even if there's no right fringe. */
20929 && ((row
->reversed_p
20930 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20931 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
20932 || it
->what
== IT_IMAGE
))
20933 ? (it
->current_x
>= it
->last_visible_x
)
20934 : (it
->current_x
> it
->last_visible_x
)))
20936 /* Maybe add truncation glyphs. */
20937 if (!FRAME_WINDOW_P (it
->f
)
20938 || (row
->reversed_p
20939 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20940 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20944 if (!row
->reversed_p
)
20946 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20947 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20952 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20953 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20955 /* Remove any padding glyphs at the front of ROW, to
20956 make room for the truncation glyphs we will be
20957 adding below. The loop below always inserts at
20958 least one truncation glyph, so also remove the
20959 last glyph added to ROW. */
20960 unproduce_glyphs (it
, i
+ 1);
20961 /* Adjust i for the loop below. */
20962 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20965 /* produce_special_glyphs overwrites the last glyph, so
20966 we don't want that if we want to keep that last
20967 glyph, which means it's an image. */
20968 if (it
->current_x
> it
->last_visible_x
)
20970 it
->current_x
= x_before
;
20971 if (!FRAME_WINDOW_P (it
->f
))
20973 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20975 row
->used
[TEXT_AREA
] = i
;
20976 produce_special_glyphs (it
, IT_TRUNCATION
);
20981 row
->used
[TEXT_AREA
] = i
;
20982 produce_special_glyphs (it
, IT_TRUNCATION
);
20984 it
->hpos
= hpos_before
;
20987 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20989 /* Don't truncate if we can overflow newline into fringe. */
20990 if (!get_next_display_element (it
))
20992 it
->continuation_lines_width
= 0;
20993 row
->ends_at_zv_p
= true;
20994 row
->exact_window_width_line_p
= true;
20997 if (ITERATOR_AT_END_OF_LINE_P (it
))
20999 row
->exact_window_width_line_p
= true;
21000 goto at_end_of_line
;
21002 it
->current_x
= x_before
;
21003 it
->hpos
= hpos_before
;
21006 row
->truncated_on_right_p
= true;
21007 it
->continuation_lines_width
= 0;
21008 reseat_at_next_visible_line_start (it
, false);
21009 /* We insist below that IT's position be at ZV because in
21010 bidi-reordered lines the character at visible line start
21011 might not be the character that follows the newline in
21012 the logical order. */
21013 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
21014 row
->ends_at_zv_p
=
21015 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
21017 row
->ends_at_zv_p
= false;
21023 bidi_unshelve_cache (wrap_data
, true);
21025 /* If line is not empty and hscrolled, maybe insert truncation glyphs
21026 at the left window margin. */
21027 if (it
->first_visible_x
21028 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
21030 if (!FRAME_WINDOW_P (it
->f
)
21031 || (((row
->reversed_p
21032 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21033 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
21034 /* Don't let insert_left_trunc_glyphs overwrite the
21035 first glyph of the row if it is an image. */
21036 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
21037 insert_left_trunc_glyphs (it
);
21038 row
->truncated_on_left_p
= true;
21041 /* Remember the position at which this line ends.
21043 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
21044 cannot be before the call to find_row_edges below, since that is
21045 where these positions are determined. */
21046 row
->end
= it
->current
;
21049 row
->minpos
= row
->start
.pos
;
21050 row
->maxpos
= row
->end
.pos
;
21054 /* ROW->minpos and ROW->maxpos must be the smallest and
21055 `1 + the largest' buffer positions in ROW. But if ROW was
21056 bidi-reordered, these two positions can be anywhere in the
21057 row, so we must determine them now. */
21058 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
21061 /* If the start of this line is the overlay arrow-position, then
21062 mark this glyph row as the one containing the overlay arrow.
21063 This is clearly a mess with variable size fonts. It would be
21064 better to let it be displayed like cursors under X. */
21065 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
21066 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
21067 !NILP (overlay_arrow_string
)))
21069 /* Overlay arrow in window redisplay is a fringe bitmap. */
21070 if (STRINGP (overlay_arrow_string
))
21072 struct glyph_row
*arrow_row
21073 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
21074 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
21075 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
21076 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
21077 struct glyph
*p2
, *end
;
21079 /* Copy the arrow glyphs. */
21080 while (glyph
< arrow_end
)
21083 /* Throw away padding glyphs. */
21085 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
21086 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
21092 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
21097 eassert (INTEGERP (overlay_arrow_string
));
21098 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
21100 overlay_arrow_seen
= true;
21103 /* Highlight trailing whitespace. */
21104 if (!NILP (Vshow_trailing_whitespace
))
21105 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
21107 /* Compute pixel dimensions of this line. */
21108 compute_line_metrics (it
);
21110 /* Implementation note: No changes in the glyphs of ROW or in their
21111 faces can be done past this point, because compute_line_metrics
21112 computes ROW's hash value and stores it within the glyph_row
21115 /* Record whether this row ends inside an ellipsis. */
21116 row
->ends_in_ellipsis_p
21117 = (it
->method
== GET_FROM_DISPLAY_VECTOR
21118 && it
->ellipsis_p
);
21120 /* Save fringe bitmaps in this row. */
21121 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
21122 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
21123 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
21124 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
21126 it
->left_user_fringe_bitmap
= 0;
21127 it
->left_user_fringe_face_id
= 0;
21128 it
->right_user_fringe_bitmap
= 0;
21129 it
->right_user_fringe_face_id
= 0;
21131 /* Maybe set the cursor. */
21132 cvpos
= it
->w
->cursor
.vpos
;
21134 /* In bidi-reordered rows, keep checking for proper cursor
21135 position even if one has been found already, because buffer
21136 positions in such rows change non-linearly with ROW->VPOS,
21137 when a line is continued. One exception: when we are at ZV,
21138 display cursor on the first suitable glyph row, since all
21139 the empty rows after that also have their position set to ZV. */
21140 /* FIXME: Revisit this when glyph ``spilling'' in continuation
21141 lines' rows is implemented for bidi-reordered rows. */
21143 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
21144 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
21145 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
21146 && cursor_row_p (row
))
21147 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
21149 /* Prepare for the next line. This line starts horizontally at (X
21150 HPOS) = (0 0). Vertical positions are incremented. As a
21151 convenience for the caller, IT->glyph_row is set to the next
21153 it
->current_x
= it
->hpos
= 0;
21154 it
->current_y
+= row
->height
;
21155 SET_TEXT_POS (it
->eol_pos
, 0, 0);
21158 /* The next row should by default use the same value of the
21159 reversed_p flag as this one. set_iterator_to_next decides when
21160 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
21161 the flag accordingly. */
21162 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
21163 it
->glyph_row
->reversed_p
= row
->reversed_p
;
21164 it
->start
= row
->end
;
21165 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
21167 #undef RECORD_MAX_MIN_POS
21170 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
21171 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
21172 doc
: /* Return paragraph direction at point in BUFFER.
21173 Value is either `left-to-right' or `right-to-left'.
21174 If BUFFER is omitted or nil, it defaults to the current buffer.
21176 Paragraph direction determines how the text in the paragraph is displayed.
21177 In left-to-right paragraphs, text begins at the left margin of the window
21178 and the reading direction is generally left to right. In right-to-left
21179 paragraphs, text begins at the right margin and is read from right to left.
21181 See also `bidi-paragraph-direction'. */)
21182 (Lisp_Object buffer
)
21184 struct buffer
*buf
= current_buffer
;
21185 struct buffer
*old
= buf
;
21187 if (! NILP (buffer
))
21189 CHECK_BUFFER (buffer
);
21190 buf
= XBUFFER (buffer
);
21193 if (NILP (BVAR (buf
, bidi_display_reordering
))
21194 || NILP (BVAR (buf
, enable_multibyte_characters
))
21195 /* When we are loading loadup.el, the character property tables
21196 needed for bidi iteration are not yet available. */
21197 || !NILP (Vpurify_flag
))
21198 return Qleft_to_right
;
21199 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
21200 return BVAR (buf
, bidi_paragraph_direction
);
21203 /* Determine the direction from buffer text. We could try to
21204 use current_matrix if it is up to date, but this seems fast
21205 enough as it is. */
21206 struct bidi_it itb
;
21207 ptrdiff_t pos
= BUF_PT (buf
);
21208 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
21210 void *itb_data
= bidi_shelve_cache ();
21212 set_buffer_temp (buf
);
21213 /* bidi_paragraph_init finds the base direction of the paragraph
21214 by searching forward from paragraph start. We need the base
21215 direction of the current or _previous_ paragraph, so we need
21216 to make sure we are within that paragraph. To that end, find
21217 the previous non-empty line. */
21218 if (pos
>= ZV
&& pos
> BEGV
)
21219 DEC_BOTH (pos
, bytepos
);
21220 AUTO_STRING (trailing_white_space
, "[\f\t ]*\n");
21221 if (fast_looking_at (trailing_white_space
,
21222 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
21224 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
21225 || c
== ' ' || c
== '\t' || c
== '\f')
21227 if (bytepos
<= BEGV_BYTE
)
21232 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
21235 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
21236 itb
.paragraph_dir
= NEUTRAL_DIR
;
21237 itb
.string
.s
= NULL
;
21238 itb
.string
.lstring
= Qnil
;
21239 itb
.string
.bufpos
= 0;
21240 itb
.string
.from_disp_str
= false;
21241 itb
.string
.unibyte
= false;
21242 /* We have no window to use here for ignoring window-specific
21243 overlays. Using NULL for window pointer will cause
21244 compute_display_string_pos to use the current buffer. */
21246 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, true);
21247 bidi_unshelve_cache (itb_data
, false);
21248 set_buffer_temp (old
);
21249 switch (itb
.paragraph_dir
)
21252 return Qleft_to_right
;
21255 return Qright_to_left
;
21263 DEFUN ("bidi-find-overridden-directionality",
21264 Fbidi_find_overridden_directionality
,
21265 Sbidi_find_overridden_directionality
, 2, 3, 0,
21266 doc
: /* Return position between FROM and TO where directionality was overridden.
21268 This function returns the first character position in the specified
21269 region of OBJECT where there is a character whose `bidi-class' property
21270 is `L', but which was forced to display as `R' by a directional
21271 override, and likewise with characters whose `bidi-class' is `R'
21272 or `AL' that were forced to display as `L'.
21274 If no such character is found, the function returns nil.
21276 OBJECT is a Lisp string or buffer to search for overridden
21277 directionality, and defaults to the current buffer if nil or omitted.
21278 OBJECT can also be a window, in which case the function will search
21279 the buffer displayed in that window. Passing the window instead of
21280 a buffer is preferable when the buffer is displayed in some window,
21281 because this function will then be able to correctly account for
21282 window-specific overlays, which can affect the results.
21284 Strong directional characters `L', `R', and `AL' can have their
21285 intrinsic directionality overridden by directional override
21286 control characters RLO (u+202e) and LRO (u+202d). See the
21287 function `get-char-code-property' for a way to inquire about
21288 the `bidi-class' property of a character. */)
21289 (Lisp_Object from
, Lisp_Object to
, Lisp_Object object
)
21291 struct buffer
*buf
= current_buffer
;
21292 struct buffer
*old
= buf
;
21293 struct window
*w
= NULL
;
21294 bool frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ());
21295 struct bidi_it itb
;
21296 ptrdiff_t from_pos
, to_pos
, from_bpos
;
21299 if (!NILP (object
))
21301 if (BUFFERP (object
))
21302 buf
= XBUFFER (object
);
21303 else if (WINDOWP (object
))
21305 w
= decode_live_window (object
);
21306 buf
= XBUFFER (w
->contents
);
21307 frame_window_p
= FRAME_WINDOW_P (XFRAME (w
->frame
));
21310 CHECK_STRING (object
);
21313 if (STRINGP (object
))
21315 /* Characters in unibyte strings are always treated by bidi.c as
21317 if (!STRING_MULTIBYTE (object
)
21318 /* When we are loading loadup.el, the character property
21319 tables needed for bidi iteration are not yet
21321 || !NILP (Vpurify_flag
))
21324 validate_subarray (object
, from
, to
, SCHARS (object
), &from_pos
, &to_pos
);
21325 if (from_pos
>= SCHARS (object
))
21328 /* Set up the bidi iterator. */
21329 itb_data
= bidi_shelve_cache ();
21330 itb
.paragraph_dir
= NEUTRAL_DIR
;
21331 itb
.string
.lstring
= object
;
21332 itb
.string
.s
= NULL
;
21333 itb
.string
.schars
= SCHARS (object
);
21334 itb
.string
.bufpos
= 0;
21335 itb
.string
.from_disp_str
= false;
21336 itb
.string
.unibyte
= false;
21338 bidi_init_it (0, 0, frame_window_p
, &itb
);
21342 /* Nothing this fancy can happen in unibyte buffers, or in a
21343 buffer that disabled reordering, or if FROM is at EOB. */
21344 if (NILP (BVAR (buf
, bidi_display_reordering
))
21345 || NILP (BVAR (buf
, enable_multibyte_characters
))
21346 /* When we are loading loadup.el, the character property
21347 tables needed for bidi iteration are not yet
21349 || !NILP (Vpurify_flag
))
21352 set_buffer_temp (buf
);
21353 validate_region (&from
, &to
);
21354 from_pos
= XINT (from
);
21355 to_pos
= XINT (to
);
21356 if (from_pos
>= ZV
)
21359 /* Set up the bidi iterator. */
21360 itb_data
= bidi_shelve_cache ();
21361 from_bpos
= CHAR_TO_BYTE (from_pos
);
21362 if (from_pos
== BEGV
)
21364 itb
.charpos
= BEGV
;
21365 itb
.bytepos
= BEGV_BYTE
;
21367 else if (FETCH_CHAR (from_bpos
- 1) == '\n')
21369 itb
.charpos
= from_pos
;
21370 itb
.bytepos
= from_bpos
;
21373 itb
.charpos
= find_newline_no_quit (from_pos
, CHAR_TO_BYTE (from_pos
),
21375 itb
.paragraph_dir
= NEUTRAL_DIR
;
21376 itb
.string
.s
= NULL
;
21377 itb
.string
.lstring
= Qnil
;
21378 itb
.string
.bufpos
= 0;
21379 itb
.string
.from_disp_str
= false;
21380 itb
.string
.unibyte
= false;
21382 bidi_init_it (itb
.charpos
, itb
.bytepos
, frame_window_p
, &itb
);
21387 /* For the purposes of this function, the actual base direction of
21388 the paragraph doesn't matter, so just set it to L2R. */
21389 bidi_paragraph_init (L2R
, &itb
, false);
21390 while ((found
= bidi_find_first_overridden (&itb
)) < from_pos
)
21392 } while (found
== ZV
&& itb
.ch
== '\n' && itb
.charpos
< to_pos
);
21394 bidi_unshelve_cache (itb_data
, false);
21395 set_buffer_temp (old
);
21397 return (from_pos
<= found
&& found
< to_pos
) ? make_number (found
) : Qnil
;
21400 DEFUN ("move-point-visually", Fmove_point_visually
,
21401 Smove_point_visually
, 1, 1, 0,
21402 doc
: /* Move point in the visual order in the specified DIRECTION.
21403 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
21406 Value is the new character position of point. */)
21407 (Lisp_Object direction
)
21409 struct window
*w
= XWINDOW (selected_window
);
21410 struct buffer
*b
= XBUFFER (w
->contents
);
21411 struct glyph_row
*row
;
21413 Lisp_Object paragraph_dir
;
21415 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21416 (!(ROW)->continued_p \
21417 && NILP ((GLYPH)->object) \
21418 && (GLYPH)->type == CHAR_GLYPH \
21419 && (GLYPH)->u.ch == ' ' \
21420 && (GLYPH)->charpos >= 0 \
21421 && !(GLYPH)->avoid_cursor_p)
21423 CHECK_NUMBER (direction
);
21424 dir
= XINT (direction
);
21430 /* If current matrix is up-to-date, we can use the information
21431 recorded in the glyphs, at least as long as the goal is on the
21433 if (w
->window_end_valid
21434 && !windows_or_buffers_changed
21436 && !b
->clip_changed
21437 && !b
->prevent_redisplay_optimizations_p
21438 && !window_outdated (w
)
21439 /* We rely below on the cursor coordinates to be up to date, but
21440 we cannot trust them if some command moved point since the
21441 last complete redisplay. */
21442 && w
->last_point
== BUF_PT (b
)
21443 && w
->cursor
.vpos
>= 0
21444 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21445 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21447 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21448 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21449 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21451 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21453 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21455 SET_PT (g
->charpos
);
21456 w
->cursor
.vpos
= -1;
21457 return make_number (PT
);
21459 else if (!NILP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21463 if (BUFFERP (gpt
->object
))
21466 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21467 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21469 new_pos
-= (row
->reversed_p
? -dir
: dir
);
21471 else if (BUFFERP (g
->object
))
21472 new_pos
= g
->charpos
;
21476 w
->cursor
.vpos
= -1;
21477 return make_number (PT
);
21479 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21481 /* Glyphs inserted at the end of a non-empty line for
21482 positioning the cursor have zero charpos, so we must
21483 deduce the value of point by other means. */
21484 if (g
->charpos
> 0)
21485 SET_PT (g
->charpos
);
21486 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21488 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21489 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21492 w
->cursor
.vpos
= -1;
21493 return make_number (PT
);
21496 if (g
== e
|| NILP (g
->object
))
21498 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21499 goto simulate_display
;
21500 if (!row
->reversed_p
)
21504 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21505 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21506 goto simulate_display
;
21510 if (row
->reversed_p
&& !row
->continued_p
)
21512 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21513 w
->cursor
.vpos
= -1;
21514 return make_number (PT
);
21516 g
= row
->glyphs
[TEXT_AREA
];
21517 e
= g
+ row
->used
[TEXT_AREA
];
21518 for ( ; g
< e
; g
++)
21520 if (BUFFERP (g
->object
)
21521 /* Empty lines have only one glyph, which stands
21522 for the newline, and whose charpos is the
21523 buffer position of the newline. */
21524 || ROW_GLYPH_NEWLINE_P (row
, g
)
21525 /* When the buffer ends in a newline, the line at
21526 EOB also has one glyph, but its charpos is -1. */
21527 || (row
->ends_at_zv_p
21528 && !row
->reversed_p
21529 && NILP (g
->object
)
21530 && g
->type
== CHAR_GLYPH
21531 && g
->u
.ch
== ' '))
21533 if (g
->charpos
> 0)
21534 SET_PT (g
->charpos
);
21535 else if (!row
->reversed_p
21536 && row
->ends_at_zv_p
21541 w
->cursor
.vpos
= -1;
21542 return make_number (PT
);
21548 if (!row
->reversed_p
&& !row
->continued_p
)
21550 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21551 w
->cursor
.vpos
= -1;
21552 return make_number (PT
);
21554 e
= row
->glyphs
[TEXT_AREA
];
21555 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21556 for ( ; g
>= e
; g
--)
21558 if (BUFFERP (g
->object
)
21559 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21561 /* Empty R2L lines on GUI frames have the buffer
21562 position of the newline stored in the stretch
21564 || g
->type
== STRETCH_GLYPH
21565 || (row
->ends_at_zv_p
21567 && NILP (g
->object
)
21568 && g
->type
== CHAR_GLYPH
21569 && g
->u
.ch
== ' '))
21571 if (g
->charpos
> 0)
21572 SET_PT (g
->charpos
);
21573 else if (row
->reversed_p
21574 && row
->ends_at_zv_p
21579 w
->cursor
.vpos
= -1;
21580 return make_number (PT
);
21589 /* If we wind up here, we failed to move by using the glyphs, so we
21590 need to simulate display instead. */
21593 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21595 paragraph_dir
= Qleft_to_right
;
21596 if (EQ (paragraph_dir
, Qright_to_left
))
21598 if (PT
<= BEGV
&& dir
< 0)
21599 xsignal0 (Qbeginning_of_buffer
);
21600 else if (PT
>= ZV
&& dir
> 0)
21601 xsignal0 (Qend_of_buffer
);
21604 struct text_pos pt
;
21606 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21608 bool overshoot_expected
= false;
21609 bool target_is_eol_p
= false;
21611 /* Setup the arena. */
21612 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21613 start_display (&it
, w
, pt
);
21614 /* When lines are truncated, we could be called with point
21615 outside of the windows edges, in which case move_it_*
21616 functions either prematurely stop at window's edge or jump to
21617 the next screen line, whereas we rely below on our ability to
21618 reach point, in order to start from its X coordinate. So we
21619 need to disregard the window's horizontal extent in that case. */
21620 if (it
.line_wrap
== TRUNCATE
)
21621 it
.last_visible_x
= INFINITY
;
21623 if (it
.cmp_it
.id
< 0
21624 && it
.method
== GET_FROM_STRING
21625 && it
.area
== TEXT_AREA
21626 && it
.string_from_display_prop_p
21627 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21628 overshoot_expected
= true;
21630 /* Find the X coordinate of point. We start from the beginning
21631 of this or previous line to make sure we are before point in
21632 the logical order (since the move_it_* functions can only
21635 reseat_at_previous_visible_line_start (&it
);
21636 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21637 if (IT_CHARPOS (it
) != PT
)
21639 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21640 -1, -1, -1, MOVE_TO_POS
);
21641 /* If we missed point because the character there is
21642 displayed out of a display vector that has more than one
21643 glyph, retry expecting overshoot. */
21644 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21645 && it
.current
.dpvec_index
> 0
21646 && !overshoot_expected
)
21648 overshoot_expected
= true;
21651 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21652 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21654 pt_x
= it
.current_x
;
21656 if (dir
> 0 || overshoot_expected
)
21658 struct glyph_row
*row
= it
.glyph_row
;
21660 /* When point is at beginning of line, we don't have
21661 information about the glyph there loaded into struct
21662 it. Calling get_next_display_element fixes that. */
21664 get_next_display_element (&it
);
21665 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21666 it
.glyph_row
= NULL
;
21667 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21668 it
.glyph_row
= row
;
21669 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21670 it, lest it will become out of sync with it's buffer
21672 it
.current_x
= pt_x
;
21675 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21676 pixel_width
= it
.pixel_width
;
21677 if (overshoot_expected
&& at_eol_p
)
21679 else if (pixel_width
<= 0)
21682 /* If there's a display string (or something similar) at point,
21683 we are actually at the glyph to the left of point, so we need
21684 to correct the X coordinate. */
21685 if (overshoot_expected
)
21688 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21690 pt_x
+= pixel_width
;
21693 /* Compute target X coordinate, either to the left or to the
21694 right of point. On TTY frames, all characters have the same
21695 pixel width of 1, so we can use that. On GUI frames we don't
21696 have an easy way of getting at the pixel width of the
21697 character to the left of point, so we use a different method
21698 of getting to that place. */
21700 target_x
= pt_x
+ pixel_width
;
21702 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21704 /* Target X coordinate could be one line above or below the line
21705 of point, in which case we need to adjust the target X
21706 coordinate. Also, if moving to the left, we need to begin at
21707 the left edge of the point's screen line. */
21712 start_display (&it
, w
, pt
);
21713 if (it
.line_wrap
== TRUNCATE
)
21714 it
.last_visible_x
= INFINITY
;
21715 reseat_at_previous_visible_line_start (&it
);
21716 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21718 move_it_by_lines (&it
, pt_vpos
);
21722 move_it_by_lines (&it
, -1);
21723 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21724 target_is_eol_p
= true;
21725 /* Under word-wrap, we don't know the x coordinate of
21726 the last character displayed on the previous line,
21727 which immediately precedes the wrap point. To find
21728 out its x coordinate, we try moving to the right
21729 margin of the window, which will stop at the wrap
21730 point, and then reset target_x to point at the
21731 character that precedes the wrap point. This is not
21732 needed on GUI frames, because (see below) there we
21733 move from the left margin one grapheme cluster at a
21734 time, and stop when we hit the wrap point. */
21735 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21737 void *it_data
= NULL
;
21740 SAVE_IT (it2
, it
, it_data
);
21741 move_it_in_display_line_to (&it
, ZV
, target_x
,
21742 MOVE_TO_POS
| MOVE_TO_X
);
21743 /* If we arrived at target_x, that _is_ the last
21744 character on the previous line. */
21745 if (it
.current_x
!= target_x
)
21746 target_x
= it
.current_x
- 1;
21747 RESTORE_IT (&it
, &it2
, it_data
);
21754 || (target_x
>= it
.last_visible_x
21755 && it
.line_wrap
!= TRUNCATE
))
21758 move_it_by_lines (&it
, 0);
21759 move_it_by_lines (&it
, 1);
21764 /* Move to the target X coordinate. */
21765 #ifdef HAVE_WINDOW_SYSTEM
21766 /* On GUI frames, as we don't know the X coordinate of the
21767 character to the left of point, moving point to the left
21768 requires walking, one grapheme cluster at a time, until we
21769 find ourself at a place immediately to the left of the
21770 character at point. */
21771 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21773 struct text_pos new_pos
;
21774 enum move_it_result rc
= MOVE_X_REACHED
;
21776 if (it
.current_x
== 0)
21777 get_next_display_element (&it
);
21778 if (it
.what
== IT_COMPOSITION
)
21780 new_pos
.charpos
= it
.cmp_it
.charpos
;
21781 new_pos
.bytepos
= -1;
21784 new_pos
= it
.current
.pos
;
21786 while (it
.current_x
+ it
.pixel_width
<= target_x
21787 && (rc
== MOVE_X_REACHED
21788 /* Under word-wrap, move_it_in_display_line_to
21789 stops at correct coordinates, but sometimes
21790 returns MOVE_POS_MATCH_OR_ZV. */
21791 || (it
.line_wrap
== WORD_WRAP
21792 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21794 int new_x
= it
.current_x
+ it
.pixel_width
;
21796 /* For composed characters, we want the position of the
21797 first character in the grapheme cluster (usually, the
21798 composition's base character), whereas it.current
21799 might give us the position of the _last_ one, e.g. if
21800 the composition is rendered in reverse due to bidi
21802 if (it
.what
== IT_COMPOSITION
)
21804 new_pos
.charpos
= it
.cmp_it
.charpos
;
21805 new_pos
.bytepos
= -1;
21808 new_pos
= it
.current
.pos
;
21809 if (new_x
== it
.current_x
)
21811 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21812 MOVE_TO_POS
| MOVE_TO_X
);
21813 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21816 /* The previous position we saw in the loop is the one we
21818 if (new_pos
.bytepos
== -1)
21819 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21820 it
.current
.pos
= new_pos
;
21824 if (it
.current_x
!= target_x
)
21825 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21827 /* If we ended up in a display string that covers point, move to
21828 buffer position to the right in the visual order. */
21831 while (IT_CHARPOS (it
) == PT
)
21833 set_iterator_to_next (&it
, false);
21834 if (!get_next_display_element (&it
))
21839 /* Move point to that position. */
21840 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21843 return make_number (PT
);
21845 #undef ROW_GLYPH_NEWLINE_P
21848 DEFUN ("bidi-resolved-levels", Fbidi_resolved_levels
,
21849 Sbidi_resolved_levels
, 0, 1, 0,
21850 doc
: /* Return the resolved bidirectional levels of characters at VPOS.
21852 The resolved levels are produced by the Emacs bidi reordering engine
21853 that implements the UBA, the Unicode Bidirectional Algorithm. Please
21854 read the Unicode Standard Annex 9 (UAX#9) for background information
21855 about these levels.
21857 VPOS is the zero-based number of the current window's screen line
21858 for which to produce the resolved levels. If VPOS is nil or omitted,
21859 it defaults to the screen line of point. If the window displays a
21860 header line, VPOS of zero will report on the header line, and first
21861 line of text in the window will have VPOS of 1.
21863 Value is an array of resolved levels, indexed by glyph number.
21864 Glyphs are numbered from zero starting from the beginning of the
21865 screen line, i.e. the left edge of the window for left-to-right lines
21866 and from the right edge for right-to-left lines. The resolved levels
21867 are produced only for the window's text area; text in display margins
21870 If the selected window's display is not up-to-date, or if the specified
21871 screen line does not display text, this function returns nil. It is
21872 highly recommended to bind this function to some simple key, like F8,
21873 in order to avoid these problems.
21875 This function exists mainly for testing the correctness of the
21876 Emacs UBA implementation, in particular with the test suite. */)
21879 struct window
*w
= XWINDOW (selected_window
);
21880 struct buffer
*b
= XBUFFER (w
->contents
);
21882 struct glyph_row
*row
;
21886 int d1
, d2
, d3
, d4
, d5
;
21888 pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &nrow
);
21892 CHECK_NUMBER_COERCE_MARKER (vpos
);
21893 nrow
= XINT (vpos
);
21896 /* We require up-to-date glyph matrix for this window. */
21897 if (w
->window_end_valid
21898 && !windows_or_buffers_changed
21900 && !b
->clip_changed
21901 && !b
->prevent_redisplay_optimizations_p
21902 && !window_outdated (w
)
21904 && nrow
< w
->current_matrix
->nrows
21905 && (row
= MATRIX_ROW (w
->current_matrix
, nrow
))->enabled_p
21906 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
21908 struct glyph
*g
, *e
, *g1
;
21910 Lisp_Object levels
;
21912 if (!row
->reversed_p
) /* Left-to-right glyph row. */
21914 g
= g1
= row
->glyphs
[TEXT_AREA
];
21915 e
= g
+ row
->used
[TEXT_AREA
];
21917 /* Skip over glyphs at the start of the row that was
21918 generated by redisplay for its own needs. */
21920 && NILP (g
->object
)
21925 /* Count the "interesting" glyphs in this row. */
21926 for (nglyphs
= 0; g
< e
&& !NILP (g
->object
); g
++)
21929 /* Create and fill the array. */
21930 levels
= make_uninit_vector (nglyphs
);
21931 for (i
= 0; g1
< g
; i
++, g1
++)
21932 ASET (levels
, i
, make_number (g1
->resolved_level
));
21934 else /* Right-to-left glyph row. */
21936 g
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
21937 e
= row
->glyphs
[TEXT_AREA
] - 1;
21939 && NILP (g
->object
)
21943 for (nglyphs
= 0; g
> e
&& !NILP (g
->object
); g
--)
21945 levels
= make_uninit_vector (nglyphs
);
21946 for (i
= 0; g1
> g
; i
++, g1
--)
21947 ASET (levels
, i
, make_number (g1
->resolved_level
));
21957 /***********************************************************************
21959 ***********************************************************************/
21961 /* Redisplay the menu bar in the frame for window W.
21963 The menu bar of X frames that don't have X toolkit support is
21964 displayed in a special window W->frame->menu_bar_window.
21966 The menu bar of terminal frames is treated specially as far as
21967 glyph matrices are concerned. Menu bar lines are not part of
21968 windows, so the update is done directly on the frame matrix rows
21969 for the menu bar. */
21972 display_menu_bar (struct window
*w
)
21974 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21979 /* Don't do all this for graphical frames. */
21981 if (FRAME_W32_P (f
))
21984 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21990 if (FRAME_NS_P (f
))
21992 #endif /* HAVE_NS */
21994 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21995 eassert (!FRAME_WINDOW_P (f
));
21996 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21997 it
.first_visible_x
= 0;
21998 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21999 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
22000 if (FRAME_WINDOW_P (f
))
22002 /* Menu bar lines are displayed in the desired matrix of the
22003 dummy window menu_bar_window. */
22004 struct window
*menu_w
;
22005 menu_w
= XWINDOW (f
->menu_bar_window
);
22006 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
22008 it
.first_visible_x
= 0;
22009 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
22012 #endif /* not USE_X_TOOLKIT and not USE_GTK */
22014 /* This is a TTY frame, i.e. character hpos/vpos are used as
22016 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
22018 it
.first_visible_x
= 0;
22019 it
.last_visible_x
= FRAME_COLS (f
);
22022 /* FIXME: This should be controlled by a user option. See the
22023 comments in redisplay_tool_bar and display_mode_line about
22025 it
.paragraph_embedding
= L2R
;
22027 /* Clear all rows of the menu bar. */
22028 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
22030 struct glyph_row
*row
= it
.glyph_row
+ i
;
22031 clear_glyph_row (row
);
22032 row
->enabled_p
= true;
22033 row
->full_width_p
= true;
22034 row
->reversed_p
= false;
22037 /* Display all items of the menu bar. */
22038 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
22039 for (i
= 0; i
< ASIZE (items
); i
+= 4)
22041 Lisp_Object string
;
22043 /* Stop at nil string. */
22044 string
= AREF (items
, i
+ 1);
22048 /* Remember where item was displayed. */
22049 ASET (items
, i
+ 3, make_number (it
.hpos
));
22051 /* Display the item, pad with one space. */
22052 if (it
.current_x
< it
.last_visible_x
)
22053 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
22054 SCHARS (string
) + 1, 0, 0, -1);
22057 /* Fill out the line with spaces. */
22058 if (it
.current_x
< it
.last_visible_x
)
22059 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
22061 /* Compute the total height of the lines. */
22062 compute_line_metrics (&it
);
22065 /* Deep copy of a glyph row, including the glyphs. */
22067 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
22069 struct glyph
*pointers
[1 + LAST_AREA
];
22070 int to_used
= to
->used
[TEXT_AREA
];
22072 /* Save glyph pointers of TO. */
22073 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
22075 /* Do a structure assignment. */
22078 /* Restore original glyph pointers of TO. */
22079 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
22081 /* Copy the glyphs. */
22082 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
22083 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
22085 /* If we filled only part of the TO row, fill the rest with
22086 space_glyph (which will display as empty space). */
22087 if (to_used
> from
->used
[TEXT_AREA
])
22088 fill_up_frame_row_with_spaces (to
, to_used
);
22091 /* Display one menu item on a TTY, by overwriting the glyphs in the
22092 frame F's desired glyph matrix with glyphs produced from the menu
22093 item text. Called from term.c to display TTY drop-down menus one
22096 ITEM_TEXT is the menu item text as a C string.
22098 FACE_ID is the face ID to be used for this menu item. FACE_ID
22099 could specify one of 3 faces: a face for an enabled item, a face
22100 for a disabled item, or a face for a selected item.
22102 X and Y are coordinates of the first glyph in the frame's desired
22103 matrix to be overwritten by the menu item. Since this is a TTY, Y
22104 is the zero-based number of the glyph row and X is the zero-based
22105 glyph number in the row, starting from left, where to start
22106 displaying the item.
22108 SUBMENU means this menu item drops down a submenu, which
22109 should be indicated by displaying a proper visual cue after the
22113 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
22114 int x
, int y
, bool submenu
)
22117 struct frame
*f
= SELECTED_FRAME ();
22118 struct window
*w
= XWINDOW (f
->selected_window
);
22119 struct glyph_row
*row
;
22120 size_t item_len
= strlen (item_text
);
22122 eassert (FRAME_TERMCAP_P (f
));
22124 /* Don't write beyond the matrix's last row. This can happen for
22125 TTY screens that are not high enough to show the entire menu.
22126 (This is actually a bit of defensive programming, as
22127 tty_menu_display already limits the number of menu items to one
22128 less than the number of screen lines.) */
22129 if (y
>= f
->desired_matrix
->nrows
)
22132 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
22133 it
.first_visible_x
= 0;
22134 it
.last_visible_x
= FRAME_COLS (f
) - 1;
22135 row
= it
.glyph_row
;
22136 /* Start with the row contents from the current matrix. */
22137 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
22138 bool saved_width
= row
->full_width_p
;
22139 row
->full_width_p
= true;
22140 bool saved_reversed
= row
->reversed_p
;
22141 row
->reversed_p
= false;
22142 row
->enabled_p
= true;
22144 /* Arrange for the menu item glyphs to start at (X,Y) and have the
22146 eassert (x
< f
->desired_matrix
->matrix_w
);
22147 it
.current_x
= it
.hpos
= x
;
22148 it
.current_y
= it
.vpos
= y
;
22149 int saved_used
= row
->used
[TEXT_AREA
];
22150 bool saved_truncated
= row
->truncated_on_right_p
;
22151 row
->used
[TEXT_AREA
] = x
;
22152 it
.face_id
= face_id
;
22153 it
.line_wrap
= TRUNCATE
;
22155 /* FIXME: This should be controlled by a user option. See the
22156 comments in redisplay_tool_bar and display_mode_line about this.
22157 Also, if paragraph_embedding could ever be R2L, changes will be
22158 needed to avoid shifting to the right the row characters in
22159 term.c:append_glyph. */
22160 it
.paragraph_embedding
= L2R
;
22162 /* Pad with a space on the left. */
22163 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
22165 /* Display the menu item, pad with spaces to WIDTH. */
22168 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
22169 item_len
, 0, FRAME_COLS (f
) - 1, -1);
22171 /* Indicate with " >" that there's a submenu. */
22172 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
22173 FRAME_COLS (f
) - 1, -1);
22176 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
22177 width
, 0, FRAME_COLS (f
) - 1, -1);
22179 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
22180 row
->truncated_on_right_p
= saved_truncated
;
22181 row
->hash
= row_hash (row
);
22182 row
->full_width_p
= saved_width
;
22183 row
->reversed_p
= saved_reversed
;
22186 /***********************************************************************
22188 ***********************************************************************/
22190 /* Redisplay mode lines in the window tree whose root is WINDOW.
22191 If FORCE, redisplay mode lines unconditionally.
22192 Otherwise, redisplay only mode lines that are garbaged. Value is
22193 the number of windows whose mode lines were redisplayed. */
22196 redisplay_mode_lines (Lisp_Object window
, bool force
)
22200 while (!NILP (window
))
22202 struct window
*w
= XWINDOW (window
);
22204 if (WINDOWP (w
->contents
))
22205 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
22207 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
22208 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
22210 struct text_pos lpoint
;
22211 struct buffer
*old
= current_buffer
;
22213 /* Set the window's buffer for the mode line display. */
22214 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
22215 set_buffer_internal_1 (XBUFFER (w
->contents
));
22217 /* Point refers normally to the selected window. For any
22218 other window, set up appropriate value. */
22219 if (!EQ (window
, selected_window
))
22221 struct text_pos pt
;
22223 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
22224 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
22227 /* Display mode lines. */
22228 clear_glyph_matrix (w
->desired_matrix
);
22229 if (display_mode_lines (w
))
22232 /* Restore old settings. */
22233 set_buffer_internal_1 (old
);
22234 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
22244 /* Display the mode and/or header line of window W. Value is the
22245 sum number of mode lines and header lines displayed. */
22248 display_mode_lines (struct window
*w
)
22250 Lisp_Object old_selected_window
= selected_window
;
22251 Lisp_Object old_selected_frame
= selected_frame
;
22252 Lisp_Object new_frame
= w
->frame
;
22253 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
22256 selected_frame
= new_frame
;
22257 /* FIXME: If we were to allow the mode-line's computation changing the buffer
22258 or window's point, then we'd need select_window_1 here as well. */
22259 XSETWINDOW (selected_window
, w
);
22260 XFRAME (new_frame
)->selected_window
= selected_window
;
22262 /* These will be set while the mode line specs are processed. */
22263 line_number_displayed
= false;
22264 w
->column_number_displayed
= -1;
22266 if (WINDOW_WANTS_MODELINE_P (w
))
22268 struct window
*sel_w
= XWINDOW (old_selected_window
);
22270 /* Select mode line face based on the real selected window. */
22271 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
22272 BVAR (current_buffer
, mode_line_format
));
22276 if (WINDOW_WANTS_HEADER_LINE_P (w
))
22278 display_mode_line (w
, HEADER_LINE_FACE_ID
,
22279 BVAR (current_buffer
, header_line_format
));
22283 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
22284 selected_frame
= old_selected_frame
;
22285 selected_window
= old_selected_window
;
22287 w
->must_be_updated_p
= true;
22292 /* Display mode or header line of window W. FACE_ID specifies which
22293 line to display; it is either MODE_LINE_FACE_ID or
22294 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
22295 display. Value is the pixel height of the mode/header line
22299 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
22303 ptrdiff_t count
= SPECPDL_INDEX ();
22305 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22306 /* Don't extend on a previously drawn mode-line.
22307 This may happen if called from pos_visible_p. */
22308 it
.glyph_row
->enabled_p
= false;
22309 prepare_desired_row (w
, it
.glyph_row
, true);
22311 it
.glyph_row
->mode_line_p
= true;
22313 /* FIXME: This should be controlled by a user option. But
22314 supporting such an option is not trivial, since the mode line is
22315 made up of many separate strings. */
22316 it
.paragraph_embedding
= L2R
;
22318 record_unwind_protect (unwind_format_mode_line
,
22319 format_mode_line_unwind_data (NULL
, NULL
,
22322 mode_line_target
= MODE_LINE_DISPLAY
;
22324 /* Temporarily make frame's keyboard the current kboard so that
22325 kboard-local variables in the mode_line_format will get the right
22327 push_kboard (FRAME_KBOARD (it
.f
));
22328 record_unwind_save_match_data ();
22329 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22332 unbind_to (count
, Qnil
);
22334 /* Fill up with spaces. */
22335 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
22337 compute_line_metrics (&it
);
22338 it
.glyph_row
->full_width_p
= true;
22339 it
.glyph_row
->continued_p
= false;
22340 it
.glyph_row
->truncated_on_left_p
= false;
22341 it
.glyph_row
->truncated_on_right_p
= false;
22343 /* Make a 3D mode-line have a shadow at its right end. */
22344 face
= FACE_FROM_ID (it
.f
, face_id
);
22345 extend_face_to_end_of_line (&it
);
22346 if (face
->box
!= FACE_NO_BOX
)
22348 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
22349 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
22350 last
->right_box_line_p
= true;
22353 return it
.glyph_row
->height
;
22356 /* Move element ELT in LIST to the front of LIST.
22357 Return the updated list. */
22360 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
22362 register Lisp_Object tail
, prev
;
22363 register Lisp_Object tem
;
22367 while (CONSP (tail
))
22373 /* Splice out the link TAIL. */
22375 list
= XCDR (tail
);
22377 Fsetcdr (prev
, XCDR (tail
));
22379 /* Now make it the first. */
22380 Fsetcdr (tail
, list
);
22385 tail
= XCDR (tail
);
22389 /* Not found--return unchanged LIST. */
22393 /* Contribute ELT to the mode line for window IT->w. How it
22394 translates into text depends on its data type.
22396 IT describes the display environment in which we display, as usual.
22398 DEPTH is the depth in recursion. It is used to prevent
22399 infinite recursion here.
22401 FIELD_WIDTH is the number of characters the display of ELT should
22402 occupy in the mode line, and PRECISION is the maximum number of
22403 characters to display from ELT's representation. See
22404 display_string for details.
22406 Returns the hpos of the end of the text generated by ELT.
22408 PROPS is a property list to add to any string we encounter.
22410 If RISKY, remove (disregard) any properties in any string
22411 we encounter, and ignore :eval and :propertize.
22413 The global variable `mode_line_target' determines whether the
22414 output is passed to `store_mode_line_noprop',
22415 `store_mode_line_string', or `display_string'. */
22418 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
22419 Lisp_Object elt
, Lisp_Object props
, bool risky
)
22421 int n
= 0, field
, prec
;
22422 bool literal
= false;
22426 elt
= build_string ("*too-deep*");
22430 switch (XTYPE (elt
))
22434 /* A string: output it and check for %-constructs within it. */
22436 ptrdiff_t offset
= 0;
22438 if (SCHARS (elt
) > 0
22439 && (!NILP (props
) || risky
))
22441 Lisp_Object oprops
, aelt
;
22442 oprops
= Ftext_properties_at (make_number (0), elt
);
22444 /* If the starting string's properties are not what
22445 we want, translate the string. Also, if the string
22446 is risky, do that anyway. */
22448 if (NILP (Fequal (props
, oprops
)) || risky
)
22450 /* If the starting string has properties,
22451 merge the specified ones onto the existing ones. */
22452 if (! NILP (oprops
) && !risky
)
22456 oprops
= Fcopy_sequence (oprops
);
22458 while (CONSP (tem
))
22460 oprops
= Fplist_put (oprops
, XCAR (tem
),
22461 XCAR (XCDR (tem
)));
22462 tem
= XCDR (XCDR (tem
));
22467 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
22468 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
22470 /* AELT is what we want. Move it to the front
22471 without consing. */
22473 mode_line_proptrans_alist
22474 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
22480 /* If AELT has the wrong props, it is useless.
22481 so get rid of it. */
22483 mode_line_proptrans_alist
22484 = Fdelq (aelt
, mode_line_proptrans_alist
);
22486 elt
= Fcopy_sequence (elt
);
22487 Fset_text_properties (make_number (0), Flength (elt
),
22489 /* Add this item to mode_line_proptrans_alist. */
22490 mode_line_proptrans_alist
22491 = Fcons (Fcons (elt
, props
),
22492 mode_line_proptrans_alist
);
22493 /* Truncate mode_line_proptrans_alist
22494 to at most 50 elements. */
22495 tem
= Fnthcdr (make_number (50),
22496 mode_line_proptrans_alist
);
22498 XSETCDR (tem
, Qnil
);
22507 prec
= precision
- n
;
22508 switch (mode_line_target
)
22510 case MODE_LINE_NOPROP
:
22511 case MODE_LINE_TITLE
:
22512 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
22514 case MODE_LINE_STRING
:
22515 n
+= store_mode_line_string (NULL
, elt
, true, 0, prec
, Qnil
);
22517 case MODE_LINE_DISPLAY
:
22518 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
22519 0, prec
, 0, STRING_MULTIBYTE (elt
));
22526 /* Handle the non-literal case. */
22528 while ((precision
<= 0 || n
< precision
)
22529 && SREF (elt
, offset
) != 0
22530 && (mode_line_target
!= MODE_LINE_DISPLAY
22531 || it
->current_x
< it
->last_visible_x
))
22533 ptrdiff_t last_offset
= offset
;
22535 /* Advance to end of string or next format specifier. */
22536 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22539 if (offset
- 1 != last_offset
)
22541 ptrdiff_t nchars
, nbytes
;
22543 /* Output to end of string or up to '%'. Field width
22544 is length of string. Don't output more than
22545 PRECISION allows us. */
22548 prec
= c_string_width (SDATA (elt
) + last_offset
,
22549 offset
- last_offset
, precision
- n
,
22552 switch (mode_line_target
)
22554 case MODE_LINE_NOPROP
:
22555 case MODE_LINE_TITLE
:
22556 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22558 case MODE_LINE_STRING
:
22560 ptrdiff_t bytepos
= last_offset
;
22561 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22562 ptrdiff_t endpos
= (precision
<= 0
22563 ? string_byte_to_char (elt
, offset
)
22564 : charpos
+ nchars
);
22565 Lisp_Object mode_string
22566 = Fsubstring (elt
, make_number (charpos
),
22567 make_number (endpos
));
22568 n
+= store_mode_line_string (NULL
, mode_string
, false,
22572 case MODE_LINE_DISPLAY
:
22574 ptrdiff_t bytepos
= last_offset
;
22575 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22577 if (precision
<= 0)
22578 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22579 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22581 STRING_MULTIBYTE (elt
));
22586 else /* c == '%' */
22588 ptrdiff_t percent_position
= offset
;
22590 /* Get the specified minimum width. Zero means
22593 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22594 field
= field
* 10 + c
- '0';
22596 /* Don't pad beyond the total padding allowed. */
22597 if (field_width
- n
> 0 && field
> field_width
- n
)
22598 field
= field_width
- n
;
22600 /* Note that either PRECISION <= 0 or N < PRECISION. */
22601 prec
= precision
- n
;
22604 n
+= display_mode_element (it
, depth
, field
, prec
,
22605 Vglobal_mode_string
, props
,
22610 ptrdiff_t bytepos
, charpos
;
22612 Lisp_Object string
;
22614 bytepos
= percent_position
;
22615 charpos
= (STRING_MULTIBYTE (elt
)
22616 ? string_byte_to_char (elt
, bytepos
)
22618 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22619 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22621 switch (mode_line_target
)
22623 case MODE_LINE_NOPROP
:
22624 case MODE_LINE_TITLE
:
22625 n
+= store_mode_line_noprop (spec
, field
, prec
);
22627 case MODE_LINE_STRING
:
22629 Lisp_Object tem
= build_string (spec
);
22630 props
= Ftext_properties_at (make_number (charpos
), elt
);
22631 /* Should only keep face property in props */
22632 n
+= store_mode_line_string (NULL
, tem
, false,
22633 field
, prec
, props
);
22636 case MODE_LINE_DISPLAY
:
22638 int nglyphs_before
, nwritten
;
22640 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22641 nwritten
= display_string (spec
, string
, elt
,
22646 /* Assign to the glyphs written above the
22647 string where the `%x' came from, position
22651 struct glyph
*glyph
22652 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22656 for (i
= 0; i
< nwritten
; ++i
)
22658 glyph
[i
].object
= elt
;
22659 glyph
[i
].charpos
= charpos
;
22676 /* A symbol: process the value of the symbol recursively
22677 as if it appeared here directly. Avoid error if symbol void.
22678 Special case: if value of symbol is a string, output the string
22681 register Lisp_Object tem
;
22683 /* If the variable is not marked as risky to set
22684 then its contents are risky to use. */
22685 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22688 tem
= Fboundp (elt
);
22691 tem
= Fsymbol_value (elt
);
22692 /* If value is a string, output that string literally:
22693 don't check for % within it. */
22697 if (!EQ (tem
, elt
))
22699 /* Give up right away for nil or t. */
22709 register Lisp_Object car
, tem
;
22711 /* A cons cell: five distinct cases.
22712 If first element is :eval or :propertize, do something special.
22713 If first element is a string or a cons, process all the elements
22714 and effectively concatenate them.
22715 If first element is a negative number, truncate displaying cdr to
22716 at most that many characters. If positive, pad (with spaces)
22717 to at least that many characters.
22718 If first element is a symbol, process the cadr or caddr recursively
22719 according to whether the symbol's value is non-nil or nil. */
22721 if (EQ (car
, QCeval
))
22723 /* An element of the form (:eval FORM) means evaluate FORM
22724 and use the result as mode line elements. */
22729 if (CONSP (XCDR (elt
)))
22732 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22733 n
+= display_mode_element (it
, depth
, field_width
- n
,
22734 precision
- n
, spec
, props
,
22738 else if (EQ (car
, QCpropertize
))
22740 /* An element of the form (:propertize ELT PROPS...)
22741 means display ELT but applying properties PROPS. */
22746 if (CONSP (XCDR (elt
)))
22747 n
+= display_mode_element (it
, depth
, field_width
- n
,
22748 precision
- n
, XCAR (XCDR (elt
)),
22749 XCDR (XCDR (elt
)), risky
);
22751 else if (SYMBOLP (car
))
22753 tem
= Fboundp (car
);
22757 /* elt is now the cdr, and we know it is a cons cell.
22758 Use its car if CAR has a non-nil value. */
22761 tem
= Fsymbol_value (car
);
22768 /* Symbol's value is nil (or symbol is unbound)
22769 Get the cddr of the original list
22770 and if possible find the caddr and use that. */
22774 else if (!CONSP (elt
))
22779 else if (INTEGERP (car
))
22781 register int lim
= XINT (car
);
22785 /* Negative int means reduce maximum width. */
22786 if (precision
<= 0)
22789 precision
= min (precision
, -lim
);
22793 /* Padding specified. Don't let it be more than
22794 current maximum. */
22796 lim
= min (precision
, lim
);
22798 /* If that's more padding than already wanted, queue it.
22799 But don't reduce padding already specified even if
22800 that is beyond the current truncation point. */
22801 field_width
= max (lim
, field_width
);
22805 else if (STRINGP (car
) || CONSP (car
))
22807 Lisp_Object halftail
= elt
;
22811 && (precision
<= 0 || n
< precision
))
22813 n
+= display_mode_element (it
, depth
,
22814 /* Do padding only after the last
22815 element in the list. */
22816 (! CONSP (XCDR (elt
))
22819 precision
- n
, XCAR (elt
),
22823 if ((len
& 1) == 0)
22824 halftail
= XCDR (halftail
);
22825 /* Check for cycle. */
22826 if (EQ (halftail
, elt
))
22835 elt
= build_string ("*invalid*");
22839 /* Pad to FIELD_WIDTH. */
22840 if (field_width
> 0 && n
< field_width
)
22842 switch (mode_line_target
)
22844 case MODE_LINE_NOPROP
:
22845 case MODE_LINE_TITLE
:
22846 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22848 case MODE_LINE_STRING
:
22849 n
+= store_mode_line_string ("", Qnil
, false, field_width
- n
, 0,
22852 case MODE_LINE_DISPLAY
:
22853 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22862 /* Store a mode-line string element in mode_line_string_list.
22864 If STRING is non-null, display that C string. Otherwise, the Lisp
22865 string LISP_STRING is displayed.
22867 FIELD_WIDTH is the minimum number of output glyphs to produce.
22868 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22869 with spaces. FIELD_WIDTH <= 0 means don't pad.
22871 PRECISION is the maximum number of characters to output from
22872 STRING. PRECISION <= 0 means don't truncate the string.
22874 If COPY_STRING, make a copy of LISP_STRING before adding
22875 properties to the string.
22877 PROPS are the properties to add to the string.
22878 The mode_line_string_face face property is always added to the string.
22882 store_mode_line_string (const char *string
, Lisp_Object lisp_string
,
22884 int field_width
, int precision
, Lisp_Object props
)
22889 if (string
!= NULL
)
22891 len
= strlen (string
);
22892 if (precision
> 0 && len
> precision
)
22894 lisp_string
= make_string (string
, len
);
22896 props
= mode_line_string_face_prop
;
22897 else if (!NILP (mode_line_string_face
))
22899 Lisp_Object face
= Fplist_get (props
, Qface
);
22900 props
= Fcopy_sequence (props
);
22902 face
= mode_line_string_face
;
22904 face
= list2 (face
, mode_line_string_face
);
22905 props
= Fplist_put (props
, Qface
, face
);
22907 Fadd_text_properties (make_number (0), make_number (len
),
22908 props
, lisp_string
);
22912 len
= XFASTINT (Flength (lisp_string
));
22913 if (precision
> 0 && len
> precision
)
22916 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22919 if (!NILP (mode_line_string_face
))
22923 props
= Ftext_properties_at (make_number (0), lisp_string
);
22924 face
= Fplist_get (props
, Qface
);
22926 face
= mode_line_string_face
;
22928 face
= list2 (face
, mode_line_string_face
);
22929 props
= list2 (Qface
, face
);
22931 lisp_string
= Fcopy_sequence (lisp_string
);
22934 Fadd_text_properties (make_number (0), make_number (len
),
22935 props
, lisp_string
);
22940 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22944 if (field_width
> len
)
22946 field_width
-= len
;
22947 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22949 Fadd_text_properties (make_number (0), make_number (field_width
),
22950 props
, lisp_string
);
22951 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22959 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22961 doc
: /* Format a string out of a mode line format specification.
22962 First arg FORMAT specifies the mode line format (see `mode-line-format'
22963 for details) to use.
22965 By default, the format is evaluated for the currently selected window.
22967 Optional second arg FACE specifies the face property to put on all
22968 characters for which no face is specified. The value nil means the
22969 default face. The value t means whatever face the window's mode line
22970 currently uses (either `mode-line' or `mode-line-inactive',
22971 depending on whether the window is the selected window or not).
22972 An integer value means the value string has no text
22975 Optional third and fourth args WINDOW and BUFFER specify the window
22976 and buffer to use as the context for the formatting (defaults
22977 are the selected window and the WINDOW's buffer). */)
22978 (Lisp_Object format
, Lisp_Object face
,
22979 Lisp_Object window
, Lisp_Object buffer
)
22984 struct buffer
*old_buffer
= NULL
;
22986 bool no_props
= INTEGERP (face
);
22987 ptrdiff_t count
= SPECPDL_INDEX ();
22989 int string_start
= 0;
22991 w
= decode_any_window (window
);
22992 XSETWINDOW (window
, w
);
22995 buffer
= w
->contents
;
22996 CHECK_BUFFER (buffer
);
22998 /* Make formatting the modeline a non-op when noninteractive, otherwise
22999 there will be problems later caused by a partially initialized frame. */
23000 if (NILP (format
) || noninteractive
)
23001 return empty_unibyte_string
;
23006 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
23007 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
23008 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
23009 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
23010 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
23011 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
23012 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
23015 old_buffer
= current_buffer
;
23017 /* Save things including mode_line_proptrans_alist,
23018 and set that to nil so that we don't alter the outer value. */
23019 record_unwind_protect (unwind_format_mode_line
,
23020 format_mode_line_unwind_data
23021 (XFRAME (WINDOW_FRAME (w
)),
23022 old_buffer
, selected_window
, true));
23023 mode_line_proptrans_alist
= Qnil
;
23025 Fselect_window (window
, Qt
);
23026 set_buffer_internal_1 (XBUFFER (buffer
));
23028 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
23032 mode_line_target
= MODE_LINE_NOPROP
;
23033 mode_line_string_face_prop
= Qnil
;
23034 mode_line_string_list
= Qnil
;
23035 string_start
= MODE_LINE_NOPROP_LEN (0);
23039 mode_line_target
= MODE_LINE_STRING
;
23040 mode_line_string_list
= Qnil
;
23041 mode_line_string_face
= face
;
23042 mode_line_string_face_prop
23043 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
23046 push_kboard (FRAME_KBOARD (it
.f
));
23047 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
23052 len
= MODE_LINE_NOPROP_LEN (string_start
);
23053 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
23057 mode_line_string_list
= Fnreverse (mode_line_string_list
);
23058 str
= Fmapconcat (Qidentity
, mode_line_string_list
,
23059 empty_unibyte_string
);
23062 unbind_to (count
, Qnil
);
23066 /* Write a null-terminated, right justified decimal representation of
23067 the positive integer D to BUF using a minimal field width WIDTH. */
23070 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
23072 register char *p
= buf
;
23080 *p
++ = d
% 10 + '0';
23085 for (width
-= (int) (p
- buf
); width
> 0; --width
)
23096 /* Write a null-terminated, right justified decimal and "human
23097 readable" representation of the nonnegative integer D to BUF using
23098 a minimal field width WIDTH. D should be smaller than 999.5e24. */
23100 static const char power_letter
[] =
23114 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
23116 /* We aim to represent the nonnegative integer D as
23117 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
23118 ptrdiff_t quotient
= d
;
23120 /* -1 means: do not use TENTHS. */
23124 /* Length of QUOTIENT.TENTHS as a string. */
23130 if (quotient
>= 1000)
23132 /* Scale to the appropriate EXPONENT. */
23135 remainder
= quotient
% 1000;
23139 while (quotient
>= 1000);
23141 /* Round to nearest and decide whether to use TENTHS or not. */
23144 tenths
= remainder
/ 100;
23145 if (remainder
% 100 >= 50)
23152 if (quotient
== 10)
23160 if (remainder
>= 500)
23162 if (quotient
< 999)
23173 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
23174 if (tenths
== -1 && quotient
<= 99)
23181 p
= psuffix
= buf
+ max (width
, length
);
23183 /* Print EXPONENT. */
23184 *psuffix
++ = power_letter
[exponent
];
23187 /* Print TENTHS. */
23190 *--p
= '0' + tenths
;
23194 /* Print QUOTIENT. */
23197 int digit
= quotient
% 10;
23198 *--p
= '0' + digit
;
23200 while ((quotient
/= 10) != 0);
23202 /* Print leading spaces. */
23207 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
23208 If EOL_FLAG, set also a mnemonic character for end-of-line
23209 type of CODING_SYSTEM. Return updated pointer into BUF. */
23211 static unsigned char invalid_eol_type
[] = "(*invalid*)";
23214 decode_mode_spec_coding (Lisp_Object coding_system
, char *buf
, bool eol_flag
)
23217 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
23218 const unsigned char *eol_str
;
23220 /* The EOL conversion we are using. */
23221 Lisp_Object eoltype
;
23223 val
= CODING_SYSTEM_SPEC (coding_system
);
23226 if (!VECTORP (val
)) /* Not yet decided. */
23228 *buf
++ = multibyte
? '-' : ' ';
23230 eoltype
= eol_mnemonic_undecided
;
23231 /* Don't mention EOL conversion if it isn't decided. */
23236 Lisp_Object eolvalue
;
23238 attrs
= AREF (val
, 0);
23239 eolvalue
= AREF (val
, 2);
23242 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
23247 /* The EOL conversion that is normal on this system. */
23249 if (NILP (eolvalue
)) /* Not yet decided. */
23250 eoltype
= eol_mnemonic_undecided
;
23251 else if (VECTORP (eolvalue
)) /* Not yet decided. */
23252 eoltype
= eol_mnemonic_undecided
;
23253 else /* eolvalue is Qunix, Qdos, or Qmac. */
23254 eoltype
= (EQ (eolvalue
, Qunix
)
23255 ? eol_mnemonic_unix
23256 : EQ (eolvalue
, Qdos
)
23257 ? eol_mnemonic_dos
: eol_mnemonic_mac
);
23263 /* Mention the EOL conversion if it is not the usual one. */
23264 if (STRINGP (eoltype
))
23266 eol_str
= SDATA (eoltype
);
23267 eol_str_len
= SBYTES (eoltype
);
23269 else if (CHARACTERP (eoltype
))
23271 int c
= XFASTINT (eoltype
);
23272 return buf
+ CHAR_STRING (c
, (unsigned char *) buf
);
23276 eol_str
= invalid_eol_type
;
23277 eol_str_len
= sizeof (invalid_eol_type
) - 1;
23279 memcpy (buf
, eol_str
, eol_str_len
);
23280 buf
+= eol_str_len
;
23286 /* Return a string for the output of a mode line %-spec for window W,
23287 generated by character C. FIELD_WIDTH > 0 means pad the string
23288 returned with spaces to that value. Return a Lisp string in
23289 *STRING if the resulting string is taken from that Lisp string.
23291 Note we operate on the current buffer for most purposes. */
23293 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
23295 static const char *
23296 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
23297 Lisp_Object
*string
)
23300 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23301 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
23302 /* We are going to use f->decode_mode_spec_buffer as the buffer to
23303 produce strings from numerical values, so limit preposterously
23304 large values of FIELD_WIDTH to avoid overrunning the buffer's
23305 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
23306 bytes plus the terminating null. */
23307 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
23308 struct buffer
*b
= current_buffer
;
23316 if (!NILP (BVAR (b
, read_only
)))
23318 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23323 /* This differs from %* only for a modified read-only buffer. */
23324 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23326 if (!NILP (BVAR (b
, read_only
)))
23331 /* This differs from %* in ignoring read-only-ness. */
23332 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23344 if (command_loop_level
> 5)
23346 p
= decode_mode_spec_buf
;
23347 for (i
= 0; i
< command_loop_level
; i
++)
23350 return decode_mode_spec_buf
;
23358 if (command_loop_level
> 5)
23360 p
= decode_mode_spec_buf
;
23361 for (i
= 0; i
< command_loop_level
; i
++)
23364 return decode_mode_spec_buf
;
23371 /* Let lots_of_dashes be a string of infinite length. */
23372 if (mode_line_target
== MODE_LINE_NOPROP
23373 || mode_line_target
== MODE_LINE_STRING
)
23375 if (field_width
<= 0
23376 || field_width
> sizeof (lots_of_dashes
))
23378 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
23379 decode_mode_spec_buf
[i
] = '-';
23380 decode_mode_spec_buf
[i
] = '\0';
23381 return decode_mode_spec_buf
;
23384 return lots_of_dashes
;
23388 obj
= BVAR (b
, name
);
23392 /* %c and %l are ignored in `frame-title-format'.
23393 (In redisplay_internal, the frame title is drawn _before_ the
23394 windows are updated, so the stuff which depends on actual
23395 window contents (such as %l) may fail to render properly, or
23396 even crash emacs.) */
23397 if (mode_line_target
== MODE_LINE_TITLE
)
23401 ptrdiff_t col
= current_column ();
23402 w
->column_number_displayed
= col
;
23403 pint2str (decode_mode_spec_buf
, width
, col
);
23404 return decode_mode_spec_buf
;
23408 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
23410 if (NILP (Vmemory_full
))
23413 return "!MEM FULL! ";
23420 /* %F displays the frame name. */
23421 if (!NILP (f
->title
))
23422 return SSDATA (f
->title
);
23423 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
23424 return SSDATA (f
->name
);
23428 obj
= BVAR (b
, filename
);
23433 ptrdiff_t size
= ZV
- BEGV
;
23434 pint2str (decode_mode_spec_buf
, width
, size
);
23435 return decode_mode_spec_buf
;
23440 ptrdiff_t size
= ZV
- BEGV
;
23441 pint2hrstr (decode_mode_spec_buf
, width
, size
);
23442 return decode_mode_spec_buf
;
23447 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
23448 ptrdiff_t topline
, nlines
, height
;
23451 /* %c and %l are ignored in `frame-title-format'. */
23452 if (mode_line_target
== MODE_LINE_TITLE
)
23455 startpos
= marker_position (w
->start
);
23456 startpos_byte
= marker_byte_position (w
->start
);
23457 height
= WINDOW_TOTAL_LINES (w
);
23459 /* If we decided that this buffer isn't suitable for line numbers,
23460 don't forget that too fast. */
23461 if (w
->base_line_pos
== -1)
23464 /* If the buffer is very big, don't waste time. */
23465 if (INTEGERP (Vline_number_display_limit
)
23466 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
23468 w
->base_line_pos
= 0;
23469 w
->base_line_number
= 0;
23473 if (w
->base_line_number
> 0
23474 && w
->base_line_pos
> 0
23475 && w
->base_line_pos
<= startpos
)
23477 line
= w
->base_line_number
;
23478 linepos
= w
->base_line_pos
;
23479 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
23484 linepos
= BUF_BEGV (b
);
23485 linepos_byte
= BUF_BEGV_BYTE (b
);
23488 /* Count lines from base line to window start position. */
23489 nlines
= display_count_lines (linepos_byte
,
23493 topline
= nlines
+ line
;
23495 /* Determine a new base line, if the old one is too close
23496 or too far away, or if we did not have one.
23497 "Too close" means it's plausible a scroll-down would
23498 go back past it. */
23499 if (startpos
== BUF_BEGV (b
))
23501 w
->base_line_number
= topline
;
23502 w
->base_line_pos
= BUF_BEGV (b
);
23504 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
23505 || linepos
== BUF_BEGV (b
))
23507 ptrdiff_t limit
= BUF_BEGV (b
);
23508 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
23509 ptrdiff_t position
;
23510 ptrdiff_t distance
=
23511 (height
* 2 + 30) * line_number_display_limit_width
;
23513 if (startpos
- distance
> limit
)
23515 limit
= startpos
- distance
;
23516 limit_byte
= CHAR_TO_BYTE (limit
);
23519 nlines
= display_count_lines (startpos_byte
,
23521 - (height
* 2 + 30),
23523 /* If we couldn't find the lines we wanted within
23524 line_number_display_limit_width chars per line,
23525 give up on line numbers for this window. */
23526 if (position
== limit_byte
&& limit
== startpos
- distance
)
23528 w
->base_line_pos
= -1;
23529 w
->base_line_number
= 0;
23533 w
->base_line_number
= topline
- nlines
;
23534 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23537 /* Now count lines from the start pos to point. */
23538 nlines
= display_count_lines (startpos_byte
,
23539 PT_BYTE
, PT
, &junk
);
23541 /* Record that we did display the line number. */
23542 line_number_displayed
= true;
23544 /* Make the string to show. */
23545 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23546 return decode_mode_spec_buf
;
23549 char *p
= decode_mode_spec_buf
;
23550 int pad
= width
- 2;
23556 return decode_mode_spec_buf
;
23562 obj
= BVAR (b
, mode_name
);
23566 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23572 ptrdiff_t pos
= marker_position (w
->start
);
23573 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23575 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23577 if (pos
<= BUF_BEGV (b
))
23582 else if (pos
<= BUF_BEGV (b
))
23586 if (total
> 1000000)
23587 /* Do it differently for a large value, to avoid overflow. */
23588 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23590 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23591 /* We can't normally display a 3-digit number,
23592 so get us a 2-digit number that is close. */
23595 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23596 return decode_mode_spec_buf
;
23600 /* Display percentage of size above the bottom of the screen. */
23603 ptrdiff_t toppos
= marker_position (w
->start
);
23604 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23605 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23607 if (botpos
>= BUF_ZV (b
))
23609 if (toppos
<= BUF_BEGV (b
))
23616 if (total
> 1000000)
23617 /* Do it differently for a large value, to avoid overflow. */
23618 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23620 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23621 /* We can't normally display a 3-digit number,
23622 so get us a 2-digit number that is close. */
23625 if (toppos
<= BUF_BEGV (b
))
23626 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23628 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23629 return decode_mode_spec_buf
;
23634 /* status of process */
23635 obj
= Fget_buffer_process (Fcurrent_buffer ());
23637 return "no process";
23639 obj
= Fsymbol_name (Fprocess_status (obj
));
23645 ptrdiff_t count
= inhibit_garbage_collection ();
23646 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23647 Lisp_Object val
= Qnil
;
23649 if (STRINGP (curdir
))
23650 val
= call1 (intern ("file-remote-p"), curdir
);
23652 unbind_to (count
, Qnil
);
23661 /* coding-system (not including end-of-line format) */
23663 /* coding-system (including end-of-line type) */
23665 bool eol_flag
= (c
== 'Z');
23666 char *p
= decode_mode_spec_buf
;
23668 if (! FRAME_WINDOW_P (f
))
23670 /* No need to mention EOL here--the terminal never needs
23671 to do EOL conversion. */
23672 p
= decode_mode_spec_coding (CODING_ID_NAME
23673 (FRAME_KEYBOARD_CODING (f
)->id
),
23675 p
= decode_mode_spec_coding (CODING_ID_NAME
23676 (FRAME_TERMINAL_CODING (f
)->id
),
23679 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23682 #if false /* This proves to be annoying; I think we can do without. -- rms. */
23683 #ifdef subprocesses
23684 obj
= Fget_buffer_process (Fcurrent_buffer ());
23685 if (PROCESSP (obj
))
23687 p
= decode_mode_spec_coding
23688 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23689 p
= decode_mode_spec_coding
23690 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23692 #endif /* subprocesses */
23695 return decode_mode_spec_buf
;
23702 return SSDATA (obj
);
23709 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23710 means count lines back from START_BYTE. But don't go beyond
23711 LIMIT_BYTE. Return the number of lines thus found (always
23714 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23715 either the position COUNT lines after/before START_BYTE, if we
23716 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23720 display_count_lines (ptrdiff_t start_byte
,
23721 ptrdiff_t limit_byte
, ptrdiff_t count
,
23722 ptrdiff_t *byte_pos_ptr
)
23724 register unsigned char *cursor
;
23725 unsigned char *base
;
23727 register ptrdiff_t ceiling
;
23728 register unsigned char *ceiling_addr
;
23729 ptrdiff_t orig_count
= count
;
23731 /* If we are not in selective display mode,
23732 check only for newlines. */
23733 bool selective_display
23734 = (!NILP (BVAR (current_buffer
, selective_display
))
23735 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23739 while (start_byte
< limit_byte
)
23741 ceiling
= BUFFER_CEILING_OF (start_byte
);
23742 ceiling
= min (limit_byte
- 1, ceiling
);
23743 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23744 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23748 if (selective_display
)
23750 while (*cursor
!= '\n' && *cursor
!= 015
23751 && ++cursor
!= ceiling_addr
)
23753 if (cursor
== ceiling_addr
)
23758 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23767 start_byte
+= cursor
- base
;
23768 *byte_pos_ptr
= start_byte
;
23772 while (cursor
< ceiling_addr
);
23774 start_byte
+= ceiling_addr
- base
;
23779 while (start_byte
> limit_byte
)
23781 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23782 ceiling
= max (limit_byte
, ceiling
);
23783 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23784 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23787 if (selective_display
)
23789 while (--cursor
>= ceiling_addr
23790 && *cursor
!= '\n' && *cursor
!= 015)
23792 if (cursor
< ceiling_addr
)
23797 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23804 start_byte
+= cursor
- base
+ 1;
23805 *byte_pos_ptr
= start_byte
;
23806 /* When scanning backwards, we should
23807 not count the newline posterior to which we stop. */
23808 return - orig_count
- 1;
23811 start_byte
+= ceiling_addr
- base
;
23815 *byte_pos_ptr
= limit_byte
;
23818 return - orig_count
+ count
;
23819 return orig_count
- count
;
23825 /***********************************************************************
23827 ***********************************************************************/
23829 /* Display a NUL-terminated string, starting with index START.
23831 If STRING is non-null, display that C string. Otherwise, the Lisp
23832 string LISP_STRING is displayed. There's a case that STRING is
23833 non-null and LISP_STRING is not nil. It means STRING is a string
23834 data of LISP_STRING. In that case, we display LISP_STRING while
23835 ignoring its text properties.
23837 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23838 FACE_STRING. Display STRING or LISP_STRING with the face at
23839 FACE_STRING_POS in FACE_STRING:
23841 Display the string in the environment given by IT, but use the
23842 standard display table, temporarily.
23844 FIELD_WIDTH is the minimum number of output glyphs to produce.
23845 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23846 with spaces. If STRING has more characters, more than FIELD_WIDTH
23847 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23849 PRECISION is the maximum number of characters to output from
23850 STRING. PRECISION < 0 means don't truncate the string.
23852 This is roughly equivalent to printf format specifiers:
23854 FIELD_WIDTH PRECISION PRINTF
23855 ----------------------------------------
23861 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23862 display them, and < 0 means obey the current buffer's value of
23863 enable_multibyte_characters.
23865 Value is the number of columns displayed. */
23868 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23869 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23870 int field_width
, int precision
, int max_x
, int multibyte
)
23872 int hpos_at_start
= it
->hpos
;
23873 int saved_face_id
= it
->face_id
;
23874 struct glyph_row
*row
= it
->glyph_row
;
23875 ptrdiff_t it_charpos
;
23877 /* Initialize the iterator IT for iteration over STRING beginning
23878 with index START. */
23879 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23880 precision
, field_width
, multibyte
);
23881 if (string
&& STRINGP (lisp_string
))
23882 /* LISP_STRING is the one returned by decode_mode_spec. We should
23883 ignore its text properties. */
23884 it
->stop_charpos
= it
->end_charpos
;
23886 /* If displaying STRING, set up the face of the iterator from
23887 FACE_STRING, if that's given. */
23888 if (STRINGP (face_string
))
23894 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23895 0, &endptr
, it
->base_face_id
, false);
23896 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23897 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23900 /* Set max_x to the maximum allowed X position. Don't let it go
23901 beyond the right edge of the window. */
23903 max_x
= it
->last_visible_x
;
23905 max_x
= min (max_x
, it
->last_visible_x
);
23907 /* Skip over display elements that are not visible. because IT->w is
23909 if (it
->current_x
< it
->first_visible_x
)
23910 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23911 MOVE_TO_POS
| MOVE_TO_X
);
23913 row
->ascent
= it
->max_ascent
;
23914 row
->height
= it
->max_ascent
+ it
->max_descent
;
23915 row
->phys_ascent
= it
->max_phys_ascent
;
23916 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23917 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23919 if (STRINGP (it
->string
))
23920 it_charpos
= IT_STRING_CHARPOS (*it
);
23922 it_charpos
= IT_CHARPOS (*it
);
23924 /* This condition is for the case that we are called with current_x
23925 past last_visible_x. */
23926 while (it
->current_x
< max_x
)
23928 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23930 /* Get the next display element. */
23931 if (!get_next_display_element (it
))
23934 /* Produce glyphs. */
23935 x_before
= it
->current_x
;
23936 n_glyphs_before
= row
->used
[TEXT_AREA
];
23937 PRODUCE_GLYPHS (it
);
23939 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23942 while (i
< nglyphs
)
23944 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23946 if (it
->line_wrap
!= TRUNCATE
23947 && x
+ glyph
->pixel_width
> max_x
)
23949 /* End of continued line or max_x reached. */
23950 if (CHAR_GLYPH_PADDING_P (*glyph
))
23952 /* A wide character is unbreakable. */
23953 if (row
->reversed_p
)
23954 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23955 - n_glyphs_before
);
23956 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23957 it
->current_x
= x_before
;
23961 if (row
->reversed_p
)
23962 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23963 - (n_glyphs_before
+ i
));
23964 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23969 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23971 /* Glyph is at least partially visible. */
23973 if (x
< it
->first_visible_x
)
23974 row
->x
= x
- it
->first_visible_x
;
23978 /* Glyph is off the left margin of the display area.
23979 Should not happen. */
23983 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23984 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23985 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23986 row
->phys_height
= max (row
->phys_height
,
23987 it
->max_phys_ascent
+ it
->max_phys_descent
);
23988 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23989 it
->max_extra_line_spacing
);
23990 x
+= glyph
->pixel_width
;
23994 /* Stop if max_x reached. */
23998 /* Stop at line ends. */
23999 if (ITERATOR_AT_END_OF_LINE_P (it
))
24001 it
->continuation_lines_width
= 0;
24005 set_iterator_to_next (it
, true);
24006 if (STRINGP (it
->string
))
24007 it_charpos
= IT_STRING_CHARPOS (*it
);
24009 it_charpos
= IT_CHARPOS (*it
);
24011 /* Stop if truncating at the right edge. */
24012 if (it
->line_wrap
== TRUNCATE
24013 && it
->current_x
>= it
->last_visible_x
)
24015 /* Add truncation mark, but don't do it if the line is
24016 truncated at a padding space. */
24017 if (it_charpos
< it
->string_nchars
)
24019 if (!FRAME_WINDOW_P (it
->f
))
24023 if (it
->current_x
> it
->last_visible_x
)
24025 if (!row
->reversed_p
)
24027 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
24028 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
24033 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
24034 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
24036 unproduce_glyphs (it
, ii
+ 1);
24037 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
24039 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
24041 row
->used
[TEXT_AREA
] = ii
;
24042 produce_special_glyphs (it
, IT_TRUNCATION
);
24045 produce_special_glyphs (it
, IT_TRUNCATION
);
24047 row
->truncated_on_right_p
= true;
24053 /* Maybe insert a truncation at the left. */
24054 if (it
->first_visible_x
24057 if (!FRAME_WINDOW_P (it
->f
)
24058 || (row
->reversed_p
24059 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24060 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
24061 insert_left_trunc_glyphs (it
);
24062 row
->truncated_on_left_p
= true;
24065 it
->face_id
= saved_face_id
;
24067 /* Value is number of columns displayed. */
24068 return it
->hpos
- hpos_at_start
;
24073 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
24074 appears as an element of LIST or as the car of an element of LIST.
24075 If PROPVAL is a list, compare each element against LIST in that
24076 way, and return 1/2 if any element of PROPVAL is found in LIST.
24077 Otherwise return 0. This function cannot quit.
24078 The return value is 2 if the text is invisible but with an ellipsis
24079 and 1 if it's invisible and without an ellipsis. */
24082 invisible_prop (Lisp_Object propval
, Lisp_Object list
)
24084 Lisp_Object tail
, proptail
;
24086 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
24088 register Lisp_Object tem
;
24090 if (EQ (propval
, tem
))
24092 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
24093 return NILP (XCDR (tem
)) ? 1 : 2;
24096 if (CONSP (propval
))
24098 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
24100 Lisp_Object propelt
;
24101 propelt
= XCAR (proptail
);
24102 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
24104 register Lisp_Object tem
;
24106 if (EQ (propelt
, tem
))
24108 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
24109 return NILP (XCDR (tem
)) ? 1 : 2;
24117 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
24118 doc
: /* Non-nil if the property makes the text invisible.
24119 POS-OR-PROP can be a marker or number, in which case it is taken to be
24120 a position in the current buffer and the value of the `invisible' property
24121 is checked; or it can be some other value, which is then presumed to be the
24122 value of the `invisible' property of the text of interest.
24123 The non-nil value returned can be t for truly invisible text or something
24124 else if the text is replaced by an ellipsis. */)
24125 (Lisp_Object pos_or_prop
)
24128 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
24129 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
24131 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
24132 return (invis
== 0 ? Qnil
24134 : make_number (invis
));
24137 /* Calculate a width or height in pixels from a specification using
24138 the following elements:
24141 NUM - a (fractional) multiple of the default font width/height
24142 (NUM) - specifies exactly NUM pixels
24143 UNIT - a fixed number of pixels, see below.
24144 ELEMENT - size of a display element in pixels, see below.
24145 (NUM . SPEC) - equals NUM * SPEC
24146 (+ SPEC SPEC ...) - add pixel values
24147 (- SPEC SPEC ...) - subtract pixel values
24148 (- SPEC) - negate pixel value
24151 INT or FLOAT - a number constant
24152 SYMBOL - use symbol's (buffer local) variable binding.
24155 in - pixels per inch *)
24156 mm - pixels per 1/1000 meter *)
24157 cm - pixels per 1/100 meter *)
24158 width - width of current font in pixels.
24159 height - height of current font in pixels.
24161 *) using the ratio(s) defined in display-pixels-per-inch.
24165 left-fringe - left fringe width in pixels
24166 right-fringe - right fringe width in pixels
24168 left-margin - left margin width in pixels
24169 right-margin - right margin width in pixels
24171 scroll-bar - scroll-bar area width in pixels
24175 Pixels corresponding to 5 inches:
24178 Total width of non-text areas on left side of window (if scroll-bar is on left):
24179 '(space :width (+ left-fringe left-margin scroll-bar))
24181 Align to first text column (in header line):
24182 '(space :align-to 0)
24184 Align to middle of text area minus half the width of variable `my-image'
24185 containing a loaded image:
24186 '(space :align-to (0.5 . (- text my-image)))
24188 Width of left margin minus width of 1 character in the default font:
24189 '(space :width (- left-margin 1))
24191 Width of left margin minus width of 2 characters in the current font:
24192 '(space :width (- left-margin (2 . width)))
24194 Center 1 character over left-margin (in header line):
24195 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
24197 Different ways to express width of left fringe plus left margin minus one pixel:
24198 '(space :width (- (+ left-fringe left-margin) (1)))
24199 '(space :width (+ left-fringe left-margin (- (1))))
24200 '(space :width (+ left-fringe left-margin (-1)))
24205 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
24206 struct font
*font
, bool width_p
, int *align_to
)
24210 # define OK_PIXELS(val) (*res = (val), true)
24211 # define OK_ALIGN_TO(val) (*align_to = (val), true)
24214 return OK_PIXELS (0);
24216 eassert (FRAME_LIVE_P (it
->f
));
24218 if (SYMBOLP (prop
))
24220 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
24222 char *unit
= SSDATA (SYMBOL_NAME (prop
));
24224 if (unit
[0] == 'i' && unit
[1] == 'n')
24226 else if (unit
[0] == 'm' && unit
[1] == 'm')
24228 else if (unit
[0] == 'c' && unit
[1] == 'm')
24234 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
24235 : FRAME_RES_Y (it
->f
));
24238 return OK_PIXELS (ppi
/ pixels
);
24243 #ifdef HAVE_WINDOW_SYSTEM
24244 if (EQ (prop
, Qheight
))
24245 return OK_PIXELS (font
24246 ? normal_char_height (font
, -1)
24247 : FRAME_LINE_HEIGHT (it
->f
));
24248 if (EQ (prop
, Qwidth
))
24249 return OK_PIXELS (font
24250 ? FONT_WIDTH (font
)
24251 : FRAME_COLUMN_WIDTH (it
->f
));
24253 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
24254 return OK_PIXELS (1);
24257 if (EQ (prop
, Qtext
))
24258 return OK_PIXELS (width_p
24259 ? window_box_width (it
->w
, TEXT_AREA
)
24260 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
24262 if (align_to
&& *align_to
< 0)
24265 if (EQ (prop
, Qleft
))
24266 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
24267 if (EQ (prop
, Qright
))
24268 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
24269 if (EQ (prop
, Qcenter
))
24270 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
24271 + window_box_width (it
->w
, TEXT_AREA
) / 2);
24272 if (EQ (prop
, Qleft_fringe
))
24273 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24274 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
24275 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
24276 if (EQ (prop
, Qright_fringe
))
24277 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24278 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24279 : window_box_right_offset (it
->w
, TEXT_AREA
));
24280 if (EQ (prop
, Qleft_margin
))
24281 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
24282 if (EQ (prop
, Qright_margin
))
24283 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
24284 if (EQ (prop
, Qscroll_bar
))
24285 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
24287 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24288 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24289 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24294 if (EQ (prop
, Qleft_fringe
))
24295 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
24296 if (EQ (prop
, Qright_fringe
))
24297 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
24298 if (EQ (prop
, Qleft_margin
))
24299 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
24300 if (EQ (prop
, Qright_margin
))
24301 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
24302 if (EQ (prop
, Qscroll_bar
))
24303 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
24306 prop
= buffer_local_value (prop
, it
->w
->contents
);
24307 if (EQ (prop
, Qunbound
))
24311 if (NUMBERP (prop
))
24313 int base_unit
= (width_p
24314 ? FRAME_COLUMN_WIDTH (it
->f
)
24315 : FRAME_LINE_HEIGHT (it
->f
));
24316 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
24321 Lisp_Object car
= XCAR (prop
);
24322 Lisp_Object cdr
= XCDR (prop
);
24326 #ifdef HAVE_WINDOW_SYSTEM
24327 if (FRAME_WINDOW_P (it
->f
)
24328 && valid_image_p (prop
))
24330 ptrdiff_t id
= lookup_image (it
->f
, prop
);
24331 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
24333 return OK_PIXELS (width_p
? img
->width
: img
->height
);
24335 if (FRAME_WINDOW_P (it
->f
) && valid_xwidget_spec_p (prop
))
24337 // TODO: Don't return dummy size.
24338 return OK_PIXELS (100);
24341 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
24347 while (CONSP (cdr
))
24349 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
24350 font
, width_p
, align_to
))
24353 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= false;
24358 if (EQ (car
, Qminus
))
24360 return OK_PIXELS (pixels
);
24363 car
= buffer_local_value (car
, it
->w
->contents
);
24364 if (EQ (car
, Qunbound
))
24371 pixels
= XFLOATINT (car
);
24373 return OK_PIXELS (pixels
);
24374 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
24375 font
, width_p
, align_to
))
24376 return OK_PIXELS (pixels
* fact
);
24387 get_font_ascent_descent (struct font
*font
, int *ascent
, int *descent
)
24389 #ifdef HAVE_WINDOW_SYSTEM
24390 normal_char_ascent_descent (font
, -1, ascent
, descent
);
24398 /***********************************************************************
24400 ***********************************************************************/
24402 #ifdef HAVE_WINDOW_SYSTEM
24407 dump_glyph_string (struct glyph_string
*s
)
24409 fprintf (stderr
, "glyph string\n");
24410 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
24411 s
->x
, s
->y
, s
->width
, s
->height
);
24412 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
24413 fprintf (stderr
, " hl = %d\n", s
->hl
);
24414 fprintf (stderr
, " left overhang = %d, right = %d\n",
24415 s
->left_overhang
, s
->right_overhang
);
24416 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
24417 fprintf (stderr
, " extends to end of line = %d\n",
24418 s
->extends_to_end_of_line_p
);
24419 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
24420 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
24423 #endif /* GLYPH_DEBUG */
24425 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
24426 of XChar2b structures for S; it can't be allocated in
24427 init_glyph_string because it must be allocated via `alloca'. W
24428 is the window on which S is drawn. ROW and AREA are the glyph row
24429 and area within the row from which S is constructed. START is the
24430 index of the first glyph structure covered by S. HL is a
24431 face-override for drawing S. */
24434 #define OPTIONAL_HDC(hdc) HDC hdc,
24435 #define DECLARE_HDC(hdc) HDC hdc;
24436 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
24437 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
24440 #ifndef OPTIONAL_HDC
24441 #define OPTIONAL_HDC(hdc)
24442 #define DECLARE_HDC(hdc)
24443 #define ALLOCATE_HDC(hdc, f)
24444 #define RELEASE_HDC(hdc, f)
24448 init_glyph_string (struct glyph_string
*s
,
24450 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
24451 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
24453 memset (s
, 0, sizeof *s
);
24455 s
->f
= XFRAME (w
->frame
);
24459 s
->display
= FRAME_X_DISPLAY (s
->f
);
24460 s
->window
= FRAME_X_WINDOW (s
->f
);
24461 s
->char2b
= char2b
;
24465 s
->first_glyph
= row
->glyphs
[area
] + start
;
24466 s
->height
= row
->height
;
24467 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
24468 s
->ybase
= s
->y
+ row
->ascent
;
24472 /* Append the list of glyph strings with head H and tail T to the list
24473 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
24476 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24477 struct glyph_string
*h
, struct glyph_string
*t
)
24491 /* Prepend the list of glyph strings with head H and tail T to the
24492 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
24496 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24497 struct glyph_string
*h
, struct glyph_string
*t
)
24511 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
24512 Set *HEAD and *TAIL to the resulting list. */
24515 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
24516 struct glyph_string
*s
)
24518 s
->next
= s
->prev
= NULL
;
24519 append_glyph_string_lists (head
, tail
, s
, s
);
24523 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24524 The encoding of C is returned in *CHAR2B. DISPLAY_P means
24525 make sure that X resources for the face returned are allocated.
24526 Value is a pointer to a realized face that is ready for display if
24529 static struct face
*
24530 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
24531 XChar2b
*char2b
, bool display_p
)
24533 struct face
*face
= FACE_FROM_ID (f
, face_id
);
24538 code
= face
->font
->driver
->encode_char (face
->font
, c
);
24540 if (code
== FONT_INVALID_CODE
)
24543 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24545 /* Make sure X resources of the face are allocated. */
24546 #ifdef HAVE_X_WINDOWS
24550 eassert (face
!= NULL
);
24551 prepare_face_for_display (f
, face
);
24558 /* Get face and two-byte form of character glyph GLYPH on frame F.
24559 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24560 a pointer to a realized face that is ready for display. */
24562 static struct face
*
24563 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24569 eassert (glyph
->type
== CHAR_GLYPH
);
24570 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24572 /* Make sure X resources of the face are allocated. */
24573 eassert (face
!= NULL
);
24574 prepare_face_for_display (f
, face
);
24578 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24579 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24581 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24583 if (code
== FONT_INVALID_CODE
)
24587 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24592 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24593 Return true iff FONT has a glyph for C. */
24596 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24600 if (CHAR_BYTE8_P (c
))
24601 code
= CHAR_TO_BYTE8 (c
);
24603 code
= font
->driver
->encode_char (font
, c
);
24605 if (code
== FONT_INVALID_CODE
)
24607 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24612 /* Fill glyph string S with composition components specified by S->cmp.
24614 BASE_FACE is the base face of the composition.
24615 S->cmp_from is the index of the first component for S.
24617 OVERLAPS non-zero means S should draw the foreground only, and use
24618 its physical height for clipping. See also draw_glyphs.
24620 Value is the index of a component not in S. */
24623 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24627 /* For all glyphs of this composition, starting at the offset
24628 S->cmp_from, until we reach the end of the definition or encounter a
24629 glyph that requires the different face, add it to S. */
24634 s
->for_overlaps
= overlaps
;
24637 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24639 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24641 /* TAB in a composition means display glyphs with padding space
24642 on the left or right. */
24645 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24648 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24649 s
->char2b
+ i
, true);
24655 s
->font
= s
->face
->font
;
24657 else if (s
->face
!= face
)
24665 if (s
->face
== NULL
)
24667 s
->face
= base_face
->ascii_face
;
24668 s
->font
= s
->face
->font
;
24671 /* All glyph strings for the same composition has the same width,
24672 i.e. the width set for the first component of the composition. */
24673 s
->width
= s
->first_glyph
->pixel_width
;
24675 /* If the specified font could not be loaded, use the frame's
24676 default font, but record the fact that we couldn't load it in
24677 the glyph string so that we can draw rectangles for the
24678 characters of the glyph string. */
24679 if (s
->font
== NULL
)
24681 s
->font_not_found_p
= true;
24682 s
->font
= FRAME_FONT (s
->f
);
24685 /* Adjust base line for subscript/superscript text. */
24686 s
->ybase
+= s
->first_glyph
->voffset
;
24692 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24693 int start
, int end
, int overlaps
)
24695 struct glyph
*glyph
, *last
;
24696 Lisp_Object lgstring
;
24699 s
->for_overlaps
= overlaps
;
24700 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24701 last
= s
->row
->glyphs
[s
->area
] + end
;
24702 s
->cmp_id
= glyph
->u
.cmp
.id
;
24703 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24704 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24705 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24706 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24707 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24709 while (glyph
< last
24710 && glyph
->u
.cmp
.automatic
24711 && glyph
->u
.cmp
.id
== s
->cmp_id
24712 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24713 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24715 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24717 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24718 unsigned code
= LGLYPH_CODE (lglyph
);
24720 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24722 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24723 return glyph
- s
->row
->glyphs
[s
->area
];
24727 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24728 See the comment of fill_glyph_string for arguments.
24729 Value is the index of the first glyph not in S. */
24733 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24734 int start
, int end
, int overlaps
)
24736 struct glyph
*glyph
, *last
;
24739 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24740 s
->for_overlaps
= overlaps
;
24741 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24742 last
= s
->row
->glyphs
[s
->area
] + end
;
24743 voffset
= glyph
->voffset
;
24744 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24745 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24747 s
->width
= glyph
->pixel_width
;
24749 while (glyph
< last
24750 && glyph
->type
== GLYPHLESS_GLYPH
24751 && glyph
->voffset
== voffset
24752 && glyph
->face_id
== face_id
)
24755 s
->width
+= glyph
->pixel_width
;
24758 s
->ybase
+= voffset
;
24759 return glyph
- s
->row
->glyphs
[s
->area
];
24763 /* Fill glyph string S from a sequence of character glyphs.
24765 FACE_ID is the face id of the string. START is the index of the
24766 first glyph to consider, END is the index of the last + 1.
24767 OVERLAPS non-zero means S should draw the foreground only, and use
24768 its physical height for clipping. See also draw_glyphs.
24770 Value is the index of the first glyph not in S. */
24773 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24774 int start
, int end
, int overlaps
)
24776 struct glyph
*glyph
, *last
;
24778 bool glyph_not_available_p
;
24780 eassert (s
->f
== XFRAME (s
->w
->frame
));
24781 eassert (s
->nchars
== 0);
24782 eassert (start
>= 0 && end
> start
);
24784 s
->for_overlaps
= overlaps
;
24785 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24786 last
= s
->row
->glyphs
[s
->area
] + end
;
24787 voffset
= glyph
->voffset
;
24788 s
->padding_p
= glyph
->padding_p
;
24789 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24791 while (glyph
< last
24792 && glyph
->type
== CHAR_GLYPH
24793 && glyph
->voffset
== voffset
24794 /* Same face id implies same font, nowadays. */
24795 && glyph
->face_id
== face_id
24796 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24798 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24799 s
->char2b
+ s
->nchars
);
24801 eassert (s
->nchars
<= end
- start
);
24802 s
->width
+= glyph
->pixel_width
;
24803 if (glyph
++->padding_p
!= s
->padding_p
)
24807 s
->font
= s
->face
->font
;
24809 /* If the specified font could not be loaded, use the frame's font,
24810 but record the fact that we couldn't load it in
24811 S->font_not_found_p so that we can draw rectangles for the
24812 characters of the glyph string. */
24813 if (s
->font
== NULL
|| glyph_not_available_p
)
24815 s
->font_not_found_p
= true;
24816 s
->font
= FRAME_FONT (s
->f
);
24819 /* Adjust base line for subscript/superscript text. */
24820 s
->ybase
+= voffset
;
24822 eassert (s
->face
&& s
->face
->gc
);
24823 return glyph
- s
->row
->glyphs
[s
->area
];
24827 /* Fill glyph string S from image glyph S->first_glyph. */
24830 fill_image_glyph_string (struct glyph_string
*s
)
24832 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24833 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24835 s
->slice
= s
->first_glyph
->slice
.img
;
24836 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24837 s
->font
= s
->face
->font
;
24838 s
->width
= s
->first_glyph
->pixel_width
;
24840 /* Adjust base line for subscript/superscript text. */
24841 s
->ybase
+= s
->first_glyph
->voffset
;
24845 #ifdef HAVE_XWIDGETS
24847 fill_xwidget_glyph_string (struct glyph_string
*s
)
24849 eassert (s
->first_glyph
->type
== XWIDGET_GLYPH
);
24850 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24851 s
->font
= s
->face
->font
;
24852 s
->width
= s
->first_glyph
->pixel_width
;
24853 s
->ybase
+= s
->first_glyph
->voffset
;
24854 s
->xwidget
= s
->first_glyph
->u
.xwidget
;
24857 /* Fill glyph string S from a sequence of stretch glyphs.
24859 START is the index of the first glyph to consider,
24860 END is the index of the last + 1.
24862 Value is the index of the first glyph not in S. */
24865 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24867 struct glyph
*glyph
, *last
;
24868 int voffset
, face_id
;
24870 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24872 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24873 last
= s
->row
->glyphs
[s
->area
] + end
;
24874 face_id
= glyph
->face_id
;
24875 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24876 s
->font
= s
->face
->font
;
24877 s
->width
= glyph
->pixel_width
;
24879 voffset
= glyph
->voffset
;
24883 && glyph
->type
== STRETCH_GLYPH
24884 && glyph
->voffset
== voffset
24885 && glyph
->face_id
== face_id
);
24887 s
->width
+= glyph
->pixel_width
;
24889 /* Adjust base line for subscript/superscript text. */
24890 s
->ybase
+= voffset
;
24892 /* The case that face->gc == 0 is handled when drawing the glyph
24893 string by calling prepare_face_for_display. */
24895 return glyph
- s
->row
->glyphs
[s
->area
];
24898 static struct font_metrics
*
24899 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24901 static struct font_metrics metrics
;
24906 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24907 if (code
== FONT_INVALID_CODE
)
24909 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24913 /* A subroutine that computes "normal" values of ASCENT and DESCENT
24914 for FONT. Values are taken from font-global ones, except for fonts
24915 that claim preposterously large values, but whose glyphs actually
24916 have reasonable dimensions. C is the character to use for metrics
24917 if the font-global values are too large; if C is negative, the
24918 function selects a default character. */
24920 normal_char_ascent_descent (struct font
*font
, int c
, int *ascent
, int *descent
)
24922 *ascent
= FONT_BASE (font
);
24923 *descent
= FONT_DESCENT (font
);
24925 if (FONT_TOO_HIGH (font
))
24929 /* Get metrics of C, defaulting to a reasonably sized ASCII
24931 if (get_char_glyph_code (c
>= 0 ? c
: '{', font
, &char2b
))
24933 struct font_metrics
*pcm
= get_per_char_metric (font
, &char2b
);
24935 if (!(pcm
->width
== 0 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0))
24937 /* We add 1 pixel to character dimensions as heuristics
24938 that produces nicer display, e.g. when the face has
24939 the box attribute. */
24940 *ascent
= pcm
->ascent
+ 1;
24941 *descent
= pcm
->descent
+ 1;
24947 /* A subroutine that computes a reasonable "normal character height"
24948 for fonts that claim preposterously large vertical dimensions, but
24949 whose glyphs are actually reasonably sized. C is the character
24950 whose metrics to use for those fonts, or -1 for default
24953 normal_char_height (struct font
*font
, int c
)
24955 int ascent
, descent
;
24957 normal_char_ascent_descent (font
, c
, &ascent
, &descent
);
24959 return ascent
+ descent
;
24963 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24964 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24965 assumed to be zero. */
24968 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24970 *left
= *right
= 0;
24972 if (glyph
->type
== CHAR_GLYPH
)
24975 struct face
*face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
);
24978 struct font_metrics
*pcm
= get_per_char_metric (face
->font
, &char2b
);
24981 if (pcm
->rbearing
> pcm
->width
)
24982 *right
= pcm
->rbearing
- pcm
->width
;
24983 if (pcm
->lbearing
< 0)
24984 *left
= -pcm
->lbearing
;
24988 else if (glyph
->type
== COMPOSITE_GLYPH
)
24990 if (! glyph
->u
.cmp
.automatic
)
24992 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24994 if (cmp
->rbearing
> cmp
->pixel_width
)
24995 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24996 if (cmp
->lbearing
< 0)
24997 *left
= - cmp
->lbearing
;
25001 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
25002 struct font_metrics metrics
;
25004 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
25005 glyph
->slice
.cmp
.to
+ 1, &metrics
);
25006 if (metrics
.rbearing
> metrics
.width
)
25007 *right
= metrics
.rbearing
- metrics
.width
;
25008 if (metrics
.lbearing
< 0)
25009 *left
= - metrics
.lbearing
;
25015 /* Return the index of the first glyph preceding glyph string S that
25016 is overwritten by S because of S's left overhang. Value is -1
25017 if no glyphs are overwritten. */
25020 left_overwritten (struct glyph_string
*s
)
25024 if (s
->left_overhang
)
25027 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25028 int first
= s
->first_glyph
- glyphs
;
25030 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
25031 x
-= glyphs
[i
].pixel_width
;
25042 /* Return the index of the first glyph preceding glyph string S that
25043 is overwriting S because of its right overhang. Value is -1 if no
25044 glyph in front of S overwrites S. */
25047 left_overwriting (struct glyph_string
*s
)
25050 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25051 int first
= s
->first_glyph
- glyphs
;
25055 for (i
= first
- 1; i
>= 0; --i
)
25058 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
25061 x
-= glyphs
[i
].pixel_width
;
25068 /* Return the index of the last glyph following glyph string S that is
25069 overwritten by S because of S's right overhang. Value is -1 if
25070 no such glyph is found. */
25073 right_overwritten (struct glyph_string
*s
)
25077 if (s
->right_overhang
)
25080 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25081 int first
= (s
->first_glyph
- glyphs
25082 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
25083 int end
= s
->row
->used
[s
->area
];
25085 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
25086 x
+= glyphs
[i
].pixel_width
;
25095 /* Return the index of the last glyph following glyph string S that
25096 overwrites S because of its left overhang. Value is negative
25097 if no such glyph is found. */
25100 right_overwriting (struct glyph_string
*s
)
25103 int end
= s
->row
->used
[s
->area
];
25104 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25105 int first
= (s
->first_glyph
- glyphs
25106 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
25110 for (i
= first
; i
< end
; ++i
)
25113 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
25116 x
+= glyphs
[i
].pixel_width
;
25123 /* Set background width of glyph string S. START is the index of the
25124 first glyph following S. LAST_X is the right-most x-position + 1
25125 in the drawing area. */
25128 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
25130 /* If the face of this glyph string has to be drawn to the end of
25131 the drawing area, set S->extends_to_end_of_line_p. */
25133 if (start
== s
->row
->used
[s
->area
]
25134 && ((s
->row
->fill_line_p
25135 && (s
->hl
== DRAW_NORMAL_TEXT
25136 || s
->hl
== DRAW_IMAGE_RAISED
25137 || s
->hl
== DRAW_IMAGE_SUNKEN
))
25138 || s
->hl
== DRAW_MOUSE_FACE
))
25139 s
->extends_to_end_of_line_p
= true;
25141 /* If S extends its face to the end of the line, set its
25142 background_width to the distance to the right edge of the drawing
25144 if (s
->extends_to_end_of_line_p
)
25145 s
->background_width
= last_x
- s
->x
+ 1;
25147 s
->background_width
= s
->width
;
25151 /* Compute overhangs and x-positions for glyph string S and its
25152 predecessors, or successors. X is the starting x-position for S.
25153 BACKWARD_P means process predecessors. */
25156 compute_overhangs_and_x (struct glyph_string
*s
, int x
, bool backward_p
)
25162 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
25163 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
25173 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
25174 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
25184 /* The following macros are only called from draw_glyphs below.
25185 They reference the following parameters of that function directly:
25186 `w', `row', `area', and `overlap_p'
25187 as well as the following local variables:
25188 `s', `f', and `hdc' (in W32) */
25191 /* On W32, silently add local `hdc' variable to argument list of
25192 init_glyph_string. */
25193 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
25194 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
25196 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
25197 init_glyph_string (s, char2b, w, row, area, start, hl)
25200 /* Add a glyph string for a stretch glyph to the list of strings
25201 between HEAD and TAIL. START is the index of the stretch glyph in
25202 row area AREA of glyph row ROW. END is the index of the last glyph
25203 in that glyph row area. X is the current output position assigned
25204 to the new glyph string constructed. HL overrides that face of the
25205 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25206 is the right-most x-position of the drawing area. */
25208 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
25209 and below -- keep them on one line. */
25210 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25213 s = alloca (sizeof *s); \
25214 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25215 START = fill_stretch_glyph_string (s, START, END); \
25216 append_glyph_string (&HEAD, &TAIL, s); \
25222 /* Add a glyph string for an image glyph to the list of strings
25223 between HEAD and TAIL. START is the index of the image glyph in
25224 row area AREA of glyph row ROW. END is the index of the last glyph
25225 in that glyph row area. X is the current output position assigned
25226 to the new glyph string constructed. HL overrides that face of the
25227 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25228 is the right-most x-position of the drawing area. */
25230 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25233 s = alloca (sizeof *s); \
25234 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25235 fill_image_glyph_string (s); \
25236 append_glyph_string (&HEAD, &TAIL, s); \
25242 #ifndef HAVE_XWIDGETS
25243 # define BUILD_XWIDGET_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25246 # define BUILD_XWIDGET_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25249 s = alloca (sizeof *s); \
25250 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25251 fill_xwidget_glyph_string (s); \
25252 append_glyph_string (&(HEAD), &(TAIL), s); \
25259 /* Add a glyph string for a sequence of character glyphs to the list
25260 of strings between HEAD and TAIL. START is the index of the first
25261 glyph in row area AREA of glyph row ROW that is part of the new
25262 glyph string. END is the index of the last glyph in that glyph row
25263 area. X is the current output position assigned to the new glyph
25264 string constructed. HL overrides that face of the glyph; e.g. it
25265 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
25266 right-most x-position of the drawing area. */
25268 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25274 face_id = (row)->glyphs[area][START].face_id; \
25276 s = alloca (sizeof *s); \
25277 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
25278 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25279 append_glyph_string (&HEAD, &TAIL, s); \
25281 START = fill_glyph_string (s, face_id, START, END, overlaps); \
25286 /* Add a glyph string for a composite sequence to the list of strings
25287 between HEAD and TAIL. START is the index of the first glyph in
25288 row area AREA of glyph row ROW that is part of the new glyph
25289 string. END is the index of the last glyph in that glyph row area.
25290 X is the current output position assigned to the new glyph string
25291 constructed. HL overrides that face of the glyph; e.g. it is
25292 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
25293 x-position of the drawing area. */
25295 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25297 int face_id = (row)->glyphs[area][START].face_id; \
25298 struct face *base_face = FACE_FROM_ID (f, face_id); \
25299 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
25300 struct composition *cmp = composition_table[cmp_id]; \
25302 struct glyph_string *first_s = NULL; \
25305 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
25307 /* Make glyph_strings for each glyph sequence that is drawable by \
25308 the same face, and append them to HEAD/TAIL. */ \
25309 for (n = 0; n < cmp->glyph_len;) \
25311 s = alloca (sizeof *s); \
25312 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25313 append_glyph_string (&(HEAD), &(TAIL), s); \
25319 n = fill_composite_glyph_string (s, base_face, overlaps); \
25327 /* Add a glyph string for a glyph-string sequence to the list of strings
25328 between HEAD and TAIL. */
25330 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25334 Lisp_Object gstring; \
25336 face_id = (row)->glyphs[area][START].face_id; \
25337 gstring = (composition_gstring_from_id \
25338 ((row)->glyphs[area][START].u.cmp.id)); \
25339 s = alloca (sizeof *s); \
25340 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
25341 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25342 append_glyph_string (&(HEAD), &(TAIL), s); \
25344 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
25348 /* Add a glyph string for a sequence of glyphless character's glyphs
25349 to the list of strings between HEAD and TAIL. The meanings of
25350 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
25352 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25357 face_id = (row)->glyphs[area][START].face_id; \
25359 s = alloca (sizeof *s); \
25360 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25361 append_glyph_string (&HEAD, &TAIL, s); \
25363 START = fill_glyphless_glyph_string (s, face_id, START, END, \
25369 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
25370 of AREA of glyph row ROW on window W between indices START and END.
25371 HL overrides the face for drawing glyph strings, e.g. it is
25372 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
25373 x-positions of the drawing area.
25375 This is an ugly monster macro construct because we must use alloca
25376 to allocate glyph strings (because draw_glyphs can be called
25377 asynchronously). */
25379 #define BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25382 HEAD = TAIL = NULL; \
25383 while (START < END) \
25385 struct glyph *first_glyph = (row)->glyphs[area] + START; \
25386 switch (first_glyph->type) \
25389 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
25393 case COMPOSITE_GLYPH: \
25394 if (first_glyph->u.cmp.automatic) \
25395 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
25398 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
25402 case STRETCH_GLYPH: \
25403 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
25407 case IMAGE_GLYPH: \
25408 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
25412 #define BUILD_GLYPH_STRINGS_XW(START, END, HEAD, TAIL, HL, X, LAST_X) \
25413 case XWIDGET_GLYPH: \
25414 BUILD_XWIDGET_GLYPH_STRING (START, END, HEAD, TAIL, \
25418 #define BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X) \
25419 case GLYPHLESS_GLYPH: \
25420 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
25430 set_glyph_string_background_width (s, START, LAST_X); \
25437 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25438 BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25439 BUILD_GLYPH_STRINGS_XW(START, END, HEAD, TAIL, HL, X, LAST_X) \
25440 BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X)
25443 /* Draw glyphs between START and END in AREA of ROW on window W,
25444 starting at x-position X. X is relative to AREA in W. HL is a
25445 face-override with the following meaning:
25447 DRAW_NORMAL_TEXT draw normally
25448 DRAW_CURSOR draw in cursor face
25449 DRAW_MOUSE_FACE draw in mouse face.
25450 DRAW_INVERSE_VIDEO draw in mode line face
25451 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
25452 DRAW_IMAGE_RAISED draw an image with a raised relief around it
25454 If OVERLAPS is non-zero, draw only the foreground of characters and
25455 clip to the physical height of ROW. Non-zero value also defines
25456 the overlapping part to be drawn:
25458 OVERLAPS_PRED overlap with preceding rows
25459 OVERLAPS_SUCC overlap with succeeding rows
25460 OVERLAPS_BOTH overlap with both preceding/succeeding rows
25461 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
25463 Value is the x-position reached, relative to AREA of W. */
25466 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
25467 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
25468 enum draw_glyphs_face hl
, int overlaps
)
25470 struct glyph_string
*head
, *tail
;
25471 struct glyph_string
*s
;
25472 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
25473 int i
, j
, x_reached
, last_x
, area_left
= 0;
25474 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25477 ALLOCATE_HDC (hdc
, f
);
25479 /* Let's rather be paranoid than getting a SEGV. */
25480 end
= min (end
, row
->used
[area
]);
25481 start
= clip_to_bounds (0, start
, end
);
25483 /* Translate X to frame coordinates. Set last_x to the right
25484 end of the drawing area. */
25485 if (row
->full_width_p
)
25487 /* X is relative to the left edge of W, without scroll bars
25489 area_left
= WINDOW_LEFT_EDGE_X (w
);
25490 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
25491 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
25495 area_left
= window_box_left (w
, area
);
25496 last_x
= area_left
+ window_box_width (w
, area
);
25500 /* Build a doubly-linked list of glyph_string structures between
25501 head and tail from what we have to draw. Note that the macro
25502 BUILD_GLYPH_STRINGS will modify its start parameter. That's
25503 the reason we use a separate variable `i'. */
25506 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
25508 x_reached
= tail
->x
+ tail
->background_width
;
25512 /* If there are any glyphs with lbearing < 0 or rbearing > width in
25513 the row, redraw some glyphs in front or following the glyph
25514 strings built above. */
25515 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
25517 struct glyph_string
*h
, *t
;
25518 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25519 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
25520 bool check_mouse_face
= false;
25523 /* If mouse highlighting is on, we may need to draw adjacent
25524 glyphs using mouse-face highlighting. */
25525 if (area
== TEXT_AREA
&& row
->mouse_face_p
25526 && hlinfo
->mouse_face_beg_row
>= 0
25527 && hlinfo
->mouse_face_end_row
>= 0)
25529 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
25531 if (row_vpos
>= hlinfo
->mouse_face_beg_row
25532 && row_vpos
<= hlinfo
->mouse_face_end_row
)
25534 check_mouse_face
= true;
25535 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
25536 ? hlinfo
->mouse_face_beg_col
: 0;
25537 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
25538 ? hlinfo
->mouse_face_end_col
25539 : row
->used
[TEXT_AREA
];
25543 /* Compute overhangs for all glyph strings. */
25544 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
25545 for (s
= head
; s
; s
= s
->next
)
25546 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
25548 /* Prepend glyph strings for glyphs in front of the first glyph
25549 string that are overwritten because of the first glyph
25550 string's left overhang. The background of all strings
25551 prepended must be drawn because the first glyph string
25553 i
= left_overwritten (head
);
25556 enum draw_glyphs_face overlap_hl
;
25558 /* If this row contains mouse highlighting, attempt to draw
25559 the overlapped glyphs with the correct highlight. This
25560 code fails if the overlap encompasses more than one glyph
25561 and mouse-highlight spans only some of these glyphs.
25562 However, making it work perfectly involves a lot more
25563 code, and I don't know if the pathological case occurs in
25564 practice, so we'll stick to this for now. --- cyd */
25565 if (check_mouse_face
25566 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25567 overlap_hl
= DRAW_MOUSE_FACE
;
25569 overlap_hl
= DRAW_NORMAL_TEXT
;
25571 if (hl
!= overlap_hl
)
25574 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
25575 overlap_hl
, dummy_x
, last_x
);
25577 compute_overhangs_and_x (t
, head
->x
, true);
25578 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25579 if (clip_head
== NULL
)
25583 /* Prepend glyph strings for glyphs in front of the first glyph
25584 string that overwrite that glyph string because of their
25585 right overhang. For these strings, only the foreground must
25586 be drawn, because it draws over the glyph string at `head'.
25587 The background must not be drawn because this would overwrite
25588 right overhangs of preceding glyphs for which no glyph
25590 i
= left_overwriting (head
);
25593 enum draw_glyphs_face overlap_hl
;
25595 if (check_mouse_face
25596 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25597 overlap_hl
= DRAW_MOUSE_FACE
;
25599 overlap_hl
= DRAW_NORMAL_TEXT
;
25601 if (hl
== overlap_hl
|| clip_head
== NULL
)
25603 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
25604 overlap_hl
, dummy_x
, last_x
);
25605 for (s
= h
; s
; s
= s
->next
)
25606 s
->background_filled_p
= true;
25607 compute_overhangs_and_x (t
, head
->x
, true);
25608 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25611 /* Append glyphs strings for glyphs following the last glyph
25612 string tail that are overwritten by tail. The background of
25613 these strings has to be drawn because tail's foreground draws
25615 i
= right_overwritten (tail
);
25618 enum draw_glyphs_face overlap_hl
;
25620 if (check_mouse_face
25621 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25622 overlap_hl
= DRAW_MOUSE_FACE
;
25624 overlap_hl
= DRAW_NORMAL_TEXT
;
25626 if (hl
!= overlap_hl
)
25628 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25629 overlap_hl
, x
, last_x
);
25630 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25631 we don't have `end = i;' here. */
25632 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25633 append_glyph_string_lists (&head
, &tail
, h
, t
);
25634 if (clip_tail
== NULL
)
25638 /* Append glyph strings for glyphs following the last glyph
25639 string tail that overwrite tail. The foreground of such
25640 glyphs has to be drawn because it writes into the background
25641 of tail. The background must not be drawn because it could
25642 paint over the foreground of following glyphs. */
25643 i
= right_overwriting (tail
);
25646 enum draw_glyphs_face overlap_hl
;
25647 if (check_mouse_face
25648 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25649 overlap_hl
= DRAW_MOUSE_FACE
;
25651 overlap_hl
= DRAW_NORMAL_TEXT
;
25653 if (hl
== overlap_hl
|| clip_tail
== NULL
)
25655 i
++; /* We must include the Ith glyph. */
25656 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25657 overlap_hl
, x
, last_x
);
25658 for (s
= h
; s
; s
= s
->next
)
25659 s
->background_filled_p
= true;
25660 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25661 append_glyph_string_lists (&head
, &tail
, h
, t
);
25663 if (clip_head
|| clip_tail
)
25664 for (s
= head
; s
; s
= s
->next
)
25666 s
->clip_head
= clip_head
;
25667 s
->clip_tail
= clip_tail
;
25671 /* Draw all strings. */
25672 for (s
= head
; s
; s
= s
->next
)
25673 FRAME_RIF (f
)->draw_glyph_string (s
);
25676 /* When focus a sole frame and move horizontally, this clears on_p
25677 causing a failure to erase prev cursor position. */
25678 if (area
== TEXT_AREA
25679 && !row
->full_width_p
25680 /* When drawing overlapping rows, only the glyph strings'
25681 foreground is drawn, which doesn't erase a cursor
25685 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25686 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25687 : (tail
? tail
->x
+ tail
->background_width
: x
));
25691 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25692 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25696 /* Value is the x-position up to which drawn, relative to AREA of W.
25697 This doesn't include parts drawn because of overhangs. */
25698 if (row
->full_width_p
)
25699 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25701 x_reached
-= area_left
;
25703 RELEASE_HDC (hdc
, f
);
25709 /* Expand row matrix if too narrow. Don't expand if area
25712 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25714 if (!it->f->fonts_changed \
25715 && (it->glyph_row->glyphs[area] \
25716 < it->glyph_row->glyphs[area + 1])) \
25718 it->w->ncols_scale_factor++; \
25719 it->f->fonts_changed = true; \
25723 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25724 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25727 append_glyph (struct it
*it
)
25729 struct glyph
*glyph
;
25730 enum glyph_row_area area
= it
->area
;
25732 eassert (it
->glyph_row
);
25733 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25735 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25736 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25738 /* If the glyph row is reversed, we need to prepend the glyph
25739 rather than append it. */
25740 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25744 /* Make room for the additional glyph. */
25745 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25747 glyph
= it
->glyph_row
->glyphs
[area
];
25749 glyph
->charpos
= CHARPOS (it
->position
);
25750 glyph
->object
= it
->object
;
25751 if (it
->pixel_width
> 0)
25753 glyph
->pixel_width
= it
->pixel_width
;
25754 glyph
->padding_p
= false;
25758 /* Assure at least 1-pixel width. Otherwise, cursor can't
25759 be displayed correctly. */
25760 glyph
->pixel_width
= 1;
25761 glyph
->padding_p
= true;
25763 glyph
->ascent
= it
->ascent
;
25764 glyph
->descent
= it
->descent
;
25765 glyph
->voffset
= it
->voffset
;
25766 glyph
->type
= CHAR_GLYPH
;
25767 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25768 glyph
->multibyte_p
= it
->multibyte_p
;
25769 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25771 /* In R2L rows, the left and the right box edges need to be
25772 drawn in reverse direction. */
25773 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25774 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25778 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25779 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25781 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25782 || it
->phys_descent
> it
->descent
);
25783 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25784 glyph
->face_id
= it
->face_id
;
25785 glyph
->u
.ch
= it
->char_to_display
;
25786 glyph
->slice
.img
= null_glyph_slice
;
25787 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25790 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25791 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25792 glyph
->bidi_type
= it
->bidi_it
.type
;
25796 glyph
->resolved_level
= 0;
25797 glyph
->bidi_type
= UNKNOWN_BT
;
25799 ++it
->glyph_row
->used
[area
];
25802 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25805 /* Store one glyph for the composition IT->cmp_it.id in
25806 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25810 append_composite_glyph (struct it
*it
)
25812 struct glyph
*glyph
;
25813 enum glyph_row_area area
= it
->area
;
25815 eassert (it
->glyph_row
);
25817 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25818 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25820 /* If the glyph row is reversed, we need to prepend the glyph
25821 rather than append it. */
25822 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25826 /* Make room for the new glyph. */
25827 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25829 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25831 glyph
->charpos
= it
->cmp_it
.charpos
;
25832 glyph
->object
= it
->object
;
25833 glyph
->pixel_width
= it
->pixel_width
;
25834 glyph
->ascent
= it
->ascent
;
25835 glyph
->descent
= it
->descent
;
25836 glyph
->voffset
= it
->voffset
;
25837 glyph
->type
= COMPOSITE_GLYPH
;
25838 if (it
->cmp_it
.ch
< 0)
25840 glyph
->u
.cmp
.automatic
= false;
25841 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25842 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25846 glyph
->u
.cmp
.automatic
= true;
25847 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25848 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25849 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25851 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25852 glyph
->multibyte_p
= it
->multibyte_p
;
25853 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25855 /* In R2L rows, the left and the right box edges need to be
25856 drawn in reverse direction. */
25857 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25858 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25862 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25863 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25865 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25866 || it
->phys_descent
> it
->descent
);
25867 glyph
->padding_p
= false;
25868 glyph
->glyph_not_available_p
= false;
25869 glyph
->face_id
= it
->face_id
;
25870 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25873 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25874 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25875 glyph
->bidi_type
= it
->bidi_it
.type
;
25877 ++it
->glyph_row
->used
[area
];
25880 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25884 /* Change IT->ascent and IT->height according to the setting of
25888 take_vertical_position_into_account (struct it
*it
)
25892 if (it
->voffset
< 0)
25893 /* Increase the ascent so that we can display the text higher
25895 it
->ascent
-= it
->voffset
;
25897 /* Increase the descent so that we can display the text lower
25899 it
->descent
+= it
->voffset
;
25904 /* Produce glyphs/get display metrics for the image IT is loaded with.
25905 See the description of struct display_iterator in dispextern.h for
25906 an overview of struct display_iterator. */
25909 produce_image_glyph (struct it
*it
)
25913 int glyph_ascent
, crop
;
25914 struct glyph_slice slice
;
25916 eassert (it
->what
== IT_IMAGE
);
25918 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25920 /* Make sure X resources of the face is loaded. */
25921 prepare_face_for_display (it
->f
, face
);
25923 if (it
->image_id
< 0)
25925 /* Fringe bitmap. */
25926 it
->ascent
= it
->phys_ascent
= 0;
25927 it
->descent
= it
->phys_descent
= 0;
25928 it
->pixel_width
= 0;
25933 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25935 /* Make sure X resources of the image is loaded. */
25936 prepare_image_for_display (it
->f
, img
);
25938 slice
.x
= slice
.y
= 0;
25939 slice
.width
= img
->width
;
25940 slice
.height
= img
->height
;
25942 if (INTEGERP (it
->slice
.x
))
25943 slice
.x
= XINT (it
->slice
.x
);
25944 else if (FLOATP (it
->slice
.x
))
25945 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25947 if (INTEGERP (it
->slice
.y
))
25948 slice
.y
= XINT (it
->slice
.y
);
25949 else if (FLOATP (it
->slice
.y
))
25950 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25952 if (INTEGERP (it
->slice
.width
))
25953 slice
.width
= XINT (it
->slice
.width
);
25954 else if (FLOATP (it
->slice
.width
))
25955 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25957 if (INTEGERP (it
->slice
.height
))
25958 slice
.height
= XINT (it
->slice
.height
);
25959 else if (FLOATP (it
->slice
.height
))
25960 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25962 if (slice
.x
>= img
->width
)
25963 slice
.x
= img
->width
;
25964 if (slice
.y
>= img
->height
)
25965 slice
.y
= img
->height
;
25966 if (slice
.x
+ slice
.width
>= img
->width
)
25967 slice
.width
= img
->width
- slice
.x
;
25968 if (slice
.y
+ slice
.height
> img
->height
)
25969 slice
.height
= img
->height
- slice
.y
;
25971 if (slice
.width
== 0 || slice
.height
== 0)
25974 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25976 it
->descent
= slice
.height
- glyph_ascent
;
25978 it
->descent
+= img
->vmargin
;
25979 if (slice
.y
+ slice
.height
== img
->height
)
25980 it
->descent
+= img
->vmargin
;
25981 it
->phys_descent
= it
->descent
;
25983 it
->pixel_width
= slice
.width
;
25985 it
->pixel_width
+= img
->hmargin
;
25986 if (slice
.x
+ slice
.width
== img
->width
)
25987 it
->pixel_width
+= img
->hmargin
;
25989 /* It's quite possible for images to have an ascent greater than
25990 their height, so don't get confused in that case. */
25991 if (it
->descent
< 0)
25996 if (face
->box
!= FACE_NO_BOX
)
25998 if (face
->box_line_width
> 0)
26001 it
->ascent
+= face
->box_line_width
;
26002 if (slice
.y
+ slice
.height
== img
->height
)
26003 it
->descent
+= face
->box_line_width
;
26006 if (it
->start_of_box_run_p
&& slice
.x
== 0)
26007 it
->pixel_width
+= eabs (face
->box_line_width
);
26008 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
26009 it
->pixel_width
+= eabs (face
->box_line_width
);
26012 take_vertical_position_into_account (it
);
26014 /* Automatically crop wide image glyphs at right edge so we can
26015 draw the cursor on same display row. */
26016 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
26017 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
26019 it
->pixel_width
-= crop
;
26020 slice
.width
-= crop
;
26025 struct glyph
*glyph
;
26026 enum glyph_row_area area
= it
->area
;
26028 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26029 if (it
->glyph_row
->reversed_p
)
26033 /* Make room for the new glyph. */
26034 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
26036 glyph
= it
->glyph_row
->glyphs
[it
->area
];
26038 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26040 glyph
->charpos
= CHARPOS (it
->position
);
26041 glyph
->object
= it
->object
;
26042 glyph
->pixel_width
= it
->pixel_width
;
26043 glyph
->ascent
= glyph_ascent
;
26044 glyph
->descent
= it
->descent
;
26045 glyph
->voffset
= it
->voffset
;
26046 glyph
->type
= IMAGE_GLYPH
;
26047 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26048 glyph
->multibyte_p
= it
->multibyte_p
;
26049 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26051 /* In R2L rows, the left and the right box edges need to be
26052 drawn in reverse direction. */
26053 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26054 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26058 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26059 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26061 glyph
->overlaps_vertically_p
= false;
26062 glyph
->padding_p
= false;
26063 glyph
->glyph_not_available_p
= false;
26064 glyph
->face_id
= it
->face_id
;
26065 glyph
->u
.img_id
= img
->id
;
26066 glyph
->slice
.img
= slice
;
26067 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26070 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26071 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26072 glyph
->bidi_type
= it
->bidi_it
.type
;
26074 ++it
->glyph_row
->used
[area
];
26077 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26082 produce_xwidget_glyph (struct it
*it
)
26084 #ifdef HAVE_XWIDGETS
26085 struct xwidget
*xw
;
26086 int glyph_ascent
, crop
;
26087 eassert (it
->what
== IT_XWIDGET
);
26089 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26091 /* Make sure X resources of the face is loaded. */
26092 prepare_face_for_display (it
->f
, face
);
26095 it
->ascent
= it
->phys_ascent
= glyph_ascent
= xw
->height
/2;
26096 it
->descent
= xw
->height
/2;
26097 it
->phys_descent
= it
->descent
;
26098 it
->pixel_width
= xw
->width
;
26099 /* It's quite possible for images to have an ascent greater than
26100 their height, so don't get confused in that case. */
26101 if (it
->descent
< 0)
26106 if (face
->box
!= FACE_NO_BOX
)
26108 if (face
->box_line_width
> 0)
26110 it
->ascent
+= face
->box_line_width
;
26111 it
->descent
+= face
->box_line_width
;
26114 if (it
->start_of_box_run_p
)
26115 it
->pixel_width
+= eabs (face
->box_line_width
);
26116 it
->pixel_width
+= eabs (face
->box_line_width
);
26119 take_vertical_position_into_account (it
);
26121 /* Automatically crop wide image glyphs at right edge so we can
26122 draw the cursor on same display row. */
26123 crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
);
26124 if (crop
> 0 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
26125 it
->pixel_width
-= crop
;
26129 enum glyph_row_area area
= it
->area
;
26130 struct glyph
*glyph
26131 = it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26133 if (it
->glyph_row
->reversed_p
)
26137 /* Make room for the new glyph. */
26138 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
26140 glyph
= it
->glyph_row
->glyphs
[it
->area
];
26142 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26144 glyph
->charpos
= CHARPOS (it
->position
);
26145 glyph
->object
= it
->object
;
26146 glyph
->pixel_width
= it
->pixel_width
;
26147 glyph
->ascent
= glyph_ascent
;
26148 glyph
->descent
= it
->descent
;
26149 glyph
->voffset
= it
->voffset
;
26150 glyph
->type
= XWIDGET_GLYPH
;
26151 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26152 glyph
->multibyte_p
= it
->multibyte_p
;
26153 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26155 /* In R2L rows, the left and the right box edges need to be
26156 drawn in reverse direction. */
26157 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26158 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26162 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26163 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26165 glyph
->overlaps_vertically_p
= 0;
26166 glyph
->padding_p
= 0;
26167 glyph
->glyph_not_available_p
= 0;
26168 glyph
->face_id
= it
->face_id
;
26169 glyph
->u
.xwidget
= it
->xwidget
;
26170 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26173 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26174 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26175 glyph
->bidi_type
= it
->bidi_it
.type
;
26177 ++it
->glyph_row
->used
[area
];
26180 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26185 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
26186 of the glyph, WIDTH and HEIGHT are the width and height of the
26187 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
26190 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
26191 int width
, int height
, int ascent
)
26193 struct glyph
*glyph
;
26194 enum glyph_row_area area
= it
->area
;
26196 eassert (ascent
>= 0 && ascent
<= height
);
26198 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26199 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26201 /* If the glyph row is reversed, we need to prepend the glyph
26202 rather than append it. */
26203 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26207 /* Make room for the additional glyph. */
26208 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26210 glyph
= it
->glyph_row
->glyphs
[area
];
26212 /* Decrease the width of the first glyph of the row that
26213 begins before first_visible_x (e.g., due to hscroll).
26214 This is so the overall width of the row becomes smaller
26215 by the scroll amount, and the stretch glyph appended by
26216 extend_face_to_end_of_line will be wider, to shift the
26217 row glyphs to the right. (In L2R rows, the corresponding
26218 left-shift effect is accomplished by setting row->x to a
26219 negative value, which won't work with R2L rows.)
26221 This must leave us with a positive value of WIDTH, since
26222 otherwise the call to move_it_in_display_line_to at the
26223 beginning of display_line would have got past the entire
26224 first glyph, and then it->current_x would have been
26225 greater or equal to it->first_visible_x. */
26226 if (it
->current_x
< it
->first_visible_x
)
26227 width
-= it
->first_visible_x
- it
->current_x
;
26228 eassert (width
> 0);
26230 glyph
->charpos
= CHARPOS (it
->position
);
26231 glyph
->object
= object
;
26232 glyph
->pixel_width
= width
;
26233 glyph
->ascent
= ascent
;
26234 glyph
->descent
= height
- ascent
;
26235 glyph
->voffset
= it
->voffset
;
26236 glyph
->type
= STRETCH_GLYPH
;
26237 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26238 glyph
->multibyte_p
= it
->multibyte_p
;
26239 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26241 /* In R2L rows, the left and the right box edges need to be
26242 drawn in reverse direction. */
26243 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26244 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26248 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26249 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26251 glyph
->overlaps_vertically_p
= false;
26252 glyph
->padding_p
= false;
26253 glyph
->glyph_not_available_p
= false;
26254 glyph
->face_id
= it
->face_id
;
26255 glyph
->u
.stretch
.ascent
= ascent
;
26256 glyph
->u
.stretch
.height
= height
;
26257 glyph
->slice
.img
= null_glyph_slice
;
26258 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26261 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26262 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26263 glyph
->bidi_type
= it
->bidi_it
.type
;
26267 glyph
->resolved_level
= 0;
26268 glyph
->bidi_type
= UNKNOWN_BT
;
26270 ++it
->glyph_row
->used
[area
];
26273 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26276 #endif /* HAVE_WINDOW_SYSTEM */
26278 /* Produce a stretch glyph for iterator IT. IT->object is the value
26279 of the glyph property displayed. The value must be a list
26280 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
26283 1. `:width WIDTH' specifies that the space should be WIDTH *
26284 canonical char width wide. WIDTH may be an integer or floating
26287 2. `:relative-width FACTOR' specifies that the width of the stretch
26288 should be computed from the width of the first character having the
26289 `glyph' property, and should be FACTOR times that width.
26291 3. `:align-to HPOS' specifies that the space should be wide enough
26292 to reach HPOS, a value in canonical character units.
26294 Exactly one of the above pairs must be present.
26296 4. `:height HEIGHT' specifies that the height of the stretch produced
26297 should be HEIGHT, measured in canonical character units.
26299 5. `:relative-height FACTOR' specifies that the height of the
26300 stretch should be FACTOR times the height of the characters having
26301 the glyph property.
26303 Either none or exactly one of 4 or 5 must be present.
26305 6. `:ascent ASCENT' specifies that ASCENT percent of the height
26306 of the stretch should be used for the ascent of the stretch.
26307 ASCENT must be in the range 0 <= ASCENT <= 100. */
26310 produce_stretch_glyph (struct it
*it
)
26312 /* (space :width WIDTH :height HEIGHT ...) */
26313 Lisp_Object prop
, plist
;
26314 int width
= 0, height
= 0, align_to
= -1;
26315 bool zero_width_ok_p
= false;
26317 struct font
*font
= NULL
;
26319 #ifdef HAVE_WINDOW_SYSTEM
26321 bool zero_height_ok_p
= false;
26323 if (FRAME_WINDOW_P (it
->f
))
26325 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26326 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26327 prepare_face_for_display (it
->f
, face
);
26331 /* List should start with `space'. */
26332 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
26333 plist
= XCDR (it
->object
);
26335 /* Compute the width of the stretch. */
26336 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
26337 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true, 0))
26339 /* Absolute width `:width WIDTH' specified and valid. */
26340 zero_width_ok_p
= true;
26343 else if (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0)
26345 /* Relative width `:relative-width FACTOR' specified and valid.
26346 Compute the width of the characters having the `glyph'
26349 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
26352 if (it
->multibyte_p
)
26353 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
26356 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
26357 if (! ASCII_CHAR_P (it2
.c
))
26358 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
26361 it2
.glyph_row
= NULL
;
26362 it2
.what
= IT_CHARACTER
;
26363 PRODUCE_GLYPHS (&it2
);
26364 width
= NUMVAL (prop
) * it2
.pixel_width
;
26366 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
26367 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true,
26370 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
26371 align_to
= (align_to
< 0
26373 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
26374 else if (align_to
< 0)
26375 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
26376 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
26377 zero_width_ok_p
= true;
26380 /* Nothing specified -> width defaults to canonical char width. */
26381 width
= FRAME_COLUMN_WIDTH (it
->f
);
26383 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
26386 #ifdef HAVE_WINDOW_SYSTEM
26387 /* Compute height. */
26388 if (FRAME_WINDOW_P (it
->f
))
26390 int default_height
= normal_char_height (font
, ' ');
26392 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
26393 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26396 zero_height_ok_p
= true;
26398 else if (prop
= Fplist_get (plist
, QCrelative_height
),
26400 height
= default_height
* NUMVAL (prop
);
26402 height
= default_height
;
26404 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
26407 /* Compute percentage of height used for ascent. If
26408 `:ascent ASCENT' is present and valid, use that. Otherwise,
26409 derive the ascent from the font in use. */
26410 if (prop
= Fplist_get (plist
, QCascent
),
26411 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
26412 ascent
= height
* NUMVAL (prop
) / 100.0;
26413 else if (!NILP (prop
)
26414 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26415 ascent
= min (max (0, (int)tem
), height
);
26417 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
26420 #endif /* HAVE_WINDOW_SYSTEM */
26423 if (width
> 0 && it
->line_wrap
!= TRUNCATE
26424 && it
->current_x
+ width
> it
->last_visible_x
)
26426 width
= it
->last_visible_x
- it
->current_x
;
26427 #ifdef HAVE_WINDOW_SYSTEM
26428 /* Subtract one more pixel from the stretch width, but only on
26429 GUI frames, since on a TTY each glyph is one "pixel" wide. */
26430 width
-= FRAME_WINDOW_P (it
->f
);
26434 if (width
> 0 && height
> 0 && it
->glyph_row
)
26436 Lisp_Object o_object
= it
->object
;
26437 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
26440 if (!STRINGP (object
))
26441 object
= it
->w
->contents
;
26442 #ifdef HAVE_WINDOW_SYSTEM
26443 if (FRAME_WINDOW_P (it
->f
))
26444 append_stretch_glyph (it
, object
, width
, height
, ascent
);
26448 it
->object
= object
;
26449 it
->char_to_display
= ' ';
26450 it
->pixel_width
= it
->len
= 1;
26452 tty_append_glyph (it
);
26453 it
->object
= o_object
;
26457 it
->pixel_width
= width
;
26458 #ifdef HAVE_WINDOW_SYSTEM
26459 if (FRAME_WINDOW_P (it
->f
))
26461 it
->ascent
= it
->phys_ascent
= ascent
;
26462 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
26463 it
->nglyphs
= width
> 0 && height
> 0;
26464 take_vertical_position_into_account (it
);
26468 it
->nglyphs
= width
;
26471 /* Get information about special display element WHAT in an
26472 environment described by IT. WHAT is one of IT_TRUNCATION or
26473 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
26474 non-null glyph_row member. This function ensures that fields like
26475 face_id, c, len of IT are left untouched. */
26478 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
26485 temp_it
.object
= Qnil
;
26486 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
26488 if (what
== IT_CONTINUATION
)
26490 /* Continuation glyph. For R2L lines, we mirror it by hand. */
26491 if (it
->bidi_it
.paragraph_dir
== R2L
)
26492 SET_GLYPH_FROM_CHAR (glyph
, '/');
26494 SET_GLYPH_FROM_CHAR (glyph
, '\\');
26496 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26498 /* FIXME: Should we mirror GC for R2L lines? */
26499 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26500 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26503 else if (what
== IT_TRUNCATION
)
26505 /* Truncation glyph. */
26506 SET_GLYPH_FROM_CHAR (glyph
, '$');
26508 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26510 /* FIXME: Should we mirror GC for R2L lines? */
26511 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26512 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26518 #ifdef HAVE_WINDOW_SYSTEM
26519 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
26520 is turned off, we precede the truncation/continuation glyphs by a
26521 stretch glyph whose width is computed such that these special
26522 glyphs are aligned at the window margin, even when very different
26523 fonts are used in different glyph rows. */
26524 if (FRAME_WINDOW_P (temp_it
.f
)
26525 /* init_iterator calls this with it->glyph_row == NULL, and it
26526 wants only the pixel width of the truncation/continuation
26528 && temp_it
.glyph_row
26529 /* insert_left_trunc_glyphs calls us at the beginning of the
26530 row, and it has its own calculation of the stretch glyph
26532 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
26533 && (temp_it
.glyph_row
->reversed_p
26534 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
26535 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
26537 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
26539 if (stretch_width
> 0)
26541 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
26542 struct font
*font
=
26543 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
26544 int stretch_ascent
=
26545 (((temp_it
.ascent
+ temp_it
.descent
)
26546 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
26548 append_stretch_glyph (&temp_it
, Qnil
, stretch_width
,
26549 temp_it
.ascent
+ temp_it
.descent
,
26556 temp_it
.what
= IT_CHARACTER
;
26557 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
26558 temp_it
.face_id
= GLYPH_FACE (glyph
);
26559 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
26561 PRODUCE_GLYPHS (&temp_it
);
26562 it
->pixel_width
= temp_it
.pixel_width
;
26563 it
->nglyphs
= temp_it
.nglyphs
;
26566 #ifdef HAVE_WINDOW_SYSTEM
26568 /* Calculate line-height and line-spacing properties.
26569 An integer value specifies explicit pixel value.
26570 A float value specifies relative value to current face height.
26571 A cons (float . face-name) specifies relative value to
26572 height of specified face font.
26574 Returns height in pixels, or nil. */
26577 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
26578 int boff
, bool override
)
26580 Lisp_Object face_name
= Qnil
;
26581 int ascent
, descent
, height
;
26583 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
26588 face_name
= XCAR (val
);
26590 if (!NUMBERP (val
))
26591 val
= make_number (1);
26592 if (NILP (face_name
))
26594 height
= it
->ascent
+ it
->descent
;
26599 if (NILP (face_name
))
26601 font
= FRAME_FONT (it
->f
);
26602 boff
= FRAME_BASELINE_OFFSET (it
->f
);
26604 else if (EQ (face_name
, Qt
))
26613 face_id
= lookup_named_face (it
->f
, face_name
, false);
26615 return make_number (-1);
26617 face
= FACE_FROM_ID (it
->f
, face_id
);
26620 return make_number (-1);
26621 boff
= font
->baseline_offset
;
26622 if (font
->vertical_centering
)
26623 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26626 normal_char_ascent_descent (font
, -1, &ascent
, &descent
);
26630 it
->override_ascent
= ascent
;
26631 it
->override_descent
= descent
;
26632 it
->override_boff
= boff
;
26635 height
= ascent
+ descent
;
26639 height
= (int)(XFLOAT_DATA (val
) * height
);
26640 else if (INTEGERP (val
))
26641 height
*= XINT (val
);
26643 return make_number (height
);
26647 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
26648 is a face ID to be used for the glyph. FOR_NO_FONT is true if
26649 and only if this is for a character for which no font was found.
26651 If the display method (it->glyphless_method) is
26652 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
26653 length of the acronym or the hexadecimal string, UPPER_XOFF and
26654 UPPER_YOFF are pixel offsets for the upper part of the string,
26655 LOWER_XOFF and LOWER_YOFF are for the lower part.
26657 For the other display methods, LEN through LOWER_YOFF are zero. */
26660 append_glyphless_glyph (struct it
*it
, int face_id
, bool for_no_font
, int len
,
26661 short upper_xoff
, short upper_yoff
,
26662 short lower_xoff
, short lower_yoff
)
26664 struct glyph
*glyph
;
26665 enum glyph_row_area area
= it
->area
;
26667 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26668 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26670 /* If the glyph row is reversed, we need to prepend the glyph
26671 rather than append it. */
26672 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26676 /* Make room for the additional glyph. */
26677 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26679 glyph
= it
->glyph_row
->glyphs
[area
];
26681 glyph
->charpos
= CHARPOS (it
->position
);
26682 glyph
->object
= it
->object
;
26683 glyph
->pixel_width
= it
->pixel_width
;
26684 glyph
->ascent
= it
->ascent
;
26685 glyph
->descent
= it
->descent
;
26686 glyph
->voffset
= it
->voffset
;
26687 glyph
->type
= GLYPHLESS_GLYPH
;
26688 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
26689 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
26690 glyph
->u
.glyphless
.len
= len
;
26691 glyph
->u
.glyphless
.ch
= it
->c
;
26692 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
26693 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
26694 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
26695 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
26696 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26697 glyph
->multibyte_p
= it
->multibyte_p
;
26698 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26700 /* In R2L rows, the left and the right box edges need to be
26701 drawn in reverse direction. */
26702 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26703 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26707 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26708 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26710 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
26711 || it
->phys_descent
> it
->descent
);
26712 glyph
->padding_p
= false;
26713 glyph
->glyph_not_available_p
= false;
26714 glyph
->face_id
= face_id
;
26715 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26718 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26719 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26720 glyph
->bidi_type
= it
->bidi_it
.type
;
26722 ++it
->glyph_row
->used
[area
];
26725 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26729 /* Produce a glyph for a glyphless character for iterator IT.
26730 IT->glyphless_method specifies which method to use for displaying
26731 the character. See the description of enum
26732 glyphless_display_method in dispextern.h for the detail.
26734 FOR_NO_FONT is true if and only if this is for a character for
26735 which no font was found. ACRONYM, if non-nil, is an acronym string
26736 for the character. */
26739 produce_glyphless_glyph (struct it
*it
, bool for_no_font
, Lisp_Object acronym
)
26744 int base_width
, base_height
, width
, height
;
26745 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26748 /* Get the metrics of the base font. We always refer to the current
26750 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26751 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26752 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
26753 it
->ascent
+= font
->baseline_offset
;
26754 it
->descent
-= font
->baseline_offset
;
26755 base_height
= it
->ascent
+ it
->descent
;
26756 base_width
= font
->average_width
;
26758 face_id
= merge_glyphless_glyph_face (it
);
26760 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26762 it
->pixel_width
= THIN_SPACE_WIDTH
;
26764 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26766 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26768 width
= CHAR_WIDTH (it
->c
);
26771 else if (width
> 4)
26773 it
->pixel_width
= base_width
* width
;
26775 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26781 unsigned int code
[6];
26783 int ascent
, descent
;
26784 struct font_metrics metrics_upper
, metrics_lower
;
26786 face
= FACE_FROM_ID (it
->f
, face_id
);
26787 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26788 prepare_face_for_display (it
->f
, face
);
26790 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26792 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26793 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26794 if (CONSP (acronym
))
26795 acronym
= XCAR (acronym
);
26796 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26800 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26801 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
+ 0u);
26804 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
26805 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26806 upper_len
= (len
+ 1) / 2;
26807 font
->driver
->text_extents (font
, code
, upper_len
,
26809 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26814 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26815 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26816 upper_xoff
= upper_yoff
= 2; /* the typical case */
26817 if (base_width
>= width
)
26819 /* Align the upper to the left, the lower to the right. */
26820 it
->pixel_width
= base_width
;
26821 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26825 /* Center the shorter one. */
26826 it
->pixel_width
= width
;
26827 if (metrics_upper
.width
>= metrics_lower
.width
)
26828 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26831 /* FIXME: This code doesn't look right. It formerly was
26832 missing the "lower_xoff = 0;", which couldn't have
26833 been right since it left lower_xoff uninitialized. */
26835 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26839 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26840 top, bottom, and between upper and lower strings. */
26841 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26842 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26843 /* Center vertically.
26844 H:base_height, D:base_descent
26845 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26847 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26848 descent = D - H/2 + h/2;
26849 lower_yoff = descent - 2 - ld;
26850 upper_yoff = lower_yoff - la - 1 - ud; */
26851 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26852 descent
= it
->descent
- (base_height
- height
) / 2;
26853 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26854 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26855 - metrics_upper
.descent
);
26856 /* Don't make the height shorter than the base height. */
26857 if (height
> base_height
)
26859 it
->ascent
= ascent
;
26860 it
->descent
= descent
;
26864 it
->phys_ascent
= it
->ascent
;
26865 it
->phys_descent
= it
->descent
;
26867 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26868 upper_xoff
, upper_yoff
,
26869 lower_xoff
, lower_yoff
);
26871 take_vertical_position_into_account (it
);
26876 Produce glyphs/get display metrics for the display element IT is
26877 loaded with. See the description of struct it in dispextern.h
26878 for an overview of struct it. */
26881 x_produce_glyphs (struct it
*it
)
26883 int extra_line_spacing
= it
->extra_line_spacing
;
26885 it
->glyph_not_available_p
= false;
26887 if (it
->what
== IT_CHARACTER
)
26890 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26891 struct font
*font
= face
->font
;
26892 struct font_metrics
*pcm
= NULL
;
26893 int boff
; /* Baseline offset. */
26897 /* When no suitable font is found, display this character by
26898 the method specified in the first extra slot of
26899 Vglyphless_char_display. */
26900 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26902 eassert (it
->what
== IT_GLYPHLESS
);
26903 produce_glyphless_glyph (it
, true,
26904 STRINGP (acronym
) ? acronym
: Qnil
);
26908 boff
= font
->baseline_offset
;
26909 if (font
->vertical_centering
)
26910 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26912 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26916 if (it
->override_ascent
>= 0)
26918 it
->ascent
= it
->override_ascent
;
26919 it
->descent
= it
->override_descent
;
26920 boff
= it
->override_boff
;
26924 it
->ascent
= FONT_BASE (font
) + boff
;
26925 it
->descent
= FONT_DESCENT (font
) - boff
;
26928 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
26930 pcm
= get_per_char_metric (font
, &char2b
);
26931 if (pcm
->width
== 0
26932 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26938 it
->phys_ascent
= pcm
->ascent
+ boff
;
26939 it
->phys_descent
= pcm
->descent
- boff
;
26940 it
->pixel_width
= pcm
->width
;
26941 /* Don't use font-global values for ascent and descent
26942 if they result in an exceedingly large line height. */
26943 if (it
->override_ascent
< 0)
26945 if (FONT_TOO_HIGH (font
))
26947 it
->ascent
= it
->phys_ascent
;
26948 it
->descent
= it
->phys_descent
;
26949 /* These limitations are enforced by an
26950 assertion near the end of this function. */
26951 if (it
->ascent
< 0)
26953 if (it
->descent
< 0)
26960 it
->glyph_not_available_p
= true;
26961 it
->phys_ascent
= it
->ascent
;
26962 it
->phys_descent
= it
->descent
;
26963 it
->pixel_width
= font
->space_width
;
26966 if (it
->constrain_row_ascent_descent_p
)
26968 if (it
->descent
> it
->max_descent
)
26970 it
->ascent
+= it
->descent
- it
->max_descent
;
26971 it
->descent
= it
->max_descent
;
26973 if (it
->ascent
> it
->max_ascent
)
26975 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26976 it
->ascent
= it
->max_ascent
;
26978 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26979 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26980 extra_line_spacing
= 0;
26983 /* If this is a space inside a region of text with
26984 `space-width' property, change its width. */
26986 = it
->char_to_display
== ' ' && !NILP (it
->space_width
);
26988 it
->pixel_width
*= XFLOATINT (it
->space_width
);
26990 /* If face has a box, add the box thickness to the character
26991 height. If character has a box line to the left and/or
26992 right, add the box line width to the character's width. */
26993 if (face
->box
!= FACE_NO_BOX
)
26995 int thick
= face
->box_line_width
;
26999 it
->ascent
+= thick
;
27000 it
->descent
+= thick
;
27005 if (it
->start_of_box_run_p
)
27006 it
->pixel_width
+= thick
;
27007 if (it
->end_of_box_run_p
)
27008 it
->pixel_width
+= thick
;
27011 /* If face has an overline, add the height of the overline
27012 (1 pixel) and a 1 pixel margin to the character height. */
27013 if (face
->overline_p
)
27014 it
->ascent
+= overline_margin
;
27016 if (it
->constrain_row_ascent_descent_p
)
27018 if (it
->ascent
> it
->max_ascent
)
27019 it
->ascent
= it
->max_ascent
;
27020 if (it
->descent
> it
->max_descent
)
27021 it
->descent
= it
->max_descent
;
27024 take_vertical_position_into_account (it
);
27026 /* If we have to actually produce glyphs, do it. */
27031 /* Translate a space with a `space-width' property
27032 into a stretch glyph. */
27033 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
27034 / FONT_HEIGHT (font
));
27035 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
27036 it
->ascent
+ it
->descent
, ascent
);
27041 /* If characters with lbearing or rbearing are displayed
27042 in this line, record that fact in a flag of the
27043 glyph row. This is used to optimize X output code. */
27044 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
27045 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27047 if (! stretched_p
&& it
->pixel_width
== 0)
27048 /* We assure that all visible glyphs have at least 1-pixel
27050 it
->pixel_width
= 1;
27052 else if (it
->char_to_display
== '\n')
27054 /* A newline has no width, but we need the height of the
27055 line. But if previous part of the line sets a height,
27056 don't increase that height. */
27058 Lisp_Object height
;
27059 Lisp_Object total_height
= Qnil
;
27061 it
->override_ascent
= -1;
27062 it
->pixel_width
= 0;
27065 height
= get_it_property (it
, Qline_height
);
27066 /* Split (line-height total-height) list. */
27068 && CONSP (XCDR (height
))
27069 && NILP (XCDR (XCDR (height
))))
27071 total_height
= XCAR (XCDR (height
));
27072 height
= XCAR (height
);
27074 height
= calc_line_height_property (it
, height
, font
, boff
, true);
27076 if (it
->override_ascent
>= 0)
27078 it
->ascent
= it
->override_ascent
;
27079 it
->descent
= it
->override_descent
;
27080 boff
= it
->override_boff
;
27084 if (FONT_TOO_HIGH (font
))
27086 it
->ascent
= font
->pixel_size
+ boff
- 1;
27087 it
->descent
= -boff
+ 1;
27088 if (it
->descent
< 0)
27093 it
->ascent
= FONT_BASE (font
) + boff
;
27094 it
->descent
= FONT_DESCENT (font
) - boff
;
27098 if (EQ (height
, Qt
))
27100 if (it
->descent
> it
->max_descent
)
27102 it
->ascent
+= it
->descent
- it
->max_descent
;
27103 it
->descent
= it
->max_descent
;
27105 if (it
->ascent
> it
->max_ascent
)
27107 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
27108 it
->ascent
= it
->max_ascent
;
27110 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
27111 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
27112 it
->constrain_row_ascent_descent_p
= true;
27113 extra_line_spacing
= 0;
27117 Lisp_Object spacing
;
27119 it
->phys_ascent
= it
->ascent
;
27120 it
->phys_descent
= it
->descent
;
27122 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
27123 && face
->box
!= FACE_NO_BOX
27124 && face
->box_line_width
> 0)
27126 it
->ascent
+= face
->box_line_width
;
27127 it
->descent
+= face
->box_line_width
;
27130 && XINT (height
) > it
->ascent
+ it
->descent
)
27131 it
->ascent
= XINT (height
) - it
->descent
;
27133 if (!NILP (total_height
))
27134 spacing
= calc_line_height_property (it
, total_height
, font
,
27138 spacing
= get_it_property (it
, Qline_spacing
);
27139 spacing
= calc_line_height_property (it
, spacing
, font
,
27142 if (INTEGERP (spacing
))
27144 extra_line_spacing
= XINT (spacing
);
27145 if (!NILP (total_height
))
27146 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
27150 else /* i.e. (it->char_to_display == '\t') */
27152 if (font
->space_width
> 0)
27154 int tab_width
= it
->tab_width
* font
->space_width
;
27155 int x
= it
->current_x
+ it
->continuation_lines_width
;
27156 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
27158 /* If the distance from the current position to the next tab
27159 stop is less than a space character width, use the
27160 tab stop after that. */
27161 if (next_tab_x
- x
< font
->space_width
)
27162 next_tab_x
+= tab_width
;
27164 it
->pixel_width
= next_tab_x
- x
;
27166 if (FONT_TOO_HIGH (font
))
27168 if (get_char_glyph_code (' ', font
, &char2b
))
27170 pcm
= get_per_char_metric (font
, &char2b
);
27171 if (pcm
->width
== 0
27172 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
27178 it
->ascent
= pcm
->ascent
+ boff
;
27179 it
->descent
= pcm
->descent
- boff
;
27183 it
->ascent
= font
->pixel_size
+ boff
- 1;
27184 it
->descent
= -boff
+ 1;
27186 if (it
->ascent
< 0)
27188 if (it
->descent
< 0)
27193 it
->ascent
= FONT_BASE (font
) + boff
;
27194 it
->descent
= FONT_DESCENT (font
) - boff
;
27196 it
->phys_ascent
= it
->ascent
;
27197 it
->phys_descent
= it
->descent
;
27201 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
27202 it
->ascent
+ it
->descent
, it
->ascent
);
27207 it
->pixel_width
= 0;
27212 if (FONT_TOO_HIGH (font
))
27214 int font_ascent
, font_descent
;
27216 /* For very large fonts, where we ignore the declared font
27217 dimensions, and go by per-character metrics instead,
27218 don't let the row ascent and descent values (and the row
27219 height computed from them) be smaller than the "normal"
27220 character metrics. This avoids unpleasant effects
27221 whereby lines on display would change their height
27222 depending on which characters are shown. */
27223 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
27224 it
->max_ascent
= max (it
->max_ascent
, font_ascent
);
27225 it
->max_descent
= max (it
->max_descent
, font_descent
);
27228 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
27230 /* A static composition.
27232 Note: A composition is represented as one glyph in the
27233 glyph matrix. There are no padding glyphs.
27235 Important note: pixel_width, ascent, and descent are the
27236 values of what is drawn by draw_glyphs (i.e. the values of
27237 the overall glyphs composed). */
27238 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27239 int boff
; /* baseline offset */
27240 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
27241 int glyph_len
= cmp
->glyph_len
;
27242 struct font
*font
= face
->font
;
27246 /* If we have not yet calculated pixel size data of glyphs of
27247 the composition for the current face font, calculate them
27248 now. Theoretically, we have to check all fonts for the
27249 glyphs, but that requires much time and memory space. So,
27250 here we check only the font of the first glyph. This may
27251 lead to incorrect display, but it's very rare, and C-l
27252 (recenter-top-bottom) can correct the display anyway. */
27253 if (! cmp
->font
|| cmp
->font
!= font
)
27255 /* Ascent and descent of the font of the first character
27256 of this composition (adjusted by baseline offset).
27257 Ascent and descent of overall glyphs should not be less
27258 than these, respectively. */
27259 int font_ascent
, font_descent
, font_height
;
27260 /* Bounding box of the overall glyphs. */
27261 int leftmost
, rightmost
, lowest
, highest
;
27262 int lbearing
, rbearing
;
27263 int i
, width
, ascent
, descent
;
27264 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
27266 struct font_metrics
*pcm
;
27269 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
27270 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
27272 bool right_padded
= glyph_len
< cmp
->glyph_len
;
27273 for (i
= 0; i
< glyph_len
; i
++)
27275 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
27277 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
27279 bool left_padded
= i
> 0;
27281 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
27282 : IT_CHARPOS (*it
));
27283 /* If no suitable font is found, use the default font. */
27284 bool font_not_found_p
= font
== NULL
;
27285 if (font_not_found_p
)
27287 face
= face
->ascii_face
;
27290 boff
= font
->baseline_offset
;
27291 if (font
->vertical_centering
)
27292 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
27293 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
27294 font_ascent
+= boff
;
27295 font_descent
-= boff
;
27296 font_height
= font_ascent
+ font_descent
;
27301 if (! font_not_found_p
)
27303 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
27305 pcm
= get_per_char_metric (font
, &char2b
);
27308 /* Initialize the bounding box. */
27311 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
27312 ascent
= pcm
->ascent
;
27313 descent
= pcm
->descent
;
27314 lbearing
= pcm
->lbearing
;
27315 rbearing
= pcm
->rbearing
;
27319 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
27320 ascent
= FONT_BASE (font
);
27321 descent
= FONT_DESCENT (font
);
27328 lowest
= - descent
+ boff
;
27329 highest
= ascent
+ boff
;
27331 if (! font_not_found_p
27332 && font
->default_ascent
27333 && CHAR_TABLE_P (Vuse_default_ascent
)
27334 && !NILP (Faref (Vuse_default_ascent
,
27335 make_number (it
->char_to_display
))))
27336 highest
= font
->default_ascent
+ boff
;
27338 /* Draw the first glyph at the normal position. It may be
27339 shifted to right later if some other glyphs are drawn
27341 cmp
->offsets
[i
* 2] = 0;
27342 cmp
->offsets
[i
* 2 + 1] = boff
;
27343 cmp
->lbearing
= lbearing
;
27344 cmp
->rbearing
= rbearing
;
27346 /* Set cmp->offsets for the remaining glyphs. */
27347 for (i
++; i
< glyph_len
; i
++)
27349 int left
, right
, btm
, top
;
27350 int ch
= COMPOSITION_GLYPH (cmp
, i
);
27352 struct face
*this_face
;
27356 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
27357 this_face
= FACE_FROM_ID (it
->f
, face_id
);
27358 font
= this_face
->font
;
27364 get_char_face_and_encoding (it
->f
, ch
, face_id
,
27366 pcm
= get_per_char_metric (font
, &char2b
);
27369 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
27372 width
= pcm
->width
;
27373 ascent
= pcm
->ascent
;
27374 descent
= pcm
->descent
;
27375 lbearing
= pcm
->lbearing
;
27376 rbearing
= pcm
->rbearing
;
27377 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
27379 /* Relative composition with or without
27380 alternate chars. */
27381 left
= (leftmost
+ rightmost
- width
) / 2;
27382 btm
= - descent
+ boff
;
27383 if (font
->relative_compose
27384 && (! CHAR_TABLE_P (Vignore_relative_composition
)
27385 || NILP (Faref (Vignore_relative_composition
,
27386 make_number (ch
)))))
27389 if (- descent
>= font
->relative_compose
)
27390 /* One extra pixel between two glyphs. */
27392 else if (ascent
<= 0)
27393 /* One extra pixel between two glyphs. */
27394 btm
= lowest
- 1 - ascent
- descent
;
27399 /* A composition rule is specified by an integer
27400 value that encodes global and new reference
27401 points (GREF and NREF). GREF and NREF are
27402 specified by numbers as below:
27404 0---1---2 -- ascent
27408 9--10--11 -- center
27410 ---3---4---5--- baseline
27412 6---7---8 -- descent
27414 int rule
= COMPOSITION_RULE (cmp
, i
);
27415 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
27417 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
27418 grefx
= gref
% 3, nrefx
= nref
% 3;
27419 grefy
= gref
/ 3, nrefy
= nref
/ 3;
27421 xoff
= font_height
* (xoff
- 128) / 256;
27423 yoff
= font_height
* (yoff
- 128) / 256;
27426 + grefx
* (rightmost
- leftmost
) / 2
27427 - nrefx
* width
/ 2
27430 btm
= ((grefy
== 0 ? highest
27432 : grefy
== 2 ? lowest
27433 : (highest
+ lowest
) / 2)
27434 - (nrefy
== 0 ? ascent
+ descent
27435 : nrefy
== 1 ? descent
- boff
27437 : (ascent
+ descent
) / 2)
27441 cmp
->offsets
[i
* 2] = left
;
27442 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
27444 /* Update the bounding box of the overall glyphs. */
27447 right
= left
+ width
;
27448 if (left
< leftmost
)
27450 if (right
> rightmost
)
27453 top
= btm
+ descent
+ ascent
;
27459 if (cmp
->lbearing
> left
+ lbearing
)
27460 cmp
->lbearing
= left
+ lbearing
;
27461 if (cmp
->rbearing
< left
+ rbearing
)
27462 cmp
->rbearing
= left
+ rbearing
;
27466 /* If there are glyphs whose x-offsets are negative,
27467 shift all glyphs to the right and make all x-offsets
27471 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27472 cmp
->offsets
[i
* 2] -= leftmost
;
27473 rightmost
-= leftmost
;
27474 cmp
->lbearing
-= leftmost
;
27475 cmp
->rbearing
-= leftmost
;
27478 if (left_padded
&& cmp
->lbearing
< 0)
27480 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27481 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
27482 rightmost
-= cmp
->lbearing
;
27483 cmp
->rbearing
-= cmp
->lbearing
;
27486 if (right_padded
&& rightmost
< cmp
->rbearing
)
27488 rightmost
= cmp
->rbearing
;
27491 cmp
->pixel_width
= rightmost
;
27492 cmp
->ascent
= highest
;
27493 cmp
->descent
= - lowest
;
27494 if (cmp
->ascent
< font_ascent
)
27495 cmp
->ascent
= font_ascent
;
27496 if (cmp
->descent
< font_descent
)
27497 cmp
->descent
= font_descent
;
27501 && (cmp
->lbearing
< 0
27502 || cmp
->rbearing
> cmp
->pixel_width
))
27503 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27505 it
->pixel_width
= cmp
->pixel_width
;
27506 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
27507 it
->descent
= it
->phys_descent
= cmp
->descent
;
27508 if (face
->box
!= FACE_NO_BOX
)
27510 int thick
= face
->box_line_width
;
27514 it
->ascent
+= thick
;
27515 it
->descent
+= thick
;
27520 if (it
->start_of_box_run_p
)
27521 it
->pixel_width
+= thick
;
27522 if (it
->end_of_box_run_p
)
27523 it
->pixel_width
+= thick
;
27526 /* If face has an overline, add the height of the overline
27527 (1 pixel) and a 1 pixel margin to the character height. */
27528 if (face
->overline_p
)
27529 it
->ascent
+= overline_margin
;
27531 take_vertical_position_into_account (it
);
27532 if (it
->ascent
< 0)
27534 if (it
->descent
< 0)
27537 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
27538 append_composite_glyph (it
);
27540 else if (it
->what
== IT_COMPOSITION
)
27542 /* A dynamic (automatic) composition. */
27543 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27544 Lisp_Object gstring
;
27545 struct font_metrics metrics
;
27549 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
27551 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
27554 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
27555 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27556 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
27557 it
->descent
= it
->phys_descent
= metrics
.descent
;
27558 if (face
->box
!= FACE_NO_BOX
)
27560 int thick
= face
->box_line_width
;
27564 it
->ascent
+= thick
;
27565 it
->descent
+= thick
;
27570 if (it
->start_of_box_run_p
)
27571 it
->pixel_width
+= thick
;
27572 if (it
->end_of_box_run_p
)
27573 it
->pixel_width
+= thick
;
27575 /* If face has an overline, add the height of the overline
27576 (1 pixel) and a 1 pixel margin to the character height. */
27577 if (face
->overline_p
)
27578 it
->ascent
+= overline_margin
;
27579 take_vertical_position_into_account (it
);
27580 if (it
->ascent
< 0)
27582 if (it
->descent
< 0)
27586 append_composite_glyph (it
);
27588 else if (it
->what
== IT_GLYPHLESS
)
27589 produce_glyphless_glyph (it
, false, Qnil
);
27590 else if (it
->what
== IT_IMAGE
)
27591 produce_image_glyph (it
);
27592 else if (it
->what
== IT_STRETCH
)
27593 produce_stretch_glyph (it
);
27594 else if (it
->what
== IT_XWIDGET
)
27595 produce_xwidget_glyph (it
);
27598 /* Accumulate dimensions. Note: can't assume that it->descent > 0
27599 because this isn't true for images with `:ascent 100'. */
27600 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
27601 if (it
->area
== TEXT_AREA
)
27602 it
->current_x
+= it
->pixel_width
;
27604 if (extra_line_spacing
> 0)
27606 it
->descent
+= extra_line_spacing
;
27607 if (extra_line_spacing
> it
->max_extra_line_spacing
)
27608 it
->max_extra_line_spacing
= extra_line_spacing
;
27611 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
27612 it
->max_descent
= max (it
->max_descent
, it
->descent
);
27613 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
27614 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
27618 Output LEN glyphs starting at START at the nominal cursor position.
27619 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
27620 being updated, and UPDATED_AREA is the area of that row being updated. */
27623 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27624 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27626 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
27628 eassert (updated_row
);
27629 /* When the window is hscrolled, cursor hpos can legitimately be out
27630 of bounds, but we draw the cursor at the corresponding window
27631 margin in that case. */
27632 if (!updated_row
->reversed_p
&& chpos
< 0)
27634 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
27635 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
27639 /* Write glyphs. */
27641 hpos
= start
- updated_row
->glyphs
[updated_area
];
27642 x
= draw_glyphs (w
, w
->output_cursor
.x
,
27643 updated_row
, updated_area
,
27645 DRAW_NORMAL_TEXT
, 0);
27647 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
27648 if (updated_area
== TEXT_AREA
27649 && w
->phys_cursor_on_p
27650 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
27652 && chpos
< hpos
+ len
)
27653 w
->phys_cursor_on_p
= false;
27657 /* Advance the output cursor. */
27658 w
->output_cursor
.hpos
+= len
;
27659 w
->output_cursor
.x
= x
;
27664 Insert LEN glyphs from START at the nominal cursor position. */
27667 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27668 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27671 int line_height
, shift_by_width
, shifted_region_width
;
27672 struct glyph_row
*row
;
27673 struct glyph
*glyph
;
27674 int frame_x
, frame_y
;
27677 eassert (updated_row
);
27679 f
= XFRAME (WINDOW_FRAME (w
));
27681 /* Get the height of the line we are in. */
27683 line_height
= row
->height
;
27685 /* Get the width of the glyphs to insert. */
27686 shift_by_width
= 0;
27687 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
27688 shift_by_width
+= glyph
->pixel_width
;
27690 /* Get the width of the region to shift right. */
27691 shifted_region_width
= (window_box_width (w
, updated_area
)
27692 - w
->output_cursor
.x
27696 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
27697 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
27699 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
27700 line_height
, shift_by_width
);
27702 /* Write the glyphs. */
27703 hpos
= start
- row
->glyphs
[updated_area
];
27704 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
27706 DRAW_NORMAL_TEXT
, 0);
27708 /* Advance the output cursor. */
27709 w
->output_cursor
.hpos
+= len
;
27710 w
->output_cursor
.x
+= shift_by_width
;
27716 Erase the current text line from the nominal cursor position
27717 (inclusive) to pixel column TO_X (exclusive). The idea is that
27718 everything from TO_X onward is already erased.
27720 TO_X is a pixel position relative to UPDATED_AREA of currently
27721 updated window W. TO_X == -1 means clear to the end of this area. */
27724 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
27725 enum glyph_row_area updated_area
, int to_x
)
27728 int max_x
, min_y
, max_y
;
27729 int from_x
, from_y
, to_y
;
27731 eassert (updated_row
);
27732 f
= XFRAME (w
->frame
);
27734 if (updated_row
->full_width_p
)
27735 max_x
= (WINDOW_PIXEL_WIDTH (w
)
27736 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
27738 max_x
= window_box_width (w
, updated_area
);
27739 max_y
= window_text_bottom_y (w
);
27741 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
27742 of window. For TO_X > 0, truncate to end of drawing area. */
27748 to_x
= min (to_x
, max_x
);
27750 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
27752 /* Notice if the cursor will be cleared by this operation. */
27753 if (!updated_row
->full_width_p
)
27754 notice_overwritten_cursor (w
, updated_area
,
27755 w
->output_cursor
.x
, -1,
27757 MATRIX_ROW_BOTTOM_Y (updated_row
));
27759 from_x
= w
->output_cursor
.x
;
27761 /* Translate to frame coordinates. */
27762 if (updated_row
->full_width_p
)
27764 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
27765 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
27769 int area_left
= window_box_left (w
, updated_area
);
27770 from_x
+= area_left
;
27774 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
27775 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
27776 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
27778 /* Prevent inadvertently clearing to end of the X window. */
27779 if (to_x
> from_x
&& to_y
> from_y
)
27782 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
27783 to_x
- from_x
, to_y
- from_y
);
27788 #endif /* HAVE_WINDOW_SYSTEM */
27792 /***********************************************************************
27794 ***********************************************************************/
27796 /* Value is the internal representation of the specified cursor type
27797 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27798 of the bar cursor. */
27800 static enum text_cursor_kinds
27801 get_specified_cursor_type (Lisp_Object arg
, int *width
)
27803 enum text_cursor_kinds type
;
27808 if (EQ (arg
, Qbox
))
27809 return FILLED_BOX_CURSOR
;
27811 if (EQ (arg
, Qhollow
))
27812 return HOLLOW_BOX_CURSOR
;
27814 if (EQ (arg
, Qbar
))
27821 && EQ (XCAR (arg
), Qbar
)
27822 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27824 *width
= XINT (XCDR (arg
));
27828 if (EQ (arg
, Qhbar
))
27831 return HBAR_CURSOR
;
27835 && EQ (XCAR (arg
), Qhbar
)
27836 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27838 *width
= XINT (XCDR (arg
));
27839 return HBAR_CURSOR
;
27842 /* Treat anything unknown as "hollow box cursor".
27843 It was bad to signal an error; people have trouble fixing
27844 .Xdefaults with Emacs, when it has something bad in it. */
27845 type
= HOLLOW_BOX_CURSOR
;
27850 /* Set the default cursor types for specified frame. */
27852 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27857 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27858 FRAME_CURSOR_WIDTH (f
) = width
;
27860 /* By default, set up the blink-off state depending on the on-state. */
27862 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27865 FRAME_BLINK_OFF_CURSOR (f
)
27866 = get_specified_cursor_type (XCDR (tem
), &width
);
27867 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27870 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27872 /* Make sure the cursor gets redrawn. */
27873 f
->cursor_type_changed
= true;
27877 #ifdef HAVE_WINDOW_SYSTEM
27879 /* Return the cursor we want to be displayed in window W. Return
27880 width of bar/hbar cursor through WIDTH arg. Return with
27881 ACTIVE_CURSOR arg set to true if cursor in window W is `active'
27882 (i.e. if the `system caret' should track this cursor).
27884 In a mini-buffer window, we want the cursor only to appear if we
27885 are reading input from this window. For the selected window, we
27886 want the cursor type given by the frame parameter or buffer local
27887 setting of cursor-type. If explicitly marked off, draw no cursor.
27888 In all other cases, we want a hollow box cursor. */
27890 static enum text_cursor_kinds
27891 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27892 bool *active_cursor
)
27894 struct frame
*f
= XFRAME (w
->frame
);
27895 struct buffer
*b
= XBUFFER (w
->contents
);
27896 int cursor_type
= DEFAULT_CURSOR
;
27897 Lisp_Object alt_cursor
;
27898 bool non_selected
= false;
27900 *active_cursor
= true;
27903 if (cursor_in_echo_area
27904 && FRAME_HAS_MINIBUF_P (f
)
27905 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27907 if (w
== XWINDOW (echo_area_window
))
27909 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27911 *width
= FRAME_CURSOR_WIDTH (f
);
27912 return FRAME_DESIRED_CURSOR (f
);
27915 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27918 *active_cursor
= false;
27919 non_selected
= true;
27922 /* Detect a nonselected window or nonselected frame. */
27923 else if (w
!= XWINDOW (f
->selected_window
)
27924 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
27926 *active_cursor
= false;
27928 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
27931 non_selected
= true;
27934 /* Never display a cursor in a window in which cursor-type is nil. */
27935 if (NILP (BVAR (b
, cursor_type
)))
27938 /* Get the normal cursor type for this window. */
27939 if (EQ (BVAR (b
, cursor_type
), Qt
))
27941 cursor_type
= FRAME_DESIRED_CURSOR (f
);
27942 *width
= FRAME_CURSOR_WIDTH (f
);
27945 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27947 /* Use cursor-in-non-selected-windows instead
27948 for non-selected window or frame. */
27951 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
27952 if (!EQ (Qt
, alt_cursor
))
27953 return get_specified_cursor_type (alt_cursor
, width
);
27954 /* t means modify the normal cursor type. */
27955 if (cursor_type
== FILLED_BOX_CURSOR
)
27956 cursor_type
= HOLLOW_BOX_CURSOR
;
27957 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
27959 return cursor_type
;
27962 /* Use normal cursor if not blinked off. */
27963 if (!w
->cursor_off_p
)
27965 if (glyph
!= NULL
&& glyph
->type
== XWIDGET_GLYPH
)
27967 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27969 if (cursor_type
== FILLED_BOX_CURSOR
)
27971 /* Using a block cursor on large images can be very annoying.
27972 So use a hollow cursor for "large" images.
27973 If image is not transparent (no mask), also use hollow cursor. */
27974 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27975 if (img
!= NULL
&& IMAGEP (img
->spec
))
27977 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27978 where N = size of default frame font size.
27979 This should cover most of the "tiny" icons people may use. */
27981 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
27982 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
27983 cursor_type
= HOLLOW_BOX_CURSOR
;
27986 else if (cursor_type
!= NO_CURSOR
)
27988 /* Display current only supports BOX and HOLLOW cursors for images.
27989 So for now, unconditionally use a HOLLOW cursor when cursor is
27990 not a solid box cursor. */
27991 cursor_type
= HOLLOW_BOX_CURSOR
;
27994 return cursor_type
;
27997 /* Cursor is blinked off, so determine how to "toggle" it. */
27999 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
28000 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
28001 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
28003 /* Then see if frame has specified a specific blink off cursor type. */
28004 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
28006 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
28007 return FRAME_BLINK_OFF_CURSOR (f
);
28011 /* Some people liked having a permanently visible blinking cursor,
28012 while others had very strong opinions against it. So it was
28013 decided to remove it. KFS 2003-09-03 */
28015 /* Finally perform built-in cursor blinking:
28016 filled box <-> hollow box
28017 wide [h]bar <-> narrow [h]bar
28018 narrow [h]bar <-> no cursor
28019 other type <-> no cursor */
28021 if (cursor_type
== FILLED_BOX_CURSOR
)
28022 return HOLLOW_BOX_CURSOR
;
28024 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
28027 return cursor_type
;
28035 /* Notice when the text cursor of window W has been completely
28036 overwritten by a drawing operation that outputs glyphs in AREA
28037 starting at X0 and ending at X1 in the line starting at Y0 and
28038 ending at Y1. X coordinates are area-relative. X1 < 0 means all
28039 the rest of the line after X0 has been written. Y coordinates
28040 are window-relative. */
28043 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
28044 int x0
, int x1
, int y0
, int y1
)
28046 int cx0
, cx1
, cy0
, cy1
;
28047 struct glyph_row
*row
;
28049 if (!w
->phys_cursor_on_p
)
28051 if (area
!= TEXT_AREA
)
28054 if (w
->phys_cursor
.vpos
< 0
28055 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
28056 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
28057 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
28060 if (row
->cursor_in_fringe_p
)
28062 row
->cursor_in_fringe_p
= false;
28063 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
28064 w
->phys_cursor_on_p
= false;
28068 cx0
= w
->phys_cursor
.x
;
28069 cx1
= cx0
+ w
->phys_cursor_width
;
28070 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
28073 /* The cursor image will be completely removed from the
28074 screen if the output area intersects the cursor area in
28075 y-direction. When we draw in [y0 y1[, and some part of
28076 the cursor is at y < y0, that part must have been drawn
28077 before. When scrolling, the cursor is erased before
28078 actually scrolling, so we don't come here. When not
28079 scrolling, the rows above the old cursor row must have
28080 changed, and in this case these rows must have written
28081 over the cursor image.
28083 Likewise if part of the cursor is below y1, with the
28084 exception of the cursor being in the first blank row at
28085 the buffer and window end because update_text_area
28086 doesn't draw that row. (Except when it does, but
28087 that's handled in update_text_area.) */
28089 cy0
= w
->phys_cursor
.y
;
28090 cy1
= cy0
+ w
->phys_cursor_height
;
28091 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
28094 w
->phys_cursor_on_p
= false;
28097 #endif /* HAVE_WINDOW_SYSTEM */
28100 /************************************************************************
28102 ************************************************************************/
28104 #ifdef HAVE_WINDOW_SYSTEM
28107 Fix the display of area AREA of overlapping row ROW in window W
28108 with respect to the overlapping part OVERLAPS. */
28111 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
28112 enum glyph_row_area area
, int overlaps
)
28119 for (i
= 0; i
< row
->used
[area
];)
28121 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
28123 int start
= i
, start_x
= x
;
28127 x
+= row
->glyphs
[area
][i
].pixel_width
;
28130 while (i
< row
->used
[area
]
28131 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
28133 draw_glyphs (w
, start_x
, row
, area
,
28135 DRAW_NORMAL_TEXT
, overlaps
);
28139 x
+= row
->glyphs
[area
][i
].pixel_width
;
28149 Draw the cursor glyph of window W in glyph row ROW. See the
28150 comment of draw_glyphs for the meaning of HL. */
28153 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
28154 enum draw_glyphs_face hl
)
28156 /* If cursor hpos is out of bounds, don't draw garbage. This can
28157 happen in mini-buffer windows when switching between echo area
28158 glyphs and mini-buffer. */
28159 if ((row
->reversed_p
28160 ? (w
->phys_cursor
.hpos
>= 0)
28161 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
28163 bool on_p
= w
->phys_cursor_on_p
;
28165 int hpos
= w
->phys_cursor
.hpos
;
28167 /* When the window is hscrolled, cursor hpos can legitimately be
28168 out of bounds, but we draw the cursor at the corresponding
28169 window margin in that case. */
28170 if (!row
->reversed_p
&& hpos
< 0)
28172 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28173 hpos
= row
->used
[TEXT_AREA
] - 1;
28175 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
28177 w
->phys_cursor_on_p
= on_p
;
28179 if (hl
== DRAW_CURSOR
)
28180 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
28181 /* When we erase the cursor, and ROW is overlapped by other
28182 rows, make sure that these overlapping parts of other rows
28184 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
28186 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
28188 if (row
> w
->current_matrix
->rows
28189 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
28190 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
28191 OVERLAPS_ERASED_CURSOR
);
28193 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
28194 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
28195 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
28196 OVERLAPS_ERASED_CURSOR
);
28202 /* Erase the image of a cursor of window W from the screen. */
28205 erase_phys_cursor (struct window
*w
)
28207 struct frame
*f
= XFRAME (w
->frame
);
28208 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28209 int hpos
= w
->phys_cursor
.hpos
;
28210 int vpos
= w
->phys_cursor
.vpos
;
28211 bool mouse_face_here_p
= false;
28212 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
28213 struct glyph_row
*cursor_row
;
28214 struct glyph
*cursor_glyph
;
28215 enum draw_glyphs_face hl
;
28217 /* No cursor displayed or row invalidated => nothing to do on the
28219 if (w
->phys_cursor_type
== NO_CURSOR
)
28220 goto mark_cursor_off
;
28222 /* VPOS >= active_glyphs->nrows means that window has been resized.
28223 Don't bother to erase the cursor. */
28224 if (vpos
>= active_glyphs
->nrows
)
28225 goto mark_cursor_off
;
28227 /* If row containing cursor is marked invalid, there is nothing we
28229 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
28230 if (!cursor_row
->enabled_p
)
28231 goto mark_cursor_off
;
28233 /* If line spacing is > 0, old cursor may only be partially visible in
28234 window after split-window. So adjust visible height. */
28235 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
28236 window_text_bottom_y (w
) - cursor_row
->y
);
28238 /* If row is completely invisible, don't attempt to delete a cursor which
28239 isn't there. This can happen if cursor is at top of a window, and
28240 we switch to a buffer with a header line in that window. */
28241 if (cursor_row
->visible_height
<= 0)
28242 goto mark_cursor_off
;
28244 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
28245 if (cursor_row
->cursor_in_fringe_p
)
28247 cursor_row
->cursor_in_fringe_p
= false;
28248 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
28249 goto mark_cursor_off
;
28252 /* This can happen when the new row is shorter than the old one.
28253 In this case, either draw_glyphs or clear_end_of_line
28254 should have cleared the cursor. Note that we wouldn't be
28255 able to erase the cursor in this case because we don't have a
28256 cursor glyph at hand. */
28257 if ((cursor_row
->reversed_p
28258 ? (w
->phys_cursor
.hpos
< 0)
28259 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
28260 goto mark_cursor_off
;
28262 /* When the window is hscrolled, cursor hpos can legitimately be out
28263 of bounds, but we draw the cursor at the corresponding window
28264 margin in that case. */
28265 if (!cursor_row
->reversed_p
&& hpos
< 0)
28267 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
28268 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
28270 /* If the cursor is in the mouse face area, redisplay that when
28271 we clear the cursor. */
28272 if (! NILP (hlinfo
->mouse_face_window
)
28273 && coords_in_mouse_face_p (w
, hpos
, vpos
)
28274 /* Don't redraw the cursor's spot in mouse face if it is at the
28275 end of a line (on a newline). The cursor appears there, but
28276 mouse highlighting does not. */
28277 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
28278 mouse_face_here_p
= true;
28280 /* Maybe clear the display under the cursor. */
28281 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
28284 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
28287 cursor_glyph
= get_phys_cursor_glyph (w
);
28288 if (cursor_glyph
== NULL
)
28289 goto mark_cursor_off
;
28291 width
= cursor_glyph
->pixel_width
;
28292 x
= w
->phys_cursor
.x
;
28298 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
28299 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
28300 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
28303 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
28306 /* Erase the cursor by redrawing the character underneath it. */
28307 if (mouse_face_here_p
)
28308 hl
= DRAW_MOUSE_FACE
;
28310 hl
= DRAW_NORMAL_TEXT
;
28311 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
28314 w
->phys_cursor_on_p
= false;
28315 w
->phys_cursor_type
= NO_CURSOR
;
28319 /* Display or clear cursor of window W. If !ON, clear the cursor.
28320 If ON, display the cursor; where to put the cursor is specified by
28321 HPOS, VPOS, X and Y. */
28324 display_and_set_cursor (struct window
*w
, bool on
,
28325 int hpos
, int vpos
, int x
, int y
)
28327 struct frame
*f
= XFRAME (w
->frame
);
28328 int new_cursor_type
;
28329 int new_cursor_width
;
28330 bool active_cursor
;
28331 struct glyph_row
*glyph_row
;
28332 struct glyph
*glyph
;
28334 /* This is pointless on invisible frames, and dangerous on garbaged
28335 windows and frames; in the latter case, the frame or window may
28336 be in the midst of changing its size, and x and y may be off the
28338 if (! FRAME_VISIBLE_P (f
)
28339 || FRAME_GARBAGED_P (f
)
28340 || vpos
>= w
->current_matrix
->nrows
28341 || hpos
>= w
->current_matrix
->matrix_w
)
28344 /* If cursor is off and we want it off, return quickly. */
28345 if (!on
&& !w
->phys_cursor_on_p
)
28348 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28349 /* If cursor row is not enabled, we don't really know where to
28350 display the cursor. */
28351 if (!glyph_row
->enabled_p
)
28353 w
->phys_cursor_on_p
= false;
28358 if (!glyph_row
->exact_window_width_line_p
28359 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
28360 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
28362 eassert (input_blocked_p ());
28364 /* Set new_cursor_type to the cursor we want to be displayed. */
28365 new_cursor_type
= get_window_cursor_type (w
, glyph
,
28366 &new_cursor_width
, &active_cursor
);
28368 /* If cursor is currently being shown and we don't want it to be or
28369 it is in the wrong place, or the cursor type is not what we want,
28371 if (w
->phys_cursor_on_p
28373 || w
->phys_cursor
.x
!= x
28374 || w
->phys_cursor
.y
!= y
28375 /* HPOS can be negative in R2L rows whose
28376 exact_window_width_line_p flag is set (i.e. their newline
28377 would "overflow into the fringe"). */
28379 || new_cursor_type
!= w
->phys_cursor_type
28380 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
28381 && new_cursor_width
!= w
->phys_cursor_width
)))
28382 erase_phys_cursor (w
);
28384 /* Don't check phys_cursor_on_p here because that flag is only set
28385 to false in some cases where we know that the cursor has been
28386 completely erased, to avoid the extra work of erasing the cursor
28387 twice. In other words, phys_cursor_on_p can be true and the cursor
28388 still not be visible, or it has only been partly erased. */
28391 w
->phys_cursor_ascent
= glyph_row
->ascent
;
28392 w
->phys_cursor_height
= glyph_row
->height
;
28394 /* Set phys_cursor_.* before x_draw_.* is called because some
28395 of them may need the information. */
28396 w
->phys_cursor
.x
= x
;
28397 w
->phys_cursor
.y
= glyph_row
->y
;
28398 w
->phys_cursor
.hpos
= hpos
;
28399 w
->phys_cursor
.vpos
= vpos
;
28402 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
28403 new_cursor_type
, new_cursor_width
,
28404 on
, active_cursor
);
28408 /* Switch the display of W's cursor on or off, according to the value
28412 update_window_cursor (struct window
*w
, bool on
)
28414 /* Don't update cursor in windows whose frame is in the process
28415 of being deleted. */
28416 if (w
->current_matrix
)
28418 int hpos
= w
->phys_cursor
.hpos
;
28419 int vpos
= w
->phys_cursor
.vpos
;
28420 struct glyph_row
*row
;
28422 if (vpos
>= w
->current_matrix
->nrows
28423 || hpos
>= w
->current_matrix
->matrix_w
)
28426 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28428 /* When the window is hscrolled, cursor hpos can legitimately be
28429 out of bounds, but we draw the cursor at the corresponding
28430 window margin in that case. */
28431 if (!row
->reversed_p
&& hpos
< 0)
28433 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28434 hpos
= row
->used
[TEXT_AREA
] - 1;
28437 display_and_set_cursor (w
, on
, hpos
, vpos
,
28438 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28444 /* Call update_window_cursor with parameter ON_P on all leaf windows
28445 in the window tree rooted at W. */
28448 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
28452 if (WINDOWP (w
->contents
))
28453 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
28455 update_window_cursor (w
, on_p
);
28457 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
28463 Display the cursor on window W, or clear it, according to ON_P.
28464 Don't change the cursor's position. */
28467 x_update_cursor (struct frame
*f
, bool on_p
)
28469 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
28474 Clear the cursor of window W to background color, and mark the
28475 cursor as not shown. This is used when the text where the cursor
28476 is about to be rewritten. */
28479 x_clear_cursor (struct window
*w
)
28481 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
28482 update_window_cursor (w
, false);
28485 #endif /* HAVE_WINDOW_SYSTEM */
28487 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
28490 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
28491 int start_hpos
, int end_hpos
,
28492 enum draw_glyphs_face draw
)
28494 #ifdef HAVE_WINDOW_SYSTEM
28495 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
28497 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
28501 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
28502 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
28506 /* Display the active region described by mouse_face_* according to DRAW. */
28509 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
28511 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
28512 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28514 if (/* If window is in the process of being destroyed, don't bother
28516 w
->current_matrix
!= NULL
28517 /* Don't update mouse highlight if hidden. */
28518 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
28519 /* Recognize when we are called to operate on rows that don't exist
28520 anymore. This can happen when a window is split. */
28521 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
28523 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
28524 struct glyph_row
*row
, *first
, *last
;
28526 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
28527 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
28529 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
28531 int start_hpos
, end_hpos
, start_x
;
28533 /* For all but the first row, the highlight starts at column 0. */
28536 /* R2L rows have BEG and END in reversed order, but the
28537 screen drawing geometry is always left to right. So
28538 we need to mirror the beginning and end of the
28539 highlighted area in R2L rows. */
28540 if (!row
->reversed_p
)
28542 start_hpos
= hlinfo
->mouse_face_beg_col
;
28543 start_x
= hlinfo
->mouse_face_beg_x
;
28545 else if (row
== last
)
28547 start_hpos
= hlinfo
->mouse_face_end_col
;
28548 start_x
= hlinfo
->mouse_face_end_x
;
28556 else if (row
->reversed_p
&& row
== last
)
28558 start_hpos
= hlinfo
->mouse_face_end_col
;
28559 start_x
= hlinfo
->mouse_face_end_x
;
28569 if (!row
->reversed_p
)
28570 end_hpos
= hlinfo
->mouse_face_end_col
;
28571 else if (row
== first
)
28572 end_hpos
= hlinfo
->mouse_face_beg_col
;
28575 end_hpos
= row
->used
[TEXT_AREA
];
28576 if (draw
== DRAW_NORMAL_TEXT
)
28577 row
->fill_line_p
= true; /* Clear to end of line. */
28580 else if (row
->reversed_p
&& row
== first
)
28581 end_hpos
= hlinfo
->mouse_face_beg_col
;
28584 end_hpos
= row
->used
[TEXT_AREA
];
28585 if (draw
== DRAW_NORMAL_TEXT
)
28586 row
->fill_line_p
= true; /* Clear to end of line. */
28589 if (end_hpos
> start_hpos
)
28591 draw_row_with_mouse_face (w
, start_x
, row
,
28592 start_hpos
, end_hpos
, draw
);
28595 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
28599 #ifdef HAVE_WINDOW_SYSTEM
28600 /* When we've written over the cursor, arrange for it to
28601 be displayed again. */
28602 if (FRAME_WINDOW_P (f
)
28603 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
28605 int hpos
= w
->phys_cursor
.hpos
;
28607 /* When the window is hscrolled, cursor hpos can legitimately be
28608 out of bounds, but we draw the cursor at the corresponding
28609 window margin in that case. */
28610 if (!row
->reversed_p
&& hpos
< 0)
28612 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28613 hpos
= row
->used
[TEXT_AREA
] - 1;
28616 display_and_set_cursor (w
, true, hpos
, w
->phys_cursor
.vpos
,
28617 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28620 #endif /* HAVE_WINDOW_SYSTEM */
28623 #ifdef HAVE_WINDOW_SYSTEM
28624 /* Change the mouse cursor. */
28625 if (FRAME_WINDOW_P (f
) && NILP (do_mouse_tracking
))
28627 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
28628 if (draw
== DRAW_NORMAL_TEXT
28629 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
28630 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
28633 if (draw
== DRAW_MOUSE_FACE
)
28634 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
28636 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
28638 #endif /* HAVE_WINDOW_SYSTEM */
28642 Clear out the mouse-highlighted active region.
28643 Redraw it un-highlighted first. Value is true if mouse
28644 face was actually drawn unhighlighted. */
28647 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
28650 = !hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
);
28652 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
28653 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28654 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28655 hlinfo
->mouse_face_window
= Qnil
;
28656 hlinfo
->mouse_face_overlay
= Qnil
;
28660 /* Return true if the coordinates HPOS and VPOS on windows W are
28661 within the mouse face on that window. */
28663 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
28665 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28667 /* Quickly resolve the easy cases. */
28668 if (!(WINDOWP (hlinfo
->mouse_face_window
)
28669 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
28671 if (vpos
< hlinfo
->mouse_face_beg_row
28672 || vpos
> hlinfo
->mouse_face_end_row
)
28674 if (vpos
> hlinfo
->mouse_face_beg_row
28675 && vpos
< hlinfo
->mouse_face_end_row
)
28678 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
28680 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28682 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
28685 else if ((vpos
== hlinfo
->mouse_face_beg_row
28686 && hpos
>= hlinfo
->mouse_face_beg_col
)
28687 || (vpos
== hlinfo
->mouse_face_end_row
28688 && hpos
< hlinfo
->mouse_face_end_col
))
28693 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28695 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
28698 else if ((vpos
== hlinfo
->mouse_face_beg_row
28699 && hpos
<= hlinfo
->mouse_face_beg_col
)
28700 || (vpos
== hlinfo
->mouse_face_end_row
28701 && hpos
> hlinfo
->mouse_face_end_col
))
28709 True if physical cursor of window W is within mouse face. */
28712 cursor_in_mouse_face_p (struct window
*w
)
28714 int hpos
= w
->phys_cursor
.hpos
;
28715 int vpos
= w
->phys_cursor
.vpos
;
28716 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28718 /* When the window is hscrolled, cursor hpos can legitimately be out
28719 of bounds, but we draw the cursor at the corresponding window
28720 margin in that case. */
28721 if (!row
->reversed_p
&& hpos
< 0)
28723 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28724 hpos
= row
->used
[TEXT_AREA
] - 1;
28726 return coords_in_mouse_face_p (w
, hpos
, vpos
);
28731 /* Find the glyph rows START_ROW and END_ROW of window W that display
28732 characters between buffer positions START_CHARPOS and END_CHARPOS
28733 (excluding END_CHARPOS). DISP_STRING is a display string that
28734 covers these buffer positions. This is similar to
28735 row_containing_pos, but is more accurate when bidi reordering makes
28736 buffer positions change non-linearly with glyph rows. */
28738 rows_from_pos_range (struct window
*w
,
28739 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
28740 Lisp_Object disp_string
,
28741 struct glyph_row
**start
, struct glyph_row
**end
)
28743 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28744 int last_y
= window_text_bottom_y (w
);
28745 struct glyph_row
*row
;
28750 while (!first
->enabled_p
28751 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
28754 /* Find the START row. */
28756 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
28759 /* A row can potentially be the START row if the range of the
28760 characters it displays intersects the range
28761 [START_CHARPOS..END_CHARPOS). */
28762 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
28763 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
28764 /* See the commentary in row_containing_pos, for the
28765 explanation of the complicated way to check whether
28766 some position is beyond the end of the characters
28767 displayed by a row. */
28768 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28769 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28770 && !row
->ends_at_zv_p
28771 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
28772 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28773 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28774 && !row
->ends_at_zv_p
28775 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
28777 /* Found a candidate row. Now make sure at least one of the
28778 glyphs it displays has a charpos from the range
28779 [START_CHARPOS..END_CHARPOS).
28781 This is not obvious because bidi reordering could make
28782 buffer positions of a row be 1,2,3,102,101,100, and if we
28783 want to highlight characters in [50..60), we don't want
28784 this row, even though [50..60) does intersect [1..103),
28785 the range of character positions given by the row's start
28786 and end positions. */
28787 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
28788 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
28792 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28793 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28794 /* A glyph that comes from DISP_STRING is by
28795 definition to be highlighted. */
28796 || EQ (g
->object
, disp_string
))
28805 /* Find the END row. */
28807 /* If the last row is partially visible, start looking for END
28808 from that row, instead of starting from FIRST. */
28809 && !(row
->enabled_p
28810 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
28812 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
28814 struct glyph_row
*next
= row
+ 1;
28815 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
28817 if (!next
->enabled_p
28818 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
28819 /* The first row >= START whose range of displayed characters
28820 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28821 is the row END + 1. */
28822 || (start_charpos
< next_start
28823 && end_charpos
< next_start
)
28824 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28825 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28826 && !next
->ends_at_zv_p
28827 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28828 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28829 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28830 && !next
->ends_at_zv_p
28831 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28838 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28839 but none of the characters it displays are in the range, it is
28841 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28842 struct glyph
*s
= g
;
28843 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28847 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28848 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28849 /* If the buffer position of the first glyph in
28850 the row is equal to END_CHARPOS, it means
28851 the last character to be highlighted is the
28852 newline of ROW, and we must consider NEXT as
28854 || (((!next
->reversed_p
&& g
== s
)
28855 || (next
->reversed_p
&& g
== e
- 1))
28856 && (g
->charpos
== end_charpos
28857 /* Special case for when NEXT is an
28858 empty line at ZV. */
28859 || (g
->charpos
== -1
28860 && !row
->ends_at_zv_p
28861 && next_start
== end_charpos
)))))
28862 /* A glyph that comes from DISP_STRING is by
28863 definition to be highlighted. */
28864 || EQ (g
->object
, disp_string
))
28873 /* The first row that ends at ZV must be the last to be
28875 else if (next
->ends_at_zv_p
)
28884 /* This function sets the mouse_face_* elements of HLINFO, assuming
28885 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28886 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28887 for the overlay or run of text properties specifying the mouse
28888 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28889 before-string and after-string that must also be highlighted.
28890 DISP_STRING, if non-nil, is a display string that may cover some
28891 or all of the highlighted text. */
28894 mouse_face_from_buffer_pos (Lisp_Object window
,
28895 Mouse_HLInfo
*hlinfo
,
28896 ptrdiff_t mouse_charpos
,
28897 ptrdiff_t start_charpos
,
28898 ptrdiff_t end_charpos
,
28899 Lisp_Object before_string
,
28900 Lisp_Object after_string
,
28901 Lisp_Object disp_string
)
28903 struct window
*w
= XWINDOW (window
);
28904 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28905 struct glyph_row
*r1
, *r2
;
28906 struct glyph
*glyph
, *end
;
28907 ptrdiff_t ignore
, pos
;
28910 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28911 eassert (NILP (before_string
) || STRINGP (before_string
));
28912 eassert (NILP (after_string
) || STRINGP (after_string
));
28914 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28915 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
28917 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28918 /* If the before-string or display-string contains newlines,
28919 rows_from_pos_range skips to its last row. Move back. */
28920 if (!NILP (before_string
) || !NILP (disp_string
))
28922 struct glyph_row
*prev
;
28923 while ((prev
= r1
- 1, prev
>= first
)
28924 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
28925 && prev
->used
[TEXT_AREA
] > 0)
28927 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
28928 glyph
= beg
+ prev
->used
[TEXT_AREA
];
28929 while (--glyph
>= beg
&& NILP (glyph
->object
));
28931 || !(EQ (glyph
->object
, before_string
)
28932 || EQ (glyph
->object
, disp_string
)))
28939 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28940 hlinfo
->mouse_face_past_end
= true;
28942 else if (!NILP (after_string
))
28944 /* If the after-string has newlines, advance to its last row. */
28945 struct glyph_row
*next
;
28946 struct glyph_row
*last
28947 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28949 for (next
= r2
+ 1;
28951 && next
->used
[TEXT_AREA
] > 0
28952 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
28956 /* The rest of the display engine assumes that mouse_face_beg_row is
28957 either above mouse_face_end_row or identical to it. But with
28958 bidi-reordered continued lines, the row for START_CHARPOS could
28959 be below the row for END_CHARPOS. If so, swap the rows and store
28960 them in correct order. */
28963 struct glyph_row
*tem
= r2
;
28969 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
28970 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
28972 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28973 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28974 could be anywhere in the row and in any order. The strategy
28975 below is to find the leftmost and the rightmost glyph that
28976 belongs to either of these 3 strings, or whose position is
28977 between START_CHARPOS and END_CHARPOS, and highlight all the
28978 glyphs between those two. This may cover more than just the text
28979 between START_CHARPOS and END_CHARPOS if the range of characters
28980 strides the bidi level boundary, e.g. if the beginning is in R2L
28981 text while the end is in L2R text or vice versa. */
28982 if (!r1
->reversed_p
)
28984 /* This row is in a left to right paragraph. Scan it left to
28986 glyph
= r1
->glyphs
[TEXT_AREA
];
28987 end
= glyph
+ r1
->used
[TEXT_AREA
];
28990 /* Skip truncation glyphs at the start of the glyph row. */
28991 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28993 && NILP (glyph
->object
)
28994 && glyph
->charpos
< 0;
28996 x
+= glyph
->pixel_width
;
28998 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28999 or DISP_STRING, and the first glyph from buffer whose
29000 position is between START_CHARPOS and END_CHARPOS. */
29002 && !NILP (glyph
->object
)
29003 && !EQ (glyph
->object
, disp_string
)
29004 && !(BUFFERP (glyph
->object
)
29005 && (glyph
->charpos
>= start_charpos
29006 && glyph
->charpos
< end_charpos
));
29009 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29010 are present at buffer positions between START_CHARPOS and
29011 END_CHARPOS, or if they come from an overlay. */
29012 if (EQ (glyph
->object
, before_string
))
29014 pos
= string_buffer_position (before_string
,
29016 /* If pos == 0, it means before_string came from an
29017 overlay, not from a buffer position. */
29018 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29021 else if (EQ (glyph
->object
, after_string
))
29023 pos
= string_buffer_position (after_string
, end_charpos
);
29024 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29027 x
+= glyph
->pixel_width
;
29029 hlinfo
->mouse_face_beg_x
= x
;
29030 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
29034 /* This row is in a right to left paragraph. Scan it right to
29038 end
= r1
->glyphs
[TEXT_AREA
] - 1;
29039 glyph
= end
+ r1
->used
[TEXT_AREA
];
29041 /* Skip truncation glyphs at the start of the glyph row. */
29042 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
29044 && NILP (glyph
->object
)
29045 && glyph
->charpos
< 0;
29049 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
29050 or DISP_STRING, and the first glyph from buffer whose
29051 position is between START_CHARPOS and END_CHARPOS. */
29053 && !NILP (glyph
->object
)
29054 && !EQ (glyph
->object
, disp_string
)
29055 && !(BUFFERP (glyph
->object
)
29056 && (glyph
->charpos
>= start_charpos
29057 && glyph
->charpos
< end_charpos
));
29060 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29061 are present at buffer positions between START_CHARPOS and
29062 END_CHARPOS, or if they come from an overlay. */
29063 if (EQ (glyph
->object
, before_string
))
29065 pos
= string_buffer_position (before_string
, start_charpos
);
29066 /* If pos == 0, it means before_string came from an
29067 overlay, not from a buffer position. */
29068 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29071 else if (EQ (glyph
->object
, after_string
))
29073 pos
= string_buffer_position (after_string
, end_charpos
);
29074 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29079 glyph
++; /* first glyph to the right of the highlighted area */
29080 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
29081 x
+= g
->pixel_width
;
29082 hlinfo
->mouse_face_beg_x
= x
;
29083 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
29086 /* If the highlight ends in a different row, compute GLYPH and END
29087 for the end row. Otherwise, reuse the values computed above for
29088 the row where the highlight begins. */
29091 if (!r2
->reversed_p
)
29093 glyph
= r2
->glyphs
[TEXT_AREA
];
29094 end
= glyph
+ r2
->used
[TEXT_AREA
];
29099 end
= r2
->glyphs
[TEXT_AREA
] - 1;
29100 glyph
= end
+ r2
->used
[TEXT_AREA
];
29104 if (!r2
->reversed_p
)
29106 /* Skip truncation and continuation glyphs near the end of the
29107 row, and also blanks and stretch glyphs inserted by
29108 extend_face_to_end_of_line. */
29110 && NILP ((end
- 1)->object
))
29112 /* Scan the rest of the glyph row from the end, looking for the
29113 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
29114 DISP_STRING, or whose position is between START_CHARPOS
29118 && !NILP (end
->object
)
29119 && !EQ (end
->object
, disp_string
)
29120 && !(BUFFERP (end
->object
)
29121 && (end
->charpos
>= start_charpos
29122 && end
->charpos
< end_charpos
));
29125 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29126 are present at buffer positions between START_CHARPOS and
29127 END_CHARPOS, or if they come from an overlay. */
29128 if (EQ (end
->object
, before_string
))
29130 pos
= string_buffer_position (before_string
, start_charpos
);
29131 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29134 else if (EQ (end
->object
, after_string
))
29136 pos
= string_buffer_position (after_string
, end_charpos
);
29137 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29141 /* Find the X coordinate of the last glyph to be highlighted. */
29142 for (; glyph
<= end
; ++glyph
)
29143 x
+= glyph
->pixel_width
;
29145 hlinfo
->mouse_face_end_x
= x
;
29146 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
29150 /* Skip truncation and continuation glyphs near the end of the
29151 row, and also blanks and stretch glyphs inserted by
29152 extend_face_to_end_of_line. */
29156 && NILP (end
->object
))
29158 x
+= end
->pixel_width
;
29161 /* Scan the rest of the glyph row from the end, looking for the
29162 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
29163 DISP_STRING, or whose position is between START_CHARPOS
29167 && !NILP (end
->object
)
29168 && !EQ (end
->object
, disp_string
)
29169 && !(BUFFERP (end
->object
)
29170 && (end
->charpos
>= start_charpos
29171 && end
->charpos
< end_charpos
));
29174 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29175 are present at buffer positions between START_CHARPOS and
29176 END_CHARPOS, or if they come from an overlay. */
29177 if (EQ (end
->object
, before_string
))
29179 pos
= string_buffer_position (before_string
, start_charpos
);
29180 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29183 else if (EQ (end
->object
, after_string
))
29185 pos
= string_buffer_position (after_string
, end_charpos
);
29186 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29189 x
+= end
->pixel_width
;
29191 /* If we exited the above loop because we arrived at the last
29192 glyph of the row, and its buffer position is still not in
29193 range, it means the last character in range is the preceding
29194 newline. Bump the end column and x values to get past the
29197 && BUFFERP (end
->object
)
29198 && (end
->charpos
< start_charpos
29199 || end
->charpos
>= end_charpos
))
29201 x
+= end
->pixel_width
;
29204 hlinfo
->mouse_face_end_x
= x
;
29205 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
29208 hlinfo
->mouse_face_window
= window
;
29209 hlinfo
->mouse_face_face_id
29210 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
29212 !hlinfo
->mouse_face_hidden
, -1);
29213 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29216 /* The following function is not used anymore (replaced with
29217 mouse_face_from_string_pos), but I leave it here for the time
29218 being, in case someone would. */
29220 #if false /* not used */
29222 /* Find the position of the glyph for position POS in OBJECT in
29223 window W's current matrix, and return in *X, *Y the pixel
29224 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
29226 RIGHT_P means return the position of the right edge of the glyph.
29227 !RIGHT_P means return the left edge position.
29229 If no glyph for POS exists in the matrix, return the position of
29230 the glyph with the next smaller position that is in the matrix, if
29231 RIGHT_P is false. If RIGHT_P, and no glyph for POS
29232 exists in the matrix, return the position of the glyph with the
29233 next larger position in OBJECT.
29235 Value is true if a glyph was found. */
29238 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
29239 int *hpos
, int *vpos
, int *x
, int *y
, bool right_p
)
29241 int yb
= window_text_bottom_y (w
);
29242 struct glyph_row
*r
;
29243 struct glyph
*best_glyph
= NULL
;
29244 struct glyph_row
*best_row
= NULL
;
29247 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
29248 r
->enabled_p
&& r
->y
< yb
;
29251 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
29252 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
29255 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
29256 if (EQ (g
->object
, object
))
29258 if (g
->charpos
== pos
)
29265 else if (best_glyph
== NULL
29266 || ((eabs (g
->charpos
- pos
)
29267 < eabs (best_glyph
->charpos
- pos
))
29270 : g
->charpos
> pos
)))
29284 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
29288 *x
+= best_glyph
->pixel_width
;
29293 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
29296 return best_glyph
!= NULL
;
29298 #endif /* not used */
29300 /* Find the positions of the first and the last glyphs in window W's
29301 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
29302 (assumed to be a string), and return in HLINFO's mouse_face_*
29303 members the pixel and column/row coordinates of those glyphs. */
29306 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
29307 Lisp_Object object
,
29308 ptrdiff_t startpos
, ptrdiff_t endpos
)
29310 int yb
= window_text_bottom_y (w
);
29311 struct glyph_row
*r
;
29312 struct glyph
*g
, *e
;
29314 bool found
= false;
29316 /* Find the glyph row with at least one position in the range
29317 [STARTPOS..ENDPOS), and the first glyph in that row whose
29318 position belongs to that range. */
29319 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
29320 r
->enabled_p
&& r
->y
< yb
;
29323 if (!r
->reversed_p
)
29325 g
= r
->glyphs
[TEXT_AREA
];
29326 e
= g
+ r
->used
[TEXT_AREA
];
29327 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
29328 if (EQ (g
->object
, object
)
29329 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29331 hlinfo
->mouse_face_beg_row
29332 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29333 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29334 hlinfo
->mouse_face_beg_x
= gx
;
29343 e
= r
->glyphs
[TEXT_AREA
];
29344 g
= e
+ r
->used
[TEXT_AREA
];
29345 for ( ; g
> e
; --g
)
29346 if (EQ ((g
-1)->object
, object
)
29347 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
29349 hlinfo
->mouse_face_beg_row
29350 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29351 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29352 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
29353 gx
+= g1
->pixel_width
;
29354 hlinfo
->mouse_face_beg_x
= gx
;
29366 /* Starting with the next row, look for the first row which does NOT
29367 include any glyphs whose positions are in the range. */
29368 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
29370 g
= r
->glyphs
[TEXT_AREA
];
29371 e
= g
+ r
->used
[TEXT_AREA
];
29373 for ( ; g
< e
; ++g
)
29374 if (EQ (g
->object
, object
)
29375 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29384 /* The highlighted region ends on the previous row. */
29387 /* Set the end row. */
29388 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29390 /* Compute and set the end column and the end column's horizontal
29391 pixel coordinate. */
29392 if (!r
->reversed_p
)
29394 g
= r
->glyphs
[TEXT_AREA
];
29395 e
= g
+ r
->used
[TEXT_AREA
];
29396 for ( ; e
> g
; --e
)
29397 if (EQ ((e
-1)->object
, object
)
29398 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
29400 hlinfo
->mouse_face_end_col
= e
- g
;
29402 for (gx
= r
->x
; g
< e
; ++g
)
29403 gx
+= g
->pixel_width
;
29404 hlinfo
->mouse_face_end_x
= gx
;
29408 e
= r
->glyphs
[TEXT_AREA
];
29409 g
= e
+ r
->used
[TEXT_AREA
];
29410 for (gx
= r
->x
; e
< g
; ++e
)
29412 if (EQ (e
->object
, object
)
29413 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
29415 gx
+= e
->pixel_width
;
29417 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
29418 hlinfo
->mouse_face_end_x
= gx
;
29422 #ifdef HAVE_WINDOW_SYSTEM
29424 /* See if position X, Y is within a hot-spot of an image. */
29427 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
29429 if (!CONSP (hot_spot
))
29432 if (EQ (XCAR (hot_spot
), Qrect
))
29434 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
29435 Lisp_Object rect
= XCDR (hot_spot
);
29439 if (!CONSP (XCAR (rect
)))
29441 if (!CONSP (XCDR (rect
)))
29443 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
29445 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
29447 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
29449 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
29453 else if (EQ (XCAR (hot_spot
), Qcircle
))
29455 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
29456 Lisp_Object circ
= XCDR (hot_spot
);
29457 Lisp_Object lr
, lx0
, ly0
;
29459 && CONSP (XCAR (circ
))
29460 && (lr
= XCDR (circ
), NUMBERP (lr
))
29461 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
29462 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
29464 double r
= XFLOATINT (lr
);
29465 double dx
= XINT (lx0
) - x
;
29466 double dy
= XINT (ly0
) - y
;
29467 return (dx
* dx
+ dy
* dy
<= r
* r
);
29470 else if (EQ (XCAR (hot_spot
), Qpoly
))
29472 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
29473 if (VECTORP (XCDR (hot_spot
)))
29475 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
29476 Lisp_Object
*poly
= v
->contents
;
29477 ptrdiff_t n
= v
->header
.size
;
29479 bool inside
= false;
29480 Lisp_Object lx
, ly
;
29483 /* Need an even number of coordinates, and at least 3 edges. */
29484 if (n
< 6 || n
& 1)
29487 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
29488 If count is odd, we are inside polygon. Pixels on edges
29489 may or may not be included depending on actual geometry of the
29491 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
29492 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
29494 x0
= XINT (lx
), y0
= XINT (ly
);
29495 for (i
= 0; i
< n
; i
+= 2)
29497 int x1
= x0
, y1
= y0
;
29498 if ((lx
= poly
[i
], !INTEGERP (lx
))
29499 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
29501 x0
= XINT (lx
), y0
= XINT (ly
);
29503 /* Does this segment cross the X line? */
29511 if (y
> y0
&& y
> y1
)
29513 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
29523 find_hot_spot (Lisp_Object map
, int x
, int y
)
29525 while (CONSP (map
))
29527 if (CONSP (XCAR (map
))
29528 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
29536 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
29538 doc
: /* Lookup in image map MAP coordinates X and Y.
29539 An image map is an alist where each element has the format (AREA ID PLIST).
29540 An AREA is specified as either a rectangle, a circle, or a polygon:
29541 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
29542 pixel coordinates of the upper left and bottom right corners.
29543 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
29544 and the radius of the circle; r may be a float or integer.
29545 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
29546 vector describes one corner in the polygon.
29547 Returns the alist element for the first matching AREA in MAP. */)
29548 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
29556 return find_hot_spot (map
,
29557 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
29558 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
29562 /* Display frame CURSOR, optionally using shape defined by POINTER. */
29564 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
29566 /* Do not change cursor shape while dragging mouse. */
29567 if (EQ (do_mouse_tracking
, Qdragging
))
29570 if (!NILP (pointer
))
29572 if (EQ (pointer
, Qarrow
))
29573 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29574 else if (EQ (pointer
, Qhand
))
29575 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
29576 else if (EQ (pointer
, Qtext
))
29577 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29578 else if (EQ (pointer
, intern ("hdrag")))
29579 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29580 else if (EQ (pointer
, intern ("nhdrag")))
29581 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29582 #ifdef HAVE_X_WINDOWS
29583 else if (EQ (pointer
, intern ("vdrag")))
29584 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29586 else if (EQ (pointer
, intern ("hourglass")))
29587 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
29588 else if (EQ (pointer
, Qmodeline
))
29589 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
29591 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29594 if (cursor
!= No_Cursor
)
29595 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
29598 #endif /* HAVE_WINDOW_SYSTEM */
29600 /* Take proper action when mouse has moved to the mode or header line
29601 or marginal area AREA of window W, x-position X and y-position Y.
29602 X is relative to the start of the text display area of W, so the
29603 width of bitmap areas and scroll bars must be subtracted to get a
29604 position relative to the start of the mode line. */
29607 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
29608 enum window_part area
)
29610 struct window
*w
= XWINDOW (window
);
29611 struct frame
*f
= XFRAME (w
->frame
);
29612 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29613 #ifdef HAVE_WINDOW_SYSTEM
29614 Display_Info
*dpyinfo
;
29616 Cursor cursor
= No_Cursor
;
29617 Lisp_Object pointer
= Qnil
;
29618 int dx
, dy
, width
, height
;
29620 Lisp_Object string
, object
= Qnil
;
29621 Lisp_Object pos
IF_LINT (= Qnil
), help
;
29623 Lisp_Object mouse_face
;
29624 int original_x_pixel
= x
;
29625 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
29626 struct glyph_row
*row
IF_LINT (= 0);
29628 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
29633 /* Kludge alert: mode_line_string takes X/Y in pixels, but
29634 returns them in row/column units! */
29635 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
29636 &object
, &dx
, &dy
, &width
, &height
);
29638 row
= (area
== ON_MODE_LINE
29639 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
29640 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
29642 /* Find the glyph under the mouse pointer. */
29643 if (row
->mode_line_p
&& row
->enabled_p
)
29645 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
29646 end
= glyph
+ row
->used
[TEXT_AREA
];
29648 for (x0
= original_x_pixel
;
29649 glyph
< end
&& x0
>= glyph
->pixel_width
;
29651 x0
-= glyph
->pixel_width
;
29659 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
29660 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
29661 returns them in row/column units! */
29662 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
29663 &object
, &dx
, &dy
, &width
, &height
);
29668 #ifdef HAVE_WINDOW_SYSTEM
29669 if (IMAGEP (object
))
29671 Lisp_Object image_map
, hotspot
;
29672 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
29674 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
29676 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29680 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
29681 If so, we could look for mouse-enter, mouse-leave
29682 properties in PLIST (and do something...). */
29683 hotspot
= XCDR (hotspot
);
29684 if (CONSP (hotspot
)
29685 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29687 pointer
= Fplist_get (plist
, Qpointer
);
29688 if (NILP (pointer
))
29690 help
= Fplist_get (plist
, Qhelp_echo
);
29693 help_echo_string
= help
;
29694 XSETWINDOW (help_echo_window
, w
);
29695 help_echo_object
= w
->contents
;
29696 help_echo_pos
= charpos
;
29700 if (NILP (pointer
))
29701 pointer
= Fplist_get (XCDR (object
), QCpointer
);
29703 #endif /* HAVE_WINDOW_SYSTEM */
29705 if (STRINGP (string
))
29706 pos
= make_number (charpos
);
29708 /* Set the help text and mouse pointer. If the mouse is on a part
29709 of the mode line without any text (e.g. past the right edge of
29710 the mode line text), use the default help text and pointer. */
29711 if (STRINGP (string
) || area
== ON_MODE_LINE
)
29713 /* Arrange to display the help by setting the global variables
29714 help_echo_string, help_echo_object, and help_echo_pos. */
29717 if (STRINGP (string
))
29718 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
29722 help_echo_string
= help
;
29723 XSETWINDOW (help_echo_window
, w
);
29724 help_echo_object
= string
;
29725 help_echo_pos
= charpos
;
29727 else if (area
== ON_MODE_LINE
)
29729 Lisp_Object default_help
29730 = buffer_local_value (Qmode_line_default_help_echo
,
29733 if (STRINGP (default_help
))
29735 help_echo_string
= default_help
;
29736 XSETWINDOW (help_echo_window
, w
);
29737 help_echo_object
= Qnil
;
29738 help_echo_pos
= -1;
29743 #ifdef HAVE_WINDOW_SYSTEM
29744 /* Change the mouse pointer according to what is under it. */
29745 if (FRAME_WINDOW_P (f
))
29747 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
29749 || NILP (Vresize_mini_windows
));
29751 dpyinfo
= FRAME_DISPLAY_INFO (f
);
29752 if (STRINGP (string
))
29754 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29756 if (NILP (pointer
))
29757 pointer
= Fget_text_property (pos
, Qpointer
, string
);
29759 /* Change the mouse pointer according to what is under X/Y. */
29761 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
29764 map
= Fget_text_property (pos
, Qlocal_map
, string
);
29765 if (!KEYMAPP (map
))
29766 map
= Fget_text_property (pos
, Qkeymap
, string
);
29767 if (!KEYMAPP (map
) && draggable
)
29768 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
29771 else if (draggable
)
29772 /* Default mode-line pointer. */
29773 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29778 /* Change the mouse face according to what is under X/Y. */
29779 bool mouse_face_shown
= false;
29780 if (STRINGP (string
))
29782 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
29783 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
29784 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29789 struct glyph
* tmp_glyph
;
29793 int total_pixel_width
;
29794 ptrdiff_t begpos
, endpos
, ignore
;
29798 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
29799 Qmouse_face
, string
, Qnil
);
29805 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
29807 endpos
= SCHARS (string
);
29811 /* Calculate the glyph position GPOS of GLYPH in the
29812 displayed string, relative to the beginning of the
29813 highlighted part of the string.
29815 Note: GPOS is different from CHARPOS. CHARPOS is the
29816 position of GLYPH in the internal string object. A mode
29817 line string format has structures which are converted to
29818 a flattened string by the Emacs Lisp interpreter. The
29819 internal string is an element of those structures. The
29820 displayed string is the flattened string. */
29821 tmp_glyph
= row_start_glyph
;
29822 while (tmp_glyph
< glyph
29823 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29824 && begpos
<= tmp_glyph
->charpos
29825 && tmp_glyph
->charpos
< endpos
)))
29827 gpos
= glyph
- tmp_glyph
;
29829 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29830 the highlighted part of the displayed string to which
29831 GLYPH belongs. Note: GSEQ_LENGTH is different from
29832 SCHARS (STRING), because the latter returns the length of
29833 the internal string. */
29834 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29836 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29837 && begpos
<= tmp_glyph
->charpos
29838 && tmp_glyph
->charpos
< endpos
));
29841 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29843 /* Calculate the total pixel width of all the glyphs between
29844 the beginning of the highlighted area and GLYPH. */
29845 total_pixel_width
= 0;
29846 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29847 total_pixel_width
+= tmp_glyph
->pixel_width
;
29849 /* Pre calculation of re-rendering position. Note: X is in
29850 column units here, after the call to mode_line_string or
29851 marginal_area_string. */
29853 vpos
= (area
== ON_MODE_LINE
29854 ? (w
->current_matrix
)->nrows
- 1
29857 /* If GLYPH's position is included in the region that is
29858 already drawn in mouse face, we have nothing to do. */
29859 if ( EQ (window
, hlinfo
->mouse_face_window
)
29860 && (!row
->reversed_p
29861 ? (hlinfo
->mouse_face_beg_col
<= hpos
29862 && hpos
< hlinfo
->mouse_face_end_col
)
29863 /* In R2L rows we swap BEG and END, see below. */
29864 : (hlinfo
->mouse_face_end_col
<= hpos
29865 && hpos
< hlinfo
->mouse_face_beg_col
))
29866 && hlinfo
->mouse_face_beg_row
== vpos
)
29869 if (clear_mouse_face (hlinfo
))
29870 cursor
= No_Cursor
;
29872 if (!row
->reversed_p
)
29874 hlinfo
->mouse_face_beg_col
= hpos
;
29875 hlinfo
->mouse_face_beg_x
= original_x_pixel
29876 - (total_pixel_width
+ dx
);
29877 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29878 hlinfo
->mouse_face_end_x
= 0;
29882 /* In R2L rows, show_mouse_face expects BEG and END
29883 coordinates to be swapped. */
29884 hlinfo
->mouse_face_end_col
= hpos
;
29885 hlinfo
->mouse_face_end_x
= original_x_pixel
29886 - (total_pixel_width
+ dx
);
29887 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29888 hlinfo
->mouse_face_beg_x
= 0;
29891 hlinfo
->mouse_face_beg_row
= vpos
;
29892 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29893 hlinfo
->mouse_face_past_end
= false;
29894 hlinfo
->mouse_face_window
= window
;
29896 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29901 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29902 mouse_face_shown
= true;
29904 if (NILP (pointer
))
29909 /* If mouse-face doesn't need to be shown, clear any existing
29911 if ((area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
) && !mouse_face_shown
)
29912 clear_mouse_face (hlinfo
);
29914 #ifdef HAVE_WINDOW_SYSTEM
29915 if (FRAME_WINDOW_P (f
))
29916 define_frame_cursor1 (f
, cursor
, pointer
);
29922 Take proper action when the mouse has moved to position X, Y on
29923 frame F with regards to highlighting portions of display that have
29924 mouse-face properties. Also de-highlight portions of display where
29925 the mouse was before, set the mouse pointer shape as appropriate
29926 for the mouse coordinates, and activate help echo (tooltips).
29927 X and Y can be negative or out of range. */
29930 note_mouse_highlight (struct frame
*f
, int x
, int y
)
29932 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29933 enum window_part part
= ON_NOTHING
;
29934 Lisp_Object window
;
29936 Cursor cursor
= No_Cursor
;
29937 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
29940 /* When a menu is active, don't highlight because this looks odd. */
29941 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29942 if (popup_activated ())
29946 if (!f
->glyphs_initialized_p
29947 || f
->pointer_invisible
)
29950 hlinfo
->mouse_face_mouse_x
= x
;
29951 hlinfo
->mouse_face_mouse_y
= y
;
29952 hlinfo
->mouse_face_mouse_frame
= f
;
29954 if (hlinfo
->mouse_face_defer
)
29957 /* Which window is that in? */
29958 window
= window_from_coordinates (f
, x
, y
, &part
, true);
29960 /* If displaying active text in another window, clear that. */
29961 if (! EQ (window
, hlinfo
->mouse_face_window
)
29962 /* Also clear if we move out of text area in same window. */
29963 || (!NILP (hlinfo
->mouse_face_window
)
29966 && part
!= ON_MODE_LINE
29967 && part
!= ON_HEADER_LINE
))
29968 clear_mouse_face (hlinfo
);
29970 /* Not on a window -> return. */
29971 if (!WINDOWP (window
))
29974 /* Reset help_echo_string. It will get recomputed below. */
29975 help_echo_string
= Qnil
;
29977 /* Convert to window-relative pixel coordinates. */
29978 w
= XWINDOW (window
);
29979 frame_to_window_pixel_xy (w
, &x
, &y
);
29981 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29982 /* Handle tool-bar window differently since it doesn't display a
29984 if (EQ (window
, f
->tool_bar_window
))
29986 note_tool_bar_highlight (f
, x
, y
);
29991 /* Mouse is on the mode, header line or margin? */
29992 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
29993 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29995 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
29997 #ifdef HAVE_WINDOW_SYSTEM
29998 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
30000 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30001 /* Show non-text cursor (Bug#16647). */
30009 #ifdef HAVE_WINDOW_SYSTEM
30010 if (part
== ON_VERTICAL_BORDER
)
30012 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
30013 help_echo_string
= build_string ("drag-mouse-1: resize");
30015 else if (part
== ON_RIGHT_DIVIDER
)
30017 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
30018 help_echo_string
= build_string ("drag-mouse-1: resize");
30020 else if (part
== ON_BOTTOM_DIVIDER
)
30021 if (! WINDOW_BOTTOMMOST_P (w
)
30023 || NILP (Vresize_mini_windows
))
30025 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
30026 help_echo_string
= build_string ("drag-mouse-1: resize");
30029 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30030 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
30031 || part
== ON_VERTICAL_SCROLL_BAR
30032 || part
== ON_HORIZONTAL_SCROLL_BAR
)
30033 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30035 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
30038 /* Are we in a window whose display is up to date?
30039 And verify the buffer's text has not changed. */
30040 b
= XBUFFER (w
->contents
);
30041 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
30043 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
30045 struct glyph
*glyph
;
30046 Lisp_Object object
;
30047 Lisp_Object mouse_face
= Qnil
, position
;
30048 Lisp_Object
*overlay_vec
= NULL
;
30049 ptrdiff_t i
, noverlays
;
30050 struct buffer
*obuf
;
30051 ptrdiff_t obegv
, ozv
;
30054 /* Find the glyph under X/Y. */
30055 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
30057 #ifdef HAVE_WINDOW_SYSTEM
30058 /* Look for :pointer property on image. */
30059 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
30061 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
30062 if (img
!= NULL
&& IMAGEP (img
->spec
))
30064 Lisp_Object image_map
, hotspot
;
30065 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
30067 && (hotspot
= find_hot_spot (image_map
,
30068 glyph
->slice
.img
.x
+ dx
,
30069 glyph
->slice
.img
.y
+ dy
),
30071 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
30075 /* Could check XCAR (hotspot) to see if we enter/leave
30077 If so, we could look for mouse-enter, mouse-leave
30078 properties in PLIST (and do something...). */
30079 hotspot
= XCDR (hotspot
);
30080 if (CONSP (hotspot
)
30081 && (plist
= XCAR (hotspot
), CONSP (plist
)))
30083 pointer
= Fplist_get (plist
, Qpointer
);
30084 if (NILP (pointer
))
30086 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
30087 if (!NILP (help_echo_string
))
30089 help_echo_window
= window
;
30090 help_echo_object
= glyph
->object
;
30091 help_echo_pos
= glyph
->charpos
;
30095 if (NILP (pointer
))
30096 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
30099 #endif /* HAVE_WINDOW_SYSTEM */
30101 /* Clear mouse face if X/Y not over text. */
30103 || area
!= TEXT_AREA
30104 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
30105 /* Glyph's OBJECT is nil for glyphs inserted by the
30106 display engine for its internal purposes, like truncation
30107 and continuation glyphs and blanks beyond the end of
30108 line's text on text terminals. If we are over such a
30109 glyph, we are not over any text. */
30110 || NILP (glyph
->object
)
30111 /* R2L rows have a stretch glyph at their front, which
30112 stands for no text, whereas L2R rows have no glyphs at
30113 all beyond the end of text. Treat such stretch glyphs
30114 like we do with NULL glyphs in L2R rows. */
30115 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
30116 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
30117 && glyph
->type
== STRETCH_GLYPH
30118 && glyph
->avoid_cursor_p
))
30120 if (clear_mouse_face (hlinfo
))
30121 cursor
= No_Cursor
;
30122 #ifdef HAVE_WINDOW_SYSTEM
30123 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30125 if (area
!= TEXT_AREA
)
30126 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30128 pointer
= Vvoid_text_area_pointer
;
30134 pos
= glyph
->charpos
;
30135 object
= glyph
->object
;
30136 if (!STRINGP (object
) && !BUFFERP (object
))
30139 /* If we get an out-of-range value, return now; avoid an error. */
30140 if (BUFFERP (object
) && pos
> BUF_Z (b
))
30143 /* Make the window's buffer temporarily current for
30144 overlays_at and compute_char_face. */
30145 obuf
= current_buffer
;
30146 current_buffer
= b
;
30152 /* Is this char mouse-active or does it have help-echo? */
30153 position
= make_number (pos
);
30157 if (BUFFERP (object
))
30159 /* Put all the overlays we want in a vector in overlay_vec. */
30160 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, false);
30161 /* Sort overlays into increasing priority order. */
30162 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
30167 if (NILP (Vmouse_highlight
))
30169 clear_mouse_face (hlinfo
);
30170 goto check_help_echo
;
30173 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
30176 cursor
= No_Cursor
;
30178 /* Check mouse-face highlighting. */
30180 /* If there exists an overlay with mouse-face overlapping
30181 the one we are currently highlighting, we have to
30182 check if we enter the overlapping overlay, and then
30183 highlight only that. */
30184 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
30185 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
30187 /* Find the highest priority overlay with a mouse-face. */
30188 Lisp_Object overlay
= Qnil
;
30189 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
30191 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
30192 if (!NILP (mouse_face
))
30193 overlay
= overlay_vec
[i
];
30196 /* If we're highlighting the same overlay as before, there's
30197 no need to do that again. */
30198 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
30199 goto check_help_echo
;
30200 hlinfo
->mouse_face_overlay
= overlay
;
30202 /* Clear the display of the old active region, if any. */
30203 if (clear_mouse_face (hlinfo
))
30204 cursor
= No_Cursor
;
30206 /* If no overlay applies, get a text property. */
30207 if (NILP (overlay
))
30208 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
30210 /* Next, compute the bounds of the mouse highlighting and
30212 if (!NILP (mouse_face
) && STRINGP (object
))
30214 /* The mouse-highlighting comes from a display string
30215 with a mouse-face. */
30219 s
= Fprevious_single_property_change
30220 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
30221 e
= Fnext_single_property_change
30222 (position
, Qmouse_face
, object
, Qnil
);
30224 s
= make_number (0);
30226 e
= make_number (SCHARS (object
));
30227 mouse_face_from_string_pos (w
, hlinfo
, object
,
30228 XINT (s
), XINT (e
));
30229 hlinfo
->mouse_face_past_end
= false;
30230 hlinfo
->mouse_face_window
= window
;
30231 hlinfo
->mouse_face_face_id
30232 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
30233 glyph
->face_id
, true);
30234 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
30235 cursor
= No_Cursor
;
30239 /* The mouse-highlighting, if any, comes from an overlay
30240 or text property in the buffer. */
30241 Lisp_Object buffer
IF_LINT (= Qnil
);
30242 Lisp_Object disp_string
IF_LINT (= Qnil
);
30244 if (STRINGP (object
))
30246 /* If we are on a display string with no mouse-face,
30247 check if the text under it has one. */
30248 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
30249 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30250 pos
= string_buffer_position (object
, start
);
30253 mouse_face
= get_char_property_and_overlay
30254 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
30255 buffer
= w
->contents
;
30256 disp_string
= object
;
30262 disp_string
= Qnil
;
30265 if (!NILP (mouse_face
))
30267 Lisp_Object before
, after
;
30268 Lisp_Object before_string
, after_string
;
30269 /* To correctly find the limits of mouse highlight
30270 in a bidi-reordered buffer, we must not use the
30271 optimization of limiting the search in
30272 previous-single-property-change and
30273 next-single-property-change, because
30274 rows_from_pos_range needs the real start and end
30275 positions to DTRT in this case. That's because
30276 the first row visible in a window does not
30277 necessarily display the character whose position
30278 is the smallest. */
30280 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
30281 ? Fmarker_position (w
->start
)
30284 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
30285 ? make_number (BUF_Z (XBUFFER (buffer
))
30286 - w
->window_end_pos
)
30289 if (NILP (overlay
))
30291 /* Handle the text property case. */
30292 before
= Fprevious_single_property_change
30293 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
30294 after
= Fnext_single_property_change
30295 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
30296 before_string
= after_string
= Qnil
;
30300 /* Handle the overlay case. */
30301 before
= Foverlay_start (overlay
);
30302 after
= Foverlay_end (overlay
);
30303 before_string
= Foverlay_get (overlay
, Qbefore_string
);
30304 after_string
= Foverlay_get (overlay
, Qafter_string
);
30306 if (!STRINGP (before_string
)) before_string
= Qnil
;
30307 if (!STRINGP (after_string
)) after_string
= Qnil
;
30310 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
30313 : XFASTINT (before
),
30315 ? BUF_Z (XBUFFER (buffer
))
30316 : XFASTINT (after
),
30317 before_string
, after_string
,
30319 cursor
= No_Cursor
;
30326 /* Look for a `help-echo' property. */
30327 if (NILP (help_echo_string
)) {
30328 Lisp_Object help
, overlay
;
30330 /* Check overlays first. */
30331 help
= overlay
= Qnil
;
30332 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
30334 overlay
= overlay_vec
[i
];
30335 help
= Foverlay_get (overlay
, Qhelp_echo
);
30340 help_echo_string
= help
;
30341 help_echo_window
= window
;
30342 help_echo_object
= overlay
;
30343 help_echo_pos
= pos
;
30347 Lisp_Object obj
= glyph
->object
;
30348 ptrdiff_t charpos
= glyph
->charpos
;
30350 /* Try text properties. */
30353 && charpos
< SCHARS (obj
))
30355 help
= Fget_text_property (make_number (charpos
),
30359 /* If the string itself doesn't specify a help-echo,
30360 see if the buffer text ``under'' it does. */
30361 struct glyph_row
*r
30362 = MATRIX_ROW (w
->current_matrix
, vpos
);
30363 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30364 ptrdiff_t p
= string_buffer_position (obj
, start
);
30367 help
= Fget_char_property (make_number (p
),
30368 Qhelp_echo
, w
->contents
);
30377 else if (BUFFERP (obj
)
30380 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
30385 help_echo_string
= help
;
30386 help_echo_window
= window
;
30387 help_echo_object
= obj
;
30388 help_echo_pos
= charpos
;
30393 #ifdef HAVE_WINDOW_SYSTEM
30394 /* Look for a `pointer' property. */
30395 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30397 /* Check overlays first. */
30398 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
30399 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
30401 if (NILP (pointer
))
30403 Lisp_Object obj
= glyph
->object
;
30404 ptrdiff_t charpos
= glyph
->charpos
;
30406 /* Try text properties. */
30409 && charpos
< SCHARS (obj
))
30411 pointer
= Fget_text_property (make_number (charpos
),
30413 if (NILP (pointer
))
30415 /* If the string itself doesn't specify a pointer,
30416 see if the buffer text ``under'' it does. */
30417 struct glyph_row
*r
30418 = MATRIX_ROW (w
->current_matrix
, vpos
);
30419 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30420 ptrdiff_t p
= string_buffer_position (obj
, start
);
30422 pointer
= Fget_char_property (make_number (p
),
30423 Qpointer
, w
->contents
);
30426 else if (BUFFERP (obj
)
30429 pointer
= Fget_text_property (make_number (charpos
),
30433 #endif /* HAVE_WINDOW_SYSTEM */
30437 current_buffer
= obuf
;
30443 #ifdef HAVE_WINDOW_SYSTEM
30444 if (FRAME_WINDOW_P (f
))
30445 define_frame_cursor1 (f
, cursor
, pointer
);
30447 /* This is here to prevent a compiler error, about "label at end of
30448 compound statement". */
30455 Clear any mouse-face on window W. This function is part of the
30456 redisplay interface, and is called from try_window_id and similar
30457 functions to ensure the mouse-highlight is off. */
30460 x_clear_window_mouse_face (struct window
*w
)
30462 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
30463 Lisp_Object window
;
30466 XSETWINDOW (window
, w
);
30467 if (EQ (window
, hlinfo
->mouse_face_window
))
30468 clear_mouse_face (hlinfo
);
30474 Just discard the mouse face information for frame F, if any.
30475 This is used when the size of F is changed. */
30478 cancel_mouse_face (struct frame
*f
)
30480 Lisp_Object window
;
30481 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30483 window
= hlinfo
->mouse_face_window
;
30484 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
30485 reset_mouse_highlight (hlinfo
);
30490 /***********************************************************************
30492 ***********************************************************************/
30494 #ifdef HAVE_WINDOW_SYSTEM
30496 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
30497 which intersects rectangle R. R is in window-relative coordinates. */
30500 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
30501 enum glyph_row_area area
)
30503 struct glyph
*first
= row
->glyphs
[area
];
30504 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
30505 struct glyph
*last
;
30506 int first_x
, start_x
, x
;
30508 if (area
== TEXT_AREA
&& row
->fill_line_p
)
30509 /* If row extends face to end of line write the whole line. */
30510 draw_glyphs (w
, 0, row
, area
,
30511 0, row
->used
[area
],
30512 DRAW_NORMAL_TEXT
, 0);
30515 /* Set START_X to the window-relative start position for drawing glyphs of
30516 AREA. The first glyph of the text area can be partially visible.
30517 The first glyphs of other areas cannot. */
30518 start_x
= window_box_left_offset (w
, area
);
30520 if (area
== TEXT_AREA
)
30523 /* Find the first glyph that must be redrawn. */
30525 && x
+ first
->pixel_width
< r
->x
)
30527 x
+= first
->pixel_width
;
30531 /* Find the last one. */
30534 /* Use a signed int intermediate value to avoid catastrophic
30535 failures due to comparison between signed and unsigned, when
30536 x is negative (can happen for wide images that are hscrolled). */
30537 int r_end
= r
->x
+ r
->width
;
30538 while (last
< end
&& x
< r_end
)
30540 x
+= last
->pixel_width
;
30546 draw_glyphs (w
, first_x
- start_x
, row
, area
,
30547 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
30548 DRAW_NORMAL_TEXT
, 0);
30553 /* Redraw the parts of the glyph row ROW on window W intersecting
30554 rectangle R. R is in window-relative coordinates. Value is
30555 true if mouse-face was overwritten. */
30558 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
30560 eassert (row
->enabled_p
);
30562 if (row
->mode_line_p
|| w
->pseudo_window_p
)
30563 draw_glyphs (w
, 0, row
, TEXT_AREA
,
30564 0, row
->used
[TEXT_AREA
],
30565 DRAW_NORMAL_TEXT
, 0);
30568 if (row
->used
[LEFT_MARGIN_AREA
])
30569 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
30570 if (row
->used
[TEXT_AREA
])
30571 expose_area (w
, row
, r
, TEXT_AREA
);
30572 if (row
->used
[RIGHT_MARGIN_AREA
])
30573 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
30574 draw_row_fringe_bitmaps (w
, row
);
30577 return row
->mouse_face_p
;
30581 /* Redraw those parts of glyphs rows during expose event handling that
30582 overlap other rows. Redrawing of an exposed line writes over parts
30583 of lines overlapping that exposed line; this function fixes that.
30585 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
30586 row in W's current matrix that is exposed and overlaps other rows.
30587 LAST_OVERLAPPING_ROW is the last such row. */
30590 expose_overlaps (struct window
*w
,
30591 struct glyph_row
*first_overlapping_row
,
30592 struct glyph_row
*last_overlapping_row
,
30595 struct glyph_row
*row
;
30597 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
30598 if (row
->overlapping_p
)
30600 eassert (row
->enabled_p
&& !row
->mode_line_p
);
30603 if (row
->used
[LEFT_MARGIN_AREA
])
30604 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
30606 if (row
->used
[TEXT_AREA
])
30607 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
30609 if (row
->used
[RIGHT_MARGIN_AREA
])
30610 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
30616 /* Return true if W's cursor intersects rectangle R. */
30619 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
30621 XRectangle cr
, result
;
30622 struct glyph
*cursor_glyph
;
30623 struct glyph_row
*row
;
30625 if (w
->phys_cursor
.vpos
>= 0
30626 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
30627 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
30629 && row
->cursor_in_fringe_p
)
30631 /* Cursor is in the fringe. */
30632 cr
.x
= window_box_right_offset (w
,
30633 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
30634 ? RIGHT_MARGIN_AREA
30637 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
30638 cr
.height
= row
->height
;
30639 return x_intersect_rectangles (&cr
, r
, &result
);
30642 cursor_glyph
= get_phys_cursor_glyph (w
);
30645 /* r is relative to W's box, but w->phys_cursor.x is relative
30646 to left edge of W's TEXT area. Adjust it. */
30647 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
30648 cr
.y
= w
->phys_cursor
.y
;
30649 cr
.width
= cursor_glyph
->pixel_width
;
30650 cr
.height
= w
->phys_cursor_height
;
30651 /* ++KFS: W32 version used W32-specific IntersectRect here, but
30652 I assume the effect is the same -- and this is portable. */
30653 return x_intersect_rectangles (&cr
, r
, &result
);
30655 /* If we don't understand the format, pretend we're not in the hot-spot. */
30661 Draw a vertical window border to the right of window W if W doesn't
30662 have vertical scroll bars. */
30665 x_draw_vertical_border (struct window
*w
)
30667 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30669 /* We could do better, if we knew what type of scroll-bar the adjacent
30670 windows (on either side) have... But we don't :-(
30671 However, I think this works ok. ++KFS 2003-04-25 */
30673 /* Redraw borders between horizontally adjacent windows. Don't
30674 do it for frames with vertical scroll bars because either the
30675 right scroll bar of a window, or the left scroll bar of its
30676 neighbor will suffice as a border. */
30677 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
30680 /* Note: It is necessary to redraw both the left and the right
30681 borders, for when only this single window W is being
30683 if (!WINDOW_RIGHTMOST_P (w
)
30684 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
30686 int x0
, x1
, y0
, y1
;
30688 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30691 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30694 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
30697 if (!WINDOW_LEFTMOST_P (w
)
30698 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
30700 int x0
, x1
, y0
, y1
;
30702 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30705 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30708 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
30713 /* Draw window dividers for window W. */
30716 x_draw_right_divider (struct window
*w
)
30718 struct frame
*f
= WINDOW_XFRAME (w
);
30720 if (w
->mini
|| w
->pseudo_window_p
)
30722 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30724 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
30725 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30726 int y0
= WINDOW_TOP_EDGE_Y (w
);
30727 /* The bottom divider prevails. */
30728 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30730 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30735 x_draw_bottom_divider (struct window
*w
)
30737 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30739 if (w
->mini
|| w
->pseudo_window_p
)
30741 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30743 int x0
= WINDOW_LEFT_EDGE_X (w
);
30744 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30745 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30746 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
30748 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30752 /* Redraw the part of window W intersection rectangle FR. Pixel
30753 coordinates in FR are frame-relative. Call this function with
30754 input blocked. Value is true if the exposure overwrites
30758 expose_window (struct window
*w
, XRectangle
*fr
)
30760 struct frame
*f
= XFRAME (w
->frame
);
30762 bool mouse_face_overwritten_p
= false;
30764 /* If window is not yet fully initialized, do nothing. This can
30765 happen when toolkit scroll bars are used and a window is split.
30766 Reconfiguring the scroll bar will generate an expose for a newly
30768 if (w
->current_matrix
== NULL
)
30771 /* When we're currently updating the window, display and current
30772 matrix usually don't agree. Arrange for a thorough display
30774 if (w
->must_be_updated_p
)
30776 SET_FRAME_GARBAGED (f
);
30780 /* Frame-relative pixel rectangle of W. */
30781 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
30782 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
30783 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
30784 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
30786 if (x_intersect_rectangles (fr
, &wr
, &r
))
30788 int yb
= window_text_bottom_y (w
);
30789 struct glyph_row
*row
;
30790 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
30792 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
30793 r
.x
, r
.y
, r
.width
, r
.height
));
30795 /* Convert to window coordinates. */
30796 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
30797 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
30799 /* Turn off the cursor. */
30800 bool cursor_cleared_p
= (!w
->pseudo_window_p
30801 && phys_cursor_in_rect_p (w
, &r
));
30802 if (cursor_cleared_p
)
30803 x_clear_cursor (w
);
30805 /* If the row containing the cursor extends face to end of line,
30806 then expose_area might overwrite the cursor outside the
30807 rectangle and thus notice_overwritten_cursor might clear
30808 w->phys_cursor_on_p. We remember the original value and
30809 check later if it is changed. */
30810 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
30812 /* Use a signed int intermediate value to avoid catastrophic
30813 failures due to comparison between signed and unsigned, when
30814 y0 or y1 is negative (can happen for tall images). */
30815 int r_bottom
= r
.y
+ r
.height
;
30817 /* Update lines intersecting rectangle R. */
30818 first_overlapping_row
= last_overlapping_row
= NULL
;
30819 for (row
= w
->current_matrix
->rows
;
30824 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
30826 if ((y0
>= r
.y
&& y0
< r_bottom
)
30827 || (y1
> r
.y
&& y1
< r_bottom
)
30828 || (r
.y
>= y0
&& r
.y
< y1
)
30829 || (r_bottom
> y0
&& r_bottom
< y1
))
30831 /* A header line may be overlapping, but there is no need
30832 to fix overlapping areas for them. KFS 2005-02-12 */
30833 if (row
->overlapping_p
&& !row
->mode_line_p
)
30835 if (first_overlapping_row
== NULL
)
30836 first_overlapping_row
= row
;
30837 last_overlapping_row
= row
;
30841 if (expose_line (w
, row
, &r
))
30842 mouse_face_overwritten_p
= true;
30845 else if (row
->overlapping_p
)
30847 /* We must redraw a row overlapping the exposed area. */
30849 ? y0
+ row
->phys_height
> r
.y
30850 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30852 if (first_overlapping_row
== NULL
)
30853 first_overlapping_row
= row
;
30854 last_overlapping_row
= row
;
30862 /* Display the mode line if there is one. */
30863 if (WINDOW_WANTS_MODELINE_P (w
)
30864 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30866 && row
->y
< r_bottom
)
30868 if (expose_line (w
, row
, &r
))
30869 mouse_face_overwritten_p
= true;
30872 if (!w
->pseudo_window_p
)
30874 /* Fix the display of overlapping rows. */
30875 if (first_overlapping_row
)
30876 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30879 /* Draw border between windows. */
30880 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30881 x_draw_right_divider (w
);
30883 x_draw_vertical_border (w
);
30885 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30886 x_draw_bottom_divider (w
);
30888 /* Turn the cursor on again. */
30889 if (cursor_cleared_p
30890 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30891 update_window_cursor (w
, true);
30895 return mouse_face_overwritten_p
;
30900 /* Redraw (parts) of all windows in the window tree rooted at W that
30901 intersect R. R contains frame pixel coordinates. Value is
30902 true if the exposure overwrites mouse-face. */
30905 expose_window_tree (struct window
*w
, XRectangle
*r
)
30907 struct frame
*f
= XFRAME (w
->frame
);
30908 bool mouse_face_overwritten_p
= false;
30910 while (w
&& !FRAME_GARBAGED_P (f
))
30912 mouse_face_overwritten_p
30913 |= (WINDOWP (w
->contents
)
30914 ? expose_window_tree (XWINDOW (w
->contents
), r
)
30915 : expose_window (w
, r
));
30917 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
30920 return mouse_face_overwritten_p
;
30925 Redisplay an exposed area of frame F. X and Y are the upper-left
30926 corner of the exposed rectangle. W and H are width and height of
30927 the exposed area. All are pixel values. W or H zero means redraw
30928 the entire frame. */
30931 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
30934 bool mouse_face_overwritten_p
= false;
30936 TRACE ((stderr
, "expose_frame "));
30938 /* No need to redraw if frame will be redrawn soon. */
30939 if (FRAME_GARBAGED_P (f
))
30941 TRACE ((stderr
, " garbaged\n"));
30945 /* If basic faces haven't been realized yet, there is no point in
30946 trying to redraw anything. This can happen when we get an expose
30947 event while Emacs is starting, e.g. by moving another window. */
30948 if (FRAME_FACE_CACHE (f
) == NULL
30949 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
30951 TRACE ((stderr
, " no faces\n"));
30955 if (w
== 0 || h
== 0)
30958 r
.width
= FRAME_TEXT_WIDTH (f
);
30959 r
.height
= FRAME_TEXT_HEIGHT (f
);
30969 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
30970 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
30972 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30973 if (WINDOWP (f
->tool_bar_window
))
30974 mouse_face_overwritten_p
30975 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
30978 #ifdef HAVE_X_WINDOWS
30980 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30981 if (WINDOWP (f
->menu_bar_window
))
30982 mouse_face_overwritten_p
30983 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
30984 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30988 /* Some window managers support a focus-follows-mouse style with
30989 delayed raising of frames. Imagine a partially obscured frame,
30990 and moving the mouse into partially obscured mouse-face on that
30991 frame. The visible part of the mouse-face will be highlighted,
30992 then the WM raises the obscured frame. With at least one WM, KDE
30993 2.1, Emacs is not getting any event for the raising of the frame
30994 (even tried with SubstructureRedirectMask), only Expose events.
30995 These expose events will draw text normally, i.e. not
30996 highlighted. Which means we must redo the highlight here.
30997 Subsume it under ``we love X''. --gerd 2001-08-15 */
30998 /* Included in Windows version because Windows most likely does not
30999 do the right thing if any third party tool offers
31000 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
31001 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
31003 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
31004 if (f
== hlinfo
->mouse_face_mouse_frame
)
31006 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
31007 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
31008 clear_mouse_face (hlinfo
);
31009 note_mouse_highlight (f
, mouse_x
, mouse_y
);
31016 Determine the intersection of two rectangles R1 and R2. Return
31017 the intersection in *RESULT. Value is true if RESULT is not
31021 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
31023 XRectangle
*left
, *right
;
31024 XRectangle
*upper
, *lower
;
31025 bool intersection_p
= false;
31027 /* Rearrange so that R1 is the left-most rectangle. */
31029 left
= r1
, right
= r2
;
31031 left
= r2
, right
= r1
;
31033 /* X0 of the intersection is right.x0, if this is inside R1,
31034 otherwise there is no intersection. */
31035 if (right
->x
<= left
->x
+ left
->width
)
31037 result
->x
= right
->x
;
31039 /* The right end of the intersection is the minimum of
31040 the right ends of left and right. */
31041 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
31044 /* Same game for Y. */
31046 upper
= r1
, lower
= r2
;
31048 upper
= r2
, lower
= r1
;
31050 /* The upper end of the intersection is lower.y0, if this is inside
31051 of upper. Otherwise, there is no intersection. */
31052 if (lower
->y
<= upper
->y
+ upper
->height
)
31054 result
->y
= lower
->y
;
31056 /* The lower end of the intersection is the minimum of the lower
31057 ends of upper and lower. */
31058 result
->height
= (min (lower
->y
+ lower
->height
,
31059 upper
->y
+ upper
->height
)
31061 intersection_p
= true;
31065 return intersection_p
;
31068 #endif /* HAVE_WINDOW_SYSTEM */
31071 /***********************************************************************
31073 ***********************************************************************/
31076 syms_of_xdisp (void)
31078 Vwith_echo_area_save_vector
= Qnil
;
31079 staticpro (&Vwith_echo_area_save_vector
);
31081 Vmessage_stack
= Qnil
;
31082 staticpro (&Vmessage_stack
);
31084 /* Non-nil means don't actually do any redisplay. */
31085 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
31087 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
31089 DEFVAR_BOOL("inhibit-message", inhibit_message
,
31090 doc
: /* Non-nil means calls to `message' are not displayed.
31091 They are still logged to the *Messages* buffer. */);
31092 inhibit_message
= 0;
31094 message_dolog_marker1
= Fmake_marker ();
31095 staticpro (&message_dolog_marker1
);
31096 message_dolog_marker2
= Fmake_marker ();
31097 staticpro (&message_dolog_marker2
);
31098 message_dolog_marker3
= Fmake_marker ();
31099 staticpro (&message_dolog_marker3
);
31102 defsubr (&Sdump_frame_glyph_matrix
);
31103 defsubr (&Sdump_glyph_matrix
);
31104 defsubr (&Sdump_glyph_row
);
31105 defsubr (&Sdump_tool_bar_row
);
31106 defsubr (&Strace_redisplay
);
31107 defsubr (&Strace_to_stderr
);
31109 #ifdef HAVE_WINDOW_SYSTEM
31110 defsubr (&Stool_bar_height
);
31111 defsubr (&Slookup_image_map
);
31113 defsubr (&Sline_pixel_height
);
31114 defsubr (&Sformat_mode_line
);
31115 defsubr (&Sinvisible_p
);
31116 defsubr (&Scurrent_bidi_paragraph_direction
);
31117 defsubr (&Swindow_text_pixel_size
);
31118 defsubr (&Smove_point_visually
);
31119 defsubr (&Sbidi_find_overridden_directionality
);
31121 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
31122 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
31123 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
31124 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
31125 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
31126 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
31127 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
31128 DEFSYM (Qeval
, "eval");
31129 DEFSYM (QCdata
, ":data");
31131 /* Names of text properties relevant for redisplay. */
31132 DEFSYM (Qdisplay
, "display");
31133 DEFSYM (Qspace_width
, "space-width");
31134 DEFSYM (Qraise
, "raise");
31135 DEFSYM (Qslice
, "slice");
31136 DEFSYM (Qspace
, "space");
31137 DEFSYM (Qmargin
, "margin");
31138 DEFSYM (Qpointer
, "pointer");
31139 DEFSYM (Qleft_margin
, "left-margin");
31140 DEFSYM (Qright_margin
, "right-margin");
31141 DEFSYM (Qcenter
, "center");
31142 DEFSYM (Qline_height
, "line-height");
31143 DEFSYM (QCalign_to
, ":align-to");
31144 DEFSYM (QCrelative_width
, ":relative-width");
31145 DEFSYM (QCrelative_height
, ":relative-height");
31146 DEFSYM (QCeval
, ":eval");
31147 DEFSYM (QCpropertize
, ":propertize");
31148 DEFSYM (QCfile
, ":file");
31149 DEFSYM (Qfontified
, "fontified");
31150 DEFSYM (Qfontification_functions
, "fontification-functions");
31152 /* Name of the face used to highlight trailing whitespace. */
31153 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
31155 /* Name and number of the face used to highlight escape glyphs. */
31156 DEFSYM (Qescape_glyph
, "escape-glyph");
31158 /* Name and number of the face used to highlight non-breaking spaces. */
31159 DEFSYM (Qnobreak_space
, "nobreak-space");
31161 /* The symbol 'image' which is the car of the lists used to represent
31162 images in Lisp. Also a tool bar style. */
31163 DEFSYM (Qimage
, "image");
31165 /* Tool bar styles. */
31166 DEFSYM (Qtext
, "text");
31167 DEFSYM (Qboth
, "both");
31168 DEFSYM (Qboth_horiz
, "both-horiz");
31169 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
31171 /* The image map types. */
31172 DEFSYM (QCmap
, ":map");
31173 DEFSYM (QCpointer
, ":pointer");
31174 DEFSYM (Qrect
, "rect");
31175 DEFSYM (Qcircle
, "circle");
31176 DEFSYM (Qpoly
, "poly");
31178 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
31180 DEFSYM (Qgrow_only
, "grow-only");
31181 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
31182 DEFSYM (Qposition
, "position");
31183 DEFSYM (Qbuffer_position
, "buffer-position");
31184 DEFSYM (Qobject
, "object");
31186 /* Cursor shapes. */
31187 DEFSYM (Qbar
, "bar");
31188 DEFSYM (Qhbar
, "hbar");
31189 DEFSYM (Qbox
, "box");
31190 DEFSYM (Qhollow
, "hollow");
31192 /* Pointer shapes. */
31193 DEFSYM (Qhand
, "hand");
31194 DEFSYM (Qarrow
, "arrow");
31197 DEFSYM (Qdragging
, "dragging");
31199 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
31201 list_of_error
= list1 (list2 (Qerror
, Qvoid_variable
));
31202 staticpro (&list_of_error
);
31204 /* Values of those variables at last redisplay are stored as
31205 properties on 'overlay-arrow-position' symbol. However, if
31206 Voverlay_arrow_position is a marker, last-arrow-position is its
31207 numerical position. */
31208 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
31209 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
31211 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
31212 properties on a symbol in overlay-arrow-variable-list. */
31213 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
31214 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
31216 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
31217 staticpro (&echo_buffer
[0]);
31218 staticpro (&echo_buffer
[1]);
31220 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
31221 staticpro (&echo_area_buffer
[0]);
31222 staticpro (&echo_area_buffer
[1]);
31224 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
31225 staticpro (&Vmessages_buffer_name
);
31227 mode_line_proptrans_alist
= Qnil
;
31228 staticpro (&mode_line_proptrans_alist
);
31229 mode_line_string_list
= Qnil
;
31230 staticpro (&mode_line_string_list
);
31231 mode_line_string_face
= Qnil
;
31232 staticpro (&mode_line_string_face
);
31233 mode_line_string_face_prop
= Qnil
;
31234 staticpro (&mode_line_string_face_prop
);
31235 Vmode_line_unwind_vector
= Qnil
;
31236 staticpro (&Vmode_line_unwind_vector
);
31238 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
31240 help_echo_string
= Qnil
;
31241 staticpro (&help_echo_string
);
31242 help_echo_object
= Qnil
;
31243 staticpro (&help_echo_object
);
31244 help_echo_window
= Qnil
;
31245 staticpro (&help_echo_window
);
31246 previous_help_echo_string
= Qnil
;
31247 staticpro (&previous_help_echo_string
);
31248 help_echo_pos
= -1;
31250 DEFSYM (Qright_to_left
, "right-to-left");
31251 DEFSYM (Qleft_to_right
, "left-to-right");
31252 defsubr (&Sbidi_resolved_levels
);
31254 #ifdef HAVE_WINDOW_SYSTEM
31255 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
31256 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
31257 For example, if a block cursor is over a tab, it will be drawn as
31258 wide as that tab on the display. */);
31259 x_stretch_cursor_p
= 0;
31262 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
31263 doc
: /* Non-nil means highlight trailing whitespace.
31264 The face used for trailing whitespace is `trailing-whitespace'. */);
31265 Vshow_trailing_whitespace
= Qnil
;
31267 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
31268 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
31269 If the value is t, Emacs highlights non-ASCII chars which have the
31270 same appearance as an ASCII space or hyphen, using the `nobreak-space'
31271 or `escape-glyph' face respectively.
31273 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
31274 U+2011 (non-breaking hyphen) are affected.
31276 Any other non-nil value means to display these characters as a escape
31277 glyph followed by an ordinary space or hyphen.
31279 A value of nil means no special handling of these characters. */);
31280 Vnobreak_char_display
= Qt
;
31282 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
31283 doc
: /* The pointer shape to show in void text areas.
31284 A value of nil means to show the text pointer. Other options are
31285 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
31287 Vvoid_text_area_pointer
= Qarrow
;
31289 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
31290 doc
: /* Non-nil means don't actually do any redisplay.
31291 This is used for internal purposes. */);
31292 Vinhibit_redisplay
= Qnil
;
31294 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
31295 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
31296 Vglobal_mode_string
= Qnil
;
31298 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
31299 doc
: /* Marker for where to display an arrow on top of the buffer text.
31300 This must be the beginning of a line in order to work.
31301 See also `overlay-arrow-string'. */);
31302 Voverlay_arrow_position
= Qnil
;
31304 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
31305 doc
: /* String to display as an arrow in non-window frames.
31306 See also `overlay-arrow-position'. */);
31307 Voverlay_arrow_string
= build_pure_c_string ("=>");
31309 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
31310 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
31311 The symbols on this list are examined during redisplay to determine
31312 where to display overlay arrows. */);
31313 Voverlay_arrow_variable_list
31314 = list1 (intern_c_string ("overlay-arrow-position"));
31316 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
31317 doc
: /* The number of lines to try scrolling a window by when point moves out.
31318 If that fails to bring point back on frame, point is centered instead.
31319 If this is zero, point is always centered after it moves off frame.
31320 If you want scrolling to always be a line at a time, you should set
31321 `scroll-conservatively' to a large value rather than set this to 1. */);
31323 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
31324 doc
: /* Scroll up to this many lines, to bring point back on screen.
31325 If point moves off-screen, redisplay will scroll by up to
31326 `scroll-conservatively' lines in order to bring point just barely
31327 onto the screen again. If that cannot be done, then redisplay
31328 recenters point as usual.
31330 If the value is greater than 100, redisplay will never recenter point,
31331 but will always scroll just enough text to bring point into view, even
31332 if you move far away.
31334 A value of zero means always recenter point if it moves off screen. */);
31335 scroll_conservatively
= 0;
31337 DEFVAR_INT ("scroll-margin", scroll_margin
,
31338 doc
: /* Number of lines of margin at the top and bottom of a window.
31339 Recenter the window whenever point gets within this many lines
31340 of the top or bottom of the window. */);
31343 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
31344 doc
: /* Pixels per inch value for non-window system displays.
31345 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
31346 Vdisplay_pixels_per_inch
= make_float (72.0);
31349 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
31352 DEFVAR_LISP ("truncate-partial-width-windows",
31353 Vtruncate_partial_width_windows
,
31354 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
31355 For an integer value, truncate lines in each window narrower than the
31356 full frame width, provided the window width is less than that integer;
31357 otherwise, respect the value of `truncate-lines'.
31359 For any other non-nil value, truncate lines in all windows that do
31360 not span the full frame width.
31362 A value of nil means to respect the value of `truncate-lines'.
31364 If `word-wrap' is enabled, you might want to reduce this. */);
31365 Vtruncate_partial_width_windows
= make_number (50);
31367 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
31368 doc
: /* Maximum buffer size for which line number should be displayed.
31369 If the buffer is bigger than this, the line number does not appear
31370 in the mode line. A value of nil means no limit. */);
31371 Vline_number_display_limit
= Qnil
;
31373 DEFVAR_INT ("line-number-display-limit-width",
31374 line_number_display_limit_width
,
31375 doc
: /* Maximum line width (in characters) for line number display.
31376 If the average length of the lines near point is bigger than this, then the
31377 line number may be omitted from the mode line. */);
31378 line_number_display_limit_width
= 200;
31380 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
31381 doc
: /* Non-nil means highlight region even in nonselected windows. */);
31382 highlight_nonselected_windows
= false;
31384 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
31385 doc
: /* Non-nil if more than one frame is visible on this display.
31386 Minibuffer-only frames don't count, but iconified frames do.
31387 This variable is not guaranteed to be accurate except while processing
31388 `frame-title-format' and `icon-title-format'. */);
31390 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
31391 doc
: /* Template for displaying the title bar of visible frames.
31392 (Assuming the window manager supports this feature.)
31394 This variable has the same structure as `mode-line-format', except that
31395 the %c and %l constructs are ignored. It is used only on frames for
31396 which no explicit name has been set (see `modify-frame-parameters'). */);
31398 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
31399 doc
: /* Template for displaying the title bar of an iconified frame.
31400 (Assuming the window manager supports this feature.)
31401 This variable has the same structure as `mode-line-format' (which see),
31402 and is used only on frames for which no explicit name has been set
31403 (see `modify-frame-parameters'). */);
31405 = Vframe_title_format
31406 = listn (CONSTYPE_PURE
, 3,
31407 intern_c_string ("multiple-frames"),
31408 build_pure_c_string ("%b"),
31409 listn (CONSTYPE_PURE
, 4,
31410 empty_unibyte_string
,
31411 intern_c_string ("invocation-name"),
31412 build_pure_c_string ("@"),
31413 intern_c_string ("system-name")));
31415 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
31416 doc
: /* Maximum number of lines to keep in the message log buffer.
31417 If nil, disable message logging. If t, log messages but don't truncate
31418 the buffer when it becomes large. */);
31419 Vmessage_log_max
= make_number (1000);
31421 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
31422 doc
: /* List of functions to call before redisplaying a window with scrolling.
31423 Each function is called with two arguments, the window and its new
31424 display-start position.
31425 These functions are called whenever the `window-start' marker is modified,
31426 either to point into another buffer (e.g. via `set-window-buffer') or another
31427 place in the same buffer.
31428 Note that the value of `window-end' is not valid when these functions are
31431 Warning: Do not use this feature to alter the way the window
31432 is scrolled. It is not designed for that, and such use probably won't
31434 Vwindow_scroll_functions
= Qnil
;
31436 DEFVAR_LISP ("window-text-change-functions",
31437 Vwindow_text_change_functions
,
31438 doc
: /* Functions to call in redisplay when text in the window might change. */);
31439 Vwindow_text_change_functions
= Qnil
;
31441 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
31442 doc
: /* Functions called when redisplay of a window reaches the end trigger.
31443 Each function is called with two arguments, the window and the end trigger value.
31444 See `set-window-redisplay-end-trigger'. */);
31445 Vredisplay_end_trigger_functions
= Qnil
;
31447 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
31448 doc
: /* Non-nil means autoselect window with mouse pointer.
31449 If nil, do not autoselect windows.
31450 A positive number means delay autoselection by that many seconds: a
31451 window is autoselected only after the mouse has remained in that
31452 window for the duration of the delay.
31453 A negative number has a similar effect, but causes windows to be
31454 autoselected only after the mouse has stopped moving. (Because of
31455 the way Emacs compares mouse events, you will occasionally wait twice
31456 that time before the window gets selected.)
31457 Any other value means to autoselect window instantaneously when the
31458 mouse pointer enters it.
31460 Autoselection selects the minibuffer only if it is active, and never
31461 unselects the minibuffer if it is active.
31463 When customizing this variable make sure that the actual value of
31464 `focus-follows-mouse' matches the behavior of your window manager. */);
31465 Vmouse_autoselect_window
= Qnil
;
31467 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
31468 doc
: /* Non-nil means automatically resize tool-bars.
31469 This dynamically changes the tool-bar's height to the minimum height
31470 that is needed to make all tool-bar items visible.
31471 If value is `grow-only', the tool-bar's height is only increased
31472 automatically; to decrease the tool-bar height, use \\[recenter]. */);
31473 Vauto_resize_tool_bars
= Qt
;
31475 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
31476 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
31477 auto_raise_tool_bar_buttons_p
= true;
31479 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
31480 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
31481 make_cursor_line_fully_visible_p
= true;
31483 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
31484 doc
: /* Border below tool-bar in pixels.
31485 If an integer, use it as the height of the border.
31486 If it is one of `internal-border-width' or `border-width', use the
31487 value of the corresponding frame parameter.
31488 Otherwise, no border is added below the tool-bar. */);
31489 Vtool_bar_border
= Qinternal_border_width
;
31491 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
31492 doc
: /* Margin around tool-bar buttons in pixels.
31493 If an integer, use that for both horizontal and vertical margins.
31494 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
31495 HORZ specifying the horizontal margin, and VERT specifying the
31496 vertical margin. */);
31497 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
31499 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
31500 doc
: /* Relief thickness of tool-bar buttons. */);
31501 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
31503 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
31504 doc
: /* Tool bar style to use.
31506 image - show images only
31507 text - show text only
31508 both - show both, text below image
31509 both-horiz - show text to the right of the image
31510 text-image-horiz - show text to the left of the image
31511 any other - use system default or image if no system default.
31513 This variable only affects the GTK+ toolkit version of Emacs. */);
31514 Vtool_bar_style
= Qnil
;
31516 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
31517 doc
: /* Maximum number of characters a label can have to be shown.
31518 The tool bar style must also show labels for this to have any effect, see
31519 `tool-bar-style'. */);
31520 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
31522 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
31523 doc
: /* List of functions to call to fontify regions of text.
31524 Each function is called with one argument POS. Functions must
31525 fontify a region starting at POS in the current buffer, and give
31526 fontified regions the property `fontified'. */);
31527 Vfontification_functions
= Qnil
;
31528 Fmake_variable_buffer_local (Qfontification_functions
);
31530 DEFVAR_BOOL ("unibyte-display-via-language-environment",
31531 unibyte_display_via_language_environment
,
31532 doc
: /* Non-nil means display unibyte text according to language environment.
31533 Specifically, this means that raw bytes in the range 160-255 decimal
31534 are displayed by converting them to the equivalent multibyte characters
31535 according to the current language environment. As a result, they are
31536 displayed according to the current fontset.
31538 Note that this variable affects only how these bytes are displayed,
31539 but does not change the fact they are interpreted as raw bytes. */);
31540 unibyte_display_via_language_environment
= false;
31542 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
31543 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
31544 If a float, it specifies a fraction of the mini-window frame's height.
31545 If an integer, it specifies a number of lines. */);
31546 Vmax_mini_window_height
= make_float (0.25);
31548 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
31549 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
31550 A value of nil means don't automatically resize mini-windows.
31551 A value of t means resize them to fit the text displayed in them.
31552 A value of `grow-only', the default, means let mini-windows grow only;
31553 they return to their normal size when the minibuffer is closed, or the
31554 echo area becomes empty. */);
31555 Vresize_mini_windows
= Qgrow_only
;
31557 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
31558 doc
: /* Alist specifying how to blink the cursor off.
31559 Each element has the form (ON-STATE . OFF-STATE). Whenever the
31560 `cursor-type' frame-parameter or variable equals ON-STATE,
31561 comparing using `equal', Emacs uses OFF-STATE to specify
31562 how to blink it off. ON-STATE and OFF-STATE are values for
31563 the `cursor-type' frame parameter.
31565 If a frame's ON-STATE has no entry in this list,
31566 the frame's other specifications determine how to blink the cursor off. */);
31567 Vblink_cursor_alist
= Qnil
;
31569 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
31570 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
31571 If non-nil, windows are automatically scrolled horizontally to make
31572 point visible. */);
31573 automatic_hscrolling_p
= true;
31574 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
31576 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
31577 doc
: /* How many columns away from the window edge point is allowed to get
31578 before automatic hscrolling will horizontally scroll the window. */);
31579 hscroll_margin
= 5;
31581 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
31582 doc
: /* How many columns to scroll the window when point gets too close to the edge.
31583 When point is less than `hscroll-margin' columns from the window
31584 edge, automatic hscrolling will scroll the window by the amount of columns
31585 determined by this variable. If its value is a positive integer, scroll that
31586 many columns. If it's a positive floating-point number, it specifies the
31587 fraction of the window's width to scroll. If it's nil or zero, point will be
31588 centered horizontally after the scroll. Any other value, including negative
31589 numbers, are treated as if the value were zero.
31591 Automatic hscrolling always moves point outside the scroll margin, so if
31592 point was more than scroll step columns inside the margin, the window will
31593 scroll more than the value given by the scroll step.
31595 Note that the lower bound for automatic hscrolling specified by `scroll-left'
31596 and `scroll-right' overrides this variable's effect. */);
31597 Vhscroll_step
= make_number (0);
31599 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
31600 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
31601 Bind this around calls to `message' to let it take effect. */);
31602 message_truncate_lines
= false;
31604 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
31605 doc
: /* Normal hook run to update the menu bar definitions.
31606 Redisplay runs this hook before it redisplays the menu bar.
31607 This is used to update menus such as Buffers, whose contents depend on
31609 Vmenu_bar_update_hook
= Qnil
;
31611 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
31612 doc
: /* Frame for which we are updating a menu.
31613 The enable predicate for a menu binding should check this variable. */);
31614 Vmenu_updating_frame
= Qnil
;
31616 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
31617 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
31618 inhibit_menubar_update
= false;
31620 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
31621 doc
: /* Prefix prepended to all continuation lines at display time.
31622 The value may be a string, an image, or a stretch-glyph; it is
31623 interpreted in the same way as the value of a `display' text property.
31625 This variable is overridden by any `wrap-prefix' text or overlay
31628 To add a prefix to non-continuation lines, use `line-prefix'. */);
31629 Vwrap_prefix
= Qnil
;
31630 DEFSYM (Qwrap_prefix
, "wrap-prefix");
31631 Fmake_variable_buffer_local (Qwrap_prefix
);
31633 DEFVAR_LISP ("line-prefix", Vline_prefix
,
31634 doc
: /* Prefix prepended to all non-continuation lines at display time.
31635 The value may be a string, an image, or a stretch-glyph; it is
31636 interpreted in the same way as the value of a `display' text property.
31638 This variable is overridden by any `line-prefix' text or overlay
31641 To add a prefix to continuation lines, use `wrap-prefix'. */);
31642 Vline_prefix
= Qnil
;
31643 DEFSYM (Qline_prefix
, "line-prefix");
31644 Fmake_variable_buffer_local (Qline_prefix
);
31646 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
31647 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
31648 inhibit_eval_during_redisplay
= false;
31650 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
31651 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
31652 inhibit_free_realized_faces
= false;
31654 DEFVAR_BOOL ("inhibit-bidi-mirroring", inhibit_bidi_mirroring
,
31655 doc
: /* Non-nil means don't mirror characters even when bidi context requires that.
31656 Intended for use during debugging and for testing bidi display;
31657 see biditest.el in the test suite. */);
31658 inhibit_bidi_mirroring
= false;
31661 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
31662 doc
: /* Inhibit try_window_id display optimization. */);
31663 inhibit_try_window_id
= false;
31665 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
31666 doc
: /* Inhibit try_window_reusing display optimization. */);
31667 inhibit_try_window_reusing
= false;
31669 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
31670 doc
: /* Inhibit try_cursor_movement display optimization. */);
31671 inhibit_try_cursor_movement
= false;
31672 #endif /* GLYPH_DEBUG */
31674 DEFVAR_INT ("overline-margin", overline_margin
,
31675 doc
: /* Space between overline and text, in pixels.
31676 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
31677 margin to the character height. */);
31678 overline_margin
= 2;
31680 DEFVAR_INT ("underline-minimum-offset",
31681 underline_minimum_offset
,
31682 doc
: /* Minimum distance between baseline and underline.
31683 This can improve legibility of underlined text at small font sizes,
31684 particularly when using variable `x-use-underline-position-properties'
31685 with fonts that specify an UNDERLINE_POSITION relatively close to the
31686 baseline. The default value is 1. */);
31687 underline_minimum_offset
= 1;
31689 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
31690 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
31691 This feature only works when on a window system that can change
31692 cursor shapes. */);
31693 display_hourglass_p
= true;
31695 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
31696 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
31697 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
31699 #ifdef HAVE_WINDOW_SYSTEM
31700 hourglass_atimer
= NULL
;
31701 hourglass_shown_p
= false;
31702 #endif /* HAVE_WINDOW_SYSTEM */
31704 /* Name of the face used to display glyphless characters. */
31705 DEFSYM (Qglyphless_char
, "glyphless-char");
31707 /* Method symbols for Vglyphless_char_display. */
31708 DEFSYM (Qhex_code
, "hex-code");
31709 DEFSYM (Qempty_box
, "empty-box");
31710 DEFSYM (Qthin_space
, "thin-space");
31711 DEFSYM (Qzero_width
, "zero-width");
31713 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
31714 doc
: /* Function run just before redisplay.
31715 It is called with one argument, which is the set of windows that are to
31716 be redisplayed. This set can be nil (meaning, only the selected window),
31717 or t (meaning all windows). */);
31718 Vpre_redisplay_function
= intern ("ignore");
31720 /* Symbol for the purpose of Vglyphless_char_display. */
31721 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
31722 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
31724 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
31725 doc
: /* Char-table defining glyphless characters.
31726 Each element, if non-nil, should be one of the following:
31727 an ASCII acronym string: display this string in a box
31728 `hex-code': display the hexadecimal code of a character in a box
31729 `empty-box': display as an empty box
31730 `thin-space': display as 1-pixel width space
31731 `zero-width': don't display
31732 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
31733 display method for graphical terminals and text terminals respectively.
31734 GRAPHICAL and TEXT should each have one of the values listed above.
31736 The char-table has one extra slot to control the display of a character for
31737 which no font is found. This slot only takes effect on graphical terminals.
31738 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
31739 `thin-space'. The default is `empty-box'.
31741 If a character has a non-nil entry in an active display table, the
31742 display table takes effect; in this case, Emacs does not consult
31743 `glyphless-char-display' at all. */);
31744 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
31745 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
31748 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
31749 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
31750 Vdebug_on_message
= Qnil
;
31752 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
31754 Vredisplay__all_windows_cause
= Fmake_hash_table (0, NULL
);
31756 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
31758 Vredisplay__mode_lines_cause
= Fmake_hash_table (0, NULL
);
31760 DEFVAR_LISP ("redisplay--variables", Vredisplay__variables
,
31761 doc
: /* A hash-table of variables changing which triggers a thorough redisplay. */);
31762 Vredisplay__variables
= Qnil
;
31766 /* Initialize this module when Emacs starts. */
31771 CHARPOS (this_line_start_pos
) = 0;
31773 if (!noninteractive
)
31775 struct window
*m
= XWINDOW (minibuf_window
);
31776 Lisp_Object frame
= m
->frame
;
31777 struct frame
*f
= XFRAME (frame
);
31778 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
31779 struct window
*r
= XWINDOW (root
);
31782 echo_area_window
= minibuf_window
;
31784 r
->top_line
= FRAME_TOP_MARGIN (f
);
31785 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
31786 r
->total_cols
= FRAME_COLS (f
);
31787 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31788 r
->total_lines
= FRAME_TOTAL_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
31789 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
31791 m
->top_line
= FRAME_TOTAL_LINES (f
) - 1;
31792 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
31793 m
->total_cols
= FRAME_COLS (f
);
31794 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31795 m
->total_lines
= 1;
31796 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
31798 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
31799 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
31800 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
31802 /* The default ellipsis glyphs `...'. */
31803 for (i
= 0; i
< 3; ++i
)
31804 default_invis_vector
[i
] = make_number ('.');
31808 /* Allocate the buffer for frame titles.
31809 Also used for `format-mode-line'. */
31811 mode_line_noprop_buf
= xmalloc (size
);
31812 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
31813 mode_line_noprop_ptr
= mode_line_noprop_buf
;
31814 mode_line_target
= MODE_LINE_DISPLAY
;
31817 help_echo_showing_p
= false;
31820 #ifdef HAVE_WINDOW_SYSTEM
31822 /* Platform-independent portion of hourglass implementation. */
31824 /* Timer function of hourglass_atimer. */
31827 show_hourglass (struct atimer
*timer
)
31829 /* The timer implementation will cancel this timer automatically
31830 after this function has run. Set hourglass_atimer to null
31831 so that we know the timer doesn't have to be canceled. */
31832 hourglass_atimer
= NULL
;
31834 if (!hourglass_shown_p
)
31836 Lisp_Object tail
, frame
;
31840 FOR_EACH_FRAME (tail
, frame
)
31842 struct frame
*f
= XFRAME (frame
);
31844 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31845 && FRAME_RIF (f
)->show_hourglass
)
31846 FRAME_RIF (f
)->show_hourglass (f
);
31849 hourglass_shown_p
= true;
31854 /* Cancel a currently active hourglass timer, and start a new one. */
31857 start_hourglass (void)
31859 struct timespec delay
;
31861 cancel_hourglass ();
31863 if (INTEGERP (Vhourglass_delay
)
31864 && XINT (Vhourglass_delay
) > 0)
31865 delay
= make_timespec (min (XINT (Vhourglass_delay
),
31866 TYPE_MAXIMUM (time_t)),
31868 else if (FLOATP (Vhourglass_delay
)
31869 && XFLOAT_DATA (Vhourglass_delay
) > 0)
31870 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
31872 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
31874 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
31875 show_hourglass
, NULL
);
31878 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31882 cancel_hourglass (void)
31884 if (hourglass_atimer
)
31886 cancel_atimer (hourglass_atimer
);
31887 hourglass_atimer
= NULL
;
31890 if (hourglass_shown_p
)
31892 Lisp_Object tail
, frame
;
31896 FOR_EACH_FRAME (tail
, frame
)
31898 struct frame
*f
= XFRAME (frame
);
31900 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31901 && FRAME_RIF (f
)->hide_hourglass
)
31902 FRAME_RIF (f
)->hide_hourglass (f
);
31904 /* No cursors on non GUI frames - restore to stock arrow cursor. */
31905 else if (!FRAME_W32_P (f
))
31906 w32_arrow_cursor ();
31910 hourglass_shown_p
= false;
31915 #endif /* HAVE_WINDOW_SYSTEM */