1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2016 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or (at
11 your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
25 Emacs separates the task of updating the display from code
26 modifying global state, e.g. buffer text. This way functions
27 operating on buffers don't also have to be concerned with updating
30 Updating the display is triggered by the Lisp interpreter when it
31 decides it's time to do it. This is done either automatically for
32 you as part of the interpreter's command loop or as the result of
33 calling Lisp functions like `sit-for'. The C function `redisplay'
34 in xdisp.c is the only entry into the inner redisplay code.
36 The following diagram shows how redisplay code is invoked. As you
37 can see, Lisp calls redisplay and vice versa. Under window systems
38 like X, some portions of the redisplay code are also called
39 asynchronously during mouse movement or expose events. It is very
40 important that these code parts do NOT use the C library (malloc,
41 free) because many C libraries under Unix are not reentrant. They
42 may also NOT call functions of the Lisp interpreter which could
43 change the interpreter's state. If you don't follow these rules,
44 you will encounter bugs which are very hard to explain.
46 +--------------+ redisplay +----------------+
47 | Lisp machine |---------------->| Redisplay code |<--+
48 +--------------+ (xdisp.c) +----------------+ |
50 +----------------------------------+ |
51 Don't use this path when called |
54 expose_window (asynchronous) |
56 X expose events -----+
58 What does redisplay do? Obviously, it has to figure out somehow what
59 has been changed since the last time the display has been updated,
60 and to make these changes visible. Preferably it would do that in
61 a moderately intelligent way, i.e. fast.
63 Changes in buffer text can be deduced from window and buffer
64 structures, and from some global variables like `beg_unchanged' and
65 `end_unchanged'. The contents of the display are additionally
66 recorded in a `glyph matrix', a two-dimensional matrix of glyph
67 structures. Each row in such a matrix corresponds to a line on the
68 display, and each glyph in a row corresponds to a column displaying
69 a character, an image, or what else. This matrix is called the
70 `current glyph matrix' or `current matrix' in redisplay
73 For buffer parts that have been changed since the last update, a
74 second glyph matrix is constructed, the so called `desired glyph
75 matrix' or short `desired matrix'. Current and desired matrix are
76 then compared to find a cheap way to update the display, e.g. by
77 reusing part of the display by scrolling lines.
79 You will find a lot of redisplay optimizations when you start
80 looking at the innards of redisplay. The overall goal of all these
81 optimizations is to make redisplay fast because it is done
82 frequently. Some of these optimizations are implemented by the
87 This function tries to update the display if the text in the
88 window did not change and did not scroll, only point moved, and
89 it did not move off the displayed portion of the text.
91 . try_window_reusing_current_matrix
93 This function reuses the current matrix of a window when text
94 has not changed, but the window start changed (e.g., due to
99 This function attempts to redisplay a window by reusing parts of
100 its existing display. It finds and reuses the part that was not
101 changed, and redraws the rest. (The "id" part in the function's
102 name stands for "insert/delete", not for "identification" or
107 This function performs the full redisplay of a single window
108 assuming that its fonts were not changed and that the cursor
109 will not end up in the scroll margins. (Loading fonts requires
110 re-adjustment of dimensions of glyph matrices, which makes this
111 method impossible to use.)
113 These optimizations are tried in sequence (some can be skipped if
114 it is known that they are not applicable). If none of the
115 optimizations were successful, redisplay calls redisplay_windows,
116 which performs a full redisplay of all windows.
118 Note that there's one more important optimization up Emacs's
119 sleeve, but it is related to actually redrawing the potentially
120 changed portions of the window/frame, not to reproducing the
121 desired matrices of those potentially changed portions. Namely,
122 the function update_frame and its subroutines, which you will find
123 in dispnew.c, compare the desired matrices with the current
124 matrices, and only redraw the portions that changed. So it could
125 happen that the functions in this file for some reason decide that
126 the entire desired matrix needs to be regenerated from scratch, and
127 still only parts of the Emacs display, or even nothing at all, will
128 be actually delivered to the glass, because update_frame has found
129 that the new and the old screen contents are similar or identical.
133 Desired matrices are always built per Emacs window. The function
134 `display_line' is the central function to look at if you are
135 interested. It constructs one row in a desired matrix given an
136 iterator structure containing both a buffer position and a
137 description of the environment in which the text is to be
138 displayed. But this is too early, read on.
140 Characters and pixmaps displayed for a range of buffer text depend
141 on various settings of buffers and windows, on overlays and text
142 properties, on display tables, on selective display. The good news
143 is that all this hairy stuff is hidden behind a small set of
144 interface functions taking an iterator structure (struct it)
147 Iteration over things to be displayed is then simple. It is
148 started by initializing an iterator with a call to init_iterator,
149 passing it the buffer position where to start iteration. For
150 iteration over strings, pass -1 as the position to init_iterator,
151 and call reseat_to_string when the string is ready, to initialize
152 the iterator for that string. Thereafter, calls to
153 get_next_display_element fill the iterator structure with relevant
154 information about the next thing to display. Calls to
155 set_iterator_to_next move the iterator to the next thing.
157 Besides this, an iterator also contains information about the
158 display environment in which glyphs for display elements are to be
159 produced. It has fields for the width and height of the display,
160 the information whether long lines are truncated or continued, a
161 current X and Y position, and lots of other stuff you can better
164 Glyphs in a desired matrix are normally constructed in a loop
165 calling get_next_display_element and then PRODUCE_GLYPHS. The call
166 to PRODUCE_GLYPHS will fill the iterator structure with pixel
167 information about the element being displayed and at the same time
168 produce glyphs for it. If the display element fits on the line
169 being displayed, set_iterator_to_next is called next, otherwise the
170 glyphs produced are discarded. The function display_line is the
171 workhorse of filling glyph rows in the desired matrix with glyphs.
172 In addition to producing glyphs, it also handles line truncation
173 and continuation, word wrap, and cursor positioning (for the
174 latter, see also set_cursor_from_row).
178 That just couldn't be all, could it? What about terminal types not
179 supporting operations on sub-windows of the screen? To update the
180 display on such a terminal, window-based glyph matrices are not
181 well suited. To be able to reuse part of the display (scrolling
182 lines up and down), we must instead have a view of the whole
183 screen. This is what `frame matrices' are for. They are a trick.
185 Frames on terminals like above have a glyph pool. Windows on such
186 a frame sub-allocate their glyph memory from their frame's glyph
187 pool. The frame itself is given its own glyph matrices. By
188 coincidence---or maybe something else---rows in window glyph
189 matrices are slices of corresponding rows in frame matrices. Thus
190 writing to window matrices implicitly updates a frame matrix which
191 provides us with the view of the whole screen that we originally
192 wanted to have without having to move many bytes around. To be
193 honest, there is a little bit more done, but not much more. If you
194 plan to extend that code, take a look at dispnew.c. The function
195 build_frame_matrix is a good starting point.
197 Bidirectional display.
199 Bidirectional display adds quite some hair to this already complex
200 design. The good news are that a large portion of that hairy stuff
201 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
202 reordering engine which is called by set_iterator_to_next and
203 returns the next character to display in the visual order. See
204 commentary on bidi.c for more details. As far as redisplay is
205 concerned, the effect of calling bidi_move_to_visually_next, the
206 main interface of the reordering engine, is that the iterator gets
207 magically placed on the buffer or string position that is to be
208 displayed next. In other words, a linear iteration through the
209 buffer/string is replaced with a non-linear one. All the rest of
210 the redisplay is oblivious to the bidi reordering.
212 Well, almost oblivious---there are still complications, most of
213 them due to the fact that buffer and string positions no longer
214 change monotonously with glyph indices in a glyph row. Moreover,
215 for continued lines, the buffer positions may not even be
216 monotonously changing with vertical positions. Also, accounting
217 for face changes, overlays, etc. becomes more complex because
218 non-linear iteration could potentially skip many positions with
219 changes, and then cross them again on the way back...
221 One other prominent effect of bidirectional display is that some
222 paragraphs of text need to be displayed starting at the right
223 margin of the window---the so-called right-to-left, or R2L
224 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
225 which have their reversed_p flag set. The bidi reordering engine
226 produces characters in such rows starting from the character which
227 should be the rightmost on display. PRODUCE_GLYPHS then reverses
228 the order, when it fills up the glyph row whose reversed_p flag is
229 set, by prepending each new glyph to what is already there, instead
230 of appending it. When the glyph row is complete, the function
231 extend_face_to_end_of_line fills the empty space to the left of the
232 leftmost character with special glyphs, which will display as,
233 well, empty. On text terminals, these special glyphs are simply
234 blank characters. On graphics terminals, there's a single stretch
235 glyph of a suitably computed width. Both the blanks and the
236 stretch glyph are given the face of the background of the line.
237 This way, the terminal-specific back-end can still draw the glyphs
238 left to right, even for R2L lines.
240 Bidirectional display and character compositions
242 Some scripts cannot be displayed by drawing each character
243 individually, because adjacent characters change each other's shape
244 on display. For example, Arabic and Indic scripts belong to this
247 Emacs display supports this by providing "character compositions",
248 most of which is implemented in composite.c. During the buffer
249 scan that delivers characters to PRODUCE_GLYPHS, if the next
250 character to be delivered is a composed character, the iteration
251 calls composition_reseat_it and next_element_from_composition. If
252 they succeed to compose the character with one or more of the
253 following characters, the whole sequence of characters that where
254 composed is recorded in the `struct composition_it' object that is
255 part of the buffer iterator. The composed sequence could produce
256 one or more font glyphs (called "grapheme clusters") on the screen.
257 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
258 in the direction corresponding to the current bidi scan direction
259 (recorded in the scan_dir member of the `struct bidi_it' object
260 that is part of the buffer iterator). In particular, if the bidi
261 iterator currently scans the buffer backwards, the grapheme
262 clusters are delivered back to front. This reorders the grapheme
263 clusters as appropriate for the current bidi context. Note that
264 this means that the grapheme clusters are always stored in the
265 LGSTRING object (see composite.c) in the logical order.
267 Moving an iterator in bidirectional text
268 without producing glyphs
270 Note one important detail mentioned above: that the bidi reordering
271 engine, driven by the iterator, produces characters in R2L rows
272 starting at the character that will be the rightmost on display.
273 As far as the iterator is concerned, the geometry of such rows is
274 still left to right, i.e. the iterator "thinks" the first character
275 is at the leftmost pixel position. The iterator does not know that
276 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
277 delivers. This is important when functions from the move_it_*
278 family are used to get to certain screen position or to match
279 screen coordinates with buffer coordinates: these functions use the
280 iterator geometry, which is left to right even in R2L paragraphs.
281 This works well with most callers of move_it_*, because they need
282 to get to a specific column, and columns are still numbered in the
283 reading order, i.e. the rightmost character in a R2L paragraph is
284 still column zero. But some callers do not get well with this; a
285 notable example is mouse clicks that need to find the character
286 that corresponds to certain pixel coordinates. See
287 buffer_posn_from_coords in dispnew.c for how this is handled. */
295 #include "composite.h"
296 #include "keyboard.h"
300 #include "termchar.h"
301 #include "dispextern.h"
302 #include "character.h"
306 #include "commands.h"
309 #include "termhooks.h"
310 #include "termopts.h"
311 #include "intervals.h"
313 #include "region-cache.h"
316 #include "blockinput.h"
318 #ifdef HAVE_WINDOW_SYSTEM
320 #endif /* HAVE_WINDOW_SYSTEM */
322 #ifndef FRAME_X_OUTPUT
323 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
326 #define INFINITY 10000000
328 /* Holds the list (error). */
329 static Lisp_Object list_of_error
;
331 #ifdef HAVE_WINDOW_SYSTEM
333 /* Test if overflow newline into fringe. Called with iterator IT
334 at or past right window margin, and with IT->current_x set. */
336 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
337 (!NILP (Voverflow_newline_into_fringe) \
338 && FRAME_WINDOW_P ((IT)->f) \
339 && ((IT)->bidi_it.paragraph_dir == R2L \
340 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
341 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
342 && (IT)->current_x == (IT)->last_visible_x)
344 #else /* !HAVE_WINDOW_SYSTEM */
345 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) false
346 #endif /* HAVE_WINDOW_SYSTEM */
348 /* Test if the display element loaded in IT, or the underlying buffer
349 or string character, is a space or a TAB character. This is used
350 to determine where word wrapping can occur. */
352 #define IT_DISPLAYING_WHITESPACE(it) \
353 ((it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t')) \
354 || ((STRINGP (it->string) \
355 && (SREF (it->string, IT_STRING_BYTEPOS (*it)) == ' ' \
356 || SREF (it->string, IT_STRING_BYTEPOS (*it)) == '\t')) \
358 && (it->s[IT_BYTEPOS (*it)] == ' ' \
359 || it->s[IT_BYTEPOS (*it)] == '\t')) \
360 || (IT_BYTEPOS (*it) < ZV_BYTE \
361 && (*BYTE_POS_ADDR (IT_BYTEPOS (*it)) == ' ' \
362 || *BYTE_POS_ADDR (IT_BYTEPOS (*it)) == '\t')))) \
364 /* True means print newline to stdout before next mini-buffer message. */
366 bool noninteractive_need_newline
;
368 /* True means print newline to message log before next message. */
370 static bool message_log_need_newline
;
372 /* Three markers that message_dolog uses.
373 It could allocate them itself, but that causes trouble
374 in handling memory-full errors. */
375 static Lisp_Object message_dolog_marker1
;
376 static Lisp_Object message_dolog_marker2
;
377 static Lisp_Object message_dolog_marker3
;
379 /* The buffer position of the first character appearing entirely or
380 partially on the line of the selected window which contains the
381 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
382 redisplay optimization in redisplay_internal. */
384 static struct text_pos this_line_start_pos
;
386 /* Number of characters past the end of the line above, including the
387 terminating newline. */
389 static struct text_pos this_line_end_pos
;
391 /* The vertical positions and the height of this line. */
393 static int this_line_vpos
;
394 static int this_line_y
;
395 static int this_line_pixel_height
;
397 /* X position at which this display line starts. Usually zero;
398 negative if first character is partially visible. */
400 static int this_line_start_x
;
402 /* The smallest character position seen by move_it_* functions as they
403 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
404 hscrolled lines, see display_line. */
406 static struct text_pos this_line_min_pos
;
408 /* Buffer that this_line_.* variables are referring to. */
410 static struct buffer
*this_line_buffer
;
412 /* True if an overlay arrow has been displayed in this window. */
414 static bool overlay_arrow_seen
;
416 /* Vector containing glyphs for an ellipsis `...'. */
418 static Lisp_Object default_invis_vector
[3];
420 /* This is the window where the echo area message was displayed. It
421 is always a mini-buffer window, but it may not be the same window
422 currently active as a mini-buffer. */
424 Lisp_Object echo_area_window
;
426 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
427 pushes the current message and the value of
428 message_enable_multibyte on the stack, the function restore_message
429 pops the stack and displays MESSAGE again. */
431 static Lisp_Object Vmessage_stack
;
433 /* True means multibyte characters were enabled when the echo area
434 message was specified. */
436 static bool message_enable_multibyte
;
438 /* At each redisplay cycle, we should refresh everything there is to refresh.
439 To do that efficiently, we use many optimizations that try to make sure we
440 don't waste too much time updating things that haven't changed.
441 The coarsest such optimization is that, in the most common cases, we only
442 look at the selected-window.
444 To know whether other windows should be considered for redisplay, we use the
445 variable windows_or_buffers_changed: as long as it is 0, it means that we
446 have not noticed anything that should require updating anything else than
447 the selected-window. If it is set to REDISPLAY_SOME, it means that since
448 last redisplay, some changes have been made which could impact other
449 windows. To know which ones need redisplay, every buffer, window, and frame
450 has a `redisplay' bit, which (if true) means that this object needs to be
451 redisplayed. If windows_or_buffers_changed is 0, we know there's no point
452 looking for those `redisplay' bits (actually, there might be some such bits
453 set, but then only on objects which aren't displayed anyway).
455 OTOH if it's non-zero we wil have to loop through all windows and then check
456 the `redisplay' bit of the corresponding window, frame, and buffer, in order
457 to decide whether that window needs attention or not. Note that we can't
458 just look at the frame's redisplay bit to decide that the whole frame can be
459 skipped, since even if the frame's redisplay bit is unset, some of its
460 windows's redisplay bits may be set.
462 Mostly for historical reasons, windows_or_buffers_changed can also take
463 other non-zero values. In that case, the precise value doesn't matter (it
464 encodes the cause of the setting but is only used for debugging purposes),
465 and what it means is that we shouldn't pay attention to any `redisplay' bits
466 and we should simply try and redisplay every window out there. */
468 int windows_or_buffers_changed
;
470 /* Nonzero if we should redraw the mode lines on the next redisplay.
471 Similarly to `windows_or_buffers_changed', If it has value REDISPLAY_SOME,
472 then only redisplay the mode lines in those buffers/windows/frames where the
473 `redisplay' bit has been set.
474 For any other value, redisplay all mode lines (the number used is then only
475 used to track down the cause for this full-redisplay).
477 Since the frame title uses the same %-constructs as the mode line
478 (except %c and %l), if this variable is non-zero, we also consider
479 redisplaying the title of each frame, see x_consider_frame_title.
481 The `redisplay' bits are the same as those used for
482 windows_or_buffers_changed, and setting windows_or_buffers_changed also
483 causes recomputation of the mode lines of all those windows. IOW this
484 variable only has an effect if windows_or_buffers_changed is zero, in which
485 case we should only need to redisplay the mode-line of those objects with
486 a `redisplay' bit set but not the window's text content (tho we may still
487 need to refresh the text content of the selected-window). */
489 int update_mode_lines
;
491 /* True after display_mode_line if %l was used and it displayed a
494 static bool line_number_displayed
;
496 /* The name of the *Messages* buffer, a string. */
498 static Lisp_Object Vmessages_buffer_name
;
500 /* Current, index 0, and last displayed echo area message. Either
501 buffers from echo_buffers, or nil to indicate no message. */
503 Lisp_Object echo_area_buffer
[2];
505 /* The buffers referenced from echo_area_buffer. */
507 static Lisp_Object echo_buffer
[2];
509 /* A vector saved used in with_area_buffer to reduce consing. */
511 static Lisp_Object Vwith_echo_area_save_vector
;
513 /* True means display_echo_area should display the last echo area
514 message again. Set by redisplay_preserve_echo_area. */
516 static bool display_last_displayed_message_p
;
518 /* True if echo area is being used by print; false if being used by
521 static bool message_buf_print
;
523 /* Set to true in clear_message to make redisplay_internal aware
524 of an emptied echo area. */
526 static bool message_cleared_p
;
528 /* A scratch glyph row with contents used for generating truncation
529 glyphs. Also used in direct_output_for_insert. */
531 #define MAX_SCRATCH_GLYPHS 100
532 static struct glyph_row scratch_glyph_row
;
533 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
535 /* Ascent and height of the last line processed by move_it_to. */
537 static int last_height
;
539 /* True if there's a help-echo in the echo area. */
541 bool help_echo_showing_p
;
543 /* The maximum distance to look ahead for text properties. Values
544 that are too small let us call compute_char_face and similar
545 functions too often which is expensive. Values that are too large
546 let us call compute_char_face and alike too often because we
547 might not be interested in text properties that far away. */
549 #define TEXT_PROP_DISTANCE_LIMIT 100
551 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
552 iterator state and later restore it. This is needed because the
553 bidi iterator on bidi.c keeps a stacked cache of its states, which
554 is really a singleton. When we use scratch iterator objects to
555 move around the buffer, we can cause the bidi cache to be pushed or
556 popped, and therefore we need to restore the cache state when we
557 return to the original iterator. */
558 #define SAVE_IT(ITCOPY, ITORIG, CACHE) \
561 bidi_unshelve_cache (CACHE, true); \
563 CACHE = bidi_shelve_cache (); \
566 #define RESTORE_IT(pITORIG, pITCOPY, CACHE) \
568 if (pITORIG != pITCOPY) \
569 *(pITORIG) = *(pITCOPY); \
570 bidi_unshelve_cache (CACHE, false); \
574 /* Functions to mark elements as needing redisplay. */
575 enum { REDISPLAY_SOME
= 2}; /* Arbitrary choice. */
578 redisplay_other_windows (void)
580 if (!windows_or_buffers_changed
)
581 windows_or_buffers_changed
= REDISPLAY_SOME
;
585 wset_redisplay (struct window
*w
)
587 /* Beware: selected_window can be nil during early stages. */
588 if (!EQ (make_lisp_ptr (w
, Lisp_Vectorlike
), selected_window
))
589 redisplay_other_windows ();
594 fset_redisplay (struct frame
*f
)
596 redisplay_other_windows ();
601 bset_redisplay (struct buffer
*b
)
603 int count
= buffer_window_count (b
);
606 /* ... it's visible in other window than selected, */
607 if (count
> 1 || b
!= XBUFFER (XWINDOW (selected_window
)->contents
))
608 redisplay_other_windows ();
609 /* Even if we don't set windows_or_buffers_changed, do set `redisplay'
610 so that if we later set windows_or_buffers_changed, this buffer will
612 b
->text
->redisplay
= true;
617 bset_update_mode_line (struct buffer
*b
)
619 if (!update_mode_lines
)
620 update_mode_lines
= REDISPLAY_SOME
;
621 b
->text
->redisplay
= true;
625 maybe_set_redisplay (Lisp_Object symbol
)
627 if (HASH_TABLE_P (Vredisplay__variables
)
628 && hash_lookup (XHASH_TABLE (Vredisplay__variables
), symbol
, NULL
) >= 0)
630 bset_update_mode_line (current_buffer
);
631 current_buffer
->prevent_redisplay_optimizations_p
= true;
637 /* True means print traces of redisplay if compiled with
638 GLYPH_DEBUG defined. */
640 bool trace_redisplay_p
;
642 #endif /* GLYPH_DEBUG */
644 #ifdef DEBUG_TRACE_MOVE
645 /* True means trace with TRACE_MOVE to stderr. */
646 static bool trace_move
;
648 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
650 #define TRACE_MOVE(x) (void) 0
653 /* Buffer being redisplayed -- for redisplay_window_error. */
655 static struct buffer
*displayed_buffer
;
657 /* Value returned from text property handlers (see below). */
662 HANDLED_RECOMPUTE_PROPS
,
663 HANDLED_OVERLAY_STRING_CONSUMED
,
667 /* A description of text properties that redisplay is interested
672 /* The symbol index of the name of the property. */
675 /* A unique index for the property. */
678 /* A handler function called to set up iterator IT from the property
679 at IT's current position. Value is used to steer handle_stop. */
680 enum prop_handled (*handler
) (struct it
*it
);
683 static enum prop_handled
handle_face_prop (struct it
*);
684 static enum prop_handled
handle_invisible_prop (struct it
*);
685 static enum prop_handled
handle_display_prop (struct it
*);
686 static enum prop_handled
handle_composition_prop (struct it
*);
687 static enum prop_handled
handle_overlay_change (struct it
*);
688 static enum prop_handled
handle_fontified_prop (struct it
*);
690 /* Properties handled by iterators. */
692 static struct props it_props
[] =
694 {SYMBOL_INDEX (Qfontified
), FONTIFIED_PROP_IDX
, handle_fontified_prop
},
695 /* Handle `face' before `display' because some sub-properties of
696 `display' need to know the face. */
697 {SYMBOL_INDEX (Qface
), FACE_PROP_IDX
, handle_face_prop
},
698 {SYMBOL_INDEX (Qdisplay
), DISPLAY_PROP_IDX
, handle_display_prop
},
699 {SYMBOL_INDEX (Qinvisible
), INVISIBLE_PROP_IDX
, handle_invisible_prop
},
700 {SYMBOL_INDEX (Qcomposition
), COMPOSITION_PROP_IDX
, handle_composition_prop
},
704 /* Value is the position described by X. If X is a marker, value is
705 the marker_position of X. Otherwise, value is X. */
707 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
709 /* Enumeration returned by some move_it_.* functions internally. */
713 /* Not used. Undefined value. */
716 /* Move ended at the requested buffer position or ZV. */
717 MOVE_POS_MATCH_OR_ZV
,
719 /* Move ended at the requested X pixel position. */
722 /* Move within a line ended at the end of a line that must be
726 /* Move within a line ended at the end of a line that would
727 be displayed truncated. */
730 /* Move within a line ended at a line end. */
734 /* This counter is used to clear the face cache every once in a while
735 in redisplay_internal. It is incremented for each redisplay.
736 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
739 #define CLEAR_FACE_CACHE_COUNT 500
740 static int clear_face_cache_count
;
742 /* Similarly for the image cache. */
744 #ifdef HAVE_WINDOW_SYSTEM
745 #define CLEAR_IMAGE_CACHE_COUNT 101
746 static int clear_image_cache_count
;
748 /* Null glyph slice */
749 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
752 /* True while redisplay_internal is in progress. */
756 /* If a string, XTread_socket generates an event to display that string.
757 (The display is done in read_char.) */
759 Lisp_Object help_echo_string
;
760 Lisp_Object help_echo_window
;
761 Lisp_Object help_echo_object
;
762 ptrdiff_t help_echo_pos
;
764 /* Temporary variable for XTread_socket. */
766 Lisp_Object previous_help_echo_string
;
768 /* Platform-independent portion of hourglass implementation. */
770 #ifdef HAVE_WINDOW_SYSTEM
772 /* True means an hourglass cursor is currently shown. */
773 static bool hourglass_shown_p
;
775 /* If non-null, an asynchronous timer that, when it expires, displays
776 an hourglass cursor on all frames. */
777 static struct atimer
*hourglass_atimer
;
779 #endif /* HAVE_WINDOW_SYSTEM */
781 /* Default number of seconds to wait before displaying an hourglass
783 #define DEFAULT_HOURGLASS_DELAY 1
785 #ifdef HAVE_WINDOW_SYSTEM
787 /* Default pixel width of `thin-space' display method. */
788 #define THIN_SPACE_WIDTH 1
790 #endif /* HAVE_WINDOW_SYSTEM */
792 /* Function prototypes. */
794 static void setup_for_ellipsis (struct it
*, int);
795 static void set_iterator_to_next (struct it
*, bool);
796 static void mark_window_display_accurate_1 (struct window
*, bool);
797 static bool row_for_charpos_p (struct glyph_row
*, ptrdiff_t);
798 static bool cursor_row_p (struct glyph_row
*);
799 static int redisplay_mode_lines (Lisp_Object
, bool);
801 static void handle_line_prefix (struct it
*);
803 static void handle_stop_backwards (struct it
*, ptrdiff_t);
804 static void unwind_with_echo_area_buffer (Lisp_Object
);
805 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
806 static bool current_message_1 (ptrdiff_t, Lisp_Object
);
807 static bool truncate_message_1 (ptrdiff_t, Lisp_Object
);
808 static void set_message (Lisp_Object
);
809 static bool set_message_1 (ptrdiff_t, Lisp_Object
);
810 static bool display_echo_area_1 (ptrdiff_t, Lisp_Object
);
811 static bool resize_mini_window_1 (ptrdiff_t, Lisp_Object
);
812 static void unwind_redisplay (void);
813 static void extend_face_to_end_of_line (struct it
*);
814 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
815 static void push_it (struct it
*, struct text_pos
*);
816 static void iterate_out_of_display_property (struct it
*);
817 static void pop_it (struct it
*);
818 static void redisplay_internal (void);
819 static void echo_area_display (bool);
820 static void redisplay_windows (Lisp_Object
);
821 static void redisplay_window (Lisp_Object
, bool);
822 static Lisp_Object
redisplay_window_error (Lisp_Object
);
823 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
824 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
825 static bool set_cursor_from_row (struct window
*, struct glyph_row
*,
826 struct glyph_matrix
*, ptrdiff_t, ptrdiff_t,
828 static bool cursor_row_fully_visible_p (struct window
*, bool, bool);
829 static bool update_menu_bar (struct frame
*, bool, bool);
830 static bool try_window_reusing_current_matrix (struct window
*);
831 static int try_window_id (struct window
*);
832 static bool display_line (struct it
*);
833 static int display_mode_lines (struct window
*);
834 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
835 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
,
837 static int store_mode_line_string (const char *, Lisp_Object
, bool, int, int,
839 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
840 static void display_menu_bar (struct window
*);
841 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
843 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
844 ptrdiff_t, ptrdiff_t, struct it
*, int, int, int, int);
845 static void compute_line_metrics (struct it
*);
846 static void run_redisplay_end_trigger_hook (struct it
*);
847 static bool get_overlay_strings (struct it
*, ptrdiff_t);
848 static bool get_overlay_strings_1 (struct it
*, ptrdiff_t, bool);
849 static void next_overlay_string (struct it
*);
850 static void reseat (struct it
*, struct text_pos
, bool);
851 static void reseat_1 (struct it
*, struct text_pos
, bool);
852 static bool next_element_from_display_vector (struct it
*);
853 static bool next_element_from_string (struct it
*);
854 static bool next_element_from_c_string (struct it
*);
855 static bool next_element_from_buffer (struct it
*);
856 static bool next_element_from_composition (struct it
*);
857 static bool next_element_from_image (struct it
*);
858 static bool next_element_from_stretch (struct it
*);
859 static bool next_element_from_xwidget (struct it
*);
860 static void load_overlay_strings (struct it
*, ptrdiff_t);
861 static bool get_next_display_element (struct it
*);
862 static enum move_it_result
863 move_it_in_display_line_to (struct it
*, ptrdiff_t, int,
864 enum move_operation_enum
);
865 static void get_visually_first_element (struct it
*);
866 static void compute_stop_pos (struct it
*);
867 static int face_before_or_after_it_pos (struct it
*, bool);
868 static ptrdiff_t next_overlay_change (ptrdiff_t);
869 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
870 Lisp_Object
, struct text_pos
*, ptrdiff_t, bool);
871 static int handle_single_display_spec (struct it
*, Lisp_Object
,
872 Lisp_Object
, Lisp_Object
,
873 struct text_pos
*, ptrdiff_t, int, bool);
874 static int underlying_face_id (struct it
*);
876 #define face_before_it_pos(IT) face_before_or_after_it_pos (IT, true)
877 #define face_after_it_pos(IT) face_before_or_after_it_pos (IT, false)
879 #ifdef HAVE_WINDOW_SYSTEM
881 static void update_tool_bar (struct frame
*, bool);
882 static void x_draw_bottom_divider (struct window
*w
);
883 static void notice_overwritten_cursor (struct window
*,
886 static int normal_char_height (struct font
*, int);
887 static void normal_char_ascent_descent (struct font
*, int, int *, int *);
889 static void append_stretch_glyph (struct it
*, Lisp_Object
,
892 static Lisp_Object
get_it_property (struct it
*, Lisp_Object
);
893 static Lisp_Object
calc_line_height_property (struct it
*, Lisp_Object
,
894 struct font
*, int, bool);
896 #endif /* HAVE_WINDOW_SYSTEM */
898 static void produce_special_glyphs (struct it
*, enum display_element_type
);
899 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
900 static bool coords_in_mouse_face_p (struct window
*, int, int);
904 /***********************************************************************
905 Window display dimensions
906 ***********************************************************************/
908 /* Return the bottom boundary y-position for text lines in window W.
909 This is the first y position at which a line cannot start.
910 It is relative to the top of the window.
912 This is the height of W minus the height of a mode line, if any. */
915 window_text_bottom_y (struct window
*w
)
917 int height
= WINDOW_PIXEL_HEIGHT (w
);
919 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
921 if (WINDOW_WANTS_MODELINE_P (w
))
922 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
924 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
929 /* Return the pixel width of display area AREA of window W.
930 ANY_AREA means return the total width of W, not including
931 fringes to the left and right of the window. */
934 window_box_width (struct window
*w
, enum glyph_row_area area
)
936 int width
= w
->pixel_width
;
938 if (!w
->pseudo_window_p
)
940 width
-= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
941 width
-= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
943 if (area
== TEXT_AREA
)
944 width
-= (WINDOW_MARGINS_WIDTH (w
)
945 + WINDOW_FRINGES_WIDTH (w
));
946 else if (area
== LEFT_MARGIN_AREA
)
947 width
= WINDOW_LEFT_MARGIN_WIDTH (w
);
948 else if (area
== RIGHT_MARGIN_AREA
)
949 width
= WINDOW_RIGHT_MARGIN_WIDTH (w
);
952 /* With wide margins, fringes, etc. we might end up with a negative
953 width, correct that here. */
954 return max (0, width
);
958 /* Return the pixel height of the display area of window W, not
959 including mode lines of W, if any. */
962 window_box_height (struct window
*w
)
964 struct frame
*f
= XFRAME (w
->frame
);
965 int height
= WINDOW_PIXEL_HEIGHT (w
);
967 eassert (height
>= 0);
969 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
970 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
972 /* Note: the code below that determines the mode-line/header-line
973 height is essentially the same as that contained in the macro
974 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
975 the appropriate glyph row has its `mode_line_p' flag set,
976 and if it doesn't, uses estimate_mode_line_height instead. */
978 if (WINDOW_WANTS_MODELINE_P (w
))
980 struct glyph_row
*ml_row
981 = (w
->current_matrix
&& w
->current_matrix
->rows
982 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
984 if (ml_row
&& ml_row
->mode_line_p
)
985 height
-= ml_row
->height
;
987 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
990 if (WINDOW_WANTS_HEADER_LINE_P (w
))
992 struct glyph_row
*hl_row
993 = (w
->current_matrix
&& w
->current_matrix
->rows
994 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
996 if (hl_row
&& hl_row
->mode_line_p
)
997 height
-= hl_row
->height
;
999 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1002 /* With a very small font and a mode-line that's taller than
1003 default, we might end up with a negative height. */
1004 return max (0, height
);
1007 /* Return the window-relative coordinate of the left edge of display
1008 area AREA of window W. ANY_AREA means return the left edge of the
1009 whole window, to the right of the left fringe of W. */
1012 window_box_left_offset (struct window
*w
, enum glyph_row_area area
)
1016 if (w
->pseudo_window_p
)
1019 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1021 if (area
== TEXT_AREA
)
1022 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1023 + window_box_width (w
, LEFT_MARGIN_AREA
));
1024 else if (area
== RIGHT_MARGIN_AREA
)
1025 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1026 + window_box_width (w
, LEFT_MARGIN_AREA
)
1027 + window_box_width (w
, TEXT_AREA
)
1028 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1030 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1031 else if (area
== LEFT_MARGIN_AREA
1032 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1033 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1035 /* Don't return more than the window's pixel width. */
1036 return min (x
, w
->pixel_width
);
1040 /* Return the window-relative coordinate of the right edge of display
1041 area AREA of window W. ANY_AREA means return the right edge of the
1042 whole window, to the left of the right fringe of W. */
1045 window_box_right_offset (struct window
*w
, enum glyph_row_area area
)
1047 /* Don't return more than the window's pixel width. */
1048 return min (window_box_left_offset (w
, area
) + window_box_width (w
, area
),
1052 /* Return the frame-relative coordinate of the left edge of display
1053 area AREA of window W. ANY_AREA means return the left edge of the
1054 whole window, to the right of the left fringe of W. */
1057 window_box_left (struct window
*w
, enum glyph_row_area area
)
1059 struct frame
*f
= XFRAME (w
->frame
);
1062 if (w
->pseudo_window_p
)
1063 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1065 x
= (WINDOW_LEFT_EDGE_X (w
)
1066 + window_box_left_offset (w
, area
));
1072 /* Return the frame-relative coordinate of the right edge of display
1073 area AREA of window W. ANY_AREA means return the right edge of the
1074 whole window, to the left of the right fringe of W. */
1077 window_box_right (struct window
*w
, enum glyph_row_area area
)
1079 return window_box_left (w
, area
) + window_box_width (w
, area
);
1082 /* Get the bounding box of the display area AREA of window W, without
1083 mode lines, in frame-relative coordinates. ANY_AREA means the
1084 whole window, not including the left and right fringes of
1085 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1086 coordinates of the upper-left corner of the box. Return in
1087 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1090 window_box (struct window
*w
, enum glyph_row_area area
, int *box_x
,
1091 int *box_y
, int *box_width
, int *box_height
)
1094 *box_width
= window_box_width (w
, area
);
1096 *box_height
= window_box_height (w
);
1098 *box_x
= window_box_left (w
, area
);
1101 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1102 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1103 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1107 #ifdef HAVE_WINDOW_SYSTEM
1109 /* Get the bounding box of the display area AREA of window W, without
1110 mode lines and both fringes of the window. Return in *TOP_LEFT_X
1111 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1112 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1113 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1117 window_box_edges (struct window
*w
, int *top_left_x
, int *top_left_y
,
1118 int *bottom_right_x
, int *bottom_right_y
)
1120 window_box (w
, ANY_AREA
, top_left_x
, top_left_y
,
1121 bottom_right_x
, bottom_right_y
);
1122 *bottom_right_x
+= *top_left_x
;
1123 *bottom_right_y
+= *top_left_y
;
1126 #endif /* HAVE_WINDOW_SYSTEM */
1128 /***********************************************************************
1130 ***********************************************************************/
1132 /* Return the bottom y-position of the line the iterator IT is in.
1133 This can modify IT's settings. */
1136 line_bottom_y (struct it
*it
)
1138 int line_height
= it
->max_ascent
+ it
->max_descent
;
1139 int line_top_y
= it
->current_y
;
1141 if (line_height
== 0)
1144 line_height
= last_height
;
1145 else if (IT_CHARPOS (*it
) < ZV
)
1147 move_it_by_lines (it
, 1);
1148 line_height
= (it
->max_ascent
|| it
->max_descent
1149 ? it
->max_ascent
+ it
->max_descent
1154 struct glyph_row
*row
= it
->glyph_row
;
1156 /* Use the default character height. */
1157 it
->glyph_row
= NULL
;
1158 it
->what
= IT_CHARACTER
;
1161 PRODUCE_GLYPHS (it
);
1162 line_height
= it
->ascent
+ it
->descent
;
1163 it
->glyph_row
= row
;
1167 return line_top_y
+ line_height
;
1170 DEFUN ("line-pixel-height", Fline_pixel_height
,
1171 Sline_pixel_height
, 0, 0, 0,
1172 doc
: /* Return height in pixels of text line in the selected window.
1174 Value is the height in pixels of the line at point. */)
1179 struct window
*w
= XWINDOW (selected_window
);
1180 struct buffer
*old_buffer
= NULL
;
1183 if (XBUFFER (w
->contents
) != current_buffer
)
1185 old_buffer
= current_buffer
;
1186 set_buffer_internal_1 (XBUFFER (w
->contents
));
1188 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
1189 start_display (&it
, w
, pt
);
1190 it
.vpos
= it
.current_y
= 0;
1192 result
= make_number (line_bottom_y (&it
));
1194 set_buffer_internal_1 (old_buffer
);
1199 /* Return the default pixel height of text lines in window W. The
1200 value is the canonical height of the W frame's default font, plus
1201 any extra space required by the line-spacing variable or frame
1204 Implementation note: this ignores any line-spacing text properties
1205 put on the newline characters. This is because those properties
1206 only affect the _screen_ line ending in the newline (i.e., in a
1207 continued line, only the last screen line will be affected), which
1208 means only a small number of lines in a buffer can ever use this
1209 feature. Since this function is used to compute the default pixel
1210 equivalent of text lines in a window, we can safely ignore those
1211 few lines. For the same reasons, we ignore the line-height
1214 default_line_pixel_height (struct window
*w
)
1216 struct frame
*f
= WINDOW_XFRAME (w
);
1217 int height
= FRAME_LINE_HEIGHT (f
);
1219 if (!FRAME_INITIAL_P (f
) && BUFFERP (w
->contents
))
1221 struct buffer
*b
= XBUFFER (w
->contents
);
1222 Lisp_Object val
= BVAR (b
, extra_line_spacing
);
1225 val
= BVAR (&buffer_defaults
, extra_line_spacing
);
1228 if (RANGED_INTEGERP (0, val
, INT_MAX
))
1229 height
+= XFASTINT (val
);
1230 else if (FLOATP (val
))
1232 int addon
= XFLOAT_DATA (val
) * height
+ 0.5;
1239 height
+= f
->extra_line_spacing
;
1245 /* Subroutine of pos_visible_p below. Extracts a display string, if
1246 any, from the display spec given as its argument. */
1248 string_from_display_spec (Lisp_Object spec
)
1252 while (CONSP (spec
))
1254 if (STRINGP (XCAR (spec
)))
1259 else if (VECTORP (spec
))
1263 for (i
= 0; i
< ASIZE (spec
); i
++)
1265 if (STRINGP (AREF (spec
, i
)))
1266 return AREF (spec
, i
);
1275 /* Limit insanely large values of W->hscroll on frame F to the largest
1276 value that will still prevent first_visible_x and last_visible_x of
1277 'struct it' from overflowing an int. */
1279 window_hscroll_limited (struct window
*w
, struct frame
*f
)
1281 ptrdiff_t window_hscroll
= w
->hscroll
;
1282 int window_text_width
= window_box_width (w
, TEXT_AREA
);
1283 int colwidth
= FRAME_COLUMN_WIDTH (f
);
1285 if (window_hscroll
> (INT_MAX
- window_text_width
) / colwidth
- 1)
1286 window_hscroll
= (INT_MAX
- window_text_width
) / colwidth
- 1;
1288 return window_hscroll
;
1291 /* Return true if position CHARPOS is visible in window W.
1292 CHARPOS < 0 means return info about WINDOW_END position.
1293 If visible, set *X and *Y to pixel coordinates of top left corner.
1294 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1295 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1298 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1299 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1302 void *itdata
= bidi_shelve_cache ();
1303 struct text_pos top
;
1304 bool visible_p
= false;
1305 struct buffer
*old_buffer
= NULL
;
1308 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1311 if (XBUFFER (w
->contents
) != current_buffer
)
1313 old_buffer
= current_buffer
;
1314 set_buffer_internal_1 (XBUFFER (w
->contents
));
1317 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1318 /* Scrolling a minibuffer window via scroll bar when the echo area
1319 shows long text sometimes resets the minibuffer contents behind
1321 if (CHARPOS (top
) > ZV
)
1322 SET_TEXT_POS (top
, BEGV
, BEGV_BYTE
);
1324 /* Compute exact mode line heights. */
1325 if (WINDOW_WANTS_MODELINE_P (w
))
1327 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1328 BVAR (current_buffer
, mode_line_format
));
1330 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1331 w
->header_line_height
1332 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1333 BVAR (current_buffer
, header_line_format
));
1335 start_display (&it
, w
, top
);
1336 move_it_to (&it
, charpos
, -1, it
.last_visible_y
- 1, -1,
1337 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1340 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
!= -1)
1341 && IT_CHARPOS (it
) >= charpos
)
1342 /* When scanning backwards under bidi iteration, move_it_to
1343 stops at or _before_ CHARPOS, because it stops at or to
1344 the _right_ of the character at CHARPOS. */
1345 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1346 && IT_CHARPOS (it
) <= charpos
)))
1348 /* We have reached CHARPOS, or passed it. How the call to
1349 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1350 or covered by a display property, move_it_to stops at the end
1351 of the invisible text, to the right of CHARPOS. (ii) If
1352 CHARPOS is in a display vector, move_it_to stops on its last
1354 int top_x
= it
.current_x
;
1355 int top_y
= it
.current_y
;
1356 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1359 void *save_it_data
= NULL
;
1361 /* Calling line_bottom_y may change it.method, it.position, etc. */
1362 SAVE_IT (save_it
, it
, save_it_data
);
1364 bottom_y
= line_bottom_y (&it
);
1365 if (top_y
< window_top_y
)
1366 visible_p
= bottom_y
> window_top_y
;
1367 else if (top_y
< it
.last_visible_y
)
1369 if (bottom_y
>= it
.last_visible_y
1370 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1371 && IT_CHARPOS (it
) < charpos
)
1373 /* When the last line of the window is scanned backwards
1374 under bidi iteration, we could be duped into thinking
1375 that we have passed CHARPOS, when in fact move_it_to
1376 simply stopped short of CHARPOS because it reached
1377 last_visible_y. To see if that's what happened, we call
1378 move_it_to again with a slightly larger vertical limit,
1379 and see if it actually moved vertically; if it did, we
1380 didn't really reach CHARPOS, which is beyond window end. */
1381 /* Why 10? because we don't know how many canonical lines
1382 will the height of the next line(s) be. So we guess. */
1383 int ten_more_lines
= 10 * default_line_pixel_height (w
);
1385 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1386 MOVE_TO_POS
| MOVE_TO_Y
);
1387 if (it
.current_y
> top_y
)
1391 RESTORE_IT (&it
, &save_it
, save_it_data
);
1394 if (it
.method
== GET_FROM_DISPLAY_VECTOR
)
1396 /* We stopped on the last glyph of a display vector.
1397 Try and recompute. Hack alert! */
1398 if (charpos
< 2 || top
.charpos
>= charpos
)
1399 top_x
= it
.glyph_row
->x
;
1402 struct it it2
, it2_prev
;
1403 /* The idea is to get to the previous buffer
1404 position, consume the character there, and use
1405 the pixel coordinates we get after that. But if
1406 the previous buffer position is also displayed
1407 from a display vector, we need to consume all of
1408 the glyphs from that display vector. */
1409 start_display (&it2
, w
, top
);
1410 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1411 /* If we didn't get to CHARPOS - 1, there's some
1412 replacing display property at that position, and
1413 we stopped after it. That is exactly the place
1414 whose coordinates we want. */
1415 if (IT_CHARPOS (it2
) != charpos
- 1)
1419 /* Iterate until we get out of the display
1420 vector that displays the character at
1423 get_next_display_element (&it2
);
1424 PRODUCE_GLYPHS (&it2
);
1426 set_iterator_to_next (&it2
, true);
1427 } while (it2
.method
== GET_FROM_DISPLAY_VECTOR
1428 && IT_CHARPOS (it2
) < charpos
);
1430 if (ITERATOR_AT_END_OF_LINE_P (&it2_prev
)
1431 || it2_prev
.current_x
> it2_prev
.last_visible_x
)
1432 top_x
= it
.glyph_row
->x
;
1435 top_x
= it2_prev
.current_x
;
1436 top_y
= it2_prev
.current_y
;
1440 else if (IT_CHARPOS (it
) != charpos
)
1442 Lisp_Object cpos
= make_number (charpos
);
1443 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1444 Lisp_Object string
= string_from_display_spec (spec
);
1445 struct text_pos tpos
;
1446 bool newline_in_string
1448 && memchr (SDATA (string
), '\n', SBYTES (string
)));
1450 SET_TEXT_POS (tpos
, charpos
, CHAR_TO_BYTE (charpos
));
1451 bool replacing_spec_p
1453 && handle_display_spec (NULL
, spec
, Qnil
, Qnil
, &tpos
,
1454 charpos
, FRAME_WINDOW_P (it
.f
)));
1455 /* The tricky code below is needed because there's a
1456 discrepancy between move_it_to and how we set cursor
1457 when PT is at the beginning of a portion of text
1458 covered by a display property or an overlay with a
1459 display property, or the display line ends in a
1460 newline from a display string. move_it_to will stop
1461 _after_ such display strings, whereas
1462 set_cursor_from_row conspires with cursor_row_p to
1463 place the cursor on the first glyph produced from the
1466 /* We have overshoot PT because it is covered by a
1467 display property that replaces the text it covers.
1468 If the string includes embedded newlines, we are also
1469 in the wrong display line. Backtrack to the correct
1470 line, where the display property begins. */
1471 if (replacing_spec_p
)
1473 Lisp_Object startpos
, endpos
;
1474 EMACS_INT start
, end
;
1477 /* Find the first and the last buffer positions
1478 covered by the display string. */
1480 Fnext_single_char_property_change (cpos
, Qdisplay
,
1483 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1485 start
= XFASTINT (startpos
);
1486 end
= XFASTINT (endpos
);
1487 /* Move to the last buffer position before the
1488 display property. */
1489 start_display (&it3
, w
, top
);
1490 if (start
> CHARPOS (top
))
1491 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1492 /* Move forward one more line if the position before
1493 the display string is a newline or if it is the
1494 rightmost character on a line that is
1495 continued or word-wrapped. */
1496 if (it3
.method
== GET_FROM_BUFFER
1498 || FETCH_BYTE (IT_BYTEPOS (it3
)) == '\n'))
1499 move_it_by_lines (&it3
, 1);
1500 else if (move_it_in_display_line_to (&it3
, -1,
1504 == MOVE_LINE_CONTINUED
)
1506 move_it_by_lines (&it3
, 1);
1507 /* When we are under word-wrap, the #$@%!
1508 move_it_by_lines moves 2 lines, so we need to
1510 if (it3
.line_wrap
== WORD_WRAP
)
1511 move_it_by_lines (&it3
, -1);
1514 /* Record the vertical coordinate of the display
1515 line where we wound up. */
1516 top_y
= it3
.current_y
;
1519 /* When characters are reordered for display,
1520 the character displayed to the left of the
1521 display string could be _after_ the display
1522 property in the logical order. Use the
1523 smallest vertical position of these two. */
1524 start_display (&it3
, w
, top
);
1525 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1526 if (it3
.current_y
< top_y
)
1527 top_y
= it3
.current_y
;
1529 /* Move from the top of the window to the beginning
1530 of the display line where the display string
1532 start_display (&it3
, w
, top
);
1533 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1534 /* If it3_moved stays false after the 'while' loop
1535 below, that means we already were at a newline
1536 before the loop (e.g., the display string begins
1537 with a newline), so we don't need to (and cannot)
1538 inspect the glyphs of it3.glyph_row, because
1539 PRODUCE_GLYPHS will not produce anything for a
1540 newline, and thus it3.glyph_row stays at its
1541 stale content it got at top of the window. */
1542 bool it3_moved
= false;
1543 /* Finally, advance the iterator until we hit the
1544 first display element whose character position is
1545 CHARPOS, or until the first newline from the
1546 display string, which signals the end of the
1548 while (get_next_display_element (&it3
))
1550 PRODUCE_GLYPHS (&it3
);
1551 if (IT_CHARPOS (it3
) == charpos
1552 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1555 set_iterator_to_next (&it3
, false);
1557 top_x
= it3
.current_x
- it3
.pixel_width
;
1558 /* Normally, we would exit the above loop because we
1559 found the display element whose character
1560 position is CHARPOS. For the contingency that we
1561 didn't, and stopped at the first newline from the
1562 display string, move back over the glyphs
1563 produced from the string, until we find the
1564 rightmost glyph not from the string. */
1566 && newline_in_string
1567 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1569 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1570 + it3
.glyph_row
->used
[TEXT_AREA
];
1572 while (EQ ((g
- 1)->object
, string
))
1575 top_x
-= g
->pixel_width
;
1577 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1578 + it3
.glyph_row
->used
[TEXT_AREA
]);
1584 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1585 *rtop
= max (0, window_top_y
- top_y
);
1586 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1587 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1588 - max (top_y
, window_top_y
)));
1590 if (it
.bidi_it
.paragraph_dir
== R2L
)
1596 /* Either we were asked to provide info about WINDOW_END, or
1597 CHARPOS is in the partially visible glyph row at end of
1600 void *it2data
= NULL
;
1602 SAVE_IT (it2
, it
, it2data
);
1603 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1604 move_it_by_lines (&it
, 1);
1605 if (charpos
< IT_CHARPOS (it
)
1606 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1609 RESTORE_IT (&it2
, &it2
, it2data
);
1610 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1612 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1613 *rtop
= max (0, -it2
.current_y
);
1614 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1615 - it
.last_visible_y
));
1616 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1618 - max (it2
.current_y
,
1619 WINDOW_HEADER_LINE_HEIGHT (w
))));
1621 if (it2
.bidi_it
.paragraph_dir
== R2L
)
1625 bidi_unshelve_cache (it2data
, true);
1627 bidi_unshelve_cache (itdata
, false);
1630 set_buffer_internal_1 (old_buffer
);
1636 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1637 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1638 /* For lines in an R2L paragraph, we need to mirror the X pixel
1639 coordinate wrt the text area. For the reasons, see the
1640 commentary in buffer_posn_from_coords and the explanation of
1641 the geometry used by the move_it_* functions at the end of
1642 the large commentary near the beginning of this file. */
1644 *x
= window_box_width (w
, TEXT_AREA
) - *x
- 1;
1648 /* Debugging code. */
1650 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1651 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1653 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1660 /* Return the next character from STR. Return in *LEN the length of
1661 the character. This is like STRING_CHAR_AND_LENGTH but never
1662 returns an invalid character. If we find one, we return a `?', but
1663 with the length of the invalid character. */
1666 string_char_and_length (const unsigned char *str
, int *len
)
1670 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1671 if (!CHAR_VALID_P (c
))
1672 /* We may not change the length here because other places in Emacs
1673 don't use this function, i.e. they silently accept invalid
1682 /* Given a position POS containing a valid character and byte position
1683 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1685 static struct text_pos
1686 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1688 eassert (STRINGP (string
) && nchars
>= 0);
1690 if (STRING_MULTIBYTE (string
))
1692 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1697 string_char_and_length (p
, &len
);
1700 BYTEPOS (pos
) += len
;
1704 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1710 /* Value is the text position, i.e. character and byte position,
1711 for character position CHARPOS in STRING. */
1713 static struct text_pos
1714 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1716 struct text_pos pos
;
1717 eassert (STRINGP (string
));
1718 eassert (charpos
>= 0);
1719 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1724 /* Value is a text position, i.e. character and byte position, for
1725 character position CHARPOS in C string S. MULTIBYTE_P
1726 means recognize multibyte characters. */
1728 static struct text_pos
1729 c_string_pos (ptrdiff_t charpos
, const char *s
, bool multibyte_p
)
1731 struct text_pos pos
;
1733 eassert (s
!= NULL
);
1734 eassert (charpos
>= 0);
1740 SET_TEXT_POS (pos
, 0, 0);
1743 string_char_and_length ((const unsigned char *) s
, &len
);
1746 BYTEPOS (pos
) += len
;
1750 SET_TEXT_POS (pos
, charpos
, charpos
);
1756 /* Value is the number of characters in C string S. MULTIBYTE_P
1757 means recognize multibyte characters. */
1760 number_of_chars (const char *s
, bool multibyte_p
)
1766 ptrdiff_t rest
= strlen (s
);
1768 const unsigned char *p
= (const unsigned char *) s
;
1770 for (nchars
= 0; rest
> 0; ++nchars
)
1772 string_char_and_length (p
, &len
);
1773 rest
-= len
, p
+= len
;
1777 nchars
= strlen (s
);
1783 /* Compute byte position NEWPOS->bytepos corresponding to
1784 NEWPOS->charpos. POS is a known position in string STRING.
1785 NEWPOS->charpos must be >= POS.charpos. */
1788 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1790 eassert (STRINGP (string
));
1791 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1793 if (STRING_MULTIBYTE (string
))
1794 *newpos
= string_pos_nchars_ahead (pos
, string
,
1795 CHARPOS (*newpos
) - CHARPOS (pos
));
1797 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1801 Return an estimation of the pixel height of mode or header lines on
1802 frame F. FACE_ID specifies what line's height to estimate. */
1805 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1807 #ifdef HAVE_WINDOW_SYSTEM
1808 if (FRAME_WINDOW_P (f
))
1810 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1812 /* This function is called so early when Emacs starts that the face
1813 cache and mode line face are not yet initialized. */
1814 if (FRAME_FACE_CACHE (f
))
1816 struct face
*face
= FACE_OPT_FROM_ID (f
, face_id
);
1820 height
= normal_char_height (face
->font
, -1);
1821 if (face
->box_line_width
> 0)
1822 height
+= 2 * face
->box_line_width
;
1833 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1834 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1835 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP, do
1836 not force the value into range. */
1839 pixel_to_glyph_coords (struct frame
*f
, int pix_x
, int pix_y
, int *x
, int *y
,
1840 NativeRectangle
*bounds
, bool noclip
)
1843 #ifdef HAVE_WINDOW_SYSTEM
1844 if (FRAME_WINDOW_P (f
))
1846 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1847 even for negative values. */
1849 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1851 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1853 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1854 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1857 STORE_NATIVE_RECT (*bounds
,
1858 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1859 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1860 FRAME_COLUMN_WIDTH (f
) - 1,
1861 FRAME_LINE_HEIGHT (f
) - 1);
1863 /* PXW: Should we clip pixels before converting to columns/lines? */
1868 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1869 pix_x
= FRAME_TOTAL_COLS (f
);
1873 else if (pix_y
> FRAME_TOTAL_LINES (f
))
1874 pix_y
= FRAME_TOTAL_LINES (f
);
1884 /* Find the glyph under window-relative coordinates X/Y in window W.
1885 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1886 strings. Return in *HPOS and *VPOS the row and column number of
1887 the glyph found. Return in *AREA the glyph area containing X.
1888 Value is a pointer to the glyph found or null if X/Y is not on
1889 text, or we can't tell because W's current matrix is not up to
1892 static struct glyph
*
1893 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1894 int *dx
, int *dy
, int *area
)
1896 struct glyph
*glyph
, *end
;
1897 struct glyph_row
*row
= NULL
;
1900 /* Find row containing Y. Give up if some row is not enabled. */
1901 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1903 row
= MATRIX_ROW (w
->current_matrix
, i
);
1904 if (!row
->enabled_p
)
1906 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1913 /* Give up if Y is not in the window. */
1914 if (i
== w
->current_matrix
->nrows
)
1917 /* Get the glyph area containing X. */
1918 if (w
->pseudo_window_p
)
1925 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1927 *area
= LEFT_MARGIN_AREA
;
1928 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1930 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1933 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1937 *area
= RIGHT_MARGIN_AREA
;
1938 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1942 /* Find glyph containing X. */
1943 glyph
= row
->glyphs
[*area
];
1944 end
= glyph
+ row
->used
[*area
];
1946 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1948 x
-= glyph
->pixel_width
;
1958 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1961 *hpos
= glyph
- row
->glyphs
[*area
];
1965 /* Convert frame-relative x/y to coordinates relative to window W.
1966 Takes pseudo-windows into account. */
1969 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1971 if (w
->pseudo_window_p
)
1973 /* A pseudo-window is always full-width, and starts at the
1974 left edge of the frame, plus a frame border. */
1975 struct frame
*f
= XFRAME (w
->frame
);
1976 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1977 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1981 *x
-= WINDOW_LEFT_EDGE_X (w
);
1982 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1986 #ifdef HAVE_WINDOW_SYSTEM
1989 Return in RECTS[] at most N clipping rectangles for glyph string S.
1990 Return the number of stored rectangles. */
1993 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
2000 if (s
->row
->full_width_p
)
2002 /* Draw full-width. X coordinates are relative to S->w->left_col. */
2003 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
2004 if (s
->row
->mode_line_p
)
2005 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
) - WINDOW_RIGHT_DIVIDER_WIDTH (s
->w
);
2007 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
);
2009 /* Unless displaying a mode or menu bar line, which are always
2010 fully visible, clip to the visible part of the row. */
2011 if (s
->w
->pseudo_window_p
)
2012 r
.height
= s
->row
->visible_height
;
2014 r
.height
= s
->height
;
2018 /* This is a text line that may be partially visible. */
2019 r
.x
= window_box_left (s
->w
, s
->area
);
2020 r
.width
= window_box_width (s
->w
, s
->area
);
2021 r
.height
= s
->row
->visible_height
;
2025 if (r
.x
< s
->clip_head
->x
)
2027 if (r
.width
>= s
->clip_head
->x
- r
.x
)
2028 r
.width
-= s
->clip_head
->x
- r
.x
;
2031 r
.x
= s
->clip_head
->x
;
2034 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
2036 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
2037 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
2042 /* If S draws overlapping rows, it's sufficient to use the top and
2043 bottom of the window for clipping because this glyph string
2044 intentionally draws over other lines. */
2045 if (s
->for_overlaps
)
2047 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2048 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
2050 /* Alas, the above simple strategy does not work for the
2051 environments with anti-aliased text: if the same text is
2052 drawn onto the same place multiple times, it gets thicker.
2053 If the overlap we are processing is for the erased cursor, we
2054 take the intersection with the rectangle of the cursor. */
2055 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
2057 XRectangle rc
, r_save
= r
;
2059 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
2060 rc
.y
= s
->w
->phys_cursor
.y
;
2061 rc
.width
= s
->w
->phys_cursor_width
;
2062 rc
.height
= s
->w
->phys_cursor_height
;
2064 x_intersect_rectangles (&r_save
, &rc
, &r
);
2069 /* Don't use S->y for clipping because it doesn't take partially
2070 visible lines into account. For example, it can be negative for
2071 partially visible lines at the top of a window. */
2072 if (!s
->row
->full_width_p
2073 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2074 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2076 r
.y
= max (0, s
->row
->y
);
2079 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2081 /* If drawing the cursor, don't let glyph draw outside its
2082 advertised boundaries. Cleartype does this under some circumstances. */
2083 if (s
->hl
== DRAW_CURSOR
)
2085 struct glyph
*glyph
= s
->first_glyph
;
2090 if (r
.width
>= s
->x
- r
.x
)
2091 r
.width
-= s
->x
- r
.x
;
2092 else /* R2L hscrolled row with cursor outside text area */
2096 r
.width
= min (r
.width
, glyph
->pixel_width
);
2098 /* If r.y is below window bottom, ensure that we still see a cursor. */
2099 height
= min (glyph
->ascent
+ glyph
->descent
,
2100 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2101 max_y
= window_text_bottom_y (s
->w
) - height
;
2102 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2103 if (s
->ybase
- glyph
->ascent
> max_y
)
2110 /* Don't draw cursor glyph taller than our actual glyph. */
2111 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2112 if (height
< r
.height
)
2114 max_y
= r
.y
+ r
.height
;
2115 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2116 r
.height
= min (max_y
- r
.y
, height
);
2123 XRectangle r_save
= r
;
2125 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2129 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2130 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2132 #ifdef CONVERT_FROM_XRECT
2133 CONVERT_FROM_XRECT (r
, *rects
);
2141 /* If we are processing overlapping and allowed to return
2142 multiple clipping rectangles, we exclude the row of the glyph
2143 string from the clipping rectangle. This is to avoid drawing
2144 the same text on the environment with anti-aliasing. */
2145 #ifdef CONVERT_FROM_XRECT
2148 XRectangle
*rs
= rects
;
2150 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2152 if (s
->for_overlaps
& OVERLAPS_PRED
)
2155 if (r
.y
+ r
.height
> row_y
)
2158 rs
[i
].height
= row_y
- r
.y
;
2164 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2167 if (r
.y
< row_y
+ s
->row
->visible_height
)
2169 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2171 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2172 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2181 #ifdef CONVERT_FROM_XRECT
2182 for (i
= 0; i
< n
; i
++)
2183 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2190 Return in *NR the clipping rectangle for glyph string S. */
2193 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2195 get_glyph_string_clip_rects (s
, nr
, 1);
2200 Return the position and height of the phys cursor in window W.
2201 Set w->phys_cursor_width to width of phys cursor.
2205 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2206 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2208 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2209 int x
, y
, wd
, h
, h0
, y0
, ascent
;
2211 /* Compute the width of the rectangle to draw. If on a stretch
2212 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2213 rectangle as wide as the glyph, but use a canonical character
2215 wd
= glyph
->pixel_width
;
2217 x
= w
->phys_cursor
.x
;
2224 if (glyph
->type
== STRETCH_GLYPH
2225 && !x_stretch_cursor_p
)
2226 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2227 w
->phys_cursor_width
= wd
;
2229 /* Don't let the hollow cursor glyph descend below the glyph row's
2230 ascent value, lest the hollow cursor looks funny. */
2231 y
= w
->phys_cursor
.y
;
2232 ascent
= row
->ascent
;
2233 if (row
->ascent
< glyph
->ascent
)
2235 y
=- glyph
->ascent
- row
->ascent
;
2236 ascent
= glyph
->ascent
;
2239 /* If y is below window bottom, ensure that we still see a cursor. */
2240 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2242 h
= max (h0
, ascent
+ glyph
->descent
);
2243 h0
= min (h0
, ascent
+ glyph
->descent
);
2245 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2248 h
= max (h
- (y0
- y
) + 1, h0
);
2253 y0
= window_text_bottom_y (w
) - h0
;
2261 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2262 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2267 * Remember which glyph the mouse is over.
2271 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2275 struct glyph_row
*r
, *gr
, *end_row
;
2276 enum window_part part
;
2277 enum glyph_row_area area
;
2278 int x
, y
, width
, height
;
2280 /* Try to determine frame pixel position and size of the glyph under
2281 frame pixel coordinates X/Y on frame F. */
2283 if (window_resize_pixelwise
)
2288 else if (!f
->glyphs_initialized_p
2289 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, false),
2292 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2293 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2297 w
= XWINDOW (window
);
2298 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2299 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2301 x
= window_relative_x_coord (w
, part
, gx
);
2302 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2304 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2305 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2307 if (w
->pseudo_window_p
)
2310 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2316 case ON_LEFT_MARGIN
:
2317 area
= LEFT_MARGIN_AREA
;
2320 case ON_RIGHT_MARGIN
:
2321 area
= RIGHT_MARGIN_AREA
;
2324 case ON_HEADER_LINE
:
2326 gr
= (part
== ON_HEADER_LINE
2327 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2328 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2331 goto text_glyph_row_found
;
2338 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2339 if (r
->y
+ r
->height
> y
)
2345 text_glyph_row_found
:
2348 struct glyph
*g
= gr
->glyphs
[area
];
2349 struct glyph
*end
= g
+ gr
->used
[area
];
2351 height
= gr
->height
;
2352 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2353 if (gx
+ g
->pixel_width
> x
)
2358 if (g
->type
== IMAGE_GLYPH
)
2360 /* Don't remember when mouse is over image, as
2361 image may have hot-spots. */
2362 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2365 width
= g
->pixel_width
;
2369 /* Use nominal char spacing at end of line. */
2371 gx
+= (x
/ width
) * width
;
2374 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2376 gx
+= window_box_left_offset (w
, area
);
2377 /* Don't expand over the modeline to make sure the vertical
2378 drag cursor is shown early enough. */
2379 height
= min (height
,
2380 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2385 /* Use nominal line height at end of window. */
2386 gx
= (x
/ width
) * width
;
2388 gy
+= (y
/ height
) * height
;
2389 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2390 /* See comment above. */
2391 height
= min (height
,
2392 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2396 case ON_LEFT_FRINGE
:
2397 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2398 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2399 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2400 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2403 case ON_RIGHT_FRINGE
:
2404 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2405 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2406 : window_box_right_offset (w
, TEXT_AREA
));
2407 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
) == 0
2408 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w
)
2409 && !WINDOW_RIGHTMOST_P (w
))
2410 if (gx
< WINDOW_PIXEL_WIDTH (w
) - width
)
2411 /* Make sure the vertical border can get her own glyph to the
2412 right of the one we build here. */
2413 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
) - width
;
2415 width
= WINDOW_PIXEL_WIDTH (w
) - gx
;
2417 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2421 case ON_VERTICAL_BORDER
:
2422 gx
= WINDOW_PIXEL_WIDTH (w
) - width
;
2425 case ON_VERTICAL_SCROLL_BAR
:
2426 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2428 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2429 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2430 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2432 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2436 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2437 if (r
->y
+ r
->height
> y
)
2444 height
= gr
->height
;
2447 /* Use nominal line height at end of window. */
2449 gy
+= (y
/ height
) * height
;
2453 case ON_RIGHT_DIVIDER
:
2454 gx
= WINDOW_PIXEL_WIDTH (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2455 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2457 /* The bottom divider prevails. */
2458 height
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2461 case ON_BOTTOM_DIVIDER
:
2463 width
= WINDOW_PIXEL_WIDTH (w
);
2464 gy
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2465 height
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2471 /* If there is no glyph under the mouse, then we divide the screen
2472 into a grid of the smallest glyph in the frame, and use that
2475 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2476 round down even for negative values. */
2482 gx
= (gx
/ width
) * width
;
2483 gy
= (gy
/ height
) * height
;
2489 gx
+= WINDOW_LEFT_EDGE_X (w
);
2490 gy
+= WINDOW_TOP_EDGE_Y (w
);
2493 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2495 /* Visible feedback for debugging. */
2496 #if false && defined HAVE_X_WINDOWS
2497 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2498 f
->output_data
.x
->normal_gc
,
2499 gx
, gy
, width
, height
);
2504 #endif /* HAVE_WINDOW_SYSTEM */
2507 adjust_window_ends (struct window
*w
, struct glyph_row
*row
, bool current
)
2510 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
2511 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
2513 = MATRIX_ROW_VPOS (row
, current
? w
->current_matrix
: w
->desired_matrix
);
2516 /***********************************************************************
2517 Lisp form evaluation
2518 ***********************************************************************/
2520 /* Error handler for safe_eval and safe_call. */
2523 safe_eval_handler (Lisp_Object arg
, ptrdiff_t nargs
, Lisp_Object
*args
)
2525 add_to_log ("Error during redisplay: %S signaled %S",
2526 Flist (nargs
, args
), arg
);
2530 /* Call function FUNC with the rest of NARGS - 1 arguments
2531 following. Return the result, or nil if something went
2532 wrong. Prevent redisplay during the evaluation. */
2535 safe__call (bool inhibit_quit
, ptrdiff_t nargs
, Lisp_Object func
, va_list ap
)
2539 if (inhibit_eval_during_redisplay
)
2544 ptrdiff_t count
= SPECPDL_INDEX ();
2547 SAFE_ALLOCA_LISP (args
, nargs
);
2550 for (i
= 1; i
< nargs
; i
++)
2551 args
[i
] = va_arg (ap
, Lisp_Object
);
2553 specbind (Qinhibit_redisplay
, Qt
);
2555 specbind (Qinhibit_quit
, Qt
);
2556 /* Use Qt to ensure debugger does not run,
2557 so there is no possibility of wanting to redisplay. */
2558 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2561 val
= unbind_to (count
, val
);
2568 safe_call (ptrdiff_t nargs
, Lisp_Object func
, ...)
2573 va_start (ap
, func
);
2574 retval
= safe__call (false, nargs
, func
, ap
);
2579 /* Call function FN with one argument ARG.
2580 Return the result, or nil if something went wrong. */
2583 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2585 return safe_call (2, fn
, arg
);
2589 safe__call1 (bool inhibit_quit
, Lisp_Object fn
, ...)
2595 retval
= safe__call (inhibit_quit
, 2, fn
, ap
);
2601 safe_eval (Lisp_Object sexpr
)
2603 return safe__call1 (false, Qeval
, sexpr
);
2607 safe__eval (bool inhibit_quit
, Lisp_Object sexpr
)
2609 return safe__call1 (inhibit_quit
, Qeval
, sexpr
);
2612 /* Call function FN with two arguments ARG1 and ARG2.
2613 Return the result, or nil if something went wrong. */
2616 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2618 return safe_call (3, fn
, arg1
, arg2
);
2623 /***********************************************************************
2625 ***********************************************************************/
2627 /* Define CHECK_IT to perform sanity checks on iterators.
2628 This is for debugging. It is too slow to do unconditionally. */
2631 CHECK_IT (struct it
*it
)
2634 if (it
->method
== GET_FROM_STRING
)
2636 eassert (STRINGP (it
->string
));
2637 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2641 eassert (IT_STRING_CHARPOS (*it
) < 0);
2642 if (it
->method
== GET_FROM_BUFFER
)
2644 /* Check that character and byte positions agree. */
2645 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2650 eassert (it
->current
.dpvec_index
>= 0);
2652 eassert (it
->current
.dpvec_index
< 0);
2657 /* Check that the window end of window W is what we expect it
2658 to be---the last row in the current matrix displaying text. */
2661 CHECK_WINDOW_END (struct window
*w
)
2663 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2664 if (!MINI_WINDOW_P (w
) && w
->window_end_valid
)
2666 struct glyph_row
*row
;
2667 eassert ((row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
),
2669 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2670 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2675 /***********************************************************************
2676 Iterator initialization
2677 ***********************************************************************/
2679 /* Initialize IT for displaying current_buffer in window W, starting
2680 at character position CHARPOS. CHARPOS < 0 means that no buffer
2681 position is specified which is useful when the iterator is assigned
2682 a position later. BYTEPOS is the byte position corresponding to
2685 If ROW is not null, calls to produce_glyphs with IT as parameter
2686 will produce glyphs in that row.
2688 BASE_FACE_ID is the id of a base face to use. It must be one of
2689 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2690 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2691 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2693 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2694 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2695 will be initialized to use the corresponding mode line glyph row of
2696 the desired matrix of W. */
2699 init_iterator (struct it
*it
, struct window
*w
,
2700 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2701 struct glyph_row
*row
, enum face_id base_face_id
)
2703 enum face_id remapped_base_face_id
= base_face_id
;
2705 /* Some precondition checks. */
2706 eassert (w
!= NULL
&& it
!= NULL
);
2707 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2710 /* If face attributes have been changed since the last redisplay,
2711 free realized faces now because they depend on face definitions
2712 that might have changed. Don't free faces while there might be
2713 desired matrices pending which reference these faces. */
2714 if (!inhibit_free_realized_faces
)
2718 face_change
= false;
2719 free_all_realized_faces (Qnil
);
2721 else if (XFRAME (w
->frame
)->face_change
)
2723 XFRAME (w
->frame
)->face_change
= 0;
2724 free_all_realized_faces (w
->frame
);
2728 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2729 if (! NILP (Vface_remapping_alist
))
2730 remapped_base_face_id
2731 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2733 /* Use one of the mode line rows of W's desired matrix if
2737 if (base_face_id
== MODE_LINE_FACE_ID
2738 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2739 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2740 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2741 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2744 /* Clear IT, and set it->object and other IT's Lisp objects to Qnil.
2745 Other parts of redisplay rely on that. */
2746 memclear (it
, sizeof *it
);
2747 it
->current
.overlay_string_index
= -1;
2748 it
->current
.dpvec_index
= -1;
2749 it
->base_face_id
= remapped_base_face_id
;
2750 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2751 it
->paragraph_embedding
= L2R
;
2754 /* The window in which we iterate over current_buffer: */
2755 XSETWINDOW (it
->window
, w
);
2757 it
->f
= XFRAME (w
->frame
);
2761 /* Extra space between lines (on window systems only). */
2762 if (base_face_id
== DEFAULT_FACE_ID
2763 && FRAME_WINDOW_P (it
->f
))
2765 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2766 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2767 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2768 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2769 * FRAME_LINE_HEIGHT (it
->f
));
2770 else if (it
->f
->extra_line_spacing
> 0)
2771 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2774 /* If realized faces have been removed, e.g. because of face
2775 attribute changes of named faces, recompute them. When running
2776 in batch mode, the face cache of the initial frame is null. If
2777 we happen to get called, make a dummy face cache. */
2778 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2779 init_frame_faces (it
->f
);
2780 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2781 recompute_basic_faces (it
->f
);
2783 it
->override_ascent
= -1;
2785 /* Are control characters displayed as `^C'? */
2786 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2788 /* -1 means everything between a CR and the following line end
2789 is invisible. >0 means lines indented more than this value are
2791 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2793 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2795 : (!NILP (BVAR (current_buffer
, selective_display
))
2797 it
->selective_display_ellipsis_p
2798 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2800 /* Display table to use. */
2801 it
->dp
= window_display_table (w
);
2803 /* Are multibyte characters enabled in current_buffer? */
2804 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2806 /* Get the position at which the redisplay_end_trigger hook should
2807 be run, if it is to be run at all. */
2808 if (MARKERP (w
->redisplay_end_trigger
)
2809 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2810 it
->redisplay_end_trigger_charpos
2811 = marker_position (w
->redisplay_end_trigger
);
2812 else if (INTEGERP (w
->redisplay_end_trigger
))
2813 it
->redisplay_end_trigger_charpos
2814 = clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
),
2817 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2819 /* Are lines in the display truncated? */
2821 it
->line_wrap
= TRUNCATE
;
2822 if (base_face_id
== DEFAULT_FACE_ID
2824 && (WINDOW_FULL_WIDTH_P (it
->w
)
2825 || NILP (Vtruncate_partial_width_windows
)
2826 || (INTEGERP (Vtruncate_partial_width_windows
)
2827 /* PXW: Shall we do something about this? */
2828 && (XINT (Vtruncate_partial_width_windows
)
2829 <= WINDOW_TOTAL_COLS (it
->w
))))
2830 && NILP (BVAR (current_buffer
, truncate_lines
)))
2831 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2832 ? WINDOW_WRAP
: WORD_WRAP
;
2834 /* Get dimensions of truncation and continuation glyphs. These are
2835 displayed as fringe bitmaps under X, but we need them for such
2836 frames when the fringes are turned off. But leave the dimensions
2837 zero for tooltip frames, as these glyphs look ugly there and also
2838 sabotage calculations of tooltip dimensions in x-show-tip. */
2839 #ifdef HAVE_WINDOW_SYSTEM
2840 if (!(FRAME_WINDOW_P (it
->f
)
2841 && FRAMEP (tip_frame
)
2842 && it
->f
== XFRAME (tip_frame
)))
2845 if (it
->line_wrap
== TRUNCATE
)
2847 /* We will need the truncation glyph. */
2848 eassert (it
->glyph_row
== NULL
);
2849 produce_special_glyphs (it
, IT_TRUNCATION
);
2850 it
->truncation_pixel_width
= it
->pixel_width
;
2854 /* We will need the continuation glyph. */
2855 eassert (it
->glyph_row
== NULL
);
2856 produce_special_glyphs (it
, IT_CONTINUATION
);
2857 it
->continuation_pixel_width
= it
->pixel_width
;
2861 /* Reset these values to zero because the produce_special_glyphs
2862 above has changed them. */
2863 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2864 it
->phys_ascent
= it
->phys_descent
= 0;
2866 /* Set this after getting the dimensions of truncation and
2867 continuation glyphs, so that we don't produce glyphs when calling
2868 produce_special_glyphs, above. */
2869 it
->glyph_row
= row
;
2870 it
->area
= TEXT_AREA
;
2872 /* Get the dimensions of the display area. The display area
2873 consists of the visible window area plus a horizontally scrolled
2874 part to the left of the window. All x-values are relative to the
2875 start of this total display area. */
2876 if (base_face_id
!= DEFAULT_FACE_ID
)
2878 /* Mode lines, menu bar in terminal frames. */
2879 it
->first_visible_x
= 0;
2880 it
->last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
2885 = window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2886 it
->last_visible_x
= (it
->first_visible_x
2887 + window_box_width (w
, TEXT_AREA
));
2889 /* If we truncate lines, leave room for the truncation glyph(s) at
2890 the right margin. Otherwise, leave room for the continuation
2891 glyph(s). Done only if the window has no right fringe. */
2892 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
2894 if (it
->line_wrap
== TRUNCATE
)
2895 it
->last_visible_x
-= it
->truncation_pixel_width
;
2897 it
->last_visible_x
-= it
->continuation_pixel_width
;
2900 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2901 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2904 /* Leave room for a border glyph. */
2905 if (!FRAME_WINDOW_P (it
->f
)
2906 && !WINDOW_RIGHTMOST_P (it
->w
))
2907 it
->last_visible_x
-= 1;
2909 it
->last_visible_y
= window_text_bottom_y (w
);
2911 /* For mode lines and alike, arrange for the first glyph having a
2912 left box line if the face specifies a box. */
2913 if (base_face_id
!= DEFAULT_FACE_ID
)
2917 it
->face_id
= remapped_base_face_id
;
2919 /* If we have a boxed mode line, make the first character appear
2920 with a left box line. */
2921 face
= FACE_OPT_FROM_ID (it
->f
, remapped_base_face_id
);
2922 if (face
&& face
->box
!= FACE_NO_BOX
)
2923 it
->start_of_box_run_p
= true;
2926 /* If a buffer position was specified, set the iterator there,
2927 getting overlays and face properties from that position. */
2928 if (charpos
>= BUF_BEG (current_buffer
))
2930 it
->stop_charpos
= charpos
;
2931 it
->end_charpos
= ZV
;
2932 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
2933 IT_CHARPOS (*it
) = charpos
;
2934 IT_BYTEPOS (*it
) = bytepos
;
2936 /* We will rely on `reseat' to set this up properly, via
2937 handle_face_prop. */
2938 it
->face_id
= it
->base_face_id
;
2940 it
->start
= it
->current
;
2941 /* Do we need to reorder bidirectional text? Not if this is a
2942 unibyte buffer: by definition, none of the single-byte
2943 characters are strong R2L, so no reordering is needed. And
2944 bidi.c doesn't support unibyte buffers anyway. Also, don't
2945 reorder while we are loading loadup.el, since the tables of
2946 character properties needed for reordering are not yet
2949 !redisplay__inhibit_bidi
2950 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2953 /* If we are to reorder bidirectional text, init the bidi
2957 /* Since we don't know at this point whether there will be
2958 any R2L lines in the window, we reserve space for
2959 truncation/continuation glyphs even if only the left
2960 fringe is absent. */
2961 if (base_face_id
== DEFAULT_FACE_ID
2962 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
2963 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
2965 if (it
->line_wrap
== TRUNCATE
)
2966 it
->last_visible_x
-= it
->truncation_pixel_width
;
2968 it
->last_visible_x
-= it
->continuation_pixel_width
;
2970 /* Note the paragraph direction that this buffer wants to
2972 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2974 it
->paragraph_embedding
= L2R
;
2975 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2977 it
->paragraph_embedding
= R2L
;
2979 it
->paragraph_embedding
= NEUTRAL_DIR
;
2980 bidi_unshelve_cache (NULL
, false);
2981 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2985 /* Compute faces etc. */
2986 reseat (it
, it
->current
.pos
, true);
2993 /* Initialize IT for the display of window W with window start POS. */
2996 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2998 struct glyph_row
*row
;
2999 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
3001 row
= w
->desired_matrix
->rows
+ first_vpos
;
3002 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
3003 it
->first_vpos
= first_vpos
;
3005 /* Don't reseat to previous visible line start if current start
3006 position is in a string or image. */
3007 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
3009 int first_y
= it
->current_y
;
3011 /* If window start is not at a line start, skip forward to POS to
3012 get the correct continuation lines width. */
3013 bool start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
3014 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
3015 if (!start_at_line_beg_p
)
3019 reseat_at_previous_visible_line_start (it
);
3020 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
3022 new_x
= it
->current_x
+ it
->pixel_width
;
3024 /* If lines are continued, this line may end in the middle
3025 of a multi-glyph character (e.g. a control character
3026 displayed as \003, or in the middle of an overlay
3027 string). In this case move_it_to above will not have
3028 taken us to the start of the continuation line but to the
3029 end of the continued line. */
3030 if (it
->current_x
> 0
3031 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
3032 && (/* And glyph doesn't fit on the line. */
3033 new_x
> it
->last_visible_x
3034 /* Or it fits exactly and we're on a window
3036 || (new_x
== it
->last_visible_x
3037 && FRAME_WINDOW_P (it
->f
)
3038 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
3039 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
3040 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
3042 if ((it
->current
.dpvec_index
>= 0
3043 || it
->current
.overlay_string_index
>= 0)
3044 /* If we are on a newline from a display vector or
3045 overlay string, then we are already at the end of
3046 a screen line; no need to go to the next line in
3047 that case, as this line is not really continued.
3048 (If we do go to the next line, C-e will not DTRT.) */
3051 set_iterator_to_next (it
, true);
3052 move_it_in_display_line_to (it
, -1, -1, 0);
3055 it
->continuation_lines_width
+= it
->current_x
;
3057 /* If the character at POS is displayed via a display
3058 vector, move_it_to above stops at the final glyph of
3059 IT->dpvec. To make the caller redisplay that character
3060 again (a.k.a. start at POS), we need to reset the
3061 dpvec_index to the beginning of IT->dpvec. */
3062 else if (it
->current
.dpvec_index
>= 0)
3063 it
->current
.dpvec_index
= 0;
3065 /* We're starting a new display line, not affected by the
3066 height of the continued line, so clear the appropriate
3067 fields in the iterator structure. */
3068 it
->max_ascent
= it
->max_descent
= 0;
3069 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3071 it
->current_y
= first_y
;
3073 it
->current_x
= it
->hpos
= 0;
3079 /* Return true if POS is a position in ellipses displayed for invisible
3080 text. W is the window we display, for text property lookup. */
3083 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3085 Lisp_Object prop
, window
;
3086 bool ellipses_p
= false;
3087 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3089 /* If POS specifies a position in a display vector, this might
3090 be for an ellipsis displayed for invisible text. We won't
3091 get the iterator set up for delivering that ellipsis unless
3092 we make sure that it gets aware of the invisible text. */
3093 if (pos
->dpvec_index
>= 0
3094 && pos
->overlay_string_index
< 0
3095 && CHARPOS (pos
->string_pos
) < 0
3097 && (XSETWINDOW (window
, w
),
3098 prop
= Fget_char_property (make_number (charpos
),
3099 Qinvisible
, window
),
3100 TEXT_PROP_MEANS_INVISIBLE (prop
) == 0))
3102 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3104 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3111 /* Initialize IT for stepping through current_buffer in window W,
3112 starting at position POS that includes overlay string and display
3113 vector/ control character translation position information. Value
3114 is false if there are overlay strings with newlines at POS. */
3117 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3119 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3121 bool overlay_strings_with_newlines
= false;
3123 /* If POS specifies a position in a display vector, this might
3124 be for an ellipsis displayed for invisible text. We won't
3125 get the iterator set up for delivering that ellipsis unless
3126 we make sure that it gets aware of the invisible text. */
3127 if (in_ellipses_for_invisible_text_p (pos
, w
))
3133 /* Keep in mind: the call to reseat in init_iterator skips invisible
3134 text, so we might end up at a position different from POS. This
3135 is only a problem when POS is a row start after a newline and an
3136 overlay starts there with an after-string, and the overlay has an
3137 invisible property. Since we don't skip invisible text in
3138 display_line and elsewhere immediately after consuming the
3139 newline before the row start, such a POS will not be in a string,
3140 but the call to init_iterator below will move us to the
3142 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3144 /* This only scans the current chunk -- it should scan all chunks.
3145 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3146 to 16 in 22.1 to make this a lesser problem. */
3147 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3149 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3150 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3152 while (s
< e
&& *s
!= '\n')
3157 overlay_strings_with_newlines
= true;
3162 /* If position is within an overlay string, set up IT to the right
3164 if (pos
->overlay_string_index
>= 0)
3168 /* If the first overlay string happens to have a `display'
3169 property for an image, the iterator will be set up for that
3170 image, and we have to undo that setup first before we can
3171 correct the overlay string index. */
3172 if (it
->method
== GET_FROM_IMAGE
)
3175 /* We already have the first chunk of overlay strings in
3176 IT->overlay_strings. Load more until the one for
3177 pos->overlay_string_index is in IT->overlay_strings. */
3178 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3180 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3181 it
->current
.overlay_string_index
= 0;
3184 load_overlay_strings (it
, 0);
3185 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3189 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3190 relative_index
= (it
->current
.overlay_string_index
3191 % OVERLAY_STRING_CHUNK_SIZE
);
3192 it
->string
= it
->overlay_strings
[relative_index
];
3193 eassert (STRINGP (it
->string
));
3194 it
->current
.string_pos
= pos
->string_pos
;
3195 it
->method
= GET_FROM_STRING
;
3196 it
->end_charpos
= SCHARS (it
->string
);
3197 /* Set up the bidi iterator for this overlay string. */
3200 it
->bidi_it
.string
.lstring
= it
->string
;
3201 it
->bidi_it
.string
.s
= NULL
;
3202 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3203 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3204 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3205 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3206 it
->bidi_it
.w
= it
->w
;
3207 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3208 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3210 /* Synchronize the state of the bidi iterator with
3211 pos->string_pos. For any string position other than
3212 zero, this will be done automagically when we resume
3213 iteration over the string and get_visually_first_element
3214 is called. But if string_pos is zero, and the string is
3215 to be reordered for display, we need to resync manually,
3216 since it could be that the iteration state recorded in
3217 pos ended at string_pos of 0 moving backwards in string. */
3218 if (CHARPOS (pos
->string_pos
) == 0)
3220 get_visually_first_element (it
);
3221 if (IT_STRING_CHARPOS (*it
) != 0)
3224 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3225 bidi_move_to_visually_next (&it
->bidi_it
);
3226 } while (it
->bidi_it
.charpos
!= 0);
3228 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3229 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3233 if (CHARPOS (pos
->string_pos
) >= 0)
3235 /* Recorded position is not in an overlay string, but in another
3236 string. This can only be a string from a `display' property.
3237 IT should already be filled with that string. */
3238 it
->current
.string_pos
= pos
->string_pos
;
3239 eassert (STRINGP (it
->string
));
3241 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3242 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3245 /* Restore position in display vector translations, control
3246 character translations or ellipses. */
3247 if (pos
->dpvec_index
>= 0)
3249 if (it
->dpvec
== NULL
)
3250 get_next_display_element (it
);
3251 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3252 it
->current
.dpvec_index
= pos
->dpvec_index
;
3256 return !overlay_strings_with_newlines
;
3260 /* Initialize IT for stepping through current_buffer in window W
3261 starting at ROW->start. */
3264 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3266 init_from_display_pos (it
, w
, &row
->start
);
3267 it
->start
= row
->start
;
3268 it
->continuation_lines_width
= row
->continuation_lines_width
;
3273 /* Initialize IT for stepping through current_buffer in window W
3274 starting in the line following ROW, i.e. starting at ROW->end.
3275 Value is false if there are overlay strings with newlines at ROW's
3279 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3281 bool success
= false;
3283 if (init_from_display_pos (it
, w
, &row
->end
))
3285 if (row
->continued_p
)
3286 it
->continuation_lines_width
3287 = row
->continuation_lines_width
+ row
->pixel_width
;
3298 /***********************************************************************
3300 ***********************************************************************/
3302 /* Called when IT reaches IT->stop_charpos. Handle text property and
3303 overlay changes. Set IT->stop_charpos to the next position where
3307 handle_stop (struct it
*it
)
3309 enum prop_handled handled
;
3310 bool handle_overlay_change_p
;
3314 it
->current
.dpvec_index
= -1;
3315 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3316 it
->ellipsis_p
= false;
3318 /* Use face of preceding text for ellipsis (if invisible) */
3319 if (it
->selective_display_ellipsis_p
)
3320 it
->saved_face_id
= it
->face_id
;
3322 /* Here's the description of the semantics of, and the logic behind,
3323 the various HANDLED_* statuses:
3325 HANDLED_NORMALLY means the handler did its job, and the loop
3326 should proceed to calling the next handler in order.
3328 HANDLED_RECOMPUTE_PROPS means the handler caused a significant
3329 change in the properties and overlays at current position, so the
3330 loop should be restarted, to re-invoke the handlers that were
3331 already called. This happens when fontification-functions were
3332 called by handle_fontified_prop, and actually fontified
3333 something. Another case where HANDLED_RECOMPUTE_PROPS is
3334 returned is when we discover overlay strings that need to be
3335 displayed right away. The loop below will continue for as long
3336 as the status is HANDLED_RECOMPUTE_PROPS.
3338 HANDLED_RETURN means return immediately to the caller, to
3339 continue iteration without calling any further handlers. This is
3340 used when we need to act on some property right away, for example
3341 when we need to display the ellipsis or a replacing display
3342 property, such as display string or image.
3344 HANDLED_OVERLAY_STRING_CONSUMED means an overlay string was just
3345 consumed, and the handler switched to the next overlay string.
3346 This signals the loop below to refrain from looking for more
3347 overlays before all the overlay strings of the current overlay
3350 Some of the handlers called by the loop push the iterator state
3351 onto the stack (see 'push_it'), and arrange for the iteration to
3352 continue with another object, such as an image, a display string,
3353 or an overlay string. In most such cases, it->stop_charpos is
3354 set to the first character of the string, so that when the
3355 iteration resumes, this function will immediately be called
3356 again, to examine the properties at the beginning of the string.
3358 When a display or overlay string is exhausted, the iterator state
3359 is popped (see 'pop_it'), and iteration continues with the
3360 previous object. Again, in many such cases this function is
3361 called again to find the next position where properties might
3366 handled
= HANDLED_NORMALLY
;
3368 /* Call text property handlers. */
3369 for (p
= it_props
; p
->handler
; ++p
)
3371 handled
= p
->handler (it
);
3373 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3375 else if (handled
== HANDLED_RETURN
)
3377 /* We still want to show before and after strings from
3378 overlays even if the actual buffer text is replaced. */
3379 if (!handle_overlay_change_p
3381 /* Don't call get_overlay_strings_1 if we already
3382 have overlay strings loaded, because doing so
3383 will load them again and push the iterator state
3384 onto the stack one more time, which is not
3385 expected by the rest of the code that processes
3387 || (it
->current
.overlay_string_index
< 0
3388 && !get_overlay_strings_1 (it
, 0, false)))
3391 setup_for_ellipsis (it
, 0);
3392 /* When handling a display spec, we might load an
3393 empty string. In that case, discard it here. We
3394 used to discard it in handle_single_display_spec,
3395 but that causes get_overlay_strings_1, above, to
3396 ignore overlay strings that we must check. */
3397 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3401 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3405 it
->string_from_display_prop_p
= false;
3406 it
->from_disp_prop_p
= false;
3407 handle_overlay_change_p
= false;
3409 handled
= HANDLED_RECOMPUTE_PROPS
;
3412 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3413 handle_overlay_change_p
= false;
3416 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3418 /* Don't check for overlay strings below when set to deliver
3419 characters from a display vector. */
3420 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3421 handle_overlay_change_p
= false;
3423 /* Handle overlay changes.
3424 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3425 if it finds overlays. */
3426 if (handle_overlay_change_p
)
3427 handled
= handle_overlay_change (it
);
3432 setup_for_ellipsis (it
, 0);
3436 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3438 /* Determine where to stop next. */
3439 if (handled
== HANDLED_NORMALLY
)
3440 compute_stop_pos (it
);
3444 /* Compute IT->stop_charpos from text property and overlay change
3445 information for IT's current position. */
3448 compute_stop_pos (struct it
*it
)
3450 register INTERVAL iv
, next_iv
;
3451 Lisp_Object object
, limit
, position
;
3452 ptrdiff_t charpos
, bytepos
;
3454 if (STRINGP (it
->string
))
3456 /* Strings are usually short, so don't limit the search for
3458 it
->stop_charpos
= it
->end_charpos
;
3459 object
= it
->string
;
3461 charpos
= IT_STRING_CHARPOS (*it
);
3462 bytepos
= IT_STRING_BYTEPOS (*it
);
3468 /* If end_charpos is out of range for some reason, such as a
3469 misbehaving display function, rationalize it (Bug#5984). */
3470 if (it
->end_charpos
> ZV
)
3471 it
->end_charpos
= ZV
;
3472 it
->stop_charpos
= it
->end_charpos
;
3474 /* If next overlay change is in front of the current stop pos
3475 (which is IT->end_charpos), stop there. Note: value of
3476 next_overlay_change is point-max if no overlay change
3478 charpos
= IT_CHARPOS (*it
);
3479 bytepos
= IT_BYTEPOS (*it
);
3480 pos
= next_overlay_change (charpos
);
3481 if (pos
< it
->stop_charpos
)
3482 it
->stop_charpos
= pos
;
3484 /* Set up variables for computing the stop position from text
3485 property changes. */
3486 XSETBUFFER (object
, current_buffer
);
3487 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3490 /* Get the interval containing IT's position. Value is a null
3491 interval if there isn't such an interval. */
3492 position
= make_number (charpos
);
3493 iv
= validate_interval_range (object
, &position
, &position
, false);
3496 Lisp_Object values_here
[LAST_PROP_IDX
];
3499 /* Get properties here. */
3500 for (p
= it_props
; p
->handler
; ++p
)
3501 values_here
[p
->idx
] = textget (iv
->plist
,
3502 builtin_lisp_symbol (p
->name
));
3504 /* Look for an interval following iv that has different
3506 for (next_iv
= next_interval (iv
);
3509 || XFASTINT (limit
) > next_iv
->position
));
3510 next_iv
= next_interval (next_iv
))
3512 for (p
= it_props
; p
->handler
; ++p
)
3514 Lisp_Object new_value
= textget (next_iv
->plist
,
3515 builtin_lisp_symbol (p
->name
));
3516 if (!EQ (values_here
[p
->idx
], new_value
))
3526 if (INTEGERP (limit
)
3527 && next_iv
->position
>= XFASTINT (limit
))
3528 /* No text property change up to limit. */
3529 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3531 /* Text properties change in next_iv. */
3532 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3536 if (it
->cmp_it
.id
< 0)
3538 ptrdiff_t stoppos
= it
->end_charpos
;
3540 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3542 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3543 stoppos
, it
->string
);
3546 eassert (STRINGP (it
->string
)
3547 || (it
->stop_charpos
>= BEGV
3548 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3552 /* Return the position of the next overlay change after POS in
3553 current_buffer. Value is point-max if no overlay change
3554 follows. This is like `next-overlay-change' but doesn't use
3558 next_overlay_change (ptrdiff_t pos
)
3560 ptrdiff_t i
, noverlays
;
3562 Lisp_Object
*overlays
;
3565 /* Get all overlays at the given position. */
3566 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, true);
3568 /* If any of these overlays ends before endpos,
3569 use its ending point instead. */
3570 for (i
= 0; i
< noverlays
; ++i
)
3575 oend
= OVERLAY_END (overlays
[i
]);
3576 oendpos
= OVERLAY_POSITION (oend
);
3577 endpos
= min (endpos
, oendpos
);
3584 /* How many characters forward to search for a display property or
3585 display string. Searching too far forward makes the bidi display
3586 sluggish, especially in small windows. */
3587 #define MAX_DISP_SCAN 250
3589 /* Return the character position of a display string at or after
3590 position specified by POSITION. If no display string exists at or
3591 after POSITION, return ZV. A display string is either an overlay
3592 with `display' property whose value is a string, or a `display'
3593 text property whose value is a string. STRING is data about the
3594 string to iterate; if STRING->lstring is nil, we are iterating a
3595 buffer. FRAME_WINDOW_P is true when we are displaying a window
3596 on a GUI frame. DISP_PROP is set to zero if we searched
3597 MAX_DISP_SCAN characters forward without finding any display
3598 strings, non-zero otherwise. It is set to 2 if the display string
3599 uses any kind of `(space ...)' spec that will produce a stretch of
3600 white space in the text area. */
3602 compute_display_string_pos (struct text_pos
*position
,
3603 struct bidi_string_data
*string
,
3605 bool frame_window_p
, int *disp_prop
)
3607 /* OBJECT = nil means current buffer. */
3608 Lisp_Object object
, object1
;
3609 Lisp_Object pos
, spec
, limpos
;
3610 bool string_p
= string
&& (STRINGP (string
->lstring
) || string
->s
);
3611 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3612 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3613 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3615 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3616 struct text_pos tpos
;
3619 if (string
&& STRINGP (string
->lstring
))
3620 object1
= object
= string
->lstring
;
3621 else if (w
&& !string_p
)
3623 XSETWINDOW (object
, w
);
3627 object1
= object
= Qnil
;
3632 /* We don't support display properties whose values are strings
3633 that have display string properties. */
3634 || string
->from_disp_str
3635 /* C strings cannot have display properties. */
3636 || (string
->s
&& !STRINGP (object
)))
3642 /* If the character at CHARPOS is where the display string begins,
3644 pos
= make_number (charpos
);
3645 if (STRINGP (object
))
3646 bufpos
= string
->bufpos
;
3650 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3652 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3655 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3663 /* Look forward for the first character with a `display' property
3664 that will replace the underlying text when displayed. */
3665 limpos
= make_number (lim
);
3667 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3668 CHARPOS (tpos
) = XFASTINT (pos
);
3669 if (CHARPOS (tpos
) >= lim
)
3674 if (STRINGP (object
))
3675 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3677 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3678 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3679 if (!STRINGP (object
))
3680 bufpos
= CHARPOS (tpos
);
3681 } while (NILP (spec
)
3682 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3683 bufpos
, frame_window_p
)));
3687 return CHARPOS (tpos
);
3690 /* Return the character position of the end of the display string that
3691 started at CHARPOS. If there's no display string at CHARPOS,
3692 return -1. A display string is either an overlay with `display'
3693 property whose value is a string or a `display' text property whose
3694 value is a string. */
3696 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3698 /* OBJECT = nil means current buffer. */
3699 Lisp_Object object
=
3700 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3701 Lisp_Object pos
= make_number (charpos
);
3703 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3705 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3708 /* It could happen that the display property or overlay was removed
3709 since we found it in compute_display_string_pos above. One way
3710 this can happen is if JIT font-lock was called (through
3711 handle_fontified_prop), and jit-lock-functions remove text
3712 properties or overlays from the portion of buffer that includes
3713 CHARPOS. Muse mode is known to do that, for example. In this
3714 case, we return -1 to the caller, to signal that no display
3715 string is actually present at CHARPOS. See bidi_fetch_char for
3716 how this is handled.
3718 An alternative would be to never look for display properties past
3719 it->stop_charpos. But neither compute_display_string_pos nor
3720 bidi_fetch_char that calls it know or care where the next
3722 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3725 /* Look forward for the first character where the `display' property
3727 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3729 return XFASTINT (pos
);
3734 /***********************************************************************
3736 ***********************************************************************/
3738 /* Handle changes in the `fontified' property of the current buffer by
3739 calling hook functions from Qfontification_functions to fontify
3742 static enum prop_handled
3743 handle_fontified_prop (struct it
*it
)
3745 Lisp_Object prop
, pos
;
3746 enum prop_handled handled
= HANDLED_NORMALLY
;
3748 if (!NILP (Vmemory_full
))
3751 /* Get the value of the `fontified' property at IT's current buffer
3752 position. (The `fontified' property doesn't have a special
3753 meaning in strings.) If the value is nil, call functions from
3754 Qfontification_functions. */
3755 if (!STRINGP (it
->string
)
3757 && !NILP (Vfontification_functions
)
3758 && !NILP (Vrun_hooks
)
3759 && (pos
= make_number (IT_CHARPOS (*it
)),
3760 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3761 /* Ignore the special cased nil value always present at EOB since
3762 no amount of fontifying will be able to change it. */
3763 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3765 ptrdiff_t count
= SPECPDL_INDEX ();
3767 struct buffer
*obuf
= current_buffer
;
3768 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3769 bool old_clip_changed
= current_buffer
->clip_changed
;
3771 val
= Vfontification_functions
;
3772 specbind (Qfontification_functions
, Qnil
);
3774 eassert (it
->end_charpos
== ZV
);
3776 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3777 safe_call1 (val
, pos
);
3780 Lisp_Object fns
, fn
;
3784 for (; CONSP (val
); val
= XCDR (val
))
3790 /* A value of t indicates this hook has a local
3791 binding; it means to run the global binding too.
3792 In a global value, t should not occur. If it
3793 does, we must ignore it to avoid an endless
3795 for (fns
= Fdefault_value (Qfontification_functions
);
3801 safe_call1 (fn
, pos
);
3805 safe_call1 (fn
, pos
);
3809 unbind_to (count
, Qnil
);
3811 /* Fontification functions routinely call `save-restriction'.
3812 Normally, this tags clip_changed, which can confuse redisplay
3813 (see discussion in Bug#6671). Since we don't perform any
3814 special handling of fontification changes in the case where
3815 `save-restriction' isn't called, there's no point doing so in
3816 this case either. So, if the buffer's restrictions are
3817 actually left unchanged, reset clip_changed. */
3818 if (obuf
== current_buffer
)
3820 if (begv
== BEGV
&& zv
== ZV
)
3821 current_buffer
->clip_changed
= old_clip_changed
;
3823 /* There isn't much we can reasonably do to protect against
3824 misbehaving fontification, but here's a fig leaf. */
3825 else if (BUFFER_LIVE_P (obuf
))
3826 set_buffer_internal_1 (obuf
);
3828 /* The fontification code may have added/removed text.
3829 It could do even a lot worse, but let's at least protect against
3830 the most obvious case where only the text past `pos' gets changed',
3831 as is/was done in grep.el where some escapes sequences are turned
3832 into face properties (bug#7876). */
3833 it
->end_charpos
= ZV
;
3835 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3836 something. This avoids an endless loop if they failed to
3837 fontify the text for which reason ever. */
3838 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3839 handled
= HANDLED_RECOMPUTE_PROPS
;
3847 /***********************************************************************
3849 ***********************************************************************/
3851 /* Set up iterator IT from face properties at its current position.
3852 Called from handle_stop. */
3854 static enum prop_handled
3855 handle_face_prop (struct it
*it
)
3858 ptrdiff_t next_stop
;
3860 if (!STRINGP (it
->string
))
3863 = face_at_buffer_position (it
->w
,
3867 + TEXT_PROP_DISTANCE_LIMIT
),
3868 false, it
->base_face_id
);
3870 /* Is this a start of a run of characters with box face?
3871 Caveat: this can be called for a freshly initialized
3872 iterator; face_id is -1 in this case. We know that the new
3873 face will not change until limit, i.e. if the new face has a
3874 box, all characters up to limit will have one. But, as
3875 usual, we don't know whether limit is really the end. */
3876 if (new_face_id
!= it
->face_id
)
3878 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3879 /* If it->face_id is -1, old_face below will be NULL, see
3880 the definition of FACE_OPT_FROM_ID. This will happen if this
3881 is the initial call that gets the face. */
3882 struct face
*old_face
= FACE_OPT_FROM_ID (it
->f
, it
->face_id
);
3884 /* If the value of face_id of the iterator is -1, we have to
3885 look in front of IT's position and see whether there is a
3886 face there that's different from new_face_id. */
3887 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
3889 int prev_face_id
= face_before_it_pos (it
);
3891 old_face
= FACE_OPT_FROM_ID (it
->f
, prev_face_id
);
3894 /* If the new face has a box, but the old face does not,
3895 this is the start of a run of characters with box face,
3896 i.e. this character has a shadow on the left side. */
3897 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
3898 && (old_face
== NULL
|| !old_face
->box
));
3899 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3907 Lisp_Object from_overlay
3908 = (it
->current
.overlay_string_index
>= 0
3909 ? it
->string_overlays
[it
->current
.overlay_string_index
3910 % OVERLAY_STRING_CHUNK_SIZE
]
3913 /* See if we got to this string directly or indirectly from
3914 an overlay property. That includes the before-string or
3915 after-string of an overlay, strings in display properties
3916 provided by an overlay, their text properties, etc.
3918 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3919 if (! NILP (from_overlay
))
3920 for (i
= it
->sp
- 1; i
>= 0; i
--)
3922 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3924 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3925 % OVERLAY_STRING_CHUNK_SIZE
];
3926 else if (! NILP (it
->stack
[i
].from_overlay
))
3927 from_overlay
= it
->stack
[i
].from_overlay
;
3929 if (!NILP (from_overlay
))
3933 if (! NILP (from_overlay
))
3935 bufpos
= IT_CHARPOS (*it
);
3936 /* For a string from an overlay, the base face depends
3937 only on text properties and ignores overlays. */
3939 = face_for_overlay_string (it
->w
,
3943 + TEXT_PROP_DISTANCE_LIMIT
),
3951 /* For strings from a `display' property, use the face at
3952 IT's current buffer position as the base face to merge
3953 with, so that overlay strings appear in the same face as
3954 surrounding text, unless they specify their own faces.
3955 For strings from wrap-prefix and line-prefix properties,
3956 use the default face, possibly remapped via
3957 Vface_remapping_alist. */
3958 /* Note that the fact that we use the face at _buffer_
3959 position means that a 'display' property on an overlay
3960 string will not inherit the face of that overlay string,
3961 but will instead revert to the face of buffer text
3962 covered by the overlay. This is visible, e.g., when the
3963 overlay specifies a box face, but neither the buffer nor
3964 the display string do. This sounds like a design bug,
3965 but Emacs always did that since v21.1, so changing that
3966 might be a big deal. */
3967 base_face_id
= it
->string_from_prefix_prop_p
3968 ? (!NILP (Vface_remapping_alist
)
3969 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
3971 : underlying_face_id (it
);
3974 new_face_id
= face_at_string_position (it
->w
,
3976 IT_STRING_CHARPOS (*it
),
3979 base_face_id
, false);
3981 /* Is this a start of a run of characters with box? Caveat:
3982 this can be called for a freshly allocated iterator; face_id
3983 is -1 is this case. We know that the new face will not
3984 change until the next check pos, i.e. if the new face has a
3985 box, all characters up to that position will have a
3986 box. But, as usual, we don't know whether that position
3987 is really the end. */
3988 if (new_face_id
!= it
->face_id
)
3990 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3991 struct face
*old_face
= FACE_OPT_FROM_ID (it
->f
, it
->face_id
);
3993 /* If new face has a box but old face hasn't, this is the
3994 start of a run of characters with box, i.e. it has a
3995 shadow on the left side. */
3996 it
->start_of_box_run_p
3997 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3998 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
4002 it
->face_id
= new_face_id
;
4003 return HANDLED_NORMALLY
;
4007 /* Return the ID of the face ``underlying'' IT's current position,
4008 which is in a string. If the iterator is associated with a
4009 buffer, return the face at IT's current buffer position.
4010 Otherwise, use the iterator's base_face_id. */
4013 underlying_face_id (struct it
*it
)
4015 int face_id
= it
->base_face_id
, i
;
4017 eassert (STRINGP (it
->string
));
4019 for (i
= it
->sp
- 1; i
>= 0; --i
)
4020 if (NILP (it
->stack
[i
].string
))
4021 face_id
= it
->stack
[i
].face_id
;
4027 /* Compute the face one character before or after the current position
4028 of IT, in the visual order. BEFORE_P means get the face
4029 in front (to the left in L2R paragraphs, to the right in R2L
4030 paragraphs) of IT's screen position. Value is the ID of the face. */
4033 face_before_or_after_it_pos (struct it
*it
, bool before_p
)
4036 ptrdiff_t next_check_charpos
;
4038 void *it_copy_data
= NULL
;
4040 eassert (it
->s
== NULL
);
4042 if (STRINGP (it
->string
))
4044 ptrdiff_t bufpos
, charpos
;
4047 /* No face change past the end of the string (for the case
4048 we are padding with spaces). No face change before the
4050 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
4051 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
4056 /* Set charpos to the position before or after IT's current
4057 position, in the logical order, which in the non-bidi
4058 case is the same as the visual order. */
4060 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4061 else if (it
->what
== IT_COMPOSITION
)
4062 /* For composition, we must check the character after the
4064 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4066 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4072 /* With bidi iteration, the character before the current
4073 in the visual order cannot be found by simple
4074 iteration, because "reverse" reordering is not
4075 supported. Instead, we need to start from the string
4076 beginning and go all the way to the current string
4077 position, remembering the previous position. */
4078 /* Ignore face changes before the first visible
4079 character on this display line. */
4080 if (it
->current_x
<= it
->first_visible_x
)
4082 SAVE_IT (it_copy
, *it
, it_copy_data
);
4083 IT_STRING_CHARPOS (it_copy
) = 0;
4084 bidi_init_it (0, 0, FRAME_WINDOW_P (it_copy
.f
), &it_copy
.bidi_it
);
4088 charpos
= IT_STRING_CHARPOS (it_copy
);
4089 if (charpos
>= SCHARS (it
->string
))
4091 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4093 while (IT_STRING_CHARPOS (it_copy
) != IT_STRING_CHARPOS (*it
));
4095 RESTORE_IT (it
, it
, it_copy_data
);
4099 /* Set charpos to the string position of the character
4100 that comes after IT's current position in the visual
4102 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4106 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4108 charpos
= it_copy
.bidi_it
.charpos
;
4111 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4113 if (it
->current
.overlay_string_index
>= 0)
4114 bufpos
= IT_CHARPOS (*it
);
4118 base_face_id
= underlying_face_id (it
);
4120 /* Get the face for ASCII, or unibyte. */
4121 face_id
= face_at_string_position (it
->w
,
4125 &next_check_charpos
,
4126 base_face_id
, false);
4128 /* Correct the face for charsets different from ASCII. Do it
4129 for the multibyte case only. The face returned above is
4130 suitable for unibyte text if IT->string is unibyte. */
4131 if (STRING_MULTIBYTE (it
->string
))
4133 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4134 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4136 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4138 c
= string_char_and_length (p
, &len
);
4139 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4144 struct text_pos pos
;
4146 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4147 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4150 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4151 pos
= it
->current
.pos
;
4156 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4159 if (it
->what
== IT_COMPOSITION
)
4161 /* For composition, we must check the position after
4163 pos
.charpos
+= it
->cmp_it
.nchars
;
4164 pos
.bytepos
+= it
->len
;
4167 INC_TEXT_POS (pos
, it
->multibyte_p
);
4176 /* With bidi iteration, the character before the current
4177 in the visual order cannot be found by simple
4178 iteration, because "reverse" reordering is not
4179 supported. Instead, we need to use the move_it_*
4180 family of functions, and move to the previous
4181 character starting from the beginning of the visual
4183 /* Ignore face changes before the first visible
4184 character on this display line. */
4185 if (it
->current_x
<= it
->first_visible_x
)
4187 SAVE_IT (it_copy
, *it
, it_copy_data
);
4188 /* Implementation note: Since move_it_in_display_line
4189 works in the iterator geometry, and thinks the first
4190 character is always the leftmost, even in R2L lines,
4191 we don't need to distinguish between the R2L and L2R
4193 current_x
= it_copy
.current_x
;
4194 move_it_vertically_backward (&it_copy
, 0);
4195 move_it_in_display_line (&it_copy
, ZV
, current_x
- 1, MOVE_TO_X
);
4196 pos
= it_copy
.current
.pos
;
4197 RESTORE_IT (it
, it
, it_copy_data
);
4201 /* Set charpos to the buffer position of the character
4202 that comes after IT's current position in the visual
4204 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4208 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4211 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4214 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4216 /* Determine face for CHARSET_ASCII, or unibyte. */
4217 face_id
= face_at_buffer_position (it
->w
,
4219 &next_check_charpos
,
4222 /* Correct the face for charsets different from ASCII. Do it
4223 for the multibyte case only. The face returned above is
4224 suitable for unibyte text if current_buffer is unibyte. */
4225 if (it
->multibyte_p
)
4227 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4228 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4229 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4238 /***********************************************************************
4240 ***********************************************************************/
4242 /* Set up iterator IT from invisible properties at its current
4243 position. Called from handle_stop. */
4245 static enum prop_handled
4246 handle_invisible_prop (struct it
*it
)
4248 enum prop_handled handled
= HANDLED_NORMALLY
;
4252 if (STRINGP (it
->string
))
4254 Lisp_Object end_charpos
, limit
;
4256 /* Get the value of the invisible text property at the
4257 current position. Value will be nil if there is no such
4259 end_charpos
= make_number (IT_STRING_CHARPOS (*it
));
4260 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4261 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4263 if (invis
!= 0 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4265 /* Record whether we have to display an ellipsis for the
4267 bool display_ellipsis_p
= (invis
== 2);
4268 ptrdiff_t len
, endpos
;
4270 handled
= HANDLED_RECOMPUTE_PROPS
;
4272 /* Get the position at which the next visible text can be
4273 found in IT->string, if any. */
4274 endpos
= len
= SCHARS (it
->string
);
4275 XSETINT (limit
, len
);
4279 = Fnext_single_property_change (end_charpos
, Qinvisible
,
4281 /* Since LIMIT is always an integer, so should be the
4282 value returned by Fnext_single_property_change. */
4283 eassert (INTEGERP (end_charpos
));
4284 if (INTEGERP (end_charpos
))
4286 endpos
= XFASTINT (end_charpos
);
4287 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4288 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4290 display_ellipsis_p
= true;
4292 else /* Should never happen; but if it does, exit the loop. */
4295 while (invis
!= 0 && endpos
< len
);
4297 if (display_ellipsis_p
)
4298 it
->ellipsis_p
= true;
4302 /* Text at END_CHARPOS is visible. Move IT there. */
4303 struct text_pos old
;
4306 old
= it
->current
.string_pos
;
4307 oldpos
= CHARPOS (old
);
4310 if (it
->bidi_it
.first_elt
4311 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4312 bidi_paragraph_init (it
->paragraph_embedding
,
4313 &it
->bidi_it
, true);
4314 /* Bidi-iterate out of the invisible text. */
4317 bidi_move_to_visually_next (&it
->bidi_it
);
4319 while (oldpos
<= it
->bidi_it
.charpos
4320 && it
->bidi_it
.charpos
< endpos
);
4322 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4323 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4324 if (IT_CHARPOS (*it
) >= endpos
)
4325 it
->prev_stop
= endpos
;
4329 IT_STRING_CHARPOS (*it
) = endpos
;
4330 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4335 /* The rest of the string is invisible. If this is an
4336 overlay string, proceed with the next overlay string
4337 or whatever comes and return a character from there. */
4338 if (it
->current
.overlay_string_index
>= 0
4339 && !display_ellipsis_p
)
4341 next_overlay_string (it
);
4342 /* Don't check for overlay strings when we just
4343 finished processing them. */
4344 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4348 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4349 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4356 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4357 Lisp_Object pos
, overlay
;
4359 /* First of all, is there invisible text at this position? */
4360 tem
= start_charpos
= IT_CHARPOS (*it
);
4361 pos
= make_number (tem
);
4362 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4364 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4366 /* If we are on invisible text, skip over it. */
4367 if (invis
!= 0 && start_charpos
< it
->end_charpos
)
4369 /* Record whether we have to display an ellipsis for the
4371 bool display_ellipsis_p
= invis
== 2;
4373 handled
= HANDLED_RECOMPUTE_PROPS
;
4375 /* Loop skipping over invisible text. The loop is left at
4376 ZV or with IT on the first char being visible again. */
4379 /* Try to skip some invisible text. Return value is the
4380 position reached which can be equal to where we start
4381 if there is nothing invisible there. This skips both
4382 over invisible text properties and overlays with
4383 invisible property. */
4384 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4386 /* If we skipped nothing at all we weren't at invisible
4387 text in the first place. If everything to the end of
4388 the buffer was skipped, end the loop. */
4389 if (newpos
== tem
|| newpos
>= ZV
)
4393 /* We skipped some characters but not necessarily
4394 all there are. Check if we ended up on visible
4395 text. Fget_char_property returns the property of
4396 the char before the given position, i.e. if we
4397 get invis = 0, this means that the char at
4398 newpos is visible. */
4399 pos
= make_number (newpos
);
4400 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4401 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4404 /* If we ended up on invisible text, proceed to
4405 skip starting with next_stop. */
4409 /* If there are adjacent invisible texts, don't lose the
4410 second one's ellipsis. */
4412 display_ellipsis_p
= true;
4416 /* The position newpos is now either ZV or on visible text. */
4419 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4421 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4423 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4425 /* If the invisible text ends on a newline or on a
4426 character after a newline, we can avoid the costly,
4427 character by character, bidi iteration to NEWPOS, and
4428 instead simply reseat the iterator there. That's
4429 because all bidi reordering information is tossed at
4430 the newline. This is a big win for modes that hide
4431 complete lines, like Outline, Org, etc. */
4432 if (on_newline
|| after_newline
)
4434 struct text_pos tpos
;
4435 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4437 SET_TEXT_POS (tpos
, newpos
, bpos
);
4438 reseat_1 (it
, tpos
, false);
4439 /* If we reseat on a newline/ZV, we need to prep the
4440 bidi iterator for advancing to the next character
4441 after the newline/EOB, keeping the current paragraph
4442 direction (so that PRODUCE_GLYPHS does TRT wrt
4443 prepending/appending glyphs to a glyph row). */
4446 it
->bidi_it
.first_elt
= false;
4447 it
->bidi_it
.paragraph_dir
= pdir
;
4448 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4449 it
->bidi_it
.nchars
= 1;
4450 it
->bidi_it
.ch_len
= 1;
4453 else /* Must use the slow method. */
4455 /* With bidi iteration, the region of invisible text
4456 could start and/or end in the middle of a
4457 non-base embedding level. Therefore, we need to
4458 skip invisible text using the bidi iterator,
4459 starting at IT's current position, until we find
4460 ourselves outside of the invisible text.
4461 Skipping invisible text _after_ bidi iteration
4462 avoids affecting the visual order of the
4463 displayed text when invisible properties are
4464 added or removed. */
4465 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4467 /* If we were `reseat'ed to a new paragraph,
4468 determine the paragraph base direction. We
4469 need to do it now because
4470 next_element_from_buffer may not have a
4471 chance to do it, if we are going to skip any
4472 text at the beginning, which resets the
4474 bidi_paragraph_init (it
->paragraph_embedding
,
4475 &it
->bidi_it
, true);
4479 bidi_move_to_visually_next (&it
->bidi_it
);
4481 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4482 && it
->bidi_it
.charpos
< newpos
);
4483 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4484 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4485 /* If we overstepped NEWPOS, record its position in
4486 the iterator, so that we skip invisible text if
4487 later the bidi iteration lands us in the
4488 invisible region again. */
4489 if (IT_CHARPOS (*it
) >= newpos
)
4490 it
->prev_stop
= newpos
;
4495 IT_CHARPOS (*it
) = newpos
;
4496 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4499 if (display_ellipsis_p
)
4501 /* Make sure that the glyphs of the ellipsis will get
4502 correct `charpos' values. If we would not update
4503 it->position here, the glyphs would belong to the
4504 last visible character _before_ the invisible
4505 text, which confuses `set_cursor_from_row'.
4507 We use the last invisible position instead of the
4508 first because this way the cursor is always drawn on
4509 the first "." of the ellipsis, whenever PT is inside
4510 the invisible text. Otherwise the cursor would be
4511 placed _after_ the ellipsis when the point is after the
4512 first invisible character. */
4513 if (!STRINGP (it
->object
))
4515 it
->position
.charpos
= newpos
- 1;
4516 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4520 /* If there are before-strings at the start of invisible
4521 text, and the text is invisible because of a text
4522 property, arrange to show before-strings because 20.x did
4523 it that way. (If the text is invisible because of an
4524 overlay property instead of a text property, this is
4525 already handled in the overlay code.) */
4527 && get_overlay_strings (it
, it
->stop_charpos
))
4529 handled
= HANDLED_RECOMPUTE_PROPS
;
4532 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4533 /* The call to get_overlay_strings above recomputes
4534 it->stop_charpos, but it only considers changes
4535 in properties and overlays beyond iterator's
4536 current position. This causes us to miss changes
4537 that happen exactly where the invisible property
4538 ended. So we play it safe here and force the
4539 iterator to check for potential stop positions
4540 immediately after the invisible text. Note that
4541 if get_overlay_strings returns true, it
4542 normally also pushed the iterator stack, so we
4543 need to update the stop position in the slot
4544 below the current one. */
4545 it
->stack
[it
->sp
- 1].stop_charpos
4546 = CHARPOS (it
->stack
[it
->sp
- 1].current
.pos
);
4549 else if (display_ellipsis_p
)
4551 it
->ellipsis_p
= true;
4552 /* Let the ellipsis display before
4553 considering any properties of the following char.
4554 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4555 handled
= HANDLED_RETURN
;
4564 /* Make iterator IT return `...' next.
4565 Replaces LEN characters from buffer. */
4568 setup_for_ellipsis (struct it
*it
, int len
)
4570 /* Use the display table definition for `...'. Invalid glyphs
4571 will be handled by the method returning elements from dpvec. */
4572 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4574 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4575 it
->dpvec
= v
->contents
;
4576 it
->dpend
= v
->contents
+ v
->header
.size
;
4580 /* Default `...'. */
4581 it
->dpvec
= default_invis_vector
;
4582 it
->dpend
= default_invis_vector
+ 3;
4585 it
->dpvec_char_len
= len
;
4586 it
->current
.dpvec_index
= 0;
4587 it
->dpvec_face_id
= -1;
4589 /* Use IT->saved_face_id for the ellipsis, so that it has the same
4590 face as the preceding text. IT->saved_face_id was set in
4591 handle_stop to the face of the preceding character, and will be
4592 different from IT->face_id only if the invisible text skipped in
4593 handle_invisible_prop has some non-default face on its first
4594 character. We thus ignore the face of the invisible text when we
4595 display the ellipsis. IT's face is restored in set_iterator_to_next. */
4596 if (it
->saved_face_id
>= 0)
4597 it
->face_id
= it
->saved_face_id
;
4599 /* If the ellipsis represents buffer text, it means we advanced in
4600 the buffer, so we should no longer ignore overlay strings. */
4601 if (it
->method
== GET_FROM_BUFFER
)
4602 it
->ignore_overlay_strings_at_pos_p
= false;
4604 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4605 it
->ellipsis_p
= true;
4610 /***********************************************************************
4612 ***********************************************************************/
4614 /* Set up iterator IT from `display' property at its current position.
4615 Called from handle_stop.
4616 We return HANDLED_RETURN if some part of the display property
4617 overrides the display of the buffer text itself.
4618 Otherwise we return HANDLED_NORMALLY. */
4620 static enum prop_handled
4621 handle_display_prop (struct it
*it
)
4623 Lisp_Object propval
, object
, overlay
;
4624 struct text_pos
*position
;
4626 /* Nonzero if some property replaces the display of the text itself. */
4627 int display_replaced
= 0;
4629 if (STRINGP (it
->string
))
4631 object
= it
->string
;
4632 position
= &it
->current
.string_pos
;
4633 bufpos
= CHARPOS (it
->current
.pos
);
4637 XSETWINDOW (object
, it
->w
);
4638 position
= &it
->current
.pos
;
4639 bufpos
= CHARPOS (*position
);
4642 /* Reset those iterator values set from display property values. */
4643 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4644 it
->space_width
= Qnil
;
4645 it
->font_height
= Qnil
;
4648 /* We don't support recursive `display' properties, i.e. string
4649 values that have a string `display' property, that have a string
4650 `display' property etc. */
4651 if (!it
->string_from_display_prop_p
)
4652 it
->area
= TEXT_AREA
;
4654 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4655 Qdisplay
, object
, &overlay
);
4657 return HANDLED_NORMALLY
;
4658 /* Now OVERLAY is the overlay that gave us this property, or nil
4659 if it was a text property. */
4661 if (!STRINGP (it
->string
))
4662 object
= it
->w
->contents
;
4664 display_replaced
= handle_display_spec (it
, propval
, object
, overlay
,
4666 FRAME_WINDOW_P (it
->f
));
4667 return display_replaced
!= 0 ? HANDLED_RETURN
: HANDLED_NORMALLY
;
4670 /* Subroutine of handle_display_prop. Returns non-zero if the display
4671 specification in SPEC is a replacing specification, i.e. it would
4672 replace the text covered by `display' property with something else,
4673 such as an image or a display string. If SPEC includes any kind or
4674 `(space ...) specification, the value is 2; this is used by
4675 compute_display_string_pos, which see.
4677 See handle_single_display_spec for documentation of arguments.
4678 FRAME_WINDOW_P is true if the window being redisplayed is on a
4679 GUI frame; this argument is used only if IT is NULL, see below.
4681 IT can be NULL, if this is called by the bidi reordering code
4682 through compute_display_string_pos, which see. In that case, this
4683 function only examines SPEC, but does not otherwise "handle" it, in
4684 the sense that it doesn't set up members of IT from the display
4687 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4688 Lisp_Object overlay
, struct text_pos
*position
,
4689 ptrdiff_t bufpos
, bool frame_window_p
)
4694 /* Simple specifications. */
4695 && !EQ (XCAR (spec
), Qimage
)
4696 #ifdef HAVE_XWIDGETS
4697 && !EQ (XCAR (spec
), Qxwidget
)
4699 && !EQ (XCAR (spec
), Qspace
)
4700 && !EQ (XCAR (spec
), Qwhen
)
4701 && !EQ (XCAR (spec
), Qslice
)
4702 && !EQ (XCAR (spec
), Qspace_width
)
4703 && !EQ (XCAR (spec
), Qheight
)
4704 && !EQ (XCAR (spec
), Qraise
)
4705 /* Marginal area specifications. */
4706 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4707 && !EQ (XCAR (spec
), Qleft_fringe
)
4708 && !EQ (XCAR (spec
), Qright_fringe
)
4709 && !NILP (XCAR (spec
)))
4711 for (; CONSP (spec
); spec
= XCDR (spec
))
4713 int rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4714 overlay
, position
, bufpos
,
4715 replacing
, frame_window_p
);
4719 /* If some text in a string is replaced, `position' no
4720 longer points to the position of `object'. */
4721 if (!it
|| STRINGP (object
))
4726 else if (VECTORP (spec
))
4729 for (i
= 0; i
< ASIZE (spec
); ++i
)
4731 int rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4732 overlay
, position
, bufpos
,
4733 replacing
, frame_window_p
);
4737 /* If some text in a string is replaced, `position' no
4738 longer points to the position of `object'. */
4739 if (!it
|| STRINGP (object
))
4745 replacing
= handle_single_display_spec (it
, spec
, object
, overlay
, position
,
4746 bufpos
, 0, frame_window_p
);
4750 /* Value is the position of the end of the `display' property starting
4751 at START_POS in OBJECT. */
4753 static struct text_pos
4754 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4757 struct text_pos end_pos
;
4759 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4760 Qdisplay
, object
, Qnil
);
4761 CHARPOS (end_pos
) = XFASTINT (end
);
4762 if (STRINGP (object
))
4763 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4765 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4771 /* Set up IT from a single `display' property specification SPEC. OBJECT
4772 is the object in which the `display' property was found. *POSITION
4773 is the position in OBJECT at which the `display' property was found.
4774 BUFPOS is the buffer position of OBJECT (different from POSITION if
4775 OBJECT is not a buffer). DISPLAY_REPLACED non-zero means that we
4776 previously saw a display specification which already replaced text
4777 display with something else, for example an image; we ignore such
4778 properties after the first one has been processed.
4780 OVERLAY is the overlay this `display' property came from,
4781 or nil if it was a text property.
4783 If SPEC is a `space' or `image' specification, and in some other
4784 cases too, set *POSITION to the position where the `display'
4787 If IT is NULL, only examine the property specification in SPEC, but
4788 don't set up IT. In that case, FRAME_WINDOW_P means SPEC
4789 is intended to be displayed in a window on a GUI frame.
4791 Value is non-zero if something was found which replaces the display
4792 of buffer or string text. */
4795 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4796 Lisp_Object overlay
, struct text_pos
*position
,
4797 ptrdiff_t bufpos
, int display_replaced
,
4798 bool frame_window_p
)
4801 Lisp_Object location
, value
;
4802 struct text_pos start_pos
= *position
;
4804 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4805 If the result is non-nil, use VALUE instead of SPEC. */
4807 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4816 if (!NILP (form
) && !EQ (form
, Qt
))
4818 ptrdiff_t count
= SPECPDL_INDEX ();
4820 /* Bind `object' to the object having the `display' property, a
4821 buffer or string. Bind `position' to the position in the
4822 object where the property was found, and `buffer-position'
4823 to the current position in the buffer. */
4826 XSETBUFFER (object
, current_buffer
);
4827 specbind (Qobject
, object
);
4828 specbind (Qposition
, make_number (CHARPOS (*position
)));
4829 specbind (Qbuffer_position
, make_number (bufpos
));
4830 form
= safe_eval (form
);
4831 unbind_to (count
, Qnil
);
4837 /* Handle `(height HEIGHT)' specifications. */
4839 && EQ (XCAR (spec
), Qheight
)
4840 && CONSP (XCDR (spec
)))
4844 if (!FRAME_WINDOW_P (it
->f
))
4847 it
->font_height
= XCAR (XCDR (spec
));
4848 if (!NILP (it
->font_height
))
4850 int new_height
= -1;
4852 if (CONSP (it
->font_height
)
4853 && (EQ (XCAR (it
->font_height
), Qplus
)
4854 || EQ (XCAR (it
->font_height
), Qminus
))
4855 && CONSP (XCDR (it
->font_height
))
4856 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4858 /* `(+ N)' or `(- N)' where N is an integer. */
4859 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4860 if (EQ (XCAR (it
->font_height
), Qplus
))
4862 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4864 else if (FUNCTIONP (it
->font_height
))
4866 /* Call function with current height as argument.
4867 Value is the new height. */
4868 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4870 height
= safe_call1 (it
->font_height
,
4871 face
->lface
[LFACE_HEIGHT_INDEX
]);
4872 if (NUMBERP (height
))
4873 new_height
= XFLOATINT (height
);
4875 else if (NUMBERP (it
->font_height
))
4877 /* Value is a multiple of the canonical char height. */
4880 f
= FACE_FROM_ID (it
->f
,
4881 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4882 new_height
= (XFLOATINT (it
->font_height
)
4883 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4887 /* Evaluate IT->font_height with `height' bound to the
4888 current specified height to get the new height. */
4889 ptrdiff_t count
= SPECPDL_INDEX ();
4890 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4892 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4893 value
= safe_eval (it
->font_height
);
4894 unbind_to (count
, Qnil
);
4896 if (NUMBERP (value
))
4897 new_height
= XFLOATINT (value
);
4901 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4908 /* Handle `(space-width WIDTH)'. */
4910 && EQ (XCAR (spec
), Qspace_width
)
4911 && CONSP (XCDR (spec
)))
4915 if (!FRAME_WINDOW_P (it
->f
))
4918 value
= XCAR (XCDR (spec
));
4919 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4920 it
->space_width
= value
;
4926 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4928 && EQ (XCAR (spec
), Qslice
))
4934 if (!FRAME_WINDOW_P (it
->f
))
4937 if (tem
= XCDR (spec
), CONSP (tem
))
4939 it
->slice
.x
= XCAR (tem
);
4940 if (tem
= XCDR (tem
), CONSP (tem
))
4942 it
->slice
.y
= XCAR (tem
);
4943 if (tem
= XCDR (tem
), CONSP (tem
))
4945 it
->slice
.width
= XCAR (tem
);
4946 if (tem
= XCDR (tem
), CONSP (tem
))
4947 it
->slice
.height
= XCAR (tem
);
4956 /* Handle `(raise FACTOR)'. */
4958 && EQ (XCAR (spec
), Qraise
)
4959 && CONSP (XCDR (spec
)))
4963 if (!FRAME_WINDOW_P (it
->f
))
4966 #ifdef HAVE_WINDOW_SYSTEM
4967 value
= XCAR (XCDR (spec
));
4968 if (NUMBERP (value
))
4970 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4971 it
->voffset
= - (XFLOATINT (value
)
4972 * (normal_char_height (face
->font
, -1)));
4974 #endif /* HAVE_WINDOW_SYSTEM */
4980 /* Don't handle the other kinds of display specifications
4981 inside a string that we got from a `display' property. */
4982 if (it
&& it
->string_from_display_prop_p
)
4985 /* Characters having this form of property are not displayed, so
4986 we have to find the end of the property. */
4989 start_pos
= *position
;
4990 *position
= display_prop_end (it
, object
, start_pos
);
4991 /* If the display property comes from an overlay, don't consider
4992 any potential stop_charpos values before the end of that
4993 overlay. Since display_prop_end will happily find another
4994 'display' property coming from some other overlay or text
4995 property on buffer positions before this overlay's end, we
4996 need to ignore them, or else we risk displaying this
4997 overlay's display string/image twice. */
4998 if (!NILP (overlay
))
5000 ptrdiff_t ovendpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5002 if (ovendpos
> CHARPOS (*position
))
5003 SET_TEXT_POS (*position
, ovendpos
, CHAR_TO_BYTE (ovendpos
));
5008 /* Stop the scan at that end position--we assume that all
5009 text properties change there. */
5011 it
->stop_charpos
= position
->charpos
;
5013 /* Handle `(left-fringe BITMAP [FACE])'
5014 and `(right-fringe BITMAP [FACE])'. */
5016 && (EQ (XCAR (spec
), Qleft_fringe
)
5017 || EQ (XCAR (spec
), Qright_fringe
))
5018 && CONSP (XCDR (spec
)))
5024 if (!FRAME_WINDOW_P (it
->f
))
5025 /* If we return here, POSITION has been advanced
5026 across the text with this property. */
5028 /* Synchronize the bidi iterator with POSITION. This is
5029 needed because we are not going to push the iterator
5030 on behalf of this display property, so there will be
5031 no pop_it call to do this synchronization for us. */
5034 it
->position
= *position
;
5035 iterate_out_of_display_property (it
);
5036 *position
= it
->position
;
5041 else if (!frame_window_p
)
5044 #ifdef HAVE_WINDOW_SYSTEM
5045 value
= XCAR (XCDR (spec
));
5046 if (!SYMBOLP (value
)
5047 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
5048 /* If we return here, POSITION has been advanced
5049 across the text with this property. */
5051 if (it
&& it
->bidi_p
)
5053 it
->position
= *position
;
5054 iterate_out_of_display_property (it
);
5055 *position
= it
->position
;
5062 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
5064 if (CONSP (XCDR (XCDR (spec
))))
5066 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
5067 int face_id2
= lookup_derived_face (it
->f
, face_name
,
5068 FRINGE_FACE_ID
, false);
5073 /* Save current settings of IT so that we can restore them
5074 when we are finished with the glyph property value. */
5075 push_it (it
, position
);
5077 it
->area
= TEXT_AREA
;
5078 it
->what
= IT_IMAGE
;
5079 it
->image_id
= -1; /* no image */
5080 it
->position
= start_pos
;
5081 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5082 it
->method
= GET_FROM_IMAGE
;
5083 it
->from_overlay
= Qnil
;
5084 it
->face_id
= face_id
;
5085 it
->from_disp_prop_p
= true;
5087 /* Say that we haven't consumed the characters with
5088 `display' property yet. The call to pop_it in
5089 set_iterator_to_next will clean this up. */
5090 *position
= start_pos
;
5092 if (EQ (XCAR (spec
), Qleft_fringe
))
5094 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5095 it
->left_user_fringe_face_id
= face_id
;
5099 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5100 it
->right_user_fringe_face_id
= face_id
;
5103 #endif /* HAVE_WINDOW_SYSTEM */
5107 /* Prepare to handle `((margin left-margin) ...)',
5108 `((margin right-margin) ...)' and `((margin nil) ...)'
5109 prefixes for display specifications. */
5110 location
= Qunbound
;
5111 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5115 value
= XCDR (spec
);
5117 value
= XCAR (value
);
5120 if (EQ (XCAR (tem
), Qmargin
)
5121 && (tem
= XCDR (tem
),
5122 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5124 || EQ (tem
, Qleft_margin
)
5125 || EQ (tem
, Qright_margin
))))
5129 if (EQ (location
, Qunbound
))
5135 /* After this point, VALUE is the property after any
5136 margin prefix has been stripped. It must be a string,
5137 an image specification, or `(space ...)'.
5139 LOCATION specifies where to display: `left-margin',
5140 `right-margin' or nil. */
5142 bool valid_p
= (STRINGP (value
)
5143 #ifdef HAVE_WINDOW_SYSTEM
5144 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5145 && valid_image_p (value
))
5146 #endif /* not HAVE_WINDOW_SYSTEM */
5147 || (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5148 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5149 && valid_xwidget_spec_p (value
)));
5151 if (valid_p
&& display_replaced
== 0)
5157 /* Callers need to know whether the display spec is any kind
5158 of `(space ...)' spec that is about to affect text-area
5160 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5165 /* Save current settings of IT so that we can restore them
5166 when we are finished with the glyph property value. */
5167 push_it (it
, position
);
5168 it
->from_overlay
= overlay
;
5169 it
->from_disp_prop_p
= true;
5171 if (NILP (location
))
5172 it
->area
= TEXT_AREA
;
5173 else if (EQ (location
, Qleft_margin
))
5174 it
->area
= LEFT_MARGIN_AREA
;
5176 it
->area
= RIGHT_MARGIN_AREA
;
5178 if (STRINGP (value
))
5181 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5182 it
->current
.overlay_string_index
= -1;
5183 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5184 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5185 it
->method
= GET_FROM_STRING
;
5186 it
->stop_charpos
= 0;
5188 it
->base_level_stop
= 0;
5189 it
->string_from_display_prop_p
= true;
5190 /* Say that we haven't consumed the characters with
5191 `display' property yet. The call to pop_it in
5192 set_iterator_to_next will clean this up. */
5193 if (BUFFERP (object
))
5194 *position
= start_pos
;
5196 /* Force paragraph direction to be that of the parent
5197 object. If the parent object's paragraph direction is
5198 not yet determined, default to L2R. */
5199 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5200 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5202 it
->paragraph_embedding
= L2R
;
5204 /* Set up the bidi iterator for this display string. */
5207 it
->bidi_it
.string
.lstring
= it
->string
;
5208 it
->bidi_it
.string
.s
= NULL
;
5209 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5210 it
->bidi_it
.string
.bufpos
= bufpos
;
5211 it
->bidi_it
.string
.from_disp_str
= true;
5212 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5213 it
->bidi_it
.w
= it
->w
;
5214 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5217 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5219 it
->method
= GET_FROM_STRETCH
;
5221 *position
= it
->position
= start_pos
;
5222 retval
= 1 + (it
->area
== TEXT_AREA
);
5224 else if (valid_xwidget_spec_p (value
))
5226 it
->what
= IT_XWIDGET
;
5227 it
->method
= GET_FROM_XWIDGET
;
5228 it
->position
= start_pos
;
5229 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5230 *position
= start_pos
;
5231 it
->xwidget
= lookup_xwidget (value
);
5233 #ifdef HAVE_WINDOW_SYSTEM
5236 it
->what
= IT_IMAGE
;
5237 it
->image_id
= lookup_image (it
->f
, value
);
5238 it
->position
= start_pos
;
5239 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5240 it
->method
= GET_FROM_IMAGE
;
5242 /* Say that we haven't consumed the characters with
5243 `display' property yet. The call to pop_it in
5244 set_iterator_to_next will clean this up. */
5245 *position
= start_pos
;
5247 #endif /* HAVE_WINDOW_SYSTEM */
5252 /* Invalid property or property not supported. Restore
5253 POSITION to what it was before. */
5254 *position
= start_pos
;
5258 /* Check if PROP is a display property value whose text should be
5259 treated as intangible. OVERLAY is the overlay from which PROP
5260 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5261 specify the buffer position covered by PROP. */
5264 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5265 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5267 bool frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5268 struct text_pos position
;
5270 SET_TEXT_POS (position
, charpos
, bytepos
);
5271 return (handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5272 &position
, charpos
, frame_window_p
)
5277 /* Return true if PROP is a display sub-property value containing STRING.
5279 Implementation note: this and the following function are really
5280 special cases of handle_display_spec and
5281 handle_single_display_spec, and should ideally use the same code.
5282 Until they do, these two pairs must be consistent and must be
5283 modified in sync. */
5286 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5288 if (EQ (string
, prop
))
5291 /* Skip over `when FORM'. */
5292 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5297 /* Actually, the condition following `when' should be eval'ed,
5298 like handle_single_display_spec does, and we should return
5299 false if it evaluates to nil. However, this function is
5300 called only when the buffer was already displayed and some
5301 glyph in the glyph matrix was found to come from a display
5302 string. Therefore, the condition was already evaluated, and
5303 the result was non-nil, otherwise the display string wouldn't
5304 have been displayed and we would have never been called for
5305 this property. Thus, we can skip the evaluation and assume
5306 its result is non-nil. */
5311 /* Skip over `margin LOCATION'. */
5312 if (EQ (XCAR (prop
), Qmargin
))
5323 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5327 /* Return true if STRING appears in the `display' property PROP. */
5330 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5333 && !EQ (XCAR (prop
), Qwhen
)
5334 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5336 /* A list of sub-properties. */
5337 while (CONSP (prop
))
5339 if (single_display_spec_string_p (XCAR (prop
), string
))
5344 else if (VECTORP (prop
))
5346 /* A vector of sub-properties. */
5348 for (i
= 0; i
< ASIZE (prop
); ++i
)
5349 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5353 return single_display_spec_string_p (prop
, string
);
5358 /* Look for STRING in overlays and text properties in the current
5359 buffer, between character positions FROM and TO (excluding TO).
5360 BACK_P means look back (in this case, TO is supposed to be
5362 Value is the first character position where STRING was found, or
5363 zero if it wasn't found before hitting TO.
5365 This function may only use code that doesn't eval because it is
5366 called asynchronously from note_mouse_highlight. */
5369 string_buffer_position_lim (Lisp_Object string
,
5370 ptrdiff_t from
, ptrdiff_t to
, bool back_p
)
5372 Lisp_Object limit
, prop
, pos
;
5375 pos
= make_number (max (from
, BEGV
));
5377 if (!back_p
) /* looking forward */
5379 limit
= make_number (min (to
, ZV
));
5380 while (!found
&& !EQ (pos
, limit
))
5382 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5383 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5386 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5390 else /* looking back */
5392 limit
= make_number (max (to
, BEGV
));
5393 while (!found
&& !EQ (pos
, limit
))
5395 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5396 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5399 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5404 return found
? XINT (pos
) : 0;
5407 /* Determine which buffer position in current buffer STRING comes from.
5408 AROUND_CHARPOS is an approximate position where it could come from.
5409 Value is the buffer position or 0 if it couldn't be determined.
5411 This function is necessary because we don't record buffer positions
5412 in glyphs generated from strings (to keep struct glyph small).
5413 This function may only use code that doesn't eval because it is
5414 called asynchronously from note_mouse_highlight. */
5417 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5419 const int MAX_DISTANCE
= 1000;
5420 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5421 around_charpos
+ MAX_DISTANCE
,
5425 found
= string_buffer_position_lim (string
, around_charpos
,
5426 around_charpos
- MAX_DISTANCE
, true);
5432 /***********************************************************************
5433 `composition' property
5434 ***********************************************************************/
5436 /* Set up iterator IT from `composition' property at its current
5437 position. Called from handle_stop. */
5439 static enum prop_handled
5440 handle_composition_prop (struct it
*it
)
5442 Lisp_Object prop
, string
;
5443 ptrdiff_t pos
, pos_byte
, start
, end
;
5445 if (STRINGP (it
->string
))
5449 pos
= IT_STRING_CHARPOS (*it
);
5450 pos_byte
= IT_STRING_BYTEPOS (*it
);
5451 string
= it
->string
;
5452 s
= SDATA (string
) + pos_byte
;
5453 it
->c
= STRING_CHAR (s
);
5457 pos
= IT_CHARPOS (*it
);
5458 pos_byte
= IT_BYTEPOS (*it
);
5460 it
->c
= FETCH_CHAR (pos_byte
);
5463 /* If there's a valid composition and point is not inside of the
5464 composition (in the case that the composition is from the current
5465 buffer), draw a glyph composed from the composition components. */
5466 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5467 && composition_valid_p (start
, end
, prop
)
5468 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5471 /* As we can't handle this situation (perhaps font-lock added
5472 a new composition), we just return here hoping that next
5473 redisplay will detect this composition much earlier. */
5474 return HANDLED_NORMALLY
;
5477 if (STRINGP (it
->string
))
5478 pos_byte
= string_char_to_byte (it
->string
, start
);
5480 pos_byte
= CHAR_TO_BYTE (start
);
5482 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5485 if (it
->cmp_it
.id
>= 0)
5488 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5489 it
->cmp_it
.nglyphs
= -1;
5493 return HANDLED_NORMALLY
;
5498 /***********************************************************************
5500 ***********************************************************************/
5502 /* The following structure is used to record overlay strings for
5503 later sorting in load_overlay_strings. */
5505 struct overlay_entry
5507 Lisp_Object overlay
;
5510 bool after_string_p
;
5514 /* Set up iterator IT from overlay strings at its current position.
5515 Called from handle_stop. */
5517 static enum prop_handled
5518 handle_overlay_change (struct it
*it
)
5520 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5521 return HANDLED_RECOMPUTE_PROPS
;
5523 return HANDLED_NORMALLY
;
5527 /* Set up the next overlay string for delivery by IT, if there is an
5528 overlay string to deliver. Called by set_iterator_to_next when the
5529 end of the current overlay string is reached. If there are more
5530 overlay strings to display, IT->string and
5531 IT->current.overlay_string_index are set appropriately here.
5532 Otherwise IT->string is set to nil. */
5535 next_overlay_string (struct it
*it
)
5537 ++it
->current
.overlay_string_index
;
5538 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5540 /* No more overlay strings. Restore IT's settings to what
5541 they were before overlay strings were processed, and
5542 continue to deliver from current_buffer. */
5544 it
->ellipsis_p
= it
->stack
[it
->sp
- 1].display_ellipsis_p
;
5547 || (NILP (it
->string
)
5548 && it
->method
== GET_FROM_BUFFER
5549 && it
->stop_charpos
>= BEGV
5550 && it
->stop_charpos
<= it
->end_charpos
));
5551 it
->current
.overlay_string_index
= -1;
5552 it
->n_overlay_strings
= 0;
5553 /* If there's an empty display string on the stack, pop the
5554 stack, to resync the bidi iterator with IT's position. Such
5555 empty strings are pushed onto the stack in
5556 get_overlay_strings_1. */
5557 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5560 /* Since we've exhausted overlay strings at this buffer
5561 position, set the flag to ignore overlays until we move to
5562 another position. The flag is reset in
5563 next_element_from_buffer. */
5564 it
->ignore_overlay_strings_at_pos_p
= true;
5566 /* If we're at the end of the buffer, record that we have
5567 processed the overlay strings there already, so that
5568 next_element_from_buffer doesn't try it again. */
5569 if (NILP (it
->string
)
5570 && IT_CHARPOS (*it
) >= it
->end_charpos
5571 && it
->overlay_strings_charpos
>= it
->end_charpos
)
5572 it
->overlay_strings_at_end_processed_p
= true;
5573 /* Note: we reset overlay_strings_charpos only here, to make
5574 sure the just-processed overlays were indeed at EOB.
5575 Otherwise, overlays on text with invisible text property,
5576 which are processed with IT's position past the invisible
5577 text, might fool us into thinking the overlays at EOB were
5578 already processed (linum-mode can cause this, for
5580 it
->overlay_strings_charpos
= -1;
5584 /* There are more overlay strings to process. If
5585 IT->current.overlay_string_index has advanced to a position
5586 where we must load IT->overlay_strings with more strings, do
5587 it. We must load at the IT->overlay_strings_charpos where
5588 IT->n_overlay_strings was originally computed; when invisible
5589 text is present, this might not be IT_CHARPOS (Bug#7016). */
5590 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5592 if (it
->current
.overlay_string_index
&& i
== 0)
5593 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5595 /* Initialize IT to deliver display elements from the overlay
5597 it
->string
= it
->overlay_strings
[i
];
5598 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5599 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5600 it
->method
= GET_FROM_STRING
;
5601 it
->stop_charpos
= 0;
5602 it
->end_charpos
= SCHARS (it
->string
);
5603 if (it
->cmp_it
.stop_pos
>= 0)
5604 it
->cmp_it
.stop_pos
= 0;
5606 it
->base_level_stop
= 0;
5608 /* Set up the bidi iterator for this overlay string. */
5611 it
->bidi_it
.string
.lstring
= it
->string
;
5612 it
->bidi_it
.string
.s
= NULL
;
5613 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5614 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5615 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5616 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5617 it
->bidi_it
.w
= it
->w
;
5618 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5626 /* Compare two overlay_entry structures E1 and E2. Used as a
5627 comparison function for qsort in load_overlay_strings. Overlay
5628 strings for the same position are sorted so that
5630 1. All after-strings come in front of before-strings, except
5631 when they come from the same overlay.
5633 2. Within after-strings, strings are sorted so that overlay strings
5634 from overlays with higher priorities come first.
5636 2. Within before-strings, strings are sorted so that overlay
5637 strings from overlays with higher priorities come last.
5639 Value is analogous to strcmp. */
5643 compare_overlay_entries (const void *e1
, const void *e2
)
5645 struct overlay_entry
const *entry1
= e1
;
5646 struct overlay_entry
const *entry2
= e2
;
5649 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5651 /* Let after-strings appear in front of before-strings if
5652 they come from different overlays. */
5653 if (EQ (entry1
->overlay
, entry2
->overlay
))
5654 result
= entry1
->after_string_p
? 1 : -1;
5656 result
= entry1
->after_string_p
? -1 : 1;
5658 else if (entry1
->priority
!= entry2
->priority
)
5660 if (entry1
->after_string_p
)
5661 /* After-strings sorted in order of decreasing priority. */
5662 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5664 /* Before-strings sorted in order of increasing priority. */
5665 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5674 /* Load the vector IT->overlay_strings with overlay strings from IT's
5675 current buffer position, or from CHARPOS if that is > 0. Set
5676 IT->n_overlays to the total number of overlay strings found.
5678 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5679 a time. On entry into load_overlay_strings,
5680 IT->current.overlay_string_index gives the number of overlay
5681 strings that have already been loaded by previous calls to this
5684 IT->add_overlay_start contains an additional overlay start
5685 position to consider for taking overlay strings from, if non-zero.
5686 This position comes into play when the overlay has an `invisible'
5687 property, and both before and after-strings. When we've skipped to
5688 the end of the overlay, because of its `invisible' property, we
5689 nevertheless want its before-string to appear.
5690 IT->add_overlay_start will contain the overlay start position
5693 Overlay strings are sorted so that after-string strings come in
5694 front of before-string strings. Within before and after-strings,
5695 strings are sorted by overlay priority. See also function
5696 compare_overlay_entries. */
5699 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5701 Lisp_Object overlay
, window
, str
, invisible
;
5702 struct Lisp_Overlay
*ov
;
5703 ptrdiff_t start
, end
;
5704 ptrdiff_t n
= 0, i
, j
;
5706 struct overlay_entry entriesbuf
[20];
5707 ptrdiff_t size
= ARRAYELTS (entriesbuf
);
5708 struct overlay_entry
*entries
= entriesbuf
;
5712 charpos
= IT_CHARPOS (*it
);
5714 /* Append the overlay string STRING of overlay OVERLAY to vector
5715 `entries' which has size `size' and currently contains `n'
5716 elements. AFTER_P means STRING is an after-string of
5718 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5721 Lisp_Object priority; \
5725 struct overlay_entry *old = entries; \
5726 SAFE_NALLOCA (entries, 2, size); \
5727 memcpy (entries, old, size * sizeof *entries); \
5731 entries[n].string = (STRING); \
5732 entries[n].overlay = (OVERLAY); \
5733 priority = Foverlay_get ((OVERLAY), Qpriority); \
5734 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5735 entries[n].after_string_p = (AFTER_P); \
5740 /* Process overlay before the overlay center. */
5741 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5743 XSETMISC (overlay
, ov
);
5744 eassert (OVERLAYP (overlay
));
5745 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5746 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5751 /* Skip this overlay if it doesn't start or end at IT's current
5753 if (end
!= charpos
&& start
!= charpos
)
5756 /* Skip this overlay if it doesn't apply to IT->w. */
5757 window
= Foverlay_get (overlay
, Qwindow
);
5758 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5761 /* If the text ``under'' the overlay is invisible, both before-
5762 and after-strings from this overlay are visible; start and
5763 end position are indistinguishable. */
5764 invisible
= Foverlay_get (overlay
, Qinvisible
);
5765 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5767 /* If overlay has a non-empty before-string, record it. */
5768 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5769 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5771 RECORD_OVERLAY_STRING (overlay
, str
, false);
5773 /* If overlay has a non-empty after-string, record it. */
5774 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5775 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5777 RECORD_OVERLAY_STRING (overlay
, str
, true);
5780 /* Process overlays after the overlay center. */
5781 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5783 XSETMISC (overlay
, ov
);
5784 eassert (OVERLAYP (overlay
));
5785 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5786 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5788 if (start
> charpos
)
5791 /* Skip this overlay if it doesn't start or end at IT's current
5793 if (end
!= charpos
&& start
!= charpos
)
5796 /* Skip this overlay if it doesn't apply to IT->w. */
5797 window
= Foverlay_get (overlay
, Qwindow
);
5798 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5801 /* If the text ``under'' the overlay is invisible, it has a zero
5802 dimension, and both before- and after-strings apply. */
5803 invisible
= Foverlay_get (overlay
, Qinvisible
);
5804 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5806 /* If overlay has a non-empty before-string, record it. */
5807 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5808 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5810 RECORD_OVERLAY_STRING (overlay
, str
, false);
5812 /* If overlay has a non-empty after-string, record it. */
5813 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5814 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5816 RECORD_OVERLAY_STRING (overlay
, str
, true);
5819 #undef RECORD_OVERLAY_STRING
5823 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5825 /* Record number of overlay strings, and where we computed it. */
5826 it
->n_overlay_strings
= n
;
5827 it
->overlay_strings_charpos
= charpos
;
5829 /* IT->current.overlay_string_index is the number of overlay strings
5830 that have already been consumed by IT. Copy some of the
5831 remaining overlay strings to IT->overlay_strings. */
5833 j
= it
->current
.overlay_string_index
;
5834 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5836 it
->overlay_strings
[i
] = entries
[j
].string
;
5837 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5845 /* Get the first chunk of overlay strings at IT's current buffer
5846 position, or at CHARPOS if that is > 0. Value is true if at
5847 least one overlay string was found. */
5850 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, bool compute_stop_p
)
5852 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5853 process. This fills IT->overlay_strings with strings, and sets
5854 IT->n_overlay_strings to the total number of strings to process.
5855 IT->pos.overlay_string_index has to be set temporarily to zero
5856 because load_overlay_strings needs this; it must be set to -1
5857 when no overlay strings are found because a zero value would
5858 indicate a position in the first overlay string. */
5859 it
->current
.overlay_string_index
= 0;
5860 load_overlay_strings (it
, charpos
);
5862 /* If we found overlay strings, set up IT to deliver display
5863 elements from the first one. Otherwise set up IT to deliver
5864 from current_buffer. */
5865 if (it
->n_overlay_strings
)
5867 /* Make sure we know settings in current_buffer, so that we can
5868 restore meaningful values when we're done with the overlay
5871 compute_stop_pos (it
);
5872 eassert (it
->face_id
>= 0);
5874 /* Save IT's settings. They are restored after all overlay
5875 strings have been processed. */
5876 eassert (!compute_stop_p
|| it
->sp
== 0);
5878 /* When called from handle_stop, there might be an empty display
5879 string loaded. In that case, don't bother saving it. But
5880 don't use this optimization with the bidi iterator, since we
5881 need the corresponding pop_it call to resync the bidi
5882 iterator's position with IT's position, after we are done
5883 with the overlay strings. (The corresponding call to pop_it
5884 in case of an empty display string is in
5885 next_overlay_string.) */
5887 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5890 /* Set up IT to deliver display elements from the first overlay
5892 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5893 it
->string
= it
->overlay_strings
[0];
5894 it
->from_overlay
= Qnil
;
5895 it
->stop_charpos
= 0;
5896 eassert (STRINGP (it
->string
));
5897 it
->end_charpos
= SCHARS (it
->string
);
5899 it
->base_level_stop
= 0;
5900 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5901 it
->method
= GET_FROM_STRING
;
5902 it
->from_disp_prop_p
= 0;
5904 /* Force paragraph direction to be that of the parent
5906 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5907 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5909 it
->paragraph_embedding
= L2R
;
5911 /* Set up the bidi iterator for this overlay string. */
5914 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5916 it
->bidi_it
.string
.lstring
= it
->string
;
5917 it
->bidi_it
.string
.s
= NULL
;
5918 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5919 it
->bidi_it
.string
.bufpos
= pos
;
5920 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5921 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5922 it
->bidi_it
.w
= it
->w
;
5923 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5928 it
->current
.overlay_string_index
= -1;
5933 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5936 it
->method
= GET_FROM_BUFFER
;
5938 get_overlay_strings_1 (it
, charpos
, true);
5942 /* Value is true if we found at least one overlay string. */
5943 return STRINGP (it
->string
);
5948 /***********************************************************************
5949 Saving and restoring state
5950 ***********************************************************************/
5952 /* Save current settings of IT on IT->stack. Called, for example,
5953 before setting up IT for an overlay string, to be able to restore
5954 IT's settings to what they were after the overlay string has been
5955 processed. If POSITION is non-NULL, it is the position to save on
5956 the stack instead of IT->position. */
5959 push_it (struct it
*it
, struct text_pos
*position
)
5961 struct iterator_stack_entry
*p
;
5963 eassert (it
->sp
< IT_STACK_SIZE
);
5964 p
= it
->stack
+ it
->sp
;
5966 p
->stop_charpos
= it
->stop_charpos
;
5967 p
->prev_stop
= it
->prev_stop
;
5968 p
->base_level_stop
= it
->base_level_stop
;
5969 p
->cmp_it
= it
->cmp_it
;
5970 eassert (it
->face_id
>= 0);
5971 p
->face_id
= it
->face_id
;
5972 p
->string
= it
->string
;
5973 p
->method
= it
->method
;
5974 p
->from_overlay
= it
->from_overlay
;
5977 case GET_FROM_IMAGE
:
5978 p
->u
.image
.object
= it
->object
;
5979 p
->u
.image
.image_id
= it
->image_id
;
5980 p
->u
.image
.slice
= it
->slice
;
5982 case GET_FROM_STRETCH
:
5983 p
->u
.stretch
.object
= it
->object
;
5985 case GET_FROM_XWIDGET
:
5986 p
->u
.xwidget
.object
= it
->object
;
5988 case GET_FROM_BUFFER
:
5989 case GET_FROM_DISPLAY_VECTOR
:
5990 case GET_FROM_STRING
:
5991 case GET_FROM_C_STRING
:
5996 p
->position
= position
? *position
: it
->position
;
5997 p
->current
= it
->current
;
5998 p
->end_charpos
= it
->end_charpos
;
5999 p
->string_nchars
= it
->string_nchars
;
6001 p
->multibyte_p
= it
->multibyte_p
;
6002 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
6003 p
->space_width
= it
->space_width
;
6004 p
->font_height
= it
->font_height
;
6005 p
->voffset
= it
->voffset
;
6006 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
6007 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
6008 p
->display_ellipsis_p
= false;
6009 p
->line_wrap
= it
->line_wrap
;
6010 p
->bidi_p
= it
->bidi_p
;
6011 p
->paragraph_embedding
= it
->paragraph_embedding
;
6012 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
6015 /* Save the state of the bidi iterator as well. */
6017 bidi_push_it (&it
->bidi_it
);
6021 iterate_out_of_display_property (struct it
*it
)
6023 bool buffer_p
= !STRINGP (it
->string
);
6024 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
6025 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
6027 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
6029 /* Maybe initialize paragraph direction. If we are at the beginning
6030 of a new paragraph, next_element_from_buffer may not have a
6031 chance to do that. */
6032 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
6033 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
6034 /* prev_stop can be zero, so check against BEGV as well. */
6035 while (it
->bidi_it
.charpos
>= bob
6036 && it
->prev_stop
<= it
->bidi_it
.charpos
6037 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
6038 && it
->bidi_it
.charpos
< eob
)
6039 bidi_move_to_visually_next (&it
->bidi_it
);
6040 /* Record the stop_pos we just crossed, for when we cross it
6042 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
6043 it
->prev_stop
= CHARPOS (it
->position
);
6044 /* If we ended up not where pop_it put us, resync IT's
6045 positional members with the bidi iterator. */
6046 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
6047 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
6049 it
->current
.pos
= it
->position
;
6051 it
->current
.string_pos
= it
->position
;
6054 /* Restore IT's settings from IT->stack. Called, for example, when no
6055 more overlay strings must be processed, and we return to delivering
6056 display elements from a buffer, or when the end of a string from a
6057 `display' property is reached and we return to delivering display
6058 elements from an overlay string, or from a buffer. */
6061 pop_it (struct it
*it
)
6063 struct iterator_stack_entry
*p
;
6064 bool from_display_prop
= it
->from_disp_prop_p
;
6065 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
6067 eassert (it
->sp
> 0);
6069 p
= it
->stack
+ it
->sp
;
6070 it
->stop_charpos
= p
->stop_charpos
;
6071 it
->prev_stop
= p
->prev_stop
;
6072 it
->base_level_stop
= p
->base_level_stop
;
6073 it
->cmp_it
= p
->cmp_it
;
6074 it
->face_id
= p
->face_id
;
6075 it
->current
= p
->current
;
6076 it
->position
= p
->position
;
6077 it
->string
= p
->string
;
6078 it
->from_overlay
= p
->from_overlay
;
6079 if (NILP (it
->string
))
6080 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
6081 it
->method
= p
->method
;
6084 case GET_FROM_IMAGE
:
6085 it
->image_id
= p
->u
.image
.image_id
;
6086 it
->object
= p
->u
.image
.object
;
6087 it
->slice
= p
->u
.image
.slice
;
6089 case GET_FROM_XWIDGET
:
6090 it
->object
= p
->u
.xwidget
.object
;
6092 case GET_FROM_STRETCH
:
6093 it
->object
= p
->u
.stretch
.object
;
6095 case GET_FROM_BUFFER
:
6096 it
->object
= it
->w
->contents
;
6098 case GET_FROM_STRING
:
6100 struct face
*face
= FACE_OPT_FROM_ID (it
->f
, it
->face_id
);
6102 /* Restore the face_box_p flag, since it could have been
6103 overwritten by the face of the object that we just finished
6106 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6107 it
->object
= it
->string
;
6110 case GET_FROM_DISPLAY_VECTOR
:
6112 it
->method
= GET_FROM_C_STRING
;
6113 else if (STRINGP (it
->string
))
6114 it
->method
= GET_FROM_STRING
;
6117 it
->method
= GET_FROM_BUFFER
;
6118 it
->object
= it
->w
->contents
;
6121 case GET_FROM_C_STRING
:
6126 it
->end_charpos
= p
->end_charpos
;
6127 it
->string_nchars
= p
->string_nchars
;
6129 it
->multibyte_p
= p
->multibyte_p
;
6130 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6131 it
->space_width
= p
->space_width
;
6132 it
->font_height
= p
->font_height
;
6133 it
->voffset
= p
->voffset
;
6134 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6135 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6136 it
->line_wrap
= p
->line_wrap
;
6137 it
->bidi_p
= p
->bidi_p
;
6138 it
->paragraph_embedding
= p
->paragraph_embedding
;
6139 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6142 bidi_pop_it (&it
->bidi_it
);
6143 /* Bidi-iterate until we get out of the portion of text, if any,
6144 covered by a `display' text property or by an overlay with
6145 `display' property. (We cannot just jump there, because the
6146 internal coherency of the bidi iterator state can not be
6147 preserved across such jumps.) We also must determine the
6148 paragraph base direction if the overlay we just processed is
6149 at the beginning of a new paragraph. */
6150 if (from_display_prop
6151 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6152 iterate_out_of_display_property (it
);
6154 eassert ((BUFFERP (it
->object
)
6155 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6156 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6157 || (STRINGP (it
->object
)
6158 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6159 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6160 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6162 /* If we move the iterator over text covered by a display property
6163 to a new buffer position, any info about previously seen overlays
6164 is no longer valid. */
6165 if (from_display_prop
&& it
->sp
== 0 && CHARPOS (it
->position
) != prev_pos
)
6166 it
->ignore_overlay_strings_at_pos_p
= false;
6171 /***********************************************************************
6173 ***********************************************************************/
6175 /* Set IT's current position to the previous line start. */
6178 back_to_previous_line_start (struct it
*it
)
6180 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6183 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6187 /* Move IT to the next line start.
6189 Value is true if a newline was found. Set *SKIPPED_P to true if
6190 we skipped over part of the text (as opposed to moving the iterator
6191 continuously over the text). Otherwise, don't change the value
6194 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6195 iterator on the newline, if it was found.
6197 Newlines may come from buffer text, overlay strings, or strings
6198 displayed via the `display' property. That's the reason we can't
6199 simply use find_newline_no_quit.
6201 Note that this function may not skip over invisible text that is so
6202 because of text properties and immediately follows a newline. If
6203 it would, function reseat_at_next_visible_line_start, when called
6204 from set_iterator_to_next, would effectively make invisible
6205 characters following a newline part of the wrong glyph row, which
6206 leads to wrong cursor motion. */
6209 forward_to_next_line_start (struct it
*it
, bool *skipped_p
,
6210 struct bidi_it
*bidi_it_prev
)
6212 ptrdiff_t old_selective
;
6213 bool newline_found_p
= false;
6215 const int MAX_NEWLINE_DISTANCE
= 500;
6217 /* If already on a newline, just consume it to avoid unintended
6218 skipping over invisible text below. */
6219 if (it
->what
== IT_CHARACTER
6221 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6223 if (it
->bidi_p
&& bidi_it_prev
)
6224 *bidi_it_prev
= it
->bidi_it
;
6225 set_iterator_to_next (it
, false);
6230 /* Don't handle selective display in the following. It's (a)
6231 unnecessary because it's done by the caller, and (b) leads to an
6232 infinite recursion because next_element_from_ellipsis indirectly
6233 calls this function. */
6234 old_selective
= it
->selective
;
6237 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6238 from buffer text. */
6240 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6241 n
+= !STRINGP (it
->string
))
6243 if (!get_next_display_element (it
))
6245 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6246 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6247 *bidi_it_prev
= it
->bidi_it
;
6248 set_iterator_to_next (it
, false);
6251 /* If we didn't find a newline near enough, see if we can use a
6253 if (!newline_found_p
)
6255 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6256 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6260 eassert (!STRINGP (it
->string
));
6262 /* If there isn't any `display' property in sight, and no
6263 overlays, we can just use the position of the newline in
6265 if (it
->stop_charpos
>= limit
6266 || ((pos
= Fnext_single_property_change (make_number (start
),
6268 make_number (limit
)),
6270 && next_overlay_change (start
) == ZV
))
6274 IT_CHARPOS (*it
) = limit
;
6275 IT_BYTEPOS (*it
) = bytepos
;
6279 struct bidi_it bprev
;
6281 /* Help bidi.c avoid expensive searches for display
6282 properties and overlays, by telling it that there are
6283 none up to `limit'. */
6284 if (it
->bidi_it
.disp_pos
< limit
)
6286 it
->bidi_it
.disp_pos
= limit
;
6287 it
->bidi_it
.disp_prop
= 0;
6290 bprev
= it
->bidi_it
;
6291 bidi_move_to_visually_next (&it
->bidi_it
);
6292 } while (it
->bidi_it
.charpos
!= limit
);
6293 IT_CHARPOS (*it
) = limit
;
6294 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6296 *bidi_it_prev
= bprev
;
6298 *skipped_p
= newline_found_p
= true;
6302 while (get_next_display_element (it
)
6303 && !newline_found_p
)
6305 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6306 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6307 *bidi_it_prev
= it
->bidi_it
;
6308 set_iterator_to_next (it
, false);
6313 it
->selective
= old_selective
;
6314 return newline_found_p
;
6318 /* Set IT's current position to the previous visible line start. Skip
6319 invisible text that is so either due to text properties or due to
6320 selective display. Caution: this does not change IT->current_x and
6324 back_to_previous_visible_line_start (struct it
*it
)
6326 while (IT_CHARPOS (*it
) > BEGV
)
6328 back_to_previous_line_start (it
);
6330 if (IT_CHARPOS (*it
) <= BEGV
)
6333 /* If selective > 0, then lines indented more than its value are
6335 if (it
->selective
> 0
6336 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6340 /* Check the newline before point for invisibility. */
6343 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6344 Qinvisible
, it
->window
);
6345 if (TEXT_PROP_MEANS_INVISIBLE (prop
) != 0)
6349 if (IT_CHARPOS (*it
) <= BEGV
)
6354 void *it2data
= NULL
;
6357 Lisp_Object val
, overlay
;
6359 SAVE_IT (it2
, *it
, it2data
);
6361 /* If newline is part of a composition, continue from start of composition */
6362 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6363 && beg
< IT_CHARPOS (*it
))
6366 /* If newline is replaced by a display property, find start of overlay
6367 or interval and continue search from that point. */
6368 pos
= --IT_CHARPOS (it2
);
6371 bidi_unshelve_cache (NULL
, false);
6372 it2
.string_from_display_prop_p
= false;
6373 it2
.from_disp_prop_p
= false;
6374 if (handle_display_prop (&it2
) == HANDLED_RETURN
6375 && !NILP (val
= get_char_property_and_overlay
6376 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6377 && (OVERLAYP (overlay
)
6378 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6379 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6381 RESTORE_IT (it
, it
, it2data
);
6385 /* Newline is not replaced by anything -- so we are done. */
6386 RESTORE_IT (it
, it
, it2data
);
6392 IT_CHARPOS (*it
) = beg
;
6393 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6397 it
->continuation_lines_width
= 0;
6399 eassert (IT_CHARPOS (*it
) >= BEGV
);
6400 eassert (IT_CHARPOS (*it
) == BEGV
6401 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6406 /* Reseat iterator IT at the previous visible line start. Skip
6407 invisible text that is so either due to text properties or due to
6408 selective display. At the end, update IT's overlay information,
6409 face information etc. */
6412 reseat_at_previous_visible_line_start (struct it
*it
)
6414 back_to_previous_visible_line_start (it
);
6415 reseat (it
, it
->current
.pos
, true);
6420 /* Reseat iterator IT on the next visible line start in the current
6421 buffer. ON_NEWLINE_P means position IT on the newline
6422 preceding the line start. Skip over invisible text that is so
6423 because of selective display. Compute faces, overlays etc at the
6424 new position. Note that this function does not skip over text that
6425 is invisible because of text properties. */
6428 reseat_at_next_visible_line_start (struct it
*it
, bool on_newline_p
)
6430 bool skipped_p
= false;
6431 struct bidi_it bidi_it_prev
;
6432 bool newline_found_p
6433 = forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6435 /* Skip over lines that are invisible because they are indented
6436 more than the value of IT->selective. */
6437 if (it
->selective
> 0)
6438 while (IT_CHARPOS (*it
) < ZV
6439 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6442 eassert (IT_BYTEPOS (*it
) == BEGV
6443 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6445 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6448 /* Position on the newline if that's what's requested. */
6449 if (on_newline_p
&& newline_found_p
)
6451 if (STRINGP (it
->string
))
6453 if (IT_STRING_CHARPOS (*it
) > 0)
6457 --IT_STRING_CHARPOS (*it
);
6458 --IT_STRING_BYTEPOS (*it
);
6462 /* We need to restore the bidi iterator to the state
6463 it had on the newline, and resync the IT's
6464 position with that. */
6465 it
->bidi_it
= bidi_it_prev
;
6466 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6467 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6471 else if (IT_CHARPOS (*it
) > BEGV
)
6480 /* We need to restore the bidi iterator to the state it
6481 had on the newline and resync IT with that. */
6482 it
->bidi_it
= bidi_it_prev
;
6483 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6484 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6486 reseat (it
, it
->current
.pos
, false);
6490 reseat (it
, it
->current
.pos
, false);
6497 /***********************************************************************
6498 Changing an iterator's position
6499 ***********************************************************************/
6501 /* Change IT's current position to POS in current_buffer.
6502 If FORCE_P, always check for text properties at the new position.
6503 Otherwise, text properties are only looked up if POS >=
6504 IT->check_charpos of a property. */
6507 reseat (struct it
*it
, struct text_pos pos
, bool force_p
)
6509 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6511 reseat_1 (it
, pos
, false);
6513 /* Determine where to check text properties. Avoid doing it
6514 where possible because text property lookup is very expensive. */
6516 || CHARPOS (pos
) > it
->stop_charpos
6517 || CHARPOS (pos
) < original_pos
)
6521 /* For bidi iteration, we need to prime prev_stop and
6522 base_level_stop with our best estimations. */
6523 /* Implementation note: Of course, POS is not necessarily a
6524 stop position, so assigning prev_pos to it is a lie; we
6525 should have called compute_stop_backwards. However, if
6526 the current buffer does not include any R2L characters,
6527 that call would be a waste of cycles, because the
6528 iterator will never move back, and thus never cross this
6529 "fake" stop position. So we delay that backward search
6530 until the time we really need it, in next_element_from_buffer. */
6531 if (CHARPOS (pos
) != it
->prev_stop
)
6532 it
->prev_stop
= CHARPOS (pos
);
6533 if (CHARPOS (pos
) < it
->base_level_stop
)
6534 it
->base_level_stop
= 0; /* meaning it's unknown */
6540 it
->prev_stop
= it
->base_level_stop
= 0;
6549 /* Change IT's buffer position to POS. SET_STOP_P means set
6550 IT->stop_pos to POS, also. */
6553 reseat_1 (struct it
*it
, struct text_pos pos
, bool set_stop_p
)
6555 /* Don't call this function when scanning a C string. */
6556 eassert (it
->s
== NULL
);
6558 /* POS must be a reasonable value. */
6559 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6561 it
->current
.pos
= it
->position
= pos
;
6562 it
->end_charpos
= ZV
;
6564 it
->current
.dpvec_index
= -1;
6565 it
->current
.overlay_string_index
= -1;
6566 IT_STRING_CHARPOS (*it
) = -1;
6567 IT_STRING_BYTEPOS (*it
) = -1;
6569 it
->method
= GET_FROM_BUFFER
;
6570 it
->object
= it
->w
->contents
;
6571 it
->area
= TEXT_AREA
;
6572 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6574 it
->string_from_display_prop_p
= false;
6575 it
->string_from_prefix_prop_p
= false;
6577 it
->from_disp_prop_p
= false;
6578 it
->face_before_selective_p
= false;
6581 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6583 bidi_unshelve_cache (NULL
, false);
6584 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6585 it
->bidi_it
.string
.s
= NULL
;
6586 it
->bidi_it
.string
.lstring
= Qnil
;
6587 it
->bidi_it
.string
.bufpos
= 0;
6588 it
->bidi_it
.string
.from_disp_str
= false;
6589 it
->bidi_it
.string
.unibyte
= false;
6590 it
->bidi_it
.w
= it
->w
;
6595 it
->stop_charpos
= CHARPOS (pos
);
6596 it
->base_level_stop
= CHARPOS (pos
);
6598 /* This make the information stored in it->cmp_it invalidate. */
6603 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6604 If S is non-null, it is a C string to iterate over. Otherwise,
6605 STRING gives a Lisp string to iterate over.
6607 If PRECISION > 0, don't return more then PRECISION number of
6608 characters from the string.
6610 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6611 characters have been returned. FIELD_WIDTH < 0 means an infinite
6614 MULTIBYTE = 0 means disable processing of multibyte characters,
6615 MULTIBYTE > 0 means enable it,
6616 MULTIBYTE < 0 means use IT->multibyte_p.
6618 IT must be initialized via a prior call to init_iterator before
6619 calling this function. */
6622 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6623 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6626 /* No text property checks performed by default, but see below. */
6627 it
->stop_charpos
= -1;
6629 /* Set iterator position and end position. */
6630 memset (&it
->current
, 0, sizeof it
->current
);
6631 it
->current
.overlay_string_index
= -1;
6632 it
->current
.dpvec_index
= -1;
6633 eassert (charpos
>= 0);
6635 /* If STRING is specified, use its multibyteness, otherwise use the
6636 setting of MULTIBYTE, if specified. */
6638 it
->multibyte_p
= multibyte
> 0;
6640 /* Bidirectional reordering of strings is controlled by the default
6641 value of bidi-display-reordering. Don't try to reorder while
6642 loading loadup.el, as the necessary character property tables are
6643 not yet available. */
6645 !redisplay__inhibit_bidi
6646 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6650 eassert (STRINGP (string
));
6651 it
->string
= string
;
6653 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6654 it
->method
= GET_FROM_STRING
;
6655 it
->current
.string_pos
= string_pos (charpos
, string
);
6659 it
->bidi_it
.string
.lstring
= string
;
6660 it
->bidi_it
.string
.s
= NULL
;
6661 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6662 it
->bidi_it
.string
.bufpos
= 0;
6663 it
->bidi_it
.string
.from_disp_str
= false;
6664 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6665 it
->bidi_it
.w
= it
->w
;
6666 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6667 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6672 it
->s
= (const unsigned char *) s
;
6675 /* Note that we use IT->current.pos, not it->current.string_pos,
6676 for displaying C strings. */
6677 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6678 if (it
->multibyte_p
)
6680 it
->current
.pos
= c_string_pos (charpos
, s
, true);
6681 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, true);
6685 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6686 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6691 it
->bidi_it
.string
.lstring
= Qnil
;
6692 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6693 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6694 it
->bidi_it
.string
.bufpos
= 0;
6695 it
->bidi_it
.string
.from_disp_str
= false;
6696 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6697 it
->bidi_it
.w
= it
->w
;
6698 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6701 it
->method
= GET_FROM_C_STRING
;
6704 /* PRECISION > 0 means don't return more than PRECISION characters
6706 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6708 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6710 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6713 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6714 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6715 FIELD_WIDTH < 0 means infinite field width. This is useful for
6716 padding with `-' at the end of a mode line. */
6717 if (field_width
< 0)
6718 field_width
= INFINITY
;
6719 /* Implementation note: We deliberately don't enlarge
6720 it->bidi_it.string.schars here to fit it->end_charpos, because
6721 the bidi iterator cannot produce characters out of thin air. */
6722 if (field_width
> it
->end_charpos
- charpos
)
6723 it
->end_charpos
= charpos
+ field_width
;
6725 /* Use the standard display table for displaying strings. */
6726 if (DISP_TABLE_P (Vstandard_display_table
))
6727 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6729 it
->stop_charpos
= charpos
;
6730 it
->prev_stop
= charpos
;
6731 it
->base_level_stop
= 0;
6734 it
->bidi_it
.first_elt
= true;
6735 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6736 it
->bidi_it
.disp_pos
= -1;
6738 if (s
== NULL
&& it
->multibyte_p
)
6740 ptrdiff_t endpos
= SCHARS (it
->string
);
6741 if (endpos
> it
->end_charpos
)
6742 endpos
= it
->end_charpos
;
6743 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6751 /***********************************************************************
6753 ***********************************************************************/
6755 /* Map enum it_method value to corresponding next_element_from_* function. */
6757 typedef bool (*next_element_function
) (struct it
*);
6759 static next_element_function
const get_next_element
[NUM_IT_METHODS
] =
6761 next_element_from_buffer
,
6762 next_element_from_display_vector
,
6763 next_element_from_string
,
6764 next_element_from_c_string
,
6765 next_element_from_image
,
6766 next_element_from_stretch
,
6767 next_element_from_xwidget
,
6770 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6773 /* Return true iff a character at CHARPOS (and BYTEPOS) is composed
6774 (possibly with the following characters). */
6776 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6777 ((IT)->cmp_it.id >= 0 \
6778 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6779 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6780 END_CHARPOS, (IT)->w, \
6781 FACE_OPT_FROM_ID ((IT)->f, (IT)->face_id), \
6785 /* Lookup the char-table Vglyphless_char_display for character C (-1
6786 if we want information for no-font case), and return the display
6787 method symbol. By side-effect, update it->what and
6788 it->glyphless_method. This function is called from
6789 get_next_display_element for each character element, and from
6790 x_produce_glyphs when no suitable font was found. */
6793 lookup_glyphless_char_display (int c
, struct it
*it
)
6795 Lisp_Object glyphless_method
= Qnil
;
6797 if (CHAR_TABLE_P (Vglyphless_char_display
)
6798 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6802 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6803 if (CONSP (glyphless_method
))
6804 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6805 ? XCAR (glyphless_method
)
6806 : XCDR (glyphless_method
);
6809 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6813 if (NILP (glyphless_method
))
6816 /* The default is to display the character by a proper font. */
6818 /* The default for the no-font case is to display an empty box. */
6819 glyphless_method
= Qempty_box
;
6821 if (EQ (glyphless_method
, Qzero_width
))
6824 return glyphless_method
;
6825 /* This method can't be used for the no-font case. */
6826 glyphless_method
= Qempty_box
;
6828 if (EQ (glyphless_method
, Qthin_space
))
6829 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6830 else if (EQ (glyphless_method
, Qempty_box
))
6831 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6832 else if (EQ (glyphless_method
, Qhex_code
))
6833 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6834 else if (STRINGP (glyphless_method
))
6835 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6838 /* Invalid value. We use the default method. */
6839 glyphless_method
= Qnil
;
6842 it
->what
= IT_GLYPHLESS
;
6843 return glyphless_method
;
6846 /* Merge escape glyph face and cache the result. */
6848 static struct frame
*last_escape_glyph_frame
= NULL
;
6849 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6850 static int last_escape_glyph_merged_face_id
= 0;
6853 merge_escape_glyph_face (struct it
*it
)
6857 if (it
->f
== last_escape_glyph_frame
6858 && it
->face_id
== last_escape_glyph_face_id
)
6859 face_id
= last_escape_glyph_merged_face_id
;
6862 /* Merge the `escape-glyph' face into the current face. */
6863 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6864 last_escape_glyph_frame
= it
->f
;
6865 last_escape_glyph_face_id
= it
->face_id
;
6866 last_escape_glyph_merged_face_id
= face_id
;
6871 /* Likewise for glyphless glyph face. */
6873 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6874 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6875 static int last_glyphless_glyph_merged_face_id
= 0;
6878 merge_glyphless_glyph_face (struct it
*it
)
6882 if (it
->f
== last_glyphless_glyph_frame
6883 && it
->face_id
== last_glyphless_glyph_face_id
)
6884 face_id
= last_glyphless_glyph_merged_face_id
;
6887 /* Merge the `glyphless-char' face into the current face. */
6888 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6889 last_glyphless_glyph_frame
= it
->f
;
6890 last_glyphless_glyph_face_id
= it
->face_id
;
6891 last_glyphless_glyph_merged_face_id
= face_id
;
6896 /* Forget the `escape-glyph' and `glyphless-char' faces. This should
6897 be called before redisplaying windows, and when the frame's face
6900 forget_escape_and_glyphless_faces (void)
6902 last_escape_glyph_frame
= NULL
;
6903 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6904 last_glyphless_glyph_frame
= NULL
;
6905 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6908 /* Load IT's display element fields with information about the next
6909 display element from the current position of IT. Value is false if
6910 end of buffer (or C string) is reached. */
6913 get_next_display_element (struct it
*it
)
6915 /* True means that we found a display element. False means that
6916 we hit the end of what we iterate over. Performance note: the
6917 function pointer `method' used here turns out to be faster than
6918 using a sequence of if-statements. */
6922 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6924 if (it
->what
== IT_CHARACTER
)
6926 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6927 and only if (a) the resolved directionality of that character
6929 /* FIXME: Do we need an exception for characters from display
6931 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
6932 && !inhibit_bidi_mirroring
)
6933 it
->c
= bidi_mirror_char (it
->c
);
6934 /* Map via display table or translate control characters.
6935 IT->c, IT->len etc. have been set to the next character by
6936 the function call above. If we have a display table, and it
6937 contains an entry for IT->c, translate it. Don't do this if
6938 IT->c itself comes from a display table, otherwise we could
6939 end up in an infinite recursion. (An alternative could be to
6940 count the recursion depth of this function and signal an
6941 error when a certain maximum depth is reached.) Is it worth
6943 if (success_p
&& it
->dpvec
== NULL
)
6946 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6947 bool nonascii_space_p
= false;
6948 bool nonascii_hyphen_p
= false;
6949 int c
= it
->c
; /* This is the character to display. */
6951 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6953 eassert (SINGLE_BYTE_CHAR_P (c
));
6954 if (unibyte_display_via_language_environment
)
6956 c
= DECODE_CHAR (unibyte
, c
);
6958 c
= BYTE8_TO_CHAR (it
->c
);
6961 c
= BYTE8_TO_CHAR (it
->c
);
6965 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6968 struct Lisp_Vector
*v
= XVECTOR (dv
);
6970 /* Return the first character from the display table
6971 entry, if not empty. If empty, don't display the
6972 current character. */
6975 it
->dpvec_char_len
= it
->len
;
6976 it
->dpvec
= v
->contents
;
6977 it
->dpend
= v
->contents
+ v
->header
.size
;
6978 it
->current
.dpvec_index
= 0;
6979 it
->dpvec_face_id
= -1;
6980 it
->saved_face_id
= it
->face_id
;
6981 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6982 it
->ellipsis_p
= false;
6986 set_iterator_to_next (it
, false);
6991 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6993 if (it
->what
== IT_GLYPHLESS
)
6995 /* Don't display this character. */
6996 set_iterator_to_next (it
, false);
7000 /* If `nobreak-char-display' is non-nil, we display
7001 non-ASCII spaces and hyphens specially. */
7002 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
7004 if (c
== NO_BREAK_SPACE
)
7005 nonascii_space_p
= true;
7006 else if (c
== SOFT_HYPHEN
|| c
== HYPHEN
7007 || c
== NON_BREAKING_HYPHEN
)
7008 nonascii_hyphen_p
= true;
7011 /* Translate control characters into `\003' or `^C' form.
7012 Control characters coming from a display table entry are
7013 currently not translated because we use IT->dpvec to hold
7014 the translation. This could easily be changed but I
7015 don't believe that it is worth doing.
7017 The characters handled by `nobreak-char-display' must be
7020 Non-printable characters and raw-byte characters are also
7021 translated to octal form. */
7022 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
7023 ? (it
->area
!= TEXT_AREA
7024 /* In mode line, treat \n, \t like other crl chars. */
7027 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
7028 || (c
!= '\n' && c
!= '\t'))
7030 || nonascii_hyphen_p
7032 || ! CHAR_PRINTABLE_P (c
))))
7034 /* C is a control character, non-ASCII space/hyphen,
7035 raw-byte, or a non-printable character which must be
7036 displayed either as '\003' or as `^C' where the '\\'
7037 and '^' can be defined in the display table. Fill
7038 IT->ctl_chars with glyphs for what we have to
7039 display. Then, set IT->dpvec to these glyphs. */
7046 /* Handle control characters with ^. */
7048 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
7052 g
= '^'; /* default glyph for Control */
7053 /* Set IT->ctl_chars[0] to the glyph for `^'. */
7055 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7057 g
= GLYPH_CODE_CHAR (gc
);
7058 lface_id
= GLYPH_CODE_FACE (gc
);
7062 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7063 : merge_escape_glyph_face (it
));
7065 XSETINT (it
->ctl_chars
[0], g
);
7066 XSETINT (it
->ctl_chars
[1], c
^ 0100);
7068 goto display_control
;
7071 /* Handle non-ascii space in the mode where it only gets
7074 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
7076 /* Merge `nobreak-space' into the current face. */
7077 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
7079 XSETINT (it
->ctl_chars
[0], ' ');
7081 goto display_control
;
7084 /* Handle non-ascii hyphens in the mode where it only
7085 gets highlighting. */
7087 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
7089 /* Merge `nobreak-space' into the current face. */
7090 face_id
= merge_faces (it
->f
, Qnobreak_hyphen
, 0,
7092 XSETINT (it
->ctl_chars
[0], '-');
7094 goto display_control
;
7097 /* Handle sequences that start with the "escape glyph". */
7099 /* the default escape glyph is \. */
7100 escape_glyph
= '\\';
7103 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7105 escape_glyph
= GLYPH_CODE_CHAR (gc
);
7106 lface_id
= GLYPH_CODE_FACE (gc
);
7110 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7111 : merge_escape_glyph_face (it
));
7113 /* Draw non-ASCII space/hyphen with escape glyph: */
7115 if (nonascii_space_p
|| nonascii_hyphen_p
)
7117 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7118 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7120 goto display_control
;
7127 if (CHAR_BYTE8_P (c
))
7128 /* Display \200 instead of \17777600. */
7129 c
= CHAR_TO_BYTE8 (c
);
7130 len
= sprintf (str
, "%03o", c
+ 0u);
7132 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7133 for (i
= 0; i
< len
; i
++)
7134 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7139 /* Set up IT->dpvec and return first character from it. */
7140 it
->dpvec_char_len
= it
->len
;
7141 it
->dpvec
= it
->ctl_chars
;
7142 it
->dpend
= it
->dpvec
+ ctl_len
;
7143 it
->current
.dpvec_index
= 0;
7144 it
->dpvec_face_id
= face_id
;
7145 it
->saved_face_id
= it
->face_id
;
7146 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7147 it
->ellipsis_p
= false;
7150 it
->char_to_display
= c
;
7154 it
->char_to_display
= it
->c
;
7158 #ifdef HAVE_WINDOW_SYSTEM
7159 /* Adjust face id for a multibyte character. There are no multibyte
7160 character in unibyte text. */
7161 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7164 && FRAME_WINDOW_P (it
->f
))
7166 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7168 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7170 /* Automatic composition with glyph-string. */
7171 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7173 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7177 ptrdiff_t pos
= (it
->s
? -1
7178 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7179 : IT_CHARPOS (*it
));
7182 if (it
->what
== IT_CHARACTER
)
7183 c
= it
->char_to_display
;
7186 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7190 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7191 /* TAB in a composition means display glyphs with
7192 padding space on the left or right. */
7193 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7196 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7199 #endif /* HAVE_WINDOW_SYSTEM */
7202 /* Is this character the last one of a run of characters with
7203 box? If yes, set IT->end_of_box_run_p to true. */
7207 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7209 int face_id
= underlying_face_id (it
);
7210 struct face
*face
= FACE_OPT_FROM_ID (it
->f
, face_id
);
7214 if (face
->box
== FACE_NO_BOX
)
7216 /* If the box comes from face properties in a
7217 display string, check faces in that string. */
7218 int string_face_id
= face_after_it_pos (it
);
7219 it
->end_of_box_run_p
7220 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7223 /* Otherwise, the box comes from the underlying face.
7224 If this is the last string character displayed, check
7225 the next buffer location. */
7226 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7227 /* n_overlay_strings is unreliable unless
7228 overlay_string_index is non-negative. */
7229 && ((it
->current
.overlay_string_index
>= 0
7230 && (it
->current
.overlay_string_index
7231 == it
->n_overlay_strings
- 1))
7232 /* A string from display property. */
7233 || it
->from_disp_prop_p
))
7237 bool text_from_string
= false;
7238 /* Normally, the next buffer location is stored in
7239 IT->current.pos... */
7240 struct text_pos pos
= it
->current
.pos
;
7242 /* ...but for a string from a display property, the
7243 next buffer position is stored in the 'position'
7244 member of the iteration stack slot below the
7245 current one, see handle_single_display_spec. By
7246 contrast, it->current.pos was not yet updated to
7247 point to that buffer position; that will happen
7248 in pop_it, after we finish displaying the current
7249 string. Note that we already checked above that
7250 it->sp is positive, so subtracting one from it is
7252 if (it
->from_disp_prop_p
)
7254 int stackp
= it
->sp
- 1;
7256 /* Find the stack level with data from buffer. */
7258 && STRINGP ((it
->stack
+ stackp
)->string
))
7262 /* If no stack slot was found for iterating
7263 a buffer, we are displaying text from a
7264 string, most probably the mode line or
7265 the header line, and that string has a
7266 display string on some of its
7268 text_from_string
= true;
7269 pos
= it
->stack
[it
->sp
- 1].position
;
7272 pos
= (it
->stack
+ stackp
)->position
;
7275 INC_TEXT_POS (pos
, it
->multibyte_p
);
7277 if (text_from_string
)
7279 Lisp_Object base_string
= it
->stack
[it
->sp
- 1].string
;
7281 if (CHARPOS (pos
) >= SCHARS (base_string
) - 1)
7282 it
->end_of_box_run_p
= true;
7286 = face_at_string_position (it
->w
, base_string
,
7288 &ignore
, face_id
, false);
7289 it
->end_of_box_run_p
7290 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7294 else if (CHARPOS (pos
) >= ZV
)
7295 it
->end_of_box_run_p
= true;
7299 face_at_buffer_position (it
->w
, CHARPOS (pos
), &ignore
,
7301 + TEXT_PROP_DISTANCE_LIMIT
,
7303 it
->end_of_box_run_p
7304 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7310 /* next_element_from_display_vector sets this flag according to
7311 faces of the display vector glyphs, see there. */
7312 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7314 int face_id
= face_after_it_pos (it
);
7315 it
->end_of_box_run_p
7316 = (face_id
!= it
->face_id
7317 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7320 /* If we reached the end of the object we've been iterating (e.g., a
7321 display string or an overlay string), and there's something on
7322 IT->stack, proceed with what's on the stack. It doesn't make
7323 sense to return false if there's unprocessed stuff on the stack,
7324 because otherwise that stuff will never be displayed. */
7325 if (!success_p
&& it
->sp
> 0)
7327 set_iterator_to_next (it
, false);
7328 success_p
= get_next_display_element (it
);
7331 /* Value is false if end of buffer or string reached. */
7336 /* Move IT to the next display element.
7338 RESEAT_P means if called on a newline in buffer text,
7339 skip to the next visible line start.
7341 Functions get_next_display_element and set_iterator_to_next are
7342 separate because I find this arrangement easier to handle than a
7343 get_next_display_element function that also increments IT's
7344 position. The way it is we can first look at an iterator's current
7345 display element, decide whether it fits on a line, and if it does,
7346 increment the iterator position. The other way around we probably
7347 would either need a flag indicating whether the iterator has to be
7348 incremented the next time, or we would have to implement a
7349 decrement position function which would not be easy to write. */
7352 set_iterator_to_next (struct it
*it
, bool reseat_p
)
7354 /* Reset flags indicating start and end of a sequence of characters
7355 with box. Reset them at the start of this function because
7356 moving the iterator to a new position might set them. */
7357 it
->start_of_box_run_p
= it
->end_of_box_run_p
= false;
7361 case GET_FROM_BUFFER
:
7362 /* The current display element of IT is a character from
7363 current_buffer. Advance in the buffer, and maybe skip over
7364 invisible lines that are so because of selective display. */
7365 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7366 reseat_at_next_visible_line_start (it
, false);
7367 else if (it
->cmp_it
.id
>= 0)
7369 /* We are currently getting glyphs from a composition. */
7372 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7373 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7379 /* Update IT's char/byte positions to point to the first
7380 character of the next grapheme cluster, or to the
7381 character visually after the current composition. */
7382 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7383 bidi_move_to_visually_next (&it
->bidi_it
);
7384 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7385 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7388 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7389 && it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7391 /* Composition created while scanning forward. Proceed
7392 to the next grapheme cluster. */
7393 it
->cmp_it
.from
= it
->cmp_it
.to
;
7395 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7396 && it
->cmp_it
.from
> 0)
7398 /* Composition created while scanning backward. Proceed
7399 to the previous grapheme cluster. */
7400 it
->cmp_it
.to
= it
->cmp_it
.from
;
7404 /* No more grapheme clusters in this composition.
7405 Find the next stop position. */
7406 ptrdiff_t stop
= it
->end_charpos
;
7408 if (it
->bidi_it
.scan_dir
< 0)
7409 /* Now we are scanning backward and don't know
7412 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7413 IT_BYTEPOS (*it
), stop
, Qnil
);
7418 eassert (it
->len
!= 0);
7422 IT_BYTEPOS (*it
) += it
->len
;
7423 IT_CHARPOS (*it
) += 1;
7427 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7428 /* If this is a new paragraph, determine its base
7429 direction (a.k.a. its base embedding level). */
7430 if (it
->bidi_it
.new_paragraph
)
7431 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
7433 bidi_move_to_visually_next (&it
->bidi_it
);
7434 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7435 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7436 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7438 /* As the scan direction was changed, we must
7439 re-compute the stop position for composition. */
7440 ptrdiff_t stop
= it
->end_charpos
;
7441 if (it
->bidi_it
.scan_dir
< 0)
7443 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7444 IT_BYTEPOS (*it
), stop
, Qnil
);
7447 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7451 case GET_FROM_C_STRING
:
7452 /* Current display element of IT is from a C string. */
7454 /* If the string position is beyond string's end, it means
7455 next_element_from_c_string is padding the string with
7456 blanks, in which case we bypass the bidi iterator,
7457 because it cannot deal with such virtual characters. */
7458 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7460 IT_BYTEPOS (*it
) += it
->len
;
7461 IT_CHARPOS (*it
) += 1;
7465 bidi_move_to_visually_next (&it
->bidi_it
);
7466 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7467 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7471 case GET_FROM_DISPLAY_VECTOR
:
7472 /* Current display element of IT is from a display table entry.
7473 Advance in the display table definition. Reset it to null if
7474 end reached, and continue with characters from buffers/
7476 ++it
->current
.dpvec_index
;
7478 /* Restore face of the iterator to what they were before the
7479 display vector entry (these entries may contain faces). */
7480 it
->face_id
= it
->saved_face_id
;
7482 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7484 bool recheck_faces
= it
->ellipsis_p
;
7487 it
->method
= GET_FROM_C_STRING
;
7488 else if (STRINGP (it
->string
))
7489 it
->method
= GET_FROM_STRING
;
7492 it
->method
= GET_FROM_BUFFER
;
7493 it
->object
= it
->w
->contents
;
7497 it
->current
.dpvec_index
= -1;
7499 /* Skip over characters which were displayed via IT->dpvec. */
7500 if (it
->dpvec_char_len
< 0)
7501 reseat_at_next_visible_line_start (it
, true);
7502 else if (it
->dpvec_char_len
> 0)
7504 it
->len
= it
->dpvec_char_len
;
7505 set_iterator_to_next (it
, reseat_p
);
7508 /* Maybe recheck faces after display vector. */
7511 if (it
->method
== GET_FROM_STRING
)
7512 it
->stop_charpos
= IT_STRING_CHARPOS (*it
);
7514 it
->stop_charpos
= IT_CHARPOS (*it
);
7519 case GET_FROM_STRING
:
7520 /* Current display element is a character from a Lisp string. */
7521 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7522 /* Don't advance past string end. These conditions are true
7523 when set_iterator_to_next is called at the end of
7524 get_next_display_element, in which case the Lisp string is
7525 already exhausted, and all we want is pop the iterator
7527 if (it
->current
.overlay_string_index
>= 0)
7529 /* This is an overlay string, so there's no padding with
7530 spaces, and the number of characters in the string is
7531 where the string ends. */
7532 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7533 goto consider_string_end
;
7537 /* Not an overlay string. There could be padding, so test
7538 against it->end_charpos. */
7539 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7540 goto consider_string_end
;
7542 if (it
->cmp_it
.id
>= 0)
7544 /* We are delivering display elements from a composition.
7545 Update the string position past the grapheme cluster
7546 we've just processed. */
7549 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7550 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7556 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7557 bidi_move_to_visually_next (&it
->bidi_it
);
7558 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7559 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7562 /* Did we exhaust all the grapheme clusters of this
7564 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7565 && (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
))
7567 /* Not all the grapheme clusters were processed yet;
7568 advance to the next cluster. */
7569 it
->cmp_it
.from
= it
->cmp_it
.to
;
7571 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7572 && it
->cmp_it
.from
> 0)
7574 /* Likewise: advance to the next cluster, but going in
7575 the reverse direction. */
7576 it
->cmp_it
.to
= it
->cmp_it
.from
;
7580 /* This composition was fully processed; find the next
7581 candidate place for checking for composed
7583 /* Always limit string searches to the string length;
7584 any padding spaces are not part of the string, and
7585 there cannot be any compositions in that padding. */
7586 ptrdiff_t stop
= SCHARS (it
->string
);
7588 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
7590 else if (it
->end_charpos
< stop
)
7592 /* Cf. PRECISION in reseat_to_string: we might be
7593 limited in how many of the string characters we
7595 stop
= it
->end_charpos
;
7597 composition_compute_stop_pos (&it
->cmp_it
,
7598 IT_STRING_CHARPOS (*it
),
7599 IT_STRING_BYTEPOS (*it
), stop
,
7606 /* If the string position is beyond string's end, it
7607 means next_element_from_string is padding the string
7608 with blanks, in which case we bypass the bidi
7609 iterator, because it cannot deal with such virtual
7611 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7613 IT_STRING_BYTEPOS (*it
) += it
->len
;
7614 IT_STRING_CHARPOS (*it
) += 1;
7618 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7620 bidi_move_to_visually_next (&it
->bidi_it
);
7621 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7622 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7623 /* If the scan direction changes, we may need to update
7624 the place where to check for composed characters. */
7625 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7627 ptrdiff_t stop
= SCHARS (it
->string
);
7629 if (it
->bidi_it
.scan_dir
< 0)
7631 else if (it
->end_charpos
< stop
)
7632 stop
= it
->end_charpos
;
7634 composition_compute_stop_pos (&it
->cmp_it
,
7635 IT_STRING_CHARPOS (*it
),
7636 IT_STRING_BYTEPOS (*it
), stop
,
7642 consider_string_end
:
7644 if (it
->current
.overlay_string_index
>= 0)
7646 /* IT->string is an overlay string. Advance to the
7647 next, if there is one. */
7648 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7650 it
->ellipsis_p
= false;
7651 next_overlay_string (it
);
7653 setup_for_ellipsis (it
, 0);
7658 /* IT->string is not an overlay string. If we reached
7659 its end, and there is something on IT->stack, proceed
7660 with what is on the stack. This can be either another
7661 string, this time an overlay string, or a buffer. */
7662 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7666 if (it
->method
== GET_FROM_STRING
)
7667 goto consider_string_end
;
7672 case GET_FROM_IMAGE
:
7673 case GET_FROM_STRETCH
:
7674 case GET_FROM_XWIDGET
:
7676 /* The position etc with which we have to proceed are on
7677 the stack. The position may be at the end of a string,
7678 if the `display' property takes up the whole string. */
7679 eassert (it
->sp
> 0);
7681 if (it
->method
== GET_FROM_STRING
)
7682 goto consider_string_end
;
7686 /* There are no other methods defined, so this should be a bug. */
7690 eassert (it
->method
!= GET_FROM_STRING
7691 || (STRINGP (it
->string
)
7692 && IT_STRING_CHARPOS (*it
) >= 0));
7695 /* Load IT's display element fields with information about the next
7696 display element which comes from a display table entry or from the
7697 result of translating a control character to one of the forms `^C'
7700 IT->dpvec holds the glyphs to return as characters.
7701 IT->saved_face_id holds the face id before the display vector--it
7702 is restored into IT->face_id in set_iterator_to_next. */
7705 next_element_from_display_vector (struct it
*it
)
7708 int prev_face_id
= it
->face_id
;
7712 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7714 it
->face_id
= it
->saved_face_id
;
7716 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7717 That seemed totally bogus - so I changed it... */
7718 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7720 if (GLYPH_CODE_P (gc
))
7722 struct face
*this_face
, *prev_face
, *next_face
;
7724 it
->c
= GLYPH_CODE_CHAR (gc
);
7725 it
->len
= CHAR_BYTES (it
->c
);
7727 /* The entry may contain a face id to use. Such a face id is
7728 the id of a Lisp face, not a realized face. A face id of
7729 zero means no face is specified. */
7730 if (it
->dpvec_face_id
>= 0)
7731 it
->face_id
= it
->dpvec_face_id
;
7734 int lface_id
= GLYPH_CODE_FACE (gc
);
7736 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7740 /* Glyphs in the display vector could have the box face, so we
7741 need to set the related flags in the iterator, as
7743 this_face
= FACE_OPT_FROM_ID (it
->f
, it
->face_id
);
7744 prev_face
= FACE_OPT_FROM_ID (it
->f
, prev_face_id
);
7746 /* Is this character the first character of a box-face run? */
7747 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7749 || prev_face
->box
== FACE_NO_BOX
));
7751 /* For the last character of the box-face run, we need to look
7752 either at the next glyph from the display vector, or at the
7753 face we saw before the display vector. */
7754 next_face_id
= it
->saved_face_id
;
7755 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7757 if (it
->dpvec_face_id
>= 0)
7758 next_face_id
= it
->dpvec_face_id
;
7762 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7765 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7769 next_face
= FACE_OPT_FROM_ID (it
->f
, next_face_id
);
7770 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7772 || next_face
->box
== FACE_NO_BOX
));
7773 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7776 /* Display table entry is invalid. Return a space. */
7777 it
->c
= ' ', it
->len
= 1;
7779 /* Don't change position and object of the iterator here. They are
7780 still the values of the character that had this display table
7781 entry or was translated, and that's what we want. */
7782 it
->what
= IT_CHARACTER
;
7786 /* Get the first element of string/buffer in the visual order, after
7787 being reseated to a new position in a string or a buffer. */
7789 get_visually_first_element (struct it
*it
)
7791 bool string_p
= STRINGP (it
->string
) || it
->s
;
7792 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7793 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7795 if (STRINGP (it
->string
))
7797 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7798 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7802 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7803 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7806 if (it
->bidi_it
.charpos
== eob
)
7808 /* Nothing to do, but reset the FIRST_ELT flag, like
7809 bidi_paragraph_init does, because we are not going to
7811 it
->bidi_it
.first_elt
= false;
7813 else if (it
->bidi_it
.charpos
== bob
7815 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7816 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7818 /* If we are at the beginning of a line/string, we can produce
7819 the next element right away. */
7820 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7821 bidi_move_to_visually_next (&it
->bidi_it
);
7825 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7827 /* We need to prime the bidi iterator starting at the line's or
7828 string's beginning, before we will be able to produce the
7831 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7833 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7834 IT_BYTEPOS (*it
), -1,
7835 &it
->bidi_it
.bytepos
);
7836 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7839 /* Now return to buffer/string position where we were asked
7840 to get the next display element, and produce that. */
7841 bidi_move_to_visually_next (&it
->bidi_it
);
7843 while (it
->bidi_it
.bytepos
!= orig_bytepos
7844 && it
->bidi_it
.charpos
< eob
);
7847 /* Adjust IT's position information to where we ended up. */
7848 if (STRINGP (it
->string
))
7850 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7851 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7855 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7856 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7859 if (STRINGP (it
->string
) || !it
->s
)
7861 ptrdiff_t stop
, charpos
, bytepos
;
7863 if (STRINGP (it
->string
))
7866 stop
= SCHARS (it
->string
);
7867 if (stop
> it
->end_charpos
)
7868 stop
= it
->end_charpos
;
7869 charpos
= IT_STRING_CHARPOS (*it
);
7870 bytepos
= IT_STRING_BYTEPOS (*it
);
7874 stop
= it
->end_charpos
;
7875 charpos
= IT_CHARPOS (*it
);
7876 bytepos
= IT_BYTEPOS (*it
);
7878 if (it
->bidi_it
.scan_dir
< 0)
7880 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7885 /* Load IT with the next display element from Lisp string IT->string.
7886 IT->current.string_pos is the current position within the string.
7887 If IT->current.overlay_string_index >= 0, the Lisp string is an
7891 next_element_from_string (struct it
*it
)
7893 struct text_pos position
;
7895 eassert (STRINGP (it
->string
));
7896 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7897 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7898 position
= it
->current
.string_pos
;
7900 /* With bidi reordering, the character to display might not be the
7901 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT means
7902 that we were reseat()ed to a new string, whose paragraph
7903 direction is not known. */
7904 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7906 get_visually_first_element (it
);
7907 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7910 /* Time to check for invisible text? */
7911 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7913 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7916 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7917 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7919 /* With bidi non-linear iteration, we could find
7920 ourselves far beyond the last computed stop_charpos,
7921 with several other stop positions in between that we
7922 missed. Scan them all now, in buffer's logical
7923 order, until we find and handle the last stop_charpos
7924 that precedes our current position. */
7925 handle_stop_backwards (it
, it
->stop_charpos
);
7926 return GET_NEXT_DISPLAY_ELEMENT (it
);
7932 /* Take note of the stop position we just moved
7933 across, for when we will move back across it. */
7934 it
->prev_stop
= it
->stop_charpos
;
7935 /* If we are at base paragraph embedding level, take
7936 note of the last stop position seen at this
7938 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7939 it
->base_level_stop
= it
->stop_charpos
;
7943 /* Since a handler may have changed IT->method, we must
7945 return GET_NEXT_DISPLAY_ELEMENT (it
);
7949 /* If we are before prev_stop, we may have overstepped
7950 on our way backwards a stop_pos, and if so, we need
7951 to handle that stop_pos. */
7952 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7953 /* We can sometimes back up for reasons that have nothing
7954 to do with bidi reordering. E.g., compositions. The
7955 code below is only needed when we are above the base
7956 embedding level, so test for that explicitly. */
7957 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7959 /* If we lost track of base_level_stop, we have no better
7960 place for handle_stop_backwards to start from than string
7961 beginning. This happens, e.g., when we were reseated to
7962 the previous screenful of text by vertical-motion. */
7963 if (it
->base_level_stop
<= 0
7964 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7965 it
->base_level_stop
= 0;
7966 handle_stop_backwards (it
, it
->base_level_stop
);
7967 return GET_NEXT_DISPLAY_ELEMENT (it
);
7971 if (it
->current
.overlay_string_index
>= 0)
7973 /* Get the next character from an overlay string. In overlay
7974 strings, there is no field width or padding with spaces to
7976 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7981 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7982 IT_STRING_BYTEPOS (*it
),
7983 it
->bidi_it
.scan_dir
< 0
7985 : SCHARS (it
->string
))
7986 && next_element_from_composition (it
))
7990 else if (STRING_MULTIBYTE (it
->string
))
7992 const unsigned char *s
= (SDATA (it
->string
)
7993 + IT_STRING_BYTEPOS (*it
));
7994 it
->c
= string_char_and_length (s
, &it
->len
);
7998 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
8004 /* Get the next character from a Lisp string that is not an
8005 overlay string. Such strings come from the mode line, for
8006 example. We may have to pad with spaces, or truncate the
8007 string. See also next_element_from_c_string. */
8008 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
8013 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
8015 /* Pad with spaces. */
8016 it
->c
= ' ', it
->len
= 1;
8017 CHARPOS (position
) = BYTEPOS (position
) = -1;
8019 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
8020 IT_STRING_BYTEPOS (*it
),
8021 it
->bidi_it
.scan_dir
< 0
8023 : it
->string_nchars
)
8024 && next_element_from_composition (it
))
8028 else if (STRING_MULTIBYTE (it
->string
))
8030 const unsigned char *s
= (SDATA (it
->string
)
8031 + IT_STRING_BYTEPOS (*it
));
8032 it
->c
= string_char_and_length (s
, &it
->len
);
8036 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
8041 /* Record what we have and where it came from. */
8042 it
->what
= IT_CHARACTER
;
8043 it
->object
= it
->string
;
8044 it
->position
= position
;
8049 /* Load IT with next display element from C string IT->s.
8050 IT->string_nchars is the maximum number of characters to return
8051 from the string. IT->end_charpos may be greater than
8052 IT->string_nchars when this function is called, in which case we
8053 may have to return padding spaces. Value is false if end of string
8054 reached, including padding spaces. */
8057 next_element_from_c_string (struct it
*it
)
8059 bool success_p
= true;
8062 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
8063 it
->what
= IT_CHARACTER
;
8064 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
8065 it
->object
= make_number (0);
8067 /* With bidi reordering, the character to display might not be the
8068 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
8069 we were reseated to a new string, whose paragraph direction is
8071 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8072 get_visually_first_element (it
);
8074 /* IT's position can be greater than IT->string_nchars in case a
8075 field width or precision has been specified when the iterator was
8077 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8079 /* End of the game. */
8083 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
8085 /* Pad with spaces. */
8086 it
->c
= ' ', it
->len
= 1;
8087 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
8089 else if (it
->multibyte_p
)
8090 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
8092 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
8098 /* Set up IT to return characters from an ellipsis, if appropriate.
8099 The definition of the ellipsis glyphs may come from a display table
8100 entry. This function fills IT with the first glyph from the
8101 ellipsis if an ellipsis is to be displayed. */
8104 next_element_from_ellipsis (struct it
*it
)
8106 if (it
->selective_display_ellipsis_p
)
8107 setup_for_ellipsis (it
, it
->len
);
8110 /* The face at the current position may be different from the
8111 face we find after the invisible text. Remember what it
8112 was in IT->saved_face_id, and signal that it's there by
8113 setting face_before_selective_p. */
8114 it
->saved_face_id
= it
->face_id
;
8115 it
->method
= GET_FROM_BUFFER
;
8116 it
->object
= it
->w
->contents
;
8117 reseat_at_next_visible_line_start (it
, true);
8118 it
->face_before_selective_p
= true;
8121 return GET_NEXT_DISPLAY_ELEMENT (it
);
8125 /* Deliver an image display element. The iterator IT is already
8126 filled with image information (done in handle_display_prop). Value
8131 next_element_from_image (struct it
*it
)
8133 it
->what
= IT_IMAGE
;
8138 next_element_from_xwidget (struct it
*it
)
8140 it
->what
= IT_XWIDGET
;
8145 /* Fill iterator IT with next display element from a stretch glyph
8146 property. IT->object is the value of the text property. Value is
8150 next_element_from_stretch (struct it
*it
)
8152 it
->what
= IT_STRETCH
;
8156 /* Scan backwards from IT's current position until we find a stop
8157 position, or until BEGV. This is called when we find ourself
8158 before both the last known prev_stop and base_level_stop while
8159 reordering bidirectional text. */
8162 compute_stop_pos_backwards (struct it
*it
)
8164 const int SCAN_BACK_LIMIT
= 1000;
8165 struct text_pos pos
;
8166 struct display_pos save_current
= it
->current
;
8167 struct text_pos save_position
= it
->position
;
8168 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8169 ptrdiff_t where_we_are
= charpos
;
8170 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8171 ptrdiff_t save_end_pos
= it
->end_charpos
;
8173 eassert (NILP (it
->string
) && !it
->s
);
8174 eassert (it
->bidi_p
);
8178 it
->end_charpos
= min (charpos
+ 1, ZV
);
8179 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8180 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8181 reseat_1 (it
, pos
, false);
8182 compute_stop_pos (it
);
8183 /* We must advance forward, right? */
8184 if (it
->stop_charpos
<= charpos
)
8187 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8189 if (it
->stop_charpos
<= where_we_are
)
8190 it
->prev_stop
= it
->stop_charpos
;
8192 it
->prev_stop
= BEGV
;
8194 it
->current
= save_current
;
8195 it
->position
= save_position
;
8196 it
->stop_charpos
= save_stop_pos
;
8197 it
->end_charpos
= save_end_pos
;
8200 /* Scan forward from CHARPOS in the current buffer/string, until we
8201 find a stop position > current IT's position. Then handle the stop
8202 position before that. This is called when we bump into a stop
8203 position while reordering bidirectional text. CHARPOS should be
8204 the last previously processed stop_pos (or BEGV/0, if none were
8205 processed yet) whose position is less that IT's current
8209 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8211 bool bufp
= !STRINGP (it
->string
);
8212 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8213 struct display_pos save_current
= it
->current
;
8214 struct text_pos save_position
= it
->position
;
8215 struct text_pos pos1
;
8216 ptrdiff_t next_stop
;
8218 /* Scan in strict logical order. */
8219 eassert (it
->bidi_p
);
8223 it
->prev_stop
= charpos
;
8226 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8227 reseat_1 (it
, pos1
, false);
8230 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8231 compute_stop_pos (it
);
8232 /* We must advance forward, right? */
8233 if (it
->stop_charpos
<= it
->prev_stop
)
8235 charpos
= it
->stop_charpos
;
8237 while (charpos
<= where_we_are
);
8240 it
->current
= save_current
;
8241 it
->position
= save_position
;
8242 next_stop
= it
->stop_charpos
;
8243 it
->stop_charpos
= it
->prev_stop
;
8245 it
->stop_charpos
= next_stop
;
8248 /* Load IT with the next display element from current_buffer. Value
8249 is false if end of buffer reached. IT->stop_charpos is the next
8250 position at which to stop and check for text properties or buffer
8254 next_element_from_buffer (struct it
*it
)
8256 bool success_p
= true;
8258 eassert (IT_CHARPOS (*it
) >= BEGV
);
8259 eassert (NILP (it
->string
) && !it
->s
);
8260 eassert (!it
->bidi_p
8261 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8262 && it
->bidi_it
.string
.s
== NULL
));
8264 /* With bidi reordering, the character to display might not be the
8265 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
8266 we were reseat()ed to a new buffer position, which is potentially
8267 a different paragraph. */
8268 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8270 get_visually_first_element (it
);
8271 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8274 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8276 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8278 bool overlay_strings_follow_p
;
8280 /* End of the game, except when overlay strings follow that
8281 haven't been returned yet. */
8282 if (it
->overlay_strings_at_end_processed_p
)
8283 overlay_strings_follow_p
= false;
8286 it
->overlay_strings_at_end_processed_p
= true;
8287 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8290 if (overlay_strings_follow_p
)
8291 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8295 it
->position
= it
->current
.pos
;
8299 else if (!(!it
->bidi_p
8300 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8301 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8303 /* With bidi non-linear iteration, we could find ourselves
8304 far beyond the last computed stop_charpos, with several
8305 other stop positions in between that we missed. Scan
8306 them all now, in buffer's logical order, until we find
8307 and handle the last stop_charpos that precedes our
8308 current position. */
8309 handle_stop_backwards (it
, it
->stop_charpos
);
8310 it
->ignore_overlay_strings_at_pos_p
= false;
8311 return GET_NEXT_DISPLAY_ELEMENT (it
);
8317 /* Take note of the stop position we just moved across,
8318 for when we will move back across it. */
8319 it
->prev_stop
= it
->stop_charpos
;
8320 /* If we are at base paragraph embedding level, take
8321 note of the last stop position seen at this
8323 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8324 it
->base_level_stop
= it
->stop_charpos
;
8327 it
->ignore_overlay_strings_at_pos_p
= false;
8328 return GET_NEXT_DISPLAY_ELEMENT (it
);
8332 /* If we are before prev_stop, we may have overstepped on
8333 our way backwards a stop_pos, and if so, we need to
8334 handle that stop_pos. */
8335 && IT_CHARPOS (*it
) < it
->prev_stop
8336 /* We can sometimes back up for reasons that have nothing
8337 to do with bidi reordering. E.g., compositions. The
8338 code below is only needed when we are above the base
8339 embedding level, so test for that explicitly. */
8340 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8342 if (it
->base_level_stop
<= 0
8343 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8345 /* If we lost track of base_level_stop, we need to find
8346 prev_stop by looking backwards. This happens, e.g., when
8347 we were reseated to the previous screenful of text by
8349 it
->base_level_stop
= BEGV
;
8350 compute_stop_pos_backwards (it
);
8351 handle_stop_backwards (it
, it
->prev_stop
);
8354 handle_stop_backwards (it
, it
->base_level_stop
);
8355 it
->ignore_overlay_strings_at_pos_p
= false;
8356 return GET_NEXT_DISPLAY_ELEMENT (it
);
8360 /* No face changes, overlays etc. in sight, so just return a
8361 character from current_buffer. */
8365 /* We moved to the next buffer position, so any info about
8366 previously seen overlays is no longer valid. */
8367 it
->ignore_overlay_strings_at_pos_p
= false;
8369 /* Maybe run the redisplay end trigger hook. Performance note:
8370 This doesn't seem to cost measurable time. */
8371 if (it
->redisplay_end_trigger_charpos
8373 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8374 run_redisplay_end_trigger_hook (it
);
8376 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8377 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8379 && next_element_from_composition (it
))
8384 /* Get the next character, maybe multibyte. */
8385 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8386 if (it
->multibyte_p
&& !ASCII_CHAR_P (*p
))
8387 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8389 it
->c
= *p
, it
->len
= 1;
8391 /* Record what we have and where it came from. */
8392 it
->what
= IT_CHARACTER
;
8393 it
->object
= it
->w
->contents
;
8394 it
->position
= it
->current
.pos
;
8396 /* Normally we return the character found above, except when we
8397 really want to return an ellipsis for selective display. */
8402 /* A value of selective > 0 means hide lines indented more
8403 than that number of columns. */
8404 if (it
->selective
> 0
8405 && IT_CHARPOS (*it
) + 1 < ZV
8406 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8407 IT_BYTEPOS (*it
) + 1,
8410 success_p
= next_element_from_ellipsis (it
);
8411 it
->dpvec_char_len
= -1;
8414 else if (it
->c
== '\r' && it
->selective
== -1)
8416 /* A value of selective == -1 means that everything from the
8417 CR to the end of the line is invisible, with maybe an
8418 ellipsis displayed for it. */
8419 success_p
= next_element_from_ellipsis (it
);
8420 it
->dpvec_char_len
= -1;
8425 /* Value is false if end of buffer reached. */
8426 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8431 /* Run the redisplay end trigger hook for IT. */
8434 run_redisplay_end_trigger_hook (struct it
*it
)
8436 /* IT->glyph_row should be non-null, i.e. we should be actually
8437 displaying something, or otherwise we should not run the hook. */
8438 eassert (it
->glyph_row
);
8440 ptrdiff_t charpos
= it
->redisplay_end_trigger_charpos
;
8441 it
->redisplay_end_trigger_charpos
= 0;
8443 /* Since we are *trying* to run these functions, don't try to run
8444 them again, even if they get an error. */
8445 wset_redisplay_end_trigger (it
->w
, Qnil
);
8446 CALLN (Frun_hook_with_args
, Qredisplay_end_trigger_functions
, it
->window
,
8447 make_number (charpos
));
8449 /* Notice if it changed the face of the character we are on. */
8450 handle_face_prop (it
);
8454 /* Deliver a composition display element. Unlike the other
8455 next_element_from_XXX, this function is not registered in the array
8456 get_next_element[]. It is called from next_element_from_buffer and
8457 next_element_from_string when necessary. */
8460 next_element_from_composition (struct it
*it
)
8462 it
->what
= IT_COMPOSITION
;
8463 it
->len
= it
->cmp_it
.nbytes
;
8464 if (STRINGP (it
->string
))
8468 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8469 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8472 it
->position
= it
->current
.string_pos
;
8473 it
->object
= it
->string
;
8474 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8475 IT_STRING_BYTEPOS (*it
), it
->string
);
8481 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8482 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8485 if (it
->bidi_it
.new_paragraph
)
8486 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
8488 /* Resync the bidi iterator with IT's new position.
8489 FIXME: this doesn't support bidirectional text. */
8490 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8491 bidi_move_to_visually_next (&it
->bidi_it
);
8495 it
->position
= it
->current
.pos
;
8496 it
->object
= it
->w
->contents
;
8497 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8498 IT_BYTEPOS (*it
), Qnil
);
8505 /***********************************************************************
8506 Moving an iterator without producing glyphs
8507 ***********************************************************************/
8509 /* Check if iterator is at a position corresponding to a valid buffer
8510 position after some move_it_ call. */
8512 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8513 ((it)->method != GET_FROM_STRING || IT_STRING_CHARPOS (*it) == 0)
8516 /* Move iterator IT to a specified buffer or X position within one
8517 line on the display without producing glyphs.
8519 OP should be a bit mask including some or all of these bits:
8520 MOVE_TO_X: Stop upon reaching x-position TO_X.
8521 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8522 Regardless of OP's value, stop upon reaching the end of the display line.
8524 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8525 This means, in particular, that TO_X includes window's horizontal
8528 The return value has several possible values that
8529 say what condition caused the scan to stop:
8531 MOVE_POS_MATCH_OR_ZV
8532 - when TO_POS or ZV was reached.
8535 -when TO_X was reached before TO_POS or ZV were reached.
8538 - when we reached the end of the display area and the line must
8542 - when we reached the end of the display area and the line is
8546 - when we stopped at a line end, i.e. a newline or a CR and selective
8549 static enum move_it_result
8550 move_it_in_display_line_to (struct it
*it
,
8551 ptrdiff_t to_charpos
, int to_x
,
8552 enum move_operation_enum op
)
8554 enum move_it_result result
= MOVE_UNDEFINED
;
8555 struct glyph_row
*saved_glyph_row
;
8556 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8557 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8558 void *ppos_data
= NULL
;
8559 bool may_wrap
= false;
8560 enum it_method prev_method
= it
->method
;
8561 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8562 bool saw_smaller_pos
= prev_pos
< to_charpos
;
8564 /* Don't produce glyphs in produce_glyphs. */
8565 saved_glyph_row
= it
->glyph_row
;
8566 it
->glyph_row
= NULL
;
8568 /* Use wrap_it to save a copy of IT wherever a word wrap could
8569 occur. Use atpos_it to save a copy of IT at the desired buffer
8570 position, if found, so that we can scan ahead and check if the
8571 word later overshoots the window edge. Use atx_it similarly, for
8577 /* Use ppos_it under bidi reordering to save a copy of IT for the
8578 initial position. We restore that position in IT when we have
8579 scanned the entire display line without finding a match for
8580 TO_CHARPOS and all the character positions are greater than
8581 TO_CHARPOS. We then restart the scan from the initial position,
8582 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8583 the closest to TO_CHARPOS. */
8586 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8588 SAVE_IT (ppos_it
, *it
, ppos_data
);
8589 closest_pos
= IT_CHARPOS (*it
);
8595 #define BUFFER_POS_REACHED_P() \
8596 ((op & MOVE_TO_POS) != 0 \
8597 && BUFFERP (it->object) \
8598 && (IT_CHARPOS (*it) == to_charpos \
8600 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8601 && IT_CHARPOS (*it) > to_charpos) \
8602 || (it->what == IT_COMPOSITION \
8603 && ((IT_CHARPOS (*it) > to_charpos \
8604 && to_charpos >= it->cmp_it.charpos) \
8605 || (IT_CHARPOS (*it) < to_charpos \
8606 && to_charpos <= it->cmp_it.charpos)))) \
8607 && (it->method == GET_FROM_BUFFER \
8608 || (it->method == GET_FROM_DISPLAY_VECTOR \
8609 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8611 /* If there's a line-/wrap-prefix, handle it. */
8612 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8613 && it
->current_y
< it
->last_visible_y
)
8614 handle_line_prefix (it
);
8616 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8617 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8621 int x
, i
, ascent
= 0, descent
= 0;
8623 /* Utility macro to reset an iterator with x, ascent, and descent. */
8624 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8625 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8626 (IT)->max_descent = descent)
8628 /* Stop if we move beyond TO_CHARPOS (after an image or a
8629 display string or stretch glyph). */
8630 if ((op
& MOVE_TO_POS
) != 0
8631 && BUFFERP (it
->object
)
8632 && it
->method
== GET_FROM_BUFFER
8634 /* When the iterator is at base embedding level, we
8635 are guaranteed that characters are delivered for
8636 display in strictly increasing order of their
8637 buffer positions. */
8638 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8639 && IT_CHARPOS (*it
) > to_charpos
)
8641 && (prev_method
== GET_FROM_IMAGE
8642 || prev_method
== GET_FROM_STRETCH
8643 || prev_method
== GET_FROM_STRING
)
8644 /* Passed TO_CHARPOS from left to right. */
8645 && ((prev_pos
< to_charpos
8646 && IT_CHARPOS (*it
) > to_charpos
)
8647 /* Passed TO_CHARPOS from right to left. */
8648 || (prev_pos
> to_charpos
8649 && IT_CHARPOS (*it
) < to_charpos
)))))
8651 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8653 result
= MOVE_POS_MATCH_OR_ZV
;
8656 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8657 /* If wrap_it is valid, the current position might be in a
8658 word that is wrapped. So, save the iterator in
8659 atpos_it and continue to see if wrapping happens. */
8660 SAVE_IT (atpos_it
, *it
, atpos_data
);
8663 /* Stop when ZV reached.
8664 We used to stop here when TO_CHARPOS reached as well, but that is
8665 too soon if this glyph does not fit on this line. So we handle it
8666 explicitly below. */
8667 if (!get_next_display_element (it
))
8669 result
= MOVE_POS_MATCH_OR_ZV
;
8673 if (it
->line_wrap
== TRUNCATE
)
8675 if (BUFFER_POS_REACHED_P ())
8677 result
= MOVE_POS_MATCH_OR_ZV
;
8683 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8685 if (IT_DISPLAYING_WHITESPACE (it
))
8689 /* We have reached a glyph that follows one or more
8690 whitespace characters. If the position is
8691 already found, we are done. */
8692 if (atpos_it
.sp
>= 0)
8694 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8695 result
= MOVE_POS_MATCH_OR_ZV
;
8700 RESTORE_IT (it
, &atx_it
, atx_data
);
8701 result
= MOVE_X_REACHED
;
8704 /* Otherwise, we can wrap here. */
8705 SAVE_IT (wrap_it
, *it
, wrap_data
);
8711 /* Remember the line height for the current line, in case
8712 the next element doesn't fit on the line. */
8713 ascent
= it
->max_ascent
;
8714 descent
= it
->max_descent
;
8716 /* The call to produce_glyphs will get the metrics of the
8717 display element IT is loaded with. Record the x-position
8718 before this display element, in case it doesn't fit on the
8722 PRODUCE_GLYPHS (it
);
8724 if (it
->area
!= TEXT_AREA
)
8726 prev_method
= it
->method
;
8727 if (it
->method
== GET_FROM_BUFFER
)
8728 prev_pos
= IT_CHARPOS (*it
);
8729 set_iterator_to_next (it
, true);
8730 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8731 SET_TEXT_POS (this_line_min_pos
,
8732 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8734 && (op
& MOVE_TO_POS
)
8735 && IT_CHARPOS (*it
) > to_charpos
8736 && IT_CHARPOS (*it
) < closest_pos
)
8737 closest_pos
= IT_CHARPOS (*it
);
8741 /* The number of glyphs we get back in IT->nglyphs will normally
8742 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8743 character on a terminal frame, or (iii) a line end. For the
8744 second case, IT->nglyphs - 1 padding glyphs will be present.
8745 (On X frames, there is only one glyph produced for a
8746 composite character.)
8748 The behavior implemented below means, for continuation lines,
8749 that as many spaces of a TAB as fit on the current line are
8750 displayed there. For terminal frames, as many glyphs of a
8751 multi-glyph character are displayed in the current line, too.
8752 This is what the old redisplay code did, and we keep it that
8753 way. Under X, the whole shape of a complex character must
8754 fit on the line or it will be completely displayed in the
8757 Note that both for tabs and padding glyphs, all glyphs have
8761 /* More than one glyph or glyph doesn't fit on line. All
8762 glyphs have the same width. */
8763 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8765 int x_before_this_char
= x
;
8766 int hpos_before_this_char
= it
->hpos
;
8768 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8770 new_x
= x
+ single_glyph_width
;
8772 /* We want to leave anything reaching TO_X to the caller. */
8773 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8775 if (BUFFER_POS_REACHED_P ())
8777 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8778 goto buffer_pos_reached
;
8779 if (atpos_it
.sp
< 0)
8781 SAVE_IT (atpos_it
, *it
, atpos_data
);
8782 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8787 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8790 result
= MOVE_X_REACHED
;
8795 SAVE_IT (atx_it
, *it
, atx_data
);
8796 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8801 if (/* Lines are continued. */
8802 it
->line_wrap
!= TRUNCATE
8803 && (/* And glyph doesn't fit on the line. */
8804 new_x
> it
->last_visible_x
8805 /* Or it fits exactly and we're on a window
8807 || (new_x
== it
->last_visible_x
8808 && FRAME_WINDOW_P (it
->f
)
8809 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8810 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8811 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8813 if (/* IT->hpos == 0 means the very first glyph
8814 doesn't fit on the line, e.g. a wide image. */
8816 || (new_x
== it
->last_visible_x
8817 && FRAME_WINDOW_P (it
->f
)))
8820 it
->current_x
= new_x
;
8822 /* The character's last glyph just barely fits
8824 if (i
== it
->nglyphs
- 1)
8826 /* If this is the destination position,
8827 return a position *before* it in this row,
8828 now that we know it fits in this row. */
8829 if (BUFFER_POS_REACHED_P ())
8831 if (it
->line_wrap
!= WORD_WRAP
8833 /* If we've just found whitespace to
8834 wrap, effectively ignore the
8835 previous wrap point -- it is no
8836 longer relevant, but we won't
8837 have an opportunity to update it,
8838 since we've reached the edge of
8839 this screen line. */
8841 && IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8843 it
->hpos
= hpos_before_this_char
;
8844 it
->current_x
= x_before_this_char
;
8845 result
= MOVE_POS_MATCH_OR_ZV
;
8848 if (it
->line_wrap
== WORD_WRAP
8851 SAVE_IT (atpos_it
, *it
, atpos_data
);
8852 atpos_it
.current_x
= x_before_this_char
;
8853 atpos_it
.hpos
= hpos_before_this_char
;
8857 prev_method
= it
->method
;
8858 if (it
->method
== GET_FROM_BUFFER
)
8859 prev_pos
= IT_CHARPOS (*it
);
8860 set_iterator_to_next (it
, true);
8861 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8862 SET_TEXT_POS (this_line_min_pos
,
8863 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8864 /* On graphical terminals, newlines may
8865 "overflow" into the fringe if
8866 overflow-newline-into-fringe is non-nil.
8867 On text terminals, and on graphical
8868 terminals with no right margin, newlines
8869 may overflow into the last glyph on the
8871 if (!FRAME_WINDOW_P (it
->f
)
8873 && it
->bidi_it
.paragraph_dir
== R2L
)
8874 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8875 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8876 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8878 if (!get_next_display_element (it
))
8880 result
= MOVE_POS_MATCH_OR_ZV
;
8883 if (BUFFER_POS_REACHED_P ())
8885 if (ITERATOR_AT_END_OF_LINE_P (it
))
8886 result
= MOVE_POS_MATCH_OR_ZV
;
8888 result
= MOVE_LINE_CONTINUED
;
8891 if (ITERATOR_AT_END_OF_LINE_P (it
)
8892 && (it
->line_wrap
!= WORD_WRAP
8894 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8896 result
= MOVE_NEWLINE_OR_CR
;
8903 IT_RESET_X_ASCENT_DESCENT (it
);
8905 /* If the screen line ends with whitespace, and we
8906 are under word-wrap, don't use wrap_it: it is no
8907 longer relevant, but we won't have an opportunity
8908 to update it, since we are done with this screen
8910 if (may_wrap
&& IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8912 /* If we've found TO_X, go back there, as we now
8913 know the last word fits on this screen line. */
8914 if ((op
& MOVE_TO_X
) && new_x
== it
->last_visible_x
8917 RESTORE_IT (it
, &atx_it
, atx_data
);
8920 result
= MOVE_X_REACHED
;
8924 else if (wrap_it
.sp
>= 0)
8926 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8931 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8933 result
= MOVE_LINE_CONTINUED
;
8937 if (BUFFER_POS_REACHED_P ())
8939 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8940 goto buffer_pos_reached
;
8941 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8943 SAVE_IT (atpos_it
, *it
, atpos_data
);
8944 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8948 if (new_x
> it
->first_visible_x
)
8950 /* Glyph is visible. Increment number of glyphs that
8951 would be displayed. */
8956 if (result
!= MOVE_UNDEFINED
)
8959 else if (BUFFER_POS_REACHED_P ())
8962 IT_RESET_X_ASCENT_DESCENT (it
);
8963 result
= MOVE_POS_MATCH_OR_ZV
;
8966 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8968 /* Stop when TO_X specified and reached. This check is
8969 necessary here because of lines consisting of a line end,
8970 only. The line end will not produce any glyphs and we
8971 would never get MOVE_X_REACHED. */
8972 eassert (it
->nglyphs
== 0);
8973 result
= MOVE_X_REACHED
;
8977 /* Is this a line end? If yes, we're done. */
8978 if (ITERATOR_AT_END_OF_LINE_P (it
))
8980 /* If we are past TO_CHARPOS, but never saw any character
8981 positions smaller than TO_CHARPOS, return
8982 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8984 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8986 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8988 if (closest_pos
< ZV
)
8990 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8991 /* Don't recurse if closest_pos is equal to
8992 to_charpos, since we have just tried that. */
8993 if (closest_pos
!= to_charpos
)
8994 move_it_in_display_line_to (it
, closest_pos
, -1,
8996 result
= MOVE_POS_MATCH_OR_ZV
;
8999 goto buffer_pos_reached
;
9001 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
9002 && IT_CHARPOS (*it
) > to_charpos
)
9003 goto buffer_pos_reached
;
9005 result
= MOVE_NEWLINE_OR_CR
;
9008 result
= MOVE_NEWLINE_OR_CR
;
9012 prev_method
= it
->method
;
9013 if (it
->method
== GET_FROM_BUFFER
)
9014 prev_pos
= IT_CHARPOS (*it
);
9015 /* The current display element has been consumed. Advance
9017 set_iterator_to_next (it
, true);
9018 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
9019 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
9020 if (IT_CHARPOS (*it
) < to_charpos
)
9021 saw_smaller_pos
= true;
9023 && (op
& MOVE_TO_POS
)
9024 && IT_CHARPOS (*it
) >= to_charpos
9025 && IT_CHARPOS (*it
) < closest_pos
)
9026 closest_pos
= IT_CHARPOS (*it
);
9028 /* Stop if lines are truncated and IT's current x-position is
9029 past the right edge of the window now. */
9030 if (it
->line_wrap
== TRUNCATE
9031 && it
->current_x
>= it
->last_visible_x
)
9033 if (!FRAME_WINDOW_P (it
->f
)
9034 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
9035 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
9036 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
9037 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
9039 bool at_eob_p
= false;
9041 if ((at_eob_p
= !get_next_display_element (it
))
9042 || BUFFER_POS_REACHED_P ()
9043 /* If we are past TO_CHARPOS, but never saw any
9044 character positions smaller than TO_CHARPOS,
9045 return MOVE_POS_MATCH_OR_ZV, like the
9046 unidirectional display did. */
9047 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
9049 && IT_CHARPOS (*it
) > to_charpos
))
9052 && !BUFFER_POS_REACHED_P ()
9053 && !at_eob_p
&& closest_pos
< ZV
)
9055 RESTORE_IT (it
, &ppos_it
, ppos_data
);
9056 if (closest_pos
!= to_charpos
)
9057 move_it_in_display_line_to (it
, closest_pos
, -1,
9060 result
= MOVE_POS_MATCH_OR_ZV
;
9063 if (ITERATOR_AT_END_OF_LINE_P (it
))
9065 result
= MOVE_NEWLINE_OR_CR
;
9069 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
9071 && IT_CHARPOS (*it
) > to_charpos
)
9073 if (closest_pos
< ZV
)
9075 RESTORE_IT (it
, &ppos_it
, ppos_data
);
9076 if (closest_pos
!= to_charpos
)
9077 move_it_in_display_line_to (it
, closest_pos
, -1,
9080 result
= MOVE_POS_MATCH_OR_ZV
;
9083 result
= MOVE_LINE_TRUNCATED
;
9086 #undef IT_RESET_X_ASCENT_DESCENT
9089 #undef BUFFER_POS_REACHED_P
9091 /* If we scanned beyond to_pos and didn't find a point to wrap at,
9092 restore the saved iterator. */
9093 if (atpos_it
.sp
>= 0)
9094 RESTORE_IT (it
, &atpos_it
, atpos_data
);
9095 else if (atx_it
.sp
>= 0)
9096 RESTORE_IT (it
, &atx_it
, atx_data
);
9101 bidi_unshelve_cache (atpos_data
, true);
9103 bidi_unshelve_cache (atx_data
, true);
9105 bidi_unshelve_cache (wrap_data
, true);
9107 bidi_unshelve_cache (ppos_data
, true);
9109 /* Restore the iterator settings altered at the beginning of this
9111 it
->glyph_row
= saved_glyph_row
;
9115 /* For external use. */
9117 move_it_in_display_line (struct it
*it
,
9118 ptrdiff_t to_charpos
, int to_x
,
9119 enum move_operation_enum op
)
9121 if (it
->line_wrap
== WORD_WRAP
9122 && (op
& MOVE_TO_X
))
9125 void *save_data
= NULL
;
9128 SAVE_IT (save_it
, *it
, save_data
);
9129 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9130 /* When word-wrap is on, TO_X may lie past the end
9131 of a wrapped line. Then it->current is the
9132 character on the next line, so backtrack to the
9133 space before the wrap point. */
9134 if (skip
== MOVE_LINE_CONTINUED
)
9136 int prev_x
= max (it
->current_x
- 1, 0);
9137 RESTORE_IT (it
, &save_it
, save_data
);
9138 move_it_in_display_line_to
9139 (it
, -1, prev_x
, MOVE_TO_X
);
9142 bidi_unshelve_cache (save_data
, true);
9145 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9149 /* Move IT forward until it satisfies one or more of the criteria in
9150 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9152 OP is a bit-mask that specifies where to stop, and in particular,
9153 which of those four position arguments makes a difference. See the
9154 description of enum move_operation_enum.
9156 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9157 screen line, this function will set IT to the next position that is
9158 displayed to the right of TO_CHARPOS on the screen.
9160 Return the maximum pixel length of any line scanned but never more
9161 than it.last_visible_x. */
9164 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9166 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9167 int line_height
, line_start_x
= 0, reached
= 0;
9168 int max_current_x
= 0;
9169 void *backup_data
= NULL
;
9173 if (op
& MOVE_TO_VPOS
)
9175 /* If no TO_CHARPOS and no TO_X specified, stop at the
9176 start of the line TO_VPOS. */
9177 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9179 if (it
->vpos
== to_vpos
)
9185 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9189 /* TO_VPOS >= 0 means stop at TO_X in the line at
9190 TO_VPOS, or at TO_POS, whichever comes first. */
9191 if (it
->vpos
== to_vpos
)
9197 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9199 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9204 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9206 /* We have reached TO_X but not in the line we want. */
9207 skip
= move_it_in_display_line_to (it
, to_charpos
,
9209 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9217 else if (op
& MOVE_TO_Y
)
9219 struct it it_backup
;
9221 if (it
->line_wrap
== WORD_WRAP
)
9222 SAVE_IT (it_backup
, *it
, backup_data
);
9224 /* TO_Y specified means stop at TO_X in the line containing
9225 TO_Y---or at TO_CHARPOS if this is reached first. The
9226 problem is that we can't really tell whether the line
9227 contains TO_Y before we have completely scanned it, and
9228 this may skip past TO_X. What we do is to first scan to
9231 If TO_X is not specified, use a TO_X of zero. The reason
9232 is to make the outcome of this function more predictable.
9233 If we didn't use TO_X == 0, we would stop at the end of
9234 the line which is probably not what a caller would expect
9236 skip
= move_it_in_display_line_to
9237 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9238 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9240 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9241 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9243 else if (skip
== MOVE_X_REACHED
)
9245 /* If TO_X was reached, we want to know whether TO_Y is
9246 in the line. We know this is the case if the already
9247 scanned glyphs make the line tall enough. Otherwise,
9248 we must check by scanning the rest of the line. */
9249 line_height
= it
->max_ascent
+ it
->max_descent
;
9250 if (to_y
>= it
->current_y
9251 && to_y
< it
->current_y
+ line_height
)
9256 SAVE_IT (it_backup
, *it
, backup_data
);
9257 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9258 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9260 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9261 line_height
= it
->max_ascent
+ it
->max_descent
;
9262 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9264 if (to_y
>= it
->current_y
9265 && to_y
< it
->current_y
+ line_height
)
9267 /* If TO_Y is in this line and TO_X was reached
9268 above, we scanned too far. We have to restore
9269 IT's settings to the ones before skipping. But
9270 keep the more accurate values of max_ascent and
9271 max_descent we've found while skipping the rest
9272 of the line, for the sake of callers, such as
9273 pos_visible_p, that need to know the line
9275 int max_ascent
= it
->max_ascent
;
9276 int max_descent
= it
->max_descent
;
9278 RESTORE_IT (it
, &it_backup
, backup_data
);
9279 it
->max_ascent
= max_ascent
;
9280 it
->max_descent
= max_descent
;
9286 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9292 /* Check whether TO_Y is in this line. */
9293 line_height
= it
->max_ascent
+ it
->max_descent
;
9294 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9296 if (to_y
>= it
->current_y
9297 && to_y
< it
->current_y
+ line_height
)
9299 if (to_y
> it
->current_y
)
9300 max_current_x
= max (it
->current_x
, max_current_x
);
9302 /* When word-wrap is on, TO_X may lie past the end
9303 of a wrapped line. Then it->current is the
9304 character on the next line, so backtrack to the
9305 space before the wrap point. */
9306 if (skip
== MOVE_LINE_CONTINUED
9307 && it
->line_wrap
== WORD_WRAP
)
9309 int prev_x
= max (it
->current_x
- 1, 0);
9310 RESTORE_IT (it
, &it_backup
, backup_data
);
9311 skip
= move_it_in_display_line_to
9312 (it
, -1, prev_x
, MOVE_TO_X
);
9321 max_current_x
= max (it
->current_x
, max_current_x
);
9325 else if (BUFFERP (it
->object
)
9326 && (it
->method
== GET_FROM_BUFFER
9327 || it
->method
== GET_FROM_STRETCH
)
9328 && IT_CHARPOS (*it
) >= to_charpos
9329 /* Under bidi iteration, a call to set_iterator_to_next
9330 can scan far beyond to_charpos if the initial
9331 portion of the next line needs to be reordered. In
9332 that case, give move_it_in_display_line_to another
9335 && it
->bidi_it
.scan_dir
== -1))
9336 skip
= MOVE_POS_MATCH_OR_ZV
;
9338 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9342 case MOVE_POS_MATCH_OR_ZV
:
9343 max_current_x
= max (it
->current_x
, max_current_x
);
9347 case MOVE_NEWLINE_OR_CR
:
9348 max_current_x
= max (it
->current_x
, max_current_x
);
9349 set_iterator_to_next (it
, true);
9350 it
->continuation_lines_width
= 0;
9353 case MOVE_LINE_TRUNCATED
:
9354 max_current_x
= it
->last_visible_x
;
9355 it
->continuation_lines_width
= 0;
9356 reseat_at_next_visible_line_start (it
, false);
9357 if ((op
& MOVE_TO_POS
) != 0
9358 && IT_CHARPOS (*it
) > to_charpos
)
9365 case MOVE_LINE_CONTINUED
:
9366 max_current_x
= it
->last_visible_x
;
9367 /* For continued lines ending in a tab, some of the glyphs
9368 associated with the tab are displayed on the current
9369 line. Since it->current_x does not include these glyphs,
9370 we use it->last_visible_x instead. */
9373 it
->continuation_lines_width
+= it
->last_visible_x
;
9374 /* When moving by vpos, ensure that the iterator really
9375 advances to the next line (bug#847, bug#969). Fixme:
9376 do we need to do this in other circumstances? */
9377 if (it
->current_x
!= it
->last_visible_x
9378 && (op
& MOVE_TO_VPOS
)
9379 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9381 line_start_x
= it
->current_x
+ it
->pixel_width
9382 - it
->last_visible_x
;
9383 if (FRAME_WINDOW_P (it
->f
))
9385 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9386 struct font
*face_font
= face
->font
;
9388 /* When display_line produces a continued line
9389 that ends in a TAB, it skips a tab stop that
9390 is closer than the font's space character
9391 width (see x_produce_glyphs where it produces
9392 the stretch glyph which represents a TAB).
9393 We need to reproduce the same logic here. */
9394 eassert (face_font
);
9397 if (line_start_x
< face_font
->space_width
)
9399 += it
->tab_width
* face_font
->space_width
;
9402 set_iterator_to_next (it
, false);
9406 it
->continuation_lines_width
+= it
->current_x
;
9413 /* Reset/increment for the next run. */
9414 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9415 it
->current_x
= line_start_x
;
9418 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9420 last_height
= it
->max_ascent
+ it
->max_descent
;
9421 it
->max_ascent
= it
->max_descent
= 0;
9426 /* On text terminals, we may stop at the end of a line in the middle
9427 of a multi-character glyph. If the glyph itself is continued,
9428 i.e. it is actually displayed on the next line, don't treat this
9429 stopping point as valid; move to the next line instead (unless
9430 that brings us offscreen). */
9431 if (!FRAME_WINDOW_P (it
->f
)
9433 && IT_CHARPOS (*it
) == to_charpos
9434 && it
->what
== IT_CHARACTER
9436 && it
->line_wrap
== WINDOW_WRAP
9437 && it
->current_x
== it
->last_visible_x
- 1
9440 && it
->w
->window_end_valid
9441 && it
->vpos
< it
->w
->window_end_vpos
)
9443 it
->continuation_lines_width
+= it
->current_x
;
9444 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9445 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9447 last_height
= it
->max_ascent
+ it
->max_descent
;
9451 bidi_unshelve_cache (backup_data
, true);
9453 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9455 return max_current_x
;
9459 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9461 If DY > 0, move IT backward at least that many pixels. DY = 0
9462 means move IT backward to the preceding line start or BEGV. This
9463 function may move over more than DY pixels if IT->current_y - DY
9464 ends up in the middle of a line; in this case IT->current_y will be
9465 set to the top of the line moved to. */
9468 move_it_vertically_backward (struct it
*it
, int dy
)
9472 void *it2data
= NULL
, *it3data
= NULL
;
9473 ptrdiff_t start_pos
;
9475 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9476 ptrdiff_t pos_limit
;
9481 start_pos
= IT_CHARPOS (*it
);
9483 /* Estimate how many newlines we must move back. */
9484 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9485 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9488 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9490 /* Set the iterator's position that many lines back. But don't go
9491 back more than NLINES full screen lines -- this wins a day with
9492 buffers which have very long lines. */
9493 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9494 back_to_previous_visible_line_start (it
);
9496 /* Reseat the iterator here. When moving backward, we don't want
9497 reseat to skip forward over invisible text, set up the iterator
9498 to deliver from overlay strings at the new position etc. So,
9499 use reseat_1 here. */
9500 reseat_1 (it
, it
->current
.pos
, true);
9502 /* We are now surely at a line start. */
9503 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9504 reordering is in effect. */
9505 it
->continuation_lines_width
= 0;
9507 /* Move forward and see what y-distance we moved. First move to the
9508 start of the next line so that we get its height. We need this
9509 height to be able to tell whether we reached the specified
9511 SAVE_IT (it2
, *it
, it2data
);
9512 it2
.max_ascent
= it2
.max_descent
= 0;
9515 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9516 MOVE_TO_POS
| MOVE_TO_VPOS
);
9518 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9519 /* If we are in a display string which starts at START_POS,
9520 and that display string includes a newline, and we are
9521 right after that newline (i.e. at the beginning of a
9522 display line), exit the loop, because otherwise we will
9523 infloop, since move_it_to will see that it is already at
9524 START_POS and will not move. */
9525 || (it2
.method
== GET_FROM_STRING
9526 && IT_CHARPOS (it2
) == start_pos
9527 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9528 eassert (IT_CHARPOS (*it
) >= BEGV
);
9529 SAVE_IT (it3
, it2
, it3data
);
9531 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9532 eassert (IT_CHARPOS (*it
) >= BEGV
);
9533 /* H is the actual vertical distance from the position in *IT
9534 and the starting position. */
9535 h
= it2
.current_y
- it
->current_y
;
9536 /* NLINES is the distance in number of lines. */
9537 nlines
= it2
.vpos
- it
->vpos
;
9539 /* Correct IT's y and vpos position
9540 so that they are relative to the starting point. */
9546 /* DY == 0 means move to the start of the screen line. The
9547 value of nlines is > 0 if continuation lines were involved,
9548 or if the original IT position was at start of a line. */
9549 RESTORE_IT (it
, it
, it2data
);
9551 move_it_by_lines (it
, nlines
);
9552 /* The above code moves us to some position NLINES down,
9553 usually to its first glyph (leftmost in an L2R line), but
9554 that's not necessarily the start of the line, under bidi
9555 reordering. We want to get to the character position
9556 that is immediately after the newline of the previous
9559 && !it
->continuation_lines_width
9560 && !STRINGP (it
->string
)
9561 && IT_CHARPOS (*it
) > BEGV
9562 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9564 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9567 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9568 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9570 bidi_unshelve_cache (it3data
, true);
9574 /* The y-position we try to reach, relative to *IT.
9575 Note that H has been subtracted in front of the if-statement. */
9576 int target_y
= it
->current_y
+ h
- dy
;
9577 int y0
= it3
.current_y
;
9581 RESTORE_IT (&it3
, &it3
, it3data
);
9582 y1
= line_bottom_y (&it3
);
9583 line_height
= y1
- y0
;
9584 RESTORE_IT (it
, it
, it2data
);
9585 /* If we did not reach target_y, try to move further backward if
9586 we can. If we moved too far backward, try to move forward. */
9587 if (target_y
< it
->current_y
9588 /* This is heuristic. In a window that's 3 lines high, with
9589 a line height of 13 pixels each, recentering with point
9590 on the bottom line will try to move -39/2 = 19 pixels
9591 backward. Try to avoid moving into the first line. */
9592 && (it
->current_y
- target_y
9593 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9594 && IT_CHARPOS (*it
) > BEGV
)
9596 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9597 target_y
- it
->current_y
));
9598 dy
= it
->current_y
- target_y
;
9599 goto move_further_back
;
9601 else if (target_y
>= it
->current_y
+ line_height
9602 && IT_CHARPOS (*it
) < ZV
)
9604 /* Should move forward by at least one line, maybe more.
9606 Note: Calling move_it_by_lines can be expensive on
9607 terminal frames, where compute_motion is used (via
9608 vmotion) to do the job, when there are very long lines
9609 and truncate-lines is nil. That's the reason for
9610 treating terminal frames specially here. */
9612 if (!FRAME_WINDOW_P (it
->f
))
9613 move_it_vertically (it
, target_y
- it
->current_y
);
9618 move_it_by_lines (it
, 1);
9620 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9627 /* Move IT by a specified amount of pixel lines DY. DY negative means
9628 move backwards. DY = 0 means move to start of screen line. At the
9629 end, IT will be on the start of a screen line. */
9632 move_it_vertically (struct it
*it
, int dy
)
9635 move_it_vertically_backward (it
, -dy
);
9638 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9639 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9640 MOVE_TO_POS
| MOVE_TO_Y
);
9641 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9643 /* If buffer ends in ZV without a newline, move to the start of
9644 the line to satisfy the post-condition. */
9645 if (IT_CHARPOS (*it
) == ZV
9647 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9648 move_it_by_lines (it
, 0);
9653 /* Move iterator IT past the end of the text line it is in. */
9656 move_it_past_eol (struct it
*it
)
9658 enum move_it_result rc
;
9660 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9661 if (rc
== MOVE_NEWLINE_OR_CR
)
9662 set_iterator_to_next (it
, false);
9666 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9667 negative means move up. DVPOS == 0 means move to the start of the
9670 Optimization idea: If we would know that IT->f doesn't use
9671 a face with proportional font, we could be faster for
9672 truncate-lines nil. */
9675 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9678 /* The commented-out optimization uses vmotion on terminals. This
9679 gives bad results, because elements like it->what, on which
9680 callers such as pos_visible_p rely, aren't updated. */
9681 /* struct position pos;
9682 if (!FRAME_WINDOW_P (it->f))
9684 struct text_pos textpos;
9686 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9687 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9688 reseat (it, textpos, true);
9689 it->vpos += pos.vpos;
9690 it->current_y += pos.vpos;
9696 /* DVPOS == 0 means move to the start of the screen line. */
9697 move_it_vertically_backward (it
, 0);
9698 /* Let next call to line_bottom_y calculate real line height. */
9703 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9704 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9706 /* Only move to the next buffer position if we ended up in a
9707 string from display property, not in an overlay string
9708 (before-string or after-string). That is because the
9709 latter don't conceal the underlying buffer position, so
9710 we can ask to move the iterator to the exact position we
9711 are interested in. Note that, even if we are already at
9712 IT_CHARPOS (*it), the call below is not a no-op, as it
9713 will detect that we are at the end of the string, pop the
9714 iterator, and compute it->current_x and it->hpos
9716 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9717 -1, -1, -1, MOVE_TO_POS
);
9723 void *it2data
= NULL
;
9724 ptrdiff_t start_charpos
, i
;
9726 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9727 bool hit_pos_limit
= false;
9728 ptrdiff_t pos_limit
;
9730 /* Start at the beginning of the screen line containing IT's
9731 position. This may actually move vertically backwards,
9732 in case of overlays, so adjust dvpos accordingly. */
9734 move_it_vertically_backward (it
, 0);
9737 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9738 screen lines, and reseat the iterator there. */
9739 start_charpos
= IT_CHARPOS (*it
);
9740 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9743 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9745 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9746 back_to_previous_visible_line_start (it
);
9747 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9748 hit_pos_limit
= true;
9749 reseat (it
, it
->current
.pos
, true);
9751 /* Move further back if we end up in a string or an image. */
9752 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9754 /* First try to move to start of display line. */
9756 move_it_vertically_backward (it
, 0);
9758 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9760 /* If start of line is still in string or image,
9761 move further back. */
9762 back_to_previous_visible_line_start (it
);
9763 reseat (it
, it
->current
.pos
, true);
9767 it
->current_x
= it
->hpos
= 0;
9769 /* Above call may have moved too far if continuation lines
9770 are involved. Scan forward and see if it did. */
9771 SAVE_IT (it2
, *it
, it2data
);
9772 it2
.vpos
= it2
.current_y
= 0;
9773 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9774 it
->vpos
-= it2
.vpos
;
9775 it
->current_y
-= it2
.current_y
;
9776 it
->current_x
= it
->hpos
= 0;
9778 /* If we moved too far back, move IT some lines forward. */
9779 if (it2
.vpos
> -dvpos
)
9781 int delta
= it2
.vpos
+ dvpos
;
9783 RESTORE_IT (&it2
, &it2
, it2data
);
9784 SAVE_IT (it2
, *it
, it2data
);
9785 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9786 /* Move back again if we got too far ahead. */
9787 if (IT_CHARPOS (*it
) >= start_charpos
)
9788 RESTORE_IT (it
, &it2
, it2data
);
9790 bidi_unshelve_cache (it2data
, true);
9792 else if (hit_pos_limit
&& pos_limit
> BEGV
9793 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9795 /* If we hit the limit, but still didn't make it far enough
9796 back, that means there's a display string with a newline
9797 covering a large chunk of text, and that caused
9798 back_to_previous_visible_line_start try to go too far.
9799 Punish those who commit such atrocities by going back
9800 until we've reached DVPOS, after lifting the limit, which
9801 could make it slow for very long lines. "If it hurts,
9804 RESTORE_IT (it
, it
, it2data
);
9805 for (i
= -dvpos
; i
> 0; --i
)
9807 back_to_previous_visible_line_start (it
);
9810 reseat_1 (it
, it
->current
.pos
, true);
9813 RESTORE_IT (it
, it
, it2data
);
9817 /* Return true if IT points into the middle of a display vector. */
9820 in_display_vector_p (struct it
*it
)
9822 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9823 && it
->current
.dpvec_index
> 0
9824 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9827 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9828 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9829 WINDOW must be a live window and defaults to the selected one. The
9830 return value is a cons of the maximum pixel-width of any text line and
9831 the maximum pixel-height of all text lines.
9833 The optional argument FROM, if non-nil, specifies the first text
9834 position and defaults to the minimum accessible position of the buffer.
9835 If FROM is t, use the minimum accessible position that starts a
9836 non-empty line. TO, if non-nil, specifies the last text position and
9837 defaults to the maximum accessible position of the buffer. If TO is t,
9838 use the maximum accessible position that ends a non-empty line.
9840 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9841 width that can be returned. X-LIMIT nil or omitted, means to use the
9842 pixel-width of WINDOW's body; use this if you want to know how high
9843 WINDOW should be become in order to fit all of its buffer's text with
9844 the width of WINDOW unaltered. Use the maximum width WINDOW may assume
9845 if you intend to change WINDOW's width. In any case, text whose
9846 x-coordinate is beyond X-LIMIT is ignored. Since calculating the width
9847 of long lines can take some time, it's always a good idea to make this
9848 argument as small as possible; in particular, if the buffer contains
9849 long lines that shall be truncated anyway.
9851 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9852 height (excluding the height of the mode- or header-line, if any) that
9853 can be returned. Text lines whose y-coordinate is beyond Y-LIMIT are
9854 ignored. Since calculating the text height of a large buffer can take
9855 some time, it makes sense to specify this argument if the size of the
9856 buffer is large or unknown.
9858 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9859 include the height of the mode- or header-line of WINDOW in the return
9860 value. If it is either the symbol `mode-line' or `header-line', include
9861 only the height of that line, if present, in the return value. If t,
9862 include the height of both, if present, in the return value. */)
9863 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
,
9864 Lisp_Object y_limit
, Lisp_Object mode_and_header_line
)
9866 struct window
*w
= decode_live_window (window
);
9867 Lisp_Object buffer
= w
->contents
;
9870 struct buffer
*old_b
= NULL
;
9871 ptrdiff_t start
, end
, pos
;
9872 struct text_pos startp
;
9873 void *itdata
= NULL
;
9874 int c
, max_x
= 0, max_y
= 0, x
= 0, y
= 0;
9876 CHECK_BUFFER (buffer
);
9877 b
= XBUFFER (buffer
);
9879 if (b
!= current_buffer
)
9881 old_b
= current_buffer
;
9882 set_buffer_internal (b
);
9887 else if (EQ (from
, Qt
))
9890 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9891 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9893 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9898 CHECK_NUMBER_COERCE_MARKER (from
);
9899 start
= min (max (XINT (from
), BEGV
), ZV
);
9904 else if (EQ (to
, Qt
))
9907 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9908 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9910 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9915 CHECK_NUMBER_COERCE_MARKER (to
);
9916 end
= max (start
, min (XINT (to
), ZV
));
9919 if (!NILP (x_limit
) && RANGED_INTEGERP (0, x_limit
, INT_MAX
))
9920 max_x
= XINT (x_limit
);
9924 else if (RANGED_INTEGERP (0, y_limit
, INT_MAX
))
9925 max_y
= XINT (y_limit
);
9927 itdata
= bidi_shelve_cache ();
9928 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9929 start_display (&it
, w
, startp
);
9932 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9935 it
.last_visible_x
= max_x
;
9936 /* Actually, we never want move_it_to stop at to_x. But to make
9937 sure that move_it_in_display_line_to always moves far enough,
9938 we set it to INT_MAX and specify MOVE_TO_X. Also bound width
9939 value by X-LIMIT. */
9940 x
= min (move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9941 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
),
9945 /* Subtract height of header-line which was counted automatically by
9947 y
= min (it
.current_y
+ it
.max_ascent
+ it
.max_descent
9948 - WINDOW_HEADER_LINE_HEIGHT (w
),
9951 if (EQ (mode_and_header_line
, Qheader_line
)
9952 || EQ (mode_and_header_line
, Qt
))
9953 /* Re-add height of header-line as requested. */
9954 y
= y
+ WINDOW_HEADER_LINE_HEIGHT (w
);
9956 if (EQ (mode_and_header_line
, Qmode_line
)
9957 || EQ (mode_and_header_line
, Qt
))
9958 /* Add height of mode-line as requested. */
9959 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9961 bidi_unshelve_cache (itdata
, false);
9964 set_buffer_internal (old_b
);
9966 return Fcons (make_number (x
), make_number (y
));
9969 /***********************************************************************
9971 ***********************************************************************/
9973 /* Return the number of arguments the format string FORMAT needs. */
9976 format_nargs (char const *format
)
9978 ptrdiff_t nargs
= 0;
9979 for (char const *p
= format
; (p
= strchr (p
, '%')); p
++)
9987 /* Add a message with format string FORMAT and formatted arguments
9991 add_to_log (const char *format
, ...)
9994 va_start (ap
, format
);
9995 vadd_to_log (format
, ap
);
10000 vadd_to_log (char const *format
, va_list ap
)
10002 ptrdiff_t form_nargs
= format_nargs (format
);
10003 ptrdiff_t nargs
= 1 + form_nargs
;
10004 Lisp_Object args
[10];
10005 eassert (nargs
<= ARRAYELTS (args
));
10006 AUTO_STRING (args0
, format
);
10008 for (ptrdiff_t i
= 1; i
<= nargs
; i
++)
10009 args
[i
] = va_arg (ap
, Lisp_Object
);
10010 Lisp_Object msg
= Qnil
;
10011 msg
= Fformat_message (nargs
, args
);
10013 ptrdiff_t len
= SBYTES (msg
) + 1;
10015 char *buffer
= SAFE_ALLOCA (len
);
10016 memcpy (buffer
, SDATA (msg
), len
);
10018 message_dolog (buffer
, len
- 1, true, STRING_MULTIBYTE (msg
));
10023 /* Output a newline in the *Messages* buffer if "needs" one. */
10026 message_log_maybe_newline (void)
10028 if (message_log_need_newline
)
10029 message_dolog ("", 0, true, false);
10033 /* Add a string M of length NBYTES to the message log, optionally
10034 terminated with a newline when NLFLAG is true. MULTIBYTE, if
10035 true, means interpret the contents of M as multibyte. This
10036 function calls low-level routines in order to bypass text property
10037 hooks, etc. which might not be safe to run.
10039 This may GC (insert may run before/after change hooks),
10040 so the buffer M must NOT point to a Lisp string. */
10043 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
10045 const unsigned char *msg
= (const unsigned char *) m
;
10047 if (!NILP (Vmemory_full
))
10050 if (!NILP (Vmessage_log_max
))
10052 struct buffer
*oldbuf
;
10053 Lisp_Object oldpoint
, oldbegv
, oldzv
;
10054 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
10055 ptrdiff_t point_at_end
= 0;
10056 ptrdiff_t zv_at_end
= 0;
10057 Lisp_Object old_deactivate_mark
;
10059 old_deactivate_mark
= Vdeactivate_mark
;
10060 oldbuf
= current_buffer
;
10062 /* Ensure the Messages buffer exists, and switch to it.
10063 If we created it, set the major-mode. */
10064 bool newbuffer
= NILP (Fget_buffer (Vmessages_buffer_name
));
10065 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
10067 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
10068 call0 (intern ("messages-buffer-mode"));
10070 bset_undo_list (current_buffer
, Qt
);
10071 bset_cache_long_scans (current_buffer
, Qnil
);
10073 oldpoint
= message_dolog_marker1
;
10074 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
10075 oldbegv
= message_dolog_marker2
;
10076 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
10077 oldzv
= message_dolog_marker3
;
10078 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
10086 BEGV_BYTE
= BEG_BYTE
;
10089 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10091 /* Insert the string--maybe converting multibyte to single byte
10092 or vice versa, so that all the text fits the buffer. */
10094 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10100 /* Convert a multibyte string to single-byte
10101 for the *Message* buffer. */
10102 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
10104 c
= string_char_and_length (msg
+ i
, &char_bytes
);
10105 work
[0] = CHAR_TO_BYTE8 (c
);
10106 insert_1_both (work
, 1, 1, true, false, false);
10109 else if (! multibyte
10110 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10114 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10115 /* Convert a single-byte string to multibyte
10116 for the *Message* buffer. */
10117 for (i
= 0; i
< nbytes
; i
++)
10120 MAKE_CHAR_MULTIBYTE (c
);
10121 char_bytes
= CHAR_STRING (c
, str
);
10122 insert_1_both ((char *) str
, 1, char_bytes
, true, false, false);
10126 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
,
10127 true, false, false);
10131 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
10134 insert_1_both ("\n", 1, 1, true, false, false);
10136 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, false);
10138 this_bol_byte
= PT_BYTE
;
10140 /* See if this line duplicates the previous one.
10141 If so, combine duplicates. */
10142 if (this_bol
> BEG
)
10144 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, false);
10146 prev_bol_byte
= PT_BYTE
;
10148 dups
= message_log_check_duplicate (prev_bol_byte
,
10152 del_range_both (prev_bol
, prev_bol_byte
,
10153 this_bol
, this_bol_byte
, false);
10156 char dupstr
[sizeof " [ times]"
10157 + INT_STRLEN_BOUND (printmax_t
)];
10159 /* If you change this format, don't forget to also
10160 change message_log_check_duplicate. */
10161 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
10162 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
10163 insert_1_both (dupstr
, duplen
, duplen
,
10164 true, false, true);
10169 /* If we have more than the desired maximum number of lines
10170 in the *Messages* buffer now, delete the oldest ones.
10171 This is safe because we don't have undo in this buffer. */
10173 if (NATNUMP (Vmessage_log_max
))
10175 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10176 -XFASTINT (Vmessage_log_max
) - 1, false);
10177 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, false);
10180 BEGV
= marker_position (oldbegv
);
10181 BEGV_BYTE
= marker_byte_position (oldbegv
);
10190 ZV
= marker_position (oldzv
);
10191 ZV_BYTE
= marker_byte_position (oldzv
);
10195 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10197 /* We can't do Fgoto_char (oldpoint) because it will run some
10199 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10200 marker_byte_position (oldpoint
));
10202 unchain_marker (XMARKER (oldpoint
));
10203 unchain_marker (XMARKER (oldbegv
));
10204 unchain_marker (XMARKER (oldzv
));
10206 /* We called insert_1_both above with its 5th argument (PREPARE)
10207 false, which prevents insert_1_both from calling
10208 prepare_to_modify_buffer, which in turns prevents us from
10209 incrementing windows_or_buffers_changed even if *Messages* is
10210 shown in some window. So we must manually set
10211 windows_or_buffers_changed here to make up for that. */
10212 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10213 bset_redisplay (current_buffer
);
10215 set_buffer_internal (oldbuf
);
10217 message_log_need_newline
= !nlflag
;
10218 Vdeactivate_mark
= old_deactivate_mark
;
10223 /* We are at the end of the buffer after just having inserted a newline.
10224 (Note: We depend on the fact we won't be crossing the gap.)
10225 Check to see if the most recent message looks a lot like the previous one.
10226 Return 0 if different, 1 if the new one should just replace it, or a
10227 value N > 1 if we should also append " [N times]". */
10230 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10233 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10234 bool seen_dots
= false;
10235 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10236 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10238 for (i
= 0; i
< len
; i
++)
10240 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10242 if (p1
[i
] != p2
[i
])
10248 if (*p1
++ == ' ' && *p1
++ == '[')
10251 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10252 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10259 /* Display an echo area message M with a specified length of NBYTES
10260 bytes. The string may include null characters. If M is not a
10261 string, clear out any existing message, and let the mini-buffer
10264 This function cancels echoing. */
10267 message3 (Lisp_Object m
)
10269 clear_message (true, true);
10272 /* First flush out any partial line written with print. */
10273 message_log_maybe_newline ();
10276 ptrdiff_t nbytes
= SBYTES (m
);
10277 bool multibyte
= STRING_MULTIBYTE (m
);
10280 SAFE_ALLOCA_STRING (buffer
, m
);
10281 message_dolog (buffer
, nbytes
, true, multibyte
);
10284 if (! inhibit_message
)
10285 message3_nolog (m
);
10288 /* Log the message M to stderr. Log an empty line if M is not a string. */
10291 message_to_stderr (Lisp_Object m
)
10293 if (noninteractive_need_newline
)
10295 noninteractive_need_newline
= false;
10296 fputc ('\n', stderr
);
10300 Lisp_Object coding_system
= Vlocale_coding_system
;
10303 if (!NILP (Vcoding_system_for_write
))
10304 coding_system
= Vcoding_system_for_write
;
10305 if (!NILP (coding_system
))
10306 s
= code_convert_string_norecord (m
, coding_system
, true);
10310 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10312 if (!cursor_in_echo_area
)
10313 fputc ('\n', stderr
);
10317 /* The non-logging version of message3.
10318 This does not cancel echoing, because it is used for echoing.
10319 Perhaps we need to make a separate function for echoing
10320 and make this cancel echoing. */
10323 message3_nolog (Lisp_Object m
)
10325 struct frame
*sf
= SELECTED_FRAME ();
10327 if (FRAME_INITIAL_P (sf
))
10328 message_to_stderr (m
);
10329 /* Error messages get reported properly by cmd_error, so this must be just an
10330 informative message; if the frame hasn't really been initialized yet, just
10332 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10334 /* Get the frame containing the mini-buffer
10335 that the selected frame is using. */
10336 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10337 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10338 struct frame
*f
= XFRAME (frame
);
10340 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10341 Fmake_frame_visible (frame
);
10343 if (STRINGP (m
) && SCHARS (m
) > 0)
10346 if (minibuffer_auto_raise
)
10347 Fraise_frame (frame
);
10348 /* Assume we are not echoing.
10349 (If we are, echo_now will override this.) */
10350 echo_message_buffer
= Qnil
;
10353 clear_message (true, true);
10355 do_pending_window_change (false);
10356 echo_area_display (true);
10357 do_pending_window_change (false);
10358 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10359 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10364 /* Display a null-terminated echo area message M. If M is 0, clear
10365 out any existing message, and let the mini-buffer text show through.
10367 The buffer M must continue to exist until after the echo area gets
10368 cleared or some other message gets displayed there. Do not pass
10369 text that is stored in a Lisp string. Do not pass text in a buffer
10370 that was alloca'd. */
10373 message1 (const char *m
)
10375 message3 (m
? build_unibyte_string (m
) : Qnil
);
10379 /* The non-logging counterpart of message1. */
10382 message1_nolog (const char *m
)
10384 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10387 /* Display a message M which contains a single %s
10388 which gets replaced with STRING. */
10391 message_with_string (const char *m
, Lisp_Object string
, bool log
)
10393 CHECK_STRING (string
);
10396 if (noninteractive
)
10397 need_message
= !!m
;
10398 else if (!INTERACTIVE
)
10399 need_message
= false;
10402 /* The frame whose minibuffer we're going to display the message on.
10403 It may be larger than the selected frame, so we need
10404 to use its buffer, not the selected frame's buffer. */
10405 Lisp_Object mini_window
;
10406 struct frame
*f
, *sf
= SELECTED_FRAME ();
10408 /* Get the frame containing the minibuffer
10409 that the selected frame is using. */
10410 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10411 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10413 /* Error messages get reported properly by cmd_error, so this must be
10414 just an informative message; if the frame hasn't really been
10415 initialized yet, just toss it. */
10416 need_message
= f
->glyphs_initialized_p
;
10421 AUTO_STRING (fmt
, m
);
10422 Lisp_Object msg
= CALLN (Fformat_message
, fmt
, string
);
10424 if (noninteractive
)
10425 message_to_stderr (msg
);
10431 message3_nolog (msg
);
10433 /* Print should start at the beginning of the message
10434 buffer next time. */
10435 message_buf_print
= false;
10441 /* Dump an informative message to the minibuf. If M is 0, clear out
10442 any existing message, and let the mini-buffer text show through.
10444 The message must be safe ASCII and the format must not contain ` or
10445 '. If your message and format do not fit into this category,
10446 convert your arguments to Lisp objects and use Fmessage instead. */
10448 static void ATTRIBUTE_FORMAT_PRINTF (1, 0)
10449 vmessage (const char *m
, va_list ap
)
10451 if (noninteractive
)
10455 if (noninteractive_need_newline
)
10456 putc ('\n', stderr
);
10457 noninteractive_need_newline
= false;
10458 vfprintf (stderr
, m
, ap
);
10459 if (!cursor_in_echo_area
)
10460 fprintf (stderr
, "\n");
10464 else if (INTERACTIVE
)
10466 /* The frame whose mini-buffer we're going to display the message
10467 on. It may be larger than the selected frame, so we need to
10468 use its buffer, not the selected frame's buffer. */
10469 Lisp_Object mini_window
;
10470 struct frame
*f
, *sf
= SELECTED_FRAME ();
10472 /* Get the frame containing the mini-buffer
10473 that the selected frame is using. */
10474 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10475 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10477 /* Error messages get reported properly by cmd_error, so this must be
10478 just an informative message; if the frame hasn't really been
10479 initialized yet, just toss it. */
10480 if (f
->glyphs_initialized_p
)
10485 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10487 char *message_buf
= SAFE_ALLOCA (maxsize
+ 1);
10489 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10491 message3 (make_string (message_buf
, len
));
10497 /* Print should start at the beginning of the message
10498 buffer next time. */
10499 message_buf_print
= false;
10505 message (const char *m
, ...)
10514 /* Display the current message in the current mini-buffer. This is
10515 only called from error handlers in process.c, and is not time
10519 update_echo_area (void)
10521 if (!NILP (echo_area_buffer
[0]))
10523 Lisp_Object string
;
10524 string
= Fcurrent_message ();
10530 /* Make sure echo area buffers in `echo_buffers' are live.
10531 If they aren't, make new ones. */
10534 ensure_echo_area_buffers (void)
10536 for (int i
= 0; i
< 2; i
++)
10537 if (!BUFFERP (echo_buffer
[i
])
10538 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10540 Lisp_Object old_buffer
= echo_buffer
[i
];
10541 static char const name_fmt
[] = " *Echo Area %d*";
10542 char name
[sizeof name_fmt
+ INT_STRLEN_BOUND (int)];
10543 AUTO_STRING_WITH_LEN (lname
, name
, sprintf (name
, name_fmt
, i
));
10544 echo_buffer
[i
] = Fget_buffer_create (lname
);
10545 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10546 /* to force word wrap in echo area -
10547 it was decided to postpone this*/
10548 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10550 for (int j
= 0; j
< 2; j
++)
10551 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10552 echo_area_buffer
[j
] = echo_buffer
[i
];
10557 /* Call FN with args A1..A2 with either the current or last displayed
10558 echo_area_buffer as current buffer.
10560 WHICH zero means use the current message buffer
10561 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10562 from echo_buffer[] and clear it.
10564 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10565 suitable buffer from echo_buffer[] and clear it.
10567 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10568 that the current message becomes the last displayed one, choose a
10569 suitable buffer for echo_area_buffer[0], and clear it.
10571 Value is what FN returns. */
10574 with_echo_area_buffer (struct window
*w
, int which
,
10575 bool (*fn
) (ptrdiff_t, Lisp_Object
),
10576 ptrdiff_t a1
, Lisp_Object a2
)
10578 Lisp_Object buffer
;
10579 bool this_one
, the_other
, clear_buffer_p
, rc
;
10580 ptrdiff_t count
= SPECPDL_INDEX ();
10582 /* If buffers aren't live, make new ones. */
10583 ensure_echo_area_buffers ();
10585 clear_buffer_p
= false;
10588 this_one
= false, the_other
= true;
10589 else if (which
> 0)
10590 this_one
= true, the_other
= false;
10593 this_one
= false, the_other
= true;
10594 clear_buffer_p
= true;
10596 /* We need a fresh one in case the current echo buffer equals
10597 the one containing the last displayed echo area message. */
10598 if (!NILP (echo_area_buffer
[this_one
])
10599 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10600 echo_area_buffer
[this_one
] = Qnil
;
10603 /* Choose a suitable buffer from echo_buffer[] if we don't
10605 if (NILP (echo_area_buffer
[this_one
]))
10607 echo_area_buffer
[this_one
]
10608 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10609 ? echo_buffer
[the_other
]
10610 : echo_buffer
[this_one
]);
10611 clear_buffer_p
= true;
10614 buffer
= echo_area_buffer
[this_one
];
10616 /* Don't get confused by reusing the buffer used for echoing
10617 for a different purpose. */
10618 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10621 record_unwind_protect (unwind_with_echo_area_buffer
,
10622 with_echo_area_buffer_unwind_data (w
));
10624 /* Make the echo area buffer current. Note that for display
10625 purposes, it is not necessary that the displayed window's buffer
10626 == current_buffer, except for text property lookup. So, let's
10627 only set that buffer temporarily here without doing a full
10628 Fset_window_buffer. We must also change w->pointm, though,
10629 because otherwise an assertions in unshow_buffer fails, and Emacs
10631 set_buffer_internal_1 (XBUFFER (buffer
));
10634 wset_buffer (w
, buffer
);
10635 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10636 set_marker_both (w
->old_pointm
, buffer
, BEG
, BEG_BYTE
);
10639 bset_undo_list (current_buffer
, Qt
);
10640 bset_read_only (current_buffer
, Qnil
);
10641 specbind (Qinhibit_read_only
, Qt
);
10642 specbind (Qinhibit_modification_hooks
, Qt
);
10644 if (clear_buffer_p
&& Z
> BEG
)
10645 del_range (BEG
, Z
);
10647 eassert (BEGV
>= BEG
);
10648 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10652 eassert (BEGV
>= BEG
);
10653 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10655 unbind_to (count
, Qnil
);
10660 /* Save state that should be preserved around the call to the function
10661 FN called in with_echo_area_buffer. */
10664 with_echo_area_buffer_unwind_data (struct window
*w
)
10667 Lisp_Object vector
, tmp
;
10669 /* Reduce consing by keeping one vector in
10670 Vwith_echo_area_save_vector. */
10671 vector
= Vwith_echo_area_save_vector
;
10672 Vwith_echo_area_save_vector
= Qnil
;
10675 vector
= Fmake_vector (make_number (11), Qnil
);
10677 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10678 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10679 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10683 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10684 ASET (vector
, i
, w
->contents
); ++i
;
10685 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10686 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10687 ASET (vector
, i
, make_number (marker_position (w
->old_pointm
))); ++i
;
10688 ASET (vector
, i
, make_number (marker_byte_position (w
->old_pointm
))); ++i
;
10689 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10690 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10695 for (; i
< end
; ++i
)
10696 ASET (vector
, i
, Qnil
);
10699 eassert (i
== ASIZE (vector
));
10704 /* Restore global state from VECTOR which was created by
10705 with_echo_area_buffer_unwind_data. */
10708 unwind_with_echo_area_buffer (Lisp_Object vector
)
10710 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10711 Vdeactivate_mark
= AREF (vector
, 1);
10712 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10714 if (WINDOWP (AREF (vector
, 3)))
10717 Lisp_Object buffer
;
10719 w
= XWINDOW (AREF (vector
, 3));
10720 buffer
= AREF (vector
, 4);
10722 wset_buffer (w
, buffer
);
10723 set_marker_both (w
->pointm
, buffer
,
10724 XFASTINT (AREF (vector
, 5)),
10725 XFASTINT (AREF (vector
, 6)));
10726 set_marker_both (w
->old_pointm
, buffer
,
10727 XFASTINT (AREF (vector
, 7)),
10728 XFASTINT (AREF (vector
, 8)));
10729 set_marker_both (w
->start
, buffer
,
10730 XFASTINT (AREF (vector
, 9)),
10731 XFASTINT (AREF (vector
, 10)));
10734 Vwith_echo_area_save_vector
= vector
;
10738 /* Set up the echo area for use by print functions. MULTIBYTE_P
10739 means we will print multibyte. */
10742 setup_echo_area_for_printing (bool multibyte_p
)
10744 /* If we can't find an echo area any more, exit. */
10745 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10746 Fkill_emacs (Qnil
);
10748 ensure_echo_area_buffers ();
10750 if (!message_buf_print
)
10752 /* A message has been output since the last time we printed.
10753 Choose a fresh echo area buffer. */
10754 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10755 echo_area_buffer
[0] = echo_buffer
[1];
10757 echo_area_buffer
[0] = echo_buffer
[0];
10759 /* Switch to that buffer and clear it. */
10760 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10761 bset_truncate_lines (current_buffer
, Qnil
);
10765 ptrdiff_t count
= SPECPDL_INDEX ();
10766 specbind (Qinhibit_read_only
, Qt
);
10767 /* Note that undo recording is always disabled. */
10768 del_range (BEG
, Z
);
10769 unbind_to (count
, Qnil
);
10771 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10773 /* Set up the buffer for the multibyteness we need. */
10775 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10776 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10778 /* Raise the frame containing the echo area. */
10779 if (minibuffer_auto_raise
)
10781 struct frame
*sf
= SELECTED_FRAME ();
10782 Lisp_Object mini_window
;
10783 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10784 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10787 message_log_maybe_newline ();
10788 message_buf_print
= true;
10792 if (NILP (echo_area_buffer
[0]))
10794 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10795 echo_area_buffer
[0] = echo_buffer
[1];
10797 echo_area_buffer
[0] = echo_buffer
[0];
10800 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10802 /* Someone switched buffers between print requests. */
10803 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10804 bset_truncate_lines (current_buffer
, Qnil
);
10810 /* Display an echo area message in window W. Value is true if W's
10811 height is changed. If display_last_displayed_message_p,
10812 display the message that was last displayed, otherwise
10813 display the current message. */
10816 display_echo_area (struct window
*w
)
10818 bool no_message_p
, window_height_changed_p
;
10820 /* Temporarily disable garbage collections while displaying the echo
10821 area. This is done because a GC can print a message itself.
10822 That message would modify the echo area buffer's contents while a
10823 redisplay of the buffer is going on, and seriously confuse
10825 ptrdiff_t count
= inhibit_garbage_collection ();
10827 /* If there is no message, we must call display_echo_area_1
10828 nevertheless because it resizes the window. But we will have to
10829 reset the echo_area_buffer in question to nil at the end because
10830 with_echo_area_buffer will sets it to an empty buffer. */
10831 bool i
= display_last_displayed_message_p
;
10832 /* According to the C99, C11 and C++11 standards, the integral value
10833 of a "bool" is always 0 or 1, so this array access is safe here,
10835 no_message_p
= NILP (echo_area_buffer
[i
]);
10837 window_height_changed_p
10838 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10839 display_echo_area_1
,
10840 (intptr_t) w
, Qnil
);
10843 echo_area_buffer
[i
] = Qnil
;
10845 unbind_to (count
, Qnil
);
10846 return window_height_changed_p
;
10850 /* Helper for display_echo_area. Display the current buffer which
10851 contains the current echo area message in window W, a mini-window,
10852 a pointer to which is passed in A1. A2..A4 are currently not used.
10853 Change the height of W so that all of the message is displayed.
10854 Value is true if height of W was changed. */
10857 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10860 struct window
*w
= (struct window
*) i1
;
10861 Lisp_Object window
;
10862 struct text_pos start
;
10864 /* We are about to enter redisplay without going through
10865 redisplay_internal, so we need to forget these faces by hand
10867 forget_escape_and_glyphless_faces ();
10869 /* Do this before displaying, so that we have a large enough glyph
10870 matrix for the display. If we can't get enough space for the
10871 whole text, display the last N lines. That works by setting w->start. */
10872 bool window_height_changed_p
= resize_mini_window (w
, false);
10874 /* Use the starting position chosen by resize_mini_window. */
10875 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10878 clear_glyph_matrix (w
->desired_matrix
);
10879 XSETWINDOW (window
, w
);
10880 try_window (window
, start
, 0);
10882 return window_height_changed_p
;
10886 /* Resize the echo area window to exactly the size needed for the
10887 currently displayed message, if there is one. If a mini-buffer
10888 is active, don't shrink it. */
10891 resize_echo_area_exactly (void)
10893 if (BUFFERP (echo_area_buffer
[0])
10894 && WINDOWP (echo_area_window
))
10896 struct window
*w
= XWINDOW (echo_area_window
);
10897 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10898 bool resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10899 (intptr_t) w
, resize_exactly
);
10902 windows_or_buffers_changed
= 42;
10903 update_mode_lines
= 30;
10904 redisplay_internal ();
10910 /* Callback function for with_echo_area_buffer, when used from
10911 resize_echo_area_exactly. A1 contains a pointer to the window to
10912 resize, EXACTLY non-nil means resize the mini-window exactly to the
10913 size of the text displayed. A3 and A4 are not used. Value is what
10914 resize_mini_window returns. */
10917 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10920 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10924 /* Resize mini-window W to fit the size of its contents. EXACT_P
10925 means size the window exactly to the size needed. Otherwise, it's
10926 only enlarged until W's buffer is empty.
10928 Set W->start to the right place to begin display. If the whole
10929 contents fit, start at the beginning. Otherwise, start so as
10930 to make the end of the contents appear. This is particularly
10931 important for y-or-n-p, but seems desirable generally.
10933 Value is true if the window height has been changed. */
10936 resize_mini_window (struct window
*w
, bool exact_p
)
10938 struct frame
*f
= XFRAME (w
->frame
);
10939 bool window_height_changed_p
= false;
10941 eassert (MINI_WINDOW_P (w
));
10943 /* By default, start display at the beginning. */
10944 set_marker_both (w
->start
, w
->contents
,
10945 BUF_BEGV (XBUFFER (w
->contents
)),
10946 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10948 /* Don't resize windows while redisplaying a window; it would
10949 confuse redisplay functions when the size of the window they are
10950 displaying changes from under them. Such a resizing can happen,
10951 for instance, when which-func prints a long message while
10952 we are running fontification-functions. We're running these
10953 functions with safe_call which binds inhibit-redisplay to t. */
10954 if (!NILP (Vinhibit_redisplay
))
10957 /* Nil means don't try to resize. */
10958 if (NILP (Vresize_mini_windows
)
10959 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10962 if (!FRAME_MINIBUF_ONLY_P (f
))
10965 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10966 + WINDOW_PIXEL_HEIGHT (w
));
10967 int unit
= FRAME_LINE_HEIGHT (f
);
10968 int height
, max_height
;
10969 struct text_pos start
;
10970 struct buffer
*old_current_buffer
= NULL
;
10972 if (current_buffer
!= XBUFFER (w
->contents
))
10974 old_current_buffer
= current_buffer
;
10975 set_buffer_internal (XBUFFER (w
->contents
));
10978 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10980 /* Compute the max. number of lines specified by the user. */
10981 if (FLOATP (Vmax_mini_window_height
))
10982 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10983 else if (INTEGERP (Vmax_mini_window_height
))
10984 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10986 max_height
= total_height
/ 4;
10988 /* Correct that max. height if it's bogus. */
10989 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10991 /* Find out the height of the text in the window. */
10992 if (it
.line_wrap
== TRUNCATE
)
10997 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10998 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10999 height
= it
.current_y
+ last_height
;
11001 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
11002 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
11005 /* Compute a suitable window start. */
11006 if (height
> max_height
)
11008 height
= (max_height
/ unit
) * unit
;
11009 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
11010 move_it_vertically_backward (&it
, height
- unit
);
11011 start
= it
.current
.pos
;
11014 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
11015 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
11017 if (EQ (Vresize_mini_windows
, Qgrow_only
))
11019 /* Let it grow only, until we display an empty message, in which
11020 case the window shrinks again. */
11021 if (height
> WINDOW_PIXEL_HEIGHT (w
))
11023 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11025 FRAME_WINDOWS_FROZEN (f
) = true;
11026 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
11027 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11029 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
11030 && (exact_p
|| BEGV
== ZV
))
11032 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11034 FRAME_WINDOWS_FROZEN (f
) = false;
11035 shrink_mini_window (w
, true);
11036 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11041 /* Always resize to exact size needed. */
11042 if (height
> WINDOW_PIXEL_HEIGHT (w
))
11044 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11046 FRAME_WINDOWS_FROZEN (f
) = true;
11047 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
11048 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11050 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
11052 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11054 FRAME_WINDOWS_FROZEN (f
) = false;
11055 shrink_mini_window (w
, true);
11059 FRAME_WINDOWS_FROZEN (f
) = true;
11060 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
11063 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11067 if (old_current_buffer
)
11068 set_buffer_internal (old_current_buffer
);
11071 return window_height_changed_p
;
11075 /* Value is the current message, a string, or nil if there is no
11076 current message. */
11079 current_message (void)
11083 if (!BUFFERP (echo_area_buffer
[0]))
11087 with_echo_area_buffer (0, 0, current_message_1
,
11088 (intptr_t) &msg
, Qnil
);
11090 echo_area_buffer
[0] = Qnil
;
11098 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
11101 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
11104 *msg
= make_buffer_string (BEG
, Z
, true);
11111 /* Push the current message on Vmessage_stack for later restoration
11112 by restore_message. Value is true if the current message isn't
11113 empty. This is a relatively infrequent operation, so it's not
11114 worth optimizing. */
11117 push_message (void)
11119 Lisp_Object msg
= current_message ();
11120 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
11121 return STRINGP (msg
);
11125 /* Restore message display from the top of Vmessage_stack. */
11128 restore_message (void)
11130 eassert (CONSP (Vmessage_stack
));
11131 message3_nolog (XCAR (Vmessage_stack
));
11135 /* Handler for unwind-protect calling pop_message. */
11138 pop_message_unwind (void)
11140 /* Pop the top-most entry off Vmessage_stack. */
11141 eassert (CONSP (Vmessage_stack
));
11142 Vmessage_stack
= XCDR (Vmessage_stack
);
11146 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11147 exits. If the stack is not empty, we have a missing pop_message
11151 check_message_stack (void)
11153 if (!NILP (Vmessage_stack
))
11158 /* Truncate to NCHARS what will be displayed in the echo area the next
11159 time we display it---but don't redisplay it now. */
11162 truncate_echo_area (ptrdiff_t nchars
)
11165 echo_area_buffer
[0] = Qnil
;
11166 else if (!noninteractive
11168 && !NILP (echo_area_buffer
[0]))
11170 struct frame
*sf
= SELECTED_FRAME ();
11171 /* Error messages get reported properly by cmd_error, so this must be
11172 just an informative message; if the frame hasn't really been
11173 initialized yet, just toss it. */
11174 if (sf
->glyphs_initialized_p
)
11175 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11180 /* Helper function for truncate_echo_area. Truncate the current
11181 message to at most NCHARS characters. */
11184 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11186 if (BEG
+ nchars
< Z
)
11187 del_range (BEG
+ nchars
, Z
);
11189 echo_area_buffer
[0] = Qnil
;
11193 /* Set the current message to STRING. */
11196 set_message (Lisp_Object string
)
11198 eassert (STRINGP (string
));
11200 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11202 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11203 message_buf_print
= false;
11204 help_echo_showing_p
= false;
11206 if (STRINGP (Vdebug_on_message
)
11207 && STRINGP (string
)
11208 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11209 call_debugger (list2 (Qerror
, string
));
11213 /* Helper function for set_message. First argument is ignored and second
11214 argument has the same meaning as for set_message.
11215 This function is called with the echo area buffer being current. */
11218 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11220 eassert (STRINGP (string
));
11222 /* Change multibyteness of the echo buffer appropriately. */
11223 if (message_enable_multibyte
11224 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11225 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11227 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11228 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11229 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11231 /* Insert new message at BEG. */
11232 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11234 /* This function takes care of single/multibyte conversion.
11235 We just have to ensure that the echo area buffer has the right
11236 setting of enable_multibyte_characters. */
11237 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), true);
11243 /* Clear messages. CURRENT_P means clear the current message.
11244 LAST_DISPLAYED_P means clear the message last displayed. */
11247 clear_message (bool current_p
, bool last_displayed_p
)
11251 echo_area_buffer
[0] = Qnil
;
11252 message_cleared_p
= true;
11255 if (last_displayed_p
)
11256 echo_area_buffer
[1] = Qnil
;
11258 message_buf_print
= false;
11261 /* Clear garbaged frames.
11263 This function is used where the old redisplay called
11264 redraw_garbaged_frames which in turn called redraw_frame which in
11265 turn called clear_frame. The call to clear_frame was a source of
11266 flickering. I believe a clear_frame is not necessary. It should
11267 suffice in the new redisplay to invalidate all current matrices,
11268 and ensure a complete redisplay of all windows. */
11271 clear_garbaged_frames (void)
11273 if (frame_garbaged
)
11275 Lisp_Object tail
, frame
;
11276 struct frame
*sf
= SELECTED_FRAME ();
11278 FOR_EACH_FRAME (tail
, frame
)
11280 struct frame
*f
= XFRAME (frame
);
11282 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11285 /* It makes no sense to redraw a non-selected TTY
11286 frame, since that will actually clear the
11287 selected frame, and might leave the selected
11288 frame with corrupted display, if it happens not
11289 to be marked garbaged. */
11290 && !(f
!= sf
&& (FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))))
11293 clear_current_matrices (f
);
11294 fset_redisplay (f
);
11295 f
->garbaged
= false;
11296 f
->resized_p
= false;
11300 frame_garbaged
= false;
11305 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P, update
11309 echo_area_display (bool update_frame_p
)
11311 Lisp_Object mini_window
;
11314 bool window_height_changed_p
= false;
11315 struct frame
*sf
= SELECTED_FRAME ();
11317 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11318 w
= XWINDOW (mini_window
);
11319 f
= XFRAME (WINDOW_FRAME (w
));
11321 /* Don't display if frame is invisible or not yet initialized. */
11322 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11325 #ifdef HAVE_WINDOW_SYSTEM
11326 /* When Emacs starts, selected_frame may be the initial terminal
11327 frame. If we let this through, a message would be displayed on
11329 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11331 #endif /* HAVE_WINDOW_SYSTEM */
11333 /* Redraw garbaged frames. */
11334 clear_garbaged_frames ();
11336 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11338 echo_area_window
= mini_window
;
11339 window_height_changed_p
= display_echo_area (w
);
11340 w
->must_be_updated_p
= true;
11342 /* Update the display, unless called from redisplay_internal.
11343 Also don't update the screen during redisplay itself. The
11344 update will happen at the end of redisplay, and an update
11345 here could cause confusion. */
11346 if (update_frame_p
&& !redisplaying_p
)
11350 /* If the display update has been interrupted by pending
11351 input, update mode lines in the frame. Due to the
11352 pending input, it might have been that redisplay hasn't
11353 been called, so that mode lines above the echo area are
11354 garbaged. This looks odd, so we prevent it here. */
11355 if (!display_completed
)
11356 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11358 if (window_height_changed_p
11359 /* Don't do this if Emacs is shutting down. Redisplay
11360 needs to run hooks. */
11361 && !NILP (Vrun_hooks
))
11363 /* Must update other windows. Likewise as in other
11364 cases, don't let this update be interrupted by
11366 ptrdiff_t count
= SPECPDL_INDEX ();
11367 specbind (Qredisplay_dont_pause
, Qt
);
11368 fset_redisplay (f
);
11369 redisplay_internal ();
11370 unbind_to (count
, Qnil
);
11372 else if (FRAME_WINDOW_P (f
) && n
== 0)
11374 /* Window configuration is the same as before.
11375 Can do with a display update of the echo area,
11376 unless we displayed some mode lines. */
11377 update_single_window (w
);
11381 update_frame (f
, true, true);
11383 /* If cursor is in the echo area, make sure that the next
11384 redisplay displays the minibuffer, so that the cursor will
11385 be replaced with what the minibuffer wants. */
11386 if (cursor_in_echo_area
)
11387 wset_redisplay (XWINDOW (mini_window
));
11390 else if (!EQ (mini_window
, selected_window
))
11391 wset_redisplay (XWINDOW (mini_window
));
11393 /* Last displayed message is now the current message. */
11394 echo_area_buffer
[1] = echo_area_buffer
[0];
11395 /* Inform read_char that we're not echoing. */
11396 echo_message_buffer
= Qnil
;
11398 /* Prevent redisplay optimization in redisplay_internal by resetting
11399 this_line_start_pos. This is done because the mini-buffer now
11400 displays the message instead of its buffer text. */
11401 if (EQ (mini_window
, selected_window
))
11402 CHARPOS (this_line_start_pos
) = 0;
11404 if (window_height_changed_p
)
11406 fset_redisplay (f
);
11408 /* If window configuration was changed, frames may have been
11409 marked garbaged. Clear them or we will experience
11410 surprises wrt scrolling.
11411 FIXME: How/why/when? */
11412 clear_garbaged_frames ();
11416 /* True if W's buffer was changed but not saved. */
11419 window_buffer_changed (struct window
*w
)
11421 struct buffer
*b
= XBUFFER (w
->contents
);
11423 eassert (BUFFER_LIVE_P (b
));
11425 return (BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
;
11428 /* True if W has %c in its mode line and mode line should be updated. */
11431 mode_line_update_needed (struct window
*w
)
11433 return (w
->column_number_displayed
!= -1
11434 && !(PT
== w
->last_point
&& !window_outdated (w
))
11435 && (w
->column_number_displayed
!= current_column ()));
11438 /* True if window start of W is frozen and may not be changed during
11442 window_frozen_p (struct window
*w
)
11444 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11446 Lisp_Object window
;
11448 XSETWINDOW (window
, w
);
11449 if (MINI_WINDOW_P (w
))
11451 else if (EQ (window
, selected_window
))
11453 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11454 && EQ (window
, Vminibuf_scroll_window
))
11455 /* This special window can't be frozen too. */
11463 /***********************************************************************
11464 Mode Lines and Frame Titles
11465 ***********************************************************************/
11467 /* A buffer for constructing non-propertized mode-line strings and
11468 frame titles in it; allocated from the heap in init_xdisp and
11469 resized as needed in store_mode_line_noprop_char. */
11471 static char *mode_line_noprop_buf
;
11473 /* The buffer's end, and a current output position in it. */
11475 static char *mode_line_noprop_buf_end
;
11476 static char *mode_line_noprop_ptr
;
11478 #define MODE_LINE_NOPROP_LEN(start) \
11479 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11482 MODE_LINE_DISPLAY
= 0,
11486 } mode_line_target
;
11488 /* Alist that caches the results of :propertize.
11489 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11490 static Lisp_Object mode_line_proptrans_alist
;
11492 /* List of strings making up the mode-line. */
11493 static Lisp_Object mode_line_string_list
;
11495 /* Base face property when building propertized mode line string. */
11496 static Lisp_Object mode_line_string_face
;
11497 static Lisp_Object mode_line_string_face_prop
;
11500 /* Unwind data for mode line strings */
11502 static Lisp_Object Vmode_line_unwind_vector
;
11505 format_mode_line_unwind_data (struct frame
*target_frame
,
11506 struct buffer
*obuf
,
11508 bool save_proptrans
)
11510 Lisp_Object vector
, tmp
;
11512 /* Reduce consing by keeping one vector in
11513 Vwith_echo_area_save_vector. */
11514 vector
= Vmode_line_unwind_vector
;
11515 Vmode_line_unwind_vector
= Qnil
;
11518 vector
= Fmake_vector (make_number (10), Qnil
);
11520 ASET (vector
, 0, make_number (mode_line_target
));
11521 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11522 ASET (vector
, 2, mode_line_string_list
);
11523 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11524 ASET (vector
, 4, mode_line_string_face
);
11525 ASET (vector
, 5, mode_line_string_face_prop
);
11528 XSETBUFFER (tmp
, obuf
);
11531 ASET (vector
, 6, tmp
);
11532 ASET (vector
, 7, owin
);
11535 /* Similarly to `with-selected-window', if the operation selects
11536 a window on another frame, we must restore that frame's
11537 selected window, and (for a tty) the top-frame. */
11538 ASET (vector
, 8, target_frame
->selected_window
);
11539 if (FRAME_TERMCAP_P (target_frame
))
11540 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11547 unwind_format_mode_line (Lisp_Object vector
)
11549 Lisp_Object old_window
= AREF (vector
, 7);
11550 Lisp_Object target_frame_window
= AREF (vector
, 8);
11551 Lisp_Object old_top_frame
= AREF (vector
, 9);
11553 mode_line_target
= XINT (AREF (vector
, 0));
11554 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11555 mode_line_string_list
= AREF (vector
, 2);
11556 if (! EQ (AREF (vector
, 3), Qt
))
11557 mode_line_proptrans_alist
= AREF (vector
, 3);
11558 mode_line_string_face
= AREF (vector
, 4);
11559 mode_line_string_face_prop
= AREF (vector
, 5);
11561 /* Select window before buffer, since it may change the buffer. */
11562 if (!NILP (old_window
))
11564 /* If the operation that we are unwinding had selected a window
11565 on a different frame, reset its frame-selected-window. For a
11566 text terminal, reset its top-frame if necessary. */
11567 if (!NILP (target_frame_window
))
11570 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11572 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11573 Fselect_window (target_frame_window
, Qt
);
11575 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11576 Fselect_frame (old_top_frame
, Qt
);
11579 Fselect_window (old_window
, Qt
);
11582 if (!NILP (AREF (vector
, 6)))
11584 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11585 ASET (vector
, 6, Qnil
);
11588 Vmode_line_unwind_vector
= vector
;
11592 /* Store a single character C for the frame title in mode_line_noprop_buf.
11593 Re-allocate mode_line_noprop_buf if necessary. */
11596 store_mode_line_noprop_char (char c
)
11598 /* If output position has reached the end of the allocated buffer,
11599 increase the buffer's size. */
11600 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11602 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11603 ptrdiff_t size
= len
;
11604 mode_line_noprop_buf
=
11605 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11606 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11607 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11610 *mode_line_noprop_ptr
++ = c
;
11614 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11615 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11616 characters that yield more columns than PRECISION; PRECISION <= 0
11617 means copy the whole string. Pad with spaces until FIELD_WIDTH
11618 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11619 pad. Called from display_mode_element when it is used to build a
11623 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11625 const unsigned char *str
= (const unsigned char *) string
;
11627 ptrdiff_t dummy
, nbytes
;
11629 /* Copy at most PRECISION chars from STR. */
11630 nbytes
= strlen (string
);
11631 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11633 store_mode_line_noprop_char (*str
++);
11635 /* Fill up with spaces until FIELD_WIDTH reached. */
11636 while (field_width
> 0
11637 && n
< field_width
)
11639 store_mode_line_noprop_char (' ');
11646 /***********************************************************************
11648 ***********************************************************************/
11650 #ifdef HAVE_WINDOW_SYSTEM
11652 /* Set the title of FRAME, if it has changed. The title format is
11653 Vicon_title_format if FRAME is iconified, otherwise it is
11654 frame_title_format. */
11657 x_consider_frame_title (Lisp_Object frame
)
11659 struct frame
*f
= XFRAME (frame
);
11661 if ((FRAME_WINDOW_P (f
)
11662 || FRAME_MINIBUF_ONLY_P (f
)
11663 || f
->explicit_name
)
11664 && NILP (Fframe_parameter (frame
, Qtooltip
)))
11666 /* Do we have more than one visible frame on this X display? */
11667 Lisp_Object tail
, other_frame
, fmt
;
11668 ptrdiff_t title_start
;
11672 ptrdiff_t count
= SPECPDL_INDEX ();
11674 FOR_EACH_FRAME (tail
, other_frame
)
11676 struct frame
*tf
= XFRAME (other_frame
);
11679 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11680 && !FRAME_MINIBUF_ONLY_P (tf
)
11681 && !EQ (other_frame
, tip_frame
)
11682 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11686 /* Set global variable indicating that multiple frames exist. */
11687 multiple_frames
= CONSP (tail
);
11689 /* Switch to the buffer of selected window of the frame. Set up
11690 mode_line_target so that display_mode_element will output into
11691 mode_line_noprop_buf; then display the title. */
11692 record_unwind_protect (unwind_format_mode_line
,
11693 format_mode_line_unwind_data
11694 (f
, current_buffer
, selected_window
, false));
11696 Fselect_window (f
->selected_window
, Qt
);
11697 set_buffer_internal_1
11698 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11699 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11701 mode_line_target
= MODE_LINE_TITLE
;
11702 title_start
= MODE_LINE_NOPROP_LEN (0);
11703 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11704 NULL
, DEFAULT_FACE_ID
);
11705 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, false);
11706 len
= MODE_LINE_NOPROP_LEN (title_start
);
11707 title
= mode_line_noprop_buf
+ title_start
;
11708 unbind_to (count
, Qnil
);
11710 /* Set the title only if it's changed. This avoids consing in
11711 the common case where it hasn't. (If it turns out that we've
11712 already wasted too much time by walking through the list with
11713 display_mode_element, then we might need to optimize at a
11714 higher level than this.) */
11715 if (! STRINGP (f
->name
)
11716 || SBYTES (f
->name
) != len
11717 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11718 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11722 #endif /* not HAVE_WINDOW_SYSTEM */
11725 /***********************************************************************
11727 ***********************************************************************/
11729 /* True if we will not redisplay all visible windows. */
11730 #define REDISPLAY_SOME_P() \
11731 ((windows_or_buffers_changed == 0 \
11732 || windows_or_buffers_changed == REDISPLAY_SOME) \
11733 && (update_mode_lines == 0 \
11734 || update_mode_lines == REDISPLAY_SOME))
11736 /* Prepare for redisplay by updating menu-bar item lists when
11737 appropriate. This can call eval. */
11740 prepare_menu_bars (void)
11742 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11743 bool some_windows
= REDISPLAY_SOME_P ();
11744 Lisp_Object tooltip_frame
;
11746 #ifdef HAVE_WINDOW_SYSTEM
11747 tooltip_frame
= tip_frame
;
11749 tooltip_frame
= Qnil
;
11752 if (FUNCTIONP (Vpre_redisplay_function
))
11754 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11755 if (all_windows
&& some_windows
)
11757 Lisp_Object ws
= window_list ();
11758 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11760 Lisp_Object
this = XCAR (ws
);
11761 struct window
*w
= XWINDOW (this);
11763 || XFRAME (w
->frame
)->redisplay
11764 || XBUFFER (w
->contents
)->text
->redisplay
)
11766 windows
= Fcons (this, windows
);
11770 safe__call1 (true, Vpre_redisplay_function
, windows
);
11773 /* Update all frame titles based on their buffer names, etc. We do
11774 this before the menu bars so that the buffer-menu will show the
11775 up-to-date frame titles. */
11776 #ifdef HAVE_WINDOW_SYSTEM
11779 Lisp_Object tail
, frame
;
11781 FOR_EACH_FRAME (tail
, frame
)
11783 struct frame
*f
= XFRAME (frame
);
11784 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11788 && !XBUFFER (w
->contents
)->text
->redisplay
)
11791 if (!EQ (frame
, tooltip_frame
)
11792 && (FRAME_ICONIFIED_P (f
)
11793 || FRAME_VISIBLE_P (f
) == 1
11794 /* Exclude TTY frames that are obscured because they
11795 are not the top frame on their console. This is
11796 because x_consider_frame_title actually switches
11797 to the frame, which for TTY frames means it is
11798 marked as garbaged, and will be completely
11799 redrawn on the next redisplay cycle. This causes
11800 TTY frames to be completely redrawn, when there
11801 are more than one of them, even though nothing
11802 should be changed on display. */
11803 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11804 x_consider_frame_title (frame
);
11807 #endif /* HAVE_WINDOW_SYSTEM */
11809 /* Update the menu bar item lists, if appropriate. This has to be
11810 done before any actual redisplay or generation of display lines. */
11814 Lisp_Object tail
, frame
;
11815 ptrdiff_t count
= SPECPDL_INDEX ();
11816 /* True means that update_menu_bar has run its hooks
11817 so any further calls to update_menu_bar shouldn't do so again. */
11818 bool menu_bar_hooks_run
= false;
11820 record_unwind_save_match_data ();
11822 FOR_EACH_FRAME (tail
, frame
)
11824 struct frame
*f
= XFRAME (frame
);
11825 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11827 /* Ignore tooltip frame. */
11828 if (EQ (frame
, tooltip_frame
))
11834 && !XBUFFER (w
->contents
)->text
->redisplay
)
11837 run_window_size_change_functions (frame
);
11838 menu_bar_hooks_run
= update_menu_bar (f
, false, menu_bar_hooks_run
);
11839 #ifdef HAVE_WINDOW_SYSTEM
11840 update_tool_bar (f
, false);
11844 unbind_to (count
, Qnil
);
11848 struct frame
*sf
= SELECTED_FRAME ();
11849 update_menu_bar (sf
, true, false);
11850 #ifdef HAVE_WINDOW_SYSTEM
11851 update_tool_bar (sf
, true);
11857 /* Update the menu bar item list for frame F. This has to be done
11858 before we start to fill in any display lines, because it can call
11861 If SAVE_MATCH_DATA, we must save and restore it here.
11863 If HOOKS_RUN, a previous call to update_menu_bar
11864 already ran the menu bar hooks for this redisplay, so there
11865 is no need to run them again. The return value is the
11866 updated value of this flag, to pass to the next call. */
11869 update_menu_bar (struct frame
*f
, bool save_match_data
, bool hooks_run
)
11871 Lisp_Object window
;
11874 /* If called recursively during a menu update, do nothing. This can
11875 happen when, for instance, an activate-menubar-hook causes a
11877 if (inhibit_menubar_update
)
11880 window
= FRAME_SELECTED_WINDOW (f
);
11881 w
= XWINDOW (window
);
11883 if (FRAME_WINDOW_P (f
)
11885 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11886 || defined (HAVE_NS) || defined (USE_GTK)
11887 FRAME_EXTERNAL_MENU_BAR (f
)
11889 FRAME_MENU_BAR_LINES (f
) > 0
11891 : FRAME_MENU_BAR_LINES (f
) > 0)
11893 /* If the user has switched buffers or windows, we need to
11894 recompute to reflect the new bindings. But we'll
11895 recompute when update_mode_lines is set too; that means
11896 that people can use force-mode-line-update to request
11897 that the menu bar be recomputed. The adverse effect on
11898 the rest of the redisplay algorithm is about the same as
11899 windows_or_buffers_changed anyway. */
11900 if (windows_or_buffers_changed
11901 /* This used to test w->update_mode_line, but we believe
11902 there is no need to recompute the menu in that case. */
11903 || update_mode_lines
11904 || window_buffer_changed (w
))
11906 struct buffer
*prev
= current_buffer
;
11907 ptrdiff_t count
= SPECPDL_INDEX ();
11909 specbind (Qinhibit_menubar_update
, Qt
);
11911 set_buffer_internal_1 (XBUFFER (w
->contents
));
11912 if (save_match_data
)
11913 record_unwind_save_match_data ();
11914 if (NILP (Voverriding_local_map_menu_flag
))
11916 specbind (Qoverriding_terminal_local_map
, Qnil
);
11917 specbind (Qoverriding_local_map
, Qnil
);
11922 /* Run the Lucid hook. */
11923 safe_run_hooks (Qactivate_menubar_hook
);
11925 /* If it has changed current-menubar from previous value,
11926 really recompute the menu-bar from the value. */
11927 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11928 call0 (Qrecompute_lucid_menubar
);
11930 safe_run_hooks (Qmenu_bar_update_hook
);
11935 XSETFRAME (Vmenu_updating_frame
, f
);
11936 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11938 /* Redisplay the menu bar in case we changed it. */
11939 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11940 || defined (HAVE_NS) || defined (USE_GTK)
11941 if (FRAME_WINDOW_P (f
))
11943 #if defined (HAVE_NS)
11944 /* All frames on Mac OS share the same menubar. So only
11945 the selected frame should be allowed to set it. */
11946 if (f
== SELECTED_FRAME ())
11948 set_frame_menubar (f
, false, false);
11951 /* On a terminal screen, the menu bar is an ordinary screen
11952 line, and this makes it get updated. */
11953 w
->update_mode_line
= true;
11954 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11955 /* In the non-toolkit version, the menu bar is an ordinary screen
11956 line, and this makes it get updated. */
11957 w
->update_mode_line
= true;
11958 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11960 unbind_to (count
, Qnil
);
11961 set_buffer_internal_1 (prev
);
11968 /***********************************************************************
11970 ***********************************************************************/
11972 #ifdef HAVE_WINDOW_SYSTEM
11974 /* Select `frame' temporarily without running all the code in
11976 FIXME: Maybe do_switch_frame should be trimmed down similarly
11977 when `norecord' is set. */
11979 fast_set_selected_frame (Lisp_Object frame
)
11981 if (!EQ (selected_frame
, frame
))
11983 selected_frame
= frame
;
11984 selected_window
= XFRAME (frame
)->selected_window
;
11988 /* Update the tool-bar item list for frame F. This has to be done
11989 before we start to fill in any display lines. Called from
11990 prepare_menu_bars. If SAVE_MATCH_DATA, we must save
11991 and restore it here. */
11994 update_tool_bar (struct frame
*f
, bool save_match_data
)
11996 #if defined (USE_GTK) || defined (HAVE_NS)
11997 bool do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11999 bool do_update
= (WINDOWP (f
->tool_bar_window
)
12000 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0);
12005 Lisp_Object window
;
12008 window
= FRAME_SELECTED_WINDOW (f
);
12009 w
= XWINDOW (window
);
12011 /* If the user has switched buffers or windows, we need to
12012 recompute to reflect the new bindings. But we'll
12013 recompute when update_mode_lines is set too; that means
12014 that people can use force-mode-line-update to request
12015 that the menu bar be recomputed. The adverse effect on
12016 the rest of the redisplay algorithm is about the same as
12017 windows_or_buffers_changed anyway. */
12018 if (windows_or_buffers_changed
12019 || w
->update_mode_line
12020 || update_mode_lines
12021 || window_buffer_changed (w
))
12023 struct buffer
*prev
= current_buffer
;
12024 ptrdiff_t count
= SPECPDL_INDEX ();
12025 Lisp_Object frame
, new_tool_bar
;
12026 int new_n_tool_bar
;
12028 /* Set current_buffer to the buffer of the selected
12029 window of the frame, so that we get the right local
12031 set_buffer_internal_1 (XBUFFER (w
->contents
));
12033 /* Save match data, if we must. */
12034 if (save_match_data
)
12035 record_unwind_save_match_data ();
12037 /* Make sure that we don't accidentally use bogus keymaps. */
12038 if (NILP (Voverriding_local_map_menu_flag
))
12040 specbind (Qoverriding_terminal_local_map
, Qnil
);
12041 specbind (Qoverriding_local_map
, Qnil
);
12044 /* We must temporarily set the selected frame to this frame
12045 before calling tool_bar_items, because the calculation of
12046 the tool-bar keymap uses the selected frame (see
12047 `tool-bar-make-keymap' in tool-bar.el). */
12048 eassert (EQ (selected_window
,
12049 /* Since we only explicitly preserve selected_frame,
12050 check that selected_window would be redundant. */
12051 XFRAME (selected_frame
)->selected_window
));
12052 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
12053 XSETFRAME (frame
, f
);
12054 fast_set_selected_frame (frame
);
12056 /* Build desired tool-bar items from keymaps. */
12058 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
12061 /* Redisplay the tool-bar if we changed it. */
12062 if (new_n_tool_bar
!= f
->n_tool_bar_items
12063 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
12065 /* Redisplay that happens asynchronously due to an expose event
12066 may access f->tool_bar_items. Make sure we update both
12067 variables within BLOCK_INPUT so no such event interrupts. */
12069 fset_tool_bar_items (f
, new_tool_bar
);
12070 f
->n_tool_bar_items
= new_n_tool_bar
;
12071 w
->update_mode_line
= true;
12075 unbind_to (count
, Qnil
);
12076 set_buffer_internal_1 (prev
);
12081 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12083 /* Set F->desired_tool_bar_string to a Lisp string representing frame
12084 F's desired tool-bar contents. F->tool_bar_items must have
12085 been set up previously by calling prepare_menu_bars. */
12088 build_desired_tool_bar_string (struct frame
*f
)
12090 int i
, size
, size_needed
;
12091 Lisp_Object image
, plist
;
12093 image
= plist
= Qnil
;
12095 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
12096 Otherwise, make a new string. */
12098 /* The size of the string we might be able to reuse. */
12099 size
= (STRINGP (f
->desired_tool_bar_string
)
12100 ? SCHARS (f
->desired_tool_bar_string
)
12103 /* We need one space in the string for each image. */
12104 size_needed
= f
->n_tool_bar_items
;
12106 /* Reuse f->desired_tool_bar_string, if possible. */
12107 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
12108 fset_desired_tool_bar_string
12109 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
12112 AUTO_LIST4 (props
, Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
12113 Fremove_text_properties (make_number (0), make_number (size
),
12114 props
, f
->desired_tool_bar_string
);
12117 /* Put a `display' property on the string for the images to display,
12118 put a `menu_item' property on tool-bar items with a value that
12119 is the index of the item in F's tool-bar item vector. */
12120 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
12122 #define PROP(IDX) \
12123 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
12125 bool enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
12126 bool selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
12127 int hmargin
, vmargin
, relief
, idx
, end
;
12129 /* If image is a vector, choose the image according to the
12131 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
12132 if (VECTORP (image
))
12136 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12137 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
12140 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12141 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
12143 eassert (ASIZE (image
) >= idx
);
12144 image
= AREF (image
, idx
);
12149 /* Ignore invalid image specifications. */
12150 if (!valid_image_p (image
))
12153 /* Display the tool-bar button pressed, or depressed. */
12154 plist
= Fcopy_sequence (XCDR (image
));
12156 /* Compute margin and relief to draw. */
12157 relief
= (tool_bar_button_relief
>= 0
12158 ? tool_bar_button_relief
12159 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12160 hmargin
= vmargin
= relief
;
12162 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12163 INT_MAX
- max (hmargin
, vmargin
)))
12165 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12166 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12168 else if (CONSP (Vtool_bar_button_margin
))
12170 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12171 INT_MAX
- hmargin
))
12172 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12174 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12175 INT_MAX
- vmargin
))
12176 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12179 if (auto_raise_tool_bar_buttons_p
)
12181 /* Add a `:relief' property to the image spec if the item is
12185 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12192 /* If image is selected, display it pressed, i.e. with a
12193 negative relief. If it's not selected, display it with a
12195 plist
= Fplist_put (plist
, QCrelief
,
12197 ? make_number (-relief
)
12198 : make_number (relief
)));
12203 /* Put a margin around the image. */
12204 if (hmargin
|| vmargin
)
12206 if (hmargin
== vmargin
)
12207 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12209 plist
= Fplist_put (plist
, QCmargin
,
12210 Fcons (make_number (hmargin
),
12211 make_number (vmargin
)));
12214 /* If button is not enabled, and we don't have special images
12215 for the disabled state, make the image appear disabled by
12216 applying an appropriate algorithm to it. */
12217 if (!enabled_p
&& idx
< 0)
12218 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12220 /* Put a `display' text property on the string for the image to
12221 display. Put a `menu-item' property on the string that gives
12222 the start of this item's properties in the tool-bar items
12224 image
= Fcons (Qimage
, plist
);
12225 AUTO_LIST4 (props
, Qdisplay
, image
, Qmenu_item
,
12226 make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12228 /* Let the last image hide all remaining spaces in the tool bar
12229 string. The string can be longer than needed when we reuse a
12230 previous string. */
12231 if (i
+ 1 == f
->n_tool_bar_items
)
12232 end
= SCHARS (f
->desired_tool_bar_string
);
12235 Fadd_text_properties (make_number (i
), make_number (end
),
12236 props
, f
->desired_tool_bar_string
);
12242 /* Display one line of the tool-bar of frame IT->f.
12244 HEIGHT specifies the desired height of the tool-bar line.
12245 If the actual height of the glyph row is less than HEIGHT, the
12246 row's height is increased to HEIGHT, and the icons are centered
12247 vertically in the new height.
12249 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12250 count a final empty row in case the tool-bar width exactly matches
12255 display_tool_bar_line (struct it
*it
, int height
)
12257 struct glyph_row
*row
= it
->glyph_row
;
12258 int max_x
= it
->last_visible_x
;
12259 struct glyph
*last
;
12261 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12262 clear_glyph_row (row
);
12263 row
->enabled_p
= true;
12264 row
->y
= it
->current_y
;
12266 /* Note that this isn't made use of if the face hasn't a box,
12267 so there's no need to check the face here. */
12268 it
->start_of_box_run_p
= true;
12270 while (it
->current_x
< max_x
)
12272 int x
, n_glyphs_before
, i
, nglyphs
;
12273 struct it it_before
;
12275 /* Get the next display element. */
12276 if (!get_next_display_element (it
))
12278 /* Don't count empty row if we are counting needed tool-bar lines. */
12279 if (height
< 0 && !it
->hpos
)
12284 /* Produce glyphs. */
12285 n_glyphs_before
= row
->used
[TEXT_AREA
];
12288 PRODUCE_GLYPHS (it
);
12290 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12292 x
= it_before
.current_x
;
12293 while (i
< nglyphs
)
12295 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12297 if (x
+ glyph
->pixel_width
> max_x
)
12299 /* Glyph doesn't fit on line. Backtrack. */
12300 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12302 /* If this is the only glyph on this line, it will never fit on the
12303 tool-bar, so skip it. But ensure there is at least one glyph,
12304 so we don't accidentally disable the tool-bar. */
12305 if (n_glyphs_before
== 0
12306 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12312 x
+= glyph
->pixel_width
;
12316 /* Stop at line end. */
12317 if (ITERATOR_AT_END_OF_LINE_P (it
))
12320 set_iterator_to_next (it
, true);
12325 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12327 /* Use default face for the border below the tool bar.
12329 FIXME: When auto-resize-tool-bars is grow-only, there is
12330 no additional border below the possibly empty tool-bar lines.
12331 So to make the extra empty lines look "normal", we have to
12332 use the tool-bar face for the border too. */
12333 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12334 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12335 it
->face_id
= DEFAULT_FACE_ID
;
12337 extend_face_to_end_of_line (it
);
12338 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12339 last
->right_box_line_p
= true;
12340 if (last
== row
->glyphs
[TEXT_AREA
])
12341 last
->left_box_line_p
= true;
12343 /* Make line the desired height and center it vertically. */
12344 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12346 /* Don't add more than one line height. */
12347 height
%= FRAME_LINE_HEIGHT (it
->f
);
12348 it
->max_ascent
+= height
/ 2;
12349 it
->max_descent
+= (height
+ 1) / 2;
12352 compute_line_metrics (it
);
12354 /* If line is empty, make it occupy the rest of the tool-bar. */
12355 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12357 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12358 row
->visible_height
= row
->height
;
12359 row
->ascent
= row
->phys_ascent
= 0;
12360 row
->extra_line_spacing
= 0;
12363 row
->full_width_p
= true;
12364 row
->continued_p
= false;
12365 row
->truncated_on_left_p
= false;
12366 row
->truncated_on_right_p
= false;
12368 it
->current_x
= it
->hpos
= 0;
12369 it
->current_y
+= row
->height
;
12375 /* Value is the number of pixels needed to make all tool-bar items of
12376 frame F visible. The actual number of glyph rows needed is
12377 returned in *N_ROWS if non-NULL. */
12379 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12381 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12383 /* tool_bar_height is called from redisplay_tool_bar after building
12384 the desired matrix, so use (unused) mode-line row as temporary row to
12385 avoid destroying the first tool-bar row. */
12386 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12388 /* Initialize an iterator for iteration over
12389 F->desired_tool_bar_string in the tool-bar window of frame F. */
12390 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12391 temp_row
->reversed_p
= false;
12392 it
.first_visible_x
= 0;
12393 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12394 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12395 it
.paragraph_embedding
= L2R
;
12397 while (!ITERATOR_AT_END_P (&it
))
12399 clear_glyph_row (temp_row
);
12400 it
.glyph_row
= temp_row
;
12401 display_tool_bar_line (&it
, -1);
12403 clear_glyph_row (temp_row
);
12405 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12407 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12410 return it
.current_y
;
12412 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12415 #endif /* !USE_GTK && !HAVE_NS */
12417 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12419 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12420 If FRAME is nil or omitted, use the selected frame. Optional argument
12421 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12422 (Lisp_Object frame
, Lisp_Object pixelwise
)
12426 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12427 struct frame
*f
= decode_any_frame (frame
);
12429 if (WINDOWP (f
->tool_bar_window
)
12430 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12432 update_tool_bar (f
, true);
12433 if (f
->n_tool_bar_items
)
12435 build_desired_tool_bar_string (f
);
12436 height
= tool_bar_height (f
, NULL
, !NILP (pixelwise
));
12441 return make_number (height
);
12445 /* Display the tool-bar of frame F. Value is true if tool-bar's
12446 height should be changed. */
12448 redisplay_tool_bar (struct frame
*f
)
12450 f
->tool_bar_redisplayed
= true;
12451 #if defined (USE_GTK) || defined (HAVE_NS)
12453 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12454 update_frame_tool_bar (f
);
12457 #else /* !USE_GTK && !HAVE_NS */
12461 struct glyph_row
*row
;
12463 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12464 do anything. This means you must start with tool-bar-lines
12465 non-zero to get the auto-sizing effect. Or in other words, you
12466 can turn off tool-bars by specifying tool-bar-lines zero. */
12467 if (!WINDOWP (f
->tool_bar_window
)
12468 || (w
= XWINDOW (f
->tool_bar_window
),
12469 WINDOW_TOTAL_LINES (w
) == 0))
12472 /* Set up an iterator for the tool-bar window. */
12473 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12474 it
.first_visible_x
= 0;
12475 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12476 row
= it
.glyph_row
;
12477 row
->reversed_p
= false;
12479 /* Build a string that represents the contents of the tool-bar. */
12480 build_desired_tool_bar_string (f
);
12481 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12482 /* FIXME: This should be controlled by a user option. But it
12483 doesn't make sense to have an R2L tool bar if the menu bar cannot
12484 be drawn also R2L, and making the menu bar R2L is tricky due
12485 toolkit-specific code that implements it. If an R2L tool bar is
12486 ever supported, display_tool_bar_line should also be augmented to
12487 call unproduce_glyphs like display_line and display_string
12489 it
.paragraph_embedding
= L2R
;
12491 if (f
->n_tool_bar_rows
== 0)
12493 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, true);
12495 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12497 x_change_tool_bar_height (f
, new_height
);
12498 frame_default_tool_bar_height
= new_height
;
12499 /* Always do that now. */
12500 clear_glyph_matrix (w
->desired_matrix
);
12501 f
->fonts_changed
= true;
12506 /* Display as many lines as needed to display all tool-bar items. */
12508 if (f
->n_tool_bar_rows
> 0)
12510 int border
, rows
, height
, extra
;
12512 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12513 border
= XINT (Vtool_bar_border
);
12514 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12515 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12516 else if (EQ (Vtool_bar_border
, Qborder_width
))
12517 border
= f
->border_width
;
12523 rows
= f
->n_tool_bar_rows
;
12524 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12525 extra
= it
.last_visible_y
- border
- height
* rows
;
12527 while (it
.current_y
< it
.last_visible_y
)
12530 if (extra
> 0 && rows
-- > 0)
12532 h
= (extra
+ rows
- 1) / rows
;
12535 display_tool_bar_line (&it
, height
+ h
);
12540 while (it
.current_y
< it
.last_visible_y
)
12541 display_tool_bar_line (&it
, 0);
12544 /* It doesn't make much sense to try scrolling in the tool-bar
12545 window, so don't do it. */
12546 w
->desired_matrix
->no_scrolling_p
= true;
12547 w
->must_be_updated_p
= true;
12549 if (!NILP (Vauto_resize_tool_bars
))
12551 bool change_height_p
= true;
12553 /* If we couldn't display everything, change the tool-bar's
12554 height if there is room for more. */
12555 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
12556 change_height_p
= true;
12558 /* We subtract 1 because display_tool_bar_line advances the
12559 glyph_row pointer before returning to its caller. We want to
12560 examine the last glyph row produced by
12561 display_tool_bar_line. */
12562 row
= it
.glyph_row
- 1;
12564 /* If there are blank lines at the end, except for a partially
12565 visible blank line at the end that is smaller than
12566 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12567 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12568 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12569 change_height_p
= true;
12571 /* If row displays tool-bar items, but is partially visible,
12572 change the tool-bar's height. */
12573 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12574 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
12575 change_height_p
= true;
12577 /* Resize windows as needed by changing the `tool-bar-lines'
12578 frame parameter. */
12579 if (change_height_p
)
12582 int new_height
= tool_bar_height (f
, &nrows
, true);
12584 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12585 && !f
->minimize_tool_bar_window_p
)
12586 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12587 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12588 f
->minimize_tool_bar_window_p
= false;
12590 if (change_height_p
)
12592 x_change_tool_bar_height (f
, new_height
);
12593 frame_default_tool_bar_height
= new_height
;
12594 clear_glyph_matrix (w
->desired_matrix
);
12595 f
->n_tool_bar_rows
= nrows
;
12596 f
->fonts_changed
= true;
12603 f
->minimize_tool_bar_window_p
= false;
12606 #endif /* USE_GTK || HAVE_NS */
12609 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12611 /* Get information about the tool-bar item which is displayed in GLYPH
12612 on frame F. Return in *PROP_IDX the index where tool-bar item
12613 properties start in F->tool_bar_items. Value is false if
12614 GLYPH doesn't display a tool-bar item. */
12617 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12622 /* This function can be called asynchronously, which means we must
12623 exclude any possibility that Fget_text_property signals an
12625 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12626 charpos
= max (0, charpos
);
12628 /* Get the text property `menu-item' at pos. The value of that
12629 property is the start index of this item's properties in
12630 F->tool_bar_items. */
12631 prop
= Fget_text_property (make_number (charpos
),
12632 Qmenu_item
, f
->current_tool_bar_string
);
12633 if (! INTEGERP (prop
))
12635 *prop_idx
= XINT (prop
);
12640 /* Get information about the tool-bar item at position X/Y on frame F.
12641 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12642 the current matrix of the tool-bar window of F, or NULL if not
12643 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12644 item in F->tool_bar_items. Value is
12646 -1 if X/Y is not on a tool-bar item
12647 0 if X/Y is on the same item that was highlighted before.
12651 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12652 int *hpos
, int *vpos
, int *prop_idx
)
12654 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12655 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12658 /* Find the glyph under X/Y. */
12659 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12660 if (*glyph
== NULL
)
12663 /* Get the start of this tool-bar item's properties in
12664 f->tool_bar_items. */
12665 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12668 /* Is mouse on the highlighted item? */
12669 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12670 && *vpos
>= hlinfo
->mouse_face_beg_row
12671 && *vpos
<= hlinfo
->mouse_face_end_row
12672 && (*vpos
> hlinfo
->mouse_face_beg_row
12673 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12674 && (*vpos
< hlinfo
->mouse_face_end_row
12675 || *hpos
< hlinfo
->mouse_face_end_col
12676 || hlinfo
->mouse_face_past_end
))
12684 Handle mouse button event on the tool-bar of frame F, at
12685 frame-relative coordinates X/Y. DOWN_P is true for a button press,
12686 false for button release. MODIFIERS is event modifiers for button
12690 handle_tool_bar_click (struct frame
*f
, int x
, int y
, bool down_p
,
12693 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12694 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12695 int hpos
, vpos
, prop_idx
;
12696 struct glyph
*glyph
;
12697 Lisp_Object enabled_p
;
12700 /* If not on the highlighted tool-bar item, and mouse-highlight is
12701 non-nil, return. This is so we generate the tool-bar button
12702 click only when the mouse button is released on the same item as
12703 where it was pressed. However, when mouse-highlight is disabled,
12704 generate the click when the button is released regardless of the
12705 highlight, since tool-bar items are not highlighted in that
12707 frame_to_window_pixel_xy (w
, &x
, &y
);
12708 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12710 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12713 /* When mouse-highlight is off, generate the click for the item
12714 where the button was pressed, disregarding where it was
12716 if (NILP (Vmouse_highlight
) && !down_p
)
12717 prop_idx
= f
->last_tool_bar_item
;
12719 /* If item is disabled, do nothing. */
12720 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12721 if (NILP (enabled_p
))
12726 /* Show item in pressed state. */
12727 if (!NILP (Vmouse_highlight
))
12728 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12729 f
->last_tool_bar_item
= prop_idx
;
12733 Lisp_Object key
, frame
;
12734 struct input_event event
;
12735 EVENT_INIT (event
);
12737 /* Show item in released state. */
12738 if (!NILP (Vmouse_highlight
))
12739 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12741 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12743 XSETFRAME (frame
, f
);
12744 event
.kind
= TOOL_BAR_EVENT
;
12745 event
.frame_or_window
= frame
;
12747 kbd_buffer_store_event (&event
);
12749 event
.kind
= TOOL_BAR_EVENT
;
12750 event
.frame_or_window
= frame
;
12752 event
.modifiers
= modifiers
;
12753 kbd_buffer_store_event (&event
);
12754 f
->last_tool_bar_item
= -1;
12759 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12760 tool-bar window-relative coordinates X/Y. Called from
12761 note_mouse_highlight. */
12764 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12766 Lisp_Object window
= f
->tool_bar_window
;
12767 struct window
*w
= XWINDOW (window
);
12768 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12769 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12771 struct glyph
*glyph
;
12772 struct glyph_row
*row
;
12774 Lisp_Object enabled_p
;
12776 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12780 /* Function note_mouse_highlight is called with negative X/Y
12781 values when mouse moves outside of the frame. */
12782 if (x
<= 0 || y
<= 0)
12784 clear_mouse_face (hlinfo
);
12788 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12791 /* Not on tool-bar item. */
12792 clear_mouse_face (hlinfo
);
12796 /* On same tool-bar item as before. */
12797 goto set_help_echo
;
12799 clear_mouse_face (hlinfo
);
12801 /* Mouse is down, but on different tool-bar item? */
12802 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12803 && f
== dpyinfo
->last_mouse_frame
);
12805 if (mouse_down_p
&& f
->last_tool_bar_item
!= prop_idx
)
12808 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12810 /* If tool-bar item is not enabled, don't highlight it. */
12811 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12812 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12814 /* Compute the x-position of the glyph. In front and past the
12815 image is a space. We include this in the highlighted area. */
12816 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12817 for (i
= x
= 0; i
< hpos
; ++i
)
12818 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12820 /* Record this as the current active region. */
12821 hlinfo
->mouse_face_beg_col
= hpos
;
12822 hlinfo
->mouse_face_beg_row
= vpos
;
12823 hlinfo
->mouse_face_beg_x
= x
;
12824 hlinfo
->mouse_face_past_end
= false;
12826 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12827 hlinfo
->mouse_face_end_row
= vpos
;
12828 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12829 hlinfo
->mouse_face_window
= window
;
12830 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12832 /* Display it as active. */
12833 show_mouse_face (hlinfo
, draw
);
12838 /* Set help_echo_string to a help string to display for this tool-bar item.
12839 XTread_socket does the rest. */
12840 help_echo_object
= help_echo_window
= Qnil
;
12841 help_echo_pos
= -1;
12842 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12843 if (NILP (help_echo_string
))
12844 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12847 #endif /* !USE_GTK && !HAVE_NS */
12849 #endif /* HAVE_WINDOW_SYSTEM */
12853 /************************************************************************
12854 Horizontal scrolling
12855 ************************************************************************/
12857 /* For all leaf windows in the window tree rooted at WINDOW, set their
12858 hscroll value so that PT is (i) visible in the window, and (ii) so
12859 that it is not within a certain margin at the window's left and
12860 right border. Value is true if any window's hscroll has been
12864 hscroll_window_tree (Lisp_Object window
)
12866 bool hscrolled_p
= false;
12867 bool hscroll_relative_p
= FLOATP (Vhscroll_step
);
12868 int hscroll_step_abs
= 0;
12869 double hscroll_step_rel
= 0;
12871 if (hscroll_relative_p
)
12873 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12874 if (hscroll_step_rel
< 0)
12876 hscroll_relative_p
= false;
12877 hscroll_step_abs
= 0;
12880 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12882 hscroll_step_abs
= XINT (Vhscroll_step
);
12883 if (hscroll_step_abs
< 0)
12884 hscroll_step_abs
= 0;
12887 hscroll_step_abs
= 0;
12889 while (WINDOWP (window
))
12891 struct window
*w
= XWINDOW (window
);
12893 if (WINDOWP (w
->contents
))
12894 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12895 else if (w
->cursor
.vpos
>= 0)
12898 int text_area_width
;
12899 struct glyph_row
*cursor_row
;
12900 struct glyph_row
*bottom_row
;
12902 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12903 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12904 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12906 cursor_row
= bottom_row
- 1;
12908 if (!cursor_row
->enabled_p
)
12910 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12911 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12912 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12914 cursor_row
= bottom_row
- 1;
12916 bool row_r2l_p
= cursor_row
->reversed_p
;
12918 text_area_width
= window_box_width (w
, TEXT_AREA
);
12920 /* Scroll when cursor is inside this scroll margin. */
12921 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12923 /* If the position of this window's point has explicitly
12924 changed, no more suspend auto hscrolling. */
12925 if (NILP (Fequal (Fwindow_point (window
), Fwindow_old_point (window
))))
12926 w
->suspend_auto_hscroll
= false;
12928 /* Remember window point. */
12929 Fset_marker (w
->old_pointm
,
12930 ((w
== XWINDOW (selected_window
))
12931 ? make_number (BUF_PT (XBUFFER (w
->contents
)))
12932 : Fmarker_position (w
->pointm
)),
12935 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12936 && !w
->suspend_auto_hscroll
12937 /* In some pathological cases, like restoring a window
12938 configuration into a frame that is much smaller than
12939 the one from which the configuration was saved, we
12940 get glyph rows whose start and end have zero buffer
12941 positions, which we cannot handle below. Just skip
12943 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12944 /* For left-to-right rows, hscroll when cursor is either
12945 (i) inside the right hscroll margin, or (ii) if it is
12946 inside the left margin and the window is already
12949 && ((w
->hscroll
&& w
->cursor
.x
<= h_margin
)
12950 || (cursor_row
->enabled_p
12951 && cursor_row
->truncated_on_right_p
12952 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12953 /* For right-to-left rows, the logic is similar,
12954 except that rules for scrolling to left and right
12955 are reversed. E.g., if cursor.x <= h_margin, we
12956 need to hscroll "to the right" unconditionally,
12957 and that will scroll the screen to the left so as
12958 to reveal the next portion of the row. */
12960 && ((cursor_row
->enabled_p
12961 /* FIXME: It is confusing to set the
12962 truncated_on_right_p flag when R2L rows
12963 are actually truncated on the left. */
12964 && cursor_row
->truncated_on_right_p
12965 && w
->cursor
.x
<= h_margin
)
12967 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12971 struct buffer
*saved_current_buffer
;
12975 /* Find point in a display of infinite width. */
12976 saved_current_buffer
= current_buffer
;
12977 current_buffer
= XBUFFER (w
->contents
);
12979 if (w
== XWINDOW (selected_window
))
12982 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12984 /* Move iterator to pt starting at cursor_row->start in
12985 a line with infinite width. */
12986 init_to_row_start (&it
, w
, cursor_row
);
12987 it
.last_visible_x
= INFINITY
;
12988 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12989 current_buffer
= saved_current_buffer
;
12991 /* Position cursor in window. */
12992 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12993 hscroll
= max (0, (it
.current_x
12994 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12995 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12996 : (text_area_width
/ 2))))
12997 / FRAME_COLUMN_WIDTH (it
.f
);
12998 else if ((!row_r2l_p
12999 && w
->cursor
.x
>= text_area_width
- h_margin
)
13000 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
13002 if (hscroll_relative_p
)
13003 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
13006 wanted_x
= text_area_width
13007 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
13010 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
13014 if (hscroll_relative_p
)
13015 wanted_x
= text_area_width
* hscroll_step_rel
13018 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
13021 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
13023 hscroll
= max (hscroll
, w
->min_hscroll
);
13025 /* Don't prevent redisplay optimizations if hscroll
13026 hasn't changed, as it will unnecessarily slow down
13028 if (w
->hscroll
!= hscroll
)
13030 struct buffer
*b
= XBUFFER (w
->contents
);
13031 b
->prevent_redisplay_optimizations_p
= true;
13032 w
->hscroll
= hscroll
;
13033 hscrolled_p
= true;
13041 /* Value is true if hscroll of any leaf window has been changed. */
13042 return hscrolled_p
;
13046 /* Set hscroll so that cursor is visible and not inside horizontal
13047 scroll margins for all windows in the tree rooted at WINDOW. See
13048 also hscroll_window_tree above. Value is true if any window's
13049 hscroll has been changed. If it has, desired matrices on the frame
13050 of WINDOW are cleared. */
13053 hscroll_windows (Lisp_Object window
)
13055 bool hscrolled_p
= hscroll_window_tree (window
);
13057 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
13058 return hscrolled_p
;
13063 /************************************************************************
13065 ************************************************************************/
13067 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined.
13068 This is sometimes handy to have in a debugger session. */
13072 /* First and last unchanged row for try_window_id. */
13074 static int debug_first_unchanged_at_end_vpos
;
13075 static int debug_last_unchanged_at_beg_vpos
;
13077 /* Delta vpos and y. */
13079 static int debug_dvpos
, debug_dy
;
13081 /* Delta in characters and bytes for try_window_id. */
13083 static ptrdiff_t debug_delta
, debug_delta_bytes
;
13085 /* Values of window_end_pos and window_end_vpos at the end of
13088 static ptrdiff_t debug_end_vpos
;
13090 /* Append a string to W->desired_matrix->method. FMT is a printf
13091 format string. If trace_redisplay_p is true also printf the
13092 resulting string to stderr. */
13094 static void debug_method_add (struct window
*, char const *, ...)
13095 ATTRIBUTE_FORMAT_PRINTF (2, 3);
13098 debug_method_add (struct window
*w
, char const *fmt
, ...)
13101 char *method
= w
->desired_matrix
->method
;
13102 int len
= strlen (method
);
13103 int size
= sizeof w
->desired_matrix
->method
;
13104 int remaining
= size
- len
- 1;
13107 if (len
&& remaining
)
13110 --remaining
, ++len
;
13113 va_start (ap
, fmt
);
13114 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
13117 if (trace_redisplay_p
)
13118 fprintf (stderr
, "%p (%s): %s\n",
13120 ((BUFFERP (w
->contents
)
13121 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
13122 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13127 #endif /* GLYPH_DEBUG */
13130 /* Value is true if all changes in window W, which displays
13131 current_buffer, are in the text between START and END. START is a
13132 buffer position, END is given as a distance from Z. Used in
13133 redisplay_internal for display optimization. */
13136 text_outside_line_unchanged_p (struct window
*w
,
13137 ptrdiff_t start
, ptrdiff_t end
)
13139 bool unchanged_p
= true;
13141 /* If text or overlays have changed, see where. */
13142 if (window_outdated (w
))
13144 /* Gap in the line? */
13145 if (GPT
< start
|| Z
- GPT
< end
)
13146 unchanged_p
= false;
13148 /* Changes start in front of the line, or end after it? */
13150 && (BEG_UNCHANGED
< start
- 1
13151 || END_UNCHANGED
< end
))
13152 unchanged_p
= false;
13154 /* If selective display, can't optimize if changes start at the
13155 beginning of the line. */
13157 && INTEGERP (BVAR (current_buffer
, selective_display
))
13158 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13159 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13160 unchanged_p
= false;
13162 /* If there are overlays at the start or end of the line, these
13163 may have overlay strings with newlines in them. A change at
13164 START, for instance, may actually concern the display of such
13165 overlay strings as well, and they are displayed on different
13166 lines. So, quickly rule out this case. (For the future, it
13167 might be desirable to implement something more telling than
13168 just BEG/END_UNCHANGED.) */
13171 if (BEG
+ BEG_UNCHANGED
== start
13172 && overlay_touches_p (start
))
13173 unchanged_p
= false;
13174 if (END_UNCHANGED
== end
13175 && overlay_touches_p (Z
- end
))
13176 unchanged_p
= false;
13179 /* Under bidi reordering, adding or deleting a character in the
13180 beginning of a paragraph, before the first strong directional
13181 character, can change the base direction of the paragraph (unless
13182 the buffer specifies a fixed paragraph direction), which will
13183 require redisplaying the whole paragraph. It might be worthwhile
13184 to find the paragraph limits and widen the range of redisplayed
13185 lines to that, but for now just give up this optimization. */
13186 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13187 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13188 unchanged_p
= false;
13191 return unchanged_p
;
13195 /* Do a frame update, taking possible shortcuts into account. This is
13196 the main external entry point for redisplay.
13198 If the last redisplay displayed an echo area message and that message
13199 is no longer requested, we clear the echo area or bring back the
13200 mini-buffer if that is in use. */
13205 redisplay_internal ();
13210 overlay_arrow_string_or_property (Lisp_Object var
)
13214 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13217 return Voverlay_arrow_string
;
13220 /* Return true if there are any overlay-arrows in current_buffer. */
13222 overlay_arrow_in_current_buffer_p (void)
13226 for (vlist
= Voverlay_arrow_variable_list
;
13228 vlist
= XCDR (vlist
))
13230 Lisp_Object var
= XCAR (vlist
);
13233 if (!SYMBOLP (var
))
13235 val
= find_symbol_value (var
);
13237 && current_buffer
== XMARKER (val
)->buffer
)
13244 /* Return true if any overlay_arrows have moved or overlay-arrow-string
13248 overlay_arrows_changed_p (void)
13252 for (vlist
= Voverlay_arrow_variable_list
;
13254 vlist
= XCDR (vlist
))
13256 Lisp_Object var
= XCAR (vlist
);
13257 Lisp_Object val
, pstr
;
13259 if (!SYMBOLP (var
))
13261 val
= find_symbol_value (var
);
13262 if (!MARKERP (val
))
13264 if (! EQ (COERCE_MARKER (val
),
13265 Fget (var
, Qlast_arrow_position
))
13266 || ! (pstr
= overlay_arrow_string_or_property (var
),
13267 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13273 /* Mark overlay arrows to be updated on next redisplay. */
13276 update_overlay_arrows (int up_to_date
)
13280 for (vlist
= Voverlay_arrow_variable_list
;
13282 vlist
= XCDR (vlist
))
13284 Lisp_Object var
= XCAR (vlist
);
13286 if (!SYMBOLP (var
))
13289 if (up_to_date
> 0)
13291 Lisp_Object val
= find_symbol_value (var
);
13292 Fput (var
, Qlast_arrow_position
,
13293 COERCE_MARKER (val
));
13294 Fput (var
, Qlast_arrow_string
,
13295 overlay_arrow_string_or_property (var
));
13297 else if (up_to_date
< 0
13298 || !NILP (Fget (var
, Qlast_arrow_position
)))
13300 Fput (var
, Qlast_arrow_position
, Qt
);
13301 Fput (var
, Qlast_arrow_string
, Qt
);
13307 /* Return overlay arrow string to display at row.
13308 Return integer (bitmap number) for arrow bitmap in left fringe.
13309 Return nil if no overlay arrow. */
13312 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13316 for (vlist
= Voverlay_arrow_variable_list
;
13318 vlist
= XCDR (vlist
))
13320 Lisp_Object var
= XCAR (vlist
);
13323 if (!SYMBOLP (var
))
13326 val
= find_symbol_value (var
);
13329 && current_buffer
== XMARKER (val
)->buffer
13330 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13332 if (FRAME_WINDOW_P (it
->f
)
13333 /* FIXME: if ROW->reversed_p is set, this should test
13334 the right fringe, not the left one. */
13335 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13337 #ifdef HAVE_WINDOW_SYSTEM
13338 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13340 int fringe_bitmap
= lookup_fringe_bitmap (val
);
13341 if (fringe_bitmap
!= 0)
13342 return make_number (fringe_bitmap
);
13345 return make_number (-1); /* Use default arrow bitmap. */
13347 return overlay_arrow_string_or_property (var
);
13354 /* Return true if point moved out of or into a composition. Otherwise
13355 return false. PREV_BUF and PREV_PT are the last point buffer and
13356 position. BUF and PT are the current point buffer and position. */
13359 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13360 struct buffer
*buf
, ptrdiff_t pt
)
13362 ptrdiff_t start
, end
;
13364 Lisp_Object buffer
;
13366 XSETBUFFER (buffer
, buf
);
13367 /* Check a composition at the last point if point moved within the
13369 if (prev_buf
== buf
)
13372 /* Point didn't move. */
13375 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13376 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13377 && composition_valid_p (start
, end
, prop
)
13378 && start
< prev_pt
&& end
> prev_pt
)
13379 /* The last point was within the composition. Return true iff
13380 point moved out of the composition. */
13381 return (pt
<= start
|| pt
>= end
);
13384 /* Check a composition at the current point. */
13385 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13386 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13387 && composition_valid_p (start
, end
, prop
)
13388 && start
< pt
&& end
> pt
);
13391 /* Reconsider the clip changes of buffer which is displayed in W. */
13394 reconsider_clip_changes (struct window
*w
)
13396 struct buffer
*b
= XBUFFER (w
->contents
);
13398 if (b
->clip_changed
13399 && w
->window_end_valid
13400 && w
->current_matrix
->buffer
== b
13401 && w
->current_matrix
->zv
== BUF_ZV (b
)
13402 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13403 b
->clip_changed
= false;
13405 /* If display wasn't paused, and W is not a tool bar window, see if
13406 point has been moved into or out of a composition. In that case,
13407 set b->clip_changed to force updating the screen. If
13408 b->clip_changed has already been set, skip this check. */
13409 if (!b
->clip_changed
&& w
->window_end_valid
)
13411 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13412 ? PT
: marker_position (w
->pointm
));
13414 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13415 && check_point_in_composition (w
->current_matrix
->buffer
,
13416 w
->last_point
, b
, pt
))
13417 b
->clip_changed
= true;
13422 propagate_buffer_redisplay (void)
13423 { /* Resetting b->text->redisplay is problematic!
13424 We can't just reset it in the case that some window that displays
13425 it has not been redisplayed; and such a window can stay
13426 unredisplayed for a long time if it's currently invisible.
13427 But we do want to reset it at the end of redisplay otherwise
13428 its displayed windows will keep being redisplayed over and over
13430 So we copy all b->text->redisplay flags up to their windows here,
13431 such that mark_window_display_accurate can safely reset
13432 b->text->redisplay. */
13433 Lisp_Object ws
= window_list ();
13434 for (; CONSP (ws
); ws
= XCDR (ws
))
13436 struct window
*thisw
= XWINDOW (XCAR (ws
));
13437 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13438 if (thisb
->text
->redisplay
)
13439 thisw
->redisplay
= true;
13443 #define STOP_POLLING \
13444 do { if (! polling_stopped_here) stop_polling (); \
13445 polling_stopped_here = true; } while (false)
13447 #define RESUME_POLLING \
13448 do { if (polling_stopped_here) start_polling (); \
13449 polling_stopped_here = false; } while (false)
13452 /* Perhaps in the future avoid recentering windows if it
13453 is not necessary; currently that causes some problems. */
13456 redisplay_internal (void)
13458 struct window
*w
= XWINDOW (selected_window
);
13462 bool must_finish
= false, match_p
;
13463 struct text_pos tlbufpos
, tlendpos
;
13464 int number_of_visible_frames
;
13467 bool polling_stopped_here
= false;
13468 Lisp_Object tail
, frame
;
13470 /* True means redisplay has to consider all windows on all
13471 frames. False, only selected_window is considered. */
13472 bool consider_all_windows_p
;
13474 /* True means redisplay has to redisplay the miniwindow. */
13475 bool update_miniwindow_p
= false;
13477 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13479 /* No redisplay if running in batch mode or frame is not yet fully
13480 initialized, or redisplay is explicitly turned off by setting
13481 Vinhibit_redisplay. */
13482 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13483 || !NILP (Vinhibit_redisplay
))
13486 /* Don't examine these until after testing Vinhibit_redisplay.
13487 When Emacs is shutting down, perhaps because its connection to
13488 X has dropped, we should not look at them at all. */
13489 fr
= XFRAME (w
->frame
);
13490 sf
= SELECTED_FRAME ();
13492 if (!fr
->glyphs_initialized_p
)
13495 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13496 if (popup_activated ())
13500 /* I don't think this happens but let's be paranoid. */
13501 if (redisplaying_p
)
13504 /* Record a function that clears redisplaying_p
13505 when we leave this function. */
13506 count
= SPECPDL_INDEX ();
13507 record_unwind_protect_void (unwind_redisplay
);
13508 redisplaying_p
= true;
13509 specbind (Qinhibit_free_realized_faces
, Qnil
);
13511 /* Record this function, so it appears on the profiler's backtraces. */
13512 record_in_backtrace (Qredisplay_internal_xC_functionx
, 0, 0);
13514 FOR_EACH_FRAME (tail
, frame
)
13515 XFRAME (frame
)->already_hscrolled_p
= false;
13518 /* Remember the currently selected window. */
13522 forget_escape_and_glyphless_faces ();
13524 inhibit_free_realized_faces
= false;
13526 /* If face_change, init_iterator will free all realized faces, which
13527 includes the faces referenced from current matrices. So, we
13528 can't reuse current matrices in this case. */
13530 windows_or_buffers_changed
= 47;
13532 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13533 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13535 /* Since frames on a single ASCII terminal share the same
13536 display area, displaying a different frame means redisplay
13537 the whole thing. */
13538 SET_FRAME_GARBAGED (sf
);
13540 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13542 FRAME_TTY (sf
)->previous_frame
= sf
;
13545 /* Set the visible flags for all frames. Do this before checking for
13546 resized or garbaged frames; they want to know if their frames are
13547 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13548 number_of_visible_frames
= 0;
13550 FOR_EACH_FRAME (tail
, frame
)
13552 struct frame
*f
= XFRAME (frame
);
13554 if (FRAME_VISIBLE_P (f
))
13556 ++number_of_visible_frames
;
13557 /* Adjust matrices for visible frames only. */
13558 if (f
->fonts_changed
)
13560 adjust_frame_glyphs (f
);
13561 /* Disable all redisplay optimizations for this frame.
13562 This is because adjust_frame_glyphs resets the
13563 enabled_p flag for all glyph rows of all windows, so
13564 many optimizations will fail anyway, and some might
13565 fail to test that flag and do bogus things as
13567 SET_FRAME_GARBAGED (f
);
13568 f
->fonts_changed
= false;
13570 /* If cursor type has been changed on the frame
13571 other than selected, consider all frames. */
13572 if (f
!= sf
&& f
->cursor_type_changed
)
13573 fset_redisplay (f
);
13575 clear_desired_matrices (f
);
13578 /* Notice any pending interrupt request to change frame size. */
13579 do_pending_window_change (true);
13581 /* do_pending_window_change could change the selected_window due to
13582 frame resizing which makes the selected window too small. */
13583 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13586 /* Clear frames marked as garbaged. */
13587 clear_garbaged_frames ();
13589 /* Build menubar and tool-bar items. */
13590 if (NILP (Vmemory_full
))
13591 prepare_menu_bars ();
13593 reconsider_clip_changes (w
);
13595 /* In most cases selected window displays current buffer. */
13596 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13599 /* Detect case that we need to write or remove a star in the mode line. */
13600 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13601 w
->update_mode_line
= true;
13603 if (mode_line_update_needed (w
))
13604 w
->update_mode_line
= true;
13606 /* If reconsider_clip_changes above decided that the narrowing
13607 in the current buffer changed, make sure all other windows
13608 showing that buffer will be redisplayed. */
13609 if (current_buffer
->clip_changed
)
13610 bset_update_mode_line (current_buffer
);
13613 /* Normally the message* functions will have already displayed and
13614 updated the echo area, but the frame may have been trashed, or
13615 the update may have been preempted, so display the echo area
13616 again here. Checking message_cleared_p captures the case that
13617 the echo area should be cleared. */
13618 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13619 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13620 || (message_cleared_p
13621 && minibuf_level
== 0
13622 /* If the mini-window is currently selected, this means the
13623 echo-area doesn't show through. */
13624 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13626 echo_area_display (false);
13628 /* If echo_area_display resizes the mini-window, the redisplay and
13629 window_sizes_changed flags of the selected frame are set, but
13630 it's too late for the hooks in window-size-change-functions,
13631 which have been examined already in prepare_menu_bars. So in
13632 that case we call the hooks here only for the selected frame. */
13635 ptrdiff_t count1
= SPECPDL_INDEX ();
13637 record_unwind_save_match_data ();
13638 run_window_size_change_functions (selected_frame
);
13639 unbind_to (count1
, Qnil
);
13642 if (message_cleared_p
)
13643 update_miniwindow_p
= true;
13645 must_finish
= true;
13647 /* If we don't display the current message, don't clear the
13648 message_cleared_p flag, because, if we did, we wouldn't clear
13649 the echo area in the next redisplay which doesn't preserve
13651 if (!display_last_displayed_message_p
)
13652 message_cleared_p
= false;
13654 else if (EQ (selected_window
, minibuf_window
)
13655 && (current_buffer
->clip_changed
|| window_outdated (w
))
13656 && resize_mini_window (w
, false))
13660 ptrdiff_t count1
= SPECPDL_INDEX ();
13662 record_unwind_save_match_data ();
13663 run_window_size_change_functions (selected_frame
);
13664 unbind_to (count1
, Qnil
);
13667 /* Resized active mini-window to fit the size of what it is
13668 showing if its contents might have changed. */
13669 must_finish
= true;
13671 /* If window configuration was changed, frames may have been
13672 marked garbaged. Clear them or we will experience
13673 surprises wrt scrolling. */
13674 clear_garbaged_frames ();
13677 if (windows_or_buffers_changed
&& !update_mode_lines
)
13678 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13679 only the windows's contents needs to be refreshed, or whether the
13680 mode-lines also need a refresh. */
13681 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13682 ? REDISPLAY_SOME
: 32);
13684 /* If specs for an arrow have changed, do thorough redisplay
13685 to ensure we remove any arrow that should no longer exist. */
13686 if (overlay_arrows_changed_p ())
13687 /* Apparently, this is the only case where we update other windows,
13688 without updating other mode-lines. */
13689 windows_or_buffers_changed
= 49;
13691 consider_all_windows_p
= (update_mode_lines
13692 || windows_or_buffers_changed
);
13694 #define AINC(a,i) \
13696 Lisp_Object entry = Fgethash (make_number (i), a, make_number (0)); \
13697 if (INTEGERP (entry)) \
13698 Fputhash (make_number (i), make_number (1 + XINT (entry)), a); \
13701 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13702 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13704 /* Optimize the case that only the line containing the cursor in the
13705 selected window has changed. Variables starting with this_ are
13706 set in display_line and record information about the line
13707 containing the cursor. */
13708 tlbufpos
= this_line_start_pos
;
13709 tlendpos
= this_line_end_pos
;
13710 if (!consider_all_windows_p
13711 && CHARPOS (tlbufpos
) > 0
13712 && !w
->update_mode_line
13713 && !current_buffer
->clip_changed
13714 && !current_buffer
->prevent_redisplay_optimizations_p
13715 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13716 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13717 && !XFRAME (w
->frame
)->cursor_type_changed
13718 && !XFRAME (w
->frame
)->face_change
13719 /* Make sure recorded data applies to current buffer, etc. */
13720 && this_line_buffer
== current_buffer
13723 && !w
->optional_new_start
13724 /* Point must be on the line that we have info recorded about. */
13725 && PT
>= CHARPOS (tlbufpos
)
13726 && PT
<= Z
- CHARPOS (tlendpos
)
13727 /* All text outside that line, including its final newline,
13728 must be unchanged. */
13729 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13730 CHARPOS (tlendpos
)))
13732 if (CHARPOS (tlbufpos
) > BEGV
13733 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13734 && (CHARPOS (tlbufpos
) == ZV
13735 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13736 /* Former continuation line has disappeared by becoming empty. */
13738 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13740 /* We have to handle the case of continuation around a
13741 wide-column character (see the comment in indent.c around
13744 For instance, in the following case:
13746 -------- Insert --------
13747 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13748 J_I_ ==> J_I_ `^^' are cursors.
13752 As we have to redraw the line above, we cannot use this
13756 int line_height_before
= this_line_pixel_height
;
13758 /* Note that start_display will handle the case that the
13759 line starting at tlbufpos is a continuation line. */
13760 start_display (&it
, w
, tlbufpos
);
13762 /* Implementation note: It this still necessary? */
13763 if (it
.current_x
!= this_line_start_x
)
13766 TRACE ((stderr
, "trying display optimization 1\n"));
13767 w
->cursor
.vpos
= -1;
13768 overlay_arrow_seen
= false;
13769 it
.vpos
= this_line_vpos
;
13770 it
.current_y
= this_line_y
;
13771 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13772 display_line (&it
);
13774 /* If line contains point, is not continued,
13775 and ends at same distance from eob as before, we win. */
13776 if (w
->cursor
.vpos
>= 0
13777 /* Line is not continued, otherwise this_line_start_pos
13778 would have been set to 0 in display_line. */
13779 && CHARPOS (this_line_start_pos
)
13780 /* Line ends as before. */
13781 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13782 /* Line has same height as before. Otherwise other lines
13783 would have to be shifted up or down. */
13784 && this_line_pixel_height
== line_height_before
)
13786 /* If this is not the window's last line, we must adjust
13787 the charstarts of the lines below. */
13788 if (it
.current_y
< it
.last_visible_y
)
13790 struct glyph_row
*row
13791 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13792 ptrdiff_t delta
, delta_bytes
;
13794 /* We used to distinguish between two cases here,
13795 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13796 when the line ends in a newline or the end of the
13797 buffer's accessible portion. But both cases did
13798 the same, so they were collapsed. */
13800 - CHARPOS (tlendpos
)
13801 - MATRIX_ROW_START_CHARPOS (row
));
13802 delta_bytes
= (Z_BYTE
13803 - BYTEPOS (tlendpos
)
13804 - MATRIX_ROW_START_BYTEPOS (row
));
13806 increment_matrix_positions (w
->current_matrix
,
13807 this_line_vpos
+ 1,
13808 w
->current_matrix
->nrows
,
13809 delta
, delta_bytes
);
13812 /* If this row displays text now but previously didn't,
13813 or vice versa, w->window_end_vpos may have to be
13815 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13817 if (w
->window_end_vpos
< this_line_vpos
)
13818 w
->window_end_vpos
= this_line_vpos
;
13820 else if (w
->window_end_vpos
== this_line_vpos
13821 && this_line_vpos
> 0)
13822 w
->window_end_vpos
= this_line_vpos
- 1;
13823 w
->window_end_valid
= false;
13825 /* Update hint: No need to try to scroll in update_window. */
13826 w
->desired_matrix
->no_scrolling_p
= true;
13829 *w
->desired_matrix
->method
= 0;
13830 debug_method_add (w
, "optimization 1");
13832 #ifdef HAVE_WINDOW_SYSTEM
13833 update_window_fringes (w
, false);
13840 else if (/* Cursor position hasn't changed. */
13841 PT
== w
->last_point
13842 /* Make sure the cursor was last displayed
13843 in this window. Otherwise we have to reposition it. */
13845 /* PXW: Must be converted to pixels, probably. */
13846 && 0 <= w
->cursor
.vpos
13847 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13851 do_pending_window_change (true);
13852 /* If selected_window changed, redisplay again. */
13853 if (WINDOWP (selected_window
)
13854 && (w
= XWINDOW (selected_window
)) != sw
)
13857 /* We used to always goto end_of_redisplay here, but this
13858 isn't enough if we have a blinking cursor. */
13859 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13860 goto end_of_redisplay
;
13864 /* If highlighting the region, or if the cursor is in the echo area,
13865 then we can't just move the cursor. */
13866 else if (NILP (Vshow_trailing_whitespace
)
13867 && !cursor_in_echo_area
)
13870 struct glyph_row
*row
;
13872 /* Skip from tlbufpos to PT and see where it is. Note that
13873 PT may be in invisible text. If so, we will end at the
13874 next visible position. */
13875 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13876 NULL
, DEFAULT_FACE_ID
);
13877 it
.current_x
= this_line_start_x
;
13878 it
.current_y
= this_line_y
;
13879 it
.vpos
= this_line_vpos
;
13881 /* The call to move_it_to stops in front of PT, but
13882 moves over before-strings. */
13883 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13885 if (it
.vpos
== this_line_vpos
13886 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13889 eassert (this_line_vpos
== it
.vpos
);
13890 eassert (this_line_y
== it
.current_y
);
13891 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13892 if (cursor_row_fully_visible_p (w
, false, true))
13895 *w
->desired_matrix
->method
= 0;
13896 debug_method_add (w
, "optimization 3");
13908 /* Text changed drastically or point moved off of line. */
13909 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13912 CHARPOS (this_line_start_pos
) = 0;
13913 ++clear_face_cache_count
;
13914 #ifdef HAVE_WINDOW_SYSTEM
13915 ++clear_image_cache_count
;
13918 /* Build desired matrices, and update the display. If
13919 consider_all_windows_p, do it for all windows on all frames that
13920 require redisplay, as specified by their 'redisplay' flag.
13921 Otherwise do it for selected_window, only. */
13923 if (consider_all_windows_p
)
13925 FOR_EACH_FRAME (tail
, frame
)
13926 XFRAME (frame
)->updated_p
= false;
13928 propagate_buffer_redisplay ();
13930 FOR_EACH_FRAME (tail
, frame
)
13932 struct frame
*f
= XFRAME (frame
);
13934 /* We don't have to do anything for unselected terminal
13936 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13937 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13941 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13944 /* Only GC scrollbars when we redisplay the whole frame. */
13945 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13946 bool f_redisplay_flag
= f
->redisplay
;
13947 /* Mark all the scroll bars to be removed; we'll redeem
13948 the ones we want when we redisplay their windows. */
13949 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13950 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13952 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13953 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13954 /* Remember that the invisible frames need to be redisplayed next
13955 time they're visible. */
13956 else if (!REDISPLAY_SOME_P ())
13957 f
->redisplay
= true;
13959 /* The X error handler may have deleted that frame. */
13960 if (!FRAME_LIVE_P (f
))
13963 /* Any scroll bars which redisplay_windows should have
13964 nuked should now go away. */
13965 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13966 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13968 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13970 /* If fonts changed on visible frame, display again. */
13971 if (f
->fonts_changed
)
13973 adjust_frame_glyphs (f
);
13974 /* Disable all redisplay optimizations for this
13975 frame. For the reasons, see the comment near
13976 the previous call to adjust_frame_glyphs above. */
13977 SET_FRAME_GARBAGED (f
);
13978 f
->fonts_changed
= false;
13982 /* See if we have to hscroll. */
13983 if (!f
->already_hscrolled_p
)
13985 f
->already_hscrolled_p
= true;
13986 if (hscroll_windows (f
->root_window
))
13990 /* If the frame's redisplay flag was not set before
13991 we went about redisplaying its windows, but it is
13992 set now, that means we employed some redisplay
13993 optimizations inside redisplay_windows, and
13994 bypassed producing some screen lines. But if
13995 f->redisplay is now set, it might mean the old
13996 faces are no longer valid (e.g., if redisplaying
13997 some window called some Lisp which defined a new
13998 face or redefined an existing face), so trying to
13999 use them in update_frame will segfault.
14000 Therefore, we must redisplay this frame. */
14001 if (!f_redisplay_flag
&& f
->redisplay
)
14004 /* Prevent various kinds of signals during display
14005 update. stdio is not robust about handling
14006 signals, which can cause an apparent I/O error. */
14007 if (interrupt_input
)
14008 unrequest_sigio ();
14011 pending
|= update_frame (f
, false, false);
14012 f
->cursor_type_changed
= false;
14013 f
->updated_p
= true;
14018 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
14022 /* Do the mark_window_display_accurate after all windows have
14023 been redisplayed because this call resets flags in buffers
14024 which are needed for proper redisplay. */
14025 FOR_EACH_FRAME (tail
, frame
)
14027 struct frame
*f
= XFRAME (frame
);
14030 f
->redisplay
= false;
14031 mark_window_display_accurate (f
->root_window
, true);
14032 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
14033 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
14038 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
14040 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
14041 /* Use list_of_error, not Qerror, so that
14042 we catch only errors and don't run the debugger. */
14043 internal_condition_case_1 (redisplay_window_1
, selected_window
,
14045 redisplay_window_error
);
14046 if (update_miniwindow_p
)
14047 internal_condition_case_1 (redisplay_window_1
,
14048 FRAME_MINIBUF_WINDOW (sf
), list_of_error
,
14049 redisplay_window_error
);
14051 /* Compare desired and current matrices, perform output. */
14054 /* If fonts changed, display again. Likewise if redisplay_window_1
14055 above caused some change (e.g., a change in faces) that requires
14056 considering the entire frame again. */
14057 if (sf
->fonts_changed
|| sf
->redisplay
)
14061 /* Set this to force a more thorough redisplay.
14062 Otherwise, we might immediately loop back to the
14063 above "else-if" clause (since all the conditions that
14064 led here might still be true), and we will then
14065 infloop, because the selected-frame's redisplay flag
14066 is not (and cannot be) reset. */
14067 windows_or_buffers_changed
= 50;
14072 /* Prevent freeing of realized faces, since desired matrices are
14073 pending that reference the faces we computed and cached. */
14074 inhibit_free_realized_faces
= true;
14076 /* Prevent various kinds of signals during display update.
14077 stdio is not robust about handling signals,
14078 which can cause an apparent I/O error. */
14079 if (interrupt_input
)
14080 unrequest_sigio ();
14083 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
14085 if (hscroll_windows (selected_window
))
14088 XWINDOW (selected_window
)->must_be_updated_p
= true;
14089 pending
= update_frame (sf
, false, false);
14090 sf
->cursor_type_changed
= false;
14093 /* We may have called echo_area_display at the top of this
14094 function. If the echo area is on another frame, that may
14095 have put text on a frame other than the selected one, so the
14096 above call to update_frame would not have caught it. Catch
14098 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
14099 struct frame
*mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
14101 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
14103 XWINDOW (mini_window
)->must_be_updated_p
= true;
14104 pending
|= update_frame (mini_frame
, false, false);
14105 mini_frame
->cursor_type_changed
= false;
14106 if (!pending
&& hscroll_windows (mini_window
))
14111 /* If display was paused because of pending input, make sure we do a
14112 thorough update the next time. */
14115 /* Prevent the optimization at the beginning of
14116 redisplay_internal that tries a single-line update of the
14117 line containing the cursor in the selected window. */
14118 CHARPOS (this_line_start_pos
) = 0;
14120 /* Let the overlay arrow be updated the next time. */
14121 update_overlay_arrows (0);
14123 /* If we pause after scrolling, some rows in the current
14124 matrices of some windows are not valid. */
14125 if (!WINDOW_FULL_WIDTH_P (w
)
14126 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
14127 update_mode_lines
= 36;
14131 if (!consider_all_windows_p
)
14133 /* This has already been done above if
14134 consider_all_windows_p is set. */
14135 if (XBUFFER (w
->contents
)->text
->redisplay
14136 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
14137 /* This can happen if b->text->redisplay was set during
14139 propagate_buffer_redisplay ();
14140 mark_window_display_accurate_1 (w
, true);
14142 /* Say overlay arrows are up to date. */
14143 update_overlay_arrows (1);
14145 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
14146 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
14149 update_mode_lines
= 0;
14150 windows_or_buffers_changed
= 0;
14153 /* Start SIGIO interrupts coming again. Having them off during the
14154 code above makes it less likely one will discard output, but not
14155 impossible, since there might be stuff in the system buffer here.
14156 But it is much hairier to try to do anything about that. */
14157 if (interrupt_input
)
14161 /* If a frame has become visible which was not before, redisplay
14162 again, so that we display it. Expose events for such a frame
14163 (which it gets when becoming visible) don't call the parts of
14164 redisplay constructing glyphs, so simply exposing a frame won't
14165 display anything in this case. So, we have to display these
14166 frames here explicitly. */
14171 FOR_EACH_FRAME (tail
, frame
)
14173 if (XFRAME (frame
)->visible
)
14177 if (new_count
!= number_of_visible_frames
)
14178 windows_or_buffers_changed
= 52;
14181 /* Change frame size now if a change is pending. */
14182 do_pending_window_change (true);
14184 /* If we just did a pending size change, or have additional
14185 visible frames, or selected_window changed, redisplay again. */
14186 if ((windows_or_buffers_changed
&& !pending
)
14187 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14190 /* Clear the face and image caches.
14192 We used to do this only if consider_all_windows_p. But the cache
14193 needs to be cleared if a timer creates images in the current
14194 buffer (e.g. the test case in Bug#6230). */
14196 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14198 clear_face_cache (false);
14199 clear_face_cache_count
= 0;
14202 #ifdef HAVE_WINDOW_SYSTEM
14203 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14205 clear_image_caches (Qnil
);
14206 clear_image_cache_count
= 0;
14208 #endif /* HAVE_WINDOW_SYSTEM */
14212 ns_set_doc_edited ();
14214 if (interrupt_input
&& interrupts_deferred
)
14217 unbind_to (count
, Qnil
);
14222 /* Redisplay, but leave alone any recent echo area message unless
14223 another message has been requested in its place.
14225 This is useful in situations where you need to redisplay but no
14226 user action has occurred, making it inappropriate for the message
14227 area to be cleared. See tracking_off and
14228 wait_reading_process_output for examples of these situations.
14230 FROM_WHERE is an integer saying from where this function was
14231 called. This is useful for debugging. */
14234 redisplay_preserve_echo_area (int from_where
)
14236 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14238 if (!NILP (echo_area_buffer
[1]))
14240 /* We have a previously displayed message, but no current
14241 message. Redisplay the previous message. */
14242 display_last_displayed_message_p
= true;
14243 redisplay_internal ();
14244 display_last_displayed_message_p
= false;
14247 redisplay_internal ();
14249 flush_frame (SELECTED_FRAME ());
14253 /* Function registered with record_unwind_protect in redisplay_internal. */
14256 unwind_redisplay (void)
14258 redisplaying_p
= false;
14262 /* Mark the display of leaf window W as accurate or inaccurate.
14263 If ACCURATE_P, mark display of W as accurate.
14264 If !ACCURATE_P, arrange for W to be redisplayed the next
14265 time redisplay_internal is called. */
14268 mark_window_display_accurate_1 (struct window
*w
, bool accurate_p
)
14270 struct buffer
*b
= XBUFFER (w
->contents
);
14272 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14273 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14274 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14278 b
->clip_changed
= false;
14279 b
->prevent_redisplay_optimizations_p
= false;
14280 eassert (buffer_window_count (b
) > 0);
14281 /* Resetting b->text->redisplay is problematic!
14282 In order to make it safer to do it here, redisplay_internal must
14283 have copied all b->text->redisplay to their respective windows. */
14284 b
->text
->redisplay
= false;
14286 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14287 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14288 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14289 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14291 w
->current_matrix
->buffer
= b
;
14292 w
->current_matrix
->begv
= BUF_BEGV (b
);
14293 w
->current_matrix
->zv
= BUF_ZV (b
);
14295 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14296 w
->last_cursor_off_p
= w
->cursor_off_p
;
14298 if (w
== XWINDOW (selected_window
))
14299 w
->last_point
= BUF_PT (b
);
14301 w
->last_point
= marker_position (w
->pointm
);
14303 w
->window_end_valid
= true;
14304 w
->update_mode_line
= false;
14307 w
->redisplay
= !accurate_p
;
14311 /* Mark the display of windows in the window tree rooted at WINDOW as
14312 accurate or inaccurate. If ACCURATE_P, mark display of
14313 windows as accurate. If !ACCURATE_P, arrange for windows to
14314 be redisplayed the next time redisplay_internal is called. */
14317 mark_window_display_accurate (Lisp_Object window
, bool accurate_p
)
14321 for (; !NILP (window
); window
= w
->next
)
14323 w
= XWINDOW (window
);
14324 if (WINDOWP (w
->contents
))
14325 mark_window_display_accurate (w
->contents
, accurate_p
);
14327 mark_window_display_accurate_1 (w
, accurate_p
);
14331 update_overlay_arrows (1);
14333 /* Force a thorough redisplay the next time by setting
14334 last_arrow_position and last_arrow_string to t, which is
14335 unequal to any useful value of Voverlay_arrow_... */
14336 update_overlay_arrows (-1);
14340 /* Return value in display table DP (Lisp_Char_Table *) for character
14341 C. Since a display table doesn't have any parent, we don't have to
14342 follow parent. Do not call this function directly but use the
14343 macro DISP_CHAR_VECTOR. */
14346 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14350 if (ASCII_CHAR_P (c
))
14353 if (SUB_CHAR_TABLE_P (val
))
14354 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14360 XSETCHAR_TABLE (table
, dp
);
14361 val
= char_table_ref (table
, c
);
14370 /***********************************************************************
14372 ***********************************************************************/
14374 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14377 redisplay_windows (Lisp_Object window
)
14379 while (!NILP (window
))
14381 struct window
*w
= XWINDOW (window
);
14383 if (WINDOWP (w
->contents
))
14384 redisplay_windows (w
->contents
);
14385 else if (BUFFERP (w
->contents
))
14387 displayed_buffer
= XBUFFER (w
->contents
);
14388 /* Use list_of_error, not Qerror, so that
14389 we catch only errors and don't run the debugger. */
14390 internal_condition_case_1 (redisplay_window_0
, window
,
14392 redisplay_window_error
);
14400 redisplay_window_error (Lisp_Object ignore
)
14402 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14407 redisplay_window_0 (Lisp_Object window
)
14409 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14410 redisplay_window (window
, false);
14415 redisplay_window_1 (Lisp_Object window
)
14417 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14418 redisplay_window (window
, true);
14423 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14424 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14425 which positions recorded in ROW differ from current buffer
14428 Return true iff cursor is on this row. */
14431 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14432 struct glyph_matrix
*matrix
,
14433 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14436 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14437 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14438 struct glyph
*cursor
= NULL
;
14439 /* The last known character position in row. */
14440 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14442 ptrdiff_t pt_old
= PT
- delta
;
14443 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14444 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14445 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14446 /* A glyph beyond the edge of TEXT_AREA which we should never
14448 struct glyph
*glyphs_end
= end
;
14449 /* True means we've found a match for cursor position, but that
14450 glyph has the avoid_cursor_p flag set. */
14451 bool match_with_avoid_cursor
= false;
14452 /* True means we've seen at least one glyph that came from a
14454 bool string_seen
= false;
14455 /* Largest and smallest buffer positions seen so far during scan of
14457 ptrdiff_t bpos_max
= pos_before
;
14458 ptrdiff_t bpos_min
= pos_after
;
14459 /* Last buffer position covered by an overlay string with an integer
14460 `cursor' property. */
14461 ptrdiff_t bpos_covered
= 0;
14462 /* True means the display string on which to display the cursor
14463 comes from a text property, not from an overlay. */
14464 bool string_from_text_prop
= false;
14466 /* Don't even try doing anything if called for a mode-line or
14467 header-line row, since the rest of the code isn't prepared to
14468 deal with such calamities. */
14469 eassert (!row
->mode_line_p
);
14470 if (row
->mode_line_p
)
14473 /* Skip over glyphs not having an object at the start and the end of
14474 the row. These are special glyphs like truncation marks on
14475 terminal frames. */
14476 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14478 if (!row
->reversed_p
)
14481 && NILP (glyph
->object
)
14482 && glyph
->charpos
< 0)
14484 x
+= glyph
->pixel_width
;
14488 && NILP ((end
- 1)->object
)
14489 /* CHARPOS is zero for blanks and stretch glyphs
14490 inserted by extend_face_to_end_of_line. */
14491 && (end
- 1)->charpos
<= 0)
14493 glyph_before
= glyph
- 1;
14500 /* If the glyph row is reversed, we need to process it from back
14501 to front, so swap the edge pointers. */
14502 glyphs_end
= end
= glyph
- 1;
14503 glyph
+= row
->used
[TEXT_AREA
] - 1;
14505 while (glyph
> end
+ 1
14506 && NILP (glyph
->object
)
14507 && glyph
->charpos
< 0)
14510 x
-= glyph
->pixel_width
;
14512 if (NILP (glyph
->object
) && glyph
->charpos
< 0)
14514 /* By default, in reversed rows we put the cursor on the
14515 rightmost (first in the reading order) glyph. */
14516 for (g
= end
+ 1; g
< glyph
; g
++)
14517 x
+= g
->pixel_width
;
14519 && NILP ((end
+ 1)->object
)
14520 && (end
+ 1)->charpos
<= 0)
14522 glyph_before
= glyph
+ 1;
14526 else if (row
->reversed_p
)
14528 /* In R2L rows that don't display text, put the cursor on the
14529 rightmost glyph. Case in point: an empty last line that is
14530 part of an R2L paragraph. */
14532 /* Avoid placing the cursor on the last glyph of the row, where
14533 on terminal frames we hold the vertical border between
14534 adjacent windows. */
14535 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14536 && !WINDOW_RIGHTMOST_P (w
)
14537 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14539 x
= -1; /* will be computed below, at label compute_x */
14542 /* Step 1: Try to find the glyph whose character position
14543 corresponds to point. If that's not possible, find 2 glyphs
14544 whose character positions are the closest to point, one before
14545 point, the other after it. */
14546 if (!row
->reversed_p
)
14547 while (/* not marched to end of glyph row */
14549 /* glyph was not inserted by redisplay for internal purposes */
14550 && !NILP (glyph
->object
))
14552 if (BUFFERP (glyph
->object
))
14554 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14556 if (glyph
->charpos
> bpos_max
)
14557 bpos_max
= glyph
->charpos
;
14558 if (glyph
->charpos
< bpos_min
)
14559 bpos_min
= glyph
->charpos
;
14560 if (!glyph
->avoid_cursor_p
)
14562 /* If we hit point, we've found the glyph on which to
14563 display the cursor. */
14566 match_with_avoid_cursor
= false;
14569 /* See if we've found a better approximation to
14570 POS_BEFORE or to POS_AFTER. */
14571 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14573 pos_before
= glyph
->charpos
;
14574 glyph_before
= glyph
;
14576 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14578 pos_after
= glyph
->charpos
;
14579 glyph_after
= glyph
;
14582 else if (dpos
== 0)
14583 match_with_avoid_cursor
= true;
14585 else if (STRINGP (glyph
->object
))
14587 Lisp_Object chprop
;
14588 ptrdiff_t glyph_pos
= glyph
->charpos
;
14590 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14592 if (!NILP (chprop
))
14594 /* If the string came from a `display' text property,
14595 look up the buffer position of that property and
14596 use that position to update bpos_max, as if we
14597 actually saw such a position in one of the row's
14598 glyphs. This helps with supporting integer values
14599 of `cursor' property on the display string in
14600 situations where most or all of the row's buffer
14601 text is completely covered by display properties,
14602 so that no glyph with valid buffer positions is
14603 ever seen in the row. */
14604 ptrdiff_t prop_pos
=
14605 string_buffer_position_lim (glyph
->object
, pos_before
,
14608 if (prop_pos
>= pos_before
)
14609 bpos_max
= prop_pos
;
14611 if (INTEGERP (chprop
))
14613 bpos_covered
= bpos_max
+ XINT (chprop
);
14614 /* If the `cursor' property covers buffer positions up
14615 to and including point, we should display cursor on
14616 this glyph. Note that, if a `cursor' property on one
14617 of the string's characters has an integer value, we
14618 will break out of the loop below _before_ we get to
14619 the position match above. IOW, integer values of
14620 the `cursor' property override the "exact match for
14621 point" strategy of positioning the cursor. */
14622 /* Implementation note: bpos_max == pt_old when, e.g.,
14623 we are in an empty line, where bpos_max is set to
14624 MATRIX_ROW_START_CHARPOS, see above. */
14625 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14632 string_seen
= true;
14634 x
+= glyph
->pixel_width
;
14637 else if (glyph
> end
) /* row is reversed */
14638 while (!NILP (glyph
->object
))
14640 if (BUFFERP (glyph
->object
))
14642 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14644 if (glyph
->charpos
> bpos_max
)
14645 bpos_max
= glyph
->charpos
;
14646 if (glyph
->charpos
< bpos_min
)
14647 bpos_min
= glyph
->charpos
;
14648 if (!glyph
->avoid_cursor_p
)
14652 match_with_avoid_cursor
= false;
14655 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14657 pos_before
= glyph
->charpos
;
14658 glyph_before
= glyph
;
14660 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14662 pos_after
= glyph
->charpos
;
14663 glyph_after
= glyph
;
14666 else if (dpos
== 0)
14667 match_with_avoid_cursor
= true;
14669 else if (STRINGP (glyph
->object
))
14671 Lisp_Object chprop
;
14672 ptrdiff_t glyph_pos
= glyph
->charpos
;
14674 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14676 if (!NILP (chprop
))
14678 ptrdiff_t prop_pos
=
14679 string_buffer_position_lim (glyph
->object
, pos_before
,
14682 if (prop_pos
>= pos_before
)
14683 bpos_max
= prop_pos
;
14685 if (INTEGERP (chprop
))
14687 bpos_covered
= bpos_max
+ XINT (chprop
);
14688 /* If the `cursor' property covers buffer positions up
14689 to and including point, we should display cursor on
14691 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14697 string_seen
= true;
14700 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14702 x
--; /* can't use any pixel_width */
14705 x
-= glyph
->pixel_width
;
14708 /* Step 2: If we didn't find an exact match for point, we need to
14709 look for a proper place to put the cursor among glyphs between
14710 GLYPH_BEFORE and GLYPH_AFTER. */
14711 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14712 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14713 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14715 /* An empty line has a single glyph whose OBJECT is nil and
14716 whose CHARPOS is the position of a newline on that line.
14717 Note that on a TTY, there are more glyphs after that, which
14718 were produced by extend_face_to_end_of_line, but their
14719 CHARPOS is zero or negative. */
14720 bool empty_line_p
=
14721 ((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14722 && NILP (glyph
->object
) && glyph
->charpos
> 0
14723 /* On a TTY, continued and truncated rows also have a glyph at
14724 their end whose OBJECT is nil and whose CHARPOS is
14725 positive (the continuation and truncation glyphs), but such
14726 rows are obviously not "empty". */
14727 && !(row
->continued_p
|| row
->truncated_on_right_p
));
14729 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14731 ptrdiff_t ellipsis_pos
;
14733 /* Scan back over the ellipsis glyphs. */
14734 if (!row
->reversed_p
)
14736 ellipsis_pos
= (glyph
- 1)->charpos
;
14737 while (glyph
> row
->glyphs
[TEXT_AREA
]
14738 && (glyph
- 1)->charpos
== ellipsis_pos
)
14739 glyph
--, x
-= glyph
->pixel_width
;
14740 /* That loop always goes one position too far, including
14741 the glyph before the ellipsis. So scan forward over
14743 x
+= glyph
->pixel_width
;
14746 else /* row is reversed */
14748 ellipsis_pos
= (glyph
+ 1)->charpos
;
14749 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14750 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14751 glyph
++, x
+= glyph
->pixel_width
;
14752 x
-= glyph
->pixel_width
;
14756 else if (match_with_avoid_cursor
)
14758 cursor
= glyph_after
;
14761 else if (string_seen
)
14763 int incr
= row
->reversed_p
? -1 : +1;
14765 /* Need to find the glyph that came out of a string which is
14766 present at point. That glyph is somewhere between
14767 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14768 positioned between POS_BEFORE and POS_AFTER in the
14770 struct glyph
*start
, *stop
;
14771 ptrdiff_t pos
= pos_before
;
14775 /* If the row ends in a newline from a display string,
14776 reordering could have moved the glyphs belonging to the
14777 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14778 in this case we extend the search to the last glyph in
14779 the row that was not inserted by redisplay. */
14780 if (row
->ends_in_newline_from_string_p
)
14783 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14786 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14787 correspond to POS_BEFORE and POS_AFTER, respectively. We
14788 need START and STOP in the order that corresponds to the
14789 row's direction as given by its reversed_p flag. If the
14790 directionality of characters between POS_BEFORE and
14791 POS_AFTER is the opposite of the row's base direction,
14792 these characters will have been reordered for display,
14793 and we need to reverse START and STOP. */
14794 if (!row
->reversed_p
)
14796 start
= min (glyph_before
, glyph_after
);
14797 stop
= max (glyph_before
, glyph_after
);
14801 start
= max (glyph_before
, glyph_after
);
14802 stop
= min (glyph_before
, glyph_after
);
14804 for (glyph
= start
+ incr
;
14805 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14808 /* Any glyphs that come from the buffer are here because
14809 of bidi reordering. Skip them, and only pay
14810 attention to glyphs that came from some string. */
14811 if (STRINGP (glyph
->object
))
14815 /* If the display property covers the newline, we
14816 need to search for it one position farther. */
14817 ptrdiff_t lim
= pos_after
14818 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14820 string_from_text_prop
= false;
14821 str
= glyph
->object
;
14822 tem
= string_buffer_position_lim (str
, pos
, lim
, false);
14823 if (tem
== 0 /* from overlay */
14826 /* If the string from which this glyph came is
14827 found in the buffer at point, or at position
14828 that is closer to point than pos_after, then
14829 we've found the glyph we've been looking for.
14830 If it comes from an overlay (tem == 0), and
14831 it has the `cursor' property on one of its
14832 glyphs, record that glyph as a candidate for
14833 displaying the cursor. (As in the
14834 unidirectional version, we will display the
14835 cursor on the last candidate we find.) */
14838 || (tem
- pt_old
> 0 && tem
< pos_after
))
14840 /* The glyphs from this string could have
14841 been reordered. Find the one with the
14842 smallest string position. Or there could
14843 be a character in the string with the
14844 `cursor' property, which means display
14845 cursor on that character's glyph. */
14846 ptrdiff_t strpos
= glyph
->charpos
;
14851 string_from_text_prop
= true;
14854 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14855 && EQ (glyph
->object
, str
);
14859 ptrdiff_t gpos
= glyph
->charpos
;
14861 cprop
= Fget_char_property (make_number (gpos
),
14869 if (tem
&& glyph
->charpos
< strpos
)
14871 strpos
= glyph
->charpos
;
14877 || (tem
- pt_old
> 0 && tem
< pos_after
))
14881 pos
= tem
+ 1; /* don't find previous instances */
14883 /* This string is not what we want; skip all of the
14884 glyphs that came from it. */
14885 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14886 && EQ (glyph
->object
, str
))
14893 /* If we reached the end of the line, and END was from a string,
14894 the cursor is not on this line. */
14896 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14897 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14898 && STRINGP (end
->object
)
14899 && row
->continued_p
)
14902 /* A truncated row may not include PT among its character positions.
14903 Setting the cursor inside the scroll margin will trigger
14904 recalculation of hscroll in hscroll_window_tree. But if a
14905 display string covers point, defer to the string-handling
14906 code below to figure this out. */
14907 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14909 cursor
= glyph_before
;
14912 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14913 /* Zero-width characters produce no glyphs. */
14915 && (row
->reversed_p
14916 ? glyph_after
> glyphs_end
14917 : glyph_after
< glyphs_end
)))
14919 cursor
= glyph_after
;
14925 if (cursor
!= NULL
)
14927 else if (glyph
== glyphs_end
14928 && pos_before
== pos_after
14929 && STRINGP ((row
->reversed_p
14930 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14931 : row
->glyphs
[TEXT_AREA
])->object
))
14933 /* If all the glyphs of this row came from strings, put the
14934 cursor on the first glyph of the row. This avoids having the
14935 cursor outside of the text area in this very rare and hard
14939 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14940 : row
->glyphs
[TEXT_AREA
];
14946 /* Need to compute x that corresponds to GLYPH. */
14947 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14949 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14951 x
+= g
->pixel_width
;
14955 /* ROW could be part of a continued line, which, under bidi
14956 reordering, might have other rows whose start and end charpos
14957 occlude point. Only set w->cursor if we found a better
14958 approximation to the cursor position than we have from previously
14959 examined candidate rows belonging to the same continued line. */
14960 if (/* We already have a candidate row. */
14961 w
->cursor
.vpos
>= 0
14962 /* That candidate is not the row we are processing. */
14963 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14964 /* Make sure cursor.vpos specifies a row whose start and end
14965 charpos occlude point, and it is valid candidate for being a
14966 cursor-row. This is because some callers of this function
14967 leave cursor.vpos at the row where the cursor was displayed
14968 during the last redisplay cycle. */
14969 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14970 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14971 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14974 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14976 /* Don't consider glyphs that are outside TEXT_AREA. */
14977 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14979 /* Keep the candidate whose buffer position is the closest to
14980 point or has the `cursor' property. */
14981 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14982 w
->cursor
.hpos
>= 0
14983 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14984 && ((BUFFERP (g1
->object
)
14985 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14986 || (BUFFERP (glyph
->object
)
14987 && eabs (g1
->charpos
- pt_old
)
14988 < eabs (glyph
->charpos
- pt_old
))))
14989 /* Previous candidate is a glyph from a string that has
14990 a non-nil `cursor' property. */
14991 || (STRINGP (g1
->object
)
14992 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14993 Qcursor
, g1
->object
))
14994 /* Previous candidate is from the same display
14995 string as this one, and the display string
14996 came from a text property. */
14997 || (EQ (g1
->object
, glyph
->object
)
14998 && string_from_text_prop
)
14999 /* this candidate is from newline and its
15000 position is not an exact match */
15001 || (NILP (glyph
->object
)
15002 && glyph
->charpos
!= pt_old
)))))
15004 /* If this candidate gives an exact match, use that. */
15005 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
15006 /* If this candidate is a glyph created for the
15007 terminating newline of a line, and point is on that
15008 newline, it wins because it's an exact match. */
15009 || (!row
->continued_p
15010 && NILP (glyph
->object
)
15011 && glyph
->charpos
== 0
15012 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
15013 /* Otherwise, keep the candidate that comes from a row
15014 spanning less buffer positions. This may win when one or
15015 both candidate positions are on glyphs that came from
15016 display strings, for which we cannot compare buffer
15018 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
15019 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
15020 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
15023 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
15025 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
15026 w
->cursor
.y
= row
->y
+ dy
;
15028 if (w
== XWINDOW (selected_window
))
15030 if (!row
->continued_p
15031 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15034 this_line_buffer
= XBUFFER (w
->contents
);
15036 CHARPOS (this_line_start_pos
)
15037 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
15038 BYTEPOS (this_line_start_pos
)
15039 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
15041 CHARPOS (this_line_end_pos
)
15042 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
15043 BYTEPOS (this_line_end_pos
)
15044 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
15046 this_line_y
= w
->cursor
.y
;
15047 this_line_pixel_height
= row
->height
;
15048 this_line_vpos
= w
->cursor
.vpos
;
15049 this_line_start_x
= row
->x
;
15052 CHARPOS (this_line_start_pos
) = 0;
15059 /* Run window scroll functions, if any, for WINDOW with new window
15060 start STARTP. Sets the window start of WINDOW to that position.
15062 We assume that the window's buffer is really current. */
15064 static struct text_pos
15065 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
15067 struct window
*w
= XWINDOW (window
);
15068 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
15070 eassert (current_buffer
== XBUFFER (w
->contents
));
15072 if (!NILP (Vwindow_scroll_functions
))
15074 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
15075 make_number (CHARPOS (startp
)));
15076 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15077 /* In case the hook functions switch buffers. */
15078 set_buffer_internal (XBUFFER (w
->contents
));
15085 /* Make sure the line containing the cursor is fully visible.
15086 A value of true means there is nothing to be done.
15087 (Either the line is fully visible, or it cannot be made so,
15088 or we cannot tell.)
15090 If FORCE_P, return false even if partial visible cursor row
15091 is higher than window.
15093 If CURRENT_MATRIX_P, use the information from the
15094 window's current glyph matrix; otherwise use the desired glyph
15097 A value of false means the caller should do scrolling
15098 as if point had gone off the screen. */
15101 cursor_row_fully_visible_p (struct window
*w
, bool force_p
,
15102 bool current_matrix_p
)
15104 struct glyph_matrix
*matrix
;
15105 struct glyph_row
*row
;
15108 if (!make_cursor_line_fully_visible_p
)
15111 /* It's not always possible to find the cursor, e.g, when a window
15112 is full of overlay strings. Don't do anything in that case. */
15113 if (w
->cursor
.vpos
< 0)
15116 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
15117 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
15119 /* If the cursor row is not partially visible, there's nothing to do. */
15120 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
15123 /* If the row the cursor is in is taller than the window's height,
15124 it's not clear what to do, so do nothing. */
15125 window_height
= window_box_height (w
);
15126 if (row
->height
>= window_height
)
15128 if (!force_p
|| MINI_WINDOW_P (w
)
15129 || w
->vscroll
|| w
->cursor
.vpos
== 0)
15136 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
15137 means only WINDOW is redisplayed in redisplay_internal.
15138 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
15139 in redisplay_window to bring a partially visible line into view in
15140 the case that only the cursor has moved.
15142 LAST_LINE_MISFIT should be true if we're scrolling because the
15143 last screen line's vertical height extends past the end of the screen.
15147 1 if scrolling succeeded
15149 0 if scrolling didn't find point.
15151 -1 if new fonts have been loaded so that we must interrupt
15152 redisplay, adjust glyph matrices, and try again. */
15158 SCROLLING_NEED_LARGER_MATRICES
15161 /* If scroll-conservatively is more than this, never recenter.
15163 If you change this, don't forget to update the doc string of
15164 `scroll-conservatively' and the Emacs manual. */
15165 #define SCROLL_LIMIT 100
15168 try_scrolling (Lisp_Object window
, bool just_this_one_p
,
15169 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
15170 bool temp_scroll_step
, bool last_line_misfit
)
15172 struct window
*w
= XWINDOW (window
);
15173 struct frame
*f
= XFRAME (w
->frame
);
15174 struct text_pos pos
, startp
;
15176 int this_scroll_margin
, scroll_max
, rc
, height
;
15177 int dy
= 0, amount_to_scroll
= 0;
15178 bool scroll_down_p
= false;
15179 int extra_scroll_margin_lines
= last_line_misfit
;
15180 Lisp_Object aggressive
;
15181 /* We will never try scrolling more than this number of lines. */
15182 int scroll_limit
= SCROLL_LIMIT
;
15183 int frame_line_height
= default_line_pixel_height (w
);
15184 int window_total_lines
15185 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15188 debug_method_add (w
, "try_scrolling");
15191 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15193 /* Compute scroll margin height in pixels. We scroll when point is
15194 within this distance from the top or bottom of the window. */
15195 if (scroll_margin
> 0)
15196 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15197 * frame_line_height
;
15199 this_scroll_margin
= 0;
15201 /* Force arg_scroll_conservatively to have a reasonable value, to
15202 avoid scrolling too far away with slow move_it_* functions. Note
15203 that the user can supply scroll-conservatively equal to
15204 `most-positive-fixnum', which can be larger than INT_MAX. */
15205 if (arg_scroll_conservatively
> scroll_limit
)
15207 arg_scroll_conservatively
= scroll_limit
+ 1;
15208 scroll_max
= scroll_limit
* frame_line_height
;
15210 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15211 /* Compute how much we should try to scroll maximally to bring
15212 point into view. */
15213 scroll_max
= (max (scroll_step
,
15214 max (arg_scroll_conservatively
, temp_scroll_step
))
15215 * frame_line_height
);
15216 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15217 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15218 /* We're trying to scroll because of aggressive scrolling but no
15219 scroll_step is set. Choose an arbitrary one. */
15220 scroll_max
= 10 * frame_line_height
;
15226 /* Decide whether to scroll down. */
15227 if (PT
> CHARPOS (startp
))
15229 int scroll_margin_y
;
15231 /* Compute the pixel ypos of the scroll margin, then move IT to
15232 either that ypos or PT, whichever comes first. */
15233 start_display (&it
, w
, startp
);
15234 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15235 - frame_line_height
* extra_scroll_margin_lines
;
15236 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15237 (MOVE_TO_POS
| MOVE_TO_Y
));
15239 if (PT
> CHARPOS (it
.current
.pos
))
15241 int y0
= line_bottom_y (&it
);
15242 /* Compute how many pixels below window bottom to stop searching
15243 for PT. This avoids costly search for PT that is far away if
15244 the user limited scrolling by a small number of lines, but
15245 always finds PT if scroll_conservatively is set to a large
15246 number, such as most-positive-fixnum. */
15247 int slack
= max (scroll_max
, 10 * frame_line_height
);
15248 int y_to_move
= it
.last_visible_y
+ slack
;
15250 /* Compute the distance from the scroll margin to PT or to
15251 the scroll limit, whichever comes first. This should
15252 include the height of the cursor line, to make that line
15254 move_it_to (&it
, PT
, -1, y_to_move
,
15255 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15256 dy
= line_bottom_y (&it
) - y0
;
15258 if (dy
> scroll_max
)
15259 return SCROLLING_FAILED
;
15262 scroll_down_p
= true;
15268 /* Point is in or below the bottom scroll margin, so move the
15269 window start down. If scrolling conservatively, move it just
15270 enough down to make point visible. If scroll_step is set,
15271 move it down by scroll_step. */
15272 if (arg_scroll_conservatively
)
15274 = min (max (dy
, frame_line_height
),
15275 frame_line_height
* arg_scroll_conservatively
);
15276 else if (scroll_step
|| temp_scroll_step
)
15277 amount_to_scroll
= scroll_max
;
15280 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15281 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15282 if (NUMBERP (aggressive
))
15284 double float_amount
= XFLOATINT (aggressive
) * height
;
15285 int aggressive_scroll
= float_amount
;
15286 if (aggressive_scroll
== 0 && float_amount
> 0)
15287 aggressive_scroll
= 1;
15288 /* Don't let point enter the scroll margin near top of
15289 the window. This could happen if the value of
15290 scroll_up_aggressively is too large and there are
15291 non-zero margins, because scroll_up_aggressively
15292 means put point that fraction of window height
15293 _from_the_bottom_margin_. */
15294 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15295 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15296 amount_to_scroll
= dy
+ aggressive_scroll
;
15300 if (amount_to_scroll
<= 0)
15301 return SCROLLING_FAILED
;
15303 start_display (&it
, w
, startp
);
15304 if (arg_scroll_conservatively
<= scroll_limit
)
15305 move_it_vertically (&it
, amount_to_scroll
);
15308 /* Extra precision for users who set scroll-conservatively
15309 to a large number: make sure the amount we scroll
15310 the window start is never less than amount_to_scroll,
15311 which was computed as distance from window bottom to
15312 point. This matters when lines at window top and lines
15313 below window bottom have different height. */
15315 void *it1data
= NULL
;
15316 /* We use a temporary it1 because line_bottom_y can modify
15317 its argument, if it moves one line down; see there. */
15320 SAVE_IT (it1
, it
, it1data
);
15321 start_y
= line_bottom_y (&it1
);
15323 RESTORE_IT (&it
, &it
, it1data
);
15324 move_it_by_lines (&it
, 1);
15325 SAVE_IT (it1
, it
, it1data
);
15326 } while (IT_CHARPOS (it
) < ZV
15327 && line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15328 bidi_unshelve_cache (it1data
, true);
15331 /* If STARTP is unchanged, move it down another screen line. */
15332 if (IT_CHARPOS (it
) == CHARPOS (startp
))
15333 move_it_by_lines (&it
, 1);
15334 startp
= it
.current
.pos
;
15338 struct text_pos scroll_margin_pos
= startp
;
15341 /* See if point is inside the scroll margin at the top of the
15343 if (this_scroll_margin
)
15347 start_display (&it
, w
, startp
);
15348 y_start
= it
.current_y
;
15349 move_it_vertically (&it
, this_scroll_margin
);
15350 scroll_margin_pos
= it
.current
.pos
;
15351 /* If we didn't move enough before hitting ZV, request
15352 additional amount of scroll, to move point out of the
15354 if (IT_CHARPOS (it
) == ZV
15355 && it
.current_y
- y_start
< this_scroll_margin
)
15356 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15359 if (PT
< CHARPOS (scroll_margin_pos
))
15361 /* Point is in the scroll margin at the top of the window or
15362 above what is displayed in the window. */
15365 /* Compute the vertical distance from PT to the scroll
15366 margin position. Move as far as scroll_max allows, or
15367 one screenful, or 10 screen lines, whichever is largest.
15368 Give up if distance is greater than scroll_max or if we
15369 didn't reach the scroll margin position. */
15370 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15371 start_display (&it
, w
, pos
);
15373 y_to_move
= max (it
.last_visible_y
,
15374 max (scroll_max
, 10 * frame_line_height
));
15375 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15377 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15378 dy
= it
.current_y
- y0
;
15379 if (dy
> scroll_max
15380 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15381 return SCROLLING_FAILED
;
15383 /* Additional scroll for when ZV was too close to point. */
15386 /* Compute new window start. */
15387 start_display (&it
, w
, startp
);
15389 if (arg_scroll_conservatively
)
15390 amount_to_scroll
= max (dy
, frame_line_height
15391 * max (scroll_step
, temp_scroll_step
));
15392 else if (scroll_step
|| temp_scroll_step
)
15393 amount_to_scroll
= scroll_max
;
15396 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15397 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15398 if (NUMBERP (aggressive
))
15400 double float_amount
= XFLOATINT (aggressive
) * height
;
15401 int aggressive_scroll
= float_amount
;
15402 if (aggressive_scroll
== 0 && float_amount
> 0)
15403 aggressive_scroll
= 1;
15404 /* Don't let point enter the scroll margin near
15405 bottom of the window, if the value of
15406 scroll_down_aggressively happens to be too
15408 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15409 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15410 amount_to_scroll
= dy
+ aggressive_scroll
;
15414 if (amount_to_scroll
<= 0)
15415 return SCROLLING_FAILED
;
15417 move_it_vertically_backward (&it
, amount_to_scroll
);
15418 startp
= it
.current
.pos
;
15422 /* Run window scroll functions. */
15423 startp
= run_window_scroll_functions (window
, startp
);
15425 /* Display the window. Give up if new fonts are loaded, or if point
15427 if (!try_window (window
, startp
, 0))
15428 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15429 else if (w
->cursor
.vpos
< 0)
15431 clear_glyph_matrix (w
->desired_matrix
);
15432 rc
= SCROLLING_FAILED
;
15436 /* Maybe forget recorded base line for line number display. */
15437 if (!just_this_one_p
15438 || current_buffer
->clip_changed
15439 || BEG_UNCHANGED
< CHARPOS (startp
))
15440 w
->base_line_number
= 0;
15442 /* If cursor ends up on a partially visible line,
15443 treat that as being off the bottom of the screen. */
15444 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1,
15446 /* It's possible that the cursor is on the first line of the
15447 buffer, which is partially obscured due to a vscroll
15448 (Bug#7537). In that case, avoid looping forever. */
15449 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15451 clear_glyph_matrix (w
->desired_matrix
);
15452 ++extra_scroll_margin_lines
;
15455 rc
= SCROLLING_SUCCESS
;
15462 /* Compute a suitable window start for window W if display of W starts
15463 on a continuation line. Value is true if a new window start
15466 The new window start will be computed, based on W's width, starting
15467 from the start of the continued line. It is the start of the
15468 screen line with the minimum distance from the old start W->start. */
15471 compute_window_start_on_continuation_line (struct window
*w
)
15473 struct text_pos pos
, start_pos
;
15474 bool window_start_changed_p
= false;
15476 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15478 /* If window start is on a continuation line... Window start may be
15479 < BEGV in case there's invisible text at the start of the
15480 buffer (M-x rmail, for example). */
15481 if (CHARPOS (start_pos
) > BEGV
15482 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15485 struct glyph_row
*row
;
15487 /* Handle the case that the window start is out of range. */
15488 if (CHARPOS (start_pos
) < BEGV
)
15489 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15490 else if (CHARPOS (start_pos
) > ZV
)
15491 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15493 /* Find the start of the continued line. This should be fast
15494 because find_newline is fast (newline cache). */
15495 row
= w
->desired_matrix
->rows
+ WINDOW_WANTS_HEADER_LINE_P (w
);
15496 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15497 row
, DEFAULT_FACE_ID
);
15498 reseat_at_previous_visible_line_start (&it
);
15500 /* If the line start is "too far" away from the window start,
15501 say it takes too much time to compute a new window start. */
15502 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15503 /* PXW: Do we need upper bounds here? */
15504 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15506 int min_distance
, distance
;
15508 /* Move forward by display lines to find the new window
15509 start. If window width was enlarged, the new start can
15510 be expected to be > the old start. If window width was
15511 decreased, the new window start will be < the old start.
15512 So, we're looking for the display line start with the
15513 minimum distance from the old window start. */
15514 pos
= it
.current
.pos
;
15515 min_distance
= INFINITY
;
15516 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15517 distance
< min_distance
)
15519 min_distance
= distance
;
15520 pos
= it
.current
.pos
;
15521 if (it
.line_wrap
== WORD_WRAP
)
15523 /* Under WORD_WRAP, move_it_by_lines is likely to
15524 overshoot and stop not at the first, but the
15525 second character from the left margin. So in
15526 that case, we need a more tight control on the X
15527 coordinate of the iterator than move_it_by_lines
15528 promises in its contract. The method is to first
15529 go to the last (rightmost) visible character of a
15530 line, then move to the leftmost character on the
15531 next line in a separate call. */
15532 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15533 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15534 move_it_to (&it
, ZV
, 0,
15535 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15536 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15539 move_it_by_lines (&it
, 1);
15542 /* Set the window start there. */
15543 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15544 window_start_changed_p
= true;
15548 return window_start_changed_p
;
15552 /* Try cursor movement in case text has not changed in window WINDOW,
15553 with window start STARTP. Value is
15555 CURSOR_MOVEMENT_SUCCESS if successful
15557 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15559 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15560 display. *SCROLL_STEP is set to true, under certain circumstances, if
15561 we want to scroll as if scroll-step were set to 1. See the code.
15563 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15564 which case we have to abort this redisplay, and adjust matrices
15569 CURSOR_MOVEMENT_SUCCESS
,
15570 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15571 CURSOR_MOVEMENT_MUST_SCROLL
,
15572 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15576 try_cursor_movement (Lisp_Object window
, struct text_pos startp
,
15579 struct window
*w
= XWINDOW (window
);
15580 struct frame
*f
= XFRAME (w
->frame
);
15581 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15584 if (inhibit_try_cursor_movement
)
15588 /* Previously, there was a check for Lisp integer in the
15589 if-statement below. Now, this field is converted to
15590 ptrdiff_t, thus zero means invalid position in a buffer. */
15591 eassert (w
->last_point
> 0);
15592 /* Likewise there was a check whether window_end_vpos is nil or larger
15593 than the window. Now window_end_vpos is int and so never nil, but
15594 let's leave eassert to check whether it fits in the window. */
15595 eassert (!w
->window_end_valid
15596 || w
->window_end_vpos
< w
->current_matrix
->nrows
);
15598 /* Handle case where text has not changed, only point, and it has
15599 not moved off the frame. */
15600 if (/* Point may be in this window. */
15601 PT
>= CHARPOS (startp
)
15602 /* Selective display hasn't changed. */
15603 && !current_buffer
->clip_changed
15604 /* Function force-mode-line-update is used to force a thorough
15605 redisplay. It sets either windows_or_buffers_changed or
15606 update_mode_lines. So don't take a shortcut here for these
15608 && !update_mode_lines
15609 && !windows_or_buffers_changed
15610 && !f
->cursor_type_changed
15611 && NILP (Vshow_trailing_whitespace
)
15612 /* This code is not used for mini-buffer for the sake of the case
15613 of redisplaying to replace an echo area message; since in
15614 that case the mini-buffer contents per se are usually
15615 unchanged. This code is of no real use in the mini-buffer
15616 since the handling of this_line_start_pos, etc., in redisplay
15617 handles the same cases. */
15618 && !EQ (window
, minibuf_window
)
15619 && (FRAME_WINDOW_P (f
)
15620 || !overlay_arrow_in_current_buffer_p ()))
15622 int this_scroll_margin
, top_scroll_margin
;
15623 struct glyph_row
*row
= NULL
;
15624 int frame_line_height
= default_line_pixel_height (w
);
15625 int window_total_lines
15626 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15629 debug_method_add (w
, "cursor movement");
15632 /* Scroll if point within this distance from the top or bottom
15633 of the window. This is a pixel value. */
15634 if (scroll_margin
> 0)
15636 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15637 this_scroll_margin
*= frame_line_height
;
15640 this_scroll_margin
= 0;
15642 top_scroll_margin
= this_scroll_margin
;
15643 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15644 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15646 /* Start with the row the cursor was displayed during the last
15647 not paused redisplay. Give up if that row is not valid. */
15648 if (w
->last_cursor_vpos
< 0
15649 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15650 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15653 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15654 if (row
->mode_line_p
)
15656 if (!row
->enabled_p
)
15657 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15660 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15662 bool scroll_p
= false, must_scroll
= false;
15663 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15665 if (PT
> w
->last_point
)
15667 /* Point has moved forward. */
15668 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15669 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15671 eassert (row
->enabled_p
);
15675 /* If the end position of a row equals the start
15676 position of the next row, and PT is at that position,
15677 we would rather display cursor in the next line. */
15678 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15679 && MATRIX_ROW_END_CHARPOS (row
) == PT
15680 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15681 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15682 && !cursor_row_p (row
))
15685 /* If within the scroll margin, scroll. Note that
15686 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15687 the next line would be drawn, and that
15688 this_scroll_margin can be zero. */
15689 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15690 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15691 /* Line is completely visible last line in window
15692 and PT is to be set in the next line. */
15693 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15694 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15695 && !row
->ends_at_zv_p
15696 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15699 else if (PT
< w
->last_point
)
15701 /* Cursor has to be moved backward. Note that PT >=
15702 CHARPOS (startp) because of the outer if-statement. */
15703 while (!row
->mode_line_p
15704 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15705 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15706 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15707 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15708 row
> w
->current_matrix
->rows
15709 && (row
-1)->ends_in_newline_from_string_p
))))
15710 && (row
->y
> top_scroll_margin
15711 || CHARPOS (startp
) == BEGV
))
15713 eassert (row
->enabled_p
);
15717 /* Consider the following case: Window starts at BEGV,
15718 there is invisible, intangible text at BEGV, so that
15719 display starts at some point START > BEGV. It can
15720 happen that we are called with PT somewhere between
15721 BEGV and START. Try to handle that case. */
15722 if (row
< w
->current_matrix
->rows
15723 || row
->mode_line_p
)
15725 row
= w
->current_matrix
->rows
;
15726 if (row
->mode_line_p
)
15730 /* Due to newlines in overlay strings, we may have to
15731 skip forward over overlay strings. */
15732 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15733 && MATRIX_ROW_END_CHARPOS (row
) == PT
15734 && !cursor_row_p (row
))
15737 /* If within the scroll margin, scroll. */
15738 if (row
->y
< top_scroll_margin
15739 && CHARPOS (startp
) != BEGV
)
15744 /* Cursor did not move. So don't scroll even if cursor line
15745 is partially visible, as it was so before. */
15746 rc
= CURSOR_MOVEMENT_SUCCESS
;
15749 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15750 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15752 /* if PT is not in the glyph row, give up. */
15753 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15754 must_scroll
= true;
15756 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15757 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15759 struct glyph_row
*row1
;
15761 /* If rows are bidi-reordered and point moved, back up
15762 until we find a row that does not belong to a
15763 continuation line. This is because we must consider
15764 all rows of a continued line as candidates for the
15765 new cursor positioning, since row start and end
15766 positions change non-linearly with vertical position
15768 /* FIXME: Revisit this when glyph ``spilling'' in
15769 continuation lines' rows is implemented for
15770 bidi-reordered rows. */
15771 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15772 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15775 /* If we hit the beginning of the displayed portion
15776 without finding the first row of a continued
15780 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15783 eassert (row
->enabled_p
);
15788 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15789 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15790 /* Make sure this isn't a header line by any chance, since
15791 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield true. */
15792 && !row
->mode_line_p
15793 && make_cursor_line_fully_visible_p
)
15795 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15796 && !row
->ends_at_zv_p
15797 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15798 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15799 else if (row
->height
> window_box_height (w
))
15801 /* If we end up in a partially visible line, let's
15802 make it fully visible, except when it's taller
15803 than the window, in which case we can't do much
15805 *scroll_step
= true;
15806 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15810 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15811 if (!cursor_row_fully_visible_p (w
, false, true))
15812 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15814 rc
= CURSOR_MOVEMENT_SUCCESS
;
15818 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15819 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15820 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15822 /* With bidi-reordered rows, there could be more than
15823 one candidate row whose start and end positions
15824 occlude point. We need to let set_cursor_from_row
15825 find the best candidate. */
15826 /* FIXME: Revisit this when glyph ``spilling'' in
15827 continuation lines' rows is implemented for
15828 bidi-reordered rows. */
15833 bool at_zv_p
= false, exact_match_p
= false;
15835 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15836 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15837 && cursor_row_p (row
))
15838 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15840 /* As soon as we've found the exact match for point,
15841 or the first suitable row whose ends_at_zv_p flag
15842 is set, we are done. */
15845 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15846 w
->cursor
.vpos
)->ends_at_zv_p
;
15848 && w
->cursor
.hpos
>= 0
15849 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15852 struct glyph_row
*candidate
=
15853 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15855 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15856 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15859 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15860 || (NILP (g
->object
)
15861 && (g
->charpos
== PT
15862 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15864 if (at_zv_p
|| exact_match_p
)
15866 rc
= CURSOR_MOVEMENT_SUCCESS
;
15870 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15874 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15875 || row
->continued_p
)
15876 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15877 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15878 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15879 /* If we didn't find any candidate rows, or exited the
15880 loop before all the candidates were examined, signal
15881 to the caller that this method failed. */
15882 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15884 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15885 && !row
->continued_p
))
15886 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15888 rc
= CURSOR_MOVEMENT_SUCCESS
;
15894 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15896 rc
= CURSOR_MOVEMENT_SUCCESS
;
15901 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15902 && MATRIX_ROW_START_CHARPOS (row
) == PT
15903 && cursor_row_p (row
));
15913 set_vertical_scroll_bar (struct window
*w
)
15915 ptrdiff_t start
, end
, whole
;
15917 /* Calculate the start and end positions for the current window.
15918 At some point, it would be nice to choose between scrollbars
15919 which reflect the whole buffer size, with special markers
15920 indicating narrowing, and scrollbars which reflect only the
15923 Note that mini-buffers sometimes aren't displaying any text. */
15924 if (!MINI_WINDOW_P (w
)
15925 || (w
== XWINDOW (minibuf_window
)
15926 && NILP (echo_area_buffer
[0])))
15928 struct buffer
*buf
= XBUFFER (w
->contents
);
15929 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15930 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15931 /* I don't think this is guaranteed to be right. For the
15932 moment, we'll pretend it is. */
15933 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15937 if (whole
< (end
- start
))
15938 whole
= end
- start
;
15941 start
= end
= whole
= 0;
15943 /* Indicate what this scroll bar ought to be displaying now. */
15944 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15945 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15946 (w
, end
- start
, whole
, start
);
15951 set_horizontal_scroll_bar (struct window
*w
)
15953 int start
, end
, whole
, portion
;
15955 if (!MINI_WINDOW_P (w
)
15956 || (w
== XWINDOW (minibuf_window
)
15957 && NILP (echo_area_buffer
[0])))
15959 struct buffer
*b
= XBUFFER (w
->contents
);
15960 struct buffer
*old_buffer
= NULL
;
15962 struct text_pos startp
;
15964 if (b
!= current_buffer
)
15966 old_buffer
= current_buffer
;
15967 set_buffer_internal (b
);
15970 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15971 start_display (&it
, w
, startp
);
15972 it
.last_visible_x
= INT_MAX
;
15973 whole
= move_it_to (&it
, -1, INT_MAX
, window_box_height (w
), -1,
15974 MOVE_TO_X
| MOVE_TO_Y
);
15975 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
15976 window_box_height (w), -1,
15977 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
15979 start
= w
->hscroll
* FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
));
15980 end
= start
+ window_box_width (w
, TEXT_AREA
);
15981 portion
= end
- start
;
15982 /* After enlarging a horizontally scrolled window such that it
15983 gets at least as wide as the text it contains, make sure that
15984 the thumb doesn't fill the entire scroll bar so we can still
15985 drag it back to see the entire text. */
15986 whole
= max (whole
, end
);
15992 pdir
= Fcurrent_bidi_paragraph_direction (Qnil
);
15993 if (EQ (pdir
, Qright_to_left
))
15995 start
= whole
- end
;
15996 end
= start
+ portion
;
16001 set_buffer_internal (old_buffer
);
16004 start
= end
= whole
= portion
= 0;
16006 w
->hscroll_whole
= whole
;
16008 /* Indicate what this scroll bar ought to be displaying now. */
16009 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
16010 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
16011 (w
, portion
, whole
, start
);
16015 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P means only
16016 selected_window is redisplayed.
16018 We can return without actually redisplaying the window if fonts has been
16019 changed on window's frame. In that case, redisplay_internal will retry.
16021 As one of the important parts of redisplaying a window, we need to
16022 decide whether the previous window-start position (stored in the
16023 window's w->start marker position) is still valid, and if it isn't,
16024 recompute it. Some details about that:
16026 . The previous window-start could be in a continuation line, in
16027 which case we need to recompute it when the window width
16028 changes. See compute_window_start_on_continuation_line and its
16031 . The text that changed since last redisplay could include the
16032 previous window-start position. In that case, we try to salvage
16033 what we can from the current glyph matrix by calling
16034 try_scrolling, which see.
16036 . Some Emacs command could force us to use a specific window-start
16037 position by setting the window's force_start flag, or gently
16038 propose doing that by setting the window's optional_new_start
16039 flag. In these cases, we try using the specified start point if
16040 that succeeds (i.e. the window desired matrix is successfully
16041 recomputed, and point location is within the window). In case
16042 of optional_new_start, we first check if the specified start
16043 position is feasible, i.e. if it will allow point to be
16044 displayed in the window. If using the specified start point
16045 fails, e.g., if new fonts are needed to be loaded, we abort the
16046 redisplay cycle and leave it up to the next cycle to figure out
16049 . Note that the window's force_start flag is sometimes set by
16050 redisplay itself, when it decides that the previous window start
16051 point is fine and should be kept. Search for "goto force_start"
16052 below to see the details. Like the values of window-start
16053 specified outside of redisplay, these internally-deduced values
16054 are tested for feasibility, and ignored if found to be
16057 . Note that the function try_window, used to completely redisplay
16058 a window, accepts the window's start point as its argument.
16059 This is used several times in the redisplay code to control
16060 where the window start will be, according to user options such
16061 as scroll-conservatively, and also to ensure the screen line
16062 showing point will be fully (as opposed to partially) visible on
16066 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
16068 struct window
*w
= XWINDOW (window
);
16069 struct frame
*f
= XFRAME (w
->frame
);
16070 struct buffer
*buffer
= XBUFFER (w
->contents
);
16071 struct buffer
*old
= current_buffer
;
16072 struct text_pos lpoint
, opoint
, startp
;
16073 bool update_mode_line
;
16076 /* Record it now because it's overwritten. */
16077 bool current_matrix_up_to_date_p
= false;
16078 bool used_current_matrix_p
= false;
16079 /* This is less strict than current_matrix_up_to_date_p.
16080 It indicates that the buffer contents and narrowing are unchanged. */
16081 bool buffer_unchanged_p
= false;
16082 bool temp_scroll_step
= false;
16083 ptrdiff_t count
= SPECPDL_INDEX ();
16085 int centering_position
= -1;
16086 bool last_line_misfit
= false;
16087 ptrdiff_t beg_unchanged
, end_unchanged
;
16088 int frame_line_height
;
16089 bool use_desired_matrix
;
16091 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16095 *w
->desired_matrix
->method
= 0;
16098 if (!just_this_one_p
16099 && REDISPLAY_SOME_P ()
16101 && !w
->update_mode_line
16104 && !buffer
->text
->redisplay
16105 && BUF_PT (buffer
) == w
->last_point
)
16108 /* Make sure that both W's markers are valid. */
16109 eassert (XMARKER (w
->start
)->buffer
== buffer
);
16110 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
16112 /* We come here again if we need to run window-text-change-functions
16115 reconsider_clip_changes (w
);
16116 frame_line_height
= default_line_pixel_height (w
);
16118 /* Has the mode line to be updated? */
16119 update_mode_line
= (w
->update_mode_line
16120 || update_mode_lines
16121 || buffer
->clip_changed
16122 || buffer
->prevent_redisplay_optimizations_p
);
16124 if (!just_this_one_p
)
16125 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
16126 cleverly elsewhere. */
16127 w
->must_be_updated_p
= true;
16129 if (MINI_WINDOW_P (w
))
16131 if (w
== XWINDOW (echo_area_window
)
16132 && !NILP (echo_area_buffer
[0]))
16134 if (update_mode_line
)
16135 /* We may have to update a tty frame's menu bar or a
16136 tool-bar. Example `M-x C-h C-h C-g'. */
16137 goto finish_menu_bars
;
16139 /* We've already displayed the echo area glyphs in this window. */
16140 goto finish_scroll_bars
;
16142 else if ((w
!= XWINDOW (minibuf_window
)
16143 || minibuf_level
== 0)
16144 /* When buffer is nonempty, redisplay window normally. */
16145 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
16146 /* Quail displays non-mini buffers in minibuffer window.
16147 In that case, redisplay the window normally. */
16148 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
16150 /* W is a mini-buffer window, but it's not active, so clear
16152 int yb
= window_text_bottom_y (w
);
16153 struct glyph_row
*row
;
16156 for (y
= 0, row
= w
->desired_matrix
->rows
;
16158 y
+= row
->height
, ++row
)
16159 blank_row (w
, row
, y
);
16160 goto finish_scroll_bars
;
16163 clear_glyph_matrix (w
->desired_matrix
);
16166 /* Otherwise set up data on this window; select its buffer and point
16168 /* Really select the buffer, for the sake of buffer-local
16170 set_buffer_internal_1 (XBUFFER (w
->contents
));
16172 current_matrix_up_to_date_p
16173 = (w
->window_end_valid
16174 && !current_buffer
->clip_changed
16175 && !current_buffer
->prevent_redisplay_optimizations_p
16176 && !window_outdated (w
));
16178 /* Run the window-text-change-functions
16179 if it is possible that the text on the screen has changed
16180 (either due to modification of the text, or any other reason). */
16181 if (!current_matrix_up_to_date_p
16182 && !NILP (Vwindow_text_change_functions
))
16184 safe_run_hooks (Qwindow_text_change_functions
);
16188 beg_unchanged
= BEG_UNCHANGED
;
16189 end_unchanged
= END_UNCHANGED
;
16191 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
16193 specbind (Qinhibit_point_motion_hooks
, Qt
);
16196 = (w
->window_end_valid
16197 && !current_buffer
->clip_changed
16198 && !window_outdated (w
));
16200 /* When windows_or_buffers_changed is non-zero, we can't rely
16201 on the window end being valid, so set it to zero there. */
16202 if (windows_or_buffers_changed
)
16204 /* If window starts on a continuation line, maybe adjust the
16205 window start in case the window's width changed. */
16206 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16207 compute_window_start_on_continuation_line (w
);
16209 w
->window_end_valid
= false;
16210 /* If so, we also can't rely on current matrix
16211 and should not fool try_cursor_movement below. */
16212 current_matrix_up_to_date_p
= false;
16215 /* Some sanity checks. */
16216 CHECK_WINDOW_END (w
);
16217 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16219 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16222 if (mode_line_update_needed (w
))
16223 update_mode_line
= true;
16225 /* Point refers normally to the selected window. For any other
16226 window, set up appropriate value. */
16227 if (!EQ (window
, selected_window
))
16229 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16230 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16235 new_pt_byte
= BEGV_BYTE
;
16236 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16238 else if (new_pt
> (ZV
- 1))
16241 new_pt_byte
= ZV_BYTE
;
16242 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16245 /* We don't use SET_PT so that the point-motion hooks don't run. */
16246 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16249 /* If any of the character widths specified in the display table
16250 have changed, invalidate the width run cache. It's true that
16251 this may be a bit late to catch such changes, but the rest of
16252 redisplay goes (non-fatally) haywire when the display table is
16253 changed, so why should we worry about doing any better? */
16254 if (current_buffer
->width_run_cache
16255 || (current_buffer
->base_buffer
16256 && current_buffer
->base_buffer
->width_run_cache
))
16258 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16260 if (! disptab_matches_widthtab
16261 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16263 struct buffer
*buf
= current_buffer
;
16265 if (buf
->base_buffer
)
16266 buf
= buf
->base_buffer
;
16267 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16268 recompute_width_table (current_buffer
, disptab
);
16272 /* If window-start is screwed up, choose a new one. */
16273 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16276 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16278 /* If someone specified a new starting point but did not insist,
16279 check whether it can be used. */
16280 if ((w
->optional_new_start
|| window_frozen_p (w
))
16281 && CHARPOS (startp
) >= BEGV
16282 && CHARPOS (startp
) <= ZV
)
16284 ptrdiff_t it_charpos
;
16286 w
->optional_new_start
= false;
16287 start_display (&it
, w
, startp
);
16288 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16289 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16290 /* Record IT's position now, since line_bottom_y might change
16292 it_charpos
= IT_CHARPOS (it
);
16293 /* Make sure we set the force_start flag only if the cursor row
16294 will be fully visible. Otherwise, the code under force_start
16295 label below will try to move point back into view, which is
16296 not what the code which sets optional_new_start wants. */
16297 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
16298 && !w
->force_start
)
16300 if (it_charpos
== PT
)
16301 w
->force_start
= true;
16302 /* IT may overshoot PT if text at PT is invisible. */
16303 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16304 w
->force_start
= true;
16306 if (w
->force_start
)
16308 if (window_frozen_p (w
))
16309 debug_method_add (w
, "set force_start from frozen window start");
16311 debug_method_add (w
, "set force_start from optional_new_start");
16319 /* Handle case where place to start displaying has been specified,
16320 unless the specified location is outside the accessible range. */
16321 if (w
->force_start
)
16323 /* We set this later on if we have to adjust point. */
16326 w
->force_start
= false;
16328 w
->window_end_valid
= false;
16330 /* Forget any recorded base line for line number display. */
16331 if (!buffer_unchanged_p
)
16332 w
->base_line_number
= 0;
16334 /* Redisplay the mode line. Select the buffer properly for that.
16335 Also, run the hook window-scroll-functions
16336 because we have scrolled. */
16337 /* Note, we do this after clearing force_start because
16338 if there's an error, it is better to forget about force_start
16339 than to get into an infinite loop calling the hook functions
16340 and having them get more errors. */
16341 if (!update_mode_line
16342 || ! NILP (Vwindow_scroll_functions
))
16344 update_mode_line
= true;
16345 w
->update_mode_line
= true;
16346 startp
= run_window_scroll_functions (window
, startp
);
16349 if (CHARPOS (startp
) < BEGV
)
16350 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16351 else if (CHARPOS (startp
) > ZV
)
16352 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16354 /* Redisplay, then check if cursor has been set during the
16355 redisplay. Give up if new fonts were loaded. */
16356 /* We used to issue a CHECK_MARGINS argument to try_window here,
16357 but this causes scrolling to fail when point begins inside
16358 the scroll margin (bug#148) -- cyd */
16359 if (!try_window (window
, startp
, 0))
16361 w
->force_start
= true;
16362 clear_glyph_matrix (w
->desired_matrix
);
16363 goto need_larger_matrices
;
16366 if (w
->cursor
.vpos
< 0)
16368 /* If point does not appear, try to move point so it does
16369 appear. The desired matrix has been built above, so we
16370 can use it here. First see if point is in invisible
16371 text, and if so, move it to the first visible buffer
16372 position past that. */
16373 struct glyph_row
*r
= NULL
;
16374 Lisp_Object invprop
=
16375 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16378 if (TEXT_PROP_MEANS_INVISIBLE (invprop
) != 0)
16381 Lisp_Object invprop_end
=
16382 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16385 if (NATNUMP (invprop_end
))
16386 alt_pt
= XFASTINT (invprop_end
);
16389 r
= row_containing_pos (w
, alt_pt
, w
->desired_matrix
->rows
,
16393 new_vpos
= MATRIX_ROW_BOTTOM_Y (r
);
16394 else /* Give up and just move to the middle of the window. */
16395 new_vpos
= window_box_height (w
) / 2;
16398 if (!cursor_row_fully_visible_p (w
, false, false))
16400 /* Point does appear, but on a line partly visible at end of window.
16401 Move it back to a fully-visible line. */
16402 new_vpos
= window_box_height (w
);
16403 /* But if window_box_height suggests a Y coordinate that is
16404 not less than we already have, that line will clearly not
16405 be fully visible, so give up and scroll the display.
16406 This can happen when the default face uses a font whose
16407 dimensions are different from the frame's default
16409 if (new_vpos
>= w
->cursor
.y
)
16411 w
->cursor
.vpos
= -1;
16412 clear_glyph_matrix (w
->desired_matrix
);
16413 goto try_to_scroll
;
16416 else if (w
->cursor
.vpos
>= 0)
16418 /* Some people insist on not letting point enter the scroll
16419 margin, even though this part handles windows that didn't
16421 int window_total_lines
16422 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16423 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16424 int pixel_margin
= margin
* frame_line_height
;
16425 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16427 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16428 below, which finds the row to move point to, advances by
16429 the Y coordinate of the _next_ row, see the definition of
16430 MATRIX_ROW_BOTTOM_Y. */
16431 if (w
->cursor
.vpos
< margin
+ header_line
)
16433 w
->cursor
.vpos
= -1;
16434 clear_glyph_matrix (w
->desired_matrix
);
16435 goto try_to_scroll
;
16439 int window_height
= window_box_height (w
);
16442 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16443 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16445 w
->cursor
.vpos
= -1;
16446 clear_glyph_matrix (w
->desired_matrix
);
16447 goto try_to_scroll
;
16452 /* If we need to move point for either of the above reasons,
16453 now actually do it. */
16456 struct glyph_row
*row
;
16458 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16459 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16462 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16463 MATRIX_ROW_START_BYTEPOS (row
));
16465 if (w
!= XWINDOW (selected_window
))
16466 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16467 else if (current_buffer
== old
)
16468 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16470 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16472 /* Re-run pre-redisplay-function so it can update the region
16473 according to the new position of point. */
16474 /* Other than the cursor, w's redisplay is done so we can set its
16475 redisplay to false. Also the buffer's redisplay can be set to
16476 false, since propagate_buffer_redisplay should have already
16477 propagated its info to `w' anyway. */
16478 w
->redisplay
= false;
16479 XBUFFER (w
->contents
)->text
->redisplay
= false;
16480 safe__call1 (true, Vpre_redisplay_function
, Fcons (window
, Qnil
));
16482 if (w
->redisplay
|| XBUFFER (w
->contents
)->text
->redisplay
)
16484 /* pre-redisplay-function made changes (e.g. move the region)
16485 that require another round of redisplay. */
16486 clear_glyph_matrix (w
->desired_matrix
);
16487 if (!try_window (window
, startp
, 0))
16488 goto need_larger_matrices
;
16491 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, false, false))
16493 clear_glyph_matrix (w
->desired_matrix
);
16494 goto try_to_scroll
;
16498 debug_method_add (w
, "forced window start");
16503 /* Handle case where text has not changed, only point, and it has
16504 not moved off the frame, and we are not retrying after hscroll.
16505 (current_matrix_up_to_date_p is true when retrying.) */
16506 if (current_matrix_up_to_date_p
16507 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16508 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16512 case CURSOR_MOVEMENT_SUCCESS
:
16513 used_current_matrix_p
= true;
16516 case CURSOR_MOVEMENT_MUST_SCROLL
:
16517 goto try_to_scroll
;
16523 /* If current starting point was originally the beginning of a line
16524 but no longer is, find a new starting point. */
16525 else if (w
->start_at_line_beg
16526 && !(CHARPOS (startp
) <= BEGV
16527 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16530 debug_method_add (w
, "recenter 1");
16535 /* Try scrolling with try_window_id. Value is > 0 if update has
16536 been done, it is -1 if we know that the same window start will
16537 not work. It is 0 if unsuccessful for some other reason. */
16538 else if ((tem
= try_window_id (w
)) != 0)
16541 debug_method_add (w
, "try_window_id %d", tem
);
16544 if (f
->fonts_changed
)
16545 goto need_larger_matrices
;
16549 /* Otherwise try_window_id has returned -1 which means that we
16550 don't want the alternative below this comment to execute. */
16552 else if (CHARPOS (startp
) >= BEGV
16553 && CHARPOS (startp
) <= ZV
16554 && PT
>= CHARPOS (startp
)
16555 && (CHARPOS (startp
) < ZV
16556 /* Avoid starting at end of buffer. */
16557 || CHARPOS (startp
) == BEGV
16558 || !window_outdated (w
)))
16560 int d1
, d2
, d5
, d6
;
16563 /* If first window line is a continuation line, and window start
16564 is inside the modified region, but the first change is before
16565 current window start, we must select a new window start.
16567 However, if this is the result of a down-mouse event (e.g. by
16568 extending the mouse-drag-overlay), we don't want to select a
16569 new window start, since that would change the position under
16570 the mouse, resulting in an unwanted mouse-movement rather
16571 than a simple mouse-click. */
16572 if (!w
->start_at_line_beg
16573 && NILP (do_mouse_tracking
)
16574 && CHARPOS (startp
) > BEGV
16575 && CHARPOS (startp
) > BEG
+ beg_unchanged
16576 && CHARPOS (startp
) <= Z
- end_unchanged
16577 /* Even if w->start_at_line_beg is nil, a new window may
16578 start at a line_beg, since that's how set_buffer_window
16579 sets it. So, we need to check the return value of
16580 compute_window_start_on_continuation_line. (See also
16582 && XMARKER (w
->start
)->buffer
== current_buffer
16583 && compute_window_start_on_continuation_line (w
)
16584 /* It doesn't make sense to force the window start like we
16585 do at label force_start if it is already known that point
16586 will not be fully visible in the resulting window, because
16587 doing so will move point from its correct position
16588 instead of scrolling the window to bring point into view.
16590 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16591 /* A very tall row could need more than the window height,
16592 in which case we accept that it is partially visible. */
16593 && (rtop
!= 0) == (rbot
!= 0))
16595 w
->force_start
= true;
16596 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16598 debug_method_add (w
, "recomputed window start in continuation line");
16604 debug_method_add (w
, "same window start");
16607 /* Try to redisplay starting at same place as before.
16608 If point has not moved off frame, accept the results. */
16609 if (!current_matrix_up_to_date_p
16610 /* Don't use try_window_reusing_current_matrix in this case
16611 because a window scroll function can have changed the
16613 || !NILP (Vwindow_scroll_functions
)
16614 || MINI_WINDOW_P (w
)
16615 || !(used_current_matrix_p
16616 = try_window_reusing_current_matrix (w
)))
16618 IF_DEBUG (debug_method_add (w
, "1"));
16619 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16620 /* -1 means we need to scroll.
16621 0 means we need new matrices, but fonts_changed
16622 is set in that case, so we will detect it below. */
16623 goto try_to_scroll
;
16626 if (f
->fonts_changed
)
16627 goto need_larger_matrices
;
16629 if (w
->cursor
.vpos
>= 0)
16631 if (!just_this_one_p
16632 || current_buffer
->clip_changed
16633 || BEG_UNCHANGED
< CHARPOS (startp
))
16634 /* Forget any recorded base line for line number display. */
16635 w
->base_line_number
= 0;
16637 if (!cursor_row_fully_visible_p (w
, true, false))
16639 clear_glyph_matrix (w
->desired_matrix
);
16640 last_line_misfit
= true;
16642 /* Drop through and scroll. */
16647 clear_glyph_matrix (w
->desired_matrix
);
16652 /* Redisplay the mode line. Select the buffer properly for that. */
16653 if (!update_mode_line
)
16655 update_mode_line
= true;
16656 w
->update_mode_line
= true;
16659 /* Try to scroll by specified few lines. */
16660 if ((scroll_conservatively
16661 || emacs_scroll_step
16662 || temp_scroll_step
16663 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16664 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16665 && CHARPOS (startp
) >= BEGV
16666 && CHARPOS (startp
) <= ZV
)
16668 /* The function returns -1 if new fonts were loaded, 1 if
16669 successful, 0 if not successful. */
16670 int ss
= try_scrolling (window
, just_this_one_p
,
16671 scroll_conservatively
,
16673 temp_scroll_step
, last_line_misfit
);
16676 case SCROLLING_SUCCESS
:
16679 case SCROLLING_NEED_LARGER_MATRICES
:
16680 goto need_larger_matrices
;
16682 case SCROLLING_FAILED
:
16690 /* Finally, just choose a place to start which positions point
16691 according to user preferences. */
16696 debug_method_add (w
, "recenter");
16699 /* Forget any previously recorded base line for line number display. */
16700 if (!buffer_unchanged_p
)
16701 w
->base_line_number
= 0;
16703 /* Determine the window start relative to point. */
16704 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16705 it
.current_y
= it
.last_visible_y
;
16706 if (centering_position
< 0)
16708 int window_total_lines
16709 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16711 = scroll_margin
> 0
16712 ? min (scroll_margin
, window_total_lines
/ 4)
16714 ptrdiff_t margin_pos
= CHARPOS (startp
);
16715 Lisp_Object aggressive
;
16718 /* If there is a scroll margin at the top of the window, find
16719 its character position. */
16721 /* Cannot call start_display if startp is not in the
16722 accessible region of the buffer. This can happen when we
16723 have just switched to a different buffer and/or changed
16724 its restriction. In that case, startp is initialized to
16725 the character position 1 (BEGV) because we did not yet
16726 have chance to display the buffer even once. */
16727 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16730 void *it1data
= NULL
;
16732 SAVE_IT (it1
, it
, it1data
);
16733 start_display (&it1
, w
, startp
);
16734 move_it_vertically (&it1
, margin
* frame_line_height
);
16735 margin_pos
= IT_CHARPOS (it1
);
16736 RESTORE_IT (&it
, &it
, it1data
);
16738 scrolling_up
= PT
> margin_pos
;
16741 ? BVAR (current_buffer
, scroll_up_aggressively
)
16742 : BVAR (current_buffer
, scroll_down_aggressively
);
16744 if (!MINI_WINDOW_P (w
)
16745 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16749 /* Setting scroll-conservatively overrides
16750 scroll-*-aggressively. */
16751 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16753 double float_amount
= XFLOATINT (aggressive
);
16755 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16756 if (pt_offset
== 0 && float_amount
> 0)
16758 if (pt_offset
&& margin
> 0)
16761 /* Compute how much to move the window start backward from
16762 point so that point will be displayed where the user
16766 centering_position
= it
.last_visible_y
;
16768 centering_position
-= pt_offset
;
16769 centering_position
-=
16770 (frame_line_height
* (1 + margin
+ last_line_misfit
)
16771 + WINDOW_HEADER_LINE_HEIGHT (w
));
16772 /* Don't let point enter the scroll margin near top of
16774 if (centering_position
< margin
* frame_line_height
)
16775 centering_position
= margin
* frame_line_height
;
16778 centering_position
= margin
* frame_line_height
+ pt_offset
;
16781 /* Set the window start half the height of the window backward
16783 centering_position
= window_box_height (w
) / 2;
16785 move_it_vertically_backward (&it
, centering_position
);
16787 eassert (IT_CHARPOS (it
) >= BEGV
);
16789 /* The function move_it_vertically_backward may move over more
16790 than the specified y-distance. If it->w is small, e.g. a
16791 mini-buffer window, we may end up in front of the window's
16792 display area. Start displaying at the start of the line
16793 containing PT in this case. */
16794 if (it
.current_y
<= 0)
16796 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16797 move_it_vertically_backward (&it
, 0);
16801 it
.current_x
= it
.hpos
= 0;
16803 /* Set the window start position here explicitly, to avoid an
16804 infinite loop in case the functions in window-scroll-functions
16806 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16808 /* Run scroll hooks. */
16809 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16811 /* Redisplay the window. */
16812 use_desired_matrix
= false;
16813 if (!current_matrix_up_to_date_p
16814 || windows_or_buffers_changed
16815 || f
->cursor_type_changed
16816 /* Don't use try_window_reusing_current_matrix in this case
16817 because it can have changed the buffer. */
16818 || !NILP (Vwindow_scroll_functions
)
16819 || !just_this_one_p
16820 || MINI_WINDOW_P (w
)
16821 || !(used_current_matrix_p
16822 = try_window_reusing_current_matrix (w
)))
16823 use_desired_matrix
= (try_window (window
, startp
, 0) == 1);
16825 /* If new fonts have been loaded (due to fontsets), give up. We
16826 have to start a new redisplay since we need to re-adjust glyph
16828 if (f
->fonts_changed
)
16829 goto need_larger_matrices
;
16831 /* If cursor did not appear assume that the middle of the window is
16832 in the first line of the window. Do it again with the next line.
16833 (Imagine a window of height 100, displaying two lines of height
16834 60. Moving back 50 from it->last_visible_y will end in the first
16836 if (w
->cursor
.vpos
< 0)
16838 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16840 clear_glyph_matrix (w
->desired_matrix
);
16841 move_it_by_lines (&it
, 1);
16842 try_window (window
, it
.current
.pos
, 0);
16844 else if (PT
< IT_CHARPOS (it
))
16846 clear_glyph_matrix (w
->desired_matrix
);
16847 move_it_by_lines (&it
, -1);
16848 try_window (window
, it
.current
.pos
, 0);
16852 /* Not much we can do about it. */
16856 /* Consider the following case: Window starts at BEGV, there is
16857 invisible, intangible text at BEGV, so that display starts at
16858 some point START > BEGV. It can happen that we are called with
16859 PT somewhere between BEGV and START. Try to handle that case,
16860 and similar ones. */
16861 if (w
->cursor
.vpos
< 0)
16863 /* Prefer the desired matrix to the current matrix, if possible,
16864 in the fallback calculations below. This is because using
16865 the current matrix might completely goof, e.g. if its first
16866 row is after point. */
16867 struct glyph_matrix
*matrix
=
16868 use_desired_matrix
? w
->desired_matrix
: w
->current_matrix
;
16869 /* First, try locating the proper glyph row for PT. */
16870 struct glyph_row
*row
=
16871 row_containing_pos (w
, PT
, matrix
->rows
, NULL
, 0);
16873 /* Sometimes point is at the beginning of invisible text that is
16874 before the 1st character displayed in the row. In that case,
16875 row_containing_pos fails to find the row, because no glyphs
16876 with appropriate buffer positions are present in the row.
16877 Therefore, we next try to find the row which shows the 1st
16878 position after the invisible text. */
16882 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16885 if (TEXT_PROP_MEANS_INVISIBLE (val
) != 0)
16888 Lisp_Object invis_end
=
16889 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16892 if (NATNUMP (invis_end
))
16893 alt_pos
= XFASTINT (invis_end
);
16896 row
= row_containing_pos (w
, alt_pos
, matrix
->rows
, NULL
, 0);
16899 /* Finally, fall back on the first row of the window after the
16900 header line (if any). This is slightly better than not
16901 displaying the cursor at all. */
16904 row
= matrix
->rows
;
16905 if (row
->mode_line_p
)
16908 set_cursor_from_row (w
, row
, matrix
, 0, 0, 0, 0);
16911 if (!cursor_row_fully_visible_p (w
, false, false))
16913 /* If vscroll is enabled, disable it and try again. */
16917 clear_glyph_matrix (w
->desired_matrix
);
16921 /* Users who set scroll-conservatively to a large number want
16922 point just above/below the scroll margin. If we ended up
16923 with point's row partially visible, move the window start to
16924 make that row fully visible and out of the margin. */
16925 if (scroll_conservatively
> SCROLL_LIMIT
)
16927 int window_total_lines
16928 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16931 ? min (scroll_margin
, window_total_lines
/ 4)
16933 bool move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16935 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16936 clear_glyph_matrix (w
->desired_matrix
);
16937 if (1 == try_window (window
, it
.current
.pos
,
16938 TRY_WINDOW_CHECK_MARGINS
))
16942 /* If centering point failed to make the whole line visible,
16943 put point at the top instead. That has to make the whole line
16944 visible, if it can be done. */
16945 if (centering_position
== 0)
16948 clear_glyph_matrix (w
->desired_matrix
);
16949 centering_position
= 0;
16955 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16956 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16957 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16959 /* Display the mode line, if we must. */
16960 if ((update_mode_line
16961 /* If window not full width, must redo its mode line
16962 if (a) the window to its side is being redone and
16963 (b) we do a frame-based redisplay. This is a consequence
16964 of how inverted lines are drawn in frame-based redisplay. */
16965 || (!just_this_one_p
16966 && !FRAME_WINDOW_P (f
)
16967 && !WINDOW_FULL_WIDTH_P (w
))
16968 /* Line number to display. */
16969 || w
->base_line_pos
> 0
16970 /* Column number is displayed and different from the one displayed. */
16971 || (w
->column_number_displayed
!= -1
16972 && (w
->column_number_displayed
!= current_column ())))
16973 /* This means that the window has a mode line. */
16974 && (WINDOW_WANTS_MODELINE_P (w
)
16975 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16978 display_mode_lines (w
);
16980 /* If mode line height has changed, arrange for a thorough
16981 immediate redisplay using the correct mode line height. */
16982 if (WINDOW_WANTS_MODELINE_P (w
)
16983 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16985 f
->fonts_changed
= true;
16986 w
->mode_line_height
= -1;
16987 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16988 = DESIRED_MODE_LINE_HEIGHT (w
);
16991 /* If header line height has changed, arrange for a thorough
16992 immediate redisplay using the correct header line height. */
16993 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16994 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16996 f
->fonts_changed
= true;
16997 w
->header_line_height
= -1;
16998 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16999 = DESIRED_HEADER_LINE_HEIGHT (w
);
17002 if (f
->fonts_changed
)
17003 goto need_larger_matrices
;
17006 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
17008 w
->base_line_pos
= 0;
17009 w
->base_line_number
= 0;
17014 /* When we reach a frame's selected window, redo the frame's menu
17015 bar and the frame's title. */
17016 if (update_mode_line
17017 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
17019 bool redisplay_menu_p
;
17021 if (FRAME_WINDOW_P (f
))
17023 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
17024 || defined (HAVE_NS) || defined (USE_GTK)
17025 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
17027 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
17031 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
17033 if (redisplay_menu_p
)
17034 display_menu_bar (w
);
17036 #ifdef HAVE_WINDOW_SYSTEM
17037 if (FRAME_WINDOW_P (f
))
17039 #if defined (USE_GTK) || defined (HAVE_NS)
17040 if (FRAME_EXTERNAL_TOOL_BAR (f
))
17041 redisplay_tool_bar (f
);
17043 if (WINDOWP (f
->tool_bar_window
)
17044 && (FRAME_TOOL_BAR_LINES (f
) > 0
17045 || !NILP (Vauto_resize_tool_bars
))
17046 && redisplay_tool_bar (f
))
17047 ignore_mouse_drag_p
= true;
17050 ptrdiff_t count1
= SPECPDL_INDEX ();
17051 /* x_consider_frame_title calls select-frame, which calls
17052 resize_mini_window, which could resize the mini-window and by
17053 that undo the effect of this redisplay cycle wrt minibuffer
17054 and echo-area display. Binding inhibit-redisplay to t makes
17055 the call to resize_mini_window a no-op, thus avoiding the
17056 adverse side effects. */
17057 specbind (Qinhibit_redisplay
, Qt
);
17058 x_consider_frame_title (w
->frame
);
17059 unbind_to (count1
, Qnil
);
17063 #ifdef HAVE_WINDOW_SYSTEM
17064 if (FRAME_WINDOW_P (f
)
17065 && update_window_fringes (w
, (just_this_one_p
17066 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
17067 || w
->pseudo_window_p
)))
17071 if (draw_window_fringes (w
, true))
17073 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
17074 x_draw_right_divider (w
);
17076 x_draw_vertical_border (w
);
17082 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
17083 x_draw_bottom_divider (w
);
17084 #endif /* HAVE_WINDOW_SYSTEM */
17086 /* We go to this label, with fonts_changed set, if it is
17087 necessary to try again using larger glyph matrices.
17088 We have to redeem the scroll bar even in this case,
17089 because the loop in redisplay_internal expects that. */
17090 need_larger_matrices
:
17092 finish_scroll_bars
:
17094 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
17096 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
17097 /* Set the thumb's position and size. */
17098 set_vertical_scroll_bar (w
);
17100 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
17101 /* Set the thumb's position and size. */
17102 set_horizontal_scroll_bar (w
);
17104 /* Note that we actually used the scroll bar attached to this
17105 window, so it shouldn't be deleted at the end of redisplay. */
17106 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
17107 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
17110 /* Restore current_buffer and value of point in it. The window
17111 update may have changed the buffer, so first make sure `opoint'
17112 is still valid (Bug#6177). */
17113 if (CHARPOS (opoint
) < BEGV
)
17114 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
17115 else if (CHARPOS (opoint
) > ZV
)
17116 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
17118 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
17120 set_buffer_internal_1 (old
);
17121 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
17122 shorter. This can be caused by log truncation in *Messages*. */
17123 if (CHARPOS (lpoint
) <= ZV
)
17124 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
17126 unbind_to (count
, Qnil
);
17130 /* Build the complete desired matrix of WINDOW with a window start
17131 buffer position POS.
17133 Value is 1 if successful. It is zero if fonts were loaded during
17134 redisplay which makes re-adjusting glyph matrices necessary, and -1
17135 if point would appear in the scroll margins.
17136 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
17137 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
17141 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
17143 struct window
*w
= XWINDOW (window
);
17145 struct glyph_row
*last_text_row
= NULL
;
17146 struct frame
*f
= XFRAME (w
->frame
);
17147 int frame_line_height
= default_line_pixel_height (w
);
17149 /* Make POS the new window start. */
17150 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
17152 /* Mark cursor position as unknown. No overlay arrow seen. */
17153 w
->cursor
.vpos
= -1;
17154 overlay_arrow_seen
= false;
17156 /* Initialize iterator and info to start at POS. */
17157 start_display (&it
, w
, pos
);
17158 it
.glyph_row
->reversed_p
= false;
17160 /* Display all lines of W. */
17161 while (it
.current_y
< it
.last_visible_y
)
17163 if (display_line (&it
))
17164 last_text_row
= it
.glyph_row
- 1;
17165 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
17169 /* Don't let the cursor end in the scroll margins. */
17170 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
17171 && !MINI_WINDOW_P (w
))
17173 int this_scroll_margin
;
17174 int window_total_lines
17175 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
17177 if (scroll_margin
> 0)
17179 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
17180 this_scroll_margin
*= frame_line_height
;
17183 this_scroll_margin
= 0;
17185 if ((w
->cursor
.y
>= 0 /* not vscrolled */
17186 && w
->cursor
.y
< this_scroll_margin
17187 && CHARPOS (pos
) > BEGV
17188 && IT_CHARPOS (it
) < ZV
)
17189 /* rms: considering make_cursor_line_fully_visible_p here
17190 seems to give wrong results. We don't want to recenter
17191 when the last line is partly visible, we want to allow
17192 that case to be handled in the usual way. */
17193 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
17195 w
->cursor
.vpos
= -1;
17196 clear_glyph_matrix (w
->desired_matrix
);
17201 /* If bottom moved off end of frame, change mode line percentage. */
17202 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
17203 w
->update_mode_line
= true;
17205 /* Set window_end_pos to the offset of the last character displayed
17206 on the window from the end of current_buffer. Set
17207 window_end_vpos to its row number. */
17210 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
17211 adjust_window_ends (w
, last_text_row
, false);
17213 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
17214 w
->window_end_vpos
)));
17218 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17219 w
->window_end_pos
= Z
- ZV
;
17220 w
->window_end_vpos
= 0;
17223 /* But that is not valid info until redisplay finishes. */
17224 w
->window_end_valid
= false;
17230 /************************************************************************
17231 Window redisplay reusing current matrix when buffer has not changed
17232 ************************************************************************/
17234 /* Try redisplay of window W showing an unchanged buffer with a
17235 different window start than the last time it was displayed by
17236 reusing its current matrix. Value is true if successful.
17237 W->start is the new window start. */
17240 try_window_reusing_current_matrix (struct window
*w
)
17242 struct frame
*f
= XFRAME (w
->frame
);
17243 struct glyph_row
*bottom_row
;
17246 struct text_pos start
, new_start
;
17247 int nrows_scrolled
, i
;
17248 struct glyph_row
*last_text_row
;
17249 struct glyph_row
*last_reused_text_row
;
17250 struct glyph_row
*start_row
;
17251 int start_vpos
, min_y
, max_y
;
17254 if (inhibit_try_window_reusing
)
17258 if (/* This function doesn't handle terminal frames. */
17259 !FRAME_WINDOW_P (f
)
17260 /* Don't try to reuse the display if windows have been split
17262 || windows_or_buffers_changed
17263 || f
->cursor_type_changed
)
17266 /* Can't do this if showing trailing whitespace. */
17267 if (!NILP (Vshow_trailing_whitespace
))
17270 /* If top-line visibility has changed, give up. */
17271 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17272 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17275 /* Give up if old or new display is scrolled vertically. We could
17276 make this function handle this, but right now it doesn't. */
17277 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17278 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17281 /* The variable new_start now holds the new window start. The old
17282 start `start' can be determined from the current matrix. */
17283 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17284 start
= start_row
->minpos
;
17285 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17287 /* Clear the desired matrix for the display below. */
17288 clear_glyph_matrix (w
->desired_matrix
);
17290 if (CHARPOS (new_start
) <= CHARPOS (start
))
17292 /* Don't use this method if the display starts with an ellipsis
17293 displayed for invisible text. It's not easy to handle that case
17294 below, and it's certainly not worth the effort since this is
17295 not a frequent case. */
17296 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17299 IF_DEBUG (debug_method_add (w
, "twu1"));
17301 /* Display up to a row that can be reused. The variable
17302 last_text_row is set to the last row displayed that displays
17303 text. Note that it.vpos == 0 if or if not there is a
17304 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17305 start_display (&it
, w
, new_start
);
17306 w
->cursor
.vpos
= -1;
17307 last_text_row
= last_reused_text_row
= NULL
;
17309 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17311 /* If we have reached into the characters in the START row,
17312 that means the line boundaries have changed. So we
17313 can't start copying with the row START. Maybe it will
17314 work to start copying with the following row. */
17315 while (IT_CHARPOS (it
) > CHARPOS (start
))
17317 /* Advance to the next row as the "start". */
17319 start
= start_row
->minpos
;
17320 /* If there are no more rows to try, or just one, give up. */
17321 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17322 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17323 || CHARPOS (start
) == ZV
)
17325 clear_glyph_matrix (w
->desired_matrix
);
17329 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17331 /* If we have reached alignment, we can copy the rest of the
17333 if (IT_CHARPOS (it
) == CHARPOS (start
)
17334 /* Don't accept "alignment" inside a display vector,
17335 since start_row could have started in the middle of
17336 that same display vector (thus their character
17337 positions match), and we have no way of telling if
17338 that is the case. */
17339 && it
.current
.dpvec_index
< 0)
17342 it
.glyph_row
->reversed_p
= false;
17343 if (display_line (&it
))
17344 last_text_row
= it
.glyph_row
- 1;
17348 /* A value of current_y < last_visible_y means that we stopped
17349 at the previous window start, which in turn means that we
17350 have at least one reusable row. */
17351 if (it
.current_y
< it
.last_visible_y
)
17353 struct glyph_row
*row
;
17355 /* IT.vpos always starts from 0; it counts text lines. */
17356 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17358 /* Find PT if not already found in the lines displayed. */
17359 if (w
->cursor
.vpos
< 0)
17361 int dy
= it
.current_y
- start_row
->y
;
17363 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17364 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17366 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17367 dy
, nrows_scrolled
);
17370 clear_glyph_matrix (w
->desired_matrix
);
17375 /* Scroll the display. Do it before the current matrix is
17376 changed. The problem here is that update has not yet
17377 run, i.e. part of the current matrix is not up to date.
17378 scroll_run_hook will clear the cursor, and use the
17379 current matrix to get the height of the row the cursor is
17381 run
.current_y
= start_row
->y
;
17382 run
.desired_y
= it
.current_y
;
17383 run
.height
= it
.last_visible_y
- it
.current_y
;
17385 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17388 FRAME_RIF (f
)->update_window_begin_hook (w
);
17389 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17390 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17391 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17395 /* Shift current matrix down by nrows_scrolled lines. */
17396 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17397 rotate_matrix (w
->current_matrix
,
17399 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17402 /* Disable lines that must be updated. */
17403 for (i
= 0; i
< nrows_scrolled
; ++i
)
17404 (start_row
+ i
)->enabled_p
= false;
17406 /* Re-compute Y positions. */
17407 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17408 max_y
= it
.last_visible_y
;
17409 for (row
= start_row
+ nrows_scrolled
;
17413 row
->y
= it
.current_y
;
17414 row
->visible_height
= row
->height
;
17416 if (row
->y
< min_y
)
17417 row
->visible_height
-= min_y
- row
->y
;
17418 if (row
->y
+ row
->height
> max_y
)
17419 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17420 if (row
->fringe_bitmap_periodic_p
)
17421 row
->redraw_fringe_bitmaps_p
= true;
17423 it
.current_y
+= row
->height
;
17425 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17426 last_reused_text_row
= row
;
17427 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17431 /* Disable lines in the current matrix which are now
17432 below the window. */
17433 for (++row
; row
< bottom_row
; ++row
)
17434 row
->enabled_p
= row
->mode_line_p
= false;
17437 /* Update window_end_pos etc.; last_reused_text_row is the last
17438 reused row from the current matrix containing text, if any.
17439 The value of last_text_row is the last displayed line
17440 containing text. */
17441 if (last_reused_text_row
)
17442 adjust_window_ends (w
, last_reused_text_row
, true);
17443 else if (last_text_row
)
17444 adjust_window_ends (w
, last_text_row
, false);
17447 /* This window must be completely empty. */
17448 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17449 w
->window_end_pos
= Z
- ZV
;
17450 w
->window_end_vpos
= 0;
17452 w
->window_end_valid
= false;
17454 /* Update hint: don't try scrolling again in update_window. */
17455 w
->desired_matrix
->no_scrolling_p
= true;
17458 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17462 else if (CHARPOS (new_start
) > CHARPOS (start
))
17464 struct glyph_row
*pt_row
, *row
;
17465 struct glyph_row
*first_reusable_row
;
17466 struct glyph_row
*first_row_to_display
;
17468 int yb
= window_text_bottom_y (w
);
17470 /* Find the row starting at new_start, if there is one. Don't
17471 reuse a partially visible line at the end. */
17472 first_reusable_row
= start_row
;
17473 while (first_reusable_row
->enabled_p
17474 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17475 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17476 < CHARPOS (new_start
)))
17477 ++first_reusable_row
;
17479 /* Give up if there is no row to reuse. */
17480 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17481 || !first_reusable_row
->enabled_p
17482 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17483 != CHARPOS (new_start
)))
17486 /* We can reuse fully visible rows beginning with
17487 first_reusable_row to the end of the window. Set
17488 first_row_to_display to the first row that cannot be reused.
17489 Set pt_row to the row containing point, if there is any. */
17491 for (first_row_to_display
= first_reusable_row
;
17492 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17493 ++first_row_to_display
)
17495 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17496 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17497 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17498 && first_row_to_display
->ends_at_zv_p
17499 && pt_row
== NULL
)))
17500 pt_row
= first_row_to_display
;
17503 /* Start displaying at the start of first_row_to_display. */
17504 eassert (first_row_to_display
->y
< yb
);
17505 init_to_row_start (&it
, w
, first_row_to_display
);
17507 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17509 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17511 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17512 + WINDOW_HEADER_LINE_HEIGHT (w
));
17514 /* Display lines beginning with first_row_to_display in the
17515 desired matrix. Set last_text_row to the last row displayed
17516 that displays text. */
17517 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17518 if (pt_row
== NULL
)
17519 w
->cursor
.vpos
= -1;
17520 last_text_row
= NULL
;
17521 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17522 if (display_line (&it
))
17523 last_text_row
= it
.glyph_row
- 1;
17525 /* If point is in a reused row, adjust y and vpos of the cursor
17529 w
->cursor
.vpos
-= nrows_scrolled
;
17530 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17533 /* Give up if point isn't in a row displayed or reused. (This
17534 also handles the case where w->cursor.vpos < nrows_scrolled
17535 after the calls to display_line, which can happen with scroll
17536 margins. See bug#1295.) */
17537 if (w
->cursor
.vpos
< 0)
17539 clear_glyph_matrix (w
->desired_matrix
);
17543 /* Scroll the display. */
17544 run
.current_y
= first_reusable_row
->y
;
17545 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17546 run
.height
= it
.last_visible_y
- run
.current_y
;
17547 dy
= run
.current_y
- run
.desired_y
;
17552 FRAME_RIF (f
)->update_window_begin_hook (w
);
17553 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17554 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17555 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17559 /* Adjust Y positions of reused rows. */
17560 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17561 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17562 max_y
= it
.last_visible_y
;
17563 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17566 row
->visible_height
= row
->height
;
17567 if (row
->y
< min_y
)
17568 row
->visible_height
-= min_y
- row
->y
;
17569 if (row
->y
+ row
->height
> max_y
)
17570 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17571 if (row
->fringe_bitmap_periodic_p
)
17572 row
->redraw_fringe_bitmaps_p
= true;
17575 /* Scroll the current matrix. */
17576 eassert (nrows_scrolled
> 0);
17577 rotate_matrix (w
->current_matrix
,
17579 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17582 /* Disable rows not reused. */
17583 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17584 row
->enabled_p
= false;
17586 /* Point may have moved to a different line, so we cannot assume that
17587 the previous cursor position is valid; locate the correct row. */
17590 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17592 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17593 && !row
->ends_at_zv_p
;
17597 w
->cursor
.y
= row
->y
;
17599 if (row
< bottom_row
)
17601 /* Can't simply scan the row for point with
17602 bidi-reordered glyph rows. Let set_cursor_from_row
17603 figure out where to put the cursor, and if it fails,
17605 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17607 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17610 clear_glyph_matrix (w
->desired_matrix
);
17616 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17617 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17620 && (!BUFFERP (glyph
->object
)
17621 || glyph
->charpos
< PT
);
17625 w
->cursor
.x
+= glyph
->pixel_width
;
17631 /* Adjust window end. A null value of last_text_row means that
17632 the window end is in reused rows which in turn means that
17633 only its vpos can have changed. */
17635 adjust_window_ends (w
, last_text_row
, false);
17637 w
->window_end_vpos
-= nrows_scrolled
;
17639 w
->window_end_valid
= false;
17640 w
->desired_matrix
->no_scrolling_p
= true;
17643 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17653 /************************************************************************
17654 Window redisplay reusing current matrix when buffer has changed
17655 ************************************************************************/
17657 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17658 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17659 ptrdiff_t *, ptrdiff_t *);
17660 static struct glyph_row
*
17661 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17662 struct glyph_row
*);
17665 /* Return the last row in MATRIX displaying text. If row START is
17666 non-null, start searching with that row. IT gives the dimensions
17667 of the display. Value is null if matrix is empty; otherwise it is
17668 a pointer to the row found. */
17670 static struct glyph_row
*
17671 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17672 struct glyph_row
*start
)
17674 struct glyph_row
*row
, *row_found
;
17676 /* Set row_found to the last row in IT->w's current matrix
17677 displaying text. The loop looks funny but think of partially
17680 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17681 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17683 eassert (row
->enabled_p
);
17685 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17694 /* Return the last row in the current matrix of W that is not affected
17695 by changes at the start of current_buffer that occurred since W's
17696 current matrix was built. Value is null if no such row exists.
17698 BEG_UNCHANGED us the number of characters unchanged at the start of
17699 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17700 first changed character in current_buffer. Characters at positions <
17701 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17702 when the current matrix was built. */
17704 static struct glyph_row
*
17705 find_last_unchanged_at_beg_row (struct window
*w
)
17707 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17708 struct glyph_row
*row
;
17709 struct glyph_row
*row_found
= NULL
;
17710 int yb
= window_text_bottom_y (w
);
17712 /* Find the last row displaying unchanged text. */
17713 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17714 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17715 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17718 if (/* If row ends before first_changed_pos, it is unchanged,
17719 except in some case. */
17720 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17721 /* When row ends in ZV and we write at ZV it is not
17723 && !row
->ends_at_zv_p
17724 /* When first_changed_pos is the end of a continued line,
17725 row is not unchanged because it may be no longer
17727 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17728 && (row
->continued_p
17729 || row
->exact_window_width_line_p
))
17730 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17731 needs to be recomputed, so don't consider this row as
17732 unchanged. This happens when the last line was
17733 bidi-reordered and was killed immediately before this
17734 redisplay cycle. In that case, ROW->end stores the
17735 buffer position of the first visual-order character of
17736 the killed text, which is now beyond ZV. */
17737 && CHARPOS (row
->end
.pos
) <= ZV
)
17740 /* Stop if last visible row. */
17741 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17749 /* Find the first glyph row in the current matrix of W that is not
17750 affected by changes at the end of current_buffer since the
17751 time W's current matrix was built.
17753 Return in *DELTA the number of chars by which buffer positions in
17754 unchanged text at the end of current_buffer must be adjusted.
17756 Return in *DELTA_BYTES the corresponding number of bytes.
17758 Value is null if no such row exists, i.e. all rows are affected by
17761 static struct glyph_row
*
17762 find_first_unchanged_at_end_row (struct window
*w
,
17763 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17765 struct glyph_row
*row
;
17766 struct glyph_row
*row_found
= NULL
;
17768 *delta
= *delta_bytes
= 0;
17770 /* Display must not have been paused, otherwise the current matrix
17771 is not up to date. */
17772 eassert (w
->window_end_valid
);
17774 /* A value of window_end_pos >= END_UNCHANGED means that the window
17775 end is in the range of changed text. If so, there is no
17776 unchanged row at the end of W's current matrix. */
17777 if (w
->window_end_pos
>= END_UNCHANGED
)
17780 /* Set row to the last row in W's current matrix displaying text. */
17781 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17783 /* If matrix is entirely empty, no unchanged row exists. */
17784 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17786 /* The value of row is the last glyph row in the matrix having a
17787 meaningful buffer position in it. The end position of row
17788 corresponds to window_end_pos. This allows us to translate
17789 buffer positions in the current matrix to current buffer
17790 positions for characters not in changed text. */
17792 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17793 ptrdiff_t Z_BYTE_old
=
17794 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17795 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17796 struct glyph_row
*first_text_row
17797 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17799 *delta
= Z
- Z_old
;
17800 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17802 /* Set last_unchanged_pos to the buffer position of the last
17803 character in the buffer that has not been changed. Z is the
17804 index + 1 of the last character in current_buffer, i.e. by
17805 subtracting END_UNCHANGED we get the index of the last
17806 unchanged character, and we have to add BEG to get its buffer
17808 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17809 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17811 /* Search backward from ROW for a row displaying a line that
17812 starts at a minimum position >= last_unchanged_pos_old. */
17813 for (; row
> first_text_row
; --row
)
17815 /* This used to abort, but it can happen.
17816 It is ok to just stop the search instead here. KFS. */
17817 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17820 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17825 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17831 /* Make sure that glyph rows in the current matrix of window W
17832 reference the same glyph memory as corresponding rows in the
17833 frame's frame matrix. This function is called after scrolling W's
17834 current matrix on a terminal frame in try_window_id and
17835 try_window_reusing_current_matrix. */
17838 sync_frame_with_window_matrix_rows (struct window
*w
)
17840 struct frame
*f
= XFRAME (w
->frame
);
17841 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17843 /* Preconditions: W must be a leaf window and full-width. Its frame
17844 must have a frame matrix. */
17845 eassert (BUFFERP (w
->contents
));
17846 eassert (WINDOW_FULL_WIDTH_P (w
));
17847 eassert (!FRAME_WINDOW_P (f
));
17849 /* If W is a full-width window, glyph pointers in W's current matrix
17850 have, by definition, to be the same as glyph pointers in the
17851 corresponding frame matrix. Note that frame matrices have no
17852 marginal areas (see build_frame_matrix). */
17853 window_row
= w
->current_matrix
->rows
;
17854 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17855 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17856 while (window_row
< window_row_end
)
17858 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17859 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17861 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17862 frame_row
->glyphs
[TEXT_AREA
] = start
;
17863 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17864 frame_row
->glyphs
[LAST_AREA
] = end
;
17866 /* Disable frame rows whose corresponding window rows have
17867 been disabled in try_window_id. */
17868 if (!window_row
->enabled_p
)
17869 frame_row
->enabled_p
= false;
17871 ++window_row
, ++frame_row
;
17876 /* Find the glyph row in window W containing CHARPOS. Consider all
17877 rows between START and END (not inclusive). END null means search
17878 all rows to the end of the display area of W. Value is the row
17879 containing CHARPOS or null. */
17882 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17883 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17885 struct glyph_row
*row
= start
;
17886 struct glyph_row
*best_row
= NULL
;
17887 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17890 /* If we happen to start on a header-line, skip that. */
17891 if (row
->mode_line_p
)
17894 if ((end
&& row
>= end
) || !row
->enabled_p
)
17897 last_y
= window_text_bottom_y (w
) - dy
;
17901 /* Give up if we have gone too far. */
17902 if ((end
&& row
>= end
) || !row
->enabled_p
)
17904 /* This formerly returned if they were equal.
17905 I think that both quantities are of a "last plus one" type;
17906 if so, when they are equal, the row is within the screen. -- rms. */
17907 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17910 /* If it is in this row, return this row. */
17911 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17912 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17913 /* The end position of a row equals the start
17914 position of the next row. If CHARPOS is there, we
17915 would rather consider it displayed in the next
17916 line, except when this line ends in ZV. */
17917 && !row_for_charpos_p (row
, charpos
)))
17918 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17922 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17923 || (!best_row
&& !row
->continued_p
))
17925 /* In bidi-reordered rows, there could be several rows whose
17926 edges surround CHARPOS, all of these rows belonging to
17927 the same continued line. We need to find the row which
17928 fits CHARPOS the best. */
17929 for (g
= row
->glyphs
[TEXT_AREA
];
17930 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17933 if (!STRINGP (g
->object
))
17935 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17937 mindif
= eabs (g
->charpos
- charpos
);
17939 /* Exact match always wins. */
17946 else if (best_row
&& !row
->continued_p
)
17953 /* Try to redisplay window W by reusing its existing display. W's
17954 current matrix must be up to date when this function is called,
17955 i.e., window_end_valid must be true.
17959 >= 1 if successful, i.e. display has been updated
17961 1 means the changes were in front of a newline that precedes
17962 the window start, and the whole current matrix was reused
17963 2 means the changes were after the last position displayed
17964 in the window, and the whole current matrix was reused
17965 3 means portions of the current matrix were reused, while
17966 some of the screen lines were redrawn
17967 -1 if redisplay with same window start is known not to succeed
17968 0 if otherwise unsuccessful
17970 The following steps are performed:
17972 1. Find the last row in the current matrix of W that is not
17973 affected by changes at the start of current_buffer. If no such row
17976 2. Find the first row in W's current matrix that is not affected by
17977 changes at the end of current_buffer. Maybe there is no such row.
17979 3. Display lines beginning with the row + 1 found in step 1 to the
17980 row found in step 2 or, if step 2 didn't find a row, to the end of
17983 4. If cursor is not known to appear on the window, give up.
17985 5. If display stopped at the row found in step 2, scroll the
17986 display and current matrix as needed.
17988 6. Maybe display some lines at the end of W, if we must. This can
17989 happen under various circumstances, like a partially visible line
17990 becoming fully visible, or because newly displayed lines are displayed
17991 in smaller font sizes.
17993 7. Update W's window end information. */
17996 try_window_id (struct window
*w
)
17998 struct frame
*f
= XFRAME (w
->frame
);
17999 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
18000 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
18001 struct glyph_row
*last_unchanged_at_beg_row
;
18002 struct glyph_row
*first_unchanged_at_end_row
;
18003 struct glyph_row
*row
;
18004 struct glyph_row
*bottom_row
;
18007 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
18009 struct text_pos start_pos
;
18011 int first_unchanged_at_end_vpos
= 0;
18012 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
18013 struct text_pos start
;
18014 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
18017 if (inhibit_try_window_id
)
18021 /* This is handy for debugging. */
18023 #define GIVE_UP(X) \
18025 TRACE ((stderr, "try_window_id give up %d\n", (X))); \
18029 #define GIVE_UP(X) return 0
18032 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
18034 /* Don't use this for mini-windows because these can show
18035 messages and mini-buffers, and we don't handle that here. */
18036 if (MINI_WINDOW_P (w
))
18039 /* This flag is used to prevent redisplay optimizations. */
18040 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
18043 /* This function's optimizations cannot be used if overlays have
18044 changed in the buffer displayed by the window, so give up if they
18046 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
18049 /* Verify that narrowing has not changed.
18050 Also verify that we were not told to prevent redisplay optimizations.
18051 It would be nice to further
18052 reduce the number of cases where this prevents try_window_id. */
18053 if (current_buffer
->clip_changed
18054 || current_buffer
->prevent_redisplay_optimizations_p
)
18057 /* Window must either use window-based redisplay or be full width. */
18058 if (!FRAME_WINDOW_P (f
)
18059 && (!FRAME_LINE_INS_DEL_OK (f
)
18060 || !WINDOW_FULL_WIDTH_P (w
)))
18063 /* Give up if point is known NOT to appear in W. */
18064 if (PT
< CHARPOS (start
))
18067 /* Another way to prevent redisplay optimizations. */
18068 if (w
->last_modified
== 0)
18071 /* Verify that window is not hscrolled. */
18072 if (w
->hscroll
!= 0)
18075 /* Verify that display wasn't paused. */
18076 if (!w
->window_end_valid
)
18079 /* Likewise if highlighting trailing whitespace. */
18080 if (!NILP (Vshow_trailing_whitespace
))
18083 /* Can't use this if overlay arrow position and/or string have
18085 if (overlay_arrows_changed_p ())
18088 /* When word-wrap is on, adding a space to the first word of a
18089 wrapped line can change the wrap position, altering the line
18090 above it. It might be worthwhile to handle this more
18091 intelligently, but for now just redisplay from scratch. */
18092 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
18095 /* Under bidi reordering, adding or deleting a character in the
18096 beginning of a paragraph, before the first strong directional
18097 character, can change the base direction of the paragraph (unless
18098 the buffer specifies a fixed paragraph direction), which will
18099 require redisplaying the whole paragraph. It might be worthwhile
18100 to find the paragraph limits and widen the range of redisplayed
18101 lines to that, but for now just give up this optimization and
18102 redisplay from scratch. */
18103 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
18104 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
18107 /* Give up if the buffer has line-spacing set, as Lisp-level changes
18108 to that variable require thorough redisplay. */
18109 if (!NILP (BVAR (XBUFFER (w
->contents
), extra_line_spacing
)))
18112 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
18113 only if buffer has really changed. The reason is that the gap is
18114 initially at Z for freshly visited files. The code below would
18115 set end_unchanged to 0 in that case. */
18116 if (MODIFF
> SAVE_MODIFF
18117 /* This seems to happen sometimes after saving a buffer. */
18118 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
18120 if (GPT
- BEG
< BEG_UNCHANGED
)
18121 BEG_UNCHANGED
= GPT
- BEG
;
18122 if (Z
- GPT
< END_UNCHANGED
)
18123 END_UNCHANGED
= Z
- GPT
;
18126 /* The position of the first and last character that has been changed. */
18127 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
18128 last_changed_charpos
= Z
- END_UNCHANGED
;
18130 /* If window starts after a line end, and the last change is in
18131 front of that newline, then changes don't affect the display.
18132 This case happens with stealth-fontification. Note that although
18133 the display is unchanged, glyph positions in the matrix have to
18134 be adjusted, of course. */
18135 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
18136 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
18137 && ((last_changed_charpos
< CHARPOS (start
)
18138 && CHARPOS (start
) == BEGV
)
18139 || (last_changed_charpos
< CHARPOS (start
) - 1
18140 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
18142 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
18143 struct glyph_row
*r0
;
18145 /* Compute how many chars/bytes have been added to or removed
18146 from the buffer. */
18147 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
18148 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
18149 Z_delta
= Z
- Z_old
;
18150 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
18152 /* Give up if PT is not in the window. Note that it already has
18153 been checked at the start of try_window_id that PT is not in
18154 front of the window start. */
18155 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
18158 /* If window start is unchanged, we can reuse the whole matrix
18159 as is, after adjusting glyph positions. No need to compute
18160 the window end again, since its offset from Z hasn't changed. */
18161 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18162 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
18163 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
18164 /* PT must not be in a partially visible line. */
18165 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
18166 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18168 /* Adjust positions in the glyph matrix. */
18169 if (Z_delta
|| Z_delta_bytes
)
18171 struct glyph_row
*r1
18172 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18173 increment_matrix_positions (w
->current_matrix
,
18174 MATRIX_ROW_VPOS (r0
, current_matrix
),
18175 MATRIX_ROW_VPOS (r1
, current_matrix
),
18176 Z_delta
, Z_delta_bytes
);
18179 /* Set the cursor. */
18180 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18182 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18187 /* Handle the case that changes are all below what is displayed in
18188 the window, and that PT is in the window. This shortcut cannot
18189 be taken if ZV is visible in the window, and text has been added
18190 there that is visible in the window. */
18191 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
18192 /* ZV is not visible in the window, or there are no
18193 changes at ZV, actually. */
18194 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
18195 || first_changed_charpos
== last_changed_charpos
))
18197 struct glyph_row
*r0
;
18199 /* Give up if PT is not in the window. Note that it already has
18200 been checked at the start of try_window_id that PT is not in
18201 front of the window start. */
18202 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
18205 /* If window start is unchanged, we can reuse the whole matrix
18206 as is, without changing glyph positions since no text has
18207 been added/removed in front of the window end. */
18208 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18209 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
18210 /* PT must not be in a partially visible line. */
18211 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
18212 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18214 /* We have to compute the window end anew since text
18215 could have been added/removed after it. */
18216 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18217 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18219 /* Set the cursor. */
18220 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18222 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18227 /* Give up if window start is in the changed area.
18229 The condition used to read
18231 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18233 but why that was tested escapes me at the moment. */
18234 if (CHARPOS (start
) >= first_changed_charpos
18235 && CHARPOS (start
) <= last_changed_charpos
)
18238 /* Check that window start agrees with the start of the first glyph
18239 row in its current matrix. Check this after we know the window
18240 start is not in changed text, otherwise positions would not be
18242 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18243 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
18246 /* Give up if the window ends in strings. Overlay strings
18247 at the end are difficult to handle, so don't try. */
18248 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
18249 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
18252 /* Compute the position at which we have to start displaying new
18253 lines. Some of the lines at the top of the window might be
18254 reusable because they are not displaying changed text. Find the
18255 last row in W's current matrix not affected by changes at the
18256 start of current_buffer. Value is null if changes start in the
18257 first line of window. */
18258 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18259 if (last_unchanged_at_beg_row
)
18261 /* Avoid starting to display in the middle of a character, a TAB
18262 for instance. This is easier than to set up the iterator
18263 exactly, and it's not a frequent case, so the additional
18264 effort wouldn't really pay off. */
18265 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18266 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18267 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18268 --last_unchanged_at_beg_row
;
18270 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18273 if (! init_to_row_end (&it
, w
, last_unchanged_at_beg_row
))
18275 start_pos
= it
.current
.pos
;
18277 /* Start displaying new lines in the desired matrix at the same
18278 vpos we would use in the current matrix, i.e. below
18279 last_unchanged_at_beg_row. */
18280 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18282 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18283 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18285 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18289 /* There are no reusable lines at the start of the window.
18290 Start displaying in the first text line. */
18291 start_display (&it
, w
, start
);
18292 it
.vpos
= it
.first_vpos
;
18293 start_pos
= it
.current
.pos
;
18296 /* Find the first row that is not affected by changes at the end of
18297 the buffer. Value will be null if there is no unchanged row, in
18298 which case we must redisplay to the end of the window. delta
18299 will be set to the value by which buffer positions beginning with
18300 first_unchanged_at_end_row have to be adjusted due to text
18302 first_unchanged_at_end_row
18303 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18304 IF_DEBUG (debug_delta
= delta
);
18305 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18307 /* Set stop_pos to the buffer position up to which we will have to
18308 display new lines. If first_unchanged_at_end_row != NULL, this
18309 is the buffer position of the start of the line displayed in that
18310 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18311 that we don't stop at a buffer position. */
18313 if (first_unchanged_at_end_row
)
18315 eassert (last_unchanged_at_beg_row
== NULL
18316 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18318 /* If this is a continuation line, move forward to the next one
18319 that isn't. Changes in lines above affect this line.
18320 Caution: this may move first_unchanged_at_end_row to a row
18321 not displaying text. */
18322 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18323 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18324 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18325 < it
.last_visible_y
))
18326 ++first_unchanged_at_end_row
;
18328 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18329 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18330 >= it
.last_visible_y
))
18331 first_unchanged_at_end_row
= NULL
;
18334 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18336 first_unchanged_at_end_vpos
18337 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18338 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18341 else if (last_unchanged_at_beg_row
== NULL
)
18347 /* Either there is no unchanged row at the end, or the one we have
18348 now displays text. This is a necessary condition for the window
18349 end pos calculation at the end of this function. */
18350 eassert (first_unchanged_at_end_row
== NULL
18351 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18353 debug_last_unchanged_at_beg_vpos
18354 = (last_unchanged_at_beg_row
18355 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18357 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18359 #endif /* GLYPH_DEBUG */
18362 /* Display new lines. Set last_text_row to the last new line
18363 displayed which has text on it, i.e. might end up as being the
18364 line where the window_end_vpos is. */
18365 w
->cursor
.vpos
= -1;
18366 last_text_row
= NULL
;
18367 overlay_arrow_seen
= false;
18368 if (it
.current_y
< it
.last_visible_y
18369 && !f
->fonts_changed
18370 && (first_unchanged_at_end_row
== NULL
18371 || IT_CHARPOS (it
) < stop_pos
))
18372 it
.glyph_row
->reversed_p
= false;
18373 while (it
.current_y
< it
.last_visible_y
18374 && !f
->fonts_changed
18375 && (first_unchanged_at_end_row
== NULL
18376 || IT_CHARPOS (it
) < stop_pos
))
18378 if (display_line (&it
))
18379 last_text_row
= it
.glyph_row
- 1;
18382 if (f
->fonts_changed
)
18385 /* The redisplay iterations in display_line above could have
18386 triggered font-lock, which could have done something that
18387 invalidates IT->w window's end-point information, on which we
18388 rely below. E.g., one package, which will remain unnamed, used
18389 to install a font-lock-fontify-region-function that called
18390 bury-buffer, whose side effect is to switch the buffer displayed
18391 by IT->w, and that predictably resets IT->w's window_end_valid
18392 flag, which we already tested at the entry to this function.
18393 Amply punish such packages/modes by giving up on this
18394 optimization in those cases. */
18395 if (!w
->window_end_valid
)
18397 clear_glyph_matrix (w
->desired_matrix
);
18401 /* Compute differences in buffer positions, y-positions etc. for
18402 lines reused at the bottom of the window. Compute what we can
18404 if (first_unchanged_at_end_row
18405 /* No lines reused because we displayed everything up to the
18406 bottom of the window. */
18407 && it
.current_y
< it
.last_visible_y
)
18410 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18412 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18413 run
.current_y
= first_unchanged_at_end_row
->y
;
18414 run
.desired_y
= run
.current_y
+ dy
;
18415 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18419 delta
= delta_bytes
= dvpos
= dy
18420 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18421 first_unchanged_at_end_row
= NULL
;
18423 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18426 /* Find the cursor if not already found. We have to decide whether
18427 PT will appear on this window (it sometimes doesn't, but this is
18428 not a very frequent case.) This decision has to be made before
18429 the current matrix is altered. A value of cursor.vpos < 0 means
18430 that PT is either in one of the lines beginning at
18431 first_unchanged_at_end_row or below the window. Don't care for
18432 lines that might be displayed later at the window end; as
18433 mentioned, this is not a frequent case. */
18434 if (w
->cursor
.vpos
< 0)
18436 /* Cursor in unchanged rows at the top? */
18437 if (PT
< CHARPOS (start_pos
)
18438 && last_unchanged_at_beg_row
)
18440 row
= row_containing_pos (w
, PT
,
18441 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18442 last_unchanged_at_beg_row
+ 1, 0);
18444 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18447 /* Start from first_unchanged_at_end_row looking for PT. */
18448 else if (first_unchanged_at_end_row
)
18450 row
= row_containing_pos (w
, PT
- delta
,
18451 first_unchanged_at_end_row
, NULL
, 0);
18453 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18454 delta_bytes
, dy
, dvpos
);
18457 /* Give up if cursor was not found. */
18458 if (w
->cursor
.vpos
< 0)
18460 clear_glyph_matrix (w
->desired_matrix
);
18465 /* Don't let the cursor end in the scroll margins. */
18467 int this_scroll_margin
, cursor_height
;
18468 int frame_line_height
= default_line_pixel_height (w
);
18469 int window_total_lines
18470 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18472 this_scroll_margin
=
18473 max (0, min (scroll_margin
, window_total_lines
/ 4));
18474 this_scroll_margin
*= frame_line_height
;
18475 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18477 if ((w
->cursor
.y
< this_scroll_margin
18478 && CHARPOS (start
) > BEGV
)
18479 /* Old redisplay didn't take scroll margin into account at the bottom,
18480 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18481 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18482 ? cursor_height
+ this_scroll_margin
18483 : 1)) > it
.last_visible_y
)
18485 w
->cursor
.vpos
= -1;
18486 clear_glyph_matrix (w
->desired_matrix
);
18491 /* Scroll the display. Do it before changing the current matrix so
18492 that xterm.c doesn't get confused about where the cursor glyph is
18494 if (dy
&& run
.height
)
18498 if (FRAME_WINDOW_P (f
))
18500 FRAME_RIF (f
)->update_window_begin_hook (w
);
18501 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18502 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18503 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
18507 /* Terminal frame. In this case, dvpos gives the number of
18508 lines to scroll by; dvpos < 0 means scroll up. */
18510 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18511 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18512 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18513 + WINDOW_WANTS_HEADER_LINE_P (w
)
18514 + window_internal_height (w
));
18516 #if defined (HAVE_GPM) || defined (MSDOS)
18517 x_clear_window_mouse_face (w
);
18519 /* Perform the operation on the screen. */
18522 /* Scroll last_unchanged_at_beg_row to the end of the
18523 window down dvpos lines. */
18524 set_terminal_window (f
, end
);
18526 /* On dumb terminals delete dvpos lines at the end
18527 before inserting dvpos empty lines. */
18528 if (!FRAME_SCROLL_REGION_OK (f
))
18529 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18531 /* Insert dvpos empty lines in front of
18532 last_unchanged_at_beg_row. */
18533 ins_del_lines (f
, from
, dvpos
);
18535 else if (dvpos
< 0)
18537 /* Scroll up last_unchanged_at_beg_vpos to the end of
18538 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18539 set_terminal_window (f
, end
);
18541 /* Delete dvpos lines in front of
18542 last_unchanged_at_beg_vpos. ins_del_lines will set
18543 the cursor to the given vpos and emit |dvpos| delete
18545 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18547 /* On a dumb terminal insert dvpos empty lines at the
18549 if (!FRAME_SCROLL_REGION_OK (f
))
18550 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18553 set_terminal_window (f
, 0);
18559 /* Shift reused rows of the current matrix to the right position.
18560 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18562 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18563 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18566 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18567 bottom_vpos
, dvpos
);
18568 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18571 else if (dvpos
> 0)
18573 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18574 bottom_vpos
, dvpos
);
18575 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18576 first_unchanged_at_end_vpos
+ dvpos
);
18579 /* For frame-based redisplay, make sure that current frame and window
18580 matrix are in sync with respect to glyph memory. */
18581 if (!FRAME_WINDOW_P (f
))
18582 sync_frame_with_window_matrix_rows (w
);
18584 /* Adjust buffer positions in reused rows. */
18585 if (delta
|| delta_bytes
)
18586 increment_matrix_positions (current_matrix
,
18587 first_unchanged_at_end_vpos
+ dvpos
,
18588 bottom_vpos
, delta
, delta_bytes
);
18590 /* Adjust Y positions. */
18592 shift_glyph_matrix (w
, current_matrix
,
18593 first_unchanged_at_end_vpos
+ dvpos
,
18596 if (first_unchanged_at_end_row
)
18598 first_unchanged_at_end_row
+= dvpos
;
18599 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18600 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18601 first_unchanged_at_end_row
= NULL
;
18604 /* If scrolling up, there may be some lines to display at the end of
18606 last_text_row_at_end
= NULL
;
18609 /* Scrolling up can leave for example a partially visible line
18610 at the end of the window to be redisplayed. */
18611 /* Set last_row to the glyph row in the current matrix where the
18612 window end line is found. It has been moved up or down in
18613 the matrix by dvpos. */
18614 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18615 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18617 /* If last_row is the window end line, it should display text. */
18618 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18620 /* If window end line was partially visible before, begin
18621 displaying at that line. Otherwise begin displaying with the
18622 line following it. */
18623 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18625 init_to_row_start (&it
, w
, last_row
);
18626 it
.vpos
= last_vpos
;
18627 it
.current_y
= last_row
->y
;
18631 init_to_row_end (&it
, w
, last_row
);
18632 it
.vpos
= 1 + last_vpos
;
18633 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18637 /* We may start in a continuation line. If so, we have to
18638 get the right continuation_lines_width and current_x. */
18639 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18640 it
.hpos
= it
.current_x
= 0;
18642 /* Display the rest of the lines at the window end. */
18643 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18644 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18646 /* Is it always sure that the display agrees with lines in
18647 the current matrix? I don't think so, so we mark rows
18648 displayed invalid in the current matrix by setting their
18649 enabled_p flag to false. */
18650 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18651 if (display_line (&it
))
18652 last_text_row_at_end
= it
.glyph_row
- 1;
18656 /* Update window_end_pos and window_end_vpos. */
18657 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18659 /* Window end line if one of the preserved rows from the current
18660 matrix. Set row to the last row displaying text in current
18661 matrix starting at first_unchanged_at_end_row, after
18663 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18664 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18665 first_unchanged_at_end_row
);
18666 eassume (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18667 adjust_window_ends (w
, row
, true);
18668 eassert (w
->window_end_bytepos
>= 0);
18669 IF_DEBUG (debug_method_add (w
, "A"));
18671 else if (last_text_row_at_end
)
18673 adjust_window_ends (w
, last_text_row_at_end
, false);
18674 eassert (w
->window_end_bytepos
>= 0);
18675 IF_DEBUG (debug_method_add (w
, "B"));
18677 else if (last_text_row
)
18679 /* We have displayed either to the end of the window or at the
18680 end of the window, i.e. the last row with text is to be found
18681 in the desired matrix. */
18682 adjust_window_ends (w
, last_text_row
, false);
18683 eassert (w
->window_end_bytepos
>= 0);
18685 else if (first_unchanged_at_end_row
== NULL
18686 && last_text_row
== NULL
18687 && last_text_row_at_end
== NULL
)
18689 /* Displayed to end of window, but no line containing text was
18690 displayed. Lines were deleted at the end of the window. */
18691 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
18692 int vpos
= w
->window_end_vpos
;
18693 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18694 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18696 for (row
= NULL
; !row
; --vpos
, --current_row
, --desired_row
)
18698 eassert (first_vpos
<= vpos
);
18699 if (desired_row
->enabled_p
)
18701 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18704 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18708 w
->window_end_vpos
= vpos
+ 1;
18709 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18710 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18711 eassert (w
->window_end_bytepos
>= 0);
18712 IF_DEBUG (debug_method_add (w
, "C"));
18717 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18718 debug_end_vpos
= w
->window_end_vpos
));
18720 /* Record that display has not been completed. */
18721 w
->window_end_valid
= false;
18722 w
->desired_matrix
->no_scrolling_p
= true;
18730 /***********************************************************************
18731 More debugging support
18732 ***********************************************************************/
18736 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18737 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18738 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18741 /* Dump the contents of glyph matrix MATRIX on stderr.
18743 GLYPHS 0 means don't show glyph contents.
18744 GLYPHS 1 means show glyphs in short form
18745 GLYPHS > 1 means show glyphs in long form. */
18748 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18751 for (i
= 0; i
< matrix
->nrows
; ++i
)
18752 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18756 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18757 the glyph row and area where the glyph comes from. */
18760 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18762 if (glyph
->type
== CHAR_GLYPH
18763 || glyph
->type
== GLYPHLESS_GLYPH
)
18766 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18767 glyph
- row
->glyphs
[TEXT_AREA
],
18768 (glyph
->type
== CHAR_GLYPH
18772 (BUFFERP (glyph
->object
)
18774 : (STRINGP (glyph
->object
)
18776 : (NILP (glyph
->object
)
18779 glyph
->pixel_width
,
18781 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18785 glyph
->left_box_line_p
,
18786 glyph
->right_box_line_p
);
18788 else if (glyph
->type
== STRETCH_GLYPH
)
18791 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18792 glyph
- row
->glyphs
[TEXT_AREA
],
18795 (BUFFERP (glyph
->object
)
18797 : (STRINGP (glyph
->object
)
18799 : (NILP (glyph
->object
)
18802 glyph
->pixel_width
,
18806 glyph
->left_box_line_p
,
18807 glyph
->right_box_line_p
);
18809 else if (glyph
->type
== IMAGE_GLYPH
)
18812 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18813 glyph
- row
->glyphs
[TEXT_AREA
],
18816 (BUFFERP (glyph
->object
)
18818 : (STRINGP (glyph
->object
)
18820 : (NILP (glyph
->object
)
18823 glyph
->pixel_width
,
18827 glyph
->left_box_line_p
,
18828 glyph
->right_box_line_p
);
18830 else if (glyph
->type
== COMPOSITE_GLYPH
)
18833 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18834 glyph
- row
->glyphs
[TEXT_AREA
],
18837 (BUFFERP (glyph
->object
)
18839 : (STRINGP (glyph
->object
)
18841 : (NILP (glyph
->object
)
18844 glyph
->pixel_width
,
18846 if (glyph
->u
.cmp
.automatic
)
18849 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18850 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18852 glyph
->left_box_line_p
,
18853 glyph
->right_box_line_p
);
18855 else if (glyph
->type
== XWIDGET_GLYPH
)
18857 #ifndef HAVE_XWIDGETS
18861 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
18862 glyph
- row
->glyphs
[TEXT_AREA
],
18865 (BUFFERP (glyph
->object
)
18867 : (STRINGP (glyph
->object
)
18870 glyph
->pixel_width
,
18874 glyph
->left_box_line_p
,
18875 glyph
->right_box_line_p
);
18881 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18882 GLYPHS 0 means don't show glyph contents.
18883 GLYPHS 1 means show glyphs in short form
18884 GLYPHS > 1 means show glyphs in long form. */
18887 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18891 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18892 fprintf (stderr
, "==============================================================================\n");
18894 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18895 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18897 MATRIX_ROW_START_CHARPOS (row
),
18898 MATRIX_ROW_END_CHARPOS (row
),
18899 row
->used
[TEXT_AREA
],
18900 row
->contains_overlapping_glyphs_p
,
18902 row
->truncated_on_left_p
,
18903 row
->truncated_on_right_p
,
18905 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18906 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18909 row
->ends_in_middle_of_char_p
,
18910 row
->starts_in_middle_of_char_p
,
18916 row
->visible_height
,
18919 /* The next 3 lines should align to "Start" in the header. */
18920 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18921 row
->end
.overlay_string_index
,
18922 row
->continuation_lines_width
);
18923 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18924 CHARPOS (row
->start
.string_pos
),
18925 CHARPOS (row
->end
.string_pos
));
18926 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18927 row
->end
.dpvec_index
);
18934 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18936 struct glyph
*glyph
= row
->glyphs
[area
];
18937 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18939 /* Glyph for a line end in text. */
18940 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18943 if (glyph
< glyph_end
)
18944 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18946 for (; glyph
< glyph_end
; ++glyph
)
18947 dump_glyph (row
, glyph
, area
);
18950 else if (glyphs
== 1)
18953 char s
[SHRT_MAX
+ 4];
18955 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18959 for (i
= 0; i
< row
->used
[area
]; ++i
)
18961 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18962 if (i
== row
->used
[area
] - 1
18963 && area
== TEXT_AREA
18964 && NILP (glyph
->object
)
18965 && glyph
->type
== CHAR_GLYPH
18966 && glyph
->u
.ch
== ' ')
18968 strcpy (&s
[i
], "[\\n]");
18971 else if (glyph
->type
== CHAR_GLYPH
18972 && glyph
->u
.ch
< 0x80
18973 && glyph
->u
.ch
>= ' ')
18974 s
[i
] = glyph
->u
.ch
;
18980 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18986 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18987 Sdump_glyph_matrix
, 0, 1, "p",
18988 doc
: /* Dump the current matrix of the selected window to stderr.
18989 Shows contents of glyph row structures. With non-nil
18990 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18991 glyphs in short form, otherwise show glyphs in long form.
18993 Interactively, no argument means show glyphs in short form;
18994 with numeric argument, its value is passed as the GLYPHS flag. */)
18995 (Lisp_Object glyphs
)
18997 struct window
*w
= XWINDOW (selected_window
);
18998 struct buffer
*buffer
= XBUFFER (w
->contents
);
19000 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
19001 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
19002 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
19003 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
19004 fprintf (stderr
, "=============================================\n");
19005 dump_glyph_matrix (w
->current_matrix
,
19006 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
19011 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
19012 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* Dump the current glyph matrix of the selected frame to stderr.
19013 Only text-mode frames have frame glyph matrices. */)
19016 struct frame
*f
= XFRAME (selected_frame
);
19018 if (f
->current_matrix
)
19019 dump_glyph_matrix (f
->current_matrix
, 1);
19021 fprintf (stderr
, "*** This frame doesn't have a frame glyph matrix ***\n");
19026 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
19027 doc
: /* Dump glyph row ROW to stderr.
19028 GLYPH 0 means don't dump glyphs.
19029 GLYPH 1 means dump glyphs in short form.
19030 GLYPH > 1 or omitted means dump glyphs in long form. */)
19031 (Lisp_Object row
, Lisp_Object glyphs
)
19033 struct glyph_matrix
*matrix
;
19036 CHECK_NUMBER (row
);
19037 matrix
= XWINDOW (selected_window
)->current_matrix
;
19039 if (vpos
>= 0 && vpos
< matrix
->nrows
)
19040 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
19042 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
19047 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
19048 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
19049 GLYPH 0 means don't dump glyphs.
19050 GLYPH 1 means dump glyphs in short form.
19051 GLYPH > 1 or omitted means dump glyphs in long form.
19053 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
19055 (Lisp_Object row
, Lisp_Object glyphs
)
19057 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19058 struct frame
*sf
= SELECTED_FRAME ();
19059 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
19062 CHECK_NUMBER (row
);
19064 if (vpos
>= 0 && vpos
< m
->nrows
)
19065 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
19066 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
19072 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
19073 doc
: /* Toggle tracing of redisplay.
19074 With ARG, turn tracing on if and only if ARG is positive. */)
19078 trace_redisplay_p
= !trace_redisplay_p
;
19081 arg
= Fprefix_numeric_value (arg
);
19082 trace_redisplay_p
= XINT (arg
) > 0;
19089 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
19090 doc
: /* Like `format', but print result to stderr.
19091 usage: (trace-to-stderr STRING &rest OBJECTS) */)
19092 (ptrdiff_t nargs
, Lisp_Object
*args
)
19094 Lisp_Object s
= Fformat (nargs
, args
);
19095 fwrite (SDATA (s
), 1, SBYTES (s
), stderr
);
19099 #endif /* GLYPH_DEBUG */
19103 /***********************************************************************
19104 Building Desired Matrix Rows
19105 ***********************************************************************/
19107 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
19108 Used for non-window-redisplay windows, and for windows w/o left fringe. */
19110 static struct glyph_row
*
19111 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
19113 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19114 struct buffer
*buffer
= XBUFFER (w
->contents
);
19115 struct buffer
*old
= current_buffer
;
19116 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
19117 ptrdiff_t arrow_len
= SCHARS (overlay_arrow_string
);
19118 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
19119 const unsigned char *p
;
19122 int n_glyphs_before
;
19124 set_buffer_temp (buffer
);
19125 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
19126 scratch_glyph_row
.reversed_p
= false;
19127 it
.glyph_row
->used
[TEXT_AREA
] = 0;
19128 SET_TEXT_POS (it
.position
, 0, 0);
19130 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
19132 while (p
< arrow_end
)
19134 Lisp_Object face
, ilisp
;
19136 /* Get the next character. */
19138 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
19141 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
19142 if (! ASCII_CHAR_P (it
.c
))
19143 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
19147 /* Get its face. */
19148 ilisp
= make_number (p
- arrow_string
);
19149 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
19150 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
19152 /* Compute its width, get its glyphs. */
19153 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
19154 SET_TEXT_POS (it
.position
, -1, -1);
19155 PRODUCE_GLYPHS (&it
);
19157 /* If this character doesn't fit any more in the line, we have
19158 to remove some glyphs. */
19159 if (it
.current_x
> it
.last_visible_x
)
19161 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19166 set_buffer_temp (old
);
19167 return it
.glyph_row
;
19171 /* Insert truncation glyphs at the start of IT->glyph_row. Which
19172 glyphs to insert is determined by produce_special_glyphs. */
19175 insert_left_trunc_glyphs (struct it
*it
)
19177 struct it truncate_it
;
19178 struct glyph
*from
, *end
, *to
, *toend
;
19180 eassert (!FRAME_WINDOW_P (it
->f
)
19181 || (!it
->glyph_row
->reversed_p
19182 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19183 || (it
->glyph_row
->reversed_p
19184 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
19186 /* Get the truncation glyphs. */
19188 truncate_it
.current_x
= 0;
19189 truncate_it
.face_id
= DEFAULT_FACE_ID
;
19190 truncate_it
.glyph_row
= &scratch_glyph_row
;
19191 truncate_it
.area
= TEXT_AREA
;
19192 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
19193 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
19194 truncate_it
.object
= Qnil
;
19195 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
19197 /* Overwrite glyphs from IT with truncation glyphs. */
19198 if (!it
->glyph_row
->reversed_p
)
19200 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19202 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19203 end
= from
+ tused
;
19204 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19205 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
19206 if (FRAME_WINDOW_P (it
->f
))
19208 /* On GUI frames, when variable-size fonts are displayed,
19209 the truncation glyphs may need more pixels than the row's
19210 glyphs they overwrite. We overwrite more glyphs to free
19211 enough screen real estate, and enlarge the stretch glyph
19212 on the right (see display_line), if there is one, to
19213 preserve the screen position of the truncation glyphs on
19216 struct glyph
*g
= to
;
19219 /* The first glyph could be partially visible, in which case
19220 it->glyph_row->x will be negative. But we want the left
19221 truncation glyphs to be aligned at the left margin of the
19222 window, so we override the x coordinate at which the row
19224 it
->glyph_row
->x
= 0;
19225 while (g
< toend
&& w
< it
->truncation_pixel_width
)
19227 w
+= g
->pixel_width
;
19230 if (g
- to
- tused
> 0)
19232 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
19233 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
19235 used
= it
->glyph_row
->used
[TEXT_AREA
];
19236 if (it
->glyph_row
->truncated_on_right_p
19237 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
19238 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
19241 int extra
= w
- it
->truncation_pixel_width
;
19243 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
19250 /* There may be padding glyphs left over. Overwrite them too. */
19251 if (!FRAME_WINDOW_P (it
->f
))
19253 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
19255 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19262 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
19266 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19268 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19269 that back to front. */
19270 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19271 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19272 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19273 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19274 if (FRAME_WINDOW_P (it
->f
))
19277 struct glyph
*g
= to
;
19279 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19281 w
+= g
->pixel_width
;
19284 if (to
- g
- tused
> 0)
19286 if (it
->glyph_row
->truncated_on_right_p
19287 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19288 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19290 int extra
= w
- it
->truncation_pixel_width
;
19292 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19296 while (from
>= end
&& to
>= toend
)
19298 if (!FRAME_WINDOW_P (it
->f
))
19300 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19303 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19304 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19305 while (from
>= end
&& to
>= toend
)
19311 /* Need to free some room before prepending additional
19313 int move_by
= from
- end
+ 1;
19314 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19315 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19317 for ( ; g
>= g0
; g
--)
19319 while (from
>= end
)
19321 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19326 /* Compute the hash code for ROW. */
19328 row_hash (struct glyph_row
*row
)
19331 unsigned hashval
= 0;
19333 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19334 for (k
= 0; k
< row
->used
[area
]; ++k
)
19335 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19336 + row
->glyphs
[area
][k
].u
.val
19337 + row
->glyphs
[area
][k
].face_id
19338 + row
->glyphs
[area
][k
].padding_p
19339 + (row
->glyphs
[area
][k
].type
<< 2));
19344 /* Compute the pixel height and width of IT->glyph_row.
19346 Most of the time, ascent and height of a display line will be equal
19347 to the max_ascent and max_height values of the display iterator
19348 structure. This is not the case if
19350 1. We hit ZV without displaying anything. In this case, max_ascent
19351 and max_height will be zero.
19353 2. We have some glyphs that don't contribute to the line height.
19354 (The glyph row flag contributes_to_line_height_p is for future
19355 pixmap extensions).
19357 The first case is easily covered by using default values because in
19358 these cases, the line height does not really matter, except that it
19359 must not be zero. */
19362 compute_line_metrics (struct it
*it
)
19364 struct glyph_row
*row
= it
->glyph_row
;
19366 if (FRAME_WINDOW_P (it
->f
))
19368 int i
, min_y
, max_y
;
19370 /* The line may consist of one space only, that was added to
19371 place the cursor on it. If so, the row's height hasn't been
19373 if (row
->height
== 0)
19375 if (it
->max_ascent
+ it
->max_descent
== 0)
19376 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19377 row
->ascent
= it
->max_ascent
;
19378 row
->height
= it
->max_ascent
+ it
->max_descent
;
19379 row
->phys_ascent
= it
->max_phys_ascent
;
19380 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19381 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19384 /* Compute the width of this line. */
19385 row
->pixel_width
= row
->x
;
19386 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19387 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19389 eassert (row
->pixel_width
>= 0);
19390 eassert (row
->ascent
>= 0 && row
->height
> 0);
19392 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19393 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19395 /* If first line's physical ascent is larger than its logical
19396 ascent, use the physical ascent, and make the row taller.
19397 This makes accented characters fully visible. */
19398 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19399 && row
->phys_ascent
> row
->ascent
)
19401 row
->height
+= row
->phys_ascent
- row
->ascent
;
19402 row
->ascent
= row
->phys_ascent
;
19405 /* Compute how much of the line is visible. */
19406 row
->visible_height
= row
->height
;
19408 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19409 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19411 if (row
->y
< min_y
)
19412 row
->visible_height
-= min_y
- row
->y
;
19413 if (row
->y
+ row
->height
> max_y
)
19414 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19418 row
->pixel_width
= row
->used
[TEXT_AREA
];
19419 if (row
->continued_p
)
19420 row
->pixel_width
-= it
->continuation_pixel_width
;
19421 else if (row
->truncated_on_right_p
)
19422 row
->pixel_width
-= it
->truncation_pixel_width
;
19423 row
->ascent
= row
->phys_ascent
= 0;
19424 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19425 row
->extra_line_spacing
= 0;
19428 /* Compute a hash code for this row. */
19429 row
->hash
= row_hash (row
);
19431 it
->max_ascent
= it
->max_descent
= 0;
19432 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19436 /* Append one space to the glyph row of iterator IT if doing a
19437 window-based redisplay. The space has the same face as
19438 IT->face_id. Value is true if a space was added.
19440 This function is called to make sure that there is always one glyph
19441 at the end of a glyph row that the cursor can be set on under
19442 window-systems. (If there weren't such a glyph we would not know
19443 how wide and tall a box cursor should be displayed).
19445 At the same time this space let's a nicely handle clearing to the
19446 end of the line if the row ends in italic text. */
19449 append_space_for_newline (struct it
*it
, bool default_face_p
)
19451 if (FRAME_WINDOW_P (it
->f
))
19453 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19455 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19456 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19458 /* Save some values that must not be changed.
19459 Must save IT->c and IT->len because otherwise
19460 ITERATOR_AT_END_P wouldn't work anymore after
19461 append_space_for_newline has been called. */
19462 enum display_element_type saved_what
= it
->what
;
19463 int saved_c
= it
->c
, saved_len
= it
->len
;
19464 int saved_char_to_display
= it
->char_to_display
;
19465 int saved_x
= it
->current_x
;
19466 int saved_face_id
= it
->face_id
;
19467 bool saved_box_end
= it
->end_of_box_run_p
;
19468 struct text_pos saved_pos
;
19469 Lisp_Object saved_object
;
19473 saved_object
= it
->object
;
19474 saved_pos
= it
->position
;
19476 it
->what
= IT_CHARACTER
;
19477 memset (&it
->position
, 0, sizeof it
->position
);
19479 it
->c
= it
->char_to_display
= ' ';
19482 /* If the default face was remapped, be sure to use the
19483 remapped face for the appended newline. */
19484 if (default_face_p
)
19485 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19486 else if (it
->face_before_selective_p
)
19487 it
->face_id
= it
->saved_face_id
;
19488 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19489 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19490 /* In R2L rows, we will prepend a stretch glyph that will
19491 have the end_of_box_run_p flag set for it, so there's no
19492 need for the appended newline glyph to have that flag
19494 if (it
->glyph_row
->reversed_p
19495 /* But if the appended newline glyph goes all the way to
19496 the end of the row, there will be no stretch glyph,
19497 so leave the box flag set. */
19498 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19499 it
->end_of_box_run_p
= false;
19501 PRODUCE_GLYPHS (it
);
19503 #ifdef HAVE_WINDOW_SYSTEM
19504 /* Make sure this space glyph has the right ascent and
19505 descent values, or else cursor at end of line will look
19506 funny, and height of empty lines will be incorrect. */
19507 g
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19508 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
19511 Lisp_Object height
, total_height
;
19512 int extra_line_spacing
= it
->extra_line_spacing
;
19513 int boff
= font
->baseline_offset
;
19515 if (font
->vertical_centering
)
19516 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
19518 it
->object
= saved_object
; /* get_it_property needs this */
19519 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
19520 /* Must do a subset of line height processing from
19521 x_produce_glyph for newline characters. */
19522 height
= get_it_property (it
, Qline_height
);
19524 && CONSP (XCDR (height
))
19525 && NILP (XCDR (XCDR (height
))))
19527 total_height
= XCAR (XCDR (height
));
19528 height
= XCAR (height
);
19531 total_height
= Qnil
;
19532 height
= calc_line_height_property (it
, height
, font
, boff
, true);
19534 if (it
->override_ascent
>= 0)
19536 it
->ascent
= it
->override_ascent
;
19537 it
->descent
= it
->override_descent
;
19538 boff
= it
->override_boff
;
19540 if (EQ (height
, Qt
))
19541 extra_line_spacing
= 0;
19544 Lisp_Object spacing
;
19546 it
->phys_ascent
= it
->ascent
;
19547 it
->phys_descent
= it
->descent
;
19549 && XINT (height
) > it
->ascent
+ it
->descent
)
19550 it
->ascent
= XINT (height
) - it
->descent
;
19552 if (!NILP (total_height
))
19553 spacing
= calc_line_height_property (it
, total_height
, font
,
19557 spacing
= get_it_property (it
, Qline_spacing
);
19558 spacing
= calc_line_height_property (it
, spacing
, font
,
19561 if (INTEGERP (spacing
))
19563 extra_line_spacing
= XINT (spacing
);
19564 if (!NILP (total_height
))
19565 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
19568 if (extra_line_spacing
> 0)
19570 it
->descent
+= extra_line_spacing
;
19571 if (extra_line_spacing
> it
->max_extra_line_spacing
)
19572 it
->max_extra_line_spacing
= extra_line_spacing
;
19574 it
->max_ascent
= it
->ascent
;
19575 it
->max_descent
= it
->descent
;
19576 /* Make sure compute_line_metrics recomputes the row height. */
19577 it
->glyph_row
->height
= 0;
19580 g
->ascent
= it
->max_ascent
;
19581 g
->descent
= it
->max_descent
;
19584 it
->override_ascent
= -1;
19585 it
->constrain_row_ascent_descent_p
= false;
19586 it
->current_x
= saved_x
;
19587 it
->object
= saved_object
;
19588 it
->position
= saved_pos
;
19589 it
->what
= saved_what
;
19590 it
->face_id
= saved_face_id
;
19591 it
->len
= saved_len
;
19593 it
->char_to_display
= saved_char_to_display
;
19594 it
->end_of_box_run_p
= saved_box_end
;
19603 /* Extend the face of the last glyph in the text area of IT->glyph_row
19604 to the end of the display line. Called from display_line. If the
19605 glyph row is empty, add a space glyph to it so that we know the
19606 face to draw. Set the glyph row flag fill_line_p. If the glyph
19607 row is R2L, prepend a stretch glyph to cover the empty space to the
19608 left of the leftmost glyph. */
19611 extend_face_to_end_of_line (struct it
*it
)
19613 struct face
*face
, *default_face
;
19614 struct frame
*f
= it
->f
;
19616 /* If line is already filled, do nothing. Non window-system frames
19617 get a grace of one more ``pixel'' because their characters are
19618 1-``pixel'' wide, so they hit the equality too early. This grace
19619 is needed only for R2L rows that are not continued, to produce
19620 one extra blank where we could display the cursor. */
19621 if ((it
->current_x
>= it
->last_visible_x
19622 + (!FRAME_WINDOW_P (f
)
19623 && it
->glyph_row
->reversed_p
19624 && !it
->glyph_row
->continued_p
))
19625 /* If the window has display margins, we will need to extend
19626 their face even if the text area is filled. */
19627 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19628 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19631 /* The default face, possibly remapped. */
19632 default_face
= FACE_OPT_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19634 /* Face extension extends the background and box of IT->face_id
19635 to the end of the line. If the background equals the background
19636 of the frame, we don't have to do anything. */
19637 face
= FACE_OPT_FROM_ID (f
, (it
->face_before_selective_p
19639 : it
->saved_face_id
));
19641 if (FRAME_WINDOW_P (f
)
19642 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19643 && face
->box
== FACE_NO_BOX
19644 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19645 #ifdef HAVE_WINDOW_SYSTEM
19648 && !it
->glyph_row
->reversed_p
)
19651 /* Set the glyph row flag indicating that the face of the last glyph
19652 in the text area has to be drawn to the end of the text area. */
19653 it
->glyph_row
->fill_line_p
= true;
19655 /* If current character of IT is not ASCII, make sure we have the
19656 ASCII face. This will be automatically undone the next time
19657 get_next_display_element returns a multibyte character. Note
19658 that the character will always be single byte in unibyte
19660 if (!ASCII_CHAR_P (it
->c
))
19662 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19665 if (FRAME_WINDOW_P (f
))
19667 /* If the row is empty, add a space with the current face of IT,
19668 so that we know which face to draw. */
19669 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19671 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19672 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19673 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19675 /* Mode line and the header line don't have margins, and
19676 likewise the frame's tool-bar window, if there is any. */
19677 if (!(it
->glyph_row
->mode_line_p
19678 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19679 || (WINDOWP (f
->tool_bar_window
)
19680 && it
->w
== XWINDOW (f
->tool_bar_window
))
19684 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19685 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19687 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19688 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19690 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19692 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19693 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19695 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19696 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19698 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19701 #ifdef HAVE_WINDOW_SYSTEM
19702 if (it
->glyph_row
->reversed_p
)
19704 /* Prepend a stretch glyph to the row, such that the
19705 rightmost glyph will be drawn flushed all the way to the
19706 right margin of the window. The stretch glyph that will
19707 occupy the empty space, if any, to the left of the
19709 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19710 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19711 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19713 int row_width
, stretch_ascent
, stretch_width
;
19714 struct text_pos saved_pos
;
19716 bool saved_avoid_cursor
, saved_box_start
;
19718 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19719 row_width
+= g
->pixel_width
;
19721 /* FIXME: There are various minor display glitches in R2L
19722 rows when only one of the fringes is missing. The
19723 strange condition below produces the least bad effect. */
19724 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19725 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19726 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19727 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19729 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19730 stretch_width
-= row_width
;
19732 if (stretch_width
> 0)
19735 (((it
->ascent
+ it
->descent
)
19736 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19737 saved_pos
= it
->position
;
19738 memset (&it
->position
, 0, sizeof it
->position
);
19739 saved_avoid_cursor
= it
->avoid_cursor_p
;
19740 it
->avoid_cursor_p
= true;
19741 saved_face_id
= it
->face_id
;
19742 saved_box_start
= it
->start_of_box_run_p
;
19743 /* The last row's stretch glyph should get the default
19744 face, to avoid painting the rest of the window with
19745 the region face, if the region ends at ZV. */
19746 if (it
->glyph_row
->ends_at_zv_p
)
19747 it
->face_id
= default_face
->id
;
19749 it
->face_id
= face
->id
;
19750 it
->start_of_box_run_p
= false;
19751 append_stretch_glyph (it
, Qnil
, stretch_width
,
19752 it
->ascent
+ it
->descent
, stretch_ascent
);
19753 it
->position
= saved_pos
;
19754 it
->avoid_cursor_p
= saved_avoid_cursor
;
19755 it
->face_id
= saved_face_id
;
19756 it
->start_of_box_run_p
= saved_box_start
;
19758 /* If stretch_width comes out negative, it means that the
19759 last glyph is only partially visible. In R2L rows, we
19760 want the leftmost glyph to be partially visible, so we
19761 need to give the row the corresponding left offset. */
19762 if (stretch_width
< 0)
19763 it
->glyph_row
->x
= stretch_width
;
19765 #endif /* HAVE_WINDOW_SYSTEM */
19769 /* Save some values that must not be changed. */
19770 int saved_x
= it
->current_x
;
19771 struct text_pos saved_pos
;
19772 Lisp_Object saved_object
;
19773 enum display_element_type saved_what
= it
->what
;
19774 int saved_face_id
= it
->face_id
;
19776 saved_object
= it
->object
;
19777 saved_pos
= it
->position
;
19779 it
->what
= IT_CHARACTER
;
19780 memset (&it
->position
, 0, sizeof it
->position
);
19782 it
->c
= it
->char_to_display
= ' ';
19785 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19786 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19787 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19788 && !it
->glyph_row
->mode_line_p
19789 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19791 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19792 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19794 for (it
->current_x
= 0; g
< e
; g
++)
19795 it
->current_x
+= g
->pixel_width
;
19797 it
->area
= LEFT_MARGIN_AREA
;
19798 it
->face_id
= default_face
->id
;
19799 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19800 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19802 PRODUCE_GLYPHS (it
);
19803 /* term.c:produce_glyphs advances it->current_x only for
19805 it
->current_x
+= it
->pixel_width
;
19808 it
->current_x
= saved_x
;
19809 it
->area
= TEXT_AREA
;
19812 /* The last row's blank glyphs should get the default face, to
19813 avoid painting the rest of the window with the region face,
19814 if the region ends at ZV. */
19815 if (it
->glyph_row
->ends_at_zv_p
)
19816 it
->face_id
= default_face
->id
;
19818 it
->face_id
= face
->id
;
19819 PRODUCE_GLYPHS (it
);
19821 while (it
->current_x
<= it
->last_visible_x
)
19822 PRODUCE_GLYPHS (it
);
19824 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19825 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19826 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19827 && !it
->glyph_row
->mode_line_p
19828 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19830 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19831 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19833 for ( ; g
< e
; g
++)
19834 it
->current_x
+= g
->pixel_width
;
19836 it
->area
= RIGHT_MARGIN_AREA
;
19837 it
->face_id
= default_face
->id
;
19838 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19839 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19841 PRODUCE_GLYPHS (it
);
19842 it
->current_x
+= it
->pixel_width
;
19845 it
->area
= TEXT_AREA
;
19848 /* Don't count these blanks really. It would let us insert a left
19849 truncation glyph below and make us set the cursor on them, maybe. */
19850 it
->current_x
= saved_x
;
19851 it
->object
= saved_object
;
19852 it
->position
= saved_pos
;
19853 it
->what
= saved_what
;
19854 it
->face_id
= saved_face_id
;
19859 /* Value is true if text starting at CHARPOS in current_buffer is
19860 trailing whitespace. */
19863 trailing_whitespace_p (ptrdiff_t charpos
)
19865 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19868 while (bytepos
< ZV_BYTE
19869 && (c
= FETCH_CHAR (bytepos
),
19870 c
== ' ' || c
== '\t'))
19873 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19875 if (bytepos
!= PT_BYTE
)
19882 /* Highlight trailing whitespace, if any, in ROW. */
19885 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19887 int used
= row
->used
[TEXT_AREA
];
19891 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19892 struct glyph
*glyph
= start
+ used
- 1;
19894 if (row
->reversed_p
)
19896 /* Right-to-left rows need to be processed in the opposite
19897 direction, so swap the edge pointers. */
19899 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19902 /* Skip over glyphs inserted to display the cursor at the
19903 end of a line, for extending the face of the last glyph
19904 to the end of the line on terminals, and for truncation
19905 and continuation glyphs. */
19906 if (!row
->reversed_p
)
19908 while (glyph
>= start
19909 && glyph
->type
== CHAR_GLYPH
19910 && NILP (glyph
->object
))
19915 while (glyph
<= start
19916 && glyph
->type
== CHAR_GLYPH
19917 && NILP (glyph
->object
))
19921 /* If last glyph is a space or stretch, and it's trailing
19922 whitespace, set the face of all trailing whitespace glyphs in
19923 IT->glyph_row to `trailing-whitespace'. */
19924 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19925 && BUFFERP (glyph
->object
)
19926 && (glyph
->type
== STRETCH_GLYPH
19927 || (glyph
->type
== CHAR_GLYPH
19928 && glyph
->u
.ch
== ' '))
19929 && trailing_whitespace_p (glyph
->charpos
))
19931 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, false);
19935 if (!row
->reversed_p
)
19937 while (glyph
>= start
19938 && BUFFERP (glyph
->object
)
19939 && (glyph
->type
== STRETCH_GLYPH
19940 || (glyph
->type
== CHAR_GLYPH
19941 && glyph
->u
.ch
== ' ')))
19942 (glyph
--)->face_id
= face_id
;
19946 while (glyph
<= start
19947 && BUFFERP (glyph
->object
)
19948 && (glyph
->type
== STRETCH_GLYPH
19949 || (glyph
->type
== CHAR_GLYPH
19950 && glyph
->u
.ch
== ' ')))
19951 (glyph
++)->face_id
= face_id
;
19958 /* Value is true if glyph row ROW should be
19959 considered to hold the buffer position CHARPOS. */
19962 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19964 bool result
= true;
19966 if (charpos
== CHARPOS (row
->end
.pos
)
19967 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19969 /* Suppose the row ends on a string.
19970 Unless the row is continued, that means it ends on a newline
19971 in the string. If it's anything other than a display string
19972 (e.g., a before-string from an overlay), we don't want the
19973 cursor there. (This heuristic seems to give the optimal
19974 behavior for the various types of multi-line strings.)
19975 One exception: if the string has `cursor' property on one of
19976 its characters, we _do_ want the cursor there. */
19977 if (CHARPOS (row
->end
.string_pos
) >= 0)
19979 if (row
->continued_p
)
19983 /* Check for `display' property. */
19984 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19985 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19986 struct glyph
*glyph
;
19989 for (glyph
= end
; glyph
>= beg
; --glyph
)
19990 if (STRINGP (glyph
->object
))
19993 = Fget_char_property (make_number (charpos
),
19997 && display_prop_string_p (prop
, glyph
->object
));
19998 /* If there's a `cursor' property on one of the
19999 string's characters, this row is a cursor row,
20000 even though this is not a display string. */
20003 Lisp_Object s
= glyph
->object
;
20005 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
20007 ptrdiff_t gpos
= glyph
->charpos
;
20009 if (!NILP (Fget_char_property (make_number (gpos
),
20021 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
20023 /* If the row ends in middle of a real character,
20024 and the line is continued, we want the cursor here.
20025 That's because CHARPOS (ROW->end.pos) would equal
20026 PT if PT is before the character. */
20027 if (!row
->ends_in_ellipsis_p
)
20028 result
= row
->continued_p
;
20030 /* If the row ends in an ellipsis, then
20031 CHARPOS (ROW->end.pos) will equal point after the
20032 invisible text. We want that position to be displayed
20033 after the ellipsis. */
20036 /* If the row ends at ZV, display the cursor at the end of that
20037 row instead of at the start of the row below. */
20039 result
= row
->ends_at_zv_p
;
20045 /* Value is true if glyph row ROW should be
20046 used to hold the cursor. */
20049 cursor_row_p (struct glyph_row
*row
)
20051 return row_for_charpos_p (row
, PT
);
20056 /* Push the property PROP so that it will be rendered at the current
20057 position in IT. Return true if PROP was successfully pushed, false
20058 otherwise. Called from handle_line_prefix to handle the
20059 `line-prefix' and `wrap-prefix' properties. */
20062 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
20064 struct text_pos pos
=
20065 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
20067 eassert (it
->method
== GET_FROM_BUFFER
20068 || it
->method
== GET_FROM_DISPLAY_VECTOR
20069 || it
->method
== GET_FROM_STRING
20070 || it
->method
== GET_FROM_IMAGE
);
20072 /* We need to save the current buffer/string position, so it will be
20073 restored by pop_it, because iterate_out_of_display_property
20074 depends on that being set correctly, but some situations leave
20075 it->position not yet set when this function is called. */
20076 push_it (it
, &pos
);
20078 if (STRINGP (prop
))
20080 if (SCHARS (prop
) == 0)
20087 it
->string_from_prefix_prop_p
= true;
20088 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
20089 it
->current
.overlay_string_index
= -1;
20090 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
20091 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
20092 it
->method
= GET_FROM_STRING
;
20093 it
->stop_charpos
= 0;
20095 it
->base_level_stop
= 0;
20097 /* Force paragraph direction to be that of the parent
20099 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
20100 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
20102 it
->paragraph_embedding
= L2R
;
20104 /* Set up the bidi iterator for this display string. */
20107 it
->bidi_it
.string
.lstring
= it
->string
;
20108 it
->bidi_it
.string
.s
= NULL
;
20109 it
->bidi_it
.string
.schars
= it
->end_charpos
;
20110 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
20111 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
20112 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
20113 it
->bidi_it
.w
= it
->w
;
20114 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
20117 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
20119 it
->method
= GET_FROM_STRETCH
;
20122 #ifdef HAVE_WINDOW_SYSTEM
20123 else if (IMAGEP (prop
))
20125 it
->what
= IT_IMAGE
;
20126 it
->image_id
= lookup_image (it
->f
, prop
);
20127 it
->method
= GET_FROM_IMAGE
;
20129 #endif /* HAVE_WINDOW_SYSTEM */
20132 pop_it (it
); /* bogus display property, give up */
20139 /* Return the character-property PROP at the current position in IT. */
20142 get_it_property (struct it
*it
, Lisp_Object prop
)
20144 Lisp_Object position
, object
= it
->object
;
20146 if (STRINGP (object
))
20147 position
= make_number (IT_STRING_CHARPOS (*it
));
20148 else if (BUFFERP (object
))
20150 position
= make_number (IT_CHARPOS (*it
));
20151 object
= it
->window
;
20156 return Fget_char_property (position
, prop
, object
);
20159 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
20162 handle_line_prefix (struct it
*it
)
20164 Lisp_Object prefix
;
20166 if (it
->continuation_lines_width
> 0)
20168 prefix
= get_it_property (it
, Qwrap_prefix
);
20170 prefix
= Vwrap_prefix
;
20174 prefix
= get_it_property (it
, Qline_prefix
);
20176 prefix
= Vline_prefix
;
20178 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
20180 /* If the prefix is wider than the window, and we try to wrap
20181 it, it would acquire its own wrap prefix, and so on till the
20182 iterator stack overflows. So, don't wrap the prefix. */
20183 it
->line_wrap
= TRUNCATE
;
20184 it
->avoid_cursor_p
= true;
20190 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
20191 only for R2L lines from display_line and display_string, when they
20192 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
20193 the line/string needs to be continued on the next glyph row. */
20195 unproduce_glyphs (struct it
*it
, int n
)
20197 struct glyph
*glyph
, *end
;
20199 eassert (it
->glyph_row
);
20200 eassert (it
->glyph_row
->reversed_p
);
20201 eassert (it
->area
== TEXT_AREA
);
20202 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
20204 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
20205 n
= it
->glyph_row
->used
[TEXT_AREA
];
20206 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
20207 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
20208 for ( ; glyph
< end
; glyph
++)
20209 glyph
[-n
] = *glyph
;
20212 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
20213 and ROW->maxpos. */
20215 find_row_edges (struct it
*it
, struct glyph_row
*row
,
20216 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
20217 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
20219 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20220 lines' rows is implemented for bidi-reordered rows. */
20222 /* ROW->minpos is the value of min_pos, the minimal buffer position
20223 we have in ROW, or ROW->start.pos if that is smaller. */
20224 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
20225 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
20227 /* We didn't find buffer positions smaller than ROW->start, or
20228 didn't find _any_ valid buffer positions in any of the glyphs,
20229 so we must trust the iterator's computed positions. */
20230 row
->minpos
= row
->start
.pos
;
20233 max_pos
= CHARPOS (it
->current
.pos
);
20234 max_bpos
= BYTEPOS (it
->current
.pos
);
20237 /* Here are the various use-cases for ending the row, and the
20238 corresponding values for ROW->maxpos:
20240 Line ends in a newline from buffer eol_pos + 1
20241 Line is continued from buffer max_pos + 1
20242 Line is truncated on right it->current.pos
20243 Line ends in a newline from string max_pos + 1(*)
20244 (*) + 1 only when line ends in a forward scan
20245 Line is continued from string max_pos
20246 Line is continued from display vector max_pos
20247 Line is entirely from a string min_pos == max_pos
20248 Line is entirely from a display vector min_pos == max_pos
20249 Line that ends at ZV ZV
20251 If you discover other use-cases, please add them here as
20253 if (row
->ends_at_zv_p
)
20254 row
->maxpos
= it
->current
.pos
;
20255 else if (row
->used
[TEXT_AREA
])
20257 bool seen_this_string
= false;
20258 struct glyph_row
*r1
= row
- 1;
20260 /* Did we see the same display string on the previous row? */
20261 if (STRINGP (it
->object
)
20262 /* this is not the first row */
20263 && row
> it
->w
->desired_matrix
->rows
20264 /* previous row is not the header line */
20265 && !r1
->mode_line_p
20266 /* previous row also ends in a newline from a string */
20267 && r1
->ends_in_newline_from_string_p
)
20269 struct glyph
*start
, *end
;
20271 /* Search for the last glyph of the previous row that came
20272 from buffer or string. Depending on whether the row is
20273 L2R or R2L, we need to process it front to back or the
20274 other way round. */
20275 if (!r1
->reversed_p
)
20277 start
= r1
->glyphs
[TEXT_AREA
];
20278 end
= start
+ r1
->used
[TEXT_AREA
];
20279 /* Glyphs inserted by redisplay have nil as their object. */
20281 && NILP ((end
- 1)->object
)
20282 && (end
- 1)->charpos
<= 0)
20286 if (EQ ((end
- 1)->object
, it
->object
))
20287 seen_this_string
= true;
20290 /* If all the glyphs of the previous row were inserted
20291 by redisplay, it means the previous row was
20292 produced from a single newline, which is only
20293 possible if that newline came from the same string
20294 as the one which produced this ROW. */
20295 seen_this_string
= true;
20299 end
= r1
->glyphs
[TEXT_AREA
] - 1;
20300 start
= end
+ r1
->used
[TEXT_AREA
];
20302 && NILP ((end
+ 1)->object
)
20303 && (end
+ 1)->charpos
<= 0)
20307 if (EQ ((end
+ 1)->object
, it
->object
))
20308 seen_this_string
= true;
20311 seen_this_string
= true;
20314 /* Take note of each display string that covers a newline only
20315 once, the first time we see it. This is for when a display
20316 string includes more than one newline in it. */
20317 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
20319 /* If we were scanning the buffer forward when we displayed
20320 the string, we want to account for at least one buffer
20321 position that belongs to this row (position covered by
20322 the display string), so that cursor positioning will
20323 consider this row as a candidate when point is at the end
20324 of the visual line represented by this row. This is not
20325 required when scanning back, because max_pos will already
20326 have a much larger value. */
20327 if (CHARPOS (row
->end
.pos
) > max_pos
)
20328 INC_BOTH (max_pos
, max_bpos
);
20329 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20331 else if (CHARPOS (it
->eol_pos
) > 0)
20332 SET_TEXT_POS (row
->maxpos
,
20333 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
20334 else if (row
->continued_p
)
20336 /* If max_pos is different from IT's current position, it
20337 means IT->method does not belong to the display element
20338 at max_pos. However, it also means that the display
20339 element at max_pos was displayed in its entirety on this
20340 line, which is equivalent to saying that the next line
20341 starts at the next buffer position. */
20342 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
20343 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20346 INC_BOTH (max_pos
, max_bpos
);
20347 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20350 else if (row
->truncated_on_right_p
)
20351 /* display_line already called reseat_at_next_visible_line_start,
20352 which puts the iterator at the beginning of the next line, in
20353 the logical order. */
20354 row
->maxpos
= it
->current
.pos
;
20355 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20356 /* A line that is entirely from a string/image/stretch... */
20357 row
->maxpos
= row
->minpos
;
20362 row
->maxpos
= it
->current
.pos
;
20365 /* Construct the glyph row IT->glyph_row in the desired matrix of
20366 IT->w from text at the current position of IT. See dispextern.h
20367 for an overview of struct it. Value is true if
20368 IT->glyph_row displays text, as opposed to a line displaying ZV
20372 display_line (struct it
*it
)
20374 struct glyph_row
*row
= it
->glyph_row
;
20375 Lisp_Object overlay_arrow_string
;
20377 void *wrap_data
= NULL
;
20378 bool may_wrap
= false;
20379 int wrap_x
IF_LINT (= 0);
20380 int wrap_row_used
= -1;
20381 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
20382 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
20383 int wrap_row_extra_line_spacing
IF_LINT (= 0);
20384 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
20385 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
20387 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20388 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
20389 bool pending_handle_line_prefix
= false;
20391 /* We always start displaying at hpos zero even if hscrolled. */
20392 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20394 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20395 >= it
->w
->desired_matrix
->nrows
)
20397 it
->w
->nrows_scale_factor
++;
20398 it
->f
->fonts_changed
= true;
20402 /* Clear the result glyph row and enable it. */
20403 prepare_desired_row (it
->w
, row
, false);
20405 row
->y
= it
->current_y
;
20406 row
->start
= it
->start
;
20407 row
->continuation_lines_width
= it
->continuation_lines_width
;
20408 row
->displays_text_p
= true;
20409 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20410 it
->starts_in_middle_of_char_p
= false;
20412 /* Arrange the overlays nicely for our purposes. Usually, we call
20413 display_line on only one line at a time, in which case this
20414 can't really hurt too much, or we call it on lines which appear
20415 one after another in the buffer, in which case all calls to
20416 recenter_overlay_lists but the first will be pretty cheap. */
20417 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20419 /* Move over display elements that are not visible because we are
20420 hscrolled. This may stop at an x-position < IT->first_visible_x
20421 if the first glyph is partially visible or if we hit a line end. */
20422 if (it
->current_x
< it
->first_visible_x
)
20424 enum move_it_result move_result
;
20426 this_line_min_pos
= row
->start
.pos
;
20427 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20428 MOVE_TO_POS
| MOVE_TO_X
);
20429 /* If we are under a large hscroll, move_it_in_display_line_to
20430 could hit the end of the line without reaching
20431 it->first_visible_x. Pretend that we did reach it. This is
20432 especially important on a TTY, where we will call
20433 extend_face_to_end_of_line, which needs to know how many
20434 blank glyphs to produce. */
20435 if (it
->current_x
< it
->first_visible_x
20436 && (move_result
== MOVE_NEWLINE_OR_CR
20437 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20438 it
->current_x
= it
->first_visible_x
;
20440 /* Record the smallest positions seen while we moved over
20441 display elements that are not visible. This is needed by
20442 redisplay_internal for optimizing the case where the cursor
20443 stays inside the same line. The rest of this function only
20444 considers positions that are actually displayed, so
20445 RECORD_MAX_MIN_POS will not otherwise record positions that
20446 are hscrolled to the left of the left edge of the window. */
20447 min_pos
= CHARPOS (this_line_min_pos
);
20448 min_bpos
= BYTEPOS (this_line_min_pos
);
20450 else if (it
->area
== TEXT_AREA
)
20452 /* We only do this when not calling move_it_in_display_line_to
20453 above, because that function calls itself handle_line_prefix. */
20454 handle_line_prefix (it
);
20458 /* Line-prefix and wrap-prefix are always displayed in the text
20459 area. But if this is the first call to display_line after
20460 init_iterator, the iterator might have been set up to write
20461 into a marginal area, e.g. if the line begins with some
20462 display property that writes to the margins. So we need to
20463 wait with the call to handle_line_prefix until whatever
20464 writes to the margin has done its job. */
20465 pending_handle_line_prefix
= true;
20468 /* Get the initial row height. This is either the height of the
20469 text hscrolled, if there is any, or zero. */
20470 row
->ascent
= it
->max_ascent
;
20471 row
->height
= it
->max_ascent
+ it
->max_descent
;
20472 row
->phys_ascent
= it
->max_phys_ascent
;
20473 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20474 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20476 /* Utility macro to record max and min buffer positions seen until now. */
20477 #define RECORD_MAX_MIN_POS(IT) \
20480 bool composition_p \
20481 = !STRINGP ((IT)->string) && ((IT)->what == IT_COMPOSITION); \
20482 ptrdiff_t current_pos = \
20483 composition_p ? (IT)->cmp_it.charpos \
20484 : IT_CHARPOS (*(IT)); \
20485 ptrdiff_t current_bpos = \
20486 composition_p ? CHAR_TO_BYTE (current_pos) \
20487 : IT_BYTEPOS (*(IT)); \
20488 if (current_pos < min_pos) \
20490 min_pos = current_pos; \
20491 min_bpos = current_bpos; \
20493 if (IT_CHARPOS (*it) > max_pos) \
20495 max_pos = IT_CHARPOS (*it); \
20496 max_bpos = IT_BYTEPOS (*it); \
20501 /* Loop generating characters. The loop is left with IT on the next
20502 character to display. */
20505 int n_glyphs_before
, hpos_before
, x_before
;
20507 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20509 /* Retrieve the next thing to display. Value is false if end of
20511 if (!get_next_display_element (it
))
20513 /* Maybe add a space at the end of this line that is used to
20514 display the cursor there under X. Set the charpos of the
20515 first glyph of blank lines not corresponding to any text
20517 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20518 row
->exact_window_width_line_p
= true;
20519 else if ((append_space_for_newline (it
, true)
20520 && row
->used
[TEXT_AREA
] == 1)
20521 || row
->used
[TEXT_AREA
] == 0)
20523 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20524 row
->displays_text_p
= false;
20526 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20527 && (!MINI_WINDOW_P (it
->w
)
20528 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20529 row
->indicate_empty_line_p
= true;
20532 it
->continuation_lines_width
= 0;
20533 row
->ends_at_zv_p
= true;
20534 /* A row that displays right-to-left text must always have
20535 its last face extended all the way to the end of line,
20536 even if this row ends in ZV, because we still write to
20537 the screen left to right. We also need to extend the
20538 last face if the default face is remapped to some
20539 different face, otherwise the functions that clear
20540 portions of the screen will clear with the default face's
20541 background color. */
20542 if (row
->reversed_p
20543 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20544 extend_face_to_end_of_line (it
);
20548 /* Now, get the metrics of what we want to display. This also
20549 generates glyphs in `row' (which is IT->glyph_row). */
20550 n_glyphs_before
= row
->used
[TEXT_AREA
];
20553 /* Remember the line height so far in case the next element doesn't
20554 fit on the line. */
20555 if (it
->line_wrap
!= TRUNCATE
)
20557 ascent
= it
->max_ascent
;
20558 descent
= it
->max_descent
;
20559 phys_ascent
= it
->max_phys_ascent
;
20560 phys_descent
= it
->max_phys_descent
;
20562 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20564 if (IT_DISPLAYING_WHITESPACE (it
))
20568 SAVE_IT (wrap_it
, *it
, wrap_data
);
20570 wrap_row_used
= row
->used
[TEXT_AREA
];
20571 wrap_row_ascent
= row
->ascent
;
20572 wrap_row_height
= row
->height
;
20573 wrap_row_phys_ascent
= row
->phys_ascent
;
20574 wrap_row_phys_height
= row
->phys_height
;
20575 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20576 wrap_row_min_pos
= min_pos
;
20577 wrap_row_min_bpos
= min_bpos
;
20578 wrap_row_max_pos
= max_pos
;
20579 wrap_row_max_bpos
= max_bpos
;
20585 PRODUCE_GLYPHS (it
);
20587 /* If this display element was in marginal areas, continue with
20589 if (it
->area
!= TEXT_AREA
)
20591 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20592 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20593 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20594 row
->phys_height
= max (row
->phys_height
,
20595 it
->max_phys_ascent
+ it
->max_phys_descent
);
20596 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20597 it
->max_extra_line_spacing
);
20598 set_iterator_to_next (it
, true);
20599 /* If we didn't handle the line/wrap prefix above, and the
20600 call to set_iterator_to_next just switched to TEXT_AREA,
20601 process the prefix now. */
20602 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20604 pending_handle_line_prefix
= false;
20605 handle_line_prefix (it
);
20610 /* Does the display element fit on the line? If we truncate
20611 lines, we should draw past the right edge of the window. If
20612 we don't truncate, we want to stop so that we can display the
20613 continuation glyph before the right margin. If lines are
20614 continued, there are two possible strategies for characters
20615 resulting in more than 1 glyph (e.g. tabs): Display as many
20616 glyphs as possible in this line and leave the rest for the
20617 continuation line, or display the whole element in the next
20618 line. Original redisplay did the former, so we do it also. */
20619 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20620 hpos_before
= it
->hpos
;
20623 if (/* Not a newline. */
20625 /* Glyphs produced fit entirely in the line. */
20626 && it
->current_x
< it
->last_visible_x
)
20628 it
->hpos
+= nglyphs
;
20629 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20630 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20631 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20632 row
->phys_height
= max (row
->phys_height
,
20633 it
->max_phys_ascent
+ it
->max_phys_descent
);
20634 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20635 it
->max_extra_line_spacing
);
20636 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20637 /* In R2L rows, we arrange in extend_face_to_end_of_line
20638 to add a right offset to the line, by a suitable
20639 change to the stretch glyph that is the leftmost
20640 glyph of the line. */
20641 && !row
->reversed_p
)
20642 row
->x
= x
- it
->first_visible_x
;
20643 /* Record the maximum and minimum buffer positions seen so
20644 far in glyphs that will be displayed by this row. */
20646 RECORD_MAX_MIN_POS (it
);
20651 struct glyph
*glyph
;
20653 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20655 /* Identify the glyphs added by the last call to
20656 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20657 the previous glyphs. */
20658 if (!row
->reversed_p
)
20659 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20661 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20662 new_x
= x
+ glyph
->pixel_width
;
20664 if (/* Lines are continued. */
20665 it
->line_wrap
!= TRUNCATE
20666 && (/* Glyph doesn't fit on the line. */
20667 new_x
> it
->last_visible_x
20668 /* Or it fits exactly on a window system frame. */
20669 || (new_x
== it
->last_visible_x
20670 && FRAME_WINDOW_P (it
->f
)
20671 && (row
->reversed_p
20672 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20673 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20675 /* End of a continued line. */
20678 || (new_x
== it
->last_visible_x
20679 && FRAME_WINDOW_P (it
->f
)
20680 && (row
->reversed_p
20681 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20682 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20684 /* Current glyph is the only one on the line or
20685 fits exactly on the line. We must continue
20686 the line because we can't draw the cursor
20687 after the glyph. */
20688 row
->continued_p
= true;
20689 it
->current_x
= new_x
;
20690 it
->continuation_lines_width
+= new_x
;
20692 if (i
== nglyphs
- 1)
20694 /* If line-wrap is on, check if a previous
20695 wrap point was found. */
20696 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)
20697 && wrap_row_used
> 0
20698 /* Even if there is a previous wrap
20699 point, continue the line here as
20700 usual, if (i) the previous character
20701 was a space or tab AND (ii) the
20702 current character is not. */
20704 || IT_DISPLAYING_WHITESPACE (it
)))
20707 /* Record the maximum and minimum buffer
20708 positions seen so far in glyphs that will be
20709 displayed by this row. */
20711 RECORD_MAX_MIN_POS (it
);
20712 set_iterator_to_next (it
, true);
20713 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20715 if (!get_next_display_element (it
))
20717 row
->exact_window_width_line_p
= true;
20718 it
->continuation_lines_width
= 0;
20719 row
->continued_p
= false;
20720 row
->ends_at_zv_p
= true;
20722 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20724 row
->continued_p
= false;
20725 row
->exact_window_width_line_p
= true;
20727 /* If line-wrap is on, check if a
20728 previous wrap point was found. */
20729 else if (wrap_row_used
> 0
20730 /* Even if there is a previous wrap
20731 point, continue the line here as
20732 usual, if (i) the previous character
20733 was a space or tab AND (ii) the
20734 current character is not. */
20736 || IT_DISPLAYING_WHITESPACE (it
)))
20741 else if (it
->bidi_p
)
20742 RECORD_MAX_MIN_POS (it
);
20743 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20744 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20745 extend_face_to_end_of_line (it
);
20747 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20748 && !FRAME_WINDOW_P (it
->f
))
20750 /* A padding glyph that doesn't fit on this line.
20751 This means the whole character doesn't fit
20753 if (row
->reversed_p
)
20754 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20755 - n_glyphs_before
);
20756 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20758 /* Fill the rest of the row with continuation
20759 glyphs like in 20.x. */
20760 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20761 < row
->glyphs
[1 + TEXT_AREA
])
20762 produce_special_glyphs (it
, IT_CONTINUATION
);
20764 row
->continued_p
= true;
20765 it
->current_x
= x_before
;
20766 it
->continuation_lines_width
+= x_before
;
20768 /* Restore the height to what it was before the
20769 element not fitting on the line. */
20770 it
->max_ascent
= ascent
;
20771 it
->max_descent
= descent
;
20772 it
->max_phys_ascent
= phys_ascent
;
20773 it
->max_phys_descent
= phys_descent
;
20774 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20775 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20776 extend_face_to_end_of_line (it
);
20778 else if (wrap_row_used
> 0)
20781 if (row
->reversed_p
)
20782 unproduce_glyphs (it
,
20783 row
->used
[TEXT_AREA
] - wrap_row_used
);
20784 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20785 it
->continuation_lines_width
+= wrap_x
;
20786 row
->used
[TEXT_AREA
] = wrap_row_used
;
20787 row
->ascent
= wrap_row_ascent
;
20788 row
->height
= wrap_row_height
;
20789 row
->phys_ascent
= wrap_row_phys_ascent
;
20790 row
->phys_height
= wrap_row_phys_height
;
20791 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20792 min_pos
= wrap_row_min_pos
;
20793 min_bpos
= wrap_row_min_bpos
;
20794 max_pos
= wrap_row_max_pos
;
20795 max_bpos
= wrap_row_max_bpos
;
20796 row
->continued_p
= true;
20797 row
->ends_at_zv_p
= false;
20798 row
->exact_window_width_line_p
= false;
20799 it
->continuation_lines_width
+= x
;
20801 /* Make sure that a non-default face is extended
20802 up to the right margin of the window. */
20803 extend_face_to_end_of_line (it
);
20805 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20807 /* A TAB that extends past the right edge of the
20808 window. This produces a single glyph on
20809 window system frames. We leave the glyph in
20810 this row and let it fill the row, but don't
20811 consume the TAB. */
20812 if ((row
->reversed_p
20813 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20814 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20815 produce_special_glyphs (it
, IT_CONTINUATION
);
20816 it
->continuation_lines_width
+= it
->last_visible_x
;
20817 row
->ends_in_middle_of_char_p
= true;
20818 row
->continued_p
= true;
20819 glyph
->pixel_width
= it
->last_visible_x
- x
;
20820 it
->starts_in_middle_of_char_p
= true;
20821 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20822 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20823 extend_face_to_end_of_line (it
);
20827 /* Something other than a TAB that draws past
20828 the right edge of the window. Restore
20829 positions to values before the element. */
20830 if (row
->reversed_p
)
20831 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20832 - (n_glyphs_before
+ i
));
20833 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20835 /* Display continuation glyphs. */
20836 it
->current_x
= x_before
;
20837 it
->continuation_lines_width
+= x
;
20838 if (!FRAME_WINDOW_P (it
->f
)
20839 || (row
->reversed_p
20840 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20841 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20842 produce_special_glyphs (it
, IT_CONTINUATION
);
20843 row
->continued_p
= true;
20845 extend_face_to_end_of_line (it
);
20847 if (nglyphs
> 1 && i
> 0)
20849 row
->ends_in_middle_of_char_p
= true;
20850 it
->starts_in_middle_of_char_p
= true;
20853 /* Restore the height to what it was before the
20854 element not fitting on the line. */
20855 it
->max_ascent
= ascent
;
20856 it
->max_descent
= descent
;
20857 it
->max_phys_ascent
= phys_ascent
;
20858 it
->max_phys_descent
= phys_descent
;
20863 else if (new_x
> it
->first_visible_x
)
20865 /* Increment number of glyphs actually displayed. */
20868 /* Record the maximum and minimum buffer positions
20869 seen so far in glyphs that will be displayed by
20872 RECORD_MAX_MIN_POS (it
);
20874 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20875 /* Glyph is partially visible, i.e. row starts at
20876 negative X position. Don't do that in R2L
20877 rows, where we arrange to add a right offset to
20878 the line in extend_face_to_end_of_line, by a
20879 suitable change to the stretch glyph that is
20880 the leftmost glyph of the line. */
20881 row
->x
= x
- it
->first_visible_x
;
20882 /* When the last glyph of an R2L row only fits
20883 partially on the line, we need to set row->x to a
20884 negative offset, so that the leftmost glyph is
20885 the one that is partially visible. But if we are
20886 going to produce the truncation glyph, this will
20887 be taken care of in produce_special_glyphs. */
20888 if (row
->reversed_p
20889 && new_x
> it
->last_visible_x
20890 && !(it
->line_wrap
== TRUNCATE
20891 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
20893 eassert (FRAME_WINDOW_P (it
->f
));
20894 row
->x
= it
->last_visible_x
- new_x
;
20899 /* Glyph is completely off the left margin of the
20900 window. This should not happen because of the
20901 move_it_in_display_line at the start of this
20902 function, unless the text display area of the
20903 window is empty. */
20904 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20907 /* Even if this display element produced no glyphs at all,
20908 we want to record its position. */
20909 if (it
->bidi_p
&& nglyphs
== 0)
20910 RECORD_MAX_MIN_POS (it
);
20912 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20913 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20914 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20915 row
->phys_height
= max (row
->phys_height
,
20916 it
->max_phys_ascent
+ it
->max_phys_descent
);
20917 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20918 it
->max_extra_line_spacing
);
20920 /* End of this display line if row is continued. */
20921 if (row
->continued_p
|| row
->ends_at_zv_p
)
20926 /* Is this a line end? If yes, we're also done, after making
20927 sure that a non-default face is extended up to the right
20928 margin of the window. */
20929 if (ITERATOR_AT_END_OF_LINE_P (it
))
20931 int used_before
= row
->used
[TEXT_AREA
];
20933 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20935 /* Add a space at the end of the line that is used to
20936 display the cursor there. */
20937 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20938 append_space_for_newline (it
, false);
20940 /* Extend the face to the end of the line. */
20941 extend_face_to_end_of_line (it
);
20943 /* Make sure we have the position. */
20944 if (used_before
== 0)
20945 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20947 /* Record the position of the newline, for use in
20949 it
->eol_pos
= it
->current
.pos
;
20951 /* Consume the line end. This skips over invisible lines. */
20952 set_iterator_to_next (it
, true);
20953 it
->continuation_lines_width
= 0;
20957 /* Proceed with next display element. Note that this skips
20958 over lines invisible because of selective display. */
20959 set_iterator_to_next (it
, true);
20961 /* If we truncate lines, we are done when the last displayed
20962 glyphs reach past the right margin of the window. */
20963 if (it
->line_wrap
== TRUNCATE
20964 && ((FRAME_WINDOW_P (it
->f
)
20965 /* Images are preprocessed in produce_image_glyph such
20966 that they are cropped at the right edge of the
20967 window, so an image glyph will always end exactly at
20968 last_visible_x, even if there's no right fringe. */
20969 && ((row
->reversed_p
20970 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20971 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
20972 || it
->what
== IT_IMAGE
))
20973 ? (it
->current_x
>= it
->last_visible_x
)
20974 : (it
->current_x
> it
->last_visible_x
)))
20976 /* Maybe add truncation glyphs. */
20977 if (!FRAME_WINDOW_P (it
->f
)
20978 || (row
->reversed_p
20979 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20980 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20984 if (!row
->reversed_p
)
20986 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20987 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20992 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20993 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20995 /* Remove any padding glyphs at the front of ROW, to
20996 make room for the truncation glyphs we will be
20997 adding below. The loop below always inserts at
20998 least one truncation glyph, so also remove the
20999 last glyph added to ROW. */
21000 unproduce_glyphs (it
, i
+ 1);
21001 /* Adjust i for the loop below. */
21002 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
21005 /* produce_special_glyphs overwrites the last glyph, so
21006 we don't want that if we want to keep that last
21007 glyph, which means it's an image. */
21008 if (it
->current_x
> it
->last_visible_x
)
21010 it
->current_x
= x_before
;
21011 if (!FRAME_WINDOW_P (it
->f
))
21013 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
21015 row
->used
[TEXT_AREA
] = i
;
21016 produce_special_glyphs (it
, IT_TRUNCATION
);
21021 row
->used
[TEXT_AREA
] = i
;
21022 produce_special_glyphs (it
, IT_TRUNCATION
);
21024 it
->hpos
= hpos_before
;
21027 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
21029 /* Don't truncate if we can overflow newline into fringe. */
21030 if (!get_next_display_element (it
))
21032 it
->continuation_lines_width
= 0;
21033 row
->ends_at_zv_p
= true;
21034 row
->exact_window_width_line_p
= true;
21037 if (ITERATOR_AT_END_OF_LINE_P (it
))
21039 row
->exact_window_width_line_p
= true;
21040 goto at_end_of_line
;
21042 it
->current_x
= x_before
;
21043 it
->hpos
= hpos_before
;
21046 row
->truncated_on_right_p
= true;
21047 it
->continuation_lines_width
= 0;
21048 reseat_at_next_visible_line_start (it
, false);
21049 /* We insist below that IT's position be at ZV because in
21050 bidi-reordered lines the character at visible line start
21051 might not be the character that follows the newline in
21052 the logical order. */
21053 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
21054 row
->ends_at_zv_p
=
21055 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
21057 row
->ends_at_zv_p
= false;
21063 bidi_unshelve_cache (wrap_data
, true);
21065 /* If line is not empty and hscrolled, maybe insert truncation glyphs
21066 at the left window margin. */
21067 if (it
->first_visible_x
21068 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
21070 if (!FRAME_WINDOW_P (it
->f
)
21071 || (((row
->reversed_p
21072 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21073 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
21074 /* Don't let insert_left_trunc_glyphs overwrite the
21075 first glyph of the row if it is an image. */
21076 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
21077 insert_left_trunc_glyphs (it
);
21078 row
->truncated_on_left_p
= true;
21081 /* Remember the position at which this line ends.
21083 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
21084 cannot be before the call to find_row_edges below, since that is
21085 where these positions are determined. */
21086 row
->end
= it
->current
;
21089 row
->minpos
= row
->start
.pos
;
21090 row
->maxpos
= row
->end
.pos
;
21094 /* ROW->minpos and ROW->maxpos must be the smallest and
21095 `1 + the largest' buffer positions in ROW. But if ROW was
21096 bidi-reordered, these two positions can be anywhere in the
21097 row, so we must determine them now. */
21098 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
21101 /* If the start of this line is the overlay arrow-position, then
21102 mark this glyph row as the one containing the overlay arrow.
21103 This is clearly a mess with variable size fonts. It would be
21104 better to let it be displayed like cursors under X. */
21105 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
21106 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
21107 !NILP (overlay_arrow_string
)))
21109 /* Overlay arrow in window redisplay is a fringe bitmap. */
21110 if (STRINGP (overlay_arrow_string
))
21112 struct glyph_row
*arrow_row
21113 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
21114 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
21115 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
21116 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
21117 struct glyph
*p2
, *end
;
21119 /* Copy the arrow glyphs. */
21120 while (glyph
< arrow_end
)
21123 /* Throw away padding glyphs. */
21125 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
21126 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
21132 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
21137 eassert (INTEGERP (overlay_arrow_string
));
21138 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
21140 overlay_arrow_seen
= true;
21143 /* Highlight trailing whitespace. */
21144 if (!NILP (Vshow_trailing_whitespace
))
21145 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
21147 /* Compute pixel dimensions of this line. */
21148 compute_line_metrics (it
);
21150 /* Implementation note: No changes in the glyphs of ROW or in their
21151 faces can be done past this point, because compute_line_metrics
21152 computes ROW's hash value and stores it within the glyph_row
21155 /* Record whether this row ends inside an ellipsis. */
21156 row
->ends_in_ellipsis_p
21157 = (it
->method
== GET_FROM_DISPLAY_VECTOR
21158 && it
->ellipsis_p
);
21160 /* Save fringe bitmaps in this row. */
21161 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
21162 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
21163 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
21164 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
21166 it
->left_user_fringe_bitmap
= 0;
21167 it
->left_user_fringe_face_id
= 0;
21168 it
->right_user_fringe_bitmap
= 0;
21169 it
->right_user_fringe_face_id
= 0;
21171 /* Maybe set the cursor. */
21172 cvpos
= it
->w
->cursor
.vpos
;
21174 /* In bidi-reordered rows, keep checking for proper cursor
21175 position even if one has been found already, because buffer
21176 positions in such rows change non-linearly with ROW->VPOS,
21177 when a line is continued. One exception: when we are at ZV,
21178 display cursor on the first suitable glyph row, since all
21179 the empty rows after that also have their position set to ZV. */
21180 /* FIXME: Revisit this when glyph ``spilling'' in continuation
21181 lines' rows is implemented for bidi-reordered rows. */
21183 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
21184 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
21185 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
21186 && cursor_row_p (row
))
21187 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
21189 /* Prepare for the next line. This line starts horizontally at (X
21190 HPOS) = (0 0). Vertical positions are incremented. As a
21191 convenience for the caller, IT->glyph_row is set to the next
21193 it
->current_x
= it
->hpos
= 0;
21194 it
->current_y
+= row
->height
;
21195 SET_TEXT_POS (it
->eol_pos
, 0, 0);
21198 /* The next row should by default use the same value of the
21199 reversed_p flag as this one. set_iterator_to_next decides when
21200 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
21201 the flag accordingly. */
21202 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
21203 it
->glyph_row
->reversed_p
= row
->reversed_p
;
21204 it
->start
= row
->end
;
21205 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
21207 #undef RECORD_MAX_MIN_POS
21210 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
21211 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
21212 doc
: /* Return paragraph direction at point in BUFFER.
21213 Value is either `left-to-right' or `right-to-left'.
21214 If BUFFER is omitted or nil, it defaults to the current buffer.
21216 Paragraph direction determines how the text in the paragraph is displayed.
21217 In left-to-right paragraphs, text begins at the left margin of the window
21218 and the reading direction is generally left to right. In right-to-left
21219 paragraphs, text begins at the right margin and is read from right to left.
21221 See also `bidi-paragraph-direction'. */)
21222 (Lisp_Object buffer
)
21224 struct buffer
*buf
= current_buffer
;
21225 struct buffer
*old
= buf
;
21227 if (! NILP (buffer
))
21229 CHECK_BUFFER (buffer
);
21230 buf
= XBUFFER (buffer
);
21233 if (NILP (BVAR (buf
, bidi_display_reordering
))
21234 || NILP (BVAR (buf
, enable_multibyte_characters
))
21235 /* When we are loading loadup.el, the character property tables
21236 needed for bidi iteration are not yet available. */
21237 || redisplay__inhibit_bidi
)
21238 return Qleft_to_right
;
21239 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
21240 return BVAR (buf
, bidi_paragraph_direction
);
21243 /* Determine the direction from buffer text. We could try to
21244 use current_matrix if it is up to date, but this seems fast
21245 enough as it is. */
21246 struct bidi_it itb
;
21247 ptrdiff_t pos
= BUF_PT (buf
);
21248 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
21250 void *itb_data
= bidi_shelve_cache ();
21252 set_buffer_temp (buf
);
21253 /* bidi_paragraph_init finds the base direction of the paragraph
21254 by searching forward from paragraph start. We need the base
21255 direction of the current or _previous_ paragraph, so we need
21256 to make sure we are within that paragraph. To that end, find
21257 the previous non-empty line. */
21258 if (pos
>= ZV
&& pos
> BEGV
)
21259 DEC_BOTH (pos
, bytepos
);
21260 AUTO_STRING (trailing_white_space
, "[\f\t ]*\n");
21261 if (fast_looking_at (trailing_white_space
,
21262 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
21264 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
21265 || c
== ' ' || c
== '\t' || c
== '\f')
21267 if (bytepos
<= BEGV_BYTE
)
21272 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
21275 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
21276 itb
.paragraph_dir
= NEUTRAL_DIR
;
21277 itb
.string
.s
= NULL
;
21278 itb
.string
.lstring
= Qnil
;
21279 itb
.string
.bufpos
= 0;
21280 itb
.string
.from_disp_str
= false;
21281 itb
.string
.unibyte
= false;
21282 /* We have no window to use here for ignoring window-specific
21283 overlays. Using NULL for window pointer will cause
21284 compute_display_string_pos to use the current buffer. */
21286 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, true);
21287 bidi_unshelve_cache (itb_data
, false);
21288 set_buffer_temp (old
);
21289 switch (itb
.paragraph_dir
)
21292 return Qleft_to_right
;
21295 return Qright_to_left
;
21303 DEFUN ("bidi-find-overridden-directionality",
21304 Fbidi_find_overridden_directionality
,
21305 Sbidi_find_overridden_directionality
, 2, 3, 0,
21306 doc
: /* Return position between FROM and TO where directionality was overridden.
21308 This function returns the first character position in the specified
21309 region of OBJECT where there is a character whose `bidi-class' property
21310 is `L', but which was forced to display as `R' by a directional
21311 override, and likewise with characters whose `bidi-class' is `R'
21312 or `AL' that were forced to display as `L'.
21314 If no such character is found, the function returns nil.
21316 OBJECT is a Lisp string or buffer to search for overridden
21317 directionality, and defaults to the current buffer if nil or omitted.
21318 OBJECT can also be a window, in which case the function will search
21319 the buffer displayed in that window. Passing the window instead of
21320 a buffer is preferable when the buffer is displayed in some window,
21321 because this function will then be able to correctly account for
21322 window-specific overlays, which can affect the results.
21324 Strong directional characters `L', `R', and `AL' can have their
21325 intrinsic directionality overridden by directional override
21326 control characters RLO (u+202e) and LRO (u+202d). See the
21327 function `get-char-code-property' for a way to inquire about
21328 the `bidi-class' property of a character. */)
21329 (Lisp_Object from
, Lisp_Object to
, Lisp_Object object
)
21331 struct buffer
*buf
= current_buffer
;
21332 struct buffer
*old
= buf
;
21333 struct window
*w
= NULL
;
21334 bool frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ());
21335 struct bidi_it itb
;
21336 ptrdiff_t from_pos
, to_pos
, from_bpos
;
21339 if (!NILP (object
))
21341 if (BUFFERP (object
))
21342 buf
= XBUFFER (object
);
21343 else if (WINDOWP (object
))
21345 w
= decode_live_window (object
);
21346 buf
= XBUFFER (w
->contents
);
21347 frame_window_p
= FRAME_WINDOW_P (XFRAME (w
->frame
));
21350 CHECK_STRING (object
);
21353 if (STRINGP (object
))
21355 /* Characters in unibyte strings are always treated by bidi.c as
21357 if (!STRING_MULTIBYTE (object
)
21358 /* When we are loading loadup.el, the character property
21359 tables needed for bidi iteration are not yet
21361 || redisplay__inhibit_bidi
)
21364 validate_subarray (object
, from
, to
, SCHARS (object
), &from_pos
, &to_pos
);
21365 if (from_pos
>= SCHARS (object
))
21368 /* Set up the bidi iterator. */
21369 itb_data
= bidi_shelve_cache ();
21370 itb
.paragraph_dir
= NEUTRAL_DIR
;
21371 itb
.string
.lstring
= object
;
21372 itb
.string
.s
= NULL
;
21373 itb
.string
.schars
= SCHARS (object
);
21374 itb
.string
.bufpos
= 0;
21375 itb
.string
.from_disp_str
= false;
21376 itb
.string
.unibyte
= false;
21378 bidi_init_it (0, 0, frame_window_p
, &itb
);
21382 /* Nothing this fancy can happen in unibyte buffers, or in a
21383 buffer that disabled reordering, or if FROM is at EOB. */
21384 if (NILP (BVAR (buf
, bidi_display_reordering
))
21385 || NILP (BVAR (buf
, enable_multibyte_characters
))
21386 /* When we are loading loadup.el, the character property
21387 tables needed for bidi iteration are not yet
21389 || redisplay__inhibit_bidi
)
21392 set_buffer_temp (buf
);
21393 validate_region (&from
, &to
);
21394 from_pos
= XINT (from
);
21395 to_pos
= XINT (to
);
21396 if (from_pos
>= ZV
)
21399 /* Set up the bidi iterator. */
21400 itb_data
= bidi_shelve_cache ();
21401 from_bpos
= CHAR_TO_BYTE (from_pos
);
21402 if (from_pos
== BEGV
)
21404 itb
.charpos
= BEGV
;
21405 itb
.bytepos
= BEGV_BYTE
;
21407 else if (FETCH_CHAR (from_bpos
- 1) == '\n')
21409 itb
.charpos
= from_pos
;
21410 itb
.bytepos
= from_bpos
;
21413 itb
.charpos
= find_newline_no_quit (from_pos
, CHAR_TO_BYTE (from_pos
),
21415 itb
.paragraph_dir
= NEUTRAL_DIR
;
21416 itb
.string
.s
= NULL
;
21417 itb
.string
.lstring
= Qnil
;
21418 itb
.string
.bufpos
= 0;
21419 itb
.string
.from_disp_str
= false;
21420 itb
.string
.unibyte
= false;
21422 bidi_init_it (itb
.charpos
, itb
.bytepos
, frame_window_p
, &itb
);
21427 /* For the purposes of this function, the actual base direction of
21428 the paragraph doesn't matter, so just set it to L2R. */
21429 bidi_paragraph_init (L2R
, &itb
, false);
21430 while ((found
= bidi_find_first_overridden (&itb
)) < from_pos
)
21432 } while (found
== ZV
&& itb
.ch
== '\n' && itb
.charpos
< to_pos
);
21434 bidi_unshelve_cache (itb_data
, false);
21435 set_buffer_temp (old
);
21437 return (from_pos
<= found
&& found
< to_pos
) ? make_number (found
) : Qnil
;
21440 DEFUN ("move-point-visually", Fmove_point_visually
,
21441 Smove_point_visually
, 1, 1, 0,
21442 doc
: /* Move point in the visual order in the specified DIRECTION.
21443 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
21446 Value is the new character position of point. */)
21447 (Lisp_Object direction
)
21449 struct window
*w
= XWINDOW (selected_window
);
21450 struct buffer
*b
= XBUFFER (w
->contents
);
21451 struct glyph_row
*row
;
21453 Lisp_Object paragraph_dir
;
21455 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21456 (!(ROW)->continued_p \
21457 && NILP ((GLYPH)->object) \
21458 && (GLYPH)->type == CHAR_GLYPH \
21459 && (GLYPH)->u.ch == ' ' \
21460 && (GLYPH)->charpos >= 0 \
21461 && !(GLYPH)->avoid_cursor_p)
21463 CHECK_NUMBER (direction
);
21464 dir
= XINT (direction
);
21470 /* If current matrix is up-to-date, we can use the information
21471 recorded in the glyphs, at least as long as the goal is on the
21473 if (w
->window_end_valid
21474 && !windows_or_buffers_changed
21476 && !b
->clip_changed
21477 && !b
->prevent_redisplay_optimizations_p
21478 && !window_outdated (w
)
21479 /* We rely below on the cursor coordinates to be up to date, but
21480 we cannot trust them if some command moved point since the
21481 last complete redisplay. */
21482 && w
->last_point
== BUF_PT (b
)
21483 && w
->cursor
.vpos
>= 0
21484 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21485 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21487 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21488 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21489 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21491 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21493 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21495 SET_PT (g
->charpos
);
21496 w
->cursor
.vpos
= -1;
21497 return make_number (PT
);
21499 else if (!NILP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21503 if (BUFFERP (gpt
->object
))
21506 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21507 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21509 new_pos
-= (row
->reversed_p
? -dir
: dir
);
21511 else if (BUFFERP (g
->object
))
21512 new_pos
= g
->charpos
;
21516 w
->cursor
.vpos
= -1;
21517 return make_number (PT
);
21519 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21521 /* Glyphs inserted at the end of a non-empty line for
21522 positioning the cursor have zero charpos, so we must
21523 deduce the value of point by other means. */
21524 if (g
->charpos
> 0)
21525 SET_PT (g
->charpos
);
21526 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21528 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21529 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21532 w
->cursor
.vpos
= -1;
21533 return make_number (PT
);
21536 if (g
== e
|| NILP (g
->object
))
21538 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21539 goto simulate_display
;
21540 if (!row
->reversed_p
)
21544 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21545 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21546 goto simulate_display
;
21550 if (row
->reversed_p
&& !row
->continued_p
)
21552 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21553 w
->cursor
.vpos
= -1;
21554 return make_number (PT
);
21556 g
= row
->glyphs
[TEXT_AREA
];
21557 e
= g
+ row
->used
[TEXT_AREA
];
21558 for ( ; g
< e
; g
++)
21560 if (BUFFERP (g
->object
)
21561 /* Empty lines have only one glyph, which stands
21562 for the newline, and whose charpos is the
21563 buffer position of the newline. */
21564 || ROW_GLYPH_NEWLINE_P (row
, g
)
21565 /* When the buffer ends in a newline, the line at
21566 EOB also has one glyph, but its charpos is -1. */
21567 || (row
->ends_at_zv_p
21568 && !row
->reversed_p
21569 && NILP (g
->object
)
21570 && g
->type
== CHAR_GLYPH
21571 && g
->u
.ch
== ' '))
21573 if (g
->charpos
> 0)
21574 SET_PT (g
->charpos
);
21575 else if (!row
->reversed_p
21576 && row
->ends_at_zv_p
21581 w
->cursor
.vpos
= -1;
21582 return make_number (PT
);
21588 if (!row
->reversed_p
&& !row
->continued_p
)
21590 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21591 w
->cursor
.vpos
= -1;
21592 return make_number (PT
);
21594 e
= row
->glyphs
[TEXT_AREA
];
21595 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21596 for ( ; g
>= e
; g
--)
21598 if (BUFFERP (g
->object
)
21599 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21601 /* Empty R2L lines on GUI frames have the buffer
21602 position of the newline stored in the stretch
21604 || g
->type
== STRETCH_GLYPH
21605 || (row
->ends_at_zv_p
21607 && NILP (g
->object
)
21608 && g
->type
== CHAR_GLYPH
21609 && g
->u
.ch
== ' '))
21611 if (g
->charpos
> 0)
21612 SET_PT (g
->charpos
);
21613 else if (row
->reversed_p
21614 && row
->ends_at_zv_p
21619 w
->cursor
.vpos
= -1;
21620 return make_number (PT
);
21629 /* If we wind up here, we failed to move by using the glyphs, so we
21630 need to simulate display instead. */
21633 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21635 paragraph_dir
= Qleft_to_right
;
21636 if (EQ (paragraph_dir
, Qright_to_left
))
21638 if (PT
<= BEGV
&& dir
< 0)
21639 xsignal0 (Qbeginning_of_buffer
);
21640 else if (PT
>= ZV
&& dir
> 0)
21641 xsignal0 (Qend_of_buffer
);
21644 struct text_pos pt
;
21646 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21648 bool overshoot_expected
= false;
21649 bool target_is_eol_p
= false;
21651 /* Setup the arena. */
21652 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21653 start_display (&it
, w
, pt
);
21654 /* When lines are truncated, we could be called with point
21655 outside of the windows edges, in which case move_it_*
21656 functions either prematurely stop at window's edge or jump to
21657 the next screen line, whereas we rely below on our ability to
21658 reach point, in order to start from its X coordinate. So we
21659 need to disregard the window's horizontal extent in that case. */
21660 if (it
.line_wrap
== TRUNCATE
)
21661 it
.last_visible_x
= INFINITY
;
21663 if (it
.cmp_it
.id
< 0
21664 && it
.method
== GET_FROM_STRING
21665 && it
.area
== TEXT_AREA
21666 && it
.string_from_display_prop_p
21667 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21668 overshoot_expected
= true;
21670 /* Find the X coordinate of point. We start from the beginning
21671 of this or previous line to make sure we are before point in
21672 the logical order (since the move_it_* functions can only
21675 reseat_at_previous_visible_line_start (&it
);
21676 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21677 if (IT_CHARPOS (it
) != PT
)
21679 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21680 -1, -1, -1, MOVE_TO_POS
);
21681 /* If we missed point because the character there is
21682 displayed out of a display vector that has more than one
21683 glyph, retry expecting overshoot. */
21684 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21685 && it
.current
.dpvec_index
> 0
21686 && !overshoot_expected
)
21688 overshoot_expected
= true;
21691 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21692 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21694 pt_x
= it
.current_x
;
21696 if (dir
> 0 || overshoot_expected
)
21698 struct glyph_row
*row
= it
.glyph_row
;
21700 /* When point is at beginning of line, we don't have
21701 information about the glyph there loaded into struct
21702 it. Calling get_next_display_element fixes that. */
21704 get_next_display_element (&it
);
21705 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21706 it
.glyph_row
= NULL
;
21707 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21708 it
.glyph_row
= row
;
21709 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21710 it, lest it will become out of sync with it's buffer
21712 it
.current_x
= pt_x
;
21715 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21716 pixel_width
= it
.pixel_width
;
21717 if (overshoot_expected
&& at_eol_p
)
21719 else if (pixel_width
<= 0)
21722 /* If there's a display string (or something similar) at point,
21723 we are actually at the glyph to the left of point, so we need
21724 to correct the X coordinate. */
21725 if (overshoot_expected
)
21728 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21730 pt_x
+= pixel_width
;
21733 /* Compute target X coordinate, either to the left or to the
21734 right of point. On TTY frames, all characters have the same
21735 pixel width of 1, so we can use that. On GUI frames we don't
21736 have an easy way of getting at the pixel width of the
21737 character to the left of point, so we use a different method
21738 of getting to that place. */
21740 target_x
= pt_x
+ pixel_width
;
21742 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21744 /* Target X coordinate could be one line above or below the line
21745 of point, in which case we need to adjust the target X
21746 coordinate. Also, if moving to the left, we need to begin at
21747 the left edge of the point's screen line. */
21752 start_display (&it
, w
, pt
);
21753 if (it
.line_wrap
== TRUNCATE
)
21754 it
.last_visible_x
= INFINITY
;
21755 reseat_at_previous_visible_line_start (&it
);
21756 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21758 move_it_by_lines (&it
, pt_vpos
);
21762 move_it_by_lines (&it
, -1);
21763 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21764 target_is_eol_p
= true;
21765 /* Under word-wrap, we don't know the x coordinate of
21766 the last character displayed on the previous line,
21767 which immediately precedes the wrap point. To find
21768 out its x coordinate, we try moving to the right
21769 margin of the window, which will stop at the wrap
21770 point, and then reset target_x to point at the
21771 character that precedes the wrap point. This is not
21772 needed on GUI frames, because (see below) there we
21773 move from the left margin one grapheme cluster at a
21774 time, and stop when we hit the wrap point. */
21775 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21777 void *it_data
= NULL
;
21780 SAVE_IT (it2
, it
, it_data
);
21781 move_it_in_display_line_to (&it
, ZV
, target_x
,
21782 MOVE_TO_POS
| MOVE_TO_X
);
21783 /* If we arrived at target_x, that _is_ the last
21784 character on the previous line. */
21785 if (it
.current_x
!= target_x
)
21786 target_x
= it
.current_x
- 1;
21787 RESTORE_IT (&it
, &it2
, it_data
);
21794 || (target_x
>= it
.last_visible_x
21795 && it
.line_wrap
!= TRUNCATE
))
21798 move_it_by_lines (&it
, 0);
21799 move_it_by_lines (&it
, 1);
21804 /* Move to the target X coordinate. */
21805 #ifdef HAVE_WINDOW_SYSTEM
21806 /* On GUI frames, as we don't know the X coordinate of the
21807 character to the left of point, moving point to the left
21808 requires walking, one grapheme cluster at a time, until we
21809 find ourself at a place immediately to the left of the
21810 character at point. */
21811 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21813 struct text_pos new_pos
;
21814 enum move_it_result rc
= MOVE_X_REACHED
;
21816 if (it
.current_x
== 0)
21817 get_next_display_element (&it
);
21818 if (it
.what
== IT_COMPOSITION
)
21820 new_pos
.charpos
= it
.cmp_it
.charpos
;
21821 new_pos
.bytepos
= -1;
21824 new_pos
= it
.current
.pos
;
21826 while (it
.current_x
+ it
.pixel_width
<= target_x
21827 && (rc
== MOVE_X_REACHED
21828 /* Under word-wrap, move_it_in_display_line_to
21829 stops at correct coordinates, but sometimes
21830 returns MOVE_POS_MATCH_OR_ZV. */
21831 || (it
.line_wrap
== WORD_WRAP
21832 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21834 int new_x
= it
.current_x
+ it
.pixel_width
;
21836 /* For composed characters, we want the position of the
21837 first character in the grapheme cluster (usually, the
21838 composition's base character), whereas it.current
21839 might give us the position of the _last_ one, e.g. if
21840 the composition is rendered in reverse due to bidi
21842 if (it
.what
== IT_COMPOSITION
)
21844 new_pos
.charpos
= it
.cmp_it
.charpos
;
21845 new_pos
.bytepos
= -1;
21848 new_pos
= it
.current
.pos
;
21849 if (new_x
== it
.current_x
)
21851 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21852 MOVE_TO_POS
| MOVE_TO_X
);
21853 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21856 /* The previous position we saw in the loop is the one we
21858 if (new_pos
.bytepos
== -1)
21859 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21860 it
.current
.pos
= new_pos
;
21864 if (it
.current_x
!= target_x
)
21865 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21867 /* If we ended up in a display string that covers point, move to
21868 buffer position to the right in the visual order. */
21871 while (IT_CHARPOS (it
) == PT
)
21873 set_iterator_to_next (&it
, false);
21874 if (!get_next_display_element (&it
))
21879 /* Move point to that position. */
21880 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21883 return make_number (PT
);
21885 #undef ROW_GLYPH_NEWLINE_P
21888 DEFUN ("bidi-resolved-levels", Fbidi_resolved_levels
,
21889 Sbidi_resolved_levels
, 0, 1, 0,
21890 doc
: /* Return the resolved bidirectional levels of characters at VPOS.
21892 The resolved levels are produced by the Emacs bidi reordering engine
21893 that implements the UBA, the Unicode Bidirectional Algorithm. Please
21894 read the Unicode Standard Annex 9 (UAX#9) for background information
21895 about these levels.
21897 VPOS is the zero-based number of the current window's screen line
21898 for which to produce the resolved levels. If VPOS is nil or omitted,
21899 it defaults to the screen line of point. If the window displays a
21900 header line, VPOS of zero will report on the header line, and first
21901 line of text in the window will have VPOS of 1.
21903 Value is an array of resolved levels, indexed by glyph number.
21904 Glyphs are numbered from zero starting from the beginning of the
21905 screen line, i.e. the left edge of the window for left-to-right lines
21906 and from the right edge for right-to-left lines. The resolved levels
21907 are produced only for the window's text area; text in display margins
21910 If the selected window's display is not up-to-date, or if the specified
21911 screen line does not display text, this function returns nil. It is
21912 highly recommended to bind this function to some simple key, like F8,
21913 in order to avoid these problems.
21915 This function exists mainly for testing the correctness of the
21916 Emacs UBA implementation, in particular with the test suite. */)
21919 struct window
*w
= XWINDOW (selected_window
);
21920 struct buffer
*b
= XBUFFER (w
->contents
);
21922 struct glyph_row
*row
;
21926 int d1
, d2
, d3
, d4
, d5
;
21928 pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &nrow
);
21932 CHECK_NUMBER_COERCE_MARKER (vpos
);
21933 nrow
= XINT (vpos
);
21936 /* We require up-to-date glyph matrix for this window. */
21937 if (w
->window_end_valid
21938 && !windows_or_buffers_changed
21940 && !b
->clip_changed
21941 && !b
->prevent_redisplay_optimizations_p
21942 && !window_outdated (w
)
21944 && nrow
< w
->current_matrix
->nrows
21945 && (row
= MATRIX_ROW (w
->current_matrix
, nrow
))->enabled_p
21946 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
21948 struct glyph
*g
, *e
, *g1
;
21950 Lisp_Object levels
;
21952 if (!row
->reversed_p
) /* Left-to-right glyph row. */
21954 g
= g1
= row
->glyphs
[TEXT_AREA
];
21955 e
= g
+ row
->used
[TEXT_AREA
];
21957 /* Skip over glyphs at the start of the row that was
21958 generated by redisplay for its own needs. */
21960 && NILP (g
->object
)
21965 /* Count the "interesting" glyphs in this row. */
21966 for (nglyphs
= 0; g
< e
&& !NILP (g
->object
); g
++)
21969 /* Create and fill the array. */
21970 levels
= make_uninit_vector (nglyphs
);
21971 for (i
= 0; g1
< g
; i
++, g1
++)
21972 ASET (levels
, i
, make_number (g1
->resolved_level
));
21974 else /* Right-to-left glyph row. */
21976 g
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
21977 e
= row
->glyphs
[TEXT_AREA
] - 1;
21979 && NILP (g
->object
)
21983 for (nglyphs
= 0; g
> e
&& !NILP (g
->object
); g
--)
21985 levels
= make_uninit_vector (nglyphs
);
21986 for (i
= 0; g1
> g
; i
++, g1
--)
21987 ASET (levels
, i
, make_number (g1
->resolved_level
));
21997 /***********************************************************************
21999 ***********************************************************************/
22001 /* Redisplay the menu bar in the frame for window W.
22003 The menu bar of X frames that don't have X toolkit support is
22004 displayed in a special window W->frame->menu_bar_window.
22006 The menu bar of terminal frames is treated specially as far as
22007 glyph matrices are concerned. Menu bar lines are not part of
22008 windows, so the update is done directly on the frame matrix rows
22009 for the menu bar. */
22012 display_menu_bar (struct window
*w
)
22014 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22019 /* Don't do all this for graphical frames. */
22021 if (FRAME_W32_P (f
))
22024 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
22030 if (FRAME_NS_P (f
))
22032 #endif /* HAVE_NS */
22034 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
22035 eassert (!FRAME_WINDOW_P (f
));
22036 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
22037 it
.first_visible_x
= 0;
22038 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
22039 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
22040 if (FRAME_WINDOW_P (f
))
22042 /* Menu bar lines are displayed in the desired matrix of the
22043 dummy window menu_bar_window. */
22044 struct window
*menu_w
;
22045 menu_w
= XWINDOW (f
->menu_bar_window
);
22046 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
22048 it
.first_visible_x
= 0;
22049 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
22052 #endif /* not USE_X_TOOLKIT and not USE_GTK */
22054 /* This is a TTY frame, i.e. character hpos/vpos are used as
22056 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
22058 it
.first_visible_x
= 0;
22059 it
.last_visible_x
= FRAME_COLS (f
);
22062 /* FIXME: This should be controlled by a user option. See the
22063 comments in redisplay_tool_bar and display_mode_line about
22065 it
.paragraph_embedding
= L2R
;
22067 /* Clear all rows of the menu bar. */
22068 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
22070 struct glyph_row
*row
= it
.glyph_row
+ i
;
22071 clear_glyph_row (row
);
22072 row
->enabled_p
= true;
22073 row
->full_width_p
= true;
22074 row
->reversed_p
= false;
22077 /* Display all items of the menu bar. */
22078 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
22079 for (i
= 0; i
< ASIZE (items
); i
+= 4)
22081 Lisp_Object string
;
22083 /* Stop at nil string. */
22084 string
= AREF (items
, i
+ 1);
22088 /* Remember where item was displayed. */
22089 ASET (items
, i
+ 3, make_number (it
.hpos
));
22091 /* Display the item, pad with one space. */
22092 if (it
.current_x
< it
.last_visible_x
)
22093 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
22094 SCHARS (string
) + 1, 0, 0, -1);
22097 /* Fill out the line with spaces. */
22098 if (it
.current_x
< it
.last_visible_x
)
22099 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
22101 /* Compute the total height of the lines. */
22102 compute_line_metrics (&it
);
22105 /* Deep copy of a glyph row, including the glyphs. */
22107 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
22109 struct glyph
*pointers
[1 + LAST_AREA
];
22110 int to_used
= to
->used
[TEXT_AREA
];
22112 /* Save glyph pointers of TO. */
22113 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
22115 /* Do a structure assignment. */
22118 /* Restore original glyph pointers of TO. */
22119 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
22121 /* Copy the glyphs. */
22122 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
22123 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
22125 /* If we filled only part of the TO row, fill the rest with
22126 space_glyph (which will display as empty space). */
22127 if (to_used
> from
->used
[TEXT_AREA
])
22128 fill_up_frame_row_with_spaces (to
, to_used
);
22131 /* Display one menu item on a TTY, by overwriting the glyphs in the
22132 frame F's desired glyph matrix with glyphs produced from the menu
22133 item text. Called from term.c to display TTY drop-down menus one
22136 ITEM_TEXT is the menu item text as a C string.
22138 FACE_ID is the face ID to be used for this menu item. FACE_ID
22139 could specify one of 3 faces: a face for an enabled item, a face
22140 for a disabled item, or a face for a selected item.
22142 X and Y are coordinates of the first glyph in the frame's desired
22143 matrix to be overwritten by the menu item. Since this is a TTY, Y
22144 is the zero-based number of the glyph row and X is the zero-based
22145 glyph number in the row, starting from left, where to start
22146 displaying the item.
22148 SUBMENU means this menu item drops down a submenu, which
22149 should be indicated by displaying a proper visual cue after the
22153 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
22154 int x
, int y
, bool submenu
)
22157 struct frame
*f
= SELECTED_FRAME ();
22158 struct window
*w
= XWINDOW (f
->selected_window
);
22159 struct glyph_row
*row
;
22160 size_t item_len
= strlen (item_text
);
22162 eassert (FRAME_TERMCAP_P (f
));
22164 /* Don't write beyond the matrix's last row. This can happen for
22165 TTY screens that are not high enough to show the entire menu.
22166 (This is actually a bit of defensive programming, as
22167 tty_menu_display already limits the number of menu items to one
22168 less than the number of screen lines.) */
22169 if (y
>= f
->desired_matrix
->nrows
)
22172 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
22173 it
.first_visible_x
= 0;
22174 it
.last_visible_x
= FRAME_COLS (f
) - 1;
22175 row
= it
.glyph_row
;
22176 /* Start with the row contents from the current matrix. */
22177 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
22178 bool saved_width
= row
->full_width_p
;
22179 row
->full_width_p
= true;
22180 bool saved_reversed
= row
->reversed_p
;
22181 row
->reversed_p
= false;
22182 row
->enabled_p
= true;
22184 /* Arrange for the menu item glyphs to start at (X,Y) and have the
22186 eassert (x
< f
->desired_matrix
->matrix_w
);
22187 it
.current_x
= it
.hpos
= x
;
22188 it
.current_y
= it
.vpos
= y
;
22189 int saved_used
= row
->used
[TEXT_AREA
];
22190 bool saved_truncated
= row
->truncated_on_right_p
;
22191 row
->used
[TEXT_AREA
] = x
;
22192 it
.face_id
= face_id
;
22193 it
.line_wrap
= TRUNCATE
;
22195 /* FIXME: This should be controlled by a user option. See the
22196 comments in redisplay_tool_bar and display_mode_line about this.
22197 Also, if paragraph_embedding could ever be R2L, changes will be
22198 needed to avoid shifting to the right the row characters in
22199 term.c:append_glyph. */
22200 it
.paragraph_embedding
= L2R
;
22202 /* Pad with a space on the left. */
22203 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
22205 /* Display the menu item, pad with spaces to WIDTH. */
22208 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
22209 item_len
, 0, FRAME_COLS (f
) - 1, -1);
22211 /* Indicate with " >" that there's a submenu. */
22212 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
22213 FRAME_COLS (f
) - 1, -1);
22216 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
22217 width
, 0, FRAME_COLS (f
) - 1, -1);
22219 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
22220 row
->truncated_on_right_p
= saved_truncated
;
22221 row
->hash
= row_hash (row
);
22222 row
->full_width_p
= saved_width
;
22223 row
->reversed_p
= saved_reversed
;
22226 /***********************************************************************
22228 ***********************************************************************/
22230 /* Redisplay mode lines in the window tree whose root is WINDOW.
22231 If FORCE, redisplay mode lines unconditionally.
22232 Otherwise, redisplay only mode lines that are garbaged. Value is
22233 the number of windows whose mode lines were redisplayed. */
22236 redisplay_mode_lines (Lisp_Object window
, bool force
)
22240 while (!NILP (window
))
22242 struct window
*w
= XWINDOW (window
);
22244 if (WINDOWP (w
->contents
))
22245 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
22247 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
22248 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
22250 struct text_pos lpoint
;
22251 struct buffer
*old
= current_buffer
;
22253 /* Set the window's buffer for the mode line display. */
22254 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
22255 set_buffer_internal_1 (XBUFFER (w
->contents
));
22257 /* Point refers normally to the selected window. For any
22258 other window, set up appropriate value. */
22259 if (!EQ (window
, selected_window
))
22261 struct text_pos pt
;
22263 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
22264 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
22267 /* Display mode lines. */
22268 clear_glyph_matrix (w
->desired_matrix
);
22269 if (display_mode_lines (w
))
22272 /* Restore old settings. */
22273 set_buffer_internal_1 (old
);
22274 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
22284 /* Display the mode and/or header line of window W. Value is the
22285 sum number of mode lines and header lines displayed. */
22288 display_mode_lines (struct window
*w
)
22290 Lisp_Object old_selected_window
= selected_window
;
22291 Lisp_Object old_selected_frame
= selected_frame
;
22292 Lisp_Object new_frame
= w
->frame
;
22293 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
22296 selected_frame
= new_frame
;
22297 /* FIXME: If we were to allow the mode-line's computation changing the buffer
22298 or window's point, then we'd need select_window_1 here as well. */
22299 XSETWINDOW (selected_window
, w
);
22300 XFRAME (new_frame
)->selected_window
= selected_window
;
22302 /* These will be set while the mode line specs are processed. */
22303 line_number_displayed
= false;
22304 w
->column_number_displayed
= -1;
22306 if (WINDOW_WANTS_MODELINE_P (w
))
22308 struct window
*sel_w
= XWINDOW (old_selected_window
);
22310 /* Select mode line face based on the real selected window. */
22311 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
22312 BVAR (current_buffer
, mode_line_format
));
22316 if (WINDOW_WANTS_HEADER_LINE_P (w
))
22318 display_mode_line (w
, HEADER_LINE_FACE_ID
,
22319 BVAR (current_buffer
, header_line_format
));
22323 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
22324 selected_frame
= old_selected_frame
;
22325 selected_window
= old_selected_window
;
22327 w
->must_be_updated_p
= true;
22332 /* Display mode or header line of window W. FACE_ID specifies which
22333 line to display; it is either MODE_LINE_FACE_ID or
22334 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
22335 display. Value is the pixel height of the mode/header line
22339 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
22343 ptrdiff_t count
= SPECPDL_INDEX ();
22345 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22346 /* Don't extend on a previously drawn mode-line.
22347 This may happen if called from pos_visible_p. */
22348 it
.glyph_row
->enabled_p
= false;
22349 prepare_desired_row (w
, it
.glyph_row
, true);
22351 it
.glyph_row
->mode_line_p
= true;
22353 /* FIXME: This should be controlled by a user option. But
22354 supporting such an option is not trivial, since the mode line is
22355 made up of many separate strings. */
22356 it
.paragraph_embedding
= L2R
;
22358 record_unwind_protect (unwind_format_mode_line
,
22359 format_mode_line_unwind_data (NULL
, NULL
,
22362 mode_line_target
= MODE_LINE_DISPLAY
;
22364 /* Temporarily make frame's keyboard the current kboard so that
22365 kboard-local variables in the mode_line_format will get the right
22367 push_kboard (FRAME_KBOARD (it
.f
));
22368 record_unwind_save_match_data ();
22369 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22372 unbind_to (count
, Qnil
);
22374 /* Fill up with spaces. */
22375 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
22377 compute_line_metrics (&it
);
22378 it
.glyph_row
->full_width_p
= true;
22379 it
.glyph_row
->continued_p
= false;
22380 it
.glyph_row
->truncated_on_left_p
= false;
22381 it
.glyph_row
->truncated_on_right_p
= false;
22383 /* Make a 3D mode-line have a shadow at its right end. */
22384 face
= FACE_FROM_ID (it
.f
, face_id
);
22385 extend_face_to_end_of_line (&it
);
22386 if (face
->box
!= FACE_NO_BOX
)
22388 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
22389 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
22390 last
->right_box_line_p
= true;
22393 return it
.glyph_row
->height
;
22396 /* Move element ELT in LIST to the front of LIST.
22397 Return the updated list. */
22400 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
22402 register Lisp_Object tail
, prev
;
22403 register Lisp_Object tem
;
22407 while (CONSP (tail
))
22413 /* Splice out the link TAIL. */
22415 list
= XCDR (tail
);
22417 Fsetcdr (prev
, XCDR (tail
));
22419 /* Now make it the first. */
22420 Fsetcdr (tail
, list
);
22425 tail
= XCDR (tail
);
22429 /* Not found--return unchanged LIST. */
22433 /* Contribute ELT to the mode line for window IT->w. How it
22434 translates into text depends on its data type.
22436 IT describes the display environment in which we display, as usual.
22438 DEPTH is the depth in recursion. It is used to prevent
22439 infinite recursion here.
22441 FIELD_WIDTH is the number of characters the display of ELT should
22442 occupy in the mode line, and PRECISION is the maximum number of
22443 characters to display from ELT's representation. See
22444 display_string for details.
22446 Returns the hpos of the end of the text generated by ELT.
22448 PROPS is a property list to add to any string we encounter.
22450 If RISKY, remove (disregard) any properties in any string
22451 we encounter, and ignore :eval and :propertize.
22453 The global variable `mode_line_target' determines whether the
22454 output is passed to `store_mode_line_noprop',
22455 `store_mode_line_string', or `display_string'. */
22458 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
22459 Lisp_Object elt
, Lisp_Object props
, bool risky
)
22461 int n
= 0, field
, prec
;
22462 bool literal
= false;
22466 elt
= build_string ("*too-deep*");
22470 switch (XTYPE (elt
))
22474 /* A string: output it and check for %-constructs within it. */
22476 ptrdiff_t offset
= 0;
22478 if (SCHARS (elt
) > 0
22479 && (!NILP (props
) || risky
))
22481 Lisp_Object oprops
, aelt
;
22482 oprops
= Ftext_properties_at (make_number (0), elt
);
22484 /* If the starting string's properties are not what
22485 we want, translate the string. Also, if the string
22486 is risky, do that anyway. */
22488 if (NILP (Fequal (props
, oprops
)) || risky
)
22490 /* If the starting string has properties,
22491 merge the specified ones onto the existing ones. */
22492 if (! NILP (oprops
) && !risky
)
22496 oprops
= Fcopy_sequence (oprops
);
22498 while (CONSP (tem
))
22500 oprops
= Fplist_put (oprops
, XCAR (tem
),
22501 XCAR (XCDR (tem
)));
22502 tem
= XCDR (XCDR (tem
));
22507 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
22508 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
22510 /* AELT is what we want. Move it to the front
22511 without consing. */
22513 mode_line_proptrans_alist
22514 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
22520 /* If AELT has the wrong props, it is useless.
22521 so get rid of it. */
22523 mode_line_proptrans_alist
22524 = Fdelq (aelt
, mode_line_proptrans_alist
);
22526 elt
= Fcopy_sequence (elt
);
22527 Fset_text_properties (make_number (0), Flength (elt
),
22529 /* Add this item to mode_line_proptrans_alist. */
22530 mode_line_proptrans_alist
22531 = Fcons (Fcons (elt
, props
),
22532 mode_line_proptrans_alist
);
22533 /* Truncate mode_line_proptrans_alist
22534 to at most 50 elements. */
22535 tem
= Fnthcdr (make_number (50),
22536 mode_line_proptrans_alist
);
22538 XSETCDR (tem
, Qnil
);
22547 prec
= precision
- n
;
22548 switch (mode_line_target
)
22550 case MODE_LINE_NOPROP
:
22551 case MODE_LINE_TITLE
:
22552 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
22554 case MODE_LINE_STRING
:
22555 n
+= store_mode_line_string (NULL
, elt
, true, 0, prec
, Qnil
);
22557 case MODE_LINE_DISPLAY
:
22558 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
22559 0, prec
, 0, STRING_MULTIBYTE (elt
));
22566 /* Handle the non-literal case. */
22568 while ((precision
<= 0 || n
< precision
)
22569 && SREF (elt
, offset
) != 0
22570 && (mode_line_target
!= MODE_LINE_DISPLAY
22571 || it
->current_x
< it
->last_visible_x
))
22573 ptrdiff_t last_offset
= offset
;
22575 /* Advance to end of string or next format specifier. */
22576 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22579 if (offset
- 1 != last_offset
)
22581 ptrdiff_t nchars
, nbytes
;
22583 /* Output to end of string or up to '%'. Field width
22584 is length of string. Don't output more than
22585 PRECISION allows us. */
22588 prec
= c_string_width (SDATA (elt
) + last_offset
,
22589 offset
- last_offset
, precision
- n
,
22592 switch (mode_line_target
)
22594 case MODE_LINE_NOPROP
:
22595 case MODE_LINE_TITLE
:
22596 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22598 case MODE_LINE_STRING
:
22600 ptrdiff_t bytepos
= last_offset
;
22601 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22602 ptrdiff_t endpos
= (precision
<= 0
22603 ? string_byte_to_char (elt
, offset
)
22604 : charpos
+ nchars
);
22605 Lisp_Object mode_string
22606 = Fsubstring (elt
, make_number (charpos
),
22607 make_number (endpos
));
22608 n
+= store_mode_line_string (NULL
, mode_string
, false,
22612 case MODE_LINE_DISPLAY
:
22614 ptrdiff_t bytepos
= last_offset
;
22615 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22617 if (precision
<= 0)
22618 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22619 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22621 STRING_MULTIBYTE (elt
));
22626 else /* c == '%' */
22628 ptrdiff_t percent_position
= offset
;
22630 /* Get the specified minimum width. Zero means
22633 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22634 field
= field
* 10 + c
- '0';
22636 /* Don't pad beyond the total padding allowed. */
22637 if (field_width
- n
> 0 && field
> field_width
- n
)
22638 field
= field_width
- n
;
22640 /* Note that either PRECISION <= 0 or N < PRECISION. */
22641 prec
= precision
- n
;
22644 n
+= display_mode_element (it
, depth
, field
, prec
,
22645 Vglobal_mode_string
, props
,
22650 ptrdiff_t bytepos
, charpos
;
22652 Lisp_Object string
;
22654 bytepos
= percent_position
;
22655 charpos
= (STRING_MULTIBYTE (elt
)
22656 ? string_byte_to_char (elt
, bytepos
)
22658 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22659 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22661 switch (mode_line_target
)
22663 case MODE_LINE_NOPROP
:
22664 case MODE_LINE_TITLE
:
22665 n
+= store_mode_line_noprop (spec
, field
, prec
);
22667 case MODE_LINE_STRING
:
22669 Lisp_Object tem
= build_string (spec
);
22670 props
= Ftext_properties_at (make_number (charpos
), elt
);
22671 /* Should only keep face property in props */
22672 n
+= store_mode_line_string (NULL
, tem
, false,
22673 field
, prec
, props
);
22676 case MODE_LINE_DISPLAY
:
22678 int nglyphs_before
, nwritten
;
22680 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22681 nwritten
= display_string (spec
, string
, elt
,
22686 /* Assign to the glyphs written above the
22687 string where the `%x' came from, position
22691 struct glyph
*glyph
22692 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22696 for (i
= 0; i
< nwritten
; ++i
)
22698 glyph
[i
].object
= elt
;
22699 glyph
[i
].charpos
= charpos
;
22716 /* A symbol: process the value of the symbol recursively
22717 as if it appeared here directly. Avoid error if symbol void.
22718 Special case: if value of symbol is a string, output the string
22721 register Lisp_Object tem
;
22723 /* If the variable is not marked as risky to set
22724 then its contents are risky to use. */
22725 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22728 tem
= Fboundp (elt
);
22731 tem
= Fsymbol_value (elt
);
22732 /* If value is a string, output that string literally:
22733 don't check for % within it. */
22737 if (!EQ (tem
, elt
))
22739 /* Give up right away for nil or t. */
22749 register Lisp_Object car
, tem
;
22751 /* A cons cell: five distinct cases.
22752 If first element is :eval or :propertize, do something special.
22753 If first element is a string or a cons, process all the elements
22754 and effectively concatenate them.
22755 If first element is a negative number, truncate displaying cdr to
22756 at most that many characters. If positive, pad (with spaces)
22757 to at least that many characters.
22758 If first element is a symbol, process the cadr or caddr recursively
22759 according to whether the symbol's value is non-nil or nil. */
22761 if (EQ (car
, QCeval
))
22763 /* An element of the form (:eval FORM) means evaluate FORM
22764 and use the result as mode line elements. */
22769 if (CONSP (XCDR (elt
)))
22772 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22773 n
+= display_mode_element (it
, depth
, field_width
- n
,
22774 precision
- n
, spec
, props
,
22778 else if (EQ (car
, QCpropertize
))
22780 /* An element of the form (:propertize ELT PROPS...)
22781 means display ELT but applying properties PROPS. */
22786 if (CONSP (XCDR (elt
)))
22787 n
+= display_mode_element (it
, depth
, field_width
- n
,
22788 precision
- n
, XCAR (XCDR (elt
)),
22789 XCDR (XCDR (elt
)), risky
);
22791 else if (SYMBOLP (car
))
22793 tem
= Fboundp (car
);
22797 /* elt is now the cdr, and we know it is a cons cell.
22798 Use its car if CAR has a non-nil value. */
22801 tem
= Fsymbol_value (car
);
22808 /* Symbol's value is nil (or symbol is unbound)
22809 Get the cddr of the original list
22810 and if possible find the caddr and use that. */
22814 else if (!CONSP (elt
))
22819 else if (INTEGERP (car
))
22821 register int lim
= XINT (car
);
22825 /* Negative int means reduce maximum width. */
22826 if (precision
<= 0)
22829 precision
= min (precision
, -lim
);
22833 /* Padding specified. Don't let it be more than
22834 current maximum. */
22836 lim
= min (precision
, lim
);
22838 /* If that's more padding than already wanted, queue it.
22839 But don't reduce padding already specified even if
22840 that is beyond the current truncation point. */
22841 field_width
= max (lim
, field_width
);
22845 else if (STRINGP (car
) || CONSP (car
))
22847 Lisp_Object halftail
= elt
;
22851 && (precision
<= 0 || n
< precision
))
22853 n
+= display_mode_element (it
, depth
,
22854 /* Do padding only after the last
22855 element in the list. */
22856 (! CONSP (XCDR (elt
))
22859 precision
- n
, XCAR (elt
),
22863 if ((len
& 1) == 0)
22864 halftail
= XCDR (halftail
);
22865 /* Check for cycle. */
22866 if (EQ (halftail
, elt
))
22875 elt
= build_string ("*invalid*");
22879 /* Pad to FIELD_WIDTH. */
22880 if (field_width
> 0 && n
< field_width
)
22882 switch (mode_line_target
)
22884 case MODE_LINE_NOPROP
:
22885 case MODE_LINE_TITLE
:
22886 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22888 case MODE_LINE_STRING
:
22889 n
+= store_mode_line_string ("", Qnil
, false, field_width
- n
, 0,
22892 case MODE_LINE_DISPLAY
:
22893 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22902 /* Store a mode-line string element in mode_line_string_list.
22904 If STRING is non-null, display that C string. Otherwise, the Lisp
22905 string LISP_STRING is displayed.
22907 FIELD_WIDTH is the minimum number of output glyphs to produce.
22908 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22909 with spaces. FIELD_WIDTH <= 0 means don't pad.
22911 PRECISION is the maximum number of characters to output from
22912 STRING. PRECISION <= 0 means don't truncate the string.
22914 If COPY_STRING, make a copy of LISP_STRING before adding
22915 properties to the string.
22917 PROPS are the properties to add to the string.
22918 The mode_line_string_face face property is always added to the string.
22922 store_mode_line_string (const char *string
, Lisp_Object lisp_string
,
22924 int field_width
, int precision
, Lisp_Object props
)
22929 if (string
!= NULL
)
22931 len
= strlen (string
);
22932 if (precision
> 0 && len
> precision
)
22934 lisp_string
= make_string (string
, len
);
22936 props
= mode_line_string_face_prop
;
22937 else if (!NILP (mode_line_string_face
))
22939 Lisp_Object face
= Fplist_get (props
, Qface
);
22940 props
= Fcopy_sequence (props
);
22942 face
= mode_line_string_face
;
22944 face
= list2 (face
, mode_line_string_face
);
22945 props
= Fplist_put (props
, Qface
, face
);
22947 Fadd_text_properties (make_number (0), make_number (len
),
22948 props
, lisp_string
);
22952 len
= XFASTINT (Flength (lisp_string
));
22953 if (precision
> 0 && len
> precision
)
22956 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22959 if (!NILP (mode_line_string_face
))
22963 props
= Ftext_properties_at (make_number (0), lisp_string
);
22964 face
= Fplist_get (props
, Qface
);
22966 face
= mode_line_string_face
;
22968 face
= list2 (face
, mode_line_string_face
);
22969 props
= list2 (Qface
, face
);
22971 lisp_string
= Fcopy_sequence (lisp_string
);
22974 Fadd_text_properties (make_number (0), make_number (len
),
22975 props
, lisp_string
);
22980 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22984 if (field_width
> len
)
22986 field_width
-= len
;
22987 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22989 Fadd_text_properties (make_number (0), make_number (field_width
),
22990 props
, lisp_string
);
22991 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22999 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
23001 doc
: /* Format a string out of a mode line format specification.
23002 First arg FORMAT specifies the mode line format (see `mode-line-format'
23003 for details) to use.
23005 By default, the format is evaluated for the currently selected window.
23007 Optional second arg FACE specifies the face property to put on all
23008 characters for which no face is specified. The value nil means the
23009 default face. The value t means whatever face the window's mode line
23010 currently uses (either `mode-line' or `mode-line-inactive',
23011 depending on whether the window is the selected window or not).
23012 An integer value means the value string has no text
23015 Optional third and fourth args WINDOW and BUFFER specify the window
23016 and buffer to use as the context for the formatting (defaults
23017 are the selected window and the WINDOW's buffer). */)
23018 (Lisp_Object format
, Lisp_Object face
,
23019 Lisp_Object window
, Lisp_Object buffer
)
23024 struct buffer
*old_buffer
= NULL
;
23026 bool no_props
= INTEGERP (face
);
23027 ptrdiff_t count
= SPECPDL_INDEX ();
23029 int string_start
= 0;
23031 w
= decode_any_window (window
);
23032 XSETWINDOW (window
, w
);
23035 buffer
= w
->contents
;
23036 CHECK_BUFFER (buffer
);
23038 /* Make formatting the modeline a non-op when noninteractive, otherwise
23039 there will be problems later caused by a partially initialized frame. */
23040 if (NILP (format
) || noninteractive
)
23041 return empty_unibyte_string
;
23046 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
23047 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
23048 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
23049 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
23050 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
23051 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
23052 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
23055 old_buffer
= current_buffer
;
23057 /* Save things including mode_line_proptrans_alist,
23058 and set that to nil so that we don't alter the outer value. */
23059 record_unwind_protect (unwind_format_mode_line
,
23060 format_mode_line_unwind_data
23061 (XFRAME (WINDOW_FRAME (w
)),
23062 old_buffer
, selected_window
, true));
23063 mode_line_proptrans_alist
= Qnil
;
23065 Fselect_window (window
, Qt
);
23066 set_buffer_internal_1 (XBUFFER (buffer
));
23068 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
23072 mode_line_target
= MODE_LINE_NOPROP
;
23073 mode_line_string_face_prop
= Qnil
;
23074 mode_line_string_list
= Qnil
;
23075 string_start
= MODE_LINE_NOPROP_LEN (0);
23079 mode_line_target
= MODE_LINE_STRING
;
23080 mode_line_string_list
= Qnil
;
23081 mode_line_string_face
= face
;
23082 mode_line_string_face_prop
23083 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
23086 push_kboard (FRAME_KBOARD (it
.f
));
23087 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
23092 len
= MODE_LINE_NOPROP_LEN (string_start
);
23093 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
23097 mode_line_string_list
= Fnreverse (mode_line_string_list
);
23098 str
= Fmapconcat (Qidentity
, mode_line_string_list
,
23099 empty_unibyte_string
);
23102 unbind_to (count
, Qnil
);
23106 /* Write a null-terminated, right justified decimal representation of
23107 the positive integer D to BUF using a minimal field width WIDTH. */
23110 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
23112 register char *p
= buf
;
23120 *p
++ = d
% 10 + '0';
23125 for (width
-= (int) (p
- buf
); width
> 0; --width
)
23136 /* Write a null-terminated, right justified decimal and "human
23137 readable" representation of the nonnegative integer D to BUF using
23138 a minimal field width WIDTH. D should be smaller than 999.5e24. */
23140 static const char power_letter
[] =
23154 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
23156 /* We aim to represent the nonnegative integer D as
23157 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
23158 ptrdiff_t quotient
= d
;
23160 /* -1 means: do not use TENTHS. */
23164 /* Length of QUOTIENT.TENTHS as a string. */
23170 if (quotient
>= 1000)
23172 /* Scale to the appropriate EXPONENT. */
23175 remainder
= quotient
% 1000;
23179 while (quotient
>= 1000);
23181 /* Round to nearest and decide whether to use TENTHS or not. */
23184 tenths
= remainder
/ 100;
23185 if (remainder
% 100 >= 50)
23192 if (quotient
== 10)
23200 if (remainder
>= 500)
23202 if (quotient
< 999)
23213 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
23214 if (tenths
== -1 && quotient
<= 99)
23221 p
= psuffix
= buf
+ max (width
, length
);
23223 /* Print EXPONENT. */
23224 *psuffix
++ = power_letter
[exponent
];
23227 /* Print TENTHS. */
23230 *--p
= '0' + tenths
;
23234 /* Print QUOTIENT. */
23237 int digit
= quotient
% 10;
23238 *--p
= '0' + digit
;
23240 while ((quotient
/= 10) != 0);
23242 /* Print leading spaces. */
23247 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
23248 If EOL_FLAG, set also a mnemonic character for end-of-line
23249 type of CODING_SYSTEM. Return updated pointer into BUF. */
23251 static unsigned char invalid_eol_type
[] = "(*invalid*)";
23254 decode_mode_spec_coding (Lisp_Object coding_system
, char *buf
, bool eol_flag
)
23257 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
23258 const unsigned char *eol_str
;
23260 /* The EOL conversion we are using. */
23261 Lisp_Object eoltype
;
23263 val
= CODING_SYSTEM_SPEC (coding_system
);
23266 if (!VECTORP (val
)) /* Not yet decided. */
23268 *buf
++ = multibyte
? '-' : ' ';
23270 eoltype
= eol_mnemonic_undecided
;
23271 /* Don't mention EOL conversion if it isn't decided. */
23276 Lisp_Object eolvalue
;
23278 attrs
= AREF (val
, 0);
23279 eolvalue
= AREF (val
, 2);
23282 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
23287 /* The EOL conversion that is normal on this system. */
23289 if (NILP (eolvalue
)) /* Not yet decided. */
23290 eoltype
= eol_mnemonic_undecided
;
23291 else if (VECTORP (eolvalue
)) /* Not yet decided. */
23292 eoltype
= eol_mnemonic_undecided
;
23293 else /* eolvalue is Qunix, Qdos, or Qmac. */
23294 eoltype
= (EQ (eolvalue
, Qunix
)
23295 ? eol_mnemonic_unix
23296 : EQ (eolvalue
, Qdos
)
23297 ? eol_mnemonic_dos
: eol_mnemonic_mac
);
23303 /* Mention the EOL conversion if it is not the usual one. */
23304 if (STRINGP (eoltype
))
23306 eol_str
= SDATA (eoltype
);
23307 eol_str_len
= SBYTES (eoltype
);
23309 else if (CHARACTERP (eoltype
))
23311 int c
= XFASTINT (eoltype
);
23312 return buf
+ CHAR_STRING (c
, (unsigned char *) buf
);
23316 eol_str
= invalid_eol_type
;
23317 eol_str_len
= sizeof (invalid_eol_type
) - 1;
23319 memcpy (buf
, eol_str
, eol_str_len
);
23320 buf
+= eol_str_len
;
23326 /* Return a string for the output of a mode line %-spec for window W,
23327 generated by character C. FIELD_WIDTH > 0 means pad the string
23328 returned with spaces to that value. Return a Lisp string in
23329 *STRING if the resulting string is taken from that Lisp string.
23331 Note we operate on the current buffer for most purposes. */
23333 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
23335 static const char *
23336 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
23337 Lisp_Object
*string
)
23340 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23341 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
23342 /* We are going to use f->decode_mode_spec_buffer as the buffer to
23343 produce strings from numerical values, so limit preposterously
23344 large values of FIELD_WIDTH to avoid overrunning the buffer's
23345 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
23346 bytes plus the terminating null. */
23347 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
23348 struct buffer
*b
= current_buffer
;
23356 if (!NILP (BVAR (b
, read_only
)))
23358 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23363 /* This differs from %* only for a modified read-only buffer. */
23364 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23366 if (!NILP (BVAR (b
, read_only
)))
23371 /* This differs from %* in ignoring read-only-ness. */
23372 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23384 if (command_loop_level
> 5)
23386 p
= decode_mode_spec_buf
;
23387 for (i
= 0; i
< command_loop_level
; i
++)
23390 return decode_mode_spec_buf
;
23398 if (command_loop_level
> 5)
23400 p
= decode_mode_spec_buf
;
23401 for (i
= 0; i
< command_loop_level
; i
++)
23404 return decode_mode_spec_buf
;
23411 /* Let lots_of_dashes be a string of infinite length. */
23412 if (mode_line_target
== MODE_LINE_NOPROP
23413 || mode_line_target
== MODE_LINE_STRING
)
23415 if (field_width
<= 0
23416 || field_width
> sizeof (lots_of_dashes
))
23418 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
23419 decode_mode_spec_buf
[i
] = '-';
23420 decode_mode_spec_buf
[i
] = '\0';
23421 return decode_mode_spec_buf
;
23424 return lots_of_dashes
;
23428 obj
= BVAR (b
, name
);
23432 /* %c and %l are ignored in `frame-title-format'.
23433 (In redisplay_internal, the frame title is drawn _before_ the
23434 windows are updated, so the stuff which depends on actual
23435 window contents (such as %l) may fail to render properly, or
23436 even crash emacs.) */
23437 if (mode_line_target
== MODE_LINE_TITLE
)
23441 ptrdiff_t col
= current_column ();
23442 w
->column_number_displayed
= col
;
23443 pint2str (decode_mode_spec_buf
, width
, col
);
23444 return decode_mode_spec_buf
;
23448 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
23450 if (NILP (Vmemory_full
))
23453 return "!MEM FULL! ";
23460 /* %F displays the frame name. */
23461 if (!NILP (f
->title
))
23462 return SSDATA (f
->title
);
23463 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
23464 return SSDATA (f
->name
);
23468 obj
= BVAR (b
, filename
);
23473 ptrdiff_t size
= ZV
- BEGV
;
23474 pint2str (decode_mode_spec_buf
, width
, size
);
23475 return decode_mode_spec_buf
;
23480 ptrdiff_t size
= ZV
- BEGV
;
23481 pint2hrstr (decode_mode_spec_buf
, width
, size
);
23482 return decode_mode_spec_buf
;
23487 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
23488 ptrdiff_t topline
, nlines
, height
;
23491 /* %c and %l are ignored in `frame-title-format'. */
23492 if (mode_line_target
== MODE_LINE_TITLE
)
23495 startpos
= marker_position (w
->start
);
23496 startpos_byte
= marker_byte_position (w
->start
);
23497 height
= WINDOW_TOTAL_LINES (w
);
23499 /* If we decided that this buffer isn't suitable for line numbers,
23500 don't forget that too fast. */
23501 if (w
->base_line_pos
== -1)
23504 /* If the buffer is very big, don't waste time. */
23505 if (INTEGERP (Vline_number_display_limit
)
23506 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
23508 w
->base_line_pos
= 0;
23509 w
->base_line_number
= 0;
23513 if (w
->base_line_number
> 0
23514 && w
->base_line_pos
> 0
23515 && w
->base_line_pos
<= startpos
)
23517 line
= w
->base_line_number
;
23518 linepos
= w
->base_line_pos
;
23519 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
23524 linepos
= BUF_BEGV (b
);
23525 linepos_byte
= BUF_BEGV_BYTE (b
);
23528 /* Count lines from base line to window start position. */
23529 nlines
= display_count_lines (linepos_byte
,
23533 topline
= nlines
+ line
;
23535 /* Determine a new base line, if the old one is too close
23536 or too far away, or if we did not have one.
23537 "Too close" means it's plausible a scroll-down would
23538 go back past it. */
23539 if (startpos
== BUF_BEGV (b
))
23541 w
->base_line_number
= topline
;
23542 w
->base_line_pos
= BUF_BEGV (b
);
23544 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
23545 || linepos
== BUF_BEGV (b
))
23547 ptrdiff_t limit
= BUF_BEGV (b
);
23548 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
23549 ptrdiff_t position
;
23550 ptrdiff_t distance
=
23551 (height
* 2 + 30) * line_number_display_limit_width
;
23553 if (startpos
- distance
> limit
)
23555 limit
= startpos
- distance
;
23556 limit_byte
= CHAR_TO_BYTE (limit
);
23559 nlines
= display_count_lines (startpos_byte
,
23561 - (height
* 2 + 30),
23563 /* If we couldn't find the lines we wanted within
23564 line_number_display_limit_width chars per line,
23565 give up on line numbers for this window. */
23566 if (position
== limit_byte
&& limit
== startpos
- distance
)
23568 w
->base_line_pos
= -1;
23569 w
->base_line_number
= 0;
23573 w
->base_line_number
= topline
- nlines
;
23574 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23577 /* Now count lines from the start pos to point. */
23578 nlines
= display_count_lines (startpos_byte
,
23579 PT_BYTE
, PT
, &junk
);
23581 /* Record that we did display the line number. */
23582 line_number_displayed
= true;
23584 /* Make the string to show. */
23585 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23586 return decode_mode_spec_buf
;
23589 char *p
= decode_mode_spec_buf
;
23590 int pad
= width
- 2;
23596 return decode_mode_spec_buf
;
23602 obj
= BVAR (b
, mode_name
);
23606 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23612 ptrdiff_t pos
= marker_position (w
->start
);
23613 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23615 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23617 if (pos
<= BUF_BEGV (b
))
23622 else if (pos
<= BUF_BEGV (b
))
23626 if (total
> 1000000)
23627 /* Do it differently for a large value, to avoid overflow. */
23628 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23630 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23631 /* We can't normally display a 3-digit number,
23632 so get us a 2-digit number that is close. */
23635 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23636 return decode_mode_spec_buf
;
23640 /* Display percentage of size above the bottom of the screen. */
23643 ptrdiff_t toppos
= marker_position (w
->start
);
23644 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23645 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23647 if (botpos
>= BUF_ZV (b
))
23649 if (toppos
<= BUF_BEGV (b
))
23656 if (total
> 1000000)
23657 /* Do it differently for a large value, to avoid overflow. */
23658 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23660 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23661 /* We can't normally display a 3-digit number,
23662 so get us a 2-digit number that is close. */
23665 if (toppos
<= BUF_BEGV (b
))
23666 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23668 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23669 return decode_mode_spec_buf
;
23674 /* status of process */
23675 obj
= Fget_buffer_process (Fcurrent_buffer ());
23677 return "no process";
23679 obj
= Fsymbol_name (Fprocess_status (obj
));
23685 ptrdiff_t count
= inhibit_garbage_collection ();
23686 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23687 Lisp_Object val
= Qnil
;
23689 if (STRINGP (curdir
))
23690 val
= call1 (intern ("file-remote-p"), curdir
);
23692 unbind_to (count
, Qnil
);
23701 /* coding-system (not including end-of-line format) */
23703 /* coding-system (including end-of-line type) */
23705 bool eol_flag
= (c
== 'Z');
23706 char *p
= decode_mode_spec_buf
;
23708 if (! FRAME_WINDOW_P (f
))
23710 /* No need to mention EOL here--the terminal never needs
23711 to do EOL conversion. */
23712 p
= decode_mode_spec_coding (CODING_ID_NAME
23713 (FRAME_KEYBOARD_CODING (f
)->id
),
23715 p
= decode_mode_spec_coding (CODING_ID_NAME
23716 (FRAME_TERMINAL_CODING (f
)->id
),
23719 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23722 #if false /* This proves to be annoying; I think we can do without. -- rms. */
23723 #ifdef subprocesses
23724 obj
= Fget_buffer_process (Fcurrent_buffer ());
23725 if (PROCESSP (obj
))
23727 p
= decode_mode_spec_coding
23728 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23729 p
= decode_mode_spec_coding
23730 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23732 #endif /* subprocesses */
23735 return decode_mode_spec_buf
;
23742 return SSDATA (obj
);
23749 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23750 means count lines back from START_BYTE. But don't go beyond
23751 LIMIT_BYTE. Return the number of lines thus found (always
23754 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23755 either the position COUNT lines after/before START_BYTE, if we
23756 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23760 display_count_lines (ptrdiff_t start_byte
,
23761 ptrdiff_t limit_byte
, ptrdiff_t count
,
23762 ptrdiff_t *byte_pos_ptr
)
23764 register unsigned char *cursor
;
23765 unsigned char *base
;
23767 register ptrdiff_t ceiling
;
23768 register unsigned char *ceiling_addr
;
23769 ptrdiff_t orig_count
= count
;
23771 /* If we are not in selective display mode,
23772 check only for newlines. */
23773 bool selective_display
23774 = (!NILP (BVAR (current_buffer
, selective_display
))
23775 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23779 while (start_byte
< limit_byte
)
23781 ceiling
= BUFFER_CEILING_OF (start_byte
);
23782 ceiling
= min (limit_byte
- 1, ceiling
);
23783 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23784 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23788 if (selective_display
)
23790 while (*cursor
!= '\n' && *cursor
!= 015
23791 && ++cursor
!= ceiling_addr
)
23793 if (cursor
== ceiling_addr
)
23798 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23807 start_byte
+= cursor
- base
;
23808 *byte_pos_ptr
= start_byte
;
23812 while (cursor
< ceiling_addr
);
23814 start_byte
+= ceiling_addr
- base
;
23819 while (start_byte
> limit_byte
)
23821 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23822 ceiling
= max (limit_byte
, ceiling
);
23823 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23824 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23827 if (selective_display
)
23829 while (--cursor
>= ceiling_addr
23830 && *cursor
!= '\n' && *cursor
!= 015)
23832 if (cursor
< ceiling_addr
)
23837 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23844 start_byte
+= cursor
- base
+ 1;
23845 *byte_pos_ptr
= start_byte
;
23846 /* When scanning backwards, we should
23847 not count the newline posterior to which we stop. */
23848 return - orig_count
- 1;
23851 start_byte
+= ceiling_addr
- base
;
23855 *byte_pos_ptr
= limit_byte
;
23858 return - orig_count
+ count
;
23859 return orig_count
- count
;
23865 /***********************************************************************
23867 ***********************************************************************/
23869 /* Display a NUL-terminated string, starting with index START.
23871 If STRING is non-null, display that C string. Otherwise, the Lisp
23872 string LISP_STRING is displayed. There's a case that STRING is
23873 non-null and LISP_STRING is not nil. It means STRING is a string
23874 data of LISP_STRING. In that case, we display LISP_STRING while
23875 ignoring its text properties.
23877 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23878 FACE_STRING. Display STRING or LISP_STRING with the face at
23879 FACE_STRING_POS in FACE_STRING:
23881 Display the string in the environment given by IT, but use the
23882 standard display table, temporarily.
23884 FIELD_WIDTH is the minimum number of output glyphs to produce.
23885 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23886 with spaces. If STRING has more characters, more than FIELD_WIDTH
23887 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23889 PRECISION is the maximum number of characters to output from
23890 STRING. PRECISION < 0 means don't truncate the string.
23892 This is roughly equivalent to printf format specifiers:
23894 FIELD_WIDTH PRECISION PRINTF
23895 ----------------------------------------
23901 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23902 display them, and < 0 means obey the current buffer's value of
23903 enable_multibyte_characters.
23905 Value is the number of columns displayed. */
23908 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23909 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23910 int field_width
, int precision
, int max_x
, int multibyte
)
23912 int hpos_at_start
= it
->hpos
;
23913 int saved_face_id
= it
->face_id
;
23914 struct glyph_row
*row
= it
->glyph_row
;
23915 ptrdiff_t it_charpos
;
23917 /* Initialize the iterator IT for iteration over STRING beginning
23918 with index START. */
23919 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23920 precision
, field_width
, multibyte
);
23921 if (string
&& STRINGP (lisp_string
))
23922 /* LISP_STRING is the one returned by decode_mode_spec. We should
23923 ignore its text properties. */
23924 it
->stop_charpos
= it
->end_charpos
;
23926 /* If displaying STRING, set up the face of the iterator from
23927 FACE_STRING, if that's given. */
23928 if (STRINGP (face_string
))
23934 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23935 0, &endptr
, it
->base_face_id
, false);
23936 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23937 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23940 /* Set max_x to the maximum allowed X position. Don't let it go
23941 beyond the right edge of the window. */
23943 max_x
= it
->last_visible_x
;
23945 max_x
= min (max_x
, it
->last_visible_x
);
23947 /* Skip over display elements that are not visible. because IT->w is
23949 if (it
->current_x
< it
->first_visible_x
)
23950 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23951 MOVE_TO_POS
| MOVE_TO_X
);
23953 row
->ascent
= it
->max_ascent
;
23954 row
->height
= it
->max_ascent
+ it
->max_descent
;
23955 row
->phys_ascent
= it
->max_phys_ascent
;
23956 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23957 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23959 if (STRINGP (it
->string
))
23960 it_charpos
= IT_STRING_CHARPOS (*it
);
23962 it_charpos
= IT_CHARPOS (*it
);
23964 /* This condition is for the case that we are called with current_x
23965 past last_visible_x. */
23966 while (it
->current_x
< max_x
)
23968 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23970 /* Get the next display element. */
23971 if (!get_next_display_element (it
))
23974 /* Produce glyphs. */
23975 x_before
= it
->current_x
;
23976 n_glyphs_before
= row
->used
[TEXT_AREA
];
23977 PRODUCE_GLYPHS (it
);
23979 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23982 while (i
< nglyphs
)
23984 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23986 if (it
->line_wrap
!= TRUNCATE
23987 && x
+ glyph
->pixel_width
> max_x
)
23989 /* End of continued line or max_x reached. */
23990 if (CHAR_GLYPH_PADDING_P (*glyph
))
23992 /* A wide character is unbreakable. */
23993 if (row
->reversed_p
)
23994 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23995 - n_glyphs_before
);
23996 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23997 it
->current_x
= x_before
;
24001 if (row
->reversed_p
)
24002 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
24003 - (n_glyphs_before
+ i
));
24004 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
24009 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
24011 /* Glyph is at least partially visible. */
24013 if (x
< it
->first_visible_x
)
24014 row
->x
= x
- it
->first_visible_x
;
24018 /* Glyph is off the left margin of the display area.
24019 Should not happen. */
24023 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
24024 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
24025 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
24026 row
->phys_height
= max (row
->phys_height
,
24027 it
->max_phys_ascent
+ it
->max_phys_descent
);
24028 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
24029 it
->max_extra_line_spacing
);
24030 x
+= glyph
->pixel_width
;
24034 /* Stop if max_x reached. */
24038 /* Stop at line ends. */
24039 if (ITERATOR_AT_END_OF_LINE_P (it
))
24041 it
->continuation_lines_width
= 0;
24045 set_iterator_to_next (it
, true);
24046 if (STRINGP (it
->string
))
24047 it_charpos
= IT_STRING_CHARPOS (*it
);
24049 it_charpos
= IT_CHARPOS (*it
);
24051 /* Stop if truncating at the right edge. */
24052 if (it
->line_wrap
== TRUNCATE
24053 && it
->current_x
>= it
->last_visible_x
)
24055 /* Add truncation mark, but don't do it if the line is
24056 truncated at a padding space. */
24057 if (it_charpos
< it
->string_nchars
)
24059 if (!FRAME_WINDOW_P (it
->f
))
24063 if (it
->current_x
> it
->last_visible_x
)
24065 if (!row
->reversed_p
)
24067 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
24068 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
24073 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
24074 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
24076 unproduce_glyphs (it
, ii
+ 1);
24077 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
24079 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
24081 row
->used
[TEXT_AREA
] = ii
;
24082 produce_special_glyphs (it
, IT_TRUNCATION
);
24085 produce_special_glyphs (it
, IT_TRUNCATION
);
24087 row
->truncated_on_right_p
= true;
24093 /* Maybe insert a truncation at the left. */
24094 if (it
->first_visible_x
24097 if (!FRAME_WINDOW_P (it
->f
)
24098 || (row
->reversed_p
24099 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24100 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
24101 insert_left_trunc_glyphs (it
);
24102 row
->truncated_on_left_p
= true;
24105 it
->face_id
= saved_face_id
;
24107 /* Value is number of columns displayed. */
24108 return it
->hpos
- hpos_at_start
;
24113 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
24114 appears as an element of LIST or as the car of an element of LIST.
24115 If PROPVAL is a list, compare each element against LIST in that
24116 way, and return 1/2 if any element of PROPVAL is found in LIST.
24117 Otherwise return 0. This function cannot quit.
24118 The return value is 2 if the text is invisible but with an ellipsis
24119 and 1 if it's invisible and without an ellipsis. */
24122 invisible_prop (Lisp_Object propval
, Lisp_Object list
)
24124 Lisp_Object tail
, proptail
;
24126 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
24128 register Lisp_Object tem
;
24130 if (EQ (propval
, tem
))
24132 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
24133 return NILP (XCDR (tem
)) ? 1 : 2;
24136 if (CONSP (propval
))
24138 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
24140 Lisp_Object propelt
;
24141 propelt
= XCAR (proptail
);
24142 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
24144 register Lisp_Object tem
;
24146 if (EQ (propelt
, tem
))
24148 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
24149 return NILP (XCDR (tem
)) ? 1 : 2;
24157 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
24158 doc
: /* Non-nil if the property makes the text invisible.
24159 POS-OR-PROP can be a marker or number, in which case it is taken to be
24160 a position in the current buffer and the value of the `invisible' property
24161 is checked; or it can be some other value, which is then presumed to be the
24162 value of the `invisible' property of the text of interest.
24163 The non-nil value returned can be t for truly invisible text or something
24164 else if the text is replaced by an ellipsis. */)
24165 (Lisp_Object pos_or_prop
)
24168 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
24169 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
24171 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
24172 return (invis
== 0 ? Qnil
24174 : make_number (invis
));
24177 /* Calculate a width or height in pixels from a specification using
24178 the following elements:
24181 NUM - a (fractional) multiple of the default font width/height
24182 (NUM) - specifies exactly NUM pixels
24183 UNIT - a fixed number of pixels, see below.
24184 ELEMENT - size of a display element in pixels, see below.
24185 (NUM . SPEC) - equals NUM * SPEC
24186 (+ SPEC SPEC ...) - add pixel values
24187 (- SPEC SPEC ...) - subtract pixel values
24188 (- SPEC) - negate pixel value
24191 INT or FLOAT - a number constant
24192 SYMBOL - use symbol's (buffer local) variable binding.
24195 in - pixels per inch *)
24196 mm - pixels per 1/1000 meter *)
24197 cm - pixels per 1/100 meter *)
24198 width - width of current font in pixels.
24199 height - height of current font in pixels.
24201 *) using the ratio(s) defined in display-pixels-per-inch.
24205 left-fringe - left fringe width in pixels
24206 right-fringe - right fringe width in pixels
24208 left-margin - left margin width in pixels
24209 right-margin - right margin width in pixels
24211 scroll-bar - scroll-bar area width in pixels
24215 Pixels corresponding to 5 inches:
24218 Total width of non-text areas on left side of window (if scroll-bar is on left):
24219 '(space :width (+ left-fringe left-margin scroll-bar))
24221 Align to first text column (in header line):
24222 '(space :align-to 0)
24224 Align to middle of text area minus half the width of variable `my-image'
24225 containing a loaded image:
24226 '(space :align-to (0.5 . (- text my-image)))
24228 Width of left margin minus width of 1 character in the default font:
24229 '(space :width (- left-margin 1))
24231 Width of left margin minus width of 2 characters in the current font:
24232 '(space :width (- left-margin (2 . width)))
24234 Center 1 character over left-margin (in header line):
24235 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
24237 Different ways to express width of left fringe plus left margin minus one pixel:
24238 '(space :width (- (+ left-fringe left-margin) (1)))
24239 '(space :width (+ left-fringe left-margin (- (1))))
24240 '(space :width (+ left-fringe left-margin (-1)))
24245 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
24246 struct font
*font
, bool width_p
, int *align_to
)
24250 # define OK_PIXELS(val) (*res = (val), true)
24251 # define OK_ALIGN_TO(val) (*align_to = (val), true)
24254 return OK_PIXELS (0);
24256 eassert (FRAME_LIVE_P (it
->f
));
24258 if (SYMBOLP (prop
))
24260 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
24262 char *unit
= SSDATA (SYMBOL_NAME (prop
));
24264 if (unit
[0] == 'i' && unit
[1] == 'n')
24266 else if (unit
[0] == 'm' && unit
[1] == 'm')
24268 else if (unit
[0] == 'c' && unit
[1] == 'm')
24274 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
24275 : FRAME_RES_Y (it
->f
));
24278 return OK_PIXELS (ppi
/ pixels
);
24283 #ifdef HAVE_WINDOW_SYSTEM
24284 if (EQ (prop
, Qheight
))
24285 return OK_PIXELS (font
24286 ? normal_char_height (font
, -1)
24287 : FRAME_LINE_HEIGHT (it
->f
));
24288 if (EQ (prop
, Qwidth
))
24289 return OK_PIXELS (font
24290 ? FONT_WIDTH (font
)
24291 : FRAME_COLUMN_WIDTH (it
->f
));
24293 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
24294 return OK_PIXELS (1);
24297 if (EQ (prop
, Qtext
))
24298 return OK_PIXELS (width_p
24299 ? window_box_width (it
->w
, TEXT_AREA
)
24300 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
24302 if (align_to
&& *align_to
< 0)
24305 if (EQ (prop
, Qleft
))
24306 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
24307 if (EQ (prop
, Qright
))
24308 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
24309 if (EQ (prop
, Qcenter
))
24310 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
24311 + window_box_width (it
->w
, TEXT_AREA
) / 2);
24312 if (EQ (prop
, Qleft_fringe
))
24313 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24314 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
24315 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
24316 if (EQ (prop
, Qright_fringe
))
24317 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24318 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24319 : window_box_right_offset (it
->w
, TEXT_AREA
));
24320 if (EQ (prop
, Qleft_margin
))
24321 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
24322 if (EQ (prop
, Qright_margin
))
24323 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
24324 if (EQ (prop
, Qscroll_bar
))
24325 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
24327 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24328 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24329 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24334 if (EQ (prop
, Qleft_fringe
))
24335 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
24336 if (EQ (prop
, Qright_fringe
))
24337 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
24338 if (EQ (prop
, Qleft_margin
))
24339 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
24340 if (EQ (prop
, Qright_margin
))
24341 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
24342 if (EQ (prop
, Qscroll_bar
))
24343 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
24346 prop
= buffer_local_value (prop
, it
->w
->contents
);
24347 if (EQ (prop
, Qunbound
))
24351 if (NUMBERP (prop
))
24353 int base_unit
= (width_p
24354 ? FRAME_COLUMN_WIDTH (it
->f
)
24355 : FRAME_LINE_HEIGHT (it
->f
));
24356 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
24361 Lisp_Object car
= XCAR (prop
);
24362 Lisp_Object cdr
= XCDR (prop
);
24366 #ifdef HAVE_WINDOW_SYSTEM
24367 if (FRAME_WINDOW_P (it
->f
)
24368 && valid_image_p (prop
))
24370 ptrdiff_t id
= lookup_image (it
->f
, prop
);
24371 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
24373 return OK_PIXELS (width_p
? img
->width
: img
->height
);
24375 if (FRAME_WINDOW_P (it
->f
) && valid_xwidget_spec_p (prop
))
24377 // TODO: Don't return dummy size.
24378 return OK_PIXELS (100);
24381 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
24387 while (CONSP (cdr
))
24389 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
24390 font
, width_p
, align_to
))
24393 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= false;
24398 if (EQ (car
, Qminus
))
24400 return OK_PIXELS (pixels
);
24403 car
= buffer_local_value (car
, it
->w
->contents
);
24404 if (EQ (car
, Qunbound
))
24411 pixels
= XFLOATINT (car
);
24413 return OK_PIXELS (pixels
);
24414 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
24415 font
, width_p
, align_to
))
24416 return OK_PIXELS (pixels
* fact
);
24427 get_font_ascent_descent (struct font
*font
, int *ascent
, int *descent
)
24429 #ifdef HAVE_WINDOW_SYSTEM
24430 normal_char_ascent_descent (font
, -1, ascent
, descent
);
24438 /***********************************************************************
24440 ***********************************************************************/
24442 #ifdef HAVE_WINDOW_SYSTEM
24447 dump_glyph_string (struct glyph_string
*s
)
24449 fprintf (stderr
, "glyph string\n");
24450 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
24451 s
->x
, s
->y
, s
->width
, s
->height
);
24452 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
24453 fprintf (stderr
, " hl = %d\n", s
->hl
);
24454 fprintf (stderr
, " left overhang = %d, right = %d\n",
24455 s
->left_overhang
, s
->right_overhang
);
24456 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
24457 fprintf (stderr
, " extends to end of line = %d\n",
24458 s
->extends_to_end_of_line_p
);
24459 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
24460 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
24463 #endif /* GLYPH_DEBUG */
24465 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
24466 of XChar2b structures for S; it can't be allocated in
24467 init_glyph_string because it must be allocated via `alloca'. W
24468 is the window on which S is drawn. ROW and AREA are the glyph row
24469 and area within the row from which S is constructed. START is the
24470 index of the first glyph structure covered by S. HL is a
24471 face-override for drawing S. */
24474 #define OPTIONAL_HDC(hdc) HDC hdc,
24475 #define DECLARE_HDC(hdc) HDC hdc;
24476 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
24477 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
24480 #ifndef OPTIONAL_HDC
24481 #define OPTIONAL_HDC(hdc)
24482 #define DECLARE_HDC(hdc)
24483 #define ALLOCATE_HDC(hdc, f)
24484 #define RELEASE_HDC(hdc, f)
24488 init_glyph_string (struct glyph_string
*s
,
24490 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
24491 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
24493 memset (s
, 0, sizeof *s
);
24495 s
->f
= XFRAME (w
->frame
);
24499 s
->display
= FRAME_X_DISPLAY (s
->f
);
24500 s
->window
= FRAME_X_WINDOW (s
->f
);
24501 s
->char2b
= char2b
;
24505 s
->first_glyph
= row
->glyphs
[area
] + start
;
24506 s
->height
= row
->height
;
24507 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
24508 s
->ybase
= s
->y
+ row
->ascent
;
24512 /* Append the list of glyph strings with head H and tail T to the list
24513 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
24516 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24517 struct glyph_string
*h
, struct glyph_string
*t
)
24531 /* Prepend the list of glyph strings with head H and tail T to the
24532 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
24536 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24537 struct glyph_string
*h
, struct glyph_string
*t
)
24551 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
24552 Set *HEAD and *TAIL to the resulting list. */
24555 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
24556 struct glyph_string
*s
)
24558 s
->next
= s
->prev
= NULL
;
24559 append_glyph_string_lists (head
, tail
, s
, s
);
24563 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24564 The encoding of C is returned in *CHAR2B. DISPLAY_P means
24565 make sure that X resources for the face returned are allocated.
24566 Value is a pointer to a realized face that is ready for display if
24569 static struct face
*
24570 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
24571 XChar2b
*char2b
, bool display_p
)
24573 struct face
*face
= FACE_FROM_ID (f
, face_id
);
24578 code
= face
->font
->driver
->encode_char (face
->font
, c
);
24580 if (code
== FONT_INVALID_CODE
)
24583 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24585 /* Make sure X resources of the face are allocated. */
24586 #ifdef HAVE_X_WINDOWS
24590 eassert (face
!= NULL
);
24591 prepare_face_for_display (f
, face
);
24598 /* Get face and two-byte form of character glyph GLYPH on frame F.
24599 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24600 a pointer to a realized face that is ready for display. */
24602 static struct face
*
24603 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24609 eassert (glyph
->type
== CHAR_GLYPH
);
24610 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24612 /* Make sure X resources of the face are allocated. */
24613 prepare_face_for_display (f
, face
);
24617 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24618 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24620 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24622 if (code
== FONT_INVALID_CODE
)
24626 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24631 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24632 Return true iff FONT has a glyph for C. */
24635 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24639 if (CHAR_BYTE8_P (c
))
24640 code
= CHAR_TO_BYTE8 (c
);
24642 code
= font
->driver
->encode_char (font
, c
);
24644 if (code
== FONT_INVALID_CODE
)
24646 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24651 /* Fill glyph string S with composition components specified by S->cmp.
24653 BASE_FACE is the base face of the composition.
24654 S->cmp_from is the index of the first component for S.
24656 OVERLAPS non-zero means S should draw the foreground only, and use
24657 its physical height for clipping. See also draw_glyphs.
24659 Value is the index of a component not in S. */
24662 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24666 /* For all glyphs of this composition, starting at the offset
24667 S->cmp_from, until we reach the end of the definition or encounter a
24668 glyph that requires the different face, add it to S. */
24673 s
->for_overlaps
= overlaps
;
24676 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24678 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24680 /* TAB in a composition means display glyphs with padding space
24681 on the left or right. */
24684 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24687 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24688 s
->char2b
+ i
, true);
24694 s
->font
= s
->face
->font
;
24696 else if (s
->face
!= face
)
24704 if (s
->face
== NULL
)
24706 s
->face
= base_face
->ascii_face
;
24707 s
->font
= s
->face
->font
;
24710 /* All glyph strings for the same composition has the same width,
24711 i.e. the width set for the first component of the composition. */
24712 s
->width
= s
->first_glyph
->pixel_width
;
24714 /* If the specified font could not be loaded, use the frame's
24715 default font, but record the fact that we couldn't load it in
24716 the glyph string so that we can draw rectangles for the
24717 characters of the glyph string. */
24718 if (s
->font
== NULL
)
24720 s
->font_not_found_p
= true;
24721 s
->font
= FRAME_FONT (s
->f
);
24724 /* Adjust base line for subscript/superscript text. */
24725 s
->ybase
+= s
->first_glyph
->voffset
;
24731 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24732 int start
, int end
, int overlaps
)
24734 struct glyph
*glyph
, *last
;
24735 Lisp_Object lgstring
;
24738 s
->for_overlaps
= overlaps
;
24739 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24740 last
= s
->row
->glyphs
[s
->area
] + end
;
24741 s
->cmp_id
= glyph
->u
.cmp
.id
;
24742 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24743 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24744 s
->face
= FACE_OPT_FROM_ID (s
->f
, face_id
);
24745 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24746 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24748 while (glyph
< last
24749 && glyph
->u
.cmp
.automatic
24750 && glyph
->u
.cmp
.id
== s
->cmp_id
24751 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24752 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24754 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24756 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24757 unsigned code
= LGLYPH_CODE (lglyph
);
24759 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24761 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24762 return glyph
- s
->row
->glyphs
[s
->area
];
24766 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24767 See the comment of fill_glyph_string for arguments.
24768 Value is the index of the first glyph not in S. */
24772 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24773 int start
, int end
, int overlaps
)
24775 struct glyph
*glyph
, *last
;
24778 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24779 s
->for_overlaps
= overlaps
;
24780 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24781 last
= s
->row
->glyphs
[s
->area
] + end
;
24782 voffset
= glyph
->voffset
;
24783 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24784 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24786 s
->width
= glyph
->pixel_width
;
24788 while (glyph
< last
24789 && glyph
->type
== GLYPHLESS_GLYPH
24790 && glyph
->voffset
== voffset
24791 && glyph
->face_id
== face_id
)
24794 s
->width
+= glyph
->pixel_width
;
24797 s
->ybase
+= voffset
;
24798 return glyph
- s
->row
->glyphs
[s
->area
];
24802 /* Fill glyph string S from a sequence of character glyphs.
24804 FACE_ID is the face id of the string. START is the index of the
24805 first glyph to consider, END is the index of the last + 1.
24806 OVERLAPS non-zero means S should draw the foreground only, and use
24807 its physical height for clipping. See also draw_glyphs.
24809 Value is the index of the first glyph not in S. */
24812 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24813 int start
, int end
, int overlaps
)
24815 struct glyph
*glyph
, *last
;
24817 bool glyph_not_available_p
;
24819 eassert (s
->f
== XFRAME (s
->w
->frame
));
24820 eassert (s
->nchars
== 0);
24821 eassert (start
>= 0 && end
> start
);
24823 s
->for_overlaps
= overlaps
;
24824 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24825 last
= s
->row
->glyphs
[s
->area
] + end
;
24826 voffset
= glyph
->voffset
;
24827 s
->padding_p
= glyph
->padding_p
;
24828 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24830 while (glyph
< last
24831 && glyph
->type
== CHAR_GLYPH
24832 && glyph
->voffset
== voffset
24833 /* Same face id implies same font, nowadays. */
24834 && glyph
->face_id
== face_id
24835 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24837 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24838 s
->char2b
+ s
->nchars
);
24840 eassert (s
->nchars
<= end
- start
);
24841 s
->width
+= glyph
->pixel_width
;
24842 if (glyph
++->padding_p
!= s
->padding_p
)
24846 s
->font
= s
->face
->font
;
24848 /* If the specified font could not be loaded, use the frame's font,
24849 but record the fact that we couldn't load it in
24850 S->font_not_found_p so that we can draw rectangles for the
24851 characters of the glyph string. */
24852 if (s
->font
== NULL
|| glyph_not_available_p
)
24854 s
->font_not_found_p
= true;
24855 s
->font
= FRAME_FONT (s
->f
);
24858 /* Adjust base line for subscript/superscript text. */
24859 s
->ybase
+= voffset
;
24861 eassert (s
->face
&& s
->face
->gc
);
24862 return glyph
- s
->row
->glyphs
[s
->area
];
24866 /* Fill glyph string S from image glyph S->first_glyph. */
24869 fill_image_glyph_string (struct glyph_string
*s
)
24871 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24872 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24873 s
->slice
= s
->first_glyph
->slice
.img
;
24874 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24875 s
->font
= s
->face
->font
;
24876 s
->width
= s
->first_glyph
->pixel_width
;
24878 /* Adjust base line for subscript/superscript text. */
24879 s
->ybase
+= s
->first_glyph
->voffset
;
24883 #ifdef HAVE_XWIDGETS
24885 fill_xwidget_glyph_string (struct glyph_string
*s
)
24887 eassert (s
->first_glyph
->type
== XWIDGET_GLYPH
);
24888 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24889 s
->font
= s
->face
->font
;
24890 s
->width
= s
->first_glyph
->pixel_width
;
24891 s
->ybase
+= s
->first_glyph
->voffset
;
24892 s
->xwidget
= s
->first_glyph
->u
.xwidget
;
24895 /* Fill glyph string S from a sequence of stretch glyphs.
24897 START is the index of the first glyph to consider,
24898 END is the index of the last + 1.
24900 Value is the index of the first glyph not in S. */
24903 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24905 struct glyph
*glyph
, *last
;
24906 int voffset
, face_id
;
24908 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24910 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24911 last
= s
->row
->glyphs
[s
->area
] + end
;
24912 face_id
= glyph
->face_id
;
24913 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24914 s
->font
= s
->face
->font
;
24915 s
->width
= glyph
->pixel_width
;
24917 voffset
= glyph
->voffset
;
24921 && glyph
->type
== STRETCH_GLYPH
24922 && glyph
->voffset
== voffset
24923 && glyph
->face_id
== face_id
);
24925 s
->width
+= glyph
->pixel_width
;
24927 /* Adjust base line for subscript/superscript text. */
24928 s
->ybase
+= voffset
;
24930 /* The case that face->gc == 0 is handled when drawing the glyph
24931 string by calling prepare_face_for_display. */
24933 return glyph
- s
->row
->glyphs
[s
->area
];
24936 static struct font_metrics
*
24937 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24939 static struct font_metrics metrics
;
24944 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24945 if (code
== FONT_INVALID_CODE
)
24947 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24951 /* A subroutine that computes "normal" values of ASCENT and DESCENT
24952 for FONT. Values are taken from font-global ones, except for fonts
24953 that claim preposterously large values, but whose glyphs actually
24954 have reasonable dimensions. C is the character to use for metrics
24955 if the font-global values are too large; if C is negative, the
24956 function selects a default character. */
24958 normal_char_ascent_descent (struct font
*font
, int c
, int *ascent
, int *descent
)
24960 *ascent
= FONT_BASE (font
);
24961 *descent
= FONT_DESCENT (font
);
24963 if (FONT_TOO_HIGH (font
))
24967 /* Get metrics of C, defaulting to a reasonably sized ASCII
24969 if (get_char_glyph_code (c
>= 0 ? c
: '{', font
, &char2b
))
24971 struct font_metrics
*pcm
= get_per_char_metric (font
, &char2b
);
24973 if (!(pcm
->width
== 0 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0))
24975 /* We add 1 pixel to character dimensions as heuristics
24976 that produces nicer display, e.g. when the face has
24977 the box attribute. */
24978 *ascent
= pcm
->ascent
+ 1;
24979 *descent
= pcm
->descent
+ 1;
24985 /* A subroutine that computes a reasonable "normal character height"
24986 for fonts that claim preposterously large vertical dimensions, but
24987 whose glyphs are actually reasonably sized. C is the character
24988 whose metrics to use for those fonts, or -1 for default
24991 normal_char_height (struct font
*font
, int c
)
24993 int ascent
, descent
;
24995 normal_char_ascent_descent (font
, c
, &ascent
, &descent
);
24997 return ascent
+ descent
;
25001 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
25002 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
25003 assumed to be zero. */
25006 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
25008 *left
= *right
= 0;
25010 if (glyph
->type
== CHAR_GLYPH
)
25013 struct face
*face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
);
25016 struct font_metrics
*pcm
= get_per_char_metric (face
->font
, &char2b
);
25019 if (pcm
->rbearing
> pcm
->width
)
25020 *right
= pcm
->rbearing
- pcm
->width
;
25021 if (pcm
->lbearing
< 0)
25022 *left
= -pcm
->lbearing
;
25026 else if (glyph
->type
== COMPOSITE_GLYPH
)
25028 if (! glyph
->u
.cmp
.automatic
)
25030 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
25032 if (cmp
->rbearing
> cmp
->pixel_width
)
25033 *right
= cmp
->rbearing
- cmp
->pixel_width
;
25034 if (cmp
->lbearing
< 0)
25035 *left
= - cmp
->lbearing
;
25039 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
25040 struct font_metrics metrics
;
25042 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
25043 glyph
->slice
.cmp
.to
+ 1, &metrics
);
25044 if (metrics
.rbearing
> metrics
.width
)
25045 *right
= metrics
.rbearing
- metrics
.width
;
25046 if (metrics
.lbearing
< 0)
25047 *left
= - metrics
.lbearing
;
25053 /* Return the index of the first glyph preceding glyph string S that
25054 is overwritten by S because of S's left overhang. Value is -1
25055 if no glyphs are overwritten. */
25058 left_overwritten (struct glyph_string
*s
)
25062 if (s
->left_overhang
)
25065 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25066 int first
= s
->first_glyph
- glyphs
;
25068 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
25069 x
-= glyphs
[i
].pixel_width
;
25080 /* Return the index of the first glyph preceding glyph string S that
25081 is overwriting S because of its right overhang. Value is -1 if no
25082 glyph in front of S overwrites S. */
25085 left_overwriting (struct glyph_string
*s
)
25088 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25089 int first
= s
->first_glyph
- glyphs
;
25093 for (i
= first
- 1; i
>= 0; --i
)
25096 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
25099 x
-= glyphs
[i
].pixel_width
;
25106 /* Return the index of the last glyph following glyph string S that is
25107 overwritten by S because of S's right overhang. Value is -1 if
25108 no such glyph is found. */
25111 right_overwritten (struct glyph_string
*s
)
25115 if (s
->right_overhang
)
25118 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25119 int first
= (s
->first_glyph
- glyphs
25120 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
25121 int end
= s
->row
->used
[s
->area
];
25123 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
25124 x
+= glyphs
[i
].pixel_width
;
25133 /* Return the index of the last glyph following glyph string S that
25134 overwrites S because of its left overhang. Value is negative
25135 if no such glyph is found. */
25138 right_overwriting (struct glyph_string
*s
)
25141 int end
= s
->row
->used
[s
->area
];
25142 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25143 int first
= (s
->first_glyph
- glyphs
25144 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
25148 for (i
= first
; i
< end
; ++i
)
25151 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
25154 x
+= glyphs
[i
].pixel_width
;
25161 /* Set background width of glyph string S. START is the index of the
25162 first glyph following S. LAST_X is the right-most x-position + 1
25163 in the drawing area. */
25166 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
25168 /* If the face of this glyph string has to be drawn to the end of
25169 the drawing area, set S->extends_to_end_of_line_p. */
25171 if (start
== s
->row
->used
[s
->area
]
25172 && ((s
->row
->fill_line_p
25173 && (s
->hl
== DRAW_NORMAL_TEXT
25174 || s
->hl
== DRAW_IMAGE_RAISED
25175 || s
->hl
== DRAW_IMAGE_SUNKEN
))
25176 || s
->hl
== DRAW_MOUSE_FACE
))
25177 s
->extends_to_end_of_line_p
= true;
25179 /* If S extends its face to the end of the line, set its
25180 background_width to the distance to the right edge of the drawing
25182 if (s
->extends_to_end_of_line_p
)
25183 s
->background_width
= last_x
- s
->x
+ 1;
25185 s
->background_width
= s
->width
;
25189 /* Compute overhangs and x-positions for glyph string S and its
25190 predecessors, or successors. X is the starting x-position for S.
25191 BACKWARD_P means process predecessors. */
25194 compute_overhangs_and_x (struct glyph_string
*s
, int x
, bool backward_p
)
25200 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
25201 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
25211 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
25212 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
25222 /* The following macros are only called from draw_glyphs below.
25223 They reference the following parameters of that function directly:
25224 `w', `row', `area', and `overlap_p'
25225 as well as the following local variables:
25226 `s', `f', and `hdc' (in W32) */
25229 /* On W32, silently add local `hdc' variable to argument list of
25230 init_glyph_string. */
25231 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
25232 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
25234 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
25235 init_glyph_string (s, char2b, w, row, area, start, hl)
25238 /* Add a glyph string for a stretch glyph to the list of strings
25239 between HEAD and TAIL. START is the index of the stretch glyph in
25240 row area AREA of glyph row ROW. END is the index of the last glyph
25241 in that glyph row area. X is the current output position assigned
25242 to the new glyph string constructed. HL overrides that face of the
25243 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25244 is the right-most x-position of the drawing area. */
25246 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
25247 and below -- keep them on one line. */
25248 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25251 s = alloca (sizeof *s); \
25252 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25253 START = fill_stretch_glyph_string (s, START, END); \
25254 append_glyph_string (&HEAD, &TAIL, s); \
25260 /* Add a glyph string for an image glyph to the list of strings
25261 between HEAD and TAIL. START is the index of the image glyph in
25262 row area AREA of glyph row ROW. END is the index of the last glyph
25263 in that glyph row area. X is the current output position assigned
25264 to the new glyph string constructed. HL overrides that face of the
25265 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25266 is the right-most x-position of the drawing area. */
25268 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25271 s = alloca (sizeof *s); \
25272 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25273 fill_image_glyph_string (s); \
25274 append_glyph_string (&HEAD, &TAIL, s); \
25280 #ifndef HAVE_XWIDGETS
25281 # define BUILD_XWIDGET_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25284 # define BUILD_XWIDGET_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25287 s = alloca (sizeof *s); \
25288 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25289 fill_xwidget_glyph_string (s); \
25290 append_glyph_string (&(HEAD), &(TAIL), s); \
25297 /* Add a glyph string for a sequence of character glyphs to the list
25298 of strings between HEAD and TAIL. START is the index of the first
25299 glyph in row area AREA of glyph row ROW that is part of the new
25300 glyph string. END is the index of the last glyph in that glyph row
25301 area. X is the current output position assigned to the new glyph
25302 string constructed. HL overrides that face of the glyph; e.g. it
25303 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
25304 right-most x-position of the drawing area. */
25306 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25312 face_id = (row)->glyphs[area][START].face_id; \
25314 s = alloca (sizeof *s); \
25315 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
25316 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25317 append_glyph_string (&HEAD, &TAIL, s); \
25319 START = fill_glyph_string (s, face_id, START, END, overlaps); \
25324 /* Add a glyph string for a composite sequence to the list of strings
25325 between HEAD and TAIL. START is the index of the first glyph in
25326 row area AREA of glyph row ROW that is part of the new glyph
25327 string. END is the index of the last glyph in that glyph row area.
25328 X is the current output position assigned to the new glyph string
25329 constructed. HL overrides that face of the glyph; e.g. it is
25330 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
25331 x-position of the drawing area. */
25333 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25335 int face_id = (row)->glyphs[area][START].face_id; \
25336 struct face *base_face = FACE_OPT_FROM_ID (f, face_id); \
25337 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
25338 struct composition *cmp = composition_table[cmp_id]; \
25340 struct glyph_string *first_s = NULL; \
25343 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
25345 /* Make glyph_strings for each glyph sequence that is drawable by \
25346 the same face, and append them to HEAD/TAIL. */ \
25347 for (n = 0; n < cmp->glyph_len;) \
25349 s = alloca (sizeof *s); \
25350 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25351 append_glyph_string (&(HEAD), &(TAIL), s); \
25357 n = fill_composite_glyph_string (s, base_face, overlaps); \
25365 /* Add a glyph string for a glyph-string sequence to the list of strings
25366 between HEAD and TAIL. */
25368 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25372 Lisp_Object gstring; \
25374 face_id = (row)->glyphs[area][START].face_id; \
25375 gstring = (composition_gstring_from_id \
25376 ((row)->glyphs[area][START].u.cmp.id)); \
25377 s = alloca (sizeof *s); \
25378 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
25379 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25380 append_glyph_string (&(HEAD), &(TAIL), s); \
25382 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
25386 /* Add a glyph string for a sequence of glyphless character's glyphs
25387 to the list of strings between HEAD and TAIL. The meanings of
25388 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
25390 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25395 face_id = (row)->glyphs[area][START].face_id; \
25397 s = alloca (sizeof *s); \
25398 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25399 append_glyph_string (&HEAD, &TAIL, s); \
25401 START = fill_glyphless_glyph_string (s, face_id, START, END, \
25407 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
25408 of AREA of glyph row ROW on window W between indices START and END.
25409 HL overrides the face for drawing glyph strings, e.g. it is
25410 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
25411 x-positions of the drawing area.
25413 This is an ugly monster macro construct because we must use alloca
25414 to allocate glyph strings (because draw_glyphs can be called
25415 asynchronously). */
25417 #define BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25420 HEAD = TAIL = NULL; \
25421 while (START < END) \
25423 struct glyph *first_glyph = (row)->glyphs[area] + START; \
25424 switch (first_glyph->type) \
25427 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
25431 case COMPOSITE_GLYPH: \
25432 if (first_glyph->u.cmp.automatic) \
25433 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
25436 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
25440 case STRETCH_GLYPH: \
25441 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
25445 case IMAGE_GLYPH: \
25446 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
25450 #define BUILD_GLYPH_STRINGS_XW(START, END, HEAD, TAIL, HL, X, LAST_X) \
25451 case XWIDGET_GLYPH: \
25452 BUILD_XWIDGET_GLYPH_STRING (START, END, HEAD, TAIL, \
25456 #define BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X) \
25457 case GLYPHLESS_GLYPH: \
25458 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
25468 set_glyph_string_background_width (s, START, LAST_X); \
25475 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25476 BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25477 BUILD_GLYPH_STRINGS_XW(START, END, HEAD, TAIL, HL, X, LAST_X) \
25478 BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X)
25481 /* Draw glyphs between START and END in AREA of ROW on window W,
25482 starting at x-position X. X is relative to AREA in W. HL is a
25483 face-override with the following meaning:
25485 DRAW_NORMAL_TEXT draw normally
25486 DRAW_CURSOR draw in cursor face
25487 DRAW_MOUSE_FACE draw in mouse face.
25488 DRAW_INVERSE_VIDEO draw in mode line face
25489 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
25490 DRAW_IMAGE_RAISED draw an image with a raised relief around it
25492 If OVERLAPS is non-zero, draw only the foreground of characters and
25493 clip to the physical height of ROW. Non-zero value also defines
25494 the overlapping part to be drawn:
25496 OVERLAPS_PRED overlap with preceding rows
25497 OVERLAPS_SUCC overlap with succeeding rows
25498 OVERLAPS_BOTH overlap with both preceding/succeeding rows
25499 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
25501 Value is the x-position reached, relative to AREA of W. */
25504 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
25505 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
25506 enum draw_glyphs_face hl
, int overlaps
)
25508 struct glyph_string
*head
, *tail
;
25509 struct glyph_string
*s
;
25510 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
25511 int i
, j
, x_reached
, last_x
, area_left
= 0;
25512 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25515 ALLOCATE_HDC (hdc
, f
);
25517 /* Let's rather be paranoid than getting a SEGV. */
25518 end
= min (end
, row
->used
[area
]);
25519 start
= clip_to_bounds (0, start
, end
);
25521 /* Translate X to frame coordinates. Set last_x to the right
25522 end of the drawing area. */
25523 if (row
->full_width_p
)
25525 /* X is relative to the left edge of W, without scroll bars
25527 area_left
= WINDOW_LEFT_EDGE_X (w
);
25528 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
25529 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
25533 area_left
= window_box_left (w
, area
);
25534 last_x
= area_left
+ window_box_width (w
, area
);
25538 /* Build a doubly-linked list of glyph_string structures between
25539 head and tail from what we have to draw. Note that the macro
25540 BUILD_GLYPH_STRINGS will modify its start parameter. That's
25541 the reason we use a separate variable `i'. */
25544 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
25546 x_reached
= tail
->x
+ tail
->background_width
;
25550 /* If there are any glyphs with lbearing < 0 or rbearing > width in
25551 the row, redraw some glyphs in front or following the glyph
25552 strings built above. */
25553 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
25555 struct glyph_string
*h
, *t
;
25556 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25557 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
25558 bool check_mouse_face
= false;
25561 /* If mouse highlighting is on, we may need to draw adjacent
25562 glyphs using mouse-face highlighting. */
25563 if (area
== TEXT_AREA
&& row
->mouse_face_p
25564 && hlinfo
->mouse_face_beg_row
>= 0
25565 && hlinfo
->mouse_face_end_row
>= 0)
25567 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
25569 if (row_vpos
>= hlinfo
->mouse_face_beg_row
25570 && row_vpos
<= hlinfo
->mouse_face_end_row
)
25572 check_mouse_face
= true;
25573 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
25574 ? hlinfo
->mouse_face_beg_col
: 0;
25575 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
25576 ? hlinfo
->mouse_face_end_col
25577 : row
->used
[TEXT_AREA
];
25581 /* Compute overhangs for all glyph strings. */
25582 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
25583 for (s
= head
; s
; s
= s
->next
)
25584 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
25586 /* Prepend glyph strings for glyphs in front of the first glyph
25587 string that are overwritten because of the first glyph
25588 string's left overhang. The background of all strings
25589 prepended must be drawn because the first glyph string
25591 i
= left_overwritten (head
);
25594 enum draw_glyphs_face overlap_hl
;
25596 /* If this row contains mouse highlighting, attempt to draw
25597 the overlapped glyphs with the correct highlight. This
25598 code fails if the overlap encompasses more than one glyph
25599 and mouse-highlight spans only some of these glyphs.
25600 However, making it work perfectly involves a lot more
25601 code, and I don't know if the pathological case occurs in
25602 practice, so we'll stick to this for now. --- cyd */
25603 if (check_mouse_face
25604 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25605 overlap_hl
= DRAW_MOUSE_FACE
;
25607 overlap_hl
= DRAW_NORMAL_TEXT
;
25609 if (hl
!= overlap_hl
)
25612 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
25613 overlap_hl
, dummy_x
, last_x
);
25615 compute_overhangs_and_x (t
, head
->x
, true);
25616 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25617 if (clip_head
== NULL
)
25621 /* Prepend glyph strings for glyphs in front of the first glyph
25622 string that overwrite that glyph string because of their
25623 right overhang. For these strings, only the foreground must
25624 be drawn, because it draws over the glyph string at `head'.
25625 The background must not be drawn because this would overwrite
25626 right overhangs of preceding glyphs for which no glyph
25628 i
= left_overwriting (head
);
25631 enum draw_glyphs_face overlap_hl
;
25633 if (check_mouse_face
25634 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25635 overlap_hl
= DRAW_MOUSE_FACE
;
25637 overlap_hl
= DRAW_NORMAL_TEXT
;
25639 if (hl
== overlap_hl
|| clip_head
== NULL
)
25641 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
25642 overlap_hl
, dummy_x
, last_x
);
25643 for (s
= h
; s
; s
= s
->next
)
25644 s
->background_filled_p
= true;
25645 compute_overhangs_and_x (t
, head
->x
, true);
25646 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25649 /* Append glyphs strings for glyphs following the last glyph
25650 string tail that are overwritten by tail. The background of
25651 these strings has to be drawn because tail's foreground draws
25653 i
= right_overwritten (tail
);
25656 enum draw_glyphs_face overlap_hl
;
25658 if (check_mouse_face
25659 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25660 overlap_hl
= DRAW_MOUSE_FACE
;
25662 overlap_hl
= DRAW_NORMAL_TEXT
;
25664 if (hl
!= overlap_hl
)
25666 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25667 overlap_hl
, x
, last_x
);
25668 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25669 we don't have `end = i;' here. */
25670 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25671 append_glyph_string_lists (&head
, &tail
, h
, t
);
25672 if (clip_tail
== NULL
)
25676 /* Append glyph strings for glyphs following the last glyph
25677 string tail that overwrite tail. The foreground of such
25678 glyphs has to be drawn because it writes into the background
25679 of tail. The background must not be drawn because it could
25680 paint over the foreground of following glyphs. */
25681 i
= right_overwriting (tail
);
25684 enum draw_glyphs_face overlap_hl
;
25685 if (check_mouse_face
25686 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25687 overlap_hl
= DRAW_MOUSE_FACE
;
25689 overlap_hl
= DRAW_NORMAL_TEXT
;
25691 if (hl
== overlap_hl
|| clip_tail
== NULL
)
25693 i
++; /* We must include the Ith glyph. */
25694 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25695 overlap_hl
, x
, last_x
);
25696 for (s
= h
; s
; s
= s
->next
)
25697 s
->background_filled_p
= true;
25698 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25699 append_glyph_string_lists (&head
, &tail
, h
, t
);
25701 if (clip_head
|| clip_tail
)
25702 for (s
= head
; s
; s
= s
->next
)
25704 s
->clip_head
= clip_head
;
25705 s
->clip_tail
= clip_tail
;
25709 /* Draw all strings. */
25710 for (s
= head
; s
; s
= s
->next
)
25711 FRAME_RIF (f
)->draw_glyph_string (s
);
25714 /* When focus a sole frame and move horizontally, this clears on_p
25715 causing a failure to erase prev cursor position. */
25716 if (area
== TEXT_AREA
25717 && !row
->full_width_p
25718 /* When drawing overlapping rows, only the glyph strings'
25719 foreground is drawn, which doesn't erase a cursor
25723 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25724 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25725 : (tail
? tail
->x
+ tail
->background_width
: x
));
25729 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25730 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25734 /* Value is the x-position up to which drawn, relative to AREA of W.
25735 This doesn't include parts drawn because of overhangs. */
25736 if (row
->full_width_p
)
25737 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25739 x_reached
-= area_left
;
25741 RELEASE_HDC (hdc
, f
);
25747 /* Expand row matrix if too narrow. Don't expand if area
25750 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25752 if (!it->f->fonts_changed \
25753 && (it->glyph_row->glyphs[area] \
25754 < it->glyph_row->glyphs[area + 1])) \
25756 it->w->ncols_scale_factor++; \
25757 it->f->fonts_changed = true; \
25761 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25762 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25765 append_glyph (struct it
*it
)
25767 struct glyph
*glyph
;
25768 enum glyph_row_area area
= it
->area
;
25770 eassert (it
->glyph_row
);
25771 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25773 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25774 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25776 /* If the glyph row is reversed, we need to prepend the glyph
25777 rather than append it. */
25778 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25782 /* Make room for the additional glyph. */
25783 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25785 glyph
= it
->glyph_row
->glyphs
[area
];
25787 glyph
->charpos
= CHARPOS (it
->position
);
25788 glyph
->object
= it
->object
;
25789 if (it
->pixel_width
> 0)
25791 eassert (it
->pixel_width
<= SHRT_MAX
);
25792 glyph
->pixel_width
= it
->pixel_width
;
25793 glyph
->padding_p
= false;
25797 /* Assure at least 1-pixel width. Otherwise, cursor can't
25798 be displayed correctly. */
25799 glyph
->pixel_width
= 1;
25800 glyph
->padding_p
= true;
25802 glyph
->ascent
= it
->ascent
;
25803 glyph
->descent
= it
->descent
;
25804 glyph
->voffset
= it
->voffset
;
25805 glyph
->type
= CHAR_GLYPH
;
25806 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25807 glyph
->multibyte_p
= it
->multibyte_p
;
25808 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25810 /* In R2L rows, the left and the right box edges need to be
25811 drawn in reverse direction. */
25812 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25813 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25817 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25818 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25820 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25821 || it
->phys_descent
> it
->descent
);
25822 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25823 glyph
->face_id
= it
->face_id
;
25824 glyph
->u
.ch
= it
->char_to_display
;
25825 glyph
->slice
.img
= null_glyph_slice
;
25826 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25829 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25830 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25831 glyph
->bidi_type
= it
->bidi_it
.type
;
25835 glyph
->resolved_level
= 0;
25836 glyph
->bidi_type
= UNKNOWN_BT
;
25838 ++it
->glyph_row
->used
[area
];
25841 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25844 /* Store one glyph for the composition IT->cmp_it.id in
25845 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25849 append_composite_glyph (struct it
*it
)
25851 struct glyph
*glyph
;
25852 enum glyph_row_area area
= it
->area
;
25854 eassert (it
->glyph_row
);
25856 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25857 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25859 /* If the glyph row is reversed, we need to prepend the glyph
25860 rather than append it. */
25861 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25865 /* Make room for the new glyph. */
25866 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25868 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25870 glyph
->charpos
= it
->cmp_it
.charpos
;
25871 glyph
->object
= it
->object
;
25872 eassert (it
->pixel_width
<= SHRT_MAX
);
25873 glyph
->pixel_width
= it
->pixel_width
;
25874 glyph
->ascent
= it
->ascent
;
25875 glyph
->descent
= it
->descent
;
25876 glyph
->voffset
= it
->voffset
;
25877 glyph
->type
= COMPOSITE_GLYPH
;
25878 if (it
->cmp_it
.ch
< 0)
25880 glyph
->u
.cmp
.automatic
= false;
25881 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25882 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25886 glyph
->u
.cmp
.automatic
= true;
25887 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25888 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25889 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25891 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25892 glyph
->multibyte_p
= it
->multibyte_p
;
25893 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25895 /* In R2L rows, the left and the right box edges need to be
25896 drawn in reverse direction. */
25897 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25898 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25902 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25903 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25905 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25906 || it
->phys_descent
> it
->descent
);
25907 glyph
->padding_p
= false;
25908 glyph
->glyph_not_available_p
= false;
25909 glyph
->face_id
= it
->face_id
;
25910 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25913 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25914 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25915 glyph
->bidi_type
= it
->bidi_it
.type
;
25917 ++it
->glyph_row
->used
[area
];
25920 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25924 /* Change IT->ascent and IT->height according to the setting of
25928 take_vertical_position_into_account (struct it
*it
)
25932 if (it
->voffset
< 0)
25933 /* Increase the ascent so that we can display the text higher
25935 it
->ascent
-= it
->voffset
;
25937 /* Increase the descent so that we can display the text lower
25939 it
->descent
+= it
->voffset
;
25944 /* Produce glyphs/get display metrics for the image IT is loaded with.
25945 See the description of struct display_iterator in dispextern.h for
25946 an overview of struct display_iterator. */
25949 produce_image_glyph (struct it
*it
)
25953 int glyph_ascent
, crop
;
25954 struct glyph_slice slice
;
25956 eassert (it
->what
== IT_IMAGE
);
25958 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25959 /* Make sure X resources of the face is loaded. */
25960 prepare_face_for_display (it
->f
, face
);
25962 if (it
->image_id
< 0)
25964 /* Fringe bitmap. */
25965 it
->ascent
= it
->phys_ascent
= 0;
25966 it
->descent
= it
->phys_descent
= 0;
25967 it
->pixel_width
= 0;
25972 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25973 /* Make sure X resources of the image is loaded. */
25974 prepare_image_for_display (it
->f
, img
);
25976 slice
.x
= slice
.y
= 0;
25977 slice
.width
= img
->width
;
25978 slice
.height
= img
->height
;
25980 if (INTEGERP (it
->slice
.x
))
25981 slice
.x
= XINT (it
->slice
.x
);
25982 else if (FLOATP (it
->slice
.x
))
25983 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25985 if (INTEGERP (it
->slice
.y
))
25986 slice
.y
= XINT (it
->slice
.y
);
25987 else if (FLOATP (it
->slice
.y
))
25988 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25990 if (INTEGERP (it
->slice
.width
))
25991 slice
.width
= XINT (it
->slice
.width
);
25992 else if (FLOATP (it
->slice
.width
))
25993 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25995 if (INTEGERP (it
->slice
.height
))
25996 slice
.height
= XINT (it
->slice
.height
);
25997 else if (FLOATP (it
->slice
.height
))
25998 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
26000 if (slice
.x
>= img
->width
)
26001 slice
.x
= img
->width
;
26002 if (slice
.y
>= img
->height
)
26003 slice
.y
= img
->height
;
26004 if (slice
.x
+ slice
.width
>= img
->width
)
26005 slice
.width
= img
->width
- slice
.x
;
26006 if (slice
.y
+ slice
.height
> img
->height
)
26007 slice
.height
= img
->height
- slice
.y
;
26009 if (slice
.width
== 0 || slice
.height
== 0)
26012 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
26014 it
->descent
= slice
.height
- glyph_ascent
;
26016 it
->descent
+= img
->vmargin
;
26017 if (slice
.y
+ slice
.height
== img
->height
)
26018 it
->descent
+= img
->vmargin
;
26019 it
->phys_descent
= it
->descent
;
26021 it
->pixel_width
= slice
.width
;
26023 it
->pixel_width
+= img
->hmargin
;
26024 if (slice
.x
+ slice
.width
== img
->width
)
26025 it
->pixel_width
+= img
->hmargin
;
26027 /* It's quite possible for images to have an ascent greater than
26028 their height, so don't get confused in that case. */
26029 if (it
->descent
< 0)
26034 if (face
->box
!= FACE_NO_BOX
)
26036 if (face
->box_line_width
> 0)
26039 it
->ascent
+= face
->box_line_width
;
26040 if (slice
.y
+ slice
.height
== img
->height
)
26041 it
->descent
+= face
->box_line_width
;
26044 if (it
->start_of_box_run_p
&& slice
.x
== 0)
26045 it
->pixel_width
+= eabs (face
->box_line_width
);
26046 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
26047 it
->pixel_width
+= eabs (face
->box_line_width
);
26050 take_vertical_position_into_account (it
);
26052 /* Automatically crop wide image glyphs at right edge so we can
26053 draw the cursor on same display row. */
26054 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
26055 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
26057 it
->pixel_width
-= crop
;
26058 slice
.width
-= crop
;
26063 struct glyph
*glyph
;
26064 enum glyph_row_area area
= it
->area
;
26066 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26067 if (it
->glyph_row
->reversed_p
)
26071 /* Make room for the new glyph. */
26072 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
26074 glyph
= it
->glyph_row
->glyphs
[it
->area
];
26076 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26078 glyph
->charpos
= CHARPOS (it
->position
);
26079 glyph
->object
= it
->object
;
26080 glyph
->pixel_width
= clip_to_bounds (-1, it
->pixel_width
, SHRT_MAX
);
26081 glyph
->ascent
= glyph_ascent
;
26082 glyph
->descent
= it
->descent
;
26083 glyph
->voffset
= it
->voffset
;
26084 glyph
->type
= IMAGE_GLYPH
;
26085 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26086 glyph
->multibyte_p
= it
->multibyte_p
;
26087 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26089 /* In R2L rows, the left and the right box edges need to be
26090 drawn in reverse direction. */
26091 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26092 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26096 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26097 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26099 glyph
->overlaps_vertically_p
= false;
26100 glyph
->padding_p
= false;
26101 glyph
->glyph_not_available_p
= false;
26102 glyph
->face_id
= it
->face_id
;
26103 glyph
->u
.img_id
= img
->id
;
26104 glyph
->slice
.img
= slice
;
26105 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26108 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26109 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26110 glyph
->bidi_type
= it
->bidi_it
.type
;
26112 ++it
->glyph_row
->used
[area
];
26115 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26120 produce_xwidget_glyph (struct it
*it
)
26122 #ifdef HAVE_XWIDGETS
26123 struct xwidget
*xw
;
26124 int glyph_ascent
, crop
;
26125 eassert (it
->what
== IT_XWIDGET
);
26127 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26128 /* Make sure X resources of the face is loaded. */
26129 prepare_face_for_display (it
->f
, face
);
26132 it
->ascent
= it
->phys_ascent
= glyph_ascent
= xw
->height
/2;
26133 it
->descent
= xw
->height
/2;
26134 it
->phys_descent
= it
->descent
;
26135 it
->pixel_width
= xw
->width
;
26136 /* It's quite possible for images to have an ascent greater than
26137 their height, so don't get confused in that case. */
26138 if (it
->descent
< 0)
26143 if (face
->box
!= FACE_NO_BOX
)
26145 if (face
->box_line_width
> 0)
26147 it
->ascent
+= face
->box_line_width
;
26148 it
->descent
+= face
->box_line_width
;
26151 if (it
->start_of_box_run_p
)
26152 it
->pixel_width
+= eabs (face
->box_line_width
);
26153 it
->pixel_width
+= eabs (face
->box_line_width
);
26156 take_vertical_position_into_account (it
);
26158 /* Automatically crop wide image glyphs at right edge so we can
26159 draw the cursor on same display row. */
26160 crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
);
26161 if (crop
> 0 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
26162 it
->pixel_width
-= crop
;
26166 enum glyph_row_area area
= it
->area
;
26167 struct glyph
*glyph
26168 = it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26170 if (it
->glyph_row
->reversed_p
)
26174 /* Make room for the new glyph. */
26175 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
26177 glyph
= it
->glyph_row
->glyphs
[it
->area
];
26179 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26181 glyph
->charpos
= CHARPOS (it
->position
);
26182 glyph
->object
= it
->object
;
26183 glyph
->pixel_width
= clip_to_bounds (-1, it
->pixel_width
, SHRT_MAX
);
26184 glyph
->ascent
= glyph_ascent
;
26185 glyph
->descent
= it
->descent
;
26186 glyph
->voffset
= it
->voffset
;
26187 glyph
->type
= XWIDGET_GLYPH
;
26188 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26189 glyph
->multibyte_p
= it
->multibyte_p
;
26190 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26192 /* In R2L rows, the left and the right box edges need to be
26193 drawn in reverse direction. */
26194 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26195 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26199 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26200 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26202 glyph
->overlaps_vertically_p
= 0;
26203 glyph
->padding_p
= 0;
26204 glyph
->glyph_not_available_p
= 0;
26205 glyph
->face_id
= it
->face_id
;
26206 glyph
->u
.xwidget
= it
->xwidget
;
26207 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26210 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26211 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26212 glyph
->bidi_type
= it
->bidi_it
.type
;
26214 ++it
->glyph_row
->used
[area
];
26217 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26222 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
26223 of the glyph, WIDTH and HEIGHT are the width and height of the
26224 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
26227 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
26228 int width
, int height
, int ascent
)
26230 struct glyph
*glyph
;
26231 enum glyph_row_area area
= it
->area
;
26233 eassert (ascent
>= 0 && ascent
<= height
);
26235 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26236 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26238 /* If the glyph row is reversed, we need to prepend the glyph
26239 rather than append it. */
26240 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26244 /* Make room for the additional glyph. */
26245 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26247 glyph
= it
->glyph_row
->glyphs
[area
];
26249 /* Decrease the width of the first glyph of the row that
26250 begins before first_visible_x (e.g., due to hscroll).
26251 This is so the overall width of the row becomes smaller
26252 by the scroll amount, and the stretch glyph appended by
26253 extend_face_to_end_of_line will be wider, to shift the
26254 row glyphs to the right. (In L2R rows, the corresponding
26255 left-shift effect is accomplished by setting row->x to a
26256 negative value, which won't work with R2L rows.)
26258 This must leave us with a positive value of WIDTH, since
26259 otherwise the call to move_it_in_display_line_to at the
26260 beginning of display_line would have got past the entire
26261 first glyph, and then it->current_x would have been
26262 greater or equal to it->first_visible_x. */
26263 if (it
->current_x
< it
->first_visible_x
)
26264 width
-= it
->first_visible_x
- it
->current_x
;
26265 eassert (width
> 0);
26267 glyph
->charpos
= CHARPOS (it
->position
);
26268 glyph
->object
= object
;
26269 /* FIXME: It would be better to use TYPE_MAX here, but
26270 __typeof__ is not portable enough... */
26271 glyph
->pixel_width
= clip_to_bounds (-1, width
, SHRT_MAX
);
26272 glyph
->ascent
= ascent
;
26273 glyph
->descent
= height
- ascent
;
26274 glyph
->voffset
= it
->voffset
;
26275 glyph
->type
= STRETCH_GLYPH
;
26276 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26277 glyph
->multibyte_p
= it
->multibyte_p
;
26278 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26280 /* In R2L rows, the left and the right box edges need to be
26281 drawn in reverse direction. */
26282 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26283 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26287 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26288 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26290 glyph
->overlaps_vertically_p
= false;
26291 glyph
->padding_p
= false;
26292 glyph
->glyph_not_available_p
= false;
26293 glyph
->face_id
= it
->face_id
;
26294 glyph
->u
.stretch
.ascent
= ascent
;
26295 glyph
->u
.stretch
.height
= height
;
26296 glyph
->slice
.img
= null_glyph_slice
;
26297 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26300 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26301 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26302 glyph
->bidi_type
= it
->bidi_it
.type
;
26306 glyph
->resolved_level
= 0;
26307 glyph
->bidi_type
= UNKNOWN_BT
;
26309 ++it
->glyph_row
->used
[area
];
26312 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26315 #endif /* HAVE_WINDOW_SYSTEM */
26317 /* Produce a stretch glyph for iterator IT. IT->object is the value
26318 of the glyph property displayed. The value must be a list
26319 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
26322 1. `:width WIDTH' specifies that the space should be WIDTH *
26323 canonical char width wide. WIDTH may be an integer or floating
26326 2. `:relative-width FACTOR' specifies that the width of the stretch
26327 should be computed from the width of the first character having the
26328 `glyph' property, and should be FACTOR times that width.
26330 3. `:align-to HPOS' specifies that the space should be wide enough
26331 to reach HPOS, a value in canonical character units.
26333 Exactly one of the above pairs must be present.
26335 4. `:height HEIGHT' specifies that the height of the stretch produced
26336 should be HEIGHT, measured in canonical character units.
26338 5. `:relative-height FACTOR' specifies that the height of the
26339 stretch should be FACTOR times the height of the characters having
26340 the glyph property.
26342 Either none or exactly one of 4 or 5 must be present.
26344 6. `:ascent ASCENT' specifies that ASCENT percent of the height
26345 of the stretch should be used for the ascent of the stretch.
26346 ASCENT must be in the range 0 <= ASCENT <= 100. */
26349 produce_stretch_glyph (struct it
*it
)
26351 /* (space :width WIDTH :height HEIGHT ...) */
26352 Lisp_Object prop
, plist
;
26353 int width
= 0, height
= 0, align_to
= -1;
26354 bool zero_width_ok_p
= false;
26356 struct font
*font
= NULL
;
26358 #ifdef HAVE_WINDOW_SYSTEM
26360 bool zero_height_ok_p
= false;
26362 if (FRAME_WINDOW_P (it
->f
))
26364 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26365 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26366 prepare_face_for_display (it
->f
, face
);
26370 /* List should start with `space'. */
26371 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
26372 plist
= XCDR (it
->object
);
26374 /* Compute the width of the stretch. */
26375 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
26376 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true, 0))
26378 /* Absolute width `:width WIDTH' specified and valid. */
26379 zero_width_ok_p
= true;
26382 else if (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0)
26384 /* Relative width `:relative-width FACTOR' specified and valid.
26385 Compute the width of the characters having the `glyph'
26388 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
26391 if (it
->multibyte_p
)
26392 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
26395 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
26396 if (! ASCII_CHAR_P (it2
.c
))
26397 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
26400 it2
.glyph_row
= NULL
;
26401 it2
.what
= IT_CHARACTER
;
26402 PRODUCE_GLYPHS (&it2
);
26403 width
= NUMVAL (prop
) * it2
.pixel_width
;
26405 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
26406 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true,
26409 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
26410 align_to
= (align_to
< 0
26412 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
26413 else if (align_to
< 0)
26414 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
26415 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
26416 zero_width_ok_p
= true;
26419 /* Nothing specified -> width defaults to canonical char width. */
26420 width
= FRAME_COLUMN_WIDTH (it
->f
);
26422 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
26425 #ifdef HAVE_WINDOW_SYSTEM
26426 /* Compute height. */
26427 if (FRAME_WINDOW_P (it
->f
))
26429 int default_height
= normal_char_height (font
, ' ');
26431 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
26432 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26435 zero_height_ok_p
= true;
26437 else if (prop
= Fplist_get (plist
, QCrelative_height
),
26439 height
= default_height
* NUMVAL (prop
);
26441 height
= default_height
;
26443 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
26446 /* Compute percentage of height used for ascent. If
26447 `:ascent ASCENT' is present and valid, use that. Otherwise,
26448 derive the ascent from the font in use. */
26449 if (prop
= Fplist_get (plist
, QCascent
),
26450 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
26451 ascent
= height
* NUMVAL (prop
) / 100.0;
26452 else if (!NILP (prop
)
26453 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26454 ascent
= min (max (0, (int)tem
), height
);
26456 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
26459 #endif /* HAVE_WINDOW_SYSTEM */
26462 if (width
> 0 && it
->line_wrap
!= TRUNCATE
26463 && it
->current_x
+ width
> it
->last_visible_x
)
26465 width
= it
->last_visible_x
- it
->current_x
;
26466 #ifdef HAVE_WINDOW_SYSTEM
26467 /* Subtract one more pixel from the stretch width, but only on
26468 GUI frames, since on a TTY each glyph is one "pixel" wide. */
26469 width
-= FRAME_WINDOW_P (it
->f
);
26473 if (width
> 0 && height
> 0 && it
->glyph_row
)
26475 Lisp_Object o_object
= it
->object
;
26476 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
26479 if (!STRINGP (object
))
26480 object
= it
->w
->contents
;
26481 #ifdef HAVE_WINDOW_SYSTEM
26482 if (FRAME_WINDOW_P (it
->f
))
26483 append_stretch_glyph (it
, object
, width
, height
, ascent
);
26487 it
->object
= object
;
26488 it
->char_to_display
= ' ';
26489 it
->pixel_width
= it
->len
= 1;
26491 tty_append_glyph (it
);
26492 it
->object
= o_object
;
26496 it
->pixel_width
= width
;
26497 #ifdef HAVE_WINDOW_SYSTEM
26498 if (FRAME_WINDOW_P (it
->f
))
26500 it
->ascent
= it
->phys_ascent
= ascent
;
26501 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
26502 it
->nglyphs
= width
> 0 && height
> 0;
26503 take_vertical_position_into_account (it
);
26507 it
->nglyphs
= width
;
26510 /* Get information about special display element WHAT in an
26511 environment described by IT. WHAT is one of IT_TRUNCATION or
26512 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
26513 non-null glyph_row member. This function ensures that fields like
26514 face_id, c, len of IT are left untouched. */
26517 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
26524 temp_it
.object
= Qnil
;
26525 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
26527 if (what
== IT_CONTINUATION
)
26529 /* Continuation glyph. For R2L lines, we mirror it by hand. */
26530 if (it
->bidi_it
.paragraph_dir
== R2L
)
26531 SET_GLYPH_FROM_CHAR (glyph
, '/');
26533 SET_GLYPH_FROM_CHAR (glyph
, '\\');
26535 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26537 /* FIXME: Should we mirror GC for R2L lines? */
26538 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26539 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26542 else if (what
== IT_TRUNCATION
)
26544 /* Truncation glyph. */
26545 SET_GLYPH_FROM_CHAR (glyph
, '$');
26547 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26549 /* FIXME: Should we mirror GC for R2L lines? */
26550 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26551 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26557 #ifdef HAVE_WINDOW_SYSTEM
26558 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
26559 is turned off, we precede the truncation/continuation glyphs by a
26560 stretch glyph whose width is computed such that these special
26561 glyphs are aligned at the window margin, even when very different
26562 fonts are used in different glyph rows. */
26563 if (FRAME_WINDOW_P (temp_it
.f
)
26564 /* init_iterator calls this with it->glyph_row == NULL, and it
26565 wants only the pixel width of the truncation/continuation
26567 && temp_it
.glyph_row
26568 /* insert_left_trunc_glyphs calls us at the beginning of the
26569 row, and it has its own calculation of the stretch glyph
26571 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
26572 && (temp_it
.glyph_row
->reversed_p
26573 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
26574 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
26576 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
26578 if (stretch_width
> 0)
26580 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
26581 struct font
*font
=
26582 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
26583 int stretch_ascent
=
26584 (((temp_it
.ascent
+ temp_it
.descent
)
26585 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
26587 append_stretch_glyph (&temp_it
, Qnil
, stretch_width
,
26588 temp_it
.ascent
+ temp_it
.descent
,
26595 temp_it
.what
= IT_CHARACTER
;
26596 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
26597 temp_it
.face_id
= GLYPH_FACE (glyph
);
26598 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
26600 PRODUCE_GLYPHS (&temp_it
);
26601 it
->pixel_width
= temp_it
.pixel_width
;
26602 it
->nglyphs
= temp_it
.nglyphs
;
26605 #ifdef HAVE_WINDOW_SYSTEM
26607 /* Calculate line-height and line-spacing properties.
26608 An integer value specifies explicit pixel value.
26609 A float value specifies relative value to current face height.
26610 A cons (float . face-name) specifies relative value to
26611 height of specified face font.
26613 Returns height in pixels, or nil. */
26616 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
26617 int boff
, bool override
)
26619 Lisp_Object face_name
= Qnil
;
26620 int ascent
, descent
, height
;
26622 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
26627 face_name
= XCAR (val
);
26629 if (!NUMBERP (val
))
26630 val
= make_number (1);
26631 if (NILP (face_name
))
26633 height
= it
->ascent
+ it
->descent
;
26638 if (NILP (face_name
))
26640 font
= FRAME_FONT (it
->f
);
26641 boff
= FRAME_BASELINE_OFFSET (it
->f
);
26643 else if (EQ (face_name
, Qt
))
26652 face_id
= lookup_named_face (it
->f
, face_name
, false);
26654 return make_number (-1);
26656 face
= FACE_FROM_ID (it
->f
, face_id
);
26659 return make_number (-1);
26660 boff
= font
->baseline_offset
;
26661 if (font
->vertical_centering
)
26662 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26665 normal_char_ascent_descent (font
, -1, &ascent
, &descent
);
26669 it
->override_ascent
= ascent
;
26670 it
->override_descent
= descent
;
26671 it
->override_boff
= boff
;
26674 height
= ascent
+ descent
;
26678 height
= (int)(XFLOAT_DATA (val
) * height
);
26679 else if (INTEGERP (val
))
26680 height
*= XINT (val
);
26682 return make_number (height
);
26686 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
26687 is a face ID to be used for the glyph. FOR_NO_FONT is true if
26688 and only if this is for a character for which no font was found.
26690 If the display method (it->glyphless_method) is
26691 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
26692 length of the acronym or the hexadecimal string, UPPER_XOFF and
26693 UPPER_YOFF are pixel offsets for the upper part of the string,
26694 LOWER_XOFF and LOWER_YOFF are for the lower part.
26696 For the other display methods, LEN through LOWER_YOFF are zero. */
26699 append_glyphless_glyph (struct it
*it
, int face_id
, bool for_no_font
, int len
,
26700 short upper_xoff
, short upper_yoff
,
26701 short lower_xoff
, short lower_yoff
)
26703 struct glyph
*glyph
;
26704 enum glyph_row_area area
= it
->area
;
26706 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26707 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26709 /* If the glyph row is reversed, we need to prepend the glyph
26710 rather than append it. */
26711 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26715 /* Make room for the additional glyph. */
26716 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26718 glyph
= it
->glyph_row
->glyphs
[area
];
26720 glyph
->charpos
= CHARPOS (it
->position
);
26721 glyph
->object
= it
->object
;
26722 eassert (it
->pixel_width
<= SHRT_MAX
);
26723 glyph
->pixel_width
= it
->pixel_width
;
26724 glyph
->ascent
= it
->ascent
;
26725 glyph
->descent
= it
->descent
;
26726 glyph
->voffset
= it
->voffset
;
26727 glyph
->type
= GLYPHLESS_GLYPH
;
26728 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
26729 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
26730 glyph
->u
.glyphless
.len
= len
;
26731 glyph
->u
.glyphless
.ch
= it
->c
;
26732 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
26733 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
26734 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
26735 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
26736 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26737 glyph
->multibyte_p
= it
->multibyte_p
;
26738 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26740 /* In R2L rows, the left and the right box edges need to be
26741 drawn in reverse direction. */
26742 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26743 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26747 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26748 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26750 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
26751 || it
->phys_descent
> it
->descent
);
26752 glyph
->padding_p
= false;
26753 glyph
->glyph_not_available_p
= false;
26754 glyph
->face_id
= face_id
;
26755 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26758 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26759 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26760 glyph
->bidi_type
= it
->bidi_it
.type
;
26762 ++it
->glyph_row
->used
[area
];
26765 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26769 /* Produce a glyph for a glyphless character for iterator IT.
26770 IT->glyphless_method specifies which method to use for displaying
26771 the character. See the description of enum
26772 glyphless_display_method in dispextern.h for the detail.
26774 FOR_NO_FONT is true if and only if this is for a character for
26775 which no font was found. ACRONYM, if non-nil, is an acronym string
26776 for the character. */
26779 produce_glyphless_glyph (struct it
*it
, bool for_no_font
, Lisp_Object acronym
)
26784 int base_width
, base_height
, width
, height
;
26785 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26788 /* Get the metrics of the base font. We always refer to the current
26790 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26791 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26792 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
26793 it
->ascent
+= font
->baseline_offset
;
26794 it
->descent
-= font
->baseline_offset
;
26795 base_height
= it
->ascent
+ it
->descent
;
26796 base_width
= font
->average_width
;
26798 face_id
= merge_glyphless_glyph_face (it
);
26800 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26802 it
->pixel_width
= THIN_SPACE_WIDTH
;
26804 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26806 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26808 width
= CHAR_WIDTH (it
->c
);
26811 else if (width
> 4)
26813 it
->pixel_width
= base_width
* width
;
26815 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26821 unsigned int code
[6];
26823 int ascent
, descent
;
26824 struct font_metrics metrics_upper
, metrics_lower
;
26826 face
= FACE_FROM_ID (it
->f
, face_id
);
26827 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26828 prepare_face_for_display (it
->f
, face
);
26830 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26832 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26833 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26834 if (CONSP (acronym
))
26835 acronym
= XCAR (acronym
);
26836 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26840 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26841 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
+ 0u);
26844 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
26845 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26846 upper_len
= (len
+ 1) / 2;
26847 font
->driver
->text_extents (font
, code
, upper_len
,
26849 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26854 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26855 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26856 upper_xoff
= upper_yoff
= 2; /* the typical case */
26857 if (base_width
>= width
)
26859 /* Align the upper to the left, the lower to the right. */
26860 it
->pixel_width
= base_width
;
26861 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26865 /* Center the shorter one. */
26866 it
->pixel_width
= width
;
26867 if (metrics_upper
.width
>= metrics_lower
.width
)
26868 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26871 /* FIXME: This code doesn't look right. It formerly was
26872 missing the "lower_xoff = 0;", which couldn't have
26873 been right since it left lower_xoff uninitialized. */
26875 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26879 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26880 top, bottom, and between upper and lower strings. */
26881 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26882 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26883 /* Center vertically.
26884 H:base_height, D:base_descent
26885 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26887 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26888 descent = D - H/2 + h/2;
26889 lower_yoff = descent - 2 - ld;
26890 upper_yoff = lower_yoff - la - 1 - ud; */
26891 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26892 descent
= it
->descent
- (base_height
- height
) / 2;
26893 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26894 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26895 - metrics_upper
.descent
);
26896 /* Don't make the height shorter than the base height. */
26897 if (height
> base_height
)
26899 it
->ascent
= ascent
;
26900 it
->descent
= descent
;
26904 it
->phys_ascent
= it
->ascent
;
26905 it
->phys_descent
= it
->descent
;
26907 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26908 upper_xoff
, upper_yoff
,
26909 lower_xoff
, lower_yoff
);
26911 take_vertical_position_into_account (it
);
26916 Produce glyphs/get display metrics for the display element IT is
26917 loaded with. See the description of struct it in dispextern.h
26918 for an overview of struct it. */
26921 x_produce_glyphs (struct it
*it
)
26923 int extra_line_spacing
= it
->extra_line_spacing
;
26925 it
->glyph_not_available_p
= false;
26927 if (it
->what
== IT_CHARACTER
)
26930 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26931 struct font
*font
= face
->font
;
26932 struct font_metrics
*pcm
= NULL
;
26933 int boff
; /* Baseline offset. */
26937 /* When no suitable font is found, display this character by
26938 the method specified in the first extra slot of
26939 Vglyphless_char_display. */
26940 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26942 eassert (it
->what
== IT_GLYPHLESS
);
26943 produce_glyphless_glyph (it
, true,
26944 STRINGP (acronym
) ? acronym
: Qnil
);
26948 boff
= font
->baseline_offset
;
26949 if (font
->vertical_centering
)
26950 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26952 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26956 if (it
->override_ascent
>= 0)
26958 it
->ascent
= it
->override_ascent
;
26959 it
->descent
= it
->override_descent
;
26960 boff
= it
->override_boff
;
26964 it
->ascent
= FONT_BASE (font
) + boff
;
26965 it
->descent
= FONT_DESCENT (font
) - boff
;
26968 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
26970 pcm
= get_per_char_metric (font
, &char2b
);
26971 if (pcm
->width
== 0
26972 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26978 it
->phys_ascent
= pcm
->ascent
+ boff
;
26979 it
->phys_descent
= pcm
->descent
- boff
;
26980 it
->pixel_width
= pcm
->width
;
26981 /* Don't use font-global values for ascent and descent
26982 if they result in an exceedingly large line height. */
26983 if (it
->override_ascent
< 0)
26985 if (FONT_TOO_HIGH (font
))
26987 it
->ascent
= it
->phys_ascent
;
26988 it
->descent
= it
->phys_descent
;
26989 /* These limitations are enforced by an
26990 assertion near the end of this function. */
26991 if (it
->ascent
< 0)
26993 if (it
->descent
< 0)
27000 it
->glyph_not_available_p
= true;
27001 it
->phys_ascent
= it
->ascent
;
27002 it
->phys_descent
= it
->descent
;
27003 it
->pixel_width
= font
->space_width
;
27006 if (it
->constrain_row_ascent_descent_p
)
27008 if (it
->descent
> it
->max_descent
)
27010 it
->ascent
+= it
->descent
- it
->max_descent
;
27011 it
->descent
= it
->max_descent
;
27013 if (it
->ascent
> it
->max_ascent
)
27015 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
27016 it
->ascent
= it
->max_ascent
;
27018 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
27019 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
27020 extra_line_spacing
= 0;
27023 /* If this is a space inside a region of text with
27024 `space-width' property, change its width. */
27026 = it
->char_to_display
== ' ' && !NILP (it
->space_width
);
27028 it
->pixel_width
*= XFLOATINT (it
->space_width
);
27030 /* If face has a box, add the box thickness to the character
27031 height. If character has a box line to the left and/or
27032 right, add the box line width to the character's width. */
27033 if (face
->box
!= FACE_NO_BOX
)
27035 int thick
= face
->box_line_width
;
27039 it
->ascent
+= thick
;
27040 it
->descent
+= thick
;
27045 if (it
->start_of_box_run_p
)
27046 it
->pixel_width
+= thick
;
27047 if (it
->end_of_box_run_p
)
27048 it
->pixel_width
+= thick
;
27051 /* If face has an overline, add the height of the overline
27052 (1 pixel) and a 1 pixel margin to the character height. */
27053 if (face
->overline_p
)
27054 it
->ascent
+= overline_margin
;
27056 if (it
->constrain_row_ascent_descent_p
)
27058 if (it
->ascent
> it
->max_ascent
)
27059 it
->ascent
= it
->max_ascent
;
27060 if (it
->descent
> it
->max_descent
)
27061 it
->descent
= it
->max_descent
;
27064 take_vertical_position_into_account (it
);
27066 /* If we have to actually produce glyphs, do it. */
27071 /* Translate a space with a `space-width' property
27072 into a stretch glyph. */
27073 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
27074 / FONT_HEIGHT (font
));
27075 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
27076 it
->ascent
+ it
->descent
, ascent
);
27081 /* If characters with lbearing or rbearing are displayed
27082 in this line, record that fact in a flag of the
27083 glyph row. This is used to optimize X output code. */
27084 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
27085 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27087 if (! stretched_p
&& it
->pixel_width
== 0)
27088 /* We assure that all visible glyphs have at least 1-pixel
27090 it
->pixel_width
= 1;
27092 else if (it
->char_to_display
== '\n')
27094 /* A newline has no width, but we need the height of the
27095 line. But if previous part of the line sets a height,
27096 don't increase that height. */
27098 Lisp_Object height
;
27099 Lisp_Object total_height
= Qnil
;
27101 it
->override_ascent
= -1;
27102 it
->pixel_width
= 0;
27105 height
= get_it_property (it
, Qline_height
);
27106 /* Split (line-height total-height) list. */
27108 && CONSP (XCDR (height
))
27109 && NILP (XCDR (XCDR (height
))))
27111 total_height
= XCAR (XCDR (height
));
27112 height
= XCAR (height
);
27114 height
= calc_line_height_property (it
, height
, font
, boff
, true);
27116 if (it
->override_ascent
>= 0)
27118 it
->ascent
= it
->override_ascent
;
27119 it
->descent
= it
->override_descent
;
27120 boff
= it
->override_boff
;
27124 if (FONT_TOO_HIGH (font
))
27126 it
->ascent
= font
->pixel_size
+ boff
- 1;
27127 it
->descent
= -boff
+ 1;
27128 if (it
->descent
< 0)
27133 it
->ascent
= FONT_BASE (font
) + boff
;
27134 it
->descent
= FONT_DESCENT (font
) - boff
;
27138 if (EQ (height
, Qt
))
27140 if (it
->descent
> it
->max_descent
)
27142 it
->ascent
+= it
->descent
- it
->max_descent
;
27143 it
->descent
= it
->max_descent
;
27145 if (it
->ascent
> it
->max_ascent
)
27147 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
27148 it
->ascent
= it
->max_ascent
;
27150 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
27151 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
27152 it
->constrain_row_ascent_descent_p
= true;
27153 extra_line_spacing
= 0;
27157 Lisp_Object spacing
;
27159 it
->phys_ascent
= it
->ascent
;
27160 it
->phys_descent
= it
->descent
;
27162 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
27163 && face
->box
!= FACE_NO_BOX
27164 && face
->box_line_width
> 0)
27166 it
->ascent
+= face
->box_line_width
;
27167 it
->descent
+= face
->box_line_width
;
27170 && XINT (height
) > it
->ascent
+ it
->descent
)
27171 it
->ascent
= XINT (height
) - it
->descent
;
27173 if (!NILP (total_height
))
27174 spacing
= calc_line_height_property (it
, total_height
, font
,
27178 spacing
= get_it_property (it
, Qline_spacing
);
27179 spacing
= calc_line_height_property (it
, spacing
, font
,
27182 if (INTEGERP (spacing
))
27184 extra_line_spacing
= XINT (spacing
);
27185 if (!NILP (total_height
))
27186 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
27190 else /* i.e. (it->char_to_display == '\t') */
27192 if (font
->space_width
> 0)
27194 int tab_width
= it
->tab_width
* font
->space_width
;
27195 int x
= it
->current_x
+ it
->continuation_lines_width
;
27196 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
27198 /* If the distance from the current position to the next tab
27199 stop is less than a space character width, use the
27200 tab stop after that. */
27201 if (next_tab_x
- x
< font
->space_width
)
27202 next_tab_x
+= tab_width
;
27204 it
->pixel_width
= next_tab_x
- x
;
27206 if (FONT_TOO_HIGH (font
))
27208 if (get_char_glyph_code (' ', font
, &char2b
))
27210 pcm
= get_per_char_metric (font
, &char2b
);
27211 if (pcm
->width
== 0
27212 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
27218 it
->ascent
= pcm
->ascent
+ boff
;
27219 it
->descent
= pcm
->descent
- boff
;
27223 it
->ascent
= font
->pixel_size
+ boff
- 1;
27224 it
->descent
= -boff
+ 1;
27226 if (it
->ascent
< 0)
27228 if (it
->descent
< 0)
27233 it
->ascent
= FONT_BASE (font
) + boff
;
27234 it
->descent
= FONT_DESCENT (font
) - boff
;
27236 it
->phys_ascent
= it
->ascent
;
27237 it
->phys_descent
= it
->descent
;
27241 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
27242 it
->ascent
+ it
->descent
, it
->ascent
);
27247 it
->pixel_width
= 0;
27252 if (FONT_TOO_HIGH (font
))
27254 int font_ascent
, font_descent
;
27256 /* For very large fonts, where we ignore the declared font
27257 dimensions, and go by per-character metrics instead,
27258 don't let the row ascent and descent values (and the row
27259 height computed from them) be smaller than the "normal"
27260 character metrics. This avoids unpleasant effects
27261 whereby lines on display would change their height
27262 depending on which characters are shown. */
27263 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
27264 it
->max_ascent
= max (it
->max_ascent
, font_ascent
);
27265 it
->max_descent
= max (it
->max_descent
, font_descent
);
27268 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
27270 /* A static composition.
27272 Note: A composition is represented as one glyph in the
27273 glyph matrix. There are no padding glyphs.
27275 Important note: pixel_width, ascent, and descent are the
27276 values of what is drawn by draw_glyphs (i.e. the values of
27277 the overall glyphs composed). */
27278 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27279 int boff
; /* baseline offset */
27280 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
27281 int glyph_len
= cmp
->glyph_len
;
27282 struct font
*font
= face
->font
;
27286 /* If we have not yet calculated pixel size data of glyphs of
27287 the composition for the current face font, calculate them
27288 now. Theoretically, we have to check all fonts for the
27289 glyphs, but that requires much time and memory space. So,
27290 here we check only the font of the first glyph. This may
27291 lead to incorrect display, but it's very rare, and C-l
27292 (recenter-top-bottom) can correct the display anyway. */
27293 if (! cmp
->font
|| cmp
->font
!= font
)
27295 /* Ascent and descent of the font of the first character
27296 of this composition (adjusted by baseline offset).
27297 Ascent and descent of overall glyphs should not be less
27298 than these, respectively. */
27299 int font_ascent
, font_descent
, font_height
;
27300 /* Bounding box of the overall glyphs. */
27301 int leftmost
, rightmost
, lowest
, highest
;
27302 int lbearing
, rbearing
;
27303 int i
, width
, ascent
, descent
;
27304 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
27306 struct font_metrics
*pcm
;
27309 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
27310 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
27312 bool right_padded
= glyph_len
< cmp
->glyph_len
;
27313 for (i
= 0; i
< glyph_len
; i
++)
27315 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
27317 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
27319 bool left_padded
= i
> 0;
27321 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
27322 : IT_CHARPOS (*it
));
27323 /* If no suitable font is found, use the default font. */
27324 bool font_not_found_p
= font
== NULL
;
27325 if (font_not_found_p
)
27327 face
= face
->ascii_face
;
27330 boff
= font
->baseline_offset
;
27331 if (font
->vertical_centering
)
27332 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
27333 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
27334 font_ascent
+= boff
;
27335 font_descent
-= boff
;
27336 font_height
= font_ascent
+ font_descent
;
27341 if (! font_not_found_p
)
27343 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
27345 pcm
= get_per_char_metric (font
, &char2b
);
27348 /* Initialize the bounding box. */
27351 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
27352 ascent
= pcm
->ascent
;
27353 descent
= pcm
->descent
;
27354 lbearing
= pcm
->lbearing
;
27355 rbearing
= pcm
->rbearing
;
27359 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
27360 ascent
= FONT_BASE (font
);
27361 descent
= FONT_DESCENT (font
);
27368 lowest
= - descent
+ boff
;
27369 highest
= ascent
+ boff
;
27371 if (! font_not_found_p
27372 && font
->default_ascent
27373 && CHAR_TABLE_P (Vuse_default_ascent
)
27374 && !NILP (Faref (Vuse_default_ascent
,
27375 make_number (it
->char_to_display
))))
27376 highest
= font
->default_ascent
+ boff
;
27378 /* Draw the first glyph at the normal position. It may be
27379 shifted to right later if some other glyphs are drawn
27381 cmp
->offsets
[i
* 2] = 0;
27382 cmp
->offsets
[i
* 2 + 1] = boff
;
27383 cmp
->lbearing
= lbearing
;
27384 cmp
->rbearing
= rbearing
;
27386 /* Set cmp->offsets for the remaining glyphs. */
27387 for (i
++; i
< glyph_len
; i
++)
27389 int left
, right
, btm
, top
;
27390 int ch
= COMPOSITION_GLYPH (cmp
, i
);
27392 struct face
*this_face
;
27396 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
27397 this_face
= FACE_FROM_ID (it
->f
, face_id
);
27398 font
= this_face
->font
;
27404 get_char_face_and_encoding (it
->f
, ch
, face_id
,
27406 pcm
= get_per_char_metric (font
, &char2b
);
27409 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
27412 width
= pcm
->width
;
27413 ascent
= pcm
->ascent
;
27414 descent
= pcm
->descent
;
27415 lbearing
= pcm
->lbearing
;
27416 rbearing
= pcm
->rbearing
;
27417 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
27419 /* Relative composition with or without
27420 alternate chars. */
27421 left
= (leftmost
+ rightmost
- width
) / 2;
27422 btm
= - descent
+ boff
;
27423 if (font
->relative_compose
27424 && (! CHAR_TABLE_P (Vignore_relative_composition
)
27425 || NILP (Faref (Vignore_relative_composition
,
27426 make_number (ch
)))))
27429 if (- descent
>= font
->relative_compose
)
27430 /* One extra pixel between two glyphs. */
27432 else if (ascent
<= 0)
27433 /* One extra pixel between two glyphs. */
27434 btm
= lowest
- 1 - ascent
- descent
;
27439 /* A composition rule is specified by an integer
27440 value that encodes global and new reference
27441 points (GREF and NREF). GREF and NREF are
27442 specified by numbers as below:
27444 0---1---2 -- ascent
27448 9--10--11 -- center
27450 ---3---4---5--- baseline
27452 6---7---8 -- descent
27454 int rule
= COMPOSITION_RULE (cmp
, i
);
27455 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
27457 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
27458 grefx
= gref
% 3, nrefx
= nref
% 3;
27459 grefy
= gref
/ 3, nrefy
= nref
/ 3;
27461 xoff
= font_height
* (xoff
- 128) / 256;
27463 yoff
= font_height
* (yoff
- 128) / 256;
27466 + grefx
* (rightmost
- leftmost
) / 2
27467 - nrefx
* width
/ 2
27470 btm
= ((grefy
== 0 ? highest
27472 : grefy
== 2 ? lowest
27473 : (highest
+ lowest
) / 2)
27474 - (nrefy
== 0 ? ascent
+ descent
27475 : nrefy
== 1 ? descent
- boff
27477 : (ascent
+ descent
) / 2)
27481 cmp
->offsets
[i
* 2] = left
;
27482 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
27484 /* Update the bounding box of the overall glyphs. */
27487 right
= left
+ width
;
27488 if (left
< leftmost
)
27490 if (right
> rightmost
)
27493 top
= btm
+ descent
+ ascent
;
27499 if (cmp
->lbearing
> left
+ lbearing
)
27500 cmp
->lbearing
= left
+ lbearing
;
27501 if (cmp
->rbearing
< left
+ rbearing
)
27502 cmp
->rbearing
= left
+ rbearing
;
27506 /* If there are glyphs whose x-offsets are negative,
27507 shift all glyphs to the right and make all x-offsets
27511 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27512 cmp
->offsets
[i
* 2] -= leftmost
;
27513 rightmost
-= leftmost
;
27514 cmp
->lbearing
-= leftmost
;
27515 cmp
->rbearing
-= leftmost
;
27518 if (left_padded
&& cmp
->lbearing
< 0)
27520 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27521 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
27522 rightmost
-= cmp
->lbearing
;
27523 cmp
->rbearing
-= cmp
->lbearing
;
27526 if (right_padded
&& rightmost
< cmp
->rbearing
)
27528 rightmost
= cmp
->rbearing
;
27531 cmp
->pixel_width
= rightmost
;
27532 cmp
->ascent
= highest
;
27533 cmp
->descent
= - lowest
;
27534 if (cmp
->ascent
< font_ascent
)
27535 cmp
->ascent
= font_ascent
;
27536 if (cmp
->descent
< font_descent
)
27537 cmp
->descent
= font_descent
;
27541 && (cmp
->lbearing
< 0
27542 || cmp
->rbearing
> cmp
->pixel_width
))
27543 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27545 it
->pixel_width
= cmp
->pixel_width
;
27546 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
27547 it
->descent
= it
->phys_descent
= cmp
->descent
;
27548 if (face
->box
!= FACE_NO_BOX
)
27550 int thick
= face
->box_line_width
;
27554 it
->ascent
+= thick
;
27555 it
->descent
+= thick
;
27560 if (it
->start_of_box_run_p
)
27561 it
->pixel_width
+= thick
;
27562 if (it
->end_of_box_run_p
)
27563 it
->pixel_width
+= thick
;
27566 /* If face has an overline, add the height of the overline
27567 (1 pixel) and a 1 pixel margin to the character height. */
27568 if (face
->overline_p
)
27569 it
->ascent
+= overline_margin
;
27571 take_vertical_position_into_account (it
);
27572 if (it
->ascent
< 0)
27574 if (it
->descent
< 0)
27577 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
27578 append_composite_glyph (it
);
27580 else if (it
->what
== IT_COMPOSITION
)
27582 /* A dynamic (automatic) composition. */
27583 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27584 Lisp_Object gstring
;
27585 struct font_metrics metrics
;
27589 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
27591 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
27594 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
27595 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27596 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
27597 it
->descent
= it
->phys_descent
= metrics
.descent
;
27598 if (face
->box
!= FACE_NO_BOX
)
27600 int thick
= face
->box_line_width
;
27604 it
->ascent
+= thick
;
27605 it
->descent
+= thick
;
27610 if (it
->start_of_box_run_p
)
27611 it
->pixel_width
+= thick
;
27612 if (it
->end_of_box_run_p
)
27613 it
->pixel_width
+= thick
;
27615 /* If face has an overline, add the height of the overline
27616 (1 pixel) and a 1 pixel margin to the character height. */
27617 if (face
->overline_p
)
27618 it
->ascent
+= overline_margin
;
27619 take_vertical_position_into_account (it
);
27620 if (it
->ascent
< 0)
27622 if (it
->descent
< 0)
27626 append_composite_glyph (it
);
27628 else if (it
->what
== IT_GLYPHLESS
)
27629 produce_glyphless_glyph (it
, false, Qnil
);
27630 else if (it
->what
== IT_IMAGE
)
27631 produce_image_glyph (it
);
27632 else if (it
->what
== IT_STRETCH
)
27633 produce_stretch_glyph (it
);
27634 else if (it
->what
== IT_XWIDGET
)
27635 produce_xwidget_glyph (it
);
27638 /* Accumulate dimensions. Note: can't assume that it->descent > 0
27639 because this isn't true for images with `:ascent 100'. */
27640 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
27641 if (it
->area
== TEXT_AREA
)
27642 it
->current_x
+= it
->pixel_width
;
27644 if (extra_line_spacing
> 0)
27646 it
->descent
+= extra_line_spacing
;
27647 if (extra_line_spacing
> it
->max_extra_line_spacing
)
27648 it
->max_extra_line_spacing
= extra_line_spacing
;
27651 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
27652 it
->max_descent
= max (it
->max_descent
, it
->descent
);
27653 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
27654 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
27658 Output LEN glyphs starting at START at the nominal cursor position.
27659 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
27660 being updated, and UPDATED_AREA is the area of that row being updated. */
27663 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27664 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27666 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
27668 eassert (updated_row
);
27669 /* When the window is hscrolled, cursor hpos can legitimately be out
27670 of bounds, but we draw the cursor at the corresponding window
27671 margin in that case. */
27672 if (!updated_row
->reversed_p
&& chpos
< 0)
27674 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
27675 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
27679 /* Write glyphs. */
27681 hpos
= start
- updated_row
->glyphs
[updated_area
];
27682 x
= draw_glyphs (w
, w
->output_cursor
.x
,
27683 updated_row
, updated_area
,
27685 DRAW_NORMAL_TEXT
, 0);
27687 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
27688 if (updated_area
== TEXT_AREA
27689 && w
->phys_cursor_on_p
27690 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
27692 && chpos
< hpos
+ len
)
27693 w
->phys_cursor_on_p
= false;
27697 /* Advance the output cursor. */
27698 w
->output_cursor
.hpos
+= len
;
27699 w
->output_cursor
.x
= x
;
27704 Insert LEN glyphs from START at the nominal cursor position. */
27707 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27708 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27711 int line_height
, shift_by_width
, shifted_region_width
;
27712 struct glyph_row
*row
;
27713 struct glyph
*glyph
;
27714 int frame_x
, frame_y
;
27717 eassert (updated_row
);
27719 f
= XFRAME (WINDOW_FRAME (w
));
27721 /* Get the height of the line we are in. */
27723 line_height
= row
->height
;
27725 /* Get the width of the glyphs to insert. */
27726 shift_by_width
= 0;
27727 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
27728 shift_by_width
+= glyph
->pixel_width
;
27730 /* Get the width of the region to shift right. */
27731 shifted_region_width
= (window_box_width (w
, updated_area
)
27732 - w
->output_cursor
.x
27736 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
27737 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
27739 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
27740 line_height
, shift_by_width
);
27742 /* Write the glyphs. */
27743 hpos
= start
- row
->glyphs
[updated_area
];
27744 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
27746 DRAW_NORMAL_TEXT
, 0);
27748 /* Advance the output cursor. */
27749 w
->output_cursor
.hpos
+= len
;
27750 w
->output_cursor
.x
+= shift_by_width
;
27756 Erase the current text line from the nominal cursor position
27757 (inclusive) to pixel column TO_X (exclusive). The idea is that
27758 everything from TO_X onward is already erased.
27760 TO_X is a pixel position relative to UPDATED_AREA of currently
27761 updated window W. TO_X == -1 means clear to the end of this area. */
27764 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
27765 enum glyph_row_area updated_area
, int to_x
)
27768 int max_x
, min_y
, max_y
;
27769 int from_x
, from_y
, to_y
;
27771 eassert (updated_row
);
27772 f
= XFRAME (w
->frame
);
27774 if (updated_row
->full_width_p
)
27775 max_x
= (WINDOW_PIXEL_WIDTH (w
)
27776 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
27778 max_x
= window_box_width (w
, updated_area
);
27779 max_y
= window_text_bottom_y (w
);
27781 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
27782 of window. For TO_X > 0, truncate to end of drawing area. */
27788 to_x
= min (to_x
, max_x
);
27790 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
27792 /* Notice if the cursor will be cleared by this operation. */
27793 if (!updated_row
->full_width_p
)
27794 notice_overwritten_cursor (w
, updated_area
,
27795 w
->output_cursor
.x
, -1,
27797 MATRIX_ROW_BOTTOM_Y (updated_row
));
27799 from_x
= w
->output_cursor
.x
;
27801 /* Translate to frame coordinates. */
27802 if (updated_row
->full_width_p
)
27804 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
27805 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
27809 int area_left
= window_box_left (w
, updated_area
);
27810 from_x
+= area_left
;
27814 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
27815 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
27816 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
27818 /* Prevent inadvertently clearing to end of the X window. */
27819 if (to_x
> from_x
&& to_y
> from_y
)
27822 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
27823 to_x
- from_x
, to_y
- from_y
);
27828 #endif /* HAVE_WINDOW_SYSTEM */
27832 /***********************************************************************
27834 ***********************************************************************/
27836 /* Value is the internal representation of the specified cursor type
27837 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27838 of the bar cursor. */
27840 static enum text_cursor_kinds
27841 get_specified_cursor_type (Lisp_Object arg
, int *width
)
27843 enum text_cursor_kinds type
;
27848 if (EQ (arg
, Qbox
))
27849 return FILLED_BOX_CURSOR
;
27851 if (EQ (arg
, Qhollow
))
27852 return HOLLOW_BOX_CURSOR
;
27854 if (EQ (arg
, Qbar
))
27861 && EQ (XCAR (arg
), Qbar
)
27862 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27864 *width
= XINT (XCDR (arg
));
27868 if (EQ (arg
, Qhbar
))
27871 return HBAR_CURSOR
;
27875 && EQ (XCAR (arg
), Qhbar
)
27876 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27878 *width
= XINT (XCDR (arg
));
27879 return HBAR_CURSOR
;
27882 /* Treat anything unknown as "hollow box cursor".
27883 It was bad to signal an error; people have trouble fixing
27884 .Xdefaults with Emacs, when it has something bad in it. */
27885 type
= HOLLOW_BOX_CURSOR
;
27890 /* Set the default cursor types for specified frame. */
27892 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27897 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27898 FRAME_CURSOR_WIDTH (f
) = width
;
27900 /* By default, set up the blink-off state depending on the on-state. */
27902 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27905 FRAME_BLINK_OFF_CURSOR (f
)
27906 = get_specified_cursor_type (XCDR (tem
), &width
);
27907 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27910 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27912 /* Make sure the cursor gets redrawn. */
27913 f
->cursor_type_changed
= true;
27917 #ifdef HAVE_WINDOW_SYSTEM
27919 /* Return the cursor we want to be displayed in window W. Return
27920 width of bar/hbar cursor through WIDTH arg. Return with
27921 ACTIVE_CURSOR arg set to true if cursor in window W is `active'
27922 (i.e. if the `system caret' should track this cursor).
27924 In a mini-buffer window, we want the cursor only to appear if we
27925 are reading input from this window. For the selected window, we
27926 want the cursor type given by the frame parameter or buffer local
27927 setting of cursor-type. If explicitly marked off, draw no cursor.
27928 In all other cases, we want a hollow box cursor. */
27930 static enum text_cursor_kinds
27931 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27932 bool *active_cursor
)
27934 struct frame
*f
= XFRAME (w
->frame
);
27935 struct buffer
*b
= XBUFFER (w
->contents
);
27936 int cursor_type
= DEFAULT_CURSOR
;
27937 Lisp_Object alt_cursor
;
27938 bool non_selected
= false;
27940 *active_cursor
= true;
27943 if (cursor_in_echo_area
27944 && FRAME_HAS_MINIBUF_P (f
)
27945 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27947 if (w
== XWINDOW (echo_area_window
))
27949 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27951 *width
= FRAME_CURSOR_WIDTH (f
);
27952 return FRAME_DESIRED_CURSOR (f
);
27955 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27958 *active_cursor
= false;
27959 non_selected
= true;
27962 /* Detect a nonselected window or nonselected frame. */
27963 else if (w
!= XWINDOW (f
->selected_window
)
27964 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
27966 *active_cursor
= false;
27968 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
27971 non_selected
= true;
27974 /* Never display a cursor in a window in which cursor-type is nil. */
27975 if (NILP (BVAR (b
, cursor_type
)))
27978 /* Get the normal cursor type for this window. */
27979 if (EQ (BVAR (b
, cursor_type
), Qt
))
27981 cursor_type
= FRAME_DESIRED_CURSOR (f
);
27982 *width
= FRAME_CURSOR_WIDTH (f
);
27985 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27987 /* Use cursor-in-non-selected-windows instead
27988 for non-selected window or frame. */
27991 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
27992 if (!EQ (Qt
, alt_cursor
))
27993 return get_specified_cursor_type (alt_cursor
, width
);
27994 /* t means modify the normal cursor type. */
27995 if (cursor_type
== FILLED_BOX_CURSOR
)
27996 cursor_type
= HOLLOW_BOX_CURSOR
;
27997 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
27999 return cursor_type
;
28002 /* Use normal cursor if not blinked off. */
28003 if (!w
->cursor_off_p
)
28005 if (glyph
!= NULL
&& glyph
->type
== XWIDGET_GLYPH
)
28007 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
28009 if (cursor_type
== FILLED_BOX_CURSOR
)
28011 /* Using a block cursor on large images can be very annoying.
28012 So use a hollow cursor for "large" images.
28013 If image is not transparent (no mask), also use hollow cursor. */
28014 struct image
*img
= IMAGE_OPT_FROM_ID (f
, glyph
->u
.img_id
);
28015 if (img
!= NULL
&& IMAGEP (img
->spec
))
28017 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
28018 where N = size of default frame font size.
28019 This should cover most of the "tiny" icons people may use. */
28021 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
28022 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
28023 cursor_type
= HOLLOW_BOX_CURSOR
;
28026 else if (cursor_type
!= NO_CURSOR
)
28028 /* Display current only supports BOX and HOLLOW cursors for images.
28029 So for now, unconditionally use a HOLLOW cursor when cursor is
28030 not a solid box cursor. */
28031 cursor_type
= HOLLOW_BOX_CURSOR
;
28034 return cursor_type
;
28037 /* Cursor is blinked off, so determine how to "toggle" it. */
28039 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
28040 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
28041 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
28043 /* Then see if frame has specified a specific blink off cursor type. */
28044 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
28046 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
28047 return FRAME_BLINK_OFF_CURSOR (f
);
28051 /* Some people liked having a permanently visible blinking cursor,
28052 while others had very strong opinions against it. So it was
28053 decided to remove it. KFS 2003-09-03 */
28055 /* Finally perform built-in cursor blinking:
28056 filled box <-> hollow box
28057 wide [h]bar <-> narrow [h]bar
28058 narrow [h]bar <-> no cursor
28059 other type <-> no cursor */
28061 if (cursor_type
== FILLED_BOX_CURSOR
)
28062 return HOLLOW_BOX_CURSOR
;
28064 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
28067 return cursor_type
;
28075 /* Notice when the text cursor of window W has been completely
28076 overwritten by a drawing operation that outputs glyphs in AREA
28077 starting at X0 and ending at X1 in the line starting at Y0 and
28078 ending at Y1. X coordinates are area-relative. X1 < 0 means all
28079 the rest of the line after X0 has been written. Y coordinates
28080 are window-relative. */
28083 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
28084 int x0
, int x1
, int y0
, int y1
)
28086 int cx0
, cx1
, cy0
, cy1
;
28087 struct glyph_row
*row
;
28089 if (!w
->phys_cursor_on_p
)
28091 if (area
!= TEXT_AREA
)
28094 if (w
->phys_cursor
.vpos
< 0
28095 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
28096 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
28097 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
28100 if (row
->cursor_in_fringe_p
)
28102 row
->cursor_in_fringe_p
= false;
28103 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
28104 w
->phys_cursor_on_p
= false;
28108 cx0
= w
->phys_cursor
.x
;
28109 cx1
= cx0
+ w
->phys_cursor_width
;
28110 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
28113 /* The cursor image will be completely removed from the
28114 screen if the output area intersects the cursor area in
28115 y-direction. When we draw in [y0 y1[, and some part of
28116 the cursor is at y < y0, that part must have been drawn
28117 before. When scrolling, the cursor is erased before
28118 actually scrolling, so we don't come here. When not
28119 scrolling, the rows above the old cursor row must have
28120 changed, and in this case these rows must have written
28121 over the cursor image.
28123 Likewise if part of the cursor is below y1, with the
28124 exception of the cursor being in the first blank row at
28125 the buffer and window end because update_text_area
28126 doesn't draw that row. (Except when it does, but
28127 that's handled in update_text_area.) */
28129 cy0
= w
->phys_cursor
.y
;
28130 cy1
= cy0
+ w
->phys_cursor_height
;
28131 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
28134 w
->phys_cursor_on_p
= false;
28137 #endif /* HAVE_WINDOW_SYSTEM */
28140 /************************************************************************
28142 ************************************************************************/
28144 #ifdef HAVE_WINDOW_SYSTEM
28147 Fix the display of area AREA of overlapping row ROW in window W
28148 with respect to the overlapping part OVERLAPS. */
28151 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
28152 enum glyph_row_area area
, int overlaps
)
28159 for (i
= 0; i
< row
->used
[area
];)
28161 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
28163 int start
= i
, start_x
= x
;
28167 x
+= row
->glyphs
[area
][i
].pixel_width
;
28170 while (i
< row
->used
[area
]
28171 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
28173 draw_glyphs (w
, start_x
, row
, area
,
28175 DRAW_NORMAL_TEXT
, overlaps
);
28179 x
+= row
->glyphs
[area
][i
].pixel_width
;
28189 Draw the cursor glyph of window W in glyph row ROW. See the
28190 comment of draw_glyphs for the meaning of HL. */
28193 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
28194 enum draw_glyphs_face hl
)
28196 /* If cursor hpos is out of bounds, don't draw garbage. This can
28197 happen in mini-buffer windows when switching between echo area
28198 glyphs and mini-buffer. */
28199 if ((row
->reversed_p
28200 ? (w
->phys_cursor
.hpos
>= 0)
28201 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
28203 bool on_p
= w
->phys_cursor_on_p
;
28205 int hpos
= w
->phys_cursor
.hpos
;
28207 /* When the window is hscrolled, cursor hpos can legitimately be
28208 out of bounds, but we draw the cursor at the corresponding
28209 window margin in that case. */
28210 if (!row
->reversed_p
&& hpos
< 0)
28212 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28213 hpos
= row
->used
[TEXT_AREA
] - 1;
28215 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
28217 w
->phys_cursor_on_p
= on_p
;
28219 if (hl
== DRAW_CURSOR
)
28220 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
28221 /* When we erase the cursor, and ROW is overlapped by other
28222 rows, make sure that these overlapping parts of other rows
28224 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
28226 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
28228 if (row
> w
->current_matrix
->rows
28229 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
28230 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
28231 OVERLAPS_ERASED_CURSOR
);
28233 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
28234 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
28235 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
28236 OVERLAPS_ERASED_CURSOR
);
28242 /* Erase the image of a cursor of window W from the screen. */
28245 erase_phys_cursor (struct window
*w
)
28247 struct frame
*f
= XFRAME (w
->frame
);
28248 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28249 int hpos
= w
->phys_cursor
.hpos
;
28250 int vpos
= w
->phys_cursor
.vpos
;
28251 bool mouse_face_here_p
= false;
28252 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
28253 struct glyph_row
*cursor_row
;
28254 struct glyph
*cursor_glyph
;
28255 enum draw_glyphs_face hl
;
28257 /* No cursor displayed or row invalidated => nothing to do on the
28259 if (w
->phys_cursor_type
== NO_CURSOR
)
28260 goto mark_cursor_off
;
28262 /* VPOS >= active_glyphs->nrows means that window has been resized.
28263 Don't bother to erase the cursor. */
28264 if (vpos
>= active_glyphs
->nrows
)
28265 goto mark_cursor_off
;
28267 /* If row containing cursor is marked invalid, there is nothing we
28269 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
28270 if (!cursor_row
->enabled_p
)
28271 goto mark_cursor_off
;
28273 /* If line spacing is > 0, old cursor may only be partially visible in
28274 window after split-window. So adjust visible height. */
28275 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
28276 window_text_bottom_y (w
) - cursor_row
->y
);
28278 /* If row is completely invisible, don't attempt to delete a cursor which
28279 isn't there. This can happen if cursor is at top of a window, and
28280 we switch to a buffer with a header line in that window. */
28281 if (cursor_row
->visible_height
<= 0)
28282 goto mark_cursor_off
;
28284 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
28285 if (cursor_row
->cursor_in_fringe_p
)
28287 cursor_row
->cursor_in_fringe_p
= false;
28288 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
28289 goto mark_cursor_off
;
28292 /* This can happen when the new row is shorter than the old one.
28293 In this case, either draw_glyphs or clear_end_of_line
28294 should have cleared the cursor. Note that we wouldn't be
28295 able to erase the cursor in this case because we don't have a
28296 cursor glyph at hand. */
28297 if ((cursor_row
->reversed_p
28298 ? (w
->phys_cursor
.hpos
< 0)
28299 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
28300 goto mark_cursor_off
;
28302 /* When the window is hscrolled, cursor hpos can legitimately be out
28303 of bounds, but we draw the cursor at the corresponding window
28304 margin in that case. */
28305 if (!cursor_row
->reversed_p
&& hpos
< 0)
28307 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
28308 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
28310 /* If the cursor is in the mouse face area, redisplay that when
28311 we clear the cursor. */
28312 if (! NILP (hlinfo
->mouse_face_window
)
28313 && coords_in_mouse_face_p (w
, hpos
, vpos
)
28314 /* Don't redraw the cursor's spot in mouse face if it is at the
28315 end of a line (on a newline). The cursor appears there, but
28316 mouse highlighting does not. */
28317 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
28318 mouse_face_here_p
= true;
28320 /* Maybe clear the display under the cursor. */
28321 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
28324 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
28327 cursor_glyph
= get_phys_cursor_glyph (w
);
28328 if (cursor_glyph
== NULL
)
28329 goto mark_cursor_off
;
28331 width
= cursor_glyph
->pixel_width
;
28332 x
= w
->phys_cursor
.x
;
28338 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
28339 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
28340 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
28343 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
28346 /* Erase the cursor by redrawing the character underneath it. */
28347 if (mouse_face_here_p
)
28348 hl
= DRAW_MOUSE_FACE
;
28350 hl
= DRAW_NORMAL_TEXT
;
28351 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
28354 w
->phys_cursor_on_p
= false;
28355 w
->phys_cursor_type
= NO_CURSOR
;
28359 /* Display or clear cursor of window W. If !ON, clear the cursor.
28360 If ON, display the cursor; where to put the cursor is specified by
28361 HPOS, VPOS, X and Y. */
28364 display_and_set_cursor (struct window
*w
, bool on
,
28365 int hpos
, int vpos
, int x
, int y
)
28367 struct frame
*f
= XFRAME (w
->frame
);
28368 int new_cursor_type
;
28369 int new_cursor_width
;
28370 bool active_cursor
;
28371 struct glyph_row
*glyph_row
;
28372 struct glyph
*glyph
;
28374 /* This is pointless on invisible frames, and dangerous on garbaged
28375 windows and frames; in the latter case, the frame or window may
28376 be in the midst of changing its size, and x and y may be off the
28378 if (! FRAME_VISIBLE_P (f
)
28379 || FRAME_GARBAGED_P (f
)
28380 || vpos
>= w
->current_matrix
->nrows
28381 || hpos
>= w
->current_matrix
->matrix_w
)
28384 /* If cursor is off and we want it off, return quickly. */
28385 if (!on
&& !w
->phys_cursor_on_p
)
28388 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28389 /* If cursor row is not enabled, we don't really know where to
28390 display the cursor. */
28391 if (!glyph_row
->enabled_p
)
28393 w
->phys_cursor_on_p
= false;
28398 if (!glyph_row
->exact_window_width_line_p
28399 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
28400 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
28402 eassert (input_blocked_p ());
28404 /* Set new_cursor_type to the cursor we want to be displayed. */
28405 new_cursor_type
= get_window_cursor_type (w
, glyph
,
28406 &new_cursor_width
, &active_cursor
);
28408 /* If cursor is currently being shown and we don't want it to be or
28409 it is in the wrong place, or the cursor type is not what we want,
28411 if (w
->phys_cursor_on_p
28413 || w
->phys_cursor
.x
!= x
28414 || w
->phys_cursor
.y
!= y
28415 /* HPOS can be negative in R2L rows whose
28416 exact_window_width_line_p flag is set (i.e. their newline
28417 would "overflow into the fringe"). */
28419 || new_cursor_type
!= w
->phys_cursor_type
28420 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
28421 && new_cursor_width
!= w
->phys_cursor_width
)))
28422 erase_phys_cursor (w
);
28424 /* Don't check phys_cursor_on_p here because that flag is only set
28425 to false in some cases where we know that the cursor has been
28426 completely erased, to avoid the extra work of erasing the cursor
28427 twice. In other words, phys_cursor_on_p can be true and the cursor
28428 still not be visible, or it has only been partly erased. */
28431 w
->phys_cursor_ascent
= glyph_row
->ascent
;
28432 w
->phys_cursor_height
= glyph_row
->height
;
28434 /* Set phys_cursor_.* before x_draw_.* is called because some
28435 of them may need the information. */
28436 w
->phys_cursor
.x
= x
;
28437 w
->phys_cursor
.y
= glyph_row
->y
;
28438 w
->phys_cursor
.hpos
= hpos
;
28439 w
->phys_cursor
.vpos
= vpos
;
28442 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
28443 new_cursor_type
, new_cursor_width
,
28444 on
, active_cursor
);
28448 /* Switch the display of W's cursor on or off, according to the value
28452 update_window_cursor (struct window
*w
, bool on
)
28454 /* Don't update cursor in windows whose frame is in the process
28455 of being deleted. */
28456 if (w
->current_matrix
)
28458 int hpos
= w
->phys_cursor
.hpos
;
28459 int vpos
= w
->phys_cursor
.vpos
;
28460 struct glyph_row
*row
;
28462 if (vpos
>= w
->current_matrix
->nrows
28463 || hpos
>= w
->current_matrix
->matrix_w
)
28466 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28468 /* When the window is hscrolled, cursor hpos can legitimately be
28469 out of bounds, but we draw the cursor at the corresponding
28470 window margin in that case. */
28471 if (!row
->reversed_p
&& hpos
< 0)
28473 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28474 hpos
= row
->used
[TEXT_AREA
] - 1;
28477 display_and_set_cursor (w
, on
, hpos
, vpos
,
28478 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28484 /* Call update_window_cursor with parameter ON_P on all leaf windows
28485 in the window tree rooted at W. */
28488 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
28492 if (WINDOWP (w
->contents
))
28493 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
28495 update_window_cursor (w
, on_p
);
28497 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
28503 Display the cursor on window W, or clear it, according to ON_P.
28504 Don't change the cursor's position. */
28507 x_update_cursor (struct frame
*f
, bool on_p
)
28509 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
28514 Clear the cursor of window W to background color, and mark the
28515 cursor as not shown. This is used when the text where the cursor
28516 is about to be rewritten. */
28519 x_clear_cursor (struct window
*w
)
28521 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
28522 update_window_cursor (w
, false);
28525 #endif /* HAVE_WINDOW_SYSTEM */
28527 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
28530 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
28531 int start_hpos
, int end_hpos
,
28532 enum draw_glyphs_face draw
)
28534 #ifdef HAVE_WINDOW_SYSTEM
28535 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
28537 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
28541 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
28542 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
28546 /* Display the active region described by mouse_face_* according to DRAW. */
28549 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
28551 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
28552 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28554 if (/* If window is in the process of being destroyed, don't bother
28556 w
->current_matrix
!= NULL
28557 /* Don't update mouse highlight if hidden. */
28558 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
28559 /* Recognize when we are called to operate on rows that don't exist
28560 anymore. This can happen when a window is split. */
28561 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
28563 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
28564 struct glyph_row
*row
, *first
, *last
;
28566 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
28567 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
28569 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
28571 int start_hpos
, end_hpos
, start_x
;
28573 /* For all but the first row, the highlight starts at column 0. */
28576 /* R2L rows have BEG and END in reversed order, but the
28577 screen drawing geometry is always left to right. So
28578 we need to mirror the beginning and end of the
28579 highlighted area in R2L rows. */
28580 if (!row
->reversed_p
)
28582 start_hpos
= hlinfo
->mouse_face_beg_col
;
28583 start_x
= hlinfo
->mouse_face_beg_x
;
28585 else if (row
== last
)
28587 start_hpos
= hlinfo
->mouse_face_end_col
;
28588 start_x
= hlinfo
->mouse_face_end_x
;
28596 else if (row
->reversed_p
&& row
== last
)
28598 start_hpos
= hlinfo
->mouse_face_end_col
;
28599 start_x
= hlinfo
->mouse_face_end_x
;
28609 if (!row
->reversed_p
)
28610 end_hpos
= hlinfo
->mouse_face_end_col
;
28611 else if (row
== first
)
28612 end_hpos
= hlinfo
->mouse_face_beg_col
;
28615 end_hpos
= row
->used
[TEXT_AREA
];
28616 if (draw
== DRAW_NORMAL_TEXT
)
28617 row
->fill_line_p
= true; /* Clear to end of line. */
28620 else if (row
->reversed_p
&& row
== first
)
28621 end_hpos
= hlinfo
->mouse_face_beg_col
;
28624 end_hpos
= row
->used
[TEXT_AREA
];
28625 if (draw
== DRAW_NORMAL_TEXT
)
28626 row
->fill_line_p
= true; /* Clear to end of line. */
28629 if (end_hpos
> start_hpos
)
28631 draw_row_with_mouse_face (w
, start_x
, row
,
28632 start_hpos
, end_hpos
, draw
);
28635 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
28639 #ifdef HAVE_WINDOW_SYSTEM
28640 /* When we've written over the cursor, arrange for it to
28641 be displayed again. */
28642 if (FRAME_WINDOW_P (f
)
28643 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
28645 int hpos
= w
->phys_cursor
.hpos
;
28647 /* When the window is hscrolled, cursor hpos can legitimately be
28648 out of bounds, but we draw the cursor at the corresponding
28649 window margin in that case. */
28650 if (!row
->reversed_p
&& hpos
< 0)
28652 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28653 hpos
= row
->used
[TEXT_AREA
] - 1;
28656 display_and_set_cursor (w
, true, hpos
, w
->phys_cursor
.vpos
,
28657 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28660 #endif /* HAVE_WINDOW_SYSTEM */
28663 #ifdef HAVE_WINDOW_SYSTEM
28664 /* Change the mouse cursor. */
28665 if (FRAME_WINDOW_P (f
) && NILP (do_mouse_tracking
))
28667 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
28668 if (draw
== DRAW_NORMAL_TEXT
28669 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
28670 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
28673 if (draw
== DRAW_MOUSE_FACE
)
28674 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
28676 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
28678 #endif /* HAVE_WINDOW_SYSTEM */
28682 Clear out the mouse-highlighted active region.
28683 Redraw it un-highlighted first. Value is true if mouse
28684 face was actually drawn unhighlighted. */
28687 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
28690 = !hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
);
28692 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
28693 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28694 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28695 hlinfo
->mouse_face_window
= Qnil
;
28696 hlinfo
->mouse_face_overlay
= Qnil
;
28700 /* Return true if the coordinates HPOS and VPOS on windows W are
28701 within the mouse face on that window. */
28703 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
28705 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28707 /* Quickly resolve the easy cases. */
28708 if (!(WINDOWP (hlinfo
->mouse_face_window
)
28709 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
28711 if (vpos
< hlinfo
->mouse_face_beg_row
28712 || vpos
> hlinfo
->mouse_face_end_row
)
28714 if (vpos
> hlinfo
->mouse_face_beg_row
28715 && vpos
< hlinfo
->mouse_face_end_row
)
28718 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
28720 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28722 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
28725 else if ((vpos
== hlinfo
->mouse_face_beg_row
28726 && hpos
>= hlinfo
->mouse_face_beg_col
)
28727 || (vpos
== hlinfo
->mouse_face_end_row
28728 && hpos
< hlinfo
->mouse_face_end_col
))
28733 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28735 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
28738 else if ((vpos
== hlinfo
->mouse_face_beg_row
28739 && hpos
<= hlinfo
->mouse_face_beg_col
)
28740 || (vpos
== hlinfo
->mouse_face_end_row
28741 && hpos
> hlinfo
->mouse_face_end_col
))
28749 True if physical cursor of window W is within mouse face. */
28752 cursor_in_mouse_face_p (struct window
*w
)
28754 int hpos
= w
->phys_cursor
.hpos
;
28755 int vpos
= w
->phys_cursor
.vpos
;
28756 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28758 /* When the window is hscrolled, cursor hpos can legitimately be out
28759 of bounds, but we draw the cursor at the corresponding window
28760 margin in that case. */
28761 if (!row
->reversed_p
&& hpos
< 0)
28763 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28764 hpos
= row
->used
[TEXT_AREA
] - 1;
28766 return coords_in_mouse_face_p (w
, hpos
, vpos
);
28771 /* Find the glyph rows START_ROW and END_ROW of window W that display
28772 characters between buffer positions START_CHARPOS and END_CHARPOS
28773 (excluding END_CHARPOS). DISP_STRING is a display string that
28774 covers these buffer positions. This is similar to
28775 row_containing_pos, but is more accurate when bidi reordering makes
28776 buffer positions change non-linearly with glyph rows. */
28778 rows_from_pos_range (struct window
*w
,
28779 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
28780 Lisp_Object disp_string
,
28781 struct glyph_row
**start
, struct glyph_row
**end
)
28783 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28784 int last_y
= window_text_bottom_y (w
);
28785 struct glyph_row
*row
;
28790 while (!first
->enabled_p
28791 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
28794 /* Find the START row. */
28796 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
28799 /* A row can potentially be the START row if the range of the
28800 characters it displays intersects the range
28801 [START_CHARPOS..END_CHARPOS). */
28802 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
28803 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
28804 /* See the commentary in row_containing_pos, for the
28805 explanation of the complicated way to check whether
28806 some position is beyond the end of the characters
28807 displayed by a row. */
28808 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28809 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28810 && !row
->ends_at_zv_p
28811 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
28812 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28813 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28814 && !row
->ends_at_zv_p
28815 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
28817 /* Found a candidate row. Now make sure at least one of the
28818 glyphs it displays has a charpos from the range
28819 [START_CHARPOS..END_CHARPOS).
28821 This is not obvious because bidi reordering could make
28822 buffer positions of a row be 1,2,3,102,101,100, and if we
28823 want to highlight characters in [50..60), we don't want
28824 this row, even though [50..60) does intersect [1..103),
28825 the range of character positions given by the row's start
28826 and end positions. */
28827 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
28828 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
28832 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28833 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28834 /* A glyph that comes from DISP_STRING is by
28835 definition to be highlighted. */
28836 || EQ (g
->object
, disp_string
))
28845 /* Find the END row. */
28847 /* If the last row is partially visible, start looking for END
28848 from that row, instead of starting from FIRST. */
28849 && !(row
->enabled_p
28850 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
28852 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
28854 struct glyph_row
*next
= row
+ 1;
28855 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
28857 if (!next
->enabled_p
28858 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
28859 /* The first row >= START whose range of displayed characters
28860 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28861 is the row END + 1. */
28862 || (start_charpos
< next_start
28863 && end_charpos
< next_start
)
28864 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28865 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28866 && !next
->ends_at_zv_p
28867 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28868 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28869 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28870 && !next
->ends_at_zv_p
28871 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28878 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28879 but none of the characters it displays are in the range, it is
28881 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28882 struct glyph
*s
= g
;
28883 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28887 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28888 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28889 /* If the buffer position of the first glyph in
28890 the row is equal to END_CHARPOS, it means
28891 the last character to be highlighted is the
28892 newline of ROW, and we must consider NEXT as
28894 || (((!next
->reversed_p
&& g
== s
)
28895 || (next
->reversed_p
&& g
== e
- 1))
28896 && (g
->charpos
== end_charpos
28897 /* Special case for when NEXT is an
28898 empty line at ZV. */
28899 || (g
->charpos
== -1
28900 && !row
->ends_at_zv_p
28901 && next_start
== end_charpos
)))))
28902 /* A glyph that comes from DISP_STRING is by
28903 definition to be highlighted. */
28904 || EQ (g
->object
, disp_string
))
28913 /* The first row that ends at ZV must be the last to be
28915 else if (next
->ends_at_zv_p
)
28924 /* This function sets the mouse_face_* elements of HLINFO, assuming
28925 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28926 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28927 for the overlay or run of text properties specifying the mouse
28928 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28929 before-string and after-string that must also be highlighted.
28930 DISP_STRING, if non-nil, is a display string that may cover some
28931 or all of the highlighted text. */
28934 mouse_face_from_buffer_pos (Lisp_Object window
,
28935 Mouse_HLInfo
*hlinfo
,
28936 ptrdiff_t mouse_charpos
,
28937 ptrdiff_t start_charpos
,
28938 ptrdiff_t end_charpos
,
28939 Lisp_Object before_string
,
28940 Lisp_Object after_string
,
28941 Lisp_Object disp_string
)
28943 struct window
*w
= XWINDOW (window
);
28944 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28945 struct glyph_row
*r1
, *r2
;
28946 struct glyph
*glyph
, *end
;
28947 ptrdiff_t ignore
, pos
;
28950 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28951 eassert (NILP (before_string
) || STRINGP (before_string
));
28952 eassert (NILP (after_string
) || STRINGP (after_string
));
28954 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28955 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
28957 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28958 /* If the before-string or display-string contains newlines,
28959 rows_from_pos_range skips to its last row. Move back. */
28960 if (!NILP (before_string
) || !NILP (disp_string
))
28962 struct glyph_row
*prev
;
28963 while ((prev
= r1
- 1, prev
>= first
)
28964 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
28965 && prev
->used
[TEXT_AREA
] > 0)
28967 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
28968 glyph
= beg
+ prev
->used
[TEXT_AREA
];
28969 while (--glyph
>= beg
&& NILP (glyph
->object
));
28971 || !(EQ (glyph
->object
, before_string
)
28972 || EQ (glyph
->object
, disp_string
)))
28979 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28980 hlinfo
->mouse_face_past_end
= true;
28982 else if (!NILP (after_string
))
28984 /* If the after-string has newlines, advance to its last row. */
28985 struct glyph_row
*next
;
28986 struct glyph_row
*last
28987 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28989 for (next
= r2
+ 1;
28991 && next
->used
[TEXT_AREA
] > 0
28992 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
28996 /* The rest of the display engine assumes that mouse_face_beg_row is
28997 either above mouse_face_end_row or identical to it. But with
28998 bidi-reordered continued lines, the row for START_CHARPOS could
28999 be below the row for END_CHARPOS. If so, swap the rows and store
29000 them in correct order. */
29003 struct glyph_row
*tem
= r2
;
29009 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
29010 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
29012 /* For a bidi-reordered row, the positions of BEFORE_STRING,
29013 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
29014 could be anywhere in the row and in any order. The strategy
29015 below is to find the leftmost and the rightmost glyph that
29016 belongs to either of these 3 strings, or whose position is
29017 between START_CHARPOS and END_CHARPOS, and highlight all the
29018 glyphs between those two. This may cover more than just the text
29019 between START_CHARPOS and END_CHARPOS if the range of characters
29020 strides the bidi level boundary, e.g. if the beginning is in R2L
29021 text while the end is in L2R text or vice versa. */
29022 if (!r1
->reversed_p
)
29024 /* This row is in a left to right paragraph. Scan it left to
29026 glyph
= r1
->glyphs
[TEXT_AREA
];
29027 end
= glyph
+ r1
->used
[TEXT_AREA
];
29030 /* Skip truncation glyphs at the start of the glyph row. */
29031 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
29033 && NILP (glyph
->object
)
29034 && glyph
->charpos
< 0;
29036 x
+= glyph
->pixel_width
;
29038 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
29039 or DISP_STRING, and the first glyph from buffer whose
29040 position is between START_CHARPOS and END_CHARPOS. */
29042 && !NILP (glyph
->object
)
29043 && !EQ (glyph
->object
, disp_string
)
29044 && !(BUFFERP (glyph
->object
)
29045 && (glyph
->charpos
>= start_charpos
29046 && glyph
->charpos
< end_charpos
));
29049 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29050 are present at buffer positions between START_CHARPOS and
29051 END_CHARPOS, or if they come from an overlay. */
29052 if (EQ (glyph
->object
, before_string
))
29054 pos
= string_buffer_position (before_string
,
29056 /* If pos == 0, it means before_string came from an
29057 overlay, not from a buffer position. */
29058 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29061 else if (EQ (glyph
->object
, after_string
))
29063 pos
= string_buffer_position (after_string
, end_charpos
);
29064 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29067 x
+= glyph
->pixel_width
;
29069 hlinfo
->mouse_face_beg_x
= x
;
29070 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
29074 /* This row is in a right to left paragraph. Scan it right to
29078 end
= r1
->glyphs
[TEXT_AREA
] - 1;
29079 glyph
= end
+ r1
->used
[TEXT_AREA
];
29081 /* Skip truncation glyphs at the start of the glyph row. */
29082 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
29084 && NILP (glyph
->object
)
29085 && glyph
->charpos
< 0;
29089 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
29090 or DISP_STRING, and the first glyph from buffer whose
29091 position is between START_CHARPOS and END_CHARPOS. */
29093 && !NILP (glyph
->object
)
29094 && !EQ (glyph
->object
, disp_string
)
29095 && !(BUFFERP (glyph
->object
)
29096 && (glyph
->charpos
>= start_charpos
29097 && glyph
->charpos
< end_charpos
));
29100 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29101 are present at buffer positions between START_CHARPOS and
29102 END_CHARPOS, or if they come from an overlay. */
29103 if (EQ (glyph
->object
, before_string
))
29105 pos
= string_buffer_position (before_string
, start_charpos
);
29106 /* If pos == 0, it means before_string came from an
29107 overlay, not from a buffer position. */
29108 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29111 else if (EQ (glyph
->object
, after_string
))
29113 pos
= string_buffer_position (after_string
, end_charpos
);
29114 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29119 glyph
++; /* first glyph to the right of the highlighted area */
29120 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
29121 x
+= g
->pixel_width
;
29122 hlinfo
->mouse_face_beg_x
= x
;
29123 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
29126 /* If the highlight ends in a different row, compute GLYPH and END
29127 for the end row. Otherwise, reuse the values computed above for
29128 the row where the highlight begins. */
29131 if (!r2
->reversed_p
)
29133 glyph
= r2
->glyphs
[TEXT_AREA
];
29134 end
= glyph
+ r2
->used
[TEXT_AREA
];
29139 end
= r2
->glyphs
[TEXT_AREA
] - 1;
29140 glyph
= end
+ r2
->used
[TEXT_AREA
];
29144 if (!r2
->reversed_p
)
29146 /* Skip truncation and continuation glyphs near the end of the
29147 row, and also blanks and stretch glyphs inserted by
29148 extend_face_to_end_of_line. */
29150 && NILP ((end
- 1)->object
))
29152 /* Scan the rest of the glyph row from the end, looking for the
29153 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
29154 DISP_STRING, or whose position is between START_CHARPOS
29158 && !NILP (end
->object
)
29159 && !EQ (end
->object
, disp_string
)
29160 && !(BUFFERP (end
->object
)
29161 && (end
->charpos
>= start_charpos
29162 && end
->charpos
< end_charpos
));
29165 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29166 are present at buffer positions between START_CHARPOS and
29167 END_CHARPOS, or if they come from an overlay. */
29168 if (EQ (end
->object
, before_string
))
29170 pos
= string_buffer_position (before_string
, start_charpos
);
29171 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29174 else if (EQ (end
->object
, after_string
))
29176 pos
= string_buffer_position (after_string
, end_charpos
);
29177 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29181 /* Find the X coordinate of the last glyph to be highlighted. */
29182 for (; glyph
<= end
; ++glyph
)
29183 x
+= glyph
->pixel_width
;
29185 hlinfo
->mouse_face_end_x
= x
;
29186 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
29190 /* Skip truncation and continuation glyphs near the end of the
29191 row, and also blanks and stretch glyphs inserted by
29192 extend_face_to_end_of_line. */
29196 && NILP (end
->object
))
29198 x
+= end
->pixel_width
;
29201 /* Scan the rest of the glyph row from the end, looking for the
29202 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
29203 DISP_STRING, or whose position is between START_CHARPOS
29207 && !NILP (end
->object
)
29208 && !EQ (end
->object
, disp_string
)
29209 && !(BUFFERP (end
->object
)
29210 && (end
->charpos
>= start_charpos
29211 && end
->charpos
< end_charpos
));
29214 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29215 are present at buffer positions between START_CHARPOS and
29216 END_CHARPOS, or if they come from an overlay. */
29217 if (EQ (end
->object
, before_string
))
29219 pos
= string_buffer_position (before_string
, start_charpos
);
29220 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29223 else if (EQ (end
->object
, after_string
))
29225 pos
= string_buffer_position (after_string
, end_charpos
);
29226 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29229 x
+= end
->pixel_width
;
29231 /* If we exited the above loop because we arrived at the last
29232 glyph of the row, and its buffer position is still not in
29233 range, it means the last character in range is the preceding
29234 newline. Bump the end column and x values to get past the
29237 && BUFFERP (end
->object
)
29238 && (end
->charpos
< start_charpos
29239 || end
->charpos
>= end_charpos
))
29241 x
+= end
->pixel_width
;
29244 hlinfo
->mouse_face_end_x
= x
;
29245 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
29248 hlinfo
->mouse_face_window
= window
;
29249 hlinfo
->mouse_face_face_id
29250 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
29252 !hlinfo
->mouse_face_hidden
, -1);
29253 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29256 /* The following function is not used anymore (replaced with
29257 mouse_face_from_string_pos), but I leave it here for the time
29258 being, in case someone would. */
29260 #if false /* not used */
29262 /* Find the position of the glyph for position POS in OBJECT in
29263 window W's current matrix, and return in *X, *Y the pixel
29264 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
29266 RIGHT_P means return the position of the right edge of the glyph.
29267 !RIGHT_P means return the left edge position.
29269 If no glyph for POS exists in the matrix, return the position of
29270 the glyph with the next smaller position that is in the matrix, if
29271 RIGHT_P is false. If RIGHT_P, and no glyph for POS
29272 exists in the matrix, return the position of the glyph with the
29273 next larger position in OBJECT.
29275 Value is true if a glyph was found. */
29278 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
29279 int *hpos
, int *vpos
, int *x
, int *y
, bool right_p
)
29281 int yb
= window_text_bottom_y (w
);
29282 struct glyph_row
*r
;
29283 struct glyph
*best_glyph
= NULL
;
29284 struct glyph_row
*best_row
= NULL
;
29287 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
29288 r
->enabled_p
&& r
->y
< yb
;
29291 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
29292 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
29295 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
29296 if (EQ (g
->object
, object
))
29298 if (g
->charpos
== pos
)
29305 else if (best_glyph
== NULL
29306 || ((eabs (g
->charpos
- pos
)
29307 < eabs (best_glyph
->charpos
- pos
))
29310 : g
->charpos
> pos
)))
29324 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
29328 *x
+= best_glyph
->pixel_width
;
29333 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
29336 return best_glyph
!= NULL
;
29338 #endif /* not used */
29340 /* Find the positions of the first and the last glyphs in window W's
29341 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
29342 (assumed to be a string), and return in HLINFO's mouse_face_*
29343 members the pixel and column/row coordinates of those glyphs. */
29346 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
29347 Lisp_Object object
,
29348 ptrdiff_t startpos
, ptrdiff_t endpos
)
29350 int yb
= window_text_bottom_y (w
);
29351 struct glyph_row
*r
;
29352 struct glyph
*g
, *e
;
29354 bool found
= false;
29356 /* Find the glyph row with at least one position in the range
29357 [STARTPOS..ENDPOS), and the first glyph in that row whose
29358 position belongs to that range. */
29359 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
29360 r
->enabled_p
&& r
->y
< yb
;
29363 if (!r
->reversed_p
)
29365 g
= r
->glyphs
[TEXT_AREA
];
29366 e
= g
+ r
->used
[TEXT_AREA
];
29367 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
29368 if (EQ (g
->object
, object
)
29369 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29371 hlinfo
->mouse_face_beg_row
29372 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29373 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29374 hlinfo
->mouse_face_beg_x
= gx
;
29383 e
= r
->glyphs
[TEXT_AREA
];
29384 g
= e
+ r
->used
[TEXT_AREA
];
29385 for ( ; g
> e
; --g
)
29386 if (EQ ((g
-1)->object
, object
)
29387 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
29389 hlinfo
->mouse_face_beg_row
29390 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29391 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29392 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
29393 gx
+= g1
->pixel_width
;
29394 hlinfo
->mouse_face_beg_x
= gx
;
29406 /* Starting with the next row, look for the first row which does NOT
29407 include any glyphs whose positions are in the range. */
29408 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
29410 g
= r
->glyphs
[TEXT_AREA
];
29411 e
= g
+ r
->used
[TEXT_AREA
];
29413 for ( ; g
< e
; ++g
)
29414 if (EQ (g
->object
, object
)
29415 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29424 /* The highlighted region ends on the previous row. */
29427 /* Set the end row. */
29428 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29430 /* Compute and set the end column and the end column's horizontal
29431 pixel coordinate. */
29432 if (!r
->reversed_p
)
29434 g
= r
->glyphs
[TEXT_AREA
];
29435 e
= g
+ r
->used
[TEXT_AREA
];
29436 for ( ; e
> g
; --e
)
29437 if (EQ ((e
-1)->object
, object
)
29438 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
29440 hlinfo
->mouse_face_end_col
= e
- g
;
29442 for (gx
= r
->x
; g
< e
; ++g
)
29443 gx
+= g
->pixel_width
;
29444 hlinfo
->mouse_face_end_x
= gx
;
29448 e
= r
->glyphs
[TEXT_AREA
];
29449 g
= e
+ r
->used
[TEXT_AREA
];
29450 for (gx
= r
->x
; e
< g
; ++e
)
29452 if (EQ (e
->object
, object
)
29453 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
29455 gx
+= e
->pixel_width
;
29457 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
29458 hlinfo
->mouse_face_end_x
= gx
;
29462 #ifdef HAVE_WINDOW_SYSTEM
29464 /* See if position X, Y is within a hot-spot of an image. */
29467 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
29469 if (!CONSP (hot_spot
))
29472 if (EQ (XCAR (hot_spot
), Qrect
))
29474 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
29475 Lisp_Object rect
= XCDR (hot_spot
);
29479 if (!CONSP (XCAR (rect
)))
29481 if (!CONSP (XCDR (rect
)))
29483 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
29485 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
29487 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
29489 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
29493 else if (EQ (XCAR (hot_spot
), Qcircle
))
29495 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
29496 Lisp_Object circ
= XCDR (hot_spot
);
29497 Lisp_Object lr
, lx0
, ly0
;
29499 && CONSP (XCAR (circ
))
29500 && (lr
= XCDR (circ
), NUMBERP (lr
))
29501 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
29502 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
29504 double r
= XFLOATINT (lr
);
29505 double dx
= XINT (lx0
) - x
;
29506 double dy
= XINT (ly0
) - y
;
29507 return (dx
* dx
+ dy
* dy
<= r
* r
);
29510 else if (EQ (XCAR (hot_spot
), Qpoly
))
29512 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
29513 if (VECTORP (XCDR (hot_spot
)))
29515 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
29516 Lisp_Object
*poly
= v
->contents
;
29517 ptrdiff_t n
= v
->header
.size
;
29519 bool inside
= false;
29520 Lisp_Object lx
, ly
;
29523 /* Need an even number of coordinates, and at least 3 edges. */
29524 if (n
< 6 || n
& 1)
29527 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
29528 If count is odd, we are inside polygon. Pixels on edges
29529 may or may not be included depending on actual geometry of the
29531 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
29532 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
29534 x0
= XINT (lx
), y0
= XINT (ly
);
29535 for (i
= 0; i
< n
; i
+= 2)
29537 int x1
= x0
, y1
= y0
;
29538 if ((lx
= poly
[i
], !INTEGERP (lx
))
29539 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
29541 x0
= XINT (lx
), y0
= XINT (ly
);
29543 /* Does this segment cross the X line? */
29551 if (y
> y0
&& y
> y1
)
29553 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
29563 find_hot_spot (Lisp_Object map
, int x
, int y
)
29565 while (CONSP (map
))
29567 if (CONSP (XCAR (map
))
29568 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
29576 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
29578 doc
: /* Lookup in image map MAP coordinates X and Y.
29579 An image map is an alist where each element has the format (AREA ID PLIST).
29580 An AREA is specified as either a rectangle, a circle, or a polygon:
29581 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
29582 pixel coordinates of the upper left and bottom right corners.
29583 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
29584 and the radius of the circle; r may be a float or integer.
29585 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
29586 vector describes one corner in the polygon.
29587 Returns the alist element for the first matching AREA in MAP. */)
29588 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
29596 return find_hot_spot (map
,
29597 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
29598 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
29602 /* Display frame CURSOR, optionally using shape defined by POINTER. */
29604 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
29606 /* Do not change cursor shape while dragging mouse. */
29607 if (EQ (do_mouse_tracking
, Qdragging
))
29610 if (!NILP (pointer
))
29612 if (EQ (pointer
, Qarrow
))
29613 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29614 else if (EQ (pointer
, Qhand
))
29615 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
29616 else if (EQ (pointer
, Qtext
))
29617 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29618 else if (EQ (pointer
, intern ("hdrag")))
29619 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29620 else if (EQ (pointer
, intern ("nhdrag")))
29621 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29622 #ifdef HAVE_X_WINDOWS
29623 else if (EQ (pointer
, intern ("vdrag")))
29624 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29626 else if (EQ (pointer
, intern ("hourglass")))
29627 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
29628 else if (EQ (pointer
, Qmodeline
))
29629 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
29631 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29634 if (cursor
!= No_Cursor
)
29635 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
29638 #endif /* HAVE_WINDOW_SYSTEM */
29640 /* Take proper action when mouse has moved to the mode or header line
29641 or marginal area AREA of window W, x-position X and y-position Y.
29642 X is relative to the start of the text display area of W, so the
29643 width of bitmap areas and scroll bars must be subtracted to get a
29644 position relative to the start of the mode line. */
29647 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
29648 enum window_part area
)
29650 struct window
*w
= XWINDOW (window
);
29651 struct frame
*f
= XFRAME (w
->frame
);
29652 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29653 #ifdef HAVE_WINDOW_SYSTEM
29654 Display_Info
*dpyinfo
;
29656 Cursor cursor
= No_Cursor
;
29657 Lisp_Object pointer
= Qnil
;
29658 int dx
, dy
, width
, height
;
29660 Lisp_Object string
, object
= Qnil
;
29661 Lisp_Object pos
IF_LINT (= Qnil
), help
;
29663 Lisp_Object mouse_face
;
29664 int original_x_pixel
= x
;
29665 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
29666 struct glyph_row
*row
IF_LINT (= 0);
29668 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
29673 /* Kludge alert: mode_line_string takes X/Y in pixels, but
29674 returns them in row/column units! */
29675 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
29676 &object
, &dx
, &dy
, &width
, &height
);
29678 row
= (area
== ON_MODE_LINE
29679 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
29680 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
29682 /* Find the glyph under the mouse pointer. */
29683 if (row
->mode_line_p
&& row
->enabled_p
)
29685 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
29686 end
= glyph
+ row
->used
[TEXT_AREA
];
29688 for (x0
= original_x_pixel
;
29689 glyph
< end
&& x0
>= glyph
->pixel_width
;
29691 x0
-= glyph
->pixel_width
;
29699 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
29700 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
29701 returns them in row/column units! */
29702 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
29703 &object
, &dx
, &dy
, &width
, &height
);
29708 #ifdef HAVE_WINDOW_SYSTEM
29709 if (IMAGEP (object
))
29711 Lisp_Object image_map
, hotspot
;
29712 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
29714 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
29716 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29720 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
29721 If so, we could look for mouse-enter, mouse-leave
29722 properties in PLIST (and do something...). */
29723 hotspot
= XCDR (hotspot
);
29724 if (CONSP (hotspot
)
29725 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29727 pointer
= Fplist_get (plist
, Qpointer
);
29728 if (NILP (pointer
))
29730 help
= Fplist_get (plist
, Qhelp_echo
);
29733 help_echo_string
= help
;
29734 XSETWINDOW (help_echo_window
, w
);
29735 help_echo_object
= w
->contents
;
29736 help_echo_pos
= charpos
;
29740 if (NILP (pointer
))
29741 pointer
= Fplist_get (XCDR (object
), QCpointer
);
29743 #endif /* HAVE_WINDOW_SYSTEM */
29745 if (STRINGP (string
))
29746 pos
= make_number (charpos
);
29748 /* Set the help text and mouse pointer. If the mouse is on a part
29749 of the mode line without any text (e.g. past the right edge of
29750 the mode line text), use the default help text and pointer. */
29751 if (STRINGP (string
) || area
== ON_MODE_LINE
)
29753 /* Arrange to display the help by setting the global variables
29754 help_echo_string, help_echo_object, and help_echo_pos. */
29757 if (STRINGP (string
))
29758 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
29762 help_echo_string
= help
;
29763 XSETWINDOW (help_echo_window
, w
);
29764 help_echo_object
= string
;
29765 help_echo_pos
= charpos
;
29767 else if (area
== ON_MODE_LINE
)
29769 Lisp_Object default_help
29770 = buffer_local_value (Qmode_line_default_help_echo
,
29773 if (STRINGP (default_help
))
29775 help_echo_string
= default_help
;
29776 XSETWINDOW (help_echo_window
, w
);
29777 help_echo_object
= Qnil
;
29778 help_echo_pos
= -1;
29783 #ifdef HAVE_WINDOW_SYSTEM
29784 /* Change the mouse pointer according to what is under it. */
29785 if (FRAME_WINDOW_P (f
))
29787 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
29789 || NILP (Vresize_mini_windows
));
29791 dpyinfo
= FRAME_DISPLAY_INFO (f
);
29792 if (STRINGP (string
))
29794 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29796 if (NILP (pointer
))
29797 pointer
= Fget_text_property (pos
, Qpointer
, string
);
29799 /* Change the mouse pointer according to what is under X/Y. */
29801 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
29804 map
= Fget_text_property (pos
, Qlocal_map
, string
);
29805 if (!KEYMAPP (map
))
29806 map
= Fget_text_property (pos
, Qkeymap
, string
);
29807 if (!KEYMAPP (map
) && draggable
)
29808 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
29811 else if (draggable
)
29812 /* Default mode-line pointer. */
29813 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29818 /* Change the mouse face according to what is under X/Y. */
29819 bool mouse_face_shown
= false;
29820 if (STRINGP (string
))
29822 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
29823 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
29824 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29829 struct glyph
* tmp_glyph
;
29833 int total_pixel_width
;
29834 ptrdiff_t begpos
, endpos
, ignore
;
29838 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
29839 Qmouse_face
, string
, Qnil
);
29845 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
29847 endpos
= SCHARS (string
);
29851 /* Calculate the glyph position GPOS of GLYPH in the
29852 displayed string, relative to the beginning of the
29853 highlighted part of the string.
29855 Note: GPOS is different from CHARPOS. CHARPOS is the
29856 position of GLYPH in the internal string object. A mode
29857 line string format has structures which are converted to
29858 a flattened string by the Emacs Lisp interpreter. The
29859 internal string is an element of those structures. The
29860 displayed string is the flattened string. */
29861 tmp_glyph
= row_start_glyph
;
29862 while (tmp_glyph
< glyph
29863 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29864 && begpos
<= tmp_glyph
->charpos
29865 && tmp_glyph
->charpos
< endpos
)))
29867 gpos
= glyph
- tmp_glyph
;
29869 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29870 the highlighted part of the displayed string to which
29871 GLYPH belongs. Note: GSEQ_LENGTH is different from
29872 SCHARS (STRING), because the latter returns the length of
29873 the internal string. */
29874 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29876 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29877 && begpos
<= tmp_glyph
->charpos
29878 && tmp_glyph
->charpos
< endpos
));
29881 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29883 /* Calculate the total pixel width of all the glyphs between
29884 the beginning of the highlighted area and GLYPH. */
29885 total_pixel_width
= 0;
29886 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29887 total_pixel_width
+= tmp_glyph
->pixel_width
;
29889 /* Pre calculation of re-rendering position. Note: X is in
29890 column units here, after the call to mode_line_string or
29891 marginal_area_string. */
29893 vpos
= (area
== ON_MODE_LINE
29894 ? (w
->current_matrix
)->nrows
- 1
29897 /* If GLYPH's position is included in the region that is
29898 already drawn in mouse face, we have nothing to do. */
29899 if ( EQ (window
, hlinfo
->mouse_face_window
)
29900 && (!row
->reversed_p
29901 ? (hlinfo
->mouse_face_beg_col
<= hpos
29902 && hpos
< hlinfo
->mouse_face_end_col
)
29903 /* In R2L rows we swap BEG and END, see below. */
29904 : (hlinfo
->mouse_face_end_col
<= hpos
29905 && hpos
< hlinfo
->mouse_face_beg_col
))
29906 && hlinfo
->mouse_face_beg_row
== vpos
)
29909 if (clear_mouse_face (hlinfo
))
29910 cursor
= No_Cursor
;
29912 if (!row
->reversed_p
)
29914 hlinfo
->mouse_face_beg_col
= hpos
;
29915 hlinfo
->mouse_face_beg_x
= original_x_pixel
29916 - (total_pixel_width
+ dx
);
29917 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29918 hlinfo
->mouse_face_end_x
= 0;
29922 /* In R2L rows, show_mouse_face expects BEG and END
29923 coordinates to be swapped. */
29924 hlinfo
->mouse_face_end_col
= hpos
;
29925 hlinfo
->mouse_face_end_x
= original_x_pixel
29926 - (total_pixel_width
+ dx
);
29927 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29928 hlinfo
->mouse_face_beg_x
= 0;
29931 hlinfo
->mouse_face_beg_row
= vpos
;
29932 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29933 hlinfo
->mouse_face_past_end
= false;
29934 hlinfo
->mouse_face_window
= window
;
29936 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29941 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29942 mouse_face_shown
= true;
29944 if (NILP (pointer
))
29949 /* If mouse-face doesn't need to be shown, clear any existing
29951 if ((area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
) && !mouse_face_shown
)
29952 clear_mouse_face (hlinfo
);
29954 #ifdef HAVE_WINDOW_SYSTEM
29955 if (FRAME_WINDOW_P (f
))
29956 define_frame_cursor1 (f
, cursor
, pointer
);
29962 Take proper action when the mouse has moved to position X, Y on
29963 frame F with regards to highlighting portions of display that have
29964 mouse-face properties. Also de-highlight portions of display where
29965 the mouse was before, set the mouse pointer shape as appropriate
29966 for the mouse coordinates, and activate help echo (tooltips).
29967 X and Y can be negative or out of range. */
29970 note_mouse_highlight (struct frame
*f
, int x
, int y
)
29972 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29973 enum window_part part
= ON_NOTHING
;
29974 Lisp_Object window
;
29976 Cursor cursor
= No_Cursor
;
29977 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
29980 /* When a menu is active, don't highlight because this looks odd. */
29981 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29982 if (popup_activated ())
29986 if (!f
->glyphs_initialized_p
29987 || f
->pointer_invisible
)
29990 hlinfo
->mouse_face_mouse_x
= x
;
29991 hlinfo
->mouse_face_mouse_y
= y
;
29992 hlinfo
->mouse_face_mouse_frame
= f
;
29994 if (hlinfo
->mouse_face_defer
)
29997 /* Which window is that in? */
29998 window
= window_from_coordinates (f
, x
, y
, &part
, true);
30000 /* If displaying active text in another window, clear that. */
30001 if (! EQ (window
, hlinfo
->mouse_face_window
)
30002 /* Also clear if we move out of text area in same window. */
30003 || (!NILP (hlinfo
->mouse_face_window
)
30006 && part
!= ON_MODE_LINE
30007 && part
!= ON_HEADER_LINE
))
30008 clear_mouse_face (hlinfo
);
30010 /* Not on a window -> return. */
30011 if (!WINDOWP (window
))
30014 /* Reset help_echo_string. It will get recomputed below. */
30015 help_echo_string
= Qnil
;
30017 /* Convert to window-relative pixel coordinates. */
30018 w
= XWINDOW (window
);
30019 frame_to_window_pixel_xy (w
, &x
, &y
);
30021 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
30022 /* Handle tool-bar window differently since it doesn't display a
30024 if (EQ (window
, f
->tool_bar_window
))
30026 note_tool_bar_highlight (f
, x
, y
);
30031 /* Mouse is on the mode, header line or margin? */
30032 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
30033 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
30035 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
30037 #ifdef HAVE_WINDOW_SYSTEM
30038 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
30040 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30041 /* Show non-text cursor (Bug#16647). */
30049 #ifdef HAVE_WINDOW_SYSTEM
30050 if (part
== ON_VERTICAL_BORDER
)
30052 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
30053 help_echo_string
= build_string ("drag-mouse-1: resize");
30055 else if (part
== ON_RIGHT_DIVIDER
)
30057 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
30058 help_echo_string
= build_string ("drag-mouse-1: resize");
30060 else if (part
== ON_BOTTOM_DIVIDER
)
30061 if (! WINDOW_BOTTOMMOST_P (w
)
30063 || NILP (Vresize_mini_windows
))
30065 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
30066 help_echo_string
= build_string ("drag-mouse-1: resize");
30069 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30070 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
30071 || part
== ON_VERTICAL_SCROLL_BAR
30072 || part
== ON_HORIZONTAL_SCROLL_BAR
)
30073 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30075 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
30078 /* Are we in a window whose display is up to date?
30079 And verify the buffer's text has not changed. */
30080 b
= XBUFFER (w
->contents
);
30081 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
30083 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
30085 struct glyph
*glyph
;
30086 Lisp_Object object
;
30087 Lisp_Object mouse_face
= Qnil
, position
;
30088 Lisp_Object
*overlay_vec
= NULL
;
30089 ptrdiff_t i
, noverlays
;
30090 struct buffer
*obuf
;
30091 ptrdiff_t obegv
, ozv
;
30094 /* Find the glyph under X/Y. */
30095 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
30097 #ifdef HAVE_WINDOW_SYSTEM
30098 /* Look for :pointer property on image. */
30099 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
30101 struct image
*img
= IMAGE_OPT_FROM_ID (f
, glyph
->u
.img_id
);
30102 if (img
!= NULL
&& IMAGEP (img
->spec
))
30104 Lisp_Object image_map
, hotspot
;
30105 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
30107 && (hotspot
= find_hot_spot (image_map
,
30108 glyph
->slice
.img
.x
+ dx
,
30109 glyph
->slice
.img
.y
+ dy
),
30111 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
30115 /* Could check XCAR (hotspot) to see if we enter/leave
30117 If so, we could look for mouse-enter, mouse-leave
30118 properties in PLIST (and do something...). */
30119 hotspot
= XCDR (hotspot
);
30120 if (CONSP (hotspot
)
30121 && (plist
= XCAR (hotspot
), CONSP (plist
)))
30123 pointer
= Fplist_get (plist
, Qpointer
);
30124 if (NILP (pointer
))
30126 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
30127 if (!NILP (help_echo_string
))
30129 help_echo_window
= window
;
30130 help_echo_object
= glyph
->object
;
30131 help_echo_pos
= glyph
->charpos
;
30135 if (NILP (pointer
))
30136 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
30139 #endif /* HAVE_WINDOW_SYSTEM */
30141 /* Clear mouse face if X/Y not over text. */
30143 || area
!= TEXT_AREA
30144 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
30145 /* Glyph's OBJECT is nil for glyphs inserted by the
30146 display engine for its internal purposes, like truncation
30147 and continuation glyphs and blanks beyond the end of
30148 line's text on text terminals. If we are over such a
30149 glyph, we are not over any text. */
30150 || NILP (glyph
->object
)
30151 /* R2L rows have a stretch glyph at their front, which
30152 stands for no text, whereas L2R rows have no glyphs at
30153 all beyond the end of text. Treat such stretch glyphs
30154 like we do with NULL glyphs in L2R rows. */
30155 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
30156 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
30157 && glyph
->type
== STRETCH_GLYPH
30158 && glyph
->avoid_cursor_p
))
30160 if (clear_mouse_face (hlinfo
))
30161 cursor
= No_Cursor
;
30162 #ifdef HAVE_WINDOW_SYSTEM
30163 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30165 if (area
!= TEXT_AREA
)
30166 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30168 pointer
= Vvoid_text_area_pointer
;
30174 pos
= glyph
->charpos
;
30175 object
= glyph
->object
;
30176 if (!STRINGP (object
) && !BUFFERP (object
))
30179 /* If we get an out-of-range value, return now; avoid an error. */
30180 if (BUFFERP (object
) && pos
> BUF_Z (b
))
30183 /* Make the window's buffer temporarily current for
30184 overlays_at and compute_char_face. */
30185 obuf
= current_buffer
;
30186 current_buffer
= b
;
30192 /* Is this char mouse-active or does it have help-echo? */
30193 position
= make_number (pos
);
30197 if (BUFFERP (object
))
30199 /* Put all the overlays we want in a vector in overlay_vec. */
30200 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, false);
30201 /* Sort overlays into increasing priority order. */
30202 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
30207 if (NILP (Vmouse_highlight
))
30209 clear_mouse_face (hlinfo
);
30210 goto check_help_echo
;
30213 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
30216 cursor
= No_Cursor
;
30218 /* Check mouse-face highlighting. */
30220 /* If there exists an overlay with mouse-face overlapping
30221 the one we are currently highlighting, we have to
30222 check if we enter the overlapping overlay, and then
30223 highlight only that. */
30224 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
30225 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
30227 /* Find the highest priority overlay with a mouse-face. */
30228 Lisp_Object overlay
= Qnil
;
30229 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
30231 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
30232 if (!NILP (mouse_face
))
30233 overlay
= overlay_vec
[i
];
30236 /* If we're highlighting the same overlay as before, there's
30237 no need to do that again. */
30238 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
30239 goto check_help_echo
;
30240 hlinfo
->mouse_face_overlay
= overlay
;
30242 /* Clear the display of the old active region, if any. */
30243 if (clear_mouse_face (hlinfo
))
30244 cursor
= No_Cursor
;
30246 /* If no overlay applies, get a text property. */
30247 if (NILP (overlay
))
30248 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
30250 /* Next, compute the bounds of the mouse highlighting and
30252 if (!NILP (mouse_face
) && STRINGP (object
))
30254 /* The mouse-highlighting comes from a display string
30255 with a mouse-face. */
30259 s
= Fprevious_single_property_change
30260 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
30261 e
= Fnext_single_property_change
30262 (position
, Qmouse_face
, object
, Qnil
);
30264 s
= make_number (0);
30266 e
= make_number (SCHARS (object
));
30267 mouse_face_from_string_pos (w
, hlinfo
, object
,
30268 XINT (s
), XINT (e
));
30269 hlinfo
->mouse_face_past_end
= false;
30270 hlinfo
->mouse_face_window
= window
;
30271 hlinfo
->mouse_face_face_id
30272 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
30273 glyph
->face_id
, true);
30274 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
30275 cursor
= No_Cursor
;
30279 /* The mouse-highlighting, if any, comes from an overlay
30280 or text property in the buffer. */
30281 Lisp_Object buffer
IF_LINT (= Qnil
);
30282 Lisp_Object disp_string
IF_LINT (= Qnil
);
30284 if (STRINGP (object
))
30286 /* If we are on a display string with no mouse-face,
30287 check if the text under it has one. */
30288 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
30289 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30290 pos
= string_buffer_position (object
, start
);
30293 mouse_face
= get_char_property_and_overlay
30294 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
30295 buffer
= w
->contents
;
30296 disp_string
= object
;
30302 disp_string
= Qnil
;
30305 if (!NILP (mouse_face
))
30307 Lisp_Object before
, after
;
30308 Lisp_Object before_string
, after_string
;
30309 /* To correctly find the limits of mouse highlight
30310 in a bidi-reordered buffer, we must not use the
30311 optimization of limiting the search in
30312 previous-single-property-change and
30313 next-single-property-change, because
30314 rows_from_pos_range needs the real start and end
30315 positions to DTRT in this case. That's because
30316 the first row visible in a window does not
30317 necessarily display the character whose position
30318 is the smallest. */
30320 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
30321 ? Fmarker_position (w
->start
)
30324 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
30325 ? make_number (BUF_Z (XBUFFER (buffer
))
30326 - w
->window_end_pos
)
30329 if (NILP (overlay
))
30331 /* Handle the text property case. */
30332 before
= Fprevious_single_property_change
30333 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
30334 after
= Fnext_single_property_change
30335 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
30336 before_string
= after_string
= Qnil
;
30340 /* Handle the overlay case. */
30341 before
= Foverlay_start (overlay
);
30342 after
= Foverlay_end (overlay
);
30343 before_string
= Foverlay_get (overlay
, Qbefore_string
);
30344 after_string
= Foverlay_get (overlay
, Qafter_string
);
30346 if (!STRINGP (before_string
)) before_string
= Qnil
;
30347 if (!STRINGP (after_string
)) after_string
= Qnil
;
30350 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
30353 : XFASTINT (before
),
30355 ? BUF_Z (XBUFFER (buffer
))
30356 : XFASTINT (after
),
30357 before_string
, after_string
,
30359 cursor
= No_Cursor
;
30366 /* Look for a `help-echo' property. */
30367 if (NILP (help_echo_string
)) {
30368 Lisp_Object help
, overlay
;
30370 /* Check overlays first. */
30371 help
= overlay
= Qnil
;
30372 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
30374 overlay
= overlay_vec
[i
];
30375 help
= Foverlay_get (overlay
, Qhelp_echo
);
30380 help_echo_string
= help
;
30381 help_echo_window
= window
;
30382 help_echo_object
= overlay
;
30383 help_echo_pos
= pos
;
30387 Lisp_Object obj
= glyph
->object
;
30388 ptrdiff_t charpos
= glyph
->charpos
;
30390 /* Try text properties. */
30393 && charpos
< SCHARS (obj
))
30395 help
= Fget_text_property (make_number (charpos
),
30399 /* If the string itself doesn't specify a help-echo,
30400 see if the buffer text ``under'' it does. */
30401 struct glyph_row
*r
30402 = MATRIX_ROW (w
->current_matrix
, vpos
);
30403 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30404 ptrdiff_t p
= string_buffer_position (obj
, start
);
30407 help
= Fget_char_property (make_number (p
),
30408 Qhelp_echo
, w
->contents
);
30417 else if (BUFFERP (obj
)
30420 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
30425 help_echo_string
= help
;
30426 help_echo_window
= window
;
30427 help_echo_object
= obj
;
30428 help_echo_pos
= charpos
;
30433 #ifdef HAVE_WINDOW_SYSTEM
30434 /* Look for a `pointer' property. */
30435 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30437 /* Check overlays first. */
30438 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
30439 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
30441 if (NILP (pointer
))
30443 Lisp_Object obj
= glyph
->object
;
30444 ptrdiff_t charpos
= glyph
->charpos
;
30446 /* Try text properties. */
30449 && charpos
< SCHARS (obj
))
30451 pointer
= Fget_text_property (make_number (charpos
),
30453 if (NILP (pointer
))
30455 /* If the string itself doesn't specify a pointer,
30456 see if the buffer text ``under'' it does. */
30457 struct glyph_row
*r
30458 = MATRIX_ROW (w
->current_matrix
, vpos
);
30459 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30460 ptrdiff_t p
= string_buffer_position (obj
, start
);
30462 pointer
= Fget_char_property (make_number (p
),
30463 Qpointer
, w
->contents
);
30466 else if (BUFFERP (obj
)
30469 pointer
= Fget_text_property (make_number (charpos
),
30473 #endif /* HAVE_WINDOW_SYSTEM */
30477 current_buffer
= obuf
;
30483 #ifdef HAVE_WINDOW_SYSTEM
30484 if (FRAME_WINDOW_P (f
))
30485 define_frame_cursor1 (f
, cursor
, pointer
);
30487 /* This is here to prevent a compiler error, about "label at end of
30488 compound statement". */
30495 Clear any mouse-face on window W. This function is part of the
30496 redisplay interface, and is called from try_window_id and similar
30497 functions to ensure the mouse-highlight is off. */
30500 x_clear_window_mouse_face (struct window
*w
)
30502 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
30503 Lisp_Object window
;
30506 XSETWINDOW (window
, w
);
30507 if (EQ (window
, hlinfo
->mouse_face_window
))
30508 clear_mouse_face (hlinfo
);
30514 Just discard the mouse face information for frame F, if any.
30515 This is used when the size of F is changed. */
30518 cancel_mouse_face (struct frame
*f
)
30520 Lisp_Object window
;
30521 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30523 window
= hlinfo
->mouse_face_window
;
30524 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
30525 reset_mouse_highlight (hlinfo
);
30530 /***********************************************************************
30532 ***********************************************************************/
30534 #ifdef HAVE_WINDOW_SYSTEM
30536 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
30537 which intersects rectangle R. R is in window-relative coordinates. */
30540 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
30541 enum glyph_row_area area
)
30543 struct glyph
*first
= row
->glyphs
[area
];
30544 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
30545 struct glyph
*last
;
30546 int first_x
, start_x
, x
;
30548 if (area
== TEXT_AREA
&& row
->fill_line_p
)
30549 /* If row extends face to end of line write the whole line. */
30550 draw_glyphs (w
, 0, row
, area
,
30551 0, row
->used
[area
],
30552 DRAW_NORMAL_TEXT
, 0);
30555 /* Set START_X to the window-relative start position for drawing glyphs of
30556 AREA. The first glyph of the text area can be partially visible.
30557 The first glyphs of other areas cannot. */
30558 start_x
= window_box_left_offset (w
, area
);
30560 if (area
== TEXT_AREA
)
30563 /* Find the first glyph that must be redrawn. */
30565 && x
+ first
->pixel_width
< r
->x
)
30567 x
+= first
->pixel_width
;
30571 /* Find the last one. */
30574 /* Use a signed int intermediate value to avoid catastrophic
30575 failures due to comparison between signed and unsigned, when
30576 x is negative (can happen for wide images that are hscrolled). */
30577 int r_end
= r
->x
+ r
->width
;
30578 while (last
< end
&& x
< r_end
)
30580 x
+= last
->pixel_width
;
30586 draw_glyphs (w
, first_x
- start_x
, row
, area
,
30587 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
30588 DRAW_NORMAL_TEXT
, 0);
30593 /* Redraw the parts of the glyph row ROW on window W intersecting
30594 rectangle R. R is in window-relative coordinates. Value is
30595 true if mouse-face was overwritten. */
30598 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
30600 eassert (row
->enabled_p
);
30602 if (row
->mode_line_p
|| w
->pseudo_window_p
)
30603 draw_glyphs (w
, 0, row
, TEXT_AREA
,
30604 0, row
->used
[TEXT_AREA
],
30605 DRAW_NORMAL_TEXT
, 0);
30608 if (row
->used
[LEFT_MARGIN_AREA
])
30609 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
30610 if (row
->used
[TEXT_AREA
])
30611 expose_area (w
, row
, r
, TEXT_AREA
);
30612 if (row
->used
[RIGHT_MARGIN_AREA
])
30613 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
30614 draw_row_fringe_bitmaps (w
, row
);
30617 return row
->mouse_face_p
;
30621 /* Redraw those parts of glyphs rows during expose event handling that
30622 overlap other rows. Redrawing of an exposed line writes over parts
30623 of lines overlapping that exposed line; this function fixes that.
30625 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
30626 row in W's current matrix that is exposed and overlaps other rows.
30627 LAST_OVERLAPPING_ROW is the last such row. */
30630 expose_overlaps (struct window
*w
,
30631 struct glyph_row
*first_overlapping_row
,
30632 struct glyph_row
*last_overlapping_row
,
30635 struct glyph_row
*row
;
30637 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
30638 if (row
->overlapping_p
)
30640 eassert (row
->enabled_p
&& !row
->mode_line_p
);
30643 if (row
->used
[LEFT_MARGIN_AREA
])
30644 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
30646 if (row
->used
[TEXT_AREA
])
30647 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
30649 if (row
->used
[RIGHT_MARGIN_AREA
])
30650 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
30656 /* Return true if W's cursor intersects rectangle R. */
30659 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
30661 XRectangle cr
, result
;
30662 struct glyph
*cursor_glyph
;
30663 struct glyph_row
*row
;
30665 if (w
->phys_cursor
.vpos
>= 0
30666 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
30667 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
30669 && row
->cursor_in_fringe_p
)
30671 /* Cursor is in the fringe. */
30672 cr
.x
= window_box_right_offset (w
,
30673 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
30674 ? RIGHT_MARGIN_AREA
30677 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
30678 cr
.height
= row
->height
;
30679 return x_intersect_rectangles (&cr
, r
, &result
);
30682 cursor_glyph
= get_phys_cursor_glyph (w
);
30685 /* r is relative to W's box, but w->phys_cursor.x is relative
30686 to left edge of W's TEXT area. Adjust it. */
30687 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
30688 cr
.y
= w
->phys_cursor
.y
;
30689 cr
.width
= cursor_glyph
->pixel_width
;
30690 cr
.height
= w
->phys_cursor_height
;
30691 /* ++KFS: W32 version used W32-specific IntersectRect here, but
30692 I assume the effect is the same -- and this is portable. */
30693 return x_intersect_rectangles (&cr
, r
, &result
);
30695 /* If we don't understand the format, pretend we're not in the hot-spot. */
30701 Draw a vertical window border to the right of window W if W doesn't
30702 have vertical scroll bars. */
30705 x_draw_vertical_border (struct window
*w
)
30707 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30709 /* We could do better, if we knew what type of scroll-bar the adjacent
30710 windows (on either side) have... But we don't :-(
30711 However, I think this works ok. ++KFS 2003-04-25 */
30713 /* Redraw borders between horizontally adjacent windows. Don't
30714 do it for frames with vertical scroll bars because either the
30715 right scroll bar of a window, or the left scroll bar of its
30716 neighbor will suffice as a border. */
30717 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
30720 /* Note: It is necessary to redraw both the left and the right
30721 borders, for when only this single window W is being
30723 if (!WINDOW_RIGHTMOST_P (w
)
30724 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
30726 int x0
, x1
, y0
, y1
;
30728 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30731 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30734 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
30737 if (!WINDOW_LEFTMOST_P (w
)
30738 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
30740 int x0
, x1
, y0
, y1
;
30742 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30745 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30748 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
30753 /* Draw window dividers for window W. */
30756 x_draw_right_divider (struct window
*w
)
30758 struct frame
*f
= WINDOW_XFRAME (w
);
30760 if (w
->mini
|| w
->pseudo_window_p
)
30762 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30764 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
30765 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30766 int y0
= WINDOW_TOP_EDGE_Y (w
);
30767 /* The bottom divider prevails. */
30768 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30770 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30775 x_draw_bottom_divider (struct window
*w
)
30777 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30779 if (w
->mini
|| w
->pseudo_window_p
)
30781 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30783 int x0
= WINDOW_LEFT_EDGE_X (w
);
30784 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30785 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30786 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
30788 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30792 /* Redraw the part of window W intersection rectangle FR. Pixel
30793 coordinates in FR are frame-relative. Call this function with
30794 input blocked. Value is true if the exposure overwrites
30798 expose_window (struct window
*w
, XRectangle
*fr
)
30800 struct frame
*f
= XFRAME (w
->frame
);
30802 bool mouse_face_overwritten_p
= false;
30804 /* If window is not yet fully initialized, do nothing. This can
30805 happen when toolkit scroll bars are used and a window is split.
30806 Reconfiguring the scroll bar will generate an expose for a newly
30808 if (w
->current_matrix
== NULL
)
30811 /* When we're currently updating the window, display and current
30812 matrix usually don't agree. Arrange for a thorough display
30814 if (w
->must_be_updated_p
)
30816 SET_FRAME_GARBAGED (f
);
30820 /* Frame-relative pixel rectangle of W. */
30821 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
30822 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
30823 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
30824 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
30826 if (x_intersect_rectangles (fr
, &wr
, &r
))
30828 int yb
= window_text_bottom_y (w
);
30829 struct glyph_row
*row
;
30830 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
30832 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
30833 r
.x
, r
.y
, r
.width
, r
.height
));
30835 /* Convert to window coordinates. */
30836 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
30837 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
30839 /* Turn off the cursor. */
30840 bool cursor_cleared_p
= (!w
->pseudo_window_p
30841 && phys_cursor_in_rect_p (w
, &r
));
30842 if (cursor_cleared_p
)
30843 x_clear_cursor (w
);
30845 /* If the row containing the cursor extends face to end of line,
30846 then expose_area might overwrite the cursor outside the
30847 rectangle and thus notice_overwritten_cursor might clear
30848 w->phys_cursor_on_p. We remember the original value and
30849 check later if it is changed. */
30850 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
30852 /* Use a signed int intermediate value to avoid catastrophic
30853 failures due to comparison between signed and unsigned, when
30854 y0 or y1 is negative (can happen for tall images). */
30855 int r_bottom
= r
.y
+ r
.height
;
30857 /* Update lines intersecting rectangle R. */
30858 first_overlapping_row
= last_overlapping_row
= NULL
;
30859 for (row
= w
->current_matrix
->rows
;
30864 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
30866 if ((y0
>= r
.y
&& y0
< r_bottom
)
30867 || (y1
> r
.y
&& y1
< r_bottom
)
30868 || (r
.y
>= y0
&& r
.y
< y1
)
30869 || (r_bottom
> y0
&& r_bottom
< y1
))
30871 /* A header line may be overlapping, but there is no need
30872 to fix overlapping areas for them. KFS 2005-02-12 */
30873 if (row
->overlapping_p
&& !row
->mode_line_p
)
30875 if (first_overlapping_row
== NULL
)
30876 first_overlapping_row
= row
;
30877 last_overlapping_row
= row
;
30881 if (expose_line (w
, row
, &r
))
30882 mouse_face_overwritten_p
= true;
30885 else if (row
->overlapping_p
)
30887 /* We must redraw a row overlapping the exposed area. */
30889 ? y0
+ row
->phys_height
> r
.y
30890 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30892 if (first_overlapping_row
== NULL
)
30893 first_overlapping_row
= row
;
30894 last_overlapping_row
= row
;
30902 /* Display the mode line if there is one. */
30903 if (WINDOW_WANTS_MODELINE_P (w
)
30904 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30906 && row
->y
< r_bottom
)
30908 if (expose_line (w
, row
, &r
))
30909 mouse_face_overwritten_p
= true;
30912 if (!w
->pseudo_window_p
)
30914 /* Fix the display of overlapping rows. */
30915 if (first_overlapping_row
)
30916 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30919 /* Draw border between windows. */
30920 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30921 x_draw_right_divider (w
);
30923 x_draw_vertical_border (w
);
30925 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30926 x_draw_bottom_divider (w
);
30928 /* Turn the cursor on again. */
30929 if (cursor_cleared_p
30930 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30931 update_window_cursor (w
, true);
30935 return mouse_face_overwritten_p
;
30940 /* Redraw (parts) of all windows in the window tree rooted at W that
30941 intersect R. R contains frame pixel coordinates. Value is
30942 true if the exposure overwrites mouse-face. */
30945 expose_window_tree (struct window
*w
, XRectangle
*r
)
30947 struct frame
*f
= XFRAME (w
->frame
);
30948 bool mouse_face_overwritten_p
= false;
30950 while (w
&& !FRAME_GARBAGED_P (f
))
30952 mouse_face_overwritten_p
30953 |= (WINDOWP (w
->contents
)
30954 ? expose_window_tree (XWINDOW (w
->contents
), r
)
30955 : expose_window (w
, r
));
30957 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
30960 return mouse_face_overwritten_p
;
30965 Redisplay an exposed area of frame F. X and Y are the upper-left
30966 corner of the exposed rectangle. W and H are width and height of
30967 the exposed area. All are pixel values. W or H zero means redraw
30968 the entire frame. */
30971 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
30974 bool mouse_face_overwritten_p
= false;
30976 TRACE ((stderr
, "expose_frame "));
30978 /* No need to redraw if frame will be redrawn soon. */
30979 if (FRAME_GARBAGED_P (f
))
30981 TRACE ((stderr
, " garbaged\n"));
30985 /* If basic faces haven't been realized yet, there is no point in
30986 trying to redraw anything. This can happen when we get an expose
30987 event while Emacs is starting, e.g. by moving another window. */
30988 if (FRAME_FACE_CACHE (f
) == NULL
30989 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
30991 TRACE ((stderr
, " no faces\n"));
30995 if (w
== 0 || h
== 0)
30998 r
.width
= FRAME_TEXT_WIDTH (f
);
30999 r
.height
= FRAME_TEXT_HEIGHT (f
);
31009 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
31010 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
31012 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
31013 if (WINDOWP (f
->tool_bar_window
))
31014 mouse_face_overwritten_p
31015 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
31018 #ifdef HAVE_X_WINDOWS
31020 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
31021 if (WINDOWP (f
->menu_bar_window
))
31022 mouse_face_overwritten_p
31023 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
31024 #endif /* not USE_X_TOOLKIT and not USE_GTK */
31028 /* Some window managers support a focus-follows-mouse style with
31029 delayed raising of frames. Imagine a partially obscured frame,
31030 and moving the mouse into partially obscured mouse-face on that
31031 frame. The visible part of the mouse-face will be highlighted,
31032 then the WM raises the obscured frame. With at least one WM, KDE
31033 2.1, Emacs is not getting any event for the raising of the frame
31034 (even tried with SubstructureRedirectMask), only Expose events.
31035 These expose events will draw text normally, i.e. not
31036 highlighted. Which means we must redo the highlight here.
31037 Subsume it under ``we love X''. --gerd 2001-08-15 */
31038 /* Included in Windows version because Windows most likely does not
31039 do the right thing if any third party tool offers
31040 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
31041 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
31043 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
31044 if (f
== hlinfo
->mouse_face_mouse_frame
)
31046 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
31047 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
31048 clear_mouse_face (hlinfo
);
31049 note_mouse_highlight (f
, mouse_x
, mouse_y
);
31056 Determine the intersection of two rectangles R1 and R2. Return
31057 the intersection in *RESULT. Value is true if RESULT is not
31061 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
31063 XRectangle
*left
, *right
;
31064 XRectangle
*upper
, *lower
;
31065 bool intersection_p
= false;
31067 /* Rearrange so that R1 is the left-most rectangle. */
31069 left
= r1
, right
= r2
;
31071 left
= r2
, right
= r1
;
31073 /* X0 of the intersection is right.x0, if this is inside R1,
31074 otherwise there is no intersection. */
31075 if (right
->x
<= left
->x
+ left
->width
)
31077 result
->x
= right
->x
;
31079 /* The right end of the intersection is the minimum of
31080 the right ends of left and right. */
31081 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
31084 /* Same game for Y. */
31086 upper
= r1
, lower
= r2
;
31088 upper
= r2
, lower
= r1
;
31090 /* The upper end of the intersection is lower.y0, if this is inside
31091 of upper. Otherwise, there is no intersection. */
31092 if (lower
->y
<= upper
->y
+ upper
->height
)
31094 result
->y
= lower
->y
;
31096 /* The lower end of the intersection is the minimum of the lower
31097 ends of upper and lower. */
31098 result
->height
= (min (lower
->y
+ lower
->height
,
31099 upper
->y
+ upper
->height
)
31101 intersection_p
= true;
31105 return intersection_p
;
31108 #endif /* HAVE_WINDOW_SYSTEM */
31111 /***********************************************************************
31113 ***********************************************************************/
31116 syms_of_xdisp (void)
31118 Vwith_echo_area_save_vector
= Qnil
;
31119 staticpro (&Vwith_echo_area_save_vector
);
31121 Vmessage_stack
= Qnil
;
31122 staticpro (&Vmessage_stack
);
31124 /* Non-nil means don't actually do any redisplay. */
31125 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
31127 DEFSYM (Qredisplay_internal_xC_functionx
, "redisplay_internal (C function)");
31129 DEFVAR_BOOL("inhibit-message", inhibit_message
,
31130 doc
: /* Non-nil means calls to `message' are not displayed.
31131 They are still logged to the *Messages* buffer. */);
31132 inhibit_message
= 0;
31134 message_dolog_marker1
= Fmake_marker ();
31135 staticpro (&message_dolog_marker1
);
31136 message_dolog_marker2
= Fmake_marker ();
31137 staticpro (&message_dolog_marker2
);
31138 message_dolog_marker3
= Fmake_marker ();
31139 staticpro (&message_dolog_marker3
);
31142 defsubr (&Sdump_frame_glyph_matrix
);
31143 defsubr (&Sdump_glyph_matrix
);
31144 defsubr (&Sdump_glyph_row
);
31145 defsubr (&Sdump_tool_bar_row
);
31146 defsubr (&Strace_redisplay
);
31147 defsubr (&Strace_to_stderr
);
31149 #ifdef HAVE_WINDOW_SYSTEM
31150 defsubr (&Stool_bar_height
);
31151 defsubr (&Slookup_image_map
);
31153 defsubr (&Sline_pixel_height
);
31154 defsubr (&Sformat_mode_line
);
31155 defsubr (&Sinvisible_p
);
31156 defsubr (&Scurrent_bidi_paragraph_direction
);
31157 defsubr (&Swindow_text_pixel_size
);
31158 defsubr (&Smove_point_visually
);
31159 defsubr (&Sbidi_find_overridden_directionality
);
31161 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
31162 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
31163 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
31164 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
31165 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
31166 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
31167 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
31168 DEFSYM (Qeval
, "eval");
31169 DEFSYM (QCdata
, ":data");
31171 /* Names of text properties relevant for redisplay. */
31172 DEFSYM (Qdisplay
, "display");
31173 DEFSYM (Qspace_width
, "space-width");
31174 DEFSYM (Qraise
, "raise");
31175 DEFSYM (Qslice
, "slice");
31176 DEFSYM (Qspace
, "space");
31177 DEFSYM (Qmargin
, "margin");
31178 DEFSYM (Qpointer
, "pointer");
31179 DEFSYM (Qleft_margin
, "left-margin");
31180 DEFSYM (Qright_margin
, "right-margin");
31181 DEFSYM (Qcenter
, "center");
31182 DEFSYM (Qline_height
, "line-height");
31183 DEFSYM (QCalign_to
, ":align-to");
31184 DEFSYM (QCrelative_width
, ":relative-width");
31185 DEFSYM (QCrelative_height
, ":relative-height");
31186 DEFSYM (QCeval
, ":eval");
31187 DEFSYM (QCpropertize
, ":propertize");
31188 DEFSYM (QCfile
, ":file");
31189 DEFSYM (Qfontified
, "fontified");
31190 DEFSYM (Qfontification_functions
, "fontification-functions");
31192 /* Name of the face used to highlight trailing whitespace. */
31193 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
31195 /* Name and number of the face used to highlight escape glyphs. */
31196 DEFSYM (Qescape_glyph
, "escape-glyph");
31198 /* Name and number of the face used to highlight non-breaking
31200 DEFSYM (Qnobreak_space
, "nobreak-space");
31201 DEFSYM (Qnobreak_hyphen
, "nobreak-hyphen");
31203 /* The symbol 'image' which is the car of the lists used to represent
31204 images in Lisp. Also a tool bar style. */
31205 DEFSYM (Qimage
, "image");
31207 /* Tool bar styles. */
31208 DEFSYM (Qtext
, "text");
31209 DEFSYM (Qboth
, "both");
31210 DEFSYM (Qboth_horiz
, "both-horiz");
31211 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
31213 /* The image map types. */
31214 DEFSYM (QCmap
, ":map");
31215 DEFSYM (QCpointer
, ":pointer");
31216 DEFSYM (Qrect
, "rect");
31217 DEFSYM (Qcircle
, "circle");
31218 DEFSYM (Qpoly
, "poly");
31220 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
31222 DEFSYM (Qgrow_only
, "grow-only");
31223 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
31224 DEFSYM (Qposition
, "position");
31225 DEFSYM (Qbuffer_position
, "buffer-position");
31226 DEFSYM (Qobject
, "object");
31228 /* Cursor shapes. */
31229 DEFSYM (Qbar
, "bar");
31230 DEFSYM (Qhbar
, "hbar");
31231 DEFSYM (Qbox
, "box");
31232 DEFSYM (Qhollow
, "hollow");
31234 /* Pointer shapes. */
31235 DEFSYM (Qhand
, "hand");
31236 DEFSYM (Qarrow
, "arrow");
31239 DEFSYM (Qdragging
, "dragging");
31241 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
31243 list_of_error
= list1 (list2 (Qerror
, Qvoid_variable
));
31244 staticpro (&list_of_error
);
31246 /* Values of those variables at last redisplay are stored as
31247 properties on 'overlay-arrow-position' symbol. However, if
31248 Voverlay_arrow_position is a marker, last-arrow-position is its
31249 numerical position. */
31250 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
31251 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
31253 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
31254 properties on a symbol in overlay-arrow-variable-list. */
31255 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
31256 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
31258 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
31259 staticpro (&echo_buffer
[0]);
31260 staticpro (&echo_buffer
[1]);
31262 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
31263 staticpro (&echo_area_buffer
[0]);
31264 staticpro (&echo_area_buffer
[1]);
31266 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
31267 staticpro (&Vmessages_buffer_name
);
31269 mode_line_proptrans_alist
= Qnil
;
31270 staticpro (&mode_line_proptrans_alist
);
31271 mode_line_string_list
= Qnil
;
31272 staticpro (&mode_line_string_list
);
31273 mode_line_string_face
= Qnil
;
31274 staticpro (&mode_line_string_face
);
31275 mode_line_string_face_prop
= Qnil
;
31276 staticpro (&mode_line_string_face_prop
);
31277 Vmode_line_unwind_vector
= Qnil
;
31278 staticpro (&Vmode_line_unwind_vector
);
31280 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
31282 help_echo_string
= Qnil
;
31283 staticpro (&help_echo_string
);
31284 help_echo_object
= Qnil
;
31285 staticpro (&help_echo_object
);
31286 help_echo_window
= Qnil
;
31287 staticpro (&help_echo_window
);
31288 previous_help_echo_string
= Qnil
;
31289 staticpro (&previous_help_echo_string
);
31290 help_echo_pos
= -1;
31292 DEFSYM (Qright_to_left
, "right-to-left");
31293 DEFSYM (Qleft_to_right
, "left-to-right");
31294 defsubr (&Sbidi_resolved_levels
);
31296 #ifdef HAVE_WINDOW_SYSTEM
31297 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
31298 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
31299 For example, if a block cursor is over a tab, it will be drawn as
31300 wide as that tab on the display. */);
31301 x_stretch_cursor_p
= 0;
31304 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
31305 doc
: /* Non-nil means highlight trailing whitespace.
31306 The face used for trailing whitespace is `trailing-whitespace'. */);
31307 Vshow_trailing_whitespace
= Qnil
;
31309 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
31310 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
31311 If the value is t, Emacs highlights non-ASCII chars which have the
31312 same appearance as an ASCII space or hyphen, using the `nobreak-space'
31313 or `nobreak-hyphen' face respectively.
31315 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
31316 U+2011 (non-breaking hyphen) are affected.
31318 Any other non-nil value means to display these characters as a escape
31319 glyph followed by an ordinary space or hyphen.
31321 A value of nil means no special handling of these characters. */);
31322 Vnobreak_char_display
= Qt
;
31324 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
31325 doc
: /* The pointer shape to show in void text areas.
31326 A value of nil means to show the text pointer. Other options are
31327 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
31329 Vvoid_text_area_pointer
= Qarrow
;
31331 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
31332 doc
: /* Non-nil means don't actually do any redisplay.
31333 This is used for internal purposes. */);
31334 Vinhibit_redisplay
= Qnil
;
31336 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
31337 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
31338 Vglobal_mode_string
= Qnil
;
31340 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
31341 doc
: /* Marker for where to display an arrow on top of the buffer text.
31342 This must be the beginning of a line in order to work.
31343 See also `overlay-arrow-string'. */);
31344 Voverlay_arrow_position
= Qnil
;
31346 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
31347 doc
: /* String to display as an arrow in non-window frames.
31348 See also `overlay-arrow-position'. */);
31349 Voverlay_arrow_string
= build_pure_c_string ("=>");
31351 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
31352 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
31353 The symbols on this list are examined during redisplay to determine
31354 where to display overlay arrows. */);
31355 Voverlay_arrow_variable_list
31356 = list1 (intern_c_string ("overlay-arrow-position"));
31358 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
31359 doc
: /* The number of lines to try scrolling a window by when point moves out.
31360 If that fails to bring point back on frame, point is centered instead.
31361 If this is zero, point is always centered after it moves off frame.
31362 If you want scrolling to always be a line at a time, you should set
31363 `scroll-conservatively' to a large value rather than set this to 1. */);
31365 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
31366 doc
: /* Scroll up to this many lines, to bring point back on screen.
31367 If point moves off-screen, redisplay will scroll by up to
31368 `scroll-conservatively' lines in order to bring point just barely
31369 onto the screen again. If that cannot be done, then redisplay
31370 recenters point as usual.
31372 If the value is greater than 100, redisplay will never recenter point,
31373 but will always scroll just enough text to bring point into view, even
31374 if you move far away.
31376 A value of zero means always recenter point if it moves off screen. */);
31377 scroll_conservatively
= 0;
31379 DEFVAR_INT ("scroll-margin", scroll_margin
,
31380 doc
: /* Number of lines of margin at the top and bottom of a window.
31381 Recenter the window whenever point gets within this many lines
31382 of the top or bottom of the window. */);
31385 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
31386 doc
: /* Pixels per inch value for non-window system displays.
31387 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
31388 Vdisplay_pixels_per_inch
= make_float (72.0);
31391 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
31394 DEFVAR_LISP ("truncate-partial-width-windows",
31395 Vtruncate_partial_width_windows
,
31396 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
31397 For an integer value, truncate lines in each window narrower than the
31398 full frame width, provided the total window width in column units is less
31399 than that integer; otherwise, respect the value of `truncate-lines'.
31400 The total width of the window is as returned by `window-total-width', it
31401 includes the fringes, the continuation and truncation glyphs, the
31402 display margins (if any), and the scroll bar
31404 For any other non-nil value, truncate lines in all windows that do
31405 not span the full frame width.
31407 A value of nil means to respect the value of `truncate-lines'.
31409 If `word-wrap' is enabled, you might want to reduce this. */);
31410 Vtruncate_partial_width_windows
= make_number (50);
31412 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
31413 doc
: /* Maximum buffer size for which line number should be displayed.
31414 If the buffer is bigger than this, the line number does not appear
31415 in the mode line. A value of nil means no limit. */);
31416 Vline_number_display_limit
= Qnil
;
31418 DEFVAR_INT ("line-number-display-limit-width",
31419 line_number_display_limit_width
,
31420 doc
: /* Maximum line width (in characters) for line number display.
31421 If the average length of the lines near point is bigger than this, then the
31422 line number may be omitted from the mode line. */);
31423 line_number_display_limit_width
= 200;
31425 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
31426 doc
: /* Non-nil means highlight region even in nonselected windows. */);
31427 highlight_nonselected_windows
= false;
31429 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
31430 doc
: /* Non-nil if more than one frame is visible on this display.
31431 Minibuffer-only frames don't count, but iconified frames do.
31432 This variable is not guaranteed to be accurate except while processing
31433 `frame-title-format' and `icon-title-format'. */);
31435 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
31436 doc
: /* Template for displaying the title bar of visible frames.
31437 \(Assuming the window manager supports this feature.)
31439 This variable has the same structure as `mode-line-format', except that
31440 the %c and %l constructs are ignored. It is used only on frames for
31441 which no explicit name has been set (see `modify-frame-parameters'). */);
31443 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
31444 doc
: /* Template for displaying the title bar of an iconified frame.
31445 \(Assuming the window manager supports this feature.)
31446 This variable has the same structure as `mode-line-format' (which see),
31447 and is used only on frames for which no explicit name has been set
31448 \(see `modify-frame-parameters'). */);
31450 = Vframe_title_format
31451 = listn (CONSTYPE_PURE
, 3,
31452 intern_c_string ("multiple-frames"),
31453 build_pure_c_string ("%b"),
31454 listn (CONSTYPE_PURE
, 4,
31455 empty_unibyte_string
,
31456 intern_c_string ("invocation-name"),
31457 build_pure_c_string ("@"),
31458 intern_c_string ("system-name")));
31460 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
31461 doc
: /* Maximum number of lines to keep in the message log buffer.
31462 If nil, disable message logging. If t, log messages but don't truncate
31463 the buffer when it becomes large. */);
31464 Vmessage_log_max
= make_number (1000);
31466 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
31467 doc
: /* List of functions to call before redisplaying a window with scrolling.
31468 Each function is called with two arguments, the window and its new
31469 display-start position.
31470 These functions are called whenever the `window-start' marker is modified,
31471 either to point into another buffer (e.g. via `set-window-buffer') or another
31472 place in the same buffer.
31473 Note that the value of `window-end' is not valid when these functions are
31476 Warning: Do not use this feature to alter the way the window
31477 is scrolled. It is not designed for that, and such use probably won't
31479 Vwindow_scroll_functions
= Qnil
;
31481 DEFVAR_LISP ("window-text-change-functions",
31482 Vwindow_text_change_functions
,
31483 doc
: /* Functions to call in redisplay when text in the window might change. */);
31484 Vwindow_text_change_functions
= Qnil
;
31486 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
31487 doc
: /* Functions called when redisplay of a window reaches the end trigger.
31488 Each function is called with two arguments, the window and the end trigger value.
31489 See `set-window-redisplay-end-trigger'. */);
31490 Vredisplay_end_trigger_functions
= Qnil
;
31492 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
31493 doc
: /* Non-nil means autoselect window with mouse pointer.
31494 If nil, do not autoselect windows.
31495 A positive number means delay autoselection by that many seconds: a
31496 window is autoselected only after the mouse has remained in that
31497 window for the duration of the delay.
31498 A negative number has a similar effect, but causes windows to be
31499 autoselected only after the mouse has stopped moving. (Because of
31500 the way Emacs compares mouse events, you will occasionally wait twice
31501 that time before the window gets selected.)
31502 Any other value means to autoselect window instantaneously when the
31503 mouse pointer enters it.
31505 Autoselection selects the minibuffer only if it is active, and never
31506 unselects the minibuffer if it is active.
31508 When customizing this variable make sure that the actual value of
31509 `focus-follows-mouse' matches the behavior of your window manager. */);
31510 Vmouse_autoselect_window
= Qnil
;
31512 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
31513 doc
: /* Non-nil means automatically resize tool-bars.
31514 This dynamically changes the tool-bar's height to the minimum height
31515 that is needed to make all tool-bar items visible.
31516 If value is `grow-only', the tool-bar's height is only increased
31517 automatically; to decrease the tool-bar height, use \\[recenter]. */);
31518 Vauto_resize_tool_bars
= Qt
;
31520 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
31521 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
31522 auto_raise_tool_bar_buttons_p
= true;
31524 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
31525 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
31526 make_cursor_line_fully_visible_p
= true;
31528 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
31529 doc
: /* Border below tool-bar in pixels.
31530 If an integer, use it as the height of the border.
31531 If it is one of `internal-border-width' or `border-width', use the
31532 value of the corresponding frame parameter.
31533 Otherwise, no border is added below the tool-bar. */);
31534 Vtool_bar_border
= Qinternal_border_width
;
31536 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
31537 doc
: /* Margin around tool-bar buttons in pixels.
31538 If an integer, use that for both horizontal and vertical margins.
31539 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
31540 HORZ specifying the horizontal margin, and VERT specifying the
31541 vertical margin. */);
31542 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
31544 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
31545 doc
: /* Relief thickness of tool-bar buttons. */);
31546 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
31548 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
31549 doc
: /* Tool bar style to use.
31551 image - show images only
31552 text - show text only
31553 both - show both, text below image
31554 both-horiz - show text to the right of the image
31555 text-image-horiz - show text to the left of the image
31556 any other - use system default or image if no system default.
31558 This variable only affects the GTK+ toolkit version of Emacs. */);
31559 Vtool_bar_style
= Qnil
;
31561 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
31562 doc
: /* Maximum number of characters a label can have to be shown.
31563 The tool bar style must also show labels for this to have any effect, see
31564 `tool-bar-style'. */);
31565 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
31567 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
31568 doc
: /* List of functions to call to fontify regions of text.
31569 Each function is called with one argument POS. Functions must
31570 fontify a region starting at POS in the current buffer, and give
31571 fontified regions the property `fontified'. */);
31572 Vfontification_functions
= Qnil
;
31573 Fmake_variable_buffer_local (Qfontification_functions
);
31575 DEFVAR_BOOL ("unibyte-display-via-language-environment",
31576 unibyte_display_via_language_environment
,
31577 doc
: /* Non-nil means display unibyte text according to language environment.
31578 Specifically, this means that raw bytes in the range 160-255 decimal
31579 are displayed by converting them to the equivalent multibyte characters
31580 according to the current language environment. As a result, they are
31581 displayed according to the current fontset.
31583 Note that this variable affects only how these bytes are displayed,
31584 but does not change the fact they are interpreted as raw bytes. */);
31585 unibyte_display_via_language_environment
= false;
31587 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
31588 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
31589 If a float, it specifies a fraction of the mini-window frame's height.
31590 If an integer, it specifies a number of lines. */);
31591 Vmax_mini_window_height
= make_float (0.25);
31593 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
31594 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
31595 A value of nil means don't automatically resize mini-windows.
31596 A value of t means resize them to fit the text displayed in them.
31597 A value of `grow-only', the default, means let mini-windows grow only;
31598 they return to their normal size when the minibuffer is closed, or the
31599 echo area becomes empty. */);
31600 /* Contrary to the doc string, we initialize this to nil, so that
31601 loading loadup.el won't try to resize windows before loading
31602 window.el, where some functions we need to call for this live.
31603 We assign the 'grow-only' value right after loading window.el
31605 Vresize_mini_windows
= Qnil
;
31607 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
31608 doc
: /* Alist specifying how to blink the cursor off.
31609 Each element has the form (ON-STATE . OFF-STATE). Whenever the
31610 `cursor-type' frame-parameter or variable equals ON-STATE,
31611 comparing using `equal', Emacs uses OFF-STATE to specify
31612 how to blink it off. ON-STATE and OFF-STATE are values for
31613 the `cursor-type' frame parameter.
31615 If a frame's ON-STATE has no entry in this list,
31616 the frame's other specifications determine how to blink the cursor off. */);
31617 Vblink_cursor_alist
= Qnil
;
31619 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
31620 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
31621 If non-nil, windows are automatically scrolled horizontally to make
31622 point visible. */);
31623 automatic_hscrolling_p
= true;
31624 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
31626 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
31627 doc
: /* How many columns away from the window edge point is allowed to get
31628 before automatic hscrolling will horizontally scroll the window. */);
31629 hscroll_margin
= 5;
31631 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
31632 doc
: /* How many columns to scroll the window when point gets too close to the edge.
31633 When point is less than `hscroll-margin' columns from the window
31634 edge, automatic hscrolling will scroll the window by the amount of columns
31635 determined by this variable. If its value is a positive integer, scroll that
31636 many columns. If it's a positive floating-point number, it specifies the
31637 fraction of the window's width to scroll. If it's nil or zero, point will be
31638 centered horizontally after the scroll. Any other value, including negative
31639 numbers, are treated as if the value were zero.
31641 Automatic hscrolling always moves point outside the scroll margin, so if
31642 point was more than scroll step columns inside the margin, the window will
31643 scroll more than the value given by the scroll step.
31645 Note that the lower bound for automatic hscrolling specified by `scroll-left'
31646 and `scroll-right' overrides this variable's effect. */);
31647 Vhscroll_step
= make_number (0);
31649 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
31650 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
31651 Bind this around calls to `message' to let it take effect. */);
31652 message_truncate_lines
= false;
31654 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
31655 doc
: /* Normal hook run to update the menu bar definitions.
31656 Redisplay runs this hook before it redisplays the menu bar.
31657 This is used to update menus such as Buffers, whose contents depend on
31659 Vmenu_bar_update_hook
= Qnil
;
31661 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
31662 doc
: /* Frame for which we are updating a menu.
31663 The enable predicate for a menu binding should check this variable. */);
31664 Vmenu_updating_frame
= Qnil
;
31666 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
31667 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
31668 inhibit_menubar_update
= false;
31670 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
31671 doc
: /* Prefix prepended to all continuation lines at display time.
31672 The value may be a string, an image, or a stretch-glyph; it is
31673 interpreted in the same way as the value of a `display' text property.
31675 This variable is overridden by any `wrap-prefix' text or overlay
31678 To add a prefix to non-continuation lines, use `line-prefix'. */);
31679 Vwrap_prefix
= Qnil
;
31680 DEFSYM (Qwrap_prefix
, "wrap-prefix");
31681 Fmake_variable_buffer_local (Qwrap_prefix
);
31683 DEFVAR_LISP ("line-prefix", Vline_prefix
,
31684 doc
: /* Prefix prepended to all non-continuation lines at display time.
31685 The value may be a string, an image, or a stretch-glyph; it is
31686 interpreted in the same way as the value of a `display' text property.
31688 This variable is overridden by any `line-prefix' text or overlay
31691 To add a prefix to continuation lines, use `wrap-prefix'. */);
31692 Vline_prefix
= Qnil
;
31693 DEFSYM (Qline_prefix
, "line-prefix");
31694 Fmake_variable_buffer_local (Qline_prefix
);
31696 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
31697 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
31698 inhibit_eval_during_redisplay
= false;
31700 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
31701 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
31702 inhibit_free_realized_faces
= false;
31704 DEFVAR_BOOL ("inhibit-bidi-mirroring", inhibit_bidi_mirroring
,
31705 doc
: /* Non-nil means don't mirror characters even when bidi context requires that.
31706 Intended for use during debugging and for testing bidi display;
31707 see biditest.el in the test suite. */);
31708 inhibit_bidi_mirroring
= false;
31711 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
31712 doc
: /* Inhibit try_window_id display optimization. */);
31713 inhibit_try_window_id
= false;
31715 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
31716 doc
: /* Inhibit try_window_reusing display optimization. */);
31717 inhibit_try_window_reusing
= false;
31719 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
31720 doc
: /* Inhibit try_cursor_movement display optimization. */);
31721 inhibit_try_cursor_movement
= false;
31722 #endif /* GLYPH_DEBUG */
31724 DEFVAR_INT ("overline-margin", overline_margin
,
31725 doc
: /* Space between overline and text, in pixels.
31726 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
31727 margin to the character height. */);
31728 overline_margin
= 2;
31730 DEFVAR_INT ("underline-minimum-offset",
31731 underline_minimum_offset
,
31732 doc
: /* Minimum distance between baseline and underline.
31733 This can improve legibility of underlined text at small font sizes,
31734 particularly when using variable `x-use-underline-position-properties'
31735 with fonts that specify an UNDERLINE_POSITION relatively close to the
31736 baseline. The default value is 1. */);
31737 underline_minimum_offset
= 1;
31739 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
31740 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
31741 This feature only works when on a window system that can change
31742 cursor shapes. */);
31743 display_hourglass_p
= true;
31745 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
31746 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
31747 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
31749 #ifdef HAVE_WINDOW_SYSTEM
31750 hourglass_atimer
= NULL
;
31751 hourglass_shown_p
= false;
31752 #endif /* HAVE_WINDOW_SYSTEM */
31754 /* Name of the face used to display glyphless characters. */
31755 DEFSYM (Qglyphless_char
, "glyphless-char");
31757 /* Method symbols for Vglyphless_char_display. */
31758 DEFSYM (Qhex_code
, "hex-code");
31759 DEFSYM (Qempty_box
, "empty-box");
31760 DEFSYM (Qthin_space
, "thin-space");
31761 DEFSYM (Qzero_width
, "zero-width");
31763 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
31764 doc
: /* Function run just before redisplay.
31765 It is called with one argument, which is the set of windows that are to
31766 be redisplayed. This set can be nil (meaning, only the selected window),
31767 or t (meaning all windows). */);
31768 Vpre_redisplay_function
= intern ("ignore");
31770 /* Symbol for the purpose of Vglyphless_char_display. */
31771 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
31772 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
31774 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
31775 doc
: /* Char-table defining glyphless characters.
31776 Each element, if non-nil, should be one of the following:
31777 an ASCII acronym string: display this string in a box
31778 `hex-code': display the hexadecimal code of a character in a box
31779 `empty-box': display as an empty box
31780 `thin-space': display as 1-pixel width space
31781 `zero-width': don't display
31782 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
31783 display method for graphical terminals and text terminals respectively.
31784 GRAPHICAL and TEXT should each have one of the values listed above.
31786 The char-table has one extra slot to control the display of a character for
31787 which no font is found. This slot only takes effect on graphical terminals.
31788 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
31789 `thin-space'. The default is `empty-box'.
31791 If a character has a non-nil entry in an active display table, the
31792 display table takes effect; in this case, Emacs does not consult
31793 `glyphless-char-display' at all. */);
31794 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
31795 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
31798 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
31799 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
31800 Vdebug_on_message
= Qnil
;
31802 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
31804 Vredisplay__all_windows_cause
= Fmake_hash_table (0, NULL
);
31806 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
31808 Vredisplay__mode_lines_cause
= Fmake_hash_table (0, NULL
);
31810 DEFVAR_LISP ("redisplay--variables", Vredisplay__variables
,
31811 doc
: /* A hash-table of variables changing which triggers a thorough redisplay. */);
31812 Vredisplay__variables
= Qnil
;
31814 DEFVAR_BOOL ("redisplay--inhibit-bidi", redisplay__inhibit_bidi
,
31815 doc
: /* Non-nil means it is not safe to attempt bidi reordering for display. */);
31816 /* Initialize to t, since we need to disable reordering until
31817 loadup.el successfully loads charprop.el. */
31818 redisplay__inhibit_bidi
= true;
31822 /* Initialize this module when Emacs starts. */
31827 CHARPOS (this_line_start_pos
) = 0;
31829 if (!noninteractive
)
31831 struct window
*m
= XWINDOW (minibuf_window
);
31832 Lisp_Object frame
= m
->frame
;
31833 struct frame
*f
= XFRAME (frame
);
31834 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
31835 struct window
*r
= XWINDOW (root
);
31838 echo_area_window
= minibuf_window
;
31840 r
->top_line
= FRAME_TOP_MARGIN (f
);
31841 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
31842 r
->total_cols
= FRAME_COLS (f
);
31843 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31844 r
->total_lines
= FRAME_TOTAL_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
31845 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
31847 m
->top_line
= FRAME_TOTAL_LINES (f
) - 1;
31848 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
31849 m
->total_cols
= FRAME_COLS (f
);
31850 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31851 m
->total_lines
= 1;
31852 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
31854 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
31855 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
31856 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
31858 /* The default ellipsis glyphs `...'. */
31859 for (i
= 0; i
< 3; ++i
)
31860 default_invis_vector
[i
] = make_number ('.');
31864 /* Allocate the buffer for frame titles.
31865 Also used for `format-mode-line'. */
31867 mode_line_noprop_buf
= xmalloc (size
);
31868 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
31869 mode_line_noprop_ptr
= mode_line_noprop_buf
;
31870 mode_line_target
= MODE_LINE_DISPLAY
;
31873 help_echo_showing_p
= false;
31876 #ifdef HAVE_WINDOW_SYSTEM
31878 /* Platform-independent portion of hourglass implementation. */
31880 /* Timer function of hourglass_atimer. */
31883 show_hourglass (struct atimer
*timer
)
31885 /* The timer implementation will cancel this timer automatically
31886 after this function has run. Set hourglass_atimer to null
31887 so that we know the timer doesn't have to be canceled. */
31888 hourglass_atimer
= NULL
;
31890 if (!hourglass_shown_p
)
31892 Lisp_Object tail
, frame
;
31896 FOR_EACH_FRAME (tail
, frame
)
31898 struct frame
*f
= XFRAME (frame
);
31900 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31901 && FRAME_RIF (f
)->show_hourglass
)
31902 FRAME_RIF (f
)->show_hourglass (f
);
31905 hourglass_shown_p
= true;
31910 /* Cancel a currently active hourglass timer, and start a new one. */
31913 start_hourglass (void)
31915 struct timespec delay
;
31917 cancel_hourglass ();
31919 if (INTEGERP (Vhourglass_delay
)
31920 && XINT (Vhourglass_delay
) > 0)
31921 delay
= make_timespec (min (XINT (Vhourglass_delay
),
31922 TYPE_MAXIMUM (time_t)),
31924 else if (FLOATP (Vhourglass_delay
)
31925 && XFLOAT_DATA (Vhourglass_delay
) > 0)
31926 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
31928 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
31930 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
31931 show_hourglass
, NULL
);
31934 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31938 cancel_hourglass (void)
31940 if (hourglass_atimer
)
31942 cancel_atimer (hourglass_atimer
);
31943 hourglass_atimer
= NULL
;
31946 if (hourglass_shown_p
)
31948 Lisp_Object tail
, frame
;
31952 FOR_EACH_FRAME (tail
, frame
)
31954 struct frame
*f
= XFRAME (frame
);
31956 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31957 && FRAME_RIF (f
)->hide_hourglass
)
31958 FRAME_RIF (f
)->hide_hourglass (f
);
31960 /* No cursors on non GUI frames - restore to stock arrow cursor. */
31961 else if (!FRAME_W32_P (f
))
31962 w32_arrow_cursor ();
31966 hourglass_shown_p
= false;
31971 #endif /* HAVE_WINDOW_SYSTEM */