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 is not a newline
9798 character. 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 is not a newline character.
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 do not intend to change
9805 the width of WINDOW. Use the maximum width WINDOW may assume if you
9806 intend to change WINDOW's width. In any case, text whose x-coordinate
9807 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9808 can take some time, it's always a good idea to make this argument as
9809 small as possible; in particular, if the buffer contains long lines that
9810 shall be truncated anyway.
9812 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9813 height that can be returned. Text lines whose y-coordinate is beyond
9814 Y-LIMIT are ignored. Since calculating the text height of a large
9815 buffer can take some time, it makes sense to specify this argument if
9816 the size of the buffer is unknown.
9818 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9819 include the height of the mode- or header-line of WINDOW in the return
9820 value. If it is either the symbol `mode-line' or `header-line', include
9821 only the height of that line, if present, in the return value. If t,
9822 include the height of both, if present, in the return value. */)
9823 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
,
9824 Lisp_Object y_limit
, Lisp_Object mode_and_header_line
)
9826 struct window
*w
= decode_live_window (window
);
9827 Lisp_Object buffer
= w
->contents
;
9830 struct buffer
*old_b
= NULL
;
9831 ptrdiff_t start
, end
, pos
;
9832 struct text_pos startp
;
9833 void *itdata
= NULL
;
9834 int c
, max_y
= -1, x
= 0, y
= 0;
9836 CHECK_BUFFER (buffer
);
9837 b
= XBUFFER (buffer
);
9839 if (b
!= current_buffer
)
9841 old_b
= current_buffer
;
9842 set_buffer_internal (b
);
9847 else if (EQ (from
, Qt
))
9850 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9851 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9853 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9858 CHECK_NUMBER_COERCE_MARKER (from
);
9859 start
= min (max (XINT (from
), BEGV
), ZV
);
9864 else if (EQ (to
, Qt
))
9867 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9868 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9870 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9875 CHECK_NUMBER_COERCE_MARKER (to
);
9876 end
= max (start
, min (XINT (to
), ZV
));
9879 if (!NILP (y_limit
))
9881 CHECK_NUMBER (y_limit
);
9882 max_y
= min (XINT (y_limit
), INT_MAX
);
9885 itdata
= bidi_shelve_cache ();
9886 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9887 start_display (&it
, w
, startp
);
9890 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9893 CHECK_NUMBER (x_limit
);
9894 it
.last_visible_x
= min (XINT (x_limit
), INFINITY
);
9895 /* Actually, we never want move_it_to stop at to_x. But to make
9896 sure that move_it_in_display_line_to always moves far enough,
9897 we set it to INT_MAX and specify MOVE_TO_X. */
9898 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9899 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9902 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9904 if (!EQ (mode_and_header_line
, Qheader_line
)
9905 && !EQ (mode_and_header_line
, Qt
))
9906 /* Do not count the header-line which was counted automatically by
9908 y
= y
- WINDOW_HEADER_LINE_HEIGHT (w
);
9910 if (EQ (mode_and_header_line
, Qmode_line
)
9911 || EQ (mode_and_header_line
, Qt
))
9912 /* Do count the mode-line which is not included automatically by
9914 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9916 bidi_unshelve_cache (itdata
, false);
9919 set_buffer_internal (old_b
);
9921 return Fcons (make_number (x
), make_number (y
));
9924 /***********************************************************************
9926 ***********************************************************************/
9928 /* Return the number of arguments the format string FORMAT needs. */
9931 format_nargs (char const *format
)
9933 ptrdiff_t nargs
= 0;
9934 for (char const *p
= format
; (p
= strchr (p
, '%')); p
++)
9942 /* Add a message with format string FORMAT and formatted arguments
9946 add_to_log (const char *format
, ...)
9949 va_start (ap
, format
);
9950 vadd_to_log (format
, ap
);
9955 vadd_to_log (char const *format
, va_list ap
)
9957 ptrdiff_t form_nargs
= format_nargs (format
);
9958 ptrdiff_t nargs
= 1 + form_nargs
;
9959 Lisp_Object args
[10];
9960 eassert (nargs
<= ARRAYELTS (args
));
9961 AUTO_STRING (args0
, format
);
9963 for (ptrdiff_t i
= 1; i
<= nargs
; i
++)
9964 args
[i
] = va_arg (ap
, Lisp_Object
);
9965 Lisp_Object msg
= Qnil
;
9966 msg
= Fformat_message (nargs
, args
);
9968 ptrdiff_t len
= SBYTES (msg
) + 1;
9970 char *buffer
= SAFE_ALLOCA (len
);
9971 memcpy (buffer
, SDATA (msg
), len
);
9973 message_dolog (buffer
, len
- 1, true, STRING_MULTIBYTE (msg
));
9978 /* Output a newline in the *Messages* buffer if "needs" one. */
9981 message_log_maybe_newline (void)
9983 if (message_log_need_newline
)
9984 message_dolog ("", 0, true, false);
9988 /* Add a string M of length NBYTES to the message log, optionally
9989 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9990 true, means interpret the contents of M as multibyte. This
9991 function calls low-level routines in order to bypass text property
9992 hooks, etc. which might not be safe to run.
9994 This may GC (insert may run before/after change hooks),
9995 so the buffer M must NOT point to a Lisp string. */
9998 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
10000 const unsigned char *msg
= (const unsigned char *) m
;
10002 if (!NILP (Vmemory_full
))
10005 if (!NILP (Vmessage_log_max
))
10007 struct buffer
*oldbuf
;
10008 Lisp_Object oldpoint
, oldbegv
, oldzv
;
10009 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
10010 ptrdiff_t point_at_end
= 0;
10011 ptrdiff_t zv_at_end
= 0;
10012 Lisp_Object old_deactivate_mark
;
10014 old_deactivate_mark
= Vdeactivate_mark
;
10015 oldbuf
= current_buffer
;
10017 /* Ensure the Messages buffer exists, and switch to it.
10018 If we created it, set the major-mode. */
10019 bool newbuffer
= NILP (Fget_buffer (Vmessages_buffer_name
));
10020 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
10022 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
10023 call0 (intern ("messages-buffer-mode"));
10025 bset_undo_list (current_buffer
, Qt
);
10026 bset_cache_long_scans (current_buffer
, Qnil
);
10028 oldpoint
= message_dolog_marker1
;
10029 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
10030 oldbegv
= message_dolog_marker2
;
10031 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
10032 oldzv
= message_dolog_marker3
;
10033 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
10041 BEGV_BYTE
= BEG_BYTE
;
10044 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10046 /* Insert the string--maybe converting multibyte to single byte
10047 or vice versa, so that all the text fits the buffer. */
10049 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10055 /* Convert a multibyte string to single-byte
10056 for the *Message* buffer. */
10057 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
10059 c
= string_char_and_length (msg
+ i
, &char_bytes
);
10060 work
[0] = CHAR_TO_BYTE8 (c
);
10061 insert_1_both (work
, 1, 1, true, false, false);
10064 else if (! multibyte
10065 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10069 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10070 /* Convert a single-byte string to multibyte
10071 for the *Message* buffer. */
10072 for (i
= 0; i
< nbytes
; i
++)
10075 MAKE_CHAR_MULTIBYTE (c
);
10076 char_bytes
= CHAR_STRING (c
, str
);
10077 insert_1_both ((char *) str
, 1, char_bytes
, true, false, false);
10081 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
,
10082 true, false, false);
10086 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
10089 insert_1_both ("\n", 1, 1, true, false, false);
10091 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, false);
10093 this_bol_byte
= PT_BYTE
;
10095 /* See if this line duplicates the previous one.
10096 If so, combine duplicates. */
10097 if (this_bol
> BEG
)
10099 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, false);
10101 prev_bol_byte
= PT_BYTE
;
10103 dups
= message_log_check_duplicate (prev_bol_byte
,
10107 del_range_both (prev_bol
, prev_bol_byte
,
10108 this_bol
, this_bol_byte
, false);
10111 char dupstr
[sizeof " [ times]"
10112 + INT_STRLEN_BOUND (printmax_t
)];
10114 /* If you change this format, don't forget to also
10115 change message_log_check_duplicate. */
10116 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
10117 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
10118 insert_1_both (dupstr
, duplen
, duplen
,
10119 true, false, true);
10124 /* If we have more than the desired maximum number of lines
10125 in the *Messages* buffer now, delete the oldest ones.
10126 This is safe because we don't have undo in this buffer. */
10128 if (NATNUMP (Vmessage_log_max
))
10130 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10131 -XFASTINT (Vmessage_log_max
) - 1, false);
10132 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, false);
10135 BEGV
= marker_position (oldbegv
);
10136 BEGV_BYTE
= marker_byte_position (oldbegv
);
10145 ZV
= marker_position (oldzv
);
10146 ZV_BYTE
= marker_byte_position (oldzv
);
10150 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10152 /* We can't do Fgoto_char (oldpoint) because it will run some
10154 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10155 marker_byte_position (oldpoint
));
10157 unchain_marker (XMARKER (oldpoint
));
10158 unchain_marker (XMARKER (oldbegv
));
10159 unchain_marker (XMARKER (oldzv
));
10161 /* We called insert_1_both above with its 5th argument (PREPARE)
10162 false, which prevents insert_1_both from calling
10163 prepare_to_modify_buffer, which in turns prevents us from
10164 incrementing windows_or_buffers_changed even if *Messages* is
10165 shown in some window. So we must manually set
10166 windows_or_buffers_changed here to make up for that. */
10167 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10168 bset_redisplay (current_buffer
);
10170 set_buffer_internal (oldbuf
);
10172 message_log_need_newline
= !nlflag
;
10173 Vdeactivate_mark
= old_deactivate_mark
;
10178 /* We are at the end of the buffer after just having inserted a newline.
10179 (Note: We depend on the fact we won't be crossing the gap.)
10180 Check to see if the most recent message looks a lot like the previous one.
10181 Return 0 if different, 1 if the new one should just replace it, or a
10182 value N > 1 if we should also append " [N times]". */
10185 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10188 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10189 bool seen_dots
= false;
10190 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10191 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10193 for (i
= 0; i
< len
; i
++)
10195 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10197 if (p1
[i
] != p2
[i
])
10203 if (*p1
++ == ' ' && *p1
++ == '[')
10206 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10207 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10214 /* Display an echo area message M with a specified length of NBYTES
10215 bytes. The string may include null characters. If M is not a
10216 string, clear out any existing message, and let the mini-buffer
10219 This function cancels echoing. */
10222 message3 (Lisp_Object m
)
10224 clear_message (true, true);
10227 /* First flush out any partial line written with print. */
10228 message_log_maybe_newline ();
10231 ptrdiff_t nbytes
= SBYTES (m
);
10232 bool multibyte
= STRING_MULTIBYTE (m
);
10235 SAFE_ALLOCA_STRING (buffer
, m
);
10236 message_dolog (buffer
, nbytes
, true, multibyte
);
10239 if (! inhibit_message
)
10240 message3_nolog (m
);
10243 /* Log the message M to stderr. Log an empty line if M is not a string. */
10246 message_to_stderr (Lisp_Object m
)
10248 if (noninteractive_need_newline
)
10250 noninteractive_need_newline
= false;
10251 fputc ('\n', stderr
);
10255 Lisp_Object coding_system
= Vlocale_coding_system
;
10258 if (!NILP (Vcoding_system_for_write
))
10259 coding_system
= Vcoding_system_for_write
;
10260 if (!NILP (coding_system
))
10261 s
= code_convert_string_norecord (m
, coding_system
, true);
10265 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10267 if (!cursor_in_echo_area
)
10268 fputc ('\n', stderr
);
10272 /* The non-logging version of message3.
10273 This does not cancel echoing, because it is used for echoing.
10274 Perhaps we need to make a separate function for echoing
10275 and make this cancel echoing. */
10278 message3_nolog (Lisp_Object m
)
10280 struct frame
*sf
= SELECTED_FRAME ();
10282 if (FRAME_INITIAL_P (sf
))
10283 message_to_stderr (m
);
10284 /* Error messages get reported properly by cmd_error, so this must be just an
10285 informative message; if the frame hasn't really been initialized yet, just
10287 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10289 /* Get the frame containing the mini-buffer
10290 that the selected frame is using. */
10291 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10292 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10293 struct frame
*f
= XFRAME (frame
);
10295 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10296 Fmake_frame_visible (frame
);
10298 if (STRINGP (m
) && SCHARS (m
) > 0)
10301 if (minibuffer_auto_raise
)
10302 Fraise_frame (frame
);
10303 /* Assume we are not echoing.
10304 (If we are, echo_now will override this.) */
10305 echo_message_buffer
= Qnil
;
10308 clear_message (true, true);
10310 do_pending_window_change (false);
10311 echo_area_display (true);
10312 do_pending_window_change (false);
10313 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10314 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10319 /* Display a null-terminated echo area message M. If M is 0, clear
10320 out any existing message, and let the mini-buffer text show through.
10322 The buffer M must continue to exist until after the echo area gets
10323 cleared or some other message gets displayed there. Do not pass
10324 text that is stored in a Lisp string. Do not pass text in a buffer
10325 that was alloca'd. */
10328 message1 (const char *m
)
10330 message3 (m
? build_unibyte_string (m
) : Qnil
);
10334 /* The non-logging counterpart of message1. */
10337 message1_nolog (const char *m
)
10339 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10342 /* Display a message M which contains a single %s
10343 which gets replaced with STRING. */
10346 message_with_string (const char *m
, Lisp_Object string
, bool log
)
10348 CHECK_STRING (string
);
10351 if (noninteractive
)
10352 need_message
= !!m
;
10353 else if (!INTERACTIVE
)
10354 need_message
= false;
10357 /* The frame whose minibuffer we're going to display the message on.
10358 It may be larger than the selected frame, so we need
10359 to use its buffer, not the selected frame's buffer. */
10360 Lisp_Object mini_window
;
10361 struct frame
*f
, *sf
= SELECTED_FRAME ();
10363 /* Get the frame containing the minibuffer
10364 that the selected frame is using. */
10365 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10366 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10368 /* Error messages get reported properly by cmd_error, so this must be
10369 just an informative message; if the frame hasn't really been
10370 initialized yet, just toss it. */
10371 need_message
= f
->glyphs_initialized_p
;
10376 AUTO_STRING (fmt
, m
);
10377 Lisp_Object msg
= CALLN (Fformat_message
, fmt
, string
);
10379 if (noninteractive
)
10380 message_to_stderr (msg
);
10386 message3_nolog (msg
);
10388 /* Print should start at the beginning of the message
10389 buffer next time. */
10390 message_buf_print
= false;
10396 /* Dump an informative message to the minibuf. If M is 0, clear out
10397 any existing message, and let the mini-buffer text show through.
10399 The message must be safe ASCII and the format must not contain ` or
10400 '. If your message and format do not fit into this category,
10401 convert your arguments to Lisp objects and use Fmessage instead. */
10403 static void ATTRIBUTE_FORMAT_PRINTF (1, 0)
10404 vmessage (const char *m
, va_list ap
)
10406 if (noninteractive
)
10410 if (noninteractive_need_newline
)
10411 putc ('\n', stderr
);
10412 noninteractive_need_newline
= false;
10413 vfprintf (stderr
, m
, ap
);
10414 if (!cursor_in_echo_area
)
10415 fprintf (stderr
, "\n");
10419 else if (INTERACTIVE
)
10421 /* The frame whose mini-buffer we're going to display the message
10422 on. It may be larger than the selected frame, so we need to
10423 use its buffer, not the selected frame's buffer. */
10424 Lisp_Object mini_window
;
10425 struct frame
*f
, *sf
= SELECTED_FRAME ();
10427 /* Get the frame containing the mini-buffer
10428 that the selected frame is using. */
10429 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10430 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10432 /* Error messages get reported properly by cmd_error, so this must be
10433 just an informative message; if the frame hasn't really been
10434 initialized yet, just toss it. */
10435 if (f
->glyphs_initialized_p
)
10440 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10442 char *message_buf
= SAFE_ALLOCA (maxsize
+ 1);
10444 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10446 message3 (make_string (message_buf
, len
));
10452 /* Print should start at the beginning of the message
10453 buffer next time. */
10454 message_buf_print
= false;
10460 message (const char *m
, ...)
10469 /* Display the current message in the current mini-buffer. This is
10470 only called from error handlers in process.c, and is not time
10474 update_echo_area (void)
10476 if (!NILP (echo_area_buffer
[0]))
10478 Lisp_Object string
;
10479 string
= Fcurrent_message ();
10485 /* Make sure echo area buffers in `echo_buffers' are live.
10486 If they aren't, make new ones. */
10489 ensure_echo_area_buffers (void)
10493 for (i
= 0; i
< 2; ++i
)
10494 if (!BUFFERP (echo_buffer
[i
])
10495 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10498 Lisp_Object old_buffer
;
10501 old_buffer
= echo_buffer
[i
];
10502 echo_buffer
[i
] = Fget_buffer_create
10503 (make_formatted_string (name
, " *Echo Area %d*", i
));
10504 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10505 /* to force word wrap in echo area -
10506 it was decided to postpone this*/
10507 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10509 for (j
= 0; j
< 2; ++j
)
10510 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10511 echo_area_buffer
[j
] = echo_buffer
[i
];
10516 /* Call FN with args A1..A2 with either the current or last displayed
10517 echo_area_buffer as current buffer.
10519 WHICH zero means use the current message buffer
10520 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10521 from echo_buffer[] and clear it.
10523 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10524 suitable buffer from echo_buffer[] and clear it.
10526 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10527 that the current message becomes the last displayed one, make
10528 choose a suitable buffer for echo_area_buffer[0], and clear it.
10530 Value is what FN returns. */
10533 with_echo_area_buffer (struct window
*w
, int which
,
10534 bool (*fn
) (ptrdiff_t, Lisp_Object
),
10535 ptrdiff_t a1
, Lisp_Object a2
)
10537 Lisp_Object buffer
;
10538 bool this_one
, the_other
, clear_buffer_p
, rc
;
10539 ptrdiff_t count
= SPECPDL_INDEX ();
10541 /* If buffers aren't live, make new ones. */
10542 ensure_echo_area_buffers ();
10544 clear_buffer_p
= false;
10547 this_one
= false, the_other
= true;
10548 else if (which
> 0)
10549 this_one
= true, the_other
= false;
10552 this_one
= false, the_other
= true;
10553 clear_buffer_p
= true;
10555 /* We need a fresh one in case the current echo buffer equals
10556 the one containing the last displayed echo area message. */
10557 if (!NILP (echo_area_buffer
[this_one
])
10558 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10559 echo_area_buffer
[this_one
] = Qnil
;
10562 /* Choose a suitable buffer from echo_buffer[] is we don't
10564 if (NILP (echo_area_buffer
[this_one
]))
10566 echo_area_buffer
[this_one
]
10567 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10568 ? echo_buffer
[the_other
]
10569 : echo_buffer
[this_one
]);
10570 clear_buffer_p
= true;
10573 buffer
= echo_area_buffer
[this_one
];
10575 /* Don't get confused by reusing the buffer used for echoing
10576 for a different purpose. */
10577 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10580 record_unwind_protect (unwind_with_echo_area_buffer
,
10581 with_echo_area_buffer_unwind_data (w
));
10583 /* Make the echo area buffer current. Note that for display
10584 purposes, it is not necessary that the displayed window's buffer
10585 == current_buffer, except for text property lookup. So, let's
10586 only set that buffer temporarily here without doing a full
10587 Fset_window_buffer. We must also change w->pointm, though,
10588 because otherwise an assertions in unshow_buffer fails, and Emacs
10590 set_buffer_internal_1 (XBUFFER (buffer
));
10593 wset_buffer (w
, buffer
);
10594 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10595 set_marker_both (w
->old_pointm
, buffer
, BEG
, BEG_BYTE
);
10598 bset_undo_list (current_buffer
, Qt
);
10599 bset_read_only (current_buffer
, Qnil
);
10600 specbind (Qinhibit_read_only
, Qt
);
10601 specbind (Qinhibit_modification_hooks
, Qt
);
10603 if (clear_buffer_p
&& Z
> BEG
)
10604 del_range (BEG
, Z
);
10606 eassert (BEGV
>= BEG
);
10607 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10611 eassert (BEGV
>= BEG
);
10612 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10614 unbind_to (count
, Qnil
);
10619 /* Save state that should be preserved around the call to the function
10620 FN called in with_echo_area_buffer. */
10623 with_echo_area_buffer_unwind_data (struct window
*w
)
10626 Lisp_Object vector
, tmp
;
10628 /* Reduce consing by keeping one vector in
10629 Vwith_echo_area_save_vector. */
10630 vector
= Vwith_echo_area_save_vector
;
10631 Vwith_echo_area_save_vector
= Qnil
;
10634 vector
= Fmake_vector (make_number (11), Qnil
);
10636 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10637 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10638 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10642 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10643 ASET (vector
, i
, w
->contents
); ++i
;
10644 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10645 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10646 ASET (vector
, i
, make_number (marker_position (w
->old_pointm
))); ++i
;
10647 ASET (vector
, i
, make_number (marker_byte_position (w
->old_pointm
))); ++i
;
10648 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10649 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10654 for (; i
< end
; ++i
)
10655 ASET (vector
, i
, Qnil
);
10658 eassert (i
== ASIZE (vector
));
10663 /* Restore global state from VECTOR which was created by
10664 with_echo_area_buffer_unwind_data. */
10667 unwind_with_echo_area_buffer (Lisp_Object vector
)
10669 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10670 Vdeactivate_mark
= AREF (vector
, 1);
10671 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10673 if (WINDOWP (AREF (vector
, 3)))
10676 Lisp_Object buffer
;
10678 w
= XWINDOW (AREF (vector
, 3));
10679 buffer
= AREF (vector
, 4);
10681 wset_buffer (w
, buffer
);
10682 set_marker_both (w
->pointm
, buffer
,
10683 XFASTINT (AREF (vector
, 5)),
10684 XFASTINT (AREF (vector
, 6)));
10685 set_marker_both (w
->old_pointm
, buffer
,
10686 XFASTINT (AREF (vector
, 7)),
10687 XFASTINT (AREF (vector
, 8)));
10688 set_marker_both (w
->start
, buffer
,
10689 XFASTINT (AREF (vector
, 9)),
10690 XFASTINT (AREF (vector
, 10)));
10693 Vwith_echo_area_save_vector
= vector
;
10697 /* Set up the echo area for use by print functions. MULTIBYTE_P
10698 means we will print multibyte. */
10701 setup_echo_area_for_printing (bool multibyte_p
)
10703 /* If we can't find an echo area any more, exit. */
10704 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10705 Fkill_emacs (Qnil
);
10707 ensure_echo_area_buffers ();
10709 if (!message_buf_print
)
10711 /* A message has been output since the last time we printed.
10712 Choose a fresh echo area buffer. */
10713 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10714 echo_area_buffer
[0] = echo_buffer
[1];
10716 echo_area_buffer
[0] = echo_buffer
[0];
10718 /* Switch to that buffer and clear it. */
10719 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10720 bset_truncate_lines (current_buffer
, Qnil
);
10724 ptrdiff_t count
= SPECPDL_INDEX ();
10725 specbind (Qinhibit_read_only
, Qt
);
10726 /* Note that undo recording is always disabled. */
10727 del_range (BEG
, Z
);
10728 unbind_to (count
, Qnil
);
10730 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10732 /* Set up the buffer for the multibyteness we need. */
10734 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10735 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10737 /* Raise the frame containing the echo area. */
10738 if (minibuffer_auto_raise
)
10740 struct frame
*sf
= SELECTED_FRAME ();
10741 Lisp_Object mini_window
;
10742 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10743 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10746 message_log_maybe_newline ();
10747 message_buf_print
= true;
10751 if (NILP (echo_area_buffer
[0]))
10753 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10754 echo_area_buffer
[0] = echo_buffer
[1];
10756 echo_area_buffer
[0] = echo_buffer
[0];
10759 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10761 /* Someone switched buffers between print requests. */
10762 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10763 bset_truncate_lines (current_buffer
, Qnil
);
10769 /* Display an echo area message in window W. Value is true if W's
10770 height is changed. If display_last_displayed_message_p,
10771 display the message that was last displayed, otherwise
10772 display the current message. */
10775 display_echo_area (struct window
*w
)
10777 bool no_message_p
, window_height_changed_p
;
10779 /* Temporarily disable garbage collections while displaying the echo
10780 area. This is done because a GC can print a message itself.
10781 That message would modify the echo area buffer's contents while a
10782 redisplay of the buffer is going on, and seriously confuse
10784 ptrdiff_t count
= inhibit_garbage_collection ();
10786 /* If there is no message, we must call display_echo_area_1
10787 nevertheless because it resizes the window. But we will have to
10788 reset the echo_area_buffer in question to nil at the end because
10789 with_echo_area_buffer will sets it to an empty buffer. */
10790 bool i
= display_last_displayed_message_p
;
10791 /* According to the C99, C11 and C++11 standards, the integral value
10792 of a "bool" is always 0 or 1, so this array access is safe here,
10794 no_message_p
= NILP (echo_area_buffer
[i
]);
10796 window_height_changed_p
10797 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10798 display_echo_area_1
,
10799 (intptr_t) w
, Qnil
);
10802 echo_area_buffer
[i
] = Qnil
;
10804 unbind_to (count
, Qnil
);
10805 return window_height_changed_p
;
10809 /* Helper for display_echo_area. Display the current buffer which
10810 contains the current echo area message in window W, a mini-window,
10811 a pointer to which is passed in A1. A2..A4 are currently not used.
10812 Change the height of W so that all of the message is displayed.
10813 Value is true if height of W was changed. */
10816 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10819 struct window
*w
= (struct window
*) i1
;
10820 Lisp_Object window
;
10821 struct text_pos start
;
10823 /* We are about to enter redisplay without going through
10824 redisplay_internal, so we need to forget these faces by hand
10826 forget_escape_and_glyphless_faces ();
10828 /* Do this before displaying, so that we have a large enough glyph
10829 matrix for the display. If we can't get enough space for the
10830 whole text, display the last N lines. That works by setting w->start. */
10831 bool window_height_changed_p
= resize_mini_window (w
, false);
10833 /* Use the starting position chosen by resize_mini_window. */
10834 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10837 clear_glyph_matrix (w
->desired_matrix
);
10838 XSETWINDOW (window
, w
);
10839 try_window (window
, start
, 0);
10841 return window_height_changed_p
;
10845 /* Resize the echo area window to exactly the size needed for the
10846 currently displayed message, if there is one. If a mini-buffer
10847 is active, don't shrink it. */
10850 resize_echo_area_exactly (void)
10852 if (BUFFERP (echo_area_buffer
[0])
10853 && WINDOWP (echo_area_window
))
10855 struct window
*w
= XWINDOW (echo_area_window
);
10856 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10857 bool resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10858 (intptr_t) w
, resize_exactly
);
10861 windows_or_buffers_changed
= 42;
10862 update_mode_lines
= 30;
10863 redisplay_internal ();
10869 /* Callback function for with_echo_area_buffer, when used from
10870 resize_echo_area_exactly. A1 contains a pointer to the window to
10871 resize, EXACTLY non-nil means resize the mini-window exactly to the
10872 size of the text displayed. A3 and A4 are not used. Value is what
10873 resize_mini_window returns. */
10876 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10879 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10883 /* Resize mini-window W to fit the size of its contents. EXACT_P
10884 means size the window exactly to the size needed. Otherwise, it's
10885 only enlarged until W's buffer is empty.
10887 Set W->start to the right place to begin display. If the whole
10888 contents fit, start at the beginning. Otherwise, start so as
10889 to make the end of the contents appear. This is particularly
10890 important for y-or-n-p, but seems desirable generally.
10892 Value is true if the window height has been changed. */
10895 resize_mini_window (struct window
*w
, bool exact_p
)
10897 struct frame
*f
= XFRAME (w
->frame
);
10898 bool window_height_changed_p
= false;
10900 eassert (MINI_WINDOW_P (w
));
10902 /* By default, start display at the beginning. */
10903 set_marker_both (w
->start
, w
->contents
,
10904 BUF_BEGV (XBUFFER (w
->contents
)),
10905 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10907 /* Don't resize windows while redisplaying a window; it would
10908 confuse redisplay functions when the size of the window they are
10909 displaying changes from under them. Such a resizing can happen,
10910 for instance, when which-func prints a long message while
10911 we are running fontification-functions. We're running these
10912 functions with safe_call which binds inhibit-redisplay to t. */
10913 if (!NILP (Vinhibit_redisplay
))
10916 /* Nil means don't try to resize. */
10917 if (NILP (Vresize_mini_windows
)
10918 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10921 if (!FRAME_MINIBUF_ONLY_P (f
))
10924 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10925 + WINDOW_PIXEL_HEIGHT (w
));
10926 int unit
= FRAME_LINE_HEIGHT (f
);
10927 int height
, max_height
;
10928 struct text_pos start
;
10929 struct buffer
*old_current_buffer
= NULL
;
10931 if (current_buffer
!= XBUFFER (w
->contents
))
10933 old_current_buffer
= current_buffer
;
10934 set_buffer_internal (XBUFFER (w
->contents
));
10937 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10939 /* Compute the max. number of lines specified by the user. */
10940 if (FLOATP (Vmax_mini_window_height
))
10941 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10942 else if (INTEGERP (Vmax_mini_window_height
))
10943 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10945 max_height
= total_height
/ 4;
10947 /* Correct that max. height if it's bogus. */
10948 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10950 /* Find out the height of the text in the window. */
10951 if (it
.line_wrap
== TRUNCATE
)
10956 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10957 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10958 height
= it
.current_y
+ last_height
;
10960 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10961 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10964 /* Compute a suitable window start. */
10965 if (height
> max_height
)
10967 height
= (max_height
/ unit
) * unit
;
10968 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10969 move_it_vertically_backward (&it
, height
- unit
);
10970 start
= it
.current
.pos
;
10973 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10974 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10976 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10978 /* Let it grow only, until we display an empty message, in which
10979 case the window shrinks again. */
10980 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10982 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10984 FRAME_WINDOWS_FROZEN (f
) = true;
10985 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10986 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10988 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10989 && (exact_p
|| BEGV
== ZV
))
10991 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10993 FRAME_WINDOWS_FROZEN (f
) = false;
10994 shrink_mini_window (w
, true);
10995 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11000 /* Always resize to exact size needed. */
11001 if (height
> WINDOW_PIXEL_HEIGHT (w
))
11003 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11005 FRAME_WINDOWS_FROZEN (f
) = true;
11006 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
11007 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11009 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
11011 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11013 FRAME_WINDOWS_FROZEN (f
) = false;
11014 shrink_mini_window (w
, true);
11018 FRAME_WINDOWS_FROZEN (f
) = true;
11019 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
11022 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11026 if (old_current_buffer
)
11027 set_buffer_internal (old_current_buffer
);
11030 return window_height_changed_p
;
11034 /* Value is the current message, a string, or nil if there is no
11035 current message. */
11038 current_message (void)
11042 if (!BUFFERP (echo_area_buffer
[0]))
11046 with_echo_area_buffer (0, 0, current_message_1
,
11047 (intptr_t) &msg
, Qnil
);
11049 echo_area_buffer
[0] = Qnil
;
11057 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
11060 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
11063 *msg
= make_buffer_string (BEG
, Z
, true);
11070 /* Push the current message on Vmessage_stack for later restoration
11071 by restore_message. Value is true if the current message isn't
11072 empty. This is a relatively infrequent operation, so it's not
11073 worth optimizing. */
11076 push_message (void)
11078 Lisp_Object msg
= current_message ();
11079 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
11080 return STRINGP (msg
);
11084 /* Restore message display from the top of Vmessage_stack. */
11087 restore_message (void)
11089 eassert (CONSP (Vmessage_stack
));
11090 message3_nolog (XCAR (Vmessage_stack
));
11094 /* Handler for unwind-protect calling pop_message. */
11097 pop_message_unwind (void)
11099 /* Pop the top-most entry off Vmessage_stack. */
11100 eassert (CONSP (Vmessage_stack
));
11101 Vmessage_stack
= XCDR (Vmessage_stack
);
11105 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11106 exits. If the stack is not empty, we have a missing pop_message
11110 check_message_stack (void)
11112 if (!NILP (Vmessage_stack
))
11117 /* Truncate to NCHARS what will be displayed in the echo area the next
11118 time we display it---but don't redisplay it now. */
11121 truncate_echo_area (ptrdiff_t nchars
)
11124 echo_area_buffer
[0] = Qnil
;
11125 else if (!noninteractive
11127 && !NILP (echo_area_buffer
[0]))
11129 struct frame
*sf
= SELECTED_FRAME ();
11130 /* Error messages get reported properly by cmd_error, so this must be
11131 just an informative message; if the frame hasn't really been
11132 initialized yet, just toss it. */
11133 if (sf
->glyphs_initialized_p
)
11134 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11139 /* Helper function for truncate_echo_area. Truncate the current
11140 message to at most NCHARS characters. */
11143 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11145 if (BEG
+ nchars
< Z
)
11146 del_range (BEG
+ nchars
, Z
);
11148 echo_area_buffer
[0] = Qnil
;
11152 /* Set the current message to STRING. */
11155 set_message (Lisp_Object string
)
11157 eassert (STRINGP (string
));
11159 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11161 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11162 message_buf_print
= false;
11163 help_echo_showing_p
= false;
11165 if (STRINGP (Vdebug_on_message
)
11166 && STRINGP (string
)
11167 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11168 call_debugger (list2 (Qerror
, string
));
11172 /* Helper function for set_message. First argument is ignored and second
11173 argument has the same meaning as for set_message.
11174 This function is called with the echo area buffer being current. */
11177 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11179 eassert (STRINGP (string
));
11181 /* Change multibyteness of the echo buffer appropriately. */
11182 if (message_enable_multibyte
11183 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11184 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11186 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11187 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11188 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11190 /* Insert new message at BEG. */
11191 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11193 /* This function takes care of single/multibyte conversion.
11194 We just have to ensure that the echo area buffer has the right
11195 setting of enable_multibyte_characters. */
11196 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), true);
11202 /* Clear messages. CURRENT_P means clear the current message.
11203 LAST_DISPLAYED_P means clear the message last displayed. */
11206 clear_message (bool current_p
, bool last_displayed_p
)
11210 echo_area_buffer
[0] = Qnil
;
11211 message_cleared_p
= true;
11214 if (last_displayed_p
)
11215 echo_area_buffer
[1] = Qnil
;
11217 message_buf_print
= false;
11220 /* Clear garbaged frames.
11222 This function is used where the old redisplay called
11223 redraw_garbaged_frames which in turn called redraw_frame which in
11224 turn called clear_frame. The call to clear_frame was a source of
11225 flickering. I believe a clear_frame is not necessary. It should
11226 suffice in the new redisplay to invalidate all current matrices,
11227 and ensure a complete redisplay of all windows. */
11230 clear_garbaged_frames (void)
11232 if (frame_garbaged
)
11234 Lisp_Object tail
, frame
;
11236 FOR_EACH_FRAME (tail
, frame
)
11238 struct frame
*f
= XFRAME (frame
);
11240 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11245 clear_current_matrices (f
);
11246 fset_redisplay (f
);
11247 f
->garbaged
= false;
11248 f
->resized_p
= false;
11252 frame_garbaged
= false;
11257 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P, update
11261 echo_area_display (bool update_frame_p
)
11263 Lisp_Object mini_window
;
11266 bool window_height_changed_p
= false;
11267 struct frame
*sf
= SELECTED_FRAME ();
11269 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11270 w
= XWINDOW (mini_window
);
11271 f
= XFRAME (WINDOW_FRAME (w
));
11273 /* Don't display if frame is invisible or not yet initialized. */
11274 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11277 #ifdef HAVE_WINDOW_SYSTEM
11278 /* When Emacs starts, selected_frame may be the initial terminal
11279 frame. If we let this through, a message would be displayed on
11281 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11283 #endif /* HAVE_WINDOW_SYSTEM */
11285 /* Redraw garbaged frames. */
11286 clear_garbaged_frames ();
11288 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11290 echo_area_window
= mini_window
;
11291 window_height_changed_p
= display_echo_area (w
);
11292 w
->must_be_updated_p
= true;
11294 /* Update the display, unless called from redisplay_internal.
11295 Also don't update the screen during redisplay itself. The
11296 update will happen at the end of redisplay, and an update
11297 here could cause confusion. */
11298 if (update_frame_p
&& !redisplaying_p
)
11302 /* If the display update has been interrupted by pending
11303 input, update mode lines in the frame. Due to the
11304 pending input, it might have been that redisplay hasn't
11305 been called, so that mode lines above the echo area are
11306 garbaged. This looks odd, so we prevent it here. */
11307 if (!display_completed
)
11308 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11310 if (window_height_changed_p
11311 /* Don't do this if Emacs is shutting down. Redisplay
11312 needs to run hooks. */
11313 && !NILP (Vrun_hooks
))
11315 /* Must update other windows. Likewise as in other
11316 cases, don't let this update be interrupted by
11318 ptrdiff_t count
= SPECPDL_INDEX ();
11319 specbind (Qredisplay_dont_pause
, Qt
);
11320 fset_redisplay (f
);
11321 redisplay_internal ();
11322 unbind_to (count
, Qnil
);
11324 else if (FRAME_WINDOW_P (f
) && n
== 0)
11326 /* Window configuration is the same as before.
11327 Can do with a display update of the echo area,
11328 unless we displayed some mode lines. */
11329 update_single_window (w
);
11333 update_frame (f
, true, true);
11335 /* If cursor is in the echo area, make sure that the next
11336 redisplay displays the minibuffer, so that the cursor will
11337 be replaced with what the minibuffer wants. */
11338 if (cursor_in_echo_area
)
11339 wset_redisplay (XWINDOW (mini_window
));
11342 else if (!EQ (mini_window
, selected_window
))
11343 wset_redisplay (XWINDOW (mini_window
));
11345 /* Last displayed message is now the current message. */
11346 echo_area_buffer
[1] = echo_area_buffer
[0];
11347 /* Inform read_char that we're not echoing. */
11348 echo_message_buffer
= Qnil
;
11350 /* Prevent redisplay optimization in redisplay_internal by resetting
11351 this_line_start_pos. This is done because the mini-buffer now
11352 displays the message instead of its buffer text. */
11353 if (EQ (mini_window
, selected_window
))
11354 CHARPOS (this_line_start_pos
) = 0;
11356 if (window_height_changed_p
)
11358 fset_redisplay (f
);
11360 /* If window configuration was changed, frames may have been
11361 marked garbaged. Clear them or we will experience
11362 surprises wrt scrolling.
11363 FIXME: How/why/when? */
11364 clear_garbaged_frames ();
11368 /* True if W's buffer was changed but not saved. */
11371 window_buffer_changed (struct window
*w
)
11373 struct buffer
*b
= XBUFFER (w
->contents
);
11375 eassert (BUFFER_LIVE_P (b
));
11377 return (BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
;
11380 /* True if W has %c in its mode line and mode line should be updated. */
11383 mode_line_update_needed (struct window
*w
)
11385 return (w
->column_number_displayed
!= -1
11386 && !(PT
== w
->last_point
&& !window_outdated (w
))
11387 && (w
->column_number_displayed
!= current_column ()));
11390 /* True if window start of W is frozen and may not be changed during
11394 window_frozen_p (struct window
*w
)
11396 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11398 Lisp_Object window
;
11400 XSETWINDOW (window
, w
);
11401 if (MINI_WINDOW_P (w
))
11403 else if (EQ (window
, selected_window
))
11405 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11406 && EQ (window
, Vminibuf_scroll_window
))
11407 /* This special window can't be frozen too. */
11415 /***********************************************************************
11416 Mode Lines and Frame Titles
11417 ***********************************************************************/
11419 /* A buffer for constructing non-propertized mode-line strings and
11420 frame titles in it; allocated from the heap in init_xdisp and
11421 resized as needed in store_mode_line_noprop_char. */
11423 static char *mode_line_noprop_buf
;
11425 /* The buffer's end, and a current output position in it. */
11427 static char *mode_line_noprop_buf_end
;
11428 static char *mode_line_noprop_ptr
;
11430 #define MODE_LINE_NOPROP_LEN(start) \
11431 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11434 MODE_LINE_DISPLAY
= 0,
11438 } mode_line_target
;
11440 /* Alist that caches the results of :propertize.
11441 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11442 static Lisp_Object mode_line_proptrans_alist
;
11444 /* List of strings making up the mode-line. */
11445 static Lisp_Object mode_line_string_list
;
11447 /* Base face property when building propertized mode line string. */
11448 static Lisp_Object mode_line_string_face
;
11449 static Lisp_Object mode_line_string_face_prop
;
11452 /* Unwind data for mode line strings */
11454 static Lisp_Object Vmode_line_unwind_vector
;
11457 format_mode_line_unwind_data (struct frame
*target_frame
,
11458 struct buffer
*obuf
,
11460 bool save_proptrans
)
11462 Lisp_Object vector
, tmp
;
11464 /* Reduce consing by keeping one vector in
11465 Vwith_echo_area_save_vector. */
11466 vector
= Vmode_line_unwind_vector
;
11467 Vmode_line_unwind_vector
= Qnil
;
11470 vector
= Fmake_vector (make_number (10), Qnil
);
11472 ASET (vector
, 0, make_number (mode_line_target
));
11473 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11474 ASET (vector
, 2, mode_line_string_list
);
11475 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11476 ASET (vector
, 4, mode_line_string_face
);
11477 ASET (vector
, 5, mode_line_string_face_prop
);
11480 XSETBUFFER (tmp
, obuf
);
11483 ASET (vector
, 6, tmp
);
11484 ASET (vector
, 7, owin
);
11487 /* Similarly to `with-selected-window', if the operation selects
11488 a window on another frame, we must restore that frame's
11489 selected window, and (for a tty) the top-frame. */
11490 ASET (vector
, 8, target_frame
->selected_window
);
11491 if (FRAME_TERMCAP_P (target_frame
))
11492 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11499 unwind_format_mode_line (Lisp_Object vector
)
11501 Lisp_Object old_window
= AREF (vector
, 7);
11502 Lisp_Object target_frame_window
= AREF (vector
, 8);
11503 Lisp_Object old_top_frame
= AREF (vector
, 9);
11505 mode_line_target
= XINT (AREF (vector
, 0));
11506 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11507 mode_line_string_list
= AREF (vector
, 2);
11508 if (! EQ (AREF (vector
, 3), Qt
))
11509 mode_line_proptrans_alist
= AREF (vector
, 3);
11510 mode_line_string_face
= AREF (vector
, 4);
11511 mode_line_string_face_prop
= AREF (vector
, 5);
11513 /* Select window before buffer, since it may change the buffer. */
11514 if (!NILP (old_window
))
11516 /* If the operation that we are unwinding had selected a window
11517 on a different frame, reset its frame-selected-window. For a
11518 text terminal, reset its top-frame if necessary. */
11519 if (!NILP (target_frame_window
))
11522 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11524 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11525 Fselect_window (target_frame_window
, Qt
);
11527 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11528 Fselect_frame (old_top_frame
, Qt
);
11531 Fselect_window (old_window
, Qt
);
11534 if (!NILP (AREF (vector
, 6)))
11536 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11537 ASET (vector
, 6, Qnil
);
11540 Vmode_line_unwind_vector
= vector
;
11544 /* Store a single character C for the frame title in mode_line_noprop_buf.
11545 Re-allocate mode_line_noprop_buf if necessary. */
11548 store_mode_line_noprop_char (char c
)
11550 /* If output position has reached the end of the allocated buffer,
11551 increase the buffer's size. */
11552 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11554 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11555 ptrdiff_t size
= len
;
11556 mode_line_noprop_buf
=
11557 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11558 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11559 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11562 *mode_line_noprop_ptr
++ = c
;
11566 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11567 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11568 characters that yield more columns than PRECISION; PRECISION <= 0
11569 means copy the whole string. Pad with spaces until FIELD_WIDTH
11570 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11571 pad. Called from display_mode_element when it is used to build a
11575 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11577 const unsigned char *str
= (const unsigned char *) string
;
11579 ptrdiff_t dummy
, nbytes
;
11581 /* Copy at most PRECISION chars from STR. */
11582 nbytes
= strlen (string
);
11583 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11585 store_mode_line_noprop_char (*str
++);
11587 /* Fill up with spaces until FIELD_WIDTH reached. */
11588 while (field_width
> 0
11589 && n
< field_width
)
11591 store_mode_line_noprop_char (' ');
11598 /***********************************************************************
11600 ***********************************************************************/
11602 #ifdef HAVE_WINDOW_SYSTEM
11604 /* Set the title of FRAME, if it has changed. The title format is
11605 Vicon_title_format if FRAME is iconified, otherwise it is
11606 frame_title_format. */
11609 x_consider_frame_title (Lisp_Object frame
)
11611 struct frame
*f
= XFRAME (frame
);
11613 if ((FRAME_WINDOW_P (f
)
11614 || FRAME_MINIBUF_ONLY_P (f
)
11615 || f
->explicit_name
)
11616 && NILP (Fframe_parameter (frame
, Qtooltip
)))
11618 /* Do we have more than one visible frame on this X display? */
11619 Lisp_Object tail
, other_frame
, fmt
;
11620 ptrdiff_t title_start
;
11624 ptrdiff_t count
= SPECPDL_INDEX ();
11626 FOR_EACH_FRAME (tail
, other_frame
)
11628 struct frame
*tf
= XFRAME (other_frame
);
11631 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11632 && !FRAME_MINIBUF_ONLY_P (tf
)
11633 && !EQ (other_frame
, tip_frame
)
11634 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11638 /* Set global variable indicating that multiple frames exist. */
11639 multiple_frames
= CONSP (tail
);
11641 /* Switch to the buffer of selected window of the frame. Set up
11642 mode_line_target so that display_mode_element will output into
11643 mode_line_noprop_buf; then display the title. */
11644 record_unwind_protect (unwind_format_mode_line
,
11645 format_mode_line_unwind_data
11646 (f
, current_buffer
, selected_window
, false));
11648 Fselect_window (f
->selected_window
, Qt
);
11649 set_buffer_internal_1
11650 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11651 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11653 mode_line_target
= MODE_LINE_TITLE
;
11654 title_start
= MODE_LINE_NOPROP_LEN (0);
11655 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11656 NULL
, DEFAULT_FACE_ID
);
11657 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, false);
11658 len
= MODE_LINE_NOPROP_LEN (title_start
);
11659 title
= mode_line_noprop_buf
+ title_start
;
11660 unbind_to (count
, Qnil
);
11662 /* Set the title only if it's changed. This avoids consing in
11663 the common case where it hasn't. (If it turns out that we've
11664 already wasted too much time by walking through the list with
11665 display_mode_element, then we might need to optimize at a
11666 higher level than this.) */
11667 if (! STRINGP (f
->name
)
11668 || SBYTES (f
->name
) != len
11669 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11670 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11674 #endif /* not HAVE_WINDOW_SYSTEM */
11677 /***********************************************************************
11679 ***********************************************************************/
11681 /* True if we will not redisplay all visible windows. */
11682 #define REDISPLAY_SOME_P() \
11683 ((windows_or_buffers_changed == 0 \
11684 || windows_or_buffers_changed == REDISPLAY_SOME) \
11685 && (update_mode_lines == 0 \
11686 || update_mode_lines == REDISPLAY_SOME))
11688 /* Prepare for redisplay by updating menu-bar item lists when
11689 appropriate. This can call eval. */
11692 prepare_menu_bars (void)
11694 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11695 bool some_windows
= REDISPLAY_SOME_P ();
11696 Lisp_Object tooltip_frame
;
11698 #ifdef HAVE_WINDOW_SYSTEM
11699 tooltip_frame
= tip_frame
;
11701 tooltip_frame
= Qnil
;
11704 if (FUNCTIONP (Vpre_redisplay_function
))
11706 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11707 if (all_windows
&& some_windows
)
11709 Lisp_Object ws
= window_list ();
11710 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11712 Lisp_Object
this = XCAR (ws
);
11713 struct window
*w
= XWINDOW (this);
11715 || XFRAME (w
->frame
)->redisplay
11716 || XBUFFER (w
->contents
)->text
->redisplay
)
11718 windows
= Fcons (this, windows
);
11722 safe__call1 (true, Vpre_redisplay_function
, windows
);
11725 /* Update all frame titles based on their buffer names, etc. We do
11726 this before the menu bars so that the buffer-menu will show the
11727 up-to-date frame titles. */
11728 #ifdef HAVE_WINDOW_SYSTEM
11731 Lisp_Object tail
, frame
;
11733 FOR_EACH_FRAME (tail
, frame
)
11735 struct frame
*f
= XFRAME (frame
);
11736 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11740 && !XBUFFER (w
->contents
)->text
->redisplay
)
11743 if (!EQ (frame
, tooltip_frame
)
11744 && (FRAME_ICONIFIED_P (f
)
11745 || FRAME_VISIBLE_P (f
) == 1
11746 /* Exclude TTY frames that are obscured because they
11747 are not the top frame on their console. This is
11748 because x_consider_frame_title actually switches
11749 to the frame, which for TTY frames means it is
11750 marked as garbaged, and will be completely
11751 redrawn on the next redisplay cycle. This causes
11752 TTY frames to be completely redrawn, when there
11753 are more than one of them, even though nothing
11754 should be changed on display. */
11755 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11756 x_consider_frame_title (frame
);
11759 #endif /* HAVE_WINDOW_SYSTEM */
11761 /* Update the menu bar item lists, if appropriate. This has to be
11762 done before any actual redisplay or generation of display lines. */
11766 Lisp_Object tail
, frame
;
11767 ptrdiff_t count
= SPECPDL_INDEX ();
11768 /* True means that update_menu_bar has run its hooks
11769 so any further calls to update_menu_bar shouldn't do so again. */
11770 bool menu_bar_hooks_run
= false;
11772 record_unwind_save_match_data ();
11774 FOR_EACH_FRAME (tail
, frame
)
11776 struct frame
*f
= XFRAME (frame
);
11777 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11779 /* Ignore tooltip frame. */
11780 if (EQ (frame
, tooltip_frame
))
11786 && !XBUFFER (w
->contents
)->text
->redisplay
)
11789 /* If a window on this frame changed size, report that to
11790 the user and clear the size-change flag. */
11791 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11793 Lisp_Object functions
;
11795 /* Clear flag first in case we get an error below. */
11796 FRAME_WINDOW_SIZES_CHANGED (f
) = false;
11797 functions
= Vwindow_size_change_functions
;
11799 while (CONSP (functions
))
11801 if (!EQ (XCAR (functions
), Qt
))
11802 call1 (XCAR (functions
), frame
);
11803 functions
= XCDR (functions
);
11807 menu_bar_hooks_run
= update_menu_bar (f
, false, menu_bar_hooks_run
);
11808 #ifdef HAVE_WINDOW_SYSTEM
11809 update_tool_bar (f
, false);
11813 unbind_to (count
, Qnil
);
11817 struct frame
*sf
= SELECTED_FRAME ();
11818 update_menu_bar (sf
, true, false);
11819 #ifdef HAVE_WINDOW_SYSTEM
11820 update_tool_bar (sf
, true);
11826 /* Update the menu bar item list for frame F. This has to be done
11827 before we start to fill in any display lines, because it can call
11830 If SAVE_MATCH_DATA, we must save and restore it here.
11832 If HOOKS_RUN, a previous call to update_menu_bar
11833 already ran the menu bar hooks for this redisplay, so there
11834 is no need to run them again. The return value is the
11835 updated value of this flag, to pass to the next call. */
11838 update_menu_bar (struct frame
*f
, bool save_match_data
, bool hooks_run
)
11840 Lisp_Object window
;
11843 /* If called recursively during a menu update, do nothing. This can
11844 happen when, for instance, an activate-menubar-hook causes a
11846 if (inhibit_menubar_update
)
11849 window
= FRAME_SELECTED_WINDOW (f
);
11850 w
= XWINDOW (window
);
11852 if (FRAME_WINDOW_P (f
)
11854 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11855 || defined (HAVE_NS) || defined (USE_GTK)
11856 FRAME_EXTERNAL_MENU_BAR (f
)
11858 FRAME_MENU_BAR_LINES (f
) > 0
11860 : FRAME_MENU_BAR_LINES (f
) > 0)
11862 /* If the user has switched buffers or windows, we need to
11863 recompute to reflect the new bindings. But we'll
11864 recompute when update_mode_lines is set too; that means
11865 that people can use force-mode-line-update to request
11866 that the menu bar be recomputed. The adverse effect on
11867 the rest of the redisplay algorithm is about the same as
11868 windows_or_buffers_changed anyway. */
11869 if (windows_or_buffers_changed
11870 /* This used to test w->update_mode_line, but we believe
11871 there is no need to recompute the menu in that case. */
11872 || update_mode_lines
11873 || window_buffer_changed (w
))
11875 struct buffer
*prev
= current_buffer
;
11876 ptrdiff_t count
= SPECPDL_INDEX ();
11878 specbind (Qinhibit_menubar_update
, Qt
);
11880 set_buffer_internal_1 (XBUFFER (w
->contents
));
11881 if (save_match_data
)
11882 record_unwind_save_match_data ();
11883 if (NILP (Voverriding_local_map_menu_flag
))
11885 specbind (Qoverriding_terminal_local_map
, Qnil
);
11886 specbind (Qoverriding_local_map
, Qnil
);
11891 /* Run the Lucid hook. */
11892 safe_run_hooks (Qactivate_menubar_hook
);
11894 /* If it has changed current-menubar from previous value,
11895 really recompute the menu-bar from the value. */
11896 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11897 call0 (Qrecompute_lucid_menubar
);
11899 safe_run_hooks (Qmenu_bar_update_hook
);
11904 XSETFRAME (Vmenu_updating_frame
, f
);
11905 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11907 /* Redisplay the menu bar in case we changed it. */
11908 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11909 || defined (HAVE_NS) || defined (USE_GTK)
11910 if (FRAME_WINDOW_P (f
))
11912 #if defined (HAVE_NS)
11913 /* All frames on Mac OS share the same menubar. So only
11914 the selected frame should be allowed to set it. */
11915 if (f
== SELECTED_FRAME ())
11917 set_frame_menubar (f
, false, false);
11920 /* On a terminal screen, the menu bar is an ordinary screen
11921 line, and this makes it get updated. */
11922 w
->update_mode_line
= true;
11923 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11924 /* In the non-toolkit version, the menu bar is an ordinary screen
11925 line, and this makes it get updated. */
11926 w
->update_mode_line
= true;
11927 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11929 unbind_to (count
, Qnil
);
11930 set_buffer_internal_1 (prev
);
11937 /***********************************************************************
11939 ***********************************************************************/
11941 #ifdef HAVE_WINDOW_SYSTEM
11943 /* Select `frame' temporarily without running all the code in
11945 FIXME: Maybe do_switch_frame should be trimmed down similarly
11946 when `norecord' is set. */
11948 fast_set_selected_frame (Lisp_Object frame
)
11950 if (!EQ (selected_frame
, frame
))
11952 selected_frame
= frame
;
11953 selected_window
= XFRAME (frame
)->selected_window
;
11957 /* Update the tool-bar item list for frame F. This has to be done
11958 before we start to fill in any display lines. Called from
11959 prepare_menu_bars. If SAVE_MATCH_DATA, we must save
11960 and restore it here. */
11963 update_tool_bar (struct frame
*f
, bool save_match_data
)
11965 #if defined (USE_GTK) || defined (HAVE_NS)
11966 bool do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11968 bool do_update
= (WINDOWP (f
->tool_bar_window
)
11969 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0);
11974 Lisp_Object window
;
11977 window
= FRAME_SELECTED_WINDOW (f
);
11978 w
= XWINDOW (window
);
11980 /* If the user has switched buffers or windows, we need to
11981 recompute to reflect the new bindings. But we'll
11982 recompute when update_mode_lines is set too; that means
11983 that people can use force-mode-line-update to request
11984 that the menu bar be recomputed. The adverse effect on
11985 the rest of the redisplay algorithm is about the same as
11986 windows_or_buffers_changed anyway. */
11987 if (windows_or_buffers_changed
11988 || w
->update_mode_line
11989 || update_mode_lines
11990 || window_buffer_changed (w
))
11992 struct buffer
*prev
= current_buffer
;
11993 ptrdiff_t count
= SPECPDL_INDEX ();
11994 Lisp_Object frame
, new_tool_bar
;
11995 int new_n_tool_bar
;
11997 /* Set current_buffer to the buffer of the selected
11998 window of the frame, so that we get the right local
12000 set_buffer_internal_1 (XBUFFER (w
->contents
));
12002 /* Save match data, if we must. */
12003 if (save_match_data
)
12004 record_unwind_save_match_data ();
12006 /* Make sure that we don't accidentally use bogus keymaps. */
12007 if (NILP (Voverriding_local_map_menu_flag
))
12009 specbind (Qoverriding_terminal_local_map
, Qnil
);
12010 specbind (Qoverriding_local_map
, Qnil
);
12013 /* We must temporarily set the selected frame to this frame
12014 before calling tool_bar_items, because the calculation of
12015 the tool-bar keymap uses the selected frame (see
12016 `tool-bar-make-keymap' in tool-bar.el). */
12017 eassert (EQ (selected_window
,
12018 /* Since we only explicitly preserve selected_frame,
12019 check that selected_window would be redundant. */
12020 XFRAME (selected_frame
)->selected_window
));
12021 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
12022 XSETFRAME (frame
, f
);
12023 fast_set_selected_frame (frame
);
12025 /* Build desired tool-bar items from keymaps. */
12027 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
12030 /* Redisplay the tool-bar if we changed it. */
12031 if (new_n_tool_bar
!= f
->n_tool_bar_items
12032 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
12034 /* Redisplay that happens asynchronously due to an expose event
12035 may access f->tool_bar_items. Make sure we update both
12036 variables within BLOCK_INPUT so no such event interrupts. */
12038 fset_tool_bar_items (f
, new_tool_bar
);
12039 f
->n_tool_bar_items
= new_n_tool_bar
;
12040 w
->update_mode_line
= true;
12044 unbind_to (count
, Qnil
);
12045 set_buffer_internal_1 (prev
);
12050 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12052 /* Set F->desired_tool_bar_string to a Lisp string representing frame
12053 F's desired tool-bar contents. F->tool_bar_items must have
12054 been set up previously by calling prepare_menu_bars. */
12057 build_desired_tool_bar_string (struct frame
*f
)
12059 int i
, size
, size_needed
;
12060 Lisp_Object image
, plist
;
12062 image
= plist
= Qnil
;
12064 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
12065 Otherwise, make a new string. */
12067 /* The size of the string we might be able to reuse. */
12068 size
= (STRINGP (f
->desired_tool_bar_string
)
12069 ? SCHARS (f
->desired_tool_bar_string
)
12072 /* We need one space in the string for each image. */
12073 size_needed
= f
->n_tool_bar_items
;
12075 /* Reuse f->desired_tool_bar_string, if possible. */
12076 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
12077 fset_desired_tool_bar_string
12078 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
12081 AUTO_LIST4 (props
, Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
12082 Fremove_text_properties (make_number (0), make_number (size
),
12083 props
, f
->desired_tool_bar_string
);
12086 /* Put a `display' property on the string for the images to display,
12087 put a `menu_item' property on tool-bar items with a value that
12088 is the index of the item in F's tool-bar item vector. */
12089 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
12091 #define PROP(IDX) \
12092 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
12094 bool enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
12095 bool selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
12096 int hmargin
, vmargin
, relief
, idx
, end
;
12098 /* If image is a vector, choose the image according to the
12100 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
12101 if (VECTORP (image
))
12105 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12106 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
12109 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12110 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
12112 eassert (ASIZE (image
) >= idx
);
12113 image
= AREF (image
, idx
);
12118 /* Ignore invalid image specifications. */
12119 if (!valid_image_p (image
))
12122 /* Display the tool-bar button pressed, or depressed. */
12123 plist
= Fcopy_sequence (XCDR (image
));
12125 /* Compute margin and relief to draw. */
12126 relief
= (tool_bar_button_relief
>= 0
12127 ? tool_bar_button_relief
12128 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12129 hmargin
= vmargin
= relief
;
12131 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12132 INT_MAX
- max (hmargin
, vmargin
)))
12134 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12135 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12137 else if (CONSP (Vtool_bar_button_margin
))
12139 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12140 INT_MAX
- hmargin
))
12141 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12143 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12144 INT_MAX
- vmargin
))
12145 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12148 if (auto_raise_tool_bar_buttons_p
)
12150 /* Add a `:relief' property to the image spec if the item is
12154 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12161 /* If image is selected, display it pressed, i.e. with a
12162 negative relief. If it's not selected, display it with a
12164 plist
= Fplist_put (plist
, QCrelief
,
12166 ? make_number (-relief
)
12167 : make_number (relief
)));
12172 /* Put a margin around the image. */
12173 if (hmargin
|| vmargin
)
12175 if (hmargin
== vmargin
)
12176 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12178 plist
= Fplist_put (plist
, QCmargin
,
12179 Fcons (make_number (hmargin
),
12180 make_number (vmargin
)));
12183 /* If button is not enabled, and we don't have special images
12184 for the disabled state, make the image appear disabled by
12185 applying an appropriate algorithm to it. */
12186 if (!enabled_p
&& idx
< 0)
12187 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12189 /* Put a `display' text property on the string for the image to
12190 display. Put a `menu-item' property on the string that gives
12191 the start of this item's properties in the tool-bar items
12193 image
= Fcons (Qimage
, plist
);
12194 AUTO_LIST4 (props
, Qdisplay
, image
, Qmenu_item
,
12195 make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12197 /* Let the last image hide all remaining spaces in the tool bar
12198 string. The string can be longer than needed when we reuse a
12199 previous string. */
12200 if (i
+ 1 == f
->n_tool_bar_items
)
12201 end
= SCHARS (f
->desired_tool_bar_string
);
12204 Fadd_text_properties (make_number (i
), make_number (end
),
12205 props
, f
->desired_tool_bar_string
);
12211 /* Display one line of the tool-bar of frame IT->f.
12213 HEIGHT specifies the desired height of the tool-bar line.
12214 If the actual height of the glyph row is less than HEIGHT, the
12215 row's height is increased to HEIGHT, and the icons are centered
12216 vertically in the new height.
12218 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12219 count a final empty row in case the tool-bar width exactly matches
12224 display_tool_bar_line (struct it
*it
, int height
)
12226 struct glyph_row
*row
= it
->glyph_row
;
12227 int max_x
= it
->last_visible_x
;
12228 struct glyph
*last
;
12230 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12231 clear_glyph_row (row
);
12232 row
->enabled_p
= true;
12233 row
->y
= it
->current_y
;
12235 /* Note that this isn't made use of if the face hasn't a box,
12236 so there's no need to check the face here. */
12237 it
->start_of_box_run_p
= true;
12239 while (it
->current_x
< max_x
)
12241 int x
, n_glyphs_before
, i
, nglyphs
;
12242 struct it it_before
;
12244 /* Get the next display element. */
12245 if (!get_next_display_element (it
))
12247 /* Don't count empty row if we are counting needed tool-bar lines. */
12248 if (height
< 0 && !it
->hpos
)
12253 /* Produce glyphs. */
12254 n_glyphs_before
= row
->used
[TEXT_AREA
];
12257 PRODUCE_GLYPHS (it
);
12259 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12261 x
= it_before
.current_x
;
12262 while (i
< nglyphs
)
12264 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12266 if (x
+ glyph
->pixel_width
> max_x
)
12268 /* Glyph doesn't fit on line. Backtrack. */
12269 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12271 /* If this is the only glyph on this line, it will never fit on the
12272 tool-bar, so skip it. But ensure there is at least one glyph,
12273 so we don't accidentally disable the tool-bar. */
12274 if (n_glyphs_before
== 0
12275 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12281 x
+= glyph
->pixel_width
;
12285 /* Stop at line end. */
12286 if (ITERATOR_AT_END_OF_LINE_P (it
))
12289 set_iterator_to_next (it
, true);
12294 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12296 /* Use default face for the border below the tool bar.
12298 FIXME: When auto-resize-tool-bars is grow-only, there is
12299 no additional border below the possibly empty tool-bar lines.
12300 So to make the extra empty lines look "normal", we have to
12301 use the tool-bar face for the border too. */
12302 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12303 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12304 it
->face_id
= DEFAULT_FACE_ID
;
12306 extend_face_to_end_of_line (it
);
12307 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12308 last
->right_box_line_p
= true;
12309 if (last
== row
->glyphs
[TEXT_AREA
])
12310 last
->left_box_line_p
= true;
12312 /* Make line the desired height and center it vertically. */
12313 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12315 /* Don't add more than one line height. */
12316 height
%= FRAME_LINE_HEIGHT (it
->f
);
12317 it
->max_ascent
+= height
/ 2;
12318 it
->max_descent
+= (height
+ 1) / 2;
12321 compute_line_metrics (it
);
12323 /* If line is empty, make it occupy the rest of the tool-bar. */
12324 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12326 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12327 row
->visible_height
= row
->height
;
12328 row
->ascent
= row
->phys_ascent
= 0;
12329 row
->extra_line_spacing
= 0;
12332 row
->full_width_p
= true;
12333 row
->continued_p
= false;
12334 row
->truncated_on_left_p
= false;
12335 row
->truncated_on_right_p
= false;
12337 it
->current_x
= it
->hpos
= 0;
12338 it
->current_y
+= row
->height
;
12344 /* Value is the number of pixels needed to make all tool-bar items of
12345 frame F visible. The actual number of glyph rows needed is
12346 returned in *N_ROWS if non-NULL. */
12348 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12350 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12352 /* tool_bar_height is called from redisplay_tool_bar after building
12353 the desired matrix, so use (unused) mode-line row as temporary row to
12354 avoid destroying the first tool-bar row. */
12355 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12357 /* Initialize an iterator for iteration over
12358 F->desired_tool_bar_string in the tool-bar window of frame F. */
12359 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12360 temp_row
->reversed_p
= false;
12361 it
.first_visible_x
= 0;
12362 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12363 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12364 it
.paragraph_embedding
= L2R
;
12366 while (!ITERATOR_AT_END_P (&it
))
12368 clear_glyph_row (temp_row
);
12369 it
.glyph_row
= temp_row
;
12370 display_tool_bar_line (&it
, -1);
12372 clear_glyph_row (temp_row
);
12374 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12376 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12379 return it
.current_y
;
12381 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12384 #endif /* !USE_GTK && !HAVE_NS */
12386 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12388 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12389 If FRAME is nil or omitted, use the selected frame. Optional argument
12390 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12391 (Lisp_Object frame
, Lisp_Object pixelwise
)
12395 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12396 struct frame
*f
= decode_any_frame (frame
);
12398 if (WINDOWP (f
->tool_bar_window
)
12399 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12401 update_tool_bar (f
, true);
12402 if (f
->n_tool_bar_items
)
12404 build_desired_tool_bar_string (f
);
12405 height
= tool_bar_height (f
, NULL
, !NILP (pixelwise
));
12410 return make_number (height
);
12414 /* Display the tool-bar of frame F. Value is true if tool-bar's
12415 height should be changed. */
12417 redisplay_tool_bar (struct frame
*f
)
12419 f
->tool_bar_redisplayed
= true;
12420 #if defined (USE_GTK) || defined (HAVE_NS)
12422 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12423 update_frame_tool_bar (f
);
12426 #else /* !USE_GTK && !HAVE_NS */
12430 struct glyph_row
*row
;
12432 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12433 do anything. This means you must start with tool-bar-lines
12434 non-zero to get the auto-sizing effect. Or in other words, you
12435 can turn off tool-bars by specifying tool-bar-lines zero. */
12436 if (!WINDOWP (f
->tool_bar_window
)
12437 || (w
= XWINDOW (f
->tool_bar_window
),
12438 WINDOW_TOTAL_LINES (w
) == 0))
12441 /* Set up an iterator for the tool-bar window. */
12442 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12443 it
.first_visible_x
= 0;
12444 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12445 row
= it
.glyph_row
;
12446 row
->reversed_p
= false;
12448 /* Build a string that represents the contents of the tool-bar. */
12449 build_desired_tool_bar_string (f
);
12450 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12451 /* FIXME: This should be controlled by a user option. But it
12452 doesn't make sense to have an R2L tool bar if the menu bar cannot
12453 be drawn also R2L, and making the menu bar R2L is tricky due
12454 toolkit-specific code that implements it. If an R2L tool bar is
12455 ever supported, display_tool_bar_line should also be augmented to
12456 call unproduce_glyphs like display_line and display_string
12458 it
.paragraph_embedding
= L2R
;
12460 if (f
->n_tool_bar_rows
== 0)
12462 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, true);
12464 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12466 x_change_tool_bar_height (f
, new_height
);
12467 frame_default_tool_bar_height
= new_height
;
12468 /* Always do that now. */
12469 clear_glyph_matrix (w
->desired_matrix
);
12470 f
->fonts_changed
= true;
12475 /* Display as many lines as needed to display all tool-bar items. */
12477 if (f
->n_tool_bar_rows
> 0)
12479 int border
, rows
, height
, extra
;
12481 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12482 border
= XINT (Vtool_bar_border
);
12483 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12484 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12485 else if (EQ (Vtool_bar_border
, Qborder_width
))
12486 border
= f
->border_width
;
12492 rows
= f
->n_tool_bar_rows
;
12493 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12494 extra
= it
.last_visible_y
- border
- height
* rows
;
12496 while (it
.current_y
< it
.last_visible_y
)
12499 if (extra
> 0 && rows
-- > 0)
12501 h
= (extra
+ rows
- 1) / rows
;
12504 display_tool_bar_line (&it
, height
+ h
);
12509 while (it
.current_y
< it
.last_visible_y
)
12510 display_tool_bar_line (&it
, 0);
12513 /* It doesn't make much sense to try scrolling in the tool-bar
12514 window, so don't do it. */
12515 w
->desired_matrix
->no_scrolling_p
= true;
12516 w
->must_be_updated_p
= true;
12518 if (!NILP (Vauto_resize_tool_bars
))
12520 bool change_height_p
= true;
12522 /* If we couldn't display everything, change the tool-bar's
12523 height if there is room for more. */
12524 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
12525 change_height_p
= true;
12527 /* We subtract 1 because display_tool_bar_line advances the
12528 glyph_row pointer before returning to its caller. We want to
12529 examine the last glyph row produced by
12530 display_tool_bar_line. */
12531 row
= it
.glyph_row
- 1;
12533 /* If there are blank lines at the end, except for a partially
12534 visible blank line at the end that is smaller than
12535 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12536 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12537 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12538 change_height_p
= true;
12540 /* If row displays tool-bar items, but is partially visible,
12541 change the tool-bar's height. */
12542 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12543 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
12544 change_height_p
= true;
12546 /* Resize windows as needed by changing the `tool-bar-lines'
12547 frame parameter. */
12548 if (change_height_p
)
12551 int new_height
= tool_bar_height (f
, &nrows
, true);
12553 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12554 && !f
->minimize_tool_bar_window_p
)
12555 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12556 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12557 f
->minimize_tool_bar_window_p
= false;
12559 if (change_height_p
)
12561 x_change_tool_bar_height (f
, new_height
);
12562 frame_default_tool_bar_height
= new_height
;
12563 clear_glyph_matrix (w
->desired_matrix
);
12564 f
->n_tool_bar_rows
= nrows
;
12565 f
->fonts_changed
= true;
12572 f
->minimize_tool_bar_window_p
= false;
12575 #endif /* USE_GTK || HAVE_NS */
12578 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12580 /* Get information about the tool-bar item which is displayed in GLYPH
12581 on frame F. Return in *PROP_IDX the index where tool-bar item
12582 properties start in F->tool_bar_items. Value is false if
12583 GLYPH doesn't display a tool-bar item. */
12586 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12591 /* This function can be called asynchronously, which means we must
12592 exclude any possibility that Fget_text_property signals an
12594 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12595 charpos
= max (0, charpos
);
12597 /* Get the text property `menu-item' at pos. The value of that
12598 property is the start index of this item's properties in
12599 F->tool_bar_items. */
12600 prop
= Fget_text_property (make_number (charpos
),
12601 Qmenu_item
, f
->current_tool_bar_string
);
12602 if (! INTEGERP (prop
))
12604 *prop_idx
= XINT (prop
);
12609 /* Get information about the tool-bar item at position X/Y on frame F.
12610 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12611 the current matrix of the tool-bar window of F, or NULL if not
12612 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12613 item in F->tool_bar_items. Value is
12615 -1 if X/Y is not on a tool-bar item
12616 0 if X/Y is on the same item that was highlighted before.
12620 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12621 int *hpos
, int *vpos
, int *prop_idx
)
12623 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12624 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12627 /* Find the glyph under X/Y. */
12628 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12629 if (*glyph
== NULL
)
12632 /* Get the start of this tool-bar item's properties in
12633 f->tool_bar_items. */
12634 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12637 /* Is mouse on the highlighted item? */
12638 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12639 && *vpos
>= hlinfo
->mouse_face_beg_row
12640 && *vpos
<= hlinfo
->mouse_face_end_row
12641 && (*vpos
> hlinfo
->mouse_face_beg_row
12642 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12643 && (*vpos
< hlinfo
->mouse_face_end_row
12644 || *hpos
< hlinfo
->mouse_face_end_col
12645 || hlinfo
->mouse_face_past_end
))
12653 Handle mouse button event on the tool-bar of frame F, at
12654 frame-relative coordinates X/Y. DOWN_P is true for a button press,
12655 false for button release. MODIFIERS is event modifiers for button
12659 handle_tool_bar_click (struct frame
*f
, int x
, int y
, bool down_p
,
12662 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12663 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12664 int hpos
, vpos
, prop_idx
;
12665 struct glyph
*glyph
;
12666 Lisp_Object enabled_p
;
12669 /* If not on the highlighted tool-bar item, and mouse-highlight is
12670 non-nil, return. This is so we generate the tool-bar button
12671 click only when the mouse button is released on the same item as
12672 where it was pressed. However, when mouse-highlight is disabled,
12673 generate the click when the button is released regardless of the
12674 highlight, since tool-bar items are not highlighted in that
12676 frame_to_window_pixel_xy (w
, &x
, &y
);
12677 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12679 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12682 /* When mouse-highlight is off, generate the click for the item
12683 where the button was pressed, disregarding where it was
12685 if (NILP (Vmouse_highlight
) && !down_p
)
12686 prop_idx
= f
->last_tool_bar_item
;
12688 /* If item is disabled, do nothing. */
12689 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12690 if (NILP (enabled_p
))
12695 /* Show item in pressed state. */
12696 if (!NILP (Vmouse_highlight
))
12697 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12698 f
->last_tool_bar_item
= prop_idx
;
12702 Lisp_Object key
, frame
;
12703 struct input_event event
;
12704 EVENT_INIT (event
);
12706 /* Show item in released state. */
12707 if (!NILP (Vmouse_highlight
))
12708 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12710 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12712 XSETFRAME (frame
, f
);
12713 event
.kind
= TOOL_BAR_EVENT
;
12714 event
.frame_or_window
= frame
;
12716 kbd_buffer_store_event (&event
);
12718 event
.kind
= TOOL_BAR_EVENT
;
12719 event
.frame_or_window
= frame
;
12721 event
.modifiers
= modifiers
;
12722 kbd_buffer_store_event (&event
);
12723 f
->last_tool_bar_item
= -1;
12728 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12729 tool-bar window-relative coordinates X/Y. Called from
12730 note_mouse_highlight. */
12733 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12735 Lisp_Object window
= f
->tool_bar_window
;
12736 struct window
*w
= XWINDOW (window
);
12737 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12738 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12740 struct glyph
*glyph
;
12741 struct glyph_row
*row
;
12743 Lisp_Object enabled_p
;
12745 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12749 /* Function note_mouse_highlight is called with negative X/Y
12750 values when mouse moves outside of the frame. */
12751 if (x
<= 0 || y
<= 0)
12753 clear_mouse_face (hlinfo
);
12757 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12760 /* Not on tool-bar item. */
12761 clear_mouse_face (hlinfo
);
12765 /* On same tool-bar item as before. */
12766 goto set_help_echo
;
12768 clear_mouse_face (hlinfo
);
12770 /* Mouse is down, but on different tool-bar item? */
12771 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12772 && f
== dpyinfo
->last_mouse_frame
);
12774 if (mouse_down_p
&& f
->last_tool_bar_item
!= prop_idx
)
12777 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12779 /* If tool-bar item is not enabled, don't highlight it. */
12780 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12781 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12783 /* Compute the x-position of the glyph. In front and past the
12784 image is a space. We include this in the highlighted area. */
12785 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12786 for (i
= x
= 0; i
< hpos
; ++i
)
12787 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12789 /* Record this as the current active region. */
12790 hlinfo
->mouse_face_beg_col
= hpos
;
12791 hlinfo
->mouse_face_beg_row
= vpos
;
12792 hlinfo
->mouse_face_beg_x
= x
;
12793 hlinfo
->mouse_face_past_end
= false;
12795 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12796 hlinfo
->mouse_face_end_row
= vpos
;
12797 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12798 hlinfo
->mouse_face_window
= window
;
12799 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12801 /* Display it as active. */
12802 show_mouse_face (hlinfo
, draw
);
12807 /* Set help_echo_string to a help string to display for this tool-bar item.
12808 XTread_socket does the rest. */
12809 help_echo_object
= help_echo_window
= Qnil
;
12810 help_echo_pos
= -1;
12811 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12812 if (NILP (help_echo_string
))
12813 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12816 #endif /* !USE_GTK && !HAVE_NS */
12818 #endif /* HAVE_WINDOW_SYSTEM */
12822 /************************************************************************
12823 Horizontal scrolling
12824 ************************************************************************/
12826 /* For all leaf windows in the window tree rooted at WINDOW, set their
12827 hscroll value so that PT is (i) visible in the window, and (ii) so
12828 that it is not within a certain margin at the window's left and
12829 right border. Value is true if any window's hscroll has been
12833 hscroll_window_tree (Lisp_Object window
)
12835 bool hscrolled_p
= false;
12836 bool hscroll_relative_p
= FLOATP (Vhscroll_step
);
12837 int hscroll_step_abs
= 0;
12838 double hscroll_step_rel
= 0;
12840 if (hscroll_relative_p
)
12842 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12843 if (hscroll_step_rel
< 0)
12845 hscroll_relative_p
= false;
12846 hscroll_step_abs
= 0;
12849 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12851 hscroll_step_abs
= XINT (Vhscroll_step
);
12852 if (hscroll_step_abs
< 0)
12853 hscroll_step_abs
= 0;
12856 hscroll_step_abs
= 0;
12858 while (WINDOWP (window
))
12860 struct window
*w
= XWINDOW (window
);
12862 if (WINDOWP (w
->contents
))
12863 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12864 else if (w
->cursor
.vpos
>= 0)
12867 int text_area_width
;
12868 struct glyph_row
*cursor_row
;
12869 struct glyph_row
*bottom_row
;
12871 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12872 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12873 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12875 cursor_row
= bottom_row
- 1;
12877 if (!cursor_row
->enabled_p
)
12879 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12880 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12881 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12883 cursor_row
= bottom_row
- 1;
12885 bool row_r2l_p
= cursor_row
->reversed_p
;
12887 text_area_width
= window_box_width (w
, TEXT_AREA
);
12889 /* Scroll when cursor is inside this scroll margin. */
12890 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12892 /* If the position of this window's point has explicitly
12893 changed, no more suspend auto hscrolling. */
12894 if (NILP (Fequal (Fwindow_point (window
), Fwindow_old_point (window
))))
12895 w
->suspend_auto_hscroll
= false;
12897 /* Remember window point. */
12898 Fset_marker (w
->old_pointm
,
12899 ((w
== XWINDOW (selected_window
))
12900 ? make_number (BUF_PT (XBUFFER (w
->contents
)))
12901 : Fmarker_position (w
->pointm
)),
12904 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12905 && !w
->suspend_auto_hscroll
12906 /* In some pathological cases, like restoring a window
12907 configuration into a frame that is much smaller than
12908 the one from which the configuration was saved, we
12909 get glyph rows whose start and end have zero buffer
12910 positions, which we cannot handle below. Just skip
12912 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12913 /* For left-to-right rows, hscroll when cursor is either
12914 (i) inside the right hscroll margin, or (ii) if it is
12915 inside the left margin and the window is already
12918 && ((w
->hscroll
&& w
->cursor
.x
<= h_margin
)
12919 || (cursor_row
->enabled_p
12920 && cursor_row
->truncated_on_right_p
12921 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12922 /* For right-to-left rows, the logic is similar,
12923 except that rules for scrolling to left and right
12924 are reversed. E.g., if cursor.x <= h_margin, we
12925 need to hscroll "to the right" unconditionally,
12926 and that will scroll the screen to the left so as
12927 to reveal the next portion of the row. */
12929 && ((cursor_row
->enabled_p
12930 /* FIXME: It is confusing to set the
12931 truncated_on_right_p flag when R2L rows
12932 are actually truncated on the left. */
12933 && cursor_row
->truncated_on_right_p
12934 && w
->cursor
.x
<= h_margin
)
12936 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12940 struct buffer
*saved_current_buffer
;
12944 /* Find point in a display of infinite width. */
12945 saved_current_buffer
= current_buffer
;
12946 current_buffer
= XBUFFER (w
->contents
);
12948 if (w
== XWINDOW (selected_window
))
12951 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12953 /* Move iterator to pt starting at cursor_row->start in
12954 a line with infinite width. */
12955 init_to_row_start (&it
, w
, cursor_row
);
12956 it
.last_visible_x
= INFINITY
;
12957 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12958 current_buffer
= saved_current_buffer
;
12960 /* Position cursor in window. */
12961 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12962 hscroll
= max (0, (it
.current_x
12963 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12964 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12965 : (text_area_width
/ 2))))
12966 / FRAME_COLUMN_WIDTH (it
.f
);
12967 else if ((!row_r2l_p
12968 && w
->cursor
.x
>= text_area_width
- h_margin
)
12969 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12971 if (hscroll_relative_p
)
12972 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12975 wanted_x
= text_area_width
12976 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12979 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12983 if (hscroll_relative_p
)
12984 wanted_x
= text_area_width
* hscroll_step_rel
12987 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12990 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12992 hscroll
= max (hscroll
, w
->min_hscroll
);
12994 /* Don't prevent redisplay optimizations if hscroll
12995 hasn't changed, as it will unnecessarily slow down
12997 if (w
->hscroll
!= hscroll
)
12999 struct buffer
*b
= XBUFFER (w
->contents
);
13000 b
->prevent_redisplay_optimizations_p
= true;
13001 w
->hscroll
= hscroll
;
13002 hscrolled_p
= true;
13010 /* Value is true if hscroll of any leaf window has been changed. */
13011 return hscrolled_p
;
13015 /* Set hscroll so that cursor is visible and not inside horizontal
13016 scroll margins for all windows in the tree rooted at WINDOW. See
13017 also hscroll_window_tree above. Value is true if any window's
13018 hscroll has been changed. If it has, desired matrices on the frame
13019 of WINDOW are cleared. */
13022 hscroll_windows (Lisp_Object window
)
13024 bool hscrolled_p
= hscroll_window_tree (window
);
13026 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
13027 return hscrolled_p
;
13032 /************************************************************************
13034 ************************************************************************/
13036 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined.
13037 This is sometimes handy to have in a debugger session. */
13041 /* First and last unchanged row for try_window_id. */
13043 static int debug_first_unchanged_at_end_vpos
;
13044 static int debug_last_unchanged_at_beg_vpos
;
13046 /* Delta vpos and y. */
13048 static int debug_dvpos
, debug_dy
;
13050 /* Delta in characters and bytes for try_window_id. */
13052 static ptrdiff_t debug_delta
, debug_delta_bytes
;
13054 /* Values of window_end_pos and window_end_vpos at the end of
13057 static ptrdiff_t debug_end_vpos
;
13059 /* Append a string to W->desired_matrix->method. FMT is a printf
13060 format string. If trace_redisplay_p is true also printf the
13061 resulting string to stderr. */
13063 static void debug_method_add (struct window
*, char const *, ...)
13064 ATTRIBUTE_FORMAT_PRINTF (2, 3);
13067 debug_method_add (struct window
*w
, char const *fmt
, ...)
13070 char *method
= w
->desired_matrix
->method
;
13071 int len
= strlen (method
);
13072 int size
= sizeof w
->desired_matrix
->method
;
13073 int remaining
= size
- len
- 1;
13076 if (len
&& remaining
)
13079 --remaining
, ++len
;
13082 va_start (ap
, fmt
);
13083 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
13086 if (trace_redisplay_p
)
13087 fprintf (stderr
, "%p (%s): %s\n",
13089 ((BUFFERP (w
->contents
)
13090 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
13091 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13096 #endif /* GLYPH_DEBUG */
13099 /* Value is true if all changes in window W, which displays
13100 current_buffer, are in the text between START and END. START is a
13101 buffer position, END is given as a distance from Z. Used in
13102 redisplay_internal for display optimization. */
13105 text_outside_line_unchanged_p (struct window
*w
,
13106 ptrdiff_t start
, ptrdiff_t end
)
13108 bool unchanged_p
= true;
13110 /* If text or overlays have changed, see where. */
13111 if (window_outdated (w
))
13113 /* Gap in the line? */
13114 if (GPT
< start
|| Z
- GPT
< end
)
13115 unchanged_p
= false;
13117 /* Changes start in front of the line, or end after it? */
13119 && (BEG_UNCHANGED
< start
- 1
13120 || END_UNCHANGED
< end
))
13121 unchanged_p
= false;
13123 /* If selective display, can't optimize if changes start at the
13124 beginning of the line. */
13126 && INTEGERP (BVAR (current_buffer
, selective_display
))
13127 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13128 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13129 unchanged_p
= false;
13131 /* If there are overlays at the start or end of the line, these
13132 may have overlay strings with newlines in them. A change at
13133 START, for instance, may actually concern the display of such
13134 overlay strings as well, and they are displayed on different
13135 lines. So, quickly rule out this case. (For the future, it
13136 might be desirable to implement something more telling than
13137 just BEG/END_UNCHANGED.) */
13140 if (BEG
+ BEG_UNCHANGED
== start
13141 && overlay_touches_p (start
))
13142 unchanged_p
= false;
13143 if (END_UNCHANGED
== end
13144 && overlay_touches_p (Z
- end
))
13145 unchanged_p
= false;
13148 /* Under bidi reordering, adding or deleting a character in the
13149 beginning of a paragraph, before the first strong directional
13150 character, can change the base direction of the paragraph (unless
13151 the buffer specifies a fixed paragraph direction), which will
13152 require redisplaying the whole paragraph. It might be worthwhile
13153 to find the paragraph limits and widen the range of redisplayed
13154 lines to that, but for now just give up this optimization. */
13155 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13156 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13157 unchanged_p
= false;
13160 return unchanged_p
;
13164 /* Do a frame update, taking possible shortcuts into account. This is
13165 the main external entry point for redisplay.
13167 If the last redisplay displayed an echo area message and that message
13168 is no longer requested, we clear the echo area or bring back the
13169 mini-buffer if that is in use. */
13174 redisplay_internal ();
13179 overlay_arrow_string_or_property (Lisp_Object var
)
13183 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13186 return Voverlay_arrow_string
;
13189 /* Return true if there are any overlay-arrows in current_buffer. */
13191 overlay_arrow_in_current_buffer_p (void)
13195 for (vlist
= Voverlay_arrow_variable_list
;
13197 vlist
= XCDR (vlist
))
13199 Lisp_Object var
= XCAR (vlist
);
13202 if (!SYMBOLP (var
))
13204 val
= find_symbol_value (var
);
13206 && current_buffer
== XMARKER (val
)->buffer
)
13213 /* Return true if any overlay_arrows have moved or overlay-arrow-string
13217 overlay_arrows_changed_p (void)
13221 for (vlist
= Voverlay_arrow_variable_list
;
13223 vlist
= XCDR (vlist
))
13225 Lisp_Object var
= XCAR (vlist
);
13226 Lisp_Object val
, pstr
;
13228 if (!SYMBOLP (var
))
13230 val
= find_symbol_value (var
);
13231 if (!MARKERP (val
))
13233 if (! EQ (COERCE_MARKER (val
),
13234 Fget (var
, Qlast_arrow_position
))
13235 || ! (pstr
= overlay_arrow_string_or_property (var
),
13236 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13242 /* Mark overlay arrows to be updated on next redisplay. */
13245 update_overlay_arrows (int up_to_date
)
13249 for (vlist
= Voverlay_arrow_variable_list
;
13251 vlist
= XCDR (vlist
))
13253 Lisp_Object var
= XCAR (vlist
);
13255 if (!SYMBOLP (var
))
13258 if (up_to_date
> 0)
13260 Lisp_Object val
= find_symbol_value (var
);
13261 Fput (var
, Qlast_arrow_position
,
13262 COERCE_MARKER (val
));
13263 Fput (var
, Qlast_arrow_string
,
13264 overlay_arrow_string_or_property (var
));
13266 else if (up_to_date
< 0
13267 || !NILP (Fget (var
, Qlast_arrow_position
)))
13269 Fput (var
, Qlast_arrow_position
, Qt
);
13270 Fput (var
, Qlast_arrow_string
, Qt
);
13276 /* Return overlay arrow string to display at row.
13277 Return integer (bitmap number) for arrow bitmap in left fringe.
13278 Return nil if no overlay arrow. */
13281 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13285 for (vlist
= Voverlay_arrow_variable_list
;
13287 vlist
= XCDR (vlist
))
13289 Lisp_Object var
= XCAR (vlist
);
13292 if (!SYMBOLP (var
))
13295 val
= find_symbol_value (var
);
13298 && current_buffer
== XMARKER (val
)->buffer
13299 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13301 if (FRAME_WINDOW_P (it
->f
)
13302 /* FIXME: if ROW->reversed_p is set, this should test
13303 the right fringe, not the left one. */
13304 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13306 #ifdef HAVE_WINDOW_SYSTEM
13307 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13309 int fringe_bitmap
= lookup_fringe_bitmap (val
);
13310 if (fringe_bitmap
!= 0)
13311 return make_number (fringe_bitmap
);
13314 return make_number (-1); /* Use default arrow bitmap. */
13316 return overlay_arrow_string_or_property (var
);
13323 /* Return true if point moved out of or into a composition. Otherwise
13324 return false. PREV_BUF and PREV_PT are the last point buffer and
13325 position. BUF and PT are the current point buffer and position. */
13328 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13329 struct buffer
*buf
, ptrdiff_t pt
)
13331 ptrdiff_t start
, end
;
13333 Lisp_Object buffer
;
13335 XSETBUFFER (buffer
, buf
);
13336 /* Check a composition at the last point if point moved within the
13338 if (prev_buf
== buf
)
13341 /* Point didn't move. */
13344 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13345 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13346 && composition_valid_p (start
, end
, prop
)
13347 && start
< prev_pt
&& end
> prev_pt
)
13348 /* The last point was within the composition. Return true iff
13349 point moved out of the composition. */
13350 return (pt
<= start
|| pt
>= end
);
13353 /* Check a composition at the current point. */
13354 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13355 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13356 && composition_valid_p (start
, end
, prop
)
13357 && start
< pt
&& end
> pt
);
13360 /* Reconsider the clip changes of buffer which is displayed in W. */
13363 reconsider_clip_changes (struct window
*w
)
13365 struct buffer
*b
= XBUFFER (w
->contents
);
13367 if (b
->clip_changed
13368 && w
->window_end_valid
13369 && w
->current_matrix
->buffer
== b
13370 && w
->current_matrix
->zv
== BUF_ZV (b
)
13371 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13372 b
->clip_changed
= false;
13374 /* If display wasn't paused, and W is not a tool bar window, see if
13375 point has been moved into or out of a composition. In that case,
13376 set b->clip_changed to force updating the screen. If
13377 b->clip_changed has already been set, skip this check. */
13378 if (!b
->clip_changed
&& w
->window_end_valid
)
13380 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13381 ? PT
: marker_position (w
->pointm
));
13383 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13384 && check_point_in_composition (w
->current_matrix
->buffer
,
13385 w
->last_point
, b
, pt
))
13386 b
->clip_changed
= true;
13391 propagate_buffer_redisplay (void)
13392 { /* Resetting b->text->redisplay is problematic!
13393 We can't just reset it in the case that some window that displays
13394 it has not been redisplayed; and such a window can stay
13395 unredisplayed for a long time if it's currently invisible.
13396 But we do want to reset it at the end of redisplay otherwise
13397 its displayed windows will keep being redisplayed over and over
13399 So we copy all b->text->redisplay flags up to their windows here,
13400 such that mark_window_display_accurate can safely reset
13401 b->text->redisplay. */
13402 Lisp_Object ws
= window_list ();
13403 for (; CONSP (ws
); ws
= XCDR (ws
))
13405 struct window
*thisw
= XWINDOW (XCAR (ws
));
13406 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13407 if (thisb
->text
->redisplay
)
13408 thisw
->redisplay
= true;
13412 #define STOP_POLLING \
13413 do { if (! polling_stopped_here) stop_polling (); \
13414 polling_stopped_here = true; } while (false)
13416 #define RESUME_POLLING \
13417 do { if (polling_stopped_here) start_polling (); \
13418 polling_stopped_here = false; } while (false)
13421 /* Perhaps in the future avoid recentering windows if it
13422 is not necessary; currently that causes some problems. */
13425 redisplay_internal (void)
13427 struct window
*w
= XWINDOW (selected_window
);
13431 bool must_finish
= false, match_p
;
13432 struct text_pos tlbufpos
, tlendpos
;
13433 int number_of_visible_frames
;
13436 bool polling_stopped_here
= false;
13437 Lisp_Object tail
, frame
;
13439 /* True means redisplay has to consider all windows on all
13440 frames. False, only selected_window is considered. */
13441 bool consider_all_windows_p
;
13443 /* True means redisplay has to redisplay the miniwindow. */
13444 bool update_miniwindow_p
= false;
13446 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13448 /* No redisplay if running in batch mode or frame is not yet fully
13449 initialized, or redisplay is explicitly turned off by setting
13450 Vinhibit_redisplay. */
13451 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13452 || !NILP (Vinhibit_redisplay
))
13455 /* Don't examine these until after testing Vinhibit_redisplay.
13456 When Emacs is shutting down, perhaps because its connection to
13457 X has dropped, we should not look at them at all. */
13458 fr
= XFRAME (w
->frame
);
13459 sf
= SELECTED_FRAME ();
13461 if (!fr
->glyphs_initialized_p
)
13464 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13465 if (popup_activated ())
13469 /* I don't think this happens but let's be paranoid. */
13470 if (redisplaying_p
)
13473 /* Record a function that clears redisplaying_p
13474 when we leave this function. */
13475 count
= SPECPDL_INDEX ();
13476 record_unwind_protect_void (unwind_redisplay
);
13477 redisplaying_p
= true;
13478 specbind (Qinhibit_free_realized_faces
, Qnil
);
13480 /* Record this function, so it appears on the profiler's backtraces. */
13481 record_in_backtrace (Qredisplay_internal
, 0, 0);
13483 FOR_EACH_FRAME (tail
, frame
)
13484 XFRAME (frame
)->already_hscrolled_p
= false;
13487 /* Remember the currently selected window. */
13491 forget_escape_and_glyphless_faces ();
13493 inhibit_free_realized_faces
= false;
13495 /* If face_change, init_iterator will free all realized faces, which
13496 includes the faces referenced from current matrices. So, we
13497 can't reuse current matrices in this case. */
13499 windows_or_buffers_changed
= 47;
13501 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13502 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13504 /* Since frames on a single ASCII terminal share the same
13505 display area, displaying a different frame means redisplay
13506 the whole thing. */
13507 SET_FRAME_GARBAGED (sf
);
13509 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13511 FRAME_TTY (sf
)->previous_frame
= sf
;
13514 /* Set the visible flags for all frames. Do this before checking for
13515 resized or garbaged frames; they want to know if their frames are
13516 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13517 number_of_visible_frames
= 0;
13519 FOR_EACH_FRAME (tail
, frame
)
13521 struct frame
*f
= XFRAME (frame
);
13523 if (FRAME_VISIBLE_P (f
))
13525 ++number_of_visible_frames
;
13526 /* Adjust matrices for visible frames only. */
13527 if (f
->fonts_changed
)
13529 adjust_frame_glyphs (f
);
13530 /* Disable all redisplay optimizations for this frame.
13531 This is because adjust_frame_glyphs resets the
13532 enabled_p flag for all glyph rows of all windows, so
13533 many optimizations will fail anyway, and some might
13534 fail to test that flag and do bogus things as
13536 SET_FRAME_GARBAGED (f
);
13537 f
->fonts_changed
= false;
13539 /* If cursor type has been changed on the frame
13540 other than selected, consider all frames. */
13541 if (f
!= sf
&& f
->cursor_type_changed
)
13542 fset_redisplay (f
);
13544 clear_desired_matrices (f
);
13547 /* Notice any pending interrupt request to change frame size. */
13548 do_pending_window_change (true);
13550 /* do_pending_window_change could change the selected_window due to
13551 frame resizing which makes the selected window too small. */
13552 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13555 /* Clear frames marked as garbaged. */
13556 clear_garbaged_frames ();
13558 /* Build menubar and tool-bar items. */
13559 if (NILP (Vmemory_full
))
13560 prepare_menu_bars ();
13562 reconsider_clip_changes (w
);
13564 /* In most cases selected window displays current buffer. */
13565 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13568 /* Detect case that we need to write or remove a star in the mode line. */
13569 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13570 w
->update_mode_line
= true;
13572 if (mode_line_update_needed (w
))
13573 w
->update_mode_line
= true;
13575 /* If reconsider_clip_changes above decided that the narrowing
13576 in the current buffer changed, make sure all other windows
13577 showing that buffer will be redisplayed. */
13578 if (current_buffer
->clip_changed
)
13579 bset_update_mode_line (current_buffer
);
13582 /* Normally the message* functions will have already displayed and
13583 updated the echo area, but the frame may have been trashed, or
13584 the update may have been preempted, so display the echo area
13585 again here. Checking message_cleared_p captures the case that
13586 the echo area should be cleared. */
13587 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13588 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13589 || (message_cleared_p
13590 && minibuf_level
== 0
13591 /* If the mini-window is currently selected, this means the
13592 echo-area doesn't show through. */
13593 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13595 echo_area_display (false);
13597 /* If echo_area_display resizes the mini-window, the redisplay and
13598 window_sizes_changed flags of the selected frame are set, but
13599 it's too late for the hooks in window-size-change-functions,
13600 which have been examined already in prepare_menu_bars. So in
13601 that case we call the hooks here only for the selected frame. */
13602 if (sf
->redisplay
&& FRAME_WINDOW_SIZES_CHANGED (sf
))
13604 Lisp_Object functions
;
13605 ptrdiff_t count1
= SPECPDL_INDEX ();
13607 record_unwind_save_match_data ();
13609 /* Clear flag first in case we get an error below. */
13610 FRAME_WINDOW_SIZES_CHANGED (sf
) = false;
13611 functions
= Vwindow_size_change_functions
;
13613 while (CONSP (functions
))
13615 if (!EQ (XCAR (functions
), Qt
))
13616 call1 (XCAR (functions
), selected_frame
);
13617 functions
= XCDR (functions
);
13620 unbind_to (count1
, Qnil
);
13623 if (message_cleared_p
)
13624 update_miniwindow_p
= true;
13626 must_finish
= true;
13628 /* If we don't display the current message, don't clear the
13629 message_cleared_p flag, because, if we did, we wouldn't clear
13630 the echo area in the next redisplay which doesn't preserve
13632 if (!display_last_displayed_message_p
)
13633 message_cleared_p
= false;
13635 else if (EQ (selected_window
, minibuf_window
)
13636 && (current_buffer
->clip_changed
|| window_outdated (w
))
13637 && resize_mini_window (w
, false))
13641 Lisp_Object functions
;
13642 ptrdiff_t count1
= SPECPDL_INDEX ();
13644 record_unwind_save_match_data ();
13646 /* Clear flag first in case we get an error below. */
13647 FRAME_WINDOW_SIZES_CHANGED (sf
) = false;
13648 functions
= Vwindow_size_change_functions
;
13650 while (CONSP (functions
))
13652 if (!EQ (XCAR (functions
), Qt
))
13653 call1 (XCAR (functions
), selected_frame
);
13654 functions
= XCDR (functions
);
13657 unbind_to (count1
, Qnil
);
13660 /* Resized active mini-window to fit the size of what it is
13661 showing if its contents might have changed. */
13662 must_finish
= true;
13664 /* If window configuration was changed, frames may have been
13665 marked garbaged. Clear them or we will experience
13666 surprises wrt scrolling. */
13667 clear_garbaged_frames ();
13670 if (windows_or_buffers_changed
&& !update_mode_lines
)
13671 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13672 only the windows's contents needs to be refreshed, or whether the
13673 mode-lines also need a refresh. */
13674 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13675 ? REDISPLAY_SOME
: 32);
13677 /* If specs for an arrow have changed, do thorough redisplay
13678 to ensure we remove any arrow that should no longer exist. */
13679 if (overlay_arrows_changed_p ())
13680 /* Apparently, this is the only case where we update other windows,
13681 without updating other mode-lines. */
13682 windows_or_buffers_changed
= 49;
13684 consider_all_windows_p
= (update_mode_lines
13685 || windows_or_buffers_changed
);
13687 #define AINC(a,i) \
13689 Lisp_Object entry = Fgethash (make_number (i), a, make_number (0)); \
13690 if (INTEGERP (entry)) \
13691 Fputhash (make_number (i), make_number (1 + XINT (entry)), a); \
13694 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13695 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13697 /* Optimize the case that only the line containing the cursor in the
13698 selected window has changed. Variables starting with this_ are
13699 set in display_line and record information about the line
13700 containing the cursor. */
13701 tlbufpos
= this_line_start_pos
;
13702 tlendpos
= this_line_end_pos
;
13703 if (!consider_all_windows_p
13704 && CHARPOS (tlbufpos
) > 0
13705 && !w
->update_mode_line
13706 && !current_buffer
->clip_changed
13707 && !current_buffer
->prevent_redisplay_optimizations_p
13708 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13709 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13710 && !XFRAME (w
->frame
)->cursor_type_changed
13711 && !XFRAME (w
->frame
)->face_change
13712 /* Make sure recorded data applies to current buffer, etc. */
13713 && this_line_buffer
== current_buffer
13716 && !w
->optional_new_start
13717 /* Point must be on the line that we have info recorded about. */
13718 && PT
>= CHARPOS (tlbufpos
)
13719 && PT
<= Z
- CHARPOS (tlendpos
)
13720 /* All text outside that line, including its final newline,
13721 must be unchanged. */
13722 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13723 CHARPOS (tlendpos
)))
13725 if (CHARPOS (tlbufpos
) > BEGV
13726 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13727 && (CHARPOS (tlbufpos
) == ZV
13728 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13729 /* Former continuation line has disappeared by becoming empty. */
13731 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13733 /* We have to handle the case of continuation around a
13734 wide-column character (see the comment in indent.c around
13737 For instance, in the following case:
13739 -------- Insert --------
13740 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13741 J_I_ ==> J_I_ `^^' are cursors.
13745 As we have to redraw the line above, we cannot use this
13749 int line_height_before
= this_line_pixel_height
;
13751 /* Note that start_display will handle the case that the
13752 line starting at tlbufpos is a continuation line. */
13753 start_display (&it
, w
, tlbufpos
);
13755 /* Implementation note: It this still necessary? */
13756 if (it
.current_x
!= this_line_start_x
)
13759 TRACE ((stderr
, "trying display optimization 1\n"));
13760 w
->cursor
.vpos
= -1;
13761 overlay_arrow_seen
= false;
13762 it
.vpos
= this_line_vpos
;
13763 it
.current_y
= this_line_y
;
13764 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13765 display_line (&it
);
13767 /* If line contains point, is not continued,
13768 and ends at same distance from eob as before, we win. */
13769 if (w
->cursor
.vpos
>= 0
13770 /* Line is not continued, otherwise this_line_start_pos
13771 would have been set to 0 in display_line. */
13772 && CHARPOS (this_line_start_pos
)
13773 /* Line ends as before. */
13774 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13775 /* Line has same height as before. Otherwise other lines
13776 would have to be shifted up or down. */
13777 && this_line_pixel_height
== line_height_before
)
13779 /* If this is not the window's last line, we must adjust
13780 the charstarts of the lines below. */
13781 if (it
.current_y
< it
.last_visible_y
)
13783 struct glyph_row
*row
13784 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13785 ptrdiff_t delta
, delta_bytes
;
13787 /* We used to distinguish between two cases here,
13788 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13789 when the line ends in a newline or the end of the
13790 buffer's accessible portion. But both cases did
13791 the same, so they were collapsed. */
13793 - CHARPOS (tlendpos
)
13794 - MATRIX_ROW_START_CHARPOS (row
));
13795 delta_bytes
= (Z_BYTE
13796 - BYTEPOS (tlendpos
)
13797 - MATRIX_ROW_START_BYTEPOS (row
));
13799 increment_matrix_positions (w
->current_matrix
,
13800 this_line_vpos
+ 1,
13801 w
->current_matrix
->nrows
,
13802 delta
, delta_bytes
);
13805 /* If this row displays text now but previously didn't,
13806 or vice versa, w->window_end_vpos may have to be
13808 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13810 if (w
->window_end_vpos
< this_line_vpos
)
13811 w
->window_end_vpos
= this_line_vpos
;
13813 else if (w
->window_end_vpos
== this_line_vpos
13814 && this_line_vpos
> 0)
13815 w
->window_end_vpos
= this_line_vpos
- 1;
13816 w
->window_end_valid
= false;
13818 /* Update hint: No need to try to scroll in update_window. */
13819 w
->desired_matrix
->no_scrolling_p
= true;
13822 *w
->desired_matrix
->method
= 0;
13823 debug_method_add (w
, "optimization 1");
13825 #ifdef HAVE_WINDOW_SYSTEM
13826 update_window_fringes (w
, false);
13833 else if (/* Cursor position hasn't changed. */
13834 PT
== w
->last_point
13835 /* Make sure the cursor was last displayed
13836 in this window. Otherwise we have to reposition it. */
13838 /* PXW: Must be converted to pixels, probably. */
13839 && 0 <= w
->cursor
.vpos
13840 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13844 do_pending_window_change (true);
13845 /* If selected_window changed, redisplay again. */
13846 if (WINDOWP (selected_window
)
13847 && (w
= XWINDOW (selected_window
)) != sw
)
13850 /* We used to always goto end_of_redisplay here, but this
13851 isn't enough if we have a blinking cursor. */
13852 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13853 goto end_of_redisplay
;
13857 /* If highlighting the region, or if the cursor is in the echo area,
13858 then we can't just move the cursor. */
13859 else if (NILP (Vshow_trailing_whitespace
)
13860 && !cursor_in_echo_area
)
13863 struct glyph_row
*row
;
13865 /* Skip from tlbufpos to PT and see where it is. Note that
13866 PT may be in invisible text. If so, we will end at the
13867 next visible position. */
13868 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13869 NULL
, DEFAULT_FACE_ID
);
13870 it
.current_x
= this_line_start_x
;
13871 it
.current_y
= this_line_y
;
13872 it
.vpos
= this_line_vpos
;
13874 /* The call to move_it_to stops in front of PT, but
13875 moves over before-strings. */
13876 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13878 if (it
.vpos
== this_line_vpos
13879 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13882 eassert (this_line_vpos
== it
.vpos
);
13883 eassert (this_line_y
== it
.current_y
);
13884 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13885 if (cursor_row_fully_visible_p (w
, false, true))
13888 *w
->desired_matrix
->method
= 0;
13889 debug_method_add (w
, "optimization 3");
13901 /* Text changed drastically or point moved off of line. */
13902 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13905 CHARPOS (this_line_start_pos
) = 0;
13906 ++clear_face_cache_count
;
13907 #ifdef HAVE_WINDOW_SYSTEM
13908 ++clear_image_cache_count
;
13911 /* Build desired matrices, and update the display. If
13912 consider_all_windows_p, do it for all windows on all frames that
13913 require redisplay, as specified by their 'redisplay' flag.
13914 Otherwise do it for selected_window, only. */
13916 if (consider_all_windows_p
)
13918 FOR_EACH_FRAME (tail
, frame
)
13919 XFRAME (frame
)->updated_p
= false;
13921 propagate_buffer_redisplay ();
13923 FOR_EACH_FRAME (tail
, frame
)
13925 struct frame
*f
= XFRAME (frame
);
13927 /* We don't have to do anything for unselected terminal
13929 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13930 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13934 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13937 /* Only GC scrollbars when we redisplay the whole frame. */
13938 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13939 bool f_redisplay_flag
= f
->redisplay
;
13940 /* Mark all the scroll bars to be removed; we'll redeem
13941 the ones we want when we redisplay their windows. */
13942 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13943 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13945 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13946 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13947 /* Remember that the invisible frames need to be redisplayed next
13948 time they're visible. */
13949 else if (!REDISPLAY_SOME_P ())
13950 f
->redisplay
= true;
13952 /* The X error handler may have deleted that frame. */
13953 if (!FRAME_LIVE_P (f
))
13956 /* Any scroll bars which redisplay_windows should have
13957 nuked should now go away. */
13958 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13959 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13961 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13963 /* If fonts changed on visible frame, display again. */
13964 if (f
->fonts_changed
)
13966 adjust_frame_glyphs (f
);
13967 /* Disable all redisplay optimizations for this
13968 frame. For the reasons, see the comment near
13969 the previous call to adjust_frame_glyphs above. */
13970 SET_FRAME_GARBAGED (f
);
13971 f
->fonts_changed
= false;
13975 /* See if we have to hscroll. */
13976 if (!f
->already_hscrolled_p
)
13978 f
->already_hscrolled_p
= true;
13979 if (hscroll_windows (f
->root_window
))
13983 /* If the frame's redisplay flag was not set before
13984 we went about redisplaying its windows, but it is
13985 set now, that means we employed some redisplay
13986 optimizations inside redisplay_windows, and
13987 bypassed producing some screen lines. But if
13988 f->redisplay is now set, it might mean the old
13989 faces are no longer valid (e.g., if redisplaying
13990 some window called some Lisp which defined a new
13991 face or redefined an existing face), so trying to
13992 use them in update_frame will segfault.
13993 Therefore, we must redisplay this frame. */
13994 if (!f_redisplay_flag
&& f
->redisplay
)
13997 /* Prevent various kinds of signals during display
13998 update. stdio is not robust about handling
13999 signals, which can cause an apparent I/O error. */
14000 if (interrupt_input
)
14001 unrequest_sigio ();
14004 pending
|= update_frame (f
, false, false);
14005 f
->cursor_type_changed
= false;
14006 f
->updated_p
= true;
14011 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
14015 /* Do the mark_window_display_accurate after all windows have
14016 been redisplayed because this call resets flags in buffers
14017 which are needed for proper redisplay. */
14018 FOR_EACH_FRAME (tail
, frame
)
14020 struct frame
*f
= XFRAME (frame
);
14023 f
->redisplay
= false;
14024 mark_window_display_accurate (f
->root_window
, true);
14025 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
14026 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
14031 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
14033 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
14034 struct frame
*mini_frame
;
14036 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
14037 /* Use list_of_error, not Qerror, so that
14038 we catch only errors and don't run the debugger. */
14039 internal_condition_case_1 (redisplay_window_1
, selected_window
,
14041 redisplay_window_error
);
14042 if (update_miniwindow_p
)
14043 internal_condition_case_1 (redisplay_window_1
, mini_window
,
14045 redisplay_window_error
);
14047 /* Compare desired and current matrices, perform output. */
14050 /* If fonts changed, display again. Likewise if redisplay_window_1
14051 above caused some change (e.g., a change in faces) that requires
14052 considering the entire frame again. */
14053 if (sf
->fonts_changed
|| sf
->redisplay
)
14057 /* Set this to force a more thorough redisplay.
14058 Otherwise, we might immediately loop back to the
14059 above "else-if" clause (since all the conditions that
14060 led here might still be true), and we will then
14061 infloop, because the selected-frame's redisplay flag
14062 is not (and cannot be) reset. */
14063 windows_or_buffers_changed
= 50;
14068 /* Prevent freeing of realized faces, since desired matrices are
14069 pending that reference the faces we computed and cached. */
14070 inhibit_free_realized_faces
= true;
14072 /* Prevent various kinds of signals during display update.
14073 stdio is not robust about handling signals,
14074 which can cause an apparent I/O error. */
14075 if (interrupt_input
)
14076 unrequest_sigio ();
14079 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
14081 if (hscroll_windows (selected_window
))
14084 XWINDOW (selected_window
)->must_be_updated_p
= true;
14085 pending
= update_frame (sf
, false, false);
14086 sf
->cursor_type_changed
= false;
14089 /* We may have called echo_area_display at the top of this
14090 function. If the echo area is on another frame, that may
14091 have put text on a frame other than the selected one, so the
14092 above call to update_frame would not have caught it. Catch
14094 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
14095 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
14097 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
14099 XWINDOW (mini_window
)->must_be_updated_p
= true;
14100 pending
|= update_frame (mini_frame
, false, false);
14101 mini_frame
->cursor_type_changed
= false;
14102 if (!pending
&& hscroll_windows (mini_window
))
14107 /* If display was paused because of pending input, make sure we do a
14108 thorough update the next time. */
14111 /* Prevent the optimization at the beginning of
14112 redisplay_internal that tries a single-line update of the
14113 line containing the cursor in the selected window. */
14114 CHARPOS (this_line_start_pos
) = 0;
14116 /* Let the overlay arrow be updated the next time. */
14117 update_overlay_arrows (0);
14119 /* If we pause after scrolling, some rows in the current
14120 matrices of some windows are not valid. */
14121 if (!WINDOW_FULL_WIDTH_P (w
)
14122 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
14123 update_mode_lines
= 36;
14127 if (!consider_all_windows_p
)
14129 /* This has already been done above if
14130 consider_all_windows_p is set. */
14131 if (XBUFFER (w
->contents
)->text
->redisplay
14132 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
14133 /* This can happen if b->text->redisplay was set during
14135 propagate_buffer_redisplay ();
14136 mark_window_display_accurate_1 (w
, true);
14138 /* Say overlay arrows are up to date. */
14139 update_overlay_arrows (1);
14141 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
14142 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
14145 update_mode_lines
= 0;
14146 windows_or_buffers_changed
= 0;
14149 /* Start SIGIO interrupts coming again. Having them off during the
14150 code above makes it less likely one will discard output, but not
14151 impossible, since there might be stuff in the system buffer here.
14152 But it is much hairier to try to do anything about that. */
14153 if (interrupt_input
)
14157 /* If a frame has become visible which was not before, redisplay
14158 again, so that we display it. Expose events for such a frame
14159 (which it gets when becoming visible) don't call the parts of
14160 redisplay constructing glyphs, so simply exposing a frame won't
14161 display anything in this case. So, we have to display these
14162 frames here explicitly. */
14167 FOR_EACH_FRAME (tail
, frame
)
14169 if (XFRAME (frame
)->visible
)
14173 if (new_count
!= number_of_visible_frames
)
14174 windows_or_buffers_changed
= 52;
14177 /* Change frame size now if a change is pending. */
14178 do_pending_window_change (true);
14180 /* If we just did a pending size change, or have additional
14181 visible frames, or selected_window changed, redisplay again. */
14182 if ((windows_or_buffers_changed
&& !pending
)
14183 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14186 /* Clear the face and image caches.
14188 We used to do this only if consider_all_windows_p. But the cache
14189 needs to be cleared if a timer creates images in the current
14190 buffer (e.g. the test case in Bug#6230). */
14192 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14194 clear_face_cache (false);
14195 clear_face_cache_count
= 0;
14198 #ifdef HAVE_WINDOW_SYSTEM
14199 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14201 clear_image_caches (Qnil
);
14202 clear_image_cache_count
= 0;
14204 #endif /* HAVE_WINDOW_SYSTEM */
14208 ns_set_doc_edited ();
14210 if (interrupt_input
&& interrupts_deferred
)
14213 unbind_to (count
, Qnil
);
14218 /* Redisplay, but leave alone any recent echo area message unless
14219 another message has been requested in its place.
14221 This is useful in situations where you need to redisplay but no
14222 user action has occurred, making it inappropriate for the message
14223 area to be cleared. See tracking_off and
14224 wait_reading_process_output for examples of these situations.
14226 FROM_WHERE is an integer saying from where this function was
14227 called. This is useful for debugging. */
14230 redisplay_preserve_echo_area (int from_where
)
14232 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14234 if (!NILP (echo_area_buffer
[1]))
14236 /* We have a previously displayed message, but no current
14237 message. Redisplay the previous message. */
14238 display_last_displayed_message_p
= true;
14239 redisplay_internal ();
14240 display_last_displayed_message_p
= false;
14243 redisplay_internal ();
14245 flush_frame (SELECTED_FRAME ());
14249 /* Function registered with record_unwind_protect in redisplay_internal. */
14252 unwind_redisplay (void)
14254 redisplaying_p
= false;
14258 /* Mark the display of leaf window W as accurate or inaccurate.
14259 If ACCURATE_P, mark display of W as accurate.
14260 If !ACCURATE_P, arrange for W to be redisplayed the next
14261 time redisplay_internal is called. */
14264 mark_window_display_accurate_1 (struct window
*w
, bool accurate_p
)
14266 struct buffer
*b
= XBUFFER (w
->contents
);
14268 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14269 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14270 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14274 b
->clip_changed
= false;
14275 b
->prevent_redisplay_optimizations_p
= false;
14276 eassert (buffer_window_count (b
) > 0);
14277 /* Resetting b->text->redisplay is problematic!
14278 In order to make it safer to do it here, redisplay_internal must
14279 have copied all b->text->redisplay to their respective windows. */
14280 b
->text
->redisplay
= false;
14282 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14283 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14284 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14285 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14287 w
->current_matrix
->buffer
= b
;
14288 w
->current_matrix
->begv
= BUF_BEGV (b
);
14289 w
->current_matrix
->zv
= BUF_ZV (b
);
14291 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14292 w
->last_cursor_off_p
= w
->cursor_off_p
;
14294 if (w
== XWINDOW (selected_window
))
14295 w
->last_point
= BUF_PT (b
);
14297 w
->last_point
= marker_position (w
->pointm
);
14299 w
->window_end_valid
= true;
14300 w
->update_mode_line
= false;
14303 w
->redisplay
= !accurate_p
;
14307 /* Mark the display of windows in the window tree rooted at WINDOW as
14308 accurate or inaccurate. If ACCURATE_P, mark display of
14309 windows as accurate. If !ACCURATE_P, arrange for windows to
14310 be redisplayed the next time redisplay_internal is called. */
14313 mark_window_display_accurate (Lisp_Object window
, bool accurate_p
)
14317 for (; !NILP (window
); window
= w
->next
)
14319 w
= XWINDOW (window
);
14320 if (WINDOWP (w
->contents
))
14321 mark_window_display_accurate (w
->contents
, accurate_p
);
14323 mark_window_display_accurate_1 (w
, accurate_p
);
14327 update_overlay_arrows (1);
14329 /* Force a thorough redisplay the next time by setting
14330 last_arrow_position and last_arrow_string to t, which is
14331 unequal to any useful value of Voverlay_arrow_... */
14332 update_overlay_arrows (-1);
14336 /* Return value in display table DP (Lisp_Char_Table *) for character
14337 C. Since a display table doesn't have any parent, we don't have to
14338 follow parent. Do not call this function directly but use the
14339 macro DISP_CHAR_VECTOR. */
14342 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14346 if (ASCII_CHAR_P (c
))
14349 if (SUB_CHAR_TABLE_P (val
))
14350 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14356 XSETCHAR_TABLE (table
, dp
);
14357 val
= char_table_ref (table
, c
);
14366 /***********************************************************************
14368 ***********************************************************************/
14370 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14373 redisplay_windows (Lisp_Object window
)
14375 while (!NILP (window
))
14377 struct window
*w
= XWINDOW (window
);
14379 if (WINDOWP (w
->contents
))
14380 redisplay_windows (w
->contents
);
14381 else if (BUFFERP (w
->contents
))
14383 displayed_buffer
= XBUFFER (w
->contents
);
14384 /* Use list_of_error, not Qerror, so that
14385 we catch only errors and don't run the debugger. */
14386 internal_condition_case_1 (redisplay_window_0
, window
,
14388 redisplay_window_error
);
14396 redisplay_window_error (Lisp_Object ignore
)
14398 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14403 redisplay_window_0 (Lisp_Object window
)
14405 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14406 redisplay_window (window
, false);
14411 redisplay_window_1 (Lisp_Object window
)
14413 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14414 redisplay_window (window
, true);
14419 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14420 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14421 which positions recorded in ROW differ from current buffer
14424 Return true iff cursor is on this row. */
14427 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14428 struct glyph_matrix
*matrix
,
14429 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14432 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14433 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14434 struct glyph
*cursor
= NULL
;
14435 /* The last known character position in row. */
14436 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14438 ptrdiff_t pt_old
= PT
- delta
;
14439 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14440 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14441 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14442 /* A glyph beyond the edge of TEXT_AREA which we should never
14444 struct glyph
*glyphs_end
= end
;
14445 /* True means we've found a match for cursor position, but that
14446 glyph has the avoid_cursor_p flag set. */
14447 bool match_with_avoid_cursor
= false;
14448 /* True means we've seen at least one glyph that came from a
14450 bool string_seen
= false;
14451 /* Largest and smallest buffer positions seen so far during scan of
14453 ptrdiff_t bpos_max
= pos_before
;
14454 ptrdiff_t bpos_min
= pos_after
;
14455 /* Last buffer position covered by an overlay string with an integer
14456 `cursor' property. */
14457 ptrdiff_t bpos_covered
= 0;
14458 /* True means the display string on which to display the cursor
14459 comes from a text property, not from an overlay. */
14460 bool string_from_text_prop
= false;
14462 /* Don't even try doing anything if called for a mode-line or
14463 header-line row, since the rest of the code isn't prepared to
14464 deal with such calamities. */
14465 eassert (!row
->mode_line_p
);
14466 if (row
->mode_line_p
)
14469 /* Skip over glyphs not having an object at the start and the end of
14470 the row. These are special glyphs like truncation marks on
14471 terminal frames. */
14472 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14474 if (!row
->reversed_p
)
14477 && NILP (glyph
->object
)
14478 && glyph
->charpos
< 0)
14480 x
+= glyph
->pixel_width
;
14484 && NILP ((end
- 1)->object
)
14485 /* CHARPOS is zero for blanks and stretch glyphs
14486 inserted by extend_face_to_end_of_line. */
14487 && (end
- 1)->charpos
<= 0)
14489 glyph_before
= glyph
- 1;
14496 /* If the glyph row is reversed, we need to process it from back
14497 to front, so swap the edge pointers. */
14498 glyphs_end
= end
= glyph
- 1;
14499 glyph
+= row
->used
[TEXT_AREA
] - 1;
14501 while (glyph
> end
+ 1
14502 && NILP (glyph
->object
)
14503 && glyph
->charpos
< 0)
14506 x
-= glyph
->pixel_width
;
14508 if (NILP (glyph
->object
) && glyph
->charpos
< 0)
14510 /* By default, in reversed rows we put the cursor on the
14511 rightmost (first in the reading order) glyph. */
14512 for (g
= end
+ 1; g
< glyph
; g
++)
14513 x
+= g
->pixel_width
;
14515 && NILP ((end
+ 1)->object
)
14516 && (end
+ 1)->charpos
<= 0)
14518 glyph_before
= glyph
+ 1;
14522 else if (row
->reversed_p
)
14524 /* In R2L rows that don't display text, put the cursor on the
14525 rightmost glyph. Case in point: an empty last line that is
14526 part of an R2L paragraph. */
14528 /* Avoid placing the cursor on the last glyph of the row, where
14529 on terminal frames we hold the vertical border between
14530 adjacent windows. */
14531 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14532 && !WINDOW_RIGHTMOST_P (w
)
14533 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14535 x
= -1; /* will be computed below, at label compute_x */
14538 /* Step 1: Try to find the glyph whose character position
14539 corresponds to point. If that's not possible, find 2 glyphs
14540 whose character positions are the closest to point, one before
14541 point, the other after it. */
14542 if (!row
->reversed_p
)
14543 while (/* not marched to end of glyph row */
14545 /* glyph was not inserted by redisplay for internal purposes */
14546 && !NILP (glyph
->object
))
14548 if (BUFFERP (glyph
->object
))
14550 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14552 if (glyph
->charpos
> bpos_max
)
14553 bpos_max
= glyph
->charpos
;
14554 if (glyph
->charpos
< bpos_min
)
14555 bpos_min
= glyph
->charpos
;
14556 if (!glyph
->avoid_cursor_p
)
14558 /* If we hit point, we've found the glyph on which to
14559 display the cursor. */
14562 match_with_avoid_cursor
= false;
14565 /* See if we've found a better approximation to
14566 POS_BEFORE or to POS_AFTER. */
14567 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14569 pos_before
= glyph
->charpos
;
14570 glyph_before
= glyph
;
14572 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14574 pos_after
= glyph
->charpos
;
14575 glyph_after
= glyph
;
14578 else if (dpos
== 0)
14579 match_with_avoid_cursor
= true;
14581 else if (STRINGP (glyph
->object
))
14583 Lisp_Object chprop
;
14584 ptrdiff_t glyph_pos
= glyph
->charpos
;
14586 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14588 if (!NILP (chprop
))
14590 /* If the string came from a `display' text property,
14591 look up the buffer position of that property and
14592 use that position to update bpos_max, as if we
14593 actually saw such a position in one of the row's
14594 glyphs. This helps with supporting integer values
14595 of `cursor' property on the display string in
14596 situations where most or all of the row's buffer
14597 text is completely covered by display properties,
14598 so that no glyph with valid buffer positions is
14599 ever seen in the row. */
14600 ptrdiff_t prop_pos
=
14601 string_buffer_position_lim (glyph
->object
, pos_before
,
14604 if (prop_pos
>= pos_before
)
14605 bpos_max
= prop_pos
;
14607 if (INTEGERP (chprop
))
14609 bpos_covered
= bpos_max
+ XINT (chprop
);
14610 /* If the `cursor' property covers buffer positions up
14611 to and including point, we should display cursor on
14612 this glyph. Note that, if a `cursor' property on one
14613 of the string's characters has an integer value, we
14614 will break out of the loop below _before_ we get to
14615 the position match above. IOW, integer values of
14616 the `cursor' property override the "exact match for
14617 point" strategy of positioning the cursor. */
14618 /* Implementation note: bpos_max == pt_old when, e.g.,
14619 we are in an empty line, where bpos_max is set to
14620 MATRIX_ROW_START_CHARPOS, see above. */
14621 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14628 string_seen
= true;
14630 x
+= glyph
->pixel_width
;
14633 else if (glyph
> end
) /* row is reversed */
14634 while (!NILP (glyph
->object
))
14636 if (BUFFERP (glyph
->object
))
14638 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14640 if (glyph
->charpos
> bpos_max
)
14641 bpos_max
= glyph
->charpos
;
14642 if (glyph
->charpos
< bpos_min
)
14643 bpos_min
= glyph
->charpos
;
14644 if (!glyph
->avoid_cursor_p
)
14648 match_with_avoid_cursor
= false;
14651 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14653 pos_before
= glyph
->charpos
;
14654 glyph_before
= glyph
;
14656 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14658 pos_after
= glyph
->charpos
;
14659 glyph_after
= glyph
;
14662 else if (dpos
== 0)
14663 match_with_avoid_cursor
= true;
14665 else if (STRINGP (glyph
->object
))
14667 Lisp_Object chprop
;
14668 ptrdiff_t glyph_pos
= glyph
->charpos
;
14670 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14672 if (!NILP (chprop
))
14674 ptrdiff_t prop_pos
=
14675 string_buffer_position_lim (glyph
->object
, pos_before
,
14678 if (prop_pos
>= pos_before
)
14679 bpos_max
= prop_pos
;
14681 if (INTEGERP (chprop
))
14683 bpos_covered
= bpos_max
+ XINT (chprop
);
14684 /* If the `cursor' property covers buffer positions up
14685 to and including point, we should display cursor on
14687 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14693 string_seen
= true;
14696 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14698 x
--; /* can't use any pixel_width */
14701 x
-= glyph
->pixel_width
;
14704 /* Step 2: If we didn't find an exact match for point, we need to
14705 look for a proper place to put the cursor among glyphs between
14706 GLYPH_BEFORE and GLYPH_AFTER. */
14707 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14708 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14709 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14711 /* An empty line has a single glyph whose OBJECT is nil and
14712 whose CHARPOS is the position of a newline on that line.
14713 Note that on a TTY, there are more glyphs after that, which
14714 were produced by extend_face_to_end_of_line, but their
14715 CHARPOS is zero or negative. */
14716 bool empty_line_p
=
14717 ((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14718 && NILP (glyph
->object
) && glyph
->charpos
> 0
14719 /* On a TTY, continued and truncated rows also have a glyph at
14720 their end whose OBJECT is nil and whose CHARPOS is
14721 positive (the continuation and truncation glyphs), but such
14722 rows are obviously not "empty". */
14723 && !(row
->continued_p
|| row
->truncated_on_right_p
));
14725 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14727 ptrdiff_t ellipsis_pos
;
14729 /* Scan back over the ellipsis glyphs. */
14730 if (!row
->reversed_p
)
14732 ellipsis_pos
= (glyph
- 1)->charpos
;
14733 while (glyph
> row
->glyphs
[TEXT_AREA
]
14734 && (glyph
- 1)->charpos
== ellipsis_pos
)
14735 glyph
--, x
-= glyph
->pixel_width
;
14736 /* That loop always goes one position too far, including
14737 the glyph before the ellipsis. So scan forward over
14739 x
+= glyph
->pixel_width
;
14742 else /* row is reversed */
14744 ellipsis_pos
= (glyph
+ 1)->charpos
;
14745 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14746 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14747 glyph
++, x
+= glyph
->pixel_width
;
14748 x
-= glyph
->pixel_width
;
14752 else if (match_with_avoid_cursor
)
14754 cursor
= glyph_after
;
14757 else if (string_seen
)
14759 int incr
= row
->reversed_p
? -1 : +1;
14761 /* Need to find the glyph that came out of a string which is
14762 present at point. That glyph is somewhere between
14763 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14764 positioned between POS_BEFORE and POS_AFTER in the
14766 struct glyph
*start
, *stop
;
14767 ptrdiff_t pos
= pos_before
;
14771 /* If the row ends in a newline from a display string,
14772 reordering could have moved the glyphs belonging to the
14773 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14774 in this case we extend the search to the last glyph in
14775 the row that was not inserted by redisplay. */
14776 if (row
->ends_in_newline_from_string_p
)
14779 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14782 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14783 correspond to POS_BEFORE and POS_AFTER, respectively. We
14784 need START and STOP in the order that corresponds to the
14785 row's direction as given by its reversed_p flag. If the
14786 directionality of characters between POS_BEFORE and
14787 POS_AFTER is the opposite of the row's base direction,
14788 these characters will have been reordered for display,
14789 and we need to reverse START and STOP. */
14790 if (!row
->reversed_p
)
14792 start
= min (glyph_before
, glyph_after
);
14793 stop
= max (glyph_before
, glyph_after
);
14797 start
= max (glyph_before
, glyph_after
);
14798 stop
= min (glyph_before
, glyph_after
);
14800 for (glyph
= start
+ incr
;
14801 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14804 /* Any glyphs that come from the buffer are here because
14805 of bidi reordering. Skip them, and only pay
14806 attention to glyphs that came from some string. */
14807 if (STRINGP (glyph
->object
))
14811 /* If the display property covers the newline, we
14812 need to search for it one position farther. */
14813 ptrdiff_t lim
= pos_after
14814 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14816 string_from_text_prop
= false;
14817 str
= glyph
->object
;
14818 tem
= string_buffer_position_lim (str
, pos
, lim
, false);
14819 if (tem
== 0 /* from overlay */
14822 /* If the string from which this glyph came is
14823 found in the buffer at point, or at position
14824 that is closer to point than pos_after, then
14825 we've found the glyph we've been looking for.
14826 If it comes from an overlay (tem == 0), and
14827 it has the `cursor' property on one of its
14828 glyphs, record that glyph as a candidate for
14829 displaying the cursor. (As in the
14830 unidirectional version, we will display the
14831 cursor on the last candidate we find.) */
14834 || (tem
- pt_old
> 0 && tem
< pos_after
))
14836 /* The glyphs from this string could have
14837 been reordered. Find the one with the
14838 smallest string position. Or there could
14839 be a character in the string with the
14840 `cursor' property, which means display
14841 cursor on that character's glyph. */
14842 ptrdiff_t strpos
= glyph
->charpos
;
14847 string_from_text_prop
= true;
14850 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14851 && EQ (glyph
->object
, str
);
14855 ptrdiff_t gpos
= glyph
->charpos
;
14857 cprop
= Fget_char_property (make_number (gpos
),
14865 if (tem
&& glyph
->charpos
< strpos
)
14867 strpos
= glyph
->charpos
;
14873 || (tem
- pt_old
> 0 && tem
< pos_after
))
14877 pos
= tem
+ 1; /* don't find previous instances */
14879 /* This string is not what we want; skip all of the
14880 glyphs that came from it. */
14881 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14882 && EQ (glyph
->object
, str
))
14889 /* If we reached the end of the line, and END was from a string,
14890 the cursor is not on this line. */
14892 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14893 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14894 && STRINGP (end
->object
)
14895 && row
->continued_p
)
14898 /* A truncated row may not include PT among its character positions.
14899 Setting the cursor inside the scroll margin will trigger
14900 recalculation of hscroll in hscroll_window_tree. But if a
14901 display string covers point, defer to the string-handling
14902 code below to figure this out. */
14903 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14905 cursor
= glyph_before
;
14908 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14909 /* Zero-width characters produce no glyphs. */
14911 && (row
->reversed_p
14912 ? glyph_after
> glyphs_end
14913 : glyph_after
< glyphs_end
)))
14915 cursor
= glyph_after
;
14921 if (cursor
!= NULL
)
14923 else if (glyph
== glyphs_end
14924 && pos_before
== pos_after
14925 && STRINGP ((row
->reversed_p
14926 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14927 : row
->glyphs
[TEXT_AREA
])->object
))
14929 /* If all the glyphs of this row came from strings, put the
14930 cursor on the first glyph of the row. This avoids having the
14931 cursor outside of the text area in this very rare and hard
14935 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14936 : row
->glyphs
[TEXT_AREA
];
14942 /* Need to compute x that corresponds to GLYPH. */
14943 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14945 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14947 x
+= g
->pixel_width
;
14951 /* ROW could be part of a continued line, which, under bidi
14952 reordering, might have other rows whose start and end charpos
14953 occlude point. Only set w->cursor if we found a better
14954 approximation to the cursor position than we have from previously
14955 examined candidate rows belonging to the same continued line. */
14956 if (/* We already have a candidate row. */
14957 w
->cursor
.vpos
>= 0
14958 /* That candidate is not the row we are processing. */
14959 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14960 /* Make sure cursor.vpos specifies a row whose start and end
14961 charpos occlude point, and it is valid candidate for being a
14962 cursor-row. This is because some callers of this function
14963 leave cursor.vpos at the row where the cursor was displayed
14964 during the last redisplay cycle. */
14965 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14966 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14967 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14970 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14972 /* Don't consider glyphs that are outside TEXT_AREA. */
14973 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14975 /* Keep the candidate whose buffer position is the closest to
14976 point or has the `cursor' property. */
14977 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14978 w
->cursor
.hpos
>= 0
14979 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14980 && ((BUFFERP (g1
->object
)
14981 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14982 || (BUFFERP (glyph
->object
)
14983 && eabs (g1
->charpos
- pt_old
)
14984 < eabs (glyph
->charpos
- pt_old
))))
14985 /* Previous candidate is a glyph from a string that has
14986 a non-nil `cursor' property. */
14987 || (STRINGP (g1
->object
)
14988 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14989 Qcursor
, g1
->object
))
14990 /* Previous candidate is from the same display
14991 string as this one, and the display string
14992 came from a text property. */
14993 || (EQ (g1
->object
, glyph
->object
)
14994 && string_from_text_prop
)
14995 /* this candidate is from newline and its
14996 position is not an exact match */
14997 || (NILP (glyph
->object
)
14998 && glyph
->charpos
!= pt_old
)))))
15000 /* If this candidate gives an exact match, use that. */
15001 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
15002 /* If this candidate is a glyph created for the
15003 terminating newline of a line, and point is on that
15004 newline, it wins because it's an exact match. */
15005 || (!row
->continued_p
15006 && NILP (glyph
->object
)
15007 && glyph
->charpos
== 0
15008 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
15009 /* Otherwise, keep the candidate that comes from a row
15010 spanning less buffer positions. This may win when one or
15011 both candidate positions are on glyphs that came from
15012 display strings, for which we cannot compare buffer
15014 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
15015 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
15016 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
15019 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
15021 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
15022 w
->cursor
.y
= row
->y
+ dy
;
15024 if (w
== XWINDOW (selected_window
))
15026 if (!row
->continued_p
15027 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15030 this_line_buffer
= XBUFFER (w
->contents
);
15032 CHARPOS (this_line_start_pos
)
15033 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
15034 BYTEPOS (this_line_start_pos
)
15035 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
15037 CHARPOS (this_line_end_pos
)
15038 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
15039 BYTEPOS (this_line_end_pos
)
15040 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
15042 this_line_y
= w
->cursor
.y
;
15043 this_line_pixel_height
= row
->height
;
15044 this_line_vpos
= w
->cursor
.vpos
;
15045 this_line_start_x
= row
->x
;
15048 CHARPOS (this_line_start_pos
) = 0;
15055 /* Run window scroll functions, if any, for WINDOW with new window
15056 start STARTP. Sets the window start of WINDOW to that position.
15058 We assume that the window's buffer is really current. */
15060 static struct text_pos
15061 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
15063 struct window
*w
= XWINDOW (window
);
15064 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
15066 eassert (current_buffer
== XBUFFER (w
->contents
));
15068 if (!NILP (Vwindow_scroll_functions
))
15070 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
15071 make_number (CHARPOS (startp
)));
15072 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15073 /* In case the hook functions switch buffers. */
15074 set_buffer_internal (XBUFFER (w
->contents
));
15081 /* Make sure the line containing the cursor is fully visible.
15082 A value of true means there is nothing to be done.
15083 (Either the line is fully visible, or it cannot be made so,
15084 or we cannot tell.)
15086 If FORCE_P, return false even if partial visible cursor row
15087 is higher than window.
15089 If CURRENT_MATRIX_P, use the information from the
15090 window's current glyph matrix; otherwise use the desired glyph
15093 A value of false means the caller should do scrolling
15094 as if point had gone off the screen. */
15097 cursor_row_fully_visible_p (struct window
*w
, bool force_p
,
15098 bool current_matrix_p
)
15100 struct glyph_matrix
*matrix
;
15101 struct glyph_row
*row
;
15104 if (!make_cursor_line_fully_visible_p
)
15107 /* It's not always possible to find the cursor, e.g, when a window
15108 is full of overlay strings. Don't do anything in that case. */
15109 if (w
->cursor
.vpos
< 0)
15112 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
15113 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
15115 /* If the cursor row is not partially visible, there's nothing to do. */
15116 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
15119 /* If the row the cursor is in is taller than the window's height,
15120 it's not clear what to do, so do nothing. */
15121 window_height
= window_box_height (w
);
15122 if (row
->height
>= window_height
)
15124 if (!force_p
|| MINI_WINDOW_P (w
)
15125 || w
->vscroll
|| w
->cursor
.vpos
== 0)
15132 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
15133 means only WINDOW is redisplayed in redisplay_internal.
15134 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
15135 in redisplay_window to bring a partially visible line into view in
15136 the case that only the cursor has moved.
15138 LAST_LINE_MISFIT should be true if we're scrolling because the
15139 last screen line's vertical height extends past the end of the screen.
15143 1 if scrolling succeeded
15145 0 if scrolling didn't find point.
15147 -1 if new fonts have been loaded so that we must interrupt
15148 redisplay, adjust glyph matrices, and try again. */
15154 SCROLLING_NEED_LARGER_MATRICES
15157 /* If scroll-conservatively is more than this, never recenter.
15159 If you change this, don't forget to update the doc string of
15160 `scroll-conservatively' and the Emacs manual. */
15161 #define SCROLL_LIMIT 100
15164 try_scrolling (Lisp_Object window
, bool just_this_one_p
,
15165 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
15166 bool temp_scroll_step
, bool last_line_misfit
)
15168 struct window
*w
= XWINDOW (window
);
15169 struct frame
*f
= XFRAME (w
->frame
);
15170 struct text_pos pos
, startp
;
15172 int this_scroll_margin
, scroll_max
, rc
, height
;
15173 int dy
= 0, amount_to_scroll
= 0;
15174 bool scroll_down_p
= false;
15175 int extra_scroll_margin_lines
= last_line_misfit
;
15176 Lisp_Object aggressive
;
15177 /* We will never try scrolling more than this number of lines. */
15178 int scroll_limit
= SCROLL_LIMIT
;
15179 int frame_line_height
= default_line_pixel_height (w
);
15180 int window_total_lines
15181 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15184 debug_method_add (w
, "try_scrolling");
15187 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15189 /* Compute scroll margin height in pixels. We scroll when point is
15190 within this distance from the top or bottom of the window. */
15191 if (scroll_margin
> 0)
15192 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15193 * frame_line_height
;
15195 this_scroll_margin
= 0;
15197 /* Force arg_scroll_conservatively to have a reasonable value, to
15198 avoid scrolling too far away with slow move_it_* functions. Note
15199 that the user can supply scroll-conservatively equal to
15200 `most-positive-fixnum', which can be larger than INT_MAX. */
15201 if (arg_scroll_conservatively
> scroll_limit
)
15203 arg_scroll_conservatively
= scroll_limit
+ 1;
15204 scroll_max
= scroll_limit
* frame_line_height
;
15206 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15207 /* Compute how much we should try to scroll maximally to bring
15208 point into view. */
15209 scroll_max
= (max (scroll_step
,
15210 max (arg_scroll_conservatively
, temp_scroll_step
))
15211 * frame_line_height
);
15212 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15213 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15214 /* We're trying to scroll because of aggressive scrolling but no
15215 scroll_step is set. Choose an arbitrary one. */
15216 scroll_max
= 10 * frame_line_height
;
15222 /* Decide whether to scroll down. */
15223 if (PT
> CHARPOS (startp
))
15225 int scroll_margin_y
;
15227 /* Compute the pixel ypos of the scroll margin, then move IT to
15228 either that ypos or PT, whichever comes first. */
15229 start_display (&it
, w
, startp
);
15230 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15231 - frame_line_height
* extra_scroll_margin_lines
;
15232 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15233 (MOVE_TO_POS
| MOVE_TO_Y
));
15235 if (PT
> CHARPOS (it
.current
.pos
))
15237 int y0
= line_bottom_y (&it
);
15238 /* Compute how many pixels below window bottom to stop searching
15239 for PT. This avoids costly search for PT that is far away if
15240 the user limited scrolling by a small number of lines, but
15241 always finds PT if scroll_conservatively is set to a large
15242 number, such as most-positive-fixnum. */
15243 int slack
= max (scroll_max
, 10 * frame_line_height
);
15244 int y_to_move
= it
.last_visible_y
+ slack
;
15246 /* Compute the distance from the scroll margin to PT or to
15247 the scroll limit, whichever comes first. This should
15248 include the height of the cursor line, to make that line
15250 move_it_to (&it
, PT
, -1, y_to_move
,
15251 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15252 dy
= line_bottom_y (&it
) - y0
;
15254 if (dy
> scroll_max
)
15255 return SCROLLING_FAILED
;
15258 scroll_down_p
= true;
15264 /* Point is in or below the bottom scroll margin, so move the
15265 window start down. If scrolling conservatively, move it just
15266 enough down to make point visible. If scroll_step is set,
15267 move it down by scroll_step. */
15268 if (arg_scroll_conservatively
)
15270 = min (max (dy
, frame_line_height
),
15271 frame_line_height
* arg_scroll_conservatively
);
15272 else if (scroll_step
|| temp_scroll_step
)
15273 amount_to_scroll
= scroll_max
;
15276 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15277 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15278 if (NUMBERP (aggressive
))
15280 double float_amount
= XFLOATINT (aggressive
) * height
;
15281 int aggressive_scroll
= float_amount
;
15282 if (aggressive_scroll
== 0 && float_amount
> 0)
15283 aggressive_scroll
= 1;
15284 /* Don't let point enter the scroll margin near top of
15285 the window. This could happen if the value of
15286 scroll_up_aggressively is too large and there are
15287 non-zero margins, because scroll_up_aggressively
15288 means put point that fraction of window height
15289 _from_the_bottom_margin_. */
15290 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15291 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15292 amount_to_scroll
= dy
+ aggressive_scroll
;
15296 if (amount_to_scroll
<= 0)
15297 return SCROLLING_FAILED
;
15299 start_display (&it
, w
, startp
);
15300 if (arg_scroll_conservatively
<= scroll_limit
)
15301 move_it_vertically (&it
, amount_to_scroll
);
15304 /* Extra precision for users who set scroll-conservatively
15305 to a large number: make sure the amount we scroll
15306 the window start is never less than amount_to_scroll,
15307 which was computed as distance from window bottom to
15308 point. This matters when lines at window top and lines
15309 below window bottom have different height. */
15311 void *it1data
= NULL
;
15312 /* We use a temporary it1 because line_bottom_y can modify
15313 its argument, if it moves one line down; see there. */
15316 SAVE_IT (it1
, it
, it1data
);
15317 start_y
= line_bottom_y (&it1
);
15319 RESTORE_IT (&it
, &it
, it1data
);
15320 move_it_by_lines (&it
, 1);
15321 SAVE_IT (it1
, it
, it1data
);
15322 } while (IT_CHARPOS (it
) < ZV
15323 && line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15324 bidi_unshelve_cache (it1data
, true);
15327 /* If STARTP is unchanged, move it down another screen line. */
15328 if (IT_CHARPOS (it
) == CHARPOS (startp
))
15329 move_it_by_lines (&it
, 1);
15330 startp
= it
.current
.pos
;
15334 struct text_pos scroll_margin_pos
= startp
;
15337 /* See if point is inside the scroll margin at the top of the
15339 if (this_scroll_margin
)
15343 start_display (&it
, w
, startp
);
15344 y_start
= it
.current_y
;
15345 move_it_vertically (&it
, this_scroll_margin
);
15346 scroll_margin_pos
= it
.current
.pos
;
15347 /* If we didn't move enough before hitting ZV, request
15348 additional amount of scroll, to move point out of the
15350 if (IT_CHARPOS (it
) == ZV
15351 && it
.current_y
- y_start
< this_scroll_margin
)
15352 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15355 if (PT
< CHARPOS (scroll_margin_pos
))
15357 /* Point is in the scroll margin at the top of the window or
15358 above what is displayed in the window. */
15361 /* Compute the vertical distance from PT to the scroll
15362 margin position. Move as far as scroll_max allows, or
15363 one screenful, or 10 screen lines, whichever is largest.
15364 Give up if distance is greater than scroll_max or if we
15365 didn't reach the scroll margin position. */
15366 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15367 start_display (&it
, w
, pos
);
15369 y_to_move
= max (it
.last_visible_y
,
15370 max (scroll_max
, 10 * frame_line_height
));
15371 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15373 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15374 dy
= it
.current_y
- y0
;
15375 if (dy
> scroll_max
15376 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15377 return SCROLLING_FAILED
;
15379 /* Additional scroll for when ZV was too close to point. */
15382 /* Compute new window start. */
15383 start_display (&it
, w
, startp
);
15385 if (arg_scroll_conservatively
)
15386 amount_to_scroll
= max (dy
, frame_line_height
15387 * max (scroll_step
, temp_scroll_step
));
15388 else if (scroll_step
|| temp_scroll_step
)
15389 amount_to_scroll
= scroll_max
;
15392 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15393 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15394 if (NUMBERP (aggressive
))
15396 double float_amount
= XFLOATINT (aggressive
) * height
;
15397 int aggressive_scroll
= float_amount
;
15398 if (aggressive_scroll
== 0 && float_amount
> 0)
15399 aggressive_scroll
= 1;
15400 /* Don't let point enter the scroll margin near
15401 bottom of the window, if the value of
15402 scroll_down_aggressively happens to be too
15404 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15405 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15406 amount_to_scroll
= dy
+ aggressive_scroll
;
15410 if (amount_to_scroll
<= 0)
15411 return SCROLLING_FAILED
;
15413 move_it_vertically_backward (&it
, amount_to_scroll
);
15414 startp
= it
.current
.pos
;
15418 /* Run window scroll functions. */
15419 startp
= run_window_scroll_functions (window
, startp
);
15421 /* Display the window. Give up if new fonts are loaded, or if point
15423 if (!try_window (window
, startp
, 0))
15424 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15425 else if (w
->cursor
.vpos
< 0)
15427 clear_glyph_matrix (w
->desired_matrix
);
15428 rc
= SCROLLING_FAILED
;
15432 /* Maybe forget recorded base line for line number display. */
15433 if (!just_this_one_p
15434 || current_buffer
->clip_changed
15435 || BEG_UNCHANGED
< CHARPOS (startp
))
15436 w
->base_line_number
= 0;
15438 /* If cursor ends up on a partially visible line,
15439 treat that as being off the bottom of the screen. */
15440 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1,
15442 /* It's possible that the cursor is on the first line of the
15443 buffer, which is partially obscured due to a vscroll
15444 (Bug#7537). In that case, avoid looping forever. */
15445 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15447 clear_glyph_matrix (w
->desired_matrix
);
15448 ++extra_scroll_margin_lines
;
15451 rc
= SCROLLING_SUCCESS
;
15458 /* Compute a suitable window start for window W if display of W starts
15459 on a continuation line. Value is true if a new window start
15462 The new window start will be computed, based on W's width, starting
15463 from the start of the continued line. It is the start of the
15464 screen line with the minimum distance from the old start W->start. */
15467 compute_window_start_on_continuation_line (struct window
*w
)
15469 struct text_pos pos
, start_pos
;
15470 bool window_start_changed_p
= false;
15472 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15474 /* If window start is on a continuation line... Window start may be
15475 < BEGV in case there's invisible text at the start of the
15476 buffer (M-x rmail, for example). */
15477 if (CHARPOS (start_pos
) > BEGV
15478 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15481 struct glyph_row
*row
;
15483 /* Handle the case that the window start is out of range. */
15484 if (CHARPOS (start_pos
) < BEGV
)
15485 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15486 else if (CHARPOS (start_pos
) > ZV
)
15487 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15489 /* Find the start of the continued line. This should be fast
15490 because find_newline is fast (newline cache). */
15491 row
= w
->desired_matrix
->rows
+ WINDOW_WANTS_HEADER_LINE_P (w
);
15492 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15493 row
, DEFAULT_FACE_ID
);
15494 reseat_at_previous_visible_line_start (&it
);
15496 /* If the line start is "too far" away from the window start,
15497 say it takes too much time to compute a new window start. */
15498 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15499 /* PXW: Do we need upper bounds here? */
15500 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15502 int min_distance
, distance
;
15504 /* Move forward by display lines to find the new window
15505 start. If window width was enlarged, the new start can
15506 be expected to be > the old start. If window width was
15507 decreased, the new window start will be < the old start.
15508 So, we're looking for the display line start with the
15509 minimum distance from the old window start. */
15510 pos
= it
.current
.pos
;
15511 min_distance
= INFINITY
;
15512 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15513 distance
< min_distance
)
15515 min_distance
= distance
;
15516 pos
= it
.current
.pos
;
15517 if (it
.line_wrap
== WORD_WRAP
)
15519 /* Under WORD_WRAP, move_it_by_lines is likely to
15520 overshoot and stop not at the first, but the
15521 second character from the left margin. So in
15522 that case, we need a more tight control on the X
15523 coordinate of the iterator than move_it_by_lines
15524 promises in its contract. The method is to first
15525 go to the last (rightmost) visible character of a
15526 line, then move to the leftmost character on the
15527 next line in a separate call. */
15528 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15529 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15530 move_it_to (&it
, ZV
, 0,
15531 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15532 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15535 move_it_by_lines (&it
, 1);
15538 /* Set the window start there. */
15539 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15540 window_start_changed_p
= true;
15544 return window_start_changed_p
;
15548 /* Try cursor movement in case text has not changed in window WINDOW,
15549 with window start STARTP. Value is
15551 CURSOR_MOVEMENT_SUCCESS if successful
15553 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15555 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15556 display. *SCROLL_STEP is set to true, under certain circumstances, if
15557 we want to scroll as if scroll-step were set to 1. See the code.
15559 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15560 which case we have to abort this redisplay, and adjust matrices
15565 CURSOR_MOVEMENT_SUCCESS
,
15566 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15567 CURSOR_MOVEMENT_MUST_SCROLL
,
15568 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15572 try_cursor_movement (Lisp_Object window
, struct text_pos startp
,
15575 struct window
*w
= XWINDOW (window
);
15576 struct frame
*f
= XFRAME (w
->frame
);
15577 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15580 if (inhibit_try_cursor_movement
)
15584 /* Previously, there was a check for Lisp integer in the
15585 if-statement below. Now, this field is converted to
15586 ptrdiff_t, thus zero means invalid position in a buffer. */
15587 eassert (w
->last_point
> 0);
15588 /* Likewise there was a check whether window_end_vpos is nil or larger
15589 than the window. Now window_end_vpos is int and so never nil, but
15590 let's leave eassert to check whether it fits in the window. */
15591 eassert (!w
->window_end_valid
15592 || w
->window_end_vpos
< w
->current_matrix
->nrows
);
15594 /* Handle case where text has not changed, only point, and it has
15595 not moved off the frame. */
15596 if (/* Point may be in this window. */
15597 PT
>= CHARPOS (startp
)
15598 /* Selective display hasn't changed. */
15599 && !current_buffer
->clip_changed
15600 /* Function force-mode-line-update is used to force a thorough
15601 redisplay. It sets either windows_or_buffers_changed or
15602 update_mode_lines. So don't take a shortcut here for these
15604 && !update_mode_lines
15605 && !windows_or_buffers_changed
15606 && !f
->cursor_type_changed
15607 && NILP (Vshow_trailing_whitespace
)
15608 /* This code is not used for mini-buffer for the sake of the case
15609 of redisplaying to replace an echo area message; since in
15610 that case the mini-buffer contents per se are usually
15611 unchanged. This code is of no real use in the mini-buffer
15612 since the handling of this_line_start_pos, etc., in redisplay
15613 handles the same cases. */
15614 && !EQ (window
, minibuf_window
)
15615 && (FRAME_WINDOW_P (f
)
15616 || !overlay_arrow_in_current_buffer_p ()))
15618 int this_scroll_margin
, top_scroll_margin
;
15619 struct glyph_row
*row
= NULL
;
15620 int frame_line_height
= default_line_pixel_height (w
);
15621 int window_total_lines
15622 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15625 debug_method_add (w
, "cursor movement");
15628 /* Scroll if point within this distance from the top or bottom
15629 of the window. This is a pixel value. */
15630 if (scroll_margin
> 0)
15632 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15633 this_scroll_margin
*= frame_line_height
;
15636 this_scroll_margin
= 0;
15638 top_scroll_margin
= this_scroll_margin
;
15639 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15640 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15642 /* Start with the row the cursor was displayed during the last
15643 not paused redisplay. Give up if that row is not valid. */
15644 if (w
->last_cursor_vpos
< 0
15645 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15646 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15649 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15650 if (row
->mode_line_p
)
15652 if (!row
->enabled_p
)
15653 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15656 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15658 bool scroll_p
= false, must_scroll
= false;
15659 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15661 if (PT
> w
->last_point
)
15663 /* Point has moved forward. */
15664 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15665 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15667 eassert (row
->enabled_p
);
15671 /* If the end position of a row equals the start
15672 position of the next row, and PT is at that position,
15673 we would rather display cursor in the next line. */
15674 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15675 && MATRIX_ROW_END_CHARPOS (row
) == PT
15676 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15677 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15678 && !cursor_row_p (row
))
15681 /* If within the scroll margin, scroll. Note that
15682 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15683 the next line would be drawn, and that
15684 this_scroll_margin can be zero. */
15685 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15686 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15687 /* Line is completely visible last line in window
15688 and PT is to be set in the next line. */
15689 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15690 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15691 && !row
->ends_at_zv_p
15692 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15695 else if (PT
< w
->last_point
)
15697 /* Cursor has to be moved backward. Note that PT >=
15698 CHARPOS (startp) because of the outer if-statement. */
15699 while (!row
->mode_line_p
15700 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15701 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15702 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15703 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15704 row
> w
->current_matrix
->rows
15705 && (row
-1)->ends_in_newline_from_string_p
))))
15706 && (row
->y
> top_scroll_margin
15707 || CHARPOS (startp
) == BEGV
))
15709 eassert (row
->enabled_p
);
15713 /* Consider the following case: Window starts at BEGV,
15714 there is invisible, intangible text at BEGV, so that
15715 display starts at some point START > BEGV. It can
15716 happen that we are called with PT somewhere between
15717 BEGV and START. Try to handle that case. */
15718 if (row
< w
->current_matrix
->rows
15719 || row
->mode_line_p
)
15721 row
= w
->current_matrix
->rows
;
15722 if (row
->mode_line_p
)
15726 /* Due to newlines in overlay strings, we may have to
15727 skip forward over overlay strings. */
15728 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15729 && MATRIX_ROW_END_CHARPOS (row
) == PT
15730 && !cursor_row_p (row
))
15733 /* If within the scroll margin, scroll. */
15734 if (row
->y
< top_scroll_margin
15735 && CHARPOS (startp
) != BEGV
)
15740 /* Cursor did not move. So don't scroll even if cursor line
15741 is partially visible, as it was so before. */
15742 rc
= CURSOR_MOVEMENT_SUCCESS
;
15745 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15746 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15748 /* if PT is not in the glyph row, give up. */
15749 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15750 must_scroll
= true;
15752 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15753 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15755 struct glyph_row
*row1
;
15757 /* If rows are bidi-reordered and point moved, back up
15758 until we find a row that does not belong to a
15759 continuation line. This is because we must consider
15760 all rows of a continued line as candidates for the
15761 new cursor positioning, since row start and end
15762 positions change non-linearly with vertical position
15764 /* FIXME: Revisit this when glyph ``spilling'' in
15765 continuation lines' rows is implemented for
15766 bidi-reordered rows. */
15767 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15768 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15771 /* If we hit the beginning of the displayed portion
15772 without finding the first row of a continued
15776 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15779 eassert (row
->enabled_p
);
15784 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15785 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15786 /* Make sure this isn't a header line by any chance, since
15787 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield true. */
15788 && !row
->mode_line_p
15789 && make_cursor_line_fully_visible_p
)
15791 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15792 && !row
->ends_at_zv_p
15793 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15794 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15795 else if (row
->height
> window_box_height (w
))
15797 /* If we end up in a partially visible line, let's
15798 make it fully visible, except when it's taller
15799 than the window, in which case we can't do much
15801 *scroll_step
= true;
15802 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15806 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15807 if (!cursor_row_fully_visible_p (w
, false, true))
15808 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15810 rc
= CURSOR_MOVEMENT_SUCCESS
;
15814 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15815 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15816 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15818 /* With bidi-reordered rows, there could be more than
15819 one candidate row whose start and end positions
15820 occlude point. We need to let set_cursor_from_row
15821 find the best candidate. */
15822 /* FIXME: Revisit this when glyph ``spilling'' in
15823 continuation lines' rows is implemented for
15824 bidi-reordered rows. */
15829 bool at_zv_p
= false, exact_match_p
= false;
15831 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15832 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15833 && cursor_row_p (row
))
15834 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15836 /* As soon as we've found the exact match for point,
15837 or the first suitable row whose ends_at_zv_p flag
15838 is set, we are done. */
15841 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15842 w
->cursor
.vpos
)->ends_at_zv_p
;
15844 && w
->cursor
.hpos
>= 0
15845 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15848 struct glyph_row
*candidate
=
15849 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15851 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15852 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15855 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15856 || (NILP (g
->object
)
15857 && (g
->charpos
== PT
15858 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15860 if (at_zv_p
|| exact_match_p
)
15862 rc
= CURSOR_MOVEMENT_SUCCESS
;
15866 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15870 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15871 || row
->continued_p
)
15872 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15873 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15874 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15875 /* If we didn't find any candidate rows, or exited the
15876 loop before all the candidates were examined, signal
15877 to the caller that this method failed. */
15878 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15880 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15881 && !row
->continued_p
))
15882 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15884 rc
= CURSOR_MOVEMENT_SUCCESS
;
15890 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15892 rc
= CURSOR_MOVEMENT_SUCCESS
;
15897 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15898 && MATRIX_ROW_START_CHARPOS (row
) == PT
15899 && cursor_row_p (row
));
15909 set_vertical_scroll_bar (struct window
*w
)
15911 ptrdiff_t start
, end
, whole
;
15913 /* Calculate the start and end positions for the current window.
15914 At some point, it would be nice to choose between scrollbars
15915 which reflect the whole buffer size, with special markers
15916 indicating narrowing, and scrollbars which reflect only the
15919 Note that mini-buffers sometimes aren't displaying any text. */
15920 if (!MINI_WINDOW_P (w
)
15921 || (w
== XWINDOW (minibuf_window
)
15922 && NILP (echo_area_buffer
[0])))
15924 struct buffer
*buf
= XBUFFER (w
->contents
);
15925 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15926 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15927 /* I don't think this is guaranteed to be right. For the
15928 moment, we'll pretend it is. */
15929 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15933 if (whole
< (end
- start
))
15934 whole
= end
- start
;
15937 start
= end
= whole
= 0;
15939 /* Indicate what this scroll bar ought to be displaying now. */
15940 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15941 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15942 (w
, end
- start
, whole
, start
);
15947 set_horizontal_scroll_bar (struct window
*w
)
15949 int start
, end
, whole
, portion
;
15951 if (!MINI_WINDOW_P (w
)
15952 || (w
== XWINDOW (minibuf_window
)
15953 && NILP (echo_area_buffer
[0])))
15955 struct buffer
*b
= XBUFFER (w
->contents
);
15956 struct buffer
*old_buffer
= NULL
;
15958 struct text_pos startp
;
15960 if (b
!= current_buffer
)
15962 old_buffer
= current_buffer
;
15963 set_buffer_internal (b
);
15966 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15967 start_display (&it
, w
, startp
);
15968 it
.last_visible_x
= INT_MAX
;
15969 whole
= move_it_to (&it
, -1, INT_MAX
, window_box_height (w
), -1,
15970 MOVE_TO_X
| MOVE_TO_Y
);
15971 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
15972 window_box_height (w), -1,
15973 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
15975 start
= w
->hscroll
* FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
));
15976 end
= start
+ window_box_width (w
, TEXT_AREA
);
15977 portion
= end
- start
;
15978 /* After enlarging a horizontally scrolled window such that it
15979 gets at least as wide as the text it contains, make sure that
15980 the thumb doesn't fill the entire scroll bar so we can still
15981 drag it back to see the entire text. */
15982 whole
= max (whole
, end
);
15988 pdir
= Fcurrent_bidi_paragraph_direction (Qnil
);
15989 if (EQ (pdir
, Qright_to_left
))
15991 start
= whole
- end
;
15992 end
= start
+ portion
;
15997 set_buffer_internal (old_buffer
);
16000 start
= end
= whole
= portion
= 0;
16002 w
->hscroll_whole
= whole
;
16004 /* Indicate what this scroll bar ought to be displaying now. */
16005 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
16006 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
16007 (w
, portion
, whole
, start
);
16011 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P means only
16012 selected_window is redisplayed.
16014 We can return without actually redisplaying the window if fonts has been
16015 changed on window's frame. In that case, redisplay_internal will retry.
16017 As one of the important parts of redisplaying a window, we need to
16018 decide whether the previous window-start position (stored in the
16019 window's w->start marker position) is still valid, and if it isn't,
16020 recompute it. Some details about that:
16022 . The previous window-start could be in a continuation line, in
16023 which case we need to recompute it when the window width
16024 changes. See compute_window_start_on_continuation_line and its
16027 . The text that changed since last redisplay could include the
16028 previous window-start position. In that case, we try to salvage
16029 what we can from the current glyph matrix by calling
16030 try_scrolling, which see.
16032 . Some Emacs command could force us to use a specific window-start
16033 position by setting the window's force_start flag, or gently
16034 propose doing that by setting the window's optional_new_start
16035 flag. In these cases, we try using the specified start point if
16036 that succeeds (i.e. the window desired matrix is successfully
16037 recomputed, and point location is within the window). In case
16038 of optional_new_start, we first check if the specified start
16039 position is feasible, i.e. if it will allow point to be
16040 displayed in the window. If using the specified start point
16041 fails, e.g., if new fonts are needed to be loaded, we abort the
16042 redisplay cycle and leave it up to the next cycle to figure out
16045 . Note that the window's force_start flag is sometimes set by
16046 redisplay itself, when it decides that the previous window start
16047 point is fine and should be kept. Search for "goto force_start"
16048 below to see the details. Like the values of window-start
16049 specified outside of redisplay, these internally-deduced values
16050 are tested for feasibility, and ignored if found to be
16053 . Note that the function try_window, used to completely redisplay
16054 a window, accepts the window's start point as its argument.
16055 This is used several times in the redisplay code to control
16056 where the window start will be, according to user options such
16057 as scroll-conservatively, and also to ensure the screen line
16058 showing point will be fully (as opposed to partially) visible on
16062 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
16064 struct window
*w
= XWINDOW (window
);
16065 struct frame
*f
= XFRAME (w
->frame
);
16066 struct buffer
*buffer
= XBUFFER (w
->contents
);
16067 struct buffer
*old
= current_buffer
;
16068 struct text_pos lpoint
, opoint
, startp
;
16069 bool update_mode_line
;
16072 /* Record it now because it's overwritten. */
16073 bool current_matrix_up_to_date_p
= false;
16074 bool used_current_matrix_p
= false;
16075 /* This is less strict than current_matrix_up_to_date_p.
16076 It indicates that the buffer contents and narrowing are unchanged. */
16077 bool buffer_unchanged_p
= false;
16078 bool temp_scroll_step
= false;
16079 ptrdiff_t count
= SPECPDL_INDEX ();
16081 int centering_position
= -1;
16082 bool last_line_misfit
= false;
16083 ptrdiff_t beg_unchanged
, end_unchanged
;
16084 int frame_line_height
;
16086 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16090 *w
->desired_matrix
->method
= 0;
16093 if (!just_this_one_p
16094 && REDISPLAY_SOME_P ()
16096 && !w
->update_mode_line
16099 && !buffer
->text
->redisplay
16100 && BUF_PT (buffer
) == w
->last_point
)
16103 /* Make sure that both W's markers are valid. */
16104 eassert (XMARKER (w
->start
)->buffer
== buffer
);
16105 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
16107 /* We come here again if we need to run window-text-change-functions
16110 reconsider_clip_changes (w
);
16111 frame_line_height
= default_line_pixel_height (w
);
16113 /* Has the mode line to be updated? */
16114 update_mode_line
= (w
->update_mode_line
16115 || update_mode_lines
16116 || buffer
->clip_changed
16117 || buffer
->prevent_redisplay_optimizations_p
);
16119 if (!just_this_one_p
)
16120 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
16121 cleverly elsewhere. */
16122 w
->must_be_updated_p
= true;
16124 if (MINI_WINDOW_P (w
))
16126 if (w
== XWINDOW (echo_area_window
)
16127 && !NILP (echo_area_buffer
[0]))
16129 if (update_mode_line
)
16130 /* We may have to update a tty frame's menu bar or a
16131 tool-bar. Example `M-x C-h C-h C-g'. */
16132 goto finish_menu_bars
;
16134 /* We've already displayed the echo area glyphs in this window. */
16135 goto finish_scroll_bars
;
16137 else if ((w
!= XWINDOW (minibuf_window
)
16138 || minibuf_level
== 0)
16139 /* When buffer is nonempty, redisplay window normally. */
16140 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
16141 /* Quail displays non-mini buffers in minibuffer window.
16142 In that case, redisplay the window normally. */
16143 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
16145 /* W is a mini-buffer window, but it's not active, so clear
16147 int yb
= window_text_bottom_y (w
);
16148 struct glyph_row
*row
;
16151 for (y
= 0, row
= w
->desired_matrix
->rows
;
16153 y
+= row
->height
, ++row
)
16154 blank_row (w
, row
, y
);
16155 goto finish_scroll_bars
;
16158 clear_glyph_matrix (w
->desired_matrix
);
16161 /* Otherwise set up data on this window; select its buffer and point
16163 /* Really select the buffer, for the sake of buffer-local
16165 set_buffer_internal_1 (XBUFFER (w
->contents
));
16167 current_matrix_up_to_date_p
16168 = (w
->window_end_valid
16169 && !current_buffer
->clip_changed
16170 && !current_buffer
->prevent_redisplay_optimizations_p
16171 && !window_outdated (w
));
16173 /* Run the window-text-change-functions
16174 if it is possible that the text on the screen has changed
16175 (either due to modification of the text, or any other reason). */
16176 if (!current_matrix_up_to_date_p
16177 && !NILP (Vwindow_text_change_functions
))
16179 safe_run_hooks (Qwindow_text_change_functions
);
16183 beg_unchanged
= BEG_UNCHANGED
;
16184 end_unchanged
= END_UNCHANGED
;
16186 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
16188 specbind (Qinhibit_point_motion_hooks
, Qt
);
16191 = (w
->window_end_valid
16192 && !current_buffer
->clip_changed
16193 && !window_outdated (w
));
16195 /* When windows_or_buffers_changed is non-zero, we can't rely
16196 on the window end being valid, so set it to zero there. */
16197 if (windows_or_buffers_changed
)
16199 /* If window starts on a continuation line, maybe adjust the
16200 window start in case the window's width changed. */
16201 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16202 compute_window_start_on_continuation_line (w
);
16204 w
->window_end_valid
= false;
16205 /* If so, we also can't rely on current matrix
16206 and should not fool try_cursor_movement below. */
16207 current_matrix_up_to_date_p
= false;
16210 /* Some sanity checks. */
16211 CHECK_WINDOW_END (w
);
16212 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16214 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16217 if (mode_line_update_needed (w
))
16218 update_mode_line
= true;
16220 /* Point refers normally to the selected window. For any other
16221 window, set up appropriate value. */
16222 if (!EQ (window
, selected_window
))
16224 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16225 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16230 new_pt_byte
= BEGV_BYTE
;
16231 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16233 else if (new_pt
> (ZV
- 1))
16236 new_pt_byte
= ZV_BYTE
;
16237 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16240 /* We don't use SET_PT so that the point-motion hooks don't run. */
16241 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16244 /* If any of the character widths specified in the display table
16245 have changed, invalidate the width run cache. It's true that
16246 this may be a bit late to catch such changes, but the rest of
16247 redisplay goes (non-fatally) haywire when the display table is
16248 changed, so why should we worry about doing any better? */
16249 if (current_buffer
->width_run_cache
16250 || (current_buffer
->base_buffer
16251 && current_buffer
->base_buffer
->width_run_cache
))
16253 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16255 if (! disptab_matches_widthtab
16256 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16258 struct buffer
*buf
= current_buffer
;
16260 if (buf
->base_buffer
)
16261 buf
= buf
->base_buffer
;
16262 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16263 recompute_width_table (current_buffer
, disptab
);
16267 /* If window-start is screwed up, choose a new one. */
16268 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16271 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16273 /* If someone specified a new starting point but did not insist,
16274 check whether it can be used. */
16275 if ((w
->optional_new_start
|| window_frozen_p (w
))
16276 && CHARPOS (startp
) >= BEGV
16277 && CHARPOS (startp
) <= ZV
)
16279 ptrdiff_t it_charpos
;
16281 w
->optional_new_start
= false;
16282 start_display (&it
, w
, startp
);
16283 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16284 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16285 /* Record IT's position now, since line_bottom_y might change
16287 it_charpos
= IT_CHARPOS (it
);
16288 /* Make sure we set the force_start flag only if the cursor row
16289 will be fully visible. Otherwise, the code under force_start
16290 label below will try to move point back into view, which is
16291 not what the code which sets optional_new_start wants. */
16292 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
16293 && !w
->force_start
)
16295 if (it_charpos
== PT
)
16296 w
->force_start
= true;
16297 /* IT may overshoot PT if text at PT is invisible. */
16298 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16299 w
->force_start
= true;
16301 if (w
->force_start
)
16303 if (window_frozen_p (w
))
16304 debug_method_add (w
, "set force_start from frozen window start");
16306 debug_method_add (w
, "set force_start from optional_new_start");
16314 /* Handle case where place to start displaying has been specified,
16315 unless the specified location is outside the accessible range. */
16316 if (w
->force_start
)
16318 /* We set this later on if we have to adjust point. */
16321 w
->force_start
= false;
16323 w
->window_end_valid
= false;
16325 /* Forget any recorded base line for line number display. */
16326 if (!buffer_unchanged_p
)
16327 w
->base_line_number
= 0;
16329 /* Redisplay the mode line. Select the buffer properly for that.
16330 Also, run the hook window-scroll-functions
16331 because we have scrolled. */
16332 /* Note, we do this after clearing force_start because
16333 if there's an error, it is better to forget about force_start
16334 than to get into an infinite loop calling the hook functions
16335 and having them get more errors. */
16336 if (!update_mode_line
16337 || ! NILP (Vwindow_scroll_functions
))
16339 update_mode_line
= true;
16340 w
->update_mode_line
= true;
16341 startp
= run_window_scroll_functions (window
, startp
);
16344 if (CHARPOS (startp
) < BEGV
)
16345 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16346 else if (CHARPOS (startp
) > ZV
)
16347 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16349 /* Redisplay, then check if cursor has been set during the
16350 redisplay. Give up if new fonts were loaded. */
16351 /* We used to issue a CHECK_MARGINS argument to try_window here,
16352 but this causes scrolling to fail when point begins inside
16353 the scroll margin (bug#148) -- cyd */
16354 if (!try_window (window
, startp
, 0))
16356 w
->force_start
= true;
16357 clear_glyph_matrix (w
->desired_matrix
);
16358 goto need_larger_matrices
;
16361 if (w
->cursor
.vpos
< 0)
16363 /* If point does not appear, try to move point so it does
16364 appear. The desired matrix has been built above, so we
16365 can use it here. First see if point is in invisible
16366 text, and if so, move it to the first visible buffer
16367 position past that. */
16368 struct glyph_row
*r
= NULL
;
16369 Lisp_Object invprop
=
16370 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16373 if (TEXT_PROP_MEANS_INVISIBLE (invprop
) != 0)
16376 Lisp_Object invprop_end
=
16377 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16380 if (NATNUMP (invprop_end
))
16381 alt_pt
= XFASTINT (invprop_end
);
16384 r
= row_containing_pos (w
, alt_pt
, w
->desired_matrix
->rows
,
16388 new_vpos
= MATRIX_ROW_BOTTOM_Y (r
);
16389 else /* Give up and just move to the middle of the window. */
16390 new_vpos
= window_box_height (w
) / 2;
16393 if (!cursor_row_fully_visible_p (w
, false, false))
16395 /* Point does appear, but on a line partly visible at end of window.
16396 Move it back to a fully-visible line. */
16397 new_vpos
= window_box_height (w
);
16398 /* But if window_box_height suggests a Y coordinate that is
16399 not less than we already have, that line will clearly not
16400 be fully visible, so give up and scroll the display.
16401 This can happen when the default face uses a font whose
16402 dimensions are different from the frame's default
16404 if (new_vpos
>= w
->cursor
.y
)
16406 w
->cursor
.vpos
= -1;
16407 clear_glyph_matrix (w
->desired_matrix
);
16408 goto try_to_scroll
;
16411 else if (w
->cursor
.vpos
>= 0)
16413 /* Some people insist on not letting point enter the scroll
16414 margin, even though this part handles windows that didn't
16416 int window_total_lines
16417 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16418 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16419 int pixel_margin
= margin
* frame_line_height
;
16420 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16422 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16423 below, which finds the row to move point to, advances by
16424 the Y coordinate of the _next_ row, see the definition of
16425 MATRIX_ROW_BOTTOM_Y. */
16426 if (w
->cursor
.vpos
< margin
+ header_line
)
16428 w
->cursor
.vpos
= -1;
16429 clear_glyph_matrix (w
->desired_matrix
);
16430 goto try_to_scroll
;
16434 int window_height
= window_box_height (w
);
16437 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16438 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16440 w
->cursor
.vpos
= -1;
16441 clear_glyph_matrix (w
->desired_matrix
);
16442 goto try_to_scroll
;
16447 /* If we need to move point for either of the above reasons,
16448 now actually do it. */
16451 struct glyph_row
*row
;
16453 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16454 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16457 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16458 MATRIX_ROW_START_BYTEPOS (row
));
16460 if (w
!= XWINDOW (selected_window
))
16461 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16462 else if (current_buffer
== old
)
16463 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16465 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16467 /* Re-run pre-redisplay-function so it can update the region
16468 according to the new position of point. */
16469 /* Other than the cursor, w's redisplay is done so we can set its
16470 redisplay to false. Also the buffer's redisplay can be set to
16471 false, since propagate_buffer_redisplay should have already
16472 propagated its info to `w' anyway. */
16473 w
->redisplay
= false;
16474 XBUFFER (w
->contents
)->text
->redisplay
= false;
16475 safe__call1 (true, Vpre_redisplay_function
, Fcons (window
, Qnil
));
16477 if (w
->redisplay
|| XBUFFER (w
->contents
)->text
->redisplay
)
16479 /* pre-redisplay-function made changes (e.g. move the region)
16480 that require another round of redisplay. */
16481 clear_glyph_matrix (w
->desired_matrix
);
16482 if (!try_window (window
, startp
, 0))
16483 goto need_larger_matrices
;
16486 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, false, false))
16488 clear_glyph_matrix (w
->desired_matrix
);
16489 goto try_to_scroll
;
16493 debug_method_add (w
, "forced window start");
16498 /* Handle case where text has not changed, only point, and it has
16499 not moved off the frame, and we are not retrying after hscroll.
16500 (current_matrix_up_to_date_p is true when retrying.) */
16501 if (current_matrix_up_to_date_p
16502 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16503 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16507 case CURSOR_MOVEMENT_SUCCESS
:
16508 used_current_matrix_p
= true;
16511 case CURSOR_MOVEMENT_MUST_SCROLL
:
16512 goto try_to_scroll
;
16518 /* If current starting point was originally the beginning of a line
16519 but no longer is, find a new starting point. */
16520 else if (w
->start_at_line_beg
16521 && !(CHARPOS (startp
) <= BEGV
16522 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16525 debug_method_add (w
, "recenter 1");
16530 /* Try scrolling with try_window_id. Value is > 0 if update has
16531 been done, it is -1 if we know that the same window start will
16532 not work. It is 0 if unsuccessful for some other reason. */
16533 else if ((tem
= try_window_id (w
)) != 0)
16536 debug_method_add (w
, "try_window_id %d", tem
);
16539 if (f
->fonts_changed
)
16540 goto need_larger_matrices
;
16544 /* Otherwise try_window_id has returned -1 which means that we
16545 don't want the alternative below this comment to execute. */
16547 else if (CHARPOS (startp
) >= BEGV
16548 && CHARPOS (startp
) <= ZV
16549 && PT
>= CHARPOS (startp
)
16550 && (CHARPOS (startp
) < ZV
16551 /* Avoid starting at end of buffer. */
16552 || CHARPOS (startp
) == BEGV
16553 || !window_outdated (w
)))
16555 int d1
, d2
, d5
, d6
;
16558 /* If first window line is a continuation line, and window start
16559 is inside the modified region, but the first change is before
16560 current window start, we must select a new window start.
16562 However, if this is the result of a down-mouse event (e.g. by
16563 extending the mouse-drag-overlay), we don't want to select a
16564 new window start, since that would change the position under
16565 the mouse, resulting in an unwanted mouse-movement rather
16566 than a simple mouse-click. */
16567 if (!w
->start_at_line_beg
16568 && NILP (do_mouse_tracking
)
16569 && CHARPOS (startp
) > BEGV
16570 && CHARPOS (startp
) > BEG
+ beg_unchanged
16571 && CHARPOS (startp
) <= Z
- end_unchanged
16572 /* Even if w->start_at_line_beg is nil, a new window may
16573 start at a line_beg, since that's how set_buffer_window
16574 sets it. So, we need to check the return value of
16575 compute_window_start_on_continuation_line. (See also
16577 && XMARKER (w
->start
)->buffer
== current_buffer
16578 && compute_window_start_on_continuation_line (w
)
16579 /* It doesn't make sense to force the window start like we
16580 do at label force_start if it is already known that point
16581 will not be fully visible in the resulting window, because
16582 doing so will move point from its correct position
16583 instead of scrolling the window to bring point into view.
16585 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16586 /* A very tall row could need more than the window height,
16587 in which case we accept that it is partially visible. */
16588 && (rtop
!= 0) == (rbot
!= 0))
16590 w
->force_start
= true;
16591 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16593 debug_method_add (w
, "recomputed window start in continuation line");
16599 debug_method_add (w
, "same window start");
16602 /* Try to redisplay starting at same place as before.
16603 If point has not moved off frame, accept the results. */
16604 if (!current_matrix_up_to_date_p
16605 /* Don't use try_window_reusing_current_matrix in this case
16606 because a window scroll function can have changed the
16608 || !NILP (Vwindow_scroll_functions
)
16609 || MINI_WINDOW_P (w
)
16610 || !(used_current_matrix_p
16611 = try_window_reusing_current_matrix (w
)))
16613 IF_DEBUG (debug_method_add (w
, "1"));
16614 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16615 /* -1 means we need to scroll.
16616 0 means we need new matrices, but fonts_changed
16617 is set in that case, so we will detect it below. */
16618 goto try_to_scroll
;
16621 if (f
->fonts_changed
)
16622 goto need_larger_matrices
;
16624 if (w
->cursor
.vpos
>= 0)
16626 if (!just_this_one_p
16627 || current_buffer
->clip_changed
16628 || BEG_UNCHANGED
< CHARPOS (startp
))
16629 /* Forget any recorded base line for line number display. */
16630 w
->base_line_number
= 0;
16632 if (!cursor_row_fully_visible_p (w
, true, false))
16634 clear_glyph_matrix (w
->desired_matrix
);
16635 last_line_misfit
= true;
16637 /* Drop through and scroll. */
16642 clear_glyph_matrix (w
->desired_matrix
);
16647 /* Redisplay the mode line. Select the buffer properly for that. */
16648 if (!update_mode_line
)
16650 update_mode_line
= true;
16651 w
->update_mode_line
= true;
16654 /* Try to scroll by specified few lines. */
16655 if ((scroll_conservatively
16656 || emacs_scroll_step
16657 || temp_scroll_step
16658 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16659 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16660 && CHARPOS (startp
) >= BEGV
16661 && CHARPOS (startp
) <= ZV
)
16663 /* The function returns -1 if new fonts were loaded, 1 if
16664 successful, 0 if not successful. */
16665 int ss
= try_scrolling (window
, just_this_one_p
,
16666 scroll_conservatively
,
16668 temp_scroll_step
, last_line_misfit
);
16671 case SCROLLING_SUCCESS
:
16674 case SCROLLING_NEED_LARGER_MATRICES
:
16675 goto need_larger_matrices
;
16677 case SCROLLING_FAILED
:
16685 /* Finally, just choose a place to start which positions point
16686 according to user preferences. */
16691 debug_method_add (w
, "recenter");
16694 /* Forget any previously recorded base line for line number display. */
16695 if (!buffer_unchanged_p
)
16696 w
->base_line_number
= 0;
16698 /* Determine the window start relative to point. */
16699 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16700 it
.current_y
= it
.last_visible_y
;
16701 if (centering_position
< 0)
16703 int window_total_lines
16704 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16706 = scroll_margin
> 0
16707 ? min (scroll_margin
, window_total_lines
/ 4)
16709 ptrdiff_t margin_pos
= CHARPOS (startp
);
16710 Lisp_Object aggressive
;
16713 /* If there is a scroll margin at the top of the window, find
16714 its character position. */
16716 /* Cannot call start_display if startp is not in the
16717 accessible region of the buffer. This can happen when we
16718 have just switched to a different buffer and/or changed
16719 its restriction. In that case, startp is initialized to
16720 the character position 1 (BEGV) because we did not yet
16721 have chance to display the buffer even once. */
16722 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16725 void *it1data
= NULL
;
16727 SAVE_IT (it1
, it
, it1data
);
16728 start_display (&it1
, w
, startp
);
16729 move_it_vertically (&it1
, margin
* frame_line_height
);
16730 margin_pos
= IT_CHARPOS (it1
);
16731 RESTORE_IT (&it
, &it
, it1data
);
16733 scrolling_up
= PT
> margin_pos
;
16736 ? BVAR (current_buffer
, scroll_up_aggressively
)
16737 : BVAR (current_buffer
, scroll_down_aggressively
);
16739 if (!MINI_WINDOW_P (w
)
16740 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16744 /* Setting scroll-conservatively overrides
16745 scroll-*-aggressively. */
16746 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16748 double float_amount
= XFLOATINT (aggressive
);
16750 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16751 if (pt_offset
== 0 && float_amount
> 0)
16753 if (pt_offset
&& margin
> 0)
16756 /* Compute how much to move the window start backward from
16757 point so that point will be displayed where the user
16761 centering_position
= it
.last_visible_y
;
16763 centering_position
-= pt_offset
;
16764 centering_position
-=
16765 (frame_line_height
* (1 + margin
+ last_line_misfit
)
16766 + WINDOW_HEADER_LINE_HEIGHT (w
));
16767 /* Don't let point enter the scroll margin near top of
16769 if (centering_position
< margin
* frame_line_height
)
16770 centering_position
= margin
* frame_line_height
;
16773 centering_position
= margin
* frame_line_height
+ pt_offset
;
16776 /* Set the window start half the height of the window backward
16778 centering_position
= window_box_height (w
) / 2;
16780 move_it_vertically_backward (&it
, centering_position
);
16782 eassert (IT_CHARPOS (it
) >= BEGV
);
16784 /* The function move_it_vertically_backward may move over more
16785 than the specified y-distance. If it->w is small, e.g. a
16786 mini-buffer window, we may end up in front of the window's
16787 display area. Start displaying at the start of the line
16788 containing PT in this case. */
16789 if (it
.current_y
<= 0)
16791 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16792 move_it_vertically_backward (&it
, 0);
16796 it
.current_x
= it
.hpos
= 0;
16798 /* Set the window start position here explicitly, to avoid an
16799 infinite loop in case the functions in window-scroll-functions
16801 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16803 /* Run scroll hooks. */
16804 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16806 /* Redisplay the window. */
16807 bool use_desired_matrix
= false;
16808 if (!current_matrix_up_to_date_p
16809 || windows_or_buffers_changed
16810 || f
->cursor_type_changed
16811 /* Don't use try_window_reusing_current_matrix in this case
16812 because it can have changed the buffer. */
16813 || !NILP (Vwindow_scroll_functions
)
16814 || !just_this_one_p
16815 || MINI_WINDOW_P (w
)
16816 || !(used_current_matrix_p
16817 = try_window_reusing_current_matrix (w
)))
16818 use_desired_matrix
= (try_window (window
, startp
, 0) == 1);
16820 /* If new fonts have been loaded (due to fontsets), give up. We
16821 have to start a new redisplay since we need to re-adjust glyph
16823 if (f
->fonts_changed
)
16824 goto need_larger_matrices
;
16826 /* If cursor did not appear assume that the middle of the window is
16827 in the first line of the window. Do it again with the next line.
16828 (Imagine a window of height 100, displaying two lines of height
16829 60. Moving back 50 from it->last_visible_y will end in the first
16831 if (w
->cursor
.vpos
< 0)
16833 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16835 clear_glyph_matrix (w
->desired_matrix
);
16836 move_it_by_lines (&it
, 1);
16837 try_window (window
, it
.current
.pos
, 0);
16839 else if (PT
< IT_CHARPOS (it
))
16841 clear_glyph_matrix (w
->desired_matrix
);
16842 move_it_by_lines (&it
, -1);
16843 try_window (window
, it
.current
.pos
, 0);
16847 /* Not much we can do about it. */
16851 /* Consider the following case: Window starts at BEGV, there is
16852 invisible, intangible text at BEGV, so that display starts at
16853 some point START > BEGV. It can happen that we are called with
16854 PT somewhere between BEGV and START. Try to handle that case,
16855 and similar ones. */
16856 if (w
->cursor
.vpos
< 0)
16858 /* Prefer the desired matrix to the current matrix, if possible,
16859 in the fallback calculations below. This is because using
16860 the current matrix might completely goof, e.g. if its first
16861 row is after point. */
16862 struct glyph_matrix
*matrix
=
16863 use_desired_matrix
? w
->desired_matrix
: w
->current_matrix
;
16864 /* First, try locating the proper glyph row for PT. */
16865 struct glyph_row
*row
=
16866 row_containing_pos (w
, PT
, matrix
->rows
, NULL
, 0);
16868 /* Sometimes point is at the beginning of invisible text that is
16869 before the 1st character displayed in the row. In that case,
16870 row_containing_pos fails to find the row, because no glyphs
16871 with appropriate buffer positions are present in the row.
16872 Therefore, we next try to find the row which shows the 1st
16873 position after the invisible text. */
16877 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16880 if (TEXT_PROP_MEANS_INVISIBLE (val
) != 0)
16883 Lisp_Object invis_end
=
16884 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16887 if (NATNUMP (invis_end
))
16888 alt_pos
= XFASTINT (invis_end
);
16891 row
= row_containing_pos (w
, alt_pos
, matrix
->rows
, NULL
, 0);
16894 /* Finally, fall back on the first row of the window after the
16895 header line (if any). This is slightly better than not
16896 displaying the cursor at all. */
16899 row
= matrix
->rows
;
16900 if (row
->mode_line_p
)
16903 set_cursor_from_row (w
, row
, matrix
, 0, 0, 0, 0);
16906 if (!cursor_row_fully_visible_p (w
, false, false))
16908 /* If vscroll is enabled, disable it and try again. */
16912 clear_glyph_matrix (w
->desired_matrix
);
16916 /* Users who set scroll-conservatively to a large number want
16917 point just above/below the scroll margin. If we ended up
16918 with point's row partially visible, move the window start to
16919 make that row fully visible and out of the margin. */
16920 if (scroll_conservatively
> SCROLL_LIMIT
)
16922 int window_total_lines
16923 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16926 ? min (scroll_margin
, window_total_lines
/ 4)
16928 bool move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16930 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16931 clear_glyph_matrix (w
->desired_matrix
);
16932 if (1 == try_window (window
, it
.current
.pos
,
16933 TRY_WINDOW_CHECK_MARGINS
))
16937 /* If centering point failed to make the whole line visible,
16938 put point at the top instead. That has to make the whole line
16939 visible, if it can be done. */
16940 if (centering_position
== 0)
16943 clear_glyph_matrix (w
->desired_matrix
);
16944 centering_position
= 0;
16950 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16951 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16952 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16954 /* Display the mode line, if we must. */
16955 if ((update_mode_line
16956 /* If window not full width, must redo its mode line
16957 if (a) the window to its side is being redone and
16958 (b) we do a frame-based redisplay. This is a consequence
16959 of how inverted lines are drawn in frame-based redisplay. */
16960 || (!just_this_one_p
16961 && !FRAME_WINDOW_P (f
)
16962 && !WINDOW_FULL_WIDTH_P (w
))
16963 /* Line number to display. */
16964 || w
->base_line_pos
> 0
16965 /* Column number is displayed and different from the one displayed. */
16966 || (w
->column_number_displayed
!= -1
16967 && (w
->column_number_displayed
!= current_column ())))
16968 /* This means that the window has a mode line. */
16969 && (WINDOW_WANTS_MODELINE_P (w
)
16970 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16973 display_mode_lines (w
);
16975 /* If mode line height has changed, arrange for a thorough
16976 immediate redisplay using the correct mode line height. */
16977 if (WINDOW_WANTS_MODELINE_P (w
)
16978 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16980 f
->fonts_changed
= true;
16981 w
->mode_line_height
= -1;
16982 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16983 = DESIRED_MODE_LINE_HEIGHT (w
);
16986 /* If header line height has changed, arrange for a thorough
16987 immediate redisplay using the correct header line height. */
16988 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16989 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16991 f
->fonts_changed
= true;
16992 w
->header_line_height
= -1;
16993 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16994 = DESIRED_HEADER_LINE_HEIGHT (w
);
16997 if (f
->fonts_changed
)
16998 goto need_larger_matrices
;
17001 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
17003 w
->base_line_pos
= 0;
17004 w
->base_line_number
= 0;
17009 /* When we reach a frame's selected window, redo the frame's menu
17010 bar and the frame's title. */
17011 if (update_mode_line
17012 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
17014 bool redisplay_menu_p
;
17016 if (FRAME_WINDOW_P (f
))
17018 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
17019 || defined (HAVE_NS) || defined (USE_GTK)
17020 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
17022 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
17026 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
17028 if (redisplay_menu_p
)
17029 display_menu_bar (w
);
17031 #ifdef HAVE_WINDOW_SYSTEM
17032 if (FRAME_WINDOW_P (f
))
17034 #if defined (USE_GTK) || defined (HAVE_NS)
17035 if (FRAME_EXTERNAL_TOOL_BAR (f
))
17036 redisplay_tool_bar (f
);
17038 if (WINDOWP (f
->tool_bar_window
)
17039 && (FRAME_TOOL_BAR_LINES (f
) > 0
17040 || !NILP (Vauto_resize_tool_bars
))
17041 && redisplay_tool_bar (f
))
17042 ignore_mouse_drag_p
= true;
17045 x_consider_frame_title (w
->frame
);
17049 #ifdef HAVE_WINDOW_SYSTEM
17050 if (FRAME_WINDOW_P (f
)
17051 && update_window_fringes (w
, (just_this_one_p
17052 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
17053 || w
->pseudo_window_p
)))
17057 if (draw_window_fringes (w
, true))
17059 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
17060 x_draw_right_divider (w
);
17062 x_draw_vertical_border (w
);
17068 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
17069 x_draw_bottom_divider (w
);
17070 #endif /* HAVE_WINDOW_SYSTEM */
17072 /* We go to this label, with fonts_changed set, if it is
17073 necessary to try again using larger glyph matrices.
17074 We have to redeem the scroll bar even in this case,
17075 because the loop in redisplay_internal expects that. */
17076 need_larger_matrices
:
17078 finish_scroll_bars
:
17080 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
17082 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
17083 /* Set the thumb's position and size. */
17084 set_vertical_scroll_bar (w
);
17086 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
17087 /* Set the thumb's position and size. */
17088 set_horizontal_scroll_bar (w
);
17090 /* Note that we actually used the scroll bar attached to this
17091 window, so it shouldn't be deleted at the end of redisplay. */
17092 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
17093 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
17096 /* Restore current_buffer and value of point in it. The window
17097 update may have changed the buffer, so first make sure `opoint'
17098 is still valid (Bug#6177). */
17099 if (CHARPOS (opoint
) < BEGV
)
17100 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
17101 else if (CHARPOS (opoint
) > ZV
)
17102 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
17104 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
17106 set_buffer_internal_1 (old
);
17107 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
17108 shorter. This can be caused by log truncation in *Messages*. */
17109 if (CHARPOS (lpoint
) <= ZV
)
17110 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
17112 unbind_to (count
, Qnil
);
17116 /* Build the complete desired matrix of WINDOW with a window start
17117 buffer position POS.
17119 Value is 1 if successful. It is zero if fonts were loaded during
17120 redisplay which makes re-adjusting glyph matrices necessary, and -1
17121 if point would appear in the scroll margins.
17122 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
17123 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
17127 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
17129 struct window
*w
= XWINDOW (window
);
17131 struct glyph_row
*last_text_row
= NULL
;
17132 struct frame
*f
= XFRAME (w
->frame
);
17133 int frame_line_height
= default_line_pixel_height (w
);
17135 /* Make POS the new window start. */
17136 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
17138 /* Mark cursor position as unknown. No overlay arrow seen. */
17139 w
->cursor
.vpos
= -1;
17140 overlay_arrow_seen
= false;
17142 /* Initialize iterator and info to start at POS. */
17143 start_display (&it
, w
, pos
);
17144 it
.glyph_row
->reversed_p
= false;
17146 /* Display all lines of W. */
17147 while (it
.current_y
< it
.last_visible_y
)
17149 if (display_line (&it
))
17150 last_text_row
= it
.glyph_row
- 1;
17151 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
17155 /* Don't let the cursor end in the scroll margins. */
17156 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
17157 && !MINI_WINDOW_P (w
))
17159 int this_scroll_margin
;
17160 int window_total_lines
17161 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
17163 if (scroll_margin
> 0)
17165 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
17166 this_scroll_margin
*= frame_line_height
;
17169 this_scroll_margin
= 0;
17171 if ((w
->cursor
.y
>= 0 /* not vscrolled */
17172 && w
->cursor
.y
< this_scroll_margin
17173 && CHARPOS (pos
) > BEGV
17174 && IT_CHARPOS (it
) < ZV
)
17175 /* rms: considering make_cursor_line_fully_visible_p here
17176 seems to give wrong results. We don't want to recenter
17177 when the last line is partly visible, we want to allow
17178 that case to be handled in the usual way. */
17179 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
17181 w
->cursor
.vpos
= -1;
17182 clear_glyph_matrix (w
->desired_matrix
);
17187 /* If bottom moved off end of frame, change mode line percentage. */
17188 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
17189 w
->update_mode_line
= true;
17191 /* Set window_end_pos to the offset of the last character displayed
17192 on the window from the end of current_buffer. Set
17193 window_end_vpos to its row number. */
17196 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
17197 adjust_window_ends (w
, last_text_row
, false);
17199 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
17200 w
->window_end_vpos
)));
17204 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17205 w
->window_end_pos
= Z
- ZV
;
17206 w
->window_end_vpos
= 0;
17209 /* But that is not valid info until redisplay finishes. */
17210 w
->window_end_valid
= false;
17216 /************************************************************************
17217 Window redisplay reusing current matrix when buffer has not changed
17218 ************************************************************************/
17220 /* Try redisplay of window W showing an unchanged buffer with a
17221 different window start than the last time it was displayed by
17222 reusing its current matrix. Value is true if successful.
17223 W->start is the new window start. */
17226 try_window_reusing_current_matrix (struct window
*w
)
17228 struct frame
*f
= XFRAME (w
->frame
);
17229 struct glyph_row
*bottom_row
;
17232 struct text_pos start
, new_start
;
17233 int nrows_scrolled
, i
;
17234 struct glyph_row
*last_text_row
;
17235 struct glyph_row
*last_reused_text_row
;
17236 struct glyph_row
*start_row
;
17237 int start_vpos
, min_y
, max_y
;
17240 if (inhibit_try_window_reusing
)
17244 if (/* This function doesn't handle terminal frames. */
17245 !FRAME_WINDOW_P (f
)
17246 /* Don't try to reuse the display if windows have been split
17248 || windows_or_buffers_changed
17249 || f
->cursor_type_changed
)
17252 /* Can't do this if showing trailing whitespace. */
17253 if (!NILP (Vshow_trailing_whitespace
))
17256 /* If top-line visibility has changed, give up. */
17257 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17258 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17261 /* Give up if old or new display is scrolled vertically. We could
17262 make this function handle this, but right now it doesn't. */
17263 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17264 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17267 /* The variable new_start now holds the new window start. The old
17268 start `start' can be determined from the current matrix. */
17269 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17270 start
= start_row
->minpos
;
17271 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17273 /* Clear the desired matrix for the display below. */
17274 clear_glyph_matrix (w
->desired_matrix
);
17276 if (CHARPOS (new_start
) <= CHARPOS (start
))
17278 /* Don't use this method if the display starts with an ellipsis
17279 displayed for invisible text. It's not easy to handle that case
17280 below, and it's certainly not worth the effort since this is
17281 not a frequent case. */
17282 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17285 IF_DEBUG (debug_method_add (w
, "twu1"));
17287 /* Display up to a row that can be reused. The variable
17288 last_text_row is set to the last row displayed that displays
17289 text. Note that it.vpos == 0 if or if not there is a
17290 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17291 start_display (&it
, w
, new_start
);
17292 w
->cursor
.vpos
= -1;
17293 last_text_row
= last_reused_text_row
= NULL
;
17295 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17297 /* If we have reached into the characters in the START row,
17298 that means the line boundaries have changed. So we
17299 can't start copying with the row START. Maybe it will
17300 work to start copying with the following row. */
17301 while (IT_CHARPOS (it
) > CHARPOS (start
))
17303 /* Advance to the next row as the "start". */
17305 start
= start_row
->minpos
;
17306 /* If there are no more rows to try, or just one, give up. */
17307 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17308 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17309 || CHARPOS (start
) == ZV
)
17311 clear_glyph_matrix (w
->desired_matrix
);
17315 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17317 /* If we have reached alignment, we can copy the rest of the
17319 if (IT_CHARPOS (it
) == CHARPOS (start
)
17320 /* Don't accept "alignment" inside a display vector,
17321 since start_row could have started in the middle of
17322 that same display vector (thus their character
17323 positions match), and we have no way of telling if
17324 that is the case. */
17325 && it
.current
.dpvec_index
< 0)
17328 it
.glyph_row
->reversed_p
= false;
17329 if (display_line (&it
))
17330 last_text_row
= it
.glyph_row
- 1;
17334 /* A value of current_y < last_visible_y means that we stopped
17335 at the previous window start, which in turn means that we
17336 have at least one reusable row. */
17337 if (it
.current_y
< it
.last_visible_y
)
17339 struct glyph_row
*row
;
17341 /* IT.vpos always starts from 0; it counts text lines. */
17342 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17344 /* Find PT if not already found in the lines displayed. */
17345 if (w
->cursor
.vpos
< 0)
17347 int dy
= it
.current_y
- start_row
->y
;
17349 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17350 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17352 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17353 dy
, nrows_scrolled
);
17356 clear_glyph_matrix (w
->desired_matrix
);
17361 /* Scroll the display. Do it before the current matrix is
17362 changed. The problem here is that update has not yet
17363 run, i.e. part of the current matrix is not up to date.
17364 scroll_run_hook will clear the cursor, and use the
17365 current matrix to get the height of the row the cursor is
17367 run
.current_y
= start_row
->y
;
17368 run
.desired_y
= it
.current_y
;
17369 run
.height
= it
.last_visible_y
- it
.current_y
;
17371 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17374 FRAME_RIF (f
)->update_window_begin_hook (w
);
17375 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17376 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17377 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17381 /* Shift current matrix down by nrows_scrolled lines. */
17382 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17383 rotate_matrix (w
->current_matrix
,
17385 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17388 /* Disable lines that must be updated. */
17389 for (i
= 0; i
< nrows_scrolled
; ++i
)
17390 (start_row
+ i
)->enabled_p
= false;
17392 /* Re-compute Y positions. */
17393 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17394 max_y
= it
.last_visible_y
;
17395 for (row
= start_row
+ nrows_scrolled
;
17399 row
->y
= it
.current_y
;
17400 row
->visible_height
= row
->height
;
17402 if (row
->y
< min_y
)
17403 row
->visible_height
-= min_y
- row
->y
;
17404 if (row
->y
+ row
->height
> max_y
)
17405 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17406 if (row
->fringe_bitmap_periodic_p
)
17407 row
->redraw_fringe_bitmaps_p
= true;
17409 it
.current_y
+= row
->height
;
17411 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17412 last_reused_text_row
= row
;
17413 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17417 /* Disable lines in the current matrix which are now
17418 below the window. */
17419 for (++row
; row
< bottom_row
; ++row
)
17420 row
->enabled_p
= row
->mode_line_p
= false;
17423 /* Update window_end_pos etc.; last_reused_text_row is the last
17424 reused row from the current matrix containing text, if any.
17425 The value of last_text_row is the last displayed line
17426 containing text. */
17427 if (last_reused_text_row
)
17428 adjust_window_ends (w
, last_reused_text_row
, true);
17429 else if (last_text_row
)
17430 adjust_window_ends (w
, last_text_row
, false);
17433 /* This window must be completely empty. */
17434 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17435 w
->window_end_pos
= Z
- ZV
;
17436 w
->window_end_vpos
= 0;
17438 w
->window_end_valid
= false;
17440 /* Update hint: don't try scrolling again in update_window. */
17441 w
->desired_matrix
->no_scrolling_p
= true;
17444 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17448 else if (CHARPOS (new_start
) > CHARPOS (start
))
17450 struct glyph_row
*pt_row
, *row
;
17451 struct glyph_row
*first_reusable_row
;
17452 struct glyph_row
*first_row_to_display
;
17454 int yb
= window_text_bottom_y (w
);
17456 /* Find the row starting at new_start, if there is one. Don't
17457 reuse a partially visible line at the end. */
17458 first_reusable_row
= start_row
;
17459 while (first_reusable_row
->enabled_p
17460 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17461 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17462 < CHARPOS (new_start
)))
17463 ++first_reusable_row
;
17465 /* Give up if there is no row to reuse. */
17466 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17467 || !first_reusable_row
->enabled_p
17468 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17469 != CHARPOS (new_start
)))
17472 /* We can reuse fully visible rows beginning with
17473 first_reusable_row to the end of the window. Set
17474 first_row_to_display to the first row that cannot be reused.
17475 Set pt_row to the row containing point, if there is any. */
17477 for (first_row_to_display
= first_reusable_row
;
17478 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17479 ++first_row_to_display
)
17481 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17482 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17483 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17484 && first_row_to_display
->ends_at_zv_p
17485 && pt_row
== NULL
)))
17486 pt_row
= first_row_to_display
;
17489 /* Start displaying at the start of first_row_to_display. */
17490 eassert (first_row_to_display
->y
< yb
);
17491 init_to_row_start (&it
, w
, first_row_to_display
);
17493 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17495 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17497 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17498 + WINDOW_HEADER_LINE_HEIGHT (w
));
17500 /* Display lines beginning with first_row_to_display in the
17501 desired matrix. Set last_text_row to the last row displayed
17502 that displays text. */
17503 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17504 if (pt_row
== NULL
)
17505 w
->cursor
.vpos
= -1;
17506 last_text_row
= NULL
;
17507 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17508 if (display_line (&it
))
17509 last_text_row
= it
.glyph_row
- 1;
17511 /* If point is in a reused row, adjust y and vpos of the cursor
17515 w
->cursor
.vpos
-= nrows_scrolled
;
17516 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17519 /* Give up if point isn't in a row displayed or reused. (This
17520 also handles the case where w->cursor.vpos < nrows_scrolled
17521 after the calls to display_line, which can happen with scroll
17522 margins. See bug#1295.) */
17523 if (w
->cursor
.vpos
< 0)
17525 clear_glyph_matrix (w
->desired_matrix
);
17529 /* Scroll the display. */
17530 run
.current_y
= first_reusable_row
->y
;
17531 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17532 run
.height
= it
.last_visible_y
- run
.current_y
;
17533 dy
= run
.current_y
- run
.desired_y
;
17538 FRAME_RIF (f
)->update_window_begin_hook (w
);
17539 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17540 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17541 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17545 /* Adjust Y positions of reused rows. */
17546 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17547 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17548 max_y
= it
.last_visible_y
;
17549 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17552 row
->visible_height
= row
->height
;
17553 if (row
->y
< min_y
)
17554 row
->visible_height
-= min_y
- row
->y
;
17555 if (row
->y
+ row
->height
> max_y
)
17556 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17557 if (row
->fringe_bitmap_periodic_p
)
17558 row
->redraw_fringe_bitmaps_p
= true;
17561 /* Scroll the current matrix. */
17562 eassert (nrows_scrolled
> 0);
17563 rotate_matrix (w
->current_matrix
,
17565 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17568 /* Disable rows not reused. */
17569 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17570 row
->enabled_p
= false;
17572 /* Point may have moved to a different line, so we cannot assume that
17573 the previous cursor position is valid; locate the correct row. */
17576 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17578 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17579 && !row
->ends_at_zv_p
;
17583 w
->cursor
.y
= row
->y
;
17585 if (row
< bottom_row
)
17587 /* Can't simply scan the row for point with
17588 bidi-reordered glyph rows. Let set_cursor_from_row
17589 figure out where to put the cursor, and if it fails,
17591 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17593 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17596 clear_glyph_matrix (w
->desired_matrix
);
17602 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17603 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17606 && (!BUFFERP (glyph
->object
)
17607 || glyph
->charpos
< PT
);
17611 w
->cursor
.x
+= glyph
->pixel_width
;
17617 /* Adjust window end. A null value of last_text_row means that
17618 the window end is in reused rows which in turn means that
17619 only its vpos can have changed. */
17621 adjust_window_ends (w
, last_text_row
, false);
17623 w
->window_end_vpos
-= nrows_scrolled
;
17625 w
->window_end_valid
= false;
17626 w
->desired_matrix
->no_scrolling_p
= true;
17629 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17639 /************************************************************************
17640 Window redisplay reusing current matrix when buffer has changed
17641 ************************************************************************/
17643 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17644 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17645 ptrdiff_t *, ptrdiff_t *);
17646 static struct glyph_row
*
17647 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17648 struct glyph_row
*);
17651 /* Return the last row in MATRIX displaying text. If row START is
17652 non-null, start searching with that row. IT gives the dimensions
17653 of the display. Value is null if matrix is empty; otherwise it is
17654 a pointer to the row found. */
17656 static struct glyph_row
*
17657 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17658 struct glyph_row
*start
)
17660 struct glyph_row
*row
, *row_found
;
17662 /* Set row_found to the last row in IT->w's current matrix
17663 displaying text. The loop looks funny but think of partially
17666 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17667 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17669 eassert (row
->enabled_p
);
17671 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17680 /* Return the last row in the current matrix of W that is not affected
17681 by changes at the start of current_buffer that occurred since W's
17682 current matrix was built. Value is null if no such row exists.
17684 BEG_UNCHANGED us the number of characters unchanged at the start of
17685 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17686 first changed character in current_buffer. Characters at positions <
17687 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17688 when the current matrix was built. */
17690 static struct glyph_row
*
17691 find_last_unchanged_at_beg_row (struct window
*w
)
17693 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17694 struct glyph_row
*row
;
17695 struct glyph_row
*row_found
= NULL
;
17696 int yb
= window_text_bottom_y (w
);
17698 /* Find the last row displaying unchanged text. */
17699 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17700 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17701 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17704 if (/* If row ends before first_changed_pos, it is unchanged,
17705 except in some case. */
17706 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17707 /* When row ends in ZV and we write at ZV it is not
17709 && !row
->ends_at_zv_p
17710 /* When first_changed_pos is the end of a continued line,
17711 row is not unchanged because it may be no longer
17713 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17714 && (row
->continued_p
17715 || row
->exact_window_width_line_p
))
17716 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17717 needs to be recomputed, so don't consider this row as
17718 unchanged. This happens when the last line was
17719 bidi-reordered and was killed immediately before this
17720 redisplay cycle. In that case, ROW->end stores the
17721 buffer position of the first visual-order character of
17722 the killed text, which is now beyond ZV. */
17723 && CHARPOS (row
->end
.pos
) <= ZV
)
17726 /* Stop if last visible row. */
17727 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17735 /* Find the first glyph row in the current matrix of W that is not
17736 affected by changes at the end of current_buffer since the
17737 time W's current matrix was built.
17739 Return in *DELTA the number of chars by which buffer positions in
17740 unchanged text at the end of current_buffer must be adjusted.
17742 Return in *DELTA_BYTES the corresponding number of bytes.
17744 Value is null if no such row exists, i.e. all rows are affected by
17747 static struct glyph_row
*
17748 find_first_unchanged_at_end_row (struct window
*w
,
17749 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17751 struct glyph_row
*row
;
17752 struct glyph_row
*row_found
= NULL
;
17754 *delta
= *delta_bytes
= 0;
17756 /* Display must not have been paused, otherwise the current matrix
17757 is not up to date. */
17758 eassert (w
->window_end_valid
);
17760 /* A value of window_end_pos >= END_UNCHANGED means that the window
17761 end is in the range of changed text. If so, there is no
17762 unchanged row at the end of W's current matrix. */
17763 if (w
->window_end_pos
>= END_UNCHANGED
)
17766 /* Set row to the last row in W's current matrix displaying text. */
17767 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17769 /* If matrix is entirely empty, no unchanged row exists. */
17770 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17772 /* The value of row is the last glyph row in the matrix having a
17773 meaningful buffer position in it. The end position of row
17774 corresponds to window_end_pos. This allows us to translate
17775 buffer positions in the current matrix to current buffer
17776 positions for characters not in changed text. */
17778 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17779 ptrdiff_t Z_BYTE_old
=
17780 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17781 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17782 struct glyph_row
*first_text_row
17783 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17785 *delta
= Z
- Z_old
;
17786 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17788 /* Set last_unchanged_pos to the buffer position of the last
17789 character in the buffer that has not been changed. Z is the
17790 index + 1 of the last character in current_buffer, i.e. by
17791 subtracting END_UNCHANGED we get the index of the last
17792 unchanged character, and we have to add BEG to get its buffer
17794 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17795 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17797 /* Search backward from ROW for a row displaying a line that
17798 starts at a minimum position >= last_unchanged_pos_old. */
17799 for (; row
> first_text_row
; --row
)
17801 /* This used to abort, but it can happen.
17802 It is ok to just stop the search instead here. KFS. */
17803 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17806 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17811 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17817 /* Make sure that glyph rows in the current matrix of window W
17818 reference the same glyph memory as corresponding rows in the
17819 frame's frame matrix. This function is called after scrolling W's
17820 current matrix on a terminal frame in try_window_id and
17821 try_window_reusing_current_matrix. */
17824 sync_frame_with_window_matrix_rows (struct window
*w
)
17826 struct frame
*f
= XFRAME (w
->frame
);
17827 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17829 /* Preconditions: W must be a leaf window and full-width. Its frame
17830 must have a frame matrix. */
17831 eassert (BUFFERP (w
->contents
));
17832 eassert (WINDOW_FULL_WIDTH_P (w
));
17833 eassert (!FRAME_WINDOW_P (f
));
17835 /* If W is a full-width window, glyph pointers in W's current matrix
17836 have, by definition, to be the same as glyph pointers in the
17837 corresponding frame matrix. Note that frame matrices have no
17838 marginal areas (see build_frame_matrix). */
17839 window_row
= w
->current_matrix
->rows
;
17840 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17841 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17842 while (window_row
< window_row_end
)
17844 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17845 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17847 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17848 frame_row
->glyphs
[TEXT_AREA
] = start
;
17849 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17850 frame_row
->glyphs
[LAST_AREA
] = end
;
17852 /* Disable frame rows whose corresponding window rows have
17853 been disabled in try_window_id. */
17854 if (!window_row
->enabled_p
)
17855 frame_row
->enabled_p
= false;
17857 ++window_row
, ++frame_row
;
17862 /* Find the glyph row in window W containing CHARPOS. Consider all
17863 rows between START and END (not inclusive). END null means search
17864 all rows to the end of the display area of W. Value is the row
17865 containing CHARPOS or null. */
17868 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17869 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17871 struct glyph_row
*row
= start
;
17872 struct glyph_row
*best_row
= NULL
;
17873 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17876 /* If we happen to start on a header-line, skip that. */
17877 if (row
->mode_line_p
)
17880 if ((end
&& row
>= end
) || !row
->enabled_p
)
17883 last_y
= window_text_bottom_y (w
) - dy
;
17887 /* Give up if we have gone too far. */
17888 if ((end
&& row
>= end
) || !row
->enabled_p
)
17890 /* This formerly returned if they were equal.
17891 I think that both quantities are of a "last plus one" type;
17892 if so, when they are equal, the row is within the screen. -- rms. */
17893 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17896 /* If it is in this row, return this row. */
17897 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17898 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17899 /* The end position of a row equals the start
17900 position of the next row. If CHARPOS is there, we
17901 would rather consider it displayed in the next
17902 line, except when this line ends in ZV. */
17903 && !row_for_charpos_p (row
, charpos
)))
17904 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17908 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17909 || (!best_row
&& !row
->continued_p
))
17911 /* In bidi-reordered rows, there could be several rows whose
17912 edges surround CHARPOS, all of these rows belonging to
17913 the same continued line. We need to find the row which
17914 fits CHARPOS the best. */
17915 for (g
= row
->glyphs
[TEXT_AREA
];
17916 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17919 if (!STRINGP (g
->object
))
17921 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17923 mindif
= eabs (g
->charpos
- charpos
);
17925 /* Exact match always wins. */
17932 else if (best_row
&& !row
->continued_p
)
17939 /* Try to redisplay window W by reusing its existing display. W's
17940 current matrix must be up to date when this function is called,
17941 i.e., window_end_valid must be true.
17945 >= 1 if successful, i.e. display has been updated
17947 1 means the changes were in front of a newline that precedes
17948 the window start, and the whole current matrix was reused
17949 2 means the changes were after the last position displayed
17950 in the window, and the whole current matrix was reused
17951 3 means portions of the current matrix were reused, while
17952 some of the screen lines were redrawn
17953 -1 if redisplay with same window start is known not to succeed
17954 0 if otherwise unsuccessful
17956 The following steps are performed:
17958 1. Find the last row in the current matrix of W that is not
17959 affected by changes at the start of current_buffer. If no such row
17962 2. Find the first row in W's current matrix that is not affected by
17963 changes at the end of current_buffer. Maybe there is no such row.
17965 3. Display lines beginning with the row + 1 found in step 1 to the
17966 row found in step 2 or, if step 2 didn't find a row, to the end of
17969 4. If cursor is not known to appear on the window, give up.
17971 5. If display stopped at the row found in step 2, scroll the
17972 display and current matrix as needed.
17974 6. Maybe display some lines at the end of W, if we must. This can
17975 happen under various circumstances, like a partially visible line
17976 becoming fully visible, or because newly displayed lines are displayed
17977 in smaller font sizes.
17979 7. Update W's window end information. */
17982 try_window_id (struct window
*w
)
17984 struct frame
*f
= XFRAME (w
->frame
);
17985 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17986 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17987 struct glyph_row
*last_unchanged_at_beg_row
;
17988 struct glyph_row
*first_unchanged_at_end_row
;
17989 struct glyph_row
*row
;
17990 struct glyph_row
*bottom_row
;
17993 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17995 struct text_pos start_pos
;
17997 int first_unchanged_at_end_vpos
= 0;
17998 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17999 struct text_pos start
;
18000 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
18003 if (inhibit_try_window_id
)
18007 /* This is handy for debugging. */
18009 #define GIVE_UP(X) \
18011 TRACE ((stderr, "try_window_id give up %d\n", (X))); \
18015 #define GIVE_UP(X) return 0
18018 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
18020 /* Don't use this for mini-windows because these can show
18021 messages and mini-buffers, and we don't handle that here. */
18022 if (MINI_WINDOW_P (w
))
18025 /* This flag is used to prevent redisplay optimizations. */
18026 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
18029 /* This function's optimizations cannot be used if overlays have
18030 changed in the buffer displayed by the window, so give up if they
18032 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
18035 /* Verify that narrowing has not changed.
18036 Also verify that we were not told to prevent redisplay optimizations.
18037 It would be nice to further
18038 reduce the number of cases where this prevents try_window_id. */
18039 if (current_buffer
->clip_changed
18040 || current_buffer
->prevent_redisplay_optimizations_p
)
18043 /* Window must either use window-based redisplay or be full width. */
18044 if (!FRAME_WINDOW_P (f
)
18045 && (!FRAME_LINE_INS_DEL_OK (f
)
18046 || !WINDOW_FULL_WIDTH_P (w
)))
18049 /* Give up if point is known NOT to appear in W. */
18050 if (PT
< CHARPOS (start
))
18053 /* Another way to prevent redisplay optimizations. */
18054 if (w
->last_modified
== 0)
18057 /* Verify that window is not hscrolled. */
18058 if (w
->hscroll
!= 0)
18061 /* Verify that display wasn't paused. */
18062 if (!w
->window_end_valid
)
18065 /* Likewise if highlighting trailing whitespace. */
18066 if (!NILP (Vshow_trailing_whitespace
))
18069 /* Can't use this if overlay arrow position and/or string have
18071 if (overlay_arrows_changed_p ())
18074 /* When word-wrap is on, adding a space to the first word of a
18075 wrapped line can change the wrap position, altering the line
18076 above it. It might be worthwhile to handle this more
18077 intelligently, but for now just redisplay from scratch. */
18078 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
18081 /* Under bidi reordering, adding or deleting a character in the
18082 beginning of a paragraph, before the first strong directional
18083 character, can change the base direction of the paragraph (unless
18084 the buffer specifies a fixed paragraph direction), which will
18085 require redisplaying the whole paragraph. It might be worthwhile
18086 to find the paragraph limits and widen the range of redisplayed
18087 lines to that, but for now just give up this optimization and
18088 redisplay from scratch. */
18089 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
18090 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
18093 /* Give up if the buffer has line-spacing set, as Lisp-level changes
18094 to that variable require thorough redisplay. */
18095 if (!NILP (BVAR (XBUFFER (w
->contents
), extra_line_spacing
)))
18098 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
18099 only if buffer has really changed. The reason is that the gap is
18100 initially at Z for freshly visited files. The code below would
18101 set end_unchanged to 0 in that case. */
18102 if (MODIFF
> SAVE_MODIFF
18103 /* This seems to happen sometimes after saving a buffer. */
18104 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
18106 if (GPT
- BEG
< BEG_UNCHANGED
)
18107 BEG_UNCHANGED
= GPT
- BEG
;
18108 if (Z
- GPT
< END_UNCHANGED
)
18109 END_UNCHANGED
= Z
- GPT
;
18112 /* The position of the first and last character that has been changed. */
18113 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
18114 last_changed_charpos
= Z
- END_UNCHANGED
;
18116 /* If window starts after a line end, and the last change is in
18117 front of that newline, then changes don't affect the display.
18118 This case happens with stealth-fontification. Note that although
18119 the display is unchanged, glyph positions in the matrix have to
18120 be adjusted, of course. */
18121 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
18122 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
18123 && ((last_changed_charpos
< CHARPOS (start
)
18124 && CHARPOS (start
) == BEGV
)
18125 || (last_changed_charpos
< CHARPOS (start
) - 1
18126 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
18128 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
18129 struct glyph_row
*r0
;
18131 /* Compute how many chars/bytes have been added to or removed
18132 from the buffer. */
18133 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
18134 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
18135 Z_delta
= Z
- Z_old
;
18136 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
18138 /* Give up if PT is not in the window. Note that it already has
18139 been checked at the start of try_window_id that PT is not in
18140 front of the window start. */
18141 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
18144 /* If window start is unchanged, we can reuse the whole matrix
18145 as is, after adjusting glyph positions. No need to compute
18146 the window end again, since its offset from Z hasn't changed. */
18147 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18148 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
18149 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
18150 /* PT must not be in a partially visible line. */
18151 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
18152 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18154 /* Adjust positions in the glyph matrix. */
18155 if (Z_delta
|| Z_delta_bytes
)
18157 struct glyph_row
*r1
18158 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18159 increment_matrix_positions (w
->current_matrix
,
18160 MATRIX_ROW_VPOS (r0
, current_matrix
),
18161 MATRIX_ROW_VPOS (r1
, current_matrix
),
18162 Z_delta
, Z_delta_bytes
);
18165 /* Set the cursor. */
18166 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18168 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18173 /* Handle the case that changes are all below what is displayed in
18174 the window, and that PT is in the window. This shortcut cannot
18175 be taken if ZV is visible in the window, and text has been added
18176 there that is visible in the window. */
18177 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
18178 /* ZV is not visible in the window, or there are no
18179 changes at ZV, actually. */
18180 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
18181 || first_changed_charpos
== last_changed_charpos
))
18183 struct glyph_row
*r0
;
18185 /* Give up if PT is not in the window. Note that it already has
18186 been checked at the start of try_window_id that PT is not in
18187 front of the window start. */
18188 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
18191 /* If window start is unchanged, we can reuse the whole matrix
18192 as is, without changing glyph positions since no text has
18193 been added/removed in front of the window end. */
18194 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18195 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
18196 /* PT must not be in a partially visible line. */
18197 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
18198 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18200 /* We have to compute the window end anew since text
18201 could have been added/removed after it. */
18202 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18203 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18205 /* Set the cursor. */
18206 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18208 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18213 /* Give up if window start is in the changed area.
18215 The condition used to read
18217 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18219 but why that was tested escapes me at the moment. */
18220 if (CHARPOS (start
) >= first_changed_charpos
18221 && CHARPOS (start
) <= last_changed_charpos
)
18224 /* Check that window start agrees with the start of the first glyph
18225 row in its current matrix. Check this after we know the window
18226 start is not in changed text, otherwise positions would not be
18228 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18229 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
18232 /* Give up if the window ends in strings. Overlay strings
18233 at the end are difficult to handle, so don't try. */
18234 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
18235 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
18238 /* Compute the position at which we have to start displaying new
18239 lines. Some of the lines at the top of the window might be
18240 reusable because they are not displaying changed text. Find the
18241 last row in W's current matrix not affected by changes at the
18242 start of current_buffer. Value is null if changes start in the
18243 first line of window. */
18244 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18245 if (last_unchanged_at_beg_row
)
18247 /* Avoid starting to display in the middle of a character, a TAB
18248 for instance. This is easier than to set up the iterator
18249 exactly, and it's not a frequent case, so the additional
18250 effort wouldn't really pay off. */
18251 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18252 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18253 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18254 --last_unchanged_at_beg_row
;
18256 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18259 if (! init_to_row_end (&it
, w
, last_unchanged_at_beg_row
))
18261 start_pos
= it
.current
.pos
;
18263 /* Start displaying new lines in the desired matrix at the same
18264 vpos we would use in the current matrix, i.e. below
18265 last_unchanged_at_beg_row. */
18266 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18268 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18269 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18271 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18275 /* There are no reusable lines at the start of the window.
18276 Start displaying in the first text line. */
18277 start_display (&it
, w
, start
);
18278 it
.vpos
= it
.first_vpos
;
18279 start_pos
= it
.current
.pos
;
18282 /* Find the first row that is not affected by changes at the end of
18283 the buffer. Value will be null if there is no unchanged row, in
18284 which case we must redisplay to the end of the window. delta
18285 will be set to the value by which buffer positions beginning with
18286 first_unchanged_at_end_row have to be adjusted due to text
18288 first_unchanged_at_end_row
18289 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18290 IF_DEBUG (debug_delta
= delta
);
18291 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18293 /* Set stop_pos to the buffer position up to which we will have to
18294 display new lines. If first_unchanged_at_end_row != NULL, this
18295 is the buffer position of the start of the line displayed in that
18296 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18297 that we don't stop at a buffer position. */
18299 if (first_unchanged_at_end_row
)
18301 eassert (last_unchanged_at_beg_row
== NULL
18302 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18304 /* If this is a continuation line, move forward to the next one
18305 that isn't. Changes in lines above affect this line.
18306 Caution: this may move first_unchanged_at_end_row to a row
18307 not displaying text. */
18308 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18309 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18310 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18311 < it
.last_visible_y
))
18312 ++first_unchanged_at_end_row
;
18314 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18315 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18316 >= it
.last_visible_y
))
18317 first_unchanged_at_end_row
= NULL
;
18320 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18322 first_unchanged_at_end_vpos
18323 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18324 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18327 else if (last_unchanged_at_beg_row
== NULL
)
18333 /* Either there is no unchanged row at the end, or the one we have
18334 now displays text. This is a necessary condition for the window
18335 end pos calculation at the end of this function. */
18336 eassert (first_unchanged_at_end_row
== NULL
18337 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18339 debug_last_unchanged_at_beg_vpos
18340 = (last_unchanged_at_beg_row
18341 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18343 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18345 #endif /* GLYPH_DEBUG */
18348 /* Display new lines. Set last_text_row to the last new line
18349 displayed which has text on it, i.e. might end up as being the
18350 line where the window_end_vpos is. */
18351 w
->cursor
.vpos
= -1;
18352 last_text_row
= NULL
;
18353 overlay_arrow_seen
= false;
18354 if (it
.current_y
< it
.last_visible_y
18355 && !f
->fonts_changed
18356 && (first_unchanged_at_end_row
== NULL
18357 || IT_CHARPOS (it
) < stop_pos
))
18358 it
.glyph_row
->reversed_p
= false;
18359 while (it
.current_y
< it
.last_visible_y
18360 && !f
->fonts_changed
18361 && (first_unchanged_at_end_row
== NULL
18362 || IT_CHARPOS (it
) < stop_pos
))
18364 if (display_line (&it
))
18365 last_text_row
= it
.glyph_row
- 1;
18368 if (f
->fonts_changed
)
18371 /* The redisplay iterations in display_line above could have
18372 triggered font-lock, which could have done something that
18373 invalidates IT->w window's end-point information, on which we
18374 rely below. E.g., one package, which will remain unnamed, used
18375 to install a font-lock-fontify-region-function that called
18376 bury-buffer, whose side effect is to switch the buffer displayed
18377 by IT->w, and that predictably resets IT->w's window_end_valid
18378 flag, which we already tested at the entry to this function.
18379 Amply punish such packages/modes by giving up on this
18380 optimization in those cases. */
18381 if (!w
->window_end_valid
)
18383 clear_glyph_matrix (w
->desired_matrix
);
18387 /* Compute differences in buffer positions, y-positions etc. for
18388 lines reused at the bottom of the window. Compute what we can
18390 if (first_unchanged_at_end_row
18391 /* No lines reused because we displayed everything up to the
18392 bottom of the window. */
18393 && it
.current_y
< it
.last_visible_y
)
18396 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18398 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18399 run
.current_y
= first_unchanged_at_end_row
->y
;
18400 run
.desired_y
= run
.current_y
+ dy
;
18401 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18405 delta
= delta_bytes
= dvpos
= dy
18406 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18407 first_unchanged_at_end_row
= NULL
;
18409 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18412 /* Find the cursor if not already found. We have to decide whether
18413 PT will appear on this window (it sometimes doesn't, but this is
18414 not a very frequent case.) This decision has to be made before
18415 the current matrix is altered. A value of cursor.vpos < 0 means
18416 that PT is either in one of the lines beginning at
18417 first_unchanged_at_end_row or below the window. Don't care for
18418 lines that might be displayed later at the window end; as
18419 mentioned, this is not a frequent case. */
18420 if (w
->cursor
.vpos
< 0)
18422 /* Cursor in unchanged rows at the top? */
18423 if (PT
< CHARPOS (start_pos
)
18424 && last_unchanged_at_beg_row
)
18426 row
= row_containing_pos (w
, PT
,
18427 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18428 last_unchanged_at_beg_row
+ 1, 0);
18430 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18433 /* Start from first_unchanged_at_end_row looking for PT. */
18434 else if (first_unchanged_at_end_row
)
18436 row
= row_containing_pos (w
, PT
- delta
,
18437 first_unchanged_at_end_row
, NULL
, 0);
18439 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18440 delta_bytes
, dy
, dvpos
);
18443 /* Give up if cursor was not found. */
18444 if (w
->cursor
.vpos
< 0)
18446 clear_glyph_matrix (w
->desired_matrix
);
18451 /* Don't let the cursor end in the scroll margins. */
18453 int this_scroll_margin
, cursor_height
;
18454 int frame_line_height
= default_line_pixel_height (w
);
18455 int window_total_lines
18456 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18458 this_scroll_margin
=
18459 max (0, min (scroll_margin
, window_total_lines
/ 4));
18460 this_scroll_margin
*= frame_line_height
;
18461 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18463 if ((w
->cursor
.y
< this_scroll_margin
18464 && CHARPOS (start
) > BEGV
)
18465 /* Old redisplay didn't take scroll margin into account at the bottom,
18466 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18467 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18468 ? cursor_height
+ this_scroll_margin
18469 : 1)) > it
.last_visible_y
)
18471 w
->cursor
.vpos
= -1;
18472 clear_glyph_matrix (w
->desired_matrix
);
18477 /* Scroll the display. Do it before changing the current matrix so
18478 that xterm.c doesn't get confused about where the cursor glyph is
18480 if (dy
&& run
.height
)
18484 if (FRAME_WINDOW_P (f
))
18486 FRAME_RIF (f
)->update_window_begin_hook (w
);
18487 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18488 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18489 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
18493 /* Terminal frame. In this case, dvpos gives the number of
18494 lines to scroll by; dvpos < 0 means scroll up. */
18496 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18497 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18498 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18499 + WINDOW_WANTS_HEADER_LINE_P (w
)
18500 + window_internal_height (w
));
18502 #if defined (HAVE_GPM) || defined (MSDOS)
18503 x_clear_window_mouse_face (w
);
18505 /* Perform the operation on the screen. */
18508 /* Scroll last_unchanged_at_beg_row to the end of the
18509 window down dvpos lines. */
18510 set_terminal_window (f
, end
);
18512 /* On dumb terminals delete dvpos lines at the end
18513 before inserting dvpos empty lines. */
18514 if (!FRAME_SCROLL_REGION_OK (f
))
18515 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18517 /* Insert dvpos empty lines in front of
18518 last_unchanged_at_beg_row. */
18519 ins_del_lines (f
, from
, dvpos
);
18521 else if (dvpos
< 0)
18523 /* Scroll up last_unchanged_at_beg_vpos to the end of
18524 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18525 set_terminal_window (f
, end
);
18527 /* Delete dvpos lines in front of
18528 last_unchanged_at_beg_vpos. ins_del_lines will set
18529 the cursor to the given vpos and emit |dvpos| delete
18531 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18533 /* On a dumb terminal insert dvpos empty lines at the
18535 if (!FRAME_SCROLL_REGION_OK (f
))
18536 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18539 set_terminal_window (f
, 0);
18545 /* Shift reused rows of the current matrix to the right position.
18546 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18548 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18549 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18552 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18553 bottom_vpos
, dvpos
);
18554 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18557 else if (dvpos
> 0)
18559 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18560 bottom_vpos
, dvpos
);
18561 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18562 first_unchanged_at_end_vpos
+ dvpos
);
18565 /* For frame-based redisplay, make sure that current frame and window
18566 matrix are in sync with respect to glyph memory. */
18567 if (!FRAME_WINDOW_P (f
))
18568 sync_frame_with_window_matrix_rows (w
);
18570 /* Adjust buffer positions in reused rows. */
18571 if (delta
|| delta_bytes
)
18572 increment_matrix_positions (current_matrix
,
18573 first_unchanged_at_end_vpos
+ dvpos
,
18574 bottom_vpos
, delta
, delta_bytes
);
18576 /* Adjust Y positions. */
18578 shift_glyph_matrix (w
, current_matrix
,
18579 first_unchanged_at_end_vpos
+ dvpos
,
18582 if (first_unchanged_at_end_row
)
18584 first_unchanged_at_end_row
+= dvpos
;
18585 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18586 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18587 first_unchanged_at_end_row
= NULL
;
18590 /* If scrolling up, there may be some lines to display at the end of
18592 last_text_row_at_end
= NULL
;
18595 /* Scrolling up can leave for example a partially visible line
18596 at the end of the window to be redisplayed. */
18597 /* Set last_row to the glyph row in the current matrix where the
18598 window end line is found. It has been moved up or down in
18599 the matrix by dvpos. */
18600 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18601 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18603 /* If last_row is the window end line, it should display text. */
18604 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18606 /* If window end line was partially visible before, begin
18607 displaying at that line. Otherwise begin displaying with the
18608 line following it. */
18609 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18611 init_to_row_start (&it
, w
, last_row
);
18612 it
.vpos
= last_vpos
;
18613 it
.current_y
= last_row
->y
;
18617 init_to_row_end (&it
, w
, last_row
);
18618 it
.vpos
= 1 + last_vpos
;
18619 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18623 /* We may start in a continuation line. If so, we have to
18624 get the right continuation_lines_width and current_x. */
18625 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18626 it
.hpos
= it
.current_x
= 0;
18628 /* Display the rest of the lines at the window end. */
18629 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18630 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18632 /* Is it always sure that the display agrees with lines in
18633 the current matrix? I don't think so, so we mark rows
18634 displayed invalid in the current matrix by setting their
18635 enabled_p flag to false. */
18636 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18637 if (display_line (&it
))
18638 last_text_row_at_end
= it
.glyph_row
- 1;
18642 /* Update window_end_pos and window_end_vpos. */
18643 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18645 /* Window end line if one of the preserved rows from the current
18646 matrix. Set row to the last row displaying text in current
18647 matrix starting at first_unchanged_at_end_row, after
18649 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18650 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18651 first_unchanged_at_end_row
);
18652 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18653 adjust_window_ends (w
, row
, true);
18654 eassert (w
->window_end_bytepos
>= 0);
18655 IF_DEBUG (debug_method_add (w
, "A"));
18657 else if (last_text_row_at_end
)
18659 adjust_window_ends (w
, last_text_row_at_end
, false);
18660 eassert (w
->window_end_bytepos
>= 0);
18661 IF_DEBUG (debug_method_add (w
, "B"));
18663 else if (last_text_row
)
18665 /* We have displayed either to the end of the window or at the
18666 end of the window, i.e. the last row with text is to be found
18667 in the desired matrix. */
18668 adjust_window_ends (w
, last_text_row
, false);
18669 eassert (w
->window_end_bytepos
>= 0);
18671 else if (first_unchanged_at_end_row
== NULL
18672 && last_text_row
== NULL
18673 && last_text_row_at_end
== NULL
)
18675 /* Displayed to end of window, but no line containing text was
18676 displayed. Lines were deleted at the end of the window. */
18677 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
18678 int vpos
= w
->window_end_vpos
;
18679 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18680 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18683 row
== NULL
&& vpos
>= first_vpos
;
18684 --vpos
, --current_row
, --desired_row
)
18686 if (desired_row
->enabled_p
)
18688 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18691 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18695 eassert (row
!= NULL
);
18696 w
->window_end_vpos
= vpos
+ 1;
18697 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18698 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18699 eassert (w
->window_end_bytepos
>= 0);
18700 IF_DEBUG (debug_method_add (w
, "C"));
18705 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18706 debug_end_vpos
= w
->window_end_vpos
));
18708 /* Record that display has not been completed. */
18709 w
->window_end_valid
= false;
18710 w
->desired_matrix
->no_scrolling_p
= true;
18718 /***********************************************************************
18719 More debugging support
18720 ***********************************************************************/
18724 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18725 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18726 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18729 /* Dump the contents of glyph matrix MATRIX on stderr.
18731 GLYPHS 0 means don't show glyph contents.
18732 GLYPHS 1 means show glyphs in short form
18733 GLYPHS > 1 means show glyphs in long form. */
18736 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18739 for (i
= 0; i
< matrix
->nrows
; ++i
)
18740 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18744 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18745 the glyph row and area where the glyph comes from. */
18748 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18750 if (glyph
->type
== CHAR_GLYPH
18751 || glyph
->type
== GLYPHLESS_GLYPH
)
18754 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18755 glyph
- row
->glyphs
[TEXT_AREA
],
18756 (glyph
->type
== CHAR_GLYPH
18760 (BUFFERP (glyph
->object
)
18762 : (STRINGP (glyph
->object
)
18764 : (NILP (glyph
->object
)
18767 glyph
->pixel_width
,
18769 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18773 glyph
->left_box_line_p
,
18774 glyph
->right_box_line_p
);
18776 else if (glyph
->type
== STRETCH_GLYPH
)
18779 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18780 glyph
- row
->glyphs
[TEXT_AREA
],
18783 (BUFFERP (glyph
->object
)
18785 : (STRINGP (glyph
->object
)
18787 : (NILP (glyph
->object
)
18790 glyph
->pixel_width
,
18794 glyph
->left_box_line_p
,
18795 glyph
->right_box_line_p
);
18797 else if (glyph
->type
== IMAGE_GLYPH
)
18800 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18801 glyph
- row
->glyphs
[TEXT_AREA
],
18804 (BUFFERP (glyph
->object
)
18806 : (STRINGP (glyph
->object
)
18808 : (NILP (glyph
->object
)
18811 glyph
->pixel_width
,
18815 glyph
->left_box_line_p
,
18816 glyph
->right_box_line_p
);
18818 else if (glyph
->type
== COMPOSITE_GLYPH
)
18821 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18822 glyph
- row
->glyphs
[TEXT_AREA
],
18825 (BUFFERP (glyph
->object
)
18827 : (STRINGP (glyph
->object
)
18829 : (NILP (glyph
->object
)
18832 glyph
->pixel_width
,
18834 if (glyph
->u
.cmp
.automatic
)
18837 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18838 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18840 glyph
->left_box_line_p
,
18841 glyph
->right_box_line_p
);
18843 else if (glyph
->type
== XWIDGET_GLYPH
)
18845 #ifndef HAVE_XWIDGETS
18849 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
18850 glyph
- row
->glyphs
[TEXT_AREA
],
18853 (BUFFERP (glyph
->object
)
18855 : (STRINGP (glyph
->object
)
18858 glyph
->pixel_width
,
18862 glyph
->left_box_line_p
,
18863 glyph
->right_box_line_p
);
18869 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18870 GLYPHS 0 means don't show glyph contents.
18871 GLYPHS 1 means show glyphs in short form
18872 GLYPHS > 1 means show glyphs in long form. */
18875 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18879 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18880 fprintf (stderr
, "==============================================================================\n");
18882 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18883 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18885 MATRIX_ROW_START_CHARPOS (row
),
18886 MATRIX_ROW_END_CHARPOS (row
),
18887 row
->used
[TEXT_AREA
],
18888 row
->contains_overlapping_glyphs_p
,
18890 row
->truncated_on_left_p
,
18891 row
->truncated_on_right_p
,
18893 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18894 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18897 row
->ends_in_middle_of_char_p
,
18898 row
->starts_in_middle_of_char_p
,
18904 row
->visible_height
,
18907 /* The next 3 lines should align to "Start" in the header. */
18908 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18909 row
->end
.overlay_string_index
,
18910 row
->continuation_lines_width
);
18911 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18912 CHARPOS (row
->start
.string_pos
),
18913 CHARPOS (row
->end
.string_pos
));
18914 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18915 row
->end
.dpvec_index
);
18922 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18924 struct glyph
*glyph
= row
->glyphs
[area
];
18925 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18927 /* Glyph for a line end in text. */
18928 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18931 if (glyph
< glyph_end
)
18932 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18934 for (; glyph
< glyph_end
; ++glyph
)
18935 dump_glyph (row
, glyph
, area
);
18938 else if (glyphs
== 1)
18941 char s
[SHRT_MAX
+ 4];
18943 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18947 for (i
= 0; i
< row
->used
[area
]; ++i
)
18949 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18950 if (i
== row
->used
[area
] - 1
18951 && area
== TEXT_AREA
18952 && NILP (glyph
->object
)
18953 && glyph
->type
== CHAR_GLYPH
18954 && glyph
->u
.ch
== ' ')
18956 strcpy (&s
[i
], "[\\n]");
18959 else if (glyph
->type
== CHAR_GLYPH
18960 && glyph
->u
.ch
< 0x80
18961 && glyph
->u
.ch
>= ' ')
18962 s
[i
] = glyph
->u
.ch
;
18968 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18974 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18975 Sdump_glyph_matrix
, 0, 1, "p",
18976 doc
: /* Dump the current matrix of the selected window to stderr.
18977 Shows contents of glyph row structures. With non-nil
18978 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18979 glyphs in short form, otherwise show glyphs in long form.
18981 Interactively, no argument means show glyphs in short form;
18982 with numeric argument, its value is passed as the GLYPHS flag. */)
18983 (Lisp_Object glyphs
)
18985 struct window
*w
= XWINDOW (selected_window
);
18986 struct buffer
*buffer
= XBUFFER (w
->contents
);
18988 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18989 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18990 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18991 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18992 fprintf (stderr
, "=============================================\n");
18993 dump_glyph_matrix (w
->current_matrix
,
18994 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18999 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
19000 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* Dump the current glyph matrix of the selected frame to stderr.
19001 Only text-mode frames have frame glyph matrices. */)
19004 struct frame
*f
= XFRAME (selected_frame
);
19006 if (f
->current_matrix
)
19007 dump_glyph_matrix (f
->current_matrix
, 1);
19009 fprintf (stderr
, "*** This frame doesn't have a frame glyph matrix ***\n");
19014 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
19015 doc
: /* Dump glyph row ROW to stderr.
19016 GLYPH 0 means don't dump glyphs.
19017 GLYPH 1 means dump glyphs in short form.
19018 GLYPH > 1 or omitted means dump glyphs in long form. */)
19019 (Lisp_Object row
, Lisp_Object glyphs
)
19021 struct glyph_matrix
*matrix
;
19024 CHECK_NUMBER (row
);
19025 matrix
= XWINDOW (selected_window
)->current_matrix
;
19027 if (vpos
>= 0 && vpos
< matrix
->nrows
)
19028 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
19030 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
19035 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
19036 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
19037 GLYPH 0 means don't dump glyphs.
19038 GLYPH 1 means dump glyphs in short form.
19039 GLYPH > 1 or omitted means dump glyphs in long form.
19041 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
19043 (Lisp_Object row
, Lisp_Object glyphs
)
19045 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19046 struct frame
*sf
= SELECTED_FRAME ();
19047 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
19050 CHECK_NUMBER (row
);
19052 if (vpos
>= 0 && vpos
< m
->nrows
)
19053 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
19054 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
19060 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
19061 doc
: /* Toggle tracing of redisplay.
19062 With ARG, turn tracing on if and only if ARG is positive. */)
19066 trace_redisplay_p
= !trace_redisplay_p
;
19069 arg
= Fprefix_numeric_value (arg
);
19070 trace_redisplay_p
= XINT (arg
) > 0;
19077 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
19078 doc
: /* Like `format', but print result to stderr.
19079 usage: (trace-to-stderr STRING &rest OBJECTS) */)
19080 (ptrdiff_t nargs
, Lisp_Object
*args
)
19082 Lisp_Object s
= Fformat (nargs
, args
);
19083 fwrite (SDATA (s
), 1, SBYTES (s
), stderr
);
19087 #endif /* GLYPH_DEBUG */
19091 /***********************************************************************
19092 Building Desired Matrix Rows
19093 ***********************************************************************/
19095 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
19096 Used for non-window-redisplay windows, and for windows w/o left fringe. */
19098 static struct glyph_row
*
19099 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
19101 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19102 struct buffer
*buffer
= XBUFFER (w
->contents
);
19103 struct buffer
*old
= current_buffer
;
19104 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
19105 ptrdiff_t arrow_len
= SCHARS (overlay_arrow_string
);
19106 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
19107 const unsigned char *p
;
19110 int n_glyphs_before
;
19112 set_buffer_temp (buffer
);
19113 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
19114 scratch_glyph_row
.reversed_p
= false;
19115 it
.glyph_row
->used
[TEXT_AREA
] = 0;
19116 SET_TEXT_POS (it
.position
, 0, 0);
19118 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
19120 while (p
< arrow_end
)
19122 Lisp_Object face
, ilisp
;
19124 /* Get the next character. */
19126 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
19129 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
19130 if (! ASCII_CHAR_P (it
.c
))
19131 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
19135 /* Get its face. */
19136 ilisp
= make_number (p
- arrow_string
);
19137 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
19138 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
19140 /* Compute its width, get its glyphs. */
19141 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
19142 SET_TEXT_POS (it
.position
, -1, -1);
19143 PRODUCE_GLYPHS (&it
);
19145 /* If this character doesn't fit any more in the line, we have
19146 to remove some glyphs. */
19147 if (it
.current_x
> it
.last_visible_x
)
19149 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19154 set_buffer_temp (old
);
19155 return it
.glyph_row
;
19159 /* Insert truncation glyphs at the start of IT->glyph_row. Which
19160 glyphs to insert is determined by produce_special_glyphs. */
19163 insert_left_trunc_glyphs (struct it
*it
)
19165 struct it truncate_it
;
19166 struct glyph
*from
, *end
, *to
, *toend
;
19168 eassert (!FRAME_WINDOW_P (it
->f
)
19169 || (!it
->glyph_row
->reversed_p
19170 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19171 || (it
->glyph_row
->reversed_p
19172 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
19174 /* Get the truncation glyphs. */
19176 truncate_it
.current_x
= 0;
19177 truncate_it
.face_id
= DEFAULT_FACE_ID
;
19178 truncate_it
.glyph_row
= &scratch_glyph_row
;
19179 truncate_it
.area
= TEXT_AREA
;
19180 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
19181 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
19182 truncate_it
.object
= Qnil
;
19183 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
19185 /* Overwrite glyphs from IT with truncation glyphs. */
19186 if (!it
->glyph_row
->reversed_p
)
19188 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19190 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19191 end
= from
+ tused
;
19192 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19193 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
19194 if (FRAME_WINDOW_P (it
->f
))
19196 /* On GUI frames, when variable-size fonts are displayed,
19197 the truncation glyphs may need more pixels than the row's
19198 glyphs they overwrite. We overwrite more glyphs to free
19199 enough screen real estate, and enlarge the stretch glyph
19200 on the right (see display_line), if there is one, to
19201 preserve the screen position of the truncation glyphs on
19204 struct glyph
*g
= to
;
19207 /* The first glyph could be partially visible, in which case
19208 it->glyph_row->x will be negative. But we want the left
19209 truncation glyphs to be aligned at the left margin of the
19210 window, so we override the x coordinate at which the row
19212 it
->glyph_row
->x
= 0;
19213 while (g
< toend
&& w
< it
->truncation_pixel_width
)
19215 w
+= g
->pixel_width
;
19218 if (g
- to
- tused
> 0)
19220 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
19221 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
19223 used
= it
->glyph_row
->used
[TEXT_AREA
];
19224 if (it
->glyph_row
->truncated_on_right_p
19225 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
19226 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
19229 int extra
= w
- it
->truncation_pixel_width
;
19231 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
19238 /* There may be padding glyphs left over. Overwrite them too. */
19239 if (!FRAME_WINDOW_P (it
->f
))
19241 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
19243 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19250 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
19254 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19256 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19257 that back to front. */
19258 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19259 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19260 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19261 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19262 if (FRAME_WINDOW_P (it
->f
))
19265 struct glyph
*g
= to
;
19267 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19269 w
+= g
->pixel_width
;
19272 if (to
- g
- tused
> 0)
19274 if (it
->glyph_row
->truncated_on_right_p
19275 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19276 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19278 int extra
= w
- it
->truncation_pixel_width
;
19280 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19284 while (from
>= end
&& to
>= toend
)
19286 if (!FRAME_WINDOW_P (it
->f
))
19288 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19291 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19292 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19293 while (from
>= end
&& to
>= toend
)
19299 /* Need to free some room before prepending additional
19301 int move_by
= from
- end
+ 1;
19302 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19303 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19305 for ( ; g
>= g0
; g
--)
19307 while (from
>= end
)
19309 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19314 /* Compute the hash code for ROW. */
19316 row_hash (struct glyph_row
*row
)
19319 unsigned hashval
= 0;
19321 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19322 for (k
= 0; k
< row
->used
[area
]; ++k
)
19323 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19324 + row
->glyphs
[area
][k
].u
.val
19325 + row
->glyphs
[area
][k
].face_id
19326 + row
->glyphs
[area
][k
].padding_p
19327 + (row
->glyphs
[area
][k
].type
<< 2));
19332 /* Compute the pixel height and width of IT->glyph_row.
19334 Most of the time, ascent and height of a display line will be equal
19335 to the max_ascent and max_height values of the display iterator
19336 structure. This is not the case if
19338 1. We hit ZV without displaying anything. In this case, max_ascent
19339 and max_height will be zero.
19341 2. We have some glyphs that don't contribute to the line height.
19342 (The glyph row flag contributes_to_line_height_p is for future
19343 pixmap extensions).
19345 The first case is easily covered by using default values because in
19346 these cases, the line height does not really matter, except that it
19347 must not be zero. */
19350 compute_line_metrics (struct it
*it
)
19352 struct glyph_row
*row
= it
->glyph_row
;
19354 if (FRAME_WINDOW_P (it
->f
))
19356 int i
, min_y
, max_y
;
19358 /* The line may consist of one space only, that was added to
19359 place the cursor on it. If so, the row's height hasn't been
19361 if (row
->height
== 0)
19363 if (it
->max_ascent
+ it
->max_descent
== 0)
19364 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19365 row
->ascent
= it
->max_ascent
;
19366 row
->height
= it
->max_ascent
+ it
->max_descent
;
19367 row
->phys_ascent
= it
->max_phys_ascent
;
19368 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19369 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19372 /* Compute the width of this line. */
19373 row
->pixel_width
= row
->x
;
19374 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19375 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19377 eassert (row
->pixel_width
>= 0);
19378 eassert (row
->ascent
>= 0 && row
->height
> 0);
19380 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19381 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19383 /* If first line's physical ascent is larger than its logical
19384 ascent, use the physical ascent, and make the row taller.
19385 This makes accented characters fully visible. */
19386 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19387 && row
->phys_ascent
> row
->ascent
)
19389 row
->height
+= row
->phys_ascent
- row
->ascent
;
19390 row
->ascent
= row
->phys_ascent
;
19393 /* Compute how much of the line is visible. */
19394 row
->visible_height
= row
->height
;
19396 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19397 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19399 if (row
->y
< min_y
)
19400 row
->visible_height
-= min_y
- row
->y
;
19401 if (row
->y
+ row
->height
> max_y
)
19402 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19406 row
->pixel_width
= row
->used
[TEXT_AREA
];
19407 if (row
->continued_p
)
19408 row
->pixel_width
-= it
->continuation_pixel_width
;
19409 else if (row
->truncated_on_right_p
)
19410 row
->pixel_width
-= it
->truncation_pixel_width
;
19411 row
->ascent
= row
->phys_ascent
= 0;
19412 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19413 row
->extra_line_spacing
= 0;
19416 /* Compute a hash code for this row. */
19417 row
->hash
= row_hash (row
);
19419 it
->max_ascent
= it
->max_descent
= 0;
19420 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19424 /* Append one space to the glyph row of iterator IT if doing a
19425 window-based redisplay. The space has the same face as
19426 IT->face_id. Value is true if a space was added.
19428 This function is called to make sure that there is always one glyph
19429 at the end of a glyph row that the cursor can be set on under
19430 window-systems. (If there weren't such a glyph we would not know
19431 how wide and tall a box cursor should be displayed).
19433 At the same time this space let's a nicely handle clearing to the
19434 end of the line if the row ends in italic text. */
19437 append_space_for_newline (struct it
*it
, bool default_face_p
)
19439 if (FRAME_WINDOW_P (it
->f
))
19441 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19443 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19444 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19446 /* Save some values that must not be changed.
19447 Must save IT->c and IT->len because otherwise
19448 ITERATOR_AT_END_P wouldn't work anymore after
19449 append_space_for_newline has been called. */
19450 enum display_element_type saved_what
= it
->what
;
19451 int saved_c
= it
->c
, saved_len
= it
->len
;
19452 int saved_char_to_display
= it
->char_to_display
;
19453 int saved_x
= it
->current_x
;
19454 int saved_face_id
= it
->face_id
;
19455 bool saved_box_end
= it
->end_of_box_run_p
;
19456 struct text_pos saved_pos
;
19457 Lisp_Object saved_object
;
19461 saved_object
= it
->object
;
19462 saved_pos
= it
->position
;
19464 it
->what
= IT_CHARACTER
;
19465 memset (&it
->position
, 0, sizeof it
->position
);
19467 it
->c
= it
->char_to_display
= ' ';
19470 /* If the default face was remapped, be sure to use the
19471 remapped face for the appended newline. */
19472 if (default_face_p
)
19473 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19474 else if (it
->face_before_selective_p
)
19475 it
->face_id
= it
->saved_face_id
;
19476 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19477 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19478 /* In R2L rows, we will prepend a stretch glyph that will
19479 have the end_of_box_run_p flag set for it, so there's no
19480 need for the appended newline glyph to have that flag
19482 if (it
->glyph_row
->reversed_p
19483 /* But if the appended newline glyph goes all the way to
19484 the end of the row, there will be no stretch glyph,
19485 so leave the box flag set. */
19486 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19487 it
->end_of_box_run_p
= false;
19489 PRODUCE_GLYPHS (it
);
19491 #ifdef HAVE_WINDOW_SYSTEM
19492 /* Make sure this space glyph has the right ascent and
19493 descent values, or else cursor at end of line will look
19494 funny, and height of empty lines will be incorrect. */
19495 g
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19496 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
19499 Lisp_Object height
, total_height
;
19500 int extra_line_spacing
= it
->extra_line_spacing
;
19501 int boff
= font
->baseline_offset
;
19503 if (font
->vertical_centering
)
19504 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
19506 it
->object
= saved_object
; /* get_it_property needs this */
19507 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
19508 /* Must do a subset of line height processing from
19509 x_produce_glyph for newline characters. */
19510 height
= get_it_property (it
, Qline_height
);
19512 && CONSP (XCDR (height
))
19513 && NILP (XCDR (XCDR (height
))))
19515 total_height
= XCAR (XCDR (height
));
19516 height
= XCAR (height
);
19519 total_height
= Qnil
;
19520 height
= calc_line_height_property (it
, height
, font
, boff
, true);
19522 if (it
->override_ascent
>= 0)
19524 it
->ascent
= it
->override_ascent
;
19525 it
->descent
= it
->override_descent
;
19526 boff
= it
->override_boff
;
19528 if (EQ (height
, Qt
))
19529 extra_line_spacing
= 0;
19532 Lisp_Object spacing
;
19534 it
->phys_ascent
= it
->ascent
;
19535 it
->phys_descent
= it
->descent
;
19537 && XINT (height
) > it
->ascent
+ it
->descent
)
19538 it
->ascent
= XINT (height
) - it
->descent
;
19540 if (!NILP (total_height
))
19541 spacing
= calc_line_height_property (it
, total_height
, font
,
19545 spacing
= get_it_property (it
, Qline_spacing
);
19546 spacing
= calc_line_height_property (it
, spacing
, font
,
19549 if (INTEGERP (spacing
))
19551 extra_line_spacing
= XINT (spacing
);
19552 if (!NILP (total_height
))
19553 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
19556 if (extra_line_spacing
> 0)
19558 it
->descent
+= extra_line_spacing
;
19559 if (extra_line_spacing
> it
->max_extra_line_spacing
)
19560 it
->max_extra_line_spacing
= extra_line_spacing
;
19562 it
->max_ascent
= it
->ascent
;
19563 it
->max_descent
= it
->descent
;
19564 /* Make sure compute_line_metrics recomputes the row height. */
19565 it
->glyph_row
->height
= 0;
19568 g
->ascent
= it
->max_ascent
;
19569 g
->descent
= it
->max_descent
;
19572 it
->override_ascent
= -1;
19573 it
->constrain_row_ascent_descent_p
= false;
19574 it
->current_x
= saved_x
;
19575 it
->object
= saved_object
;
19576 it
->position
= saved_pos
;
19577 it
->what
= saved_what
;
19578 it
->face_id
= saved_face_id
;
19579 it
->len
= saved_len
;
19581 it
->char_to_display
= saved_char_to_display
;
19582 it
->end_of_box_run_p
= saved_box_end
;
19591 /* Extend the face of the last glyph in the text area of IT->glyph_row
19592 to the end of the display line. Called from display_line. If the
19593 glyph row is empty, add a space glyph to it so that we know the
19594 face to draw. Set the glyph row flag fill_line_p. If the glyph
19595 row is R2L, prepend a stretch glyph to cover the empty space to the
19596 left of the leftmost glyph. */
19599 extend_face_to_end_of_line (struct it
*it
)
19601 struct face
*face
, *default_face
;
19602 struct frame
*f
= it
->f
;
19604 /* If line is already filled, do nothing. Non window-system frames
19605 get a grace of one more ``pixel'' because their characters are
19606 1-``pixel'' wide, so they hit the equality too early. This grace
19607 is needed only for R2L rows that are not continued, to produce
19608 one extra blank where we could display the cursor. */
19609 if ((it
->current_x
>= it
->last_visible_x
19610 + (!FRAME_WINDOW_P (f
)
19611 && it
->glyph_row
->reversed_p
19612 && !it
->glyph_row
->continued_p
))
19613 /* If the window has display margins, we will need to extend
19614 their face even if the text area is filled. */
19615 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19616 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19619 /* The default face, possibly remapped. */
19620 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19622 /* Face extension extends the background and box of IT->face_id
19623 to the end of the line. If the background equals the background
19624 of the frame, we don't have to do anything. */
19625 if (it
->face_before_selective_p
)
19626 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19628 face
= FACE_FROM_ID (f
, it
->face_id
);
19630 if (FRAME_WINDOW_P (f
)
19631 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19632 && face
->box
== FACE_NO_BOX
19633 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19634 #ifdef HAVE_WINDOW_SYSTEM
19637 && !it
->glyph_row
->reversed_p
)
19640 /* Set the glyph row flag indicating that the face of the last glyph
19641 in the text area has to be drawn to the end of the text area. */
19642 it
->glyph_row
->fill_line_p
= true;
19644 /* If current character of IT is not ASCII, make sure we have the
19645 ASCII face. This will be automatically undone the next time
19646 get_next_display_element returns a multibyte character. Note
19647 that the character will always be single byte in unibyte
19649 if (!ASCII_CHAR_P (it
->c
))
19651 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19654 if (FRAME_WINDOW_P (f
))
19656 /* If the row is empty, add a space with the current face of IT,
19657 so that we know which face to draw. */
19658 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19660 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19661 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19662 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19664 /* Mode line and the header line don't have margins, and
19665 likewise the frame's tool-bar window, if there is any. */
19666 if (!(it
->glyph_row
->mode_line_p
19667 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19668 || (WINDOWP (f
->tool_bar_window
)
19669 && it
->w
== XWINDOW (f
->tool_bar_window
))
19673 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19674 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19676 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19677 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19679 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19681 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19682 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19684 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19685 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19687 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19690 #ifdef HAVE_WINDOW_SYSTEM
19691 if (it
->glyph_row
->reversed_p
)
19693 /* Prepend a stretch glyph to the row, such that the
19694 rightmost glyph will be drawn flushed all the way to the
19695 right margin of the window. The stretch glyph that will
19696 occupy the empty space, if any, to the left of the
19698 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19699 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19700 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19702 int row_width
, stretch_ascent
, stretch_width
;
19703 struct text_pos saved_pos
;
19705 bool saved_avoid_cursor
, saved_box_start
;
19707 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19708 row_width
+= g
->pixel_width
;
19710 /* FIXME: There are various minor display glitches in R2L
19711 rows when only one of the fringes is missing. The
19712 strange condition below produces the least bad effect. */
19713 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19714 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19715 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19716 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19718 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19719 stretch_width
-= row_width
;
19721 if (stretch_width
> 0)
19724 (((it
->ascent
+ it
->descent
)
19725 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19726 saved_pos
= it
->position
;
19727 memset (&it
->position
, 0, sizeof it
->position
);
19728 saved_avoid_cursor
= it
->avoid_cursor_p
;
19729 it
->avoid_cursor_p
= true;
19730 saved_face_id
= it
->face_id
;
19731 saved_box_start
= it
->start_of_box_run_p
;
19732 /* The last row's stretch glyph should get the default
19733 face, to avoid painting the rest of the window with
19734 the region face, if the region ends at ZV. */
19735 if (it
->glyph_row
->ends_at_zv_p
)
19736 it
->face_id
= default_face
->id
;
19738 it
->face_id
= face
->id
;
19739 it
->start_of_box_run_p
= false;
19740 append_stretch_glyph (it
, Qnil
, stretch_width
,
19741 it
->ascent
+ it
->descent
, stretch_ascent
);
19742 it
->position
= saved_pos
;
19743 it
->avoid_cursor_p
= saved_avoid_cursor
;
19744 it
->face_id
= saved_face_id
;
19745 it
->start_of_box_run_p
= saved_box_start
;
19747 /* If stretch_width comes out negative, it means that the
19748 last glyph is only partially visible. In R2L rows, we
19749 want the leftmost glyph to be partially visible, so we
19750 need to give the row the corresponding left offset. */
19751 if (stretch_width
< 0)
19752 it
->glyph_row
->x
= stretch_width
;
19754 #endif /* HAVE_WINDOW_SYSTEM */
19758 /* Save some values that must not be changed. */
19759 int saved_x
= it
->current_x
;
19760 struct text_pos saved_pos
;
19761 Lisp_Object saved_object
;
19762 enum display_element_type saved_what
= it
->what
;
19763 int saved_face_id
= it
->face_id
;
19765 saved_object
= it
->object
;
19766 saved_pos
= it
->position
;
19768 it
->what
= IT_CHARACTER
;
19769 memset (&it
->position
, 0, sizeof it
->position
);
19771 it
->c
= it
->char_to_display
= ' ';
19774 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19775 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19776 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19777 && !it
->glyph_row
->mode_line_p
19778 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19780 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19781 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19783 for (it
->current_x
= 0; g
< e
; g
++)
19784 it
->current_x
+= g
->pixel_width
;
19786 it
->area
= LEFT_MARGIN_AREA
;
19787 it
->face_id
= default_face
->id
;
19788 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19789 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19791 PRODUCE_GLYPHS (it
);
19792 /* term.c:produce_glyphs advances it->current_x only for
19794 it
->current_x
+= it
->pixel_width
;
19797 it
->current_x
= saved_x
;
19798 it
->area
= TEXT_AREA
;
19801 /* The last row's blank glyphs should get the default face, to
19802 avoid painting the rest of the window with the region face,
19803 if the region ends at ZV. */
19804 if (it
->glyph_row
->ends_at_zv_p
)
19805 it
->face_id
= default_face
->id
;
19807 it
->face_id
= face
->id
;
19808 PRODUCE_GLYPHS (it
);
19810 while (it
->current_x
<= it
->last_visible_x
)
19811 PRODUCE_GLYPHS (it
);
19813 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19814 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19815 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19816 && !it
->glyph_row
->mode_line_p
19817 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19819 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19820 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19822 for ( ; g
< e
; g
++)
19823 it
->current_x
+= g
->pixel_width
;
19825 it
->area
= RIGHT_MARGIN_AREA
;
19826 it
->face_id
= default_face
->id
;
19827 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19828 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19830 PRODUCE_GLYPHS (it
);
19831 it
->current_x
+= it
->pixel_width
;
19834 it
->area
= TEXT_AREA
;
19837 /* Don't count these blanks really. It would let us insert a left
19838 truncation glyph below and make us set the cursor on them, maybe. */
19839 it
->current_x
= saved_x
;
19840 it
->object
= saved_object
;
19841 it
->position
= saved_pos
;
19842 it
->what
= saved_what
;
19843 it
->face_id
= saved_face_id
;
19848 /* Value is true if text starting at CHARPOS in current_buffer is
19849 trailing whitespace. */
19852 trailing_whitespace_p (ptrdiff_t charpos
)
19854 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19857 while (bytepos
< ZV_BYTE
19858 && (c
= FETCH_CHAR (bytepos
),
19859 c
== ' ' || c
== '\t'))
19862 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19864 if (bytepos
!= PT_BYTE
)
19871 /* Highlight trailing whitespace, if any, in ROW. */
19874 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19876 int used
= row
->used
[TEXT_AREA
];
19880 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19881 struct glyph
*glyph
= start
+ used
- 1;
19883 if (row
->reversed_p
)
19885 /* Right-to-left rows need to be processed in the opposite
19886 direction, so swap the edge pointers. */
19888 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19891 /* Skip over glyphs inserted to display the cursor at the
19892 end of a line, for extending the face of the last glyph
19893 to the end of the line on terminals, and for truncation
19894 and continuation glyphs. */
19895 if (!row
->reversed_p
)
19897 while (glyph
>= start
19898 && glyph
->type
== CHAR_GLYPH
19899 && NILP (glyph
->object
))
19904 while (glyph
<= start
19905 && glyph
->type
== CHAR_GLYPH
19906 && NILP (glyph
->object
))
19910 /* If last glyph is a space or stretch, and it's trailing
19911 whitespace, set the face of all trailing whitespace glyphs in
19912 IT->glyph_row to `trailing-whitespace'. */
19913 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19914 && BUFFERP (glyph
->object
)
19915 && (glyph
->type
== STRETCH_GLYPH
19916 || (glyph
->type
== CHAR_GLYPH
19917 && glyph
->u
.ch
== ' '))
19918 && trailing_whitespace_p (glyph
->charpos
))
19920 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, false);
19924 if (!row
->reversed_p
)
19926 while (glyph
>= start
19927 && BUFFERP (glyph
->object
)
19928 && (glyph
->type
== STRETCH_GLYPH
19929 || (glyph
->type
== CHAR_GLYPH
19930 && glyph
->u
.ch
== ' ')))
19931 (glyph
--)->face_id
= face_id
;
19935 while (glyph
<= start
19936 && BUFFERP (glyph
->object
)
19937 && (glyph
->type
== STRETCH_GLYPH
19938 || (glyph
->type
== CHAR_GLYPH
19939 && glyph
->u
.ch
== ' ')))
19940 (glyph
++)->face_id
= face_id
;
19947 /* Value is true if glyph row ROW should be
19948 considered to hold the buffer position CHARPOS. */
19951 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19953 bool result
= true;
19955 if (charpos
== CHARPOS (row
->end
.pos
)
19956 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19958 /* Suppose the row ends on a string.
19959 Unless the row is continued, that means it ends on a newline
19960 in the string. If it's anything other than a display string
19961 (e.g., a before-string from an overlay), we don't want the
19962 cursor there. (This heuristic seems to give the optimal
19963 behavior for the various types of multi-line strings.)
19964 One exception: if the string has `cursor' property on one of
19965 its characters, we _do_ want the cursor there. */
19966 if (CHARPOS (row
->end
.string_pos
) >= 0)
19968 if (row
->continued_p
)
19972 /* Check for `display' property. */
19973 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19974 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19975 struct glyph
*glyph
;
19978 for (glyph
= end
; glyph
>= beg
; --glyph
)
19979 if (STRINGP (glyph
->object
))
19982 = Fget_char_property (make_number (charpos
),
19986 && display_prop_string_p (prop
, glyph
->object
));
19987 /* If there's a `cursor' property on one of the
19988 string's characters, this row is a cursor row,
19989 even though this is not a display string. */
19992 Lisp_Object s
= glyph
->object
;
19994 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19996 ptrdiff_t gpos
= glyph
->charpos
;
19998 if (!NILP (Fget_char_property (make_number (gpos
),
20010 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
20012 /* If the row ends in middle of a real character,
20013 and the line is continued, we want the cursor here.
20014 That's because CHARPOS (ROW->end.pos) would equal
20015 PT if PT is before the character. */
20016 if (!row
->ends_in_ellipsis_p
)
20017 result
= row
->continued_p
;
20019 /* If the row ends in an ellipsis, then
20020 CHARPOS (ROW->end.pos) will equal point after the
20021 invisible text. We want that position to be displayed
20022 after the ellipsis. */
20025 /* If the row ends at ZV, display the cursor at the end of that
20026 row instead of at the start of the row below. */
20028 result
= row
->ends_at_zv_p
;
20034 /* Value is true if glyph row ROW should be
20035 used to hold the cursor. */
20038 cursor_row_p (struct glyph_row
*row
)
20040 return row_for_charpos_p (row
, PT
);
20045 /* Push the property PROP so that it will be rendered at the current
20046 position in IT. Return true if PROP was successfully pushed, false
20047 otherwise. Called from handle_line_prefix to handle the
20048 `line-prefix' and `wrap-prefix' properties. */
20051 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
20053 struct text_pos pos
=
20054 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
20056 eassert (it
->method
== GET_FROM_BUFFER
20057 || it
->method
== GET_FROM_DISPLAY_VECTOR
20058 || it
->method
== GET_FROM_STRING
20059 || it
->method
== GET_FROM_IMAGE
);
20061 /* We need to save the current buffer/string position, so it will be
20062 restored by pop_it, because iterate_out_of_display_property
20063 depends on that being set correctly, but some situations leave
20064 it->position not yet set when this function is called. */
20065 push_it (it
, &pos
);
20067 if (STRINGP (prop
))
20069 if (SCHARS (prop
) == 0)
20076 it
->string_from_prefix_prop_p
= true;
20077 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
20078 it
->current
.overlay_string_index
= -1;
20079 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
20080 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
20081 it
->method
= GET_FROM_STRING
;
20082 it
->stop_charpos
= 0;
20084 it
->base_level_stop
= 0;
20086 /* Force paragraph direction to be that of the parent
20088 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
20089 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
20091 it
->paragraph_embedding
= L2R
;
20093 /* Set up the bidi iterator for this display string. */
20096 it
->bidi_it
.string
.lstring
= it
->string
;
20097 it
->bidi_it
.string
.s
= NULL
;
20098 it
->bidi_it
.string
.schars
= it
->end_charpos
;
20099 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
20100 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
20101 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
20102 it
->bidi_it
.w
= it
->w
;
20103 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
20106 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
20108 it
->method
= GET_FROM_STRETCH
;
20111 #ifdef HAVE_WINDOW_SYSTEM
20112 else if (IMAGEP (prop
))
20114 it
->what
= IT_IMAGE
;
20115 it
->image_id
= lookup_image (it
->f
, prop
);
20116 it
->method
= GET_FROM_IMAGE
;
20118 #endif /* HAVE_WINDOW_SYSTEM */
20121 pop_it (it
); /* bogus display property, give up */
20128 /* Return the character-property PROP at the current position in IT. */
20131 get_it_property (struct it
*it
, Lisp_Object prop
)
20133 Lisp_Object position
, object
= it
->object
;
20135 if (STRINGP (object
))
20136 position
= make_number (IT_STRING_CHARPOS (*it
));
20137 else if (BUFFERP (object
))
20139 position
= make_number (IT_CHARPOS (*it
));
20140 object
= it
->window
;
20145 return Fget_char_property (position
, prop
, object
);
20148 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
20151 handle_line_prefix (struct it
*it
)
20153 Lisp_Object prefix
;
20155 if (it
->continuation_lines_width
> 0)
20157 prefix
= get_it_property (it
, Qwrap_prefix
);
20159 prefix
= Vwrap_prefix
;
20163 prefix
= get_it_property (it
, Qline_prefix
);
20165 prefix
= Vline_prefix
;
20167 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
20169 /* If the prefix is wider than the window, and we try to wrap
20170 it, it would acquire its own wrap prefix, and so on till the
20171 iterator stack overflows. So, don't wrap the prefix. */
20172 it
->line_wrap
= TRUNCATE
;
20173 it
->avoid_cursor_p
= true;
20179 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
20180 only for R2L lines from display_line and display_string, when they
20181 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
20182 the line/string needs to be continued on the next glyph row. */
20184 unproduce_glyphs (struct it
*it
, int n
)
20186 struct glyph
*glyph
, *end
;
20188 eassert (it
->glyph_row
);
20189 eassert (it
->glyph_row
->reversed_p
);
20190 eassert (it
->area
== TEXT_AREA
);
20191 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
20193 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
20194 n
= it
->glyph_row
->used
[TEXT_AREA
];
20195 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
20196 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
20197 for ( ; glyph
< end
; glyph
++)
20198 glyph
[-n
] = *glyph
;
20201 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
20202 and ROW->maxpos. */
20204 find_row_edges (struct it
*it
, struct glyph_row
*row
,
20205 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
20206 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
20208 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20209 lines' rows is implemented for bidi-reordered rows. */
20211 /* ROW->minpos is the value of min_pos, the minimal buffer position
20212 we have in ROW, or ROW->start.pos if that is smaller. */
20213 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
20214 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
20216 /* We didn't find buffer positions smaller than ROW->start, or
20217 didn't find _any_ valid buffer positions in any of the glyphs,
20218 so we must trust the iterator's computed positions. */
20219 row
->minpos
= row
->start
.pos
;
20222 max_pos
= CHARPOS (it
->current
.pos
);
20223 max_bpos
= BYTEPOS (it
->current
.pos
);
20226 /* Here are the various use-cases for ending the row, and the
20227 corresponding values for ROW->maxpos:
20229 Line ends in a newline from buffer eol_pos + 1
20230 Line is continued from buffer max_pos + 1
20231 Line is truncated on right it->current.pos
20232 Line ends in a newline from string max_pos + 1(*)
20233 (*) + 1 only when line ends in a forward scan
20234 Line is continued from string max_pos
20235 Line is continued from display vector max_pos
20236 Line is entirely from a string min_pos == max_pos
20237 Line is entirely from a display vector min_pos == max_pos
20238 Line that ends at ZV ZV
20240 If you discover other use-cases, please add them here as
20242 if (row
->ends_at_zv_p
)
20243 row
->maxpos
= it
->current
.pos
;
20244 else if (row
->used
[TEXT_AREA
])
20246 bool seen_this_string
= false;
20247 struct glyph_row
*r1
= row
- 1;
20249 /* Did we see the same display string on the previous row? */
20250 if (STRINGP (it
->object
)
20251 /* this is not the first row */
20252 && row
> it
->w
->desired_matrix
->rows
20253 /* previous row is not the header line */
20254 && !r1
->mode_line_p
20255 /* previous row also ends in a newline from a string */
20256 && r1
->ends_in_newline_from_string_p
)
20258 struct glyph
*start
, *end
;
20260 /* Search for the last glyph of the previous row that came
20261 from buffer or string. Depending on whether the row is
20262 L2R or R2L, we need to process it front to back or the
20263 other way round. */
20264 if (!r1
->reversed_p
)
20266 start
= r1
->glyphs
[TEXT_AREA
];
20267 end
= start
+ r1
->used
[TEXT_AREA
];
20268 /* Glyphs inserted by redisplay have nil as their object. */
20270 && NILP ((end
- 1)->object
)
20271 && (end
- 1)->charpos
<= 0)
20275 if (EQ ((end
- 1)->object
, it
->object
))
20276 seen_this_string
= true;
20279 /* If all the glyphs of the previous row were inserted
20280 by redisplay, it means the previous row was
20281 produced from a single newline, which is only
20282 possible if that newline came from the same string
20283 as the one which produced this ROW. */
20284 seen_this_string
= true;
20288 end
= r1
->glyphs
[TEXT_AREA
] - 1;
20289 start
= end
+ r1
->used
[TEXT_AREA
];
20291 && NILP ((end
+ 1)->object
)
20292 && (end
+ 1)->charpos
<= 0)
20296 if (EQ ((end
+ 1)->object
, it
->object
))
20297 seen_this_string
= true;
20300 seen_this_string
= true;
20303 /* Take note of each display string that covers a newline only
20304 once, the first time we see it. This is for when a display
20305 string includes more than one newline in it. */
20306 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
20308 /* If we were scanning the buffer forward when we displayed
20309 the string, we want to account for at least one buffer
20310 position that belongs to this row (position covered by
20311 the display string), so that cursor positioning will
20312 consider this row as a candidate when point is at the end
20313 of the visual line represented by this row. This is not
20314 required when scanning back, because max_pos will already
20315 have a much larger value. */
20316 if (CHARPOS (row
->end
.pos
) > max_pos
)
20317 INC_BOTH (max_pos
, max_bpos
);
20318 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20320 else if (CHARPOS (it
->eol_pos
) > 0)
20321 SET_TEXT_POS (row
->maxpos
,
20322 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
20323 else if (row
->continued_p
)
20325 /* If max_pos is different from IT's current position, it
20326 means IT->method does not belong to the display element
20327 at max_pos. However, it also means that the display
20328 element at max_pos was displayed in its entirety on this
20329 line, which is equivalent to saying that the next line
20330 starts at the next buffer position. */
20331 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
20332 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20335 INC_BOTH (max_pos
, max_bpos
);
20336 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20339 else if (row
->truncated_on_right_p
)
20340 /* display_line already called reseat_at_next_visible_line_start,
20341 which puts the iterator at the beginning of the next line, in
20342 the logical order. */
20343 row
->maxpos
= it
->current
.pos
;
20344 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20345 /* A line that is entirely from a string/image/stretch... */
20346 row
->maxpos
= row
->minpos
;
20351 row
->maxpos
= it
->current
.pos
;
20354 /* Construct the glyph row IT->glyph_row in the desired matrix of
20355 IT->w from text at the current position of IT. See dispextern.h
20356 for an overview of struct it. Value is true if
20357 IT->glyph_row displays text, as opposed to a line displaying ZV
20361 display_line (struct it
*it
)
20363 struct glyph_row
*row
= it
->glyph_row
;
20364 Lisp_Object overlay_arrow_string
;
20366 void *wrap_data
= NULL
;
20367 bool may_wrap
= false;
20368 int wrap_x
IF_LINT (= 0);
20369 int wrap_row_used
= -1;
20370 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
20371 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
20372 int wrap_row_extra_line_spacing
IF_LINT (= 0);
20373 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
20374 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
20376 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20377 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
20378 bool pending_handle_line_prefix
= false;
20380 /* We always start displaying at hpos zero even if hscrolled. */
20381 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20383 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20384 >= it
->w
->desired_matrix
->nrows
)
20386 it
->w
->nrows_scale_factor
++;
20387 it
->f
->fonts_changed
= true;
20391 /* Clear the result glyph row and enable it. */
20392 prepare_desired_row (it
->w
, row
, false);
20394 row
->y
= it
->current_y
;
20395 row
->start
= it
->start
;
20396 row
->continuation_lines_width
= it
->continuation_lines_width
;
20397 row
->displays_text_p
= true;
20398 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20399 it
->starts_in_middle_of_char_p
= false;
20401 /* Arrange the overlays nicely for our purposes. Usually, we call
20402 display_line on only one line at a time, in which case this
20403 can't really hurt too much, or we call it on lines which appear
20404 one after another in the buffer, in which case all calls to
20405 recenter_overlay_lists but the first will be pretty cheap. */
20406 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20408 /* Move over display elements that are not visible because we are
20409 hscrolled. This may stop at an x-position < IT->first_visible_x
20410 if the first glyph is partially visible or if we hit a line end. */
20411 if (it
->current_x
< it
->first_visible_x
)
20413 enum move_it_result move_result
;
20415 this_line_min_pos
= row
->start
.pos
;
20416 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20417 MOVE_TO_POS
| MOVE_TO_X
);
20418 /* If we are under a large hscroll, move_it_in_display_line_to
20419 could hit the end of the line without reaching
20420 it->first_visible_x. Pretend that we did reach it. This is
20421 especially important on a TTY, where we will call
20422 extend_face_to_end_of_line, which needs to know how many
20423 blank glyphs to produce. */
20424 if (it
->current_x
< it
->first_visible_x
20425 && (move_result
== MOVE_NEWLINE_OR_CR
20426 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20427 it
->current_x
= it
->first_visible_x
;
20429 /* Record the smallest positions seen while we moved over
20430 display elements that are not visible. This is needed by
20431 redisplay_internal for optimizing the case where the cursor
20432 stays inside the same line. The rest of this function only
20433 considers positions that are actually displayed, so
20434 RECORD_MAX_MIN_POS will not otherwise record positions that
20435 are hscrolled to the left of the left edge of the window. */
20436 min_pos
= CHARPOS (this_line_min_pos
);
20437 min_bpos
= BYTEPOS (this_line_min_pos
);
20439 else if (it
->area
== TEXT_AREA
)
20441 /* We only do this when not calling move_it_in_display_line_to
20442 above, because that function calls itself handle_line_prefix. */
20443 handle_line_prefix (it
);
20447 /* Line-prefix and wrap-prefix are always displayed in the text
20448 area. But if this is the first call to display_line after
20449 init_iterator, the iterator might have been set up to write
20450 into a marginal area, e.g. if the line begins with some
20451 display property that writes to the margins. So we need to
20452 wait with the call to handle_line_prefix until whatever
20453 writes to the margin has done its job. */
20454 pending_handle_line_prefix
= true;
20457 /* Get the initial row height. This is either the height of the
20458 text hscrolled, if there is any, or zero. */
20459 row
->ascent
= it
->max_ascent
;
20460 row
->height
= it
->max_ascent
+ it
->max_descent
;
20461 row
->phys_ascent
= it
->max_phys_ascent
;
20462 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20463 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20465 /* Utility macro to record max and min buffer positions seen until now. */
20466 #define RECORD_MAX_MIN_POS(IT) \
20469 bool composition_p \
20470 = !STRINGP ((IT)->string) && ((IT)->what == IT_COMPOSITION); \
20471 ptrdiff_t current_pos = \
20472 composition_p ? (IT)->cmp_it.charpos \
20473 : IT_CHARPOS (*(IT)); \
20474 ptrdiff_t current_bpos = \
20475 composition_p ? CHAR_TO_BYTE (current_pos) \
20476 : IT_BYTEPOS (*(IT)); \
20477 if (current_pos < min_pos) \
20479 min_pos = current_pos; \
20480 min_bpos = current_bpos; \
20482 if (IT_CHARPOS (*it) > max_pos) \
20484 max_pos = IT_CHARPOS (*it); \
20485 max_bpos = IT_BYTEPOS (*it); \
20490 /* Loop generating characters. The loop is left with IT on the next
20491 character to display. */
20494 int n_glyphs_before
, hpos_before
, x_before
;
20496 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20498 /* Retrieve the next thing to display. Value is false if end of
20500 if (!get_next_display_element (it
))
20502 /* Maybe add a space at the end of this line that is used to
20503 display the cursor there under X. Set the charpos of the
20504 first glyph of blank lines not corresponding to any text
20506 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20507 row
->exact_window_width_line_p
= true;
20508 else if ((append_space_for_newline (it
, true)
20509 && row
->used
[TEXT_AREA
] == 1)
20510 || row
->used
[TEXT_AREA
] == 0)
20512 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20513 row
->displays_text_p
= false;
20515 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20516 && (!MINI_WINDOW_P (it
->w
)
20517 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20518 row
->indicate_empty_line_p
= true;
20521 it
->continuation_lines_width
= 0;
20522 row
->ends_at_zv_p
= true;
20523 /* A row that displays right-to-left text must always have
20524 its last face extended all the way to the end of line,
20525 even if this row ends in ZV, because we still write to
20526 the screen left to right. We also need to extend the
20527 last face if the default face is remapped to some
20528 different face, otherwise the functions that clear
20529 portions of the screen will clear with the default face's
20530 background color. */
20531 if (row
->reversed_p
20532 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20533 extend_face_to_end_of_line (it
);
20537 /* Now, get the metrics of what we want to display. This also
20538 generates glyphs in `row' (which is IT->glyph_row). */
20539 n_glyphs_before
= row
->used
[TEXT_AREA
];
20542 /* Remember the line height so far in case the next element doesn't
20543 fit on the line. */
20544 if (it
->line_wrap
!= TRUNCATE
)
20546 ascent
= it
->max_ascent
;
20547 descent
= it
->max_descent
;
20548 phys_ascent
= it
->max_phys_ascent
;
20549 phys_descent
= it
->max_phys_descent
;
20551 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20553 if (IT_DISPLAYING_WHITESPACE (it
))
20557 SAVE_IT (wrap_it
, *it
, wrap_data
);
20559 wrap_row_used
= row
->used
[TEXT_AREA
];
20560 wrap_row_ascent
= row
->ascent
;
20561 wrap_row_height
= row
->height
;
20562 wrap_row_phys_ascent
= row
->phys_ascent
;
20563 wrap_row_phys_height
= row
->phys_height
;
20564 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20565 wrap_row_min_pos
= min_pos
;
20566 wrap_row_min_bpos
= min_bpos
;
20567 wrap_row_max_pos
= max_pos
;
20568 wrap_row_max_bpos
= max_bpos
;
20574 PRODUCE_GLYPHS (it
);
20576 /* If this display element was in marginal areas, continue with
20578 if (it
->area
!= TEXT_AREA
)
20580 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20581 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20582 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20583 row
->phys_height
= max (row
->phys_height
,
20584 it
->max_phys_ascent
+ it
->max_phys_descent
);
20585 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20586 it
->max_extra_line_spacing
);
20587 set_iterator_to_next (it
, true);
20588 /* If we didn't handle the line/wrap prefix above, and the
20589 call to set_iterator_to_next just switched to TEXT_AREA,
20590 process the prefix now. */
20591 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20593 pending_handle_line_prefix
= false;
20594 handle_line_prefix (it
);
20599 /* Does the display element fit on the line? If we truncate
20600 lines, we should draw past the right edge of the window. If
20601 we don't truncate, we want to stop so that we can display the
20602 continuation glyph before the right margin. If lines are
20603 continued, there are two possible strategies for characters
20604 resulting in more than 1 glyph (e.g. tabs): Display as many
20605 glyphs as possible in this line and leave the rest for the
20606 continuation line, or display the whole element in the next
20607 line. Original redisplay did the former, so we do it also. */
20608 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20609 hpos_before
= it
->hpos
;
20612 if (/* Not a newline. */
20614 /* Glyphs produced fit entirely in the line. */
20615 && it
->current_x
< it
->last_visible_x
)
20617 it
->hpos
+= nglyphs
;
20618 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20619 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20620 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20621 row
->phys_height
= max (row
->phys_height
,
20622 it
->max_phys_ascent
+ it
->max_phys_descent
);
20623 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20624 it
->max_extra_line_spacing
);
20625 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20626 /* In R2L rows, we arrange in extend_face_to_end_of_line
20627 to add a right offset to the line, by a suitable
20628 change to the stretch glyph that is the leftmost
20629 glyph of the line. */
20630 && !row
->reversed_p
)
20631 row
->x
= x
- it
->first_visible_x
;
20632 /* Record the maximum and minimum buffer positions seen so
20633 far in glyphs that will be displayed by this row. */
20635 RECORD_MAX_MIN_POS (it
);
20640 struct glyph
*glyph
;
20642 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20644 /* Identify the glyphs added by the last call to
20645 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20646 the previous glyphs. */
20647 if (!row
->reversed_p
)
20648 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20650 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20651 new_x
= x
+ glyph
->pixel_width
;
20653 if (/* Lines are continued. */
20654 it
->line_wrap
!= TRUNCATE
20655 && (/* Glyph doesn't fit on the line. */
20656 new_x
> it
->last_visible_x
20657 /* Or it fits exactly on a window system frame. */
20658 || (new_x
== it
->last_visible_x
20659 && FRAME_WINDOW_P (it
->f
)
20660 && (row
->reversed_p
20661 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20662 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20664 /* End of a continued line. */
20667 || (new_x
== it
->last_visible_x
20668 && FRAME_WINDOW_P (it
->f
)
20669 && (row
->reversed_p
20670 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20671 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20673 /* Current glyph is the only one on the line or
20674 fits exactly on the line. We must continue
20675 the line because we can't draw the cursor
20676 after the glyph. */
20677 row
->continued_p
= true;
20678 it
->current_x
= new_x
;
20679 it
->continuation_lines_width
+= new_x
;
20681 if (i
== nglyphs
- 1)
20683 /* If line-wrap is on, check if a previous
20684 wrap point was found. */
20685 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)
20686 && wrap_row_used
> 0
20687 /* Even if there is a previous wrap
20688 point, continue the line here as
20689 usual, if (i) the previous character
20690 was a space or tab AND (ii) the
20691 current character is not. */
20693 || IT_DISPLAYING_WHITESPACE (it
)))
20696 /* Record the maximum and minimum buffer
20697 positions seen so far in glyphs that will be
20698 displayed by this row. */
20700 RECORD_MAX_MIN_POS (it
);
20701 set_iterator_to_next (it
, true);
20702 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20704 if (!get_next_display_element (it
))
20706 row
->exact_window_width_line_p
= true;
20707 it
->continuation_lines_width
= 0;
20708 row
->continued_p
= false;
20709 row
->ends_at_zv_p
= true;
20711 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20713 row
->continued_p
= false;
20714 row
->exact_window_width_line_p
= true;
20716 /* If line-wrap is on, check if a
20717 previous wrap point was found. */
20718 else if (wrap_row_used
> 0
20719 /* Even if there is a previous wrap
20720 point, continue the line here as
20721 usual, if (i) the previous character
20722 was a space or tab AND (ii) the
20723 current character is not. */
20725 || IT_DISPLAYING_WHITESPACE (it
)))
20730 else if (it
->bidi_p
)
20731 RECORD_MAX_MIN_POS (it
);
20732 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20733 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20734 extend_face_to_end_of_line (it
);
20736 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20737 && !FRAME_WINDOW_P (it
->f
))
20739 /* A padding glyph that doesn't fit on this line.
20740 This means the whole character doesn't fit
20742 if (row
->reversed_p
)
20743 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20744 - n_glyphs_before
);
20745 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20747 /* Fill the rest of the row with continuation
20748 glyphs like in 20.x. */
20749 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20750 < row
->glyphs
[1 + TEXT_AREA
])
20751 produce_special_glyphs (it
, IT_CONTINUATION
);
20753 row
->continued_p
= true;
20754 it
->current_x
= x_before
;
20755 it
->continuation_lines_width
+= x_before
;
20757 /* Restore the height to what it was before the
20758 element not fitting on the line. */
20759 it
->max_ascent
= ascent
;
20760 it
->max_descent
= descent
;
20761 it
->max_phys_ascent
= phys_ascent
;
20762 it
->max_phys_descent
= phys_descent
;
20763 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20764 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20765 extend_face_to_end_of_line (it
);
20767 else if (wrap_row_used
> 0)
20770 if (row
->reversed_p
)
20771 unproduce_glyphs (it
,
20772 row
->used
[TEXT_AREA
] - wrap_row_used
);
20773 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20774 it
->continuation_lines_width
+= wrap_x
;
20775 row
->used
[TEXT_AREA
] = wrap_row_used
;
20776 row
->ascent
= wrap_row_ascent
;
20777 row
->height
= wrap_row_height
;
20778 row
->phys_ascent
= wrap_row_phys_ascent
;
20779 row
->phys_height
= wrap_row_phys_height
;
20780 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20781 min_pos
= wrap_row_min_pos
;
20782 min_bpos
= wrap_row_min_bpos
;
20783 max_pos
= wrap_row_max_pos
;
20784 max_bpos
= wrap_row_max_bpos
;
20785 row
->continued_p
= true;
20786 row
->ends_at_zv_p
= false;
20787 row
->exact_window_width_line_p
= false;
20788 it
->continuation_lines_width
+= x
;
20790 /* Make sure that a non-default face is extended
20791 up to the right margin of the window. */
20792 extend_face_to_end_of_line (it
);
20794 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20796 /* A TAB that extends past the right edge of the
20797 window. This produces a single glyph on
20798 window system frames. We leave the glyph in
20799 this row and let it fill the row, but don't
20800 consume the TAB. */
20801 if ((row
->reversed_p
20802 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20803 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20804 produce_special_glyphs (it
, IT_CONTINUATION
);
20805 it
->continuation_lines_width
+= it
->last_visible_x
;
20806 row
->ends_in_middle_of_char_p
= true;
20807 row
->continued_p
= true;
20808 glyph
->pixel_width
= it
->last_visible_x
- x
;
20809 it
->starts_in_middle_of_char_p
= true;
20810 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20811 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20812 extend_face_to_end_of_line (it
);
20816 /* Something other than a TAB that draws past
20817 the right edge of the window. Restore
20818 positions to values before the element. */
20819 if (row
->reversed_p
)
20820 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20821 - (n_glyphs_before
+ i
));
20822 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20824 /* Display continuation glyphs. */
20825 it
->current_x
= x_before
;
20826 it
->continuation_lines_width
+= x
;
20827 if (!FRAME_WINDOW_P (it
->f
)
20828 || (row
->reversed_p
20829 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20830 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20831 produce_special_glyphs (it
, IT_CONTINUATION
);
20832 row
->continued_p
= true;
20834 extend_face_to_end_of_line (it
);
20836 if (nglyphs
> 1 && i
> 0)
20838 row
->ends_in_middle_of_char_p
= true;
20839 it
->starts_in_middle_of_char_p
= true;
20842 /* Restore the height to what it was before the
20843 element not fitting on the line. */
20844 it
->max_ascent
= ascent
;
20845 it
->max_descent
= descent
;
20846 it
->max_phys_ascent
= phys_ascent
;
20847 it
->max_phys_descent
= phys_descent
;
20852 else if (new_x
> it
->first_visible_x
)
20854 /* Increment number of glyphs actually displayed. */
20857 /* Record the maximum and minimum buffer positions
20858 seen so far in glyphs that will be displayed by
20861 RECORD_MAX_MIN_POS (it
);
20863 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20864 /* Glyph is partially visible, i.e. row starts at
20865 negative X position. Don't do that in R2L
20866 rows, where we arrange to add a right offset to
20867 the line in extend_face_to_end_of_line, by a
20868 suitable change to the stretch glyph that is
20869 the leftmost glyph of the line. */
20870 row
->x
= x
- it
->first_visible_x
;
20871 /* When the last glyph of an R2L row only fits
20872 partially on the line, we need to set row->x to a
20873 negative offset, so that the leftmost glyph is
20874 the one that is partially visible. But if we are
20875 going to produce the truncation glyph, this will
20876 be taken care of in produce_special_glyphs. */
20877 if (row
->reversed_p
20878 && new_x
> it
->last_visible_x
20879 && !(it
->line_wrap
== TRUNCATE
20880 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
20882 eassert (FRAME_WINDOW_P (it
->f
));
20883 row
->x
= it
->last_visible_x
- new_x
;
20888 /* Glyph is completely off the left margin of the
20889 window. This should not happen because of the
20890 move_it_in_display_line at the start of this
20891 function, unless the text display area of the
20892 window is empty. */
20893 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20896 /* Even if this display element produced no glyphs at all,
20897 we want to record its position. */
20898 if (it
->bidi_p
&& nglyphs
== 0)
20899 RECORD_MAX_MIN_POS (it
);
20901 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20902 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20903 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20904 row
->phys_height
= max (row
->phys_height
,
20905 it
->max_phys_ascent
+ it
->max_phys_descent
);
20906 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20907 it
->max_extra_line_spacing
);
20909 /* End of this display line if row is continued. */
20910 if (row
->continued_p
|| row
->ends_at_zv_p
)
20915 /* Is this a line end? If yes, we're also done, after making
20916 sure that a non-default face is extended up to the right
20917 margin of the window. */
20918 if (ITERATOR_AT_END_OF_LINE_P (it
))
20920 int used_before
= row
->used
[TEXT_AREA
];
20922 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20924 /* Add a space at the end of the line that is used to
20925 display the cursor there. */
20926 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20927 append_space_for_newline (it
, false);
20929 /* Extend the face to the end of the line. */
20930 extend_face_to_end_of_line (it
);
20932 /* Make sure we have the position. */
20933 if (used_before
== 0)
20934 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20936 /* Record the position of the newline, for use in
20938 it
->eol_pos
= it
->current
.pos
;
20940 /* Consume the line end. This skips over invisible lines. */
20941 set_iterator_to_next (it
, true);
20942 it
->continuation_lines_width
= 0;
20946 /* Proceed with next display element. Note that this skips
20947 over lines invisible because of selective display. */
20948 set_iterator_to_next (it
, true);
20950 /* If we truncate lines, we are done when the last displayed
20951 glyphs reach past the right margin of the window. */
20952 if (it
->line_wrap
== TRUNCATE
20953 && ((FRAME_WINDOW_P (it
->f
)
20954 /* Images are preprocessed in produce_image_glyph such
20955 that they are cropped at the right edge of the
20956 window, so an image glyph will always end exactly at
20957 last_visible_x, even if there's no right fringe. */
20958 && ((row
->reversed_p
20959 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20960 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
20961 || it
->what
== IT_IMAGE
))
20962 ? (it
->current_x
>= it
->last_visible_x
)
20963 : (it
->current_x
> it
->last_visible_x
)))
20965 /* Maybe add truncation glyphs. */
20966 if (!FRAME_WINDOW_P (it
->f
)
20967 || (row
->reversed_p
20968 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20969 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20973 if (!row
->reversed_p
)
20975 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20976 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20981 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20982 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20984 /* Remove any padding glyphs at the front of ROW, to
20985 make room for the truncation glyphs we will be
20986 adding below. The loop below always inserts at
20987 least one truncation glyph, so also remove the
20988 last glyph added to ROW. */
20989 unproduce_glyphs (it
, i
+ 1);
20990 /* Adjust i for the loop below. */
20991 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20994 /* produce_special_glyphs overwrites the last glyph, so
20995 we don't want that if we want to keep that last
20996 glyph, which means it's an image. */
20997 if (it
->current_x
> it
->last_visible_x
)
20999 it
->current_x
= x_before
;
21000 if (!FRAME_WINDOW_P (it
->f
))
21002 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
21004 row
->used
[TEXT_AREA
] = i
;
21005 produce_special_glyphs (it
, IT_TRUNCATION
);
21010 row
->used
[TEXT_AREA
] = i
;
21011 produce_special_glyphs (it
, IT_TRUNCATION
);
21013 it
->hpos
= hpos_before
;
21016 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
21018 /* Don't truncate if we can overflow newline into fringe. */
21019 if (!get_next_display_element (it
))
21021 it
->continuation_lines_width
= 0;
21022 row
->ends_at_zv_p
= true;
21023 row
->exact_window_width_line_p
= true;
21026 if (ITERATOR_AT_END_OF_LINE_P (it
))
21028 row
->exact_window_width_line_p
= true;
21029 goto at_end_of_line
;
21031 it
->current_x
= x_before
;
21032 it
->hpos
= hpos_before
;
21035 row
->truncated_on_right_p
= true;
21036 it
->continuation_lines_width
= 0;
21037 reseat_at_next_visible_line_start (it
, false);
21038 /* We insist below that IT's position be at ZV because in
21039 bidi-reordered lines the character at visible line start
21040 might not be the character that follows the newline in
21041 the logical order. */
21042 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
21043 row
->ends_at_zv_p
=
21044 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
21046 row
->ends_at_zv_p
= false;
21052 bidi_unshelve_cache (wrap_data
, true);
21054 /* If line is not empty and hscrolled, maybe insert truncation glyphs
21055 at the left window margin. */
21056 if (it
->first_visible_x
21057 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
21059 if (!FRAME_WINDOW_P (it
->f
)
21060 || (((row
->reversed_p
21061 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21062 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
21063 /* Don't let insert_left_trunc_glyphs overwrite the
21064 first glyph of the row if it is an image. */
21065 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
21066 insert_left_trunc_glyphs (it
);
21067 row
->truncated_on_left_p
= true;
21070 /* Remember the position at which this line ends.
21072 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
21073 cannot be before the call to find_row_edges below, since that is
21074 where these positions are determined. */
21075 row
->end
= it
->current
;
21078 row
->minpos
= row
->start
.pos
;
21079 row
->maxpos
= row
->end
.pos
;
21083 /* ROW->minpos and ROW->maxpos must be the smallest and
21084 `1 + the largest' buffer positions in ROW. But if ROW was
21085 bidi-reordered, these two positions can be anywhere in the
21086 row, so we must determine them now. */
21087 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
21090 /* If the start of this line is the overlay arrow-position, then
21091 mark this glyph row as the one containing the overlay arrow.
21092 This is clearly a mess with variable size fonts. It would be
21093 better to let it be displayed like cursors under X. */
21094 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
21095 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
21096 !NILP (overlay_arrow_string
)))
21098 /* Overlay arrow in window redisplay is a fringe bitmap. */
21099 if (STRINGP (overlay_arrow_string
))
21101 struct glyph_row
*arrow_row
21102 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
21103 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
21104 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
21105 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
21106 struct glyph
*p2
, *end
;
21108 /* Copy the arrow glyphs. */
21109 while (glyph
< arrow_end
)
21112 /* Throw away padding glyphs. */
21114 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
21115 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
21121 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
21126 eassert (INTEGERP (overlay_arrow_string
));
21127 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
21129 overlay_arrow_seen
= true;
21132 /* Highlight trailing whitespace. */
21133 if (!NILP (Vshow_trailing_whitespace
))
21134 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
21136 /* Compute pixel dimensions of this line. */
21137 compute_line_metrics (it
);
21139 /* Implementation note: No changes in the glyphs of ROW or in their
21140 faces can be done past this point, because compute_line_metrics
21141 computes ROW's hash value and stores it within the glyph_row
21144 /* Record whether this row ends inside an ellipsis. */
21145 row
->ends_in_ellipsis_p
21146 = (it
->method
== GET_FROM_DISPLAY_VECTOR
21147 && it
->ellipsis_p
);
21149 /* Save fringe bitmaps in this row. */
21150 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
21151 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
21152 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
21153 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
21155 it
->left_user_fringe_bitmap
= 0;
21156 it
->left_user_fringe_face_id
= 0;
21157 it
->right_user_fringe_bitmap
= 0;
21158 it
->right_user_fringe_face_id
= 0;
21160 /* Maybe set the cursor. */
21161 cvpos
= it
->w
->cursor
.vpos
;
21163 /* In bidi-reordered rows, keep checking for proper cursor
21164 position even if one has been found already, because buffer
21165 positions in such rows change non-linearly with ROW->VPOS,
21166 when a line is continued. One exception: when we are at ZV,
21167 display cursor on the first suitable glyph row, since all
21168 the empty rows after that also have their position set to ZV. */
21169 /* FIXME: Revisit this when glyph ``spilling'' in continuation
21170 lines' rows is implemented for bidi-reordered rows. */
21172 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
21173 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
21174 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
21175 && cursor_row_p (row
))
21176 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
21178 /* Prepare for the next line. This line starts horizontally at (X
21179 HPOS) = (0 0). Vertical positions are incremented. As a
21180 convenience for the caller, IT->glyph_row is set to the next
21182 it
->current_x
= it
->hpos
= 0;
21183 it
->current_y
+= row
->height
;
21184 SET_TEXT_POS (it
->eol_pos
, 0, 0);
21187 /* The next row should by default use the same value of the
21188 reversed_p flag as this one. set_iterator_to_next decides when
21189 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
21190 the flag accordingly. */
21191 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
21192 it
->glyph_row
->reversed_p
= row
->reversed_p
;
21193 it
->start
= row
->end
;
21194 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
21196 #undef RECORD_MAX_MIN_POS
21199 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
21200 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
21201 doc
: /* Return paragraph direction at point in BUFFER.
21202 Value is either `left-to-right' or `right-to-left'.
21203 If BUFFER is omitted or nil, it defaults to the current buffer.
21205 Paragraph direction determines how the text in the paragraph is displayed.
21206 In left-to-right paragraphs, text begins at the left margin of the window
21207 and the reading direction is generally left to right. In right-to-left
21208 paragraphs, text begins at the right margin and is read from right to left.
21210 See also `bidi-paragraph-direction'. */)
21211 (Lisp_Object buffer
)
21213 struct buffer
*buf
= current_buffer
;
21214 struct buffer
*old
= buf
;
21216 if (! NILP (buffer
))
21218 CHECK_BUFFER (buffer
);
21219 buf
= XBUFFER (buffer
);
21222 if (NILP (BVAR (buf
, bidi_display_reordering
))
21223 || NILP (BVAR (buf
, enable_multibyte_characters
))
21224 /* When we are loading loadup.el, the character property tables
21225 needed for bidi iteration are not yet available. */
21226 || !NILP (Vpurify_flag
))
21227 return Qleft_to_right
;
21228 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
21229 return BVAR (buf
, bidi_paragraph_direction
);
21232 /* Determine the direction from buffer text. We could try to
21233 use current_matrix if it is up to date, but this seems fast
21234 enough as it is. */
21235 struct bidi_it itb
;
21236 ptrdiff_t pos
= BUF_PT (buf
);
21237 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
21239 void *itb_data
= bidi_shelve_cache ();
21241 set_buffer_temp (buf
);
21242 /* bidi_paragraph_init finds the base direction of the paragraph
21243 by searching forward from paragraph start. We need the base
21244 direction of the current or _previous_ paragraph, so we need
21245 to make sure we are within that paragraph. To that end, find
21246 the previous non-empty line. */
21247 if (pos
>= ZV
&& pos
> BEGV
)
21248 DEC_BOTH (pos
, bytepos
);
21249 AUTO_STRING (trailing_white_space
, "[\f\t ]*\n");
21250 if (fast_looking_at (trailing_white_space
,
21251 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
21253 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
21254 || c
== ' ' || c
== '\t' || c
== '\f')
21256 if (bytepos
<= BEGV_BYTE
)
21261 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
21264 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
21265 itb
.paragraph_dir
= NEUTRAL_DIR
;
21266 itb
.string
.s
= NULL
;
21267 itb
.string
.lstring
= Qnil
;
21268 itb
.string
.bufpos
= 0;
21269 itb
.string
.from_disp_str
= false;
21270 itb
.string
.unibyte
= false;
21271 /* We have no window to use here for ignoring window-specific
21272 overlays. Using NULL for window pointer will cause
21273 compute_display_string_pos to use the current buffer. */
21275 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, true);
21276 bidi_unshelve_cache (itb_data
, false);
21277 set_buffer_temp (old
);
21278 switch (itb
.paragraph_dir
)
21281 return Qleft_to_right
;
21284 return Qright_to_left
;
21292 DEFUN ("bidi-find-overridden-directionality",
21293 Fbidi_find_overridden_directionality
,
21294 Sbidi_find_overridden_directionality
, 2, 3, 0,
21295 doc
: /* Return position between FROM and TO where directionality was overridden.
21297 This function returns the first character position in the specified
21298 region of OBJECT where there is a character whose `bidi-class' property
21299 is `L', but which was forced to display as `R' by a directional
21300 override, and likewise with characters whose `bidi-class' is `R'
21301 or `AL' that were forced to display as `L'.
21303 If no such character is found, the function returns nil.
21305 OBJECT is a Lisp string or buffer to search for overridden
21306 directionality, and defaults to the current buffer if nil or omitted.
21307 OBJECT can also be a window, in which case the function will search
21308 the buffer displayed in that window. Passing the window instead of
21309 a buffer is preferable when the buffer is displayed in some window,
21310 because this function will then be able to correctly account for
21311 window-specific overlays, which can affect the results.
21313 Strong directional characters `L', `R', and `AL' can have their
21314 intrinsic directionality overridden by directional override
21315 control characters RLO (u+202e) and LRO (u+202d). See the
21316 function `get-char-code-property' for a way to inquire about
21317 the `bidi-class' property of a character. */)
21318 (Lisp_Object from
, Lisp_Object to
, Lisp_Object object
)
21320 struct buffer
*buf
= current_buffer
;
21321 struct buffer
*old
= buf
;
21322 struct window
*w
= NULL
;
21323 bool frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ());
21324 struct bidi_it itb
;
21325 ptrdiff_t from_pos
, to_pos
, from_bpos
;
21328 if (!NILP (object
))
21330 if (BUFFERP (object
))
21331 buf
= XBUFFER (object
);
21332 else if (WINDOWP (object
))
21334 w
= decode_live_window (object
);
21335 buf
= XBUFFER (w
->contents
);
21336 frame_window_p
= FRAME_WINDOW_P (XFRAME (w
->frame
));
21339 CHECK_STRING (object
);
21342 if (STRINGP (object
))
21344 /* Characters in unibyte strings are always treated by bidi.c as
21346 if (!STRING_MULTIBYTE (object
)
21347 /* When we are loading loadup.el, the character property
21348 tables needed for bidi iteration are not yet
21350 || !NILP (Vpurify_flag
))
21353 validate_subarray (object
, from
, to
, SCHARS (object
), &from_pos
, &to_pos
);
21354 if (from_pos
>= SCHARS (object
))
21357 /* Set up the bidi iterator. */
21358 itb_data
= bidi_shelve_cache ();
21359 itb
.paragraph_dir
= NEUTRAL_DIR
;
21360 itb
.string
.lstring
= object
;
21361 itb
.string
.s
= NULL
;
21362 itb
.string
.schars
= SCHARS (object
);
21363 itb
.string
.bufpos
= 0;
21364 itb
.string
.from_disp_str
= false;
21365 itb
.string
.unibyte
= false;
21367 bidi_init_it (0, 0, frame_window_p
, &itb
);
21371 /* Nothing this fancy can happen in unibyte buffers, or in a
21372 buffer that disabled reordering, or if FROM is at EOB. */
21373 if (NILP (BVAR (buf
, bidi_display_reordering
))
21374 || NILP (BVAR (buf
, enable_multibyte_characters
))
21375 /* When we are loading loadup.el, the character property
21376 tables needed for bidi iteration are not yet
21378 || !NILP (Vpurify_flag
))
21381 set_buffer_temp (buf
);
21382 validate_region (&from
, &to
);
21383 from_pos
= XINT (from
);
21384 to_pos
= XINT (to
);
21385 if (from_pos
>= ZV
)
21388 /* Set up the bidi iterator. */
21389 itb_data
= bidi_shelve_cache ();
21390 from_bpos
= CHAR_TO_BYTE (from_pos
);
21391 if (from_pos
== BEGV
)
21393 itb
.charpos
= BEGV
;
21394 itb
.bytepos
= BEGV_BYTE
;
21396 else if (FETCH_CHAR (from_bpos
- 1) == '\n')
21398 itb
.charpos
= from_pos
;
21399 itb
.bytepos
= from_bpos
;
21402 itb
.charpos
= find_newline_no_quit (from_pos
, CHAR_TO_BYTE (from_pos
),
21404 itb
.paragraph_dir
= NEUTRAL_DIR
;
21405 itb
.string
.s
= NULL
;
21406 itb
.string
.lstring
= Qnil
;
21407 itb
.string
.bufpos
= 0;
21408 itb
.string
.from_disp_str
= false;
21409 itb
.string
.unibyte
= false;
21411 bidi_init_it (itb
.charpos
, itb
.bytepos
, frame_window_p
, &itb
);
21416 /* For the purposes of this function, the actual base direction of
21417 the paragraph doesn't matter, so just set it to L2R. */
21418 bidi_paragraph_init (L2R
, &itb
, false);
21419 while ((found
= bidi_find_first_overridden (&itb
)) < from_pos
)
21421 } while (found
== ZV
&& itb
.ch
== '\n' && itb
.charpos
< to_pos
);
21423 bidi_unshelve_cache (itb_data
, false);
21424 set_buffer_temp (old
);
21426 return (from_pos
<= found
&& found
< to_pos
) ? make_number (found
) : Qnil
;
21429 DEFUN ("move-point-visually", Fmove_point_visually
,
21430 Smove_point_visually
, 1, 1, 0,
21431 doc
: /* Move point in the visual order in the specified DIRECTION.
21432 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
21435 Value is the new character position of point. */)
21436 (Lisp_Object direction
)
21438 struct window
*w
= XWINDOW (selected_window
);
21439 struct buffer
*b
= XBUFFER (w
->contents
);
21440 struct glyph_row
*row
;
21442 Lisp_Object paragraph_dir
;
21444 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21445 (!(ROW)->continued_p \
21446 && NILP ((GLYPH)->object) \
21447 && (GLYPH)->type == CHAR_GLYPH \
21448 && (GLYPH)->u.ch == ' ' \
21449 && (GLYPH)->charpos >= 0 \
21450 && !(GLYPH)->avoid_cursor_p)
21452 CHECK_NUMBER (direction
);
21453 dir
= XINT (direction
);
21459 /* If current matrix is up-to-date, we can use the information
21460 recorded in the glyphs, at least as long as the goal is on the
21462 if (w
->window_end_valid
21463 && !windows_or_buffers_changed
21465 && !b
->clip_changed
21466 && !b
->prevent_redisplay_optimizations_p
21467 && !window_outdated (w
)
21468 /* We rely below on the cursor coordinates to be up to date, but
21469 we cannot trust them if some command moved point since the
21470 last complete redisplay. */
21471 && w
->last_point
== BUF_PT (b
)
21472 && w
->cursor
.vpos
>= 0
21473 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21474 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21476 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21477 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21478 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21480 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21482 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21484 SET_PT (g
->charpos
);
21485 w
->cursor
.vpos
= -1;
21486 return make_number (PT
);
21488 else if (!NILP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21492 if (BUFFERP (gpt
->object
))
21495 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21496 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21498 new_pos
-= (row
->reversed_p
? -dir
: dir
);
21500 else if (BUFFERP (g
->object
))
21501 new_pos
= g
->charpos
;
21505 w
->cursor
.vpos
= -1;
21506 return make_number (PT
);
21508 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21510 /* Glyphs inserted at the end of a non-empty line for
21511 positioning the cursor have zero charpos, so we must
21512 deduce the value of point by other means. */
21513 if (g
->charpos
> 0)
21514 SET_PT (g
->charpos
);
21515 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21517 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21518 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21521 w
->cursor
.vpos
= -1;
21522 return make_number (PT
);
21525 if (g
== e
|| NILP (g
->object
))
21527 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21528 goto simulate_display
;
21529 if (!row
->reversed_p
)
21533 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21534 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21535 goto simulate_display
;
21539 if (row
->reversed_p
&& !row
->continued_p
)
21541 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21542 w
->cursor
.vpos
= -1;
21543 return make_number (PT
);
21545 g
= row
->glyphs
[TEXT_AREA
];
21546 e
= g
+ row
->used
[TEXT_AREA
];
21547 for ( ; g
< e
; g
++)
21549 if (BUFFERP (g
->object
)
21550 /* Empty lines have only one glyph, which stands
21551 for the newline, and whose charpos is the
21552 buffer position of the newline. */
21553 || ROW_GLYPH_NEWLINE_P (row
, g
)
21554 /* When the buffer ends in a newline, the line at
21555 EOB also has one glyph, but its charpos is -1. */
21556 || (row
->ends_at_zv_p
21557 && !row
->reversed_p
21558 && NILP (g
->object
)
21559 && g
->type
== CHAR_GLYPH
21560 && g
->u
.ch
== ' '))
21562 if (g
->charpos
> 0)
21563 SET_PT (g
->charpos
);
21564 else if (!row
->reversed_p
21565 && row
->ends_at_zv_p
21570 w
->cursor
.vpos
= -1;
21571 return make_number (PT
);
21577 if (!row
->reversed_p
&& !row
->continued_p
)
21579 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21580 w
->cursor
.vpos
= -1;
21581 return make_number (PT
);
21583 e
= row
->glyphs
[TEXT_AREA
];
21584 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21585 for ( ; g
>= e
; g
--)
21587 if (BUFFERP (g
->object
)
21588 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21590 /* Empty R2L lines on GUI frames have the buffer
21591 position of the newline stored in the stretch
21593 || g
->type
== STRETCH_GLYPH
21594 || (row
->ends_at_zv_p
21596 && NILP (g
->object
)
21597 && g
->type
== CHAR_GLYPH
21598 && g
->u
.ch
== ' '))
21600 if (g
->charpos
> 0)
21601 SET_PT (g
->charpos
);
21602 else if (row
->reversed_p
21603 && row
->ends_at_zv_p
21608 w
->cursor
.vpos
= -1;
21609 return make_number (PT
);
21618 /* If we wind up here, we failed to move by using the glyphs, so we
21619 need to simulate display instead. */
21622 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21624 paragraph_dir
= Qleft_to_right
;
21625 if (EQ (paragraph_dir
, Qright_to_left
))
21627 if (PT
<= BEGV
&& dir
< 0)
21628 xsignal0 (Qbeginning_of_buffer
);
21629 else if (PT
>= ZV
&& dir
> 0)
21630 xsignal0 (Qend_of_buffer
);
21633 struct text_pos pt
;
21635 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21637 bool overshoot_expected
= false;
21638 bool target_is_eol_p
= false;
21640 /* Setup the arena. */
21641 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21642 start_display (&it
, w
, pt
);
21643 /* When lines are truncated, we could be called with point
21644 outside of the windows edges, in which case move_it_*
21645 functions either prematurely stop at window's edge or jump to
21646 the next screen line, whereas we rely below on our ability to
21647 reach point, in order to start from its X coordinate. So we
21648 need to disregard the window's horizontal extent in that case. */
21649 if (it
.line_wrap
== TRUNCATE
)
21650 it
.last_visible_x
= INFINITY
;
21652 if (it
.cmp_it
.id
< 0
21653 && it
.method
== GET_FROM_STRING
21654 && it
.area
== TEXT_AREA
21655 && it
.string_from_display_prop_p
21656 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21657 overshoot_expected
= true;
21659 /* Find the X coordinate of point. We start from the beginning
21660 of this or previous line to make sure we are before point in
21661 the logical order (since the move_it_* functions can only
21664 reseat_at_previous_visible_line_start (&it
);
21665 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21666 if (IT_CHARPOS (it
) != PT
)
21668 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21669 -1, -1, -1, MOVE_TO_POS
);
21670 /* If we missed point because the character there is
21671 displayed out of a display vector that has more than one
21672 glyph, retry expecting overshoot. */
21673 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21674 && it
.current
.dpvec_index
> 0
21675 && !overshoot_expected
)
21677 overshoot_expected
= true;
21680 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21681 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21683 pt_x
= it
.current_x
;
21685 if (dir
> 0 || overshoot_expected
)
21687 struct glyph_row
*row
= it
.glyph_row
;
21689 /* When point is at beginning of line, we don't have
21690 information about the glyph there loaded into struct
21691 it. Calling get_next_display_element fixes that. */
21693 get_next_display_element (&it
);
21694 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21695 it
.glyph_row
= NULL
;
21696 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21697 it
.glyph_row
= row
;
21698 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21699 it, lest it will become out of sync with it's buffer
21701 it
.current_x
= pt_x
;
21704 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21705 pixel_width
= it
.pixel_width
;
21706 if (overshoot_expected
&& at_eol_p
)
21708 else if (pixel_width
<= 0)
21711 /* If there's a display string (or something similar) at point,
21712 we are actually at the glyph to the left of point, so we need
21713 to correct the X coordinate. */
21714 if (overshoot_expected
)
21717 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21719 pt_x
+= pixel_width
;
21722 /* Compute target X coordinate, either to the left or to the
21723 right of point. On TTY frames, all characters have the same
21724 pixel width of 1, so we can use that. On GUI frames we don't
21725 have an easy way of getting at the pixel width of the
21726 character to the left of point, so we use a different method
21727 of getting to that place. */
21729 target_x
= pt_x
+ pixel_width
;
21731 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21733 /* Target X coordinate could be one line above or below the line
21734 of point, in which case we need to adjust the target X
21735 coordinate. Also, if moving to the left, we need to begin at
21736 the left edge of the point's screen line. */
21741 start_display (&it
, w
, pt
);
21742 if (it
.line_wrap
== TRUNCATE
)
21743 it
.last_visible_x
= INFINITY
;
21744 reseat_at_previous_visible_line_start (&it
);
21745 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21747 move_it_by_lines (&it
, pt_vpos
);
21751 move_it_by_lines (&it
, -1);
21752 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21753 target_is_eol_p
= true;
21754 /* Under word-wrap, we don't know the x coordinate of
21755 the last character displayed on the previous line,
21756 which immediately precedes the wrap point. To find
21757 out its x coordinate, we try moving to the right
21758 margin of the window, which will stop at the wrap
21759 point, and then reset target_x to point at the
21760 character that precedes the wrap point. This is not
21761 needed on GUI frames, because (see below) there we
21762 move from the left margin one grapheme cluster at a
21763 time, and stop when we hit the wrap point. */
21764 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21766 void *it_data
= NULL
;
21769 SAVE_IT (it2
, it
, it_data
);
21770 move_it_in_display_line_to (&it
, ZV
, target_x
,
21771 MOVE_TO_POS
| MOVE_TO_X
);
21772 /* If we arrived at target_x, that _is_ the last
21773 character on the previous line. */
21774 if (it
.current_x
!= target_x
)
21775 target_x
= it
.current_x
- 1;
21776 RESTORE_IT (&it
, &it2
, it_data
);
21783 || (target_x
>= it
.last_visible_x
21784 && it
.line_wrap
!= TRUNCATE
))
21787 move_it_by_lines (&it
, 0);
21788 move_it_by_lines (&it
, 1);
21793 /* Move to the target X coordinate. */
21794 #ifdef HAVE_WINDOW_SYSTEM
21795 /* On GUI frames, as we don't know the X coordinate of the
21796 character to the left of point, moving point to the left
21797 requires walking, one grapheme cluster at a time, until we
21798 find ourself at a place immediately to the left of the
21799 character at point. */
21800 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21802 struct text_pos new_pos
;
21803 enum move_it_result rc
= MOVE_X_REACHED
;
21805 if (it
.current_x
== 0)
21806 get_next_display_element (&it
);
21807 if (it
.what
== IT_COMPOSITION
)
21809 new_pos
.charpos
= it
.cmp_it
.charpos
;
21810 new_pos
.bytepos
= -1;
21813 new_pos
= it
.current
.pos
;
21815 while (it
.current_x
+ it
.pixel_width
<= target_x
21816 && (rc
== MOVE_X_REACHED
21817 /* Under word-wrap, move_it_in_display_line_to
21818 stops at correct coordinates, but sometimes
21819 returns MOVE_POS_MATCH_OR_ZV. */
21820 || (it
.line_wrap
== WORD_WRAP
21821 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21823 int new_x
= it
.current_x
+ it
.pixel_width
;
21825 /* For composed characters, we want the position of the
21826 first character in the grapheme cluster (usually, the
21827 composition's base character), whereas it.current
21828 might give us the position of the _last_ one, e.g. if
21829 the composition is rendered in reverse due to bidi
21831 if (it
.what
== IT_COMPOSITION
)
21833 new_pos
.charpos
= it
.cmp_it
.charpos
;
21834 new_pos
.bytepos
= -1;
21837 new_pos
= it
.current
.pos
;
21838 if (new_x
== it
.current_x
)
21840 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21841 MOVE_TO_POS
| MOVE_TO_X
);
21842 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21845 /* The previous position we saw in the loop is the one we
21847 if (new_pos
.bytepos
== -1)
21848 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21849 it
.current
.pos
= new_pos
;
21853 if (it
.current_x
!= target_x
)
21854 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21856 /* If we ended up in a display string that covers point, move to
21857 buffer position to the right in the visual order. */
21860 while (IT_CHARPOS (it
) == PT
)
21862 set_iterator_to_next (&it
, false);
21863 if (!get_next_display_element (&it
))
21868 /* Move point to that position. */
21869 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21872 return make_number (PT
);
21874 #undef ROW_GLYPH_NEWLINE_P
21877 DEFUN ("bidi-resolved-levels", Fbidi_resolved_levels
,
21878 Sbidi_resolved_levels
, 0, 1, 0,
21879 doc
: /* Return the resolved bidirectional levels of characters at VPOS.
21881 The resolved levels are produced by the Emacs bidi reordering engine
21882 that implements the UBA, the Unicode Bidirectional Algorithm. Please
21883 read the Unicode Standard Annex 9 (UAX#9) for background information
21884 about these levels.
21886 VPOS is the zero-based number of the current window's screen line
21887 for which to produce the resolved levels. If VPOS is nil or omitted,
21888 it defaults to the screen line of point. If the window displays a
21889 header line, VPOS of zero will report on the header line, and first
21890 line of text in the window will have VPOS of 1.
21892 Value is an array of resolved levels, indexed by glyph number.
21893 Glyphs are numbered from zero starting from the beginning of the
21894 screen line, i.e. the left edge of the window for left-to-right lines
21895 and from the right edge for right-to-left lines. The resolved levels
21896 are produced only for the window's text area; text in display margins
21899 If the selected window's display is not up-to-date, or if the specified
21900 screen line does not display text, this function returns nil. It is
21901 highly recommended to bind this function to some simple key, like F8,
21902 in order to avoid these problems.
21904 This function exists mainly for testing the correctness of the
21905 Emacs UBA implementation, in particular with the test suite. */)
21908 struct window
*w
= XWINDOW (selected_window
);
21909 struct buffer
*b
= XBUFFER (w
->contents
);
21911 struct glyph_row
*row
;
21915 int d1
, d2
, d3
, d4
, d5
;
21917 pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &nrow
);
21921 CHECK_NUMBER_COERCE_MARKER (vpos
);
21922 nrow
= XINT (vpos
);
21925 /* We require up-to-date glyph matrix for this window. */
21926 if (w
->window_end_valid
21927 && !windows_or_buffers_changed
21929 && !b
->clip_changed
21930 && !b
->prevent_redisplay_optimizations_p
21931 && !window_outdated (w
)
21933 && nrow
< w
->current_matrix
->nrows
21934 && (row
= MATRIX_ROW (w
->current_matrix
, nrow
))->enabled_p
21935 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
21937 struct glyph
*g
, *e
, *g1
;
21939 Lisp_Object levels
;
21941 if (!row
->reversed_p
) /* Left-to-right glyph row. */
21943 g
= g1
= row
->glyphs
[TEXT_AREA
];
21944 e
= g
+ row
->used
[TEXT_AREA
];
21946 /* Skip over glyphs at the start of the row that was
21947 generated by redisplay for its own needs. */
21949 && NILP (g
->object
)
21954 /* Count the "interesting" glyphs in this row. */
21955 for (nglyphs
= 0; g
< e
&& !NILP (g
->object
); g
++)
21958 /* Create and fill the array. */
21959 levels
= make_uninit_vector (nglyphs
);
21960 for (i
= 0; g1
< g
; i
++, g1
++)
21961 ASET (levels
, i
, make_number (g1
->resolved_level
));
21963 else /* Right-to-left glyph row. */
21965 g
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
21966 e
= row
->glyphs
[TEXT_AREA
] - 1;
21968 && NILP (g
->object
)
21972 for (nglyphs
= 0; g
> e
&& !NILP (g
->object
); g
--)
21974 levels
= make_uninit_vector (nglyphs
);
21975 for (i
= 0; g1
> g
; i
++, g1
--)
21976 ASET (levels
, i
, make_number (g1
->resolved_level
));
21986 /***********************************************************************
21988 ***********************************************************************/
21990 /* Redisplay the menu bar in the frame for window W.
21992 The menu bar of X frames that don't have X toolkit support is
21993 displayed in a special window W->frame->menu_bar_window.
21995 The menu bar of terminal frames is treated specially as far as
21996 glyph matrices are concerned. Menu bar lines are not part of
21997 windows, so the update is done directly on the frame matrix rows
21998 for the menu bar. */
22001 display_menu_bar (struct window
*w
)
22003 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22008 /* Don't do all this for graphical frames. */
22010 if (FRAME_W32_P (f
))
22013 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
22019 if (FRAME_NS_P (f
))
22021 #endif /* HAVE_NS */
22023 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
22024 eassert (!FRAME_WINDOW_P (f
));
22025 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
22026 it
.first_visible_x
= 0;
22027 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
22028 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
22029 if (FRAME_WINDOW_P (f
))
22031 /* Menu bar lines are displayed in the desired matrix of the
22032 dummy window menu_bar_window. */
22033 struct window
*menu_w
;
22034 menu_w
= XWINDOW (f
->menu_bar_window
);
22035 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
22037 it
.first_visible_x
= 0;
22038 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
22041 #endif /* not USE_X_TOOLKIT and not USE_GTK */
22043 /* This is a TTY frame, i.e. character hpos/vpos are used as
22045 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
22047 it
.first_visible_x
= 0;
22048 it
.last_visible_x
= FRAME_COLS (f
);
22051 /* FIXME: This should be controlled by a user option. See the
22052 comments in redisplay_tool_bar and display_mode_line about
22054 it
.paragraph_embedding
= L2R
;
22056 /* Clear all rows of the menu bar. */
22057 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
22059 struct glyph_row
*row
= it
.glyph_row
+ i
;
22060 clear_glyph_row (row
);
22061 row
->enabled_p
= true;
22062 row
->full_width_p
= true;
22063 row
->reversed_p
= false;
22066 /* Display all items of the menu bar. */
22067 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
22068 for (i
= 0; i
< ASIZE (items
); i
+= 4)
22070 Lisp_Object string
;
22072 /* Stop at nil string. */
22073 string
= AREF (items
, i
+ 1);
22077 /* Remember where item was displayed. */
22078 ASET (items
, i
+ 3, make_number (it
.hpos
));
22080 /* Display the item, pad with one space. */
22081 if (it
.current_x
< it
.last_visible_x
)
22082 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
22083 SCHARS (string
) + 1, 0, 0, -1);
22086 /* Fill out the line with spaces. */
22087 if (it
.current_x
< it
.last_visible_x
)
22088 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
22090 /* Compute the total height of the lines. */
22091 compute_line_metrics (&it
);
22094 /* Deep copy of a glyph row, including the glyphs. */
22096 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
22098 struct glyph
*pointers
[1 + LAST_AREA
];
22099 int to_used
= to
->used
[TEXT_AREA
];
22101 /* Save glyph pointers of TO. */
22102 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
22104 /* Do a structure assignment. */
22107 /* Restore original glyph pointers of TO. */
22108 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
22110 /* Copy the glyphs. */
22111 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
22112 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
22114 /* If we filled only part of the TO row, fill the rest with
22115 space_glyph (which will display as empty space). */
22116 if (to_used
> from
->used
[TEXT_AREA
])
22117 fill_up_frame_row_with_spaces (to
, to_used
);
22120 /* Display one menu item on a TTY, by overwriting the glyphs in the
22121 frame F's desired glyph matrix with glyphs produced from the menu
22122 item text. Called from term.c to display TTY drop-down menus one
22125 ITEM_TEXT is the menu item text as a C string.
22127 FACE_ID is the face ID to be used for this menu item. FACE_ID
22128 could specify one of 3 faces: a face for an enabled item, a face
22129 for a disabled item, or a face for a selected item.
22131 X and Y are coordinates of the first glyph in the frame's desired
22132 matrix to be overwritten by the menu item. Since this is a TTY, Y
22133 is the zero-based number of the glyph row and X is the zero-based
22134 glyph number in the row, starting from left, where to start
22135 displaying the item.
22137 SUBMENU means this menu item drops down a submenu, which
22138 should be indicated by displaying a proper visual cue after the
22142 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
22143 int x
, int y
, bool submenu
)
22146 struct frame
*f
= SELECTED_FRAME ();
22147 struct window
*w
= XWINDOW (f
->selected_window
);
22148 struct glyph_row
*row
;
22149 size_t item_len
= strlen (item_text
);
22151 eassert (FRAME_TERMCAP_P (f
));
22153 /* Don't write beyond the matrix's last row. This can happen for
22154 TTY screens that are not high enough to show the entire menu.
22155 (This is actually a bit of defensive programming, as
22156 tty_menu_display already limits the number of menu items to one
22157 less than the number of screen lines.) */
22158 if (y
>= f
->desired_matrix
->nrows
)
22161 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
22162 it
.first_visible_x
= 0;
22163 it
.last_visible_x
= FRAME_COLS (f
) - 1;
22164 row
= it
.glyph_row
;
22165 /* Start with the row contents from the current matrix. */
22166 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
22167 bool saved_width
= row
->full_width_p
;
22168 row
->full_width_p
= true;
22169 bool saved_reversed
= row
->reversed_p
;
22170 row
->reversed_p
= false;
22171 row
->enabled_p
= true;
22173 /* Arrange for the menu item glyphs to start at (X,Y) and have the
22175 eassert (x
< f
->desired_matrix
->matrix_w
);
22176 it
.current_x
= it
.hpos
= x
;
22177 it
.current_y
= it
.vpos
= y
;
22178 int saved_used
= row
->used
[TEXT_AREA
];
22179 bool saved_truncated
= row
->truncated_on_right_p
;
22180 row
->used
[TEXT_AREA
] = x
;
22181 it
.face_id
= face_id
;
22182 it
.line_wrap
= TRUNCATE
;
22184 /* FIXME: This should be controlled by a user option. See the
22185 comments in redisplay_tool_bar and display_mode_line about this.
22186 Also, if paragraph_embedding could ever be R2L, changes will be
22187 needed to avoid shifting to the right the row characters in
22188 term.c:append_glyph. */
22189 it
.paragraph_embedding
= L2R
;
22191 /* Pad with a space on the left. */
22192 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
22194 /* Display the menu item, pad with spaces to WIDTH. */
22197 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
22198 item_len
, 0, FRAME_COLS (f
) - 1, -1);
22200 /* Indicate with " >" that there's a submenu. */
22201 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
22202 FRAME_COLS (f
) - 1, -1);
22205 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
22206 width
, 0, FRAME_COLS (f
) - 1, -1);
22208 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
22209 row
->truncated_on_right_p
= saved_truncated
;
22210 row
->hash
= row_hash (row
);
22211 row
->full_width_p
= saved_width
;
22212 row
->reversed_p
= saved_reversed
;
22215 /***********************************************************************
22217 ***********************************************************************/
22219 /* Redisplay mode lines in the window tree whose root is WINDOW.
22220 If FORCE, redisplay mode lines unconditionally.
22221 Otherwise, redisplay only mode lines that are garbaged. Value is
22222 the number of windows whose mode lines were redisplayed. */
22225 redisplay_mode_lines (Lisp_Object window
, bool force
)
22229 while (!NILP (window
))
22231 struct window
*w
= XWINDOW (window
);
22233 if (WINDOWP (w
->contents
))
22234 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
22236 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
22237 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
22239 struct text_pos lpoint
;
22240 struct buffer
*old
= current_buffer
;
22242 /* Set the window's buffer for the mode line display. */
22243 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
22244 set_buffer_internal_1 (XBUFFER (w
->contents
));
22246 /* Point refers normally to the selected window. For any
22247 other window, set up appropriate value. */
22248 if (!EQ (window
, selected_window
))
22250 struct text_pos pt
;
22252 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
22253 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
22256 /* Display mode lines. */
22257 clear_glyph_matrix (w
->desired_matrix
);
22258 if (display_mode_lines (w
))
22261 /* Restore old settings. */
22262 set_buffer_internal_1 (old
);
22263 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
22273 /* Display the mode and/or header line of window W. Value is the
22274 sum number of mode lines and header lines displayed. */
22277 display_mode_lines (struct window
*w
)
22279 Lisp_Object old_selected_window
= selected_window
;
22280 Lisp_Object old_selected_frame
= selected_frame
;
22281 Lisp_Object new_frame
= w
->frame
;
22282 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
22285 selected_frame
= new_frame
;
22286 /* FIXME: If we were to allow the mode-line's computation changing the buffer
22287 or window's point, then we'd need select_window_1 here as well. */
22288 XSETWINDOW (selected_window
, w
);
22289 XFRAME (new_frame
)->selected_window
= selected_window
;
22291 /* These will be set while the mode line specs are processed. */
22292 line_number_displayed
= false;
22293 w
->column_number_displayed
= -1;
22295 if (WINDOW_WANTS_MODELINE_P (w
))
22297 struct window
*sel_w
= XWINDOW (old_selected_window
);
22299 /* Select mode line face based on the real selected window. */
22300 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
22301 BVAR (current_buffer
, mode_line_format
));
22305 if (WINDOW_WANTS_HEADER_LINE_P (w
))
22307 display_mode_line (w
, HEADER_LINE_FACE_ID
,
22308 BVAR (current_buffer
, header_line_format
));
22312 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
22313 selected_frame
= old_selected_frame
;
22314 selected_window
= old_selected_window
;
22316 w
->must_be_updated_p
= true;
22321 /* Display mode or header line of window W. FACE_ID specifies which
22322 line to display; it is either MODE_LINE_FACE_ID or
22323 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
22324 display. Value is the pixel height of the mode/header line
22328 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
22332 ptrdiff_t count
= SPECPDL_INDEX ();
22334 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22335 /* Don't extend on a previously drawn mode-line.
22336 This may happen if called from pos_visible_p. */
22337 it
.glyph_row
->enabled_p
= false;
22338 prepare_desired_row (w
, it
.glyph_row
, true);
22340 it
.glyph_row
->mode_line_p
= true;
22342 /* FIXME: This should be controlled by a user option. But
22343 supporting such an option is not trivial, since the mode line is
22344 made up of many separate strings. */
22345 it
.paragraph_embedding
= L2R
;
22347 record_unwind_protect (unwind_format_mode_line
,
22348 format_mode_line_unwind_data (NULL
, NULL
,
22351 mode_line_target
= MODE_LINE_DISPLAY
;
22353 /* Temporarily make frame's keyboard the current kboard so that
22354 kboard-local variables in the mode_line_format will get the right
22356 push_kboard (FRAME_KBOARD (it
.f
));
22357 record_unwind_save_match_data ();
22358 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22361 unbind_to (count
, Qnil
);
22363 /* Fill up with spaces. */
22364 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
22366 compute_line_metrics (&it
);
22367 it
.glyph_row
->full_width_p
= true;
22368 it
.glyph_row
->continued_p
= false;
22369 it
.glyph_row
->truncated_on_left_p
= false;
22370 it
.glyph_row
->truncated_on_right_p
= false;
22372 /* Make a 3D mode-line have a shadow at its right end. */
22373 face
= FACE_FROM_ID (it
.f
, face_id
);
22374 extend_face_to_end_of_line (&it
);
22375 if (face
->box
!= FACE_NO_BOX
)
22377 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
22378 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
22379 last
->right_box_line_p
= true;
22382 return it
.glyph_row
->height
;
22385 /* Move element ELT in LIST to the front of LIST.
22386 Return the updated list. */
22389 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
22391 register Lisp_Object tail
, prev
;
22392 register Lisp_Object tem
;
22396 while (CONSP (tail
))
22402 /* Splice out the link TAIL. */
22404 list
= XCDR (tail
);
22406 Fsetcdr (prev
, XCDR (tail
));
22408 /* Now make it the first. */
22409 Fsetcdr (tail
, list
);
22414 tail
= XCDR (tail
);
22418 /* Not found--return unchanged LIST. */
22422 /* Contribute ELT to the mode line for window IT->w. How it
22423 translates into text depends on its data type.
22425 IT describes the display environment in which we display, as usual.
22427 DEPTH is the depth in recursion. It is used to prevent
22428 infinite recursion here.
22430 FIELD_WIDTH is the number of characters the display of ELT should
22431 occupy in the mode line, and PRECISION is the maximum number of
22432 characters to display from ELT's representation. See
22433 display_string for details.
22435 Returns the hpos of the end of the text generated by ELT.
22437 PROPS is a property list to add to any string we encounter.
22439 If RISKY, remove (disregard) any properties in any string
22440 we encounter, and ignore :eval and :propertize.
22442 The global variable `mode_line_target' determines whether the
22443 output is passed to `store_mode_line_noprop',
22444 `store_mode_line_string', or `display_string'. */
22447 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
22448 Lisp_Object elt
, Lisp_Object props
, bool risky
)
22450 int n
= 0, field
, prec
;
22451 bool literal
= false;
22455 elt
= build_string ("*too-deep*");
22459 switch (XTYPE (elt
))
22463 /* A string: output it and check for %-constructs within it. */
22465 ptrdiff_t offset
= 0;
22467 if (SCHARS (elt
) > 0
22468 && (!NILP (props
) || risky
))
22470 Lisp_Object oprops
, aelt
;
22471 oprops
= Ftext_properties_at (make_number (0), elt
);
22473 /* If the starting string's properties are not what
22474 we want, translate the string. Also, if the string
22475 is risky, do that anyway. */
22477 if (NILP (Fequal (props
, oprops
)) || risky
)
22479 /* If the starting string has properties,
22480 merge the specified ones onto the existing ones. */
22481 if (! NILP (oprops
) && !risky
)
22485 oprops
= Fcopy_sequence (oprops
);
22487 while (CONSP (tem
))
22489 oprops
= Fplist_put (oprops
, XCAR (tem
),
22490 XCAR (XCDR (tem
)));
22491 tem
= XCDR (XCDR (tem
));
22496 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
22497 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
22499 /* AELT is what we want. Move it to the front
22500 without consing. */
22502 mode_line_proptrans_alist
22503 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
22509 /* If AELT has the wrong props, it is useless.
22510 so get rid of it. */
22512 mode_line_proptrans_alist
22513 = Fdelq (aelt
, mode_line_proptrans_alist
);
22515 elt
= Fcopy_sequence (elt
);
22516 Fset_text_properties (make_number (0), Flength (elt
),
22518 /* Add this item to mode_line_proptrans_alist. */
22519 mode_line_proptrans_alist
22520 = Fcons (Fcons (elt
, props
),
22521 mode_line_proptrans_alist
);
22522 /* Truncate mode_line_proptrans_alist
22523 to at most 50 elements. */
22524 tem
= Fnthcdr (make_number (50),
22525 mode_line_proptrans_alist
);
22527 XSETCDR (tem
, Qnil
);
22536 prec
= precision
- n
;
22537 switch (mode_line_target
)
22539 case MODE_LINE_NOPROP
:
22540 case MODE_LINE_TITLE
:
22541 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
22543 case MODE_LINE_STRING
:
22544 n
+= store_mode_line_string (NULL
, elt
, true, 0, prec
, Qnil
);
22546 case MODE_LINE_DISPLAY
:
22547 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
22548 0, prec
, 0, STRING_MULTIBYTE (elt
));
22555 /* Handle the non-literal case. */
22557 while ((precision
<= 0 || n
< precision
)
22558 && SREF (elt
, offset
) != 0
22559 && (mode_line_target
!= MODE_LINE_DISPLAY
22560 || it
->current_x
< it
->last_visible_x
))
22562 ptrdiff_t last_offset
= offset
;
22564 /* Advance to end of string or next format specifier. */
22565 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22568 if (offset
- 1 != last_offset
)
22570 ptrdiff_t nchars
, nbytes
;
22572 /* Output to end of string or up to '%'. Field width
22573 is length of string. Don't output more than
22574 PRECISION allows us. */
22577 prec
= c_string_width (SDATA (elt
) + last_offset
,
22578 offset
- last_offset
, precision
- n
,
22581 switch (mode_line_target
)
22583 case MODE_LINE_NOPROP
:
22584 case MODE_LINE_TITLE
:
22585 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22587 case MODE_LINE_STRING
:
22589 ptrdiff_t bytepos
= last_offset
;
22590 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22591 ptrdiff_t endpos
= (precision
<= 0
22592 ? string_byte_to_char (elt
, offset
)
22593 : charpos
+ nchars
);
22594 Lisp_Object mode_string
22595 = Fsubstring (elt
, make_number (charpos
),
22596 make_number (endpos
));
22597 n
+= store_mode_line_string (NULL
, mode_string
, false,
22601 case MODE_LINE_DISPLAY
:
22603 ptrdiff_t bytepos
= last_offset
;
22604 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22606 if (precision
<= 0)
22607 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22608 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22610 STRING_MULTIBYTE (elt
));
22615 else /* c == '%' */
22617 ptrdiff_t percent_position
= offset
;
22619 /* Get the specified minimum width. Zero means
22622 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22623 field
= field
* 10 + c
- '0';
22625 /* Don't pad beyond the total padding allowed. */
22626 if (field_width
- n
> 0 && field
> field_width
- n
)
22627 field
= field_width
- n
;
22629 /* Note that either PRECISION <= 0 or N < PRECISION. */
22630 prec
= precision
- n
;
22633 n
+= display_mode_element (it
, depth
, field
, prec
,
22634 Vglobal_mode_string
, props
,
22639 ptrdiff_t bytepos
, charpos
;
22641 Lisp_Object string
;
22643 bytepos
= percent_position
;
22644 charpos
= (STRING_MULTIBYTE (elt
)
22645 ? string_byte_to_char (elt
, bytepos
)
22647 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22648 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22650 switch (mode_line_target
)
22652 case MODE_LINE_NOPROP
:
22653 case MODE_LINE_TITLE
:
22654 n
+= store_mode_line_noprop (spec
, field
, prec
);
22656 case MODE_LINE_STRING
:
22658 Lisp_Object tem
= build_string (spec
);
22659 props
= Ftext_properties_at (make_number (charpos
), elt
);
22660 /* Should only keep face property in props */
22661 n
+= store_mode_line_string (NULL
, tem
, false,
22662 field
, prec
, props
);
22665 case MODE_LINE_DISPLAY
:
22667 int nglyphs_before
, nwritten
;
22669 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22670 nwritten
= display_string (spec
, string
, elt
,
22675 /* Assign to the glyphs written above the
22676 string where the `%x' came from, position
22680 struct glyph
*glyph
22681 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22685 for (i
= 0; i
< nwritten
; ++i
)
22687 glyph
[i
].object
= elt
;
22688 glyph
[i
].charpos
= charpos
;
22705 /* A symbol: process the value of the symbol recursively
22706 as if it appeared here directly. Avoid error if symbol void.
22707 Special case: if value of symbol is a string, output the string
22710 register Lisp_Object tem
;
22712 /* If the variable is not marked as risky to set
22713 then its contents are risky to use. */
22714 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22717 tem
= Fboundp (elt
);
22720 tem
= Fsymbol_value (elt
);
22721 /* If value is a string, output that string literally:
22722 don't check for % within it. */
22726 if (!EQ (tem
, elt
))
22728 /* Give up right away for nil or t. */
22738 register Lisp_Object car
, tem
;
22740 /* A cons cell: five distinct cases.
22741 If first element is :eval or :propertize, do something special.
22742 If first element is a string or a cons, process all the elements
22743 and effectively concatenate them.
22744 If first element is a negative number, truncate displaying cdr to
22745 at most that many characters. If positive, pad (with spaces)
22746 to at least that many characters.
22747 If first element is a symbol, process the cadr or caddr recursively
22748 according to whether the symbol's value is non-nil or nil. */
22750 if (EQ (car
, QCeval
))
22752 /* An element of the form (:eval FORM) means evaluate FORM
22753 and use the result as mode line elements. */
22758 if (CONSP (XCDR (elt
)))
22761 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22762 n
+= display_mode_element (it
, depth
, field_width
- n
,
22763 precision
- n
, spec
, props
,
22767 else if (EQ (car
, QCpropertize
))
22769 /* An element of the form (:propertize ELT PROPS...)
22770 means display ELT but applying properties PROPS. */
22775 if (CONSP (XCDR (elt
)))
22776 n
+= display_mode_element (it
, depth
, field_width
- n
,
22777 precision
- n
, XCAR (XCDR (elt
)),
22778 XCDR (XCDR (elt
)), risky
);
22780 else if (SYMBOLP (car
))
22782 tem
= Fboundp (car
);
22786 /* elt is now the cdr, and we know it is a cons cell.
22787 Use its car if CAR has a non-nil value. */
22790 tem
= Fsymbol_value (car
);
22797 /* Symbol's value is nil (or symbol is unbound)
22798 Get the cddr of the original list
22799 and if possible find the caddr and use that. */
22803 else if (!CONSP (elt
))
22808 else if (INTEGERP (car
))
22810 register int lim
= XINT (car
);
22814 /* Negative int means reduce maximum width. */
22815 if (precision
<= 0)
22818 precision
= min (precision
, -lim
);
22822 /* Padding specified. Don't let it be more than
22823 current maximum. */
22825 lim
= min (precision
, lim
);
22827 /* If that's more padding than already wanted, queue it.
22828 But don't reduce padding already specified even if
22829 that is beyond the current truncation point. */
22830 field_width
= max (lim
, field_width
);
22834 else if (STRINGP (car
) || CONSP (car
))
22836 Lisp_Object halftail
= elt
;
22840 && (precision
<= 0 || n
< precision
))
22842 n
+= display_mode_element (it
, depth
,
22843 /* Do padding only after the last
22844 element in the list. */
22845 (! CONSP (XCDR (elt
))
22848 precision
- n
, XCAR (elt
),
22852 if ((len
& 1) == 0)
22853 halftail
= XCDR (halftail
);
22854 /* Check for cycle. */
22855 if (EQ (halftail
, elt
))
22864 elt
= build_string ("*invalid*");
22868 /* Pad to FIELD_WIDTH. */
22869 if (field_width
> 0 && n
< field_width
)
22871 switch (mode_line_target
)
22873 case MODE_LINE_NOPROP
:
22874 case MODE_LINE_TITLE
:
22875 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22877 case MODE_LINE_STRING
:
22878 n
+= store_mode_line_string ("", Qnil
, false, field_width
- n
, 0,
22881 case MODE_LINE_DISPLAY
:
22882 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22891 /* Store a mode-line string element in mode_line_string_list.
22893 If STRING is non-null, display that C string. Otherwise, the Lisp
22894 string LISP_STRING is displayed.
22896 FIELD_WIDTH is the minimum number of output glyphs to produce.
22897 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22898 with spaces. FIELD_WIDTH <= 0 means don't pad.
22900 PRECISION is the maximum number of characters to output from
22901 STRING. PRECISION <= 0 means don't truncate the string.
22903 If COPY_STRING, make a copy of LISP_STRING before adding
22904 properties to the string.
22906 PROPS are the properties to add to the string.
22907 The mode_line_string_face face property is always added to the string.
22911 store_mode_line_string (const char *string
, Lisp_Object lisp_string
,
22913 int field_width
, int precision
, Lisp_Object props
)
22918 if (string
!= NULL
)
22920 len
= strlen (string
);
22921 if (precision
> 0 && len
> precision
)
22923 lisp_string
= make_string (string
, len
);
22925 props
= mode_line_string_face_prop
;
22926 else if (!NILP (mode_line_string_face
))
22928 Lisp_Object face
= Fplist_get (props
, Qface
);
22929 props
= Fcopy_sequence (props
);
22931 face
= mode_line_string_face
;
22933 face
= list2 (face
, mode_line_string_face
);
22934 props
= Fplist_put (props
, Qface
, face
);
22936 Fadd_text_properties (make_number (0), make_number (len
),
22937 props
, lisp_string
);
22941 len
= XFASTINT (Flength (lisp_string
));
22942 if (precision
> 0 && len
> precision
)
22945 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22948 if (!NILP (mode_line_string_face
))
22952 props
= Ftext_properties_at (make_number (0), lisp_string
);
22953 face
= Fplist_get (props
, Qface
);
22955 face
= mode_line_string_face
;
22957 face
= list2 (face
, mode_line_string_face
);
22958 props
= list2 (Qface
, face
);
22960 lisp_string
= Fcopy_sequence (lisp_string
);
22963 Fadd_text_properties (make_number (0), make_number (len
),
22964 props
, lisp_string
);
22969 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22973 if (field_width
> len
)
22975 field_width
-= len
;
22976 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22978 Fadd_text_properties (make_number (0), make_number (field_width
),
22979 props
, lisp_string
);
22980 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22988 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22990 doc
: /* Format a string out of a mode line format specification.
22991 First arg FORMAT specifies the mode line format (see `mode-line-format'
22992 for details) to use.
22994 By default, the format is evaluated for the currently selected window.
22996 Optional second arg FACE specifies the face property to put on all
22997 characters for which no face is specified. The value nil means the
22998 default face. The value t means whatever face the window's mode line
22999 currently uses (either `mode-line' or `mode-line-inactive',
23000 depending on whether the window is the selected window or not).
23001 An integer value means the value string has no text
23004 Optional third and fourth args WINDOW and BUFFER specify the window
23005 and buffer to use as the context for the formatting (defaults
23006 are the selected window and the WINDOW's buffer). */)
23007 (Lisp_Object format
, Lisp_Object face
,
23008 Lisp_Object window
, Lisp_Object buffer
)
23013 struct buffer
*old_buffer
= NULL
;
23015 bool no_props
= INTEGERP (face
);
23016 ptrdiff_t count
= SPECPDL_INDEX ();
23018 int string_start
= 0;
23020 w
= decode_any_window (window
);
23021 XSETWINDOW (window
, w
);
23024 buffer
= w
->contents
;
23025 CHECK_BUFFER (buffer
);
23027 /* Make formatting the modeline a non-op when noninteractive, otherwise
23028 there will be problems later caused by a partially initialized frame. */
23029 if (NILP (format
) || noninteractive
)
23030 return empty_unibyte_string
;
23035 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
23036 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
23037 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
23038 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
23039 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
23040 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
23041 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
23044 old_buffer
= current_buffer
;
23046 /* Save things including mode_line_proptrans_alist,
23047 and set that to nil so that we don't alter the outer value. */
23048 record_unwind_protect (unwind_format_mode_line
,
23049 format_mode_line_unwind_data
23050 (XFRAME (WINDOW_FRAME (w
)),
23051 old_buffer
, selected_window
, true));
23052 mode_line_proptrans_alist
= Qnil
;
23054 Fselect_window (window
, Qt
);
23055 set_buffer_internal_1 (XBUFFER (buffer
));
23057 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
23061 mode_line_target
= MODE_LINE_NOPROP
;
23062 mode_line_string_face_prop
= Qnil
;
23063 mode_line_string_list
= Qnil
;
23064 string_start
= MODE_LINE_NOPROP_LEN (0);
23068 mode_line_target
= MODE_LINE_STRING
;
23069 mode_line_string_list
= Qnil
;
23070 mode_line_string_face
= face
;
23071 mode_line_string_face_prop
23072 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
23075 push_kboard (FRAME_KBOARD (it
.f
));
23076 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
23081 len
= MODE_LINE_NOPROP_LEN (string_start
);
23082 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
23086 mode_line_string_list
= Fnreverse (mode_line_string_list
);
23087 str
= Fmapconcat (Qidentity
, mode_line_string_list
,
23088 empty_unibyte_string
);
23091 unbind_to (count
, Qnil
);
23095 /* Write a null-terminated, right justified decimal representation of
23096 the positive integer D to BUF using a minimal field width WIDTH. */
23099 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
23101 register char *p
= buf
;
23109 *p
++ = d
% 10 + '0';
23114 for (width
-= (int) (p
- buf
); width
> 0; --width
)
23125 /* Write a null-terminated, right justified decimal and "human
23126 readable" representation of the nonnegative integer D to BUF using
23127 a minimal field width WIDTH. D should be smaller than 999.5e24. */
23129 static const char power_letter
[] =
23143 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
23145 /* We aim to represent the nonnegative integer D as
23146 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
23147 ptrdiff_t quotient
= d
;
23149 /* -1 means: do not use TENTHS. */
23153 /* Length of QUOTIENT.TENTHS as a string. */
23159 if (quotient
>= 1000)
23161 /* Scale to the appropriate EXPONENT. */
23164 remainder
= quotient
% 1000;
23168 while (quotient
>= 1000);
23170 /* Round to nearest and decide whether to use TENTHS or not. */
23173 tenths
= remainder
/ 100;
23174 if (remainder
% 100 >= 50)
23181 if (quotient
== 10)
23189 if (remainder
>= 500)
23191 if (quotient
< 999)
23202 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
23203 if (tenths
== -1 && quotient
<= 99)
23210 p
= psuffix
= buf
+ max (width
, length
);
23212 /* Print EXPONENT. */
23213 *psuffix
++ = power_letter
[exponent
];
23216 /* Print TENTHS. */
23219 *--p
= '0' + tenths
;
23223 /* Print QUOTIENT. */
23226 int digit
= quotient
% 10;
23227 *--p
= '0' + digit
;
23229 while ((quotient
/= 10) != 0);
23231 /* Print leading spaces. */
23236 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
23237 If EOL_FLAG, set also a mnemonic character for end-of-line
23238 type of CODING_SYSTEM. Return updated pointer into BUF. */
23240 static unsigned char invalid_eol_type
[] = "(*invalid*)";
23243 decode_mode_spec_coding (Lisp_Object coding_system
, char *buf
, bool eol_flag
)
23246 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
23247 const unsigned char *eol_str
;
23249 /* The EOL conversion we are using. */
23250 Lisp_Object eoltype
;
23252 val
= CODING_SYSTEM_SPEC (coding_system
);
23255 if (!VECTORP (val
)) /* Not yet decided. */
23257 *buf
++ = multibyte
? '-' : ' ';
23259 eoltype
= eol_mnemonic_undecided
;
23260 /* Don't mention EOL conversion if it isn't decided. */
23265 Lisp_Object eolvalue
;
23267 attrs
= AREF (val
, 0);
23268 eolvalue
= AREF (val
, 2);
23271 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
23276 /* The EOL conversion that is normal on this system. */
23278 if (NILP (eolvalue
)) /* Not yet decided. */
23279 eoltype
= eol_mnemonic_undecided
;
23280 else if (VECTORP (eolvalue
)) /* Not yet decided. */
23281 eoltype
= eol_mnemonic_undecided
;
23282 else /* eolvalue is Qunix, Qdos, or Qmac. */
23283 eoltype
= (EQ (eolvalue
, Qunix
)
23284 ? eol_mnemonic_unix
23285 : EQ (eolvalue
, Qdos
)
23286 ? eol_mnemonic_dos
: eol_mnemonic_mac
);
23292 /* Mention the EOL conversion if it is not the usual one. */
23293 if (STRINGP (eoltype
))
23295 eol_str
= SDATA (eoltype
);
23296 eol_str_len
= SBYTES (eoltype
);
23298 else if (CHARACTERP (eoltype
))
23300 int c
= XFASTINT (eoltype
);
23301 return buf
+ CHAR_STRING (c
, (unsigned char *) buf
);
23305 eol_str
= invalid_eol_type
;
23306 eol_str_len
= sizeof (invalid_eol_type
) - 1;
23308 memcpy (buf
, eol_str
, eol_str_len
);
23309 buf
+= eol_str_len
;
23315 /* Return a string for the output of a mode line %-spec for window W,
23316 generated by character C. FIELD_WIDTH > 0 means pad the string
23317 returned with spaces to that value. Return a Lisp string in
23318 *STRING if the resulting string is taken from that Lisp string.
23320 Note we operate on the current buffer for most purposes. */
23322 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
23324 static const char *
23325 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
23326 Lisp_Object
*string
)
23329 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23330 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
23331 /* We are going to use f->decode_mode_spec_buffer as the buffer to
23332 produce strings from numerical values, so limit preposterously
23333 large values of FIELD_WIDTH to avoid overrunning the buffer's
23334 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
23335 bytes plus the terminating null. */
23336 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
23337 struct buffer
*b
= current_buffer
;
23345 if (!NILP (BVAR (b
, read_only
)))
23347 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23352 /* This differs from %* only for a modified read-only buffer. */
23353 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23355 if (!NILP (BVAR (b
, read_only
)))
23360 /* This differs from %* in ignoring read-only-ness. */
23361 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23373 if (command_loop_level
> 5)
23375 p
= decode_mode_spec_buf
;
23376 for (i
= 0; i
< command_loop_level
; i
++)
23379 return decode_mode_spec_buf
;
23387 if (command_loop_level
> 5)
23389 p
= decode_mode_spec_buf
;
23390 for (i
= 0; i
< command_loop_level
; i
++)
23393 return decode_mode_spec_buf
;
23400 /* Let lots_of_dashes be a string of infinite length. */
23401 if (mode_line_target
== MODE_LINE_NOPROP
23402 || mode_line_target
== MODE_LINE_STRING
)
23404 if (field_width
<= 0
23405 || field_width
> sizeof (lots_of_dashes
))
23407 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
23408 decode_mode_spec_buf
[i
] = '-';
23409 decode_mode_spec_buf
[i
] = '\0';
23410 return decode_mode_spec_buf
;
23413 return lots_of_dashes
;
23417 obj
= BVAR (b
, name
);
23421 /* %c and %l are ignored in `frame-title-format'.
23422 (In redisplay_internal, the frame title is drawn _before_ the
23423 windows are updated, so the stuff which depends on actual
23424 window contents (such as %l) may fail to render properly, or
23425 even crash emacs.) */
23426 if (mode_line_target
== MODE_LINE_TITLE
)
23430 ptrdiff_t col
= current_column ();
23431 w
->column_number_displayed
= col
;
23432 pint2str (decode_mode_spec_buf
, width
, col
);
23433 return decode_mode_spec_buf
;
23437 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
23439 if (NILP (Vmemory_full
))
23442 return "!MEM FULL! ";
23449 /* %F displays the frame name. */
23450 if (!NILP (f
->title
))
23451 return SSDATA (f
->title
);
23452 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
23453 return SSDATA (f
->name
);
23457 obj
= BVAR (b
, filename
);
23462 ptrdiff_t size
= ZV
- BEGV
;
23463 pint2str (decode_mode_spec_buf
, width
, size
);
23464 return decode_mode_spec_buf
;
23469 ptrdiff_t size
= ZV
- BEGV
;
23470 pint2hrstr (decode_mode_spec_buf
, width
, size
);
23471 return decode_mode_spec_buf
;
23476 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
23477 ptrdiff_t topline
, nlines
, height
;
23480 /* %c and %l are ignored in `frame-title-format'. */
23481 if (mode_line_target
== MODE_LINE_TITLE
)
23484 startpos
= marker_position (w
->start
);
23485 startpos_byte
= marker_byte_position (w
->start
);
23486 height
= WINDOW_TOTAL_LINES (w
);
23488 /* If we decided that this buffer isn't suitable for line numbers,
23489 don't forget that too fast. */
23490 if (w
->base_line_pos
== -1)
23493 /* If the buffer is very big, don't waste time. */
23494 if (INTEGERP (Vline_number_display_limit
)
23495 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
23497 w
->base_line_pos
= 0;
23498 w
->base_line_number
= 0;
23502 if (w
->base_line_number
> 0
23503 && w
->base_line_pos
> 0
23504 && w
->base_line_pos
<= startpos
)
23506 line
= w
->base_line_number
;
23507 linepos
= w
->base_line_pos
;
23508 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
23513 linepos
= BUF_BEGV (b
);
23514 linepos_byte
= BUF_BEGV_BYTE (b
);
23517 /* Count lines from base line to window start position. */
23518 nlines
= display_count_lines (linepos_byte
,
23522 topline
= nlines
+ line
;
23524 /* Determine a new base line, if the old one is too close
23525 or too far away, or if we did not have one.
23526 "Too close" means it's plausible a scroll-down would
23527 go back past it. */
23528 if (startpos
== BUF_BEGV (b
))
23530 w
->base_line_number
= topline
;
23531 w
->base_line_pos
= BUF_BEGV (b
);
23533 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
23534 || linepos
== BUF_BEGV (b
))
23536 ptrdiff_t limit
= BUF_BEGV (b
);
23537 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
23538 ptrdiff_t position
;
23539 ptrdiff_t distance
=
23540 (height
* 2 + 30) * line_number_display_limit_width
;
23542 if (startpos
- distance
> limit
)
23544 limit
= startpos
- distance
;
23545 limit_byte
= CHAR_TO_BYTE (limit
);
23548 nlines
= display_count_lines (startpos_byte
,
23550 - (height
* 2 + 30),
23552 /* If we couldn't find the lines we wanted within
23553 line_number_display_limit_width chars per line,
23554 give up on line numbers for this window. */
23555 if (position
== limit_byte
&& limit
== startpos
- distance
)
23557 w
->base_line_pos
= -1;
23558 w
->base_line_number
= 0;
23562 w
->base_line_number
= topline
- nlines
;
23563 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23566 /* Now count lines from the start pos to point. */
23567 nlines
= display_count_lines (startpos_byte
,
23568 PT_BYTE
, PT
, &junk
);
23570 /* Record that we did display the line number. */
23571 line_number_displayed
= true;
23573 /* Make the string to show. */
23574 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23575 return decode_mode_spec_buf
;
23578 char *p
= decode_mode_spec_buf
;
23579 int pad
= width
- 2;
23585 return decode_mode_spec_buf
;
23591 obj
= BVAR (b
, mode_name
);
23595 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23601 ptrdiff_t pos
= marker_position (w
->start
);
23602 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23604 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23606 if (pos
<= BUF_BEGV (b
))
23611 else if (pos
<= BUF_BEGV (b
))
23615 if (total
> 1000000)
23616 /* Do it differently for a large value, to avoid overflow. */
23617 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23619 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23620 /* We can't normally display a 3-digit number,
23621 so get us a 2-digit number that is close. */
23624 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23625 return decode_mode_spec_buf
;
23629 /* Display percentage of size above the bottom of the screen. */
23632 ptrdiff_t toppos
= marker_position (w
->start
);
23633 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23634 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23636 if (botpos
>= BUF_ZV (b
))
23638 if (toppos
<= BUF_BEGV (b
))
23645 if (total
> 1000000)
23646 /* Do it differently for a large value, to avoid overflow. */
23647 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23649 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23650 /* We can't normally display a 3-digit number,
23651 so get us a 2-digit number that is close. */
23654 if (toppos
<= BUF_BEGV (b
))
23655 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23657 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23658 return decode_mode_spec_buf
;
23663 /* status of process */
23664 obj
= Fget_buffer_process (Fcurrent_buffer ());
23666 return "no process";
23668 obj
= Fsymbol_name (Fprocess_status (obj
));
23674 ptrdiff_t count
= inhibit_garbage_collection ();
23675 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23676 Lisp_Object val
= Qnil
;
23678 if (STRINGP (curdir
))
23679 val
= call1 (intern ("file-remote-p"), curdir
);
23681 unbind_to (count
, Qnil
);
23690 /* coding-system (not including end-of-line format) */
23692 /* coding-system (including end-of-line type) */
23694 bool eol_flag
= (c
== 'Z');
23695 char *p
= decode_mode_spec_buf
;
23697 if (! FRAME_WINDOW_P (f
))
23699 /* No need to mention EOL here--the terminal never needs
23700 to do EOL conversion. */
23701 p
= decode_mode_spec_coding (CODING_ID_NAME
23702 (FRAME_KEYBOARD_CODING (f
)->id
),
23704 p
= decode_mode_spec_coding (CODING_ID_NAME
23705 (FRAME_TERMINAL_CODING (f
)->id
),
23708 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23711 #if false /* This proves to be annoying; I think we can do without. -- rms. */
23712 #ifdef subprocesses
23713 obj
= Fget_buffer_process (Fcurrent_buffer ());
23714 if (PROCESSP (obj
))
23716 p
= decode_mode_spec_coding
23717 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23718 p
= decode_mode_spec_coding
23719 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23721 #endif /* subprocesses */
23724 return decode_mode_spec_buf
;
23731 return SSDATA (obj
);
23738 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23739 means count lines back from START_BYTE. But don't go beyond
23740 LIMIT_BYTE. Return the number of lines thus found (always
23743 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23744 either the position COUNT lines after/before START_BYTE, if we
23745 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23749 display_count_lines (ptrdiff_t start_byte
,
23750 ptrdiff_t limit_byte
, ptrdiff_t count
,
23751 ptrdiff_t *byte_pos_ptr
)
23753 register unsigned char *cursor
;
23754 unsigned char *base
;
23756 register ptrdiff_t ceiling
;
23757 register unsigned char *ceiling_addr
;
23758 ptrdiff_t orig_count
= count
;
23760 /* If we are not in selective display mode,
23761 check only for newlines. */
23762 bool selective_display
23763 = (!NILP (BVAR (current_buffer
, selective_display
))
23764 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23768 while (start_byte
< limit_byte
)
23770 ceiling
= BUFFER_CEILING_OF (start_byte
);
23771 ceiling
= min (limit_byte
- 1, ceiling
);
23772 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23773 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23777 if (selective_display
)
23779 while (*cursor
!= '\n' && *cursor
!= 015
23780 && ++cursor
!= ceiling_addr
)
23782 if (cursor
== ceiling_addr
)
23787 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23796 start_byte
+= cursor
- base
;
23797 *byte_pos_ptr
= start_byte
;
23801 while (cursor
< ceiling_addr
);
23803 start_byte
+= ceiling_addr
- base
;
23808 while (start_byte
> limit_byte
)
23810 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23811 ceiling
= max (limit_byte
, ceiling
);
23812 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23813 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23816 if (selective_display
)
23818 while (--cursor
>= ceiling_addr
23819 && *cursor
!= '\n' && *cursor
!= 015)
23821 if (cursor
< ceiling_addr
)
23826 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23833 start_byte
+= cursor
- base
+ 1;
23834 *byte_pos_ptr
= start_byte
;
23835 /* When scanning backwards, we should
23836 not count the newline posterior to which we stop. */
23837 return - orig_count
- 1;
23840 start_byte
+= ceiling_addr
- base
;
23844 *byte_pos_ptr
= limit_byte
;
23847 return - orig_count
+ count
;
23848 return orig_count
- count
;
23854 /***********************************************************************
23856 ***********************************************************************/
23858 /* Display a NUL-terminated string, starting with index START.
23860 If STRING is non-null, display that C string. Otherwise, the Lisp
23861 string LISP_STRING is displayed. There's a case that STRING is
23862 non-null and LISP_STRING is not nil. It means STRING is a string
23863 data of LISP_STRING. In that case, we display LISP_STRING while
23864 ignoring its text properties.
23866 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23867 FACE_STRING. Display STRING or LISP_STRING with the face at
23868 FACE_STRING_POS in FACE_STRING:
23870 Display the string in the environment given by IT, but use the
23871 standard display table, temporarily.
23873 FIELD_WIDTH is the minimum number of output glyphs to produce.
23874 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23875 with spaces. If STRING has more characters, more than FIELD_WIDTH
23876 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23878 PRECISION is the maximum number of characters to output from
23879 STRING. PRECISION < 0 means don't truncate the string.
23881 This is roughly equivalent to printf format specifiers:
23883 FIELD_WIDTH PRECISION PRINTF
23884 ----------------------------------------
23890 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23891 display them, and < 0 means obey the current buffer's value of
23892 enable_multibyte_characters.
23894 Value is the number of columns displayed. */
23897 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23898 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23899 int field_width
, int precision
, int max_x
, int multibyte
)
23901 int hpos_at_start
= it
->hpos
;
23902 int saved_face_id
= it
->face_id
;
23903 struct glyph_row
*row
= it
->glyph_row
;
23904 ptrdiff_t it_charpos
;
23906 /* Initialize the iterator IT for iteration over STRING beginning
23907 with index START. */
23908 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23909 precision
, field_width
, multibyte
);
23910 if (string
&& STRINGP (lisp_string
))
23911 /* LISP_STRING is the one returned by decode_mode_spec. We should
23912 ignore its text properties. */
23913 it
->stop_charpos
= it
->end_charpos
;
23915 /* If displaying STRING, set up the face of the iterator from
23916 FACE_STRING, if that's given. */
23917 if (STRINGP (face_string
))
23923 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23924 0, &endptr
, it
->base_face_id
, false);
23925 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23926 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23929 /* Set max_x to the maximum allowed X position. Don't let it go
23930 beyond the right edge of the window. */
23932 max_x
= it
->last_visible_x
;
23934 max_x
= min (max_x
, it
->last_visible_x
);
23936 /* Skip over display elements that are not visible. because IT->w is
23938 if (it
->current_x
< it
->first_visible_x
)
23939 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23940 MOVE_TO_POS
| MOVE_TO_X
);
23942 row
->ascent
= it
->max_ascent
;
23943 row
->height
= it
->max_ascent
+ it
->max_descent
;
23944 row
->phys_ascent
= it
->max_phys_ascent
;
23945 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23946 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23948 if (STRINGP (it
->string
))
23949 it_charpos
= IT_STRING_CHARPOS (*it
);
23951 it_charpos
= IT_CHARPOS (*it
);
23953 /* This condition is for the case that we are called with current_x
23954 past last_visible_x. */
23955 while (it
->current_x
< max_x
)
23957 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23959 /* Get the next display element. */
23960 if (!get_next_display_element (it
))
23963 /* Produce glyphs. */
23964 x_before
= it
->current_x
;
23965 n_glyphs_before
= row
->used
[TEXT_AREA
];
23966 PRODUCE_GLYPHS (it
);
23968 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23971 while (i
< nglyphs
)
23973 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23975 if (it
->line_wrap
!= TRUNCATE
23976 && x
+ glyph
->pixel_width
> max_x
)
23978 /* End of continued line or max_x reached. */
23979 if (CHAR_GLYPH_PADDING_P (*glyph
))
23981 /* A wide character is unbreakable. */
23982 if (row
->reversed_p
)
23983 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23984 - n_glyphs_before
);
23985 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23986 it
->current_x
= x_before
;
23990 if (row
->reversed_p
)
23991 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23992 - (n_glyphs_before
+ i
));
23993 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23998 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
24000 /* Glyph is at least partially visible. */
24002 if (x
< it
->first_visible_x
)
24003 row
->x
= x
- it
->first_visible_x
;
24007 /* Glyph is off the left margin of the display area.
24008 Should not happen. */
24012 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
24013 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
24014 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
24015 row
->phys_height
= max (row
->phys_height
,
24016 it
->max_phys_ascent
+ it
->max_phys_descent
);
24017 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
24018 it
->max_extra_line_spacing
);
24019 x
+= glyph
->pixel_width
;
24023 /* Stop if max_x reached. */
24027 /* Stop at line ends. */
24028 if (ITERATOR_AT_END_OF_LINE_P (it
))
24030 it
->continuation_lines_width
= 0;
24034 set_iterator_to_next (it
, true);
24035 if (STRINGP (it
->string
))
24036 it_charpos
= IT_STRING_CHARPOS (*it
);
24038 it_charpos
= IT_CHARPOS (*it
);
24040 /* Stop if truncating at the right edge. */
24041 if (it
->line_wrap
== TRUNCATE
24042 && it
->current_x
>= it
->last_visible_x
)
24044 /* Add truncation mark, but don't do it if the line is
24045 truncated at a padding space. */
24046 if (it_charpos
< it
->string_nchars
)
24048 if (!FRAME_WINDOW_P (it
->f
))
24052 if (it
->current_x
> it
->last_visible_x
)
24054 if (!row
->reversed_p
)
24056 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
24057 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
24062 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
24063 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
24065 unproduce_glyphs (it
, ii
+ 1);
24066 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
24068 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
24070 row
->used
[TEXT_AREA
] = ii
;
24071 produce_special_glyphs (it
, IT_TRUNCATION
);
24074 produce_special_glyphs (it
, IT_TRUNCATION
);
24076 row
->truncated_on_right_p
= true;
24082 /* Maybe insert a truncation at the left. */
24083 if (it
->first_visible_x
24086 if (!FRAME_WINDOW_P (it
->f
)
24087 || (row
->reversed_p
24088 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24089 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
24090 insert_left_trunc_glyphs (it
);
24091 row
->truncated_on_left_p
= true;
24094 it
->face_id
= saved_face_id
;
24096 /* Value is number of columns displayed. */
24097 return it
->hpos
- hpos_at_start
;
24102 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
24103 appears as an element of LIST or as the car of an element of LIST.
24104 If PROPVAL is a list, compare each element against LIST in that
24105 way, and return 1/2 if any element of PROPVAL is found in LIST.
24106 Otherwise return 0. This function cannot quit.
24107 The return value is 2 if the text is invisible but with an ellipsis
24108 and 1 if it's invisible and without an ellipsis. */
24111 invisible_prop (Lisp_Object propval
, Lisp_Object list
)
24113 Lisp_Object tail
, proptail
;
24115 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
24117 register Lisp_Object tem
;
24119 if (EQ (propval
, tem
))
24121 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
24122 return NILP (XCDR (tem
)) ? 1 : 2;
24125 if (CONSP (propval
))
24127 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
24129 Lisp_Object propelt
;
24130 propelt
= XCAR (proptail
);
24131 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
24133 register Lisp_Object tem
;
24135 if (EQ (propelt
, tem
))
24137 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
24138 return NILP (XCDR (tem
)) ? 1 : 2;
24146 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
24147 doc
: /* Non-nil if the property makes the text invisible.
24148 POS-OR-PROP can be a marker or number, in which case it is taken to be
24149 a position in the current buffer and the value of the `invisible' property
24150 is checked; or it can be some other value, which is then presumed to be the
24151 value of the `invisible' property of the text of interest.
24152 The non-nil value returned can be t for truly invisible text or something
24153 else if the text is replaced by an ellipsis. */)
24154 (Lisp_Object pos_or_prop
)
24157 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
24158 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
24160 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
24161 return (invis
== 0 ? Qnil
24163 : make_number (invis
));
24166 /* Calculate a width or height in pixels from a specification using
24167 the following elements:
24170 NUM - a (fractional) multiple of the default font width/height
24171 (NUM) - specifies exactly NUM pixels
24172 UNIT - a fixed number of pixels, see below.
24173 ELEMENT - size of a display element in pixels, see below.
24174 (NUM . SPEC) - equals NUM * SPEC
24175 (+ SPEC SPEC ...) - add pixel values
24176 (- SPEC SPEC ...) - subtract pixel values
24177 (- SPEC) - negate pixel value
24180 INT or FLOAT - a number constant
24181 SYMBOL - use symbol's (buffer local) variable binding.
24184 in - pixels per inch *)
24185 mm - pixels per 1/1000 meter *)
24186 cm - pixels per 1/100 meter *)
24187 width - width of current font in pixels.
24188 height - height of current font in pixels.
24190 *) using the ratio(s) defined in display-pixels-per-inch.
24194 left-fringe - left fringe width in pixels
24195 right-fringe - right fringe width in pixels
24197 left-margin - left margin width in pixels
24198 right-margin - right margin width in pixels
24200 scroll-bar - scroll-bar area width in pixels
24204 Pixels corresponding to 5 inches:
24207 Total width of non-text areas on left side of window (if scroll-bar is on left):
24208 '(space :width (+ left-fringe left-margin scroll-bar))
24210 Align to first text column (in header line):
24211 '(space :align-to 0)
24213 Align to middle of text area minus half the width of variable `my-image'
24214 containing a loaded image:
24215 '(space :align-to (0.5 . (- text my-image)))
24217 Width of left margin minus width of 1 character in the default font:
24218 '(space :width (- left-margin 1))
24220 Width of left margin minus width of 2 characters in the current font:
24221 '(space :width (- left-margin (2 . width)))
24223 Center 1 character over left-margin (in header line):
24224 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
24226 Different ways to express width of left fringe plus left margin minus one pixel:
24227 '(space :width (- (+ left-fringe left-margin) (1)))
24228 '(space :width (+ left-fringe left-margin (- (1))))
24229 '(space :width (+ left-fringe left-margin (-1)))
24234 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
24235 struct font
*font
, bool width_p
, int *align_to
)
24239 # define OK_PIXELS(val) (*res = (val), true)
24240 # define OK_ALIGN_TO(val) (*align_to = (val), true)
24243 return OK_PIXELS (0);
24245 eassert (FRAME_LIVE_P (it
->f
));
24247 if (SYMBOLP (prop
))
24249 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
24251 char *unit
= SSDATA (SYMBOL_NAME (prop
));
24253 if (unit
[0] == 'i' && unit
[1] == 'n')
24255 else if (unit
[0] == 'm' && unit
[1] == 'm')
24257 else if (unit
[0] == 'c' && unit
[1] == 'm')
24263 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
24264 : FRAME_RES_Y (it
->f
));
24267 return OK_PIXELS (ppi
/ pixels
);
24272 #ifdef HAVE_WINDOW_SYSTEM
24273 if (EQ (prop
, Qheight
))
24274 return OK_PIXELS (font
24275 ? normal_char_height (font
, -1)
24276 : FRAME_LINE_HEIGHT (it
->f
));
24277 if (EQ (prop
, Qwidth
))
24278 return OK_PIXELS (font
24279 ? FONT_WIDTH (font
)
24280 : FRAME_COLUMN_WIDTH (it
->f
));
24282 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
24283 return OK_PIXELS (1);
24286 if (EQ (prop
, Qtext
))
24287 return OK_PIXELS (width_p
24288 ? window_box_width (it
->w
, TEXT_AREA
)
24289 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
24291 if (align_to
&& *align_to
< 0)
24294 if (EQ (prop
, Qleft
))
24295 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
24296 if (EQ (prop
, Qright
))
24297 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
24298 if (EQ (prop
, Qcenter
))
24299 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
24300 + window_box_width (it
->w
, TEXT_AREA
) / 2);
24301 if (EQ (prop
, Qleft_fringe
))
24302 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24303 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
24304 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
24305 if (EQ (prop
, Qright_fringe
))
24306 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24307 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24308 : window_box_right_offset (it
->w
, TEXT_AREA
));
24309 if (EQ (prop
, Qleft_margin
))
24310 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
24311 if (EQ (prop
, Qright_margin
))
24312 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
24313 if (EQ (prop
, Qscroll_bar
))
24314 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
24316 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24317 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24318 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24323 if (EQ (prop
, Qleft_fringe
))
24324 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
24325 if (EQ (prop
, Qright_fringe
))
24326 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
24327 if (EQ (prop
, Qleft_margin
))
24328 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
24329 if (EQ (prop
, Qright_margin
))
24330 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
24331 if (EQ (prop
, Qscroll_bar
))
24332 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
24335 prop
= buffer_local_value (prop
, it
->w
->contents
);
24336 if (EQ (prop
, Qunbound
))
24340 if (NUMBERP (prop
))
24342 int base_unit
= (width_p
24343 ? FRAME_COLUMN_WIDTH (it
->f
)
24344 : FRAME_LINE_HEIGHT (it
->f
));
24345 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
24350 Lisp_Object car
= XCAR (prop
);
24351 Lisp_Object cdr
= XCDR (prop
);
24355 #ifdef HAVE_WINDOW_SYSTEM
24356 if (FRAME_WINDOW_P (it
->f
)
24357 && valid_image_p (prop
))
24359 ptrdiff_t id
= lookup_image (it
->f
, prop
);
24360 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
24362 return OK_PIXELS (width_p
? img
->width
: img
->height
);
24364 if (FRAME_WINDOW_P (it
->f
) && valid_xwidget_spec_p (prop
))
24366 // TODO: Don't return dummy size.
24367 return OK_PIXELS (100);
24370 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
24376 while (CONSP (cdr
))
24378 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
24379 font
, width_p
, align_to
))
24382 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= false;
24387 if (EQ (car
, Qminus
))
24389 return OK_PIXELS (pixels
);
24392 car
= buffer_local_value (car
, it
->w
->contents
);
24393 if (EQ (car
, Qunbound
))
24400 pixels
= XFLOATINT (car
);
24402 return OK_PIXELS (pixels
);
24403 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
24404 font
, width_p
, align_to
))
24405 return OK_PIXELS (pixels
* fact
);
24416 get_font_ascent_descent (struct font
*font
, int *ascent
, int *descent
)
24418 #ifdef HAVE_WINDOW_SYSTEM
24419 normal_char_ascent_descent (font
, -1, ascent
, descent
);
24427 /***********************************************************************
24429 ***********************************************************************/
24431 #ifdef HAVE_WINDOW_SYSTEM
24436 dump_glyph_string (struct glyph_string
*s
)
24438 fprintf (stderr
, "glyph string\n");
24439 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
24440 s
->x
, s
->y
, s
->width
, s
->height
);
24441 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
24442 fprintf (stderr
, " hl = %d\n", s
->hl
);
24443 fprintf (stderr
, " left overhang = %d, right = %d\n",
24444 s
->left_overhang
, s
->right_overhang
);
24445 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
24446 fprintf (stderr
, " extends to end of line = %d\n",
24447 s
->extends_to_end_of_line_p
);
24448 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
24449 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
24452 #endif /* GLYPH_DEBUG */
24454 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
24455 of XChar2b structures for S; it can't be allocated in
24456 init_glyph_string because it must be allocated via `alloca'. W
24457 is the window on which S is drawn. ROW and AREA are the glyph row
24458 and area within the row from which S is constructed. START is the
24459 index of the first glyph structure covered by S. HL is a
24460 face-override for drawing S. */
24463 #define OPTIONAL_HDC(hdc) HDC hdc,
24464 #define DECLARE_HDC(hdc) HDC hdc;
24465 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
24466 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
24469 #ifndef OPTIONAL_HDC
24470 #define OPTIONAL_HDC(hdc)
24471 #define DECLARE_HDC(hdc)
24472 #define ALLOCATE_HDC(hdc, f)
24473 #define RELEASE_HDC(hdc, f)
24477 init_glyph_string (struct glyph_string
*s
,
24479 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
24480 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
24482 memset (s
, 0, sizeof *s
);
24484 s
->f
= XFRAME (w
->frame
);
24488 s
->display
= FRAME_X_DISPLAY (s
->f
);
24489 s
->window
= FRAME_X_WINDOW (s
->f
);
24490 s
->char2b
= char2b
;
24494 s
->first_glyph
= row
->glyphs
[area
] + start
;
24495 s
->height
= row
->height
;
24496 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
24497 s
->ybase
= s
->y
+ row
->ascent
;
24501 /* Append the list of glyph strings with head H and tail T to the list
24502 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
24505 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24506 struct glyph_string
*h
, struct glyph_string
*t
)
24520 /* Prepend the list of glyph strings with head H and tail T to the
24521 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
24525 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24526 struct glyph_string
*h
, struct glyph_string
*t
)
24540 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
24541 Set *HEAD and *TAIL to the resulting list. */
24544 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
24545 struct glyph_string
*s
)
24547 s
->next
= s
->prev
= NULL
;
24548 append_glyph_string_lists (head
, tail
, s
, s
);
24552 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24553 The encoding of C is returned in *CHAR2B. DISPLAY_P means
24554 make sure that X resources for the face returned are allocated.
24555 Value is a pointer to a realized face that is ready for display if
24558 static struct face
*
24559 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
24560 XChar2b
*char2b
, bool display_p
)
24562 struct face
*face
= FACE_FROM_ID (f
, face_id
);
24567 code
= face
->font
->driver
->encode_char (face
->font
, c
);
24569 if (code
== FONT_INVALID_CODE
)
24572 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24574 /* Make sure X resources of the face are allocated. */
24575 #ifdef HAVE_X_WINDOWS
24579 eassert (face
!= NULL
);
24580 prepare_face_for_display (f
, face
);
24587 /* Get face and two-byte form of character glyph GLYPH on frame F.
24588 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24589 a pointer to a realized face that is ready for display. */
24591 static struct face
*
24592 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24598 eassert (glyph
->type
== CHAR_GLYPH
);
24599 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24601 /* Make sure X resources of the face are allocated. */
24602 eassert (face
!= NULL
);
24603 prepare_face_for_display (f
, face
);
24607 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24608 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24610 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24612 if (code
== FONT_INVALID_CODE
)
24616 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24621 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24622 Return true iff FONT has a glyph for C. */
24625 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24629 if (CHAR_BYTE8_P (c
))
24630 code
= CHAR_TO_BYTE8 (c
);
24632 code
= font
->driver
->encode_char (font
, c
);
24634 if (code
== FONT_INVALID_CODE
)
24636 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24641 /* Fill glyph string S with composition components specified by S->cmp.
24643 BASE_FACE is the base face of the composition.
24644 S->cmp_from is the index of the first component for S.
24646 OVERLAPS non-zero means S should draw the foreground only, and use
24647 its physical height for clipping. See also draw_glyphs.
24649 Value is the index of a component not in S. */
24652 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24656 /* For all glyphs of this composition, starting at the offset
24657 S->cmp_from, until we reach the end of the definition or encounter a
24658 glyph that requires the different face, add it to S. */
24663 s
->for_overlaps
= overlaps
;
24666 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24668 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24670 /* TAB in a composition means display glyphs with padding space
24671 on the left or right. */
24674 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24677 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24678 s
->char2b
+ i
, true);
24684 s
->font
= s
->face
->font
;
24686 else if (s
->face
!= face
)
24694 if (s
->face
== NULL
)
24696 s
->face
= base_face
->ascii_face
;
24697 s
->font
= s
->face
->font
;
24700 /* All glyph strings for the same composition has the same width,
24701 i.e. the width set for the first component of the composition. */
24702 s
->width
= s
->first_glyph
->pixel_width
;
24704 /* If the specified font could not be loaded, use the frame's
24705 default font, but record the fact that we couldn't load it in
24706 the glyph string so that we can draw rectangles for the
24707 characters of the glyph string. */
24708 if (s
->font
== NULL
)
24710 s
->font_not_found_p
= true;
24711 s
->font
= FRAME_FONT (s
->f
);
24714 /* Adjust base line for subscript/superscript text. */
24715 s
->ybase
+= s
->first_glyph
->voffset
;
24721 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24722 int start
, int end
, int overlaps
)
24724 struct glyph
*glyph
, *last
;
24725 Lisp_Object lgstring
;
24728 s
->for_overlaps
= overlaps
;
24729 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24730 last
= s
->row
->glyphs
[s
->area
] + end
;
24731 s
->cmp_id
= glyph
->u
.cmp
.id
;
24732 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24733 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24734 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24735 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24736 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24738 while (glyph
< last
24739 && glyph
->u
.cmp
.automatic
24740 && glyph
->u
.cmp
.id
== s
->cmp_id
24741 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24742 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24744 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24746 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24747 unsigned code
= LGLYPH_CODE (lglyph
);
24749 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24751 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24752 return glyph
- s
->row
->glyphs
[s
->area
];
24756 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24757 See the comment of fill_glyph_string for arguments.
24758 Value is the index of the first glyph not in S. */
24762 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24763 int start
, int end
, int overlaps
)
24765 struct glyph
*glyph
, *last
;
24768 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24769 s
->for_overlaps
= overlaps
;
24770 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24771 last
= s
->row
->glyphs
[s
->area
] + end
;
24772 voffset
= glyph
->voffset
;
24773 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24774 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24776 s
->width
= glyph
->pixel_width
;
24778 while (glyph
< last
24779 && glyph
->type
== GLYPHLESS_GLYPH
24780 && glyph
->voffset
== voffset
24781 && glyph
->face_id
== face_id
)
24784 s
->width
+= glyph
->pixel_width
;
24787 s
->ybase
+= voffset
;
24788 return glyph
- s
->row
->glyphs
[s
->area
];
24792 /* Fill glyph string S from a sequence of character glyphs.
24794 FACE_ID is the face id of the string. START is the index of the
24795 first glyph to consider, END is the index of the last + 1.
24796 OVERLAPS non-zero means S should draw the foreground only, and use
24797 its physical height for clipping. See also draw_glyphs.
24799 Value is the index of the first glyph not in S. */
24802 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24803 int start
, int end
, int overlaps
)
24805 struct glyph
*glyph
, *last
;
24807 bool glyph_not_available_p
;
24809 eassert (s
->f
== XFRAME (s
->w
->frame
));
24810 eassert (s
->nchars
== 0);
24811 eassert (start
>= 0 && end
> start
);
24813 s
->for_overlaps
= overlaps
;
24814 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24815 last
= s
->row
->glyphs
[s
->area
] + end
;
24816 voffset
= glyph
->voffset
;
24817 s
->padding_p
= glyph
->padding_p
;
24818 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24820 while (glyph
< last
24821 && glyph
->type
== CHAR_GLYPH
24822 && glyph
->voffset
== voffset
24823 /* Same face id implies same font, nowadays. */
24824 && glyph
->face_id
== face_id
24825 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24827 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24828 s
->char2b
+ s
->nchars
);
24830 eassert (s
->nchars
<= end
- start
);
24831 s
->width
+= glyph
->pixel_width
;
24832 if (glyph
++->padding_p
!= s
->padding_p
)
24836 s
->font
= s
->face
->font
;
24838 /* If the specified font could not be loaded, use the frame's font,
24839 but record the fact that we couldn't load it in
24840 S->font_not_found_p so that we can draw rectangles for the
24841 characters of the glyph string. */
24842 if (s
->font
== NULL
|| glyph_not_available_p
)
24844 s
->font_not_found_p
= true;
24845 s
->font
= FRAME_FONT (s
->f
);
24848 /* Adjust base line for subscript/superscript text. */
24849 s
->ybase
+= voffset
;
24851 eassert (s
->face
&& s
->face
->gc
);
24852 return glyph
- s
->row
->glyphs
[s
->area
];
24856 /* Fill glyph string S from image glyph S->first_glyph. */
24859 fill_image_glyph_string (struct glyph_string
*s
)
24861 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24862 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24864 s
->slice
= s
->first_glyph
->slice
.img
;
24865 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24866 s
->font
= s
->face
->font
;
24867 s
->width
= s
->first_glyph
->pixel_width
;
24869 /* Adjust base line for subscript/superscript text. */
24870 s
->ybase
+= s
->first_glyph
->voffset
;
24874 #ifdef HAVE_XWIDGETS
24876 fill_xwidget_glyph_string (struct glyph_string
*s
)
24878 eassert (s
->first_glyph
->type
== XWIDGET_GLYPH
);
24879 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24880 s
->font
= s
->face
->font
;
24881 s
->width
= s
->first_glyph
->pixel_width
;
24882 s
->ybase
+= s
->first_glyph
->voffset
;
24883 s
->xwidget
= s
->first_glyph
->u
.xwidget
;
24886 /* Fill glyph string S from a sequence of stretch glyphs.
24888 START is the index of the first glyph to consider,
24889 END is the index of the last + 1.
24891 Value is the index of the first glyph not in S. */
24894 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24896 struct glyph
*glyph
, *last
;
24897 int voffset
, face_id
;
24899 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24901 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24902 last
= s
->row
->glyphs
[s
->area
] + end
;
24903 face_id
= glyph
->face_id
;
24904 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24905 s
->font
= s
->face
->font
;
24906 s
->width
= glyph
->pixel_width
;
24908 voffset
= glyph
->voffset
;
24912 && glyph
->type
== STRETCH_GLYPH
24913 && glyph
->voffset
== voffset
24914 && glyph
->face_id
== face_id
);
24916 s
->width
+= glyph
->pixel_width
;
24918 /* Adjust base line for subscript/superscript text. */
24919 s
->ybase
+= voffset
;
24921 /* The case that face->gc == 0 is handled when drawing the glyph
24922 string by calling prepare_face_for_display. */
24924 return glyph
- s
->row
->glyphs
[s
->area
];
24927 static struct font_metrics
*
24928 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24930 static struct font_metrics metrics
;
24935 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24936 if (code
== FONT_INVALID_CODE
)
24938 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24942 /* A subroutine that computes "normal" values of ASCENT and DESCENT
24943 for FONT. Values are taken from font-global ones, except for fonts
24944 that claim preposterously large values, but whose glyphs actually
24945 have reasonable dimensions. C is the character to use for metrics
24946 if the font-global values are too large; if C is negative, the
24947 function selects a default character. */
24949 normal_char_ascent_descent (struct font
*font
, int c
, int *ascent
, int *descent
)
24951 *ascent
= FONT_BASE (font
);
24952 *descent
= FONT_DESCENT (font
);
24954 if (FONT_TOO_HIGH (font
))
24958 /* Get metrics of C, defaulting to a reasonably sized ASCII
24960 if (get_char_glyph_code (c
>= 0 ? c
: '{', font
, &char2b
))
24962 struct font_metrics
*pcm
= get_per_char_metric (font
, &char2b
);
24964 if (!(pcm
->width
== 0 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0))
24966 /* We add 1 pixel to character dimensions as heuristics
24967 that produces nicer display, e.g. when the face has
24968 the box attribute. */
24969 *ascent
= pcm
->ascent
+ 1;
24970 *descent
= pcm
->descent
+ 1;
24976 /* A subroutine that computes a reasonable "normal character height"
24977 for fonts that claim preposterously large vertical dimensions, but
24978 whose glyphs are actually reasonably sized. C is the character
24979 whose metrics to use for those fonts, or -1 for default
24982 normal_char_height (struct font
*font
, int c
)
24984 int ascent
, descent
;
24986 normal_char_ascent_descent (font
, c
, &ascent
, &descent
);
24988 return ascent
+ descent
;
24992 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24993 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24994 assumed to be zero. */
24997 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24999 *left
= *right
= 0;
25001 if (glyph
->type
== CHAR_GLYPH
)
25004 struct face
*face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
);
25007 struct font_metrics
*pcm
= get_per_char_metric (face
->font
, &char2b
);
25010 if (pcm
->rbearing
> pcm
->width
)
25011 *right
= pcm
->rbearing
- pcm
->width
;
25012 if (pcm
->lbearing
< 0)
25013 *left
= -pcm
->lbearing
;
25017 else if (glyph
->type
== COMPOSITE_GLYPH
)
25019 if (! glyph
->u
.cmp
.automatic
)
25021 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
25023 if (cmp
->rbearing
> cmp
->pixel_width
)
25024 *right
= cmp
->rbearing
- cmp
->pixel_width
;
25025 if (cmp
->lbearing
< 0)
25026 *left
= - cmp
->lbearing
;
25030 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
25031 struct font_metrics metrics
;
25033 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
25034 glyph
->slice
.cmp
.to
+ 1, &metrics
);
25035 if (metrics
.rbearing
> metrics
.width
)
25036 *right
= metrics
.rbearing
- metrics
.width
;
25037 if (metrics
.lbearing
< 0)
25038 *left
= - metrics
.lbearing
;
25044 /* Return the index of the first glyph preceding glyph string S that
25045 is overwritten by S because of S's left overhang. Value is -1
25046 if no glyphs are overwritten. */
25049 left_overwritten (struct glyph_string
*s
)
25053 if (s
->left_overhang
)
25056 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25057 int first
= s
->first_glyph
- glyphs
;
25059 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
25060 x
-= glyphs
[i
].pixel_width
;
25071 /* Return the index of the first glyph preceding glyph string S that
25072 is overwriting S because of its right overhang. Value is -1 if no
25073 glyph in front of S overwrites S. */
25076 left_overwriting (struct glyph_string
*s
)
25079 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25080 int first
= s
->first_glyph
- glyphs
;
25084 for (i
= first
- 1; i
>= 0; --i
)
25087 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
25090 x
-= glyphs
[i
].pixel_width
;
25097 /* Return the index of the last glyph following glyph string S that is
25098 overwritten by S because of S's right overhang. Value is -1 if
25099 no such glyph is found. */
25102 right_overwritten (struct glyph_string
*s
)
25106 if (s
->right_overhang
)
25109 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25110 int first
= (s
->first_glyph
- glyphs
25111 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
25112 int end
= s
->row
->used
[s
->area
];
25114 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
25115 x
+= glyphs
[i
].pixel_width
;
25124 /* Return the index of the last glyph following glyph string S that
25125 overwrites S because of its left overhang. Value is negative
25126 if no such glyph is found. */
25129 right_overwriting (struct glyph_string
*s
)
25132 int end
= s
->row
->used
[s
->area
];
25133 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25134 int first
= (s
->first_glyph
- glyphs
25135 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
25139 for (i
= first
; i
< end
; ++i
)
25142 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
25145 x
+= glyphs
[i
].pixel_width
;
25152 /* Set background width of glyph string S. START is the index of the
25153 first glyph following S. LAST_X is the right-most x-position + 1
25154 in the drawing area. */
25157 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
25159 /* If the face of this glyph string has to be drawn to the end of
25160 the drawing area, set S->extends_to_end_of_line_p. */
25162 if (start
== s
->row
->used
[s
->area
]
25163 && ((s
->row
->fill_line_p
25164 && (s
->hl
== DRAW_NORMAL_TEXT
25165 || s
->hl
== DRAW_IMAGE_RAISED
25166 || s
->hl
== DRAW_IMAGE_SUNKEN
))
25167 || s
->hl
== DRAW_MOUSE_FACE
))
25168 s
->extends_to_end_of_line_p
= true;
25170 /* If S extends its face to the end of the line, set its
25171 background_width to the distance to the right edge of the drawing
25173 if (s
->extends_to_end_of_line_p
)
25174 s
->background_width
= last_x
- s
->x
+ 1;
25176 s
->background_width
= s
->width
;
25180 /* Compute overhangs and x-positions for glyph string S and its
25181 predecessors, or successors. X is the starting x-position for S.
25182 BACKWARD_P means process predecessors. */
25185 compute_overhangs_and_x (struct glyph_string
*s
, int x
, bool backward_p
)
25191 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
25192 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
25202 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
25203 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
25213 /* The following macros are only called from draw_glyphs below.
25214 They reference the following parameters of that function directly:
25215 `w', `row', `area', and `overlap_p'
25216 as well as the following local variables:
25217 `s', `f', and `hdc' (in W32) */
25220 /* On W32, silently add local `hdc' variable to argument list of
25221 init_glyph_string. */
25222 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
25223 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
25225 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
25226 init_glyph_string (s, char2b, w, row, area, start, hl)
25229 /* Add a glyph string for a stretch glyph to the list of strings
25230 between HEAD and TAIL. START is the index of the stretch glyph in
25231 row area AREA of glyph row ROW. END is the index of the last glyph
25232 in that glyph row area. X is the current output position assigned
25233 to the new glyph string constructed. HL overrides that face of the
25234 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25235 is the right-most x-position of the drawing area. */
25237 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
25238 and below -- keep them on one line. */
25239 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25242 s = alloca (sizeof *s); \
25243 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25244 START = fill_stretch_glyph_string (s, START, END); \
25245 append_glyph_string (&HEAD, &TAIL, s); \
25251 /* Add a glyph string for an image glyph to the list of strings
25252 between HEAD and TAIL. START is the index of the image glyph in
25253 row area AREA of glyph row ROW. END is the index of the last glyph
25254 in that glyph row area. X is the current output position assigned
25255 to the new glyph string constructed. HL overrides that face of the
25256 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25257 is the right-most x-position of the drawing area. */
25259 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25262 s = alloca (sizeof *s); \
25263 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25264 fill_image_glyph_string (s); \
25265 append_glyph_string (&HEAD, &TAIL, s); \
25271 #ifndef HAVE_XWIDGETS
25272 # define BUILD_XWIDGET_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25275 # define BUILD_XWIDGET_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25278 s = alloca (sizeof *s); \
25279 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25280 fill_xwidget_glyph_string (s); \
25281 append_glyph_string (&(HEAD), &(TAIL), s); \
25288 /* Add a glyph string for a sequence of character glyphs to the list
25289 of strings between HEAD and TAIL. START is the index of the first
25290 glyph in row area AREA of glyph row ROW that is part of the new
25291 glyph string. END is the index of the last glyph in that glyph row
25292 area. X is the current output position assigned to the new glyph
25293 string constructed. HL overrides that face of the glyph; e.g. it
25294 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
25295 right-most x-position of the drawing area. */
25297 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25303 face_id = (row)->glyphs[area][START].face_id; \
25305 s = alloca (sizeof *s); \
25306 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
25307 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25308 append_glyph_string (&HEAD, &TAIL, s); \
25310 START = fill_glyph_string (s, face_id, START, END, overlaps); \
25315 /* Add a glyph string for a composite sequence to the list of strings
25316 between HEAD and TAIL. START is the index of the first glyph in
25317 row area AREA of glyph row ROW that is part of the new glyph
25318 string. END is the index of the last glyph in that glyph row area.
25319 X is the current output position assigned to the new glyph string
25320 constructed. HL overrides that face of the glyph; e.g. it is
25321 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
25322 x-position of the drawing area. */
25324 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25326 int face_id = (row)->glyphs[area][START].face_id; \
25327 struct face *base_face = FACE_FROM_ID (f, face_id); \
25328 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
25329 struct composition *cmp = composition_table[cmp_id]; \
25331 struct glyph_string *first_s = NULL; \
25334 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
25336 /* Make glyph_strings for each glyph sequence that is drawable by \
25337 the same face, and append them to HEAD/TAIL. */ \
25338 for (n = 0; n < cmp->glyph_len;) \
25340 s = alloca (sizeof *s); \
25341 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25342 append_glyph_string (&(HEAD), &(TAIL), s); \
25348 n = fill_composite_glyph_string (s, base_face, overlaps); \
25356 /* Add a glyph string for a glyph-string sequence to the list of strings
25357 between HEAD and TAIL. */
25359 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25363 Lisp_Object gstring; \
25365 face_id = (row)->glyphs[area][START].face_id; \
25366 gstring = (composition_gstring_from_id \
25367 ((row)->glyphs[area][START].u.cmp.id)); \
25368 s = alloca (sizeof *s); \
25369 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
25370 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25371 append_glyph_string (&(HEAD), &(TAIL), s); \
25373 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
25377 /* Add a glyph string for a sequence of glyphless character's glyphs
25378 to the list of strings between HEAD and TAIL. The meanings of
25379 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
25381 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25386 face_id = (row)->glyphs[area][START].face_id; \
25388 s = alloca (sizeof *s); \
25389 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25390 append_glyph_string (&HEAD, &TAIL, s); \
25392 START = fill_glyphless_glyph_string (s, face_id, START, END, \
25398 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
25399 of AREA of glyph row ROW on window W between indices START and END.
25400 HL overrides the face for drawing glyph strings, e.g. it is
25401 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
25402 x-positions of the drawing area.
25404 This is an ugly monster macro construct because we must use alloca
25405 to allocate glyph strings (because draw_glyphs can be called
25406 asynchronously). */
25408 #define BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25411 HEAD = TAIL = NULL; \
25412 while (START < END) \
25414 struct glyph *first_glyph = (row)->glyphs[area] + START; \
25415 switch (first_glyph->type) \
25418 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
25422 case COMPOSITE_GLYPH: \
25423 if (first_glyph->u.cmp.automatic) \
25424 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
25427 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
25431 case STRETCH_GLYPH: \
25432 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
25436 case IMAGE_GLYPH: \
25437 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
25441 #define BUILD_GLYPH_STRINGS_XW(START, END, HEAD, TAIL, HL, X, LAST_X) \
25442 case XWIDGET_GLYPH: \
25443 BUILD_XWIDGET_GLYPH_STRING (START, END, HEAD, TAIL, \
25447 #define BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X) \
25448 case GLYPHLESS_GLYPH: \
25449 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
25459 set_glyph_string_background_width (s, START, LAST_X); \
25466 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25467 BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25468 BUILD_GLYPH_STRINGS_XW(START, END, HEAD, TAIL, HL, X, LAST_X) \
25469 BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X)
25472 /* Draw glyphs between START and END in AREA of ROW on window W,
25473 starting at x-position X. X is relative to AREA in W. HL is a
25474 face-override with the following meaning:
25476 DRAW_NORMAL_TEXT draw normally
25477 DRAW_CURSOR draw in cursor face
25478 DRAW_MOUSE_FACE draw in mouse face.
25479 DRAW_INVERSE_VIDEO draw in mode line face
25480 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
25481 DRAW_IMAGE_RAISED draw an image with a raised relief around it
25483 If OVERLAPS is non-zero, draw only the foreground of characters and
25484 clip to the physical height of ROW. Non-zero value also defines
25485 the overlapping part to be drawn:
25487 OVERLAPS_PRED overlap with preceding rows
25488 OVERLAPS_SUCC overlap with succeeding rows
25489 OVERLAPS_BOTH overlap with both preceding/succeeding rows
25490 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
25492 Value is the x-position reached, relative to AREA of W. */
25495 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
25496 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
25497 enum draw_glyphs_face hl
, int overlaps
)
25499 struct glyph_string
*head
, *tail
;
25500 struct glyph_string
*s
;
25501 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
25502 int i
, j
, x_reached
, last_x
, area_left
= 0;
25503 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25506 ALLOCATE_HDC (hdc
, f
);
25508 /* Let's rather be paranoid than getting a SEGV. */
25509 end
= min (end
, row
->used
[area
]);
25510 start
= clip_to_bounds (0, start
, end
);
25512 /* Translate X to frame coordinates. Set last_x to the right
25513 end of the drawing area. */
25514 if (row
->full_width_p
)
25516 /* X is relative to the left edge of W, without scroll bars
25518 area_left
= WINDOW_LEFT_EDGE_X (w
);
25519 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
25520 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
25524 area_left
= window_box_left (w
, area
);
25525 last_x
= area_left
+ window_box_width (w
, area
);
25529 /* Build a doubly-linked list of glyph_string structures between
25530 head and tail from what we have to draw. Note that the macro
25531 BUILD_GLYPH_STRINGS will modify its start parameter. That's
25532 the reason we use a separate variable `i'. */
25535 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
25537 x_reached
= tail
->x
+ tail
->background_width
;
25541 /* If there are any glyphs with lbearing < 0 or rbearing > width in
25542 the row, redraw some glyphs in front or following the glyph
25543 strings built above. */
25544 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
25546 struct glyph_string
*h
, *t
;
25547 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25548 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
25549 bool check_mouse_face
= false;
25552 /* If mouse highlighting is on, we may need to draw adjacent
25553 glyphs using mouse-face highlighting. */
25554 if (area
== TEXT_AREA
&& row
->mouse_face_p
25555 && hlinfo
->mouse_face_beg_row
>= 0
25556 && hlinfo
->mouse_face_end_row
>= 0)
25558 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
25560 if (row_vpos
>= hlinfo
->mouse_face_beg_row
25561 && row_vpos
<= hlinfo
->mouse_face_end_row
)
25563 check_mouse_face
= true;
25564 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
25565 ? hlinfo
->mouse_face_beg_col
: 0;
25566 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
25567 ? hlinfo
->mouse_face_end_col
25568 : row
->used
[TEXT_AREA
];
25572 /* Compute overhangs for all glyph strings. */
25573 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
25574 for (s
= head
; s
; s
= s
->next
)
25575 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
25577 /* Prepend glyph strings for glyphs in front of the first glyph
25578 string that are overwritten because of the first glyph
25579 string's left overhang. The background of all strings
25580 prepended must be drawn because the first glyph string
25582 i
= left_overwritten (head
);
25585 enum draw_glyphs_face overlap_hl
;
25587 /* If this row contains mouse highlighting, attempt to draw
25588 the overlapped glyphs with the correct highlight. This
25589 code fails if the overlap encompasses more than one glyph
25590 and mouse-highlight spans only some of these glyphs.
25591 However, making it work perfectly involves a lot more
25592 code, and I don't know if the pathological case occurs in
25593 practice, so we'll stick to this for now. --- cyd */
25594 if (check_mouse_face
25595 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25596 overlap_hl
= DRAW_MOUSE_FACE
;
25598 overlap_hl
= DRAW_NORMAL_TEXT
;
25600 if (hl
!= overlap_hl
)
25603 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
25604 overlap_hl
, dummy_x
, last_x
);
25606 compute_overhangs_and_x (t
, head
->x
, true);
25607 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25608 if (clip_head
== NULL
)
25612 /* Prepend glyph strings for glyphs in front of the first glyph
25613 string that overwrite that glyph string because of their
25614 right overhang. For these strings, only the foreground must
25615 be drawn, because it draws over the glyph string at `head'.
25616 The background must not be drawn because this would overwrite
25617 right overhangs of preceding glyphs for which no glyph
25619 i
= left_overwriting (head
);
25622 enum draw_glyphs_face overlap_hl
;
25624 if (check_mouse_face
25625 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25626 overlap_hl
= DRAW_MOUSE_FACE
;
25628 overlap_hl
= DRAW_NORMAL_TEXT
;
25630 if (hl
== overlap_hl
|| clip_head
== NULL
)
25632 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
25633 overlap_hl
, dummy_x
, last_x
);
25634 for (s
= h
; s
; s
= s
->next
)
25635 s
->background_filled_p
= true;
25636 compute_overhangs_and_x (t
, head
->x
, true);
25637 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25640 /* Append glyphs strings for glyphs following the last glyph
25641 string tail that are overwritten by tail. The background of
25642 these strings has to be drawn because tail's foreground draws
25644 i
= right_overwritten (tail
);
25647 enum draw_glyphs_face overlap_hl
;
25649 if (check_mouse_face
25650 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25651 overlap_hl
= DRAW_MOUSE_FACE
;
25653 overlap_hl
= DRAW_NORMAL_TEXT
;
25655 if (hl
!= overlap_hl
)
25657 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25658 overlap_hl
, x
, last_x
);
25659 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25660 we don't have `end = i;' here. */
25661 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25662 append_glyph_string_lists (&head
, &tail
, h
, t
);
25663 if (clip_tail
== NULL
)
25667 /* Append glyph strings for glyphs following the last glyph
25668 string tail that overwrite tail. The foreground of such
25669 glyphs has to be drawn because it writes into the background
25670 of tail. The background must not be drawn because it could
25671 paint over the foreground of following glyphs. */
25672 i
= right_overwriting (tail
);
25675 enum draw_glyphs_face overlap_hl
;
25676 if (check_mouse_face
25677 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25678 overlap_hl
= DRAW_MOUSE_FACE
;
25680 overlap_hl
= DRAW_NORMAL_TEXT
;
25682 if (hl
== overlap_hl
|| clip_tail
== NULL
)
25684 i
++; /* We must include the Ith glyph. */
25685 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25686 overlap_hl
, x
, last_x
);
25687 for (s
= h
; s
; s
= s
->next
)
25688 s
->background_filled_p
= true;
25689 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25690 append_glyph_string_lists (&head
, &tail
, h
, t
);
25692 if (clip_head
|| clip_tail
)
25693 for (s
= head
; s
; s
= s
->next
)
25695 s
->clip_head
= clip_head
;
25696 s
->clip_tail
= clip_tail
;
25700 /* Draw all strings. */
25701 for (s
= head
; s
; s
= s
->next
)
25702 FRAME_RIF (f
)->draw_glyph_string (s
);
25705 /* When focus a sole frame and move horizontally, this clears on_p
25706 causing a failure to erase prev cursor position. */
25707 if (area
== TEXT_AREA
25708 && !row
->full_width_p
25709 /* When drawing overlapping rows, only the glyph strings'
25710 foreground is drawn, which doesn't erase a cursor
25714 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25715 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25716 : (tail
? tail
->x
+ tail
->background_width
: x
));
25720 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25721 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25725 /* Value is the x-position up to which drawn, relative to AREA of W.
25726 This doesn't include parts drawn because of overhangs. */
25727 if (row
->full_width_p
)
25728 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25730 x_reached
-= area_left
;
25732 RELEASE_HDC (hdc
, f
);
25738 /* Expand row matrix if too narrow. Don't expand if area
25741 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25743 if (!it->f->fonts_changed \
25744 && (it->glyph_row->glyphs[area] \
25745 < it->glyph_row->glyphs[area + 1])) \
25747 it->w->ncols_scale_factor++; \
25748 it->f->fonts_changed = true; \
25752 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25753 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25756 append_glyph (struct it
*it
)
25758 struct glyph
*glyph
;
25759 enum glyph_row_area area
= it
->area
;
25761 eassert (it
->glyph_row
);
25762 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25764 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25765 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25767 /* If the glyph row is reversed, we need to prepend the glyph
25768 rather than append it. */
25769 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25773 /* Make room for the additional glyph. */
25774 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25776 glyph
= it
->glyph_row
->glyphs
[area
];
25778 glyph
->charpos
= CHARPOS (it
->position
);
25779 glyph
->object
= it
->object
;
25780 if (it
->pixel_width
> 0)
25782 glyph
->pixel_width
= it
->pixel_width
;
25783 glyph
->padding_p
= false;
25787 /* Assure at least 1-pixel width. Otherwise, cursor can't
25788 be displayed correctly. */
25789 glyph
->pixel_width
= 1;
25790 glyph
->padding_p
= true;
25792 glyph
->ascent
= it
->ascent
;
25793 glyph
->descent
= it
->descent
;
25794 glyph
->voffset
= it
->voffset
;
25795 glyph
->type
= CHAR_GLYPH
;
25796 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25797 glyph
->multibyte_p
= it
->multibyte_p
;
25798 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25800 /* In R2L rows, the left and the right box edges need to be
25801 drawn in reverse direction. */
25802 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25803 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25807 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25808 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25810 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25811 || it
->phys_descent
> it
->descent
);
25812 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25813 glyph
->face_id
= it
->face_id
;
25814 glyph
->u
.ch
= it
->char_to_display
;
25815 glyph
->slice
.img
= null_glyph_slice
;
25816 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25819 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25820 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25821 glyph
->bidi_type
= it
->bidi_it
.type
;
25825 glyph
->resolved_level
= 0;
25826 glyph
->bidi_type
= UNKNOWN_BT
;
25828 ++it
->glyph_row
->used
[area
];
25831 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25834 /* Store one glyph for the composition IT->cmp_it.id in
25835 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25839 append_composite_glyph (struct it
*it
)
25841 struct glyph
*glyph
;
25842 enum glyph_row_area area
= it
->area
;
25844 eassert (it
->glyph_row
);
25846 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25847 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25849 /* If the glyph row is reversed, we need to prepend the glyph
25850 rather than append it. */
25851 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25855 /* Make room for the new glyph. */
25856 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25858 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25860 glyph
->charpos
= it
->cmp_it
.charpos
;
25861 glyph
->object
= it
->object
;
25862 glyph
->pixel_width
= it
->pixel_width
;
25863 glyph
->ascent
= it
->ascent
;
25864 glyph
->descent
= it
->descent
;
25865 glyph
->voffset
= it
->voffset
;
25866 glyph
->type
= COMPOSITE_GLYPH
;
25867 if (it
->cmp_it
.ch
< 0)
25869 glyph
->u
.cmp
.automatic
= false;
25870 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25871 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25875 glyph
->u
.cmp
.automatic
= true;
25876 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25877 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25878 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25880 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25881 glyph
->multibyte_p
= it
->multibyte_p
;
25882 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25884 /* In R2L rows, the left and the right box edges need to be
25885 drawn in reverse direction. */
25886 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25887 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25891 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25892 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25894 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25895 || it
->phys_descent
> it
->descent
);
25896 glyph
->padding_p
= false;
25897 glyph
->glyph_not_available_p
= false;
25898 glyph
->face_id
= it
->face_id
;
25899 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25902 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25903 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25904 glyph
->bidi_type
= it
->bidi_it
.type
;
25906 ++it
->glyph_row
->used
[area
];
25909 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25913 /* Change IT->ascent and IT->height according to the setting of
25917 take_vertical_position_into_account (struct it
*it
)
25921 if (it
->voffset
< 0)
25922 /* Increase the ascent so that we can display the text higher
25924 it
->ascent
-= it
->voffset
;
25926 /* Increase the descent so that we can display the text lower
25928 it
->descent
+= it
->voffset
;
25933 /* Produce glyphs/get display metrics for the image IT is loaded with.
25934 See the description of struct display_iterator in dispextern.h for
25935 an overview of struct display_iterator. */
25938 produce_image_glyph (struct it
*it
)
25942 int glyph_ascent
, crop
;
25943 struct glyph_slice slice
;
25945 eassert (it
->what
== IT_IMAGE
);
25947 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25949 /* Make sure X resources of the face is loaded. */
25950 prepare_face_for_display (it
->f
, face
);
25952 if (it
->image_id
< 0)
25954 /* Fringe bitmap. */
25955 it
->ascent
= it
->phys_ascent
= 0;
25956 it
->descent
= it
->phys_descent
= 0;
25957 it
->pixel_width
= 0;
25962 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25964 /* Make sure X resources of the image is loaded. */
25965 prepare_image_for_display (it
->f
, img
);
25967 slice
.x
= slice
.y
= 0;
25968 slice
.width
= img
->width
;
25969 slice
.height
= img
->height
;
25971 if (INTEGERP (it
->slice
.x
))
25972 slice
.x
= XINT (it
->slice
.x
);
25973 else if (FLOATP (it
->slice
.x
))
25974 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25976 if (INTEGERP (it
->slice
.y
))
25977 slice
.y
= XINT (it
->slice
.y
);
25978 else if (FLOATP (it
->slice
.y
))
25979 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25981 if (INTEGERP (it
->slice
.width
))
25982 slice
.width
= XINT (it
->slice
.width
);
25983 else if (FLOATP (it
->slice
.width
))
25984 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25986 if (INTEGERP (it
->slice
.height
))
25987 slice
.height
= XINT (it
->slice
.height
);
25988 else if (FLOATP (it
->slice
.height
))
25989 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25991 if (slice
.x
>= img
->width
)
25992 slice
.x
= img
->width
;
25993 if (slice
.y
>= img
->height
)
25994 slice
.y
= img
->height
;
25995 if (slice
.x
+ slice
.width
>= img
->width
)
25996 slice
.width
= img
->width
- slice
.x
;
25997 if (slice
.y
+ slice
.height
> img
->height
)
25998 slice
.height
= img
->height
- slice
.y
;
26000 if (slice
.width
== 0 || slice
.height
== 0)
26003 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
26005 it
->descent
= slice
.height
- glyph_ascent
;
26007 it
->descent
+= img
->vmargin
;
26008 if (slice
.y
+ slice
.height
== img
->height
)
26009 it
->descent
+= img
->vmargin
;
26010 it
->phys_descent
= it
->descent
;
26012 it
->pixel_width
= slice
.width
;
26014 it
->pixel_width
+= img
->hmargin
;
26015 if (slice
.x
+ slice
.width
== img
->width
)
26016 it
->pixel_width
+= img
->hmargin
;
26018 /* It's quite possible for images to have an ascent greater than
26019 their height, so don't get confused in that case. */
26020 if (it
->descent
< 0)
26025 if (face
->box
!= FACE_NO_BOX
)
26027 if (face
->box_line_width
> 0)
26030 it
->ascent
+= face
->box_line_width
;
26031 if (slice
.y
+ slice
.height
== img
->height
)
26032 it
->descent
+= face
->box_line_width
;
26035 if (it
->start_of_box_run_p
&& slice
.x
== 0)
26036 it
->pixel_width
+= eabs (face
->box_line_width
);
26037 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
26038 it
->pixel_width
+= eabs (face
->box_line_width
);
26041 take_vertical_position_into_account (it
);
26043 /* Automatically crop wide image glyphs at right edge so we can
26044 draw the cursor on same display row. */
26045 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
26046 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
26048 it
->pixel_width
-= crop
;
26049 slice
.width
-= crop
;
26054 struct glyph
*glyph
;
26055 enum glyph_row_area area
= it
->area
;
26057 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26058 if (it
->glyph_row
->reversed_p
)
26062 /* Make room for the new glyph. */
26063 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
26065 glyph
= it
->glyph_row
->glyphs
[it
->area
];
26067 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26069 glyph
->charpos
= CHARPOS (it
->position
);
26070 glyph
->object
= it
->object
;
26071 glyph
->pixel_width
= it
->pixel_width
;
26072 glyph
->ascent
= glyph_ascent
;
26073 glyph
->descent
= it
->descent
;
26074 glyph
->voffset
= it
->voffset
;
26075 glyph
->type
= IMAGE_GLYPH
;
26076 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26077 glyph
->multibyte_p
= it
->multibyte_p
;
26078 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26080 /* In R2L rows, the left and the right box edges need to be
26081 drawn in reverse direction. */
26082 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26083 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26087 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26088 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26090 glyph
->overlaps_vertically_p
= false;
26091 glyph
->padding_p
= false;
26092 glyph
->glyph_not_available_p
= false;
26093 glyph
->face_id
= it
->face_id
;
26094 glyph
->u
.img_id
= img
->id
;
26095 glyph
->slice
.img
= slice
;
26096 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26099 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26100 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26101 glyph
->bidi_type
= it
->bidi_it
.type
;
26103 ++it
->glyph_row
->used
[area
];
26106 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26111 produce_xwidget_glyph (struct it
*it
)
26113 #ifdef HAVE_XWIDGETS
26114 struct xwidget
*xw
;
26115 int glyph_ascent
, crop
;
26116 eassert (it
->what
== IT_XWIDGET
);
26118 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26120 /* Make sure X resources of the face is loaded. */
26121 prepare_face_for_display (it
->f
, face
);
26124 it
->ascent
= it
->phys_ascent
= glyph_ascent
= xw
->height
/2;
26125 it
->descent
= xw
->height
/2;
26126 it
->phys_descent
= it
->descent
;
26127 it
->pixel_width
= xw
->width
;
26128 /* It's quite possible for images to have an ascent greater than
26129 their height, so don't get confused in that case. */
26130 if (it
->descent
< 0)
26135 if (face
->box
!= FACE_NO_BOX
)
26137 if (face
->box_line_width
> 0)
26139 it
->ascent
+= face
->box_line_width
;
26140 it
->descent
+= face
->box_line_width
;
26143 if (it
->start_of_box_run_p
)
26144 it
->pixel_width
+= eabs (face
->box_line_width
);
26145 it
->pixel_width
+= eabs (face
->box_line_width
);
26148 take_vertical_position_into_account (it
);
26150 /* Automatically crop wide image glyphs at right edge so we can
26151 draw the cursor on same display row. */
26152 crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
);
26153 if (crop
> 0 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
26154 it
->pixel_width
-= crop
;
26158 enum glyph_row_area area
= it
->area
;
26159 struct glyph
*glyph
26160 = it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26162 if (it
->glyph_row
->reversed_p
)
26166 /* Make room for the new glyph. */
26167 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
26169 glyph
= it
->glyph_row
->glyphs
[it
->area
];
26171 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26173 glyph
->charpos
= CHARPOS (it
->position
);
26174 glyph
->object
= it
->object
;
26175 glyph
->pixel_width
= it
->pixel_width
;
26176 glyph
->ascent
= glyph_ascent
;
26177 glyph
->descent
= it
->descent
;
26178 glyph
->voffset
= it
->voffset
;
26179 glyph
->type
= XWIDGET_GLYPH
;
26180 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26181 glyph
->multibyte_p
= it
->multibyte_p
;
26182 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26184 /* In R2L rows, the left and the right box edges need to be
26185 drawn in reverse direction. */
26186 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26187 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26191 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26192 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26194 glyph
->overlaps_vertically_p
= 0;
26195 glyph
->padding_p
= 0;
26196 glyph
->glyph_not_available_p
= 0;
26197 glyph
->face_id
= it
->face_id
;
26198 glyph
->u
.xwidget
= it
->xwidget
;
26199 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26202 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26203 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26204 glyph
->bidi_type
= it
->bidi_it
.type
;
26206 ++it
->glyph_row
->used
[area
];
26209 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26214 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
26215 of the glyph, WIDTH and HEIGHT are the width and height of the
26216 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
26219 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
26220 int width
, int height
, int ascent
)
26222 struct glyph
*glyph
;
26223 enum glyph_row_area area
= it
->area
;
26225 eassert (ascent
>= 0 && ascent
<= height
);
26227 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26228 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26230 /* If the glyph row is reversed, we need to prepend the glyph
26231 rather than append it. */
26232 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26236 /* Make room for the additional glyph. */
26237 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26239 glyph
= it
->glyph_row
->glyphs
[area
];
26241 /* Decrease the width of the first glyph of the row that
26242 begins before first_visible_x (e.g., due to hscroll).
26243 This is so the overall width of the row becomes smaller
26244 by the scroll amount, and the stretch glyph appended by
26245 extend_face_to_end_of_line will be wider, to shift the
26246 row glyphs to the right. (In L2R rows, the corresponding
26247 left-shift effect is accomplished by setting row->x to a
26248 negative value, which won't work with R2L rows.)
26250 This must leave us with a positive value of WIDTH, since
26251 otherwise the call to move_it_in_display_line_to at the
26252 beginning of display_line would have got past the entire
26253 first glyph, and then it->current_x would have been
26254 greater or equal to it->first_visible_x. */
26255 if (it
->current_x
< it
->first_visible_x
)
26256 width
-= it
->first_visible_x
- it
->current_x
;
26257 eassert (width
> 0);
26259 glyph
->charpos
= CHARPOS (it
->position
);
26260 glyph
->object
= object
;
26261 glyph
->pixel_width
= width
;
26262 glyph
->ascent
= ascent
;
26263 glyph
->descent
= height
- ascent
;
26264 glyph
->voffset
= it
->voffset
;
26265 glyph
->type
= STRETCH_GLYPH
;
26266 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26267 glyph
->multibyte_p
= it
->multibyte_p
;
26268 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26270 /* In R2L rows, the left and the right box edges need to be
26271 drawn in reverse direction. */
26272 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26273 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26277 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26278 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26280 glyph
->overlaps_vertically_p
= false;
26281 glyph
->padding_p
= false;
26282 glyph
->glyph_not_available_p
= false;
26283 glyph
->face_id
= it
->face_id
;
26284 glyph
->u
.stretch
.ascent
= ascent
;
26285 glyph
->u
.stretch
.height
= height
;
26286 glyph
->slice
.img
= null_glyph_slice
;
26287 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26290 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26291 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26292 glyph
->bidi_type
= it
->bidi_it
.type
;
26296 glyph
->resolved_level
= 0;
26297 glyph
->bidi_type
= UNKNOWN_BT
;
26299 ++it
->glyph_row
->used
[area
];
26302 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26305 #endif /* HAVE_WINDOW_SYSTEM */
26307 /* Produce a stretch glyph for iterator IT. IT->object is the value
26308 of the glyph property displayed. The value must be a list
26309 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
26312 1. `:width WIDTH' specifies that the space should be WIDTH *
26313 canonical char width wide. WIDTH may be an integer or floating
26316 2. `:relative-width FACTOR' specifies that the width of the stretch
26317 should be computed from the width of the first character having the
26318 `glyph' property, and should be FACTOR times that width.
26320 3. `:align-to HPOS' specifies that the space should be wide enough
26321 to reach HPOS, a value in canonical character units.
26323 Exactly one of the above pairs must be present.
26325 4. `:height HEIGHT' specifies that the height of the stretch produced
26326 should be HEIGHT, measured in canonical character units.
26328 5. `:relative-height FACTOR' specifies that the height of the
26329 stretch should be FACTOR times the height of the characters having
26330 the glyph property.
26332 Either none or exactly one of 4 or 5 must be present.
26334 6. `:ascent ASCENT' specifies that ASCENT percent of the height
26335 of the stretch should be used for the ascent of the stretch.
26336 ASCENT must be in the range 0 <= ASCENT <= 100. */
26339 produce_stretch_glyph (struct it
*it
)
26341 /* (space :width WIDTH :height HEIGHT ...) */
26342 Lisp_Object prop
, plist
;
26343 int width
= 0, height
= 0, align_to
= -1;
26344 bool zero_width_ok_p
= false;
26346 struct font
*font
= NULL
;
26348 #ifdef HAVE_WINDOW_SYSTEM
26350 bool zero_height_ok_p
= false;
26352 if (FRAME_WINDOW_P (it
->f
))
26354 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26355 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26356 prepare_face_for_display (it
->f
, face
);
26360 /* List should start with `space'. */
26361 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
26362 plist
= XCDR (it
->object
);
26364 /* Compute the width of the stretch. */
26365 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
26366 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true, 0))
26368 /* Absolute width `:width WIDTH' specified and valid. */
26369 zero_width_ok_p
= true;
26372 else if (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0)
26374 /* Relative width `:relative-width FACTOR' specified and valid.
26375 Compute the width of the characters having the `glyph'
26378 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
26381 if (it
->multibyte_p
)
26382 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
26385 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
26386 if (! ASCII_CHAR_P (it2
.c
))
26387 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
26390 it2
.glyph_row
= NULL
;
26391 it2
.what
= IT_CHARACTER
;
26392 PRODUCE_GLYPHS (&it2
);
26393 width
= NUMVAL (prop
) * it2
.pixel_width
;
26395 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
26396 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true,
26399 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
26400 align_to
= (align_to
< 0
26402 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
26403 else if (align_to
< 0)
26404 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
26405 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
26406 zero_width_ok_p
= true;
26409 /* Nothing specified -> width defaults to canonical char width. */
26410 width
= FRAME_COLUMN_WIDTH (it
->f
);
26412 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
26415 #ifdef HAVE_WINDOW_SYSTEM
26416 /* Compute height. */
26417 if (FRAME_WINDOW_P (it
->f
))
26419 int default_height
= normal_char_height (font
, ' ');
26421 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
26422 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26425 zero_height_ok_p
= true;
26427 else if (prop
= Fplist_get (plist
, QCrelative_height
),
26429 height
= default_height
* NUMVAL (prop
);
26431 height
= default_height
;
26433 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
26436 /* Compute percentage of height used for ascent. If
26437 `:ascent ASCENT' is present and valid, use that. Otherwise,
26438 derive the ascent from the font in use. */
26439 if (prop
= Fplist_get (plist
, QCascent
),
26440 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
26441 ascent
= height
* NUMVAL (prop
) / 100.0;
26442 else if (!NILP (prop
)
26443 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26444 ascent
= min (max (0, (int)tem
), height
);
26446 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
26449 #endif /* HAVE_WINDOW_SYSTEM */
26452 if (width
> 0 && it
->line_wrap
!= TRUNCATE
26453 && it
->current_x
+ width
> it
->last_visible_x
)
26455 width
= it
->last_visible_x
- it
->current_x
;
26456 #ifdef HAVE_WINDOW_SYSTEM
26457 /* Subtract one more pixel from the stretch width, but only on
26458 GUI frames, since on a TTY each glyph is one "pixel" wide. */
26459 width
-= FRAME_WINDOW_P (it
->f
);
26463 if (width
> 0 && height
> 0 && it
->glyph_row
)
26465 Lisp_Object o_object
= it
->object
;
26466 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
26469 if (!STRINGP (object
))
26470 object
= it
->w
->contents
;
26471 #ifdef HAVE_WINDOW_SYSTEM
26472 if (FRAME_WINDOW_P (it
->f
))
26473 append_stretch_glyph (it
, object
, width
, height
, ascent
);
26477 it
->object
= object
;
26478 it
->char_to_display
= ' ';
26479 it
->pixel_width
= it
->len
= 1;
26481 tty_append_glyph (it
);
26482 it
->object
= o_object
;
26486 it
->pixel_width
= width
;
26487 #ifdef HAVE_WINDOW_SYSTEM
26488 if (FRAME_WINDOW_P (it
->f
))
26490 it
->ascent
= it
->phys_ascent
= ascent
;
26491 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
26492 it
->nglyphs
= width
> 0 && height
> 0;
26493 take_vertical_position_into_account (it
);
26497 it
->nglyphs
= width
;
26500 /* Get information about special display element WHAT in an
26501 environment described by IT. WHAT is one of IT_TRUNCATION or
26502 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
26503 non-null glyph_row member. This function ensures that fields like
26504 face_id, c, len of IT are left untouched. */
26507 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
26514 temp_it
.object
= Qnil
;
26515 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
26517 if (what
== IT_CONTINUATION
)
26519 /* Continuation glyph. For R2L lines, we mirror it by hand. */
26520 if (it
->bidi_it
.paragraph_dir
== R2L
)
26521 SET_GLYPH_FROM_CHAR (glyph
, '/');
26523 SET_GLYPH_FROM_CHAR (glyph
, '\\');
26525 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26527 /* FIXME: Should we mirror GC for R2L lines? */
26528 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26529 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26532 else if (what
== IT_TRUNCATION
)
26534 /* Truncation glyph. */
26535 SET_GLYPH_FROM_CHAR (glyph
, '$');
26537 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26539 /* FIXME: Should we mirror GC for R2L lines? */
26540 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26541 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26547 #ifdef HAVE_WINDOW_SYSTEM
26548 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
26549 is turned off, we precede the truncation/continuation glyphs by a
26550 stretch glyph whose width is computed such that these special
26551 glyphs are aligned at the window margin, even when very different
26552 fonts are used in different glyph rows. */
26553 if (FRAME_WINDOW_P (temp_it
.f
)
26554 /* init_iterator calls this with it->glyph_row == NULL, and it
26555 wants only the pixel width of the truncation/continuation
26557 && temp_it
.glyph_row
26558 /* insert_left_trunc_glyphs calls us at the beginning of the
26559 row, and it has its own calculation of the stretch glyph
26561 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
26562 && (temp_it
.glyph_row
->reversed_p
26563 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
26564 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
26566 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
26568 if (stretch_width
> 0)
26570 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
26571 struct font
*font
=
26572 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
26573 int stretch_ascent
=
26574 (((temp_it
.ascent
+ temp_it
.descent
)
26575 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
26577 append_stretch_glyph (&temp_it
, Qnil
, stretch_width
,
26578 temp_it
.ascent
+ temp_it
.descent
,
26585 temp_it
.what
= IT_CHARACTER
;
26586 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
26587 temp_it
.face_id
= GLYPH_FACE (glyph
);
26588 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
26590 PRODUCE_GLYPHS (&temp_it
);
26591 it
->pixel_width
= temp_it
.pixel_width
;
26592 it
->nglyphs
= temp_it
.nglyphs
;
26595 #ifdef HAVE_WINDOW_SYSTEM
26597 /* Calculate line-height and line-spacing properties.
26598 An integer value specifies explicit pixel value.
26599 A float value specifies relative value to current face height.
26600 A cons (float . face-name) specifies relative value to
26601 height of specified face font.
26603 Returns height in pixels, or nil. */
26606 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
26607 int boff
, bool override
)
26609 Lisp_Object face_name
= Qnil
;
26610 int ascent
, descent
, height
;
26612 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
26617 face_name
= XCAR (val
);
26619 if (!NUMBERP (val
))
26620 val
= make_number (1);
26621 if (NILP (face_name
))
26623 height
= it
->ascent
+ it
->descent
;
26628 if (NILP (face_name
))
26630 font
= FRAME_FONT (it
->f
);
26631 boff
= FRAME_BASELINE_OFFSET (it
->f
);
26633 else if (EQ (face_name
, Qt
))
26642 face_id
= lookup_named_face (it
->f
, face_name
, false);
26644 return make_number (-1);
26646 face
= FACE_FROM_ID (it
->f
, face_id
);
26649 return make_number (-1);
26650 boff
= font
->baseline_offset
;
26651 if (font
->vertical_centering
)
26652 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26655 normal_char_ascent_descent (font
, -1, &ascent
, &descent
);
26659 it
->override_ascent
= ascent
;
26660 it
->override_descent
= descent
;
26661 it
->override_boff
= boff
;
26664 height
= ascent
+ descent
;
26668 height
= (int)(XFLOAT_DATA (val
) * height
);
26669 else if (INTEGERP (val
))
26670 height
*= XINT (val
);
26672 return make_number (height
);
26676 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
26677 is a face ID to be used for the glyph. FOR_NO_FONT is true if
26678 and only if this is for a character for which no font was found.
26680 If the display method (it->glyphless_method) is
26681 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
26682 length of the acronym or the hexadecimal string, UPPER_XOFF and
26683 UPPER_YOFF are pixel offsets for the upper part of the string,
26684 LOWER_XOFF and LOWER_YOFF are for the lower part.
26686 For the other display methods, LEN through LOWER_YOFF are zero. */
26689 append_glyphless_glyph (struct it
*it
, int face_id
, bool for_no_font
, int len
,
26690 short upper_xoff
, short upper_yoff
,
26691 short lower_xoff
, short lower_yoff
)
26693 struct glyph
*glyph
;
26694 enum glyph_row_area area
= it
->area
;
26696 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26697 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26699 /* If the glyph row is reversed, we need to prepend the glyph
26700 rather than append it. */
26701 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26705 /* Make room for the additional glyph. */
26706 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26708 glyph
= it
->glyph_row
->glyphs
[area
];
26710 glyph
->charpos
= CHARPOS (it
->position
);
26711 glyph
->object
= it
->object
;
26712 glyph
->pixel_width
= it
->pixel_width
;
26713 glyph
->ascent
= it
->ascent
;
26714 glyph
->descent
= it
->descent
;
26715 glyph
->voffset
= it
->voffset
;
26716 glyph
->type
= GLYPHLESS_GLYPH
;
26717 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
26718 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
26719 glyph
->u
.glyphless
.len
= len
;
26720 glyph
->u
.glyphless
.ch
= it
->c
;
26721 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
26722 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
26723 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
26724 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
26725 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26726 glyph
->multibyte_p
= it
->multibyte_p
;
26727 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26729 /* In R2L rows, the left and the right box edges need to be
26730 drawn in reverse direction. */
26731 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26732 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26736 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26737 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26739 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
26740 || it
->phys_descent
> it
->descent
);
26741 glyph
->padding_p
= false;
26742 glyph
->glyph_not_available_p
= false;
26743 glyph
->face_id
= face_id
;
26744 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26747 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26748 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26749 glyph
->bidi_type
= it
->bidi_it
.type
;
26751 ++it
->glyph_row
->used
[area
];
26754 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26758 /* Produce a glyph for a glyphless character for iterator IT.
26759 IT->glyphless_method specifies which method to use for displaying
26760 the character. See the description of enum
26761 glyphless_display_method in dispextern.h for the detail.
26763 FOR_NO_FONT is true if and only if this is for a character for
26764 which no font was found. ACRONYM, if non-nil, is an acronym string
26765 for the character. */
26768 produce_glyphless_glyph (struct it
*it
, bool for_no_font
, Lisp_Object acronym
)
26773 int base_width
, base_height
, width
, height
;
26774 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26777 /* Get the metrics of the base font. We always refer to the current
26779 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26780 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26781 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
26782 it
->ascent
+= font
->baseline_offset
;
26783 it
->descent
-= font
->baseline_offset
;
26784 base_height
= it
->ascent
+ it
->descent
;
26785 base_width
= font
->average_width
;
26787 face_id
= merge_glyphless_glyph_face (it
);
26789 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26791 it
->pixel_width
= THIN_SPACE_WIDTH
;
26793 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26795 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26797 width
= CHAR_WIDTH (it
->c
);
26800 else if (width
> 4)
26802 it
->pixel_width
= base_width
* width
;
26804 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26810 unsigned int code
[6];
26812 int ascent
, descent
;
26813 struct font_metrics metrics_upper
, metrics_lower
;
26815 face
= FACE_FROM_ID (it
->f
, face_id
);
26816 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26817 prepare_face_for_display (it
->f
, face
);
26819 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26821 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26822 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26823 if (CONSP (acronym
))
26824 acronym
= XCAR (acronym
);
26825 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26829 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26830 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
+ 0u);
26833 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
26834 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26835 upper_len
= (len
+ 1) / 2;
26836 font
->driver
->text_extents (font
, code
, upper_len
,
26838 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26843 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26844 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26845 upper_xoff
= upper_yoff
= 2; /* the typical case */
26846 if (base_width
>= width
)
26848 /* Align the upper to the left, the lower to the right. */
26849 it
->pixel_width
= base_width
;
26850 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26854 /* Center the shorter one. */
26855 it
->pixel_width
= width
;
26856 if (metrics_upper
.width
>= metrics_lower
.width
)
26857 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26860 /* FIXME: This code doesn't look right. It formerly was
26861 missing the "lower_xoff = 0;", which couldn't have
26862 been right since it left lower_xoff uninitialized. */
26864 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26868 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26869 top, bottom, and between upper and lower strings. */
26870 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26871 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26872 /* Center vertically.
26873 H:base_height, D:base_descent
26874 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26876 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26877 descent = D - H/2 + h/2;
26878 lower_yoff = descent - 2 - ld;
26879 upper_yoff = lower_yoff - la - 1 - ud; */
26880 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26881 descent
= it
->descent
- (base_height
- height
) / 2;
26882 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26883 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26884 - metrics_upper
.descent
);
26885 /* Don't make the height shorter than the base height. */
26886 if (height
> base_height
)
26888 it
->ascent
= ascent
;
26889 it
->descent
= descent
;
26893 it
->phys_ascent
= it
->ascent
;
26894 it
->phys_descent
= it
->descent
;
26896 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26897 upper_xoff
, upper_yoff
,
26898 lower_xoff
, lower_yoff
);
26900 take_vertical_position_into_account (it
);
26905 Produce glyphs/get display metrics for the display element IT is
26906 loaded with. See the description of struct it in dispextern.h
26907 for an overview of struct it. */
26910 x_produce_glyphs (struct it
*it
)
26912 int extra_line_spacing
= it
->extra_line_spacing
;
26914 it
->glyph_not_available_p
= false;
26916 if (it
->what
== IT_CHARACTER
)
26919 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26920 struct font
*font
= face
->font
;
26921 struct font_metrics
*pcm
= NULL
;
26922 int boff
; /* Baseline offset. */
26926 /* When no suitable font is found, display this character by
26927 the method specified in the first extra slot of
26928 Vglyphless_char_display. */
26929 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26931 eassert (it
->what
== IT_GLYPHLESS
);
26932 produce_glyphless_glyph (it
, true,
26933 STRINGP (acronym
) ? acronym
: Qnil
);
26937 boff
= font
->baseline_offset
;
26938 if (font
->vertical_centering
)
26939 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26941 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26945 if (it
->override_ascent
>= 0)
26947 it
->ascent
= it
->override_ascent
;
26948 it
->descent
= it
->override_descent
;
26949 boff
= it
->override_boff
;
26953 it
->ascent
= FONT_BASE (font
) + boff
;
26954 it
->descent
= FONT_DESCENT (font
) - boff
;
26957 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
26959 pcm
= get_per_char_metric (font
, &char2b
);
26960 if (pcm
->width
== 0
26961 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26967 it
->phys_ascent
= pcm
->ascent
+ boff
;
26968 it
->phys_descent
= pcm
->descent
- boff
;
26969 it
->pixel_width
= pcm
->width
;
26970 /* Don't use font-global values for ascent and descent
26971 if they result in an exceedingly large line height. */
26972 if (it
->override_ascent
< 0)
26974 if (FONT_TOO_HIGH (font
))
26976 it
->ascent
= it
->phys_ascent
;
26977 it
->descent
= it
->phys_descent
;
26978 /* These limitations are enforced by an
26979 assertion near the end of this function. */
26980 if (it
->ascent
< 0)
26982 if (it
->descent
< 0)
26989 it
->glyph_not_available_p
= true;
26990 it
->phys_ascent
= it
->ascent
;
26991 it
->phys_descent
= it
->descent
;
26992 it
->pixel_width
= font
->space_width
;
26995 if (it
->constrain_row_ascent_descent_p
)
26997 if (it
->descent
> it
->max_descent
)
26999 it
->ascent
+= it
->descent
- it
->max_descent
;
27000 it
->descent
= it
->max_descent
;
27002 if (it
->ascent
> it
->max_ascent
)
27004 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
27005 it
->ascent
= it
->max_ascent
;
27007 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
27008 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
27009 extra_line_spacing
= 0;
27012 /* If this is a space inside a region of text with
27013 `space-width' property, change its width. */
27015 = it
->char_to_display
== ' ' && !NILP (it
->space_width
);
27017 it
->pixel_width
*= XFLOATINT (it
->space_width
);
27019 /* If face has a box, add the box thickness to the character
27020 height. If character has a box line to the left and/or
27021 right, add the box line width to the character's width. */
27022 if (face
->box
!= FACE_NO_BOX
)
27024 int thick
= face
->box_line_width
;
27028 it
->ascent
+= thick
;
27029 it
->descent
+= thick
;
27034 if (it
->start_of_box_run_p
)
27035 it
->pixel_width
+= thick
;
27036 if (it
->end_of_box_run_p
)
27037 it
->pixel_width
+= thick
;
27040 /* If face has an overline, add the height of the overline
27041 (1 pixel) and a 1 pixel margin to the character height. */
27042 if (face
->overline_p
)
27043 it
->ascent
+= overline_margin
;
27045 if (it
->constrain_row_ascent_descent_p
)
27047 if (it
->ascent
> it
->max_ascent
)
27048 it
->ascent
= it
->max_ascent
;
27049 if (it
->descent
> it
->max_descent
)
27050 it
->descent
= it
->max_descent
;
27053 take_vertical_position_into_account (it
);
27055 /* If we have to actually produce glyphs, do it. */
27060 /* Translate a space with a `space-width' property
27061 into a stretch glyph. */
27062 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
27063 / FONT_HEIGHT (font
));
27064 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
27065 it
->ascent
+ it
->descent
, ascent
);
27070 /* If characters with lbearing or rbearing are displayed
27071 in this line, record that fact in a flag of the
27072 glyph row. This is used to optimize X output code. */
27073 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
27074 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27076 if (! stretched_p
&& it
->pixel_width
== 0)
27077 /* We assure that all visible glyphs have at least 1-pixel
27079 it
->pixel_width
= 1;
27081 else if (it
->char_to_display
== '\n')
27083 /* A newline has no width, but we need the height of the
27084 line. But if previous part of the line sets a height,
27085 don't increase that height. */
27087 Lisp_Object height
;
27088 Lisp_Object total_height
= Qnil
;
27090 it
->override_ascent
= -1;
27091 it
->pixel_width
= 0;
27094 height
= get_it_property (it
, Qline_height
);
27095 /* Split (line-height total-height) list. */
27097 && CONSP (XCDR (height
))
27098 && NILP (XCDR (XCDR (height
))))
27100 total_height
= XCAR (XCDR (height
));
27101 height
= XCAR (height
);
27103 height
= calc_line_height_property (it
, height
, font
, boff
, true);
27105 if (it
->override_ascent
>= 0)
27107 it
->ascent
= it
->override_ascent
;
27108 it
->descent
= it
->override_descent
;
27109 boff
= it
->override_boff
;
27113 if (FONT_TOO_HIGH (font
))
27115 it
->ascent
= font
->pixel_size
+ boff
- 1;
27116 it
->descent
= -boff
+ 1;
27117 if (it
->descent
< 0)
27122 it
->ascent
= FONT_BASE (font
) + boff
;
27123 it
->descent
= FONT_DESCENT (font
) - boff
;
27127 if (EQ (height
, Qt
))
27129 if (it
->descent
> it
->max_descent
)
27131 it
->ascent
+= it
->descent
- it
->max_descent
;
27132 it
->descent
= it
->max_descent
;
27134 if (it
->ascent
> it
->max_ascent
)
27136 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
27137 it
->ascent
= it
->max_ascent
;
27139 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
27140 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
27141 it
->constrain_row_ascent_descent_p
= true;
27142 extra_line_spacing
= 0;
27146 Lisp_Object spacing
;
27148 it
->phys_ascent
= it
->ascent
;
27149 it
->phys_descent
= it
->descent
;
27151 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
27152 && face
->box
!= FACE_NO_BOX
27153 && face
->box_line_width
> 0)
27155 it
->ascent
+= face
->box_line_width
;
27156 it
->descent
+= face
->box_line_width
;
27159 && XINT (height
) > it
->ascent
+ it
->descent
)
27160 it
->ascent
= XINT (height
) - it
->descent
;
27162 if (!NILP (total_height
))
27163 spacing
= calc_line_height_property (it
, total_height
, font
,
27167 spacing
= get_it_property (it
, Qline_spacing
);
27168 spacing
= calc_line_height_property (it
, spacing
, font
,
27171 if (INTEGERP (spacing
))
27173 extra_line_spacing
= XINT (spacing
);
27174 if (!NILP (total_height
))
27175 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
27179 else /* i.e. (it->char_to_display == '\t') */
27181 if (font
->space_width
> 0)
27183 int tab_width
= it
->tab_width
* font
->space_width
;
27184 int x
= it
->current_x
+ it
->continuation_lines_width
;
27185 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
27187 /* If the distance from the current position to the next tab
27188 stop is less than a space character width, use the
27189 tab stop after that. */
27190 if (next_tab_x
- x
< font
->space_width
)
27191 next_tab_x
+= tab_width
;
27193 it
->pixel_width
= next_tab_x
- x
;
27195 if (FONT_TOO_HIGH (font
))
27197 if (get_char_glyph_code (' ', font
, &char2b
))
27199 pcm
= get_per_char_metric (font
, &char2b
);
27200 if (pcm
->width
== 0
27201 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
27207 it
->ascent
= pcm
->ascent
+ boff
;
27208 it
->descent
= pcm
->descent
- boff
;
27212 it
->ascent
= font
->pixel_size
+ boff
- 1;
27213 it
->descent
= -boff
+ 1;
27215 if (it
->ascent
< 0)
27217 if (it
->descent
< 0)
27222 it
->ascent
= FONT_BASE (font
) + boff
;
27223 it
->descent
= FONT_DESCENT (font
) - boff
;
27225 it
->phys_ascent
= it
->ascent
;
27226 it
->phys_descent
= it
->descent
;
27230 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
27231 it
->ascent
+ it
->descent
, it
->ascent
);
27236 it
->pixel_width
= 0;
27241 if (FONT_TOO_HIGH (font
))
27243 int font_ascent
, font_descent
;
27245 /* For very large fonts, where we ignore the declared font
27246 dimensions, and go by per-character metrics instead,
27247 don't let the row ascent and descent values (and the row
27248 height computed from them) be smaller than the "normal"
27249 character metrics. This avoids unpleasant effects
27250 whereby lines on display would change their height
27251 depending on which characters are shown. */
27252 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
27253 it
->max_ascent
= max (it
->max_ascent
, font_ascent
);
27254 it
->max_descent
= max (it
->max_descent
, font_descent
);
27257 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
27259 /* A static composition.
27261 Note: A composition is represented as one glyph in the
27262 glyph matrix. There are no padding glyphs.
27264 Important note: pixel_width, ascent, and descent are the
27265 values of what is drawn by draw_glyphs (i.e. the values of
27266 the overall glyphs composed). */
27267 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27268 int boff
; /* baseline offset */
27269 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
27270 int glyph_len
= cmp
->glyph_len
;
27271 struct font
*font
= face
->font
;
27275 /* If we have not yet calculated pixel size data of glyphs of
27276 the composition for the current face font, calculate them
27277 now. Theoretically, we have to check all fonts for the
27278 glyphs, but that requires much time and memory space. So,
27279 here we check only the font of the first glyph. This may
27280 lead to incorrect display, but it's very rare, and C-l
27281 (recenter-top-bottom) can correct the display anyway. */
27282 if (! cmp
->font
|| cmp
->font
!= font
)
27284 /* Ascent and descent of the font of the first character
27285 of this composition (adjusted by baseline offset).
27286 Ascent and descent of overall glyphs should not be less
27287 than these, respectively. */
27288 int font_ascent
, font_descent
, font_height
;
27289 /* Bounding box of the overall glyphs. */
27290 int leftmost
, rightmost
, lowest
, highest
;
27291 int lbearing
, rbearing
;
27292 int i
, width
, ascent
, descent
;
27293 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
27295 struct font_metrics
*pcm
;
27298 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
27299 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
27301 bool right_padded
= glyph_len
< cmp
->glyph_len
;
27302 for (i
= 0; i
< glyph_len
; i
++)
27304 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
27306 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
27308 bool left_padded
= i
> 0;
27310 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
27311 : IT_CHARPOS (*it
));
27312 /* If no suitable font is found, use the default font. */
27313 bool font_not_found_p
= font
== NULL
;
27314 if (font_not_found_p
)
27316 face
= face
->ascii_face
;
27319 boff
= font
->baseline_offset
;
27320 if (font
->vertical_centering
)
27321 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
27322 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
27323 font_ascent
+= boff
;
27324 font_descent
-= boff
;
27325 font_height
= font_ascent
+ font_descent
;
27330 if (! font_not_found_p
)
27332 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
27334 pcm
= get_per_char_metric (font
, &char2b
);
27337 /* Initialize the bounding box. */
27340 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
27341 ascent
= pcm
->ascent
;
27342 descent
= pcm
->descent
;
27343 lbearing
= pcm
->lbearing
;
27344 rbearing
= pcm
->rbearing
;
27348 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
27349 ascent
= FONT_BASE (font
);
27350 descent
= FONT_DESCENT (font
);
27357 lowest
= - descent
+ boff
;
27358 highest
= ascent
+ boff
;
27360 if (! font_not_found_p
27361 && font
->default_ascent
27362 && CHAR_TABLE_P (Vuse_default_ascent
)
27363 && !NILP (Faref (Vuse_default_ascent
,
27364 make_number (it
->char_to_display
))))
27365 highest
= font
->default_ascent
+ boff
;
27367 /* Draw the first glyph at the normal position. It may be
27368 shifted to right later if some other glyphs are drawn
27370 cmp
->offsets
[i
* 2] = 0;
27371 cmp
->offsets
[i
* 2 + 1] = boff
;
27372 cmp
->lbearing
= lbearing
;
27373 cmp
->rbearing
= rbearing
;
27375 /* Set cmp->offsets for the remaining glyphs. */
27376 for (i
++; i
< glyph_len
; i
++)
27378 int left
, right
, btm
, top
;
27379 int ch
= COMPOSITION_GLYPH (cmp
, i
);
27381 struct face
*this_face
;
27385 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
27386 this_face
= FACE_FROM_ID (it
->f
, face_id
);
27387 font
= this_face
->font
;
27393 get_char_face_and_encoding (it
->f
, ch
, face_id
,
27395 pcm
= get_per_char_metric (font
, &char2b
);
27398 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
27401 width
= pcm
->width
;
27402 ascent
= pcm
->ascent
;
27403 descent
= pcm
->descent
;
27404 lbearing
= pcm
->lbearing
;
27405 rbearing
= pcm
->rbearing
;
27406 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
27408 /* Relative composition with or without
27409 alternate chars. */
27410 left
= (leftmost
+ rightmost
- width
) / 2;
27411 btm
= - descent
+ boff
;
27412 if (font
->relative_compose
27413 && (! CHAR_TABLE_P (Vignore_relative_composition
)
27414 || NILP (Faref (Vignore_relative_composition
,
27415 make_number (ch
)))))
27418 if (- descent
>= font
->relative_compose
)
27419 /* One extra pixel between two glyphs. */
27421 else if (ascent
<= 0)
27422 /* One extra pixel between two glyphs. */
27423 btm
= lowest
- 1 - ascent
- descent
;
27428 /* A composition rule is specified by an integer
27429 value that encodes global and new reference
27430 points (GREF and NREF). GREF and NREF are
27431 specified by numbers as below:
27433 0---1---2 -- ascent
27437 9--10--11 -- center
27439 ---3---4---5--- baseline
27441 6---7---8 -- descent
27443 int rule
= COMPOSITION_RULE (cmp
, i
);
27444 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
27446 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
27447 grefx
= gref
% 3, nrefx
= nref
% 3;
27448 grefy
= gref
/ 3, nrefy
= nref
/ 3;
27450 xoff
= font_height
* (xoff
- 128) / 256;
27452 yoff
= font_height
* (yoff
- 128) / 256;
27455 + grefx
* (rightmost
- leftmost
) / 2
27456 - nrefx
* width
/ 2
27459 btm
= ((grefy
== 0 ? highest
27461 : grefy
== 2 ? lowest
27462 : (highest
+ lowest
) / 2)
27463 - (nrefy
== 0 ? ascent
+ descent
27464 : nrefy
== 1 ? descent
- boff
27466 : (ascent
+ descent
) / 2)
27470 cmp
->offsets
[i
* 2] = left
;
27471 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
27473 /* Update the bounding box of the overall glyphs. */
27476 right
= left
+ width
;
27477 if (left
< leftmost
)
27479 if (right
> rightmost
)
27482 top
= btm
+ descent
+ ascent
;
27488 if (cmp
->lbearing
> left
+ lbearing
)
27489 cmp
->lbearing
= left
+ lbearing
;
27490 if (cmp
->rbearing
< left
+ rbearing
)
27491 cmp
->rbearing
= left
+ rbearing
;
27495 /* If there are glyphs whose x-offsets are negative,
27496 shift all glyphs to the right and make all x-offsets
27500 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27501 cmp
->offsets
[i
* 2] -= leftmost
;
27502 rightmost
-= leftmost
;
27503 cmp
->lbearing
-= leftmost
;
27504 cmp
->rbearing
-= leftmost
;
27507 if (left_padded
&& cmp
->lbearing
< 0)
27509 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27510 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
27511 rightmost
-= cmp
->lbearing
;
27512 cmp
->rbearing
-= cmp
->lbearing
;
27515 if (right_padded
&& rightmost
< cmp
->rbearing
)
27517 rightmost
= cmp
->rbearing
;
27520 cmp
->pixel_width
= rightmost
;
27521 cmp
->ascent
= highest
;
27522 cmp
->descent
= - lowest
;
27523 if (cmp
->ascent
< font_ascent
)
27524 cmp
->ascent
= font_ascent
;
27525 if (cmp
->descent
< font_descent
)
27526 cmp
->descent
= font_descent
;
27530 && (cmp
->lbearing
< 0
27531 || cmp
->rbearing
> cmp
->pixel_width
))
27532 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27534 it
->pixel_width
= cmp
->pixel_width
;
27535 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
27536 it
->descent
= it
->phys_descent
= cmp
->descent
;
27537 if (face
->box
!= FACE_NO_BOX
)
27539 int thick
= face
->box_line_width
;
27543 it
->ascent
+= thick
;
27544 it
->descent
+= thick
;
27549 if (it
->start_of_box_run_p
)
27550 it
->pixel_width
+= thick
;
27551 if (it
->end_of_box_run_p
)
27552 it
->pixel_width
+= thick
;
27555 /* If face has an overline, add the height of the overline
27556 (1 pixel) and a 1 pixel margin to the character height. */
27557 if (face
->overline_p
)
27558 it
->ascent
+= overline_margin
;
27560 take_vertical_position_into_account (it
);
27561 if (it
->ascent
< 0)
27563 if (it
->descent
< 0)
27566 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
27567 append_composite_glyph (it
);
27569 else if (it
->what
== IT_COMPOSITION
)
27571 /* A dynamic (automatic) composition. */
27572 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27573 Lisp_Object gstring
;
27574 struct font_metrics metrics
;
27578 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
27580 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
27583 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
27584 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27585 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
27586 it
->descent
= it
->phys_descent
= metrics
.descent
;
27587 if (face
->box
!= FACE_NO_BOX
)
27589 int thick
= face
->box_line_width
;
27593 it
->ascent
+= thick
;
27594 it
->descent
+= thick
;
27599 if (it
->start_of_box_run_p
)
27600 it
->pixel_width
+= thick
;
27601 if (it
->end_of_box_run_p
)
27602 it
->pixel_width
+= thick
;
27604 /* If face has an overline, add the height of the overline
27605 (1 pixel) and a 1 pixel margin to the character height. */
27606 if (face
->overline_p
)
27607 it
->ascent
+= overline_margin
;
27608 take_vertical_position_into_account (it
);
27609 if (it
->ascent
< 0)
27611 if (it
->descent
< 0)
27615 append_composite_glyph (it
);
27617 else if (it
->what
== IT_GLYPHLESS
)
27618 produce_glyphless_glyph (it
, false, Qnil
);
27619 else if (it
->what
== IT_IMAGE
)
27620 produce_image_glyph (it
);
27621 else if (it
->what
== IT_STRETCH
)
27622 produce_stretch_glyph (it
);
27623 else if (it
->what
== IT_XWIDGET
)
27624 produce_xwidget_glyph (it
);
27627 /* Accumulate dimensions. Note: can't assume that it->descent > 0
27628 because this isn't true for images with `:ascent 100'. */
27629 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
27630 if (it
->area
== TEXT_AREA
)
27631 it
->current_x
+= it
->pixel_width
;
27633 if (extra_line_spacing
> 0)
27635 it
->descent
+= extra_line_spacing
;
27636 if (extra_line_spacing
> it
->max_extra_line_spacing
)
27637 it
->max_extra_line_spacing
= extra_line_spacing
;
27640 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
27641 it
->max_descent
= max (it
->max_descent
, it
->descent
);
27642 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
27643 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
27647 Output LEN glyphs starting at START at the nominal cursor position.
27648 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
27649 being updated, and UPDATED_AREA is the area of that row being updated. */
27652 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27653 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27655 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
27657 eassert (updated_row
);
27658 /* When the window is hscrolled, cursor hpos can legitimately be out
27659 of bounds, but we draw the cursor at the corresponding window
27660 margin in that case. */
27661 if (!updated_row
->reversed_p
&& chpos
< 0)
27663 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
27664 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
27668 /* Write glyphs. */
27670 hpos
= start
- updated_row
->glyphs
[updated_area
];
27671 x
= draw_glyphs (w
, w
->output_cursor
.x
,
27672 updated_row
, updated_area
,
27674 DRAW_NORMAL_TEXT
, 0);
27676 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
27677 if (updated_area
== TEXT_AREA
27678 && w
->phys_cursor_on_p
27679 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
27681 && chpos
< hpos
+ len
)
27682 w
->phys_cursor_on_p
= false;
27686 /* Advance the output cursor. */
27687 w
->output_cursor
.hpos
+= len
;
27688 w
->output_cursor
.x
= x
;
27693 Insert LEN glyphs from START at the nominal cursor position. */
27696 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27697 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27700 int line_height
, shift_by_width
, shifted_region_width
;
27701 struct glyph_row
*row
;
27702 struct glyph
*glyph
;
27703 int frame_x
, frame_y
;
27706 eassert (updated_row
);
27708 f
= XFRAME (WINDOW_FRAME (w
));
27710 /* Get the height of the line we are in. */
27712 line_height
= row
->height
;
27714 /* Get the width of the glyphs to insert. */
27715 shift_by_width
= 0;
27716 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
27717 shift_by_width
+= glyph
->pixel_width
;
27719 /* Get the width of the region to shift right. */
27720 shifted_region_width
= (window_box_width (w
, updated_area
)
27721 - w
->output_cursor
.x
27725 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
27726 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
27728 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
27729 line_height
, shift_by_width
);
27731 /* Write the glyphs. */
27732 hpos
= start
- row
->glyphs
[updated_area
];
27733 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
27735 DRAW_NORMAL_TEXT
, 0);
27737 /* Advance the output cursor. */
27738 w
->output_cursor
.hpos
+= len
;
27739 w
->output_cursor
.x
+= shift_by_width
;
27745 Erase the current text line from the nominal cursor position
27746 (inclusive) to pixel column TO_X (exclusive). The idea is that
27747 everything from TO_X onward is already erased.
27749 TO_X is a pixel position relative to UPDATED_AREA of currently
27750 updated window W. TO_X == -1 means clear to the end of this area. */
27753 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
27754 enum glyph_row_area updated_area
, int to_x
)
27757 int max_x
, min_y
, max_y
;
27758 int from_x
, from_y
, to_y
;
27760 eassert (updated_row
);
27761 f
= XFRAME (w
->frame
);
27763 if (updated_row
->full_width_p
)
27764 max_x
= (WINDOW_PIXEL_WIDTH (w
)
27765 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
27767 max_x
= window_box_width (w
, updated_area
);
27768 max_y
= window_text_bottom_y (w
);
27770 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
27771 of window. For TO_X > 0, truncate to end of drawing area. */
27777 to_x
= min (to_x
, max_x
);
27779 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
27781 /* Notice if the cursor will be cleared by this operation. */
27782 if (!updated_row
->full_width_p
)
27783 notice_overwritten_cursor (w
, updated_area
,
27784 w
->output_cursor
.x
, -1,
27786 MATRIX_ROW_BOTTOM_Y (updated_row
));
27788 from_x
= w
->output_cursor
.x
;
27790 /* Translate to frame coordinates. */
27791 if (updated_row
->full_width_p
)
27793 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
27794 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
27798 int area_left
= window_box_left (w
, updated_area
);
27799 from_x
+= area_left
;
27803 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
27804 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
27805 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
27807 /* Prevent inadvertently clearing to end of the X window. */
27808 if (to_x
> from_x
&& to_y
> from_y
)
27811 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
27812 to_x
- from_x
, to_y
- from_y
);
27817 #endif /* HAVE_WINDOW_SYSTEM */
27821 /***********************************************************************
27823 ***********************************************************************/
27825 /* Value is the internal representation of the specified cursor type
27826 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27827 of the bar cursor. */
27829 static enum text_cursor_kinds
27830 get_specified_cursor_type (Lisp_Object arg
, int *width
)
27832 enum text_cursor_kinds type
;
27837 if (EQ (arg
, Qbox
))
27838 return FILLED_BOX_CURSOR
;
27840 if (EQ (arg
, Qhollow
))
27841 return HOLLOW_BOX_CURSOR
;
27843 if (EQ (arg
, Qbar
))
27850 && EQ (XCAR (arg
), Qbar
)
27851 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27853 *width
= XINT (XCDR (arg
));
27857 if (EQ (arg
, Qhbar
))
27860 return HBAR_CURSOR
;
27864 && EQ (XCAR (arg
), Qhbar
)
27865 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27867 *width
= XINT (XCDR (arg
));
27868 return HBAR_CURSOR
;
27871 /* Treat anything unknown as "hollow box cursor".
27872 It was bad to signal an error; people have trouble fixing
27873 .Xdefaults with Emacs, when it has something bad in it. */
27874 type
= HOLLOW_BOX_CURSOR
;
27879 /* Set the default cursor types for specified frame. */
27881 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27886 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27887 FRAME_CURSOR_WIDTH (f
) = width
;
27889 /* By default, set up the blink-off state depending on the on-state. */
27891 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27894 FRAME_BLINK_OFF_CURSOR (f
)
27895 = get_specified_cursor_type (XCDR (tem
), &width
);
27896 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27899 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27901 /* Make sure the cursor gets redrawn. */
27902 f
->cursor_type_changed
= true;
27906 #ifdef HAVE_WINDOW_SYSTEM
27908 /* Return the cursor we want to be displayed in window W. Return
27909 width of bar/hbar cursor through WIDTH arg. Return with
27910 ACTIVE_CURSOR arg set to true if cursor in window W is `active'
27911 (i.e. if the `system caret' should track this cursor).
27913 In a mini-buffer window, we want the cursor only to appear if we
27914 are reading input from this window. For the selected window, we
27915 want the cursor type given by the frame parameter or buffer local
27916 setting of cursor-type. If explicitly marked off, draw no cursor.
27917 In all other cases, we want a hollow box cursor. */
27919 static enum text_cursor_kinds
27920 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27921 bool *active_cursor
)
27923 struct frame
*f
= XFRAME (w
->frame
);
27924 struct buffer
*b
= XBUFFER (w
->contents
);
27925 int cursor_type
= DEFAULT_CURSOR
;
27926 Lisp_Object alt_cursor
;
27927 bool non_selected
= false;
27929 *active_cursor
= true;
27932 if (cursor_in_echo_area
27933 && FRAME_HAS_MINIBUF_P (f
)
27934 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27936 if (w
== XWINDOW (echo_area_window
))
27938 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27940 *width
= FRAME_CURSOR_WIDTH (f
);
27941 return FRAME_DESIRED_CURSOR (f
);
27944 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27947 *active_cursor
= false;
27948 non_selected
= true;
27951 /* Detect a nonselected window or nonselected frame. */
27952 else if (w
!= XWINDOW (f
->selected_window
)
27953 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
27955 *active_cursor
= false;
27957 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
27960 non_selected
= true;
27963 /* Never display a cursor in a window in which cursor-type is nil. */
27964 if (NILP (BVAR (b
, cursor_type
)))
27967 /* Get the normal cursor type for this window. */
27968 if (EQ (BVAR (b
, cursor_type
), Qt
))
27970 cursor_type
= FRAME_DESIRED_CURSOR (f
);
27971 *width
= FRAME_CURSOR_WIDTH (f
);
27974 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27976 /* Use cursor-in-non-selected-windows instead
27977 for non-selected window or frame. */
27980 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
27981 if (!EQ (Qt
, alt_cursor
))
27982 return get_specified_cursor_type (alt_cursor
, width
);
27983 /* t means modify the normal cursor type. */
27984 if (cursor_type
== FILLED_BOX_CURSOR
)
27985 cursor_type
= HOLLOW_BOX_CURSOR
;
27986 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
27988 return cursor_type
;
27991 /* Use normal cursor if not blinked off. */
27992 if (!w
->cursor_off_p
)
27994 if (glyph
!= NULL
&& glyph
->type
== XWIDGET_GLYPH
)
27996 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27998 if (cursor_type
== FILLED_BOX_CURSOR
)
28000 /* Using a block cursor on large images can be very annoying.
28001 So use a hollow cursor for "large" images.
28002 If image is not transparent (no mask), also use hollow cursor. */
28003 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
28004 if (img
!= NULL
&& IMAGEP (img
->spec
))
28006 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
28007 where N = size of default frame font size.
28008 This should cover most of the "tiny" icons people may use. */
28010 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
28011 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
28012 cursor_type
= HOLLOW_BOX_CURSOR
;
28015 else if (cursor_type
!= NO_CURSOR
)
28017 /* Display current only supports BOX and HOLLOW cursors for images.
28018 So for now, unconditionally use a HOLLOW cursor when cursor is
28019 not a solid box cursor. */
28020 cursor_type
= HOLLOW_BOX_CURSOR
;
28023 return cursor_type
;
28026 /* Cursor is blinked off, so determine how to "toggle" it. */
28028 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
28029 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
28030 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
28032 /* Then see if frame has specified a specific blink off cursor type. */
28033 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
28035 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
28036 return FRAME_BLINK_OFF_CURSOR (f
);
28040 /* Some people liked having a permanently visible blinking cursor,
28041 while others had very strong opinions against it. So it was
28042 decided to remove it. KFS 2003-09-03 */
28044 /* Finally perform built-in cursor blinking:
28045 filled box <-> hollow box
28046 wide [h]bar <-> narrow [h]bar
28047 narrow [h]bar <-> no cursor
28048 other type <-> no cursor */
28050 if (cursor_type
== FILLED_BOX_CURSOR
)
28051 return HOLLOW_BOX_CURSOR
;
28053 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
28056 return cursor_type
;
28064 /* Notice when the text cursor of window W has been completely
28065 overwritten by a drawing operation that outputs glyphs in AREA
28066 starting at X0 and ending at X1 in the line starting at Y0 and
28067 ending at Y1. X coordinates are area-relative. X1 < 0 means all
28068 the rest of the line after X0 has been written. Y coordinates
28069 are window-relative. */
28072 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
28073 int x0
, int x1
, int y0
, int y1
)
28075 int cx0
, cx1
, cy0
, cy1
;
28076 struct glyph_row
*row
;
28078 if (!w
->phys_cursor_on_p
)
28080 if (area
!= TEXT_AREA
)
28083 if (w
->phys_cursor
.vpos
< 0
28084 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
28085 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
28086 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
28089 if (row
->cursor_in_fringe_p
)
28091 row
->cursor_in_fringe_p
= false;
28092 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
28093 w
->phys_cursor_on_p
= false;
28097 cx0
= w
->phys_cursor
.x
;
28098 cx1
= cx0
+ w
->phys_cursor_width
;
28099 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
28102 /* The cursor image will be completely removed from the
28103 screen if the output area intersects the cursor area in
28104 y-direction. When we draw in [y0 y1[, and some part of
28105 the cursor is at y < y0, that part must have been drawn
28106 before. When scrolling, the cursor is erased before
28107 actually scrolling, so we don't come here. When not
28108 scrolling, the rows above the old cursor row must have
28109 changed, and in this case these rows must have written
28110 over the cursor image.
28112 Likewise if part of the cursor is below y1, with the
28113 exception of the cursor being in the first blank row at
28114 the buffer and window end because update_text_area
28115 doesn't draw that row. (Except when it does, but
28116 that's handled in update_text_area.) */
28118 cy0
= w
->phys_cursor
.y
;
28119 cy1
= cy0
+ w
->phys_cursor_height
;
28120 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
28123 w
->phys_cursor_on_p
= false;
28126 #endif /* HAVE_WINDOW_SYSTEM */
28129 /************************************************************************
28131 ************************************************************************/
28133 #ifdef HAVE_WINDOW_SYSTEM
28136 Fix the display of area AREA of overlapping row ROW in window W
28137 with respect to the overlapping part OVERLAPS. */
28140 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
28141 enum glyph_row_area area
, int overlaps
)
28148 for (i
= 0; i
< row
->used
[area
];)
28150 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
28152 int start
= i
, start_x
= x
;
28156 x
+= row
->glyphs
[area
][i
].pixel_width
;
28159 while (i
< row
->used
[area
]
28160 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
28162 draw_glyphs (w
, start_x
, row
, area
,
28164 DRAW_NORMAL_TEXT
, overlaps
);
28168 x
+= row
->glyphs
[area
][i
].pixel_width
;
28178 Draw the cursor glyph of window W in glyph row ROW. See the
28179 comment of draw_glyphs for the meaning of HL. */
28182 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
28183 enum draw_glyphs_face hl
)
28185 /* If cursor hpos is out of bounds, don't draw garbage. This can
28186 happen in mini-buffer windows when switching between echo area
28187 glyphs and mini-buffer. */
28188 if ((row
->reversed_p
28189 ? (w
->phys_cursor
.hpos
>= 0)
28190 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
28192 bool on_p
= w
->phys_cursor_on_p
;
28194 int hpos
= w
->phys_cursor
.hpos
;
28196 /* When the window is hscrolled, cursor hpos can legitimately be
28197 out of bounds, but we draw the cursor at the corresponding
28198 window margin in that case. */
28199 if (!row
->reversed_p
&& hpos
< 0)
28201 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28202 hpos
= row
->used
[TEXT_AREA
] - 1;
28204 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
28206 w
->phys_cursor_on_p
= on_p
;
28208 if (hl
== DRAW_CURSOR
)
28209 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
28210 /* When we erase the cursor, and ROW is overlapped by other
28211 rows, make sure that these overlapping parts of other rows
28213 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
28215 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
28217 if (row
> w
->current_matrix
->rows
28218 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
28219 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
28220 OVERLAPS_ERASED_CURSOR
);
28222 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
28223 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
28224 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
28225 OVERLAPS_ERASED_CURSOR
);
28231 /* Erase the image of a cursor of window W from the screen. */
28234 erase_phys_cursor (struct window
*w
)
28236 struct frame
*f
= XFRAME (w
->frame
);
28237 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28238 int hpos
= w
->phys_cursor
.hpos
;
28239 int vpos
= w
->phys_cursor
.vpos
;
28240 bool mouse_face_here_p
= false;
28241 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
28242 struct glyph_row
*cursor_row
;
28243 struct glyph
*cursor_glyph
;
28244 enum draw_glyphs_face hl
;
28246 /* No cursor displayed or row invalidated => nothing to do on the
28248 if (w
->phys_cursor_type
== NO_CURSOR
)
28249 goto mark_cursor_off
;
28251 /* VPOS >= active_glyphs->nrows means that window has been resized.
28252 Don't bother to erase the cursor. */
28253 if (vpos
>= active_glyphs
->nrows
)
28254 goto mark_cursor_off
;
28256 /* If row containing cursor is marked invalid, there is nothing we
28258 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
28259 if (!cursor_row
->enabled_p
)
28260 goto mark_cursor_off
;
28262 /* If line spacing is > 0, old cursor may only be partially visible in
28263 window after split-window. So adjust visible height. */
28264 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
28265 window_text_bottom_y (w
) - cursor_row
->y
);
28267 /* If row is completely invisible, don't attempt to delete a cursor which
28268 isn't there. This can happen if cursor is at top of a window, and
28269 we switch to a buffer with a header line in that window. */
28270 if (cursor_row
->visible_height
<= 0)
28271 goto mark_cursor_off
;
28273 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
28274 if (cursor_row
->cursor_in_fringe_p
)
28276 cursor_row
->cursor_in_fringe_p
= false;
28277 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
28278 goto mark_cursor_off
;
28281 /* This can happen when the new row is shorter than the old one.
28282 In this case, either draw_glyphs or clear_end_of_line
28283 should have cleared the cursor. Note that we wouldn't be
28284 able to erase the cursor in this case because we don't have a
28285 cursor glyph at hand. */
28286 if ((cursor_row
->reversed_p
28287 ? (w
->phys_cursor
.hpos
< 0)
28288 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
28289 goto mark_cursor_off
;
28291 /* When the window is hscrolled, cursor hpos can legitimately be out
28292 of bounds, but we draw the cursor at the corresponding window
28293 margin in that case. */
28294 if (!cursor_row
->reversed_p
&& hpos
< 0)
28296 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
28297 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
28299 /* If the cursor is in the mouse face area, redisplay that when
28300 we clear the cursor. */
28301 if (! NILP (hlinfo
->mouse_face_window
)
28302 && coords_in_mouse_face_p (w
, hpos
, vpos
)
28303 /* Don't redraw the cursor's spot in mouse face if it is at the
28304 end of a line (on a newline). The cursor appears there, but
28305 mouse highlighting does not. */
28306 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
28307 mouse_face_here_p
= true;
28309 /* Maybe clear the display under the cursor. */
28310 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
28313 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
28316 cursor_glyph
= get_phys_cursor_glyph (w
);
28317 if (cursor_glyph
== NULL
)
28318 goto mark_cursor_off
;
28320 width
= cursor_glyph
->pixel_width
;
28321 x
= w
->phys_cursor
.x
;
28327 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
28328 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
28329 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
28332 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
28335 /* Erase the cursor by redrawing the character underneath it. */
28336 if (mouse_face_here_p
)
28337 hl
= DRAW_MOUSE_FACE
;
28339 hl
= DRAW_NORMAL_TEXT
;
28340 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
28343 w
->phys_cursor_on_p
= false;
28344 w
->phys_cursor_type
= NO_CURSOR
;
28348 /* Display or clear cursor of window W. If !ON, clear the cursor.
28349 If ON, display the cursor; where to put the cursor is specified by
28350 HPOS, VPOS, X and Y. */
28353 display_and_set_cursor (struct window
*w
, bool on
,
28354 int hpos
, int vpos
, int x
, int y
)
28356 struct frame
*f
= XFRAME (w
->frame
);
28357 int new_cursor_type
;
28358 int new_cursor_width
;
28359 bool active_cursor
;
28360 struct glyph_row
*glyph_row
;
28361 struct glyph
*glyph
;
28363 /* This is pointless on invisible frames, and dangerous on garbaged
28364 windows and frames; in the latter case, the frame or window may
28365 be in the midst of changing its size, and x and y may be off the
28367 if (! FRAME_VISIBLE_P (f
)
28368 || FRAME_GARBAGED_P (f
)
28369 || vpos
>= w
->current_matrix
->nrows
28370 || hpos
>= w
->current_matrix
->matrix_w
)
28373 /* If cursor is off and we want it off, return quickly. */
28374 if (!on
&& !w
->phys_cursor_on_p
)
28377 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28378 /* If cursor row is not enabled, we don't really know where to
28379 display the cursor. */
28380 if (!glyph_row
->enabled_p
)
28382 w
->phys_cursor_on_p
= false;
28387 if (!glyph_row
->exact_window_width_line_p
28388 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
28389 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
28391 eassert (input_blocked_p ());
28393 /* Set new_cursor_type to the cursor we want to be displayed. */
28394 new_cursor_type
= get_window_cursor_type (w
, glyph
,
28395 &new_cursor_width
, &active_cursor
);
28397 /* If cursor is currently being shown and we don't want it to be or
28398 it is in the wrong place, or the cursor type is not what we want,
28400 if (w
->phys_cursor_on_p
28402 || w
->phys_cursor
.x
!= x
28403 || w
->phys_cursor
.y
!= y
28404 /* HPOS can be negative in R2L rows whose
28405 exact_window_width_line_p flag is set (i.e. their newline
28406 would "overflow into the fringe"). */
28408 || new_cursor_type
!= w
->phys_cursor_type
28409 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
28410 && new_cursor_width
!= w
->phys_cursor_width
)))
28411 erase_phys_cursor (w
);
28413 /* Don't check phys_cursor_on_p here because that flag is only set
28414 to false in some cases where we know that the cursor has been
28415 completely erased, to avoid the extra work of erasing the cursor
28416 twice. In other words, phys_cursor_on_p can be true and the cursor
28417 still not be visible, or it has only been partly erased. */
28420 w
->phys_cursor_ascent
= glyph_row
->ascent
;
28421 w
->phys_cursor_height
= glyph_row
->height
;
28423 /* Set phys_cursor_.* before x_draw_.* is called because some
28424 of them may need the information. */
28425 w
->phys_cursor
.x
= x
;
28426 w
->phys_cursor
.y
= glyph_row
->y
;
28427 w
->phys_cursor
.hpos
= hpos
;
28428 w
->phys_cursor
.vpos
= vpos
;
28431 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
28432 new_cursor_type
, new_cursor_width
,
28433 on
, active_cursor
);
28437 /* Switch the display of W's cursor on or off, according to the value
28441 update_window_cursor (struct window
*w
, bool on
)
28443 /* Don't update cursor in windows whose frame is in the process
28444 of being deleted. */
28445 if (w
->current_matrix
)
28447 int hpos
= w
->phys_cursor
.hpos
;
28448 int vpos
= w
->phys_cursor
.vpos
;
28449 struct glyph_row
*row
;
28451 if (vpos
>= w
->current_matrix
->nrows
28452 || hpos
>= w
->current_matrix
->matrix_w
)
28455 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28457 /* When the window is hscrolled, cursor hpos can legitimately be
28458 out of bounds, but we draw the cursor at the corresponding
28459 window margin in that case. */
28460 if (!row
->reversed_p
&& hpos
< 0)
28462 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28463 hpos
= row
->used
[TEXT_AREA
] - 1;
28466 display_and_set_cursor (w
, on
, hpos
, vpos
,
28467 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28473 /* Call update_window_cursor with parameter ON_P on all leaf windows
28474 in the window tree rooted at W. */
28477 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
28481 if (WINDOWP (w
->contents
))
28482 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
28484 update_window_cursor (w
, on_p
);
28486 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
28492 Display the cursor on window W, or clear it, according to ON_P.
28493 Don't change the cursor's position. */
28496 x_update_cursor (struct frame
*f
, bool on_p
)
28498 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
28503 Clear the cursor of window W to background color, and mark the
28504 cursor as not shown. This is used when the text where the cursor
28505 is about to be rewritten. */
28508 x_clear_cursor (struct window
*w
)
28510 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
28511 update_window_cursor (w
, false);
28514 #endif /* HAVE_WINDOW_SYSTEM */
28516 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
28519 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
28520 int start_hpos
, int end_hpos
,
28521 enum draw_glyphs_face draw
)
28523 #ifdef HAVE_WINDOW_SYSTEM
28524 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
28526 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
28530 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
28531 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
28535 /* Display the active region described by mouse_face_* according to DRAW. */
28538 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
28540 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
28541 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28543 if (/* If window is in the process of being destroyed, don't bother
28545 w
->current_matrix
!= NULL
28546 /* Don't update mouse highlight if hidden. */
28547 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
28548 /* Recognize when we are called to operate on rows that don't exist
28549 anymore. This can happen when a window is split. */
28550 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
28552 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
28553 struct glyph_row
*row
, *first
, *last
;
28555 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
28556 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
28558 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
28560 int start_hpos
, end_hpos
, start_x
;
28562 /* For all but the first row, the highlight starts at column 0. */
28565 /* R2L rows have BEG and END in reversed order, but the
28566 screen drawing geometry is always left to right. So
28567 we need to mirror the beginning and end of the
28568 highlighted area in R2L rows. */
28569 if (!row
->reversed_p
)
28571 start_hpos
= hlinfo
->mouse_face_beg_col
;
28572 start_x
= hlinfo
->mouse_face_beg_x
;
28574 else if (row
== last
)
28576 start_hpos
= hlinfo
->mouse_face_end_col
;
28577 start_x
= hlinfo
->mouse_face_end_x
;
28585 else if (row
->reversed_p
&& row
== last
)
28587 start_hpos
= hlinfo
->mouse_face_end_col
;
28588 start_x
= hlinfo
->mouse_face_end_x
;
28598 if (!row
->reversed_p
)
28599 end_hpos
= hlinfo
->mouse_face_end_col
;
28600 else if (row
== first
)
28601 end_hpos
= hlinfo
->mouse_face_beg_col
;
28604 end_hpos
= row
->used
[TEXT_AREA
];
28605 if (draw
== DRAW_NORMAL_TEXT
)
28606 row
->fill_line_p
= true; /* Clear to end of line. */
28609 else if (row
->reversed_p
&& row
== first
)
28610 end_hpos
= hlinfo
->mouse_face_beg_col
;
28613 end_hpos
= row
->used
[TEXT_AREA
];
28614 if (draw
== DRAW_NORMAL_TEXT
)
28615 row
->fill_line_p
= true; /* Clear to end of line. */
28618 if (end_hpos
> start_hpos
)
28620 draw_row_with_mouse_face (w
, start_x
, row
,
28621 start_hpos
, end_hpos
, draw
);
28624 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
28628 #ifdef HAVE_WINDOW_SYSTEM
28629 /* When we've written over the cursor, arrange for it to
28630 be displayed again. */
28631 if (FRAME_WINDOW_P (f
)
28632 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
28634 int hpos
= w
->phys_cursor
.hpos
;
28636 /* When the window is hscrolled, cursor hpos can legitimately be
28637 out of bounds, but we draw the cursor at the corresponding
28638 window margin in that case. */
28639 if (!row
->reversed_p
&& hpos
< 0)
28641 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28642 hpos
= row
->used
[TEXT_AREA
] - 1;
28645 display_and_set_cursor (w
, true, hpos
, w
->phys_cursor
.vpos
,
28646 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28649 #endif /* HAVE_WINDOW_SYSTEM */
28652 #ifdef HAVE_WINDOW_SYSTEM
28653 /* Change the mouse cursor. */
28654 if (FRAME_WINDOW_P (f
) && NILP (do_mouse_tracking
))
28656 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
28657 if (draw
== DRAW_NORMAL_TEXT
28658 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
28659 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
28662 if (draw
== DRAW_MOUSE_FACE
)
28663 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
28665 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
28667 #endif /* HAVE_WINDOW_SYSTEM */
28671 Clear out the mouse-highlighted active region.
28672 Redraw it un-highlighted first. Value is true if mouse
28673 face was actually drawn unhighlighted. */
28676 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
28679 = !hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
);
28681 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
28682 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28683 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28684 hlinfo
->mouse_face_window
= Qnil
;
28685 hlinfo
->mouse_face_overlay
= Qnil
;
28689 /* Return true if the coordinates HPOS and VPOS on windows W are
28690 within the mouse face on that window. */
28692 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
28694 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28696 /* Quickly resolve the easy cases. */
28697 if (!(WINDOWP (hlinfo
->mouse_face_window
)
28698 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
28700 if (vpos
< hlinfo
->mouse_face_beg_row
28701 || vpos
> hlinfo
->mouse_face_end_row
)
28703 if (vpos
> hlinfo
->mouse_face_beg_row
28704 && vpos
< hlinfo
->mouse_face_end_row
)
28707 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
28709 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28711 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
28714 else if ((vpos
== hlinfo
->mouse_face_beg_row
28715 && hpos
>= hlinfo
->mouse_face_beg_col
)
28716 || (vpos
== hlinfo
->mouse_face_end_row
28717 && hpos
< hlinfo
->mouse_face_end_col
))
28722 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28724 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
28727 else if ((vpos
== hlinfo
->mouse_face_beg_row
28728 && hpos
<= hlinfo
->mouse_face_beg_col
)
28729 || (vpos
== hlinfo
->mouse_face_end_row
28730 && hpos
> hlinfo
->mouse_face_end_col
))
28738 True if physical cursor of window W is within mouse face. */
28741 cursor_in_mouse_face_p (struct window
*w
)
28743 int hpos
= w
->phys_cursor
.hpos
;
28744 int vpos
= w
->phys_cursor
.vpos
;
28745 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28747 /* When the window is hscrolled, cursor hpos can legitimately be out
28748 of bounds, but we draw the cursor at the corresponding window
28749 margin in that case. */
28750 if (!row
->reversed_p
&& hpos
< 0)
28752 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28753 hpos
= row
->used
[TEXT_AREA
] - 1;
28755 return coords_in_mouse_face_p (w
, hpos
, vpos
);
28760 /* Find the glyph rows START_ROW and END_ROW of window W that display
28761 characters between buffer positions START_CHARPOS and END_CHARPOS
28762 (excluding END_CHARPOS). DISP_STRING is a display string that
28763 covers these buffer positions. This is similar to
28764 row_containing_pos, but is more accurate when bidi reordering makes
28765 buffer positions change non-linearly with glyph rows. */
28767 rows_from_pos_range (struct window
*w
,
28768 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
28769 Lisp_Object disp_string
,
28770 struct glyph_row
**start
, struct glyph_row
**end
)
28772 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28773 int last_y
= window_text_bottom_y (w
);
28774 struct glyph_row
*row
;
28779 while (!first
->enabled_p
28780 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
28783 /* Find the START row. */
28785 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
28788 /* A row can potentially be the START row if the range of the
28789 characters it displays intersects the range
28790 [START_CHARPOS..END_CHARPOS). */
28791 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
28792 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
28793 /* See the commentary in row_containing_pos, for the
28794 explanation of the complicated way to check whether
28795 some position is beyond the end of the characters
28796 displayed by a row. */
28797 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28798 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28799 && !row
->ends_at_zv_p
28800 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
28801 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28802 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28803 && !row
->ends_at_zv_p
28804 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
28806 /* Found a candidate row. Now make sure at least one of the
28807 glyphs it displays has a charpos from the range
28808 [START_CHARPOS..END_CHARPOS).
28810 This is not obvious because bidi reordering could make
28811 buffer positions of a row be 1,2,3,102,101,100, and if we
28812 want to highlight characters in [50..60), we don't want
28813 this row, even though [50..60) does intersect [1..103),
28814 the range of character positions given by the row's start
28815 and end positions. */
28816 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
28817 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
28821 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28822 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28823 /* A glyph that comes from DISP_STRING is by
28824 definition to be highlighted. */
28825 || EQ (g
->object
, disp_string
))
28834 /* Find the END row. */
28836 /* If the last row is partially visible, start looking for END
28837 from that row, instead of starting from FIRST. */
28838 && !(row
->enabled_p
28839 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
28841 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
28843 struct glyph_row
*next
= row
+ 1;
28844 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
28846 if (!next
->enabled_p
28847 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
28848 /* The first row >= START whose range of displayed characters
28849 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28850 is the row END + 1. */
28851 || (start_charpos
< next_start
28852 && end_charpos
< next_start
)
28853 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28854 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28855 && !next
->ends_at_zv_p
28856 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28857 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28858 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28859 && !next
->ends_at_zv_p
28860 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28867 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28868 but none of the characters it displays are in the range, it is
28870 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28871 struct glyph
*s
= g
;
28872 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28876 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28877 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28878 /* If the buffer position of the first glyph in
28879 the row is equal to END_CHARPOS, it means
28880 the last character to be highlighted is the
28881 newline of ROW, and we must consider NEXT as
28883 || (((!next
->reversed_p
&& g
== s
)
28884 || (next
->reversed_p
&& g
== e
- 1))
28885 && (g
->charpos
== end_charpos
28886 /* Special case for when NEXT is an
28887 empty line at ZV. */
28888 || (g
->charpos
== -1
28889 && !row
->ends_at_zv_p
28890 && next_start
== end_charpos
)))))
28891 /* A glyph that comes from DISP_STRING is by
28892 definition to be highlighted. */
28893 || EQ (g
->object
, disp_string
))
28902 /* The first row that ends at ZV must be the last to be
28904 else if (next
->ends_at_zv_p
)
28913 /* This function sets the mouse_face_* elements of HLINFO, assuming
28914 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28915 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28916 for the overlay or run of text properties specifying the mouse
28917 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28918 before-string and after-string that must also be highlighted.
28919 DISP_STRING, if non-nil, is a display string that may cover some
28920 or all of the highlighted text. */
28923 mouse_face_from_buffer_pos (Lisp_Object window
,
28924 Mouse_HLInfo
*hlinfo
,
28925 ptrdiff_t mouse_charpos
,
28926 ptrdiff_t start_charpos
,
28927 ptrdiff_t end_charpos
,
28928 Lisp_Object before_string
,
28929 Lisp_Object after_string
,
28930 Lisp_Object disp_string
)
28932 struct window
*w
= XWINDOW (window
);
28933 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28934 struct glyph_row
*r1
, *r2
;
28935 struct glyph
*glyph
, *end
;
28936 ptrdiff_t ignore
, pos
;
28939 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28940 eassert (NILP (before_string
) || STRINGP (before_string
));
28941 eassert (NILP (after_string
) || STRINGP (after_string
));
28943 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28944 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
28946 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28947 /* If the before-string or display-string contains newlines,
28948 rows_from_pos_range skips to its last row. Move back. */
28949 if (!NILP (before_string
) || !NILP (disp_string
))
28951 struct glyph_row
*prev
;
28952 while ((prev
= r1
- 1, prev
>= first
)
28953 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
28954 && prev
->used
[TEXT_AREA
] > 0)
28956 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
28957 glyph
= beg
+ prev
->used
[TEXT_AREA
];
28958 while (--glyph
>= beg
&& NILP (glyph
->object
));
28960 || !(EQ (glyph
->object
, before_string
)
28961 || EQ (glyph
->object
, disp_string
)))
28968 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28969 hlinfo
->mouse_face_past_end
= true;
28971 else if (!NILP (after_string
))
28973 /* If the after-string has newlines, advance to its last row. */
28974 struct glyph_row
*next
;
28975 struct glyph_row
*last
28976 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28978 for (next
= r2
+ 1;
28980 && next
->used
[TEXT_AREA
] > 0
28981 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
28985 /* The rest of the display engine assumes that mouse_face_beg_row is
28986 either above mouse_face_end_row or identical to it. But with
28987 bidi-reordered continued lines, the row for START_CHARPOS could
28988 be below the row for END_CHARPOS. If so, swap the rows and store
28989 them in correct order. */
28992 struct glyph_row
*tem
= r2
;
28998 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
28999 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
29001 /* For a bidi-reordered row, the positions of BEFORE_STRING,
29002 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
29003 could be anywhere in the row and in any order. The strategy
29004 below is to find the leftmost and the rightmost glyph that
29005 belongs to either of these 3 strings, or whose position is
29006 between START_CHARPOS and END_CHARPOS, and highlight all the
29007 glyphs between those two. This may cover more than just the text
29008 between START_CHARPOS and END_CHARPOS if the range of characters
29009 strides the bidi level boundary, e.g. if the beginning is in R2L
29010 text while the end is in L2R text or vice versa. */
29011 if (!r1
->reversed_p
)
29013 /* This row is in a left to right paragraph. Scan it left to
29015 glyph
= r1
->glyphs
[TEXT_AREA
];
29016 end
= glyph
+ r1
->used
[TEXT_AREA
];
29019 /* Skip truncation glyphs at the start of the glyph row. */
29020 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
29022 && NILP (glyph
->object
)
29023 && glyph
->charpos
< 0;
29025 x
+= glyph
->pixel_width
;
29027 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
29028 or DISP_STRING, and the first glyph from buffer whose
29029 position is between START_CHARPOS and END_CHARPOS. */
29031 && !NILP (glyph
->object
)
29032 && !EQ (glyph
->object
, disp_string
)
29033 && !(BUFFERP (glyph
->object
)
29034 && (glyph
->charpos
>= start_charpos
29035 && glyph
->charpos
< end_charpos
));
29038 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29039 are present at buffer positions between START_CHARPOS and
29040 END_CHARPOS, or if they come from an overlay. */
29041 if (EQ (glyph
->object
, before_string
))
29043 pos
= string_buffer_position (before_string
,
29045 /* If pos == 0, it means before_string came from an
29046 overlay, not from a buffer position. */
29047 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29050 else if (EQ (glyph
->object
, after_string
))
29052 pos
= string_buffer_position (after_string
, end_charpos
);
29053 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29056 x
+= glyph
->pixel_width
;
29058 hlinfo
->mouse_face_beg_x
= x
;
29059 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
29063 /* This row is in a right to left paragraph. Scan it right to
29067 end
= r1
->glyphs
[TEXT_AREA
] - 1;
29068 glyph
= end
+ r1
->used
[TEXT_AREA
];
29070 /* Skip truncation glyphs at the start of the glyph row. */
29071 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
29073 && NILP (glyph
->object
)
29074 && glyph
->charpos
< 0;
29078 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
29079 or DISP_STRING, and the first glyph from buffer whose
29080 position is between START_CHARPOS and END_CHARPOS. */
29082 && !NILP (glyph
->object
)
29083 && !EQ (glyph
->object
, disp_string
)
29084 && !(BUFFERP (glyph
->object
)
29085 && (glyph
->charpos
>= start_charpos
29086 && glyph
->charpos
< end_charpos
));
29089 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29090 are present at buffer positions between START_CHARPOS and
29091 END_CHARPOS, or if they come from an overlay. */
29092 if (EQ (glyph
->object
, before_string
))
29094 pos
= string_buffer_position (before_string
, start_charpos
);
29095 /* If pos == 0, it means before_string came from an
29096 overlay, not from a buffer position. */
29097 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29100 else if (EQ (glyph
->object
, after_string
))
29102 pos
= string_buffer_position (after_string
, end_charpos
);
29103 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29108 glyph
++; /* first glyph to the right of the highlighted area */
29109 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
29110 x
+= g
->pixel_width
;
29111 hlinfo
->mouse_face_beg_x
= x
;
29112 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
29115 /* If the highlight ends in a different row, compute GLYPH and END
29116 for the end row. Otherwise, reuse the values computed above for
29117 the row where the highlight begins. */
29120 if (!r2
->reversed_p
)
29122 glyph
= r2
->glyphs
[TEXT_AREA
];
29123 end
= glyph
+ r2
->used
[TEXT_AREA
];
29128 end
= r2
->glyphs
[TEXT_AREA
] - 1;
29129 glyph
= end
+ r2
->used
[TEXT_AREA
];
29133 if (!r2
->reversed_p
)
29135 /* Skip truncation and continuation glyphs near the end of the
29136 row, and also blanks and stretch glyphs inserted by
29137 extend_face_to_end_of_line. */
29139 && NILP ((end
- 1)->object
))
29141 /* Scan the rest of the glyph row from the end, looking for the
29142 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
29143 DISP_STRING, or whose position is between START_CHARPOS
29147 && !NILP (end
->object
)
29148 && !EQ (end
->object
, disp_string
)
29149 && !(BUFFERP (end
->object
)
29150 && (end
->charpos
>= start_charpos
29151 && end
->charpos
< end_charpos
));
29154 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29155 are present at buffer positions between START_CHARPOS and
29156 END_CHARPOS, or if they come from an overlay. */
29157 if (EQ (end
->object
, before_string
))
29159 pos
= string_buffer_position (before_string
, start_charpos
);
29160 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29163 else if (EQ (end
->object
, after_string
))
29165 pos
= string_buffer_position (after_string
, end_charpos
);
29166 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29170 /* Find the X coordinate of the last glyph to be highlighted. */
29171 for (; glyph
<= end
; ++glyph
)
29172 x
+= glyph
->pixel_width
;
29174 hlinfo
->mouse_face_end_x
= x
;
29175 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
29179 /* Skip truncation and continuation glyphs near the end of the
29180 row, and also blanks and stretch glyphs inserted by
29181 extend_face_to_end_of_line. */
29185 && NILP (end
->object
))
29187 x
+= end
->pixel_width
;
29190 /* Scan the rest of the glyph row from the end, looking for the
29191 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
29192 DISP_STRING, or whose position is between START_CHARPOS
29196 && !NILP (end
->object
)
29197 && !EQ (end
->object
, disp_string
)
29198 && !(BUFFERP (end
->object
)
29199 && (end
->charpos
>= start_charpos
29200 && end
->charpos
< end_charpos
));
29203 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29204 are present at buffer positions between START_CHARPOS and
29205 END_CHARPOS, or if they come from an overlay. */
29206 if (EQ (end
->object
, before_string
))
29208 pos
= string_buffer_position (before_string
, start_charpos
);
29209 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29212 else if (EQ (end
->object
, after_string
))
29214 pos
= string_buffer_position (after_string
, end_charpos
);
29215 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29218 x
+= end
->pixel_width
;
29220 /* If we exited the above loop because we arrived at the last
29221 glyph of the row, and its buffer position is still not in
29222 range, it means the last character in range is the preceding
29223 newline. Bump the end column and x values to get past the
29226 && BUFFERP (end
->object
)
29227 && (end
->charpos
< start_charpos
29228 || end
->charpos
>= end_charpos
))
29230 x
+= end
->pixel_width
;
29233 hlinfo
->mouse_face_end_x
= x
;
29234 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
29237 hlinfo
->mouse_face_window
= window
;
29238 hlinfo
->mouse_face_face_id
29239 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
29241 !hlinfo
->mouse_face_hidden
, -1);
29242 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29245 /* The following function is not used anymore (replaced with
29246 mouse_face_from_string_pos), but I leave it here for the time
29247 being, in case someone would. */
29249 #if false /* not used */
29251 /* Find the position of the glyph for position POS in OBJECT in
29252 window W's current matrix, and return in *X, *Y the pixel
29253 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
29255 RIGHT_P means return the position of the right edge of the glyph.
29256 !RIGHT_P means return the left edge position.
29258 If no glyph for POS exists in the matrix, return the position of
29259 the glyph with the next smaller position that is in the matrix, if
29260 RIGHT_P is false. If RIGHT_P, and no glyph for POS
29261 exists in the matrix, return the position of the glyph with the
29262 next larger position in OBJECT.
29264 Value is true if a glyph was found. */
29267 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
29268 int *hpos
, int *vpos
, int *x
, int *y
, bool right_p
)
29270 int yb
= window_text_bottom_y (w
);
29271 struct glyph_row
*r
;
29272 struct glyph
*best_glyph
= NULL
;
29273 struct glyph_row
*best_row
= NULL
;
29276 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
29277 r
->enabled_p
&& r
->y
< yb
;
29280 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
29281 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
29284 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
29285 if (EQ (g
->object
, object
))
29287 if (g
->charpos
== pos
)
29294 else if (best_glyph
== NULL
29295 || ((eabs (g
->charpos
- pos
)
29296 < eabs (best_glyph
->charpos
- pos
))
29299 : g
->charpos
> pos
)))
29313 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
29317 *x
+= best_glyph
->pixel_width
;
29322 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
29325 return best_glyph
!= NULL
;
29327 #endif /* not used */
29329 /* Find the positions of the first and the last glyphs in window W's
29330 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
29331 (assumed to be a string), and return in HLINFO's mouse_face_*
29332 members the pixel and column/row coordinates of those glyphs. */
29335 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
29336 Lisp_Object object
,
29337 ptrdiff_t startpos
, ptrdiff_t endpos
)
29339 int yb
= window_text_bottom_y (w
);
29340 struct glyph_row
*r
;
29341 struct glyph
*g
, *e
;
29343 bool found
= false;
29345 /* Find the glyph row with at least one position in the range
29346 [STARTPOS..ENDPOS), and the first glyph in that row whose
29347 position belongs to that range. */
29348 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
29349 r
->enabled_p
&& r
->y
< yb
;
29352 if (!r
->reversed_p
)
29354 g
= r
->glyphs
[TEXT_AREA
];
29355 e
= g
+ r
->used
[TEXT_AREA
];
29356 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
29357 if (EQ (g
->object
, object
)
29358 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29360 hlinfo
->mouse_face_beg_row
29361 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29362 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29363 hlinfo
->mouse_face_beg_x
= gx
;
29372 e
= r
->glyphs
[TEXT_AREA
];
29373 g
= e
+ r
->used
[TEXT_AREA
];
29374 for ( ; g
> e
; --g
)
29375 if (EQ ((g
-1)->object
, object
)
29376 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
29378 hlinfo
->mouse_face_beg_row
29379 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29380 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29381 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
29382 gx
+= g1
->pixel_width
;
29383 hlinfo
->mouse_face_beg_x
= gx
;
29395 /* Starting with the next row, look for the first row which does NOT
29396 include any glyphs whose positions are in the range. */
29397 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
29399 g
= r
->glyphs
[TEXT_AREA
];
29400 e
= g
+ r
->used
[TEXT_AREA
];
29402 for ( ; g
< e
; ++g
)
29403 if (EQ (g
->object
, object
)
29404 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29413 /* The highlighted region ends on the previous row. */
29416 /* Set the end row. */
29417 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29419 /* Compute and set the end column and the end column's horizontal
29420 pixel coordinate. */
29421 if (!r
->reversed_p
)
29423 g
= r
->glyphs
[TEXT_AREA
];
29424 e
= g
+ r
->used
[TEXT_AREA
];
29425 for ( ; e
> g
; --e
)
29426 if (EQ ((e
-1)->object
, object
)
29427 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
29429 hlinfo
->mouse_face_end_col
= e
- g
;
29431 for (gx
= r
->x
; g
< e
; ++g
)
29432 gx
+= g
->pixel_width
;
29433 hlinfo
->mouse_face_end_x
= gx
;
29437 e
= r
->glyphs
[TEXT_AREA
];
29438 g
= e
+ r
->used
[TEXT_AREA
];
29439 for (gx
= r
->x
; e
< g
; ++e
)
29441 if (EQ (e
->object
, object
)
29442 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
29444 gx
+= e
->pixel_width
;
29446 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
29447 hlinfo
->mouse_face_end_x
= gx
;
29451 #ifdef HAVE_WINDOW_SYSTEM
29453 /* See if position X, Y is within a hot-spot of an image. */
29456 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
29458 if (!CONSP (hot_spot
))
29461 if (EQ (XCAR (hot_spot
), Qrect
))
29463 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
29464 Lisp_Object rect
= XCDR (hot_spot
);
29468 if (!CONSP (XCAR (rect
)))
29470 if (!CONSP (XCDR (rect
)))
29472 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
29474 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
29476 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
29478 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
29482 else if (EQ (XCAR (hot_spot
), Qcircle
))
29484 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
29485 Lisp_Object circ
= XCDR (hot_spot
);
29486 Lisp_Object lr
, lx0
, ly0
;
29488 && CONSP (XCAR (circ
))
29489 && (lr
= XCDR (circ
), NUMBERP (lr
))
29490 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
29491 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
29493 double r
= XFLOATINT (lr
);
29494 double dx
= XINT (lx0
) - x
;
29495 double dy
= XINT (ly0
) - y
;
29496 return (dx
* dx
+ dy
* dy
<= r
* r
);
29499 else if (EQ (XCAR (hot_spot
), Qpoly
))
29501 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
29502 if (VECTORP (XCDR (hot_spot
)))
29504 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
29505 Lisp_Object
*poly
= v
->contents
;
29506 ptrdiff_t n
= v
->header
.size
;
29508 bool inside
= false;
29509 Lisp_Object lx
, ly
;
29512 /* Need an even number of coordinates, and at least 3 edges. */
29513 if (n
< 6 || n
& 1)
29516 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
29517 If count is odd, we are inside polygon. Pixels on edges
29518 may or may not be included depending on actual geometry of the
29520 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
29521 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
29523 x0
= XINT (lx
), y0
= XINT (ly
);
29524 for (i
= 0; i
< n
; i
+= 2)
29526 int x1
= x0
, y1
= y0
;
29527 if ((lx
= poly
[i
], !INTEGERP (lx
))
29528 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
29530 x0
= XINT (lx
), y0
= XINT (ly
);
29532 /* Does this segment cross the X line? */
29540 if (y
> y0
&& y
> y1
)
29542 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
29552 find_hot_spot (Lisp_Object map
, int x
, int y
)
29554 while (CONSP (map
))
29556 if (CONSP (XCAR (map
))
29557 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
29565 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
29567 doc
: /* Lookup in image map MAP coordinates X and Y.
29568 An image map is an alist where each element has the format (AREA ID PLIST).
29569 An AREA is specified as either a rectangle, a circle, or a polygon:
29570 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
29571 pixel coordinates of the upper left and bottom right corners.
29572 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
29573 and the radius of the circle; r may be a float or integer.
29574 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
29575 vector describes one corner in the polygon.
29576 Returns the alist element for the first matching AREA in MAP. */)
29577 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
29585 return find_hot_spot (map
,
29586 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
29587 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
29591 /* Display frame CURSOR, optionally using shape defined by POINTER. */
29593 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
29595 /* Do not change cursor shape while dragging mouse. */
29596 if (EQ (do_mouse_tracking
, Qdragging
))
29599 if (!NILP (pointer
))
29601 if (EQ (pointer
, Qarrow
))
29602 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29603 else if (EQ (pointer
, Qhand
))
29604 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
29605 else if (EQ (pointer
, Qtext
))
29606 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29607 else if (EQ (pointer
, intern ("hdrag")))
29608 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29609 else if (EQ (pointer
, intern ("nhdrag")))
29610 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29611 #ifdef HAVE_X_WINDOWS
29612 else if (EQ (pointer
, intern ("vdrag")))
29613 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29615 else if (EQ (pointer
, intern ("hourglass")))
29616 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
29617 else if (EQ (pointer
, Qmodeline
))
29618 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
29620 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29623 if (cursor
!= No_Cursor
)
29624 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
29627 #endif /* HAVE_WINDOW_SYSTEM */
29629 /* Take proper action when mouse has moved to the mode or header line
29630 or marginal area AREA of window W, x-position X and y-position Y.
29631 X is relative to the start of the text display area of W, so the
29632 width of bitmap areas and scroll bars must be subtracted to get a
29633 position relative to the start of the mode line. */
29636 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
29637 enum window_part area
)
29639 struct window
*w
= XWINDOW (window
);
29640 struct frame
*f
= XFRAME (w
->frame
);
29641 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29642 #ifdef HAVE_WINDOW_SYSTEM
29643 Display_Info
*dpyinfo
;
29645 Cursor cursor
= No_Cursor
;
29646 Lisp_Object pointer
= Qnil
;
29647 int dx
, dy
, width
, height
;
29649 Lisp_Object string
, object
= Qnil
;
29650 Lisp_Object pos
IF_LINT (= Qnil
), help
;
29652 Lisp_Object mouse_face
;
29653 int original_x_pixel
= x
;
29654 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
29655 struct glyph_row
*row
IF_LINT (= 0);
29657 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
29662 /* Kludge alert: mode_line_string takes X/Y in pixels, but
29663 returns them in row/column units! */
29664 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
29665 &object
, &dx
, &dy
, &width
, &height
);
29667 row
= (area
== ON_MODE_LINE
29668 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
29669 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
29671 /* Find the glyph under the mouse pointer. */
29672 if (row
->mode_line_p
&& row
->enabled_p
)
29674 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
29675 end
= glyph
+ row
->used
[TEXT_AREA
];
29677 for (x0
= original_x_pixel
;
29678 glyph
< end
&& x0
>= glyph
->pixel_width
;
29680 x0
-= glyph
->pixel_width
;
29688 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
29689 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
29690 returns them in row/column units! */
29691 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
29692 &object
, &dx
, &dy
, &width
, &height
);
29697 #ifdef HAVE_WINDOW_SYSTEM
29698 if (IMAGEP (object
))
29700 Lisp_Object image_map
, hotspot
;
29701 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
29703 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
29705 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29709 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
29710 If so, we could look for mouse-enter, mouse-leave
29711 properties in PLIST (and do something...). */
29712 hotspot
= XCDR (hotspot
);
29713 if (CONSP (hotspot
)
29714 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29716 pointer
= Fplist_get (plist
, Qpointer
);
29717 if (NILP (pointer
))
29719 help
= Fplist_get (plist
, Qhelp_echo
);
29722 help_echo_string
= help
;
29723 XSETWINDOW (help_echo_window
, w
);
29724 help_echo_object
= w
->contents
;
29725 help_echo_pos
= charpos
;
29729 if (NILP (pointer
))
29730 pointer
= Fplist_get (XCDR (object
), QCpointer
);
29732 #endif /* HAVE_WINDOW_SYSTEM */
29734 if (STRINGP (string
))
29735 pos
= make_number (charpos
);
29737 /* Set the help text and mouse pointer. If the mouse is on a part
29738 of the mode line without any text (e.g. past the right edge of
29739 the mode line text), use the default help text and pointer. */
29740 if (STRINGP (string
) || area
== ON_MODE_LINE
)
29742 /* Arrange to display the help by setting the global variables
29743 help_echo_string, help_echo_object, and help_echo_pos. */
29746 if (STRINGP (string
))
29747 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
29751 help_echo_string
= help
;
29752 XSETWINDOW (help_echo_window
, w
);
29753 help_echo_object
= string
;
29754 help_echo_pos
= charpos
;
29756 else if (area
== ON_MODE_LINE
)
29758 Lisp_Object default_help
29759 = buffer_local_value (Qmode_line_default_help_echo
,
29762 if (STRINGP (default_help
))
29764 help_echo_string
= default_help
;
29765 XSETWINDOW (help_echo_window
, w
);
29766 help_echo_object
= Qnil
;
29767 help_echo_pos
= -1;
29772 #ifdef HAVE_WINDOW_SYSTEM
29773 /* Change the mouse pointer according to what is under it. */
29774 if (FRAME_WINDOW_P (f
))
29776 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
29778 || NILP (Vresize_mini_windows
));
29780 dpyinfo
= FRAME_DISPLAY_INFO (f
);
29781 if (STRINGP (string
))
29783 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29785 if (NILP (pointer
))
29786 pointer
= Fget_text_property (pos
, Qpointer
, string
);
29788 /* Change the mouse pointer according to what is under X/Y. */
29790 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
29793 map
= Fget_text_property (pos
, Qlocal_map
, string
);
29794 if (!KEYMAPP (map
))
29795 map
= Fget_text_property (pos
, Qkeymap
, string
);
29796 if (!KEYMAPP (map
) && draggable
)
29797 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
29800 else if (draggable
)
29801 /* Default mode-line pointer. */
29802 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29807 /* Change the mouse face according to what is under X/Y. */
29808 bool mouse_face_shown
= false;
29809 if (STRINGP (string
))
29811 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
29812 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
29813 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29818 struct glyph
* tmp_glyph
;
29822 int total_pixel_width
;
29823 ptrdiff_t begpos
, endpos
, ignore
;
29827 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
29828 Qmouse_face
, string
, Qnil
);
29834 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
29836 endpos
= SCHARS (string
);
29840 /* Calculate the glyph position GPOS of GLYPH in the
29841 displayed string, relative to the beginning of the
29842 highlighted part of the string.
29844 Note: GPOS is different from CHARPOS. CHARPOS is the
29845 position of GLYPH in the internal string object. A mode
29846 line string format has structures which are converted to
29847 a flattened string by the Emacs Lisp interpreter. The
29848 internal string is an element of those structures. The
29849 displayed string is the flattened string. */
29850 tmp_glyph
= row_start_glyph
;
29851 while (tmp_glyph
< glyph
29852 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29853 && begpos
<= tmp_glyph
->charpos
29854 && tmp_glyph
->charpos
< endpos
)))
29856 gpos
= glyph
- tmp_glyph
;
29858 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29859 the highlighted part of the displayed string to which
29860 GLYPH belongs. Note: GSEQ_LENGTH is different from
29861 SCHARS (STRING), because the latter returns the length of
29862 the internal string. */
29863 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29865 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29866 && begpos
<= tmp_glyph
->charpos
29867 && tmp_glyph
->charpos
< endpos
));
29870 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29872 /* Calculate the total pixel width of all the glyphs between
29873 the beginning of the highlighted area and GLYPH. */
29874 total_pixel_width
= 0;
29875 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29876 total_pixel_width
+= tmp_glyph
->pixel_width
;
29878 /* Pre calculation of re-rendering position. Note: X is in
29879 column units here, after the call to mode_line_string or
29880 marginal_area_string. */
29882 vpos
= (area
== ON_MODE_LINE
29883 ? (w
->current_matrix
)->nrows
- 1
29886 /* If GLYPH's position is included in the region that is
29887 already drawn in mouse face, we have nothing to do. */
29888 if ( EQ (window
, hlinfo
->mouse_face_window
)
29889 && (!row
->reversed_p
29890 ? (hlinfo
->mouse_face_beg_col
<= hpos
29891 && hpos
< hlinfo
->mouse_face_end_col
)
29892 /* In R2L rows we swap BEG and END, see below. */
29893 : (hlinfo
->mouse_face_end_col
<= hpos
29894 && hpos
< hlinfo
->mouse_face_beg_col
))
29895 && hlinfo
->mouse_face_beg_row
== vpos
)
29898 if (clear_mouse_face (hlinfo
))
29899 cursor
= No_Cursor
;
29901 if (!row
->reversed_p
)
29903 hlinfo
->mouse_face_beg_col
= hpos
;
29904 hlinfo
->mouse_face_beg_x
= original_x_pixel
29905 - (total_pixel_width
+ dx
);
29906 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29907 hlinfo
->mouse_face_end_x
= 0;
29911 /* In R2L rows, show_mouse_face expects BEG and END
29912 coordinates to be swapped. */
29913 hlinfo
->mouse_face_end_col
= hpos
;
29914 hlinfo
->mouse_face_end_x
= original_x_pixel
29915 - (total_pixel_width
+ dx
);
29916 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29917 hlinfo
->mouse_face_beg_x
= 0;
29920 hlinfo
->mouse_face_beg_row
= vpos
;
29921 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29922 hlinfo
->mouse_face_past_end
= false;
29923 hlinfo
->mouse_face_window
= window
;
29925 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29930 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29931 mouse_face_shown
= true;
29933 if (NILP (pointer
))
29938 /* If mouse-face doesn't need to be shown, clear any existing
29940 if ((area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
) && !mouse_face_shown
)
29941 clear_mouse_face (hlinfo
);
29943 #ifdef HAVE_WINDOW_SYSTEM
29944 if (FRAME_WINDOW_P (f
))
29945 define_frame_cursor1 (f
, cursor
, pointer
);
29951 Take proper action when the mouse has moved to position X, Y on
29952 frame F with regards to highlighting portions of display that have
29953 mouse-face properties. Also de-highlight portions of display where
29954 the mouse was before, set the mouse pointer shape as appropriate
29955 for the mouse coordinates, and activate help echo (tooltips).
29956 X and Y can be negative or out of range. */
29959 note_mouse_highlight (struct frame
*f
, int x
, int y
)
29961 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29962 enum window_part part
= ON_NOTHING
;
29963 Lisp_Object window
;
29965 Cursor cursor
= No_Cursor
;
29966 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
29969 /* When a menu is active, don't highlight because this looks odd. */
29970 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29971 if (popup_activated ())
29975 if (!f
->glyphs_initialized_p
29976 || f
->pointer_invisible
)
29979 hlinfo
->mouse_face_mouse_x
= x
;
29980 hlinfo
->mouse_face_mouse_y
= y
;
29981 hlinfo
->mouse_face_mouse_frame
= f
;
29983 if (hlinfo
->mouse_face_defer
)
29986 /* Which window is that in? */
29987 window
= window_from_coordinates (f
, x
, y
, &part
, true);
29989 /* If displaying active text in another window, clear that. */
29990 if (! EQ (window
, hlinfo
->mouse_face_window
)
29991 /* Also clear if we move out of text area in same window. */
29992 || (!NILP (hlinfo
->mouse_face_window
)
29995 && part
!= ON_MODE_LINE
29996 && part
!= ON_HEADER_LINE
))
29997 clear_mouse_face (hlinfo
);
29999 /* Not on a window -> return. */
30000 if (!WINDOWP (window
))
30003 /* Reset help_echo_string. It will get recomputed below. */
30004 help_echo_string
= Qnil
;
30006 /* Convert to window-relative pixel coordinates. */
30007 w
= XWINDOW (window
);
30008 frame_to_window_pixel_xy (w
, &x
, &y
);
30010 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
30011 /* Handle tool-bar window differently since it doesn't display a
30013 if (EQ (window
, f
->tool_bar_window
))
30015 note_tool_bar_highlight (f
, x
, y
);
30020 /* Mouse is on the mode, header line or margin? */
30021 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
30022 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
30024 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
30026 #ifdef HAVE_WINDOW_SYSTEM
30027 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
30029 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30030 /* Show non-text cursor (Bug#16647). */
30038 #ifdef HAVE_WINDOW_SYSTEM
30039 if (part
== ON_VERTICAL_BORDER
)
30041 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
30042 help_echo_string
= build_string ("drag-mouse-1: resize");
30044 else if (part
== ON_RIGHT_DIVIDER
)
30046 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
30047 help_echo_string
= build_string ("drag-mouse-1: resize");
30049 else if (part
== ON_BOTTOM_DIVIDER
)
30050 if (! WINDOW_BOTTOMMOST_P (w
)
30052 || NILP (Vresize_mini_windows
))
30054 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
30055 help_echo_string
= build_string ("drag-mouse-1: resize");
30058 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30059 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
30060 || part
== ON_VERTICAL_SCROLL_BAR
30061 || part
== ON_HORIZONTAL_SCROLL_BAR
)
30062 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30064 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
30067 /* Are we in a window whose display is up to date?
30068 And verify the buffer's text has not changed. */
30069 b
= XBUFFER (w
->contents
);
30070 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
30072 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
30074 struct glyph
*glyph
;
30075 Lisp_Object object
;
30076 Lisp_Object mouse_face
= Qnil
, position
;
30077 Lisp_Object
*overlay_vec
= NULL
;
30078 ptrdiff_t i
, noverlays
;
30079 struct buffer
*obuf
;
30080 ptrdiff_t obegv
, ozv
;
30083 /* Find the glyph under X/Y. */
30084 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
30086 #ifdef HAVE_WINDOW_SYSTEM
30087 /* Look for :pointer property on image. */
30088 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
30090 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
30091 if (img
!= NULL
&& IMAGEP (img
->spec
))
30093 Lisp_Object image_map
, hotspot
;
30094 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
30096 && (hotspot
= find_hot_spot (image_map
,
30097 glyph
->slice
.img
.x
+ dx
,
30098 glyph
->slice
.img
.y
+ dy
),
30100 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
30104 /* Could check XCAR (hotspot) to see if we enter/leave
30106 If so, we could look for mouse-enter, mouse-leave
30107 properties in PLIST (and do something...). */
30108 hotspot
= XCDR (hotspot
);
30109 if (CONSP (hotspot
)
30110 && (plist
= XCAR (hotspot
), CONSP (plist
)))
30112 pointer
= Fplist_get (plist
, Qpointer
);
30113 if (NILP (pointer
))
30115 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
30116 if (!NILP (help_echo_string
))
30118 help_echo_window
= window
;
30119 help_echo_object
= glyph
->object
;
30120 help_echo_pos
= glyph
->charpos
;
30124 if (NILP (pointer
))
30125 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
30128 #endif /* HAVE_WINDOW_SYSTEM */
30130 /* Clear mouse face if X/Y not over text. */
30132 || area
!= TEXT_AREA
30133 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
30134 /* Glyph's OBJECT is nil for glyphs inserted by the
30135 display engine for its internal purposes, like truncation
30136 and continuation glyphs and blanks beyond the end of
30137 line's text on text terminals. If we are over such a
30138 glyph, we are not over any text. */
30139 || NILP (glyph
->object
)
30140 /* R2L rows have a stretch glyph at their front, which
30141 stands for no text, whereas L2R rows have no glyphs at
30142 all beyond the end of text. Treat such stretch glyphs
30143 like we do with NULL glyphs in L2R rows. */
30144 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
30145 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
30146 && glyph
->type
== STRETCH_GLYPH
30147 && glyph
->avoid_cursor_p
))
30149 if (clear_mouse_face (hlinfo
))
30150 cursor
= No_Cursor
;
30151 #ifdef HAVE_WINDOW_SYSTEM
30152 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30154 if (area
!= TEXT_AREA
)
30155 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30157 pointer
= Vvoid_text_area_pointer
;
30163 pos
= glyph
->charpos
;
30164 object
= glyph
->object
;
30165 if (!STRINGP (object
) && !BUFFERP (object
))
30168 /* If we get an out-of-range value, return now; avoid an error. */
30169 if (BUFFERP (object
) && pos
> BUF_Z (b
))
30172 /* Make the window's buffer temporarily current for
30173 overlays_at and compute_char_face. */
30174 obuf
= current_buffer
;
30175 current_buffer
= b
;
30181 /* Is this char mouse-active or does it have help-echo? */
30182 position
= make_number (pos
);
30186 if (BUFFERP (object
))
30188 /* Put all the overlays we want in a vector in overlay_vec. */
30189 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, false);
30190 /* Sort overlays into increasing priority order. */
30191 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
30196 if (NILP (Vmouse_highlight
))
30198 clear_mouse_face (hlinfo
);
30199 goto check_help_echo
;
30202 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
30205 cursor
= No_Cursor
;
30207 /* Check mouse-face highlighting. */
30209 /* If there exists an overlay with mouse-face overlapping
30210 the one we are currently highlighting, we have to
30211 check if we enter the overlapping overlay, and then
30212 highlight only that. */
30213 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
30214 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
30216 /* Find the highest priority overlay with a mouse-face. */
30217 Lisp_Object overlay
= Qnil
;
30218 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
30220 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
30221 if (!NILP (mouse_face
))
30222 overlay
= overlay_vec
[i
];
30225 /* If we're highlighting the same overlay as before, there's
30226 no need to do that again. */
30227 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
30228 goto check_help_echo
;
30229 hlinfo
->mouse_face_overlay
= overlay
;
30231 /* Clear the display of the old active region, if any. */
30232 if (clear_mouse_face (hlinfo
))
30233 cursor
= No_Cursor
;
30235 /* If no overlay applies, get a text property. */
30236 if (NILP (overlay
))
30237 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
30239 /* Next, compute the bounds of the mouse highlighting and
30241 if (!NILP (mouse_face
) && STRINGP (object
))
30243 /* The mouse-highlighting comes from a display string
30244 with a mouse-face. */
30248 s
= Fprevious_single_property_change
30249 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
30250 e
= Fnext_single_property_change
30251 (position
, Qmouse_face
, object
, Qnil
);
30253 s
= make_number (0);
30255 e
= make_number (SCHARS (object
));
30256 mouse_face_from_string_pos (w
, hlinfo
, object
,
30257 XINT (s
), XINT (e
));
30258 hlinfo
->mouse_face_past_end
= false;
30259 hlinfo
->mouse_face_window
= window
;
30260 hlinfo
->mouse_face_face_id
30261 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
30262 glyph
->face_id
, true);
30263 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
30264 cursor
= No_Cursor
;
30268 /* The mouse-highlighting, if any, comes from an overlay
30269 or text property in the buffer. */
30270 Lisp_Object buffer
IF_LINT (= Qnil
);
30271 Lisp_Object disp_string
IF_LINT (= Qnil
);
30273 if (STRINGP (object
))
30275 /* If we are on a display string with no mouse-face,
30276 check if the text under it has one. */
30277 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
30278 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30279 pos
= string_buffer_position (object
, start
);
30282 mouse_face
= get_char_property_and_overlay
30283 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
30284 buffer
= w
->contents
;
30285 disp_string
= object
;
30291 disp_string
= Qnil
;
30294 if (!NILP (mouse_face
))
30296 Lisp_Object before
, after
;
30297 Lisp_Object before_string
, after_string
;
30298 /* To correctly find the limits of mouse highlight
30299 in a bidi-reordered buffer, we must not use the
30300 optimization of limiting the search in
30301 previous-single-property-change and
30302 next-single-property-change, because
30303 rows_from_pos_range needs the real start and end
30304 positions to DTRT in this case. That's because
30305 the first row visible in a window does not
30306 necessarily display the character whose position
30307 is the smallest. */
30309 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
30310 ? Fmarker_position (w
->start
)
30313 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
30314 ? make_number (BUF_Z (XBUFFER (buffer
))
30315 - w
->window_end_pos
)
30318 if (NILP (overlay
))
30320 /* Handle the text property case. */
30321 before
= Fprevious_single_property_change
30322 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
30323 after
= Fnext_single_property_change
30324 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
30325 before_string
= after_string
= Qnil
;
30329 /* Handle the overlay case. */
30330 before
= Foverlay_start (overlay
);
30331 after
= Foverlay_end (overlay
);
30332 before_string
= Foverlay_get (overlay
, Qbefore_string
);
30333 after_string
= Foverlay_get (overlay
, Qafter_string
);
30335 if (!STRINGP (before_string
)) before_string
= Qnil
;
30336 if (!STRINGP (after_string
)) after_string
= Qnil
;
30339 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
30342 : XFASTINT (before
),
30344 ? BUF_Z (XBUFFER (buffer
))
30345 : XFASTINT (after
),
30346 before_string
, after_string
,
30348 cursor
= No_Cursor
;
30355 /* Look for a `help-echo' property. */
30356 if (NILP (help_echo_string
)) {
30357 Lisp_Object help
, overlay
;
30359 /* Check overlays first. */
30360 help
= overlay
= Qnil
;
30361 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
30363 overlay
= overlay_vec
[i
];
30364 help
= Foverlay_get (overlay
, Qhelp_echo
);
30369 help_echo_string
= help
;
30370 help_echo_window
= window
;
30371 help_echo_object
= overlay
;
30372 help_echo_pos
= pos
;
30376 Lisp_Object obj
= glyph
->object
;
30377 ptrdiff_t charpos
= glyph
->charpos
;
30379 /* Try text properties. */
30382 && charpos
< SCHARS (obj
))
30384 help
= Fget_text_property (make_number (charpos
),
30388 /* If the string itself doesn't specify a help-echo,
30389 see if the buffer text ``under'' it does. */
30390 struct glyph_row
*r
30391 = MATRIX_ROW (w
->current_matrix
, vpos
);
30392 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30393 ptrdiff_t p
= string_buffer_position (obj
, start
);
30396 help
= Fget_char_property (make_number (p
),
30397 Qhelp_echo
, w
->contents
);
30406 else if (BUFFERP (obj
)
30409 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
30414 help_echo_string
= help
;
30415 help_echo_window
= window
;
30416 help_echo_object
= obj
;
30417 help_echo_pos
= charpos
;
30422 #ifdef HAVE_WINDOW_SYSTEM
30423 /* Look for a `pointer' property. */
30424 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30426 /* Check overlays first. */
30427 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
30428 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
30430 if (NILP (pointer
))
30432 Lisp_Object obj
= glyph
->object
;
30433 ptrdiff_t charpos
= glyph
->charpos
;
30435 /* Try text properties. */
30438 && charpos
< SCHARS (obj
))
30440 pointer
= Fget_text_property (make_number (charpos
),
30442 if (NILP (pointer
))
30444 /* If the string itself doesn't specify a pointer,
30445 see if the buffer text ``under'' it does. */
30446 struct glyph_row
*r
30447 = MATRIX_ROW (w
->current_matrix
, vpos
);
30448 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30449 ptrdiff_t p
= string_buffer_position (obj
, start
);
30451 pointer
= Fget_char_property (make_number (p
),
30452 Qpointer
, w
->contents
);
30455 else if (BUFFERP (obj
)
30458 pointer
= Fget_text_property (make_number (charpos
),
30462 #endif /* HAVE_WINDOW_SYSTEM */
30466 current_buffer
= obuf
;
30472 #ifdef HAVE_WINDOW_SYSTEM
30473 if (FRAME_WINDOW_P (f
))
30474 define_frame_cursor1 (f
, cursor
, pointer
);
30476 /* This is here to prevent a compiler error, about "label at end of
30477 compound statement". */
30484 Clear any mouse-face on window W. This function is part of the
30485 redisplay interface, and is called from try_window_id and similar
30486 functions to ensure the mouse-highlight is off. */
30489 x_clear_window_mouse_face (struct window
*w
)
30491 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
30492 Lisp_Object window
;
30495 XSETWINDOW (window
, w
);
30496 if (EQ (window
, hlinfo
->mouse_face_window
))
30497 clear_mouse_face (hlinfo
);
30503 Just discard the mouse face information for frame F, if any.
30504 This is used when the size of F is changed. */
30507 cancel_mouse_face (struct frame
*f
)
30509 Lisp_Object window
;
30510 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30512 window
= hlinfo
->mouse_face_window
;
30513 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
30514 reset_mouse_highlight (hlinfo
);
30519 /***********************************************************************
30521 ***********************************************************************/
30523 #ifdef HAVE_WINDOW_SYSTEM
30525 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
30526 which intersects rectangle R. R is in window-relative coordinates. */
30529 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
30530 enum glyph_row_area area
)
30532 struct glyph
*first
= row
->glyphs
[area
];
30533 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
30534 struct glyph
*last
;
30535 int first_x
, start_x
, x
;
30537 if (area
== TEXT_AREA
&& row
->fill_line_p
)
30538 /* If row extends face to end of line write the whole line. */
30539 draw_glyphs (w
, 0, row
, area
,
30540 0, row
->used
[area
],
30541 DRAW_NORMAL_TEXT
, 0);
30544 /* Set START_X to the window-relative start position for drawing glyphs of
30545 AREA. The first glyph of the text area can be partially visible.
30546 The first glyphs of other areas cannot. */
30547 start_x
= window_box_left_offset (w
, area
);
30549 if (area
== TEXT_AREA
)
30552 /* Find the first glyph that must be redrawn. */
30554 && x
+ first
->pixel_width
< r
->x
)
30556 x
+= first
->pixel_width
;
30560 /* Find the last one. */
30563 /* Use a signed int intermediate value to avoid catastrophic
30564 failures due to comparison between signed and unsigned, when
30565 x is negative (can happen for wide images that are hscrolled). */
30566 int r_end
= r
->x
+ r
->width
;
30567 while (last
< end
&& x
< r_end
)
30569 x
+= last
->pixel_width
;
30575 draw_glyphs (w
, first_x
- start_x
, row
, area
,
30576 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
30577 DRAW_NORMAL_TEXT
, 0);
30582 /* Redraw the parts of the glyph row ROW on window W intersecting
30583 rectangle R. R is in window-relative coordinates. Value is
30584 true if mouse-face was overwritten. */
30587 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
30589 eassert (row
->enabled_p
);
30591 if (row
->mode_line_p
|| w
->pseudo_window_p
)
30592 draw_glyphs (w
, 0, row
, TEXT_AREA
,
30593 0, row
->used
[TEXT_AREA
],
30594 DRAW_NORMAL_TEXT
, 0);
30597 if (row
->used
[LEFT_MARGIN_AREA
])
30598 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
30599 if (row
->used
[TEXT_AREA
])
30600 expose_area (w
, row
, r
, TEXT_AREA
);
30601 if (row
->used
[RIGHT_MARGIN_AREA
])
30602 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
30603 draw_row_fringe_bitmaps (w
, row
);
30606 return row
->mouse_face_p
;
30610 /* Redraw those parts of glyphs rows during expose event handling that
30611 overlap other rows. Redrawing of an exposed line writes over parts
30612 of lines overlapping that exposed line; this function fixes that.
30614 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
30615 row in W's current matrix that is exposed and overlaps other rows.
30616 LAST_OVERLAPPING_ROW is the last such row. */
30619 expose_overlaps (struct window
*w
,
30620 struct glyph_row
*first_overlapping_row
,
30621 struct glyph_row
*last_overlapping_row
,
30624 struct glyph_row
*row
;
30626 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
30627 if (row
->overlapping_p
)
30629 eassert (row
->enabled_p
&& !row
->mode_line_p
);
30632 if (row
->used
[LEFT_MARGIN_AREA
])
30633 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
30635 if (row
->used
[TEXT_AREA
])
30636 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
30638 if (row
->used
[RIGHT_MARGIN_AREA
])
30639 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
30645 /* Return true if W's cursor intersects rectangle R. */
30648 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
30650 XRectangle cr
, result
;
30651 struct glyph
*cursor_glyph
;
30652 struct glyph_row
*row
;
30654 if (w
->phys_cursor
.vpos
>= 0
30655 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
30656 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
30658 && row
->cursor_in_fringe_p
)
30660 /* Cursor is in the fringe. */
30661 cr
.x
= window_box_right_offset (w
,
30662 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
30663 ? RIGHT_MARGIN_AREA
30666 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
30667 cr
.height
= row
->height
;
30668 return x_intersect_rectangles (&cr
, r
, &result
);
30671 cursor_glyph
= get_phys_cursor_glyph (w
);
30674 /* r is relative to W's box, but w->phys_cursor.x is relative
30675 to left edge of W's TEXT area. Adjust it. */
30676 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
30677 cr
.y
= w
->phys_cursor
.y
;
30678 cr
.width
= cursor_glyph
->pixel_width
;
30679 cr
.height
= w
->phys_cursor_height
;
30680 /* ++KFS: W32 version used W32-specific IntersectRect here, but
30681 I assume the effect is the same -- and this is portable. */
30682 return x_intersect_rectangles (&cr
, r
, &result
);
30684 /* If we don't understand the format, pretend we're not in the hot-spot. */
30690 Draw a vertical window border to the right of window W if W doesn't
30691 have vertical scroll bars. */
30694 x_draw_vertical_border (struct window
*w
)
30696 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30698 /* We could do better, if we knew what type of scroll-bar the adjacent
30699 windows (on either side) have... But we don't :-(
30700 However, I think this works ok. ++KFS 2003-04-25 */
30702 /* Redraw borders between horizontally adjacent windows. Don't
30703 do it for frames with vertical scroll bars because either the
30704 right scroll bar of a window, or the left scroll bar of its
30705 neighbor will suffice as a border. */
30706 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
30709 /* Note: It is necessary to redraw both the left and the right
30710 borders, for when only this single window W is being
30712 if (!WINDOW_RIGHTMOST_P (w
)
30713 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
30715 int x0
, x1
, y0
, y1
;
30717 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30720 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30723 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
30726 if (!WINDOW_LEFTMOST_P (w
)
30727 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
30729 int x0
, x1
, y0
, y1
;
30731 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30734 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30737 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
30742 /* Draw window dividers for window W. */
30745 x_draw_right_divider (struct window
*w
)
30747 struct frame
*f
= WINDOW_XFRAME (w
);
30749 if (w
->mini
|| w
->pseudo_window_p
)
30751 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30753 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
30754 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30755 int y0
= WINDOW_TOP_EDGE_Y (w
);
30756 /* The bottom divider prevails. */
30757 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30759 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30764 x_draw_bottom_divider (struct window
*w
)
30766 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30768 if (w
->mini
|| w
->pseudo_window_p
)
30770 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30772 int x0
= WINDOW_LEFT_EDGE_X (w
);
30773 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30774 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30775 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
30777 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30781 /* Redraw the part of window W intersection rectangle FR. Pixel
30782 coordinates in FR are frame-relative. Call this function with
30783 input blocked. Value is true if the exposure overwrites
30787 expose_window (struct window
*w
, XRectangle
*fr
)
30789 struct frame
*f
= XFRAME (w
->frame
);
30791 bool mouse_face_overwritten_p
= false;
30793 /* If window is not yet fully initialized, do nothing. This can
30794 happen when toolkit scroll bars are used and a window is split.
30795 Reconfiguring the scroll bar will generate an expose for a newly
30797 if (w
->current_matrix
== NULL
)
30800 /* When we're currently updating the window, display and current
30801 matrix usually don't agree. Arrange for a thorough display
30803 if (w
->must_be_updated_p
)
30805 SET_FRAME_GARBAGED (f
);
30809 /* Frame-relative pixel rectangle of W. */
30810 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
30811 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
30812 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
30813 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
30815 if (x_intersect_rectangles (fr
, &wr
, &r
))
30817 int yb
= window_text_bottom_y (w
);
30818 struct glyph_row
*row
;
30819 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
30821 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
30822 r
.x
, r
.y
, r
.width
, r
.height
));
30824 /* Convert to window coordinates. */
30825 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
30826 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
30828 /* Turn off the cursor. */
30829 bool cursor_cleared_p
= (!w
->pseudo_window_p
30830 && phys_cursor_in_rect_p (w
, &r
));
30831 if (cursor_cleared_p
)
30832 x_clear_cursor (w
);
30834 /* If the row containing the cursor extends face to end of line,
30835 then expose_area might overwrite the cursor outside the
30836 rectangle and thus notice_overwritten_cursor might clear
30837 w->phys_cursor_on_p. We remember the original value and
30838 check later if it is changed. */
30839 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
30841 /* Use a signed int intermediate value to avoid catastrophic
30842 failures due to comparison between signed and unsigned, when
30843 y0 or y1 is negative (can happen for tall images). */
30844 int r_bottom
= r
.y
+ r
.height
;
30846 /* Update lines intersecting rectangle R. */
30847 first_overlapping_row
= last_overlapping_row
= NULL
;
30848 for (row
= w
->current_matrix
->rows
;
30853 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
30855 if ((y0
>= r
.y
&& y0
< r_bottom
)
30856 || (y1
> r
.y
&& y1
< r_bottom
)
30857 || (r
.y
>= y0
&& r
.y
< y1
)
30858 || (r_bottom
> y0
&& r_bottom
< y1
))
30860 /* A header line may be overlapping, but there is no need
30861 to fix overlapping areas for them. KFS 2005-02-12 */
30862 if (row
->overlapping_p
&& !row
->mode_line_p
)
30864 if (first_overlapping_row
== NULL
)
30865 first_overlapping_row
= row
;
30866 last_overlapping_row
= row
;
30870 if (expose_line (w
, row
, &r
))
30871 mouse_face_overwritten_p
= true;
30874 else if (row
->overlapping_p
)
30876 /* We must redraw a row overlapping the exposed area. */
30878 ? y0
+ row
->phys_height
> r
.y
30879 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30881 if (first_overlapping_row
== NULL
)
30882 first_overlapping_row
= row
;
30883 last_overlapping_row
= row
;
30891 /* Display the mode line if there is one. */
30892 if (WINDOW_WANTS_MODELINE_P (w
)
30893 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30895 && row
->y
< r_bottom
)
30897 if (expose_line (w
, row
, &r
))
30898 mouse_face_overwritten_p
= true;
30901 if (!w
->pseudo_window_p
)
30903 /* Fix the display of overlapping rows. */
30904 if (first_overlapping_row
)
30905 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30908 /* Draw border between windows. */
30909 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30910 x_draw_right_divider (w
);
30912 x_draw_vertical_border (w
);
30914 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30915 x_draw_bottom_divider (w
);
30917 /* Turn the cursor on again. */
30918 if (cursor_cleared_p
30919 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30920 update_window_cursor (w
, true);
30924 return mouse_face_overwritten_p
;
30929 /* Redraw (parts) of all windows in the window tree rooted at W that
30930 intersect R. R contains frame pixel coordinates. Value is
30931 true if the exposure overwrites mouse-face. */
30934 expose_window_tree (struct window
*w
, XRectangle
*r
)
30936 struct frame
*f
= XFRAME (w
->frame
);
30937 bool mouse_face_overwritten_p
= false;
30939 while (w
&& !FRAME_GARBAGED_P (f
))
30941 mouse_face_overwritten_p
30942 |= (WINDOWP (w
->contents
)
30943 ? expose_window_tree (XWINDOW (w
->contents
), r
)
30944 : expose_window (w
, r
));
30946 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
30949 return mouse_face_overwritten_p
;
30954 Redisplay an exposed area of frame F. X and Y are the upper-left
30955 corner of the exposed rectangle. W and H are width and height of
30956 the exposed area. All are pixel values. W or H zero means redraw
30957 the entire frame. */
30960 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
30963 bool mouse_face_overwritten_p
= false;
30965 TRACE ((stderr
, "expose_frame "));
30967 /* No need to redraw if frame will be redrawn soon. */
30968 if (FRAME_GARBAGED_P (f
))
30970 TRACE ((stderr
, " garbaged\n"));
30974 /* If basic faces haven't been realized yet, there is no point in
30975 trying to redraw anything. This can happen when we get an expose
30976 event while Emacs is starting, e.g. by moving another window. */
30977 if (FRAME_FACE_CACHE (f
) == NULL
30978 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
30980 TRACE ((stderr
, " no faces\n"));
30984 if (w
== 0 || h
== 0)
30987 r
.width
= FRAME_TEXT_WIDTH (f
);
30988 r
.height
= FRAME_TEXT_HEIGHT (f
);
30998 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
30999 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
31001 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
31002 if (WINDOWP (f
->tool_bar_window
))
31003 mouse_face_overwritten_p
31004 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
31007 #ifdef HAVE_X_WINDOWS
31009 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
31010 if (WINDOWP (f
->menu_bar_window
))
31011 mouse_face_overwritten_p
31012 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
31013 #endif /* not USE_X_TOOLKIT and not USE_GTK */
31017 /* Some window managers support a focus-follows-mouse style with
31018 delayed raising of frames. Imagine a partially obscured frame,
31019 and moving the mouse into partially obscured mouse-face on that
31020 frame. The visible part of the mouse-face will be highlighted,
31021 then the WM raises the obscured frame. With at least one WM, KDE
31022 2.1, Emacs is not getting any event for the raising of the frame
31023 (even tried with SubstructureRedirectMask), only Expose events.
31024 These expose events will draw text normally, i.e. not
31025 highlighted. Which means we must redo the highlight here.
31026 Subsume it under ``we love X''. --gerd 2001-08-15 */
31027 /* Included in Windows version because Windows most likely does not
31028 do the right thing if any third party tool offers
31029 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
31030 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
31032 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
31033 if (f
== hlinfo
->mouse_face_mouse_frame
)
31035 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
31036 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
31037 clear_mouse_face (hlinfo
);
31038 note_mouse_highlight (f
, mouse_x
, mouse_y
);
31045 Determine the intersection of two rectangles R1 and R2. Return
31046 the intersection in *RESULT. Value is true if RESULT is not
31050 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
31052 XRectangle
*left
, *right
;
31053 XRectangle
*upper
, *lower
;
31054 bool intersection_p
= false;
31056 /* Rearrange so that R1 is the left-most rectangle. */
31058 left
= r1
, right
= r2
;
31060 left
= r2
, right
= r1
;
31062 /* X0 of the intersection is right.x0, if this is inside R1,
31063 otherwise there is no intersection. */
31064 if (right
->x
<= left
->x
+ left
->width
)
31066 result
->x
= right
->x
;
31068 /* The right end of the intersection is the minimum of
31069 the right ends of left and right. */
31070 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
31073 /* Same game for Y. */
31075 upper
= r1
, lower
= r2
;
31077 upper
= r2
, lower
= r1
;
31079 /* The upper end of the intersection is lower.y0, if this is inside
31080 of upper. Otherwise, there is no intersection. */
31081 if (lower
->y
<= upper
->y
+ upper
->height
)
31083 result
->y
= lower
->y
;
31085 /* The lower end of the intersection is the minimum of the lower
31086 ends of upper and lower. */
31087 result
->height
= (min (lower
->y
+ lower
->height
,
31088 upper
->y
+ upper
->height
)
31090 intersection_p
= true;
31094 return intersection_p
;
31097 #endif /* HAVE_WINDOW_SYSTEM */
31100 /***********************************************************************
31102 ***********************************************************************/
31105 syms_of_xdisp (void)
31107 Vwith_echo_area_save_vector
= Qnil
;
31108 staticpro (&Vwith_echo_area_save_vector
);
31110 Vmessage_stack
= Qnil
;
31111 staticpro (&Vmessage_stack
);
31113 /* Non-nil means don't actually do any redisplay. */
31114 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
31116 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
31118 DEFVAR_BOOL("inhibit-message", inhibit_message
,
31119 doc
: /* Non-nil means calls to `message' are not displayed.
31120 They are still logged to the *Messages* buffer. */);
31121 inhibit_message
= 0;
31123 message_dolog_marker1
= Fmake_marker ();
31124 staticpro (&message_dolog_marker1
);
31125 message_dolog_marker2
= Fmake_marker ();
31126 staticpro (&message_dolog_marker2
);
31127 message_dolog_marker3
= Fmake_marker ();
31128 staticpro (&message_dolog_marker3
);
31131 defsubr (&Sdump_frame_glyph_matrix
);
31132 defsubr (&Sdump_glyph_matrix
);
31133 defsubr (&Sdump_glyph_row
);
31134 defsubr (&Sdump_tool_bar_row
);
31135 defsubr (&Strace_redisplay
);
31136 defsubr (&Strace_to_stderr
);
31138 #ifdef HAVE_WINDOW_SYSTEM
31139 defsubr (&Stool_bar_height
);
31140 defsubr (&Slookup_image_map
);
31142 defsubr (&Sline_pixel_height
);
31143 defsubr (&Sformat_mode_line
);
31144 defsubr (&Sinvisible_p
);
31145 defsubr (&Scurrent_bidi_paragraph_direction
);
31146 defsubr (&Swindow_text_pixel_size
);
31147 defsubr (&Smove_point_visually
);
31148 defsubr (&Sbidi_find_overridden_directionality
);
31150 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
31151 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
31152 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
31153 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
31154 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
31155 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
31156 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
31157 DEFSYM (Qeval
, "eval");
31158 DEFSYM (QCdata
, ":data");
31160 /* Names of text properties relevant for redisplay. */
31161 DEFSYM (Qdisplay
, "display");
31162 DEFSYM (Qspace_width
, "space-width");
31163 DEFSYM (Qraise
, "raise");
31164 DEFSYM (Qslice
, "slice");
31165 DEFSYM (Qspace
, "space");
31166 DEFSYM (Qmargin
, "margin");
31167 DEFSYM (Qpointer
, "pointer");
31168 DEFSYM (Qleft_margin
, "left-margin");
31169 DEFSYM (Qright_margin
, "right-margin");
31170 DEFSYM (Qcenter
, "center");
31171 DEFSYM (Qline_height
, "line-height");
31172 DEFSYM (QCalign_to
, ":align-to");
31173 DEFSYM (QCrelative_width
, ":relative-width");
31174 DEFSYM (QCrelative_height
, ":relative-height");
31175 DEFSYM (QCeval
, ":eval");
31176 DEFSYM (QCpropertize
, ":propertize");
31177 DEFSYM (QCfile
, ":file");
31178 DEFSYM (Qfontified
, "fontified");
31179 DEFSYM (Qfontification_functions
, "fontification-functions");
31181 /* Name of the face used to highlight trailing whitespace. */
31182 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
31184 /* Name and number of the face used to highlight escape glyphs. */
31185 DEFSYM (Qescape_glyph
, "escape-glyph");
31187 /* Name and number of the face used to highlight non-breaking spaces. */
31188 DEFSYM (Qnobreak_space
, "nobreak-space");
31190 /* The symbol 'image' which is the car of the lists used to represent
31191 images in Lisp. Also a tool bar style. */
31192 DEFSYM (Qimage
, "image");
31194 /* Tool bar styles. */
31195 DEFSYM (Qtext
, "text");
31196 DEFSYM (Qboth
, "both");
31197 DEFSYM (Qboth_horiz
, "both-horiz");
31198 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
31200 /* The image map types. */
31201 DEFSYM (QCmap
, ":map");
31202 DEFSYM (QCpointer
, ":pointer");
31203 DEFSYM (Qrect
, "rect");
31204 DEFSYM (Qcircle
, "circle");
31205 DEFSYM (Qpoly
, "poly");
31207 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
31209 DEFSYM (Qgrow_only
, "grow-only");
31210 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
31211 DEFSYM (Qposition
, "position");
31212 DEFSYM (Qbuffer_position
, "buffer-position");
31213 DEFSYM (Qobject
, "object");
31215 /* Cursor shapes. */
31216 DEFSYM (Qbar
, "bar");
31217 DEFSYM (Qhbar
, "hbar");
31218 DEFSYM (Qbox
, "box");
31219 DEFSYM (Qhollow
, "hollow");
31221 /* Pointer shapes. */
31222 DEFSYM (Qhand
, "hand");
31223 DEFSYM (Qarrow
, "arrow");
31226 DEFSYM (Qdragging
, "dragging");
31228 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
31230 list_of_error
= list1 (list2 (Qerror
, Qvoid_variable
));
31231 staticpro (&list_of_error
);
31233 /* Values of those variables at last redisplay are stored as
31234 properties on 'overlay-arrow-position' symbol. However, if
31235 Voverlay_arrow_position is a marker, last-arrow-position is its
31236 numerical position. */
31237 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
31238 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
31240 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
31241 properties on a symbol in overlay-arrow-variable-list. */
31242 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
31243 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
31245 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
31246 staticpro (&echo_buffer
[0]);
31247 staticpro (&echo_buffer
[1]);
31249 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
31250 staticpro (&echo_area_buffer
[0]);
31251 staticpro (&echo_area_buffer
[1]);
31253 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
31254 staticpro (&Vmessages_buffer_name
);
31256 mode_line_proptrans_alist
= Qnil
;
31257 staticpro (&mode_line_proptrans_alist
);
31258 mode_line_string_list
= Qnil
;
31259 staticpro (&mode_line_string_list
);
31260 mode_line_string_face
= Qnil
;
31261 staticpro (&mode_line_string_face
);
31262 mode_line_string_face_prop
= Qnil
;
31263 staticpro (&mode_line_string_face_prop
);
31264 Vmode_line_unwind_vector
= Qnil
;
31265 staticpro (&Vmode_line_unwind_vector
);
31267 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
31269 help_echo_string
= Qnil
;
31270 staticpro (&help_echo_string
);
31271 help_echo_object
= Qnil
;
31272 staticpro (&help_echo_object
);
31273 help_echo_window
= Qnil
;
31274 staticpro (&help_echo_window
);
31275 previous_help_echo_string
= Qnil
;
31276 staticpro (&previous_help_echo_string
);
31277 help_echo_pos
= -1;
31279 DEFSYM (Qright_to_left
, "right-to-left");
31280 DEFSYM (Qleft_to_right
, "left-to-right");
31281 defsubr (&Sbidi_resolved_levels
);
31283 #ifdef HAVE_WINDOW_SYSTEM
31284 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
31285 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
31286 For example, if a block cursor is over a tab, it will be drawn as
31287 wide as that tab on the display. */);
31288 x_stretch_cursor_p
= 0;
31291 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
31292 doc
: /* Non-nil means highlight trailing whitespace.
31293 The face used for trailing whitespace is `trailing-whitespace'. */);
31294 Vshow_trailing_whitespace
= Qnil
;
31296 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
31297 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
31298 If the value is t, Emacs highlights non-ASCII chars which have the
31299 same appearance as an ASCII space or hyphen, using the `nobreak-space'
31300 or `escape-glyph' face respectively.
31302 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
31303 U+2011 (non-breaking hyphen) are affected.
31305 Any other non-nil value means to display these characters as a escape
31306 glyph followed by an ordinary space or hyphen.
31308 A value of nil means no special handling of these characters. */);
31309 Vnobreak_char_display
= Qt
;
31311 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
31312 doc
: /* The pointer shape to show in void text areas.
31313 A value of nil means to show the text pointer. Other options are
31314 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
31316 Vvoid_text_area_pointer
= Qarrow
;
31318 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
31319 doc
: /* Non-nil means don't actually do any redisplay.
31320 This is used for internal purposes. */);
31321 Vinhibit_redisplay
= Qnil
;
31323 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
31324 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
31325 Vglobal_mode_string
= Qnil
;
31327 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
31328 doc
: /* Marker for where to display an arrow on top of the buffer text.
31329 This must be the beginning of a line in order to work.
31330 See also `overlay-arrow-string'. */);
31331 Voverlay_arrow_position
= Qnil
;
31333 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
31334 doc
: /* String to display as an arrow in non-window frames.
31335 See also `overlay-arrow-position'. */);
31336 Voverlay_arrow_string
= build_pure_c_string ("=>");
31338 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
31339 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
31340 The symbols on this list are examined during redisplay to determine
31341 where to display overlay arrows. */);
31342 Voverlay_arrow_variable_list
31343 = list1 (intern_c_string ("overlay-arrow-position"));
31345 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
31346 doc
: /* The number of lines to try scrolling a window by when point moves out.
31347 If that fails to bring point back on frame, point is centered instead.
31348 If this is zero, point is always centered after it moves off frame.
31349 If you want scrolling to always be a line at a time, you should set
31350 `scroll-conservatively' to a large value rather than set this to 1. */);
31352 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
31353 doc
: /* Scroll up to this many lines, to bring point back on screen.
31354 If point moves off-screen, redisplay will scroll by up to
31355 `scroll-conservatively' lines in order to bring point just barely
31356 onto the screen again. If that cannot be done, then redisplay
31357 recenters point as usual.
31359 If the value is greater than 100, redisplay will never recenter point,
31360 but will always scroll just enough text to bring point into view, even
31361 if you move far away.
31363 A value of zero means always recenter point if it moves off screen. */);
31364 scroll_conservatively
= 0;
31366 DEFVAR_INT ("scroll-margin", scroll_margin
,
31367 doc
: /* Number of lines of margin at the top and bottom of a window.
31368 Recenter the window whenever point gets within this many lines
31369 of the top or bottom of the window. */);
31372 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
31373 doc
: /* Pixels per inch value for non-window system displays.
31374 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
31375 Vdisplay_pixels_per_inch
= make_float (72.0);
31378 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
31381 DEFVAR_LISP ("truncate-partial-width-windows",
31382 Vtruncate_partial_width_windows
,
31383 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
31384 For an integer value, truncate lines in each window narrower than the
31385 full frame width, provided the window width is less than that integer;
31386 otherwise, respect the value of `truncate-lines'.
31388 For any other non-nil value, truncate lines in all windows that do
31389 not span the full frame width.
31391 A value of nil means to respect the value of `truncate-lines'.
31393 If `word-wrap' is enabled, you might want to reduce this. */);
31394 Vtruncate_partial_width_windows
= make_number (50);
31396 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
31397 doc
: /* Maximum buffer size for which line number should be displayed.
31398 If the buffer is bigger than this, the line number does not appear
31399 in the mode line. A value of nil means no limit. */);
31400 Vline_number_display_limit
= Qnil
;
31402 DEFVAR_INT ("line-number-display-limit-width",
31403 line_number_display_limit_width
,
31404 doc
: /* Maximum line width (in characters) for line number display.
31405 If the average length of the lines near point is bigger than this, then the
31406 line number may be omitted from the mode line. */);
31407 line_number_display_limit_width
= 200;
31409 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
31410 doc
: /* Non-nil means highlight region even in nonselected windows. */);
31411 highlight_nonselected_windows
= false;
31413 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
31414 doc
: /* Non-nil if more than one frame is visible on this display.
31415 Minibuffer-only frames don't count, but iconified frames do.
31416 This variable is not guaranteed to be accurate except while processing
31417 `frame-title-format' and `icon-title-format'. */);
31419 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
31420 doc
: /* Template for displaying the title bar of visible frames.
31421 (Assuming the window manager supports this feature.)
31423 This variable has the same structure as `mode-line-format', except that
31424 the %c and %l constructs are ignored. It is used only on frames for
31425 which no explicit name has been set (see `modify-frame-parameters'). */);
31427 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
31428 doc
: /* Template for displaying the title bar of an iconified frame.
31429 (Assuming the window manager supports this feature.)
31430 This variable has the same structure as `mode-line-format' (which see),
31431 and is used only on frames for which no explicit name has been set
31432 (see `modify-frame-parameters'). */);
31434 = Vframe_title_format
31435 = listn (CONSTYPE_PURE
, 3,
31436 intern_c_string ("multiple-frames"),
31437 build_pure_c_string ("%b"),
31438 listn (CONSTYPE_PURE
, 4,
31439 empty_unibyte_string
,
31440 intern_c_string ("invocation-name"),
31441 build_pure_c_string ("@"),
31442 intern_c_string ("system-name")));
31444 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
31445 doc
: /* Maximum number of lines to keep in the message log buffer.
31446 If nil, disable message logging. If t, log messages but don't truncate
31447 the buffer when it becomes large. */);
31448 Vmessage_log_max
= make_number (1000);
31450 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
31451 doc
: /* Functions called during redisplay, if window sizes have changed.
31452 The value should be a list of functions that take one argument.
31453 During the first part of redisplay, for each frame, if any of its windows
31454 have changed size since the last redisplay, or have been split or deleted,
31455 all the functions in the list are called, with the frame as argument.
31456 If redisplay decides to resize the minibuffer window, it calls these
31457 functions on behalf of that as well. */);
31458 Vwindow_size_change_functions
= Qnil
;
31460 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
31461 doc
: /* List of functions to call before redisplaying a window with scrolling.
31462 Each function is called with two arguments, the window and its new
31463 display-start position.
31464 These functions are called whenever the `window-start' marker is modified,
31465 either to point into another buffer (e.g. via `set-window-buffer') or another
31466 place in the same buffer.
31467 Note that the value of `window-end' is not valid when these functions are
31470 Warning: Do not use this feature to alter the way the window
31471 is scrolled. It is not designed for that, and such use probably won't
31473 Vwindow_scroll_functions
= Qnil
;
31475 DEFVAR_LISP ("window-text-change-functions",
31476 Vwindow_text_change_functions
,
31477 doc
: /* Functions to call in redisplay when text in the window might change. */);
31478 Vwindow_text_change_functions
= Qnil
;
31480 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
31481 doc
: /* Functions called when redisplay of a window reaches the end trigger.
31482 Each function is called with two arguments, the window and the end trigger value.
31483 See `set-window-redisplay-end-trigger'. */);
31484 Vredisplay_end_trigger_functions
= Qnil
;
31486 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
31487 doc
: /* Non-nil means autoselect window with mouse pointer.
31488 If nil, do not autoselect windows.
31489 A positive number means delay autoselection by that many seconds: a
31490 window is autoselected only after the mouse has remained in that
31491 window for the duration of the delay.
31492 A negative number has a similar effect, but causes windows to be
31493 autoselected only after the mouse has stopped moving. (Because of
31494 the way Emacs compares mouse events, you will occasionally wait twice
31495 that time before the window gets selected.)
31496 Any other value means to autoselect window instantaneously when the
31497 mouse pointer enters it.
31499 Autoselection selects the minibuffer only if it is active, and never
31500 unselects the minibuffer if it is active.
31502 When customizing this variable make sure that the actual value of
31503 `focus-follows-mouse' matches the behavior of your window manager. */);
31504 Vmouse_autoselect_window
= Qnil
;
31506 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
31507 doc
: /* Non-nil means automatically resize tool-bars.
31508 This dynamically changes the tool-bar's height to the minimum height
31509 that is needed to make all tool-bar items visible.
31510 If value is `grow-only', the tool-bar's height is only increased
31511 automatically; to decrease the tool-bar height, use \\[recenter]. */);
31512 Vauto_resize_tool_bars
= Qt
;
31514 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
31515 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
31516 auto_raise_tool_bar_buttons_p
= true;
31518 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
31519 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
31520 make_cursor_line_fully_visible_p
= true;
31522 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
31523 doc
: /* Border below tool-bar in pixels.
31524 If an integer, use it as the height of the border.
31525 If it is one of `internal-border-width' or `border-width', use the
31526 value of the corresponding frame parameter.
31527 Otherwise, no border is added below the tool-bar. */);
31528 Vtool_bar_border
= Qinternal_border_width
;
31530 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
31531 doc
: /* Margin around tool-bar buttons in pixels.
31532 If an integer, use that for both horizontal and vertical margins.
31533 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
31534 HORZ specifying the horizontal margin, and VERT specifying the
31535 vertical margin. */);
31536 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
31538 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
31539 doc
: /* Relief thickness of tool-bar buttons. */);
31540 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
31542 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
31543 doc
: /* Tool bar style to use.
31545 image - show images only
31546 text - show text only
31547 both - show both, text below image
31548 both-horiz - show text to the right of the image
31549 text-image-horiz - show text to the left of the image
31550 any other - use system default or image if no system default.
31552 This variable only affects the GTK+ toolkit version of Emacs. */);
31553 Vtool_bar_style
= Qnil
;
31555 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
31556 doc
: /* Maximum number of characters a label can have to be shown.
31557 The tool bar style must also show labels for this to have any effect, see
31558 `tool-bar-style'. */);
31559 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
31561 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
31562 doc
: /* List of functions to call to fontify regions of text.
31563 Each function is called with one argument POS. Functions must
31564 fontify a region starting at POS in the current buffer, and give
31565 fontified regions the property `fontified'. */);
31566 Vfontification_functions
= Qnil
;
31567 Fmake_variable_buffer_local (Qfontification_functions
);
31569 DEFVAR_BOOL ("unibyte-display-via-language-environment",
31570 unibyte_display_via_language_environment
,
31571 doc
: /* Non-nil means display unibyte text according to language environment.
31572 Specifically, this means that raw bytes in the range 160-255 decimal
31573 are displayed by converting them to the equivalent multibyte characters
31574 according to the current language environment. As a result, they are
31575 displayed according to the current fontset.
31577 Note that this variable affects only how these bytes are displayed,
31578 but does not change the fact they are interpreted as raw bytes. */);
31579 unibyte_display_via_language_environment
= false;
31581 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
31582 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
31583 If a float, it specifies a fraction of the mini-window frame's height.
31584 If an integer, it specifies a number of lines. */);
31585 Vmax_mini_window_height
= make_float (0.25);
31587 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
31588 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
31589 A value of nil means don't automatically resize mini-windows.
31590 A value of t means resize them to fit the text displayed in them.
31591 A value of `grow-only', the default, means let mini-windows grow only;
31592 they return to their normal size when the minibuffer is closed, or the
31593 echo area becomes empty. */);
31594 Vresize_mini_windows
= Qgrow_only
;
31596 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
31597 doc
: /* Alist specifying how to blink the cursor off.
31598 Each element has the form (ON-STATE . OFF-STATE). Whenever the
31599 `cursor-type' frame-parameter or variable equals ON-STATE,
31600 comparing using `equal', Emacs uses OFF-STATE to specify
31601 how to blink it off. ON-STATE and OFF-STATE are values for
31602 the `cursor-type' frame parameter.
31604 If a frame's ON-STATE has no entry in this list,
31605 the frame's other specifications determine how to blink the cursor off. */);
31606 Vblink_cursor_alist
= Qnil
;
31608 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
31609 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
31610 If non-nil, windows are automatically scrolled horizontally to make
31611 point visible. */);
31612 automatic_hscrolling_p
= true;
31613 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
31615 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
31616 doc
: /* How many columns away from the window edge point is allowed to get
31617 before automatic hscrolling will horizontally scroll the window. */);
31618 hscroll_margin
= 5;
31620 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
31621 doc
: /* How many columns to scroll the window when point gets too close to the edge.
31622 When point is less than `hscroll-margin' columns from the window
31623 edge, automatic hscrolling will scroll the window by the amount of columns
31624 determined by this variable. If its value is a positive integer, scroll that
31625 many columns. If it's a positive floating-point number, it specifies the
31626 fraction of the window's width to scroll. If it's nil or zero, point will be
31627 centered horizontally after the scroll. Any other value, including negative
31628 numbers, are treated as if the value were zero.
31630 Automatic hscrolling always moves point outside the scroll margin, so if
31631 point was more than scroll step columns inside the margin, the window will
31632 scroll more than the value given by the scroll step.
31634 Note that the lower bound for automatic hscrolling specified by `scroll-left'
31635 and `scroll-right' overrides this variable's effect. */);
31636 Vhscroll_step
= make_number (0);
31638 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
31639 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
31640 Bind this around calls to `message' to let it take effect. */);
31641 message_truncate_lines
= false;
31643 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
31644 doc
: /* Normal hook run to update the menu bar definitions.
31645 Redisplay runs this hook before it redisplays the menu bar.
31646 This is used to update menus such as Buffers, whose contents depend on
31648 Vmenu_bar_update_hook
= Qnil
;
31650 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
31651 doc
: /* Frame for which we are updating a menu.
31652 The enable predicate for a menu binding should check this variable. */);
31653 Vmenu_updating_frame
= Qnil
;
31655 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
31656 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
31657 inhibit_menubar_update
= false;
31659 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
31660 doc
: /* Prefix prepended to all continuation lines at display time.
31661 The value may be a string, an image, or a stretch-glyph; it is
31662 interpreted in the same way as the value of a `display' text property.
31664 This variable is overridden by any `wrap-prefix' text or overlay
31667 To add a prefix to non-continuation lines, use `line-prefix'. */);
31668 Vwrap_prefix
= Qnil
;
31669 DEFSYM (Qwrap_prefix
, "wrap-prefix");
31670 Fmake_variable_buffer_local (Qwrap_prefix
);
31672 DEFVAR_LISP ("line-prefix", Vline_prefix
,
31673 doc
: /* Prefix prepended to all non-continuation lines at display time.
31674 The value may be a string, an image, or a stretch-glyph; it is
31675 interpreted in the same way as the value of a `display' text property.
31677 This variable is overridden by any `line-prefix' text or overlay
31680 To add a prefix to continuation lines, use `wrap-prefix'. */);
31681 Vline_prefix
= Qnil
;
31682 DEFSYM (Qline_prefix
, "line-prefix");
31683 Fmake_variable_buffer_local (Qline_prefix
);
31685 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
31686 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
31687 inhibit_eval_during_redisplay
= false;
31689 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
31690 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
31691 inhibit_free_realized_faces
= false;
31693 DEFVAR_BOOL ("inhibit-bidi-mirroring", inhibit_bidi_mirroring
,
31694 doc
: /* Non-nil means don't mirror characters even when bidi context requires that.
31695 Intended for use during debugging and for testing bidi display;
31696 see biditest.el in the test suite. */);
31697 inhibit_bidi_mirroring
= false;
31700 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
31701 doc
: /* Inhibit try_window_id display optimization. */);
31702 inhibit_try_window_id
= false;
31704 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
31705 doc
: /* Inhibit try_window_reusing display optimization. */);
31706 inhibit_try_window_reusing
= false;
31708 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
31709 doc
: /* Inhibit try_cursor_movement display optimization. */);
31710 inhibit_try_cursor_movement
= false;
31711 #endif /* GLYPH_DEBUG */
31713 DEFVAR_INT ("overline-margin", overline_margin
,
31714 doc
: /* Space between overline and text, in pixels.
31715 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
31716 margin to the character height. */);
31717 overline_margin
= 2;
31719 DEFVAR_INT ("underline-minimum-offset",
31720 underline_minimum_offset
,
31721 doc
: /* Minimum distance between baseline and underline.
31722 This can improve legibility of underlined text at small font sizes,
31723 particularly when using variable `x-use-underline-position-properties'
31724 with fonts that specify an UNDERLINE_POSITION relatively close to the
31725 baseline. The default value is 1. */);
31726 underline_minimum_offset
= 1;
31728 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
31729 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
31730 This feature only works when on a window system that can change
31731 cursor shapes. */);
31732 display_hourglass_p
= true;
31734 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
31735 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
31736 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
31738 #ifdef HAVE_WINDOW_SYSTEM
31739 hourglass_atimer
= NULL
;
31740 hourglass_shown_p
= false;
31741 #endif /* HAVE_WINDOW_SYSTEM */
31743 /* Name of the face used to display glyphless characters. */
31744 DEFSYM (Qglyphless_char
, "glyphless-char");
31746 /* Method symbols for Vglyphless_char_display. */
31747 DEFSYM (Qhex_code
, "hex-code");
31748 DEFSYM (Qempty_box
, "empty-box");
31749 DEFSYM (Qthin_space
, "thin-space");
31750 DEFSYM (Qzero_width
, "zero-width");
31752 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
31753 doc
: /* Function run just before redisplay.
31754 It is called with one argument, which is the set of windows that are to
31755 be redisplayed. This set can be nil (meaning, only the selected window),
31756 or t (meaning all windows). */);
31757 Vpre_redisplay_function
= intern ("ignore");
31759 /* Symbol for the purpose of Vglyphless_char_display. */
31760 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
31761 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
31763 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
31764 doc
: /* Char-table defining glyphless characters.
31765 Each element, if non-nil, should be one of the following:
31766 an ASCII acronym string: display this string in a box
31767 `hex-code': display the hexadecimal code of a character in a box
31768 `empty-box': display as an empty box
31769 `thin-space': display as 1-pixel width space
31770 `zero-width': don't display
31771 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
31772 display method for graphical terminals and text terminals respectively.
31773 GRAPHICAL and TEXT should each have one of the values listed above.
31775 The char-table has one extra slot to control the display of a character for
31776 which no font is found. This slot only takes effect on graphical terminals.
31777 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
31778 `thin-space'. The default is `empty-box'.
31780 If a character has a non-nil entry in an active display table, the
31781 display table takes effect; in this case, Emacs does not consult
31782 `glyphless-char-display' at all. */);
31783 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
31784 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
31787 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
31788 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
31789 Vdebug_on_message
= Qnil
;
31791 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
31793 Vredisplay__all_windows_cause
= Fmake_hash_table (0, NULL
);
31795 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
31797 Vredisplay__mode_lines_cause
= Fmake_hash_table (0, NULL
);
31799 DEFVAR_LISP ("redisplay--variables", Vredisplay__variables
,
31800 doc
: /* A hash-table of variables changing which triggers a thorough redisplay. */);
31801 Vredisplay__variables
= Qnil
;
31805 /* Initialize this module when Emacs starts. */
31810 CHARPOS (this_line_start_pos
) = 0;
31812 if (!noninteractive
)
31814 struct window
*m
= XWINDOW (minibuf_window
);
31815 Lisp_Object frame
= m
->frame
;
31816 struct frame
*f
= XFRAME (frame
);
31817 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
31818 struct window
*r
= XWINDOW (root
);
31821 echo_area_window
= minibuf_window
;
31823 r
->top_line
= FRAME_TOP_MARGIN (f
);
31824 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
31825 r
->total_cols
= FRAME_COLS (f
);
31826 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31827 r
->total_lines
= FRAME_TOTAL_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
31828 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
31830 m
->top_line
= FRAME_TOTAL_LINES (f
) - 1;
31831 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
31832 m
->total_cols
= FRAME_COLS (f
);
31833 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31834 m
->total_lines
= 1;
31835 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
31837 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
31838 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
31839 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
31841 /* The default ellipsis glyphs `...'. */
31842 for (i
= 0; i
< 3; ++i
)
31843 default_invis_vector
[i
] = make_number ('.');
31847 /* Allocate the buffer for frame titles.
31848 Also used for `format-mode-line'. */
31850 mode_line_noprop_buf
= xmalloc (size
);
31851 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
31852 mode_line_noprop_ptr
= mode_line_noprop_buf
;
31853 mode_line_target
= MODE_LINE_DISPLAY
;
31856 help_echo_showing_p
= false;
31859 #ifdef HAVE_WINDOW_SYSTEM
31861 /* Platform-independent portion of hourglass implementation. */
31863 /* Timer function of hourglass_atimer. */
31866 show_hourglass (struct atimer
*timer
)
31868 /* The timer implementation will cancel this timer automatically
31869 after this function has run. Set hourglass_atimer to null
31870 so that we know the timer doesn't have to be canceled. */
31871 hourglass_atimer
= NULL
;
31873 if (!hourglass_shown_p
)
31875 Lisp_Object tail
, frame
;
31879 FOR_EACH_FRAME (tail
, frame
)
31881 struct frame
*f
= XFRAME (frame
);
31883 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31884 && FRAME_RIF (f
)->show_hourglass
)
31885 FRAME_RIF (f
)->show_hourglass (f
);
31888 hourglass_shown_p
= true;
31893 /* Cancel a currently active hourglass timer, and start a new one. */
31896 start_hourglass (void)
31898 struct timespec delay
;
31900 cancel_hourglass ();
31902 if (INTEGERP (Vhourglass_delay
)
31903 && XINT (Vhourglass_delay
) > 0)
31904 delay
= make_timespec (min (XINT (Vhourglass_delay
),
31905 TYPE_MAXIMUM (time_t)),
31907 else if (FLOATP (Vhourglass_delay
)
31908 && XFLOAT_DATA (Vhourglass_delay
) > 0)
31909 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
31911 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
31913 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
31914 show_hourglass
, NULL
);
31917 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31921 cancel_hourglass (void)
31923 if (hourglass_atimer
)
31925 cancel_atimer (hourglass_atimer
);
31926 hourglass_atimer
= NULL
;
31929 if (hourglass_shown_p
)
31931 Lisp_Object tail
, frame
;
31935 FOR_EACH_FRAME (tail
, frame
)
31937 struct frame
*f
= XFRAME (frame
);
31939 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31940 && FRAME_RIF (f
)->hide_hourglass
)
31941 FRAME_RIF (f
)->hide_hourglass (f
);
31943 /* No cursors on non GUI frames - restore to stock arrow cursor. */
31944 else if (!FRAME_W32_P (f
))
31945 w32_arrow_cursor ();
31949 hourglass_shown_p
= false;
31954 #endif /* HAVE_WINDOW_SYSTEM */